@postman/sdk-config 0.2.0 → 0.3.1

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.
Files changed (28) hide show
  1. package/README.md +3 -2
  2. package/dist/index.cjs +82 -18
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.js +82 -18
  5. package/dist/index.js.map +1 -1
  6. package/dist/sdk-config/index.cjs +14 -12
  7. package/dist/sdk-config/index.cjs.map +1 -1
  8. package/dist/sdk-config/index.js +14 -12
  9. package/dist/sdk-config/index.js.map +1 -1
  10. package/dist/sdk-config/v1/index.cjs +14 -12
  11. package/dist/sdk-config/v1/index.cjs.map +1 -1
  12. package/dist/sdk-config/v1/index.d.cts +10 -10
  13. package/dist/sdk-config/v1/index.d.ts +10 -10
  14. package/dist/sdk-config/v1/index.js +14 -12
  15. package/dist/sdk-config/v1/index.js.map +1 -1
  16. package/dist/sdk-config-ir/index.cjs +70 -8
  17. package/dist/sdk-config-ir/index.cjs.map +1 -1
  18. package/dist/sdk-config-ir/index.js +70 -8
  19. package/dist/sdk-config-ir/index.js.map +1 -1
  20. package/dist/sdk-config-ir/v1/index.cjs +70 -8
  21. package/dist/sdk-config-ir/v1/index.cjs.map +1 -1
  22. package/dist/sdk-config-ir/v1/index.d.cts +440 -0
  23. package/dist/sdk-config-ir/v1/index.d.ts +440 -0
  24. package/dist/sdk-config-ir/v1/index.js +70 -8
  25. package/dist/sdk-config-ir/v1/index.js.map +1 -1
  26. package/package.json +1 -1
  27. package/src/sdk-config/v1/README.md +3 -3
  28. package/src/sdk-config-ir/v1/README.md +89 -82
package/src/sdk-config-ir/v1/README.md CHANGED
@@ -112,50 +112,52 @@ Translators are responsible for alias resolution, unit conversion, and inverted
112
112
 
113
113
  ## Postman `BuildParameters` migration map
114
114
 
