@postman/sdk-config 0.24.0 → 0.25.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.
- package/dist/index.cjs +60 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +60 -2
- package/dist/index.js.map +1 -1
- package/dist/sdk-config/index.cjs +42 -0
- package/dist/sdk-config/index.cjs.map +1 -1
- package/dist/sdk-config/index.d.cts +1 -1
- package/dist/sdk-config/index.d.ts +1 -1
- package/dist/sdk-config/index.js +42 -0
- package/dist/sdk-config/index.js.map +1 -1
- package/dist/sdk-config/v1/index.cjs +42 -0
- package/dist/sdk-config/v1/index.cjs.map +1 -1
- package/dist/sdk-config/v1/index.d.cts +10 -2
- package/dist/sdk-config/v1/index.d.ts +10 -2
- package/dist/sdk-config/v1/index.js +42 -0
- package/dist/sdk-config/v1/index.js.map +1 -1
- package/dist/sdk-config-ir/index.cjs +55 -1
- package/dist/sdk-config-ir/index.cjs.map +1 -1
- package/dist/sdk-config-ir/index.d.cts +2 -2
- package/dist/sdk-config-ir/index.d.ts +2 -2
- package/dist/sdk-config-ir/index.js +55 -2
- package/dist/sdk-config-ir/index.js.map +1 -1
- package/dist/sdk-config-ir/v1/index.cjs +55 -1
- package/dist/sdk-config-ir/v1/index.cjs.map +1 -1
- package/dist/sdk-config-ir/v1/index.d.cts +30 -3
- package/dist/sdk-config-ir/v1/index.d.ts +30 -3
- package/dist/sdk-config-ir/v1/index.js +55 -2
- package/dist/sdk-config-ir/v1/index.js.map +1 -1
- package/dist/{typescript-BcBGIPrg.d.cts → typescript-BIq_eF34.d.cts} +2 -0
- package/dist/{typescript-BcBGIPrg.d.ts → typescript-BIq_eF34.d.ts} +2 -0
- package/package.json +1 -1
- package/src/sdk-config/v1/README.md +31 -0
package/dist/index.cjs
CHANGED
|
@@ -205,6 +205,9 @@ var oauthFlowSchema = zod.z.discriminatedUnion("type", [
|
|
|
205
205
|
zod.z.strictObject({
|
|
206
206
|
type: zod.z.literal("client-credentials").describe("Uses the OAuth client credentials flow."),
|
|
207
207
|
tokenUrl: nonEmptyStringSchema.describe("The URL used to obtain access tokens."),
|
|
208
|
+
environmentTokenUrls: zod.z.record(nonEmptyStringSchema, nonEmptyStringSchema).optional().describe(
|
|
209
|
+
"Token URLs by environment name, for an API whose token endpoint differs per environment. When the selected environment has an entry, its URL replaces tokenUrl, so staging and development do not call the production token endpoint. Each key must name an entry of api.environments; environments without an entry use tokenUrl."
|
|
210
|
+
),
|
|
208
211
|
refreshUrl: nonEmptyStringSchema.optional().describe("The URL used to refresh access tokens."),
|
|
209
212
|
scopes: zod.z.array(oauthScopeSchema).optional().describe("The scopes supported by this flow.")
|
|
210
213
|
}),
|
|
@@ -353,6 +356,34 @@ var apiConfigSchema = zod.z.strictObject({
|
|
|
353
356
|
*/
|
|
354
357
|
webhookSignature: webhookSignatureSchema.optional().describe("How generated helpers verify webhook signatures from the API.")
|
|
355
358
|
});
|
|
359
|
+
function oauthEnvironmentTokenUrlsIssues(api, basePath) {
|
|
360
|
+
const environmentNames = new Set((api.environments ?? []).map(({ name }) => name));
|
|
361
|
+
const issues = [];
|
|
362
|
+
(api.auth?.schemes ?? []).forEach((scheme, schemeIndex) => {
|
|
363
|
+
if (scheme.type !== "oauth2") return;
|
|
364
|
+
scheme.flows.forEach((flow, flowIndex) => {
|
|
365
|
+
if (flow.type !== "client-credentials") return;
|
|
366
|
+
Object.keys(flow.environmentTokenUrls ?? {}).forEach((environment) => {
|
|
367
|
+
if (!environmentNames.has(environment)) {
|
|
368
|
+
issues.push({
|
|
369
|
+
message: `environmentTokenUrls "${environment}" must name an entry of api.environments`,
|
|
370
|
+
path: [
|
|
371
|
+
...basePath,
|
|
372
|
+
"auth",
|
|
373
|
+
"schemes",
|
|
374
|
+
schemeIndex,
|
|
375
|
+
"flows",
|
|
376
|
+
flowIndex,
|
|
377
|
+
"environmentTokenUrls",
|
|
378
|
+
environment
|
|
379
|
+
]
|
|
380
|
+
});
|
|
381
|
+
}
|
|
382
|
+
});
|
|
383
|
+
});
|
|
384
|
+
});
|
|
385
|
+
return issues;
|
|
386
|
+
}
|
|
356
387
|
|
|
357
388
|
// src/sdk-config/v1/api.ts
|
|
358
389
|
var sdkConfigV1AuthSchemeSchema = authSchemeSchema;
|
|
@@ -810,6 +841,12 @@ var mcpHooksSchema = zod.z.strictObject({
|
|
|
810
841
|
var mcpGenerationConfigSchema = typescriptGenerationConfigSchema.extend({
|
|
811
842
|
serverName: nonEmptyStringSchema.optional().describe("The name advertised by the generated MCP server."),
|
|
812
843
|
serverDescription: nonEmptyStringSchema.optional().describe("The description advertised by the generated MCP server."),
|
|
844
|
+
instructions: nonEmptyStringSchema.optional().describe(
|
|
845
|
+
"Replaces the auto-generated server instructions returned on initialize. WARNING: the generated instructions encode protocol wiring (the openapi:// resource and schema URI templates and the _meta keys the agent needs to browse docs and fetch full input schemas); replacing them drops that wiring and can break schema/doc browsing, so prefer appendInstructions unless you intend to restate it. Emitted verbatim and sent to the MCP client on every conversation, so keep it concise."
|
|
846
|
+
),
|
|
847
|
+
appendInstructions: nonEmptyStringSchema.optional().describe(
|
|
848
|
+
"Appended after the auto-generated server instructions returned on initialize, preserving the generated protocol wiring. When both instructions and appendInstructions are set, this is appended after the replacement text. Emitted verbatim and sent to the MCP client on every conversation, so keep it concise."
|
|
849
|
+
),
|
|
813
850
|
excludeAvailability: zod.z.array(zod.z.enum(mcpAvailabilityStatuses)).optional().describe("Operation availability statuses excluded from MCP tool generation."),
|
|
814
851
|
tools: mcpToolFilterSchema.optional().describe("Global operation filters for generated MCP tools."),
|
|
815
852
|
toolsets: zod.z.record(mcpToolsetNameSchema, mcpToolFilterSchema).optional().describe("Named MCP toolsets and the operation filters for each toolset."),
|
|
@@ -3228,6 +3265,9 @@ var sdkConfigV1Schema = zod.z.strictObject({
|
|
|
3228
3265
|
targets: zod.z.array(sdkConfigV1TargetSchema).min(1).describe("Language targets to generate; each language may appear once.")
|
|
3229
3266
|
}).superRefine(({ api, output, package: globalPackage, targets }, context) => {
|
|
3230
3267
|
const configuredLanguages = /* @__PURE__ */ new Set();
|
|
3268
|
+
oauthEnvironmentTokenUrlsIssues(api, ["api"]).forEach(
|
|
3269
|
+
(issue) => context.addIssue({ code: "custom", ...issue })
|
|
3270
|
+
);
|
|
3231
3271
|
targets.forEach((target, targetIndex) => {
|
|
3232
3272
|
if (configuredLanguages.has(target.language)) {
|
|
3233
3273
|
context.addIssue({
|
|
@@ -4156,6 +4196,8 @@ function mapMcp(config, state, basePath) {
|
|
|
4156
4196
|
return compact({
|
|
4157
4197
|
serverName: takeString(config, ["serverName"], state, basePath),
|
|
4158
4198
|
serverDescription: takeString(config, ["serverDescription"], state, basePath),
|
|
4199
|
+
instructions: takeString(config, ["instructions"], state, basePath),
|
|
4200
|
+
appendInstructions: takeString(config, ["appendInstructions"], state, basePath),
|
|
4159
4201
|
excludeAvailability: takeEnumArray(
|
|
4160
4202
|
config,
|
|
4161
4203
|
["excludeAvailability"],
|
|
@@ -5207,6 +5249,9 @@ var sdkConfigIrV1Schema = zod.z.strictObject({
|
|
|
5207
5249
|
}
|
|
5208
5250
|
});
|
|
5209
5251
|
}
|
|
5252
|
+
oauthEnvironmentTokenUrlsIssues(api, ["api"]).forEach(
|
|
5253
|
+
(issue) => context.addIssue({ code: "custom", ...issue })
|
|
5254
|
+
);
|
|
5210
5255
|
oauthTokenEndpointsIssues(generation.language?.cli?.oauthTokenEndpoints, api.auth?.schemes, [
|
|
5211
5256
|
"generation",
|
|
5212
5257
|
"language",
|
|
@@ -5257,7 +5302,10 @@ var sdkConfigIrV1Schema = zod.z.strictObject({
|
|
|
5257
5302
|
function parseSdkConfigIrV1(value) {
|
|
5258
5303
|
return sdkConfigIrV1Schema.parse(value);
|
|
5259
5304
|
}
|
|
5260
|
-
var sdkConfigIrCapabilitySchema = zod.z.enum([
|
|
5305
|
+
var sdkConfigIrCapabilitySchema = zod.z.enum([
|
|
5306
|
+
"generation.generateFullProject",
|
|
5307
|
+
"api.auth.oauth.environmentTokenUrls"
|
|
5308
|
+
]);
|
|
5261
5309
|
var sdkConfigIrV1InputJsonSchema = inputJsonSchema(sdkConfigIrV1Schema);
|
|
5262
5310
|
function serializeSdkConfigIrV1(value) {
|
|
5263
5311
|
const parsed = parseSdkConfigIrV1(value);
|
|
@@ -5269,6 +5317,9 @@ function serializeSdkConfigIrV1(value) {
|
|
|
5269
5317
|
if (parsed.generation.generateFullProject) {
|
|
5270
5318
|
requiredCapabilities.push("generation.generateFullProject");
|
|
5271
5319
|
}
|
|
5320
|
+
if (usesEnvironmentTokenUrls(parsed)) {
|
|
5321
|
+
requiredCapabilities.push("api.auth.oauth.environmentTokenUrls");
|
|
5322
|
+
}
|
|
5272
5323
|
const json = JSON.stringify(wireValue);
|
|
5273
5324
|
if (json === void 0) {
|
|
5274
5325
|
throw new Error("SDK Config IR v1 could not be serialized as JSON");
|
|
@@ -5281,6 +5332,13 @@ function serializeSdkConfigIrV1(value) {
|
|
|
5281
5332
|
function parseSdkConfigIrV1ForConsumption(value) {
|
|
5282
5333
|
return parseSdkConfigIrV1(stripUnknownProperties(value, sdkConfigIrV1InputJsonSchema));
|
|
5283
5334
|
}
|
|
5335
|
+
function usesEnvironmentTokenUrls(value) {
|
|
5336
|
+
return (value.api.auth?.schemes ?? []).some(
|
|
5337
|
+
(scheme) => scheme.type === "oauth2" && scheme.flows.some(
|
|
5338
|
+
(flow) => flow.type === "client-credentials" && flow.environmentTokenUrls !== void 0 && Object.keys(flow.environmentTokenUrls).length > 0
|
|
5339
|
+
)
|
|
5340
|
+
);
|
|
5341
|
+
}
|
|
5284
5342
|
|
|
5285
5343
|
exports.CLI_DISTRIBUTION_NON_RELEASE_MODE_CODE = CLI_DISTRIBUTION_NON_RELEASE_MODE_CODE;
|
|
5286
5344
|
exports.FernConfigMappingError = FernConfigMappingError;
|
|
@@ -5322,6 +5380,7 @@ exports.mapFernConfigToSdkConfigV1 = mapFernConfigToSdkConfigV1;
|
|
|
5322
5380
|
exports.mcpAvailabilityStatuses = mcpAvailabilityStatuses;
|
|
5323
5381
|
exports.mcpGenerationConfigSchema = mcpGenerationConfigSchema;
|
|
5324
5382
|
exports.nonEmptyStringSchema = nonEmptyStringSchema;
|
|
5383
|
+
exports.oauthEnvironmentTokenUrlsIssues = oauthEnvironmentTokenUrlsIssues;
|
|
5325
5384
|
exports.oauthTokenEndpointsIssues = oauthTokenEndpointsIssues;
|
|
5326
5385
|
exports.outputConfigSchema = outputConfigSchema;
|
|
5327
5386
|
exports.packageConfigSchema = packageConfigSchema;
|