@postman/sdk-config 0.21.0 → 0.23.0

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 (35) hide show
  1. package/dist/index.cjs +196 -253
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.d.cts +1 -1
  4. package/dist/index.d.ts +1 -1
  5. package/dist/index.js +196 -254
  6. package/dist/index.js.map +1 -1
  7. package/dist/sdk-config/index.cjs +195 -253
  8. package/dist/sdk-config/index.cjs.map +1 -1
  9. package/dist/sdk-config/index.d.cts +1 -1
  10. package/dist/sdk-config/index.d.ts +1 -1
  11. package/dist/sdk-config/index.js +195 -253
  12. package/dist/sdk-config/index.js.map +1 -1
  13. package/dist/sdk-config/v1/index.cjs +195 -253
  14. package/dist/sdk-config/v1/index.cjs.map +1 -1
  15. package/dist/sdk-config/v1/index.d.cts +20 -767
  16. package/dist/sdk-config/v1/index.d.ts +20 -767
  17. package/dist/sdk-config/v1/index.js +195 -253
  18. package/dist/sdk-config/v1/index.js.map +1 -1
  19. package/dist/sdk-config-ir/index.cjs +26 -150
  20. package/dist/sdk-config-ir/index.cjs.map +1 -1
  21. package/dist/sdk-config-ir/index.d.cts +1 -1
  22. package/dist/sdk-config-ir/index.d.ts +1 -1
  23. package/dist/sdk-config-ir/index.js +26 -151
  24. package/dist/sdk-config-ir/index.js.map +1 -1
  25. package/dist/sdk-config-ir/v1/index.cjs +26 -150
  26. package/dist/sdk-config-ir/v1/index.cjs.map +1 -1
  27. package/dist/sdk-config-ir/v1/index.d.cts +29 -446
  28. package/dist/sdk-config-ir/v1/index.d.ts +29 -446
  29. package/dist/sdk-config-ir/v1/index.js +26 -151
  30. package/dist/sdk-config-ir/v1/index.js.map +1 -1
  31. package/dist/{typescript-DNic6Rq5.d.cts → typescript-ZRqfOhMd.d.cts} +23 -21
  32. package/dist/{typescript-DNic6Rq5.d.ts → typescript-ZRqfOhMd.d.ts} +23 -21
  33. package/package.json +1 -1
  34. package/src/sdk-config/v1/README.md +12 -24
  35. package/src/sdk-config-ir/v1/README.md +0 -39
@@ -195,9 +195,6 @@ declare const profilesProvisionOperationSchema: z.ZodObject<{
195
195
  operation: z.ZodString;
196
196
  credential: z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>;
197
197
  revokeParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
198
- flag: z.ZodOptional<z.ZodString>;
199
- parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
200
- profileParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
201
198
  }, z.core.$strict>;
202
199
  declare const profilesConfigSchema: z.ZodObject<{
203
200
  enabled: z.ZodBoolean;
@@ -207,9 +204,6 @@ declare const profilesConfigSchema: z.ZodObject<{
207
204
  operation: z.ZodString;
208
205
  credential: z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>;
209
206
  revokeParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
210
- flag: z.ZodOptional<z.ZodString>;
211
- parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
212
- profileParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
213
207
  }, z.core.$strict>>;
214
208
  }, z.core.$strict>;
215
209
  declare const oauthTokenEndpointsSchema: z.ZodObject<{
@@ -266,24 +260,10 @@ declare const cliGenerationConfigSchema: z.ZodObject<{
266
260
  operation: z.ZodString;
267
261
  credential: z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>;
268
262
  revokeParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
269
- flag: z.ZodOptional<z.ZodString>;
270
- parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
271
- profileParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
272
263
  }, z.core.$strict>>;
273
264
  }, z.core.$strict>>;
274
265
  splitTypeCrates: z.ZodOptional<z.ZodBoolean>;
275
266
  userAgentSuffixFlag: z.ZodOptional<z.ZodString>;
