@scalar/oas-utils 0.2.42 → 0.2.44

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

@@ -0,0 +1 @@
+{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/security.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AA6CvB;;;GAGG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAO3C,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,gCAAgC,CACxC,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,gCAAgC,GAAG,OAAO,CACpD,0BAA0B,EAC1B;IAAE,IAAI,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,CAC5B,CAAA;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,cAAc,EACtB,UAAU,GAAE,GAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;EAiBrB;AAoBD,eAAO,MAAM,sBAAsB,wCAAyC,CAAA;AAU5E,eAAO,MAAM,oBAAoB;;;;IAN/B,8EAA8E;;IAE9E,6FAA6F;;;;IAb7F,0EAA0E;;;;;;;;;;;;;;;;EAmB3E,CAAA;AACD,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAuBvE,eAAO,MAAM,kBAAkB;;;;IAhB7B;;;OAGG;;IAEH;;;;OAIG;;;;IApCH,0EAA0E;;;;;;;;;;;;;;;;EA6C3E,CAAA;AACD,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAanE,eAAO,MAAM,oBAAoB;;;;IAP/B;;;OAGG;;;;IAvDH,0EAA0E;;;;;;;;;;;;;;EA6D3E,CAAA;AACD,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AA2EvE,eAAO,MAAM,mBAAmB;;;;IAN9B,6FAA6F;;QAnD7F;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;IA6CH,oEAAoE;;;;IArIpE,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2I3E,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAKtE;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B,wFAGxC,CAAA;AAED,qCAAqC;AACrC,eAAO,MAAM,uBAAuB;;;;IAvJlC,8EAA8E;;IAE9E,6FAA6F;;;;;;;;;;;;;;;;IAc7F;;;OAGG;;IAEH;;;;OAIG;;;;;;;;;;;;;;;;IA+FH,6FAA6F;;QAnD7F;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;IA6CH,oEAAoE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAjFpE;;;OAGG;;;;;;;;;;IAgHH,CAAA;AAEF,oDAAoD;AACpD,eAAO,MAAM,oBAAoB;;;;IA/J/B,8EAA8E;;IAE9E,6FAA6F;;;;IAb7F,0EAA0E;;;;;;;;;;;;;;;;;;;;IA2B1E;;;OAGG;;IAEH;;;;OAIG;;;;IApCH,0EAA0E;;;;;;;;;;;;;;;;;;;;IAoD1E;;;OAGG;;;;IAvDH,0EAA0E;;;;;;;;;;;;;;;;;;IAmI1E,6FAA6F;;QAnD7F;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;IA6CH,oEAAoE;;;;IArIpE,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA+K1E,CAAA;AAEF;;;;GAIG;AACH,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"}

package/dist/entities/spec/security.js

@@ -0,0 +1,222 @@
+import { z } from 'zod';
+import { nanoidSchema } from '../shared/utility.js';
+
+// ---------------------------------------------------------------------------
+// Collection values for Security Schemes
+const apiKeyExampleSchema = z.object({
+    type: z.literal('apiKey').default('apiKey'),
+    name: z.string().default(''),
+    value: z.string().default(''),
+});
+const httpExampleSchema = z.object({
+    type: z.literal('http').default('http'),
+    username: z.string().default(''),
+    password: z.string().default(''),
+    token: z.string().default(''),
+});
+const oauthImplicitExampleSchema = z.object({
+    type: z.literal('oauth-implicit').default('oauth-implicit'),
+    token: z.string().default(''),
+});
+const oauthPasswordExampleSchema = z.object({
+    type: z.literal('oauth-password').default('oauth-password'),
+    token: z.string().default(''),
+    username: z.string().default(''),
+    password: z.string().default(''),
+    clientSecret: z.string().default(''),
+});
+const oauthClientCredentialsExampleSchema = z.object({
+    type: z.literal('oauth-clientCredentials').default('oauth-clientCredentials'),
+    token: z.string().default(''),
+    clientSecret: z.string().default(''),
+});
+const oauthAuthorizationCodeExampleSchema = z.object({
+    type: z.literal('oauth-authorizationCode').default('oauth-authorizationCode'),
+    token: z.string().default(''),
+    clientSecret: z.string().default(''),
+});
+/**
+ * Value schema for each type of OAuth Flow
+ * Request Examples can store populated values for a given security scheme
+ */
+const securitySchemeExampleValueSchema = z.union([
+    apiKeyExampleSchema,
+    httpExampleSchema,
+    oauthImplicitExampleSchema,
+    oauthPasswordExampleSchema,
+    oauthClientCredentialsExampleSchema,
+    oauthAuthorizationCodeExampleSchema,
+]);
+/**
+ * Generates a base set of example data for a given securityScheme
+ *
+ * TODO: we can probably remove this unless we really want to keep it separate
+ */
+function authExampleFromSchema(scheme, baseValues = {}) {
+    if (scheme.type === 'apiKey')
+        return apiKeyExampleSchema.parse({ name: scheme.name, ...baseValues });
+    if (scheme.type === 'http')
+        return httpExampleSchema.parse(baseValues);
+    if (scheme.type === 'oauth2') {
+        if (scheme.flow.type === 'authorizationCode')
+            return oauthAuthorizationCodeExampleSchema.parse(baseValues);
+        if (scheme.flow.type === 'clientCredentials')
+            return oauthClientCredentialsExampleSchema.parse(baseValues);
+        if (scheme.flow.type === 'implicit')
+            return oauthImplicitExampleSchema.parse(baseValues);
+        if (scheme.flow.type === 'password')
+            return oauthPasswordExampleSchema.parse(baseValues);
+    }
+    throw Error('INVALID SCHEMA FOR OAUTH EXAMPLE');
+}
+// ---------------------------------------------------------------------------
+// COMMON PROPS FOR ALL SECURITY SCHEMES
+/** Some common properties used in all security schemes */
+const commonProps = z.object({
+    /* A description for security scheme. CommonMark syntax MAY be used for rich text representation. */
+    description: z.string().optional(),
+});
+const extendedSecuritySchema = z.object({
+    uid: nanoidSchema,
+    /** The name key that links a security requirement to a security object */
+    nameKey: z.string().optional().default(''),
+});
+// ---------------------------------------------------------------------------
+// API KEY
+const securitySchemeApiKeyIn = ['query', 'header', 'cookie'];
+const oasSecuritySchemeApiKey = commonProps.extend({
+    type: z.literal('apiKey'),
+    /** REQUIRED. The name of the header, query or cookie parameter to be used. */
+    name: z.string().optional().default(''),
+    /** REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie". */
+    in: z.enum(securitySchemeApiKeyIn).optional().default('header'),
+});
+const securityApiKeySchema = oasSecuritySchemeApiKey.merge(extendedSecuritySchema);
+// ---------------------------------------------------------------------------
+// HTTP
+const oasSecuritySchemeHttp = commonProps.extend({
+    type: z.literal('http'),
+    /**
+     * REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in
+     * [RFC7235]. The values used SHOULD be registered in the IANA Authentication Scheme registry.
+     */
+    scheme: z.enum(['basic', 'bearer']).optional().default('basic'),
+    /**
+     * A hint to the client to identify how the bearer token is formatted.
+     * Bearer tokens are usually generated by an authorization server, so
+     * this information is primarily for documentation purposes.
+     */
+    bearerFormat: z
+        .union([z.literal('JWT'), z.string()])
+        .optional()
+        .default('JWT'),
+});
+const securityHttpSchema = oasSecuritySchemeHttp.merge(extendedSecuritySchema);
+// ---------------------------------------------------------------------------
+// OPENID CONNECT
+const oasSecuritySchemeOpenId = commonProps.extend({
+    type: z.literal('openIdConnect'),
+    /**
+     * REQUIRED. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the
+     * form of a URL. The OpenID Connect standard requires the use of TLS.
+     */
+    openIdConnectUrl: z.string().optional().default(''),
+});
+const securityOpenIdSchema = oasSecuritySchemeOpenId.merge(extendedSecuritySchema);
+// ---------------------------------------------------------------------------
+/**
+ * REQUIRED. The authorization URL to be used for this flow. This MUST be in
+ * the form of a URL. The OAuth2 standard requires the use of TLS.
+ */
+const authorizationUrl = z.string().default('');
+/**
+ * REQUIRED. The token URL to be used for this flow. This MUST be in the
+ * form of a URL. The OAuth2 standard requires the use of TLS.
+ */
+const tokenUrl = z.string().default('');
+/** Common properties used across all oauth2 flows */
+const oauthCommon = z.object({
+    /**
+     * The URL to be used for obtaining refresh tokens. This MUST be in the form of a
+     * URL. The OAuth2 standard requires the use of TLS.
+     */
+    refreshUrl: z.string().optional().default(''),
+    /**
+     * REQUIRED. The available scopes for the OAuth2 security scheme. A map
+     * between the scope name and a short description for it. The map MAY be empty.
+     */
+    scopes: z
+        .union([
+        z.map(z.string(), z.string().optional()),
+        z.record(z.string(), z.string().optional()),
+        z.object({}),
+    ])
+        .optional()
+        .default({}),
+    selectedScopes: z.array(z.string()).optional().default([]),
+});
+const oasOauthFlowSchema = z
+    .discriminatedUnion('type', [
+    /** Configuration for the OAuth Implicit flow */
+    oauthCommon.extend({
+        'type': z.literal('implicit'),
+        authorizationUrl,
+        'x-scalar-redirect-uri': z.string().optional().default(''),
+    }),
+    /** Configuration for the OAuth Resource Owner Password flow */
+    oauthCommon.extend({
+        type: z.literal('password'),
+        tokenUrl,
+    }),
+    /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
+    oauthCommon.extend({
+        type: z.literal('clientCredentials'),
+        tokenUrl,
+    }),
+    /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.*/
+    oauthCommon.extend({
+        'type': z.literal('authorizationCode'),
+        authorizationUrl,
+        'x-scalar-redirect-uri': z.string().optional().default(''),
+        tokenUrl,
+    }),
+])
+    .optional()
+    .default({ type: 'implicit', authorizationUrl: 'http://localhost:8080' });
+const oasSecuritySchemeOauth2 = commonProps.extend({
+    'type': z.literal('oauth2'),
+    /** REQUIRED. An object containing configuration information for the flow types supported. */
+    'flow': oasOauthFlowSchema,
+    /** Extension to save the client Id associated with an oauth flow */
+    'x-scalar-client-id': z.string().optional().default(''),
+});
+const securityOauthSchema = oasSecuritySchemeOauth2.merge(extendedSecuritySchema);
+// ---------------------------------------------------------------------------
+// Final Types
+/**
+ * Security Requirement
+ * Lists the required security schemes to execute this operation OR the whole collection/spec.
+ * The name used for each property MUST correspond to a security scheme declared in the Security
+ * Schemes under the Components Object.
+ *
+ * The key (name) here will be matched to the key of the securityScheme for linking
+ *
+ * @see https://spec.openapis.org/oas/latest.html#security-requirement-object
+ */
+const oasSecurityRequirementSchema = z.record(z.string(), z.array(z.string()).optional().default([]));
+/** OAS Compliant security schemes */
+const oasSecuritySchemeSchema = z.union([
+    oasSecuritySchemeApiKey,
+    oasSecuritySchemeHttp,
+    oasSecuritySchemeOauth2,
+    oasSecuritySchemeOpenId,
+]);
+/** Extended security schemes for workspace usage */
+const securitySchemeSchema = z.union([
+    securityApiKeySchema,
+    securityHttpSchema,
+    securityOpenIdSchema,
+    securityOauthSchema,
+]);
+
+export { authExampleFromSchema, oasSecurityRequirementSchema, oasSecuritySchemeSchema, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeApiKeyIn, securitySchemeExampleValueSchema, securitySchemeSchema };

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

@@ -0,0 +1,82 @@
+import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+import { type ZodSchema, z } from 'zod';
+/**
+ * Server variables
+ * An object representing a Server Variable for server URL template substitution.
+ *
+ * @see https://spec.openapis.org/oas/v3.1.0#server-variable-object
+ *
+ * NOTE: Typecase is required to handle enum string array type
+ */
+export declare const oasServerVariableSchema: ZodSchema<Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
+    enum?: [string, ...string[]];
+}>;
+export declare const oasServerSchema: z.ZodObject<{
+    /**
+     * REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that
+     * the host location is relative to the location where the OpenAPI document is being served. Variable substitutions
+     * will be made when a variable is named in {brackets}.
+     */
+    url: z.ZodOptional<z.ZodString>;
+    /**
+     * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text
+     * representation.
+     */
+    description: z.ZodOptional<z.ZodString>;
+    /** A map between a variable name and its value. The value is used for substitution in the server’s URL template. */
+    variables: z.ZodOptional<z.ZodRecord<z.ZodString, ZodSchema<Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
+        enum?: [string, ...string[]];
+    }, z.ZodTypeDef, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
+        enum?: [string, ...string[]];
+    }>>>;
+}, "strip", z.ZodTypeAny, {
+    description?: string | undefined;
+    url?: string | undefined;
+    variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
+        enum?: [string, ...string[]];
+    }> | undefined;
+}, {
+    description?: string | undefined;
+    url?: string | undefined;
+    variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
+        enum?: [string, ...string[]];
+    }> | undefined;
+}>;
+export declare const serverSchema: z.ZodObject<z.objectUtil.extendShape<{
+    /**
+     * REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that
+     * the host location is relative to the location where the OpenAPI document is being served. Variable substitutions
+     * will be made when a variable is named in {brackets}.
+     */
+    url: z.ZodOptional<z.ZodString>;
+    /**
+     * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text
+     * representation.
+     */
+    description: z.ZodOptional<z.ZodString>;
+    /** A map between a variable name and its value. The value is used for substitution in the server’s URL template. */
+    variables: z.ZodOptional<z.ZodRecord<z.ZodString, ZodSchema<Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
+        enum?: [string, ...string[]];
+    }, z.ZodTypeDef, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
+        enum?: [string, ...string[]];
+    }>>>;
+}, {
+    uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}>, "strip", z.ZodTypeAny, {
+    uid: string;
+    description?: string | undefined;
+    url?: string | undefined;
+    variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
+        enum?: [string, ...string[]];
+    }> | undefined;
+}, {
+    uid?: string | undefined;
+    description?: string | undefined;
+    url?: string | undefined;
+    variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
+        enum?: [string, ...string[]];
+    }> | undefined;
+}>;
+export type Server = z.infer<typeof serverSchema>;
+export type ServerPayload = z.input<typeof serverSchema>;
+//# sourceMappingURL=server.d.ts.map

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

