@tsed/openspec 7.83.3 → 8.0.0-alpha.10

package/lib/types-esm/common/OpenSpecJsonSchema.d.ts

@@ -1,151 +0,0 @@
-import { OpenSpecHash } from "./OpenSpecHash.js";
-import { OpenSpecRef } from "./OpenSpecRef.js";
-import { OpenSpecTypes } from "./OpenSpecTypes.js";
-export interface OpenSpecBaseJsonSchema {
-    $ref?: string;
-    /**
-     * This attribute is a string that provides a short description of the instance property.
-     *
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.2
-     */
-    title?: string;
-    /**
-     * Must be strictly greater than 0.
-     * A numeric instance is valid only if division by this keyword's value results in an integer.
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.1
-     */
-    multipleOf?: number;
-    /**
-     * Representing an inclusive upper limit for a numeric instance.
-     * This keyword validates only if the instance is less than or exactly equal to "maximum".
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.2
-     */
-    maximum?: number;
-    /**
-     * Representing an exclusive upper limit for a numeric instance.
-     * This keyword validates only if the instance is strictly less than (not equal to) to "exclusiveMaximum".
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.3
-     */
-    exclusiveMaximum?: boolean;
-    /**
-     * Representing an inclusive lower limit for a numeric instance.
-     * This keyword validates only if the instance is greater than or exactly equal to "minimum".
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.4
-     */
-    minimum?: number;
-    /**
-     * Representing an exclusive lower limit for a numeric instance.
-     * This keyword validates only if the instance is strictly greater than (not equal to) to "exclusiveMinimum".
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.5
-     */
-    exclusiveMinimum?: boolean;
-    /**
-     * Must be a non-negative integer.
-     * A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword.
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.6
-     */
-    maxLength?: number;
-    /**
-     * Must be a non-negative integer.
-     * A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword.
-     * Omitting this keyword has the same behavior as a value of 0.
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.7
-     */
-    minLength?: number;
-    /**
-     * Should be a valid regular expression, according to the ECMA 262 regular expression dialect.
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.8
-     */
-    pattern?: string;
-    /**
-     * Must be a non-negative integer.
-     * An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword.
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.11
-     */
-    maxItems?: number;
-    /**
-     * Must be a non-negative integer.
-     * An array instance is valid against "maxItems" if its size is greater than, or equal to, the value of this keyword.
-     * Omitting this keyword has the same behavior as a value of 0.
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.12
-     */
-    minItems?: number;
-    /**
-     * If this keyword has boolean value false, the instance validates successfully.
-     * If it has boolean value true, the instance validates successfully if all of its elements are unique.
-     * Omitting this keyword has the same behavior as a value of false.
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.13
-     */
-    uniqueItems?: boolean;
-    /**
-     * Must be a non-negative integer.
-     * An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword.
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.15
-     */
-    maxProperties?: number;
-    /**
-     * Must be a non-negative integer.
-     * An object instance is valid against "maxProperties" if its number of properties is greater than,
-     * or equal to, the value of this keyword.
-     * Omitting this keyword has the same behavior as a value of 0.
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.16
-     */
-    minProperties?: number;
-    /**
-     * This provides an enumeration of all possible values that are valid
-     * for the instance property. This MUST be an array, and each item in
-     * the array represents a possible value for the instance value. If
-     * this attribute is defined, the instance value MUST be one of the
-     * values in the array in order for the schema to be valid.
-     *
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.23
-     */
-    enum?: any[];
-    /**
-     * This attribute is a string that provides a full description of the of purpose the instance property.
-     *
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.2
-     */
-    description?: string;
-    /**
-     * This keyword can be used to supply a default JSON value associated with a particular schema.
-     * It is RECOMMENDED that a default value be valid against the associated schema.
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.3
-     */
-    default?: any;
-    /**
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-8
-     */
-    format?: string;
-    /**
-     * A single type, or a union of simple types
-     * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.25
-     */
-    type?: OpenSpecTypes;
-}
-export interface OpenSpecJsonSchema<Schema = any> extends OpenSpecBaseJsonSchema {
-    /**
-     * Required if type is "array". Describes the type of items in the array.
-     */
-    items?: Schema | OpenSpecRef;
-    /**
-     * A free-form property to include an example of an instance for this schema.
-     */
-    required?: string[];
-    /**
-     * Value can be boolean or object. Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
-     */
-    additionalProperties?: Schema | boolean;
-    /**
-     * Property definitions MUST be a Schema Object and not a standard JSON Schema (inline or referenced).
-     */
-    properties?: OpenSpecHash<Schema>;
-    /**
-     * Inline or referenced schema MUST be of a [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#schemaObject) and not a standard JSON Schema.
-     */
-    allOf?: (Schema | OpenSpecRef)[];
-    /**
-     * Additional external documentation for this schema.
-     */
-    example?: any;
-}

