@fern-api/fern-api-dev 5.65.8 → 5.66.1

package/cli.cjs

@@ -266112,6 +266112,211 @@ var init_IrGraph = __esm({
   }
 });
 
+// ../../commons/ir-utils/lib/global-parameters/resolveGlobalParameterApplicability.js
+function resolveGlobalParameterApplicability(ir3, { onWarning } = {}) {
+  const globalParameters = ir3.globalParameters;
+  if (globalParameters == null || globalParameters.length === 0) {
+    return;
+  }
+  for (const service of Object.values(ir3.services)) {
+    for (const endpoint3 of service.endpoints) {
+      endpoint3.globalParameters = resolveForEndpoint({
+        endpoint: endpoint3,
+        globalParameters,
+        types: ir3.types,
+        onWarning
+      });
+    }
+  }
+}
+function resolveForEndpoint({ endpoint: endpoint3, globalParameters, types: types4, onWarning }) {
+  const optIns = new Set(endpoint3.globalParameters ?? []);
+  const resolved = [];
+  for (const param of globalParameters) {
+    const isAuto = param.apply === "auto";
+    let applies;
+    switch (param.location) {
+      case "body": {
+        const schemaHasTarget = requestBodyContainsPath({
+          requestBody: endpoint3.requestBody,
+          dottedTarget: param.target,
+          types: types4
+        });
+        if (isAuto) {
+          applies = schemaHasTarget;
+        } else if (optIns.has(param.id)) {
+          applies = schemaHasTarget;
+          if (!schemaHasTarget) {
+            onWarning?.(`Endpoint "${endpoint3.id}" opts into global parameter "${param.id}" (in: body, target: "${param.target}") via x-fern-global-parameter, but its request body schema does not contain that path. The parameter will not be injected for this endpoint.`);
+          }
+        } else {
+          applies = false;
+        }
+        break;
+      }
+      case "header":
+      case "query":
+        applies = isAuto || optIns.has(param.id);
+        break;
+      case "path":
+        applies = isAuto ? endpointPathContainsParameter(endpoint3, param.target) : optIns.has(param.id);
+        break;
+      default:
+        assertNever(param.location);
+    }
+    if (applies) {
+      resolved.push(param.id);
+    }
+  }
+  return resolved.length > 0 ? resolved : void 0;
+}
+function endpointPathContainsParameter(endpoint3, target) {
+  return endpoint3.allPathParameters.some((pathParameter) => getOriginalName(pathParameter.name) === target);
+}
+function requestBodyContainsPath({ requestBody, dottedTarget, types: types4 }) {
+  if (requestBody == null) {
+    return false;
+  }
+  const segments = dottedTarget.split(".");
+  if (segments.length === 0) {
+    return false;
+  }
+  switch (requestBody.type) {
+    case "inlinedRequestBody": {
+      const seen = /* @__PURE__ */ new Set();
+      const properties7 = [
+        ...requestBody.properties.map((property24) => ({
+          wireValue: getWireValue(property24.name),
+          valueType: property24.valueType
+        })),
+        ...(requestBody.extendedProperties ?? []).map((property24) => ({
+          wireValue: getWireValue(property24.name),
+          valueType: property24.valueType
+        }))
+      ];
+      for (const extension4 of requestBody.extends) {
+        properties7.push(...collectPropertiesFromNamedType({ typeId: extension4.typeId, types: types4, seen }));
+      }
+      return propertiesContainPath({ properties: properties7, segments, types: types4, seen });
+    }
+    case "reference":
+      return typeReferenceContainsPath({
+        typeReference: requestBody.requestBodyType,
+        segments,
+        types: types4,
+        seen: /* @__PURE__ */ new Set()
+      });
+    case "fileUpload":
+    case "bytes":
+      return false;
+    default:
+      assertNever(requestBody);
+  }
+}
+function propertiesContainPath({ properties: properties7, segments, types: types4, seen }) {
+  const [head, ...rest] = segments;
+  const match3 = properties7.find((property24) => property24.wireValue === head);
+  if (match3 == null) {
+    return false;
+  }
+  if (rest.length === 0) {
+    return true;
+  }
+  return typeReferenceContainsPath({ typeReference: match3.valueType, segments: rest, types: types4, seen: /* @__PURE__ */ new Set() });
+}
+function typeReferenceContainsPath({ typeReference: typeReference2, segments, types: types4, seen }) {
+  const properties7 = resolveObjectProperties({ typeReference: typeReference2, types: types4, seen });
+  if (properties7 == null) {
+    return false;
+  }
+  return propertiesContainPath({ properties: properties7, segments, types: types4, seen });
+}
+function resolveObjectProperties({ typeReference: typeReference2, types: types4, seen }) {
+  switch (typeReference2.type) {
+    case "container": {
+      const container = typeReference2.container;
+      switch (container.type) {
+        case "optional":
+          return resolveObjectProperties({ typeReference: container.optional, types: types4, seen });
+        case "nullable":
+          return resolveObjectProperties({ typeReference: container.nullable, types: types4, seen });
+        case "list":
+        case "set":
+        case "map":
+        case "literal":
+          return void 0;
+        default:
+          return assertNever(container);
+      }
+    }
+    case "named": {
+      if (seen.has(typeReference2.typeId)) {
+        return void 0;
+      }
+      seen.add(typeReference2.typeId);
+      const declaration = types4[typeReference2.typeId];
+      if (declaration == null) {
+        return void 0;
+      }
+      switch (declaration.shape.type) {
+        case "object":
+          return collectObjectProperties2({ object: declaration.shape, types: types4, seen });
+        case "alias":
+          return resolveObjectProperties({ typeReference: declaration.shape.aliasOf, types: types4, seen });
+        case "enum":
+        case "union":
+        case "undiscriminatedUnion":
+          return void 0;
+        default:
+          return assertNever(declaration.shape);
+      }
+    }
+    case "primitive":
+    case "unknown":
+      return void 0;
+    default:
+      return assertNever(typeReference2);
+  }
+}
+function collectPropertiesFromNamedType({ typeId, types: types4, seen }) {
+  if (seen.has(typeId)) {
+    return [];
+  }
+  seen.add(typeId);
+  const declaration = types4[typeId];
+  if (declaration == null || declaration.shape.type !== "object") {
+    return [];
+  }
+  return collectObjectProperties2({ object: declaration.shape, types: types4, seen });
+}
+function collectObjectProperties2({ object: object23, types: types4, seen }) {
+  const properties7 = object23.properties.map((property24) => ({
+    wireValue: getWireValue(property24.name),
+    valueType: property24.valueType
+  }));
+  for (const property24 of object23.extendedProperties ?? []) {
+    properties7.push({ wireValue: getWireValue(property24.name), valueType: property24.valueType });
+  }
+  for (const extension4 of object23.extends) {
+    if (seen.has(extension4.typeId)) {
+      continue;
+    }
+    seen.add(extension4.typeId);
+    const declaration = types4[extension4.typeId];
+    if (declaration != null && declaration.shape.type === "object") {
+      properties7.push(...collectObjectProperties2({ object: declaration.shape, types: types4, seen }));
+    }
+  }
+  return properties7;
+}
+var init_resolveGlobalParameterApplicability = __esm({
+  "../../commons/ir-utils/lib/global-parameters/resolveGlobalParameterApplicability.js"() {
+    "use strict";
+    init_lib4();
+    init_namesUtils();
+  }
+});
+
 // ../../commons/ir-utils/lib/utils/availabilityUtils.js
 function isMarkedUnstable(availability) {
   return availability != null && !stableStatuses.includes(availability.status);
@@ -267464,6 +267669,7 @@ var init_lib21 = __esm({
     init_filterIntermediateRepresentationForAudiences();
     init_getPropertiesByAudience();
     init_IrGraph();
+    init_resolveGlobalParameterApplicability();
     init_hashJSON();
     init_IntermediateRepresentationChangeDetector();
     init_mergeIntermediateRepresentation();
@@ -276434,7 +276640,7 @@ var init_getIrGenerationSettings = __esm({
 });
 
 // ../generation/ir-generator/lib/generateIntermediateRepresentation.js
-function generateIntermediateRepresentation({ workspace, generationLanguage, keywords: keywords3, smartCasing, exampleGeneration, audiences, readme, packageName, userAgentTemplate, organization, version: version7, fdrApiDefinitionId, sourceResolver, disableDynamicExamples, dynamicGeneratorConfig, generationMetadata }) {
+function generateIntermediateRepresentation({ workspace, generationLanguage, keywords: keywords3, smartCasing, exampleGeneration, audiences, readme, packageName, userAgentTemplate, organization, version: version7, context: context3, fdrApiDefinitionId, sourceResolver, disableDynamicExamples, dynamicGeneratorConfig, generationMetadata }) {
   const irSettings = getIrGenerationSettings({ workspace });
   const casingsGenerator = constructCasingsGenerator({ generationLanguage, keywords: keywords3, smartCasing });
   const irGraph = new IrGraph(audiences);
@@ -276728,6 +276934,9 @@ function generateIntermediateRepresentation({ workspace, generationLanguage, key
   });
   intermediateRepresentation.serviceTypeReferenceInfo = computeServiceTypeReferenceInfo(irGraph);
   addExtendedPropertiesToIr(intermediateRepresentation);
+  resolveGlobalParameterApplicability(intermediateRepresentation, {
+    onWarning: (message) => context3.logger.warn(message)
+  });
   const intermediateRepresentationWithGeneratedExamples = exampleGeneration.disabled ? intermediateRepresentation : injectAutogeneratedExamples({ ir: intermediateRepresentation, exampleGeneration });
   const workspaceDefinitionRootApiFileContents = workspace.definition.rootApiFile.contents;
   const ignoreAudiences = environments2?.environments._visit({
@@ -342272,6 +342481,9 @@ var init_AbstractSpecConverter = __esm({
           hasPaginatedEndpoints,
           hasFileDownloadEndpoints
         };
+        resolveGlobalParameterApplicability(this.ir, {
+          onWarning: (message) => this.context.logger.warn(message)
+        });
         let ir3 = {
           ...this.ir,
           apiName: this.context.casingsGenerator.generateName(this.ir.apiDisplayName ?? ""),
@@ -688631,7 +688843,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "5.65.8",
+          version: "5.66.1",
           usingAccessToken: true,
           ...getRunIdProperties()
         }
@@ -688697,7 +688909,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "5.65.8",
+        version: "5.66.1",
         ...event,
         ...event.properties,
         usingAccessToken: false,
@@ -869798,7 +870010,7 @@ var LOCAL_STORAGE_FOLDER4 = ".fern-dev";
 var LOGS_FOLDER_NAME = "logs";
 var MAX_LOGS_DIR_SIZE_BYTES = 100 * 1024 * 1024;
 function getCliSource() {
-  const version7 = "5.65.8";
+  const version7 = "5.66.1";
   return `cli@${version7}`;
 }
 var DebugLogger = class {
@@ -900228,7 +900440,7 @@ function validateBasepathAlignment(instanceUrl, customDomains, context3) {
   for (const customDomain of customDomains) {
     const customDomainBasepath = getBasepath(customDomain);
     if (urlBasepath !== customDomainBasepath) {
-      context3.failAndThrow(`Basepath mismatch between Fern url and custom-domain. When basepath-aware mode is enabled (via 'multi-source: true' or the deprecated 'experimental.basepath-aware: true'), the instance 'url' and 'custom-domain' must share the same basepath, otherwise docs will fail to resolve after DNS cutover. Instance url '${instanceUrl}' has basepath '${urlBasepath}' but custom-domain '${customDomain}' has basepath '${customDomainBasepath}'.`, void 0, { code: CliError.Code.ConfigError });
+      context3.failAndThrow(`Basepath mismatch between Fern url and custom-domain. The instance 'url' and 'custom-domain' must share the same basepath, since navigation links and redirects are generated relative to the basepath and would break on a custom domain with a different one. Instance url '${instanceUrl}' has basepath '${urlBasepath}' but custom-domain '${customDomain}' has basepath '${customDomainBasepath}'.`, void 0, { code: CliError.Code.ConfigError });
     }
   }
 }
@@ -902269,10 +902481,7 @@ ${available}` : `No docs instance found. Failed to register.`, void 0, { code: C
     return;
   }
   const customDomains = (typeof maybeInstance.customDomain === "string" ? [maybeInstance.customDomain] : maybeInstance.customDomain ?? []).map(stripCustomDomainProtocol);
-  const isBasepathAware = maybeInstance.multiSource === true || docsWorkspace.config.experimental?.basepathAware === true;
-  if (isBasepathAware) {
-    validateBasepathAlignment(maybeInstance.url, customDomains, context3);
-  }
+  validateBasepathAlignment(maybeInstance.url, customDomains, context3);
   context3.logger.info(`Starting docs publishing for ${preview ? "preview" : "production"}: ${maybeInstance.url}`);
   context3.logger.debug(`Organization: ${organization}, Preview: ${preview}, APIs: ${apiWorkspaces.length}, OSS: ${ossWorkspaces.length}`);
   let publishedUrl;
@@ -902360,7 +902569,7 @@ var LegacyDocsPublisher = class {
         previewId,
         disableTemplates: void 0,
         skipUpload,
-        cliVersion: "5.65.8",
+        cliVersion: "5.66.1",
         loginCommand: "fern auth login"
       });
       if (taskContext.getResult() === TaskResult.Failure) {
@@ -968689,7 +968898,7 @@ function getAutomationContextFromEnv() {
     config_branch: process.env.FERN_CONFIG_BRANCH,
     config_pr_number: process.env.FERN_CONFIG_PR_NUMBER,
     trigger: process.env.GITHUB_EVENT_NAME,
-    cli_version: "5.65.8"
+    cli_version: "5.66.1"
   };
 }
 function isAutomationMode() {
@@ -969521,7 +969730,7 @@ var CliContext = class _CliContext {
     if (false) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "5.65.8";
+    return "5.66.1";
   }
   getCliName() {
     if (false) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.65.8",
+  "version": "5.66.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fern-api/fern.git",