276
- banner: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
277
- text: z.ZodString;
278
- colors: z.ZodOptional<z.ZodArray<z.ZodString>>;
279
- lineColors: z.ZodOptional<z.ZodArray<z.ZodString>>;
280
- direction: z.ZodOptional<z.ZodEnum<{
281
- horizontal: "horizontal";
282
- vertical: "vertical";
283
- diagonal: "diagonal";
284
- }>>;
285
- animate: z.ZodOptional<z.ZodBoolean>;
286
- }, z.core.$strict>]>>;
287
267
  oauthTokenEndpoints: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
288
268
  token: z.ZodOptional<z.ZodObject<{
289
269
  requestProperties: z.ZodOptional<z.ZodObject<{
@@ -386,6 +366,17 @@ declare const mcpToolFilterSchema: z.ZodObject<{
386
366
  include: z.ZodOptional<z.ZodArray<z.ZodString>>;
387
367
  exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
388
368
  }, z.core.$strict>;
369
+ /** MCP tool-name pattern, shared by the schema and the Fern config mapper so they can't drift. */
370
+ declare const MCP_TOOL_NAME_PATTERN: RegExp;
371
+ declare const mcpMergedToolSchema: z.ZodObject<{
372
+ include: z.ZodOptional<z.ZodArray<z.ZodString>>;
373
+ exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
374
+ dispatchOn: z.ZodString;
375
+ description: z.ZodOptional<z.ZodString>;
376
+ }, z.core.$strict>;
377
+ declare const mcpCustomToolSchema: z.ZodObject<{
378
+ path: z.ZodString;
379
+ }, z.core.$strict>;
389
380
  declare const mcpGenerationConfigSchema: z.ZodObject<{
390
381
  typescriptVersion: z.ZodOptional<z.ZodString>;
391
382
  zodVersion: z.ZodOptional<z.ZodString>;
@@ -477,9 +468,20 @@ declare const mcpGenerationConfigSchema: z.ZodObject<{
477
468
  include: z.ZodOptional<z.ZodArray<z.ZodString>>;
478
469
  exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
479
470
  }, z.core.$strict>>>;
471
+ mergedTools: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
472
+ include: z.ZodOptional<z.ZodArray<z.ZodString>>;
473
+ exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
474
+ dispatchOn: z.ZodString;
475
+ description: z.ZodOptional<z.ZodString>;
476
+ }, z.core.$strict>>>;
477
+ customTools: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
478
+ path: z.ZodString;
479
+ }, z.core.$strict>>>;
480
480
  }, z.core.$strict>;
481
481
  type McpAvailabilityStatus = (typeof mcpAvailabilityStatuses)[number];
482
482
  type McpToolFilter = z.infer<typeof mcpToolFilterSchema>;
483
+ type McpMergedTool = z.infer<typeof mcpMergedToolSchema>;
484
+ type McpCustomTool = z.infer<typeof mcpCustomToolSchema>;
483
485
  type McpGenerationConfig = z.infer<typeof mcpGenerationConfigSchema>;
484
486
 