package/lib/types-esm/common/OpenSpecPath.d.ts

@@ -1,10 +0,0 @@
-export interface OpenSpecPath<Operation> {
-    $ref?: string;
-    get?: Operation;
-    put?: Operation;
-    post?: Operation;
-    delete?: Operation;
-    options?: Operation;
-    head?: Operation;
-    patch?: Operation;
-}

package/lib/types-esm/common/OpenSpecRef.d.ts

@@ -1,3 +0,0 @@
-export interface OpenSpecRef {
-    $ref: string;
-}

package/lib/types-esm/common/OpenSpecSecurity.d.ts

@@ -1,2 +0,0 @@
-import { OpenSpecHash } from "./OpenSpecHash.js";
-export type OpenSpecSecurity = OpenSpecHash<string[]>[];

package/lib/types-esm/common/OpenSpecTag.d.ts

@@ -1,6 +0,0 @@
-import { OpenSpecExternalDocs } from "./OpenSpecExternalDocs.js";
-export interface OpenSpecTag {
-    name: string;
-    description?: string;
-    externalDocs?: OpenSpecExternalDocs;
-}

package/lib/types-esm/common/OpenSpecTypes.d.ts

@@ -1 +0,0 @@
-export type OpenSpecTypes = "string" | "number" | "integer" | "boolean" | "array" | "object" | "file";

package/lib/types-esm/common/OpenSpecVersions.d.ts

@@ -1,3 +0,0 @@
-export type OS2Versions = "2.0";
-export type OS3Versions = "3.0.1" | "3.0.2" | "3.0.3" | "3.1.0";
-export type OpenSpecVersions = OS2Versions | OS3Versions;

package/lib/types-esm/common/OpenSpecXML.d.ts

@@ -1,22 +0,0 @@
-export interface OpenSpecXML {
-    /**
-     * Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.
-     */
-    name?: string;
-    /**
-     * The URI of the namespace definition. Value MUST be in the form of an absolute URI.
-     */
-    namespace?: string;
-    /**
-     * The prefix to be used for the [name](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#xmlName).
-     */
-    prefix?: string;
-    /**
-     * Declares whether the property definition translates to an attribute instead of an element. Default value is false.
-     */
-    attribute?: boolean;
-    /**
-     * MAY be used only for an array definition. Signifies whether the array is wrapped (for example, <books><book/><book/></books>) or unwrapped (<book/><book/>). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).
-     */
-    wrapped?: boolean;
-}

package/lib/types-esm/index.d.ts

