fern-api 0.30.1 → 0.30.2

package/bundle.cjs

@@ -1030261,7 +1030261,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "0.30.1",
+          version: "0.30.2",
           usingAccessToken: true
         }
       });
@@ -1030323,7 +1030323,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "0.30.1",
+        version: "0.30.2",
         ...event,
         ...event.properties
       }
@@ -1056046,10 +1056046,10 @@ var CliContext = class {
     return "fern-api";
   }
   getPackageVersion() {
-    if ("0.30.1" == null) {
+    if ("0.30.2" == null) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "0.30.1";
+    return "0.30.2";
   }
   getCliName() {
     if ("fern" == null) {
@@ -1060469,6 +1060469,93 @@ function convertErrorDiscriminationStrategy(rawStrategy, file) {
   }
 }
 
+// pnp:/home/circleci/project/packages/cli/generation/ir-generator/lib/converters/convertReadmeConfig.js
+function convertReadmeConfig({ readme, services }) {
+  const readmeEndpointCache = new ReadmeEndpointCache(services);
+  return {
+    apiReferenceLink: readme.apiReferenceLink,
+    bannerLink: readme.bannerLink,
+    defaultEndpoint: readme.defaultEndpoint != null ? readmeEndpointCache.getEndpointForReadmeOrThrow(readme.defaultEndpoint).id : void 0,
+    features: readme.features != null ? Object.fromEntries(Object.entries(readme.features).map(([featureId, endpoints]) => {
+      return [
+        featureId,
+        endpoints.map((endpoint) => readmeEndpointCache.getEndpointForReadmeOrThrow(endpoint).id)
+      ];
+    })) : void 0
+  };
+}
+var ReadmeEndpointCache = class {
+  endpoints = {};
+  constructor(services) {
+    this.endpoints = this.buildEndpoints(services);
+  }
+  getEndpointForReadme(readmeEndpoint) {
+    const readmeEndpointObject = getReadmeEndpointObject({ endpoint: readmeEndpoint });
+    const endpointKey = this.getEndpointKeyForReadmeEndpoint(readmeEndpointObject);
+    return this.endpoints[endpointKey];
+  }
+  getEndpointForReadmeOrThrow(readmeEndpoint) {
+    const endpoint = this.getEndpointForReadme(readmeEndpoint);
+    if (endpoint == null) {
+      throw new Error(`Endpoint not found for ${JSON.stringify(readmeEndpoint)}`);
+    }
+    return endpoint;
+  }
+  buildEndpoints(services) {
+    const endpoints = {};
+    for (const service of Object.values(services)) {
+      for (const endpoint of service.endpoints) {
+        endpoints[this.getEndpointKeyForHttpEndpoint(endpoint)] = endpoint;
+      }
+    }
+    return endpoints;
+  }
+  getEndpointKeyForReadmeEndpoint(endpoint) {
+    return this.getEndpointKey({
+      method: endpoint.method,
+      path: endpoint.path,
+      stream: endpoint.stream ?? false
+    });
+  }
+  getEndpointKeyForHttpEndpoint(endpoint) {
+    var _a5, _b4;
+    return this.getEndpointKey({
+      method: endpoint.method,
+      path: getFullPathForEndpoint(endpoint),
+      stream: ((_b4 = (_a5 = endpoint.response) == null ? void 0 : _a5.body) == null ? void 0 : _b4.type) === "streaming"
+    });
+  }
+  getEndpointKey({ method: method2, path: path42, stream }) {
+    return `${method2}|${path42}|${stream}`;
+  }
+};
+function getFullPathForEndpoint(endpoint) {
+  let url = "";
+  if (endpoint.fullPath.head.length > 0) {
+    url = urlJoin21(url, endpoint.fullPath.head);
+  }
+  for (const part of endpoint.fullPath.parts) {
+    url = urlJoin21(url, "{" + part.pathParameter + "}");
+    if (part.tail.length > 0) {
+      url = urlJoin21(url, part.tail);
+    }
+  }
+  return url.startsWith("/") ? url : `/${url}`;
+}
+function getReadmeEndpointObject({ endpoint }) {
+  if (typeof endpoint === "string") {
+    const split2 = endpoint.split(" ");
+    if (split2.length !== 2 || split2[0] == null || split2[1] == null) {
+      throw new Error(`invalid endpoint string: ${endpoint}`);
+    }
+    return {
+      method: split2[0],
+      path: split2[1]
+    };
+  }
+  return endpoint;
+}
+
 // pnp:/home/circleci/project/packages/cli/generation/ir-generator/lib/converters/convertWebhookGroup.js
 async function convertWebhookGroup({ webhooks, file }) {
   const webhookGroup = [];
@@ -1062820,7 +1062907,7 @@ var VariableResolverImpl = _VariableResolverImpl;
 __publicField(VariableResolverImpl, "VARIABLE_PREFIX", "$");
 
 // pnp:/home/circleci/project/packages/cli/generation/ir-generator/lib/generateIntermediateRepresentation.js
-async function generateIntermediateRepresentation({ workspace, generationLanguage, keywords: keywords3, smartCasing, disableExamples, audiences }) {
+async function generateIntermediateRepresentation({ workspace, generationLanguage, keywords: keywords3, smartCasing, disableExamples, audiences, readme }) {
   const casingsGenerator = constructCasingsGenerator({ generationLanguage, keywords: keywords3, smartCasing });
   const irGraph = new IrGraph(audiences);
   const rootApiFileContext = constructRootApiFileContext({
@@ -1063072,6 +1063159,7 @@ async function generateIntermediateRepresentation({ workspace, generationLanguag
       return ((_b4 = (_a5 = endpoint.response) == null ? void 0 : _a5.body) == null ? void 0 : _b4.type) === "fileDownload";
     });
   });
+  const readmeConfig = readme != null ? convertReadmeConfig({ readme, services: intermediateRepresentation.services }) : void 0;
   return {
     ...intermediateRepresentationForAudiences,
     ...packageTreeGenerator.build(filteredIr),
@@ -1063085,7 +1063173,8 @@ async function generateIntermediateRepresentation({ workspace, generationLanguag
         sdkName: "X-Fern-SDK-Name",
         sdkVersion: "X-Fern-SDK-Version"
       }
-    }
+    },
+    readmeConfig
   };
 }
 function computeServiceTypeReferenceInfo(irGraph) {
@@ -1070779,7 +1070868,8 @@ var DocsDefinitionResolver = class {
           generationLanguage: void 0,
           keywords: void 0,
           smartCasing: false,
-          disableExamples: false
+          disableExamples: false,
+          readme: void 0
         });
         const apiDefinitionId = await this.registerApi({ ir, snippetsConfig });
         const unsortedChangelogItems = [];
@@ -1073682,7 +1073772,8 @@ async function registerApi({ organization, workspace, context, token, audiences,
     generationLanguage: void 0,
     keywords: void 0,
     smartCasing: false,
-    disableExamples: false
+    disableExamples: false,
+    readme: void 0
   });
   const fdrService = createFdrService({
     token: token.value
@@ -1101487,7 +1101578,8 @@ async function generateIrForFernWorkspace({
   keywords: keywords3,
   smartCasing,
   disableExamples,
-  audiences
+  audiences,
+  readme
 }) {
   await validateAPIWorkspaceAndLogIssues({ workspace, context, logWarnings: false });
   return generateIntermediateRepresentation({
@@ -1101496,7 +1101588,8 @@ async function generateIrForFernWorkspace({
     keywords: keywords3,
     smartCasing,
     disableExamples,
-    audiences
+    audiences,
+    readme
   });
 }
 
@@ -1101518,7 +1101611,8 @@ async function generateFdrApiDefinitionForWorkspaces({
           audiences,
           keywords: void 0,
           smartCasing: false,
-          disableExamples: false
+          disableExamples: false,
+          readme: void 0
         });
         const apiDefinition = convertIrToFdrApi({
           ir,
@@ -1107298,11 +1107392,11 @@ var V46_TO_V45_MIGRATION = {
   laterVersion: "v46",
   earlierVersion: "v45",
   firstGeneratorVersionToConsumeNewIR: {
-    [GeneratorName.TYPESCRIPT_NODE_SDK]: GeneratorWasNeverUpdatedToConsumeNewIR,
-    [GeneratorName.TYPESCRIPT_BROWSER_SDK]: GeneratorWasNeverUpdatedToConsumeNewIR,
+    [GeneratorName.TYPESCRIPT_NODE_SDK]: "0.21.0",
+    [GeneratorName.TYPESCRIPT_BROWSER_SDK]: "0.21.0",
     [GeneratorName.TYPESCRIPT]: GeneratorWasNeverUpdatedToConsumeNewIR,
     [GeneratorName.TYPESCRIPT_SDK]: GeneratorWasNeverUpdatedToConsumeNewIR,
-    [GeneratorName.TYPESCRIPT_EXPRESS]: GeneratorWasNeverUpdatedToConsumeNewIR,
+    [GeneratorName.TYPESCRIPT_EXPRESS]: "0.16.0",
     [GeneratorName.JAVA]: GeneratorWasNeverUpdatedToConsumeNewIR,
     [GeneratorName.JAVA_MODEL]: GeneratorWasNeverUpdatedToConsumeNewIR,
     [GeneratorName.JAVA_SDK]: GeneratorWasNeverUpdatedToConsumeNewIR,
@@ -1109089,7 +1109183,8 @@ async function generateIrForWorkspaces({
   audiences,
   version: version3,
   keywords: keywords3,
-  smartCasing
+  smartCasing,
+  readme
 }) {
   await Promise.all(
     project.apiWorkspaces.map(async (workspace) => {
@@ -1109126,7 +1109221,8 @@ async function generateIrForWorkspaces({
           smartCasing,
           disableExamples: false,
           audiences,
-          version: version3
+          version: version3,
+          readme
         });
         const irOutputFilePath = import_path34.default.resolve(irFilepath);
         await (0, import_promises35.writeFile)(
@@ -1109146,7 +1109242,8 @@ async function getIntermediateRepresentation({
   keywords: keywords3,
   smartCasing,
   disableExamples,
-  version: version3
+  version: version3,
+  readme
 }) {
   const intermediateRepresentation = await generateIrForFernWorkspace({
     workspace,
@@ -1109155,7 +1109252,8 @@ async function getIntermediateRepresentation({
     audiences,
     keywords: keywords3,
     smartCasing,
-    disableExamples
+    disableExamples,
+    readme
   });
   if (version3 == null) {
     return serialization_exports2.IntermediateRepresentation.jsonOrThrow(intermediateRepresentation, {
@@ -1109544,7 +1109642,8 @@ async function getIntermediateRepresentation2({ workspace, audiences, generatorI
     generationLanguage: generatorInvocation.language,
     keywords: generatorInvocation.keywords,
     smartCasing: generatorInvocation.smartCasing,
-    disableExamples: generatorInvocation.disableExamples
+    disableExamples: generatorInvocation.disableExamples,
+    readme: generatorInvocation.readme
   });
   context.logger.debug("Generated IR");
   const migratedIntermediateRepresentation = irVersionOverride != null ? await migrateIntermediateRepresentationThroughVersion({
@@ -1110375,14 +1110474,15 @@ function convertLogLevel(logLevel) {
 }
 
 // pnp:/home/circleci/project/packages/cli/generation/remote-generation/remote-workspace-runner/lib/runRemoteGenerationForGenerator.js
-async function runRemoteGenerationForGenerator({ projectConfig, organization, workspace, interactiveTaskContext, generatorInvocation, version: version3, audiences, shouldLogS3Url, token, whitelabel, irVersionOverride, absolutePathToPreview }) {
+async function runRemoteGenerationForGenerator({ projectConfig, organization, workspace, interactiveTaskContext, generatorInvocation, version: version3, audiences, shouldLogS3Url, token, whitelabel, irVersionOverride, absolutePathToPreview, readme }) {
   const intermediateRepresentation = await generateIntermediateRepresentation({
     workspace,
     generationLanguage: generatorInvocation.language,
     keywords: generatorInvocation.keywords,
     smartCasing: generatorInvocation.smartCasing,
     disableExamples: generatorInvocation.disableExamples,
-    audiences
+    audiences,
+    readme
   });
   const job = await createAndStartJob({
     projectConfig,
@@ -1110453,7 +1110553,8 @@ async function runRemoteGenerationForAPIWorkspace({ projectConfig, organization,
         token,
         whitelabel: (_a5 = workspaceMetadata.workspace.generatorsConfiguration) == null ? void 0 : _a5.whitelabel,
         irVersionOverride: generatorInvocation.irVersionOverride,
-        absolutePathToPreview: workspaceMetadata.absolutePathToPreview
+        absolutePathToPreview: workspaceMetadata.absolutePathToPreview,
+        readme: generatorInvocation.readme
       });
       if (remoteTaskHandlerResponse != null && remoteTaskHandlerResponse.createdSnippets) {
         snippetsProducedBy.push(generatorInvocation);
@@ -1110911,7 +1111012,7 @@ var MockServer = class {
     const endpointGroups = /* @__PURE__ */ new Map();
     for (const service of Object.values(ir.services)) {
       for (const endpoint of service.endpoints) {
-        const endpointPath = getFullPathForEndpoint(endpoint);
+        const endpointPath = getFullPathForEndpoint2(endpoint);
         context.logger.debug(`Registering ${endpoint.method} ${endpointPath} ...`);
         const existingGroup = endpointGroups.get(endpointPath) ?? /* @__PURE__ */ new Map();
         const existingEndpoints = existingGroup.get(endpoint.method) ?? [];
@@ -1110986,7 +1111087,7 @@ var MockServer = class {
     });
   }
 };
-function getFullPathForEndpoint(endpoint) {
+function getFullPathForEndpoint2(endpoint) {
   let url = "";
   if (endpoint.fullPath.head.length > 0) {
     url = urlJoin21(url, endpoint.fullPath.head);
@@ -1111169,7 +1111270,8 @@ async function mockServer({
       generationLanguage: void 0,
       keywords: void 0,
       smartCasing: false,
-      disableExamples: false
+      disableExamples: false,
+      readme: void 0
     });
     const mockServer2 = new MockServer({
       context,
@@ -1111300,7 +1111402,8 @@ async function testOutput({
       generationLanguage: void 0,
       keywords: void 0,
       smartCasing: false,
-      disableExamples: false
+      disableExamples: false,
+      readme: void 0
     });
     const mockServer2 = new MockServer({
       context,
@@ -1114466,7 +1114569,8 @@ function addIrCommand(cli, cliContext) {
         audiences: argv.audience.length > 0 ? { type: "select", audiences: argv.audience } : { type: "all" },
         version: argv.version,
         keywords: void 0,
-        smartCasing: false
+        smartCasing: false,
+        readme: void 0
       });
     }
   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fern-api",
-  "version": "0.30.1",
+  "version": "0.30.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/fern-api/fern.git",