@postman/sdk-config 0.9.0 → 0.11.0

package/dist/sdk-config-ir/v1/index.js

@@ -125,13 +125,21 @@ var oauthScopeSchema = z.strictObject({
   name: nonEmptyStringSchema.describe("The OAuth scope value requested from the provider."),
   description: z.string().optional().describe("A description of the OAuth scope included in generated SDK documentation.")
 });
+var publicClientIdSchema = nonEmptyStringSchema.refine((value) => value.trim() === value, {
+  message: "must not have leading or trailing whitespace"
+}).refine((value) => !value.includes("${"), {
+  message: "must be a literal public client ID, not an environment expression"
+});
 var oauthFlowSchema = z.discriminatedUnion("type", [
   z.strictObject({
     type: z.literal("authorization-code").describe("Uses the OAuth authorization code flow."),
     authorizationUrl: nonEmptyStringSchema.describe("The URL used to authorize the client."),
     tokenUrl: nonEmptyStringSchema.describe("The URL used to exchange a code for tokens."),
     refreshUrl: nonEmptyStringSchema.optional().describe("The URL used to refresh access tokens."),
-    scopes: z.array(oauthScopeSchema).optional().describe("The scopes supported by this flow.")
+    scopes: z.array(oauthScopeSchema).optional().describe("The scopes supported by this flow."),
+    clientId: publicClientIdSchema.optional().describe(
+      "The public, non-secret OAuth client ID that generated interactive login flows, such as CLI browser login with PKCE, send to the authorization and token endpoints. It is embedded verbatim in generated code, so it must never be a client secret."
+    )
   }),
   z.strictObject({
     type: z.literal("client-credentials").describe("Uses the OAuth client credentials flow."),
@@ -391,6 +399,91 @@ var compatibilityConfigSchema = z.strictObject({
   legacyInput: legacyInputSchema.optional().describe("Original producer input retained only for migration debugging."),
   unsupportedFields: z.array(unsupportedFieldSchema).optional().describe("Legacy fields that could not be represented in normalized configuration.")
 });
+var GITHUB_ACTIONS_SECRET_NAME_PATTERN = /^[A-Z][A-Z0-9_]*$/;
+var GITHUB_REPOSITORY_SLUG_PATTERN = /^[A-Za-z0-9._-]+\/[A-Za-z0-9._-]+$/;
+var HOMEBREW_FORMULA_NAME_PATTERN = /^[a-z][a-z0-9-]*$/;
+var githubActionsSecretNameSchema = z.string({ error: "must be the name of a GitHub Actions secret" }).regex(GITHUB_ACTIONS_SECRET_NAME_PATTERN, {
+  error: "must be the name of a GitHub Actions secret: start with an uppercase letter and contain only A-Z, 0-9, or _. Secret values and ${...} expressions are not accepted."
+}).refine((value) => value !== "GITHUB_TOKEN", {
+  error: "GITHUB_TOKEN cannot be used: it is the workflow's built-in token, scoped to the generated repository. Store the credential under a different secret name."
+});
+var githubRepositorySlugSchema = z.string({ error: 'must be a GitHub repository in "<owner>/<repo>" form' }).regex(GITHUB_REPOSITORY_SLUG_PATTERN, {
+  error: 'must be a GitHub repository in "<owner>/<repo>" form, for example "acme/homebrew-tap"'
+});
+var homebrewFormulaNameSchema = z.string({ error: "must be a Homebrew formula name" }).regex(HOMEBREW_FORMULA_NAME_PATTERN, {
+  error: "must be a Homebrew formula name: start with a lowercase letter and contain only a-z, 0-9, or -"
+});
+var cliDistributionGithubAppSchema = z.strictObject({
+  appIdSecretName: githubActionsSecretNameSchema.describe(
+    "The name of the GitHub Actions secret holding the GitHub App ID or client ID."
+  ),
+  privateKeySecretName: githubActionsSecretNameSchema.describe(
+    "The name of the GitHub Actions secret holding the GitHub App private key in PEM form."
+  )
+});
+var channelTokenSecretNameDescription = "The name of the GitHub Actions secret holding a token with write access to the channel repository. Takes precedence over githubApp for this channel.";
+var cliDistributionHomebrewSchema = z.strictObject({
+  tap: githubRepositorySlugSchema.describe(
+    'The Homebrew tap repository in "<owner>/<repo>" form that receives the formula.'
+  ),
+  formula: homebrewFormulaNameSchema.optional().describe("The Homebrew formula name; the generator defaults it to the CLI binary name."),
+  tokenSecretName: githubActionsSecretNameSchema.optional().describe(channelTokenSecretNameDescription)
+});
+var cliDistributionScoopSchema = z.strictObject({
+  bucket: githubRepositorySlugSchema.describe(
+    'The Scoop bucket repository in "<owner>/<repo>" form that receives the manifest.'
+  ),
+  tokenSecretName: githubActionsSecretNameSchema.optional().describe(channelTokenSecretNameDescription)
+});
+var cliDistributionConfigSchema = z.strictObject({
+  githubApp: cliDistributionGithubAppSchema.optional().describe(
+    "A GitHub App used to mint short-lived tokens for every channel without its own tokenSecretName."
+  ),
+  homebrew: cliDistributionHomebrewSchema.optional().describe("Publishes a Homebrew formula to a tap repository on each tagged release."),
+  scoop: cliDistributionScoopSchema.optional().describe("Publishes a Scoop manifest to a bucket repository on each tagged release.")
+}).superRefine((distribution, context) => {
+  if (distribution.homebrew !== void 0 || distribution.scoop !== void 0) {
+    return;
+  }
+  if (distribution.githubApp !== void 0) {
+    context.addIssue({
+      code: "custom",
+      message: "githubApp requires at least one distribution channel: homebrew or scoop",
+      path: ["githubApp"]
+    });
+    return;
+  }
+  context.addIssue({
+    code: "custom",
+    message: "distribution must configure at least one channel: homebrew or scoop"
+  });
+});
+var CLI_DISTRIBUTION_REQUIRES_GITHUB_DELIVERY_MESSAGE = 'distribution requires output.delivery "github": Homebrew and Scoop publish from a tagged GitHub Release produced by the generated release workflow. Set delivery to "github" or remove distribution.';
+var CLI_PUBLISH_REQUIRES_GITHUB_DELIVERY_MESSAGE = 'package publication for target language "cli" requires output.delivery "github": the CLI generator publishes npm packages only from its generated GitHub workflow.';
+var CLI_DISTRIBUTION_NON_RELEASE_MODE_CODE = "CLI_DISTRIBUTION_NON_RELEASE_MODE";
+var nonReleaseGithubModes = /* @__PURE__ */ new Set(["pull-request", "push", "commit"]);
+function cliDistributionModeDiagnostic(output, outputPath) {
+  const mode = output?.github?.mode;
+  if (output?.distribution === void 0 || mode === void 0 || !nonReleaseGithubModes.has(mode)) {
+    return void 0;
+  }
+  return {
+    code: CLI_DISTRIBUTION_NON_RELEASE_MODE_CODE,
+    severity: "warning",
+    path: [...outputPath, "github", "mode"],
+    reason: `GitHub mode "${mode}" does not create a release tag, so Homebrew and Scoop publish only after a semantic-version tag is pushed to the repository.`,
+    suggestedAction: 'Use mode "release" or "commit-and-release", or push a version tag after merging generated changes.'
+  };
+}
+
+// src/sdk-config-ir/v1/diagnostics.ts
+function getSdkConfigIrV1Diagnostics(config) {
+  if (config.target.language !== "cli") {
+    return [];
+  }
+  const diagnostic = cliDistributionModeDiagnostic(config.output, ["output"]);
+  return diagnostic ? [diagnostic] : [];
+}
 var httpMethodSchema = z.enum([
   "GET",
   "POST",
@@ -444,9 +537,117 @@ var namingConfigSchema = z.strictObject({
   /** Preserve a word boundary after digits when Fern smart casing is enabled. */
   smartCasingDigitWordBoundary: z.boolean().optional().describe("Whether smart casing preserves a word boundary after digits.")
 });
+var ALPHANUMERIC_PATTERN = /[A-Za-z0-9]/;
+var ROOT_GROUP_PATTERN = /^[a-z][a-z0-9_-]*$/;
+var KEBAB_NAME_PATTERN = /^[a-z][a-z0-9-]*$/;
+var DOTTED_COMMAND_PATH_PATTERN = /^[a-z0-9-]+(?:\.[a-z0-9-]+)+$/;
+var FIELD_NAME_PATTERN = /^[A-Za-z0-9_.-]+$/;
+var RESERVED_USER_AGENT_SUFFIX_FLAGS = /* @__PURE__ */ new Set([
+  "params",
+  "output",
+  "json",
+  "format",
+  "dry-run",
+  "base-url",
+  "page-all",
+  "page-limit",
+  "page-delay",
+  "no-pager",
+  "no-extract",
+  "no-retry",
+  "no-stream",
+  "quiet",
+  "query",
+  "help",
+  "debug",
+  "schema"
+]);
+var RESERVED_PROFILES_COMMAND_NAMES = /* @__PURE__ */ new Set([
+  "auth",
+  "completion",
+  "man",
+  "errors",
+  "generate-skills",
+  "help"
+]);
+var binaryNameSchema = nonEmptyStringSchema.regex(ALPHANUMERIC_PATTERN, {
+  message: "binaryName must contain at least one ASCII letter or digit"
+});
+var rootGroupSchema = z.string().regex(ROOT_GROUP_PATTERN, {
+  message: "rootGroup must start with a lowercase letter and contain only lowercase letters, digits, hyphens, and underscores"
+});
+var userAgentSuffixFlagSchema = z.string().superRefine((value, context) => {
+  if (value.startsWith("-")) {
+    context.addIssue({
+      code: "custom",
+      message: 'userAgentSuffixFlag must be the long flag name without the leading "--"'
+    });
+  } else if (!KEBAB_NAME_PATTERN.test(value)) {
+    context.addIssue({
+      code: "custom",
+      message: "userAgentSuffixFlag must start with a lowercase letter and contain only lowercase letters, digits, and hyphens"
+    });
+  } else if (RESERVED_USER_AGENT_SUFFIX_FLAGS.has(value)) {
+    context.addIssue({
+      code: "custom",
+      message: `userAgentSuffixFlag "${value}" collides with a built-in global flag`
+    });
+  }
+});
+var profilesCommandNameSchema = z.string().superRefine((value, context) => {
+  if (!KEBAB_NAME_PATTERN.test(value)) {
+    context.addIssue({
+      code: "custom",
+      message: "profiles.commandName must start with a lowercase letter and contain only lowercase letters, digits, and hyphens"
+    });
+  } else if (RESERVED_PROFILES_COMMAND_NAMES.has(value)) {
+    context.addIssue({
+      code: "custom",
+      message: `profiles.commandName "${value}" collides with a built-in command group`
+    });
+  }
+});
+function dottedCommandPathSchema(field) {
+  return z.string().regex(DOTTED_COMMAND_PATH_PATTERN, {
+    message: `${field} must be a dotted command path such as "iam.keys.create"`
+  });
+}
+function fieldNameMapSchema(field) {
+  const message = `${field} keys and values must be field names containing only [A-Za-z0-9_.-]`;
+  return z.record(z.string(), z.string().regex(FIELD_NAME_PATTERN, { message })).superRefine((value, context) => {
+    for (const key of Object.keys(value)) {
+      if (!FIELD_NAME_PATTERN.test(key)) {
+        context.addIssue({ code: "custom", message, path: [key] });
+      }
+    }
+  });
+}
+var profilesProvisionOperationSchema = z.strictObject({
+  operation: dottedCommandPathSchema("profiles.provisionOperation.operation").describe(
+    "The dotted command path of the operation that mints a profile credential."
+  ),
+  credential: fieldNameMapSchema("profiles.provisionOperation.credential").refine((value) => Object.keys(value).length > 0, {
+    message: "profiles.provisionOperation.credential must map at least one credential field"
+  }).describe("Maps each stored credential field to the response field that supplies it."),
+  revokeParameters: fieldNameMapSchema("profiles.provisionOperation.revokeParameters").optional().describe("Maps each revoke-operation parameter to the response field that supplies it.")
+});
+var profilesConfigSchema = z.strictObject({
+  enabled: z.boolean().describe("Whether the CLI emits profile commands and the global --profile flag."),
+  commandName: profilesCommandNameSchema.optional().describe('The profile command group name. The generator defaults to "profiles".'),
+  revokeOperation: dottedCommandPathSchema("profiles.revokeOperation").optional().describe('The dotted command path called by "profiles remove --revoke".'),
+  provisionOperation: profilesProvisionOperationSchema.optional().describe('The operation called by "profiles create --provision" and its response mapping.')
+});
 var cliGenerationConfigSchema = z.strictObject({
   paginationParameters: z.array(nonEmptyStringSchema).optional().describe("Request parameter names treated as pagination controls by the CLI."),
-  skills: z.boolean().optional().describe("Whether the generated CLI includes skills that teach AI agents to invoke commands.")
+  skills: z.boolean().optional().describe("Whether the generated CLI includes skills that teach AI agents to invoke commands."),
+  binaryName: binaryNameSchema.optional().describe(
+    "The CLI executable name. The generator kebab-cases it and also uses it for the source directory and env-var prefix."
+  ),
+  customCommands: z.boolean().optional().describe("Whether hand-written command support is generated. The generator defaults to true."),
+  rootGroup: rootGroupSchema.optional().describe("A command group that every spec-derived command is nested under."),
+  profiles: profilesConfigSchema.optional().describe("Named profile command configuration."),
+  splitTypeCrates: z.boolean().optional().describe("Whether generated types are split into one crate per API behind a facade crate."),
+  userAgentSuffixFlag: userAgentSuffixFlagSchema.optional().describe('The long flag name, without "--", that appends a product token to the User-Agent.')
 });
 var csharpGenerationConfigSchema = z.strictObject({
   useOptionalWrapper: z.boolean().optional().describe("Whether optional values use an explicit Optional wrapper."),
@@ -680,7 +881,10 @@ var packageConfigSchema = z.strictObject({
   projectUrls: z.array(projectUrlSchema).optional().describe("Labeled project links for package metadata."),
   extraDependencies: z.array(dependencySchema).optional().describe("Additional runtime dependencies added to the generated package."),
   extraDevDependencies: z.array(dependencySchema).optional().describe("Additional development dependencies added to the generated package."),
-  extraPeerDependencies: z.array(dependencySchema).optional().describe("Additional peer dependencies added to the generated package.")
+  extraPeerDependencies: z.array(dependencySchema).optional().describe("Additional peer dependencies added to the generated package."),
+  extraPeerDependenciesMeta: z.record(nonEmptyStringSchema, jsonObjectSchema).optional().describe(
+    "npm peerDependenciesMeta entries keyed by peer dependency name, such as { optional: true }."
+  )
 });
 
 // src/sdk-config-domain/v1/language/terraform.ts
@@ -1020,6 +1224,12 @@ var githubOutputSchema = z.strictObject({
   /** Automatically merge the GitHub publishing PR. Defaults to false. */
   autoMerge: z.boolean().default(false).describe("Whether the GitHub publisher automatically merges its pull request.")
 });
+var distributionShape = {
+  /** Valid only for `cli` targets with GitHub delivery; secret names only, never values. */
+  distribution: cliDistributionConfigSchema.optional().describe(
+    "CLI release channels published by the generated release workflow; credentials are GitHub Actions secret names."
+  )
+};
 var credentialResolutionShape = {
   /** Where output credential references are resolved. */
   credentialResolution: credentialResolutionSchema.default("refs-only").describe("Where output credential references are resolved.")
@@ -1028,18 +1238,21 @@ var filesOutputSchema = z.strictObject({
   delivery: z.literal("files").describe("Writes the generated SDK to a directory."),
   path: nonEmptyStringSchema.optional().describe("The destination directory for generated files."),
   publish: publishConfigSchema.optional().describe("Optional package registry publication."),
+  ...distributionShape,
   ...credentialResolutionShape
 });
 var zipOutputSchema = z.strictObject({
   delivery: z.literal("zip").describe("Packages the generated SDK as a ZIP archive."),
   fileName: nonEmptyStringSchema.optional().describe("The generated ZIP archive file name."),
   publish: publishConfigSchema.optional().describe("Optional package registry publication."),
+  ...distributionShape,
   ...credentialResolutionShape
 });
 var githubDeliverySchema = z.strictObject({
   delivery: z.literal("github").describe("Delivers the generated SDK to GitHub."),
   github: githubOutputSchema.describe("GitHub repository delivery settings."),
   publish: publishConfigSchema.optional().describe("Optional package registry publication."),
+  ...distributionShape,
   ...credentialResolutionShape
 });
 var outputConfigSchema = z.discriminatedUnion(
@@ -1159,7 +1372,7 @@ var targetConfigSchema = z.strictObject({
 // src/sdk-config-ir/v1/sdk-config-ir-v1.ts
 var SDK_CONFIG_IR_V1_SCHEMA_VERSION = "sdk-config-ir/v1";
 var publishRegistryLanguages = {
-  npm: ["typescript", "mcp"],
+  npm: ["typescript", "mcp", "cli"],
   pypi: ["python"],
   maven: ["java", "kotlin"],
   nuget: ["csharp"],
@@ -1214,6 +1427,28 @@ function validatePublishingIdentity(packageConfig, registry, context) {
     });
   }
 }
+function validateCliOutput(output, language, context) {
+  if (output.distribution !== void 0 && language !== "cli") {
+    context.addIssue({
+      code: "custom",
+      message: `output.distribution is supported only for target language "cli", not "${language}"`,
+      path: ["output", "distribution"]
+    });
+  } else if (output.distribution !== void 0 && output.delivery !== "github") {
+    context.addIssue({
+      code: "custom",
+      message: CLI_DISTRIBUTION_REQUIRES_GITHUB_DELIVERY_MESSAGE,
+      path: ["output", "distribution"]
+    });
+  }
+  if (language === "cli" && output.publish && output.delivery !== "github") {
+    context.addIssue({
+      code: "custom",
+      message: CLI_PUBLISH_REQUIRES_GITHUB_DELIVERY_MESSAGE,
+      path: ["output", "publish"]
+    });
+  }
+}
 var sdkConfigIrV1Schema = z.strictObject({
   schemaVersion: z.literal(SDK_CONFIG_IR_V1_SCHEMA_VERSION).describe("The version of the normalized SDK Config IR schema."),
   source: sourceConfigSchema.describe("Materialized API descriptions consumed by generation."),
@@ -1275,6 +1510,7 @@ var sdkConfigIrV1Schema = z.strictObject({
       });
     }
   }
+  validateCliOutput(output, target.language, context);
   if (compatibility?.legacyInput) {
     const expectedKind = target.sourceOrigin === "postman" ? "postman-build-parameters" : "fern-generator-invocation";
     if (compatibility.legacyInput.kind !== expectedKind) {
@@ -1435,6 +1671,6 @@ function parseSdkConfigIrV1ForConsumption(value) {
   return parseSdkConfigIrV1(stripUnknownProperties(value, sdkConfigIrV1InputJsonSchema));
 }
 
-export { SDK_CONFIG_IR_V1_SCHEMA_VERSION, apiConfigSchema, apiImportSettingsSchema, authConfigSchema, authSchemeSchema, cliGenerationConfigSchema, clientConfigOverrideSchema, clientConfigSchema, clientRetryOverrideSchema, compatibilityConfigSchema, composerPackageNameSchema, csharpGenerationConfigSchema, dependencySchema, docsConfigSchema, exactSemverSchema, generationConfigSchema, goGenerationConfigSchema, goModulePathSchema, javaGenerationConfigSchema, jsonObjectSchema, jsonValueSchema, kotlinGenerationConfigSchema, languageGenerationConfigSchema, legacyInputSchema, mcpAvailabilityStatuses, mcpGenerationConfigSchema, nonEmptyStringSchema, outputConfigSchema, packageConfigSchema, parseSdkConfigIrV1, parseSdkConfigIrV1ForConsumption, phpGenerationConfigSchema, publishConfigSchema, publishRegistrySchema, pythonGenerationConfigSchema, readmeCustomSectionSchema, readmeEndpointSchema, relativePathSchema, replayConfigSchema, rubyGenerationConfigSchema, rustGenerationConfigSchema, sdkConfigIrCapabilitySchema, sdkConfigIrV1Schema, serializeSdkConfigIrV1, sourceConfigSchema, sourceSpecConfigSchema, sourceSpecTypeSchema, swiftGenerationConfigSchema, targetConfigSchema, targetLanguageSchema, terraformGenerationConfigSchema, typescriptGenerationConfigSchema, unsupportedFieldSchema, webhookSignatureSchema };
+export { CLI_DISTRIBUTION_NON_RELEASE_MODE_CODE, SDK_CONFIG_IR_V1_SCHEMA_VERSION, apiConfigSchema, apiImportSettingsSchema, authConfigSchema, authSchemeSchema, cliDistributionConfigSchema, cliDistributionGithubAppSchema, cliDistributionHomebrewSchema, cliDistributionScoopSchema, cliGenerationConfigSchema, clientConfigOverrideSchema, clientConfigSchema, clientRetryOverrideSchema, compatibilityConfigSchema, composerPackageNameSchema, csharpGenerationConfigSchema, dependencySchema, docsConfigSchema, exactSemverSchema, generationConfigSchema, getSdkConfigIrV1Diagnostics, githubActionsSecretNameSchema, goGenerationConfigSchema, goModulePathSchema, javaGenerationConfigSchema, jsonObjectSchema, jsonValueSchema, kotlinGenerationConfigSchema, languageGenerationConfigSchema, legacyInputSchema, mcpAvailabilityStatuses, mcpGenerationConfigSchema, nonEmptyStringSchema, outputConfigSchema, packageConfigSchema, parseSdkConfigIrV1, parseSdkConfigIrV1ForConsumption, phpGenerationConfigSchema, publishConfigSchema, publishRegistrySchema, pythonGenerationConfigSchema, readmeCustomSectionSchema, readmeEndpointSchema, relativePathSchema, replayConfigSchema, rubyGenerationConfigSchema, rustGenerationConfigSchema, sdkConfigIrCapabilitySchema, sdkConfigIrV1Schema, serializeSdkConfigIrV1, sourceConfigSchema, sourceSpecConfigSchema, sourceSpecTypeSchema, swiftGenerationConfigSchema, targetConfigSchema, targetLanguageSchema, terraformGenerationConfigSchema, typescriptGenerationConfigSchema, unsupportedFieldSchema, webhookSignatureSchema };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map