api-farmer 0.1.3 → 0.1.4

package/dist/index.d.cts

@@ -1,334 +0,0 @@
-import { OpenAPI3, RequestBodyObject, ReferenceObject, OperationObject, OpenAPITSOptions } from 'openapi-typescript';
-export { default as pluralize } from 'pluralize';
-
-type Preset = 'axle' | 'axios';
-type StatusCodeStrategy = 'strict' | 'loose' | 'smart';
-interface StatusCodes {
-    get?: number;
-    post?: number;
-    put?: number;
-    delete?: number;
-    patch?: number;
-    options?: number;
-    head?: number;
-}
-declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
-    get: number;
-    post: number;
-    put: number;
-    delete: number;
-    patch: number;
-    options: number;
-    head: number;
-} | {
-    get: number;
-    post: number;
-    put: number;
-    delete: number;
-    patch: number;
-    options: number;
-    head: number;
-} | {
-    get: number;
-    post: number;
-    put: number;
-    delete: number;
-    patch: number;
-    options: number;
-    head: number;
-};
-declare function readSchema(input: string): Promise<OpenAPI3>;
-declare function getSchemaNode(schema: OpenAPI3, path: string): any;
-declare function readSchemaContent(input: string): Promise<string>;
-declare function isRemoteSchema(path: string): boolean;
-declare function readTemplateFile(preset?: Preset): string;
-declare function getCliVersion(): any;
-declare function isRequiredRequestBody(value: RequestBodyObject | ReferenceObject): boolean;
-declare function findObjectKey(object: Record<string, any>, targetKeys: string[]): string | undefined;
-declare function getRequestBodyContentType(value: RequestBodyObject | ReferenceObject): string | undefined;
-type ResponseMetadataItem = {
-    status: number;
-    responseContentType: string;
-};
-declare function getResponseMetadataItems(operation: OperationObject, validateStatus: (status: number) => boolean): ResponseMetadataItem[];
-
-type TransformerBaseArgs = {
-    path: string;
-    fullPath: string;
-    base: string | undefined;
-    url: string;
-    method: string;
-    operation: OperationObject;
-    uncountableNouns: string[];
-};
-declare function transformModuleName({ name }: {
-    name: string;
-}): string;
-declare function transformUrl({ path }: {
-    path: string;
-    fullPath: string;
-    base: string | undefined;
-}): string;
-declare function transformComment({ summary, description, path, method, }: {
-    summary?: string;
-    description?: string;
-    path: string;
-    method: string;
-} & TransformerBaseArgs): string;
-declare function transformVerb({ method }: {
-    method: string;
-}): string;
-declare function transformEntity({ path, method, uncountableNouns }: TransformerBaseArgs): string;
-declare function transformFn({ verb, entity }: {
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformType({ verb, entity }: {
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeValue({ fullPath, method }: {
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeQuery({ type }: {
-    type: string;
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeQueryValue({ type, }: {
-    type: string;
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeRequestBody({ type, }: {
-    type: string;
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeRequestBodyValue({ type, required, requestContentType, }: {
-    type: string;
-    verb: string;
-    entity: string;
-    required: boolean;
-    requestContentType: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeResponseBody({ type, }: {
-    type: string;
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeResponseBodyValue({ type, responseMetadataItems, }: {
-    type: string;
-    verb: string;
-    entity: string;
-    responseMetadataItems: ResponseMetadataItem[];
-} & TransformerBaseArgs): string;
-interface Transformer {
-    moduleName: typeof transformModuleName;
-    verb: typeof transformVerb;
-    url: typeof transformUrl;
-    comment: typeof transformComment;
-    entity: typeof transformEntity;
-    fn: typeof transformFn;
-    type: typeof transformType;
-    typeValue: typeof transformTypeValue;
-    typeQuery: typeof transformTypeQuery;
-    typeQueryValue: typeof transformTypeQueryValue;
-    typeRequestBody: typeof transformTypeRequestBody;
-    typeRequestBodyValue: typeof transformTypeRequestBodyValue;
-    typeResponseBody: typeof transformTypeResponseBody;
-    typeResponseBodyValue: typeof transformTypeResponseBodyValue;
-}
-declare function createTransformer(): Transformer;
-
-interface ApiModuleTemplateData {
-    /**
-     * API module metadata
-     */
-    apiModule: ApiModule;
-    /**
-     * The name of the generated api ts type aggregation file
-     */
-    typesFilename: string;
-    /**
-     * Whether to generate ts code
-     */
-    ts: boolean;
-    /**
-     * Whether to generate only types
-     */
-    typesOnly: boolean;
-}
-interface ApiModule {
-    /**
-     * The name of the API module
-     */
-    name: string;
-    /**
-     * API module payloads
-     */
-    payloads: ApiModulePayload[];
-}
-interface ApiModulePayload {
-    /**
-     * The comment of the API endpoint, including summary, description, URL, and method.
-     */
-    comment: string;
-    /**
-     * The name of the API function/dispatcher, such as apiGetUsers, apiCreatePost, apiUpdateComment, etc.
-     */
-    fn: string;
-    /**
-     * The URL of the API endpoint, such as /users, /posts, /comments, etc.
-     */
-    url: string;
-    /**
-     * The HTTP method of the API endpoint, such as get, post, put, delete, etc.
-     */
-    method: string;
-    /**
-     * The HTTP verb of the API endpoint, such as Get, Create, Update, Delete, etc.
-     */
-    verb: string;
-    /**
-     * The entity name of the API endpoint, such as User, Comment, Post, etc.
-     */
-    entity: string;
-    /**
-     * The request content type of the API endpoint, such as 'application/json', 'application/x-www-form-urlencoded'.
-     */
-    requestContentType?: string;
-    /**
-     * The type name of the API endpoint, such as ApiGetUsers, ApiCreatePost, ApiUpdateComment, etc.
-     */
-    type: string;
-    /**
-     * The value of the type of the API endpoint, such as paths['/users']['get'], paths['/posts']['post'], paths['/comments']['put'], etc.
-     */
-    typeValue: string;
-    /**
-     * The type name of the query parameters of the API endpoint, such as ApiGetUsersQuery, ApiCreatePostQuery, ApiUpdateCommentQuery, etc.
-     */
-    typeQuery: string;
-    /**
-     * The value of the type of the query parameters of the API endpoint, such as ApiGetUsersQuery['parameters']['query'], ApiCreatePostQuery['parameters']['query'], ApiUpdateCommentQuery['parameters']['query'], etc.
-     */
-    typeQueryValue: string;
-    /**
-     * The type name of the request body of the API endpoint, such as ApiGetUsersRequestBody, ApiCreatePostRequestBody, ApiUpdateCommentRequestBody, etc.
-     */
-    typeRequestBody: string;
-    /**
-     * The value of the type of the request body of the API endpoint, such as ApiGetUsersRequestBody['requestBody']['content']['application/json'], ApiCreatePostRequestBody['requestBody']['content']['application/json'], ApiUpdateCommentRequestBody['requestBody']['content']['application/json'], etc.
-     */
-    typeRequestBodyValue: string;
-    /**
-     * The type name of the response body of the API endpoint, such as ApiGetUsersResponseBody, ApiCreatePostResponseBody, ApiUpdateCommentResponseBody, etc.
-     */
-    typeResponseBody: string;
-    /**
-     * The value of the type of the response body of the API endpoint, such as ApiGetUsersResponseBody['responses']['200']['content']['application/json'], ApiCreatePostResponseBody['responses']['201']['content']['application/json'], ApiUpdateCommentResponseBody['responses']['200']['content']['application/json'], etc.
-     */
-    typeResponseBodyValue: string;
-}
-interface GenerateOptions {
-    /**
-     * The path to the OpenAPI/Swagger schema file.
-     * @default './schema.json'
-     */
-    input?: string;
-    /**
-     * The path to the output directory.
-     * @default './src/apis/generated'
-     */
-    output?: string;
-    /**
-     * The base path of the API endpoints.
-     */
-    base?: string;
-    /**
-     * The filename of the generated openapi types file.
-     * @default '_types.ts'
-     */
-    typesFilename?: string;
-    /**
-     * Whether to generate TypeScript code.
-     * @default true
-     */
-    ts?: boolean;
-    /**
-     * Whether to generate only types.
-     * @default false
-     */
-    typesOnly?: boolean;
-    /**
-     * Whether to override the existing files, or an array of filenames to override.
-     * @default true
-     */
-    overrides?: boolean | string[];
-    /**
-     * The preset ejs template to use.
-     * @default 'axle'
-     */
-    preset?: Preset;
-    /**
-     * Defines which return status codes will be typed
-     * @default (status) => status >= 200 && status < 300
-     */
-    validateStatus?: (status: number) => boolean;
-    /**
-     * The transformer api options, used to override the default transformation rules.
-     */
-    transformer?: Partial<Transformer>;
-    /**
-     * Certain uncountable nouns that do not change from singular to plural
-     */
-    uncountableNouns?: string[];
-    /**
-     * Whether to clean the output directory before generating.
-     * @default false
-     */
-    clean?: boolean;
-    /**
-     *  A function to transform the generated types AST before printing to string.
-     */
-    openapiTsOptions?: OpenAPITSOptions;
-    /**
-     * Whether to exclude deprecated API endpoints.
-     * @default false
-     */
-    excludeDeprecated?: boolean;
-}
-declare function transformPayloads(pathItems: Record<string, OperationObject>, options: {
-    path: string;
-    fullPath: string;
-    base: string | undefined;
-    transformer: Transformer;
-    uncountableNouns: string[];
-    validateStatus: (status: number) => boolean;
-    excludeDeprecated?: boolean;
-}): ApiModulePayload[];
-declare function partitionApiModules(schema: OpenAPI3, options: {
-    transformer: Transformer;
-    base: string | undefined;
-    uncountableNouns: string[];
-    validateStatus: (status: number) => boolean;
-    excludeDeprecated?: boolean;
-}): ApiModule[];
-declare function renderApiModules(apiModules: ApiModule[], options: {
-    output: string;
-    typesFilename: string;
-    ts: boolean;
-    typesOnly: boolean;
-    overrides: boolean | string[];
-    preset: Preset;
-}): Promise<unknown[]>;
-declare function generateTypes(schema: OpenAPI3, output: string, typesFilename: string, openapiTsOptions: OpenAPITSOptions): Promise<void>;
-declare function generate(userOptions?: GenerateOptions): Promise<void>;
-
-type Config = GenerateOptions;
-declare function defineConfig(config: Config): GenerateOptions;
-declare function getConfig(): Promise<Config>;
-
-export { type ApiModule, type ApiModulePayload, type ApiModuleTemplateData, type Config, type GenerateOptions, type Preset, type ResponseMetadataItem, type StatusCodeStrategy, type StatusCodes, type Transformer, type TransformerBaseArgs, createStatusCodesByStrategy, createTransformer, defineConfig, findObjectKey, generate, generateTypes, getCliVersion, getConfig, getRequestBodyContentType, getResponseMetadataItems, getSchemaNode, isRemoteSchema, isRequiredRequestBody, partitionApiModules, readSchema, readSchemaContent, readTemplateFile, renderApiModules, transformComment, transformEntity, transformFn, transformModuleName, transformPayloads, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };

package/dist/index.d.ts

@@ -1,334 +0,0 @@
-import { OpenAPI3, RequestBodyObject, ReferenceObject, OperationObject, OpenAPITSOptions } from 'openapi-typescript';
-export { default as pluralize } from 'pluralize';
-
-type Preset = 'axle' | 'axios';
-type StatusCodeStrategy = 'strict' | 'loose' | 'smart';
-interface StatusCodes {
-    get?: number;
-    post?: number;
-    put?: number;
-    delete?: number;
-    patch?: number;
-    options?: number;
-    head?: number;
-}
-declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
-    get: number;
-    post: number;
-    put: number;
-    delete: number;
-    patch: number;
-    options: number;
-    head: number;
-} | {
-    get: number;
-    post: number;
-    put: number;
-    delete: number;
-    patch: number;
-    options: number;
-    head: number;
-} | {
-    get: number;
-    post: number;
-    put: number;
-    delete: number;
-    patch: number;
-    options: number;
-    head: number;
-};
-declare function readSchema(input: string): Promise<OpenAPI3>;
-declare function getSchemaNode(schema: OpenAPI3, path: string): any;
-declare function readSchemaContent(input: string): Promise<string>;
-declare function isRemoteSchema(path: string): boolean;
-declare function readTemplateFile(preset?: Preset): string;
-declare function getCliVersion(): any;
-declare function isRequiredRequestBody(value: RequestBodyObject | ReferenceObject): boolean;
-declare function findObjectKey(object: Record<string, any>, targetKeys: string[]): string | undefined;
-declare function getRequestBodyContentType(value: RequestBodyObject | ReferenceObject): string | undefined;
-type ResponseMetadataItem = {
-    status: number;
-    responseContentType: string;
-};
-declare function getResponseMetadataItems(operation: OperationObject, validateStatus: (status: number) => boolean): ResponseMetadataItem[];
-
-type TransformerBaseArgs = {
-    path: string;
-    fullPath: string;
-    base: string | undefined;
-    url: string;
-    method: string;
-    operation: OperationObject;
-    uncountableNouns: string[];
-};
-declare function transformModuleName({ name }: {
-    name: string;
-}): string;
-declare function transformUrl({ path }: {
-    path: string;
-    fullPath: string;
-    base: string | undefined;
-}): string;
-declare function transformComment({ summary, description, path, method, }: {
-    summary?: string;
-    description?: string;
-    path: string;
-    method: string;
-} & TransformerBaseArgs): string;
-declare function transformVerb({ method }: {
-    method: string;
-}): string;
-declare function transformEntity({ path, method, uncountableNouns }: TransformerBaseArgs): string;
-declare function transformFn({ verb, entity }: {
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformType({ verb, entity }: {
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeValue({ fullPath, method }: {
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeQuery({ type }: {
-    type: string;
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeQueryValue({ type, }: {
-    type: string;
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeRequestBody({ type, }: {
-    type: string;
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeRequestBodyValue({ type, required, requestContentType, }: {
-    type: string;
-    verb: string;
-    entity: string;
-    required: boolean;
-    requestContentType: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeResponseBody({ type, }: {
-    type: string;
-    verb: string;
-    entity: string;
-} & TransformerBaseArgs): string;
-declare function transformTypeResponseBodyValue({ type, responseMetadataItems, }: {
-    type: string;
-    verb: string;
-    entity: string;
-    responseMetadataItems: ResponseMetadataItem[];
-} & TransformerBaseArgs): string;
-interface Transformer {
-    moduleName: typeof transformModuleName;
-    verb: typeof transformVerb;
-    url: typeof transformUrl;
-    comment: typeof transformComment;
-    entity: typeof transformEntity;
-    fn: typeof transformFn;
-    type: typeof transformType;
-    typeValue: typeof transformTypeValue;
-    typeQuery: typeof transformTypeQuery;
-    typeQueryValue: typeof transformTypeQueryValue;
-    typeRequestBody: typeof transformTypeRequestBody;
-    typeRequestBodyValue: typeof transformTypeRequestBodyValue;
-    typeResponseBody: typeof transformTypeResponseBody;
-    typeResponseBodyValue: typeof transformTypeResponseBodyValue;
-}
-declare function createTransformer(): Transformer;
-
-interface ApiModuleTemplateData {
-    /**
-     * API module metadata
-     */
-    apiModule: ApiModule;
-    /**
-     * The name of the generated api ts type aggregation file
-     */
-    typesFilename: string;
-    /**
-     * Whether to generate ts code
-     */
-    ts: boolean;
-    /**
-     * Whether to generate only types
-     */
-    typesOnly: boolean;
-}
-interface ApiModule {
-    /**
-     * The name of the API module
-     */
-    name: string;
-    /**
-     * API module payloads
-     */
-    payloads: ApiModulePayload[];
-}
-interface ApiModulePayload {
-    /**
-     * The comment of the API endpoint, including summary, description, URL, and method.
-     */
-    comment: string;
-    /**
-     * The name of the API function/dispatcher, such as apiGetUsers, apiCreatePost, apiUpdateComment, etc.
-     */
-    fn: string;
-    /**
-     * The URL of the API endpoint, such as /users, /posts, /comments, etc.
-     */
-    url: string;
-    /**
-     * The HTTP method of the API endpoint, such as get, post, put, delete, etc.
-     */
-    method: string;
-    /**
-     * The HTTP verb of the API endpoint, such as Get, Create, Update, Delete, etc.
-     */
-    verb: string;
-    /**
-     * The entity name of the API endpoint, such as User, Comment, Post, etc.
-     */
-    entity: string;
-    /**
-     * The request content type of the API endpoint, such as 'application/json', 'application/x-www-form-urlencoded'.
-     */
-    requestContentType?: string;
-    /**
-     * The type name of the API endpoint, such as ApiGetUsers, ApiCreatePost, ApiUpdateComment, etc.
-     */
-    type: string;
-    /**
-     * The value of the type of the API endpoint, such as paths['/users']['get'], paths['/posts']['post'], paths['/comments']['put'], etc.
-     */
-    typeValue: string;
-    /**
-     * The type name of the query parameters of the API endpoint, such as ApiGetUsersQuery, ApiCreatePostQuery, ApiUpdateCommentQuery, etc.
-     */
-    typeQuery: string;
-    /**
-     * The value of the type of the query parameters of the API endpoint, such as ApiGetUsersQuery['parameters']['query'], ApiCreatePostQuery['parameters']['query'], ApiUpdateCommentQuery['parameters']['query'], etc.
-     */
-    typeQueryValue: string;
-    /**
-     * The type name of the request body of the API endpoint, such as ApiGetUsersRequestBody, ApiCreatePostRequestBody, ApiUpdateCommentRequestBody, etc.
-     */
-    typeRequestBody: string;
-    /**
-     * The value of the type of the request body of the API endpoint, such as ApiGetUsersRequestBody['requestBody']['content']['application/json'], ApiCreatePostRequestBody['requestBody']['content']['application/json'], ApiUpdateCommentRequestBody['requestBody']['content']['application/json'], etc.
-     */
-    typeRequestBodyValue: string;
-    /**
-     * The type name of the response body of the API endpoint, such as ApiGetUsersResponseBody, ApiCreatePostResponseBody, ApiUpdateCommentResponseBody, etc.
-     */
-    typeResponseBody: string;
-    /**
-     * The value of the type of the response body of the API endpoint, such as ApiGetUsersResponseBody['responses']['200']['content']['application/json'], ApiCreatePostResponseBody['responses']['201']['content']['application/json'], ApiUpdateCommentResponseBody['responses']['200']['content']['application/json'], etc.
-     */
-    typeResponseBodyValue: string;
-}
-interface GenerateOptions {
-    /**
-     * The path to the OpenAPI/Swagger schema file.
-     * @default './schema.json'
-     */
-    input?: string;
-    /**
-     * The path to the output directory.
-     * @default './src/apis/generated'
-     */
-    output?: string;
-    /**
-     * The base path of the API endpoints.
-     */
-    base?: string;
-    /**
-     * The filename of the generated openapi types file.
-     * @default '_types.ts'
-     */
-    typesFilename?: string;
-    /**
-     * Whether to generate TypeScript code.
-     * @default true
-     */
-    ts?: boolean;
-    /**
-     * Whether to generate only types.
-     * @default false
-     */
-    typesOnly?: boolean;
-    /**
-     * Whether to override the existing files, or an array of filenames to override.
-     * @default true
-     */
-    overrides?: boolean | string[];
-    /**
-     * The preset ejs template to use.
-     * @default 'axle'
-     */
-    preset?: Preset;
-    /**
-     * Defines which return status codes will be typed
-     * @default (status) => status >= 200 && status < 300
-     */
-    validateStatus?: (status: number) => boolean;
-    /**
-     * The transformer api options, used to override the default transformation rules.
-     */
-    transformer?: Partial<Transformer>;
-    /**
-     * Certain uncountable nouns that do not change from singular to plural
-     */
-    uncountableNouns?: string[];
-    /**
-     * Whether to clean the output directory before generating.
-     * @default false
-     */
-    clean?: boolean;
-    /**
-     *  A function to transform the generated types AST before printing to string.
-     */
-    openapiTsOptions?: OpenAPITSOptions;
-    /**
-     * Whether to exclude deprecated API endpoints.
-     * @default false
-     */
-    excludeDeprecated?: boolean;
-}
-declare function transformPayloads(pathItems: Record<string, OperationObject>, options: {
-    path: string;
-    fullPath: string;
-    base: string | undefined;
-    transformer: Transformer;
-    uncountableNouns: string[];
-    validateStatus: (status: number) => boolean;
-    excludeDeprecated?: boolean;
-}): ApiModulePayload[];
-declare function partitionApiModules(schema: OpenAPI3, options: {
-    transformer: Transformer;
-    base: string | undefined;
-    uncountableNouns: string[];
-    validateStatus: (status: number) => boolean;
-    excludeDeprecated?: boolean;
-}): ApiModule[];
-declare function renderApiModules(apiModules: ApiModule[], options: {
-    output: string;
-    typesFilename: string;
-    ts: boolean;
-    typesOnly: boolean;
-    overrides: boolean | string[];
-    preset: Preset;
-}): Promise<unknown[]>;
-declare function generateTypes(schema: OpenAPI3, output: string, typesFilename: string, openapiTsOptions: OpenAPITSOptions): Promise<void>;
-declare function generate(userOptions?: GenerateOptions): Promise<void>;
-
-type Config = GenerateOptions;
-declare function defineConfig(config: Config): GenerateOptions;
-declare function getConfig(): Promise<Config>;
-
-export { type ApiModule, type ApiModulePayload, type ApiModuleTemplateData, type Config, type GenerateOptions, type Preset, type ResponseMetadataItem, type StatusCodeStrategy, type StatusCodes, type Transformer, type TransformerBaseArgs, createStatusCodesByStrategy, createTransformer, defineConfig, findObjectKey, generate, generateTypes, getCliVersion, getConfig, getRequestBodyContentType, getResponseMetadataItems, getSchemaNode, isRemoteSchema, isRequiredRequestBody, partitionApiModules, readSchema, readSchemaContent, readTemplateFile, renderApiModules, transformComment, transformEntity, transformFn, transformModuleName, transformPayloads, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };