@postman/sdk-config 0.5.1 → 0.7.0

package/dist/sdk-config/index.cjs

@@ -790,6 +790,7 @@ function githubOutput(value, publishInfo, rawOutput, language, sourcePath, state
   consume(state, [...sourcePath, "repo"]);
   const publication = publishInfo ? mapPublication(publishInfo, rawOutput, language, [...sourcePath, "publishInfo"], state, index) : void 0;
   const type = stringValue(value.type);
+  const licensePackage = mapGithubLicense(value.license, [...sourcePath, "license"], state);
   const reviewers = mapReviewers(value.reviewers, [...sourcePath, "reviewers"], state);
   if (type) consume(state, [...sourcePath, "type"]);
   if (typeof value.makePr === "boolean") consume(state, [...sourcePath, "makePr"]);
@@ -816,9 +817,20 @@ function githubOutput(value, publishInfo, rawOutput, language, sourcePath, state
       },
       ...publication ? { publish: publication.publish } : {}
     },
-    ...optional("package", publication?.package)
+    // The GitHub license wins over a publication-supplied one; `licensePackage` is `{}` or `{ license }`.
+    ...optionalObject("package", { ...publication?.package, ...licensePackage })
   };
 }
+var basicLicenseTypes = { mit: "MIT", apache: "APACHE" };
+function mapGithubLicense(value, sourcePath, state) {
+  if (!isObject(value) || stringValue(value.type) !== "basic") return {};
+  const id = stringValue(value.id);
+  const type = id ? basicLicenseTypes[id.toLowerCase()] : void 0;
+  if (!type) return {};
+  consume(state, [...sourcePath, "type"]);
+  consume(state, [...sourcePath, "id"]);
+  return { license: { type } };
+}
 function consumeCredentialObject(value, sourcePath, state) {
   if (!isObject(value)) return;
   for (const field of ["username", "password", "token", "apiKey"]) {
@@ -1339,6 +1351,113 @@ function outputDiagnostic(path, index) {
     suggestedAction: resolvedGuidance?.suggestedAction ?? "Review this output setting and preserve it outside SDK Config when no equivalent exists."
   };
 }
+var OMIT = /* @__PURE__ */ Symbol("omit");
+function inputJsonSchema(schema) {
+  return zod.z.toJSONSchema(schema, {
+    io: "input",
+    unrepresentable: "any"
+  });
+}
+function stripUnknownProperties(value, schema) {
+  return project(value, schema, schema);
+}
+function project(value, candidateSchema, rootSchema, omitDefaults) {
+  const resolvedCandidate = resolveSchema(candidateSchema, rootSchema);
+  const schema = selectSchema(value, resolvedCandidate, rootSchema);
+  if (Array.isArray(value)) {
+    if (!schema.items) return value;
+    return value.map((item) => {
+      const projected = project(item, schema.items, rootSchema);
+      return projected === OMIT ? item : projected;
+    });
+  }
+  if (!isRecord(value) || schema.type !== "object") return value;
+  const entries = [];
+  const properties = schema.properties ?? {};
+  const unionProperties = collectAlternativeProperties(resolvedCandidate, rootSchema);
+  for (const [key, propertySchema] of Object.entries(properties)) {
+    if (!Object.hasOwn(value, key)) continue;
+    const projected = project(value[key], propertySchema, rootSchema);
+    if (projected !== OMIT) entries.push([key, projected]);
+  }
+  for (const [key, fieldValue] of Object.entries(value)) {
+    if (Object.hasOwn(properties, key)) continue;
+    if (Object.hasOwn(unionProperties, key)) {
+      entries.push([key, fieldValue]);
+      continue;
+    }
+    if (schema.additionalProperties !== false) {
+      const projected = typeof schema.additionalProperties === "object" ? project(fieldValue, schema.additionalProperties, rootSchema) : fieldValue;
+      if (projected !== OMIT) entries.push([key, projected]);
+    }
+  }
+  return Object.fromEntries(entries);
+}
+function collectAlternativeProperties(schema, rootSchema) {
+  const alternatives = schema.oneOf ?? schema.anyOf;
+  if (!alternatives) return schema.properties ?? {};
+  return Object.assign(
+    {},
+    ...alternatives.map((alternative) => resolveSchema(alternative, rootSchema).properties ?? {})
+  );
+}
+function selectSchema(value, schema, rootSchema) {
+  const alternatives = schema.oneOf ?? schema.anyOf;
+  if (!alternatives || alternatives.length === 0) return schema;
+  const best = alternatives.map((alternative, index) => {
+    const resolved = resolveSchema(alternative, rootSchema);
+    return { index, schema: resolved, score: schemaMatchScore(value, resolved) };
+  }).sort((left, right) => right.score - left.score || left.index - right.index)[0];
+  return best.score === Number.NEGATIVE_INFINITY ? schema : best.schema;
+}
+function schemaMatchScore(value, schema) {
+  if (Object.hasOwn(schema, "const") && !deepEqual(value, schema.const)) {
+    return Number.NEGATIVE_INFINITY;
+  }
+  if (schema.enum && !schema.enum.some((candidate) => deepEqual(value, candidate))) {
+    return Number.NEGATIVE_INFINITY;
+  }
+  if (schema.type === "object") {
+    if (!isRecord(value)) return Number.NEGATIVE_INFINITY;
+    const properties = schema.properties ?? {};
+    for (const [key, propertySchema] of Object.entries(properties)) {
+      if (!Object.hasOwn(value, key)) continue;
+      if (Object.hasOwn(propertySchema, "const") && !deepEqual(value[key], propertySchema.const)) {
+        return Number.NEGATIVE_INFINITY;
+      }
+    }
+    return Object.keys(value).filter((key) => Object.hasOwn(properties, key)).length;
+  }
+  if (schema.type === "array") return Array.isArray(value) ? 1 : Number.NEGATIVE_INFINITY;
+  if (schema.type === "string") return typeof value === "string" ? 1 : Number.NEGATIVE_INFINITY;
+  if (schema.type === "number" || schema.type === "integer") {
+    return typeof value === "number" ? 1 : Number.NEGATIVE_INFINITY;
+  }
+  if (schema.type === "boolean") return typeof value === "boolean" ? 1 : Number.NEGATIVE_INFINITY;
+  if (schema.type === "null") return value === null ? 1 : Number.NEGATIVE_INFINITY;
+  return 0;
+}
+function resolveSchema(schema, rootSchema) {
+  if (!schema.$ref) return schema;
+  if (!schema.$ref.startsWith("#/$defs/")) return schema;
+  const name = schema.$ref.slice("#/$defs/".length).replaceAll("~1", "/").replaceAll("~0", "~");
+  return rootSchema.$defs?.[name] ?? schema;
+}
+function isRecord(value) {
+  return value !== null && typeof value === "object" && !Array.isArray(value);
+}
+function deepEqual(left, right) {
+  if (Object.is(left, right)) return true;
+  if (Array.isArray(left) && Array.isArray(right)) {
+    return left.length === right.length && left.every((value, index) => deepEqual(value, right[index]));
+  }
+  if (isRecord(left) && isRecord(right)) {
+    const leftKeys = Object.keys(left);
+    const rightKeys = Object.keys(right);
+    return leftKeys.length === rightKeys.length && leftKeys.every((key) => Object.hasOwn(right, key) && deepEqual(left[key], right[key]));
+  }
+  return false;
+}
 var namingConfigSchema = zod.z.strictObject({
   clientName: nonEmptyStringSchema.optional(),
   exportedClientName: nonEmptyStringSchema.optional(),
@@ -1699,17 +1818,22 @@ var typescriptGenerationConfigSchema = zod.z.strictObject({
   compilerOptions: compilerOptionsSchema.optional(),
   httpClient: httpClientSchema.optional(),
   packageManager: zod.z.enum(["pnpm", "yarn"]).optional(),
+  /** e.g. `1.22.22` — from the customer's own `config.packageJson.packageManager` (`yarn@1.22.22`). */
+  packageManagerVersion: nonEmptyStringSchema.optional(),
   testFramework: zod.z.enum(["jest", "vitest"]).optional(),
   namingStrategy: zod.z.enum(["base", "originalPropertyNames"]).optional(),
   bundle: zod.z.boolean().optional(),
   exportClassDefault: zod.z.boolean().optional(),
   /** Name of the top-level namespace export emitted by Fern-compatible TypeScript SDKs. */
   namespaceExportName: nonEmptyStringSchema.optional(),
+  consolidateTypeFiles: zod.z.boolean().optional(),
   allowCustomFetcher: zod.z.boolean().optional(),
   useBrandedStringAliases: zod.z.boolean().optional(),
   useLegacyExports: zod.z.boolean().optional(),
   useBigInt: zod.z.boolean().optional(),
   serdeLayer: zod.z.boolean().optional(),
+  /** Ship only the ESM build (drops CJS) to avoid the Node dual-package hazard. */
+  esmOnly: zod.z.boolean().optional(),
   scripts: zod.z.array(packageScriptSchema).optional()
 });
 
@@ -2017,6 +2141,10 @@ function validateSdkConfigV1(value) {
 function parseSdkConfigV1(value) {
   return sdkConfigV1Schema.parse(value);
 }
+var sdkConfigV1InputJsonSchema = inputJsonSchema(sdkConfigV1Schema);
+function parseSdkConfigV1ForConsumption(value) {
+  return parseSdkConfigV1(stripUnknownProperties(value, sdkConfigV1InputJsonSchema));
+}
 
 // src/sdk-config/v1/fern-config-mapper.ts
 var generatorLanguages = {
@@ -2379,15 +2507,23 @@ function mapCommonConfig(language, config, state, client, generation, packageCon
     };
   }
   const pythonClient = language === "python" ? takeObject(config, ["client"], state, basePath) : void 0;
+  const typescriptNaming = language === "typescript" || language === "mcp" ? takeObject(config, ["naming"], state, basePath) : void 0;
   const directClientName = takeString(config, ["clientName", "clientClassName"], state, basePath);
-  const nestedClientName = pythonClient ? takeString(pythonClient.value, ["className"], state, pythonClient.path) : void 0;
+  const nestedClientName = pythonClient ? takeString(pythonClient.value, ["className"], state, pythonClient.path) : typescriptNaming ? takeString(typescriptNaming.value, ["client"], state, typescriptNaming.path) : void 0;
   const directExportedClientName = takeString(
     config,
     ["exportedClientName", "exportedClientClassName"],
     state,
     basePath
   );
-  const nestedExportedClientName = pythonClient ? takeString(pythonClient.value, ["exportedClassName"], state, pythonClient.path) : void 0;
+  const nestedExportedClientName = pythonClient ? takeString(pythonClient.value, ["exportedClassName"], state, pythonClient.path) : typescriptNaming ? (
+    // TypeScript's `naming.namespace` is the base every other naming.* field defaults from
+    // (Fern's docs: `client` defaults to `${PascalCase(namespace)}Client`, same for
+    // `environment`/`error`/etc.) — the same role `exportedClientName` already plays for every
+    // other language's `clientPrefix` derivation.
+    takeString(typescriptNaming.value, ["namespace"], state, typescriptNaming.path)
+  ) : void 0;
+  const nestedEnvironmentTypeName = typescriptNaming ? takeString(typescriptNaming.value, ["environment"], state, typescriptNaming.path) : void 0;
   const naming = compact({
     pagerName: takeString(
       config,
@@ -2397,12 +2533,7 @@ function mapCommonConfig(language, config, state, client, generation, packageCon
     ),
     clientName: directClientName ?? nestedClientName,
     exportedClientName: directExportedClientName ?? nestedExportedClientName,
-    environmentTypeName: takeString(
-      config,
-      ["environmentClassName", "environmentEnumName"],
-      state,
-      basePath
-    ),
+    environmentTypeName: takeString(config, ["environmentClassName", "environmentEnumName"], state, basePath) ?? nestedEnvironmentTypeName,
     apiErrorName: takeString(config, ["baseApiExceptionClassName"], state, basePath),
     baseErrorName: takeString(config, ["baseExceptionClassName"], state, basePath)
   });
@@ -2416,6 +2547,10 @@ function mapCommonConfig(language, config, state, client, generation, packageCon
     basePath
   );
   if (webSockets !== void 0) generation.webSockets = webSockets;
+  if (language === "typescript") {
+    const streams = mapTypescriptStreams(config, state, basePath);
+    if (streams) generation.streams = streams;
+  }
   const generateFullProject = takeBoolean(config, ["generateFullProject"], state, basePath);
   if (generateFullProject !== void 0) generation.generateFullProject = generateFullProject;
   const inlineTypes = takeBoolean(config, ["enableInlineTypes"], state, basePath);
@@ -2433,6 +2568,18 @@ function mapCommonConfig(language, config, state, client, generation, packageCon
   if (packagePath !== void 0) generation.layout = { packagePath };
   mapDependencies(config, state, packageConfig, basePath);
 }
+function mapTypescriptStreams(config, state, basePath) {
+  const responseType = takeEnum(config, ["streamType"], ["wrapper", "web"], state, basePath);
+  const fileResponseType = takeEnum(
+    config,
+    ["fileResponseType"],
+    ["stream", "binary-response"],
+    state,
+    basePath
+  );
+  if (responseType === void 0 && fileResponseType === void 0) return void 0;
+  return { enabled: true, ...compact({ responseType, fileResponseType }) };
+}
 function mapLanguageConfig(language, config, state, packageConfig, basePath) {
   switch (language) {
     case "typescript":
@@ -2466,29 +2613,39 @@ function mapLanguageConfig(language, config, state, packageConfig, basePath) {
   }
 }
 function mapTypescript(config, state, packageConfig, basePath) {
-  mapPackageManifest(config, ["packageJson"], state, packageConfig, basePath);
+  const packageJsonManifest = mapPackageManifest(
+    config,
+    ["packageJson"],
+    state,
+    packageConfig,
+    basePath
+  );
+  const packageJsonPackageManager = packageJsonManifest ? takeString(packageJsonManifest.value, ["packageManager"], state, packageJsonManifest.path) : void 0;
+  const packageManagerAtIndex = packageJsonPackageManager ? packageJsonPackageManager.indexOf("@", packageJsonPackageManager.startsWith("@") ? 1 : 0) : -1;
+  const packageManagerVersionPart = packageManagerAtIndex >= 0 ? packageJsonPackageManager?.slice(packageManagerAtIndex + 1).split("+")[0] : void 0;
+  const packageManagerVersion = packageManagerVersionPart || void 0;
   const serdeLayer = takeBoolean(config, ["serdeLayer"], state, basePath);
   const noSerdeLayer = takeBoolean(config, ["noSerdeLayer"], state, basePath);
   const fetchSupport = takeEnum(config, ["fetchSupport"], ["native"], state, basePath);
+  const namingObject = takeObject(config, ["naming"], state, basePath);
+  const nestedNamespace = namingObject ? takeString(namingObject.value, ["namespace"], state, namingObject.path) : void 0;
   return compact({
     typescriptVersion: takeString(config, ["typescriptVersion"], state, basePath),
     zodVersion: takeString(config, ["zodVersion"], state, basePath),
     packageManager: takeEnum(config, ["packageManager"], ["pnpm", "yarn"], state, basePath),
+    packageManagerVersion,
     testFramework: takeEnum(config, ["testFramework"], ["jest", "vitest"], state, basePath),
     httpClient: fetchSupport === "native" ? { name: "fetch" } : void 0,
     bundle: takeBoolean(config, ["bundle"], state, basePath),
     exportClassDefault: takeBoolean(config, ["exportClassDefault"], state, basePath),
-    namespaceExportName: takeString(
-      config,
-      ["namespaceExportName", "namespaceExport"],
-      state,
-      basePath
-    ),
+    namespaceExportName: takeString(config, ["namespaceExportName", "namespaceExport"], state, basePath) ?? nestedNamespace,
+    consolidateTypeFiles: takeBoolean(config, ["consolidateTypeFiles"], state, basePath),
     allowCustomFetcher: takeBoolean(config, ["allowCustomFetcher"], state, basePath),
     useBrandedStringAliases: takeBoolean(config, ["useBrandedStringAliases"], state, basePath),
     useLegacyExports: takeBoolean(config, ["useLegacyExports"], state, basePath),
     useBigInt: takeBoolean(config, ["useBigInt"], state, basePath),
-    serdeLayer: serdeLayer ?? (noSerdeLayer === void 0 ? void 0 : !noSerdeLayer)
+    serdeLayer: serdeLayer ?? (noSerdeLayer === void 0 ? void 0 : !noSerdeLayer),
+    esmOnly: takeBoolean(config, ["esmOnly"], state, basePath)
   });
 }
 function mapPython(config, state, packageConfig, basePath) {
@@ -2599,7 +2756,8 @@ function mapCsharp(config, state, packageConfig, basePath) {
   });
 }
 function mapPhp(config, state, packageConfig, basePath) {
-  mapPackageManifest(config, ["composerJson"], state, packageConfig, basePath);
+  const manifest = mapPackageManifest(config, ["composerJson"], state, packageConfig, basePath);
+  if (manifest) mapComposerRequirements(manifest, state, packageConfig);
   const packageName = takeString(config, ["packageName"], state, basePath);
   if (packageName !== void 0) packageConfig.packageName = packageName;
   return compact({
@@ -2607,6 +2765,20 @@ function mapPhp(config, state, packageConfig, basePath) {
     generateClientInterfaces: takeBoolean(config, ["generateClientInterfaces"], state, basePath)
   });
 }
+function mapComposerRequirements(manifest, state, packageConfig) {
+  const fields = [
+    ["require", "extraDependencies"],
+    ["require-dev", "extraDevDependencies"]
+  ];
+  for (const [composerField, packageField] of fields) {
+    const located = takeObject(manifest.value, [composerField], state, manifest.path);
+    if (!located) continue;
+    const dependencies = Object.entries(located.value).flatMap(
+      ([name, dependency]) => mapDependency(name, dependency, state, [...located.path, name])
+    );
+    if (dependencies.length) packageConfig[packageField] = dependencies;
+  }
+}
 function mapRuby(config, state, packageConfig, basePath) {
   const moduleName = takeString(config, ["moduleName"], state, basePath);
   if (moduleName !== void 0) packageConfig.moduleName = moduleName;
@@ -2776,28 +2948,52 @@ function takeCustomSections(value, language, activeLanguages, state, basePath) {
 }
 function mapPackageManifest(config, aliases, state, packageConfig, basePath) {
   const manifest = takeObject(config, aliases, state, basePath);
-  if (!manifest) return;
+  if (!manifest) return void 0;
   const packageName = takeString(manifest.value, ["name"], state, manifest.path);
   const description = takeString(manifest.value, ["description"], state, manifest.path);
+  const keywords = takeStringArray(manifest.value, ["keywords"], state, manifest.path);
   const license = takeString(manifest.value, ["license"], state, manifest.path);
   const author = takeObject(manifest.value, ["author"], state, manifest.path);
   const authorName = author ? takeString(author.value, ["name"], state, author.path) : void 0;
-  const authors = authorName && author ? [
-    compact({
-      name: authorName,
-      email: takeString(author.value, ["email"], state, author.path),
-      url: takeString(author.value, ["url"], state, author.path)
-    })
-  ] : void 0;
+  const authors = [
+    ...authorName && author ? [
+      compact({
+        name: authorName,
+        email: takeString(author.value, ["email"], state, author.path),
+        url: takeString(author.value, ["url"], state, author.path)
+      })
+    ] : [],
+    ...takeManifestAuthors(manifest, state)
+  ];
   Object.assign(
     packageConfig,
     compact({
       packageName,
       description,
-      authors,
+      homepage: takeString(manifest.value, ["homepage"], state, manifest.path),
+      keywords,
+      authors: authors.length ? authors : void 0,
       license: license ? { type: license } : void 0
     })
   );
+  return manifest;
+}
+function takeManifestAuthors(manifest, state) {
+  const located = locate(manifest.value, ["authors"], manifest.path);
+  if (!located || !Array.isArray(located.value)) return [];
+  return located.value.flatMap((entry, index) => {
+    if (!isObject(entry)) return [];
+    const path = [...located.path, index];
+    const name = takeString(entry, ["name"], state, path);
+    if (!name) return [];
+    return [
+      compact({
+        name,
+        email: takeString(entry, ["email"], state, path),
+        url: takeString(entry, ["url"], state, path)
+      })
+    ];
+  });
 }
 function takePythonAdditionalInitExports(config, state, basePath) {
   const located = locate(config, ["additionalInitExports"], basePath);
@@ -2896,6 +3092,7 @@ exports.FernConfigMappingError = FernConfigMappingError;
 exports.SDK_CONFIG_V1_SCHEMA_VERSION = SDK_CONFIG_V1_SCHEMA_VERSION;
 exports.mapFernConfigToSdkConfigV1 = mapFernConfigToSdkConfigV1;
 exports.parseSdkConfigV1 = parseSdkConfigV1;
+exports.parseSdkConfigV1ForConsumption = parseSdkConfigV1ForConsumption;
 exports.sdkConfigV1ApiConfigSchema = sdkConfigV1ApiConfigSchema;
 exports.sdkConfigV1AuthConfigSchema = sdkConfigV1AuthConfigSchema;
 exports.sdkConfigV1AuthSchemeSchema = sdkConfigV1AuthSchemeSchema;