@scalar/oas-utils 0.2.106 → 0.2.108

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

@@ -1,108 +1,148 @@
 import { z } from 'zod';
 /**
+ * Removes undefined values from an object.
+ *
+ * Can be used as a transform function for any Zod schema.
+ */
+export declare const omitUndefinedValues: <T extends object>(data: T) => T;
+/**
+ * License Object
+ *
  * License information for the exposed API.
  *
- * @see https://spec.openapis.org/oas/latest.html#license-object
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#license-object
  */
-export declare const oasLicenseSchema: z.ZodObject<{
+export declare const oasLicenseSchema: z.ZodEffects<z.ZodObject<{
     /** REQUIRED. The license name used for the API. */
-    name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    name: z.ZodCatch<z.ZodNullable<z.ZodOptional<z.ZodString>>>;
     /** An SPDX license expression for the API. The identifier field is mutually exclusive of the url field. */
-    identifier: z.ZodOptional<z.ZodString>;
+    identifier: z.ZodCatch<z.ZodOptional<z.ZodString>>;
     /**
-     * A URL to the license used for the API. This MUST be in the form of a URL. The url field
-     * is mutually exclusive of the identifier field.
+     * A URI for the license used for the API. This MUST be in the form of a URI. The url field is mutually exclusive of the identifier field.
      */
-    url: z.ZodOptional<z.ZodString>;
+    url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    name: string;
+    name?: string | null | undefined;
     identifier?: string | undefined;
     url?: string | undefined;
 }, {
-    name?: string | undefined;
+    name?: unknown;
+    identifier?: unknown;
+    url?: unknown;
+}>, {
+    name?: string | null | undefined;
     identifier?: string | undefined;
     url?: string | undefined;
+}, {
+    name?: unknown;
+    identifier?: unknown;
+    url?: unknown;
 }>;
 /**
- * Contact
+ * Contact Object
+ *
  * Contact information for the exposed API.
  *
- * @see https://spec.openapis.org/oas/latest.html#contact-object
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#contact-object
  */
-export declare const oasContactSchema: z.ZodObject<{
+export declare const oasContactSchema: z.ZodEffects<z.ZodObject<{
     /** The identifying name of the contact person/organization. */
     name: z.ZodOptional<z.ZodString>;
     /** The URL pointing to the contact information. This MUST be in the form of a URL. */
-    url: z.ZodOptional<z.ZodString>;
+    url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
     /** The email address of the contact person/organization. This MUST be in the form of an email address. */
-    email: z.ZodOptional<z.ZodString>;
+    email: z.ZodCatch<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     name?: string | undefined;
     url?: string | undefined;
     email?: string | undefined;
 }, {
+    name?: string | undefined;
+    url?: unknown;
+    email?: unknown;
+}>, {
     name?: string | undefined;
     url?: string | undefined;
     email?: string | undefined;
+}, {
+    name?: string | undefined;
+    url?: unknown;
+    email?: unknown;
 }>;
 /**
- * Info
+ * Info Object
+ *
  * The object provides metadata about the API. The metadata MAY be used by the clients if needed,
  * and MAY be presented in editing or documentation generation tools for convenience.
  *
- * @see https://spec.openapis.org/oas/latest.html#info-object
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#info-object
  */
-export declare const oasInfoSchema: z.ZodObject<{
+export declare const oasInfoSchema: z.ZodEffects<z.ZodObject<{
     /** REQUIRED. The title of the API. */
-    title: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    title: z.ZodCatch<z.ZodString>;
     /** A short summary of the API. */
-    summary: z.ZodOptional<z.ZodString>;
+    summary: z.ZodCatch<z.ZodOptional<z.ZodString>>;
     /** A description of the API. CommonMark syntax MAY be used for rich text representation. */
-    description: z.ZodOptional<z.ZodString>;
+    description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
     /** A URL to the Terms of Service for the API. This MUST be in the form of a URL. */
-    termsOfService: z.ZodOptional<z.ZodString>;
+    termsOfService: z.ZodCatch<z.ZodOptional<z.ZodString>>;
     /** The contact information for the exposed API. */
-    contact: z.ZodOptional<z.ZodObject<{
+    contact: z.ZodCatch<z.ZodOptional<z.ZodEffects<z.ZodObject<{
         /** The identifying name of the contact person/organization. */
         name: z.ZodOptional<z.ZodString>;
         /** The URL pointing to the contact information. This MUST be in the form of a URL. */
-        url: z.ZodOptional<z.ZodString>;
+        url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
         /** The email address of the contact person/organization. This MUST be in the form of an email address. */
-        email: z.ZodOptional<z.ZodString>;
+        email: z.ZodCatch<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
         name?: string | undefined;
         url?: string | undefined;
         email?: string | undefined;
     }, {
+        name?: string | undefined;
+        url?: unknown;
+        email?: unknown;
+    }>, {
         name?: string | undefined;
         url?: string | undefined;
         email?: string | undefined;
-    }>>;
+    }, {
+        name?: string | undefined;
+        url?: unknown;
+        email?: unknown;
+    }>>>;
     /** The license information for the exposed API. */
-    license: z.ZodOptional<z.ZodObject<{
+    license: z.ZodCatch<z.ZodOptional<z.ZodEffects<z.ZodObject<{
         /** REQUIRED. The license name used for the API. */
-        name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        name: z.ZodCatch<z.ZodNullable<z.ZodOptional<z.ZodString>>>;
         /** An SPDX license expression for the API. The identifier field is mutually exclusive of the url field. */
-        identifier: z.ZodOptional<z.ZodString>;
+        identifier: z.ZodCatch<z.ZodOptional<z.ZodString>>;
         /**
-         * A URL to the license used for the API. This MUST be in the form of a URL. The url field
-         * is mutually exclusive of the identifier field.
+         * A URI for the license used for the API. This MUST be in the form of a URI. The url field is mutually exclusive of the identifier field.
          */
-        url: z.ZodOptional<z.ZodString>;
+        url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
-        name: string;
+        name?: string | null | undefined;
         identifier?: string | undefined;
         url?: string | undefined;
     }, {
-        name?: string | undefined;
+        name?: unknown;
+        identifier?: unknown;
+        url?: unknown;
+    }>, {
+        name?: string | null | undefined;
         identifier?: string | undefined;
         url?: string | undefined;
-    }>>;
+    }, {
+        name?: unknown;
+        identifier?: unknown;
+        url?: unknown;
+    }>>>;
     /**
-     * REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI
-     * Specification version or the API implementation version).
+     * REQUIRED. The version of the OpenAPI Document (which is distinct from the OpenAPI Specification version or the
+     * version of the API being described or the version of the OpenAPI Description).
      */
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    version: z.ZodCatch<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     title: string;
     version: string;
@@ -115,13 +155,22 @@ export declare const oasInfoSchema: z.ZodObject<{
         email?: string | undefined;
     } | undefined;
     license?: {
-        name: string;
+        name?: string | null | undefined;
         identifier?: string | undefined;
         url?: string | undefined;
     } | undefined;
 }, {
+    description?: unknown;
+    title?: unknown;
+    summary?: unknown;
+    termsOfService?: unknown;
+    contact?: unknown;
+    license?: unknown;
+    version?: unknown;
+}>, {
+    title: string;
+    version: string;
     description?: string | undefined;
-    title?: string | undefined;
     summary?: string | undefined;
     termsOfService?: string | undefined;
     contact?: {
@@ -130,29 +179,43 @@ export declare const oasInfoSchema: z.ZodObject<{
         email?: string | undefined;
     } | undefined;
     license?: {
-        name?: string | undefined;
+        name?: string | null | undefined;
         identifier?: string | undefined;
         url?: string | undefined;
     } | undefined;
-    version?: string | undefined;
+}, {
+    description?: unknown;
+    title?: unknown;
+    summary?: unknown;
+    termsOfService?: unknown;
+    contact?: unknown;
+    license?: unknown;
+    version?: unknown;
 }>;
 /**
- * External Documentation
+ * External Documentation Object
+ *
  * Allows referencing an external resource for extended documentation.
  *
- * @see https://spec.openapis.org/oas/latest.html#external-documentation-object
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#external-documentation-object
  */
-export declare const oasExternalDocumentationSchema: z.ZodObject<{
+export declare const oasExternalDocumentationSchema: z.ZodEffects<z.ZodObject<{
     /** A description of the target documentation. CommonMark syntax MAY be used for rich text representation. */
-    description: z.ZodOptional<z.ZodString>;
+    description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
     /** REQUIRED. The URL for the target documentation. This MUST be in the form of a URL. */
-    url: z.ZodDefault<z.ZodString>;
+    url: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     url: string;
     description?: string | undefined;
 }, {
+    url: string;
+    description?: unknown;
+}>, {
+    url: string;
     description?: string | undefined;
-    url?: string | undefined;
+}, {
+    url: string;
+    description?: unknown;
 }>;
 export type ExternalDocumentation = z.infer<typeof oasExternalDocumentationSchema>;
 export declare const xScalarNestedSchema: z.ZodArray<z.ZodObject<{
@@ -163,35 +226,40 @@ export declare const xScalarNestedSchema: z.ZodArray<z.ZodObject<{
     tagName: string;
 }>, "many">;
 /**
- * Tag
- * Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag
- * Object per tag defined in the Operation Object instances.
+ * Tag Object
+ *
+ * Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag
+ * defined in the Operation Object instances.
  *
- * @see https://spec.openapis.org/oas/latest.html#tag-object
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#tag-object
  */
 export declare const oasTagSchema: z.ZodObject<{
     /**
-     * @deprecated
-     *
-     * Needs to be remove as it is not a spec property
+     * @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;
     /** A description for the tag. CommonMark syntax MAY be used for rich text representation. */
-    description: z.ZodOptional<z.ZodString>;
+    description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
     /** Additional external documentation for this tag. */
-    externalDocs: z.ZodOptional<z.ZodObject<{
+    externalDocs: z.ZodOptional<z.ZodEffects<z.ZodObject<{
         /** A description of the target documentation. CommonMark syntax MAY be used for rich text representation. */
-        description: z.ZodOptional<z.ZodString>;
+        description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
         /** REQUIRED. The URL for the target documentation. This MUST be in the form of a URL. */
-        url: z.ZodDefault<z.ZodString>;
+        url: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         url: string;
         description?: string | undefined;
     }, {
+        url: string;
+        description?: unknown;
+    }>, {
+        url: string;
         description?: string | undefined;
-        url?: string | undefined;
+    }, {
+        url: string;
+        description?: unknown;
     }>>;
     'x-scalar-children': z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
         tagName: z.ZodString;
@@ -219,10 +287,10 @@ export declare const oasTagSchema: z.ZodObject<{
 }, {
     name: string;
     type?: "tag" | undefined;
-    description?: string | undefined;
+    description?: unknown;
     externalDocs?: {
-        description?: string | undefined;
-        url?: string | undefined;
+        url: string;
+        description?: unknown;
     } | undefined;
     'x-scalar-children'?: {
         tagName: string;
@@ -232,27 +300,31 @@ export declare const oasTagSchema: z.ZodObject<{
 }>;
 export declare const tagSchema: z.ZodObject<z.objectUtil.extendShape<{
     /**
-     * @deprecated
-     *
-     * Needs to be remove as it is not a spec property
+     * @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;
     /** A description for the tag. CommonMark syntax MAY be used for rich text representation. */
-    description: z.ZodOptional<z.ZodString>;
+    description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
     /** Additional external documentation for this tag. */
-    externalDocs: z.ZodOptional<z.ZodObject<{
+    externalDocs: z.ZodOptional<z.ZodEffects<z.ZodObject<{
         /** A description of the target documentation. CommonMark syntax MAY be used for rich text representation. */
-        description: z.ZodOptional<z.ZodString>;
+        description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
         /** REQUIRED. The URL for the target documentation. This MUST be in the form of a URL. */
-        url: z.ZodDefault<z.ZodString>;
+        url: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         url: string;
         description?: string | undefined;
     }, {
+        url: string;
+        description?: unknown;
+    }>, {
+        url: string;
         description?: string | undefined;
-        url?: string | undefined;
+    }, {
+        url: string;
+        description?: unknown;
     }>>;
     'x-scalar-children': z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
         tagName: z.ZodString;
@@ -265,13 +337,13 @@ export declare const tagSchema: z.ZodObject<z.objectUtil.extendShape<{
     'x-internal': z.ZodOptional<z.ZodBoolean>;
     'x-scalar-ignore': z.ZodOptional<z.ZodBoolean>;
 }, {
-    uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-    children: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
+    uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "tag">;
+    children: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodBranded<z.ZodString, "operation">, z.ZodBranded<z.ZodString, "tag">]>, "many">>;
 }>, "strip", z.ZodTypeAny, {
     type: "tag";
-    uid: string;
+    uid: string & z.BRAND<"tag">;
     name: string;
-    children: string[];
+    children: ((string & z.BRAND<"tag">) | (string & z.BRAND<"operation">))[];
     description?: string | undefined;
     externalDocs?: {
         url: string;
@@ -286,17 +358,17 @@ export declare const tagSchema: z.ZodObject<z.objectUtil.extendShape<{
     name: string;
     type?: "tag" | undefined;
     uid?: string | undefined;
-    description?: string | undefined;
+    description?: unknown;
     externalDocs?: {
-        description?: string | undefined;
-        url?: string | undefined;
+        url: string;
+        description?: unknown;
     } | undefined;
     'x-scalar-children'?: {
         tagName: string;
     }[] | undefined;
     'x-internal'?: boolean | undefined;
     'x-scalar-ignore'?: boolean | undefined;
-    children?: (string | undefined)[] | undefined;
+    children?: string[] | undefined;
 }>;
 export type Tag = z.infer<typeof tagSchema>;
 export type TagPayload = z.input<typeof tagSchema>;

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;IACvB;;;;OAIG;;IAEH,qCAAqC;;IAErC,6FAA6F;;IAE7F,sDAAsD;;QAjCtD,6GAA6G;;QAE7G,yFAAyF;;;;;;;;;;;;;;;;IAkCzF,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGvB,CAAA;AAEF,eAAO,MAAM,SAAS;IAlBpB;;;;OAIG;;IAEH,qCAAqC;;IAErC,6FAA6F;;IAE7F,sDAAsD;;QAjCtD,6GAA6G;;QAE7G,yFAAyF;;;;;;;;;;;;;;;;IAkCzF,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQvB,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,mBAAmB,GAAI,CAAC,SAAS,MAAM,QAAQ,CAAC,KAAG,CAE/D,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;IAEzB,mDAAmD;;IAEnD,2GAA2G;;IAE3G;;OAEG;;;;;;;;;;;;;;;;;;EAG0B,CAAA;AAEjC;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;IAEzB,+DAA+D;;IAE/D,sFAAsF;;IAEtF,0GAA0G;;;;;;;;;;;;;;;;;;EAG7E,CAAA;AAEjC;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa;IAEtB,sCAAsC;;IAEtC,kCAAkC;;IAElC,4FAA4F;;IAE5F,oFAAoF;;IAEpF,mDAAmD;;QA3BnD,+DAA+D;;QAE/D,sFAAsF;;QAEtF,0GAA0G;;;;;;;;;;;;;;;;;;;IAyB1G,mDAAmD;;QAjDnD,mDAAmD;;QAEnD,2GAA2G;;QAE3G;;WAEG;;;;;;;;;;;;;;;;;;;IA6CH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG0B,CAAA;AAEjC;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;IAEvC,6GAA6G;;IAE7G,yFAAyF;;;;;;;;;;;;;;EAG5D,CAAA;AAEjC,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AAElF,eAAO,MAAM,mBAAmB;;;;;;WAItB,CAAA;AAEV;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY;IAEvB;;OAEG;;IAEH,qCAAqC;;IAErC,6FAA6F;;IAE7F,sDAAsD;;QAjCpD,6GAA6G;;QAE7G,yFAAyF;;;;;;;;;;;;;;;;;;;;;;IAkC3F,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGvB,CAAA;AAEF,eAAO,MAAM,SAAS;IAhBpB;;OAEG;;IAEH,qCAAqC;;IAErC,6FAA6F;;IAE7F,sDAAsD;;QAjCpD,6GAA6G;;QAE7G,yFAAyF;;;;;;;;;;;;;;;;;;;;;;IAkC3F,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWvB,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

@@ -1,97 +1,117 @@
-import { z } from 'zod';
 import { nanoidSchema } from '../shared/utility.js';
+import { z } from 'zod';
 
 /**
+ * Removes undefined values from an object.
+ *
+ * Can be used as a transform function for any Zod schema.
+ */
+const omitUndefinedValues = (data) => {
+    return Object.fromEntries(Object.entries(data).filter(([_, value]) => value !== undefined));
+};
+/**
+ * License Object
+ *
  * License information for the exposed API.
  *
- * @see https://spec.openapis.org/oas/latest.html#license-object
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#license-object
  */
-const oasLicenseSchema = z.object({
+const oasLicenseSchema = z
+    .object({
     /** REQUIRED. The license name used for the API. */
-    name: z.string().optional().default('name'),
+    name: z.string().optional().nullable().catch(null),
     /** An SPDX license expression for the API. The identifier field is mutually exclusive of the url field. */
-    identifier: z.string().optional(),
+    identifier: z.string().optional().catch(undefined),
     /**
-     * A URL to the license used for the API. This MUST be in the form of a URL. The url field
-     * is mutually exclusive of the identifier field.
+     * A URI for the license used for the API. This MUST be in the form of a URI. The url field is mutually exclusive of the identifier field.
      */
-    url: z.string().optional(),
-});
+    url: z.string().url().optional().catch(undefined),
+})
+    .transform(omitUndefinedValues);
 /**
- * Contact
+ * Contact Object
+ *
  * Contact information for the exposed API.
  *
- * @see https://spec.openapis.org/oas/latest.html#contact-object
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#contact-object
  */
-const oasContactSchema = z.object({
+const oasContactSchema = z
+    .object({
     /** The identifying name of the contact person/organization. */
     name: z.string().optional(),
     /** The URL pointing to the contact information. This MUST be in the form of a URL. */
-    url: z.string().optional(),
+    url: z.string().url().optional().catch(undefined),
     /** The email address of the contact person/organization. This MUST be in the form of an email address. */
-    email: z.string().email().optional(),
-});
+    email: z.string().optional().catch(undefined),
+})
+    .transform(omitUndefinedValues);
 /**
- * Info
+ * Info Object
+ *
  * The object provides metadata about the API. The metadata MAY be used by the clients if needed,
  * and MAY be presented in editing or documentation generation tools for convenience.
  *
- * @see https://spec.openapis.org/oas/latest.html#info-object
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#info-object
  */
-const oasInfoSchema = z.object({
+const oasInfoSchema = z
+    .object({
     /** REQUIRED. The title of the API. */
-    title: z.string().optional().default('API'),
+    title: z.string().catch('API'),
     /** A short summary of the API. */
-    summary: z.string().optional(),
+    summary: z.string().optional().catch(undefined),
     /** A description of the API. CommonMark syntax MAY be used for rich text representation. */
-    description: z.string().optional(),
+    description: z.string().optional().catch(undefined),
     /** A URL to the Terms of Service for the API. This MUST be in the form of a URL. */
-    termsOfService: z.string().optional(),
+    termsOfService: z.string().url().optional().catch(undefined),
     /** The contact information for the exposed API. */
-    contact: oasContactSchema.optional(),
+    contact: oasContactSchema.optional().catch(undefined),
     /** The license information for the exposed API. */
-    license: oasLicenseSchema.optional(),
+    license: oasLicenseSchema.optional().catch(undefined),
     /**
-     * REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI
-     * Specification version or the API implementation version).
+     * REQUIRED. The version of the OpenAPI Document (which is distinct from the OpenAPI Specification version or the
+     * version of the API being described or the version of the OpenAPI Description).
      */
-    version: z.string().optional().default('1.0'),
-});
+    version: z.string().catch('1.0'),
+})
+    .transform(omitUndefinedValues);
 /**
- * External Documentation
+ * External Documentation Object
+ *
  * Allows referencing an external resource for extended documentation.
  *
- * @see https://spec.openapis.org/oas/latest.html#external-documentation-object
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#external-documentation-object
  */
-const oasExternalDocumentationSchema = z.object({
+const oasExternalDocumentationSchema = z
+    .object({
     /** A description of the target documentation. CommonMark syntax MAY be used for rich text representation. */
-    description: z.string().optional(),
+    description: z.string().optional().catch(undefined),
     /** REQUIRED. The URL for the target documentation. This MUST be in the form of a URL. */
-    url: z.string().default(''),
-});
+    url: z.string(),
+})
+    .transform(omitUndefinedValues);
 const xScalarNestedSchema = z
     .object({
     tagName: z.string(),
 })
     .array();
 /**
- * Tag
- * Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag
- * Object per tag defined in the Operation Object instances.
+ * Tag Object
+ *
+ * Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag
+ * defined in the Operation Object instances.
  *
- * @see https://spec.openapis.org/oas/latest.html#tag-object
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#tag-object
  */
 const oasTagSchema = z.object({
+    // TODO: Remove
     /**
-     * @deprecated
-     *
-     * Needs to be remove as it is not a spec property
+     * @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(),
     /** A description for the tag. CommonMark syntax MAY be used for rich text representation. */
-    'description': z.string().optional(),
+    'description': z.string().optional().catch(undefined),
     /** Additional external documentation for this tag. */
     'externalDocs': oasExternalDocumentationSchema.optional(),
     'x-scalar-children': xScalarNestedSchema.default([]).optional(),
@@ -100,8 +120,11 @@ const oasTagSchema = z.object({
     'x-scalar-ignore': z.boolean().optional(),
 });
 const tagSchema = oasTagSchema.extend({
-    uid: nanoidSchema,
-    children: nanoidSchema.array().default([]),
+    uid: nanoidSchema.brand(),
+    children: z
+        .union([z.string().brand(), z.string().brand()])
+        .array()
+        .default([]),
 });
 
-export { oasContactSchema, oasExternalDocumentationSchema, oasInfoSchema, oasLicenseSchema, oasTagSchema, tagSchema, xScalarNestedSchema };
+export { oasContactSchema, oasExternalDocumentationSchema, oasInfoSchema, oasLicenseSchema, oasTagSchema, omitUndefinedValues, tagSchema, xScalarNestedSchema };

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

@@ -3,21 +3,21 @@ 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;
+    description?: 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;
+    description?: 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

@@ -1 +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"}
+{"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;AAChF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA"}