@scalar/oas-utils 0.2.75 → 0.2.76

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @scalar/oas-utils
 
+## 0.2.76
+
+### Patch Changes
+
+- 6894b7d: feat: passes omitEmptyAndOptionalProperties from operation
+- c87353e: Add serialization back to OpenAPI spec for custom entities
+
 ## 0.2.75
 
 ### Patch Changes

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

@@ -1,4 +1,226 @@
 import { z } from 'zod';
+export declare const oasCollectionSchema: z.ZodObject<{
+    /**
+     * @deprecated
+     *
+     * Needs to be remove as it is not a spec property
+     */
+    type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"collection">>>;
+    openapi: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodLiteral<"3.0.0">, z.ZodLiteral<"3.1.0">, z.ZodLiteral<"4.0.0">]>>>;
+    jsonSchemaDialect: z.ZodOptional<z.ZodString>;
+    info: z.ZodOptional<z.ZodObject<{
+        title: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        summary: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        termsOfService: z.ZodOptional<z.ZodString>;
+        contact: z.ZodOptional<z.ZodObject<{
+            name: z.ZodOptional<z.ZodString>;
+            url: z.ZodOptional<z.ZodString>;
+            email: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            name?: string | undefined;
+            url?: string | undefined;
+            email?: string | undefined;
+        }, {
+            name?: string | undefined;
+            url?: string | undefined;
+            email?: string | undefined;
+        }>>;
+        license: z.ZodOptional<z.ZodObject<{
+            name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            identifier: z.ZodOptional<z.ZodString>;
+            url: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            identifier?: string | undefined;
+            url?: string | undefined;
+        }, {
+            name?: string | undefined;
+            identifier?: string | undefined;
+            url?: string | undefined;
+        }>>;
+        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        version: string;
+        description?: string | undefined;
+        summary?: string | undefined;
+        termsOfService?: string | undefined;
+        contact?: {
+            name?: string | undefined;
+            url?: string | undefined;
+            email?: string | undefined;
+        } | undefined;
+        license?: {
+            name: string;
+            identifier?: string | undefined;
+            url?: string | undefined;
+        } | undefined;
+    }, {
+        description?: string | undefined;
+        title?: string | undefined;
+        summary?: string | undefined;
+        termsOfService?: string | undefined;
+        contact?: {
+            name?: string | undefined;
+            url?: string | undefined;
+            email?: string | undefined;
+        } | undefined;
+        license?: {
+            name?: string | undefined;
+            identifier?: string | undefined;
+            url?: string | undefined;
+        } | undefined;
+        version?: string | undefined;
+    }>>;
+    /**
+     * 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.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>>, "many">>>;
+    externalDocs: z.ZodOptional<z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+        url: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        description?: string | undefined;
+    }, {
+        description?: string | undefined;
+        url?: string | undefined;
+    }>>;
+    /** TODO: Type these */
+    components: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    /** TODO: Type these */
+    webhooks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    /** A custom icon representing the collection */
+    'x-scalar-icon': z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    'x-scalar-environment': z.ZodOptional<z.ZodString>;
+    'x-scalar-environments': z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+        color: z.ZodOptional<z.ZodString>;
+        variables: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
+            description: z.ZodOptional<z.ZodString>;
+            default: z.ZodDefault<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            default: string;
+            description?: string | undefined;
+        }, {
+            default?: string | undefined;
+            description?: string | undefined;
+        }>, z.ZodString]>>;
+    }, "strip", z.ZodTypeAny, {
+        variables: Record<string, string | {
+            default: string;
+            description?: string | undefined;
+        }>;
+        description?: string | undefined;
+        color?: string | undefined;
+    }, {
+        variables: Record<string, string | {
+            default?: string | undefined;
+            description?: string | undefined;
+        }>;
+        description?: string | undefined;
+        color?: string | undefined;
+    }>>>;
+    'x-scalar-secrets': z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+        example: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        description?: string | undefined;
+        example?: string | undefined;
+    }, {
+        description?: string | undefined;
+        example?: string | undefined;
+    }>>>;
+}, "strip", z.ZodTypeAny, {
+    type: "collection";
+    openapi: string;
+    security: Record<string, string[]>[];
+    'x-scalar-icon': string;
+    externalDocs?: {
+        url: string;
+        description?: string | undefined;
+    } | undefined;
+    jsonSchemaDialect?: string | undefined;
+    info?: {
+        title: string;
+        version: string;
+        description?: string | undefined;
+        summary?: string | undefined;
+        termsOfService?: string | undefined;
+        contact?: {
+            name?: string | undefined;
+            url?: string | undefined;
+            email?: string | undefined;
+        } | undefined;
+        license?: {
+            name: string;
+            identifier?: string | undefined;
+            url?: string | undefined;
+        } | undefined;
+    } | undefined;
+    components?: Record<string, unknown> | undefined;
+    webhooks?: Record<string, unknown> | undefined;
+    'x-scalar-environment'?: string | undefined;
+    'x-scalar-environments'?: Record<string, {
+        variables: Record<string, string | {
+            default: string;
+            description?: string | undefined;
+        }>;
+        description?: string | undefined;
+        color?: string | undefined;
+    }> | undefined;
+    'x-scalar-secrets'?: Record<string, {
+        description?: string | undefined;
+        example?: string | undefined;
+    }> | undefined;
+}, {
+    type?: "collection" | undefined;
+    externalDocs?: {
+        description?: string | undefined;
+        url?: string | undefined;
+    } | undefined;
+    openapi?: string | undefined;
+    jsonSchemaDialect?: string | undefined;
+    info?: {
+        description?: string | undefined;
+        title?: string | undefined;
+        summary?: string | undefined;
+        termsOfService?: string | undefined;
+        contact?: {
+            name?: string | undefined;
+            url?: string | undefined;
+            email?: string | undefined;
+        } | undefined;
+        license?: {
+            name?: string | undefined;
+            identifier?: string | undefined;
+            url?: string | undefined;
+        } | undefined;
+        version?: string | undefined;
+    } | undefined;
+    security?: Record<string, string[] | undefined>[] | undefined;
+    components?: Record<string, unknown> | undefined;
+    webhooks?: Record<string, unknown> | undefined;
+    'x-scalar-icon'?: string | undefined;
+    'x-scalar-environment'?: string | undefined;
+    'x-scalar-environments'?: Record<string, {
+        variables: Record<string, string | {
+            default?: string | undefined;
+            description?: string | undefined;
+        }>;
+        description?: string | undefined;
+        color?: string | undefined;
+    }> | undefined;
+    'x-scalar-secrets'?: Record<string, {
+        description?: string | undefined;
+        example?: string | undefined;
+    }> | undefined;
+}>;
 export declare const extendedCollectionSchema: z.ZodObject<{
     uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     /** A list of security schemes UIDs associated with the collection */
@@ -198,6 +420,11 @@ export declare const extendedCollectionSchema: z.ZodObject<{
     watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
 }>;
 export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
+    /**
+     * @deprecated
+     *
+     * Needs to be remove as it is not a spec property
+     */
     type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"collection">>>;
     openapi: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodLiteral<"3.0.0">, z.ZodLiteral<"3.1.0">, z.ZodLiteral<"4.0.0">]>>>;
     jsonSchemaDialect: z.ZodOptional<z.ZodString>;