@@ -1,39 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./common/OpenSpecExternalDocs.js";
-export * from "./common/OpenSpecHash.js";
-export * from "./common/OpenSpecInfo.js";
-export * from "./common/OpenSpecJsonSchema.js";
-export * from "./common/OpenSpecPath.js";
-export * from "./common/OpenSpecRef.js";
-export * from "./common/OpenSpecSecurity.js";
-export * from "./common/OpenSpecTag.js";
-export * from "./common/OpenSpecTypes.js";
-export * from "./common/OpenSpecVersions.js";
-export * from "./common/OpenSpecXML.js";
-export * from "./openspec2/OpenSpec2.js";
-export * from "./openspec2/OS2Header.js";
-export * from "./openspec2/OS2Operation.js";
-export * from "./openspec2/OS2Parameter.js";
-export * from "./openspec2/OS2Paths.js";
-export * from "./openspec2/OS2Response.js";
-export * from "./openspec2/OS2Schema.js";
-export * from "./openspec2/OS2Security.js";
-export * from "./openspec3/OpenSpec3.js";
-export * from "./openspec3/OS3Callbacks.js";
-export * from "./openspec3/OS3Components.js";
-export * from "./openspec3/OS3Encoding.js";
-export * from "./openspec3/OS3Example.js";
-export * from "./openspec3/OS3Flows.js";
-export * from "./openspec3/OS3Header.js";
-export * from "./openspec3/OS3Link.js";
-export * from "./openspec3/OS3MediaType.js";
-export * from "./openspec3/OS3Operation.js";
-export * from "./openspec3/OS3Parameter.js";
-export * from "./openspec3/OS3Paths.js";
-export * from "./openspec3/OS3RequestBody.js";
-export * from "./openspec3/OS3Response.js";
-export * from "./openspec3/OS3Schema.js";
-export * from "./openspec3/OS3Security.js";
-export * from "./openspec3/OS3Server.js";

package/lib/types-esm/openspec2/OS2Header.d.ts

@@ -1,7 +0,0 @@
-import { OS2BaseSchema } from "./OS2Schema.js";
-export interface OS2Header extends OS2BaseSchema {
-    /**
-     * The type of the object. The value MUST be one of `string`, `number`, `integer`, `boolean`, or `array`.
-     */
-    type: "string" | "number" | "integer" | "boolean" | "array";
-}

package/lib/types-esm/openspec2/OS2Operation.d.ts

@@ -1,64 +0,0 @@
-import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-import { OpenSpecRef } from "../common/OpenSpecRef.js";
-import { OpenSpecSecurity } from "../common/OpenSpecSecurity.js";
-import { OS2Parameter } from "./OS2Parameter.js";
-import { OS2Response } from "./OS2Response.js";
-export interface OS2Operation {
-    /**
-     * A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
-     */
-    tags?: string[];
-    /**
-     * A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
-     */
-    summary?: string;
-    /**
-     * A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.
-     */
-    description?: string;
-    /**
-     * Additional external documentation for this operation.
-     */
-    externalDocs?: OpenSpecExternalDocs;
-    /**
-     * Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
-     */
-    operationId?: string;
-    /**
-     * A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#mimeTypes).
-     */
-    consumes?: string[];
-    /**
-     * A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#mimeTypes).
-     */
-    produces?: string[];
-    /**
-     * A list of parameters that are applicable for this operation.
-     * If a parameter is already defined at the [Path Item](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathItemParameters),
-     * the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters.
-     * A unique parameter is defined by a combination of a [name](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterName) and (location)[https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterIn].
-     * The list can use the [Reference Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#referenceObject) to link to parameters that are defined at the [Swagger Object's parameters](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerParameters).
-     * There can be one "body" parameter at most.
-     */
-    parameters?: (OS2Parameter | OpenSpecRef)[];
-    /**
-     * The list of possible responses as they are returned from executing this operation.
-     */
-    responses: OpenSpecHash<OS2Response | OpenSpecRef>;
-    /**
-     * The transfer protocol of the API. Values MUST be from the list: `http`, `https`, `ws`, `wss`. If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
-     */
-    schemes?: string[];
-    /**
-     * Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.
-     */
-    deprecated?: boolean;
-    /**
-     * A declaration of which security schemes are applied for this operation.
-     * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
-     * This definition overrides any declared top-level [security](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerSecurity).
-     * To remove a top-level security declaration, an empty array can be used.
-     */
-    security?: OpenSpecSecurity;
-}

package/lib/types-esm/openspec2/OS2Parameter.d.ts

