@automatons/parser 0.0.263 → 1.0.1

package/README.md

@@ -1,47 +1,9 @@
-# OpenapiAutomatons
-[![CI/CD](https://github.com/openapi-automatons/openapi-automatons/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/openapi-automatons/openapi-automatons/actions/workflows/ci-cd.yml)
-[![codecov](https://codecov.io/gh/openapi-automatons/openapi-automatons/branch/main/graph/badge.svg)](https://codecov.io/gh/openapi-automatons/openapi-automatons)
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
-[![npm downloads](https://img.shields.io/npm/dt/openapi-automatons)](https://www.npmjs.com/package/openapi-automatons)
+# @automatons/parser
+[![CI/CD](https://github.com/openapi-automatons/parser/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/openapi-automatons/parser/actions/workflows/ci-cd.yml)
+[![npm downloads](https://img.shields.io/npm/dt/@automatons/parser)](https://www.npmjs.com/package/@automatons/parser)
 
-## What OpenapiAutomatons
-This library is a generator using openapi file.
+## What is @automatons/parser
+This is the OpenAPI parser used by openapi-automatons generators.
+Only use via [openapi-automatons](https://github.com/openapi-automatons/openapi-automatons).
 
-## What code can generate?
-| name | language | type | example |
-| ---- | -------- | ---- | ------- |
-| @automatons/typescript-axios | typescript | client | [example](https://github.com/openapi-automatons/openapi-automatons/tree/main/examples/typescript/clients/axios "example") |
-
-## Get Started
-1. Install library to your project
-```shell script
-yarn add -D openapi-automatons @automatons/typescript-axios
-```
-
-2. Create settings in your project root
-```json:automatons.json
-{
-  "openapi": "openapi.yml",
-  "automatons": [{
-    "automaton": "@automatons/typescript-axios",
-    "outDir": "src/clients"
-  }]
-}
-```
-
-3. Add generate command your package.json
-```json:package.json
-{
-  "scripts": {
-    "generate": "openapi-automatons"
-  }
-}
-```
-
-## Automatons.json
-| property |     | type | required | description |
-| -------- | --- | ---- | -------- | ----------- |
-| openapi | | string | true | This is openapi path. It can be relative or absolute. Also, there is no problem with the url format.|
-| automatons | | array | true | This is the property that contains the module. |
-| automatons | automaton | string | true | This is the module name. You can embed your own module. It is also possible to include it with a relative path. |
-| automatons | outDir | string | true | This is the output directory of module. |
+Since v1 this package is **ESM-only** and requires **Node.js >= 22**.

package/index.d.ts

@@ -1,3 +1,206 @@
-export * from './parser';
-export * from './types';
-//# sourceMappingURL=index.d.ts.map
+import { Openapi, AutomatonSettings } from '@automatons/tools';
+
+type Schema = StringSchema | IntegerSchema | NumberSchema | BooleanSchema | ArraySchema | ObjectSchema | AllOfSchema | OneOfSchema | ModelSchema;
+interface Model {
+    filename: string;
+    title: string;
+    imports: Model[];
+    schema: Schema;
+}
+interface SchemaCommon {
+    description?: string;
+    nullable?: boolean;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    deprecated?: boolean;
+    example?: any;
+    defaultValue?: any;
+}
+interface StringSchema extends SchemaCommon {
+    type: 'string';
+    format?: 'date' | 'date-time' | 'password' | 'byte' | 'binary' | 'url' | string;
+    enum?: string[];
+    examples?: Example<string>[];
+    default?: string;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+}
+interface IntegerSchema extends SchemaCommon {
+    type: 'integer';
+    format?: 'int32' | 'int64' | 'float' | 'double';
+    enum?: number[];
+    examples?: Example<number>[];
+    default?: number;
+    maximum?: number;
+    exclusiveMaximum?: boolean;
+    minimum?: number;
+    exclusiveMinimum?: boolean;
+    multipleOf?: number;
+}
+interface NumberSchema extends SchemaCommon {
+    type: 'number';
+    format?: 'float' | 'double' | string;
+    enum?: number[];
+    examples?: Example<number>[];
+    default?: number;
+    maximum?: number;
+    exclusiveMaximum?: boolean;
+    minimum?: number;
+    exclusiveMinimum?: boolean;
+    multipleOf?: number;
+}
+interface BooleanSchema extends SchemaCommon {
+    type: 'boolean';
+    default?: boolean;
+}
+interface ObjectSchema extends SchemaCommon {
+    type: 'object';
+    discriminate?: string;
+    properties?: Property[];
+    examples?: Example<object>[];
+    default?: object;
+}
+interface Property {
+    name: string;
+    required: boolean;
+    schema: Schema;
+}
+interface ArraySchema extends SchemaCommon {
+    type: 'array';
+    uniqueItems?: boolean;
+    minItems?: number;
+    maxItems?: number;
+    items?: Schema;
+    examples?: Example<any[]>[];
+}
+interface AllOfSchema extends SchemaCommon {
+    type: 'allOf';
+    examples?: Example[];
+    schemas: Schema[];
+}
+interface OneOfSchema extends SchemaCommon {
+    type: 'oneOf';
+    examples?: Example[];
+    schemas: Schema[];
+}
+interface ModelSchema extends SchemaCommon {
+    type: 'model';
+    name: string;
+}
+type Example<T = any> = {
+    name: string;
+    value: T;
+};
+
+interface Api {
+    title: string;
+    filename: string;
+    servers: Server[];
+    imports: Model[];
+    paths: Path[];
+}
+type Path = ReceivePath | AffectPath;
+type ReceiveMethod = 'get' | 'head' | 'delete' | 'options' | 'trace';
+type ReceivePath = {
+    name: string;
+    method: ReceiveMethod;
+    path: string;
+    servers: Server[];
+    parameters?: PathParameter[];
+    queries?: QueryParameter[];
+    headers?: HeaderParameter[];
+    cookies?: CookieParameter[];
+    schema?: Schema;
+    securities?: Security[];
+};
+type AffectMethod = 'post' | 'put' | 'patch';
+type AffectPath = {
+    name: string;
+    method: AffectMethod;
+    path: string;
+    servers: Server[];
+    forms?: Form[];
+    parameters?: PathParameter[];
+    queries?: QueryParameter[];
+    headers?: HeaderParameter[];
+    cookies?: CookieParameter[];
+    schema?: Schema;
+    securities?: Security[];
+};
+type Form = {
+    types: string[];
+    required?: boolean;
+    schema: Schema;
+};
+type Server = {
+    name: string;
+    url: string;
+    values?: ServerValue[];
+};
+type ServerValue = {
+    name: string;
+    defaultValue: string;
+    enums: string[];
+};
+type PathParameter = {
+    name: string;
+    schema: Schema;
+    style: 'simple' | 'label' | 'matrix';
+    explode?: boolean;
+};
+type QueryParameter = {
+    name: string;
+    schema: Schema;
+    style: 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
+    required?: boolean;
+    explode?: boolean;
+};
+type HeaderParameter = {
+    name: string;
+    schema: Schema;
+    style: 'simple';
+    required?: boolean;
+    explode?: boolean;
+};
+type CookieParameter = {
+    name: string;
+    schema: Schema;
+    style: 'form';
+    required?: boolean;
+    explode?: boolean;
+};
+type Security = ApiKeySecurity | HttpSecurity | Oauth2Security | OpenIdConnectSecurity;
+type ApiKeySecurity = {
+    name: string;
+    type: 'apiKey';
+    key: string;
+    in: 'query' | 'header' | 'cookie';
+    description?: string;
+};
+type HttpSecurity = {
+    name: string;
+    type: 'http';
+    scheme: 'basic' | 'bearer';
+    description?: string;
+};
+type Oauth2Security = {
+    name: string;
+    type: 'oauth2';
+    scopes: string[];
+    description?: string;
+};
+type OpenIdConnectSecurity = {
+    name: string;
+    type: 'openIdConnect';
+    scopes: string[];
+    description?: string;
+};
+
+declare const parser: (openapi: Openapi, settings: AutomatonSettings) => Promise<{
+    models: Model[];
+    apis: Api[];
+    securities: Security[];
+}>;
+
+export { type AffectMethod, type AffectPath, type AllOfSchema, type Api, type ApiKeySecurity, type ArraySchema, type BooleanSchema, type CookieParameter, type Form, type HeaderParameter, type HttpSecurity, type IntegerSchema, type Model, type ModelSchema, type NumberSchema, type Oauth2Security, type ObjectSchema, type OneOfSchema, type OpenIdConnectSecurity, type Path, type PathParameter, type Property, type QueryParameter, type ReceiveMethod, type ReceivePath, type Schema, type SchemaCommon, type Security, type Server, type ServerValue, type StringSchema, parser };