@@ -290,6 +517,45 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
     webhooks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     /** A custom icon representing the collection */
     'x-scalar-icon': z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    'x-scalar-environment': z.ZodOptional<z.ZodString>;
+    'x-scalar-environments': z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+        color: z.ZodOptional<z.ZodString>;
+        variables: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
+            description: z.ZodOptional<z.ZodString>;
+            default: z.ZodDefault<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            default: string;
+            description?: string | undefined;
+        }, {
+            default?: string | undefined;
+            description?: string | undefined;
+        }>, z.ZodString]>>;
+    }, "strip", z.ZodTypeAny, {
+        variables: Record<string, string | {
+            default: string;
+            description?: string | undefined;
+        }>;
+        description?: string | undefined;
+        color?: string | undefined;
+    }, {
+        variables: Record<string, string | {
+            default?: string | undefined;
+            description?: string | undefined;
+        }>;
+        description?: string | undefined;
+        color?: string | undefined;
+    }>>>;
+    'x-scalar-secrets': z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+        example: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        description?: string | undefined;
+        example?: string | undefined;
+    }, {
+        description?: string | undefined;
+        example?: string | undefined;
+    }>>>;
 }, {
     uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     /** A list of security schemes UIDs associated with the collection */
@@ -473,6 +739,19 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
     } | undefined;
     components?: Record<string, unknown> | undefined;
     webhooks?: Record<string, unknown> | undefined;
