@postman/sdk-config 0.2.0 → 0.3.1

package/README.md

@@ -36,9 +36,7 @@ const input: SdkConfigV1Input = {
   source: {
     specs: [{ id: 'example', type: 'openapi', path: './openapi.yml' }],
   },
-  api: {},
   client: { timeoutMs: 30_000 },
-  package: {},
   output: { delivery: 'zip', fileName: 'example-typescript.zip' },
   docs: { includeApiReference: true },
   generation: { includeWatermark: true },
@@ -59,6 +57,9 @@ const sdkConfig: SdkConfigV1 = parseSdkConfigV1(document);
 Use `parseSdkConfigV1` when entering the runtime boundary and materializing the shared domain
 defaults. For validation without throwing, use the exported schema:
 
+Empty top-level `api`, `client`, `package`, `docs`, and `generation` blocks may be omitted from the
+customer document. Runtime parsing materializes those blocks and their versioned defaults.
+
 ```ts
 import { sdkConfigV1Schema } from '@postman/sdk-config/sdk-config/v1';
 

package/dist/index.cjs

@@ -283,8 +283,8 @@ var clientConfigSchema = zod.z.strictObject({
 var sdkConfigV1ClientConfigSchema = clientConfigSchema;
 var sdkConfigV1ClientConfigOverrideSchema = clientConfigOverrideSchema;
 var goModulePathSchema = relativePathSchema.regex(
-  /^(?!.*(?:^|\/)\.{1,2}(?:\/|$))[A-Za-z0-9._~-]+(?:\/[A-Za-z0-9._~-]+)+$/,
-  "Go module path must be a slash-delimited path using letters, numbers, dots, dashes, underscores, or tildes"
+  /^(?!.*(?:^|\/)\.{1,2}(?:\/|$))[A-Za-z0-9._~-]+(?:\/[A-Za-z0-9._~-]+)*$/,
+  "Go module path must use letters, numbers, dots, dashes, underscores or tildes, in slash-delimited segments"
 );
 var composerPackageNameSchema = nonEmptyStringSchema.regex(
   /^[a-z0-9]([_.-]?[a-z0-9]+)*\/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$/,
@@ -549,6 +549,9 @@ function compact(value) {
 function optional(key, value) {
   return value === void 0 ? {} : { [key]: value };
 }
+function optionalObject(key, value) {
+  return Object.keys(value).length === 0 ? {} : { [key]: value };
+}
 function isObject(value) {
   return value !== null && typeof value === "object" && !Array.isArray(value);
 }
@@ -1558,12 +1561,12 @@ var sdkConfigV1Schema = zod.z.strictObject({
   sdkVersion: nonEmptyStringSchema.default("1.0.0"),
   apiVersion: nonEmptyStringSchema.optional(),
   source: sdkConfigV1SourceConfigSchema,
-  api: sdkConfigV1ApiConfigSchema,
-  client: sdkConfigV1ClientConfigSchema,
-  package: sdkConfigV1PackageConfigSchema,
+  api: sdkConfigV1ApiConfigSchema.prefault({}),
+  client: sdkConfigV1ClientConfigSchema.prefault({}),
+  package: sdkConfigV1PackageConfigSchema.prefault({}),
   output: sdkConfigV1OutputConfigSchema.optional(),
-  docs: sdkConfigV1DocsConfigSchema,
-  generation: sdkConfigV1GenerationConfigSchema,
+  docs: sdkConfigV1DocsConfigSchema.prefault({}),
+  generation: sdkConfigV1GenerationConfigSchema.prefault({}),
   targets: zod.z.array(sdkConfigV1TargetSchema).min(1)
 }).superRefine(({ output, package: globalPackage, targets }, context) => {
   const configuredLanguages = /* @__PURE__ */ new Set();
@@ -1679,11 +1682,10 @@ function mapFernConfigToSdkConfigV1(input) {
     source: input.source,
     ...optional("sdkVersion", input.sdkVersion),
     ...optional("apiVersion", input.apiVersion),
-    api,
-    client: clients.shared,
-    package: {},
-    docs: docs.shared,
-    generation: generations.shared,
+    ...optionalObject("api", api),
+    ...optionalObject("client", clients.shared),
+    ...optionalObject("docs", docs.shared),
+    ...optionalObject("generation", generations.shared),
     targets
   };
   const parsed = sdkConfigV1Schema.safeParse(sdkConfig);
@@ -2544,19 +2546,74 @@ var commonPublishShape2 = {
    * SDK Config IR; the external publisher or orchestrator resolves this reference before use.
    */
   credentialsRef: nonEmptyStringSchema.optional(),
+  /**
+   * Registry-specific package version override. If omitted, the external publisher/orchestrator may
+   * fall back to target.sdkVersion.
+   */
+  version: nonEmptyStringSchema.optional(),
   releaseBranch: nonEmptyStringSchema.optional(),
-  tolerateRepublish: zod.z.boolean().optional()
+  tolerateRepublish: zod.z.boolean().optional(),
+  /** Generate registry publishing workflow files when publishing through GitHub delivery. */
+  shouldGeneratePublishWorkflow: zod.z.boolean().optional()
+};
+var trustedPublishingShape = {
+  /** Use registry trusted publishing / OIDC instead of a static token secret. */
+  trustedPublishing: zod.z.boolean().optional()
 };
+var mavenCoordinateSchema = nonEmptyStringSchema.regex(
+  /^[A-Za-z0-9_.-]+:[A-Za-z0-9_.-]+$/,
+  "Maven coordinate must be in groupId:artifactId form"
+);
+var mavenSignatureEnvironmentSchema = zod.z.strictObject({
+  keyIdEnvironmentVariable: nonEmptyStringSchema.optional(),
+  passwordEnvironmentVariable: nonEmptyStringSchema.optional(),
+  secretKeyEnvironmentVariable: nonEmptyStringSchema.optional()
+});
 var publishConfigSchema = zod.z.discriminatedUnion("registry", [
-  zod.z.strictObject({ registry: zod.z.literal("npm"), ...commonPublishShape2 }),
-  zod.z.strictObject({ registry: zod.z.literal("pypi"), ...commonPublishShape2 }),
-  zod.z.strictObject({ registry: zod.z.literal("nuget"), ...commonPublishShape2 }),
-  zod.z.strictObject({ registry: zod.z.literal("rubygems"), ...commonPublishShape2 }),
-  zod.z.strictObject({ registry: zod.z.literal("crates"), ...commonPublishShape2 }),
+  zod.z.strictObject({
+    registry: zod.z.literal("npm"),
+    /** Environment variable name containing the npm registry token. */
+    tokenEnvironmentVariable: nonEmptyStringSchema.optional(),
+    /** Write npm package metadata as private when the publisher creates/updates package.json. */
+    isPackagePrivate: zod.z.boolean().optional(),
+    /** Also publish the TypeScript package to JSR from the npm publishing path. */
+    publishToJsr: zod.z.boolean().optional(),
+    ...trustedPublishingShape,
+    ...commonPublishShape2
+  }),
+  zod.z.strictObject({
+    registry: zod.z.literal("pypi"),
+    usernameEnvironmentVariable: nonEmptyStringSchema.optional(),
+    passwordEnvironmentVariable: nonEmptyStringSchema.optional(),
+    ...trustedPublishingShape,
+    ...commonPublishShape2
+  }),
+  zod.z.strictObject({
+    registry: zod.z.literal("nuget"),
+    apiKeyEnvironmentVariable: nonEmptyStringSchema.optional(),
+    ...trustedPublishingShape,
+    ...commonPublishShape2
+  }),
+  zod.z.strictObject({
+    registry: zod.z.literal("rubygems"),
+    apiKeyEnvironmentVariable: nonEmptyStringSchema.optional(),
+    ...commonPublishShape2
+  }),
+  zod.z.strictObject({
+    registry: zod.z.literal("crates"),
+    tokenEnvironmentVariable: nonEmptyStringSchema.optional(),
+    ...commonPublishShape2
+  }),
   zod.z.strictObject({ registry: zod.z.literal("go"), ...commonPublishShape2 }),
   zod.z.strictObject({ registry: zod.z.literal("composer"), ...commonPublishShape2 }),
   zod.z.strictObject({
     registry: zod.z.literal("maven"),
+    /** Maven coordinate in groupId:artifactId form when consumers need the combined value. */
+    coordinate: mavenCoordinateSchema.optional(),
+    usernameEnvironmentVariable: nonEmptyStringSchema.optional(),
+    passwordEnvironmentVariable: nonEmptyStringSchema.optional(),
+    mavenUrlEnvironmentVariable: nonEmptyStringSchema.optional(),
+    signatureEnvironmentVariables: mavenSignatureEnvironmentSchema.optional(),
     /**
      * Reference to Maven signing credentials. Raw signing keys are intentionally not part of SDK
      * Config IR; the external publisher or orchestrator resolves this reference before use.
@@ -2796,6 +2853,13 @@ var sdkConfigIrV1Schema = zod.z.strictObject({
   }
   if (output.publish) {
     validatePublishingIdentity2(packageConfig, output.publish.registry, context);
+    if (output.delivery !== "github" && output.publish.shouldGeneratePublishWorkflow === true) {
+      context.addIssue({
+        code: "custom",
+        message: "output.publish.shouldGeneratePublishWorkflow requires GitHub delivery",
+        path: ["output", "publish", "shouldGeneratePublishWorkflow"]
+      });
+    }
   }
   if (compatibility?.legacyInput) {
     const expectedKind = target.sourceOrigin === "postman" ? "postman-build-parameters" : "fern-generator-invocation";