@hey-api/shared 0.2.2 → 0.2.4

package/dist/index.d.mts

@@ -1,5 +1,4 @@
 import { PathLike } from "node:fs";
-import ts from "typescript";
 import * as semver from "semver";
 import { RangeOptions, SemVer } from "semver";
 import { getResolvedInput } from "@hey-api/json-schema-ref-parser";
@@ -7,6 +6,10 @@ import { IProject, Logger, NameConflictResolver, Node, Project, Ref, RenderConte
 import { AnyString, MaybeArray, MaybeFunc, MaybePromise } from "@hey-api/types";
 
 //#region src/cli.d.ts
+/**
+ * Checks the current environment based on the HEYAPI_CODEGEN_ENV environment variable.
+ */
+declare function isEnvironment(value: 'development'): boolean;
 declare function printCliIntro(initialDir: string, showLogo?: boolean): void;
 //#endregion
 //#region src/config/engine.d.ts
@@ -2938,7 +2941,7 @@ interface IRSchemaObject extends Pick<JsonSchemaDraft2020_12, '$ref' | 'const' |
   type?: 'array' | 'boolean' | 'enum' | 'integer' | 'never' | 'null' | 'number' | 'object' | 'string' | 'tuple' | 'undefined' | 'unknown' | 'void';
 }
 type IRSecurityObject = SecuritySchemeObject$2;
