@scalar/oas-utils 0.2.75 → 0.2.76

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

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,KAAK,SAAS,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvC;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,EAc9B,SAAS,CACb,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,GAAG;IAC/C,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAA;CAC7B,CACF,CAAA;AAED,eAAO,MAAM,eAAe;IAC1B;;;;OAIG;;IAEH;;;OAGG;;IAEH,oHAAoH;;eAhB3G,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;eAArB,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;;;;;eAArB,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;;;;;eAArB,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;EAkBgB,CAAA;AAEhD,eAAO,MAAM,YAAY;IAfvB;;;;OAIG;;IAEH;;;OAGG;;IAEH,oHAAoH;;eAhB3G,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;eAArB,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;;;;;;;;eAArB,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;;;;;;eAArB,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;EAsB9B,CAAA;AAEF,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;AACjD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,KAAK,SAAS,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvC;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,EAc9B,SAAS,CACb,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,GAAG;IAC/C,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAA;CAC7B,CACF,CAAA;AAED,eAAO,MAAM,eAAe;IAC1B;;;;OAIG;;IAEH;;;OAGG;;IAEH,oHAAoH;;eAhB3G,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;eAArB,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;;;;;eAArB,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;;;;eAArB,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;;EAkBgB,CAAA;AAEhD,eAAO,MAAM,YAAY;IAfvB;;;;OAIG;;IAEH;;;OAGG;;IAEH,oHAAoH;;eAhB3G,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;eAArB,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;;;;;;;;eAArB,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;;;;;eAArB,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;;;EAsB9B,CAAA;AAEF,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;AACjD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA"}

package/dist/entities/spec/spec-objects.d.ts

