@postman/sdk-config 0.11.0 → 0.13.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 (36) hide show
  1. package/README.md +18 -6
  2. package/dist/index.cjs +372 -24
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +1 -1
  5. package/dist/index.d.ts +1 -1
  6. package/dist/index.js +372 -24
  7. package/dist/index.js.map +1 -1
  8. package/dist/sdk-config/index.cjs +370 -23
  9. package/dist/sdk-config/index.cjs.map +1 -1
  10. package/dist/sdk-config/index.d.cts +1 -1
  11. package/dist/sdk-config/index.d.ts +1 -1
  12. package/dist/sdk-config/index.js +370 -23
  13. package/dist/sdk-config/index.js.map +1 -1
  14. package/dist/sdk-config/v1/index.cjs +370 -23
  15. package/dist/sdk-config/v1/index.cjs.map +1 -1
  16. package/dist/sdk-config/v1/index.d.cts +632 -31
  17. package/dist/sdk-config/v1/index.d.ts +632 -31
  18. package/dist/sdk-config/v1/index.js +370 -23
  19. package/dist/sdk-config/v1/index.js.map +1 -1
  20. package/dist/sdk-config-ir/index.cjs +57 -6
  21. package/dist/sdk-config-ir/index.cjs.map +1 -1
  22. package/dist/sdk-config-ir/index.d.cts +1 -1
  23. package/dist/sdk-config-ir/index.d.ts +1 -1
  24. package/dist/sdk-config-ir/index.js +57 -6
  25. package/dist/sdk-config-ir/index.js.map +1 -1
  26. package/dist/sdk-config-ir/v1/index.cjs +57 -6
  27. package/dist/sdk-config-ir/v1/index.cjs.map +1 -1
  28. package/dist/sdk-config-ir/v1/index.d.cts +211 -4
  29. package/dist/sdk-config-ir/v1/index.d.ts +211 -4
  30. package/dist/sdk-config-ir/v1/index.js +57 -6
  31. package/dist/sdk-config-ir/v1/index.js.map +1 -1
  32. package/dist/{typescript-CsAa1VSy.d.cts → typescript-BFRxjAah.d.cts} +65 -0
  33. package/dist/{typescript-CsAa1VSy.d.ts → typescript-BFRxjAah.d.ts} +65 -0
  34. package/package.json +1 -1
  35. package/src/sdk-config/v1/README.md +32 -11
  36. package/src/sdk-config-ir/v1/README.md +115 -60
package/README.md CHANGED
@@ -75,15 +75,27 @@ if (!result.success) {
75
75
  SDK Config objects are strict. Unknown fields, duplicate language targets, incompatible package
76
76
  publication settings, and non-exact generator versions are rejected. npm and crates use
77
77
  `output.publish.token`, PyPI and Maven use flat `username` and `password` fields, and Maven may also
78
- use a complete `signature` object. Configure these fields with environment expressions such as
78
+ use a complete `signature` object. NuGet and RubyGems use `output.publish.apiKey` to name the
79
+ repository secret that the generated release workflow reads the API key from, such as
80
+ `${MY_NUGET_KEY}`. That value is a secret name, never the key itself. Configure these fields with
81
+ environment expressions such as
79
82
  `${NPM_TOKEN}` rather than literal credentials. Clients must resolve and transport credentials using
80
83
  a dedicated secret channel and remove them from generation payloads, logs, and stored artifacts.
81
- Fern migration preserves a credential only when the raw `generators.yml` value is exactly an
82
- environment expression; normalized, resolved, or literal values are omitted with a warning.
84
+ NuGet and RubyGems may instead set `output.publish.trustedPublishing`, which authenticates the
85
+ release workflow with a short-lived OIDC token the registry verifies against the repository. There is
86
+ then no API key secret to name, so `apiKey` and `trustedPublishing` cannot both be set.
83
87
 
84
- CLI targets may also declare `output.distribution` (Homebrew and Scoop channels) and npm
85
- publication. Distribution credentials are GitHub Actions secret **names**, not environment
86
- expressions: clients must not resolve them or send them through the publish-credential channel. See
88
+ Fern migration preserves a credential only when the raw `generators.yml` value is exactly an
89
+ environment expression; normalized, resolved, or literal values are omitted with a warning. A GitHub
90
+ NuGet target whose `api-key` names no secret gets `${NUGET_API_TOKEN}`, the secret Fern's generated
91
+ workflow reads in that case, and no warning, because publishing keeps working unchanged. Fern states
92
+ trusted publishing through the same `api-key` field, as `OIDC` or `<USE_OIDC>`, and migration maps
93
+ either to `trustedPublishing: true` rather than dropping it.
94
+
95
+ CLI targets may also declare `output.distribution` (Homebrew and Scoop channels and
96
+ `githubAttestations` for release build provenance) and npm publication. Distribution credentials are
97
+ GitHub Actions secret **names**, not environment expressions: clients must not resolve them or send
98
+ them through the publish-credential channel. See
87
99
  [CLI distribution and npm publication](src/sdk-config/v1/README.md#cli-distribution-and-npm-publication).
88
100
  Call `getSdkConfigV1Diagnostics` after validation to surface non-fatal warnings.
89
101