feat(cli): init the conjure importer (#4790)

.eslintignore

@@ -7,6 +7,7 @@ generated
 bundle.c?js
 .pnp*
 packages/ir-sdk/**
+packages/cli/api-importers/conjure/conjure-sdk/**
 packages/docs-config/**
 packages/cli/openapi-ir-sdk/**
 packages/cli/configuration/src/docs-yml/schemas/**

fern/pages/changelogs/cli/2024-09-30.mdx

@@ -0,0 +1,5 @@
+## 0.43.8
+**`(fix):`** Any markdown files that have custom components are also pushed up to the Fern Docs 
+platform.
+
+

fern/pages/changelogs/cli/2024-10-02.mdx

@@ -0,0 +1,7 @@
+## 0.44.0-rc0
+**`(feat):`** The Fern CLI now supports parsing [Conjure](https://github.com/palantir/conjure), Palantir's 
+home-grown API Definition format. 
+
+If you know a company that is using Conjure that wants API Docs + SDKs, send them our way!
+
+

fern/pages/changelogs/go-sdk/2024-09-29.mdx

@@ -0,0 +1,3 @@
+## 0.27.0
+**`(feat):`** Add support for SSE (Server-Sent Events) streaming responses. The user-facing interface for streaming responses remains the same between standard HTTP streaming and SSE.
+

package.json

@@ -39,6 +39,7 @@
     "seed:local": "pnpm --filter @fern-api/seed-cli dist:cli && node packages/seed/dist/bundle.cjs",
     "ir:generate": "pnpm --filter @fern-api/ir-sdk generate",
     "openapi-ir:generate": "pnpm --filter @fern-api/openapi-ir-sdk generate",
+    "conjure-sdk:generate": "pnpm --filter @fern-api/conjure-sdk generate",
     "seed-config:generate": "pnpm --filter @fern-api/seed-cli generate",
     "docs-config:generate": "pnpm --filter @fern-api/configuration generate",
     "prepare": "husky"

packages/cli/api-importers/commons/.depcheckrc.json

@@ -0,0 +1,10 @@
+{
+    "ignores": [
+        "@types/jest",
+        "globals",
+        "@types/node"
+    ],
+    "ignore-patterns": [
+        "lib"
+    ]
+}

packages/cli/api-importers/commons/.prettierrc.cjs

@@ -0,0 +1 @@
+module.exports = require("../../../../.prettierrc.json");

packages/cli/api-importers/commons/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@fern-api/importer-commons",
+  "version": "0.0.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fern-api/fern.git",
+    "directory": "packages/cli/generation/remote-generation/remote-workspace-runner"
+  },
+  "private": true,
+  "files": [
+    "lib"
+  ],
+  "type": "module",
+  "source": "src/index.ts",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "sideEffects": false,
+  "scripts": {
+    "clean": "rm -rf ./lib && tsc --build --clean",
+    "compile": "tsc --build",
+    "test": "vitest --passWithNoTests --run",
+    "test:update": "vitest --passWithNoTests --run -u",
+    "lint:eslint": "eslint --max-warnings 0 . --ignore-path=../../../../../.eslintignore",
+    "lint:eslint:fix": "yarn lint:eslint --fix",
+    "format": "prettier --write --ignore-unknown --ignore-path ../../../../../shared/.prettierignore \"**\"",
+    "format:check": "prettier --check --ignore-unknown --ignore-path ../../../../../shared/.prettierignore \"**\"",
+    "organize-imports": "organize-imports-cli tsconfig.json",
+    "depcheck": "depcheck"
+  },
+  "dependencies": {
+    "@fern-api/fern-definition-schema": "workspace:*",
+    "@fern-api/configuration": "workspace:*",
+    "@fern-api/task-context": "workspace:*",
+    "@fern-api/fs-utils": "workspace:*",
+    "lodash-es": "^4.17.21"
+  },
+  "devDependencies": {
+    "@types/node": "^18.7.18",
+    "depcheck": "^1.4.6",
+    "globals": "link:@types/vitest/globals",
+    "organize-imports-cli": "^0.10.0",
+    "prettier": "^2.7.1",
+    "typescript": "4.6.4",
+    "vitest": "^2.0.5",
+    "@types/lodash-es": "^4.17.12"
+  }
+}

packages/cli/api-importers/commons/src/APIDefinitionImporter.ts

@@ -0,0 +1,17 @@
+import { DefinitionFileSchema, PackageMarkerFileSchema, RootApiFileSchema } from "@fern-api/fern-definition-schema";
+import { RelativeFilePath } from "@fern-api/fs-utils";
+import { TaskContext } from "@fern-api/task-context";
+
+export declare namespace APIDefinitionImporter {
+    interface Return {
+        rootApiFile: RootApiFileSchema;
+        packageMarkerFile: PackageMarkerFileSchema;
+        definitionFiles: Record<RelativeFilePath, DefinitionFileSchema>;
+    }
+}
+
+export abstract class APIDefinitionImporter<T> {
+    public constructor(protected readonly context?: TaskContext) {}
+
+    public abstract import(input: T): Promise<APIDefinitionImporter.Return>;
+}

packages/cli/openapi-ir-to-fern/src/FernDefnitionBuilder.ts → packages/cli/api-importers/commons/src/FernDefnitionBuilder.ts

@@ -1,13 +1,13 @@
 import { FERN_PACKAGE_MARKER_FILENAME, ROOT_API_FILENAME } from "@fern-api/configuration";
 import { AbsoluteFilePath, dirname, relative, RelativeFilePath } from "@fern-api/fs-utils";
-import { OpenApiIntermediateRepresentation, Source } from "@fern-api/openapi-ir-sdk";
 import { RawSchemas, RootApiFileSchema, visitRawEnvironmentDeclaration } from "@fern-api/fern-definition-schema";
 import { camelCase, isEqual } from "lodash-es";
 import path, { basename, extname } from "path";
-import { convertToSourceSchema } from "./utils/convertToSourceSchema";
-import { FernDefinitionDirectory } from "./FernDefinitionDirectory";
+import { FernDefinitionDirectory } from "./utils/FernDefinitionDirectory";
 
 export interface FernDefinitionBuilder {
+    setDisplayName({ displayName }: { displayName: string }): void;
+
     addNavigation({ navigation }: { navigation: string[] }): void;
 
     addAuthScheme({ name, schema }: { name: string; schema: RawSchemas.AuthSchemeDeclarationSchema }): void;
@@ -40,8 +40,17 @@ export interface FernDefinitionBuilder {
      * Adds an import and returns the prefix for the import. Returns undefined if no prefix.
      * @param file the file to add the import to
      * @param fileToImport the file to import
+     * @param alias import the file with this alias
      */
-    addImport({ file, fileToImport }: { file: RelativeFilePath; fileToImport: RelativeFilePath }): string | undefined;
+    addImport({
+        file,
+        fileToImport,
+        alias
+    }: {
+        file: RelativeFilePath;
+        fileToImport: RelativeFilePath;
+        alias?: string;
+    }): string | undefined;
 
     addType(file: RelativeFilePath, { name, schema }: { name: string; schema: RawSchemas.TypeDeclarationSchema }): void;
 
@@ -57,7 +66,11 @@ export interface FernDefinitionBuilder {
 
     addEndpoint(
         file: RelativeFilePath,
-        { name, schema, source }: { name: string; schema: RawSchemas.HttpEndpointSchema; source: Source | undefined }
+        {
+            name,
+            schema,
+            source
+        }: { name: string; schema: RawSchemas.HttpEndpointSchema; source: RawSchemas.SourceSchema | undefined }
     ): void;
 
     addWebhook(file: RelativeFilePath, { name, schema }: { name: string; schema: RawSchemas.WebhookSchema }): void;
@@ -92,28 +105,25 @@ export class FernDefinitionBuilderImpl implements FernDefinitionBuilder {
     private packageMarkerFile: RawSchemas.PackageMarkerFileSchema = {};
     private basePath: string | undefined = undefined;
 
-    public constructor(
-        ir: OpenApiIntermediateRepresentation,
-        private readonly modifyBasePaths: boolean,
-        public readonly enableUniqueErrorsPerEndpoint: boolean
-    ) {
+    public constructor(public readonly enableUniqueErrorsPerEndpoint: boolean) {
         this.root = new FernDefinitionDirectory();
         this.rootApiFile = {
             name: "api",
             "error-discrimination": {
                 strategy: "status-code"
             }
         };
-        if (ir.title != null) {
-            this.rootApiFile["display-name"] = ir.title;
-        }
+    }
+
+    public setDisplayName({ displayName }: { displayName: string }): void {
+        this.rootApiFile["display-name"] = displayName;
     }
 
     public addNavigation({ navigation }: { navigation: string[] }): void {
         this.packageMarkerFile.navigation = navigation;
     }
 
-    setServiceInfo(
+    public setServiceInfo(
         file: RelativeFilePath,
         { displayName, docs }: { displayName?: string | undefined; docs?: string | undefined }
     ): void {
@@ -223,20 +233,24 @@ export class FernDefinitionBuilderImpl implements FernDefinitionBuilder {
 
     public addImport({
         file,
-        fileToImport
+        fileToImport,
+        alias
     }: {
         file: RelativeFilePath;
         fileToImport: RelativeFilePath;
+        alias?: string;
     }): string | undefined {
         if (file === fileToImport) {
             return undefined;
         }
-        const importPrefix = camelCase(
-            (dirname(fileToImport) + "/" + basename(fileToImport, extname(fileToImport))).replaceAll(
-                "__package__",
-                "root"
-            )
-        );
+        const importPrefix =
+            alias ??
+            camelCase(
+                (dirname(fileToImport) + "/" + basename(fileToImport, extname(fileToImport))).replaceAll(
+                    "__package__",
+                    "root"
+                )
+            );
 
         if (file === RelativeFilePath.of(ROOT_API_FILENAME)) {
             if (this.rootApiFile.imports == null) {
@@ -336,7 +350,11 @@ export class FernDefinitionBuilderImpl implements FernDefinitionBuilder {
 
     public addEndpoint(
         file: RelativeFilePath,
-        { name, schema, source }: { name: string; schema: RawSchemas.HttpEndpointSchema; source: Source | undefined }
+        {
+            name,
+            schema,
+            source
+        }: { name: string; schema: RawSchemas.HttpEndpointSchema; source: RawSchemas.SourceSchema | undefined }
     ): void {
         const fernFile = this.getOrCreateFile(file);
         if (fernFile.service == null) {
@@ -347,7 +365,7 @@ export class FernDefinitionBuilderImpl implements FernDefinitionBuilder {
             };
         }
         if (source != null) {
-            fernFile.service.source = convertToSourceSchema(source);
+            fernFile.service.source = source;
         }
         fernFile.service.endpoints[name] = schema;
     }
@@ -412,78 +430,6 @@ export class FernDefinitionBuilderImpl implements FernDefinitionBuilder {
 
     public build(): FernDefinition {
         const definitionFiles = this.root.getAllFiles();
-        if (this.modifyBasePaths) {
-            const basePath = getSharedEnvironmentBasePath(this.rootApiFile);
-
-            // substitute package marker file
-            if (this.packageMarkerFile.service != null) {
-                this.packageMarkerFile.service = {
-                    ...this.packageMarkerFile.service,
-                    endpoints: Object.fromEntries(
-                        Object.entries(this.packageMarkerFile.service.endpoints).map(([id, endpoint]) => {
-                            return [
-                                id,
-                                {
-                                    ...endpoint,
-                                    path: `${basePath}${endpoint.path}`
-                                }
-                            ];
-                        })
-                    )
-                };
-            }
-
-            // subsitute definition files
-            for (const file of Object.values(definitionFiles)) {
-                if (file.service != null) {
-                    file.service = {
-                        ...file.service,
-                        endpoints: Object.fromEntries(
-                            Object.entries(file.service.endpoints).map(([id, endpoint]) => {
-                                return [
-                                    id,
-                                    {
-                                        ...endpoint,
-                                        path: `${basePath}${endpoint.path}`
-                                    }
-                                ];
-                            })
-                        )
-                    };
-                }
-            }
-
-            if (this.rootApiFile.environments != null) {
-                this.rootApiFile.environments = {
-                    ...Object.fromEntries(
-                        Object.entries(this.rootApiFile.environments).map(([env, url]) => {
-                            if (typeof url === "string") {
-                                return [env, url.substring(0, url.length - basePath.length)];
-                            } else if (isSingleBaseUrl(url)) {
-                                return [
-                                    env,
-                                    {
-                                        url: url.url.substring(0, url.url.length - basePath.length)
-                                    }
-                                ];
-                            } else {
-                                return [
-                                    env,
-                                    {
-                                        urls: Object.fromEntries(
-                                            Object.entries(url.urls).map(([name, url]) => {
-                                                return [name, url.substring(0, url.length - basePath.length)];
-                                            })
-                                        )
-                                    }
-                                ];
-                            }
-                        })
-                    )
-                };
-            }
-        }
-
         const basePath = this.basePath;
         if (basePath != null) {
             // substitute package marker file

packages/cli/openapi-ir-to-fern/src/__test__/FernDefinitionDirectory.test.ts → packages/cli/api-importers/commons/src/__test__/FernDefinitionDirectory.test.ts

@@ -1,6 +1,6 @@
 import { RawSchemas } from "@fern-api/fern-definition-schema";
 import { RelativeFilePath } from "@fern-api/fs-utils";
-import { FernDefinitionDirectory } from "../FernDefinitionDirectory";
+import { FernDefinitionDirectory } from "../utils/FernDefinitionDirectory";
 
 interface TestCase {
     description: string;

packages/cli/api-importers/commons/src/index.ts

@@ -0,0 +1,2 @@
+export { APIDefinitionImporter } from "./APIDefinitionImporter";
+export { type FernDefinitionBuilder, FernDefinitionBuilderImpl, type FernDefinition } from "./FernDefnitionBuilder";

packages/cli/api-importers/commons/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../../../shared/tsconfig.shared.json",
+  "compilerOptions": { "composite": true, "outDir": "lib", "rootDir": "src" },
+  "include": ["./src/**/*"],
+  "references": [
+    { "path": "../../../cli/fern-definition/schema" },
+    { "path": "../../../commons/core-utils" }, 
+    { "path": "../../task-context" },
+    { "path": "../../../commons/fs-utils" },
+  ]
+}

packages/cli/api-importers/commons/vitest.config.ts

@@ -0,0 +1 @@
+export { default } from "../../../../shared/vitest.config";

packages/cli/api-importers/conjure/conjure-sdk/.depcheckrc.json

@@ -0,0 +1,10 @@
+{
+    "ignores": [
+        "@types/jest",
+        "globals",
+        "@types/node"
+    ],
+    "ignore-patterns": [
+        "lib"
+    ]
+}

packages/cli/api-importers/conjure/conjure-sdk/.fernignore

@@ -0,0 +1 @@
+index.ts

packages/cli/api-importers/conjure/conjure-sdk/.prettierrc.cjs

@@ -0,0 +1 @@
+module.exports = require("../../../../../.prettierrc.json");

packages/cli/api-importers/conjure/conjure-sdk/fern/definition/api.yml

@@ -0,0 +1,7 @@
+name: conjure
+docs: | 
+  This API Definition captures the Conjure API Schema. 
+  This schema is built for Fern's Conjure importer, which 
+  
+error-discrimination:
+  strategy: status-code

packages/cli/api-importers/conjure/conjure-sdk/fern/definition/commons.yml

@@ -0,0 +1,4 @@
+types: 
+  WithDocs: 
+    properties: 
+      docs: optional<string>