diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..a089263a --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +node_modules/ + +package-lock.json +pnpm-lock.yaml \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..2cf5224c --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "editor.tabSize": 2, + "editor.defaultFormatter": "esbenp.prettier-vscode", + "editor.formatOnSave": true, + "editor.codeActionsOnSave": { + "source.fixAll.eslint": "explicit" + } +} \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 00000000..d7710195 --- /dev/null +++ b/package.json @@ -0,0 +1,17 @@ +{ + "name": "@samchon/openapi", + "version": "0.1.0", + "description": "", + "main": "./lib/index.js", + "typings": "./lib/index.d.ts", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "keywords": [], + "author": "", + "license": "ISC", + "devDependencies": { + "prettier": "^3.2.5", + "typescript": "^5.4.3" + } +} diff --git a/prettier.config.js b/prettier.config.js new file mode 100644 index 00000000..046c315f --- /dev/null +++ b/prettier.config.js @@ -0,0 +1,7 @@ +module.exports = { + parser: "typescript", + printWidth: 80, + semi: true, + tabWidth: 2, + trailingComma: "all", +}; diff --git a/src/OpenApiV3.ts b/src/OpenApiV3.ts new file mode 100644 index 00000000..6787fd16 --- /dev/null +++ b/src/OpenApiV3.ts @@ -0,0 +1,256 @@ +export namespace OpenApiV3 { + export interface IDocument { + openapi: `3.0.${number}`; + servers?: IDocument.IServer[]; + info: IDocument.IInfo; + components?: IComponents; + paths: Record>; + security?: Record[]; + tags?: IDocument.ITag[]; + } + export namespace IDocument { + export interface IServer { + /** @format uri */ url: string; + description?: string; + variables?: Record; + } + export namespace IServer { + export interface IVariable { + default: string; + enum?: string[]; + description?: string; + } + } + export interface IInfo { + title: string; + description?: string; + termsOfService?: string; + contact?: IContact; + license?: ILicense; + version: string; + } + export interface ITag { + name: string; + description?: string; + } + export interface IContact { + name?: string; + /** @format uri */ url?: string; + /** @format email */ email?: string; + } + export interface ILicense { + name: string; + /** @format email */ url?: string; + } + } + + export interface IRoute { + parameters?: Array< + | IRoute.IParameter + | IJsonSchema.IReference<`#/components/headers/${string}`> + | IJsonSchema.IReference<`#/components/parameters/${string}`> + >; + requestBody?: + | IRoute.IRequestBody + | IJsonSchema.IReference<`#/components/requestBodies/${string}`>; + responses?: Record< + string, + | IRoute.IResponse + | IJsonSchema.IReference<`#/components/responses/${string}`> + >; + summary?: string; + description?: string; + security?: Record; + tags?: string[]; + } + export namespace IRoute { + export interface IParameter { + name?: string; + in: "path" | "query" | "header" | "cookie"; + schema: IJsonSchema; + required?: boolean; + description?: string; + } + export interface IRequestBody { + description?: string; + required?: boolean; + content?: Record; + } + export interface IResponse { + content?: Record; + description?: string; + } + export interface IMediaType { + schema: IJsonSchema; + } + } + + export interface IComponents { + schemas?: Record; + responses?: Record; + parameters?: Record; + requestBodies?: Record; + securitySchemes?: Record; + headers?: Record; + } + export type IJsonSchema = + | IJsonSchema.IBoolean + | IJsonSchema.IInteger + | IJsonSchema.INumber + | IJsonSchema.IString + | IJsonSchema.IArray + | IJsonSchema.IObject + | IJsonSchema.IReference + | IJsonSchema.IUnknown + | IJsonSchema.INullOnly + | IJsonSchema.IAllOf + | IJsonSchema.IAnyOf + | IJsonSchema.IOneOf; + export namespace IJsonSchema { + export interface IBoolean extends __ISignificant<"boolean"> { + default?: boolean; + enum?: boolean[]; + } + export interface IInteger extends __ISignificant<"integer"> { + /** @type int */ default?: number; + /** @type int */ enum?: number[]; + /** @type int */ minimum?: number; + /** @type int */ maximum?: number; + /** @type int */ exclusiveMinimum?: boolean; + /** @type int */ exclusiveMaximum?: boolean; + /** @type uint */ multipleOf?: number; + } + export interface INumber extends __ISignificant<"number"> { + default?: number; + enum?: number[]; + minimum?: number; + maximum?: number; + exclusiveMinimum?: boolean; + exclusiveMaximum?: boolean; + multipleOf?: number; + } + export interface IString extends __ISignificant<"string"> { + contentMediaType?: string; + default?: string; + enum?: string[]; + 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 & {}); + pattern?: string; + /** @type uint */ minLength?: number; + /** @type uint */ maxLength?: number; + } + + export interface IArray extends __ISignificant<"array"> { + item: IJsonSchema; + uniqueItems?: boolean; + /** @type uint */ minItems?: number; + /** @type uint */ maxItems?: number; + } + export interface IObject extends __ISignificant<"object"> { + properties: Record; + required?: string[]; + additionalProperties?: boolean | IJsonSchema; + } + export interface IReference extends __IAttribute { + $ref: Key; + } + + export interface IUnknown extends __IAttribute { + type?: undefined; + } + export interface INullOnly extends __IAttribute { + type: "null"; + } + export interface IAllOf extends __IAttribute { + allOf: IJsonSchema[]; + } + export interface IAnyOf extends __IAttribute { + anyOf: IJsonSchema[]; + } + export interface IOneOf extends __IAttribute { + oneOf: IJsonSchema[]; + } + + export interface __ISignificant extends __IAttribute { + type: Type; + nullable?: boolean; + } + export interface __IAttribute { + title?: string; + description?: string; + deprecated?: boolean; + } + } + export type ISecurityScheme = + | ISecurityScheme.IApiKey + | ISecurityScheme.IHttpBasic + | ISecurityScheme.IHttpBearer + | ISecurityScheme.IOAuth2 + | ISecurityScheme.IOpenId; + export namespace ISecurityScheme { + export interface IApiKey { + type: "apiKey"; + in?: "header" | "query" | "cookie"; + name?: string; + description?: string; + } + export interface IHttpBasic { + type: "http"; + schema: "basic"; + description?: string; + } + export interface IHttpBearer { + type: "http"; + schema: "bearer"; + bearerFormat?: string; + description?: string; + } + export interface IOAuth2 { + type: "oauth2"; + flows: IOAuth2.IFlowSet; + description?: string; + } + export interface IOpenId { + type: "openIdConnect"; + /** @format uri */ openIdConnectUrl: string; + description?: string; + } + export namespace IOAuth2 { + export interface IFlowSet { + authorizationCode?: IFlow; + implicit?: Omit; + password?: Omit; + clientCredentials?: Omit; + } + export interface IFlow { + authorizationUrl: string; + /** @format uri */ tokenUrl?: string; + /** @format uri */ refreshUrl?: string; + scopes?: Record; + } + } + } +} diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 00000000..4b6b51c8 --- /dev/null +++ b/src/index.ts @@ -0,0 +1 @@ +export * from "./OpenApiV3"; diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 00000000..9c51c1ac --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,109 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + "outDir": "./lib", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}