@scalar/workspace-store 0.40.2 → 0.40.4

package/dist/schemas/v3.1/strict/responses.js

@@ -1,11 +1,13 @@
-import { Type } from "@scalar/typebox";
-import { ResponseObjectRef } from "./ref-definitions.js";
-import { reference } from "./reference.js";
-const ResponsesObjectSchemaDefinition = Type.Record(
-  Type.String(),
-  Type.Union([ResponseObjectRef, reference(ResponseObjectRef)])
-);
-export {
-  ResponsesObjectSchemaDefinition
-};
-//# sourceMappingURL=responses.js.map
+import { Type } from '@scalar/typebox';
+import { ResponseObjectRef } from './ref-definitions.js';
+import { reference } from './reference.js';
+/**
+ * A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
+ *
+ * The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.
+ *
+ * The default MAY be used as a default Response Object for all HTTP codes that are not covered individually by the Responses Object.
+ *
+ * The Responses Object MUST contain at least one response code, and if only one response code is provided it SHOULD be the response for a successful operation call.
+ */
+export const ResponsesObjectSchemaDefinition = Type.Record(Type.String(), Type.Union([ResponseObjectRef, reference(ResponseObjectRef)]));

package/dist/schemas/v3.1/strict/schema.js

@@ -1,172 +1,164 @@
-import { Type } from "@scalar/typebox";
-import { compose } from "../../../schemas/compose.js";
-import { XInternalSchema } from "../../../schemas/extensions/document/x-internal.js";
-import { XScalarIgnoreSchema } from "../../../schemas/extensions/document/x-scalar-ignore.js";
-import { XTags } from "../../../schemas/extensions/document/x-tags.js";
-import {
-  XAdditionalPropertiesNameSchema
-} from "../../../schemas/extensions/schema/x-additional-properties-name.js";
-import { XEnumDescriptionsSchema } from "../../../schemas/extensions/schema/x-enum-descriptions.js";
-import { XEnumVarNamesSchema } from "../../../schemas/extensions/schema/x-enum-varnames.js";
-import { XExamplesSchema } from "../../../schemas/extensions/schema/x-examples.js";
-import { XVariableSchema } from "../../../schemas/extensions/schema/x-variable.js";
-import {
-  DiscriminatorObjectRef,
-  ExternalDocumentationObjectRef,
-  SchemaObjectRef,
-  XMLObjectRef
-} from "./ref-definitions.js";
-import { ReferenceObjectSchema } from "./reference.js";
+import { Type } from '@scalar/typebox';
+import { compose } from '../../../schemas/compose.js';
+import { XInternalSchema } from '../../../schemas/extensions/document/x-internal.js';
+import { XScalarIgnoreSchema } from '../../../schemas/extensions/document/x-scalar-ignore.js';
+import { XTags } from '../../../schemas/extensions/document/x-tags.js';
+import { XAdditionalPropertiesNameSchema, } from '../../../schemas/extensions/schema/x-additional-properties-name.js';
+import { XEnumDescriptionsSchema } from '../../../schemas/extensions/schema/x-enum-descriptions.js';
+import { XEnumVarNamesSchema } from '../../../schemas/extensions/schema/x-enum-varnames.js';
+import { XExamplesSchema } from '../../../schemas/extensions/schema/x-examples.js';
+import { XVariableSchema } from '../../../schemas/extensions/schema/x-variable.js';
+import { DiscriminatorObjectRef, ExternalDocumentationObjectRef, SchemaObjectRef, XMLObjectRef, } from './ref-definitions.js';
+import { ReferenceObjectSchema } from './reference.js';
 const schemaOrReference = Type.Union([
-  SchemaObjectRef,
-  compose(ReferenceObjectSchema, Type.Object({ "$ref-value": Type.Unknown() }))
+    SchemaObjectRef,
+    compose(ReferenceObjectSchema, Type.Object({ '$ref-value': Type.Unknown() })),
 ]);