-type IRServerObject = ServerObject$1;
+interface IRServerObject extends ServerObject$1 {}
 type IRWebhookObject = IRPathItemObject;
 interface IRModel {
   components?: IRComponentsObject;
@@ -2993,10 +2996,10 @@ interface SchemaProcessorContext {
   schema: IR.SchemaObject;
   tags?: ReadonlyArray<string>;
 }
-interface SchemaProcessorResult<Context$1 extends SchemaProcessorContext = SchemaProcessorContext> {
-  process: (ctx: Context$1) => void;
+interface SchemaProcessorResult<Context extends SchemaProcessorContext = SchemaProcessorContext> {
+  process: (ctx: Context) => void;
 }
-type SchemaExtractor<Context$1 extends SchemaProcessorContext = SchemaProcessorContext> = (ctx: Context$1) => IR.SchemaObject;
+type SchemaExtractor<Context extends SchemaProcessorContext = SchemaProcessorContext> = (ctx: Context) => IR.SchemaObject;
 declare function createSchemaProcessor(): SchemaProcessor;
 //#endregion
 //#region src/openApi/shared/utils/graph.d.ts
@@ -3074,17 +3077,11 @@ type Graph = {
  * @property tags - The set of tags for this node, if any. Optional.
  */
 type NodeInfo = {
-  /** Whether the node is deprecated. Optional. */
-  deprecated?: boolean;
-  /** The property name or array index in the parent, or null for root. */
-  key: string | number | null;
-  /** The actual object at this pointer in the spec.  */
-  node: unknown;
-  /** The JSON Pointer of the parent node, or null for root. */
-  parentPointer: string | null;
-  /** The set of access scopes for this node, if any. Optional. */
-  scopes?: Set<Scope>;
-  /** The set of tags for this node, if any. Optional. */
+  /** Whether the node is deprecated. Optional. */deprecated?: boolean; /** The property name or array index in the parent, or null for root. */
+  key: string | number | null; /** The actual object at this pointer in the spec.  */
+  node: unknown; /** The JSON Pointer of the parent node, or null for root. */
+  parentPointer: string | null; /** The set of access scopes for this node, if any. Optional. */
+  scopes?: Set<Scope>; /** The set of tags for this node, if any. Optional. */
   tags?: Set<string>;
 };
 //#endregion
@@ -3258,18 +3255,15 @@ type WalkEvents = BaseEvent & ({
   path: string;
   type: Extract<IrTopLevelKind, 'operation'>;
 } | {
-  /** Name of the parameter (e.g., "id" for a parameter defined as "#/components/parameters/id"). */
-  name: string;
+  /** Name of the parameter (e.g., "id" for a parameter defined as "#/components/parameters/id"). */name: string;
   parameter: IR.ParameterObject;
   type: Extract<IrTopLevelKind, 'parameter'>;
 } | {
-  /** Name of the request body (e.g., "CreateUserRequest" for a request body defined as "#/components/requestBodies/CreateUserRequest"). */
-  name: string;
+  /** Name of the request body (e.g., "CreateUserRequest" for a request body defined as "#/components/requestBodies/CreateUserRequest"). */name: string;
   requestBody: IR.RequestBodyObject;
   type: Extract<IrTopLevelKind, 'requestBody'>;
 } | {
-  /** Name of the schema (e.g., "User" for a schema defined as "#/components/schemas/User"). */
-  name: string;
+  /** Name of the schema (e.g., "User" for a schema defined as "#/components/schemas/User"). */name: string;
   schema: IR.SchemaObject;
   type: Extract<IrTopLevelKind, 'schema'>;
 } | {
@@ -3382,7 +3376,7 @@ declare class PluginInstance<T extends Plugin.Types = Plugin.Types> {
   querySymbol(filter: SymbolMeta): Symbol<ResolvedNode> | undefined;
   referenceSymbol(meta: SymbolMeta): Symbol<ResolvedNode>;
   /**
-   * @deprecated use `plugin.symbol()` instead
+   * Alias for `symbol()` method with single argument.
    */
   registerSymbol(symbol: SymbolIn): Symbol<ResolvedNode>;
   /**
@@ -3402,6 +3396,43 @@ declare class PluginInstance<T extends Plugin.Types = Plugin.Types> {
   private isOperationKind;
 }
 //#endregion
+//#region src/utils/naming/types.d.ts
+/**
+ * Available casing strategies.
+ */
+type Casing = 'camelCase' | 'PascalCase' | 'preserve' | 'snake_case' | 'SCREAMING_SNAKE_CASE';
+/**
+ * Name transformer: template string or function.
+ *
+ * Template supports `{{name}}` variable.
+ */
+type NameTransformer = MaybeFunc<(name: string) => string>;
+/**
+ * Full naming configuration.
+ */
+interface NamingConfig {
+  /**
+   * Casing strategy applied after transformation.
+   *
+   * @deprecated Use `casing` instead.
+   */
+  case?: Casing;
+  /**
+   * Casing strategy applied after transformation.
+   */
+  casing?: Casing;
+  /**
+   * Name template or transformer function.
+   *
+   * Applied before `casing` transformation.
+   */
+  name?: NameTransformer;
+}
+/**
+ * Name customization: shorthand or full configuration.
+ */
+type NamingRule = NameTransformer | NamingConfig;
+//#endregion
 //#region src/parser/hooks.d.ts
 type Hooks = {
   /**
@@ -3417,9 +3448,7 @@ type Hooks = {
      * @returns void
      */
     'node:set:after'?: (args: {
-      /** The node added or updated. */
-      node: Node | null;
-      /** Plugin that added or updated the node. */
+      /** The node added or updated. */node: Node | null; /** Plugin that added or updated the node. */
       plugin: PluginInstance;
     }) => void;
     /**
@@ -3431,9 +3460,7 @@ type Hooks = {
      * @returns void
      */
     'node:set:before'?: (args: {
-      /** The node to be added or updated. */
-      node: Node | null;
-      /** Plugin adding or updating the node. */
+      /** The node to be added or updated. */node: Node | null; /** Plugin adding or updating the node. */
       plugin: PluginInstance;
     }) => void;
     /**
@@ -3443,8 +3470,7 @@ type Hooks = {
      * @returns void
      */
     'plugin:handler:after'?: (args: {
-      /** Plugin that just executed. */
-      plugin: PluginInstance;
+      /** Plugin that just executed. */plugin: PluginInstance;
     }) => void;
     /**
      * Triggered before executing a plugin handler.
@@ -3453,8 +3479,7 @@ type Hooks = {
      * @returns void
      */
     'plugin:handler:before'?: (args: {
-      /** Plugin about to execute. */
-      plugin: PluginInstance;
+      /** Plugin about to execute. */plugin: PluginInstance;
     }) => void;
     /**
      * Triggered after registering a symbol.
@@ -3465,9 +3490,7 @@ type Hooks = {
      * @returns void
      */
     'symbol:register:after'?: (args: {
-      /** Plugin that registered the symbol. */
-      plugin: PluginInstance;
-      /** The registered symbol. */
+      /** Plugin that registered the symbol. */plugin: PluginInstance; /** The registered symbol. */
       symbol: Symbol;
     }) => void;
     /**
@@ -3479,9 +3502,7 @@ type Hooks = {
      * @returns void
      */
     'symbol:register:before'?: (args: {
-      /** Plugin registering the symbol. */
-      plugin: PluginInstance;
-      /** Symbol to register. */
+      /** Plugin registering the symbol. */plugin: PluginInstance; /** Symbol to register. */
       symbol: SymbolIn;
     }) => void;
   };
@@ -3609,8 +3630,28 @@ type Hooks = {
      * @returns The file path to output the symbol to, or undefined to fallback to default behavior.
      */
     getFilePath?: (symbol: Symbol) => string | undefined;
+    /**
+     * Optional output strategy to override default plugin behavior.
+     *
+     * Use this to customize symbol names.
+     *
+     * @returns The name to register the symbol with, or undefined to fallback to default behavior.
+     */
+    getName?: (ctx: GetNameContext) => MaybeFunc<(ctx: GetNameContext) => string | undefined>;
   };
 };
+interface GetNameContext {
+  /** Arbitrary metadata about the symbol. */
+  meta: SymbolMeta;
+  /** The proposed name for the symbol. */
+  name: string;
+  /** The naming configuration for the symbol. */
+  naming?: NamingConfig;
+  /** The operation object associated with the symbol. */
+  operation?: IROperationObject;
+  /** The schema object associated with the symbol. */
+  schema?: IRSchemaObject;
+}
 //#endregion
 //#region src/plugins/types.d.ts
 interface PluginConfigMap {}
@@ -3705,51 +3746,15 @@ type DefinePlugin<Config extends PluginBaseConfig = PluginBaseConfig, ResolvedCo
   Config: Plugin.Config<Plugin.Types<Config, ResolvedConfig, Api>>;
   Handler: (args: {
     plugin: PluginInstance<Plugin.Types<Config, ResolvedConfig, Api>>;
-  }) => void;
-  /** The plugin instance. */
+  }) => void; /** The plugin instance. */
   Instance: PluginInstance<Plugin.Types<Config, ResolvedConfig, Api>>;
   Types: Plugin.Types<Config, ResolvedConfig, Api>;
 };
 //#endregion
-//#region src/utils/naming/types.d.ts
-/**
- * Available casing strategies.
- */
-type Casing = 'camelCase' | 'PascalCase' | 'preserve' | 'snake_case' | 'SCREAMING_SNAKE_CASE';
-/**
- * Name transformer: template string or function.
- *
- * Template supports `{{name}}` variable.
- */
-type NameTransformer = MaybeFunc<(name: string) => string>;
-/**
- * Full naming configuration.
- */
-interface NamingConfig {
-  /**
-   * Casing strategy applied after transformation.
-   *
-   * @deprecated Use `casing` instead.
-   */
-  case?: Casing;
-  /**
-   * Casing strategy applied after transformation.
-   */
-  casing?: Casing;
-  /**
-   * Name template or transformer function.
-   *
-   * Applied before `casing` transformation.
-   */
-  name?: NameTransformer;
-}
-/**
- * Name customization: shorthand or full configuration.
- */
-type NamingRule = NameTransformer | NamingConfig;
-//#endregion
 //#region src/config/output/types.d.ts
-type OutputHeader = MaybeFunc<(ctx: Omit<RenderContext, 'file'> & Pick<Partial<RenderContext>, 'file'>) => MaybeArray<string> | null | undefined>;
+type OutputHeader = MaybeFunc<(ctx: Pick<RenderContext, 'meta' | 'project'> & Pick<Partial<RenderContext>, 'file'> & {
+  /** The default header value. */defaultValue: ReadonlyArray<string>;
+}) => MaybeArray<string> | null | undefined>;
 //#endregion
 //#region src/config/parser/filters.d.ts
 type Filters = {
@@ -8052,8 +8057,7 @@ interface SchemaVisitor<TResult, TPlugin = unknown> {
    * Apply modifiers to a result.
    */
   applyModifiers(result: TResult, ctx: SchemaVisitorContext<TPlugin>, context?: {
-    /** Is this property optional? */
-    optional?: boolean;
+    /** Is this property optional? */optional?: boolean;
   }): unknown;
   array(schema: SchemaWithType<'array'>, ctx: SchemaVisitorContext<TPlugin>, walk: Walker<TResult, TPlugin>): TResult;
   boolean(schema: SchemaWithType<'boolean'>, ctx: SchemaVisitorContext<TPlugin>): TResult;
@@ -8312,6 +8316,24 @@ declare const mappers: {
   };
 };
 //#endregion
+//#region src/plugins/symbol.d.ts
+/**
+ * Helper function to build the input for symbol registration, applying naming hooks if provided.
+ */
+declare function buildSymbolIn({
+  plugin,
+  ...ctx
+}: GetNameContext & {
+  plugin: {
+    config: Pick<PluginInstance['config'], '~hooks'>;
+    context: {
+      config: {
+        parser: Pick<PluginInstance['context']['config']['parser'], 'hooks'>;
+      };
+    };
+  };
+}): SymbolIn;
+//#endregion
 //#region src/tsConfig.d.ts
 declare function findPackageJson(initialDir: string): unknown | undefined;
 type PackageJson = {
@@ -8323,7 +8345,6 @@ type PackageJson = {
 };
 declare function loadPackageJson(initialDir: string): PackageJson | undefined;
 declare function findTsConfigPath(baseDir: string, tsConfigPath?: AnyString | null): string | null;
-declare function loadTsConfig(configPath: string | null): ts.ParsedCommandLine | null;
 //#endregion
 //#region src/utils/escape.d.ts
 declare function escapeComment(value: string): string;
@@ -8386,7 +8407,11 @@ declare const utils: {
 /**
  * Converts an {@link OutputHeader} value to a string prefix for file content.
  */
-declare function outputHeaderToPrefix(header: OutputHeader, project: IProject): string;
+declare function outputHeaderToPrefix(ctx: {
+  defaultValue: ReadonlyArray<string>;
+  header: OutputHeader;
+  project: IProject;
+}): string;
 //#endregion
 //#region src/utils/input/index.d.ts
 declare function inputToApiRegistry(input: Input & {
@@ -8514,5 +8539,5 @@ interface Url {
 }
 declare function parseUrl(value: string): Url;
 //#endregion
-export { type AnyConfig, type AnyPluginName, type BaseConfig, type BaseOutput, type BaseUserConfig, type BaseUserOutput, type Casing, type CodeSampleObject, type CommentsOption, ConfigError, ConfigValidationError, Context, type DefinePlugin, type Dependency, type EnumExtensions, type FeatureToggle, type Filters, HeyApiError, type Hooks, type IR, type IndexExportOption, type Input, IntentContext, JobError, type LinguistLanguages, type Logs, MinHeap, type NameTransformer, type NamingConfig, type NamingOptions, type NamingRule, type OpenApi, type OpenApiMetaObject, type OpenApiOperationObject, type OpenApiParameterObject, type OpenApiRequestBodyObject, type OpenApiResponseObject, type OpenApiSchemaObject, type OpenApiV2_0_X, type OpenApiV2_0_XTypes, type OpenApiV3_0_X, type OpenApiV3_0_XTypes, type OpenApiV3_1_X, type OpenApiV3_1_XTypes, OperationPath, type OperationPathStrategy, OperationStrategy, type OperationStructureStrategy, type OperationsStrategy, type OutputHeader, type Parser, type Patch, type Plugin, type PluginConfigMap, type PluginContext, PluginInstance, type PluginInstanceTypes, type PluginNames, type PostProcessor, type SchemaExtractor, type SchemaProcessor, type SchemaProcessorContext, type SchemaProcessorResult, type SchemaVisitor, type SchemaVisitorContext, type SchemaWithType, type SourceConfig, type UserCommentsOption, type UserIndexExportOption, type UserInput, type UserParser, type UserPostProcessor, type UserSourceConfig, type UserWatch, type ValueToObject, type Walker, type Watch, type WatchValues, addItemsToSchema, applyNaming, buildGraph, checkNodeVersion, childContext, compileInputPath, createOperationKey, createSchemaProcessor, createSchemaWalker, debugTools, deduplicateSchema, defaultPaginationKeywords, definePluginConfig, dependencyFactory, encodeJsonPointerSegment, ensureDirSync, escapeComment, findPackageJson, findTsConfigPath, getInput, getLogs, getParser, getSpec, hasOperationDataRequired, hasParameterGroupObjectRequired, hasParametersObjectRequired, heyApiRegistryBaseUrl, inputToApiRegistry, isTopLevelComponent, jsonPointerToPath, loadPackageJson, loadTsConfig, logCrashReport, logInputPaths, mappers, normalizeJsonPointer, openGitHubIssueWithCrashReport, operationPagination, operationResponsesMap, outputHeaderToPrefix, parameterWithPagination, parseOpenApiSpec, parseUrl, parseV2_0_X, parseV3_0_X, parseV3_1_X, patchOpenApiSpec, pathToJsonPointer, pathToName, postprocessOutput, printCliIntro, printCrashReport, refToName, resolveNaming, resolveRef, resolveSource, satisfies, shouldReportCrash, statusCodeToGroup, toCase, utils, valueToObject };
+export { type AnyConfig, type AnyPluginName, type BaseConfig, type BaseOutput, type BaseUserConfig, type BaseUserOutput, type Casing, type CodeSampleObject, type CommentsOption, ConfigError, ConfigValidationError, Context, type DefinePlugin, type Dependency, type EnumExtensions, type FeatureToggle, type Filters, type GetNameContext, HeyApiError, type Hooks, type IR, type IRModel, type IROperationObject, type IRParameterObject, type IRParametersObject, type IRSchemaObject, type IRServerObject, type IndexExportOption, type Input, IntentContext, JobError, type LinguistLanguages, type Logs, MinHeap, type NameTransformer, type NamingConfig, type NamingOptions, type NamingRule, type OpenApi, type OpenApiMetaObject, type OpenApiOperationObject, type OpenApiParameterObject, type OpenApiRequestBodyObject, type OpenApiResponseObject, type OpenApiSchemaObject, type OpenApiV2_0_X, type OpenApiV2_0_XTypes, type OpenApiV3_0_X, type OpenApiV3_0_XTypes, type OpenApiV3_1_X, type OpenApiV3_1_XTypes, OperationPath, type OperationPathStrategy, OperationStrategy, type OperationStructureStrategy, type OperationsStrategy, type OutputHeader, type Parser, type Patch, type Plugin, type PluginConfigMap, type PluginContext, PluginInstance, type PluginInstanceTypes, type PluginNames, type PostProcessor, type SchemaExtractor, type SchemaProcessor, type SchemaProcessorContext, type SchemaProcessorResult, type SchemaVisitor, type SchemaVisitorContext, type SchemaWithType, type SourceConfig, type UserCommentsOption, type UserIndexExportOption, type UserInput, type UserParser, type UserPostProcessor, type UserSourceConfig, type UserWatch, type ValueToObject, type Walker, type Watch, type WatchValues, addItemsToSchema, applyNaming, buildGraph, buildSymbolIn, checkNodeVersion, childContext, compileInputPath, createOperationKey, createSchemaProcessor, createSchemaWalker, debugTools, deduplicateSchema, defaultPaginationKeywords, definePluginConfig, dependencyFactory, encodeJsonPointerSegment, ensureDirSync, escapeComment, findPackageJson, findTsConfigPath, getInput, getLogs, getParser, getSpec, hasOperationDataRequired, hasParameterGroupObjectRequired, hasParametersObjectRequired, heyApiRegistryBaseUrl, inputToApiRegistry, isEnvironment, isTopLevelComponent, jsonPointerToPath, loadPackageJson, logCrashReport, logInputPaths, mappers, normalizeJsonPointer, openGitHubIssueWithCrashReport, operationPagination, operationResponsesMap, outputHeaderToPrefix, parameterWithPagination, parseOpenApiSpec, parseUrl, parseV2_0_X, parseV3_0_X, parseV3_1_X, patchOpenApiSpec, pathToJsonPointer, pathToName, postprocessOutput, printCliIntro, printCrashReport, refToName, resolveNaming, resolveRef, resolveSource, satisfies, shouldReportCrash, statusCodeToGroup, toCase, utils, valueToObject };
 //# sourceMappingURL=index.d.mts.map