@@ -1,50 +0,0 @@
-import { OpenSpecTypes } from "../common/OpenSpecTypes.js";
-import { OS2BaseSchema, OS2Schema } from "./OS2Schema.js";
-export type OS2BaseParameter = {
-    name: string;
-    in: "body" | "query" | "path" | "header" | "formData";
-    required?: boolean;
-    description?: string;
-};
-export type OS2BodyParameter = OS2BaseParameter & {
-    in: "body";
-    schema?: OS2Schema;
-};
-export type OS2GenericFormat = {
-    type?: OpenSpecTypes;
-    format?: string;
-};
-export type OS2IntegerFormat = {
-    type: "integer";
-    format?: "int32" | "int64";
-};
-export type OS2NumberFormat = {
-    type: "number";
-    format?: "float" | "double";
-};
-export type OS2StringFormat = {
-    type: "string";
-    format?: "" | "byte" | "binary" | "date" | "date-time" | "password";
-};
-export type OS2SchemaFormatConstraints = OS2GenericFormat | OS2IntegerFormat | OS2NumberFormat | OS2StringFormat;
-export type OS2BaseFormatContrainedParameter = OS2BaseParameter & OS2SchemaFormatConstraints;
-export type ParameterCollectionFormat = "csv" | "ssv" | "tsv" | "pipes" | "multi";
-export type OS2QueryParameter = OS2BaseFormatContrainedParameter & OS2BaseSchema & {
-    in: "query";
-    allowEmptyValue?: boolean;
-    collectionFormat?: ParameterCollectionFormat;
-};
-export type OS2PathParameter = OS2BaseFormatContrainedParameter & OS2BaseSchema & {
-    in: "path";
-    required: true;
-};
-export type OS2HeaderParameter = OS2BaseFormatContrainedParameter & OS2BaseSchema & {
-    in: "header";
-};
-export type OS2FormDataParameter = OS2BaseFormatContrainedParameter & OS2BaseSchema & {
-    in: "formData";
-    type: OpenSpecTypes;
-    allowEmptyValue?: boolean;
-    collectionFormat?: ParameterCollectionFormat;
-};
-export type OS2Parameter = OS2BodyParameter | OS2FormDataParameter | OS2QueryParameter | OS2PathParameter | OS2HeaderParameter;

package/lib/types-esm/openspec2/OS2Paths.d.ts

@@ -1,7 +0,0 @@
-import { OpenSpecPath } from "../common/OpenSpecPath.js";
-import { OpenSpecRef } from "../common/OpenSpecRef.js";
-import { OS2Operation } from "./OS2Operation.js";
-import { OS2Parameter } from "./OS2Parameter.js";
-export interface OS2Paths extends OpenSpecPath<OS2Operation> {
-    parameters?: (OS2Parameter | OpenSpecRef)[];
-}

package/lib/types-esm/openspec2/OS2Response.d.ts

@@ -1,21 +0,0 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-import { OS2Header } from "./OS2Header.js";
-import { OS2Schema } from "./OS2Schema.js";
-export interface OS2Response {
-    /**
-     * A short description of the response. GFM syntax can be used for rich text representation.
-     */
-    description: string;
-    /**
-     * A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the Schema Object, its root type value may also be "file". This SHOULD be accompanied by a relevant produces mime-type.
-     */
-    schema?: OS2Schema;
-    /**
-     * A list of headers that are sent with the response.
-     */
-    headers?: OpenSpecHash<OS2Header>;
-    /**
-     * An example of the response message.
-     */
-    examples?: OpenSpecHash<{}>;
-}

package/lib/types-esm/openspec2/OS2Schema.d.ts

@@ -1,36 +0,0 @@
-import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
-import { OpenSpecBaseJsonSchema, OpenSpecJsonSchema } from "../common/OpenSpecJsonSchema.js";
-import { OpenSpecRef } from "../common/OpenSpecRef.js";
-import { OpenSpecXML } from "../common/OpenSpecXML.js";
-export interface OS2XML {
-    name?: string;
-    namespace?: string;
-    prefix?: string;
-    attribute?: boolean;
-    wrapped?: boolean;
-}
-export interface OS2BaseSchema extends OpenSpecBaseJsonSchema {
-    /**
-     * Required if type is "array". Describes the type of items in the array.
-     */
-    items?: OS2Schema | OpenSpecRef;
-}
-export interface OS2Schema extends OpenSpecJsonSchema<OS2Schema> {
-    /**
-     * Adds support for polymorphism.
-     * The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the required property list. When used, the value MUST be the name of this schema or any schema that inherits it.
-     */
-    discriminator?: string;
-    /**
-     * Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. Properties marked as readOnly being true SHOULD NOT be in the required list of the defined schema. Default value is false.
-     */
-    readOnly?: boolean;
-    /**
-     * This MAY be used only on properties schemas. It has no effect on root schemas. Adds Additional metadata to describe the XML representation format of this property.
-     */
-    xml?: OpenSpecXML;
-    /**
-     * Additional external documentation for this schema.
-     */
-    externalDocs?: OpenSpecExternalDocs;
-}