+/**
+ * Primitive types that don't have additional validation properties.
+ * These types (null, boolean, string, number, integer, object, array) can be used
+ * without additional validation constraints.
+ *
+ * TODO: Type array will actually validate against every union type but we can cross that bridge when we come to it
+ */
 const OtherTypes = Type.Object({
-  type: Type.Union([
-    Type.Literal("null"),
-    Type.Literal("boolean"),
-    Type.Array(
-      Type.Union([
-        Type.Literal("null"),
-        Type.Literal("boolean"),
-        Type.Literal("string"),
-        Type.Literal("number"),
-        Type.Literal("integer"),
-        Type.Literal("object"),
-        Type.Literal("array")
-      ])
-    )
-  ])
+    type: Type.Union([
+        Type.Literal('null'),
+        Type.Literal('boolean'),
+        Type.Array(Type.Union([
+            Type.Literal('null'),
+            Type.Literal('boolean'),
+            Type.Literal('string'),
+            Type.Literal('number'),
+            Type.Literal('integer'),
+            Type.Literal('object'),
+            Type.Literal('array'),
+        ])),
+    ]),
 });
-const Extensions = compose(
-  XScalarIgnoreSchema,
-  XInternalSchema,
-  XVariableSchema,
-  XExamplesSchema,
-  XEnumDescriptionsSchema,
-  XEnumVarNamesSchema,
-  XAdditionalPropertiesNameSchema,
-  XTags
-);
+const Extensions = compose(XScalarIgnoreSchema, XInternalSchema, XVariableSchema, XExamplesSchema, XEnumDescriptionsSchema, XEnumVarNamesSchema, XAdditionalPropertiesNameSchema, XTags);
 const CorePropertiesWithSchema = Type.Object({
-  name: Type.Optional(Type.String()),
-  /** A title for the schema. */
-  title: Type.Optional(Type.String()),
-  /** A description of the schema. */
-  description: Type.Optional(Type.String()),
-  /** Default value for the schema. */
-  default: Type.Optional(Type.Unknown()),
-  /** Array of allowed values. */
-  enum: Type.Optional(Type.Array(Type.Unknown())),
-  /** Constant value that must match exactly. */
-  const: Type.Optional(Type.Unknown()),
-  /** Media type for content validation. */
-  contentMediaType: Type.Optional(Type.String()),
-  /** Content encoding. */
-  contentEncoding: Type.Optional(Type.String()),
-  /** Schema for content validation. */
-  contentSchema: Type.Optional(schemaOrReference),
-  /** Whether the schema is deprecated. */
-  deprecated: Type.Optional(Type.Boolean()),
-  /** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
-  discriminator: Type.Optional(DiscriminatorObjectRef),
-  /** Whether the schema is read-only. */
-  readOnly: Type.Optional(Type.Boolean()),
-  /** Whether the schema is write-only. */
-  writeOnly: Type.Optional(Type.Boolean()),
-  /** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
-  xml: Type.Optional(XMLObjectRef),
-  /** Additional external documentation for this schema. */
-  externalDocs: Type.Optional(ExternalDocumentationObjectRef),
-  /**
-   * A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
-   *
-   * @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
-   */
-  example: Type.Optional(Type.Unknown()),
-  /**
-   * An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
-   * Each example should be a valid instance of the schema.
-   */
-  examples: Type.Optional(Type.Array(Type.Unknown())),
-  /** All schemas must be valid. */
-  allOf: Type.Optional(Type.Array(schemaOrReference)),
-  /** Exactly one schema must be valid. */
-  oneOf: Type.Optional(Type.Array(schemaOrReference)),
-  /** At least one schema must be valid. */
-  anyOf: Type.Optional(Type.Array(schemaOrReference)),
-  /** Schema must not be valid. */
-  not: Type.Optional(schemaOrReference)
+    name: Type.Optional(Type.String()),
+    /** A title for the schema. */
+    title: Type.Optional(Type.String()),
+    /** A description of the schema. */
+    description: Type.Optional(Type.String()),
+    /** Default value for the schema. */
+    default: Type.Optional(Type.Unknown()),
+    /** Array of allowed values. */
+    enum: Type.Optional(Type.Array(Type.Unknown())),
+    /** Constant value that must match exactly. */
+    const: Type.Optional(Type.Unknown()),
+    /** Media type for content validation. */
+    contentMediaType: Type.Optional(Type.String()),
+    /** Content encoding. */
+    contentEncoding: Type.Optional(Type.String()),
+    /** Schema for content validation. */
+    contentSchema: Type.Optional(schemaOrReference),
+    /** Whether the schema is deprecated. */
+    deprecated: Type.Optional(Type.Boolean()),
+    /** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
+    discriminator: Type.Optional(DiscriminatorObjectRef),
+    /** Whether the schema is read-only. */
+    readOnly: Type.Optional(Type.Boolean()),
+    /** Whether the schema is write-only. */
+    writeOnly: Type.Optional(Type.Boolean()),
+    /** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
+    xml: Type.Optional(XMLObjectRef),
+    /** Additional external documentation for this schema. */
+    externalDocs: Type.Optional(ExternalDocumentationObjectRef),
+    /**
+     * A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
+     *
+     * @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
+     */
+    example: Type.Optional(Type.Unknown()),
+    /**
+     * An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
+     * Each example should be a valid instance of the schema.
+     */
+    examples: Type.Optional(Type.Array(Type.Unknown())),
+    /** All schemas must be valid. */
+    allOf: Type.Optional(Type.Array(schemaOrReference)),
+    /** Exactly one schema must be valid. */
+    oneOf: Type.Optional(Type.Array(schemaOrReference)),
+    /** At least one schema must be valid. */
+    anyOf: Type.Optional(Type.Array(schemaOrReference)),
+    /** Schema must not be valid. */
+    not: Type.Optional(schemaOrReference),
 });