@@ -170,6 +170,11 @@ export declare const xScalarNestedSchema: z.ZodArray<z.ZodObject<{
  * @see https://spec.openapis.org/oas/latest.html#tag-object
  */
 export declare const oasTagSchema: z.ZodObject<{
+    /**
+     * @deprecated
+     *
+     * Needs to be remove as it is not a spec property
+     */
     type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"tag">>>;
     /** REQUIRED. The name of the tag. */
     name: z.ZodString;
@@ -188,24 +193,24 @@ export declare const oasTagSchema: z.ZodObject<{
         description?: string | undefined;
         url?: string | undefined;
     }>>;
-    'x-scalar-children': z.ZodDefault<z.ZodArray<z.ZodObject<{
+    'x-scalar-children': z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
         tagName: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         tagName: string;
     }, {
         tagName: string;
-    }>, "many">>;
+    }>, "many">>>;
 }, "strip", z.ZodTypeAny, {
     type: "tag";
     name: string;
-    'x-scalar-children': {
-        tagName: string;
-    }[];
     description?: string | undefined;
     externalDocs?: {
         url: string;
         description?: string | undefined;
     } | undefined;
+    'x-scalar-children'?: {
+        tagName: string;
+    }[] | undefined;
 }, {
     name: string;
     type?: "tag" | undefined;
@@ -219,6 +224,11 @@ export declare const oasTagSchema: z.ZodObject<{
     }[] | undefined;
 }>;
 export declare const tagSchema: z.ZodObject<z.objectUtil.extendShape<{
+    /**
+     * @deprecated
+     *
+     * Needs to be remove as it is not a spec property
+     */
     type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"tag">>>;
     /** REQUIRED. The name of the tag. */
     name: z.ZodString;
@@ -237,13 +247,13 @@ export declare const tagSchema: z.ZodObject<z.objectUtil.extendShape<{
         description?: string | undefined;
         url?: string | undefined;
     }>>;
-    'x-scalar-children': z.ZodDefault<z.ZodArray<z.ZodObject<{
+    'x-scalar-children': z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
         tagName: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         tagName: string;
     }, {
         tagName: string;
-    }>, "many">>;
+    }>, "many">>>;
 }, {
     uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     children: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
@@ -251,15 +261,15 @@ export declare const tagSchema: z.ZodObject<z.objectUtil.extendShape<{
     type: "tag";
     uid: string;
     name: string;
-    'x-scalar-children': {
-        tagName: string;
-    }[];
     children: string[];
     description?: string | undefined;
     externalDocs?: {
         url: string;
         description?: string | undefined;
     } | undefined;
+    'x-scalar-children'?: {
+        tagName: string;
+    }[] | undefined;
 }, {
     name: string;
     type?: "tag" | undefined;

package/dist/entities/spec/spec-objects.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"spec-objects.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/spec-objects.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;IAC3B,mDAAmD;;IAEnD,2GAA2G;;IAE3G;;;OAGG;;;;;;;;;;EAEH,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB;IAC3B,+DAA+D;;IAE/D,sFAAsF;;IAEtF,0GAA0G;;;;;;;;;;EAE1G,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;IACxB,sCAAsC;;IAEtC,kCAAkC;;IAElC,4FAA4F;;IAE5F,oFAAoF;;IAEpF,mDAAmD;;QAxBnD,+DAA+D;;QAE/D,sFAAsF;;QAEtF,0GAA0G;;;;;;;;;;;IAsB1G,mDAAmD;;QA5CnD,mDAAmD;;QAEnD,2GAA2G;;QAE3G;;;WAGG;;;;;;;;;;;IAuCH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B;IACzC,6GAA6G;;IAE7G,yFAAyF;;;;;;;;EAEzF,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CACzC,OAAO,8BAA8B,CACtC,CAAA;AAED,eAAO,MAAM,mBAAmB;;;;;;WAItB,CAAA;AAEV;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;;IAEvB,qCAAqC;;IAErC,6FAA6F;;IAE7F,sDAAsD;;QA5BtD,6GAA6G;;QAE7G,yFAAyF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6BzF,CAAA;AAEF,eAAO,MAAM,SAAS;;IATpB,qCAAqC;;IAErC,6FAA6F;;IAE7F,sDAAsD;;QA5BtD,6GAA6G;;QAE7G,yFAAyF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkCzF,CAAA;AAEF,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA;AAC3C,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA"}
+{"version":3,"file":"spec-objects.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/spec-objects.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;IAC3B,mDAAmD;;IAEnD,2GAA2G;;IAE3G;;;OAGG;;;;;;;;;;EAEH,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB;IAC3B,+DAA+D;;IAE/D,sFAAsF;;IAEtF,0GAA0G;;;;;;;;;;EAE1G,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;IACxB,sCAAsC;;IAEtC,kCAAkC;;IAElC,4FAA4F;;IAE5F,oFAAoF;;IAEpF,mDAAmD;;QAxBnD,+DAA+D;;QAE/D,sFAAsF;;QAEtF,0GAA0G;;;;;;;;;;;IAsB1G,mDAAmD;;QA5CnD,mDAAmD;;QAEnD,2GAA2G;;QAE3G;;;WAGG;;;;;;;;;;;IAuCH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B;IACzC,6GAA6G;;IAE7G,yFAAyF;;;;;;;;EAEzF,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CACzC,OAAO,8BAA8B,CACtC,CAAA;AAED,eAAO,MAAM,mBAAmB;;;;;;WAItB,CAAA;AAEV;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;IACvB;;;;OAIG;;IAEH,qCAAqC;;IAErC,6FAA6F;;IAE7F,sDAAsD;;QAjCtD,6GAA6G;;QAE7G,yFAAyF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkCzF,CAAA;AAEF,eAAO,MAAM,SAAS;IAfpB;;;;OAIG;;IAEH,qCAAqC;;IAErC,6FAA6F;;IAE7F,sDAAsD;;QAjCtD,6GAA6G;;QAE7G,yFAAyF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuCzF,CAAA;AAEF,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA;AAC3C,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA"}

package/dist/entities/spec/spec-objects.js

@@ -82,6 +82,11 @@ const xScalarNestedSchema = z
  * @see https://spec.openapis.org/oas/latest.html#tag-object
  */
 const oasTagSchema = z.object({
+    /**
+     * @deprecated
+     *
+     * Needs to be remove as it is not a spec property
+     */
     'type': z.literal('tag').optional().default('tag'),
     /** REQUIRED. The name of the tag. */
     'name': z.string(),
@@ -89,7 +94,7 @@ const oasTagSchema = z.object({
     'description': z.string().optional(),
     /** Additional external documentation for this tag. */
     'externalDocs': oasExternalDocumentationSchema.optional(),
-    'x-scalar-children': xScalarNestedSchema.default([]),
+    'x-scalar-children': xScalarNestedSchema.default([]).optional(),
 });
 const tagSchema = oasTagSchema.extend({
     uid: nanoidSchema,

package/dist/entities/spec/x-scalar-environments.d.ts

@@ -0,0 +1,74 @@
+import { z } from 'zod';
+export type XScalarEnvVar = z.infer<typeof xScalarEnvVarSchema>;
+export declare const xScalarEnvVarSchema: 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]>;
+export declare const xScalarEnvironmentSchema: z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+    color: z.ZodOptional<z.ZodString>;
+    /** A map of variables by name */
+    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;
+}>;
+/** A map of environments by name */
+export declare const xScalarEnvironmentsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+    color: z.ZodOptional<z.ZodString>;
+    /** A map of variables by name */
+    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;
+}>>;
+export type XScalarEnvironment = z.infer<typeof xScalarEnvironmentSchema>;
+export type XScalarEnvironments = z.infer<typeof xScalarEnvironmentsSchema>;
+//# sourceMappingURL=x-scalar-environments.d.ts.map

package/dist/entities/spec/x-scalar-environments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"x-scalar-environments.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/x-scalar-environments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE/D,eAAO,MAAM,mBAAmB;;;;;;;;;iBAM9B,CAAA;AAEF,eAAO,MAAM,wBAAwB;;;IAGnC,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;EAEjC,CAAA;AAEF,oCAAoC;AACpC,eAAO,MAAM,yBAAyB;;;IALpC,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;GAUlC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AACzE,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA"}

package/dist/entities/spec/x-scalar-environments.js

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+
+const xScalarEnvVarSchema = z.union([
+    z.object({
+        description: z.string().optional(),
+        default: z.string().default(''),
+    }),
+    z.string(),
+]);
+const xScalarEnvironmentSchema = z.object({
+    description: z.string().optional(),
+    color: z.string().optional(),
+    /** A map of variables by name */
+    variables: z.record(z.string(), xScalarEnvVarSchema),
+});
+/** A map of environments by name */
+const xScalarEnvironmentsSchema = z.record(
+/** Name */
+z.string(), 
+/** Environment definition */
+xScalarEnvironmentSchema);
+
+export { xScalarEnvVarSchema, xScalarEnvironmentSchema, xScalarEnvironmentsSchema };

package/dist/entities/spec/x-scalar-secrets.d.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+export declare const xScalarSecretVarSchema: 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;
+}>;
+export declare const xScalarSecretsSchema: 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;
+}>>;
+export type XScalarSecrets = z.infer<typeof xScalarSecretsSchema>;
+//# sourceMappingURL=x-scalar-secrets.d.ts.map

