@aws/nx-plugin 1.0.0-rc.30 → 1.0.0-rc.32

package/src/open-api/utils/codegen-data/types.d.ts

@@ -2,11 +2,239 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { Plugin } from '@hey-api/openapi-ts';
 import type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
-export type ClientData = Parameters<Plugin.LegacyHandler<any>>[0]['client'];
-export type Operation = ClientData['services'][number]['operations'][number];
-export type Model = ClientData['models'][number];
+/**
+ * The kind of a {@link Model}, describing how it should be rendered.
+ *
+ * - `interface` — an object type with named properties
+ * - `enum` — a set of string/number literal values
+ * - `array` — a list whose element type is described by `link`
+ * - `dictionary` — a map whose value type is described by `link`
+ * - `reference` — a reference to another named model (`type` is its name)
+ * - `generic` — a primitive (string/number/boolean/null/void/binary/any)
+ * - `one-of` / `any-of` / `all-of` — a composite of other schemas
+ */
+export type ModelExport = 'interface' | 'enum' | 'array' | 'dictionary' | 'reference' | 'generic' | 'one-of' | 'any-of' | 'all-of';
+/**
+ * Where a parameter-like {@link Model} appears in a request/response.
+ * Empty string is used for models that are not parameters (schemas/properties).
+ */
+export type ModelIn = '' | 'query' | 'path' | 'header' | 'cookie' | 'body' | 'response';
+/**
+ * How array/object query & header parameters are serialised on the wire.
+ * `deepObject` explodes an object into `key[prop]=value` query pairs.
+ */
+export type CollectionFormat = 'multi' | 'csv' | 'ssv' | 'pipes' | 'deepObject';
+/** A single enum member value. */
+export interface EnumMember {
+    value: string | number | boolean;
+}
+/**
+ * A discriminated-composite mapping entry: a discriminator value and the name
+ * of the composed model it selects.
+ */
+export interface DiscriminatorMapping {
+    /** The discriminator property value (e.g. `"cat"`). */
+    value: string;
+    /** The name of the composed model this value selects (e.g. `"Cat"`). */
+    modelName: string;
+}
+/**
+ * The discriminator of a composite (`oneOf`/`anyOf`) or an inheritance base
+ * (an `object` schema whose subtypes `allOf`-compose it), used to marshal
+ * directly to the matching branch/subtype rather than merging every branch or
+ * dropping subtype-only fields.
+ */
+export interface Discriminator {
+    /** The wire property name carrying the discriminator value. */
+    propertyName: string;
+    /** The TypeScript property name (resolved during augmentation). */
+    typescriptPropertyName?: string;
+    /** The value → composed-model mapping. */
+    mapping: DiscriminatorMapping[];
+    /**
+     * True when this discriminator sits on an inheritance base (an `object`
+     * schema selected by `allOf`-composing subtypes) rather than a `oneOf`/
+     * `anyOf` composite. The base marshals via dispatch to its subtypes, but its
+     * subtypes compose the base's own (non-dispatching) body — so the base emits
+     * a separate non-dispatching marshaller to break the recursion.
+     */
+    isBase?: boolean;
+}
+/** A pattern-property entry: a regex pattern and the model for its values. */
+export interface PatternPropertyModel {
+    pattern: string;
+    model: Model;
+}
+/**
+ * A model represents an OpenAPI schema, or something derived from one (a
+ * property, parameter, or response). It is produced by the parser
+ * (`../parser.ts`) and progressively augmented by `../codegen-data.ts` with
+ * language-specific and code-generation fields before being handed to the
+ * templates. Augmentation fields are optional as they are absent on raw parser
+ * output.
+ */
+export interface Model {
+    /** The schema, property, or parameter name. */
+    name: string;
+    /** How this model should be rendered. */
+    export: ModelExport;
+    /**
+     * The model's type: a primitive name (`string`, `number`, `boolean`, `null`,
+     * `void`, `binary`, `any`), `unknown`, or the name of a referenced model.
+     */
+    type: string;
+    /** The OpenAPI `format` (e.g. `int32`, `date-time`, `binary`), if any. */
+    format?: string;
+    /** Description, used to render doc comments. */
+    description: string | null;
+    /** Whether the schema is marked deprecated. */
+    deprecated: boolean;
+    /** Whether the value may be null. */
+    isNullable: boolean;
+    /** Whether the property is read-only. */
+    isReadOnly: boolean;
+    /** Whether the property/parameter is required. */
+    isRequired: boolean;
+    /** Whether an array enforces uniqueness (rendered as a `Set`). */
+    uniqueItems?: boolean;
+    /** For arrays/dictionaries, the model describing the element/value type. */
+    link?: Model | null;
+    /** Child properties (for interfaces) or members (for composites). */
+    properties: Model[];
+    /** Enum members, when `export === 'enum'`. */
+    enum: EnumMember[];
+    /** Names of other models this model references (for import generation). */
+    imports: string[];
+    /** Where a parameter appears; `''` for non-parameter models. */
+    in: ModelIn;
+    /** The source property name for a parameter (body parameters use `body`). */
+    prop?: string;
+    /** The chosen request/response media type, for body params and responses. */
+    mediaType?: string | null;
+    /** All acceptable media types (request body / response). */
+    mediaTypes?: string[];
+    /** The response status code, for response models. */
+    code?: number | string;
+    /**
+     * For a discriminated subtype's discriminator property: the rendered literal
+     * TypeScript type (e.g. `'cat'`, or `'cat' | 'kitten'` when several values
+     * map to one subtype) that makes the union a true tagged union. Absent when
+     * the subtype's tag can't be pinned to a literal (e.g. it appears in
+     * multiple unions with different values).
+     */
+    discriminatorValue?: string;
+    /** The raw OpenAPI `type` (used to distinguish integer from number). */
+    openapiType?: string | string[];
+    /** Vendor extensions (`x-*`) copied from the schema. */
+    vendorExtensions?: VendorExtensions;
+    /** True when the schema has additionalProperties. */
+    hasAdditionalProperties?: boolean;
+    /** The model describing additionalProperties values. */
+    additionalPropertiesModel?: Model;
+    /** True when the schema has patternProperties. */
+    hasPatternProperties?: boolean;
+    /** The models describing each pattern's values. */
+    patternPropertiesModels?: PatternPropertyModel[];
+    /** For composites: the referenced (object) models composed together. */
+    composedModels?: Model[];
+    /** For composites: the primitive/enum/array members composed together. */
+    composedPrimitives?: Model[];
+    /** For discriminated one-of/any-of composites: the discriminator metadata. */
+    discriminator?: Discriminator;
+    /** The TypeScript identifier for this model/property. */
+    typescriptName?: string;
+    /** The rendered TypeScript type. */
+    typescriptType?: string;
+    /** The Python identifier for this model/property. */
+    pythonName?: string;
+    /** The rendered Python type. */
+    pythonType?: string;
+    /** snake_case model name (Python). */
+    nameSnakeCase?: string;
+    /** True when the model is a renderable primitive (not composite/collection). */
+    isPrimitive?: boolean;
+    /** True when the schema declares an enum. */
+    isEnum?: boolean;
+    /** True for JSON-lines streaming responses. */
+    isJsonlStreaming?: boolean;
+    /** The model describing each streamed item. */
+    itemSchemaModel?: Model;
+    /** Collection serialisation format for array query/header parameters. */
+    collectionFormat?: CollectionFormat;
+}
+/** Vendor extension bag (`x-*` keys copied from a schema/operation/spec). */
+export type VendorExtensions = {
+    [key: string]: unknown;
+};
+/**
+ * An operation represents a single OpenAPI path + method. Produced by the
+ * parser and augmented by `../codegen-data.ts`.
+ */
+export interface Operation {
+    id: string;
+    name: string;
+    method: string;
+    path: string;
+    description: string | null;
+    tags?: string[] | null;
+    deprecated: boolean;
+    imports: string[];
+    parameters: Model[];
+    /** The request body parameter (same object reference as in `parameters`). */
+    parametersBody?: Model | null;
+    responses: Model[];
+    /** Deduplicated operation name used throughout generated code. */
+    uniqueName?: string;
+    /** Dot-notation name (tag-qualified), used for metadata keys. */
+    dotNotationName?: string;
+    operationIdPascalCase?: string;
+    operationIdSnakeCase?: string;
+    /** The generated request type name (e.g. `FooRequest`). */
+    requestTypeName?: string;
+    /** The response model used as the operation's result. */
+    result?: Model;
+    /** The explicit body parameter when the body is not inlined. */
+    explicitRequestBodyParameter?: Model;
+    vendorExtensions?: VendorExtensions;
+    isMutation?: boolean;
+    isQuery?: boolean;
+    isStreaming?: boolean;
+    isInfiniteQuery?: boolean;
+    /** The cursor parameter, for infinite queries. */
+    infiniteQueryCursorProperty?: Model;
+}
+/**
+ * A service groups operations. Currently the parser produces a single
+ * `Default` service; operations are re-grouped by tag downstream.
+ */
+export interface Service {
+    name: string;
+    operations: Operation[];
+    imports: string[];
+    /** All model names the service (API client) needs to import. */
+    modelImports?: string[];
+    className?: string;
+    nameSnakeCase?: string;
+}
+/**
+ * The initial data structure produced by the OpenAPI parser.
+ */
+export interface ClientData {
+    models: Model[];
+    services: Service[];
+}
+/** Models indexed by name, for reference resolution during augmentation. */
+export type ModelsByName = {
+    [name: string]: Model;
+};
+/** Index a list of models by name. */
+export declare const indexModelsByName: (models: Model[]) => ModelsByName;
+/** The single service the parser emits; operations are re-grouped by tag. */
+export declare const DEFAULT_SERVICE_NAME = "Default";
+/**
+ * The full data structure handed to the code generation templates.
+ */
 export interface CodeGenData extends ClientData {
     className: string;
     info: OpenAPIV3.InfoObject | OpenAPIV3_1.InfoObject;
@@ -15,13 +243,15 @@ export interface CodeGenData extends ClientData {
         [tag: string]: Operation[];
     };
     untaggedOperations: Operation[];
-    vendorExtensions: {
-        [key: string]: any;
-    };
+    vendorExtensions: VendorExtensions;
 }