+/**
+ * Numeric validation properties for number and integer types.
+ */
 const NumericProperties = Type.Object({
-  type: Type.Union([Type.Literal("number"), Type.Literal("integer")]),
-  /** Different subtypes */
-  format: Type.Optional(Type.String()),
-  /** Number must be a multiple of this value. */
-  multipleOf: Type.Optional(Type.Number()),
-  /** Maximum value (inclusive). */
-  maximum: Type.Optional(Type.Number()),
-  /** Maximum value (exclusive). */
-  exclusiveMaximum: Type.Optional(Type.Number({ minimum: 0 })),
-  /** Minimum value (inclusive). */
-  minimum: Type.Optional(Type.Number()),
-  /** Minimum value (exclusive). */
-  exclusiveMinimum: Type.Optional(Type.Number({ minimum: 0 }))
+    type: Type.Union([Type.Literal('number'), Type.Literal('integer')]),
+    /** Different subtypes */
+    format: Type.Optional(Type.String()),
+    /** Number must be a multiple of this value. */
+    multipleOf: Type.Optional(Type.Number()),
+    /** Maximum value (inclusive). */
+    maximum: Type.Optional(Type.Number()),
+    /** Maximum value (exclusive). */
+    exclusiveMaximum: Type.Optional(Type.Number({ minimum: 0 })),
+    /** Minimum value (inclusive). */
+    minimum: Type.Optional(Type.Number()),
+    /** Minimum value (exclusive). */
+    exclusiveMinimum: Type.Optional(Type.Number({ minimum: 0 })),
 });
