@kubb/core 4.28.1 → 4.29.1

package/dist/utils.d.cts

@@ -1,287 +0,0 @@
-import { t as __name } from "./chunk-DlpkT3g-.cjs";
-import { A as AsyncEventEmitter, E as PossiblePromise, S as UserConfig, n as Config } from "./types-ulibr7zw.cjs";
-import { i as defineConfig, n as getBarrelFiles, r as CLIOptions } from "./getBarrelFiles-CmpI3rrq.cjs";
-
-//#region src/utils/buildJSDoc.d.ts
-
-/**
- * Builds a JSDoc comment block with custom indentation.
- * @param comments - Array of comment strings to include in the JSDoc block
- * @param options - Configuration options for formatting
- * @returns Formatted JSDoc string or fallback string if no comments
- */
-declare function buildJSDoc(comments: Array<string>, options?: {
-  /**
-   * String to use for indenting each line of the JSDoc comment
-   * @default '   * ' (3 spaces + asterisk + space)
-   */
-  indent?: string;
-  /**
-   * String to append after the closing JSDoc tag
-   * @default '\n  ' (newline + 2 spaces)
-   */
-  suffix?: string;
-  /**
-   * String to return when there are no comments
-   * @default '  ' (2 spaces)
-   */
-  fallback?: string;
-}): string;
-//#endregion
-//#region src/utils/Cache.d.ts
-declare class Cache<T> {
-  #private;
-  get(key: string): Promise<T | null>;
-  set(key: string, value: T): Promise<void>;
-  delete(key: string): Promise<void>;
-  clear(): Promise<void>;
-  keys(): Promise<string[]>;
-  values(): Promise<T[]>;
-  flush(): Promise<void>;
-}
-//#endregion
-//#region src/utils/checkOnlineStatus.d.ts
-/**
- * Check if the system has internet connectivity
- * Uses DNS lookup to well-known stable domains as a lightweight connectivity test
- */
-declare function isOnline(): Promise<boolean>;
-/**
- * Execute a function only if online, otherwise silently skip
- */
-declare function executeIfOnline<T>(fn: () => Promise<T>): Promise<T | null>;
-//#endregion
-//#region src/utils/FunctionParams.d.ts
-type FunctionParamsASTWithoutType = {
-  name?: string;
-  type?: string;
-  /**
-   * @default true
-   */
-  required?: boolean;
-  /**
-   * @default true
-   */
-  enabled?: boolean;
-  default?: string;
-};
-type FunctionParamsASTWithType = {
-  name?: never;
-  type: string;
-  /**
-   * @default true
-   */
-  required?: boolean;
-  /**
-   * @default true
-   */
-  enabled?: boolean;
-  default?: string;
-};
-/**
- * @deprecated
- */
-type FunctionParamsAST = FunctionParamsASTWithoutType | FunctionParamsASTWithType;
-/**
- * @deprecated
- */
-declare class FunctionParams {
-  #private;
-  constructor();
-  get items(): FunctionParamsAST[];
-  add(item: FunctionParamsAST | Array<FunctionParamsAST | FunctionParamsAST[] | undefined> | undefined): FunctionParams;
-  static toObject(items: FunctionParamsAST[]): FunctionParamsAST;
-  toObject(): FunctionParamsAST;
-  static toString(items: (FunctionParamsAST | FunctionParamsAST[])[]): string;
-  toString(): string;
-}
-//#endregion
-//#region src/utils/formatHrtime.d.ts
-/**
- * Calculates elapsed time in milliseconds from a high-resolution start time.
- * Rounds to 2 decimal places to provide sub-millisecond precision without noise.
- */
-declare function getElapsedMs(hrStart: [number, number]): number;
-/**
- * Converts a millisecond duration into a human-readable string.
- * Adjusts units (ms, s, m s) based on the magnitude of the duration.
- */
-declare function formatMs(ms: number): string;
-/**
- * Convenience helper to get and format elapsed time in one step.
- */
-declare function formatHrtime(hrStart: [number, number]): string;
-//#endregion
-//#region src/utils/formatters.d.ts
-declare const formatters: {
-  readonly prettier: {
-    readonly command: "prettier";
-    readonly args: (outputPath: string) => string[];
-    readonly errorMessage: "Prettier not found";
-  };
-  readonly biome: {
-    readonly command: "biome";
-    readonly args: (outputPath: string) => string[];
-    readonly errorMessage: "Biome not found";
-  };
-  readonly oxfmt: {
-    readonly command: "oxfmt";
-    readonly args: (outputPath: string) => string[];
-    readonly errorMessage: "Oxfmt not found";
-  };
-};
-type Formatter = keyof typeof formatters;
-/**
- * Detect which formatter is available in the system.
- *
- * @returns Promise that resolves to the first available formatter or undefined if none are found
- *
- * @remarks
- * Checks in order of preference: biome, oxfmt, prettier.
- * Uses the `--version` flag to detect if each formatter command is available.
- * This is a reliable method as all supported formatters implement this flag.
- *
- * @example
- * ```typescript
- * const formatter = await detectFormatter()
- * if (formatter) {
- *   console.log(`Using ${formatter} for formatting`)
- * } else {
- *   console.log('No formatter found')
- * }
- * ```
- */
-declare function detectFormatter(): Promise<Formatter | undefined>;
-//#endregion
-//#region src/utils/getConfigs.d.ts
-/**
- * Converting UserConfig to Config Array without a change in the object beside the JSON convert.
- */
-declare function getConfigs(config: ReturnType<typeof defineConfig> | UserConfig, args: CLIOptions): Promise<Array<Config>>;
-//#endregion
-//#region src/utils/getNestedAccessor.d.ts
-/**
- * Converts a param path (string with dot notation or array of strings) to a JavaScript accessor expression.
- * @param param - The param path, e.g., 'pagination.next.id' or ['pagination', 'next', 'id']
- * @param accessor - The base accessor, e.g., 'lastPage' or 'firstPage'
- * @returns A JavaScript accessor expression, e.g., "lastPage?.['pagination']?.['next']?.['id']", or undefined if param is empty
- *
- * @example
- * ```ts
- * getNestedAccessor('pagination.next.id', 'lastPage')
- * // returns: "lastPage?.['pagination']?.['next']?.['id']"
- *
- * getNestedAccessor(['pagination', 'next', 'id'], 'lastPage')
- * // returns: "lastPage?.['pagination']?.['next']?.['id']"
- *
- * getNestedAccessor('', 'lastPage')
- * // returns: undefined
- * ```
- */
-declare function getNestedAccessor(param: string | string[], accessor: string): string | undefined;
-//#endregion
-//#region src/utils/linters.d.ts
-declare const linters: {
-  readonly eslint: {
-    readonly command: "eslint";
-    readonly args: (outputPath: string) => string[];
-    readonly errorMessage: "Eslint not found";
-  };
-  readonly biome: {
-    readonly command: "biome";
-    readonly args: (outputPath: string) => string[];
-    readonly errorMessage: "Biome not found";
-  };
-  readonly oxlint: {
-    readonly command: "oxlint";
-    readonly args: (outputPath: string) => string[];
-    readonly errorMessage: "Oxlint not found";
-  };
-};
-type Linter = keyof typeof linters;
-declare function detectLinter(): Promise<Linter | undefined>;
-//#endregion
-//#region src/utils/promise.d.ts
-declare function isPromise<T>(result: PossiblePromise<T>): result is Promise<T>;
-declare function isPromiseFulfilledResult<T = unknown>(result: PromiseSettledResult<unknown>): result is PromiseFulfilledResult<T>;
-declare function isPromiseRejectedResult<T>(result: PromiseSettledResult<unknown>): result is Omit<PromiseRejectedResult, 'reason'> & {
-  reason: T;
-};
-//#endregion
-//#region src/utils/renderTemplate.d.ts
-declare function renderTemplate<TData extends Record<string, unknown> = Record<string, unknown>>(template: string, data?: TData | undefined): string;
-//#endregion
-//#region src/utils/serializePluginOptions.d.ts
-/**
- * Serialize plugin options for safe JSON transport.
- * Strips functions, symbols, and undefined values recursively.
- */
-declare function serializePluginOptions(options: unknown): unknown;
-//#endregion
-//#region src/utils/timeout.d.ts
-declare function timeout(ms: number): Promise<unknown>;
-//#endregion
-//#region src/utils/URLPath.d.ts
-type URLObject = {
-  url: string;
-  params?: Record<string, string>;
-};
-type ObjectOptions = {
-  type?: 'path' | 'template';
-  replacer?: (pathParam: string) => string;
-  stringify?: boolean;
-};
-type Options = {
-  casing?: 'camelcase';
-};
-declare class URLPath {
-  #private;
-  path: string;
-  constructor(path: string, options?: Options);
-  /**
-   * Convert Swagger path to URLPath(syntax of Express)
-   * @example /pet/{petId} => /pet/:petId
-   */
-  get URL(): string;
-  get isURL(): boolean;
-  /**
-   * Convert Swagger path to template literals/ template strings(camelcase)
-   * @example /pet/{petId} => `/pet/${petId}`
-   * @example /account/monetary-accountID => `/account/${monetaryAccountId}`
-   * @example /account/userID => `/account/${userId}`
-   */
-  get template(): string;
-  get object(): URLObject | string;
-  get params(): Record<string, string> | undefined;
-  toObject({
-    type,
-    replacer,
-    stringify
-  }?: ObjectOptions): URLObject | string;
-  /**
-   * Convert Swagger path to template literals/ template strings(camelcase)
-   * @example /pet/{petId} => `/pet/${petId}`
-   * @example /account/monetary-accountID => `/account/${monetaryAccountId}`
-   * @example /account/userID => `/account/${userId}`
-   */
-  toTemplateString({
-    prefix,
-    replacer
-  }?: {
-    prefix?: string;
-    replacer?: (pathParam: string) => string;
-  }): string;
-  getParams(replacer?: (pathParam: string) => string): Record<string, string> | undefined;
-  /**
-   * Convert Swagger path to URLPath(syntax of Express)
-   * @example /pet/{petId} => /pet/:petId
-   */
-  toURLPath(): string;
-}
-//#endregion
-//#region src/utils/uniqueName.d.ts
-declare function getUniqueName(originalName: string, data: Record<string, number>): string;
-declare function setUniqueName(originalName: string, data: Record<string, number>): string;
-//#endregion
-export { AsyncEventEmitter, Cache, FunctionParams, type FunctionParamsAST, type URLObject, URLPath, buildJSDoc, detectFormatter, detectLinter, executeIfOnline, formatHrtime, formatMs, formatters, getBarrelFiles, getConfigs, getElapsedMs, getNestedAccessor, getUniqueName, isOnline, isPromise, isPromiseFulfilledResult, isPromiseRejectedResult, linters, renderTemplate, serializePluginOptions, setUniqueName, timeout };
-//# sourceMappingURL=utils.d.cts.map