@postman/sdk-config 0.20.0 → 0.21.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 +159 -4
  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 +159 -4
  6. package/dist/index.js.map +1 -1
  7. package/dist/sdk-config/index.cjs +159 -4
  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 +159 -4
  12. package/dist/sdk-config/index.js.map +1 -1
  13. package/dist/sdk-config/v1/index.cjs +159 -4
  14. package/dist/sdk-config/v1/index.cjs.map +1 -1
  15. package/dist/sdk-config/v1/index.d.cts +767 -2
  16. package/dist/sdk-config/v1/index.d.ts +767 -2
  17. package/dist/sdk-config/v1/index.js +159 -4
  18. package/dist/sdk-config/v1/index.js.map +1 -1
  19. package/dist/sdk-config-ir/index.cjs +149 -2
  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 +149 -2
  24. package/dist/sdk-config-ir/index.js.map +1 -1
  25. package/dist/sdk-config-ir/v1/index.cjs +149 -2
  26. package/dist/sdk-config-ir/v1/index.cjs.map +1 -1
  27. package/dist/sdk-config-ir/v1/index.d.cts +446 -2
  28. package/dist/sdk-config-ir/v1/index.d.ts +446 -2
  29. package/dist/sdk-config-ir/v1/index.js +149 -2
  30. package/dist/sdk-config-ir/v1/index.js.map +1 -1
  31. package/dist/{typescript-VEqEGvnA.d.cts → typescript-DNic6Rq5.d.cts} +20 -0
  32. package/dist/{typescript-VEqEGvnA.d.ts → typescript-DNic6Rq5.d.ts} +20 -0
  33. package/package.json +1 -1
  34. package/src/sdk-config/v1/README.md +24 -12
  35. package/src/sdk-config-ir/v1/README.md +39 -0
@@ -721,6 +721,28 @@ function fieldNameMapSchema(field) {
721
721
  }
722
722
  });
723
723
  }