485
487
  declare const phpGenerationConfigSchema: z.ZodObject<{
@@ -682,4 +684,4 @@ declare const typescriptGenerationConfigSchema: z.ZodObject<{
682
684
  }, z.core.$strict>;
683
685
  type TypescriptGenerationConfig = z.infer<typeof typescriptGenerationConfigSchema>;
684
686
 
685
- export { relativePathSchema as $, dependencySchema as A, exactSemverSchema as B, CLI_DISTRIBUTION_NON_RELEASE_MODE_CODE as C, type Dependency as D, githubActionsSecretNameSchema as E, goGenerationConfigSchema as F, type GoGenerationConfig as G, goModulePathSchema as H, javaGenerationConfigSchema as I, type JavaGenerationConfig as J, type KotlinGenerationConfig as K, jsonObjectSchema as L, type McpAvailabilityStatus as M, jsonValueSchema as N, kotlinGenerationConfigSchema as O, type PackageConfig as P, mcpAvailabilityStatuses as Q, type RubyGenerationConfig as R, type SdkConfigDiagnostic as S, type TerraformGenerationConfig as T, mcpGenerationConfigSchema as U, nonEmptyStringSchema as V, oauthTokenEndpointsIssues as W, packageConfigSchema as X, parentRelativePathSchema as Y, phpGenerationConfigSchema as Z, pythonGenerationConfigSchema as _, type CliDistributionConfig as a, rubyGenerationConfigSchema as a0, rustGenerationConfigSchema as a1, swiftGenerationConfigSchema as a2, terraformGenerationConfigSchema as a3, typescriptGenerationConfigSchema as a4, type CliDistributionGithubAppConfig as b, type CliDistributionHomebrewConfig as c, type CliDistributionScoopConfig as d, type CliGenerationConfig as e, type CliOAuthTokenEndpoints as f, type CliProfilesConfig as g, type CliProfilesProvisionOperation as h, type CsharpGenerationConfig as i, type JsonObject as j, type JsonValue as k, type McpGenerationConfig as l, type McpToolFilter as m, type PhpGenerationConfig as n, type PlanModifiers as o, type PythonGenerationConfig as p, type RustGenerationConfig as q, type SwiftGenerationConfig as r, type TypescriptGenerationConfig as s, cliDistributionConfigSchema as t, cliDistributionGithubAppSchema as u, cliDistributionHomebrewSchema as v, cliDistributionScoopSchema as w, cliGenerationConfigSchema as x, composerPackageNameSchema as y, csharpGenerationConfigSchema as z };
687
+ export { parentRelativePathSchema as $, cliGenerationConfigSchema as A, composerPackageNameSchema as B, CLI_DISTRIBUTION_NON_RELEASE_MODE_CODE as C, type Dependency as D, csharpGenerationConfigSchema as E, dependencySchema as F, type GoGenerationConfig as G, exactSemverSchema as H, githubActionsSecretNameSchema as I, type JavaGenerationConfig as J, type KotlinGenerationConfig as K, goGenerationConfigSchema as L, MCP_TOOL_NAME_PATTERN as M, goModulePathSchema as N, javaGenerationConfigSchema as O, type PackageConfig as P, jsonObjectSchema as Q, type RubyGenerationConfig as R, type SdkConfigDiagnostic as S, type TerraformGenerationConfig as T, jsonValueSchema as U, kotlinGenerationConfigSchema as V, mcpAvailabilityStatuses as W, mcpGenerationConfigSchema as X, nonEmptyStringSchema as Y, oauthTokenEndpointsIssues as Z, packageConfigSchema as _, type CliDistributionConfig as a, phpGenerationConfigSchema as a0, pythonGenerationConfigSchema as a1, relativePathSchema as a2, rubyGenerationConfigSchema as a3, rustGenerationConfigSchema as a4, swiftGenerationConfigSchema as a5, terraformGenerationConfigSchema as a6, typescriptGenerationConfigSchema as a7, type CliDistributionGithubAppConfig as b, type CliDistributionHomebrewConfig as c, type CliDistributionScoopConfig as d, type CliGenerationConfig as e, type CliOAuthTokenEndpoints as f, type CliProfilesConfig as g, type CliProfilesProvisionOperation as h, type CsharpGenerationConfig as i, type JsonObject as j, type JsonValue as k, type McpAvailabilityStatus as l, type McpCustomTool as m, type McpGenerationConfig as n, type McpMergedTool as o, type McpToolFilter as p, type PhpGenerationConfig as q, type PlanModifiers as r, type PythonGenerationConfig as s, type RustGenerationConfig as t, type SwiftGenerationConfig as u, type TypescriptGenerationConfig as v, cliDistributionConfigSchema as w, cliDistributionGithubAppSchema as x, cliDistributionHomebrewSchema as y, cliDistributionScoopSchema as z };
@@ -195,9 +195,6 @@ declare const profilesProvisionOperationSchema: z.ZodObject<{
195
195
  operation: z.ZodString;
196
196
  credential: z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>;
197
197
  revokeParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
198
- flag: z.ZodOptional<z.ZodString>;
199
- parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
200
- profileParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
201
198
  }, z.core.$strict>;
202
199
  declare const profilesConfigSchema: z.ZodObject<{
203
200
  enabled: z.ZodBoolean;
@@ -207,9 +204,6 @@ declare const profilesConfigSchema: z.ZodObject<{
207
204
  operation: z.ZodString;
208
205
  credential: z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>;
209
206
  revokeParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
210
- flag: z.ZodOptional<z.ZodString>;
211
- parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
212
- profileParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
213
207
  }, z.core.$strict>>;
214
208
  }, z.core.$strict>;
215
209
  declare const oauthTokenEndpointsSchema: z.ZodObject<{
@@ -266,24 +260,10 @@ declare const cliGenerationConfigSchema: z.ZodObject<{
266
260
  operation: z.ZodString;
267
261
  credential: z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>;
268
262
  revokeParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
269
- flag: z.ZodOptional<z.ZodString>;
270
- parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
271
- profileParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
272
263
  }, z.core.$strict>>;
273
264
  }, z.core.$strict>>;
274
265
  splitTypeCrates: z.ZodOptional<z.ZodBoolean>;
275
266
  userAgentSuffixFlag: z.ZodOptional<z.ZodString>;
276
- banner: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
277
- text: z.ZodString;
278
- colors: z.ZodOptional<z.ZodArray<z.ZodString>>;
279
- lineColors: z.ZodOptional<z.ZodArray<z.ZodString>>;
280
- direction: z.ZodOptional<z.ZodEnum<{
281
- horizontal: "horizontal";
282
- vertical: "vertical";
283
- diagonal: "diagonal";
284
- }>>;
285
- animate: z.ZodOptional<z.ZodBoolean>;
286
- }, z.core.$strict>]>>;
287
267
  oauthTokenEndpoints: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
