@postman/sdk-config 0.7.0 → 0.9.0

package/dist/{typescript-BdDv_kwT.d.cts → typescript-Chge0X4f.d.cts}

@@ -292,9 +292,9 @@ declare const pythonGenerationConfigSchema: z.ZodObject<{
     pydanticVersion: z.ZodOptional<z.ZodString>;
     pydantic: z.ZodOptional<z.ZodObject<{
         versionCompatibility: z.ZodOptional<z.ZodEnum<{
-            both: "both";
             v1: "v1";
             v2: "v2";
+            both: "both";
             "v1-on-v2": "v1-on-v2";
         }>>;
         frozen: z.ZodOptional<z.ZodBoolean>;
@@ -419,7 +419,6 @@ declare const typescriptGenerationConfigSchema: z.ZodObject<{
         pnpm: "pnpm";
         yarn: "yarn";
     }>>;
-    /** e.g. `1.22.22` — from the customer's own `config.packageJson.packageManager` (`yarn@1.22.22`). */
     packageManagerVersion: z.ZodOptional<z.ZodString>;
     testFramework: z.ZodOptional<z.ZodEnum<{
         jest: "jest";

package/dist/{typescript-BdDv_kwT.d.ts → typescript-Chge0X4f.d.ts}

@@ -292,9 +292,9 @@ declare const pythonGenerationConfigSchema: z.ZodObject<{
     pydanticVersion: z.ZodOptional<z.ZodString>;
     pydantic: z.ZodOptional<z.ZodObject<{
         versionCompatibility: z.ZodOptional<z.ZodEnum<{
-            both: "both";
             v1: "v1";
             v2: "v2";
+            both: "both";
             "v1-on-v2": "v1-on-v2";
         }>>;
         frozen: z.ZodOptional<z.ZodBoolean>;
@@ -419,7 +419,6 @@ declare const typescriptGenerationConfigSchema: z.ZodObject<{
         pnpm: "pnpm";
         yarn: "yarn";
     }>>;
-    /** e.g. `1.22.22` — from the customer's own `config.packageJson.packageManager` (`yarn@1.22.22`). */
     packageManagerVersion: z.ZodOptional<z.ZodString>;
     testFramework: z.ZodOptional<z.ZodEnum<{
         jest: "jest";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postman/sdk-config",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Shared SDK configuration contracts and transformations for Postman SDK generation",
   "license": "UNLICENSED",
   "sideEffects": false,

package/src/sdk-config/v1/README.md

@@ -63,8 +63,9 @@ severity, reason, suggested manual action, and the SDK Config destination when o
 cases. Generation must not recover omitted values from legacy configuration. Differing
 target-specific values are retained as sparse target overrides when the public shape can represent
 them. Optional `api` enrichment may be supplied after Fern's definition or IR has already been
-lowered into the public API shape. Credentials and signing material are preserved in SDK Config
-output blocks when present; callers must treat these fields as sensitive secrets.
+lowered into the public API shape. Supported registry credentials, signing material, and GitHub
+credentials are preserved in SDK Config when present; callers must treat these fields as sensitive
+secrets.
 
 ## Contract boundaries
 
@@ -88,12 +89,14 @@ server-generated artifact metadata are not valid public locators. The public sch
 no `compatibility`, source-origin, artifact ID, credential-resolution, or server-generated
 publishing control fields. Supported registry credentials are flat fields selected by the `registry`
 discriminator: npm and crates accept `token`, PyPI and Maven accept `username` and `password`, and
-Maven accepts a complete `signature` containing `keyId`, `password`, and `secretKey`. Use environment
-expressions such as `${NPM_TOKEN}` for every credential rather than literal values. Unknown fields
-are rejected at every object boundary. Fern migration copies credential fields only when their raw
-`generators.yml` values are exact environment expressions. It never treats normalized or resolved
-output as credential provenance; literals and untraceable values are omitted with credential-safe
-warnings. Portable API, client, documentation, package, source settings, and language field schemas
+Maven accepts a complete `signature` containing `keyId`, `password`, and `secretKey`. GitHub delivery
+accepts a `credentials` object containing `username`, `password`, `token`, or `apiKey`. Use
+environment expressions such as `${NPM_TOKEN}` for every credential rather than literal values.
+Unknown fields are rejected at every object boundary. Fern migration copies credential fields only
+when their raw `generators.yml` values are exact environment expressions. It never treats normalized
+or resolved output as credential provenance; literals and untraceable values are omitted with
+credential-safe warnings. Portable API, client, documentation, package, source settings, and
+language field schemas
 come from a neutral shared domain layer to prevent drift; the public and internal envelopes and
 their operational extensions remain separate explicit allowlists.
 
@@ -117,8 +120,6 @@ segments. Absolute paths and `..` traversal are rejected at validation time.
   "output": { "delivery": "zip" },
   "replay": { "enabled": false },
   "generation": {
-    "includeWatermark": true,
-    "generateFullProject": false,
     "naming": { "smartCasing": true, "smartCasingDigitWordBoundary": false }
   },
   "targets": [
@@ -213,10 +214,10 @@ while an explicitly supplied array replaces the inherited array.
 
 An integration may also supply operational values at generation time. Those request values take
 precedence over the persisted SDK Config for fields the integration exposes, such as SDK name,
-SDK version, API version, package settings, generator version, output intent, and package-building
-requests such as `generation.generateFullProject`. The SDK Config continues to provide every field
-that the request does not override. Schema/domain defaults are applied only after this merge, when
-the single-target `SdkConfigIrV1` is parsed.
+SDK version, API version, package settings, generator version, and output intent. Operational
+packaging controls remain on the generation request rather than in the customer-authored SDK
+Config. Schema/domain defaults are applied only after this merge, when the single-target
+`SdkConfigIrV1` is parsed.
 
 Package publication requirements are validated after applying package and output precedence. For
 example, a TypeScript target publishing to npm may inherit a root `packageName`, while a Python

package/src/sdk-config-ir/v1/README.md

@@ -226,6 +226,9 @@ audited on 2026-07-17. Counts guide the initial contract; they are not a permane
 | `skipResponseValidation`, Python `pydantic_config.skip_validation`          | `client.responseValidation`                                                                               |                  Inverted; 12 TS, 8 Python |
 | `useDefaultRequestParameterValues` aliases                                  | `client.useDefaultRequestParameterValues`                                                                 |                                          1 |
 | `respectOptionalRequestBody`, `respect-optional-request-body`               | `client.respectOptionalRequestBody`                                                                       |     Not in the project snapshot; see below |
+| `auto-generate-idempotency-key`, API-wide setting                           | `client.idempotencyKeyGeneration`                                                                         |     Not in the project snapshot; see below |
+| `user-agent`, `includePlatformHeaders`, `allowUserAgentAppInfo`             | `client.userAgent`                                                                                        |     Not in the project snapshot; see below |
+| `offsetSemantics`                                                           | `client.offsetSemantics`                                                                                  |     Not in the project snapshot; see below |
 | `enable-wire-tests`, `enableWireTests`, `generateWireTests`                 | `generation.wireTests`                                                                                    |                          1-15 per language |
 | WebSocket generation aliases                                                | `generation.webSockets`                                                                                   |                             3 TS, 3 Python |
 | `streamType`, `fileResponseType`                                            | `generation.streams`                                                                                      |                                       1 TS |
@@ -273,6 +276,16 @@ enabling it changes the signature of every endpoint whose body the API declares
 absent must keep an existing SDK's signatures rather than assert a value the generator would then
 have to honour.
 
+`client.idempotencyKeyGeneration`, `client.userAgent` and `client.offsetSemantics` come from the
+Fern PHP configuration page and also postdate the snapshot. Fern's `auto-generate-idempotency-key` is
+`true`, `false`, or an object of `header-name` and `methods` (which enables it); `enabled` is always
+explicit, so a generator's `false` can opt out of the API-wide `api.settings` value, which the
+translator reads from the resolved `idempotencyKeyGenerationConfig` when the generator sets none. An
+object the translator cannot fully read is reported rather than enabled with defaults. The User-Agent
+options are grouped because they describe one header: `template` is Fern's `user-agent`,
+`includePlatformInfo` is `includePlatformHeaders`, and `allowAppInfo` is `allowUserAgentAppInfo`.
+All three stay undefaulted, for the same reason as `respectOptionalRequestBody`.
+
 Fern README endpoint strings such as `GET /users` are parsed into
 `{ "method": "GET", "path": "/users" }`; the legacy string shorthand is not part of the
 normalized contract.
@@ -337,19 +350,19 @@ project's OpenAPI specs carry it too and are refused for it.
 
 Only options that remain language-specific stay in `generation.language`.
 
-| Language    | Fern fields retained in language config                                                                                                                                                              | Shared mappings lifted out                                                                                                               |
-| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| 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                                   |
-| 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 |
-| 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                           |
-| 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                                   |
-| 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                                                                          |
-| PHP         | Property access (2) and generated client interfaces (1)                                                                                                                                              | Composer identity, namespace, client/pager names, request style, dependencies, wire tests                                                |
-| Ruby        | Require paths (2)                                                                                                                                                                                    | Gem identity, client name, dependencies, pager, wire tests                                                                               |
-| Rust        | Datetime representation, initialism casing, and Cargo features/default-features                                                                                                                      | Crate identity, client name, and package metadata use shared fields.                                                                     |
-| Swift       | Module name and the nullable-as-optional collapse                                                                                                                                                    | Client, environment and error naming use shared fields.                                                                                  |
-| CLI         | Pagination parameter names and the `skills` boolean                                                                                                                                                  | Go module and package identity use `package`.                                                                                            |
-| MCP         | Server identity, availability exclusions, tool filters and named toolsets, plus the TypeScript options                                                                                               | npm package identity, client and serialization behavior                                                                                  |
+| Language    | Fern fields retained in language config                                                                                                                                                              | Shared mappings lifted out                                                                                                                |
+| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| 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                                    |
+| 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  |
+| 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                            |
+| 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                                    |
+| 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                                                                           |
+| PHP         | Property access (2) and generated client interfaces (1)                                                                                                                                              | Composer identity, namespace, client/pager names, request style, dependencies, wire tests, idempotency keys, User-Agent, offset semantics |
+| Ruby        | Require paths (2)                                                                                                                                                                                    | Gem identity, client name, dependencies, pager, wire tests                                                                                |
+| Rust        | Datetime representation, initialism casing, and Cargo features/default-features                                                                                                                      | Crate identity, client name, and package metadata use shared fields.                                                                      |
+| Swift       | Module name and the nullable-as-optional collapse                                                                                                                                                    | Client, environment and error naming use shared fields.                                                                                   |
+| CLI         | Pagination parameter names and the `skills` boolean                                                                                                                                                  | Go module and package identity use `package`.                                                                                             |
+| MCP         | Server identity, availability exclusions, tool filters and named toolsets, plus the TypeScript options                                                                                               | npm package identity, client and serialization behavior                                                                                   |
 
 ## Removed and deferred legacy configuration
 
@@ -359,8 +372,9 @@ the migration.
 
 ### Removed after finding no customer use and no sdk-gen-core equivalent
 
-- Common Fern generation: include/omit platform-header overrides. Output-profile defaults own this
-  compatibility behavior instead of a second permanent switch.
+- Common Fern generation: the omit platform-header override (`omitFernHeaders`). Output-profile
+  defaults own this compatibility behavior instead of a second permanent switch. The include side
+  was re-added as `client.userAgent.includePlatformInfo` once the Fern PHP generator documented it.
 - Source import: optional-additional-properties defaults, environment grouping strategies,
   discriminant removal, forward-compatible inference, default environment inference, const
   coercion, endpoint filters, example-depth controls, alias resolution, single-schema oneOf