@devbie/apits 1.0.0 → 1.0.1

package/README.md

@@ -1,10 +1,10 @@
-# apits-gen
+# @devbie/apits
 
 Based on the OpenAPI specification, generate request and response type declarations and request method bodies for APIs
 
 ## Installation
 
-`npm install apits-gen`
+`npm install @devbie/apits`
 
 ## Quick start (no config file needed)
 
@@ -58,7 +58,7 @@ The config file is auto-discovered from any of:
 
 ```ts
 // apits.config.ts
-import { defineConfig } from 'apits-gen'
+import { defineConfig } from '@devbie/apits'
 
 export default defineConfig([
   {

package/dist/cjs/core/cli.js

@@ -192,7 +192,7 @@ async function genConfig(prefill) {
   await import_fs_extra.default.outputFile(
     configTSFile,
     await (0, import_utils.formatContent)(import_vtilsLite.dedent`
-      import { defineConfig } from 'apits-gen'
+      import { defineConfig } from '@devbie/apits'
 
       export default defineConfig([{
         input: '${(configAnswers == null ? void 0 : configAnswers.input) || ""}',

package/dist/cjs/utils/utils.js

@@ -338,7 +338,7 @@ async function formatContent(content, filePath) {
 function topNotesContent() {
   return `
   /**
-   * Created By apits-gen
+   * Created By @devbie/apits
    */
 
   `;

package/dist/esm/core/cli.mjs

@@ -352,7 +352,7 @@ function _genConfig() {
           _context7.t0 = fs;
           _context7.t1 = configTSFile;
           _context7.next = 21;
-          return formatContent(dedent(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n      import { defineConfig } from 'apits-gen'\n\n      export default defineConfig([{\n        input: '", "',\n        output: 'src/api',\n      ", "  baseURL: '[code]:process.env.BASE_API_URL',\n        clientImportTemplate: () => \"", "\",\n        // Keep the scaffolded request.ts because the import above points at it.\n        client: true,\n      }])\n    "])), (configAnswers === null || configAnswers === void 0 ? void 0 : configAnswers.input) || "", nameLine, "import request from './request'"));
+          return formatContent(dedent(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n      import { defineConfig } from '@devbie/apits'\n\n      export default defineConfig([{\n        input: '", "',\n        output: 'src/api',\n      ", "  baseURL: '[code]:process.env.BASE_API_URL',\n        clientImportTemplate: () => \"", "\",\n        // Keep the scaffolded request.ts because the import above points at it.\n        client: true,\n      }])\n    "])), (configAnswers === null || configAnswers === void 0 ? void 0 : configAnswers.input) || "", nameLine, "import request from './request'"));
         case 21:
           _context7.t2 = _context7.sent;
           _context7.next = 24;

package/dist/esm/utils/utils.mjs

@@ -541,5 +541,5 @@ function _formatContent() {
   return _formatContent.apply(this, arguments);
 }
 export function topNotesContent() {
-  return "\n  /**\n   * Created By apits-gen\n   */\n\n  ";
+  return "\n  /**\n   * Created By @devbie/apits\n   */\n\n  ";
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devbie/apits",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "author": "zimv <zimudashiren@163.com>",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.mjs",

package/dist/cjs/core/generator.d.ts

@@ -1,44 +0,0 @@
-import { OpenAPIV3 } from "openapi-types";
-import { Config, ExtendedInterface, Interface, SyntheticalConfig } from "../types.js";
-interface OutputFileList {
-    [outputFilePath: string]: {
-        projectId: string;
-        categoryId: string;
-        syntheticalConfig: SyntheticalConfig;
-        content: string[];
-    };
-}
-export declare class Generator {
-    /** Generator configuration. */
-    private config;
-    constructor(config: Config);
-    /** Whether an input points to a remote http(s) resource. */
-    private static isHttpInput;
-    /**
-     * Derive a file base name from the input: hostname for URLs, file name
-     * without extension for local paths. Falls back to `api`.
-     */
-    static deriveName(input: string): string;
-    /** Parse a raw JSON / JSON5 / YAML document string. */
-    private parseSpecDocument;
-    /**
-     * Load the OpenAPI document from a remote URL or a local file.
-     * Both JSON (.json/.json5) and YAML (.yaml/.yml) are supported.
-     */
-    loadSpec(input: string): Promise<OpenAPIV3.Document>;
-    /**
-     * Generate all code from the OpenAPI document.
-     * @returns map of output file path to file contents
-     */
-    generate(): Promise<OutputFileList>;
-    /**
-     * Write all generated files to disk.
-     * @param outputFileList generated files
-     */
-    write(outputFileList: OutputFileList): Promise<void[]>;
-    /** Generate a request function name from the extended interface info. */
-    requestFunctionNameGen(extendedInterfaceInfo: ExtendedInterface): string;
-    /** Generate TypeScript code (types + request function) for a single API. */
-    generateInterfaceCode(syntheticalConfig: SyntheticalConfig, interfaceInfo: Interface): Promise<string>;
-}
-export {};

package/dist/cjs/core/writeRequestClient.d.ts

@@ -1,2 +0,0 @@
-import { Config } from "../types.js";
-export default function writeRequestClient(config: Config): Promise<void>;

package/dist/cjs/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./types.js";
-export * from "./utils/helpers.js";

package/dist/cjs/types.d.ts

@@ -1,330 +0,0 @@
-/// <reference types="node" />
-export * from "json-schema";
-import { JSONSchema4 } from "json-schema";
-import { OpenAPIV3 } from "openapi-types";
-import { ParsedPath } from "path";
-/** Returns the client import snippet placed at the top of each generated file. */
-export type ClientImportTemplate = () => string;
-/** Interface definition */
-export interface Interface {
-    /** Interface name */
-    title: string;
-    /** Request path */
-    path: string;
-    /** Request method, HEAD and OPTIONS are handled like GET, others like POST */
-    method: Method;
-    /** Path parameters */
-    req_params: Array<{
-        /** Name */
-        name: string;
-        /** Description */
-        desc: string;
-        /** Example */
-        example: string;
-        /** Type (YApi-X) */
-        type?: RequestParamType;
-    }>;
-    /** GET only: query string */
-    req_query: Array<{
-        /** Name */
-        name: string;
-        /** Description */
-        desc: string;
-        /** Example */
-        example: string;
-        /** Required */
-        required: Required;
-        /** Type (YApi-X) */
-        type?: RequestQueryType;
-    }>;
-    /** POST only: request content type. No special handling needed for text, file, raw. */
-    req_body_type: RequestBodyType;
-    /** Whether it is json schema when `req_body_type = json` */
-    req_body_is_json_schema: boolean;
-    /** Request content when `req_body_type = form` */
-    req_body_form: Array<{
-        /** Name */
-        name: string;
-        /** Type */
-        type: RequestFormItemType;
-        /** Description */
-        desc: string;
-        /** Example */
-        example: string;
-        /** Required */
-        required: Required;
-        /**
-         * Whether the field accepts multiple files (a binary array in the
-         * OpenAPI schema, e.g. `files: {type: 'array', items: {format: 'binary'}}`).
-         * Only meaningful when `type` is `file`.
-         */
-        isArray?: boolean;
-        /** Allowed literal values when the form field is an enum */
-        enum?: Array<string | number>;
-    }>;
-    /**
-     * Whether the form body is `multipart/form-data` (true) or
-     * `application/x-www-form-urlencoded` (false). Only set when
-     * `req_body_type = form`.
-     */
-    req_body_multipart?: boolean;
-    /**
-     * JSON Schema fragment describing dynamic form fields (the
-     * `additionalProperties` of a multipart request schema). Used for
-     * runtime-named upload fields such as `evidence_0`, `evidence_1`, ...
-     */
-    req_body_additional?: Record<string, any>;
-    /** Request content when `req_body_type = json` */
-    req_body_other: string;
-    /** Response data type */
-    res_body_type: ResponseBodyType;
-    /** Whether it is json schema when `res_body_type = json` */
-    res_body_is_json_schema: boolean;
-    /** Response data */
-    res_body: string;
-    [key: string]: any;
-}
-/** Category information */
-export interface Category {
-    /** Category name */
-    name: string;
-    /** Category description */
-    desc: string;
-}
-/** Request method */
-export declare enum Method {
-    GET = "GET",
-    POST = "POST",
-    PUT = "PUT",
-    DELETE = "DELETE",
-    HEAD = "HEAD",
-    OPTIONS = "OPTIONS",
-    PATCH = "PATCH"
-}
-/** Required */
-export declare enum Required {
-    /** Not required */
-    false = "0",
-    /** Required */
-    true = "1"
-}
-/** Request body type */
-export declare enum RequestBodyType {
-    /** Query string */
-    query = "query",
-    /** Form */
-    form = "form",
-    /** JSON */
-    json = "json",
-    /** Plain text */
-    text = "text",
-    /** File */
-    file = "file",
-    /** Raw data */
-    raw = "raw",
-    /** No request data */
-    none = "none"
-}
-/** Request path parameter type */
-export declare enum RequestParamType {
-    /** String */
-    string = "string",
-    /** Number */
-    number = "number"
-}
-/** Request query parameter type */
-export declare enum RequestQueryType {
-    /** String */
-    string = "string",
-    /** Number */
-    number = "number"
-}
-/** Request form item type */
-export declare enum RequestFormItemType {
-    /** Plain text */
-    text = "text",
-    /** File */
-    file = "file"
-}
-/** Response body type */
-export declare enum ResponseBodyType {
-    /** JSON */
-    json = "json",
-    /** Plain text */
-    text = "text",
-    /** XML */
-    xml = "xml",
-    /** Raw data */
-    raw = "raw"
-}
-/** Extended interface definition */
-export interface ExtendedInterface extends Interface {
-    parsedPath: ParsedPath;
-}
-/**
- * Generator configuration for one OpenAPI source.
- */
-export interface ApiConfig {
-    /**
-     * The OpenAPI document to generate code from. Required.
-     *
-     * Accepts an http(s) URL or a local file path. Local files may be
-     * JSON (.json / .json5) or YAML (.yaml / .yml).
-     *
-     * @example 'http://localhost:3041/api-json'
-     * @example './openapi.json'
-     * @example './docs/openapi.yaml'
-     */
-    input: string;
-    /**
-     * Output directory for generated files (relative or absolute path).
-     *
-     * Two files are written into it: `<name>.ts` (type declarations and
-     * request functions) and `request.ts` (the axios client, unless
-     * `client` is false or the file already exists).
-     *
-     * @default 'src/api'
-     */
-    output?: string;
-    /**
-     * Base name of the generated types file: code is written to
-     * `<output>/<name>.ts`. Also serves as the source identifier for
-     * `apits gen -n <name>` filtering.
-     *
-     * Defaults to a name derived from `input`: the URL hostname
-     * (`http://localhost:3041/api-json` -> `localhost`) or the local file
-     * name without extension (`./user.openapi.yaml` -> `userOpenapi`).
-     * Duplicated derived names get an index suffix.
-     */
-    name?: string;
-    /**
-     * Runtime `baseURL` baked into every generated request function.
-     *
-     * Prefix with `[code]:` to emit the value as code instead of a string
-     * literal, e.g. to read from an env var at runtime:
-     *
-     * - `baseURL: '[code]:process.env.BASE_URL'` -> `baseURL: process.env.BASE_URL`
-     * - `baseURL: 'http://localhost:3000'`       -> `baseURL: "http://localhost:3000"`
-     *
-     * May also be a function receiving each API path and returning the
-     * baseURL to use for that path (or undefined to omit).
-     */
-    baseURL?: ((path: string) => string | undefined) | string;
-    /**
-     * Returns the import snippet placed at the top of every generated file —
-     * use it to point at a custom request client instead of the scaffolded
-     * `request.ts`.
-     *
-     * Providing this option also flips the default of `client` to `false`,
-     * so no unused `request.ts` is scaffolded; set `client: true` explicitly
-     * to keep both.
-     *
-     * @default () => "import request from './request'"
-     */
-    clientImportTemplate?: ClientImportTemplate;
-    /**
-     * Type used for the `extra` argument of every generated request
-     * function — the object spread into the underlying client call as
-     * per-request overrides (headers, signal, `responseType`, ...).
-     *
-     * Defaults to `AxiosRequestConfig`, in which case each generated file
-     * also imports that type from `axios`. When using a custom client via
-     * `clientImportTemplate`, set this to that client's config type and
-     * make sure `clientImportTemplate` imports it, e.g.:
-     *
-     * ```ts
-     * clientImportTemplate: () => "import {request, type RequestConfig} from '../fetch'",
-     * clientConfigType: 'RequestConfig',
-     * ```
-     *
-     * @default 'AxiosRequestConfig'
-     */
-    clientConfigType?: string;
-    /**
-     * Whether to scaffold the default axios request client into
-     * `<output>/request.ts` (skipped when that file already exists).
-     *
-     * Defaults to `true`, and to `false` when `clientImportTemplate` is
-     * provided without an explicit `client` value.
-     *
-     * @default true
-     */
-    client?: boolean;
-}
-/** Combined configuration. */
-export type SyntheticalConfig = Partial<ApiConfig & {
-    components: OpenAPIV3.Document["components"];
-}>;
-/** Configuration. */
-export type Config = ApiConfig;
-/**
- * Request configuration.
- */
-export interface RequestConfig<Path extends string = string, ParamName extends string = string, QueryName extends string = string, RequestDataOptional extends boolean = boolean> {
-    /** Interface path, starting with `/` */
-    path: Path;
-    /** Request method */
-    method: Method;
-    /** Request headers, all headers except Content-Type */
-    requestHeaders: Record<string, string>;
-    /** Request body type */
-    requestBodyType: RequestBodyType;
-    /** Response body type */
-    responseBodyType: ResponseBodyType;
-    /** List of path parameter names */
-    paramNames: ParamName[];
-    /** List of query parameter names */
-    queryNames: QueryName[];
-    /** Whether request data is optional */
-    requestDataOptional: RequestDataOptional;
-    /** JSON Schema for request data (only effective when JSON Schema generation is enabled) */
-    requestDataJsonSchema: JSONSchema4;
-    /** JSON Schema for response data (only effective when JSON Schema generation is enabled) */
-    responseDataJsonSchema: JSONSchema4;
-    /** Request function name */
-    requestFunctionName: string;
-}
-/**
- * Request parameters.
- */
-export interface RequestFunctionParams extends RequestConfig {
-    /** Raw data */
-    rawData: Record<string, any>;
-    /** Request data, excluding file data */
-    data: Record<string, any>;
-    /** Whether there is file data */
-    hasFileData: boolean;
-    /** Request file data */
-    fileData: Record<string, any>;
-    /** All request data, including data and fileData */
-    allData: Record<string, any>;
-    /** Get FormData instance for all request data (including files) */
-    getFormData: () => FormData;
-}
-/** Additional parameters of the request function */
-export type RequestFunctionRestArgs<T extends Function> = T extends (payload: any, ...args: infer R) => any ? R : never;
-/** Property definition */
-export interface PropDefinition {
-    /** Property name */
-    name: string;
-    /** Required */
-    required: boolean;
-    /** Type */
-    type: JSONSchema4["type"];
-    /** Comment */
-    comment: string;
-    /** Whether the property is an array (used for multi-file upload fields) */
-    isArray?: boolean;
-    /** Allowed literal values for enum properties */
-    enum?: Array<string | number>;
-}
-/** Property definition list */
-export type PropDefinitions = PropDefinition[];
-/** Request function body generation template function */
-export interface RequestFunctionTemplateProps {
-    baseURL?: string;
-    requestFunctionName: string;
-    requestDataTypeName: string;
-    extendedInterfaceInfo: ExtendedInterface;
-    responseDataTypeName: string;
-}

package/dist/cjs/utils/console.d.ts

@@ -1,16 +0,0 @@
-/** Log a plain message. */
-export declare function log(message?: any, ...args: any[]): void;
-/** Log an error message. */
-export declare function error(message?: any, ...args: any[]): void;
-/** Log an info message. */
-export declare function info(message?: any, ...args: any[]): void;
-/** Log a warning message. */
-export declare function warn(message?: any, ...args: any[]): void;
-/** Log a soft tip message with a prefix icon. */
-export declare function tips(message?: any, ...args: any[]): void;
-/** Log a success message. */
-export declare function success(message?: any, ...args: any[]): void;
-/** Print tabular data as a table. */
-export declare function table(tabularData: any, properties?: ReadonlyArray<string>): void;
-/** Print a separator line (or a blank line). */
-export declare function line(blank?: boolean): void;

package/dist/cjs/utils/getOutputPath.d.ts

@@ -1,5 +0,0 @@
-/**
- * Resolve the output file path for a generated file.
- */
-import { Config } from "../types.js";
-export declare const getOutputFilePath: (config: Config, file: string) => string;

package/dist/cjs/utils/helpers.d.ts

@@ -1,65 +0,0 @@
-import type { AppendOptions } from "form-data";
-import type { Config, RequestConfig, RequestFunctionParams } from "../types.js";
-/**
- * Normalize user configuration into a config array and apply built-in
- * defaults.
- *
- * Defaults:
- * - `output` falls back to `src/api`.
- * - `client` falls back to `true`, except when a custom
- *   `clientImportTemplate` is provided without an explicit `client` value —
- *   in that case the scaffolded client is skipped automatically, otherwise
- *   the generated `request.ts` would be dead code (the generated file
- *   imports the custom client instead).
- *
- * @param config Configuration
- */
-export declare function defineConfig(config: Config | Config[]): Config[];
-export declare class FileData<T = any> {
-    /**
-     * Original file data.
-     */
-    private originalFileData;
-    /**
-     * Options.
-     */
-    private options;
-    /**
-     * File data helper class, unified file upload for web, mini-program and other platforms.
-     *
-     * @param originalFileData Original file data
-     * @param options If using internal getFormData, options will be used by it
-     */
-    constructor(originalFileData: T, options?: AppendOptions);
-    /**
-     * Get original file data.
-     *
-     * @returns Original file data
-     */
-    getOriginalFileData(): T;
-    /**
-     * Get options.
-     */
-    getOptions(): AppendOptions | undefined;
-}
-/**
- * Parse request data, separating normal data and file data from request data.
- *
- * @param [requestData] Request data to parse
- * @returns Object containing normal data (data) and file data (fileData), when data and fileData are empty objects, it means no such data exists
- */
-export declare function parseRequestData(requestData?: any): {
-    data: any;
-    fileData: any;
-};
-/**
- * Prepare parameters to be passed to the request function.
- */
-export declare function prepare(requestConfig: RequestConfig, requestData: any): RequestFunctionParams;
-/**
- * Execute async function queue sequentially
- * @param fns
- * @param results
- * @returns
- */
-export declare const asyncFnArrayOrderRun: <T = any>(fns: (() => Promise<T>)[], results?: T[]) => Promise<T[]>;

package/dist/cjs/utils/openApiToInterfaces.d.ts

@@ -1,14 +0,0 @@
-import { OpenAPIV3 } from "openapi-types";
-import { Interface } from "../types.js";
-/**
- * Convert an OpenAPI 3.x document into the internal `Interface[]` format.
- *
- * Reads OAS3 directly — no intermediate Swagger 2.0 `openapi3Format` step,
- * no YApi platform fields (`_id`/`project_id`/`catid`/`add_time`/`up_time`),
- * no module-level mutable state.
- *
- * @param data OpenAPI 3.x document (object or JSON string)
- */
-export declare function openApiToInterfaces(data: OpenAPIV3.Document | string): Promise<{
-    interfaces: Interface[];
-}>;

package/dist/cjs/utils/spinner.d.ts

@@ -1,15 +0,0 @@
-import { Ora } from "ora";
-declare class Spin {
-    spinnerInstance: Ora;
-    constructor();
-    clear(): void;
-    start(text?: string): void;
-    succeed(text?: string): void;
-    fail(text?: string): void;
-    render(): void;
-    frame(): void;
-    info(text?: string): void;
-    stop(): void;
-}
-export declare const spinnerInstance: Spin;
-export {};

package/dist/cjs/utils/vtilsLite.d.ts

@@ -1,55 +0,0 @@
-/**
- * Local replacements for the small subset of `vtils` helpers used by this
- * project. `vtils` pulls in several deprecated dependencies (cuid, uuid,
- * tough-cookie@0.12.1 with a ReDoS advisory) and is otherwise unmaintained,
- * so these minimal local implementations keep the dependency tree clean.
- *
- * Behavior matches the upstream vtils functions for the call sites in this
- * repository only; no attempt is made to be a drop-in replacement for the
- * full vtils API.
- */
-/**
- * Remove `undefined` from a type. Equivalent to vtils's `Defined<T>`.
- */
-export type Defined<T> = Exclude<T, undefined>;
-/**
- * Wrap a value in an array unless it is already an array.
- */
-export declare function castArray<T>(value: T | T[]): T[];
-/**
- * `Array.isArray` alias, kept for import symmetry with the other helpers.
- */
-export declare const isArray: (arg: any) => arg is any[];
-/**
- * Check whether a value is a plain object (not null, not an array, not a
- * function, not a primitive). Matches vtils `isObject` for the JSON-Schema
- * values used in this project.
- */
-export declare function isObject(value: any): value is Record<string, any>;
-/**
- * Check whether a value is "empty": null/undefined, empty string, empty
- * array, or an object with no own enumerable string-keyed properties.
- */
-export declare function isEmpty(value: any): boolean;
-/**
- * Iterate over the own enumerable string-keyed properties of an object,
- * invoking `callback(value, key)` for each.
- */
-export declare function forOwn<T extends object>(obj: T, callback: (value: T[keyof T], key: keyof T) => void): void;
-/**
- * Iterate over a collection (array or object), invoking `callback(value, key)`
- * for each item. For arrays `key` is the numeric index. Types are intentionally
- * loose (matching vtils) because call sites pass heterogeneous OpenAPI data.
- */
-export declare function each(collection: any, callback: (value: any, key: any) => void): void;
-/**
- * Return the first item in a collection for which `predicate` returns a
- * truthy value, or `undefined` if none matches.
- */
-export declare function find(collection: any, predicate: (value: any, key: any) => boolean): any;
-/**
- * Tagged-template helper that strips the common leading whitespace from every
- * line. Multi-line interpolations keep the indentation of the line they are
- * embedded on (mirrors vtils `dedent`, which first runs `indent`).
- */
-export declare function dedent(literals: TemplateStringsArray, ...interpolations: any[]): string;

package/dist/esm/core/generator.d.mts

@@ -1,44 +0,0 @@
-import { OpenAPIV3 } from "openapi-types";
-import { Config, ExtendedInterface, Interface, SyntheticalConfig } from "../types.mjs";
-interface OutputFileList {
-    [outputFilePath: string]: {
-        projectId: string;
-        categoryId: string;
-        syntheticalConfig: SyntheticalConfig;
-        content: string[];
-    };
-}
-export declare class Generator {
-    /** Generator configuration. */
-    private config;
-    constructor(config: Config);
-    /** Whether an input points to a remote http(s) resource. */
-    private static isHttpInput;
-    /**
-     * Derive a file base name from the input: hostname for URLs, file name
-     * without extension for local paths. Falls back to `api`.
-     */
-    static deriveName(input: string): string;
-    /** Parse a raw JSON / JSON5 / YAML document string. */
-    private parseSpecDocument;
-    /**
-     * Load the OpenAPI document from a remote URL or a local file.
-     * Both JSON (.json/.json5) and YAML (.yaml/.yml) are supported.
-     */
-    loadSpec(input: string): Promise<OpenAPIV3.Document>;
-    /**
-     * Generate all code from the OpenAPI document.
-     * @returns map of output file path to file contents
-     */
-    generate(): Promise<OutputFileList>;
-    /**
-     * Write all generated files to disk.
-     * @param outputFileList generated files
-     */
-    write(outputFileList: OutputFileList): Promise<void[]>;
-    /** Generate a request function name from the extended interface info. */
-    requestFunctionNameGen(extendedInterfaceInfo: ExtendedInterface): string;
-    /** Generate TypeScript code (types + request function) for a single API. */
-    generateInterfaceCode(syntheticalConfig: SyntheticalConfig, interfaceInfo: Interface): Promise<string>;
-}
-export {};

package/dist/esm/core/writeRequestClient.d.mts

@@ -1,2 +0,0 @@
-import { Config } from "../types.mjs";
-export default function writeRequestClient(config: Config): Promise<void>;

package/dist/esm/index.d.mts

@@ -1,2 +0,0 @@
-export * from "./types.mjs";
-export * from "./utils/helpers.mjs";

package/dist/esm/types.d.mts

@@ -1,330 +0,0 @@
-/// <reference types="node" />
-export * from "json-schema";
-import { JSONSchema4 } from "json-schema";
-import { OpenAPIV3 } from "openapi-types";
-import { ParsedPath } from "path";
-/** Returns the client import snippet placed at the top of each generated file. */
-export type ClientImportTemplate = () => string;
-/** Interface definition */
-export interface Interface {
-    /** Interface name */
-    title: string;
-    /** Request path */
-    path: string;
-    /** Request method, HEAD and OPTIONS are handled like GET, others like POST */
-    method: Method;
-    /** Path parameters */
-    req_params: Array<{
-        /** Name */
-        name: string;
-        /** Description */
-        desc: string;
-        /** Example */
-        example: string;
-        /** Type (YApi-X) */
-        type?: RequestParamType;
-    }>;
-    /** GET only: query string */
-    req_query: Array<{
-        /** Name */
-        name: string;
-        /** Description */
-        desc: string;
-        /** Example */
-        example: string;
-        /** Required */
-        required: Required;
-        /** Type (YApi-X) */
-        type?: RequestQueryType;
-    }>;
-    /** POST only: request content type. No special handling needed for text, file, raw. */
-    req_body_type: RequestBodyType;
-    /** Whether it is json schema when `req_body_type = json` */
-    req_body_is_json_schema: boolean;
-    /** Request content when `req_body_type = form` */
-    req_body_form: Array<{
-        /** Name */
-        name: string;
-        /** Type */
-        type: RequestFormItemType;
-        /** Description */
-        desc: string;
-        /** Example */
-        example: string;
-        /** Required */
-        required: Required;
-        /**
-         * Whether the field accepts multiple files (a binary array in the
-         * OpenAPI schema, e.g. `files: {type: 'array', items: {format: 'binary'}}`).
-         * Only meaningful when `type` is `file`.
-         */
-        isArray?: boolean;
-        /** Allowed literal values when the form field is an enum */
-        enum?: Array<string | number>;
-    }>;
-    /**
-     * Whether the form body is `multipart/form-data` (true) or
-     * `application/x-www-form-urlencoded` (false). Only set when
-     * `req_body_type = form`.
-     */
-    req_body_multipart?: boolean;
-    /**
-     * JSON Schema fragment describing dynamic form fields (the
-     * `additionalProperties` of a multipart request schema). Used for
-     * runtime-named upload fields such as `evidence_0`, `evidence_1`, ...
-     */
-    req_body_additional?: Record<string, any>;
-    /** Request content when `req_body_type = json` */
-    req_body_other: string;
-    /** Response data type */
-    res_body_type: ResponseBodyType;
-    /** Whether it is json schema when `res_body_type = json` */
-    res_body_is_json_schema: boolean;
-    /** Response data */
-    res_body: string;
-    [key: string]: any;
-}
-/** Category information */
-export interface Category {
-    /** Category name */
-    name: string;
-    /** Category description */
-    desc: string;
-}
-/** Request method */
-export declare enum Method {
-    GET = "GET",
-    POST = "POST",
-    PUT = "PUT",
-    DELETE = "DELETE",
-    HEAD = "HEAD",
-    OPTIONS = "OPTIONS",
-    PATCH = "PATCH"
-}
-/** Required */
-export declare enum Required {
-    /** Not required */
-    false = "0",
-    /** Required */
-    true = "1"
-}
-/** Request body type */
-export declare enum RequestBodyType {
-    /** Query string */
-    query = "query",
-    /** Form */
-    form = "form",
-    /** JSON */
-    json = "json",
-    /** Plain text */
-    text = "text",
-    /** File */
-    file = "file",
-    /** Raw data */
-    raw = "raw",
-    /** No request data */
-    none = "none"
-}
-/** Request path parameter type */
-export declare enum RequestParamType {
-    /** String */
-    string = "string",
-    /** Number */
-    number = "number"
-}
-/** Request query parameter type */
-export declare enum RequestQueryType {
-    /** String */
-    string = "string",
-    /** Number */
-    number = "number"
-}
-/** Request form item type */
-export declare enum RequestFormItemType {
-    /** Plain text */
-    text = "text",
-    /** File */
-    file = "file"
-}
-/** Response body type */
-export declare enum ResponseBodyType {
-    /** JSON */
-    json = "json",
-    /** Plain text */
-    text = "text",
-    /** XML */
-    xml = "xml",
-    /** Raw data */
-    raw = "raw"
-}
-/** Extended interface definition */
-export interface ExtendedInterface extends Interface {
-    parsedPath: ParsedPath;
-}
-/**
- * Generator configuration for one OpenAPI source.
- */
-export interface ApiConfig {
-    /**
-     * The OpenAPI document to generate code from. Required.
-     *
-     * Accepts an http(s) URL or a local file path. Local files may be
-     * JSON (.json / .json5) or YAML (.yaml / .yml).
-     *
-     * @example 'http://localhost:3041/api-json'
-     * @example './openapi.json'
-     * @example './docs/openapi.yaml'
-     */
-    input: string;
-    /**
-     * Output directory for generated files (relative or absolute path).
-     *
-     * Two files are written into it: `<name>.ts` (type declarations and
-     * request functions) and `request.ts` (the axios client, unless
-     * `client` is false or the file already exists).
-     *
-     * @default 'src/api'
-     */
-    output?: string;
-    /**
-     * Base name of the generated types file: code is written to
-     * `<output>/<name>.ts`. Also serves as the source identifier for
-     * `apits gen -n <name>` filtering.
-     *
-     * Defaults to a name derived from `input`: the URL hostname
-     * (`http://localhost:3041/api-json` -> `localhost`) or the local file
-     * name without extension (`./user.openapi.yaml` -> `userOpenapi`).
-     * Duplicated derived names get an index suffix.
-     */
-    name?: string;
-    /**
-     * Runtime `baseURL` baked into every generated request function.
-     *
-     * Prefix with `[code]:` to emit the value as code instead of a string
-     * literal, e.g. to read from an env var at runtime:
-     *
-     * - `baseURL: '[code]:process.env.BASE_URL'` -> `baseURL: process.env.BASE_URL`
-     * - `baseURL: 'http://localhost:3000'`       -> `baseURL: "http://localhost:3000"`
-     *
-     * May also be a function receiving each API path and returning the
-     * baseURL to use for that path (or undefined to omit).
-     */
-    baseURL?: ((path: string) => string | undefined) | string;
-    /**
-     * Returns the import snippet placed at the top of every generated file —
-     * use it to point at a custom request client instead of the scaffolded
-     * `request.ts`.
-     *
-     * Providing this option also flips the default of `client` to `false`,
-     * so no unused `request.ts` is scaffolded; set `client: true` explicitly
-     * to keep both.
-     *
-     * @default () => "import request from './request'"
-     */
-    clientImportTemplate?: ClientImportTemplate;
-    /**
-     * Type used for the `extra` argument of every generated request
-     * function — the object spread into the underlying client call as
-     * per-request overrides (headers, signal, `responseType`, ...).
-     *
-     * Defaults to `AxiosRequestConfig`, in which case each generated file
-     * also imports that type from `axios`. When using a custom client via
-     * `clientImportTemplate`, set this to that client's config type and
-     * make sure `clientImportTemplate` imports it, e.g.:
-     *
-     * ```ts
-     * clientImportTemplate: () => "import {request, type RequestConfig} from '../fetch'",
-     * clientConfigType: 'RequestConfig',
-     * ```
-     *
-     * @default 'AxiosRequestConfig'
-     */
-    clientConfigType?: string;
-    /**
-     * Whether to scaffold the default axios request client into
-     * `<output>/request.ts` (skipped when that file already exists).
-     *
-     * Defaults to `true`, and to `false` when `clientImportTemplate` is
-     * provided without an explicit `client` value.
-     *
-     * @default true
-     */
-    client?: boolean;
-}
-/** Combined configuration. */
-export type SyntheticalConfig = Partial<ApiConfig & {
-    components: OpenAPIV3.Document["components"];
-}>;
-/** Configuration. */
-export type Config = ApiConfig;
-/**
- * Request configuration.
- */
-export interface RequestConfig<Path extends string = string, ParamName extends string = string, QueryName extends string = string, RequestDataOptional extends boolean = boolean> {
-    /** Interface path, starting with `/` */
-    path: Path;
-    /** Request method */
-    method: Method;
-    /** Request headers, all headers except Content-Type */
-    requestHeaders: Record<string, string>;
-    /** Request body type */
-    requestBodyType: RequestBodyType;
-    /** Response body type */
-    responseBodyType: ResponseBodyType;
-    /** List of path parameter names */
-    paramNames: ParamName[];
-    /** List of query parameter names */
-    queryNames: QueryName[];
-    /** Whether request data is optional */
-    requestDataOptional: RequestDataOptional;
-    /** JSON Schema for request data (only effective when JSON Schema generation is enabled) */
-    requestDataJsonSchema: JSONSchema4;
-    /** JSON Schema for response data (only effective when JSON Schema generation is enabled) */
-    responseDataJsonSchema: JSONSchema4;
-    /** Request function name */
-    requestFunctionName: string;
-}
-/**
- * Request parameters.
- */
-export interface RequestFunctionParams extends RequestConfig {
-    /** Raw data */
-    rawData: Record<string, any>;
-    /** Request data, excluding file data */
-    data: Record<string, any>;
-    /** Whether there is file data */
-    hasFileData: boolean;
-    /** Request file data */
-    fileData: Record<string, any>;
-    /** All request data, including data and fileData */
-    allData: Record<string, any>;
-    /** Get FormData instance for all request data (including files) */
-    getFormData: () => FormData;
-}
-/** Additional parameters of the request function */
-export type RequestFunctionRestArgs<T extends Function> = T extends (payload: any, ...args: infer R) => any ? R : never;
-/** Property definition */
-export interface PropDefinition {
-    /** Property name */
-    name: string;
-    /** Required */
-    required: boolean;
-    /** Type */
-    type: JSONSchema4["type"];
-    /** Comment */
-    comment: string;
-    /** Whether the property is an array (used for multi-file upload fields) */
-    isArray?: boolean;
-    /** Allowed literal values for enum properties */
-    enum?: Array<string | number>;
-}
-/** Property definition list */
-export type PropDefinitions = PropDefinition[];
-/** Request function body generation template function */
-export interface RequestFunctionTemplateProps {
-    baseURL?: string;
-    requestFunctionName: string;
-    requestDataTypeName: string;
-    extendedInterfaceInfo: ExtendedInterface;
-    responseDataTypeName: string;
-}

package/dist/esm/utils/console.d.mts

@@ -1,16 +0,0 @@
-/** Log a plain message. */
-export declare function log(message?: any, ...args: any[]): void;
-/** Log an error message. */
-export declare function error(message?: any, ...args: any[]): void;
-/** Log an info message. */
-export declare function info(message?: any, ...args: any[]): void;
-/** Log a warning message. */
-export declare function warn(message?: any, ...args: any[]): void;
-/** Log a soft tip message with a prefix icon. */
-export declare function tips(message?: any, ...args: any[]): void;
-/** Log a success message. */
-export declare function success(message?: any, ...args: any[]): void;
-/** Print tabular data as a table. */
-export declare function table(tabularData: any, properties?: ReadonlyArray<string>): void;
-/** Print a separator line (or a blank line). */
-export declare function line(blank?: boolean): void;

package/dist/esm/utils/getOutputPath.d.mts

@@ -1,5 +0,0 @@
-/**
- * Resolve the output file path for a generated file.
- */
-import { Config } from "../types.mjs";
-export declare const getOutputFilePath: (config: Config, file: string) => string;

package/dist/esm/utils/helpers.d.mts

@@ -1,65 +0,0 @@
-import type { AppendOptions } from "form-data";
-import type { Config, RequestConfig, RequestFunctionParams } from "../types.mjs";
-/**
- * Normalize user configuration into a config array and apply built-in
- * defaults.
- *
- * Defaults:
- * - `output` falls back to `src/api`.
- * - `client` falls back to `true`, except when a custom
- *   `clientImportTemplate` is provided without an explicit `client` value —
- *   in that case the scaffolded client is skipped automatically, otherwise
- *   the generated `request.ts` would be dead code (the generated file
- *   imports the custom client instead).
- *
- * @param config Configuration
- */
-export declare function defineConfig(config: Config | Config[]): Config[];
-export declare class FileData<T = any> {
-    /**
-     * Original file data.
-     */
-    private originalFileData;
-    /**
-     * Options.
-     */
-    private options;
-    /**
-     * File data helper class, unified file upload for web, mini-program and other platforms.
-     *
-     * @param originalFileData Original file data
-     * @param options If using internal getFormData, options will be used by it
-     */
-    constructor(originalFileData: T, options?: AppendOptions);
-    /**
-     * Get original file data.
-     *
-     * @returns Original file data
-     */
-    getOriginalFileData(): T;
-    /**
-     * Get options.
-     */
-    getOptions(): AppendOptions | undefined;
-}
-/**
- * Parse request data, separating normal data and file data from request data.
- *
- * @param [requestData] Request data to parse
- * @returns Object containing normal data (data) and file data (fileData), when data and fileData are empty objects, it means no such data exists
- */
-export declare function parseRequestData(requestData?: any): {
-    data: any;
-    fileData: any;
-};
-/**
- * Prepare parameters to be passed to the request function.
- */
-export declare function prepare(requestConfig: RequestConfig, requestData: any): RequestFunctionParams;
-/**
- * Execute async function queue sequentially
- * @param fns
- * @param results
- * @returns
- */
-export declare const asyncFnArrayOrderRun: <T = any>(fns: (() => Promise<T>)[], results?: T[]) => Promise<T[]>;

package/dist/esm/utils/openApiToInterfaces.d.mts

@@ -1,14 +0,0 @@
-import { OpenAPIV3 } from "openapi-types";
-import { Interface } from "../types.mjs";
-/**
- * Convert an OpenAPI 3.x document into the internal `Interface[]` format.
- *
- * Reads OAS3 directly — no intermediate Swagger 2.0 `openapi3Format` step,
- * no YApi platform fields (`_id`/`project_id`/`catid`/`add_time`/`up_time`),
- * no module-level mutable state.
- *
- * @param data OpenAPI 3.x document (object or JSON string)
- */
-export declare function openApiToInterfaces(data: OpenAPIV3.Document | string): Promise<{
-    interfaces: Interface[];
-}>;

package/dist/esm/utils/spinner.d.mts

@@ -1,15 +0,0 @@
-import { Ora } from "ora";
-declare class Spin {
-    spinnerInstance: Ora;
-    constructor();
-    clear(): void;
-    start(text?: string): void;
-    succeed(text?: string): void;
-    fail(text?: string): void;
-    render(): void;
-    frame(): void;
-    info(text?: string): void;
-    stop(): void;
-}
-export declare const spinnerInstance: Spin;
-export {};

package/dist/esm/utils/vtilsLite.d.mts

@@ -1,55 +0,0 @@
-/**
- * Local replacements for the small subset of `vtils` helpers used by this
- * project. `vtils` pulls in several deprecated dependencies (cuid, uuid,
- * tough-cookie@0.12.1 with a ReDoS advisory) and is otherwise unmaintained,
- * so these minimal local implementations keep the dependency tree clean.
- *
- * Behavior matches the upstream vtils functions for the call sites in this
- * repository only; no attempt is made to be a drop-in replacement for the
- * full vtils API.
- */
-/**
- * Remove `undefined` from a type. Equivalent to vtils's `Defined<T>`.
- */
-export type Defined<T> = Exclude<T, undefined>;
-/**
- * Wrap a value in an array unless it is already an array.
- */
-export declare function castArray<T>(value: T | T[]): T[];
-/**
- * `Array.isArray` alias, kept for import symmetry with the other helpers.
- */
-export declare const isArray: (arg: any) => arg is any[];
-/**
- * Check whether a value is a plain object (not null, not an array, not a
- * function, not a primitive). Matches vtils `isObject` for the JSON-Schema
- * values used in this project.
- */
-export declare function isObject(value: any): value is Record<string, any>;
-/**
- * Check whether a value is "empty": null/undefined, empty string, empty
- * array, or an object with no own enumerable string-keyed properties.
- */
-export declare function isEmpty(value: any): boolean;
-/**
- * Iterate over the own enumerable string-keyed properties of an object,
- * invoking `callback(value, key)` for each.
- */
-export declare function forOwn<T extends object>(obj: T, callback: (value: T[keyof T], key: keyof T) => void): void;
-/**
- * Iterate over a collection (array or object), invoking `callback(value, key)`
- * for each item. For arrays `key` is the numeric index. Types are intentionally
- * loose (matching vtils) because call sites pass heterogeneous OpenAPI data.
- */
-export declare function each(collection: any, callback: (value: any, key: any) => void): void;
-/**
- * Return the first item in a collection for which `predicate` returns a
- * truthy value, or `undefined` if none matches.
- */
-export declare function find(collection: any, predicate: (value: any, key: any) => boolean): any;
-/**
- * Tagged-template helper that strips the common leading whitespace from every
- * line. Multi-line interpolations keep the indentation of the line they are
- * embedded on (mirrors vtils `dedent`, which first runs `indent`).
- */
-export declare function dedent(literals: TemplateStringsArray, ...interpolations: any[]): string;