@postman/sdk-config 0.23.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 +85 -2
- 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 +85 -3
- package/dist/index.js.map +1 -1
- package/dist/sdk-config/index.cjs +67 -1
- 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 +67 -1
- package/dist/sdk-config/index.js.map +1 -1
- package/dist/sdk-config/v1/index.cjs +67 -1
- package/dist/sdk-config/v1/index.cjs.map +1 -1
- package/dist/sdk-config/v1/index.d.cts +16 -2
- package/dist/sdk-config/v1/index.d.ts +16 -2
- package/dist/sdk-config/v1/index.js +67 -1
- package/dist/sdk-config/v1/index.js.map +1 -1
- package/dist/sdk-config-ir/index.cjs +63 -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 +63 -2
- package/dist/sdk-config-ir/index.js.map +1 -1
- package/dist/sdk-config-ir/v1/index.cjs +63 -1
- package/dist/sdk-config-ir/v1/index.cjs.map +1 -1
- package/dist/sdk-config-ir/v1/index.d.cts +39 -3
- package/dist/sdk-config-ir/v1/index.d.ts +39 -3
- package/dist/sdk-config-ir/v1/index.js +63 -2
- package/dist/sdk-config-ir/v1/index.js.map +1 -1
- package/dist/{typescript-ZRqfOhMd.d.cts → typescript-BIq_eF34.d.cts} +10 -1
- package/dist/{typescript-ZRqfOhMd.d.ts → typescript-BIq_eF34.d.ts} +10 -1
- package/package.json +1 -1
- package/src/sdk-config/v1/README.md +31 -0
|
@@ -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;
|
|
@@ -802,9 +833,20 @@ var mcpCustomToolSchema = zod.z.strictObject({
|
|
|
802
833
|
"Path to a TypeScript module that exports the tool `definition` and `handler`."
|
|
803
834
|
)
|
|
804
835
|
});
|
|
836
|
+
var mcpHooksSchema = zod.z.strictObject({
|
|
837
|
+
path: relativePathSchema.describe(
|
|
838
|
+
"Path to a TypeScript module exporting the MCP request/response hooks (`beforeRequest`, `afterResponse`, `onError`, `transformResult`)."
|
|
839
|
+
)
|
|
840
|
+
});
|
|
805
841
|
var mcpGenerationConfigSchema = typescriptGenerationConfigSchema.extend({
|
|
806
842
|
serverName: nonEmptyStringSchema.optional().describe("The name advertised by the generated MCP server."),
|
|
807
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
|
+
),
|
|
808
850
|
excludeAvailability: zod.z.array(zod.z.enum(mcpAvailabilityStatuses)).optional().describe("Operation availability statuses excluded from MCP tool generation."),
|
|
809
851
|
tools: mcpToolFilterSchema.optional().describe("Global operation filters for generated MCP tools."),
|
|
810
852
|
toolsets: zod.z.record(mcpToolsetNameSchema, mcpToolFilterSchema).optional().describe("Named MCP toolsets and the operation filters for each toolset."),
|
|
@@ -813,6 +855,9 @@ var mcpGenerationConfigSchema = typescriptGenerationConfigSchema.extend({
|
|
|
813
855
|
),
|
|
814
856
|
customTools: zod.z.record(mcpToolNameSchema, mcpCustomToolSchema).optional().describe(
|
|
815
857
|
"Hand-written tools, keyed by tool name, each pointing at a TypeScript module that exports its `definition` and `handler`. Emitted alongside the operation-derived tools."
|
|
858
|
+
),
|
|
859
|
+
hooks: mcpHooksSchema.optional().describe(
|
|
860
|
+
"Customer-authored request/response hooks, emitted into the generated server as `src/hooks.ts` (replacing the no-op stub)."
|
|
816
861
|
)
|
|
817
862
|
});
|
|
818
863
|
|
|
@@ -3208,6 +3253,9 @@ var sdkConfigV1Schema = zod.z.strictObject({
|
|
|
3208
3253
|
targets: zod.z.array(sdkConfigV1TargetSchema).min(1).describe("Language targets to generate; each language may appear once.")
|
|
3209
3254
|
}).superRefine(({ api, output, package: globalPackage, targets }, context) => {
|
|
3210
3255
|
const configuredLanguages = /* @__PURE__ */ new Set();
|
|
3256
|
+
oauthEnvironmentTokenUrlsIssues(api, ["api"]).forEach(
|
|
3257
|
+
(issue) => context.addIssue({ code: "custom", ...issue })
|
|
3258
|
+
);
|
|
3211
3259
|
targets.forEach((target, targetIndex) => {
|
|
3212
3260
|
if (configuredLanguages.has(target.language)) {
|
|
3213
3261
|
context.addIssue({
|
|
@@ -4136,6 +4184,8 @@ function mapMcp(config, state, basePath) {
|
|
|
4136
4184
|
return compact({
|
|
4137
4185
|
serverName: takeString(config, ["serverName"], state, basePath),
|
|
4138
4186
|
serverDescription: takeString(config, ["serverDescription"], state, basePath),
|
|
4187
|
+
instructions: takeString(config, ["instructions"], state, basePath),
|
|
4188
|
+
appendInstructions: takeString(config, ["appendInstructions"], state, basePath),
|
|
4139
4189
|
excludeAvailability: takeEnumArray(
|
|
4140
4190
|
config,
|
|
4141
4191
|
["excludeAvailability"],
|
|
@@ -4155,7 +4205,8 @@ function mapMcp(config, state, basePath) {
|
|
|
4155
4205
|
tools: takeToolFilter(config, ["tools"], state, basePath),
|
|
4156
4206
|
toolsets: takeToolsets(config, ["toolsets"], state, basePath),
|
|
4157
4207
|
mergedTools: takeMergedTools(config, ["mergedTools"], state, basePath),
|
|
4158
|
-
customTools: takeCustomTools(config, ["customTools"], state, basePath)
|
|
4208
|
+
customTools: takeCustomTools(config, ["customTools"], state, basePath),
|
|
4209
|
+
hooks: takeHooks(config, ["hooks"], state, basePath)
|
|
4159
4210
|
});
|
|
4160
4211
|
}
|
|
4161
4212
|
function mapReadme(value, language, activeLanguages, state, basePath) {
|
|
@@ -4537,6 +4588,21 @@ function takeCustomTools(value, aliases, state, basePath) {
|
|
|
4537
4588
|
consume(state, located.path);
|
|
4538
4589
|
return Object.fromEntries(entries.filter((entry) => entry !== void 0));
|
|
4539
4590
|
}
|
|
4591
|
+
function takeHooks(value, aliases, state, basePath) {
|
|
4592
|
+
const located = takeObject(value, aliases, state, basePath);
|
|
4593
|
+
if (!located) return void 0;
|
|
4594
|
+
if (typeof located.value.path !== "string") {
|
|
4595
|
+
fail(
|
|
4596
|
+
"FERN_MCP_HOOKS_SPEC_INVALID",
|
|
4597
|
+
located.path,
|
|
4598
|
+
'MCP hooks must be an object with a string "path"',
|
|
4599
|
+
'Give "hooks" a "path" pointing at the TypeScript module exporting the request/response hooks.',
|
|
4600
|
+
["targets", basePath[2], "generation", "hooks"]
|
|
4601
|
+
);
|
|
4602
|
+
}
|
|
4603
|
+
consume(state, located.path);
|
|
4604
|
+
return { path: located.value.path };
|
|
4605
|
+
}
|
|
4540
4606
|
function takeMergedTools(value, aliases, state, basePath) {
|
|
4541
4607
|
const located = takeObject(value, aliases, state, basePath);
|
|
4542
4608
|
if (!located) return void 0;
|