@scalar/oas-utils 0.2.43 → 0.2.45

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

@@ -1 +0,0 @@
-{"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;AAGvB,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;EAUrB,CAAA;AAEF,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMW,CAAA;AAE3B,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAA;AAEjD,QAAA,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAMlC,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUlF,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;;;;;;;;;;;;;;;;;;;;;;;;;CAKtC,CAAA;AAEH,QAAA,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBA7BxB,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8ElF,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

@@ -1,96 +0,0 @@
-import { deepMerge } from '@scalar/object-utils/merge';
-import { z } from 'zod';
-import { nanoidSchema } from '../shared/utility.js';
-
-// Define the Blob schema
-const blobSchema = z.object({
-    size: z.number().nonnegative('Blob size must be a non-negative number').int(), // Size of the Blob
-    type: z.string(), // MIME type of the Blob
-    arrayBuffer: z.function().returns(z.promise(z.instanceof(ArrayBuffer))), // Returns a Promise of ArrayBuffer
-    slice: z
-        .function()
-        .args(z.number().optional(), z.number().optional(), z.string().optional())
-        .returns(z.any()), // Returns a Blob (any type for now)
-    stream: z.function().returns(z.instanceof((ReadableStream))), // Returns a ReadableStream of Uint8Array
-    text: z.function().returns(z.promise(z.string())), // Returns a Promise of string
-});
-const fileSchema = z
-    .object({
-    name: z.string(),
-    lastModified: z.number(),
-    webkitRelativePath: z.string(),
-})
-    .extend(blobSchema.shape);
-const requestExampleParametersSchema = z.object({
-    key: z.string().default(''),
-    value: z.union([z.string(), z.number()]).transform(String).default(''),
-    enabled: z.boolean().default(true),
-    file: fileSchema.optional(),
-    description: z.string().optional(),
-    /** Params are linked to parents such as path params and global headers/cookies */
-    refUid: nanoidSchema.optional(),
-    required: z.boolean().optional(),
-    enum: z.array(z.string()).optional(),
-    type: z.string().optional(),
-    format: z.string().optional(),
-    minimum: z.number().optional(),
-    maximum: z.number().optional(),
-    default: z.any().optional(),
-    nullable: z.boolean().optional(),
-});
-/** Create request example parameter helper */
-const createRequestExampleParameter = (payload) => deepMerge(requestExampleParametersSchema.parse({}), payload);
-const requestExampleSchema = z.object({
-    uid: nanoidSchema,
-    url: z.string().optional().default(''),
-    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: fileSchema.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 { blobSchema, createRequestExample, createRequestExampleParameter };

package/dist/entities/workspace/spec/requests.d.ts

@@ -1,181 +0,0 @@
-import type { OpenAPIV3_1 } from '@scalar/openapi-types';
-import { z } from 'zod';
-import type { RequestExample } from './request-examples.js';
-/** A single set of populated values for a sent request */
-export type ResponseInstance = Omit<Response, 'headers'> & {
-    /** Store headers as an object to match what we had with axios */
-    headers: Record<string, string>;
-    /** Keys of headers which set cookies */
-    cookieHeaderKeys: string[];
-    /** Time in ms the request took */
-    duration: number;
-    /** The response data */
-    data: unknown;
-};
-/** A single request/response set to save to the history stack */
-export type RequestEvent = {
-    request: RequestExample;
-    response: ResponseInstance;
-    timestamp: number;
-};
-declare const requestSchema: z.ZodObject<{
-    path: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-    method: z.ZodDefault<z.ZodOptional<z.ZodEnum<["GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS"]>>>;
-    uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-    ref: z.ZodDefault<z.ZodNullable<z.ZodObject<{
-        path: z.ZodString;
-        collectionRef: z.ZodOptional<z.ZodString>;
-        isExternal: z.ZodBoolean;
-    }, "strip", z.ZodTypeAny, {
-        path: string;
-        isExternal: boolean;
-        collectionRef?: string | undefined;
-    }, {
-        path: string;
-        isExternal: boolean;
-        collectionRef?: string | undefined;
-    }>>>;
-    /**
-     * A list of tags for API documentation control. Tags can be used for logical
-     * grouping of operations by resources or any other qualifier.
-     */
-    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    /** A short summary of what the operation does. */
-    summary: z.ZodOptional<z.ZodString>;
-    /** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */
-    description: z.ZodOptional<z.ZodString>;
-    /**
-     * Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
-     * The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an
-     * operation, therefore, it is RECOMMENDED to follow bin common programming naming conventions./
-     */
-    operationId: z.ZodOptional<z.ZodString>;
-    parameters: z.ZodDefault<z.ZodObject<{
-        path: z.ZodRecord<z.ZodString, z.ZodAny>;
-        query: z.ZodRecord<z.ZodString, z.ZodAny>;
-        headers: z.ZodRecord<z.ZodString, z.ZodAny>;
-        cookies: z.ZodRecord<z.ZodString, z.ZodAny>;
-    }, "strip", z.ZodTypeAny, {
-        path: Record<string, any>;
-        query: Record<string, any>;
-        headers: Record<string, any>;
-        cookies: Record<string, any>;
-    }, {
-        path: Record<string, any>;
-        query: Record<string, any>;
-        headers: Record<string, any>;
-        cookies: Record<string, any>;
-    }>>;
-    /**
-     * A declaration of which security mechanisms can be used across the API. The list of
-     * values includes alternative security requirement objects that can be used. Only
-     * one of the security requirement objects need to be satisfied to authorize a request.
-     * Individual operations can override this definition. To make security optional, an empty
-     * security requirement ({}) can be included in the array.
-     */
-    security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>>, "many">>;
-    /** Security schemes which have been created specifically for this request */
-    securitySchemeUids: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>>;
-    /** The currently selected security schemes at the request level */
-    selectedSecuritySchemeUids: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
-    /**
-     * The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the
-     * HTTP 1.1 specification [RFC7231] has explicitly defined semantics for request bodies. In other cases where the
-     * HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined
-     * semantics and SHOULD be avoided if possible.
-     */
-    requestBody: z.ZodOptional<z.ZodAny>;
-    /** Ordered exampleUids for the sidenav */
-    childUids: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
-    history: z.ZodDefault<z.ZodArray<z.ZodAny, "many">>;
-}, "strip", z.ZodTypeAny, {
-    path: string;
-    uid: string;
-    childUids: string[];
-    parameters: {
-        path: Record<string, any>;
-        query: Record<string, any>;
-        headers: Record<string, any>;
-        cookies: Record<string, any>;
-    };
-    method: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS";
-    ref: {
-        path: string;
-        isExternal: boolean;
-        collectionRef?: string | undefined;
-    } | null;
-    securitySchemeUids: string[];
-    selectedSecuritySchemeUids: string[];
-    history: any[];
-    description?: string | undefined;
-    summary?: string | undefined;
-    security?: Record<string, string[]>[] | undefined;
-    tags?: string[] | undefined;
-    operationId?: string | undefined;
-    requestBody?: any;
-}, {
-    path?: string | undefined;
-    uid?: string | undefined;
-    description?: string | undefined;
-    summary?: string | undefined;
-    security?: Record<string, string[] | undefined>[] | undefined;
-    tags?: string[] | undefined;
-    childUids?: (string | undefined)[] | undefined;
-    parameters?: {
-        path: Record<string, any>;
-        query: Record<string, any>;
-        headers: Record<string, any>;
-        cookies: Record<string, any>;
-    } | undefined;
-    method?: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS" | undefined;
-    ref?: {
-        path: string;
-        isExternal: boolean;
-        collectionRef?: string | undefined;
-    } | null | undefined;
-    operationId?: string | undefined;
-    securitySchemeUids?: (string | undefined)[] | undefined;
-    selectedSecuritySchemeUids?: (string | undefined)[] | undefined;
-    requestBody?: any;
-    history?: any[] | undefined;
-}>;
-/**
- * Each operation in an OpenAPI file will correspond with a single request
- *
- * @see https://spec.openapis.org/oas/v3.1.0#operation-object
- */
-export type Request = z.infer<typeof requestSchema> & {
-    externalDocs?: OpenAPIV3_1.ExternalDocumentationObject;
-};
-export type RequestPayload = z.input<typeof requestSchema> & {
-    externalDocs?: OpenAPIV3_1.ExternalDocumentationObject;
-};
-/** Create request helper */
-export declare const createRequest: (payload: RequestPayload) => {
-    path: string;
-    uid: string;
-    childUids: string[];
-    parameters: {
-        path: Record<string, any>;
-        query: Record<string, any>;
-        headers: Record<string, any>;
-        cookies: Record<string, any>;
-    };
-    method: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS";
-    ref: {
-        path: string;
-        isExternal: boolean;
-        collectionRef?: string | undefined;
-    } | null;
-    securitySchemeUids: string[];
-    selectedSecuritySchemeUids: string[];
-    history: any[];
-    description?: string | undefined;
-    summary?: string | undefined;
-    security?: Record<string, string[]>[] | undefined;
-    tags?: string[] | undefined;
-    operationId?: string | undefined;
-    requestBody?: any;
-};
-export {};
-//# sourceMappingURL=requests.d.ts.map

package/dist/entities/workspace/spec/requests.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/requests.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACzD,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,wBAAwB;IACxB,IAAI,EAAE,OAAO,CAAA;CACd,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAQD,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;IAQjB;;;OAGG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;;;;;;;;;;;;;;;;;IAUH;;;;;;OAMG;;IAEH,6EAA6E;;IAE7E,mEAAmE;;IAEnE;;;;;OAKG;;IAEH,0CAA0C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG1C,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IACpD,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AACD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IAC3D,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AAED,4BAA4B;AAC5B,eAAO,MAAM,aAAa,YAAa,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;CACY,CAAA"}

package/dist/entities/workspace/spec/spec.d.ts

@@ -1,18 +0,0 @@
-import { z } from 'zod';
-export type TagObject = {
-    name: string;
-    /** Optional CommonMark Description */
-    description?: string;
-    externalDocs?: object;
-};
-export declare const tagObjectSchema: z.ZodObject<{
-    name: z.ZodString;
-    description: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    description?: string | undefined;
-}, {
-    name: string;
-    description?: string | undefined;
-}>;
-//# sourceMappingURL=spec.d.ts.map

package/dist/entities/workspace/spec/spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"spec.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvC,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,sCAAsC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,eAAO,MAAM,eAAe;;;;;;;;;EAGK,CAAA"}

package/dist/entities/workspace/spec/spec.js

@@ -1,8 +0,0 @@
-import { z } from 'zod';
-
-const tagObjectSchema = z.object({
-    name: z.string().min(1),
-    description: z.string().optional(),
-});
-
-export { tagObjectSchema };