package/lib/types-esm/openspec2/OS2Security.d.ts

@@ -1,49 +0,0 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-export interface OS2SecurityBase {
-    /**
-     * The type of the security scheme
-     */
-    type: "basic" | "apiKey" | "oauth2";
-    /**
-     *
-     */
-    description?: string;
-}
-export interface OS2SecurityBasic extends OS2SecurityBase {
-    type: "basic";
-}
-export interface OS2SecurityApiKey extends OS2SecurityBase {
-    type: "apiKey";
-    name: string;
-    in: "query" | "header";
-}
-export interface OS2SecurityOAuth extends OS2SecurityBase {
-    type: "oauth2";
-    flow: "accessCode" | "application" | "implicit" | "password";
-    /**
-     * The available scopes for the OAuth2 security scheme.
-     */
-    scopes: OpenSpecHash<string>;
-}
-export interface OS2FlowImplicit extends OS2SecurityOAuth {
-    type: "oauth2";
-    flow: "implicit";
-    authorizationUrl: string;
-}
-export interface OS2FlowPassword extends OS2SecurityOAuth {
-    type: "oauth2";
-    flow: "password";
-    tokenUrl: string;
-}
-export interface OS2FlowApplication extends OS2SecurityOAuth {
-    type: "oauth2";
-    flow: "application";
-    tokenUrl: string;
-}
-export interface OS2FlowAccessCode extends OS2SecurityOAuth {
-    type: "oauth2";
-    flow: "accessCode";
-    tokenUrl: string;
-    authorizationUrl: string;
-}
-export type OS2Security = OS2SecurityBasic | OS2FlowAccessCode | OS2FlowApplication | OS2FlowImplicit | OS2FlowPassword | OS2SecurityApiKey;

package/lib/types-esm/openspec2/OpenSpec2.d.ts

@@ -1,72 +0,0 @@
-import { OS2Response } from "./OS2Response.js";
-import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-import { OpenSpecInfo } from "../common/OpenSpecInfo.js";
-import { OpenSpecSecurity } from "../common/OpenSpecSecurity.js";
-import { OpenSpecTag } from "../common/OpenSpecTag.js";
-import { OS2BodyParameter, OS2QueryParameter } from "./OS2Parameter.js";
-import { OS2Paths } from "./OS2Paths.js";
-import { OS2Schema } from "./OS2Schema.js";
-import { OS2Security } from "./OS2Security.js";
-export interface OpenSpec2 {
-    /**
-     * Specifies the Swagger Specification version being used. It can be used by the Swagger UI and other clients to interpret the API listing. The value MUST be "2.0".
-     */
-    swagger: string;
-    /**
-     * Provides metadata about the API. The metadata can be used by the clients if needed.
-     */
-    info?: OpenSpecInfo;
-    /**
-     * The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support [path templating](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathTemplating).
-     */
-    host?: string;
-    /**
-     * The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path [path templating](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathTemplating).
-     */
-    basePath?: string;
-    /**
-     * The transfer protocol of the API. Values MUST be from the list: `http`, `https`, `ws`, `wss`. If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
-     */
-    schemes?: ("http" | "https" | "ws" | "wss")[];
-    /**
-     * A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under [Mime Types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#mimeTypes).
-     */
-    consumes?: string[];
-    /**
-     * A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under [Mime Types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#mimeTypes).
-     */
-    produces?: string[];
-    /**
-     * The available paths and operations for the API.
-     */
-    paths?: OpenSpecHash<OS2Paths>;
-    /**
-     * An object to hold data types produced and consumed by operations.
-     */
-    definitions?: OpenSpecHash<OS2Schema>;
-    /**
-     * An object to hold parameters that can be used across operations. This property does not define global parameters for all operations.
-     */
-    parameters?: OpenSpecHash<OS2BodyParameter | OS2QueryParameter>;
-    /**
-     * An object to hold responses that can be used across operations. This property does not define global responses for all operations.
-     */
-    responses?: OpenSpecHash<OS2Response>;
-    /**
-     * A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
-     */
-    security?: OpenSpecSecurity;
-    /**
-     * Security scheme definitions that can be used across the specification.
-     */
-    securityDefinitions?: OpenSpecHash<OS2Security>;
-    /**
-     * A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared may be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.
-     */
-    tags?: OpenSpecTag[];
-    /**
-     * Additional external documentation.
-     */
-    externalDocs?: OpenSpecExternalDocs;
-}