package/dist/entities/spec/x-scalar-secrets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"x-scalar-secrets.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/x-scalar-secrets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,sBAAsB;;;;;;;;;EAGjC,CAAA;AAEF,eAAO,MAAM,oBAAoB;;;;;;;;;GAA+C,CAAA;AAEhF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA"}

package/dist/entities/spec/x-scalar-secrets.js

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+
+const xScalarSecretVarSchema = z.object({
+    description: z.string().optional(),
+    example: z.string().optional(),
+});
+const xScalarSecretsSchema = z.record(z.string(), xScalarSecretVarSchema);
+
+export { xScalarSecretVarSchema, xScalarSecretsSchema };

package/dist/migrations/v-2.1.0/migration.d.ts

@@ -200,10 +200,10 @@ export declare const migrate_v_2_1_0: (data: Omit<v_0_0_0.Data, "folders">) => {
             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;

package/dist/spec-getters/getExampleFromSchema.d.ts

@@ -23,6 +23,7 @@ export declare const getExampleFromSchema: (schema: Record<string, any>, options
     variables?: Record<string, any>;
     /**
      * Whether to omit empty and optional properties.
+     * @default false
      */
     omitEmptyAndOptionalProperties?: boolean;
 }, level?: number, parentSchema?: Record<string, any>, name?: string) => any;

package/dist/spec-getters/getExampleFromSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getExampleFromSchema.ts"],"names":[],"mappings":"AAyDA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/B;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAA;CACzC,UACM,MAAM,iBACE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,SAC3B,MAAM,KACZ,GAqTF,CAAA"}
+{"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getExampleFromSchema.ts"],"names":[],"mappings":"AAyDA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/B;;;OAGG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAA;CACzC,UACM,MAAM,iBACE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,SAC3B,MAAM,KACZ,GAqTF,CAAA"}

package/dist/spec-getters/getRequestBodyFromOperation.d.ts