+/**
+ * String validation properties for string types.
+ */
 const StringValidationProperties = Type.Object({
-  type: Type.Literal("string"),
-  /** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
-  format: Type.Optional(Type.String()),
-  /** Maximum string length. */
-  maxLength: Type.Optional(Type.Integer({ minimum: 0 })),
-  /** Minimum string length. */
-  minLength: Type.Optional(Type.Integer({ minimum: 0 })),
-  /** Regular expression pattern. */
-  pattern: Type.Optional(Type.String())
+    type: Type.Literal('string'),
+    /** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
+    format: Type.Optional(Type.String()),
+    /** Maximum string length. */
+    maxLength: Type.Optional(Type.Integer({ minimum: 0 })),
+    /** Minimum string length. */
+    minLength: Type.Optional(Type.Integer({ minimum: 0 })),
+    /** Regular expression pattern. */
+    pattern: Type.Optional(Type.String()),
 });
 const ArrayValidationPropertiesWithSchema = Type.Object({
-  type: Type.Literal("array"),
-  /** Maximum number of items in array. */
-  maxItems: Type.Optional(Type.Integer({ minimum: 0 })),
-  /** Minimum number of items in array. */
-  minItems: Type.Optional(Type.Integer({ minimum: 0 })),
-  /** Whether array items must be unique. */
-  uniqueItems: Type.Optional(Type.Boolean()),
-  /** Schema for array items. */
-  items: Type.Optional(schemaOrReference),
-  /** Schema for tuple validation. */
-  prefixItems: Type.Optional(Type.Array(schemaOrReference))
+    type: Type.Literal('array'),
+    /** Maximum number of items in array. */
+    maxItems: Type.Optional(Type.Integer({ minimum: 0 })),
+    /** Minimum number of items in array. */
+    minItems: Type.Optional(Type.Integer({ minimum: 0 })),
+    /** Whether array items must be unique. */
+    uniqueItems: Type.Optional(Type.Boolean()),
+    /** Schema for array items. */
+    items: Type.Optional(schemaOrReference),
+    /** Schema for tuple validation. */
+    prefixItems: Type.Optional(Type.Array(schemaOrReference)),
 });
 const ObjectValidationPropertiesWithSchema = Type.Object({
-  type: Type.Literal("object"),
-  /** Maximum number of properties. */
-  maxProperties: Type.Optional(Type.Integer({ minimum: 0 })),
-  /** Minimum number of properties. */
-  minProperties: Type.Optional(Type.Integer({ minimum: 0 })),
-  /** Array of required property names. */
-  required: Type.Optional(Type.Array(Type.String())),
-  /** Object property definitions. */
-  properties: Type.Optional(Type.Record(Type.String(), schemaOrReference)),
-  /** Schema for additional properties. */
-  additionalProperties: Type.Optional(Type.Union([Type.Boolean(), schemaOrReference])),
-  /** Properties matching regex patterns. */
-  patternProperties: Type.Optional(Type.Record(Type.String(), schemaOrReference)),
-  /** Constraints on property names (JSON Schema propertyNames keyword). */
-  propertyNames: Type.Optional(schemaOrReference)
+    type: Type.Literal('object'),
+    /** Maximum number of properties. */
+    maxProperties: Type.Optional(Type.Integer({ minimum: 0 })),
+    /** Minimum number of properties. */
+    minProperties: Type.Optional(Type.Integer({ minimum: 0 })),
+    /** Array of required property names. */
+    required: Type.Optional(Type.Array(Type.String())),
+    /** Object property definitions. */
+    properties: Type.Optional(Type.Record(Type.String(), schemaOrReference)),
+    /** Schema for additional properties. */
+    additionalProperties: Type.Optional(Type.Union([Type.Boolean(), schemaOrReference])),
+    /** Properties matching regex patterns. */
+    patternProperties: Type.Optional(Type.Record(Type.String(), schemaOrReference)),
+    /** Constraints on property names (JSON Schema propertyNames keyword). */
+    propertyNames: Type.Optional(schemaOrReference),
 });
