ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.260.6 (#47)

github-actions[bot] · speakeasybot · web-flow · commit 4c6872c5813c · 2024-04-19T20:27:53.000+02:00
Co-authored-by: speakeasybot &lt;bot@speakeasyapi.dev&gt;
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -3,17 +3,17 @@ id: 2f8b2839-3001-46b4-b5e0-cec0aad583ed
 management:
   docChecksum: 2401c7030f847f72ab31c8f75de58a66
   docVersion: 0.2.0
-  speakeasyVersion: 1.257.1
-  generationVersion: 2.308.2
-  releaseVersion: 0.2.8
-  configChecksum: 7f4440ef5511489d871961cca99331f5
+  speakeasyVersion: 1.260.6
+  generationVersion: 2.311.1
+  releaseVersion: 0.3.0
+  configChecksum: a5ef199e8eaf4f35475bc5e2dda2090c
   repoURL: https://github.com/StyraInc/opa-typescript.git
   installationURL: https://github.com/StyraInc/opa-typescript
   published: true
 features:
   typescript:
     constsAndDefaults: 0.1.5
-    core: 3.7.2
+    core: 3.8.0
     examples: 2.81.3
     flattening: 2.81.1
     globalServerURLs: 2.82.4
@@ -22,6 +22,7 @@ features:
 generatedFiles:
   - src/sdk/sdk.ts
   - RUNTIMES.md
+  - jsr.json
   - package.json
   - src/lib/base64.ts
   - src/lib/config.ts
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -12,7 +12,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: false
 typescript:
-  version: 0.2.8
+  version: 0.3.0
   additionalDependencies:
     dependencies: {}
     devDependencies:
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,4 +1,4 @@
-speakeasyVersion: 1.257.1
+speakeasyVersion: 1.260.6
 sources:
     openapi: {}
 targets:
diff --git a/RELEASES.md b/RELEASES.md
@@ -118,4 +118,14 @@ Based on:
 ### Generated
 - [typescript v0.2.8] .
 ### Releases
-- [NPM v0.2.8] https://www.npmjs.com/package/@styra/opa/v/0.2.8 - .
+- [NPM v0.2.8] https://www.npmjs.com/package/@styra/opa/v/0.2.8 - .
+
+## 2024-04-19 00:14:11
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.260.6 (2.311.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.3.0] .
+### Releases
+- [NPM v0.3.0] https://www.npmjs.com/package/@styra/opa/v/0.3.0 - .
diff --git a/jsr.json b/jsr.json
@@ -0,0 +1,26 @@
+
+
+{
+  "name": "@styra/opa",
+  "version": "0.3.0",
+  "exports": {
+    ".": "./src/index.ts",    
+    "./sdk/models/errors": "./src/sdk/models/errors/index.ts",    
+    "./sdk/models/components": "./src/sdk/models/components/index.ts",    
+    "./sdk/models/operations": "./src/sdk/models/operations/index.ts",
+    "./lib/config": "./src/lib/config.ts",
+    "./lib/http": "./src/lib/http.ts",
+    "./lib/retries": "./src/lib/retries.ts",
+    "./lib/sdks": "./src/lib/sdks.ts",
+    "./types": "./src/types/index.ts"
+  },
+  "publish": {
+    "include": [
+      "LICENSE",
+      "README.md",
+      "RUNTIMES.md",
+      "USAGE.md",
+      "src/**/*.ts"
+    ]
+  }
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@styra/opa",
-  "version": "0.2.8",
+  "version": "0.3.0",
   "author": "Styra",  
   "main": "./index.js",
   "sideEffects": false,
diff --git a/src/lib/config.ts b/src/lib/config.ts
@@ -4,7 +4,7 @@
 
 import { HTTPClient } from "./http";
 import { RetryConfig } from "./retries";
-import { pathToFunc } from "./url";
+import { Params, pathToFunc } from "./url";
 
 /**
  * Contains the list of servers available to the SDK
@@ -35,7 +35,7 @@ export type SDKOptions = {
 export function serverURLFromOptions(options: SDKOptions): URL | null {
     let serverURL = options.serverURL;
 
-    const params: Record<string, string> = {};
+    const params: Params = {};
 
     if (!serverURL) {
         const serverIdx = options.serverIdx ?? 0;
@@ -49,10 +49,10 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
     return new URL(u);
 }
 
-export const SDK_METADATA = Object.freeze({
+export const SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "0.2.0",
-    sdkVersion: "0.2.8",
-    genVersion: "2.308.2",
-    userAgent: "speakeasy-sdk/typescript 0.2.8 2.308.2 0.2.0 @styra/opa",
-});
+    sdkVersion: "0.3.0",
+    genVersion: "2.311.1",
+    userAgent: "speakeasy-sdk/typescript 0.3.0 2.311.1 0.2.0 @styra/opa",
+} as const;
diff --git a/src/lib/encodings.ts b/src/lib/encodings.ts
@@ -15,7 +15,7 @@ export function encodeMatrix(
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-) {
+): string {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
     ? explode(key, value)
@@ -65,7 +65,7 @@ export function encodeLabel(
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-) {
+): string {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
     ? explode(key, value)
@@ -100,7 +100,13 @@ export function encodeLabel(
   return out;
 }
 
-function formEncoder(sep: string) {
+type FormEncoder = (
+  key: string,
+  value: unknown,
+  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+) => string;
+
+function formEncoder(sep: string): FormEncoder {
   return (
     key: string,
     value: unknown,
@@ -157,7 +163,7 @@ export function encodeBodyForm(
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-) {
+): string {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
     ? explode(key, value)
@@ -200,7 +206,7 @@ export function encodeDeepObject(
   key: string,
   value: unknown,
   options?: { charEncoding?: "percent" | "none" },
-) {
+): string {
   if (value == null) {
     return "";
   }
@@ -247,7 +253,7 @@ export function encodeJSON(
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-) {
+): string {
   if (typeof value === "undefined") {
     return "";
   }
@@ -265,7 +271,7 @@ export const encodeSimple = (
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-) => {
+): string => {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
     ? explode(key, value)
@@ -337,7 +343,7 @@ function serializeValue(value: unknown): string {
   return `${value}`;
 }
 
-function jsonReplacer(_: string, value: unknown) {
+function jsonReplacer(_: string, value: unknown): unknown {
   if (value instanceof Uint8Array) {
     return bytesToBase64(value);
   } else {
diff --git a/src/lib/http.ts b/src/lib/http.ts
@@ -7,17 +7,17 @@ export type Fetcher = (
   init?: RequestInit,
 ) => Promise<Response>;
 
-type Awaitable<T> = T | Promise<T>;
+export type Awaitable<T> = T | Promise<T>;
 
 const DEFAULT_FETCHER: Fetcher = (input, init) => fetch(input, init);
 
 export interface HTTPClientOptions {
   fetcher?: Fetcher;
 }
 
-type BeforeRequestHook = (req: Request) => Awaitable<Request | void>;
-type RequestErrorHook = (err: unknown, req: Request) => Awaitable<void>;
-type ResponseHook = (res: Response, req: Request) => Awaitable<void>;
+export type BeforeRequestHook = (req: Request) => Awaitable<Request | void>;
+export type RequestErrorHook = (err: unknown, req: Request) => Awaitable<void>;
+export type ResponseHook = (res: Response, req: Request) => Awaitable<void>;
 
 export class HTTPClient {
   private fetcher: Fetcher;
@@ -100,7 +100,7 @@ export class HTTPClient {
       | [hook: "beforeRequest", fn: BeforeRequestHook]
       | [hook: "requestError", fn: RequestErrorHook]
       | [hook: "response", fn: ResponseHook]
-  ) {
+  ): this {
     let target: unknown[];
     if (args[0] === "beforeRequest") {
       target = this.requestHooks;
@@ -120,7 +120,7 @@ export class HTTPClient {
     return this;
   }
 
-  clone() {
+  clone(): HTTPClient {
     const child = new HTTPClient(this.options);
     child.requestHooks = this.requestHooks.slice();
     child.requestErrorHooks = this.requestErrorHooks.slice();
@@ -160,7 +160,7 @@ const codeRangeRE = new RegExp("^[0-9]xx$", "i");
 export function matchStatusCode(
   response: Response,
   codes: number | string | (number | string)[],
-) {
+): boolean {
   const actual = `${response.status}`;
   const expectedCodes = Array.isArray(codes) ? codes : [codes];
   if (!expectedCodes.length) {
diff --git a/src/lib/sdks.ts b/src/lib/sdks.ts
@@ -40,7 +40,7 @@ export class ClientSDK {
         this.client = client;
     }
 
-    protected createRequest$(conf: RequestConfig, options?: RequestOptions) {
+    protected createRequest$(conf: RequestConfig, options?: RequestOptions): Request {
         const { method, path, query, headers: opHeaders, security } = conf;
 
         const base = conf.baseURL ?? this.baseURL;
@@ -109,7 +109,7 @@ export class ClientSDK {
             context: HookContext;
             errorCodes: number | string | (number | string)[];
         }
-    ) {
+    ): Promise<Response> {
         const { context, errorCodes } = options;
 
         let response = await this.client.request(await this.hooks$.beforeRequest(context, req));
diff --git a/src/lib/url.ts b/src/lib/url.ts
@@ -4,10 +4,12 @@
 
 const hasOwn = Object.prototype.hasOwnProperty;
 
+export type Params = Partial<Record<string, string | number>>;
+
 export function pathToFunc(
   pathPattern: string,
   options?: { charEncoding?: "percent" | "none" },
-): (params?: Record<string, string | number>) => string {
+): (params?: Params) => string {
   const paramRE = /\{([a-zA-Z0-9_]+?)\}/g;
 
   return function buildURLPath(params: Record<string, unknown> = {}): string {
diff --git a/src/sdk/models/components/explain.ts b/src/sdk/models/components/explain.ts
@@ -12,4 +12,4 @@ export enum Explain {
 }
 
 /** @internal */
-export const Explain$ = z.nativeEnum(Explain);
+export const Explain$: z.ZodNativeEnum<typeof Explain> = z.nativeEnum(Explain);
diff --git a/src/sdk/models/components/gzipacceptencoding.ts b/src/sdk/models/components/gzipacceptencoding.ts
@@ -9,4 +9,5 @@ export enum GzipAcceptEncoding {
 }
 
 /** @internal */
-export const GzipAcceptEncoding$ = z.nativeEnum(GzipAcceptEncoding);
+export const GzipAcceptEncoding$: z.ZodNativeEnum<typeof GzipAcceptEncoding> =
+    z.nativeEnum(GzipAcceptEncoding);
diff --git a/src/sdk/models/components/gzipcontentencoding.ts b/src/sdk/models/components/gzipcontentencoding.ts
@@ -9,4 +9,5 @@ export enum GzipContentEncoding {
 }
 
 /** @internal */
-export const GzipContentEncoding$ = z.nativeEnum(GzipContentEncoding);
+export const GzipContentEncoding$: z.ZodNativeEnum<typeof GzipContentEncoding> =
+    z.nativeEnum(GzipContentEncoding);
diff --git a/src/sdk/models/errors/sdkvalidationerror.ts b/src/sdk/models/errors/sdkvalidationerror.ts
@@ -17,7 +17,7 @@ export class SDKValidationError extends Error {
     this.rawValue = rawValue;
   }
 
-  public override toString() {
+  public override toString(): string {
     return `${this.message}: ${this.cause}`;
   }
 
@@ -26,7 +26,7 @@ export class SDKValidationError extends Error {
    * is a ZodError or some other recognized error type, otherwise return the
    * default error message.
    */
-  public pretty() {
+  public pretty(): string {
     if (this.cause instanceof z.ZodError) {
       return `${this.message}\n${formatZodError(this.cause)}`;
     } else {
diff --git a/src/types/blobs.ts b/src/types/blobs.ts
@@ -4,10 +4,11 @@
 
 import * as z from "zod";
 
-export const blobLikeSchema = z.custom<Blob>(isBlobLike, {
-  message: "expected a Blob, File or Blob-like object",
-  fatal: true,
-});
+export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> =
+  z.custom<Blob>(isBlobLike, {
+    message: "expected a Blob, File or Blob-like object",
+    fatal: true,
+  });
 
 export function isBlobLike(val: unknown): val is Blob {
   if (val instanceof Blob) {
diff --git a/src/types/operations.ts b/src/types/operations.ts
@@ -11,7 +11,7 @@ export type PageIterator<Result> = Result & {
 
 export function createPageIterator<Result>(
   page: Result & { next: Paginator<Result> },
-) {
+): { [Symbol.asyncIterator]: () => AsyncIterableIterator<Result> } {
   return {
     [Symbol.asyncIterator]: async function* paginator() {
       yield page;
diff --git a/src/types/rfcdate.ts b/src/types/rfcdate.ts
@@ -10,7 +10,7 @@ export class RFCDate {
   /**
    * Creates a new RFCDate instance using today's date.
    */
-  static today() {
+  static today(): RFCDate {
     return new RFCDate(new Date());
   }
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-speakeasyVersion: 1.257.1`
	`1`	`+speakeasyVersion: 1.260.6`
`2`	`2`	`sources:`
`3`	`3`	`openapi: {}`
`4`	`4`	`targets:`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@styra/opa",`
`3`		`- "version": "0.2.8",`
	`3`	`+ "version": "0.3.0",`
`4`	`4`	`"author": "Styra",`
`5`	`5`	`"main": "./index.js",`
`6`	`6`	`"sideEffects": false,`