@@ -3,7 +3,7 @@ declare const mimeTypes: readonly ["application/json", "application/octet-stream
 /**
  * Get the request body from the operation.
  */
-export declare function getRequestBodyFromOperation(operation: Omit<TransformedOperation, 'httpVerb'>, selectedExampleKey?: string | number): {
+export declare function getRequestBodyFromOperation(operation: Omit<TransformedOperation, 'httpVerb'>, selectedExampleKey?: string | number, omitEmptyAndOptionalProperties?: boolean): {
     headers?: {
         name: string;
         value: string;

package/dist/spec-getters/getRequestBodyFromOperation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getRequestBodyFromOperation.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getRequestBodyFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAe,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAgC7E,QAAA,MAAM,SAAS,wJAOL,CAAA;AAEV;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC,EACjD,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,GACnC;IACD,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC3C,IAAI,CAAC,EAAE;QACL,QAAQ,EAAE,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAA;QACpC,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE;YACP,IAAI,EAAE,MAAM,CAAA;YACZ,KAAK,CAAC,EAAE,MAAM,CAAA;SACf,EAAE,CAAA;KACJ,CAAA;CACF,GAAG,IAAI,CAgNP"}
+{"version":3,"file":"getRequestBodyFromOperation.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getRequestBodyFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAe,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAgC7E,QAAA,MAAM,SAAS,wJAOL,CAAA;AAEV;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC,EACjD,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,EACpC,8BAA8B,CAAC,EAAE,OAAO,GACvC;IACD,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC3C,IAAI,CAAC,EAAE;QACL,QAAQ,EAAE,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAA;QACpC,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE;YACP,IAAI,EAAE,MAAM,CAAA;YACZ,KAAK,CAAC,EAAE,MAAM,CAAA;SACf,EAAE,CAAA;KACJ,CAAA;CACF,GAAG,IAAI,CA6MP"}

package/dist/spec-getters/getRequestBodyFromOperation.js

@@ -29,7 +29,7 @@ const mimeTypes = [
 /**
  * Get the request body from the operation.
  */
-function getRequestBodyFromOperation(operation, selectedExampleKey) {
+function getRequestBodyFromOperation(operation, selectedExampleKey, omitEmptyAndOptionalProperties) {
     // Get the content object from the operation
     const originalContent = operation.information?.requestBody?.content;
     const content = normalizeMimeTypeObject(originalContent);
@@ -127,7 +127,7 @@ function getRequestBodyFromOperation(operation, selectedExampleKey) {
         const exampleFromSchema = requestBodyObject?.schema
             ? getExampleFromSchema(requestBodyObject?.schema, {
                 mode: 'write',
-                omitEmptyAndOptionalProperties: true,
+                omitEmptyAndOptionalProperties: omitEmptyAndOptionalProperties,
             })
             : null;
         const body = example ?? exampleFromSchema;
@@ -145,7 +145,6 @@ function getRequestBodyFromOperation(operation, selectedExampleKey) {
             ? getExampleFromSchema(requestBodyObject?.schema, {
                 xml: true,
                 mode: 'write',
-                omitEmptyAndOptionalProperties: true,
             })
             : null;
         return {
@@ -172,7 +171,6 @@ function getRequestBodyFromOperation(operation, selectedExampleKey) {
             ? getExampleFromSchema(requestBodyObject?.schema, {
                 xml: true,
                 mode: 'write',
-                omitEmptyAndOptionalProperties: true,
             })
             : null;
         return {
@@ -190,7 +188,6 @@ function getRequestBodyFromOperation(operation, selectedExampleKey) {
             ? getExampleFromSchema(requestBodyObject?.schema, {
                 xml: true,
                 mode: 'write',
-                omitEmptyAndOptionalProperties: true,
             })
             : null;
         return {

package/dist/spec-getters/getRequestFromOperation.d.ts

@@ -6,5 +6,5 @@ export declare const getRequestFromOperation: (operation: TransformedOperation,
      */
     replaceVariables?: boolean;
     requiredOnly?: boolean;
-}, selectedExampleKey?: string | number) => Partial<HarRequestWithPath>;
+}, selectedExampleKey?: string | number, omitEmptyAndOptionalProperties?: boolean) => Partial<HarRequestWithPath>;
 //# sourceMappingURL=getRequestFromOperation.d.ts.map

package/dist/spec-getters/getRequestFromOperation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getRequestFromOperation.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getRequestFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,kBAAkB,EAGlB,oBAAoB,EACrB,MAAM,sBAAsB,CAAA;AAM7B,eAAO,MAAM,uBAAuB,cACvB,oBAAoB,YACrB;IACR;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,uBACoB,MAAM,GAAG,MAAM,KACnC,OAAO,CAAC,kBAAkB,CA4D5B,CAAA"}
+{"version":3,"file":"getRequestFromOperation.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getRequestFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,kBAAkB,EAGlB,oBAAoB,EACrB,MAAM,sBAAsB,CAAA;AAM7B,eAAO,MAAM,uBAAuB,cACvB,oBAAoB,YACrB;IACR;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,uBACoB,MAAM,GAAG,MAAM,mCACH,OAAO,KACvC,OAAO,CAAC,kBAAkB,CAgE5B,CAAA"}

package/dist/spec-getters/getRequestFromOperation.js

@@ -2,7 +2,7 @@ import { getParametersFromOperation } from './getParametersFromOperation.js';
 import { getRequestBodyFromOperation } from './getRequestBodyFromOperation.js';
 import { REGEX } from '../helpers/regexHelpers.js';
 
-const getRequestFromOperation = (operation, options, selectedExampleKey) => {
+const getRequestFromOperation = (operation, options, selectedExampleKey, omitEmptyAndOptionalProperties) => {
     // Replace all variables of the format {something} with the uppercase variable name without the brackets
     let path = operation.path;
     // {id} -> 123
@@ -31,7 +31,7 @@ const getRequestFromOperation = (operation, options, selectedExampleKey) => {
             });
         }
     }
-    const requestBody = getRequestBodyFromOperation(operation, selectedExampleKey);
+    const requestBody = getRequestBodyFromOperation(operation, selectedExampleKey, omitEmptyAndOptionalProperties);
     return {
         method: operation.httpVerb.toUpperCase(),
         path,

package/dist/transforms/export-spec.d.ts

@@ -1,74 +1,17 @@
-import { type Collection, type Request } from '../entities/spec/index.js';
-export declare function exportSpecFromWorkspace({ collection, requests, }: {
+import { type Collection, type Request, type RequestExample, type SecurityScheme, type Tag } from '../entities/spec/index.js';
+import type { OpenAPIV3_1 } from '@scalar/types';
+type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+/**
+ * Convert a workspace collection into an OpenAPI document
+ */
+export declare function exportSpecFromWorkspace({ collection, requests, requestExamples, tags, securitySchemes, }: {
     collection: Collection;
     requests: Record<string, Request>;
-}): {
-    type: "collection";
-    uid: string;
-    children: string[];
-    openapi: string;
-    security: Record<string, string[]>[];
-    'x-scalar-icon': string;
-    securitySchemes: string[];
-    selectedSecuritySchemeUids: string[];
-    selectedServerUid: string;
-    servers: string[];
-    requests: string[];
-    tags: string[];
-    auth: Record<string, {
-        type: "apiKey";
-        value: string;
-        name: string;
-    } | {
-        type: "http";
-        username: string;
-        password: string;
-        token: string;
-    } | {
-        type: "oauth-implicit";
-        token: string;
-    } | {
-        type: "oauth-password";
-        username: string;
-        password: string;
-        token: string;
-        clientSecret: string;
-    } | {
-        type: "oauth-clientCredentials";
-        token: string;
-        clientSecret: string;
-    } | {
-        type: "oauth-authorizationCode";
-        token: string;
-        clientSecret: string;
-    }>;
-    watchMode: boolean;
-    watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
-    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;
-    documentUrl?: string | undefined;
-    integration?: string | null | undefined;
-};
+    requestExamples: Record<string, RequestExample>;
+    tags: Record<string, Tag>;
+    securitySchemes: Record<string, SecurityScheme>;
+}): WithRequired<OpenAPIV3_1.Document<{}>, "paths" | "components" | "tags">;
+export {};
 //# sourceMappingURL=export-spec.d.ts.map

package/dist/transforms/export-spec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"export-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/export-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,OAAO,EAEb,MAAM,iBAAiB,CAAA;AAMxB,wBAAgB,uBAAuB,CAAC,EACtC,UAAU,EACV,QAAQ,GACT,EAAE;IACD,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEA"}
+{"version":3,"file":"export-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/export-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,GAAG,EAMT,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG;KAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAA;AAElE;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,EACtC,UAAU,EACV,QAAQ,EACR,eAAe,EACf,IAAI,EACJ,eAAe,GAChB,EAAE;IACD,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/C,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACzB,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;CAChD,2EAyEA"}

package/dist/transforms/export-spec.js

@@ -0,0 +1,73 @@
+import { oasCollectionSchema } from '../entities/spec/collection.js';
+import { oasTagSchema } from '../entities/spec/spec-objects.js';
+import { oasRequestSchema } from '../entities/spec/requests.js';
+import { convertExampleToXScalar } from '../entities/spec/request-examples.js';
+import { oasSecuritySchemeSchema } from '../entities/spec/security.js';
+
+/**
+ * Convert a workspace collection into an OpenAPI document
+ */
+function exportSpecFromWorkspace({ collection, requests, requestExamples, tags, securitySchemes, }) {
+    const parsedCollection = oasCollectionSchema.parse(collection);
+    const spec = {
+        ...parsedCollection,
+        openapi: parsedCollection.openapi,
+        tags: [],
+        paths: {},
+        webhooks: {},
+        components: {
+            securitySchemes: {},
+        },
+    };
+    /** Add all of the tags into the collection */
+    Object.values(tags).forEach((tag) => {
+        const oasTag = oasTagSchema.parse(tag);
+        if (!oasTag['x-scalar-children']?.length)
+            delete oasTag['x-scalar-children'];
+        spec.tags.push(oasTag);
+    });
+    /** Add all of the requests into the collection as operations */
+    Object.values(requests).forEach((request) => {
+        const oasRequest = oasRequestSchema.parse(request);
+        // Currently the request has tags added by name. Should this move to UID association?
+        oasRequest.tags = request.tags;
+        // If the request has examples we add them all as extensions
+        const exampleNames = new Set();
+        /** Increment non-unique names */
+        function checkName(name) {
+            if (exampleNames.has(name)) {
+                const base = name.split(' ');
+                const end = Number.parseInt(base.at(-1) ?? 'NaN', 10);
+                if (Number.isNaN(end)) {
+                    base.push('1');
+                }
+                else {
+                    base[base.length - 1] = `${end + 1}`;
+                }
+                return checkName(base.join(' '));
+            }
+            exampleNames.add(name);
+            return name;
+        }
+        if (request.examples.length) {
+            oasRequest['x-scalar-examples'] = {};
+            request.examples.forEach((uid) => {
+                const requestExample = requestExamples[uid];
+                oasRequest['x-scalar-examples'][checkName(requestExample.name)] =
+                    convertExampleToXScalar(requestExample);
+            });
+        }
+        /** Insert the request as an operation in the spec */
+        if (!spec.paths[request.path])
+            spec.paths[request.path] = {};
+        spec.paths[request.path][request.method] = oasRequest;
+    });
+    /** Add all of the security schemes into the collection */
+    Object.values(securitySchemes).forEach((securityScheme) => {
+        const oasScheme = oasSecuritySchemeSchema.parse(securityScheme);
+        spec.components.securitySchemes[securityScheme.nameKey] = oasScheme;
+    });
+    return spec;
+}
+
+export { exportSpecFromWorkspace };

package/dist/transforms/import-spec.js

@@ -116,7 +116,7 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
     const start = performance.now();
     const requests = [];
     // Grab the base server URL for relative servers
-    const backupBaseServerUrl = typeof window !== 'undefined' ? window.location.origin : 'http://localhost';
+    const backupBaseServerUrl = typeof window === 'undefined' ? 'http://localhost' : window.location.origin;
     const _baseServerUrl = baseServerURL ?? backupBaseServerUrl;
     // Add the base server url to any relative servers
     const servers = serverSchema.array().parse((overloadServers ?? schema.servers)?.map((s) => {

package/dist/transforms/index.d.ts

@@ -1,2 +1,3 @@
 export * from './import-spec.js';
+export * from './export-spec.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/transforms/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/transforms/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/transforms/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA"}

package/dist/transforms/index.js

@@ -1 +1,2 @@
 export { getBaseAuthValues, importSpecToWorkspace, parseSchema } from './import-spec.js';
+export { exportSpecFromWorkspace } from './export-spec.js';

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.75",
+  "version": "0.2.76",
   "engines": {
     "node": ">=18"
   },
@@ -106,9 +106,9 @@
     "nanoid": "^5.0.7",
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
-    "@scalar/object-utils": "1.1.12",
     "@scalar/openapi-types": "0.1.5",
     "@scalar/themes": "0.9.48",
+    "@scalar/object-utils": "1.1.12",
     "@scalar/types": "0.0.19"
   },
   "devDependencies": {
@@ -116,9 +116,9 @@
     "vite": "^5.4.9",
     "vitest": "^1.6.0",
     "zod-to-ts": "^1.2.0",
+    "@scalar/build-tooling": "0.1.12",
     "@scalar/openapi-types": "0.1.5",
-    "@scalar/openapi-parser": "0.8.9",
-    "@scalar/build-tooling": "0.1.12"
+    "@scalar/openapi-parser": "0.8.9"
   },
   "scripts": {
     "build": "scalar-build-rollup",