@typia/interface 12.0.0-dev.20260225

package/lib/openapi/SwaggerV2.d.ts

@@ -0,0 +1,343 @@
+import { IJsonSchemaAttribute } from "../schema/IJsonSchemaAttribute";
+import * as tags from "../tags";
+/**
+ * Swagger v2.0 specification types.
+ *
+ * `SwaggerV2` contains TypeScript type definitions for Swagger v2.0 (OpenAPI
+ * v2) documents. Used for parsing legacy Swagger specifications. For a
+ * normalized format that unifies all OpenAPI versions, use {@link OpenApi}.
+ *
+ * Key differences from OpenAPI v3.x:
+ *
+ * - Uses `definitions` instead of `components.schemas`
+ * - Body parameters use `in: "body"` with `schema` property
+ * - No `requestBody`, `oneOf`, `anyOf`, or `nullable`
+ * - Uses `host` + `basePath` instead of `servers`
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare namespace SwaggerV2 {
+    /** HTTP method of the operation. */
+    type Method = "get" | "post" | "put" | "delete" | "options" | "head" | "patch" | "trace";
+    /** Swagger document structure. */
+    interface IDocument {
+        /** Swagger version. */
+        swagger: "2.0" | `2.0.${number}`;
+        /** API metadata. */
+        info?: IDocument.IInfo;
+        /** Host address. */
+        host?: string;
+        /** Base path for all operations. */
+        basePath?: string;
+        /** Global content types consumed. */
+        consumes?: string[];
+        /** Global content types produced. */
+        produces?: string[];
+        /** Schema definitions. */
+        definitions?: Record<string, IJsonSchema>;
+        /** Reusable parameter definitions. */
+        parameters?: Record<string, IOperation.IParameter>;
+        /** Reusable response definitions. */
+        responses?: Record<string, IOperation.IResponse>;
+        /** Security scheme definitions. */
+        securityDefinitions?: Record<string, ISecurityDefinition>;
+        /** Global security requirements. */
+        security?: Record<string, string[]>[];
+        /** API paths and operations. */
+        paths?: Record<string, IPath>;
+        /** 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;
+        }
+        /** 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;
+        }
+        /** Tag for grouping operations. */
+        interface ITag {
+            /** Tag name. */
+            name: string;
+            /** Tag 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<`#/parameters/${string}`>>;
+    }
+    /** API operation metadata. */
+    interface IOperation {
+        /** Unique operation identifier. */
+        operationId?: string;
+        /** Operation parameters. */
+        parameters?: Array<IOperation.IParameter | IJsonSchema.IReference<`#/definitions/parameters/${string}`>>;
+        /** Response definitions by status code. */
+        responses?: Record<string, IOperation.IResponse | IJsonSchema.IReference<`#/definitions/responses/${string}`>>;
+        /** 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 (general or body). */
+        type IParameter = IGeneralParameter | IBodyParameter;
+        /** General parameter (path, query, header, formData). */
+        type IGeneralParameter = IJsonSchema & {
+            name: string;
+            in: string;
+            description?: string;
+        };
+        /** Body parameter. */
+        interface IBodyParameter {
+            /** Body schema. */
+            schema: IJsonSchema;
+            /** Parameter name. */
+            name: string;
+            /** Parameter location (always "body"). */
+            in: string;
+            /** Parameter description. */
+            description?: string;
+            /** Whether required. */
+            required?: boolean;
+        }
+        /** Response definition. */
+        interface IResponse {
+            /** Response description. */
+            description?: string;
+            /** Response headers. */
+            headers?: Record<string, IJsonSchema>;
+            /** Response body schema. */
+            schema?: IJsonSchema;
+            /** Example value. */
+            example?: any;
+        }
+    }
+    /** JSON Schema type for Swagger. */
+    type IJsonSchema = IJsonSchema.IBoolean | IJsonSchema.IInteger | IJsonSchema.INumber | IJsonSchema.IString | IJsonSchema.IArray | IJsonSchema.IObject | IJsonSchema.IReference | IJsonSchema.IAnyOf | IJsonSchema.IOneOf | IJsonSchema.INullOnly | IJsonSchema.IUnknown;
+    namespace IJsonSchema {
+        /** Boolean type. */
+        interface IBoolean extends Omit<IJsonSchemaAttribute.IBoolean, "examples">, __ISignificant<"boolean"> {
+            /** Default value. */
+            default?: boolean | null;
+            /** Allowed values. */
+            enum?: Array<boolean | null>;
+        }
+        /** Integer type. */
+        interface IInteger extends Omit<IJsonSchemaAttribute.IInteger, "examples">, __ISignificant<"integer"> {
+            /** 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">, __ISignificant<"number"> {
+            /** 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">, __ISignificant<"string"> {
+            /** 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">, __ISignificant<"array"> {
+            /** 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">, __ISignificant<"object"> {
+            /** 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 (Swagger extension). */
+        interface IAnyOf extends __IAttribute {
+            /** Union member schemas. */
+            "x-anyOf": IJsonSchema[];
+        }
+        /** One-of union (Swagger extension). */
+        interface IOneOf extends __IAttribute {
+            /** Union member schemas. */
+            "x-oneOf": IJsonSchema[];
+        }
+        /** Null type. */
+        interface INullOnly extends __IAttribute {
+            /** Type discriminator. */
+            type: "null";
+            /** Default value. */
+            default?: null;
+        }
+        /** Unknown type. */
+        interface IUnknown extends __IAttribute {
+            /** Type discriminator (undefined for unknown). */
+            type?: undefined;
+        }
+    }
+    /** Security scheme types. */
+    type ISecurityDefinition = ISecurityDefinition.IApiKey | ISecurityDefinition.IBasic | ISecurityDefinition.IOauth2Implicit | ISecurityDefinition.IOauth2AccessCode | ISecurityDefinition.IOauth2Password | ISecurityDefinition.IOauth2Application;
+    namespace ISecurityDefinition {
+        /** 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 IBasic {
+            /** Scheme type. */
+            type: "basic";
+            /** Scheme name. */
+            name?: string;
+            /** Scheme description. */
+            description?: string;
+        }
+        /** OAuth2 implicit flow. */
+        interface IOauth2Implicit {
+            /** Scheme type. */
+            type: "oauth2";
+            /** OAuth2 flow type. */
+            flow: "implicit";
+            /** Authorization URL. */
+            authorizationUrl?: string;
+            /** Available scopes. */
+            scopes?: Record<string, string>;
+            /** Scheme description. */
+            description?: string;
+        }
+        /** OAuth2 authorization code flow. */
+        interface IOauth2AccessCode {
+            /** Scheme type. */
+            type: "oauth2";
+            /** OAuth2 flow type. */
+            flow: "accessCode";
+            /** Authorization URL. */
+            authorizationUrl?: string;
+            /** Token URL. */
+            tokenUrl?: string;
+            /** Available scopes. */
+            scopes?: Record<string, string>;
+            /** Scheme description. */
+            description?: string;
+        }
+        /** OAuth2 password flow. */
+        interface IOauth2Password {
+            /** Scheme type. */
+            type: "oauth2";
+            /** OAuth2 flow type. */
+            flow: "password";
+            /** Token URL. */
+            tokenUrl?: string;
+            /** Available scopes. */
+            scopes?: Record<string, string>;
+            /** Scheme description. */
+            description?: string;
+        }
+        /** OAuth2 application (client credentials) flow. */
+        interface IOauth2Application {
+            /** Scheme type. */
+            type: "oauth2";
+            /** OAuth2 flow type. */
+            flow: "application";
+            /** Token URL. */
+            tokenUrl?: string;
+            /** Available scopes. */
+            scopes?: Record<string, string>;
+            /** Scheme description. */
+            description?: string;
+        }
+    }
+}

package/lib/openapi/SwaggerV2.js

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

package/lib/openapi/SwaggerV2.js.map

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

package/lib/openapi/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./OpenApi";
+export * from "./OpenApiV3";
+export * from "./OpenApiV3_1";
+export * from "./SwaggerV2";

package/lib/openapi/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./OpenApi"), exports);
+__exportStar(require("./OpenApiV3"), exports);
+__exportStar(require("./OpenApiV3_1"), exports);
+__exportStar(require("./SwaggerV2"), exports);
+//# sourceMappingURL=index.js.map

package/lib/openapi/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/openapi/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,8CAA4B;AAC5B,gDAA8B;AAC9B,8CAA4B"}

package/lib/protobuf/ProtobufWire.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Protocol Buffers wire types.
+ *
+ * `ProtobufWire` defines the wire types used in Protocol Buffers binary
+ * encoding. Each type determines how the value is serialized on the wire.
+ *
+ * Wire types:
+ *
+ * - {@link VARIANT} (0): Varints (int32, int64, uint32, uint64, sint32, sint64,
+ *   bool, enum)
+ * - {@link I64} (1): 64-bit (fixed64, sfixed64, double)
+ * - {@link LEN} (2): Length-delimited (string, bytes, embedded messages, packed
+ *   repeated)
+ * - {@link I32} (5): 32-bit (fixed32, sfixed32, float)
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare const enum ProtobufWire {
+    /**
+     * - Integers
+     * - Bool
+     * - Enum
+     */
+    VARIANT = 0,
+    /**
+     * - Fixed64
+     * - Sfixed64
+     * - Double
+     */
+    I64 = 1,
+    /**
+     * - String
+     * - Bytes
+     * - Embedded messages
+     * - Packed repeated fields
+     */
+    LEN = 2,
+    START_GROUP = 3,
+    END_GROUP = 4,
+    /**
+     * - Fixed
+     * - Sfixed32
+     * - Float
+     */
+    I32 = 5
+}

package/lib/protobuf/ProtobufWire.js

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

package/lib/protobuf/ProtobufWire.js.map

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

package/lib/protobuf/index.d.ts

@@ -0,0 +1 @@
+export * from "./ProtobufWire";

package/lib/protobuf/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ProtobufWire"), exports);
+//# sourceMappingURL=index.js.map

package/lib/protobuf/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/protobuf/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B"}