@typia/interface 12.0.0-dev.20260225

package/lib/openapi/OpenApiV3.d.ts

@@ -0,0 +1,420 @@
+import { IJsonSchemaAttribute } from "../schema/IJsonSchemaAttribute";
+import * as tags from "../tags";
+/**
+ * OpenAPI v3.0 specification types.
+ *
+ * `OpenApiV3` contains TypeScript type definitions for OpenAPI v3.0 documents.
+ * Used for parsing and generating OpenAPI v3.0 specifications. For a normalized
+ * format that unifies all OpenAPI versions, use {@link OpenApi} instead.
+ *
+ * Key differences from v3.1:
+ *
+ * - Uses `nullable: true` instead of `type: ["string", "null"]`
+ * - No `const` keyword support
+ * - No `prefixItems` for tuples
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare namespace OpenApiV3 {
+    /** HTTP method of the operation. */
+    type Method = "get" | "post" | "put" | "delete" | "options" | "head" | "patch" | "trace";
+    /** OpenAPI document structure. */
+    interface IDocument {
+        /** OpenAPI version. */
+        openapi: "3.0" | `3.0.${number}`;
+        /** List of servers. */
+        servers?: IServer[];
+        /** API metadata. */
+        info?: IDocument.IInfo;
+        /** Reusable components. */
+        components?: IComponents;
+        /** API paths and operations. */
+        paths?: Record<string, IPath>;
+        /** Global security requirements. */
+        security?: Record<string, string[]>[];
+        /** Tag definitions. */
+        tags?: IDocument.ITag[];
+    }
+    namespace IDocument {
+        /** API metadata. */
+        interface IInfo {
+            /** API title. */
+            title: string;
+            /** API description. */
+            description?: string;
+            /** Terms of service URL. */
+            termsOfService?: string;
+            /** Contact information. */
+            contact?: IContact;
+            /** License information. */
+            license?: ILicense;
+            /** API version. */
+            version: string;
+        }
+        /** Tag for grouping operations. */
+        interface ITag {
+            /** Tag name. */
+            name: string;
+            /** Tag description. */
+            description?: string;
+        }
+        /** Contact information. */
+        interface IContact {
+            /** Contact name. */
+            name?: string;
+            /** Contact URL. */
+            url?: string;
+            /** Contact email. */
+            email?: string & tags.Format<"email">;
+        }
+        /** License information. */
+        interface ILicense {
+            /** License name. */
+            name: string;
+            /** License URL. */
+            url?: string;
+        }
+    }
+    /** Server providing the API. */
+    interface IServer {
+        /** Server URL. */
+        url: string;
+        /** Server description. */
+        description?: string;
+        /** URL template variables. */
+        variables?: Record<string, IServer.IVariable>;
+    }
+    namespace IServer {
+        /** URL template variable. */
+        interface IVariable {
+            /** Default value. */
+            default: string;
+            /** Allowed values. */
+            enum?: string[];
+            /** Variable description. */
+            description?: string;
+        }
+    }
+    /** Path item containing operations by HTTP method. */
+    interface IPath extends Partial<Record<Method, IOperation | undefined>> {
+        /** Path-level parameters. */
+        parameters?: Array<IOperation.IParameter | IJsonSchema.IReference<`#/components/headers/${string}`> | IJsonSchema.IReference<`#/components/parameters/${string}`>>;
+        /** Path-level servers. */
+        servers?: IServer[];
+        /** Path summary. */
+        summary?: string;
+        /** Path description. */
+        description?: string;
+    }
+    /** API operation metadata. */
+    interface IOperation {
+        /** Unique operation identifier. */
+        operationId?: string;
+        /** Operation parameters. */
+        parameters?: Array<IOperation.IParameter | IJsonSchema.IReference<`#/components/headers/${string}`> | IJsonSchema.IReference<`#/components/parameters/${string}`>>;
+        /** Request body. */
+        requestBody?: IOperation.IRequestBody | IJsonSchema.IReference<`#/components/requestBodies/${string}`>;
+        /** Response definitions by status code. */
+        responses?: Record<string, IOperation.IResponse | IJsonSchema.IReference<`#/components/responses/${string}`>>;
+        /** Operation-level servers. */
+        servers?: IServer[];
+        /** Short summary. */
+        summary?: string;
+        /** Full description. */
+        description?: string;
+        /** Security requirements. */
+        security?: Record<string, string[]>[];
+        /** Operation tags. */
+        tags?: string[];
+        /** Whether deprecated. */
+        deprecated?: boolean;
+    }
+    namespace IOperation {
+        /** Operation parameter. */
+        interface IParameter {
+            /** Parameter name. */
+            name?: string;
+            /** Parameter location. */
+            in: "path" | "query" | "header" | "cookie";
+            /** Parameter schema. */
+            schema: IJsonSchema;
+            /** Whether required. */
+            required?: boolean;
+            /** Parameter description. */
+            description?: string;
+            /** Example value. */
+            example?: any;
+            /** Named examples. */
+            examples?: Record<string, IExample | IJsonSchema.IReference<`#/components/examples/${string}`>>;
+        }
+        /** Request body. */
+        interface IRequestBody {
+            /** Body description. */
+            description?: string;
+            /** Whether required. */
+            required?: boolean;
+            /** Body content by media type. */
+            content?: Record<string, IMediaType>;
+        }
+        /** Response definition. */
+        interface IResponse {
+            /** Response content by media type. */
+            content?: Record<string, IMediaType>;
+            /** Response headers. */
+            headers?: Record<string, Omit<IOperation.IParameter, "in"> | IJsonSchema.IReference<`#/components/headers/${string}`>>;
+            /** Response description. */
+            description?: string;
+        }
+        /** Media type definition. */
+        interface IMediaType {
+            /** Content schema. */
+            schema?: IJsonSchema;
+            /** Example value. */
+            example?: any;
+            /** Named examples. */
+            examples?: Record<string, IExample | IJsonSchema.IReference<`#/components/examples/${string}`>>;
+        }
+    }
+    /** Example value definition. */
+    interface IExample {
+        /** Example summary. */
+        summary?: string;
+        /** Example description. */
+        description?: string;
+        /** Example value. */
+        value?: any;
+        /** External value URL. */
+        externalValue?: string;
+    }
+    /** Reusable components storage. */
+    interface IComponents {
+        /** Named schemas. */
+        schemas?: Record<string, IJsonSchema>;
+        /** Named responses. */
+        responses?: Record<string, IOperation.IResponse>;
+        /** Named parameters. */
+        parameters?: Record<string, IOperation.IParameter>;
+        /** Named request bodies. */
+        requestBodies?: Record<string, IOperation.IRequestBody>;
+        /** Named security schemes. */
+        securitySchemes?: Record<string, ISecurityScheme>;
+        /** Named headers. */
+        headers?: Record<string, Omit<IOperation.IParameter, "in">>;
+        /** Named examples. */
+        examples?: Record<string, IExample>;
+    }
+    /** JSON Schema type for OpenAPI v3.0. */
+    type IJsonSchema = IJsonSchema.IBoolean | IJsonSchema.IInteger | IJsonSchema.INumber | IJsonSchema.IString | IJsonSchema.IArray | IJsonSchema.IObject | IJsonSchema.IReference | IJsonSchema.IAllOf | IJsonSchema.IAnyOf | IJsonSchema.IOneOf | IJsonSchema.INullOnly | IJsonSchema.IUnknown;
+    namespace IJsonSchema {
+        /** Boolean type. */
+        interface IBoolean extends Omit<IJsonSchemaAttribute.IBoolean, "examples">, __IAttribute {
+            /** Whether nullable. */
+            nullable?: boolean;
+            /** Default value. */
+            default?: boolean | null;
+            /** Allowed values. */
+            enum?: Array<boolean | null>;
+        }
+        /** Integer type. */
+        interface IInteger extends Omit<IJsonSchemaAttribute.IInteger, "examples">, __IAttribute {
+            /** Whether nullable. */
+            nullable?: boolean;
+            /** Default value. */
+            default?: (number & tags.Type<"int64">) | null;
+            /** Allowed values. */
+            enum?: Array<(number & tags.Type<"int64">) | null>;
+            /** Minimum value. */
+            minimum?: number & tags.Type<"int64">;
+            /** Maximum value. */
+            maximum?: number & tags.Type<"int64">;
+            /** Exclusive minimum. */
+            exclusiveMinimum?: number | boolean;
+            /** Exclusive maximum. */
+            exclusiveMaximum?: number | boolean;
+            /** Multiple of constraint. */
+            multipleOf?: number & tags.ExclusiveMinimum<0>;
+        }
+        /** Number (double) type. */
+        interface INumber extends Omit<IJsonSchemaAttribute.INumber, "examples">, __IAttribute {
+            /** Whether nullable. */
+            nullable?: boolean;
+            /** Default value. */
+            default?: number | null;
+            /** Allowed values. */
+            enum?: Array<number | null>;
+            /** Minimum value. */
+            minimum?: number;
+            /** Maximum value. */
+            maximum?: number;
+            /** Exclusive minimum. */
+            exclusiveMinimum?: number | boolean;
+            /** Exclusive maximum. */
+            exclusiveMaximum?: number | boolean;
+            /** Multiple of constraint. */
+            multipleOf?: number & tags.ExclusiveMinimum<0>;
+        }
+        /** String type. */
+        interface IString extends Omit<IJsonSchemaAttribute.IString, "examples">, __IAttribute {
+            /** Whether nullable. */
+            nullable?: boolean;
+            /** Default value. */
+            default?: string | null;
+            /** Allowed values. */
+            enum?: Array<string | null>;
+            /** String format. */
+            format?: "binary" | "byte" | "password" | "regex" | "uuid" | "email" | "hostname" | "idn-email" | "idn-hostname" | "iri" | "iri-reference" | "ipv4" | "ipv6" | "uri" | "uri-reference" | "uri-template" | "url" | "date-time" | "date" | "time" | "duration" | "json-pointer" | "relative-json-pointer" | (string & {});
+            /** Regex pattern. */
+            pattern?: string;
+            /** Minimum length. */
+            minLength?: number & tags.Type<"uint64">;
+            /** Maximum length. */
+            maxLength?: number & tags.Type<"uint64">;
+        }
+        /** Array type. */
+        interface IArray extends Omit<IJsonSchemaAttribute.IArray, "examples">, __IAttribute {
+            /** Whether nullable. */
+            nullable?: boolean;
+            /** Element type. */
+            items: IJsonSchema;
+            /** Whether elements must be unique. */
+            uniqueItems?: boolean;
+            /** Minimum items. */
+            minItems?: number & tags.Type<"uint64">;
+            /** Maximum items. */
+            maxItems?: number & tags.Type<"uint64">;
+        }
+        /** Object type. */
+        interface IObject extends Omit<IJsonSchemaAttribute.IObject, "examples">, __IAttribute {
+            /** Whether nullable. */
+            nullable?: boolean;
+            /** Property schemas. */
+            properties?: Record<string, IJsonSchema>;
+            /** Required property names. */
+            required?: string[];
+            /** Additional properties schema. */
+            additionalProperties?: boolean | IJsonSchema;
+            /** Maximum properties. */
+            maxProperties?: number;
+            /** Minimum properties. */
+            minProperties?: number;
+        }
+        /** Reference to a named schema. */
+        interface IReference<Key = string> extends __IAttribute {
+            /** Reference path. */
+            $ref: Key;
+        }
+        /** All-of combination. */
+        interface IAllOf extends __IAttribute {
+            /** Schemas to combine. */
+            allOf: IJsonSchema[];
+        }
+        /** Any-of union. */
+        interface IAnyOf extends __IAttribute {
+            /** Union member schemas. */
+            anyOf: IJsonSchema[];
+        }
+        /** One-of union. */
+        interface IOneOf extends __IAttribute {
+            /** Union member schemas. */
+            oneOf: IJsonSchema[];
+            /** Discriminator for tagged unions. */
+            discriminator?: IOneOf.IDiscriminator;
+        }
+        namespace IOneOf {
+            /** Discriminator for tagged unions. */
+            interface IDiscriminator {
+                /** Discriminator property name. */
+                propertyName: string;
+                /** Value to schema mapping. */
+                mapping?: Record<string, string>;
+            }
+        }
+        /** Null type. */
+        interface INullOnly extends Omit<IJsonSchemaAttribute.INull, "examples">, __IAttribute {
+            /** Default value. */
+            default?: null;
+        }
+        /** Unknown type. */
+        interface IUnknown extends Omit<IJsonSchemaAttribute.IUnknown, "examples">, __IAttribute {
+            /** Default value. */
+            default?: any;
+        }
+    }
+    /** Security scheme types. */
+    type ISecurityScheme = ISecurityScheme.IApiKey | ISecurityScheme.IHttpBasic | ISecurityScheme.IHttpBearer | ISecurityScheme.IOAuth2 | ISecurityScheme.IOpenId;
+    namespace ISecurityScheme {
+        /** API key authentication. */
+        interface IApiKey {
+            /** Scheme type. */
+            type: "apiKey";
+            /** Key location. */
+            in?: "header" | "query" | "cookie";
+            /** Key name. */
+            name?: string;
+            /** Scheme description. */
+            description?: string;
+        }
+        /** HTTP basic authentication. */
+        interface IHttpBasic {
+            /** Scheme type. */
+            type: "http";
+            /** Authentication scheme. */
+            scheme: "basic";
+            /** Scheme description. */
+            description?: string;
+        }
+        /** HTTP bearer authentication. */
+        interface IHttpBearer {
+            /** Scheme type. */
+            type: "http";
+            /** Authentication scheme. */
+            scheme: "bearer";
+            /** Bearer token format hint. */
+            bearerFormat?: string;
+            /** Scheme description. */
+            description?: string;
+        }
+        /** OAuth2 authentication. */
+        interface IOAuth2 {
+            /** Scheme type. */
+            type: "oauth2";
+            /** OAuth2 flows. */
+            flows: IOAuth2.IFlowSet;
+            /** Scheme description. */
+            description?: string;
+        }
+        /** OpenID Connect authentication. */
+        interface IOpenId {
+            /** Scheme type. */
+            type: "openIdConnect";
+            /** OpenID Connect discovery URL. */
+            openIdConnectUrl: string;
+            /** Scheme description. */
+            description?: string;
+        }
+        namespace IOAuth2 {
+            /** OAuth2 flow configurations. */
+            interface IFlowSet {
+                /** Authorization code flow. */
+                authorizationCode?: IFlow;
+                /** Implicit flow. */
+                implicit?: Omit<IFlow, "tokenUrl">;
+                /** Password flow. */
+                password?: Omit<IFlow, "authorizationUrl">;
+                /** Client credentials flow. */
+                clientCredentials?: Omit<IFlow, "authorizationUrl">;
+            }
+            /** OAuth2 flow configuration. */
+            interface IFlow {
+                /** Authorization URL. */
+                authorizationUrl?: string;
+                /** Token URL. */
+                tokenUrl?: string;
+                /** Refresh URL. */
+                refreshUrl?: string;
+                /** Available scopes. */
+                scopes?: Record<string, string>;
+            }
+        }
+    }
+}

package/lib/openapi/OpenApiV3.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=OpenApiV3.js.map

package/lib/openapi/OpenApiV3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenApiV3.js","sourceRoot":"","sources":["../../src/openapi/OpenApiV3.ts"],"names":[],"mappings":""}