288
268
  token: z.ZodOptional<z.ZodObject<{
289
269
  requestProperties: z.ZodOptional<z.ZodObject<{
@@ -386,6 +366,17 @@ declare const mcpToolFilterSchema: z.ZodObject<{
386
366
  include: z.ZodOptional<z.ZodArray<z.ZodString>>;
387
367
  exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
388
368
  }, z.core.$strict>;
369
+ /** MCP tool-name pattern, shared by the schema and the Fern config mapper so they can't drift. */
370
+ declare const MCP_TOOL_NAME_PATTERN: RegExp;
371
+ declare const mcpMergedToolSchema: z.ZodObject<{
372
+ include: z.ZodOptional<z.ZodArray<z.ZodString>>;
373
+ exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
374
+ dispatchOn: z.ZodString;
375
+ description: z.ZodOptional<z.ZodString>;
376
+ }, z.core.$strict>;
377
+ declare const mcpCustomToolSchema: z.ZodObject<{
378
+ path: z.ZodString;
379
+ }, z.core.$strict>;
389
380
  declare const mcpGenerationConfigSchema: z.ZodObject<{
390
381
  typescriptVersion: z.ZodOptional<z.ZodString>;
391
382
  zodVersion: z.ZodOptional<z.ZodString>;
@@ -477,9 +468,20 @@ declare const mcpGenerationConfigSchema: z.ZodObject<{
477
468
  include: z.ZodOptional<z.ZodArray<z.ZodString>>;
478
469
  exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
479
470
  }, z.core.$strict>>>;
471
+ mergedTools: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
472
+ include: z.ZodOptional<z.ZodArray<z.ZodString>>;
473
+ exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
474
+ dispatchOn: z.ZodString;
475
+ description: z.ZodOptional<z.ZodString>;
476
+ }, z.core.$strict>>>;
477
+ customTools: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
478
+ path: z.ZodString;
479
+ }, z.core.$strict>>>;
480
480
  }, z.core.$strict>;
481
481
  type McpAvailabilityStatus = (typeof mcpAvailabilityStatuses)[number];
482
482
  type McpToolFilter = z.infer<typeof mcpToolFilterSchema>;
483
+ type McpMergedTool = z.infer<typeof mcpMergedToolSchema>;
484
+ type McpCustomTool = z.infer<typeof mcpCustomToolSchema>;
483
485
  type McpGenerationConfig = z.infer<typeof mcpGenerationConfigSchema>;
484
486
 