-const SchemaObjectSchemaDefinition = Type.Union([
-  // Keep compositions first so they get priority when union is evaluated
-  // Make sure there is always a required field so not all properties are optional
-  // When all properties are optional (1) typescript will not throw any warnings/error and accepts anything
-  // even a non resolved ref and (2) it will match any schema so it will not validate the refs correctly
-  compose(Type.Object({ __scalar_: Type.String() }), CorePropertiesWithSchema, Extensions),
-  compose(OtherTypes, CorePropertiesWithSchema, Extensions),
-  compose(NumericProperties, CorePropertiesWithSchema, Extensions),
-  compose(StringValidationProperties, CorePropertiesWithSchema, Extensions),
-  compose(ObjectValidationPropertiesWithSchema, CorePropertiesWithSchema, Extensions),
-  compose(ArrayValidationPropertiesWithSchema, CorePropertiesWithSchema, Extensions)
+/** Builds the recursive schema schema */
+export const SchemaObjectSchemaDefinition = Type.Union([
+    // Keep compositions first so they get priority when union is evaluated
+    // Make sure there is always a required field so not all properties are optional
+    // When all properties are optional (1) typescript will not throw any warnings/error and accepts anything
+    // even a non resolved ref and (2) it will match any schema so it will not validate the refs correctly
+    compose(Type.Object({ __scalar_: Type.String() }), CorePropertiesWithSchema, Extensions),
+    compose(OtherTypes, CorePropertiesWithSchema, Extensions),
+    compose(NumericProperties, CorePropertiesWithSchema, Extensions),
+    compose(StringValidationProperties, CorePropertiesWithSchema, Extensions),
+    compose(ObjectValidationPropertiesWithSchema, CorePropertiesWithSchema, Extensions),
+    compose(ArrayValidationPropertiesWithSchema, CorePropertiesWithSchema, Extensions),
 ]);
-export {
-  SchemaObjectSchemaDefinition
-};
-//# sourceMappingURL=schema.js.map

package/dist/schemas/v3.1/strict/security-requirement.js

@@ -1,12 +1,13 @@
-import { Type } from "@scalar/typebox";
-const SecurityRequirementObjectSchemaDefinition = Type.Partial(
-  Type.Record(
-    /** Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain a list of role names which are required for the execution, but are not otherwise defined or exchanged in-band. */
-    Type.String(),
-    Type.Array(Type.String())
-  )
-);
-export {
-  SecurityRequirementObjectSchemaDefinition
-};
-//# sourceMappingURL=security-requirement.js.map
+import { Type } from '@scalar/typebox';
+/**
+ * Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.
+ *
+ * A Security Requirement Object MAY refer to multiple security schemes in which case all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information.
+ *
+ * When the security field is defined on the OpenAPI Object or Operation Object and contains multiple Security Requirement Objects, only one of the entries in the list needs to be satisfied to authorize the request. This enables support for scenarios where the API allows multiple, independent security schemes.
+ *
+ * An empty Security Requirement Object ({}) indicates anonymous access is supported.
+ */
+export const SecurityRequirementObjectSchemaDefinition = Type.Partial(Type.Record(
+/** Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain a list of role names which are required for the execution, but are not otherwise defined or exchanged in-band. */
+Type.String(), Type.Array(Type.String())));

package/dist/schemas/v3.1/strict/security-scheme.js

@@ -1,54 +1,42 @@
-import { Type } from "@scalar/typebox";
-import { compose } from "../../../schemas/compose.js";
-import { XDefaultScopesSchema } from "../../../schemas/extensions/security/x-default-scopes.js";
-import { OAuthFlowsObjectRef } from "../../../schemas/v3.1/strict/ref-definitions.js";
+import { Type } from '@scalar/typebox';
+import { compose } from '../../../schemas/compose.js';
+import { XDefaultScopesSchema } from '../../../schemas/extensions/security/x-default-scopes.js';
+import { OAuthFlowsObjectRef } from '../../../schemas/v3.1/strict/ref-definitions.js';
 const DescriptionSchema = Type.Object({
-  /** A description for security scheme. CommonMark syntax MAY be used for rich text representation. */
-  description: Type.Optional(Type.String())
+    /** A description for security scheme. CommonMark syntax MAY be used for rich text representation. */
+    description: Type.Optional(Type.String()),
 });
-const ApiKeySchema = compose(
-  DescriptionSchema,
-  Type.Object({
+const ApiKeySchema = compose(DescriptionSchema, Type.Object({
     /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
-    type: Type.Literal("apiKey"),
+    type: Type.Literal('apiKey'),
     /** REQUIRED. The name of the header, query or cookie parameter to be used. */
     name: Type.String(),
     /** REQUIRED. The location of the API key. Valid values are "query", "header", or "cookie". */
-    in: Type.Union([Type.Literal("query"), Type.Literal("header"), Type.Literal("cookie")])
-  })
-);
-const HttpSchema = compose(
-  DescriptionSchema,
-  Type.Object({
+    in: Type.Union([Type.Literal('query'), Type.Literal('header'), Type.Literal('cookie')]),
+}));
+const HttpSchema = compose(DescriptionSchema, Type.Object({
     /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
-    type: Type.Literal("http"),
+    type: Type.Literal('http'),
     /** REQUIRED. The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry. The value is case-insensitive, as defined in RFC7235. */
-    scheme: Type.Union([Type.Literal("basic"), Type.Literal("bearer")]),
+    scheme: Type.Union([Type.Literal('basic'), Type.Literal('bearer')]),
     /** 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: Type.Optional(Type.String())
-  })
-);
-const OAuth2 = compose(
-  DescriptionSchema,
-  Type.Object({
+    bearerFormat: Type.Optional(Type.String()),
+}));
+const OAuth2 = compose(DescriptionSchema, Type.Object({
     /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
-    type: Type.Literal("oauth2"),
+    type: Type.Literal('oauth2'),
     /** REQUIRED. An object containing configuration information for the flow types supported. */
-    flows: OAuthFlowsObjectRef
-  }),
-  XDefaultScopesSchema
-);
-const OpenIdConnect = compose(
-  DescriptionSchema,
-  Type.Object({
+    flows: OAuthFlowsObjectRef,
+}), XDefaultScopesSchema);
+const OpenIdConnect = compose(DescriptionSchema, Type.Object({
     /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
-    type: Type.Literal("openIdConnect"),
+    type: Type.Literal('openIdConnect'),
     /** REQUIRED. Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata. */
-    openIdConnectUrl: Type.String()
-  })
-);
-const SecuritySchemeObjectSchemaDefinition = Type.Union([ApiKeySchema, HttpSchema, OAuth2, OpenIdConnect]);
-export {
-  SecuritySchemeObjectSchemaDefinition
-};
-//# sourceMappingURL=security-scheme.js.map
+    openIdConnectUrl: Type.String(),
+}));
+/**
+ * Defines a security scheme that can be used by the operations.
+ *
+ * Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and [[OpenID-Connect-Core]]. Please note that as of 2020, the implicit flow is about to be deprecated by OAuth 2.0 Security Best Current Practice. Recommended for most use cases is Authorization Code Grant flow with PKCE.
+ */
+export const SecuritySchemeObjectSchemaDefinition = Type.Union([ApiKeySchema, HttpSchema, OAuth2, OpenIdConnect]);

package/dist/schemas/v3.1/strict/server-variable.js

@@ -1,13 +1,10 @@
-import { Type } from "@scalar/typebox";
-const ServerVariableObjectSchemaDefinition = Type.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: Type.Optional(Type.Array(Type.String())),
-  /** REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. If the enum is defined, the value MUST exist in the enum's values. Note that this behavior is different from the Schema Object's default keyword, which documents the receiver's behavior rather than inserting the value into the data. */
-  default: Type.Optional(Type.String()),
-  /** An optional description for the server variable. CommonMark syntax MAY be used for rich text representation. */
-  description: Type.Optional(Type.String())
+import { Type } from '@scalar/typebox';
+/** An object representing a Server Variable for server URL template substitution. */
+export const ServerVariableObjectSchemaDefinition = Type.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: Type.Optional(Type.Array(Type.String())),
+    /** REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. If the enum is defined, the value MUST exist in the enum's values. Note that this behavior is different from the Schema Object's default keyword, which documents the receiver's behavior rather than inserting the value into the data. */
+    default: Type.Optional(Type.String()),
+    /** An optional description for the server variable. CommonMark syntax MAY be used for rich text representation. */
+    description: Type.Optional(Type.String()),
 });