-export declare const flattenModelLink: (link?: Model | Model[]) => Model;
-export declare const COMPOSED_SCHEMA_TYPES: Set<string>;
-export declare const COLLECTION_TYPES: Set<string>;
+/**
+ * Create a {@link Model} with the default fields the parser always emits.
+ * Callers override the fields relevant to their specific schema.
+ */
+export declare const createModel: (overrides?: Partial<Model>) => Model;
+export declare const COMPOSED_SCHEMA_TYPES: Set<ModelExport>;
+export declare const COLLECTION_TYPES: Set<ModelExport>;
 export declare const PRIMITIVE_TYPES: Set<string>;
 /**
  * Content types that indicate JSON Lines streaming (OpenAPI 3.2)

package/src/open-api/utils/codegen-data/types.js

@@ -1,7 +1,30 @@
 /**
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
- */ export const flattenModelLink = (link)=>link === undefined ? undefined : Array.isArray(link) ? link[0] : link;
+ */ /** Index a list of models by name. */ export const indexModelsByName = (models)=>Object.fromEntries(models.map((m)=>[
+            m.name,
+            m
+        ]));
+/** The single service the parser emits; operations are re-grouped by tag. */ export const DEFAULT_SERVICE_NAME = 'Default';
+/**
+ * Create a {@link Model} with the default fields the parser always emits.
+ * Callers override the fields relevant to their specific schema.
+ */ export const createModel = (overrides = {})=>({
+        name: '',
+        export: 'interface',
+        type: 'unknown',
+        description: null,
+        deprecated: false,
+        isNullable: false,
+        isReadOnly: false,
+        isRequired: false,
+        link: null,
+        properties: [],
+        enum: [],
+        imports: [],
+        in: '',
+        ...overrides
+    });
 // Model types which indicate it is composed (ie inherits/mixin's another schema)
 export const COMPOSED_SCHEMA_TYPES = new Set([
     'one-of',

package/src/open-api/utils/codegen-data/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../../packages/nx-plugin/src/open-api/utils/codegen-data/types.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport type { Plugin } from '@hey-api/openapi-ts';\nimport type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';\n\nexport type ClientData = Parameters<Plugin.LegacyHandler<any>>[0]['client'];\nexport type Operation = ClientData['services'][number]['operations'][number];\nexport type Model = ClientData['models'][number];\n\nexport interface CodeGenData extends ClientData {\n  className: string;\n  info: OpenAPIV3.InfoObject | OpenAPIV3_1.InfoObject;\n  allOperations: Operation[];\n  operationsByTag: { [tag: string]: Operation[] };\n  untaggedOperations: Operation[];\n  vendorExtensions: { [key: string]: any };\n}\n\nexport const flattenModelLink = (link?: Model | Model[]): Model =>\n  link === undefined ? undefined : Array.isArray(link) ? link[0] : link;\n\n// Model types which indicate it is composed (ie inherits/mixin's another schema)\nexport const COMPOSED_SCHEMA_TYPES = new Set(['one-of', 'any-of', 'all-of']);\nexport const COLLECTION_TYPES = new Set(['array', 'dictionary']);\nexport const PRIMITIVE_TYPES = new Set([\n  'string',\n  'integer',\n  'number',\n  'boolean',\n  'null',\n  'any',\n  'binary',\n  'void',\n]);\n\n/**\n * Content types that indicate JSON Lines streaming (OpenAPI 3.2)\n */\nexport const STREAMING_CONTENT_TYPES = new Set([\n  'application/jsonl',\n  'application/x-ndjson',\n]);\n\n/**\n * Vendor extensions which are used to customise generated code\n */\nexport const VENDOR_EXTENSIONS = {\n  /**\n   * Set to 'true' to indicate this is a streaming API\n   */\n  STREAMING: 'x-streaming',\n  /**\n   * Set to true to indicate this is a mutation, regardless of its HTTP method\n   */\n  MUTATION: 'x-mutation',\n  /**\n   * Set to true to indicate this is a query, regardless of its HTTP method\n   */\n  QUERY: 'x-query',\n  /**\n   * Set to the name of the input property used as the cursor for pagination if\n   * the API accepts a cursor that is not named 'cursor'.\n   * This can also be set to false to override behaviour and indicate this is not\n   * a paginated API.\n   * Used for tanstack infinite query hooks.\n   */\n  CURSOR: 'x-cursor',\n} as const;\n"],"names":["flattenModelLink","link","undefined","Array","isArray","COMPOSED_SCHEMA_TYPES","Set","COLLECTION_TYPES","PRIMITIVE_TYPES","STREAMING_CONTENT_TYPES","VENDOR_EXTENSIONS","STREAMING","MUTATION","QUERY","CURSOR"],"mappings":"AAAA;;;CAGC,GAiBD,OAAO,MAAMA,mBAAmB,CAACC,OAC/BA,SAASC,YAAYA,YAAYC,MAAMC,OAAO,CAACH,QAAQA,IAAI,CAAC,EAAE,GAAGA,KAAK;AAExE,iFAAiF;AACjF,OAAO,MAAMI,wBAAwB,IAAIC,IAAI;IAAC;IAAU;IAAU;CAAS,EAAE;AAC7E,OAAO,MAAMC,mBAAmB,IAAID,IAAI;IAAC;IAAS;CAAa,EAAE;AACjE,OAAO,MAAME,kBAAkB,IAAIF,IAAI;IACrC;IACA;IACA;IACA;IACA;IACA;IACA;IACA;CACD,EAAE;AAEH;;CAEC,GACD,OAAO,MAAMG,0BAA0B,IAAIH,IAAI;IAC7C;IACA;CACD,EAAE;AAEH;;CAEC,GACD,OAAO,MAAMI,oBAAoB;IAC/B;;GAEC,GACDC,WAAW;IACX;;GAEC,GACDC,UAAU;IACV;;GAEC,GACDC,OAAO;IACP;;;;;;GAMC,GACDC,QAAQ;AACV,EAAW"}
+{"version":3,"sources":["../../../../../../../packages/nx-plugin/src/open-api/utils/codegen-data/types.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';\n\n/**\n * The kind of a {@link Model}, describing how it should be rendered.\n *\n * - `interface` — an object type with named properties\n * - `enum` — a set of string/number literal values\n * - `array` — a list whose element type is described by `link`\n * - `dictionary` — a map whose value type is described by `link`\n * - `reference` — a reference to another named model (`type` is its name)\n * - `generic` — a primitive (string/number/boolean/null/void/binary/any)\n * - `one-of` / `any-of` / `all-of` — a composite of other schemas\n */\nexport type ModelExport =\n  | 'interface'\n  | 'enum'\n  | 'array'\n  | 'dictionary'\n  | 'reference'\n  | 'generic'\n  | 'one-of'\n  | 'any-of'\n  | 'all-of';\n\n/**\n * Where a parameter-like {@link Model} appears in a request/response.\n * Empty string is used for models that are not parameters (schemas/properties).\n */\nexport type ModelIn =\n  | ''\n  | 'query'\n  | 'path'\n  | 'header'\n  | 'cookie'\n  | 'body'\n  | 'response';\n\n/**\n * How array/object query & header parameters are serialised on the wire.\n * `deepObject` explodes an object into `key[prop]=value` query pairs.\n */\nexport type CollectionFormat = 'multi' | 'csv' | 'ssv' | 'pipes' | 'deepObject';\n\n/** A single enum member value. */\nexport interface EnumMember {\n  value: string | number | boolean;\n}\n\n/**\n * A discriminated-composite mapping entry: a discriminator value and the name\n * of the composed model it selects.\n */\nexport interface DiscriminatorMapping {\n  /** The discriminator property value (e.g. `\"cat\"`). */\n  value: string;\n  /** The name of the composed model this value selects (e.g. `\"Cat\"`). */\n  modelName: string;\n}\n\n/**\n * The discriminator of a composite (`oneOf`/`anyOf`) or an inheritance base\n * (an `object` schema whose subtypes `allOf`-compose it), used to marshal\n * directly to the matching branch/subtype rather than merging every branch or\n * dropping subtype-only fields.\n */\nexport interface Discriminator {\n  /** The wire property name carrying the discriminator value. */\n  propertyName: string;\n  /** The TypeScript property name (resolved during augmentation). */\n  typescriptPropertyName?: string;\n  /** The value → composed-model mapping. */\n  mapping: DiscriminatorMapping[];\n  /**\n   * True when this discriminator sits on an inheritance base (an `object`\n   * schema selected by `allOf`-composing subtypes) rather than a `oneOf`/\n   * `anyOf` composite. The base marshals via dispatch to its subtypes, but its\n   * subtypes compose the base's own (non-dispatching) body — so the base emits\n   * a separate non-dispatching marshaller to break the recursion.\n   */\n  isBase?: boolean;\n}\n\n/** A pattern-property entry: a regex pattern and the model for its values. */\nexport interface PatternPropertyModel {\n  pattern: string;\n  model: Model;\n}\n\n/**\n * A model represents an OpenAPI schema, or something derived from one (a\n * property, parameter, or response). It is produced by the parser\n * (`../parser.ts`) and progressively augmented by `../codegen-data.ts` with\n * language-specific and code-generation fields before being handed to the\n * templates. Augmentation fields are optional as they are absent on raw parser\n * output.\n */\nexport interface Model {\n  /** The schema, property, or parameter name. */\n  name: string;\n  /** How this model should be rendered. */\n  export: ModelExport;\n  /**\n   * The model's type: a primitive name (`string`, `number`, `boolean`, `null`,\n   * `void`, `binary`, `any`), `unknown`, or the name of a referenced model.\n   */\n  type: string;\n  /** The OpenAPI `format` (e.g. `int32`, `date-time`, `binary`), if any. */\n  format?: string;\n  /** Description, used to render doc comments. */\n  description: string | null;\n  /** Whether the schema is marked deprecated. */\n  deprecated: boolean;\n  /** Whether the value may be null. */\n  isNullable: boolean;\n  /** Whether the property is read-only. */\n  isReadOnly: boolean;\n  /** Whether the property/parameter is required. */\n  isRequired: boolean;\n  /** Whether an array enforces uniqueness (rendered as a `Set`). */\n  uniqueItems?: boolean;\n  /** For arrays/dictionaries, the model describing the element/value type. */\n  link?: Model | null;\n  /** Child properties (for interfaces) or members (for composites). */\n  properties: Model[];\n  /** Enum members, when `export === 'enum'`. */\n  enum: EnumMember[];\n  /** Names of other models this model references (for import generation). */\n  imports: string[];\n\n  /** Where a parameter appears; `''` for non-parameter models. */\n  in: ModelIn;\n  /** The source property name for a parameter (body parameters use `body`). */\n  prop?: string;\n  /** The chosen request/response media type, for body params and responses. */\n  mediaType?: string | null;\n  /** All acceptable media types (request body / response). */\n  mediaTypes?: string[];\n  /** The response status code, for response models. */\n  code?: number | string;\n\n  /**\n   * For a discriminated subtype's discriminator property: the rendered literal\n   * TypeScript type (e.g. `'cat'`, or `'cat' | 'kitten'` when several values\n   * map to one subtype) that makes the union a true tagged union. Absent when\n   * the subtype's tag can't be pinned to a literal (e.g. it appears in\n   * multiple unions with different values).\n   */\n  discriminatorValue?: string;\n\n  /** The raw OpenAPI `type` (used to distinguish integer from number). */\n  openapiType?: string | string[];\n  /** Vendor extensions (`x-*`) copied from the schema. */\n  vendorExtensions?: VendorExtensions;\n  /** True when the schema has additionalProperties. */\n  hasAdditionalProperties?: boolean;\n  /** The model describing additionalProperties values. */\n  additionalPropertiesModel?: Model;\n  /** True when the schema has patternProperties. */\n  hasPatternProperties?: boolean;\n  /** The models describing each pattern's values. */\n  patternPropertiesModels?: PatternPropertyModel[];\n\n  /** For composites: the referenced (object) models composed together. */\n  composedModels?: Model[];\n  /** For composites: the primitive/enum/array members composed together. */\n  composedPrimitives?: Model[];\n  /** For discriminated one-of/any-of composites: the discriminator metadata. */\n  discriminator?: Discriminator;\n\n  /** The TypeScript identifier for this model/property. */\n  typescriptName?: string;\n  /** The rendered TypeScript type. */\n  typescriptType?: string;\n  /** The Python identifier for this model/property. */\n  pythonName?: string;\n  /** The rendered Python type. */\n  pythonType?: string;\n  /** snake_case model name (Python). */\n  nameSnakeCase?: string;\n  /** True when the model is a renderable primitive (not composite/collection). */\n  isPrimitive?: boolean;\n  /** True when the schema declares an enum. */\n  isEnum?: boolean;\n\n  /** True for JSON-lines streaming responses. */\n  isJsonlStreaming?: boolean;\n  /** The model describing each streamed item. */\n  itemSchemaModel?: Model;\n\n  /** Collection serialisation format for array query/header parameters. */\n  collectionFormat?: CollectionFormat;\n}\n\n/** Vendor extension bag (`x-*` keys copied from a schema/operation/spec). */\nexport type VendorExtensions = { [key: string]: unknown };\n\n/**\n * An operation represents a single OpenAPI path + method. Produced by the\n * parser and augmented by `../codegen-data.ts`.\n */\nexport interface Operation {\n  id: string;\n  name: string;\n  method: string;\n  path: string;\n  description: string | null;\n  tags?: string[] | null;\n  deprecated: boolean;\n  imports: string[];\n  parameters: Model[];\n  /** The request body parameter (same object reference as in `parameters`). */\n  parametersBody?: Model | null;\n  responses: Model[];\n\n  /** Deduplicated operation name used throughout generated code. */\n  uniqueName?: string;\n  /** Dot-notation name (tag-qualified), used for metadata keys. */\n  dotNotationName?: string;\n  operationIdPascalCase?: string;\n  operationIdSnakeCase?: string;\n  /** The generated request type name (e.g. `FooRequest`). */\n  requestTypeName?: string;\n\n  /** The response model used as the operation's result. */\n  result?: Model;\n\n  /** The explicit body parameter when the body is not inlined. */\n  explicitRequestBodyParameter?: Model;\n\n  vendorExtensions?: VendorExtensions;\n  isMutation?: boolean;\n  isQuery?: boolean;\n  isStreaming?: boolean;\n  isInfiniteQuery?: boolean;\n  /** The cursor parameter, for infinite queries. */\n  infiniteQueryCursorProperty?: Model;\n}\n\n/**\n * A service groups operations. Currently the parser produces a single\n * `Default` service; operations are re-grouped by tag downstream.\n */\nexport interface Service {\n  name: string;\n  operations: Operation[];\n  imports: string[];\n\n  /** All model names the service (API client) needs to import. */\n  modelImports?: string[];\n  className?: string;\n  nameSnakeCase?: string;\n}\n\n/**\n * The initial data structure produced by the OpenAPI parser.\n */\nexport interface ClientData {\n  models: Model[];\n  services: Service[];\n}\n\n/** Models indexed by name, for reference resolution during augmentation. */\nexport type ModelsByName = { [name: string]: Model };\n\n/** Index a list of models by name. */\nexport const indexModelsByName = (models: Model[]): ModelsByName =>\n  Object.fromEntries(models.map((m) => [m.name, m]));\n\n/** The single service the parser emits; operations are re-grouped by tag. */\nexport const DEFAULT_SERVICE_NAME = 'Default';\n\n/**\n * The full data structure handed to the code generation templates.\n */\nexport interface CodeGenData extends ClientData {\n  className: string;\n  info: OpenAPIV3.InfoObject | OpenAPIV3_1.InfoObject;\n  allOperations: Operation[];\n  operationsByTag: { [tag: string]: Operation[] };\n  untaggedOperations: Operation[];\n  vendorExtensions: VendorExtensions;\n}\n\n/**\n * Create a {@link Model} with the default fields the parser always emits.\n * Callers override the fields relevant to their specific schema.\n */\nexport const createModel = (overrides: Partial<Model> = {}): Model => ({\n  name: '',\n  export: 'interface',\n  type: 'unknown',\n  description: null,\n  deprecated: false,\n  isNullable: false,\n  isReadOnly: false,\n  isRequired: false,\n  link: null,\n  properties: [],\n  enum: [],\n  imports: [],\n  in: '',\n  ...overrides,\n});\n\n// Model types which indicate it is composed (ie inherits/mixin's another schema)\nexport const COMPOSED_SCHEMA_TYPES = new Set<ModelExport>([\n  'one-of',\n  'any-of',\n  'all-of',\n]);\nexport const COLLECTION_TYPES = new Set<ModelExport>(['array', 'dictionary']);\nexport const PRIMITIVE_TYPES = new Set([\n  'string',\n  'integer',\n  'number',\n  'boolean',\n  'null',\n  'any',\n  'binary',\n  'void',\n]);\n\n/**\n * Content types that indicate JSON Lines streaming (OpenAPI 3.2)\n */\nexport const STREAMING_CONTENT_TYPES = new Set([\n  'application/jsonl',\n  'application/x-ndjson',\n]);\n\n/**\n * Vendor extensions which are used to customise generated code\n */\nexport const VENDOR_EXTENSIONS = {\n  /**\n   * Set to 'true' to indicate this is a streaming API\n   */\n  STREAMING: 'x-streaming',\n  /**\n   * Set to true to indicate this is a mutation, regardless of its HTTP method\n   */\n  MUTATION: 'x-mutation',\n  /**\n   * Set to true to indicate this is a query, regardless of its HTTP method\n   */\n  QUERY: 'x-query',\n  /**\n   * Set to the name of the input property used as the cursor for pagination if\n   * the API accepts a cursor that is not named 'cursor'.\n   * This can also be set to false to override behaviour and indicate this is not\n   * a paginated API.\n   * Used for tanstack infinite query hooks.\n   */\n  CURSOR: 'x-cursor',\n} as const;\n"],"names":["indexModelsByName","models","Object","fromEntries","map","m","name","DEFAULT_SERVICE_NAME","createModel","overrides","export","type","description","deprecated","isNullable","isReadOnly","isRequired","link","properties","enum","imports","in","COMPOSED_SCHEMA_TYPES","Set","COLLECTION_TYPES","PRIMITIVE_TYPES","STREAMING_CONTENT_TYPES","VENDOR_EXTENSIONS","STREAMING","MUTATION","QUERY","CURSOR"],"mappings":"AAAA;;;CAGC,GAyQD,oCAAoC,GACpC,OAAO,MAAMA,oBAAoB,CAACC,SAChCC,OAAOC,WAAW,CAACF,OAAOG,GAAG,CAAC,CAACC,IAAM;YAACA,EAAEC,IAAI;YAAED;SAAE,GAAG;AAErD,2EAA2E,GAC3E,OAAO,MAAME,uBAAuB,UAAU;AAc9C;;;CAGC,GACD,OAAO,MAAMC,cAAc,CAACC,YAA4B,CAAC,CAAC,GAAa,CAAA;QACrEH,MAAM;QACNI,QAAQ;QACRC,MAAM;QACNC,aAAa;QACbC,YAAY;QACZC,YAAY;QACZC,YAAY;QACZC,YAAY;QACZC,MAAM;QACNC,YAAY,EAAE;QACdC,MAAM,EAAE;QACRC,SAAS,EAAE;QACXC,IAAI;QACJ,GAAGZ,SAAS;IACd,CAAA,EAAG;AAEH,iFAAiF;AACjF,OAAO,MAAMa,wBAAwB,IAAIC,IAAiB;IACxD;IACA;IACA;CACD,EAAE;AACH,OAAO,MAAMC,mBAAmB,IAAID,IAAiB;IAAC;IAAS;CAAa,EAAE;AAC9E,OAAO,MAAME,kBAAkB,IAAIF,IAAI;IACrC;IACA;IACA;IACA;IACA;IACA;IACA;IACA;CACD,EAAE;AAEH;;CAEC,GACD,OAAO,MAAMG,0BAA0B,IAAIH,IAAI;IAC7C;IACA;CACD,EAAE;AAEH;;CAEC,GACD,OAAO,MAAMI,oBAAoB;IAC/B;;GAEC,GACDC,WAAW;IACX;;GAEC,GACDC,UAAU;IACV;;GAEC,GACDC,OAAO;IACP;;;;;;GAMC,GACDC,QAAQ;AACV,EAAW"}

package/src/open-api/utils/codegen-data.d.ts

@@ -5,6 +5,6 @@
 import { type CodeGenData } from './codegen-data/types';
 import type { Spec } from './types';
 /**
- * Builds a data structure from an OpenAPI spec which can be used to generate code
+ * Build the data structure used to generate code from an OpenAPI spec.
  */
-export declare const buildOpenApiCodeGenData: (inSpec: Spec) => Promise<CodeGenData>;
+export declare const buildOpenApiCodeGenData: (inSpec: Spec) => CodeGenData;