115
- | Legacy field | SDK Config IR v1 | Notes |
116
- | ---------------------------------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------- |
117
- | `specUrl` | `source.specs[].specUrl` | A legacy request creates a one-element array. |
118
- | `languages[]` | `target.language` | Translators emit one IR request per target. |
119
- | `sdkName` | `target.sdkName` | Public SDK identity, not package registry identity. |
120
- | `sdkVersion` / language `sdkVersion` | `target.sdkVersion` | Language override is resolved before emitting IR. |
121
- | `apiVersion` | `target.apiVersion` | API version metadata. |
122
- | `org` | `target.organization` | Source organization metadata. |
123
- | `baseUrl` | `api.baseUrl` | Default API URL. |
124
- | `environments` | `api.environments` | Every environment has a non-empty `urls` array; a single URL becomes one entry. |
125
- | `environmentVariables` | `api.environmentVariables` | Declarations; auth/header fields reference them by name. |
126
- | `auth` + `authentication` | `api.auth` | Legacy flags and settings become typed schemes and requirements. |
127
- | `refreshToken` | `client.tokenRefresh` | Response keys map to `accessTokenField` and `refreshTokenField`. |
128
- | `retry` | `client.retry` | Millisecond units are explicit in normalized names. |
129
- | `responseHeaders` | `client.responseHeaders` | Shared across languages. |
130
- | `multiTenant` | `client.multiTenant` | Shared client behavior. |
131
- | TypeScript `httpClient` | `generation.language.typescript.httpClient` | Only `fetch` and `axios` are selectable; other languages use their generator transport. |
132
- | `additionalConstructorParameters` | `client.additionalConstructorParameters` | Merged from language options. |
133
- | `deliveryMethods` | `output.delivery` | Normalized to `files`, `zip`, or `github`; multiple deliveries produce separate IR requests. |
134
- | `fileOutput` | `output.path` or `output.fileName` | Depends on delivery type. |
135
- | `githubRef` | `output.github.branch` | Only meaningful for GitHub delivery. |
136
- | `privateRepo` | `output.github.privateRepository` | Only meaningful for GitHub delivery. |
137
- | `publishing.githubOrg` | `output.github.repository` | Translator combines the organization and repository name. |
138
- | package names and IDs | `package` | Includes npm/PyPI/NuGet/RubyGems/Crates/Composer names and Maven IDs. |
139
- | `goModuleName` | `package.modulePath` | Go publication and import identity. |
140
- | `license`, `authors`, `developers`, `homepage` | `package` | Manifest metadata. |
141
- | `documentation.url` | `docs.referenceBaseUrl` | Base URL for generated reference-file links. |
142
- | `documentation.snippets` | `docs.snippets` | `enabled` is explicit when the object is present. |
143
- | `docs[]` | `docs` | Legacy API/snippet selections are lowered to typed documentation settings. |
144
- | `includeWatermark` | `generation.includeWatermark` | Simple on/off behavior. |
145
- | `includeOptionalSnippetParameters` | `generation.includeOptionalSnippetParameters` | Simple on/off behavior. |
146
- | `inferServiceNames` | `generation.inferServiceNames` | Simple on/off behavior. |
147
- | `buildAllModels` | `generation.buildAllModels` | Simple on/off behavior. |
148
- | `deprecatedOperations.include` | `generation.includeDeprecatedOperations` | Simplified to a boolean. |
149
- | `multipleResponses.enabled` | `generation.multipleResponses` | Simplified to a boolean. |
150
- | `devContainer` | `generation.devContainer` | Simple on/off behavior. |
151
- | `ignoreFiles` / language `ignore` | `generation.ignoreFiles` | Language aliases are resolved by the translator. |
152
- | `reservedKeywords` | `generation.reservedKeywords` | Shared generator input. |
153
- | `hooks`, `hookDependencies`, `hooksLocation` | `generation.hooks` | Location and dependencies are one configurable feature. |
154
- | `customCode*`, previous artifact location | `generation.customCode` | Locations become typed generation assets. |
155
- | `workflow` | `generation.workflows[]` | The normalized shape supports more than one workflow. |
156
- | `customQueries` | `generation.customQueryPaths` | Query definitions are represented as paths. |
157
- | `analytics` | `generation.analytics` | `enabled` is explicit; timing fields use milliseconds. |
158
- | language options | `generation.language.<target>` or shared fields | Package, naming, validation, and dependency aliases are lifted out first. |
115
+ | Legacy field | SDK Config IR v1 | Notes |
116
+ | ---------------------------------------------- | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
117
+ | `specUrl` | `source.specs[].specUrl` | A legacy request creates a one-element array. |
118
+ | `languages[]` | `target.language` | Translators emit one IR request per target. |
119
+ | `sdkName` | `target.sdkName` | Public SDK identity, not package registry identity. |
120
+ | `sdkVersion` / language `sdkVersion` | `target.sdkVersion` | Language override is resolved before emitting IR. |
121
+ | `apiVersion` | `target.apiVersion` | API version metadata. |
122
+ | `org` | `target.organization` | Source organization metadata. |
123
+ | `baseUrl` | `api.baseUrl` | Default API URL. |
124
+ | `environments` | `api.environments` | Every environment has a non-empty `urls` array; a single URL becomes one entry. |
125
+ | `environmentVariables` | `api.environmentVariables` | Declarations; auth/header fields reference them by name. |
126
+ | `auth` + `authentication` | `api.auth` | Legacy flags and settings become typed schemes and requirements. |
127
+ | `refreshToken` | `client.tokenRefresh` | Response keys map to `accessTokenField` and `refreshTokenField`. |
128
+ | `retry` | `client.retry` | Millisecond units are explicit in normalized names. |
129
+ | `responseHeaders` | `client.responseHeaders` | Shared across languages. |
130
+ | `multiTenant` | `client.multiTenant` | Shared client behavior. |
131
+ | TypeScript `httpClient` | `generation.language.typescript.httpClient` | Only `fetch` and `axios` are selectable; other languages use their generator transport. |
132
+ | `additionalConstructorParameters` | `client.additionalConstructorParameters` | Merged from language options. |
133
+ | `deliveryMethods` | `output.delivery` | Normalized to `files`, `zip`, or `github`; multiple deliveries produce separate IR requests. |
134
+ | `fileOutput` | `output.path` or `output.fileName` | Depends on delivery type. |
135
+ | `githubRef` | `output.github.branch` | Only meaningful for GitHub delivery. |
136
+ | `privateRepo` | `output.github.privateRepository` | Only meaningful for GitHub delivery. |
137
+ | `publishing.githubOrg` | `output.github.repository` | Translator combines the organization and repository name. |
138
+ | package names and IDs | `package` | Includes npm/PyPI/NuGet/RubyGems/Crates/Composer names and Maven IDs. |
139
+ | `goModuleName` | `package.modulePath` | Go publication and import identity. |
140
+ | `license`, `authors`, `developers`, `homepage` | `package` | Manifest metadata. |
141
+ | TypeScript package privacy / JSR publication | `output.publish.isPackagePrivate` / `output.publish.publishToJsr` | NPM-specific publication options. |
142
+ | registry workflow and env-var settings | `output.publish` | Per-registry workflow toggles, credential env vars, and trusted publishing flags. |
143
+ | `documentation.url` | `docs.referenceBaseUrl` | Base URL for generated reference-file links. |
144
+ | `documentation.snippets` | `docs.snippets` | `enabled` is explicit when the object is present. |
145
+ | `docs[]` | `docs` | Legacy API/snippet selections are lowered to typed documentation settings. |
146
+ | `includeWatermark` | `generation.includeWatermark` | Simple on/off behavior. |
147
+ | `includeOptionalSnippetParameters` | `generation.includeOptionalSnippetParameters` | Simple on/off behavior. |
148
+ | `inferServiceNames` | `generation.inferServiceNames` | Simple on/off behavior. |
149
+ | `buildAllModels` | `generation.buildAllModels` | Simple on/off behavior. |
150
+ | `deprecatedOperations.include` | `generation.includeDeprecatedOperations` | Simplified to a boolean. |
151
+ | `multipleResponses.enabled` | `generation.multipleResponses` | Simplified to a boolean. |
152
+ | `devContainer` | `generation.devContainer` | Simple on/off behavior. |
153
+ | `ignoreFiles` / language `ignore` | `generation.ignoreFiles` | Language aliases are resolved by the translator. |
154
+ | `reservedKeywords` | `generation.reservedKeywords` | Shared generator input. |
155
+ | `hooks`, `hookDependencies`, `hooksLocation` | `generation.hooks` | Location and dependencies are one configurable feature. |
156
+ | `customCode*`, previous artifact location | `generation.customCode` | Locations become typed generation assets. |
157
+ | `workflow` | `generation.workflows[]` | The normalized shape supports more than one workflow. |
158
+ | `customQueries` | `generation.customQueryPaths` | Query definitions are represented as paths. |
159
+ | `analytics` | `generation.analytics` | `enabled` is explicit; timing fields use milliseconds. |
160
+ | language options | `generation.language.<target>` or shared fields | Package, naming, validation, and dependency aliases are lifted out first. |
159
161
 
