@aws/nx-plugin 1.0.0-rc.4 → 1.0.0-rc.41

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../../packages/nx-plugin/src/open-api/utils/codegen-data/types.ts"],"names":[],"mappings":";;;AAoBO,MAAM,gBAAgB,GAAG,CAAC,IAAsB,EAAS,EAAE,CAChE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAD3D,QAAA,gBAAgB,oBAC2C;AAExE,iFAAiF;AACpE,QAAA,qBAAqB,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AAChE,QAAA,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;AACpD,QAAA,eAAe,GAAG,IAAI,GAAG,CAAC;IACrC,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,SAAS;IACT,MAAM;IACN,KAAK;IACL,QAAQ;IACR,MAAM;CACP,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,uBAAuB,GAAG,IAAI,GAAG,CAAC;IAC7C,mBAAmB;IACnB,sBAAsB;CACvB,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,aAAa;IACxB;;OAEG;IACH,QAAQ,EAAE,YAAY;IACtB;;OAEG;IACH,KAAK,EAAE,SAAS;IAChB;;;;;;OAMG;IACH,MAAM,EAAE,UAAU;CACV,CAAC"}
+{"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 * - `tuple` — a fixed-length array (`prefixItems`) whose element types are the\n *   `properties`, in order\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  | 'tuple'\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  /**\n   * Per-part content types declared by the request body `encoding` object\n   * (multipart bodies), keyed by property name.\n   */\n  partContentTypes?: { [prop: string]: string };\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  /** Path parameter serialization style, when not the default `simple`. */\n  pathStyle?: 'matrix' | 'label';\n  /** Path parameter explode flag (used with `pathStyle`). */\n  pathExplode?: boolean;\n  /** Query parameter `allowReserved`: reserved characters are not encoded. */\n  allowReserved?: boolean;\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,GAuRD,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

@@ -1,6 +1,10 @@
-import { Spec } from './types';
-import { CodeGenData } from './codegen-data/types';
 /**
- * Builds a data structure from an OpenAPI spec which can be used to generate code
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
  */
-export declare const buildOpenApiCodeGenData: (inSpec: Spec) => Promise<CodeGenData>;
+import { type CodeGenData } from './codegen-data/types';
+import type { Spec } from './types';
+/**
+ * Build the data structure used to generate code from an OpenAPI spec.
+ */
+export declare const buildOpenApiCodeGenData: (inSpec: Spec) => CodeGenData;