+    'x-scalar-environment'?: string | undefined;
+    'x-scalar-environments'?: Record<string, {
+        variables: Record<string, string | {
+            default: string;
+            description?: string | undefined;
+        }>;
+        description?: string | undefined;
+        color?: string | undefined;
+    }> | undefined;
+    'x-scalar-secrets'?: Record<string, {
+        description?: string | undefined;
+        example?: string | undefined;
+    }> | undefined;
     documentUrl?: string | undefined;
     integration?: string | null | undefined;
 }, {
@@ -506,6 +785,19 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
     components?: Record<string, unknown> | undefined;
     webhooks?: Record<string, unknown> | undefined;
     'x-scalar-icon'?: string | undefined;
+    'x-scalar-environment'?: string | undefined;
+    'x-scalar-environments'?: Record<string, {
+        variables: Record<string, string | {
+            default?: string | undefined;
+            description?: string | undefined;
+        }>;
+        description?: string | undefined;
+        color?: string | undefined;
+    }> | undefined;
+    'x-scalar-secrets'?: Record<string, {
+        description?: string | undefined;
+        example?: string | undefined;
+    }> | undefined;
     securitySchemes?: string[] | undefined;
     selectedSecuritySchemeUids?: (string | undefined)[] | undefined;
     selectedServerUid?: string | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/collection.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAyCvB,eAAO,MAAM,wBAAwB;;IAEnC,qEAAqE;;IAErE,2FAA2F;;IAE3F,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH,wGAAwG;;IAExG;;;;OAIG;;IAEH,kFAAkF;;IAElF;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKH,CAAA;AAEF,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAnE3B;;;;;;OAMG;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;IAYhD,qEAAqE;;IAErE,2FAA2F;;IAE3F,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH,wGAAwG;;IAExG;;;;OAIG;;IAEH,kFAAkF;;IAElF;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASJ,CAAA;AACD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AACzD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}
+{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/collection.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAKvB,eAAO,MAAM,mBAAmB;IAC9B;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAaH;;;;;;OAMG;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWhD,CAAA;AAEF,eAAO,MAAM,wBAAwB;;IAEnC,qEAAqE;;IAErE,2FAA2F;;IAE3F,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH,wGAAwG;;IAExG;;;;OAIG;;IAEH,kFAAkF;;IAElF;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKH,CAAA;AAEF,eAAO,MAAM,gBAAgB;IAvF3B;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAaH;;;;;;OAMG;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAehD,qEAAqE;;IAErE,2FAA2F;;IAE3F,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH,wGAAwG;;IAExG;;;;OAIG;;IAEH,kFAAkF;;IAElF;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASJ,CAAA;AACD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AACzD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}

package/dist/entities/spec/collection.js

@@ -1,9 +1,16 @@
 import { oasSecurityRequirementSchema, securitySchemeExampleValueSchema } from './security.js';