package/lib/types-esm/openspec3/OS3Callbacks.d.ts

@@ -1,4 +0,0 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-import { OS3Paths } from "./OS3Paths.js";
-import { OS3Schema } from "./OS3Schema.js";
-export type OS3Callbacks<Schema = OS3Schema> = OpenSpecHash<OpenSpecHash<OS3Paths<Schema>>>;

package/lib/types-esm/openspec3/OS3Components.d.ts

@@ -1,48 +0,0 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-import { OS3Callbacks } from "./OS3Callbacks.js";
-import { OS3Example } from "./OS3Example.js";
-import { OS3Header } from "./OS3Header.js";
-import { OS3Link } from "./OS3Link.js";
-import { OS3Parameter } from "./OS3Parameter.js";
-import { OS3RequestBody } from "./OS3RequestBody.js";
-import { OS3Response } from "./OS3Response.js";
-import { OS3Schema } from "./OS3Schema.js";
-import { OS3Security } from "./OS3Security.js";
-export interface OS3Components<Schema = OS3Schema> {
-    /**
-     * An object to hold reusable [Schema Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#schemaObject).
-     */
-    schemas?: OpenSpecHash<Schema>;
-    /**
-     * An object to hold reusable [Response Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#responseObject).
-     */
-    responses?: OpenSpecHash<OS3Response<Schema>>;
-    /**
-     * An object to hold reusable [Parameter Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#parameterObject).
-     */
-    parameters?: OpenSpecHash<OS3Parameter<Schema>>;
-    /**
-     * An object to hold reusable [Example Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#exampleObject).
-     */
-    examples?: OpenSpecHash<OS3Example>;
-    /**
-     * An object to hold reusable [Request Body Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#requestBodyObject).
-     */
-    requestBodies?: OpenSpecHash<OS3RequestBody<Schema>>;
-    /**
-     * An object to hold reusable [Header Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#headerObject).
-     */
-    headers?: OpenSpecHash<OS3Header<Schema>>;
-    /**
-     * An object to hold reusable [Security Scheme Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#securitySchemeObject).
-     */
-    securitySchemes?: OpenSpecHash<OS3Security>;
-    /**
-     * An object to hold reusable [Link Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#linkObject).
-     */
-    links?: OpenSpecHash<OS3Link>;
-    /**
-     * An object to hold reusable [Callback Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#callbackObject).
-     */
-    callbacks?: OS3Callbacks;
-}

package/lib/types-esm/openspec3/OS3Encoding.d.ts

@@ -1,24 +0,0 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-import { OS3Header } from "./OS3Header.js";
-export interface OS3Encoding {
-    /**
-     * The `Content-Type` for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - application/json; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types.
-     */
-    contentType?: string;
-    /**
-     * A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a multipart.
-     */
-    headers?: OpenSpecHash<OS3Header>;
-    /**
-     * Describes how a specific property value will be serialized depending on its type. See [Parameter Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#parameterObject) for details on the `[style](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#parameterStyle)` property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`.
-     */
-    style?: string;
-    /**
-     * When this is true, property values of type `array` or `object` generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When `[style](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#parameterStyle)` is `form`, the default value is true. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`.
-     */
-    explode?: boolean;
-    /**
-     * Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`.
-     */
-    allowReserved?: boolean;
-}