-export {
-  ServerVariableObjectSchemaDefinition
-};
-//# sourceMappingURL=server-variable.js.map

package/dist/schemas/v3.1/strict/server.js

@@ -1,14 +1,11 @@
-import { Type } from "@scalar/typebox";
-import { ServerVariableObjectRef } from "./ref-definitions.js";
-const ServerObjectSchemaDefinition = Type.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 document containing the Server Object is being served. Variable substitutions will be made when a variable is named in {braces}. */
-  url: Type.String(),
-  /** An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation. */
-  description: Type.Optional(Type.String()),
-  /** A map between a variable name and its value. The value is used for substitution in the server's URL template. */
-  variables: Type.Optional(Type.Record(Type.String(), ServerVariableObjectRef))
+import { Type } from '@scalar/typebox';
+import { ServerVariableObjectRef } from './ref-definitions.js';
+/** An object representing a Server. */
+export const ServerObjectSchemaDefinition = Type.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 document containing the Server Object is being served. Variable substitutions will be made when a variable is named in {braces}. */
+    url: Type.String(),
+    /** An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation. */
+    description: Type.Optional(Type.String()),
+    /** A map between a variable name and its value. The value is used for substitution in the server's URL template. */
+    variables: Type.Optional(Type.Record(Type.String(), ServerVariableObjectRef)),
 });
-export {
-  ServerObjectSchemaDefinition
-};
-//# sourceMappingURL=server.js.map

package/dist/schemas/v3.1/strict/tag.js

