@scalar/oas-utils 0.11.0 → 0.12.0

package/dist/entities/spec/request-examples.d.ts

@@ -1,380 +0,0 @@
-import { z } from 'zod';
-import type { RequestParameter } from './parameters.js';
-import type { Request } from './requests.js';
-import type { Server } from './server.js';
-/**
- * TODO: Deprecate this.
- *
- * The request schema should be stored in the request and any
- * parameters should be validated against that
- */
-export declare const requestExampleParametersSchema: z.ZodPipe<z.ZodObject<{
-    key: z.ZodDefault<z.ZodString>;
-    value: z.ZodDefault<z.ZodCoercedString<unknown>>;
-    enabled: z.ZodDefault<z.ZodBoolean>;
-    file: z.ZodOptional<z.ZodAny>;
-    description: z.ZodOptional<z.ZodString>;
-    required: z.ZodOptional<z.ZodBoolean>;
-    enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    examples: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-    type: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
-    format: z.ZodOptional<z.ZodString>;
-    minimum: z.ZodOptional<z.ZodNumber>;
-    maximum: z.ZodOptional<z.ZodNumber>;
-    default: z.ZodOptional<z.ZodAny>;
-    nullable: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>, z.ZodTransform<{
-    key: string;
-    value: string;
-    enabled: boolean;
-    file?: any;
-    description?: string | undefined;
-    required?: boolean | undefined;
-    enum?: string[] | undefined;
-    examples?: any[] | undefined;
-    type?: string | string[] | undefined;
-    format?: string | undefined;
-    minimum?: number | undefined;
-    maximum?: number | undefined;
-    default?: any;
-    nullable?: boolean | undefined;
-}, {
-    key: string;
-    value: string;
-    enabled: boolean;
-    file?: any;
-    description?: string | undefined;
-    required?: boolean | undefined;
-    enum?: string[] | undefined;
-    examples?: any[] | undefined;
-    type?: string | string[] | undefined;
-    format?: string | undefined;
-    minimum?: number | undefined;
-    maximum?: number | undefined;
-    default?: any;
-    nullable?: boolean | undefined;
-}>>;
-/** Convert the array of parameters to an object keyed by the parameter name */
-export declare const parameterArrayToObject: (params: RequestExampleParameter[]) => Record<string, string>;
-/** Request examples - formerly known as instances - are "children" of requests */
-export type RequestExampleParameter = z.infer<typeof requestExampleParametersSchema>;
-export declare const requestExampleSchema: z.ZodObject<{
-    uid: z.core.$ZodBranded<z.ZodDefault<z.ZodString>, "example", "out">;
-    type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"requestExample">>>;
-    requestUid: z.ZodOptional<z.core.$ZodBranded<z.ZodString, "operation", "out">>;
-    name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-    body: z.ZodDefault<z.ZodOptional<z.ZodObject<{
-        raw: z.ZodOptional<z.ZodObject<{
-            encoding: z.ZodEnum<{
-                xml: "xml";
-                json: "json";
-                html: "html";
-                text: "text";
-                javascript: "javascript";
-                yaml: "yaml";
-                edn: "edn";
-            }>;
-            value: z.ZodDefault<z.ZodString>;
-            mimeType: z.ZodOptional<z.ZodString>;
-        }, z.core.$strip>>;
-        formData: z.ZodOptional<z.ZodObject<{
-            encoding: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"form-data">, z.ZodLiteral<"urlencoded">]>>;
-            value: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodObject<{
-                key: z.ZodDefault<z.ZodString>;
-                value: z.ZodDefault<z.ZodCoercedString<unknown>>;
-                enabled: z.ZodDefault<z.ZodBoolean>;
-                file: z.ZodOptional<z.ZodAny>;
-                description: z.ZodOptional<z.ZodString>;
-                required: z.ZodOptional<z.ZodBoolean>;
-                enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
-                examples: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-                type: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
-                format: z.ZodOptional<z.ZodString>;
-                minimum: z.ZodOptional<z.ZodNumber>;
-                maximum: z.ZodOptional<z.ZodNumber>;
-                default: z.ZodOptional<z.ZodAny>;
-                nullable: z.ZodOptional<z.ZodBoolean>;
-            }, z.core.$strip>, z.ZodTransform<{
-                key: string;
-                value: string;
-                enabled: boolean;
-                file?: any;
-                description?: string | undefined;
-                required?: boolean | undefined;
-                enum?: string[] | undefined;
-                examples?: any[] | undefined;
-                type?: string | string[] | undefined;
-                format?: string | undefined;
-                minimum?: number | undefined;
-                maximum?: number | undefined;
-                default?: any;
-                nullable?: boolean | undefined;
-            }, {
-                key: string;
-                value: string;
-                enabled: boolean;
-                file?: any;
-                description?: string | undefined;
-                required?: boolean | undefined;
-                enum?: string[] | undefined;
-                examples?: any[] | undefined;
-                type?: string | string[] | undefined;
-                format?: string | undefined;
-                minimum?: number | undefined;
-                maximum?: number | undefined;
-                default?: any;
-                nullable?: boolean | undefined;
-            }>>>>;
-        }, z.core.$strip>>;
-        binary: z.ZodOptional<z.ZodCustom<Blob, Blob>>;
-        activeBody: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"raw">, z.ZodLiteral<"formData">, z.ZodLiteral<"binary">]>>;
-    }, z.core.$strip>>>;
-    parameters: z.ZodDefault<z.ZodOptional<z.ZodObject<{
-        path: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodObject<{
-            key: z.ZodDefault<z.ZodString>;
-            value: z.ZodDefault<z.ZodCoercedString<unknown>>;
-            enabled: z.ZodDefault<z.ZodBoolean>;
-            file: z.ZodOptional<z.ZodAny>;
-            description: z.ZodOptional<z.ZodString>;
-            required: z.ZodOptional<z.ZodBoolean>;
-            enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
-            examples: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-            type: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
-            format: z.ZodOptional<z.ZodString>;
-            minimum: z.ZodOptional<z.ZodNumber>;
-            maximum: z.ZodOptional<z.ZodNumber>;
-            default: z.ZodOptional<z.ZodAny>;
-            nullable: z.ZodOptional<z.ZodBoolean>;
-        }, z.core.$strip>, z.ZodTransform<{
-            key: string;
-            value: string;
-            enabled: boolean;
-            file?: any;
-            description?: string | undefined;
-            required?: boolean | undefined;
-            enum?: string[] | undefined;
-            examples?: any[] | undefined;
-            type?: string | string[] | undefined;
-            format?: string | undefined;
-            minimum?: number | undefined;
-            maximum?: number | undefined;
-            default?: any;
-            nullable?: boolean | undefined;
-        }, {
-            key: string;
-            value: string;
-            enabled: boolean;
-            file?: any;
-            description?: string | undefined;
-            required?: boolean | undefined;
-            enum?: string[] | undefined;
-            examples?: any[] | undefined;
-            type?: string | string[] | undefined;
-            format?: string | undefined;
-            minimum?: number | undefined;
-            maximum?: number | undefined;
-            default?: any;
-            nullable?: boolean | undefined;
-        }>>>>;
-        query: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodObject<{
-            key: z.ZodDefault<z.ZodString>;
-            value: z.ZodDefault<z.ZodCoercedString<unknown>>;
-            enabled: z.ZodDefault<z.ZodBoolean>;
-            file: z.ZodOptional<z.ZodAny>;
-            description: z.ZodOptional<z.ZodString>;
-            required: z.ZodOptional<z.ZodBoolean>;
-            enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
-            examples: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-            type: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
-            format: z.ZodOptional<z.ZodString>;
-            minimum: z.ZodOptional<z.ZodNumber>;
-            maximum: z.ZodOptional<z.ZodNumber>;
-            default: z.ZodOptional<z.ZodAny>;
-            nullable: z.ZodOptional<z.ZodBoolean>;
-        }, z.core.$strip>, z.ZodTransform<{
-            key: string;
-            value: string;
-            enabled: boolean;
-            file?: any;
-            description?: string | undefined;
-            required?: boolean | undefined;
-            enum?: string[] | undefined;
-            examples?: any[] | undefined;
-            type?: string | string[] | undefined;
-            format?: string | undefined;
-            minimum?: number | undefined;
-            maximum?: number | undefined;
-            default?: any;
-            nullable?: boolean | undefined;
-        }, {
-            key: string;
-            value: string;
-            enabled: boolean;
-            file?: any;
-            description?: string | undefined;
-            required?: boolean | undefined;
-            enum?: string[] | undefined;
-            examples?: any[] | undefined;
-            type?: string | string[] | undefined;
-            format?: string | undefined;
-            minimum?: number | undefined;
-            maximum?: number | undefined;
-            default?: any;
-            nullable?: boolean | undefined;
-        }>>>>;
-        headers: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodObject<{
-            key: z.ZodDefault<z.ZodString>;
-            value: z.ZodDefault<z.ZodCoercedString<unknown>>;
-            enabled: z.ZodDefault<z.ZodBoolean>;
-            file: z.ZodOptional<z.ZodAny>;
-            description: z.ZodOptional<z.ZodString>;
-            required: z.ZodOptional<z.ZodBoolean>;
-            enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
-            examples: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-            type: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
-            format: z.ZodOptional<z.ZodString>;
-            minimum: z.ZodOptional<z.ZodNumber>;
-            maximum: z.ZodOptional<z.ZodNumber>;
-            default: z.ZodOptional<z.ZodAny>;
-            nullable: z.ZodOptional<z.ZodBoolean>;
-        }, z.core.$strip>, z.ZodTransform<{
-            key: string;
-            value: string;
-            enabled: boolean;
-            file?: any;
-            description?: string | undefined;
-            required?: boolean | undefined;
-            enum?: string[] | undefined;
-            examples?: any[] | undefined;
-            type?: string | string[] | undefined;
-            format?: string | undefined;
-            minimum?: number | undefined;
-            maximum?: number | undefined;
-            default?: any;
-            nullable?: boolean | undefined;
-        }, {
-            key: string;
-            value: string;
-            enabled: boolean;
-            file?: any;
-            description?: string | undefined;
-            required?: boolean | undefined;
-            enum?: string[] | undefined;
-            examples?: any[] | undefined;
-            type?: string | string[] | undefined;
-            format?: string | undefined;
-            minimum?: number | undefined;
-            maximum?: number | undefined;
-            default?: any;
-            nullable?: boolean | undefined;
-        }>>>>;
-        cookies: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodObject<{
-            key: z.ZodDefault<z.ZodString>;
-            value: z.ZodDefault<z.ZodCoercedString<unknown>>;
-            enabled: z.ZodDefault<z.ZodBoolean>;
-            file: z.ZodOptional<z.ZodAny>;
-            description: z.ZodOptional<z.ZodString>;
-            required: z.ZodOptional<z.ZodBoolean>;
-            enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
-            examples: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-            type: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
-            format: z.ZodOptional<z.ZodString>;
-            minimum: z.ZodOptional<z.ZodNumber>;
-            maximum: z.ZodOptional<z.ZodNumber>;
-            default: z.ZodOptional<z.ZodAny>;
-            nullable: z.ZodOptional<z.ZodBoolean>;
-        }, z.core.$strip>, z.ZodTransform<{
-            key: string;
-            value: string;
-            enabled: boolean;
-            file?: any;
-            description?: string | undefined;
-            required?: boolean | undefined;
-            enum?: string[] | undefined;
-            examples?: any[] | undefined;
-            type?: string | string[] | undefined;
-            format?: string | undefined;
-            minimum?: number | undefined;
-            maximum?: number | undefined;
-            default?: any;
-            nullable?: boolean | undefined;
-        }, {
-            key: string;
-            value: string;
-            enabled: boolean;
-            file?: any;
-            description?: string | undefined;
-            required?: boolean | undefined;
-            enum?: string[] | undefined;
-            examples?: any[] | undefined;
-            type?: string | string[] | undefined;
-            format?: string | undefined;
-            minimum?: number | undefined;
-            maximum?: number | undefined;
-            default?: any;
-            nullable?: boolean | undefined;
-        }>>>>;
-    }, z.core.$strip>>>;
-    serverVariables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;
-}, z.core.$strip>;
-export type RequestExample = z.infer<typeof requestExampleSchema>;
-/** Schema for the OAS serialization of request examples */
-export declare const xScalarExampleSchema: z.ZodObject<{
-    name: z.ZodOptional<z.ZodString>;
-    body: z.ZodOptional<z.ZodObject<{
-        encoding: z.ZodEnum<{
-            binary: "binary";
-            "application/json": "application/json";
-            "text/plain": "text/plain";
-            "text/html": "text/html";
-            "application/javascript": "application/javascript";
-            "application/xml": "application/xml";
-            "application/yaml": "application/yaml";
-            "application/edn": "application/edn";
-            "application/octet-stream": "application/octet-stream";
-            "application/x-www-form-urlencoded": "application/x-www-form-urlencoded";
-            "multipart/form-data": "multipart/form-data";
-        }>;
-        content: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodString]>;
-        file: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-            url: z.ZodString;
-            base64: z.ZodOptional<z.ZodString>;
-        }, z.core.$strip>>>;
-    }, z.core.$strip>>;
-    parameters: z.ZodObject<{
-        path: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-        query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-        cookies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-    }, z.core.$strip>;
-}, z.core.$strip>;
-/**
- * Convert a request example to the xScalar serialized format
- *
- * TODO: The base format should be migrated to align MUCH closer to the serialized format
- */
-export declare function convertExampleToXScalar(example: RequestExample): {
-    parameters: {
-        path?: Record<string, string> | undefined;
-        query?: Record<string, string> | undefined;
-        headers?: Record<string, string> | undefined;
-        cookies?: Record<string, string> | undefined;
-    };
-    name?: string | undefined;
-    body?: {
-        encoding: "binary" | "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data";
-        content: string | Record<string, any>;
-        file?: {
-            url: string;
-            base64?: string | undefined;
-        } | null | undefined;
-    } | undefined;
-};
-/** Create new instance parameter from a request parameter */
-export declare function createParamInstance(param: RequestParameter): RequestExampleParameter;
-/**
- * Create new request example from a request
- * Iterates the name of the example if provided
- */
-export declare function createExampleFromRequest(request: Request, name: string, server?: Server): RequestExample;
-//# sourceMappingURL=request-examples.d.ts.map

package/dist/entities/spec/request-examples.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"request-examples.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/request-examples.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAMvB,OAAO,KAAK,EAAoB,gBAAgB,EAAE,MAAM,cAAc,CAAA;AACtE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAKtC;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCvC,CAAA;AAEJ,+EAA+E;AAC/E,eAAO,MAAM,sBAAsB,GAAI,QAAQ,uBAAuB,EAAE,2BAIhE,CAAA;AAER,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AAoHpF,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsB/B,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAKjE,2DAA2D;AAC3D,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAU/B,CAAA;AAIF;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,cAAc;;;;;;;;;;;;;;;;EAqD9D;AAKD,6DAA6D;AAC7D,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,GAAG,uBAAuB,CAsHpF;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,cAAc,CA2HxG"}