160
162
  ### Postman language-option migration map
161
163
 
@@ -193,44 +195,49 @@ inputs were not restored as part of the normalized contract.
193
195
  Customer-use counts below are distinct projects observed in the 61-project configuration snapshot
194
196
  audited on 2026-07-17. Counts guide the initial contract; they are not a permanent support policy.
195
197
 
196
- | Fern field or aliases | SDK Config IR v1 | Observed projects |
197
- | --------------------------------------------------------------------------- | -------------------------------------------------- | -----------------------------------------: |
198
- | `api.specs[]` | `source.specs[]` | 53 OpenAPI, 3 AsyncAPI |
199
- | `api.specs[].namespace` | `source.specs[].namespace` | 1 |
200
- | `api.specs[].overlays` | `source.specs[].overlays` | 2 |
201
- | `api.specs[].overrides` | `source.specs[].overrides` | 39 |
202
- | `api.default-url` | `api.baseUrl` | 21 |
203
- | `api.default-environment` | `api.defaultEnvironment` | 22 |
204
- | `api.environments` | `api.environments` | 20+ |
205
- | `api.auth`, `api.auth-schemes` | `api.auth` | 27 |
206
- | `api.headers` | `api.headers` | 11+ |
207
- | generator-group `audiences` | `api.audiences` | Absent selects all audiences. |
208
- | generator `inlinePathParameters`, `inline-path-parameters`, and API setting | `client.pathParameterStyle` | 12 API; 1-3 per language |
209
- | generator `inlineFileProperties`, `inline-file-properties` | `client.filePropertyStyle` | 1-3 per language |
210
- | `inline_request_params` | `client.requestParameterStyle` | 6 Python |
211
- | `customPagerName`, `custom-pager-name`, `custom_pager_name` | `generation.naming.pagerName` | 2-5 per language |
212
- | `smart-casing`, `smart-casing-digit-word-boundary` | `generation.naming` | Preserved only when explicitly set. |
213
- | timeout aliases in seconds or milliseconds | `client.timeoutMs` | Translator converts units. |
214
- | `skipResponseValidation`, Python `skip_validation` | `client.responseValidation` | Inverted; 12 TS, 8 Python |
215
- | `useDefaultRequestParameterValues` aliases | `client.useDefaultRequestParameterValues` | 1 |
216
- | `respectOptionalRequestBody`, `respect-optional-request-body` | `client.respectOptionalRequestBody` | Not in the project snapshot; see below |
217
- | `enable-wire-tests`, `enableWireTests`, `generateWireTests` | `generation.wireTests` | 1-15 per language |
218
- | WebSocket generation aliases | `generation.webSockets` | 3 TS, 3 Python |
219
- | `streamType`, `fileResponseType` | `generation.streams` | 1 TS |
220
- | client/exported/environment class aliases | `generation.naming` | 1-28 per language |
221
- | base API/general exception class aliases | `generation.naming.apiErrorName` / `baseErrorName` | 3-6 Java/C# |
222
- | namespace/package-prefix aliases | `package.namespace` | 1-30 per language |
223
- | output registry package names | `package.packageName` | 5-28 per registry language |
224
- | Python custom `package_name` | `package.moduleName` | 18 |
225
- | Go `module.path` | `package.modulePath` | 3 |
226
- | Maven `group` / `artifact` | `package.groupId` / `artifactId` | 7 |
227
- | custom/extra dependencies | `package.extraDependencies` and related lists | Multiple languages |
228
- | local output | `output.delivery: "files"` | 49+ |
229
- | registry output | `output.publish` plus `package` identity | 5-28 per registry language |
230
- | GitHub output | `output.delivery: "github"` and `output.github` | Translator resolves Fern owner/repo forms. |
231
- | Fern README config | `docs.readme` | 12 API names; 11 disabled-section configs |
232
- | `customReadmeSections` | `docs.readme.customSections` | Not in the project snapshot; see below |
233
- | `includeApiReference` | `docs.includeApiReference` | 10 TS |
198
+ | Fern field or aliases | SDK Config IR v1 | Observed projects |
199
+ | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -----------------------------------------: |
200
+ | `api.specs[]` | `source.specs[]` | 53 OpenAPI, 3 AsyncAPI |
201
+ | `api.specs[].namespace` | `source.specs[].namespace` | 1 |
202
+ | `api.specs[].overlays` | `source.specs[].overlays` | 2 |
203
+ | `api.specs[].overrides` | `source.specs[].overrides` | 39 |
204
+ | `api.default-url` | `api.baseUrl` | 21 |
205
+ | `api.default-environment` | `api.defaultEnvironment` | 22 |
206
+ | `api.environments` | `api.environments` | 20+ |
207
+ | `api.auth`, `api.auth-schemes` | `api.auth` | 27 |
208
+ | `api.headers` | `api.headers` | 11+ |
209
+ | generator-group `audiences` | `api.audiences` | Absent selects all audiences. |
210
+ | generator `inlinePathParameters`, `inline-path-parameters`, and API setting | `client.pathParameterStyle` | 12 API; 1-3 per language |
211
+ | generator `inlineFileProperties`, `inline-file-properties` | `client.filePropertyStyle` | 1-3 per language |
212
+ | `inline_request_params` | `client.requestParameterStyle` | 6 Python |
213
+ | `customPagerName`, `custom-pager-name`, `custom_pager_name` | `generation.naming.pagerName` | 2-5 per language |
214
+ | `smart-casing`, `smart-casing-digit-word-boundary` | `generation.naming` | Preserved only when explicitly set. |
215
+ | timeout aliases in seconds or milliseconds | `client.timeoutMs` | Translator converts units. |
216
+ | `skipResponseValidation`, Python `skip_validation` | `client.responseValidation` | Inverted; 12 TS, 8 Python |
217
+ | `useDefaultRequestParameterValues` aliases | `client.useDefaultRequestParameterValues` | 1 |
218
+ | `respectOptionalRequestBody`, `respect-optional-request-body` | `client.respectOptionalRequestBody` | Not in the project snapshot; see below |
219
+ | `enable-wire-tests`, `enableWireTests`, `generateWireTests` | `generation.wireTests` | 1-15 per language |
220
+ | WebSocket generation aliases | `generation.webSockets` | 3 TS, 3 Python |
221
+ | `streamType`, `fileResponseType` | `generation.streams` | 1 TS |
222
+ | client/exported/environment class aliases | `generation.naming` | 1-28 per language |
223
+ | base API/general exception class aliases | `generation.naming.apiErrorName` / `generation.naming.baseErrorName` | 3-6 Java/C# |
224
+ | namespace/package-prefix aliases | `package.namespace` | 1-30 per language |
225
+ | output registry package names | `package.packageName` | 5-28 per registry language |
226
+ | Python custom `package_name` | `package.moduleName` | 18 |
227
+ | Go `module.path` | `package.modulePath` | 3 |
228
+ | Maven `group` / `artifact` | `package.groupId` / `package.artifactId` | 7 |
229
+ | custom/extra dependencies | `package.extraDependencies` and related lists | Multiple languages |
230
+ | local output | `output.delivery: "files"` | 49+ |
231
+ | registry output | `output.publish` plus `package` identity | 5-28 per registry language |
232
+ | GitHub output | `output.delivery: "github"` and `output.github` | Translator resolves Fern owner/repo forms. |
233
+ | npm package privacy and JSR publication | `output.publish.isPackagePrivate` / `output.publish.publishToJsr` | NPM-only booleans |
234
+ | registry version and workflow gate | `output.publish.version` / `output.publish.shouldGeneratePublishWorkflow` | Per-registry controls |
235
+ | registry credential environment variables | `output.publish.*EnvironmentVariable` | Registry-specific env-var names |
236
+ | trusted publishing / OIDC markers | `output.publish.trustedPublishing` | npm, PyPI, and NuGet |
237
+ | Maven coordinate and signing env vars | `output.publish.coordinate` / `output.publish.signatureEnvironmentVariables` | Maven-specific |
238
+ | Fern README config | `docs.readme` | 12 API names; 11 disabled-section configs |
239
+ | `customReadmeSections` | `docs.readme.customSections` | Not in the project snapshot; see below |
240
+ | `includeApiReference` | `docs.includeApiReference` | 10 TS |
234
241
 
235
242
  The Rust language config was added after the initial audit. That audit compared existing Fern
236
243
  _customer projects_, which surfaced no Rust-specific options; comparing the Fern Rust generator's