@postman/sdk-config 0.5.1 → 0.7.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/README.md +15 -0
  2. package/dist/index.cjs +263 -27
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +3 -3
  5. package/dist/index.d.ts +3 -3
  6. package/dist/index.js +260 -28
  7. package/dist/index.js.map +1 -1
  8. package/dist/sdk-config/index.cjs +224 -27
  9. package/dist/sdk-config/index.cjs.map +1 -1
  10. package/dist/sdk-config/index.d.cts +2 -2
  11. package/dist/sdk-config/index.d.ts +2 -2
  12. package/dist/sdk-config/index.js +224 -28
  13. package/dist/sdk-config/index.js.map +1 -1
  14. package/dist/sdk-config/v1/index.cjs +224 -27
  15. package/dist/sdk-config/v1/index.cjs.map +1 -1
  16. package/dist/sdk-config/v1/index.d.cts +20 -2
  17. package/dist/sdk-config/v1/index.d.ts +20 -2
  18. package/dist/sdk-config/v1/index.js +224 -28
  19. package/dist/sdk-config/v1/index.js.map +1 -1
  20. package/dist/sdk-config-ir/index.cjs +153 -0
  21. package/dist/sdk-config-ir/index.cjs.map +1 -1
  22. package/dist/sdk-config-ir/index.d.cts +2 -2
  23. package/dist/sdk-config-ir/index.d.ts +2 -2
  24. package/dist/sdk-config-ir/index.js +151 -1
  25. package/dist/sdk-config-ir/index.js.map +1 -1
  26. package/dist/sdk-config-ir/v1/index.cjs +153 -0
  27. package/dist/sdk-config-ir/v1/index.cjs.map +1 -1
  28. package/dist/sdk-config-ir/v1/index.d.cts +43 -3
  29. package/dist/sdk-config-ir/v1/index.d.ts +43 -3
  30. package/dist/sdk-config-ir/v1/index.js +151 -1
  31. package/dist/sdk-config-ir/v1/index.js.map +1 -1
  32. package/dist/{typescript-BruxA5zG.d.cts → typescript-BdDv_kwT.d.cts} +8 -0
  33. package/dist/{typescript-BruxA5zG.d.ts → typescript-BdDv_kwT.d.ts} +8 -0
  34. package/package.json +1 -1
  35. package/src/sdk-config-ir/v1/README.md +10 -2
@@ -230,6 +230,7 @@ declare const mcpGenerationConfigSchema: z.ZodObject<{
230
230
  pnpm: "pnpm";
231
231
  yarn: "yarn";
232
232
  }>>;