@@ -1,25 +1,16 @@
-import { Type } from "@scalar/typebox";
-import { compose } from "../../../schemas/compose.js";
-import { XInternalSchema } from "../../../schemas/extensions/document/x-internal.js";
-import { XScalarIgnoreSchema } from "../../../schemas/extensions/document/x-scalar-ignore.js";
-import { XScalarOrderSchema } from "../../../schemas/extensions/general/x-scalar-order.js";
-import { XDisplayNameSchema } from "../../../schemas/extensions/tag/x-display-name.js";
-import { ExternalDocumentationObjectRef } from "./ref-definitions.js";
-const TagObjectSchemaDefinition = compose(
-  Type.Object({
+import { Type } from '@scalar/typebox';
+import { compose } from '../../../schemas/compose.js';
+import { XInternalSchema } from '../../../schemas/extensions/document/x-internal.js';
+import { XScalarIgnoreSchema } from '../../../schemas/extensions/document/x-scalar-ignore.js';
+import { XScalarOrderSchema } from '../../../schemas/extensions/general/x-scalar-order.js';
+import { XDisplayNameSchema } from '../../../schemas/extensions/tag/x-display-name.js';
+import { ExternalDocumentationObjectRef } from './ref-definitions.js';
+/** 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. */
+export const TagObjectSchemaDefinition = compose(Type.Object({
     /** REQUIRED. The name of the tag. */
     name: Type.String(),
     /** A description for the tag. CommonMark syntax MAY be used for rich text representation. */
     description: Type.Optional(Type.String()),
     /** Additional external documentation for this tag. */
-    externalDocs: Type.Optional(ExternalDocumentationObjectRef)
-  }),
-  XDisplayNameSchema,
-  XInternalSchema,
-  XScalarIgnoreSchema,
-  XScalarOrderSchema
-);
-export {
-  TagObjectSchemaDefinition
-};
-//# sourceMappingURL=tag.js.map
+    externalDocs: Type.Optional(ExternalDocumentationObjectRef),
+}), XDisplayNameSchema, XInternalSchema, XScalarIgnoreSchema, XScalarOrderSchema);

package/dist/schemas/v3.1/strict/type-guards.js

@@ -1,25 +1,25 @@
-const isObjectSchema = (schema) => {
-  return "type" in schema && (schema.type === "object" || Array.isArray(schema.type) && schema.type.includes("object"));
+export const isObjectSchema = (schema) => {
+    return ('type' in schema && (schema.type === 'object' || (Array.isArray(schema.type) && schema.type.includes('object'))));
 };
-const isArraySchema = (schema) => {
-  return "type" in schema && (schema.type === "array" || Array.isArray(schema.type) && schema.type.includes("array"));
+export const isArraySchema = (schema) => {
+    return 'type' in schema && (schema.type === 'array' || (Array.isArray(schema.type) && schema.type.includes('array')));
 };
-const isStringSchema = (schema) => {
-  return "type" in schema && (schema.type === "string" || Array.isArray(schema.type) && schema.type.includes("string"));
+export const isStringSchema = (schema) => {
+    return ('type' in schema && (schema.type === 'string' || (Array.isArray(schema.type) && schema.type.includes('string'))));
 };
-const isNumberSchema = (schema) => {
-  return "type" in schema && (schema.type === "number" || schema.type === "integer" || Array.isArray(schema.type) && schema.type.includes("number") || Array.isArray(schema.type) && schema.type.includes("integer"));
+export const isNumberSchema = (schema) => {
+    return ('type' in schema &&
+        (schema.type === 'number' ||
+            schema.type === 'integer' ||
+            (Array.isArray(schema.type) && schema.type.includes('number')) ||
+            (Array.isArray(schema.type) && schema.type.includes('integer'))));
 };
-const isSchema = (schema) => schema !== void 0 && "type" in schema;
-const isContentTypeParameterObject = (parameter) => {
-  return "content" in parameter && parameter.content !== void 0;
+/** Special type guard to remove our internal type */
+export const isSchema = (schema) => schema !== undefined && 'type' in schema;
+/**
+ * Type guard to check if the given parameter is a ParameterWithContentObject,
+ * i.e., it has a 'content' property defined.
+ */
+export const isContentTypeParameterObject = (parameter) => {
+    return 'content' in parameter && parameter.content !== undefined;
 };
-export {
-  isArraySchema,
-  isContentTypeParameterObject,
-  isNumberSchema,
-  isObjectSchema,
-  isSchema,
-  isStringSchema
-};
-//# sourceMappingURL=type-guards.js.map