485
487
  declare const phpGenerationConfigSchema: z.ZodObject<{
@@ -682,4 +684,4 @@ declare const typescriptGenerationConfigSchema: z.ZodObject<{
682
684
  }, z.core.$strict>;
683
685
  type TypescriptGenerationConfig = z.infer<typeof typescriptGenerationConfigSchema>;
684
686
 
685
- export { relativePathSchema as $, dependencySchema as A, exactSemverSchema as B, CLI_DISTRIBUTION_NON_RELEASE_MODE_CODE as C, type Dependency as D, githubActionsSecretNameSchema as E, goGenerationConfigSchema as F, type GoGenerationConfig as G, goModulePathSchema as H, javaGenerationConfigSchema as I, type JavaGenerationConfig as J, type KotlinGenerationConfig as K, jsonObjectSchema as L, type McpAvailabilityStatus as M, jsonValueSchema as N, kotlinGenerationConfigSchema as O, type PackageConfig as P, mcpAvailabilityStatuses as Q, type RubyGenerationConfig as R, type SdkConfigDiagnostic as S, type TerraformGenerationConfig as T, mcpGenerationConfigSchema as U, nonEmptyStringSchema as V, oauthTokenEndpointsIssues as W, packageConfigSchema as X, parentRelativePathSchema as Y, phpGenerationConfigSchema as Z, pythonGenerationConfigSchema as _, type CliDistributionConfig as a, rubyGenerationConfigSchema as a0, rustGenerationConfigSchema as a1, swiftGenerationConfigSchema as a2, terraformGenerationConfigSchema as a3, typescriptGenerationConfigSchema as a4, type CliDistributionGithubAppConfig as b, type CliDistributionHomebrewConfig as c, type CliDistributionScoopConfig as d, type CliGenerationConfig as e, type CliOAuthTokenEndpoints as f, type CliProfilesConfig as g, type CliProfilesProvisionOperation as h, type CsharpGenerationConfig as i, type JsonObject as j, type JsonValue as k, type McpGenerationConfig as l, type McpToolFilter as m, type PhpGenerationConfig as n, type PlanModifiers as o, type PythonGenerationConfig as p, type RustGenerationConfig as q, type SwiftGenerationConfig as r, type TypescriptGenerationConfig as s, cliDistributionConfigSchema as t, cliDistributionGithubAppSchema as u, cliDistributionHomebrewSchema as v, cliDistributionScoopSchema as w, cliGenerationConfigSchema as x, composerPackageNameSchema as y, csharpGenerationConfigSchema as z };
687
+ export { parentRelativePathSchema as $, cliGenerationConfigSchema as A, composerPackageNameSchema as B, CLI_DISTRIBUTION_NON_RELEASE_MODE_CODE as C, type Dependency as D, csharpGenerationConfigSchema as E, dependencySchema as F, type GoGenerationConfig as G, exactSemverSchema as H, githubActionsSecretNameSchema as I, type JavaGenerationConfig as J, type KotlinGenerationConfig as K, goGenerationConfigSchema as L, MCP_TOOL_NAME_PATTERN as M, goModulePathSchema as N, javaGenerationConfigSchema as O, type PackageConfig as P, jsonObjectSchema as Q, type RubyGenerationConfig as R, type SdkConfigDiagnostic as S, type TerraformGenerationConfig as T, jsonValueSchema as U, kotlinGenerationConfigSchema as V, mcpAvailabilityStatuses as W, mcpGenerationConfigSchema as X, nonEmptyStringSchema as Y, oauthTokenEndpointsIssues as Z, packageConfigSchema as _, type CliDistributionConfig as a, phpGenerationConfigSchema as a0, pythonGenerationConfigSchema as a1, relativePathSchema as a2, rubyGenerationConfigSchema as a3, rustGenerationConfigSchema as a4, swiftGenerationConfigSchema as a5, terraformGenerationConfigSchema as a6, typescriptGenerationConfigSchema as a7, type CliDistributionGithubAppConfig as b, type CliDistributionHomebrewConfig as c, type CliDistributionScoopConfig as d, type CliGenerationConfig as e, type CliOAuthTokenEndpoints as f, type CliProfilesConfig as g, type CliProfilesProvisionOperation as h, type CsharpGenerationConfig as i, type JsonObject as j, type JsonValue as k, type McpAvailabilityStatus as l, type McpCustomTool as m, type McpGenerationConfig as n, type McpMergedTool as o, type McpToolFilter as p, type PhpGenerationConfig as q, type PlanModifiers as r, type PythonGenerationConfig as s, type RustGenerationConfig as t, type SwiftGenerationConfig as u, type TypescriptGenerationConfig as v, cliDistributionConfigSchema as w, cliDistributionGithubAppSchema as x, cliDistributionHomebrewSchema as y, cliDistributionScoopSchema as z };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@postman/sdk-config",
3
- "version": "0.21.0",
3
+ "version": "0.23.0",
4
4
  "description": "Shared SDK configuration contracts and transformations for Postman SDK generation",
5
5
  "license": "UNLICENSED",
6
6
  "sideEffects": false,
@@ -482,16 +482,8 @@ targets:
482
482
  operation: iam.keys.create
483
483
  credential: { username: sid, password: secret }
484
484
  revokeParameters: { Sid: sid }
485
- flag: api-key
486
- parameters: { FriendlyName: '{cli} for {user} on {host}' }
487
- profileParameters: { AccountSid: username }
488
485
  splitTypeCrates: true
489
486
  userAgentSuffixFlag: via
490
- banner:
491
- text: ACME
492
- colors: ['#2929CC', '#30F2B1']
493
- direction: diagonal
494
- animate: true
495
487
  ```
496
488
 
497
489
  Omitted settings stay omitted in both SDK Config and IR. The CLI generator then applies the
@@ -499,22 +491,18 @@ default shown below. Fern migration copies these keys verbatim from the CLI gene
499
491
  A legacy `profiles` block without `enabled` migrates as `enabled: false`. A legacy value this schema
500
492
  rejects is left out and reported as `FERN_CONFIG_VALUE_INVALID`.
501
493
 
502
- | Setting | Behavior | Validation | Generator default when omitted |
503
- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
504
- | `binaryName` | Executable name. The generator kebab-cases it (`Acme CLI` becomes `acme-cli`) and uses the result for the Cargo binary, the CLI source directory, the runtime app name, and the fallback environment-variable prefix. | Non-empty string with at least one ASCII letter or digit, since the generator rejects names that kebab-case to empty. | Kebab-cased API display name |
505
- | `crateName` | Name of the generated Cargo package, which release archives and installers (`<name>-installer.sh`) are named after. Defaults to the binary name when the output is delivered to GitHub. | Cargo package name: starts with a letter, then letters, digits, `-` or `_`, at most 64 characters. |
506
- | `customCommands` | Generates hand-written command support: the model and SDK crates, `sdk.rs`, and `custom.rs`. | Boolean | `true` |
507
- | `rootGroup` | Nests every spec-derived command under one group, so `acme users list` becomes `acme api users list`. | `^[a-z][a-z0-9_-]*$` | No group |
508
- | `profiles.enabled` | Emits the profile command group and the global `--profile` / `-p` flag. Profiles store per-profile credentials and request defaults. | Required boolean when `profiles` is present, following the SDK Config convention for feature objects. The generator itself treats a missing `enabled` as `false`. | Profiles off |
509
- | `profiles.commandName` | Name of the profile command group. | `^[a-z][a-z0-9-]*$`, excluding `auth`, `completion`, `man`, `errors`, `generate-skills`, and `help` | `profiles` |
510
- | `profiles.revokeOperation` | Operation that `profiles remove --revoke` calls. | Dotted command path, such as `iam.keys.remove` | No `--revoke` flag |
511
- | `profiles.provisionOperation` | Operation that `profiles create --provision` calls, and how its response fills the stored credential. | `operation` is a required dotted path. `credential` maps at least one field. Map keys and values match `^[A-Za-z0-9_.-]+$`. | No `--provision` flag |
512
- | `profiles.provisionOperation.flag` | Long name of the `profiles create` flag. `--provision` stays accepted as a hidden alias. | `^[a-z][a-z0-9-]*$` without the leading `--` | `provision` |
513
- | `profiles.provisionOperation.parameters` | Extra request values sent with the operation. `{cli}`, `{profile}`, `{user}` and `{host}` are substituted; a value the profile sets wins. | Keys match `^[A-Za-z0-9_.-]+$`. Values contain no quotes, backslashes or control characters. | None |
514
- | `profiles.provisionOperation.profileParameters` | Maps each profile parameter to the typed credential field it is copied from, so requests keep it once the credential is replaced by the provisioned key. | Keys and values match `^[A-Za-z0-9_.-]+$`. | None |
515
- | `splitTypeCrates` | Splits generated types into one crate per API behind a facade crate. | Boolean | `false` |
516
- | `userAgentSuffixFlag` | Long flag that appends a product token to the User-Agent. The environment variable is `<BINARY>_<FLAG>`, with hyphens changed to underscores. | `^[a-z][a-z0-9-]*$` without the leading `--`. Built-in global flag names such as `help` and `base-url` are rejected. | `user-agent-suffix` |
517
- | `banner` | Banner printed above root `--help`: a string, or `text` with `colors` (one colour is solid, several make a gradient along `direction`), `lineColors` (one colour per line) and `animate` (a short shimmer on an interactive terminal). | `text` is non-empty. Colours are `#RRGGBB`. `colors` and `lineColors` are exclusive. `direction` is `horizontal`, `vertical` or `diagonal`. | No banner |
494
+ | Setting | Behavior | Validation | Generator default when omitted |
495
+ | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
496
+ | `binaryName` | Executable name. The generator kebab-cases it (`Acme CLI` becomes `acme-cli`) and uses the result for the Cargo binary, the CLI source directory, the runtime app name, and the fallback environment-variable prefix. | Non-empty string with at least one ASCII letter or digit, since the generator rejects names that kebab-case to empty. | Kebab-cased API display name |
497
+ | `crateName` | Name of the generated Cargo package, which release archives and installers (`<name>-installer.sh`) are named after. Defaults to the binary name when the output is delivered to GitHub. | Cargo package name: starts with a letter, then letters, digits, `-` or `_`, at most 64 characters. |
498
+ | `customCommands` | Generates hand-written command support: the model and SDK crates, `sdk.rs`, and `custom.rs`. | Boolean | `true` |
499
+ | `rootGroup` | Nests every spec-derived command under one group, so `acme users list` becomes `acme api users list`. | `^[a-z][a-z0-9_-]*$` | No group |
500
+ | `profiles.enabled` | Emits the profile command group and the global `--profile` / `-p` flag. Profiles store per-profile credentials and request defaults. | Required boolean when `profiles` is present, following the SDK Config convention for feature objects. The generator itself treats a missing `enabled` as `false`. | Profiles off |
501
+ | `profiles.commandName` | Name of the profile command group. | `^[a-z][a-z0-9-]*$`, excluding `auth`, `completion`, `man`, `errors`, `generate-skills`, and `help` | `profiles` |
502
+ | `profiles.revokeOperation` | Operation that `profiles remove --revoke` calls. | Dotted command path, such as `iam.keys.remove` | No `--revoke` flag |
503
+ | `profiles.provisionOperation` | Operation that `profiles create --provision` calls, and how its response fills the stored credential. | `operation` is a required dotted path. `credential` maps at least one field. Map keys and values match `^[A-Za-z0-9_.-]+$`. | No `--provision` flag |
504
+ | `splitTypeCrates` | Splits generated types into one crate per API behind a facade crate. | Boolean | `false` |
505
+ | `userAgentSuffixFlag` | Long flag that appends a product token to the User-Agent. The environment variable is `<BINARY>_<FLAG>`, with hyphens changed to underscores. | `^[a-z][a-z0-9-]*$` without the leading `--`. Built-in global flag names such as `help` and `base-url` are rejected. | `user-agent-suffix` |
518
506
 
519
507
  ## Precedence
520
508
 
@@ -379,29 +379,6 @@ than generated-language presentation.
379
379
  | `path-parameter-order` | `pathParameterOrder` | 2 |
380
380
  | `type-dates-as-strings` | `typeDatesAsStrings` | 12 |
381
381
  | `default-integer-format` | `defaultIntegerFormat` | Importer defaults to `int32`. |
382
- | `respect-per-spec-base-path` | `respectPerSpecBasePath` | Not in the project snapshot; see below. |
383
- | `error-responses` | `errorResponses` | Not in the project snapshot; see below. |
384
- | `additional-properties-defaults-to` | `additionalPropertiesDefaultsTo` | Not in the project snapshot; see below. |
385
- | `optional-additional-properties` | `optionalAdditionalProperties` | Not in the project snapshot; see below. |
386
- | `any-of-sibling-properties-as-object` | `anyOfSiblingPropertiesAsObject` | Not in the project snapshot; see below. |
387
- | `preserve-single-schema-oneof` | `preserveSingleSchemaOneOf` | Not in the project snapshot; see below. |
388
- | `preserve-one-of-in-all-of` | `preserveOneOfInAllOf` | Not in the project snapshot; see below. |
389
- | `remove-discriminants-from-schemas` | `removeDiscriminantsFromSchemas` | Not in the project snapshot; see below. |
390
- | `coerce-consts-to` | `coerceConstsTo` | Not in the project snapshot; see below. |
391
- | `resolve-aliases` | `resolveAliases` | Not in the project snapshot; see below. |
392
- | `respect-forward-compatible-enums` | `respectForwardCompatibleEnums` | Not in the project snapshot; see below. |
393
- | `infer-forward-compatible` | `inferForwardCompatible` | Not in the project snapshot; see below. |
394
- | `respect-operation-id-word-boundaries` | `respectOperationIdWordBoundaries` | Not in the project snapshot; see below. |
395
- | `namespaced-errors` | `namespacedErrors` | Not in the project snapshot; see below. |
396
- | `default-form-parameter-encoding` | `defaultFormParameterEncoding` | Not in the project snapshot; see below. |
397
- | `respect-parameter-content` | `respectParameterContent` | Not in the project snapshot; see below. |
398
- | `use-bytes-for-binary-response` | `useBytesForBinaryResponse` | Not in the project snapshot; see below. |
399
- | `use-read-variant-for-responses` | `useReadVariantForResponses` | Not in the project snapshot; see below. |
400
- | `example-generation` | `exampleGeneration` | Not in the project snapshot; see below. |
401
- | `filter` | `filter` | Not in the project snapshot; see below. |
402
- | `group-environments-by-host` | `groupEnvironmentsByHost` | Not in the project snapshot; see below. |
403
- | `multi-server-strategy` | `multiServerStrategy` | Not in the project snapshot; see below. |
404
- | `infer-default-environment` | `inferDefaultEnvironment` | Not in the project snapshot; see below. |
405
382
 
406
383
  `ignoreTags` and `disambiguateRequestNames` postdate the project snapshot. Twilio declares both
407
384
  across its namespaced API specs. They stay undefaulted so omission remains distinguishable from an
@@ -436,22 +413,6 @@ importer default, which blocks the declaring customer from a post-cutover genera
436
413
  names AsyncAPI messages, but the importer resolves it as part of one shared settings object, so a
437
414
  project's OpenAPI specs carry it too and are refused for it.
438
415
 
439
- `respectPerSpecBasePath` and `errorResponses` serve the CLI generator's parity with Fern. Both stay
440
- undefaulted. `respectPerSpecBasePath` applies each document's plain `x-fern-base-path` to that
441
- document's endpoints. `errorResponses` is Fern's `error-responses` with the keys camel-cased
442
- (`apply-to` is `applyTo`, `status-code` is `statusCode`). Its `schema` is the schema object itself:
443
- Fern also accepts a path relative to `generators.yml`, which no service can read, so the client
444
- resolves the file and sends its content. The same holds for a CLI `banner` read from a file: the
445
- client sends its `text`.
446
-
447
- The remaining Fern import settings (`additionalPropertiesDefaultsTo` through `inferDefaultEnvironment` in the table above)
448
- complete the set Fern's `getAPIDefinitionSettings` maps, so a config that declares one is no longer refused. All stay
449
- undefaulted: absent must leave an existing SDK's shapes alone, and the generator applies Fern's own default. Fern's
450
- `shared-error-responses` is not a setting: it is derived from `errorResponses` set API-wide, and the generator derives it
451
- the same way. `resolveAliases` takes `true`, `false` or `{ except: [...] }`; `exampleGeneration` and `filter` are objects
452
- with the keys camel-cased (`maxDepth`, `endpoints`). This reverses the earlier removal of environment grouping and
453
- default-environment inference: both are modeled again because Fern still reads them.
454
-
455
416
  ## Fern language-specific migration map
456
417
 
457
418
  Only options that remain language-specific stay in `generation.language`.