233
+ packageManagerVersion: z.ZodOptional<z.ZodString>;
233
234
  testFramework: z.ZodOptional<z.ZodEnum<{
234
235
  jest: "jest";
235
236
  vitest: "vitest";
@@ -241,11 +242,13 @@ declare const mcpGenerationConfigSchema: z.ZodObject<{
241
242
  bundle: z.ZodOptional<z.ZodBoolean>;
242
243
  exportClassDefault: z.ZodOptional<z.ZodBoolean>;
243
244
  namespaceExportName: z.ZodOptional<z.ZodString>;
245
+ consolidateTypeFiles: z.ZodOptional<z.ZodBoolean>;
244
246
  allowCustomFetcher: z.ZodOptional<z.ZodBoolean>;
245
247
  useBrandedStringAliases: z.ZodOptional<z.ZodBoolean>;
246
248
  useLegacyExports: z.ZodOptional<z.ZodBoolean>;
247
249
  useBigInt: z.ZodOptional<z.ZodBoolean>;
248
250
  serdeLayer: z.ZodOptional<z.ZodBoolean>;
251
+ esmOnly: z.ZodOptional<z.ZodBoolean>;
249
252
  scripts: z.ZodOptional<z.ZodArray<z.ZodObject<{
250
253
  name: z.ZodString;
251
254
  command: z.ZodString;
@@ -416,6 +419,8 @@ declare const typescriptGenerationConfigSchema: z.ZodObject<{
416
419
  pnpm: "pnpm";
417
420
  yarn: "yarn";
418
421
  }>>;
422
+ /** e.g. `1.22.22` — from the customer's own `config.packageJson.packageManager` (`yarn@1.22.22`). */
423
+ packageManagerVersion: z.ZodOptional<z.ZodString>;
419
424
  testFramework: z.ZodOptional<z.ZodEnum<{
420
425
  jest: "jest";
421
426
  vitest: "vitest";
@@ -428,11 +433,14 @@ declare const typescriptGenerationConfigSchema: z.ZodObject<{
428
433
  exportClassDefault: z.ZodOptional<z.ZodBoolean>;
429
434
  /** Name of the top-level namespace export emitted by Fern-compatible TypeScript SDKs. */
430
435
  namespaceExportName: z.ZodOptional<z.ZodString>;
436
+ consolidateTypeFiles: z.ZodOptional<z.ZodBoolean>;
431
437
  allowCustomFetcher: z.ZodOptional<z.ZodBoolean>;
432
438
  useBrandedStringAliases: z.ZodOptional<z.ZodBoolean>;
433
439
  useLegacyExports: z.ZodOptional<z.ZodBoolean>;
434
440
  useBigInt: z.ZodOptional<z.ZodBoolean>;
435
441
  serdeLayer: z.ZodOptional<z.ZodBoolean>;
442
+ /** Ship only the ESM build (drops CJS) to avoid the Node dual-package hazard. */
443
+ esmOnly: z.ZodOptional<z.ZodBoolean>;
436
444
  scripts: z.ZodOptional<z.ZodArray<z.ZodObject<{
437
445
  name: z.ZodString;
438
446
  command: z.ZodString;
@@ -230,6 +230,7 @@ declare const mcpGenerationConfigSchema: z.ZodObject<{
230
230
  pnpm: "pnpm";
231
231
  yarn: "yarn";
232
232
  }>>;
233
+ packageManagerVersion: z.ZodOptional<z.ZodString>;
233
234
  testFramework: z.ZodOptional<z.ZodEnum<{
234
235
  jest: "jest";
235
236
  vitest: "vitest";
@@ -241,11 +242,13 @@ declare const mcpGenerationConfigSchema: z.ZodObject<{
241
242
  bundle: z.ZodOptional<z.ZodBoolean>;
242
243
  exportClassDefault: z.ZodOptional<z.ZodBoolean>;
243
244
  namespaceExportName: z.ZodOptional<z.ZodString>;
245
+ consolidateTypeFiles: z.ZodOptional<z.ZodBoolean>;
244
246
  allowCustomFetcher: z.ZodOptional<z.ZodBoolean>;
245
247
  useBrandedStringAliases: z.ZodOptional<z.ZodBoolean>;
246
248
  useLegacyExports: z.ZodOptional<z.ZodBoolean>;
247
249
  useBigInt: z.ZodOptional<z.ZodBoolean>;
248
250
  serdeLayer: z.ZodOptional<z.ZodBoolean>;
251
+ esmOnly: z.ZodOptional<z.ZodBoolean>;
249
252
  scripts: z.ZodOptional<z.ZodArray<z.ZodObject<{
250
253
  name: z.ZodString;
251
254
  command: z.ZodString;
@@ -416,6 +419,8 @@ declare const typescriptGenerationConfigSchema: z.ZodObject<{
416
419
  pnpm: "pnpm";
417
420
  yarn: "yarn";
418
421
  }>>;
422
+ /** e.g. `1.22.22` — from the customer's own `config.packageJson.packageManager` (`yarn@1.22.22`). */
423
+ packageManagerVersion: z.ZodOptional<z.ZodString>;
419
424
  testFramework: z.ZodOptional<z.ZodEnum<{
420
425
  jest: "jest";
421
426
  vitest: "vitest";
@@ -428,11 +433,14 @@ declare const typescriptGenerationConfigSchema: z.ZodObject<{
428
433
  exportClassDefault: z.ZodOptional<z.ZodBoolean>;
429
434
  /** Name of the top-level namespace export emitted by Fern-compatible TypeScript SDKs. */
430
435
  namespaceExportName: z.ZodOptional<z.ZodString>;
436
+ consolidateTypeFiles: z.ZodOptional<z.ZodBoolean>;
431
437
  allowCustomFetcher: z.ZodOptional<z.ZodBoolean>;
432
438
  useBrandedStringAliases: z.ZodOptional<z.ZodBoolean>;
433
439
  useLegacyExports: z.ZodOptional<z.ZodBoolean>;
434
440
  useBigInt: z.ZodOptional<z.ZodBoolean>;
435
441
  serdeLayer: z.ZodOptional<z.ZodBoolean>;
442
+ /** Ship only the ESM build (drops CJS) to avoid the Node dual-package hazard. */
443
+ esmOnly: z.ZodOptional<z.ZodBoolean>;
436
444
  scripts: z.ZodOptional<z.ZodArray<z.ZodObject<{
437
445
  name: z.ZodString;
438
446
  command: z.ZodString;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@postman/sdk-config",
3
- "version": "0.5.1",
3
+ "version": "0.7.0",
4
4
  "description": "Shared SDK configuration contracts and transformations for Postman SDK generation",
5
5
  "license": "UNLICENSED",
6
6
  "sideEffects": false,
@@ -60,6 +60,12 @@ messages. Valid IR requests route only to the IR bridge and never fall through t
60
60
  required `enabled` boolean so settings can be added without changing its shape.
61
61
  - User-defined maps are permitted only when their values have a stable schema. The temporary
62
62
  `legacyInput.value` JSON object is the deliberate migration exception.
63
+ - V1 evolves additively: new properties are optional, and existing properties are not removed,
64
+ renamed, narrowed, or made required. Incompatible changes require a new IR version.
65
+ - Generator transport uses `serializeSdkConfigIrV1`, which omits versioned defaults and reports the
66
+ capabilities required by semantically active fields. Generators use
67
+ `parseSdkConfigIrV1ForConsumption` to ignore unknown additive object fields at the wire boundary;
68
+ strict parsing remains the authoring and producer-validation contract.
63
69
 
64
70
  Examples of the boolean rule:
65
71
 
@@ -360,8 +366,10 @@ the migration.
360
366
  coercion, endpoint filters, example-depth controls, alias resolution, single-schema oneOf
361
367
  preservation, read-variant responses, binary-response import coercion, form encoding defaults,
362
368
  additional-properties defaults, and discriminated-union inference.
363
- - TypeScript: linter/formatter selection, consolidated type files, subpackage exports, and endpoint
364
- metadata.
369
+ - TypeScript: linter/formatter selection, subpackage exports, and endpoint metadata. (Consolidated
370
+ type files was re-added as `consolidateTypeFiles` in `typescriptGenerationConfigSchema` after
371
+ real customer use turned up — `intercom`/`auth0_fern` both set it — so this list entry no longer
372
+ applies to it.)
365
373
  - Python: ORM/smart-union/coercion/wrapped-alias/positional-constructor/inheritance/validator
366
374
  switches, flattened union bodies, lazy imports, and custom transport.
367
375
  - Java/JVM: JSON include, required-builder checks, public/extensible constructors, unknown-as-node,