@postman/sdk-config 0.3.3 → 0.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +48 -9
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +48 -9
- package/dist/index.js.map +1 -1
- package/dist/sdk-config/index.cjs +48 -9
- package/dist/sdk-config/index.cjs.map +1 -1
- package/dist/sdk-config/index.d.cts +1 -1
- package/dist/sdk-config/index.d.ts +1 -1
- package/dist/sdk-config/index.js +48 -9
- package/dist/sdk-config/index.js.map +1 -1
- package/dist/sdk-config/v1/index.cjs +48 -9
- package/dist/sdk-config/v1/index.cjs.map +1 -1
- package/dist/sdk-config/v1/index.d.cts +101 -5
- package/dist/sdk-config/v1/index.d.ts +101 -5
- package/dist/sdk-config/v1/index.js +48 -9
- package/dist/sdk-config/v1/index.js.map +1 -1
- package/dist/sdk-config-ir/index.cjs +16 -0
- package/dist/sdk-config-ir/index.cjs.map +1 -1
- package/dist/sdk-config-ir/index.d.cts +1 -1
- package/dist/sdk-config-ir/index.d.ts +1 -1
- package/dist/sdk-config-ir/index.js +16 -0
- package/dist/sdk-config-ir/index.js.map +1 -1
- package/dist/sdk-config-ir/v1/index.cjs +16 -0
- package/dist/sdk-config-ir/v1/index.cjs.map +1 -1
- package/dist/sdk-config-ir/v1/index.d.cts +86 -8
- package/dist/sdk-config-ir/v1/index.d.ts +86 -8
- package/dist/sdk-config-ir/v1/index.js +16 -0
- package/dist/sdk-config-ir/v1/index.js.map +1 -1
- package/dist/{typescript-CKRe_6MB.d.cts → typescript-BruxA5zG.d.cts} +10 -2
- package/dist/{typescript-CKRe_6MB.d.ts → typescript-BruxA5zG.d.ts} +10 -2
- package/package.json +1 -1
- package/src/sdk-config-ir/v1/README.md +68 -34
|
@@ -274,38 +274,74 @@ normalized contract.
|
|
|
274
274
|
These settings remain under `source.apiImportSettings` because they affect spec conversion rather
|
|
275
275
|
than generated-language presentation.
|
|
276
276
|
|
|
277
|
-
| Fern setting
|
|
278
|
-
|
|
|
279
|
-
| `respect-nullable-schemas`
|
|
280
|
-
| `title-as-schema-name`
|
|
281
|
-
| `
|
|
282
|
-
| `
|
|
283
|
-
| `
|
|
284
|
-
| `
|
|
285
|
-
| `
|
|
286
|
-
| `
|
|
287
|
-
| `
|
|
288
|
-
| `
|
|
289
|
-
| `
|
|
290
|
-
| `
|
|
277
|
+
| Fern setting | Normalized field | Observed projects |
|
|
278
|
+
| ----------------------------------------------------------- | ------------------------------------ | --------------------------------------: |
|
|
279
|
+
| `respect-nullable-schemas` | `respectNullableSchemas` | 10 |
|
|
280
|
+
| `title-as-schema-name` | `titleAsSchemaName` | 16 |
|
|
281
|
+
| `ignore-tags` | `ignoreTags` | Not in the project snapshot; see below. |
|
|
282
|
+
| `disambiguate-request-names` | `disambiguateRequestNames` | Not in the project snapshot; see below. |
|
|
283
|
+
| `respect-readonly-schemas` | `respectReadonlySchemas` | Not in the project snapshot; see below. |
|
|
284
|
+
| `unions: v1`, `prefer-undiscriminated-unions-with-literals` | `discriminatedUnionV2` | Not in the project snapshot; see below. |
|
|
285
|
+
| `prefer-undiscriminated-unions-with-literals` | `undiscriminatedUnionsWithLiterals` | Not in the project snapshot; see below. |
|
|
286
|
+
| `inline-all-of-schemas` | `inlineAllOfSchemas` | Not in the project snapshot; see below. |
|
|
287
|
+
| `resolve-schema-collisions` | `resolveSchemaCollisions` | Not in the project snapshot; see below. |
|
|
288
|
+
| `message-naming` | `asyncApiMessageNaming` | Not in the project snapshot; see below. |
|
|
289
|
+
| `coerce-enums-to-literals` | `coerceEnumsToLiterals` | 14 |
|
|
290
|
+
| `idiomatic-request-names` | `idiomaticRequestNames` | 12 |
|
|
291
|
+
| `wrap-references-to-nullable-in-optional` | `wrapReferencesToNullableInOptional` | 9 |
|
|
292
|
+
| `coerce-optional-schemas-to-nullable` | `coerceOptionalSchemasToNullable` | 9 |
|
|
293
|
+
| `object-query-parameters` | `objectQueryParameters` | 9 |
|
|
294
|
+
| `only-include-referenced-schemas` | `onlyIncludeReferencedSchemas` | 4 |
|
|
295
|
+
| `group-multi-api-environments` | `groupMultiApiEnvironments` | 2 |
|
|
296
|
+
| `path-parameter-order` | `pathParameterOrder` | 2 |
|
|
297
|
+
| `type-dates-as-strings` | `typeDatesAsStrings` | 12 |
|
|
298
|
+
| `default-integer-format` | `defaultIntegerFormat` | Importer defaults to `int32`. |
|
|
299
|
+
|
|
300
|
+
`ignoreTags` and `disambiguateRequestNames` postdate the project snapshot. Twilio declares both
|
|
301
|
+
across its namespaced API specs. They stay undefaulted so omission remains distinguishable from an
|
|
302
|
+
explicit value, including `disambiguateRequestNames: false`. `ignoreTags` controls import-time use
|
|
303
|
+
of authored tags, not generation-time service-name inference; `disambiguateRequestNames` controls
|
|
304
|
+
request/schema collisions, not idiomatic request naming. Producers and generators must map and
|
|
305
|
+
honour these fields before they change generated output.
|
|
306
|
+
|
|
307
|
+
`respectReadonlySchemas` and `discriminatedUnionV2` also postdate the snapshot. The 2026-07-17 audit
|
|
308
|
+
read declared project configuration, which is why the first pass recorded no use: both are reached
|
|
309
|
+
through effective-setting resolution rather than a literal key in `generators.yml`. Auth0 declares
|
|
310
|
+
`respect-readonly-schemas` directly, but `discriminatedUnionV2` has two declared spellings that
|
|
311
|
+
resolve to it — `prefer-undiscriminated-unions-with-literals` and `unions: v1` — so a config can be
|
|
312
|
+
refused for a key that appears nowhere in it. The two spellings are not interchangeable, which is
|
|
313
|
+
why `undiscriminatedUnionsWithLiterals` is a separate field rather than an alias: `unions: v1` sets
|
|
314
|
+
only `discriminatedUnionV2`, while `prefer-undiscriminated-unions-with-literals` sets both. A
|
|
315
|
+
contract carrying one of the pair cannot reproduce a config that set the other. All three stay
|
|
316
|
+
undefaulted for the same reason as the
|
|
317
|
+
fields above: `respectReadonlySchemas` changes which properties an imported schema exposes, and
|
|
318
|
+
`discriminatedUnionV2` changes how union variants are converted, so an absent value must leave an
|
|
319
|
+
existing SDK's shapes alone rather than assert one.
|
|
320
|
+
|
|
321
|
+
`inlineAllOfSchemas`, `resolveSchemaCollisions`, and `asyncApiMessageNaming` complete the retained
|
|
322
|
+
import settings with observed customer use. Each is refused today whenever it differs from the
|
|
323
|
+
importer default, which blocks the declaring customer from a post-cutover generator version.
|
|
324
|
+
`asyncApiMessageNaming` is the only enum of the three, and `v2` is its sole non-default value. It
|
|
325
|
+
names AsyncAPI messages, but the importer resolves it as part of one shared settings object, so a
|
|
326
|
+
project's OpenAPI specs carry it too and are refused for it.
|
|
291
327
|
|
|
292
328
|
## Fern language-specific migration map
|
|
293
329
|
|
|
294
330
|
Only options that remain language-specific stay in `generation.language`.
|
|
295
331
|
|
|
296
|
-
| Language | Fern fields retained in language config
|
|
297
|
-
| ----------- |
|
|
298
|
-
| TypeScript | `packageManager` (1), `testFramework` (2), `namespaceExportName`, `allowCustomFetcher` (13), branded aliases (1), legacy exports (1), `useBigInt`, and positive `serdeLayer` from `noSerdeLayer` (8)
|
|
299
|
-
| Python | Python/Pydantic versions, client filenames
|
|
300
|
-
| Java/Kotlin | Package layout (3), local dates (2), optional-nullable collapse (2), Gradle settings (7), and JVM async-client style
|
|
301
|
-
| Go | Legacy complex models, union version (3), legacy client options (1), and the fern root-client constructor name
|
|
302
|
-
| C# | Optional wrapper, simplified dictionaries (1), explicit namespaces (7), core namespace behavior (1), exception handler (5), and the experimental explicit-nullable-optional switch
|
|
303
|
-
| PHP | Property access (2) and generated client interfaces (1)
|
|
304
|
-
| Ruby | Require paths (2)
|
|
305
|
-
| Rust | Datetime representation, initialism casing, and Cargo features/default-features
|
|
306
|
-
| Swift | Module name and the nullable-as-optional collapse
|
|
307
|
-
| CLI | Pagination parameter names and the `skills` boolean
|
|
308
|
-
| MCP | Server identity, availability exclusions, tool filters and named toolsets, plus the TypeScript options
|
|
332
|
+
| Language | Fern fields retained in language config | Shared mappings lifted out |
|
|
333
|
+
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
334
|
+
| TypeScript | `packageManager` (1), `testFramework` (2), `namespaceExportName`, `allowCustomFetcher` (13), branded aliases (1), legacy exports (1), `useBigInt`, and positive `serdeLayer` from `noSerdeLayer` (8) | Namespace, validation, inline types, dependencies, wire tests, streams, WebSockets, pager/client names |
|
|
335
|
+
| Python | Python/Pydantic versions, client filenames, model switches, TypedDict requests, redirect/chunk/recursion compatibility, and package extras | Package/module names, enum form, extra fields, response validation, request style, dependencies, timeout, layout, wire tests, WebSockets |
|
|
336
|
+
| Java/Kotlin | Package layout (3), local dates (2), optional-nullable collapse (2), Gradle settings (7), and JVM async-client style | Maven identity, namespace, names, forward-compatible enums, inline properties, dependencies, pager, wire tests |
|
|
337
|
+
| Go | Legacy complex models, union version (3), legacy client options (1), and the fern root-client constructor name | Module/package identity, client name, environments, smart casing, inline properties, pager, wire tests |
|
|
338
|
+
| C# | Optional wrapper, simplified dictionaries (1), explicit namespaces (7), core namespace behavior (1), exception handler (5), and the experimental explicit-nullable-optional switch | NuGet identity, namespace, class/error names, pager, wire tests |
|
|
339
|
+
| PHP | Property access (2) and generated client interfaces (1) | Composer identity, namespace, client/pager names, request style, dependencies, wire tests |
|
|
340
|
+
| Ruby | Require paths (2) | Gem identity, client name, dependencies, pager, wire tests |
|
|
341
|
+
| Rust | Datetime representation, initialism casing, and Cargo features/default-features | Crate identity, client name, and package metadata use shared fields. |
|
|
342
|
+
| Swift | Module name and the nullable-as-optional collapse | Client, environment and error naming use shared fields. |
|
|
343
|
+
| CLI | Pagination parameter names and the `skills` boolean | Go module and package identity use `package`. |
|
|
344
|
+
| MCP | Server identity, availability exclusions, tool filters and named toolsets, plus the TypeScript options | npm package identity, client and serialization behavior |
|
|
309
345
|
|
|
310
346
|
## Removed and deferred legacy configuration
|
|
311
347
|
|
|
@@ -318,16 +354,14 @@ the migration.
|
|
|
318
354
|
- Common Fern generation: include/omit platform-header overrides. Output-profile defaults own this
|
|
319
355
|
compatibility behavior instead of a second permanent switch.
|
|
320
356
|
- Source import: optional-additional-properties defaults, environment grouping strategies,
|
|
321
|
-
discriminant removal,
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
discriminated-union inference, request-name disambiguation, and AsyncAPI message naming.
|
|
357
|
+
discriminant removal, forward-compatible inference, default environment inference, const
|
|
358
|
+
coercion, endpoint filters, example-depth controls, alias resolution, single-schema oneOf
|
|
359
|
+
preservation, read-variant responses, binary-response import coercion, form encoding defaults,
|
|
360
|
+
additional-properties defaults, and discriminated-union inference.
|
|
326
361
|
- TypeScript: linter/formatter selection, consolidated type files, subpackage exports, and endpoint
|
|
327
362
|
metadata.
|
|
328
363
|
- Python: ORM/smart-union/coercion/wrapped-alias/positional-constructor/inheritance/validator
|
|
329
|
-
switches, flattened union bodies,
|
|
330
|
-
transport.
|
|
364
|
+
switches, flattened union bodies, lazy imports, and custom transport.
|
|
331
365
|
- Java/JVM: JSON include, required-builder checks, public/extensible constructors, unknown-as-node,
|
|
332
366
|
nullable annotations, and custom interceptors.
|
|
333
367
|
- C#: union implementation switches, root-client access, generated error-type toggle, interceptor
|