@distilled.cloud/core 0.30.3 → 1.0.0-rc.2

package/lib/codegen/openapi.d.ts

@@ -0,0 +1,115 @@
+/**
+ * OpenAPI → Smithy 2.0 JSON converter (dev-time only, provider-agnostic).
+ *
+ * Turns a Swagger 2.0 / OAS 3.0 / OAS 3.1 document into the same Smithy JSON
+ * model shape the other spec converters produce (`{ smithy: "2.0", metadata,
+ * shapes }`), so every OpenAPI-sourced provider flows through the one shared
+ * `generateService` compiler. Conversion fidelity follows distilled v0's
+ * `generate-openapi.ts` feature matrix:
+ *
+ *   • one operation per (path × get/post/put/patch/delete), deprecated
+ *     skipped by default; op shape name = PascalCase(operationId)
+ *   • input `<Op>Request`: path params → `smithy.api#httpLabel` (+required),
+ *     query params → `smithy.api#httpQuery`, header/cookie params dropped,
+ *     body properties flattened alongside (labels win, then query, then body);
+ *     non-object bodies become a sole `body` member with `smithy.api#httpPayload`
+ *   • `$ref`s become NAMED shapes (`components/schemas/X` → `<ns>#X`), reused
+ *     across operations; anonymous nested objects synthesize names from the
+ *     parent + member path
+ *   • responses: 200 → 201 → 204 precedence, `application/json` only; object
+ *     results become `<Op>Response` structures (a sole `$ref` reuses the named
+ *     shape); bare array/scalar results wrap in a structure whose single
+ *     member carries `com.distilled.openapi#rawResponse` (the SdkSpec maps it
+ *     to a root pipe); no schema → `smithy.api#Unit`
+ *   • nullability (3.0 `nullable`, 3.1 `type: [..., "null"]`, 2.0
+ *     `x-nullable`, `oneOf`/`anyOf` null branches) → member-level
+ *     `com.distilled.openapi#nullable` trait
+ *   • sensitive string members (x-sensitive or name-pattern match) →
+ *     `smithy.api#sensitive` on the member (direction-agnostic; the SdkSpec
+ *     decides the input/output treatment)
+ *   • per-op non-2xx statuses (outside `defaultErrorStatuses`) → typed error
+ *     shapes with `smithy.api#error`/`smithy.api#httpError` and
+ *     `com.distilled.openapi#errorMatchers` status matchers
+ *   • v0 pagination detection (`pagination.cursor` / `.next` / `.next_page`,
+ *     `next_token`/`NextToken`/`nextToken`, `next_page` + input alias lists +
+ *     first top-level array property) → `smithy.api#paginated` on the op
+ *     (with the non-standard `mode` member the core runtime dispatches on)
+ */
+/** Member-level nullability (`S.NullOr` + `| null` via `SdkSpec.nullableTrait`). */
+export declare const NULLABLE_TRAIT = "com.distilled.openapi#nullable";
+/**
+ * Marks the sole member of a synthesized response wrapper for bare
+ * array/scalar response bodies. SdkSpecs bind it with a `rootPipe`
+ * (`T.RawResponseRoot()` from `core/protocol-rest`), so the emitted response
+ * type IS the payload type.
+ */
+export declare const RAW_RESPONSE_TRAIT = "com.distilled.openapi#rawResponse";
+/**
+ * Wire-matching rules for a generated error class (see
+ * `SdkSpec.errorMatchersTrait` + `applyErrorMatchers`). The converter stamps
+ * `[{ status }]` from the response status the class was mapped from.
+ */
+export declare const ERROR_MATCHERS_TRAIT = "com.distilled.openapi#errorMatchers";
+/**
+ * Non-JSON request body encoding chosen by the v0 content-type precedence
+ * (json > form-urlencoded > multipart). Value: `"form-urlencoded"` |
+ * `"multipart"`. `"multipart"` is also merged into the `smithy.api#http`
+ * trait's `contentType` (which core's `buildRequest` understands);
+ * form-urlencoded is left to provider SdkSpecs/protocols.
+ */
+export declare const CONTENT_TYPE_TRAIT = "com.distilled.openapi#contentType";
+/**
+ * The `apiVersion` recorded on every operation when
+ * {@link OpenApiConvertOptions.apiVersion} is set (Azure ARM style). The
+ * matching `api-version` query parameter is dropped from inputs; the
+ * provider's protocol injects it at request time.
+ */
+export declare const API_VERSION_TRAIT = "com.distilled.openapi#apiVersion";
+export declare const SENSITIVE_FIELD_PATTERNS: readonly RegExp[];
+export interface OpenApiConvertOptions {
+    /** Shape namespace, e.g. `"com.neon.api"`. */
+    readonly namespace: string;
+    /** Service shape name (PascalCased), e.g. `"Neon"`. */
+    readonly serviceName: string;
+    /** Service shape `version`. Default: the spec's `info.version`, else "1.0". */
+    readonly serviceVersion?: string;
+    /**
+     * Non-2xx response status → error class name. Statuses in
+     * {@link defaultErrorStatuses} never produce per-op errors. Default:
+     * `{400: BadRequest, 403: Forbidden, 404: NotFound, 409: Conflict,
+     * 422: UnprocessableEntity}` (the v0 default).
+     */
+    readonly statusToErrorClass?: Readonly<Record<string, string>>;
+    /**
+     * Statuses covered by the SDK's common errors, excluded from per-op error
+     * lists. Default: `{"401","429","500","503"}` (the v0 default).
+     */
+    readonly defaultErrorStatuses?: Iterable<string>;
+    /** Skip operations marked `deprecated: true`. Default true. */
+    readonly skipDeprecated?: boolean;
+    /**
+     * Azure-style fixed `api-version`: drops `api-version` query params and
+     * stamps {@link API_VERSION_TRAIT} on every operation.
+     */
+    readonly apiVersion?: string;
+    /**
+     * Name patterns marking string members sensitive. Default
+     * {@link SENSITIVE_FIELD_PATTERNS}. Pass `[]` to disable name-based
+     * detection (explicit `x-sensitive: true` still applies).
+     */
+    readonly sensitivePatterns?: readonly RegExp[];
+    /**
+     * Optional full shape-definition overrides for emitted error classes
+     * (keyed by class name) — e.g. custom members. The converter's default is
+     * an empty structure with `smithy.api#error` + `smithy.api#httpError` +
+     * {@link ERROR_MATCHERS_TRAIT} traits; overrides are merged over it.
+     */
+    readonly errorShapes?: Readonly<Record<string, any>>;
+}
+export interface SmithyModel {
+    smithy: "2.0";
+    metadata: any;
+    shapes: Record<string, any>;
+}
+export declare const convertOpenApiToSmithy: (spec: unknown, options: OpenApiConvertOptions) => SmithyModel;
+//# sourceMappingURL=openapi.d.ts.map

package/lib/codegen/openapi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../src/codegen/openapi.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAMH,oFAAoF;AACpF,eAAO,MAAM,cAAc,mCAAmC,CAAC;AAC/D;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,sCAAsC,CAAC;AACtE;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,wCAAwC,CAAC;AAC1E;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,sCAAsC,CAAC;AACtE;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,qCAAqC,CAAC;AAMpE,eAAO,MAAM,wBAAwB,EAAE,SAAS,MAAM,EAoBrD,CAAC;AAMF,MAAM,WAAW,qBAAqB;IACpC,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,uDAAuD;IACvD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,+EAA+E;IAC/E,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC/D;;;OAGG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACjD,+DAA+D;IAC/D,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/C;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CACtD;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,KAAK,CAAC;IACd,QAAQ,EAAE,GAAG,CAAC;IACd,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAm8BD,eAAO,MAAM,sBAAsB,SAC3B,OAAO,WACJ,qBAAqB,KAC7B,WA+UF,CAAC"}