@scalar/oas-utils 0.1.17 → 0.2.1

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

@@ -0,0 +1,479 @@
+import { z } from 'zod';
+declare const requestExampleParametersSchema: z.ZodObject<{
+    key: z.ZodDefault<z.ZodString>;
+    value: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, string, string | number>>;
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    file: z.ZodOptional<z.ZodType<File, z.ZodTypeDef, File>>;
+    description: z.ZodOptional<z.ZodString>;
+    /** Params are linked to parents such as path params and global headers/cookies */
+    refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    key: string;
+    enabled: boolean;
+    file?: File | undefined;
+    description?: string | undefined;
+    refUid?: string | undefined;
+}, {
+    key?: string | undefined;
+    value?: string | number | undefined;
+    enabled?: boolean | undefined;
+    file?: File | undefined;
+    description?: string | undefined;
+    refUid?: string | undefined;
+}>;
+/** Request examples - formerly known as instances - are "children" of requests */
+export type RequestExampleParameter = z.infer<typeof requestExampleParametersSchema>;
+export type RequestExampleParameterPayload = z.input<typeof requestExampleParametersSchema>;
+/** Create request example parameter helper */
+export declare const createRequestExampleParameter: (payload: RequestExampleParameterPayload) => {
+    value: string;
+    key: string;
+    enabled: boolean;
+    file?: File | undefined;
+    description?: string | undefined;
+    refUid?: string | undefined;
+};
+declare const requestExampleSchema: z.ZodObject<{
+    uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    requestUid: z.ZodString;
+    name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    body: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        raw: z.ZodDefault<z.ZodObject<{
+            encoding: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"json">, z.ZodLiteral<"text">, z.ZodLiteral<"html">, z.ZodLiteral<"text">, z.ZodLiteral<"javascript">, z.ZodLiteral<"xml">, z.ZodLiteral<"yaml">, z.ZodLiteral<"edn">]>>;
+            value: z.ZodDefault<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            encoding: "json" | "text" | "html" | "javascript" | "xml" | "yaml" | "edn";
+        }, {
+            encoding?: "json" | "text" | "html" | "javascript" | "xml" | "yaml" | "edn" | undefined;
+            value?: string | undefined;
+        }>>;
+        formData: z.ZodDefault<z.ZodObject<{
+            encoding: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"form-data">, z.ZodLiteral<"urlencoded">]>>;
+            value: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                key: z.ZodDefault<z.ZodString>;
+                value: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, string, string | number>>;
+                enabled: z.ZodDefault<z.ZodBoolean>;
+                file: z.ZodOptional<z.ZodType<File, z.ZodTypeDef, File>>;
+                description: z.ZodOptional<z.ZodString>;
+                /** Params are linked to parents such as path params and global headers/cookies */
+                refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+            }, "strip", z.ZodTypeAny, {
+                value: string;
+                key: string;
+                enabled: boolean;
+                file?: File | undefined;
+                description?: string | undefined;
+                refUid?: string | undefined;
+            }, {
+                key?: string | undefined;
+                value?: string | number | undefined;
+                enabled?: boolean | undefined;
+                file?: File | undefined;
+                description?: string | undefined;
+                refUid?: string | undefined;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            value: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                file?: File | undefined;
+                description?: string | undefined;
+                refUid?: string | undefined;
+            }[];
+            encoding: "form-data" | "urlencoded";
+        }, {
+            encoding?: "form-data" | "urlencoded" | undefined;
+            value?: {
+                key?: string | undefined;
+                value?: string | number | undefined;
+                enabled?: boolean | undefined;
+                file?: File | undefined;
+                description?: string | undefined;
+                refUid?: string | undefined;
+            }[] | undefined;
+        }>>;
+        binary: z.ZodOptional<z.ZodType<File, z.ZodTypeDef, File>>;
+        activeBody: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"raw">, z.ZodLiteral<"formData">, z.ZodLiteral<"binary">]>>;
+    }, "strip", z.ZodTypeAny, {
+        raw: {
+            value: string;
+            encoding: "json" | "text" | "html" | "javascript" | "xml" | "yaml" | "edn";
+        };
+        formData: {
+            value: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                file?: File | undefined;
+                description?: string | undefined;
+                refUid?: string | undefined;
+            }[];
+            encoding: "form-data" | "urlencoded";
+        };
+        activeBody: "raw" | "formData" | "binary";
+        binary?: File | undefined;
+    }, {
+        raw?: {
+            encoding?: "json" | "text" | "html" | "javascript" | "xml" | "yaml" | "edn" | undefined;
+            value?: string | undefined;
+        } | undefined;
+        formData?: {
+            encoding?: "form-data" | "urlencoded" | undefined;
+            value?: {
+                key?: string | undefined;
+                value?: string | number | undefined;
+                enabled?: boolean | undefined;
+                file?: File | undefined;
+                description?: string | undefined;
+                refUid?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+        binary?: File | undefined;
+        activeBody?: "raw" | "formData" | "binary" | undefined;
+    }>>>;
+    parameters: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        path: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodDefault<z.ZodString>;
+            value: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, string, string | number>>;
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            file: z.ZodOptional<z.ZodType<File, z.ZodTypeDef, File>>;
+            description: z.ZodOptional<z.ZodString>;
+            /** Params are linked to parents such as path params and global headers/cookies */
+            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }, {
+            key?: string | undefined;
+            value?: string | number | undefined;
+            enabled?: boolean | undefined;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }>, "many">>;
+        query: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodDefault<z.ZodString>;
+            value: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, string, string | number>>;
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            file: z.ZodOptional<z.ZodType<File, z.ZodTypeDef, File>>;
+            description: z.ZodOptional<z.ZodString>;
+            /** Params are linked to parents such as path params and global headers/cookies */
+            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }, {
+            key?: string | undefined;
+            value?: string | number | undefined;
+            enabled?: boolean | undefined;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }>, "many">>;
+        headers: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodDefault<z.ZodString>;
+            value: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, string, string | number>>;
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            file: z.ZodOptional<z.ZodType<File, z.ZodTypeDef, File>>;
+            description: z.ZodOptional<z.ZodString>;
+            /** Params are linked to parents such as path params and global headers/cookies */
+            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }, {
+            key?: string | undefined;
+            value?: string | number | undefined;
+            enabled?: boolean | undefined;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }>, "many">>;
+        cookies: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodDefault<z.ZodString>;
+            value: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, string, string | number>>;
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            file: z.ZodOptional<z.ZodType<File, z.ZodTypeDef, File>>;
+            description: z.ZodOptional<z.ZodString>;
+            /** Params are linked to parents such as path params and global headers/cookies */
+            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }, {
+            key?: string | undefined;
+            value?: string | number | undefined;
+            enabled?: boolean | undefined;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        path: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[];
+        cookies: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[];
+        headers: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[];
+        query: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[];
+    }, {
+        path?: {
+            key?: string | undefined;
+            value?: string | number | undefined;
+            enabled?: boolean | undefined;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[] | undefined;
+        query?: {
+            key?: string | undefined;
+            value?: string | number | undefined;
+            enabled?: boolean | undefined;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[] | undefined;
+        headers?: {
+            key?: string | undefined;
+            value?: string | number | undefined;
+            enabled?: boolean | undefined;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[] | undefined;
+        cookies?: {
+            key?: string | undefined;
+            value?: string | number | undefined;
+            enabled?: boolean | undefined;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[] | undefined;
+    }>>>;
+    auth: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    uid: string;
+    parameters: {
+        path: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[];
+        cookies: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[];
+        headers: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[];
+        query: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[];
+    };
+    requestUid: string;
+    body: {
+        raw: {
+            value: string;
+            encoding: "json" | "text" | "html" | "javascript" | "xml" | "yaml" | "edn";
+        };
+        formData: {
+            value: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                file?: File | undefined;
+                description?: string | undefined;
+                refUid?: string | undefined;
+            }[];
+            encoding: "form-data" | "urlencoded";
+        };
+        activeBody: "raw" | "formData" | "binary";
+        binary?: File | undefined;
+    };
+    auth: Record<string, any>;
+}, {
+    requestUid: string;
+    uid?: string | undefined;
+    name?: string | undefined;
+    body?: {
+        raw?: {
+            encoding?: "json" | "text" | "html" | "javascript" | "xml" | "yaml" | "edn" | undefined;
+            value?: string | undefined;
+        } | undefined;
+        formData?: {
+            encoding?: "form-data" | "urlencoded" | undefined;
+            value?: {
+                key?: string | undefined;
+                value?: string | number | undefined;
+                enabled?: boolean | undefined;
+                file?: File | undefined;
+                description?: string | undefined;
+                refUid?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+        binary?: File | undefined;
+        activeBody?: "raw" | "formData" | "binary" | undefined;
+    } | undefined;
+    parameters?: {
+        path?: {
+            key?: string | undefined;
+            value?: string | number | undefined;
+            enabled?: boolean | undefined;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[] | undefined;
+        query?: {
+            key?: string | undefined;
+            value?: string | number | undefined;
+            enabled?: boolean | undefined;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[] | undefined;
+        headers?: {
+            key?: string | undefined;
+            value?: string | number | undefined;
+            enabled?: boolean | undefined;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[] | undefined;
+        cookies?: {
+            key?: string | undefined;
+            value?: string | number | undefined;
+            enabled?: boolean | undefined;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[] | undefined;
+    } | undefined;
+    auth?: Record<string, any> | undefined;
+}>;
+/** A single set of params for a request example */
+export type RequestExample = z.infer<typeof requestExampleSchema>;
+export type RequestExamplePayload = z.input<typeof requestExampleSchema>;
+/** Create request example helper */
+export declare const createRequestExample: (payload: RequestExamplePayload) => {
+    name: string;
+    uid: string;
+    parameters: {
+        path: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[];
+        cookies: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[];
+        headers: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[];
+        query: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            file?: File | undefined;
+            description?: string | undefined;
+            refUid?: string | undefined;
+        }[];
+    };
+    requestUid: string;
+    body: {
+        raw: {
+            value: string;
+            encoding: "json" | "text" | "html" | "javascript" | "xml" | "yaml" | "edn";
+        };
+        formData: {
+            value: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                file?: File | undefined;
+                description?: string | undefined;
+                refUid?: string | undefined;
+            }[];
+            encoding: "form-data" | "urlencoded";
+        };
+        activeBody: "raw" | "formData" | "binary";
+        binary?: File | undefined;
+    };
+    auth: Record<string, any>;
+};
+export {};
+//# sourceMappingURL=request-examples.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"request-examples.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/request-examples.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,QAAA,MAAM,8BAA8B;;;;;;IAMlC,kFAAkF;;;;;;;;;;;;;;;;EAElF,CAAA;AAEF,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,8BAA8B,CACtC,CAAA;AACD,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,8CAA8C;AAC9C,eAAO,MAAM,6BAA6B,YAC/B,8BAA8B;;;;;;;CACwB,CAAA;AAEjE,QAAA,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;gBAjBxB,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiElF,CAAA;AAEF,mDAAmD;AACnD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAExE,oCAAoC;AACpC,eAAO,MAAM,oBAAoB,YAAa,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAIhE,CAAA"}

package/dist/entities/workspace/spec/request-examples.js

@@ -0,0 +1,68 @@
+import { z } from 'zod';
+import { nanoidSchema } from '../shared/utility.js';
+import { deepMerge } from '../../../helpers/deepMerge.js';
+
+const requestExampleParametersSchema = z.object({
+    key: z.string().default(''),
+    value: z.union([z.string(), z.number()]).transform(String).default(''),
+    enabled: z.boolean().default(true),
+    file: z.instanceof(File).optional(),
+    description: z.string().optional(),
+    /** Params are linked to parents such as path params and global headers/cookies */
+    refUid: nanoidSchema.optional(),
+});
+/** Create request example parameter helper */
+const createRequestExampleParameter = (payload) => deepMerge(requestExampleParametersSchema.parse({}), payload);
+const requestExampleSchema = z.object({
+    uid: nanoidSchema,
+    requestUid: z.string().min(7),
+    name: z.string().optional().default('Name'),
+    body: z
+        .object({
+        raw: z
+            .object({
+            encoding: z
+                .union([
+                z.literal('json'),
+                z.literal('text'),
+                z.literal('html'),
+                z.literal('text'),
+                z.literal('javascript'),
+                z.literal('xml'),
+                z.literal('yaml'),
+                z.literal('edn'),
+            ])
+                .default('json'),
+            value: z.string().default(''),
+        })
+            .default({}),
+        formData: z
+            .object({
+            encoding: z
+                .union([z.literal('form-data'), z.literal('urlencoded')])
+                .default('form-data'),
+            value: requestExampleParametersSchema.array().default([]),
+        })
+            .default({}),
+        binary: z.instanceof(File).optional(),
+        activeBody: z
+            .union([z.literal('raw'), z.literal('formData'), z.literal('binary')])
+            .default('raw'),
+    })
+        .optional()
+        .default({}),
+    parameters: z
+        .object({
+        path: requestExampleParametersSchema.array().default([]),
+        query: requestExampleParametersSchema.array().default([]),
+        headers: requestExampleParametersSchema.array().default([]),
+        cookies: requestExampleParametersSchema.array().default([]),
+    })
+        .optional()
+        .default({}),
+    auth: z.record(z.string(), z.any()).default({}),
+});
+/** Create request example helper */
+const createRequestExample = (payload) => deepMerge(requestExampleSchema.parse({ requestUid: payload.requestUid }), payload);
+
+export { createRequestExample, createRequestExampleParameter };