@@ -0,0 +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"}

package/dist/entities/{workspace/server → spec}/server.js

@@ -1,4 +1,3 @@
-import { deepMerge } from '@scalar/object-utils/merge';
 import { z } from 'zod';
 import { nanoidSchema } from '../shared/utility.js';
 
@@ -7,14 +6,15 @@ import { nanoidSchema } from '../shared/utility.js';
  * An object representing a Server Variable for server URL template substitution.
  *
  * @see https://spec.openapis.org/oas/v3.1.0#server-variable-object
+ *
+ * NOTE: Typecase is required to handle enum string array type
  */
-const serverVariableSchema = z.object({
-    uid: nanoidSchema,
+const oasServerVariableSchema = z.object({
     /**
      * An enumeration of string values to be used if the substitution options are from a limited set.
      * The array MUST NOT be empty.
      */
-    enum: z.array(z.string()).optional(),
+    enum: z.string().array().min(1).optional(),
     /**
      * REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied.
      * Note this behavior is different than the Schema Object’s treatment of default values, because in those cases
@@ -23,26 +23,24 @@ const serverVariableSchema = z.object({
     default: z.string().optional().default('default'),
     /** An optional description for the server variable. CommonMark syntax MAY be used for rich text representation. */
     description: z.string().optional(),
-    /** An optional value for the server variable */
-    value: z.string().optional(),
 });
-const serverSchema = z.object({
-    uid: nanoidSchema,
+const oasServerSchema = z.object({
     /**
      * REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that
      * the host location is relative to the location where the OpenAPI document is being served. Variable substitutions
      * will be made when a variable is named in {brackets}.
      */
-    url: z.string().optional().default(''),
+    url: z.string().optional(),
     /**
      * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text
      * representation.
      */
     description: z.string().optional(),
     /** A map between a variable name and its value. The value is used for substitution in the server’s URL template. */
-    variables: z.record(z.string(), serverVariableSchema).nullable().optional(),
+    variables: z.record(z.string(), oasServerVariableSchema).optional(),
+});
+const serverSchema = oasServerSchema.extend({
+    uid: nanoidSchema,
 });
-/** Create server helper */
-const createServer = (payload) => deepMerge(serverSchema.parse({}), payload);
 
-export { createServer };
+export { oasServerSchema, oasServerVariableSchema, serverSchema };

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

@@ -0,0 +1,279 @@
+import { z } from 'zod';
+/**
+ * License information for the exposed API.
+ *
+ * @see https://spec.openapis.org/oas/latest.html#license-object
+ */
+export declare const oasLicenseSchema: z.ZodObject<{
+    /** REQUIRED. The license name used for the API. */
+    name: z.ZodDefault<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>;
+    /**
+     * 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.
+     */
+    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;
+}>;
+/**
+ * Contact
+ * Contact information for the exposed API.
+ *
+ * @see https://spec.openapis.org/oas/latest.html#contact-object
+ */
+export declare const oasContactSchema: 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>;
+    /** The email address of the contact person/organization. This MUST be in the form of an email address. */
+    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;
+}>;
+/**
+ * Info
+ * 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
+ */
+export declare const oasInfoSchema: z.ZodObject<{
+    /** REQUIRED. The title of the API. */
+    title: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    /** A short summary of the API. */
+    summary: z.ZodOptional<z.ZodString>;
+    /** A description of the API. CommonMark syntax MAY be used for rich text representation. */
+    description: 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>;
+    /** The contact information for the exposed API. */
+    contact: z.ZodOptional<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>;
+        /** The email address of the contact person/organization. This MUST be in the form of an email address. */
+        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;
+    }>>;
+    /** The license information for the exposed API. */
+    license: z.ZodOptional<z.ZodObject<{
+        /** REQUIRED. The license name used for the API. */
+        name: z.ZodDefault<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>;
+        /**
+         * 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.
+         */
+        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;
+    }>>;
+    /**
+     * REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI
+     * Specification version or the API implementation version).
+     */
+    version: z.ZodDefault<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;
+}>;
+/**
+ * External Documentation
+ * Allows referencing an external resource for extended documentation.
+ *
+ * @see https://spec.openapis.org/oas/latest.html#external-documentation-object
+ */
+export declare const oasExternalDocumentationSchema: z.ZodObject<{
+    /** A description of the target documentation. CommonMark syntax MAY be used for rich text representation. */
+    description: 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>;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+    description?: string | undefined;
+}, {
+    description?: string | undefined;
+    url?: string | undefined;
+}>;
+export type ExternalDocumentation = z.infer<typeof oasExternalDocumentationSchema>;
+export declare const xScalarNestedSchema: z.ZodArray<z.ZodObject<{
+    tagName: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    tagName: string;
+}, {
+    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.
+ *
+ * @see https://spec.openapis.org/oas/latest.html#tag-object
+ */
+export declare const oasTagSchema: z.ZodObject<{
+    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>;
+    /** Additional external documentation for this tag. */
+    externalDocs: z.ZodOptional<z.ZodObject<{
+        /** A description of the target documentation. CommonMark syntax MAY be used for rich text representation. */
+        description: 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>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        description?: string | undefined;
+    }, {
+        description?: string | undefined;
+        url?: string | undefined;
+    }>>;
+    'x-scalar-children': z.ZodDefault<z.ZodArray<z.ZodObject<{
+        tagName: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        tagName: string;
+    }, {
+        tagName: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    type: "tag";
+    name: string;
+    'x-scalar-children': {
+        tagName: string;
+    }[];
+    description?: string | undefined;
+    externalDocs?: {
+        url: string;
+        description?: string | undefined;
+    } | undefined;
+}, {
+    name: string;
+    type?: "tag" | undefined;
+    description?: string | undefined;
+    externalDocs?: {
+        description?: string | undefined;
+        url?: string | undefined;
+    } | undefined;
+    'x-scalar-children'?: {
+        tagName: string;
+    }[] | undefined;
+}>;
+export declare const tagSchema: z.ZodObject<z.objectUtil.extendShape<{
+    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>;
+    /** Additional external documentation for this tag. */
+    externalDocs: z.ZodOptional<z.ZodObject<{
+        /** A description of the target documentation. CommonMark syntax MAY be used for rich text representation. */
+        description: 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>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        description?: string | undefined;
+    }, {
+        description?: string | undefined;
+        url?: string | undefined;
+    }>>;
+    'x-scalar-children': z.ZodDefault<z.ZodArray<z.ZodObject<{
+        tagName: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        tagName: string;
+    }, {
+        tagName: string;
+    }>, "many">>;
+}, {
+    uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    children: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
+}>, "strip", z.ZodTypeAny, {
+    type: "tag";
+    uid: string;
+    name: string;
+    'x-scalar-children': {
+        tagName: string;
+    }[];
+    children: string[];
+    description?: string | undefined;
+    externalDocs?: {
+        url: string;
+        description?: string | undefined;
+    } | undefined;
+}, {
+    name: string;
+    type?: "tag" | undefined;
+    uid?: string | undefined;
+    description?: string | undefined;
+    externalDocs?: {
+        description?: string | undefined;
+        url?: string | undefined;
+    } | undefined;
+    'x-scalar-children'?: {
+        tagName: string;
+    }[] | undefined;
+    children?: (string | undefined)[] | undefined;
+}>;
+export type Tag = z.infer<typeof tagSchema>;
+export type TagPayload = z.input<typeof tagSchema>;
+//# sourceMappingURL=spec-objects.d.ts.map

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

@@ -0,0 +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"}