724
+ var SAFE_TEXT_PATTERN = /^[^"\\\x00-\x1f]*$/;
725
+ var HEX_COLOR_PATTERN = /^#[0-9a-fA-F]{6}$/;
726
+ var provisionFlagSchema = zod.z.string().regex(KEBAB_NAME_PATTERN, {
727
+ message: 'profiles.provisionOperation.flag must be a kebab-case flag name without dashes, such as "api-key"'
728
+ });
729
+ var provisionParametersSchema = zod.z.record(zod.z.string(), zod.z.string()).superRefine((value, context) => {
730
+ for (const [key, text] of Object.entries(value)) {
731
+ if (!FIELD_NAME_PATTERN.test(key)) {
732
+ context.addIssue({
733
+ code: "custom",
734
+ message: "profiles.provisionOperation.parameters keys must be field names containing only [A-Za-z0-9_.-]",
735
+ path: [key]
736
+ });
737
+ } else if (!SAFE_TEXT_PATTERN.test(text)) {
738
+ context.addIssue({
739
+ code: "custom",
740
+ message: "profiles.provisionOperation.parameters values must not contain quotes, backslashes or control characters",
741
+ path: [key]
742
+ });
743
+ }
744
+ }
745
+ });
724
746
  var profilesProvisionOperationSchema = zod.z.strictObject({
725
747
  operation: dottedCommandPathSchema("profiles.provisionOperation.operation").describe(
726
748
  "The dotted command path of the operation that mints a profile credential."
@@ -728,7 +750,16 @@ var profilesProvisionOperationSchema = zod.z.strictObject({
728
750
  credential: fieldNameMapSchema("profiles.provisionOperation.credential").refine((value) => Object.keys(value).length > 0, {
729
751
  message: "profiles.provisionOperation.credential must map at least one credential field"
730
752
  }).describe("Maps each stored credential field to the response field that supplies it."),
731
- revokeParameters: fieldNameMapSchema("profiles.provisionOperation.revokeParameters").optional().describe("Maps each revoke-operation parameter to the response field that supplies it.")
753
+ revokeParameters: fieldNameMapSchema("profiles.provisionOperation.revokeParameters").optional().describe("Maps each revoke-operation parameter to the response field that supplies it."),
754
+ flag: provisionFlagSchema.optional().describe(
755
+ 'The long name of the "profiles create" flag, without "--". The generator defaults it to "provision", which stays accepted as a hidden alias.'
756
+ ),
757
+ parameters: provisionParametersSchema.optional().describe(
758
+ "Extra request values sent with the operation. {cli}, {profile}, {user} and {host} are substituted; a value the profile sets wins."
759
+ ),
760
+ profileParameters: fieldNameMapSchema("profiles.provisionOperation.profileParameters").optional().describe(
761
+ "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."
762
+ )
732
763
  });
733
764
  var profilesConfigSchema = zod.z.strictObject({
734
765
  enabled: zod.z.boolean().describe("Whether the CLI emits profile commands and the global --profile flag."),
@@ -736,6 +767,24 @@ var profilesConfigSchema = zod.z.strictObject({
736
767
  revokeOperation: dottedCommandPathSchema("profiles.revokeOperation").optional().describe('The dotted command path called by "profiles remove --revoke".'),
737
768
  provisionOperation: profilesProvisionOperationSchema.optional().describe('The operation called by "profiles create --provision" and its response mapping.')
738
769
  });
770
+ var bannerColorsSchema = (field) => zod.z.array(
771
+ zod.z.string().regex(HEX_COLOR_PATTERN, {
772
+ message: `banner.${field} must hold 6-digit hex colours such as "#4949F2"`
773
+ })
774
+ );
775
+ var bannerObjectSchema = zod.z.strictObject({
776
+ text: nonEmptyStringSchema.describe("The banner text. May span several lines."),
777
+ colors: bannerColorsSchema("colors").optional().describe("One colour for a solid banner, or several for a gradient along the direction."),
778
+ lineColors: bannerColorsSchema("lineColors").optional().describe("One colour per line of the banner. Exclusive with colors."),
779
+ direction: zod.z.enum(["horizontal", "vertical", "diagonal"]).optional().describe("The direction of the gradient. The generator defaults to horizontal."),
780
+ animate: zod.z.boolean().optional().describe(
781
+ "Whether root --help on an interactive terminal plays a short shimmer across the banner before printing it."
782
+ )
783
+ }).refine((banner) => banner.colors === void 0 || banner.lineColors === void 0, {
784
+ message: "banner must set either colors (a gradient) or lineColors (one colour per line), not both",
785
+ path: ["lineColors"]
786
+ });
787
+ var bannerSchema = zod.z.union([nonEmptyStringSchema, bannerObjectSchema]);
739
788
  var oauthPropertyPathSchema = zod.z.string().regex(FIELD_NAME_PATTERN, {
740
789
  message: 'must be a property name, or a dotted path to a nested property, such as "data.token"'
741
790
  }).regex(/^[^.]+(\.[^.]+)*$/, { message: "must not have an empty path segment" });
@@ -805,6 +854,9 @@ var cliGenerationConfigSchema = zod.z.strictObject({
805
854
  profiles: profilesConfigSchema.optional().describe("Named profile command configuration."),
806
855
  splitTypeCrates: zod.z.boolean().optional().describe("Whether generated types are split into one crate per API behind a facade crate."),
807
856
  userAgentSuffixFlag: userAgentSuffixFlagSchema.optional().describe('The long flag name, without "--", that appends a product token to the User-Agent.'),
857
+ banner: bannerSchema.optional().describe(
858
+ "The banner printed above root --help: a string, or text with colours, a gradient direction, per-line colours and an animation switch."
859
+ ),
808
860
  oauthTokenEndpoints: zod.z.record(nonEmptyStringSchema, oauthTokenEndpointsSchema).optional().describe(
809
861
  "Per OAuth scheme id (api.auth.schemes[].id), the names of the properties of the token and refresh requests and responses, for the client credentials flow of an API whose token endpoint does not use the RFC 6749 names."
810
862
  )
@@ -1481,6 +1533,52 @@ var outputConfigSchema = zod.z.discriminatedUnion(
1481
1533
  var replayConfigSchema = zod.z.strictObject({
1482
1534
  enabled: zod.z.boolean().describe("Whether regeneration reapplies customer-authored repository changes.")
1483
1535
  });
1536
+ var errorResponsesHttpMethodSchema = zod.z.enum([
1537
+ "get",
1538
+ "post",
1539
+ "put",
1540
+ "patch",
1541
+ "delete",
1542
+ "head",
1543
+ "options",
1544
+ "trace"
1545
+ ]);
1546
+ var errorResponsesEnsureSchema = zod.z.strictObject({
1547
+ statusCode: zod.z.number().int().min(400).max(599).describe("The 4xx or 5xx status code added to an operation that does not declare it."),
1548
+ methods: zod.z.array(errorResponsesHttpMethodSchema).optional().describe("The HTTP methods whose operations receive the response. Defaults to all methods.")
1549
+ });
1550
+ var errorResponsesSchema = zod.z.strictObject({
1551
+ schema: zod.z.record(zod.z.string(), zod.z.unknown()).describe(
1552
+ "The OpenAPI schema of error response bodies, inline. The client resolves a schema file to its content before the config reaches the generator. Any $ref inside must be a local #/components/... pointer into the spec it is applied to."
1553
+ ),
1554
+ name: nonEmptyStringSchema.optional().describe(
1555
+ "The name of the generated error body type. Defaults to the schema title, then ProblemDetails."
1556
+ ),
1557
+ applyTo: zod.z.enum(["all", "untyped"]).optional().describe(
1558
+ "all replaces the body of every 4xx/5xx response with the schema. untyped only fills in 4xx/5xx responses that declare no body schema. Defaults to all."
1559
+ ),
1560
+ ensure: zod.z.array(errorResponsesEnsureSchema).optional().describe("Error responses added to operations that do not already declare them.")
1561
+ });
1562
+ var exampleDepthSchema = zod.z.strictObject({
1563
+ maxDepth: zod.z.number().int().min(0).optional().describe("How many levels of optional properties an example includes. 0 leaves them out.")
1564
+ });
1565
+ var exampleGenerationSchema = zod.z.strictObject({
1566
+ request: exampleDepthSchema.optional().describe("Depth of generated request examples."),
1567
+ response: exampleDepthSchema.optional().describe("Depth of generated response examples.")
1568
+ });
1569
+ var resolveAliasesSchema = zod.z.union([
1570
+ zod.z.boolean(),
1571
+ zod.z.strictObject({
1572
+ except: zod.z.array(nonEmptyStringSchema).optional().describe("Component schema names whose aliases are kept.")
1573
+ })
1574
+ ]);
1575
+ var endpointFilterSchema = zod.z.strictObject({
1576
+ endpoints: zod.z.array(
1577
+ nonEmptyStringSchema.describe(
1578
+ 'An endpoint to keep, as "METHOD /path/template". An entry in another shape is ignored.'
1579
+ )
1580
+ ).describe("The only endpoints imported. Every other operation is dropped before conversion.")
1581
+ });
1484
1582
  var apiImportSettingsSchema = zod.z.strictObject({
1485
1583
  respectNullableSchemas: zod.z.boolean().optional().describe("Whether nullable schemas remain nullable in generated types."),
1486
1584
  titleAsSchemaName: zod.z.boolean().optional().describe("Whether a schema title can determine the generated type name."),
@@ -1509,7 +1607,56 @@ var apiImportSettingsSchema = zod.z.strictObject({
1509
1607
  resolveSchemaCollisions: zod.z.boolean().optional().describe("Whether colliding imported schema names are resolved automatically."),
1510
1608
  asyncApiMessageNaming: zod.z.enum(["v1", "v2"]).optional().describe("The naming strategy used for messages imported from AsyncAPI."),
1511
1609
  defaultIntegerFormat: zod.z.enum(["int32", "int64", "uint32", "uint64"]).optional().describe("The integer format used when a schema does not declare one."),
1512
- respectByteFormat: zod.z.boolean().optional().describe("Whether string schemas with format byte are imported as base64-encoded bytes.")
1610
+ respectByteFormat: zod.z.boolean().optional().describe("Whether string schemas with format byte are imported as base64-encoded bytes."),
1611
+ additionalPropertiesDefaultsTo: zod.z.boolean().optional().describe(
1612
+ "Whether an object schema that does not declare additionalProperties admits any extra property."
1613
+ ),
1614
+ optionalAdditionalProperties: zod.z.boolean().optional().describe("Whether the values of a nullable map are also nullable."),
1615
+ anyOfSiblingPropertiesAsObject: zod.z.boolean().optional().describe(
1616
+ "Whether an anyOf that only constrains which sibling properties are present imports as the object it sits beside."
1617
+ ),
1618
+ preserveSingleSchemaOneOf: zod.z.boolean().optional().describe(
1619
+ "Whether a oneOf with a single member stays a union instead of collapsing to that member."
1620
+ ),
1621
+ preserveOneOfInAllOf: zod.z.boolean().optional().describe(
1622
+ "Whether a oneOf inside an allOf stays a union of the merged variants instead of being flattened."
1623
+ ),
1624
+ removeDiscriminantsFromSchemas: zod.z.enum(["always", "never"]).optional().describe(
1625
+ "Whether the discriminator property is removed from the schemas of a discriminated union."
1626
+ ),
1627
+ coerceConstsTo: zod.z.enum(["literals", "enums", "enums-coerceable-to-literals"]).optional().describe(
1628
+ "What a const imports as: a literal, a single-value enum, or an enum that coerceEnumsToLiterals can turn into a literal."
1629
+ ),
1630
+ resolveAliases: resolveAliasesSchema.optional().describe(
1631
+ "Whether references to alias-like schemas are replaced by the schema they alias, optionally keeping the named exceptions."
1632
+ ),
1633
+ respectForwardCompatibleEnums: zod.z.boolean().optional().describe(
1634
+ "Whether a query or header parameter that accepts an enum or any string keeps both options."
1635
+ ),
1636
+ inferForwardCompatible: zod.z.boolean().optional().describe(
1637
+ "Whether a oneOf or anyOf of an enum and a plain string imports as a forward-compatible enum."
1638
+ ),
1639
+ respectOperationIdWordBoundaries: zod.z.boolean().optional().describe(
1640
+ "Whether operation ids are split at every word boundary when method names are derived."
1641
+ ),
1642
+ namespacedErrors: zod.z.boolean().optional().describe("Whether an error response takes the x-fern-sdk-namespace it declares."),
1643
+ defaultFormParameterEncoding: zod.z.enum(["form", "json"]).optional().describe("How multipart form properties without an explicit content type are encoded."),
1644
+ respectParameterContent: zod.z.boolean().optional().describe(
1645
+ "Whether a header declared with a JSON content entry instead of a schema is typed by that content."
1646
+ ),
1647
+ useBytesForBinaryResponse: zod.z.boolean().optional().describe("Whether a binary response is returned as bytes instead of a file stream."),
1648
+ useReadVariantForResponses: zod.z.boolean().optional().describe(
1649
+ "Whether responses use the read variant of a schema that has read-only properties. Needs respectReadonlySchemas."
1650
+ ),
1651
+ exampleGeneration: exampleGenerationSchema.optional().describe("How deep the examples generated for operations without one go."),
1652
+ filter: endpointFilterSchema.optional().describe("Restricts the import to a list of endpoints."),
1653
+ groupEnvironmentsByHost: zod.z.boolean().optional().describe("Whether HTTP and WebSocket servers with the same host become one environment."),
1654
+ multiServerStrategy: zod.z.enum(["environment-per-server", "urls-per-environment"]).optional().describe(
1655
+ "Whether each named server is its own environment or a named URL of one environment."
1656
+ ),
1657
+ inferDefaultEnvironment: zod.z.boolean().optional().describe("Whether the first server becomes the default environment."),
1658
+ respectPerSpecBasePath: zod.z.boolean().optional().describe("Whether each spec's plain x-fern-base-path applies to that spec's endpoints."),
1659
+ errorResponses: errorResponsesSchema.optional().describe("A shared error body schema applied to the 4xx/5xx responses of the specs.")
1513
1660
  });
1514
1661
  var sourceSpecTypeSchema = zod.z.enum([
1515
1662
  "openapi",