+import { xScalarEnvironmentsSchema } from './x-scalar-environments.js';
+import { xScalarSecretsSchema } from './x-scalar-secrets.js';
 import { z } from 'zod';
 import { oasInfoSchema, oasExternalDocumentationSchema } from './spec-objects.js';
 import { nanoidSchema } from '../shared/utility.js';
 
 const oasCollectionSchema = z.object({
+    /**
+     * @deprecated
+     *
+     * Needs to be remove as it is not a spec property
+     */
     'type': z.literal('collection').optional().default('collection'),
     'openapi': z
         .union([
@@ -31,6 +38,9 @@ const oasCollectionSchema = z.object({
     'webhooks': z.record(z.string(), z.unknown()).optional(),
     /** A custom icon representing the collection */
     'x-scalar-icon': z.string().optional().default('interface-content-folder'),
+    'x-scalar-environment': z.string().optional(),
+    'x-scalar-environments': xScalarEnvironmentsSchema.optional(),
+    'x-scalar-secrets': xScalarSecretsSchema.optional(),
     // These properties will be stripped out and mapped back as id lists
     // servers
     // paths/**
@@ -83,4 +93,4 @@ const extendedCollectionSchema = z.object({
 });
 const collectionSchema = oasCollectionSchema.merge(extendedCollectionSchema);
 
-export { collectionSchema, extendedCollectionSchema };
+export { collectionSchema, extendedCollectionSchema, oasCollectionSchema };

package/dist/entities/spec/index.js

@@ -1,7 +1,7 @@
-export { collectionSchema, extendedCollectionSchema } from './collection.js';
+export { collectionSchema, extendedCollectionSchema, oasCollectionSchema } from './collection.js';
 export { oasServerSchema, oasServerVariableSchema, serverSchema } from './server.js';
 export { oasRequestSchema, requestMethods, requestSchema } from './requests.js';
-export { createExampleFromRequest, createParamInstance, exampleRequestBodyEncoding, exampleRequestBodySchema, requestExampleParametersSchema, requestExampleSchema } from './request-examples.js';
+export { convertExampleToXScalar, createExampleFromRequest, createParamInstance, exampleBodyMime, exampleRequestBodyEncoding, exampleRequestBodySchema, requestExampleParametersSchema, requestExampleSchema, xScalarExampleBodySchema, xScalarExampleSchema, xScalarFileValueSchema, xScalarFormDataValue } from './request-examples.js';
 export { oasContactSchema, oasExternalDocumentationSchema, oasInfoSchema, oasLicenseSchema, oasTagSchema, tagSchema, xScalarNestedSchema } from './spec-objects.js';
 export { oasParameterSchema, parameterStyleSchema, parameterTypeSchema } from './parameters.js';
 export { authExampleFromSchema, oasOauthFlowSchema, oasSecurityRequirementSchema, oasSecuritySchemeSchema, pkceOptions, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeApiKeyIn, securitySchemeExampleValueSchema, securitySchemeSchema } from './security.js';

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

@@ -35,10 +35,10 @@ export declare const oasParameterSchema: z.ZodObject<{
     in: "path" | "query" | "header" | "cookie";
     deprecated: boolean;
     description?: string | undefined;
+    example?: unknown;
     schema?: unknown;
     content?: unknown;
     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
-    example?: unknown;
     examples?: Record<string, {
         value?: unknown;
         summary?: string | undefined;
@@ -48,11 +48,11 @@ export declare const oasParameterSchema: z.ZodObject<{
     in: "path" | "query" | "header" | "cookie";
     required?: boolean | undefined;
     description?: string | undefined;
+    example?: unknown;
     deprecated?: boolean | undefined;
     schema?: unknown;
     content?: unknown;
     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
-    example?: unknown;
     examples?: Record<string, {
         value?: unknown;
         summary?: string | undefined;