feat(cli): Add @fern-api/browser-compatible-fern-workspace (fern-api#…

…5317) * chore(cli): Add @fern-api/browser-compatible-fern-workspace * Add workspace directory * Update all tsconfig.json references * Refactor with BaseOpenAPIWorkspace * Update and move getOSSWorkspaceSettingsFromGeneratorInvocation * Remove duplicative SpecImportSettings * Update absoluteFilePath * Consolidate Source and Spec types * Fix depcheck * Remove absoluteFilePath from snapshots * Add configurable absoluteFilePath for tests
emretezisci · Dec 3, 2024 · 6fd463a · 6fd463a
1 parent 76d320b
commit 6fd463a
Show file tree

Hide file tree

Showing 141 changed files with 1,124 additions and 837 deletions.
diff --git a/package.json b/package.json
@@ -34,9 +34,9 @@
     "seed:build": "pnpm --filter @fern-api/seed-cli dist:cli && echo 'Run packages/seed/dist/cli.cjs'",
     "publish": "pnpm -r publish --access public --no-git-checks --loglevel=verbose",
     "jsonschema": "pnpm definition-yml:jsonschema && pnpm api-yml:jsonschema && pnpm package-yml:jsonschema && pnpm docs-yml:jsonschema && pnpm generators-yml:jsonschema",
-    "definition-yml:jsonschema": "fern jsonschema fern.schema.json --api fern-definition --type file.DefinitionFileSchema && fern jsonschema packages/cli/lazy-fern-workspace/src/fern.schema.json --api fern-definition --type file.DefinitionFileSchema",
-    "api-yml:jsonschema": "fern jsonschema api-yml.schema.json --api fern-definition --type file.RootApiFileSchema && fern jsonschema packages/cli/lazy-fern-workspace/src/api-yml.schema.json --api fern-definition --type file.RootApiFileSchema",
-    "package-yml:jsonschema": "fern jsonschema package-yml.schema.json --api fern-definition --type file.PackageMarkerFileSchema && fern jsonschema packages/cli/lazy-fern-workspace/src/package-yml.schema.json --api fern-definition --type file.PackageMarkerFileSchema",
+    "definition-yml:jsonschema": "fern jsonschema fern.schema.json --api fern-definition --type file.DefinitionFileSchema && fern jsonschema packages/cli/workspace/lazy-fern-workspace/src/fern.schema.json --api fern-definition --type file.DefinitionFileSchema",
+    "api-yml:jsonschema": "fern jsonschema api-yml.schema.json --api fern-definition --type file.RootApiFileSchema && fern jsonschema packages/cli/workspace/lazy-fern-workspace/src/api-yml.schema.json --api fern-definition --type file.RootApiFileSchema",
+    "package-yml:jsonschema": "fern jsonschema package-yml.schema.json --api fern-definition --type file.PackageMarkerFileSchema && fern jsonschema packages/cli/workspace/lazy-fern-workspace/src/package-yml.schema.json --api fern-definition --type file.PackageMarkerFileSchema",
     "docs-yml:jsonschema": "fern jsonschema docs-yml.schema.json --api docs-yml --type docs.DocsConfiguration",
     "generators-yml:jsonschema": "fern jsonschema generators-yml.schema.json --api generators-yml --type generators.GeneratorsConfigurationSchema",
     "check-cli-release-blockers": "pnpm fern-script check-cli-release-blockers",

diff --git a/packages/cli/api-importers/conjure/conjure-to-fern-tests/tsconfig.json b/packages/cli/api-importers/conjure/conjure-to-fern-tests/tsconfig.json
@@ -6,6 +6,6 @@
   "references": [
     { "path": "../../../../commons/fs-utils" },
     { "path": "../../../task-context" },
-    { "path": "../../../workspace-loader" },
+    { "path": "../../../workspace/loader" },
   ]
 }
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/index.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/index.ts
@@ -1,5 +1,4 @@
 export { type ParseOpenAPIOptions } from "./options";
-export { parse, type Document } from "./parse";
-export { InMemoryOpenAPILoader } from "./openapi/InMemoryOpenAPILoader";
+export { parse, type Document, type OpenAPIDocument, type SpecImportSettings } from "./parse";
 export { FernOpenAPIExtension, XFernStreaming, FERN_TYPE_EXTENSIONS } from "./openapi/v3/extensions/fernExtensions";
 export * from "./asyncapi/v2";
diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/package.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/package.json
@@ -28,10 +28,10 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
+    "@fern-api/browser-compatible-fern-workspace": "workspace:*",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/task-context": "workspace:*",
     "@fern-api/lazy-fern-workspace": "workspace:*",
-    "@fern-api/openapi-ir-parser": "workspace:*",
     "@fern-api/workspace-loader": "workspace:*",
     "js-yaml": "^4.1.0",
     "openapi-types": "^12.1.3"

diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/openapi-ir.test.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/openapi-ir.test.ts
@@ -3,10 +3,11 @@ import { createMockTaskContext } from "@fern-api/task-context";
 import { loadAPIWorkspace } from "@fern-api/workspace-loader";
 import { readdir } from "fs/promises";
 import { OSSWorkspace } from "@fern-api/lazy-fern-workspace";
-import { InMemoryOpenAPILoader } from "@fern-api/openapi-ir-parser";
+import { InMemoryOpenAPILoader } from "@fern-api/browser-compatible-fern-workspace";
 import fs from "fs/promises";
 import { OpenAPI } from "openapi-types";
 import yaml from "js-yaml";
+
 const FIXTURES_DIR = join(AbsoluteFilePath.of(__dirname), RelativeFilePath.of("fixtures"));
 
 // eslint-disable-next-line @typescript-eslint/no-misused-promises

diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/openapi.test.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/openapi.test.ts
@@ -28,7 +28,11 @@ describe("openapi-ir-to-fern", async () => {
                         `Failed to load OpenAPI fixture ${fixture.name}\n${JSON.stringify(workspace.failures)}`
                     );
                 }
-                const definition = await workspace.workspace.getDefinition({ context });
+                const definition = await workspace.workspace.getDefinition({
+                    context,
+                    absoluteFilePath: AbsoluteFilePath.of("/DUMMY_PATH")
+                });
+
                 // eslint-disable-next-line jest/no-standalone-expect
                 expect(definition).toMatchFileSnapshot(`./__snapshots__/openapi/${fixture.name}.json`);
             },

diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/openapiDocs.test.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/openapiDocs.test.ts
@@ -28,10 +28,15 @@ describe("openapi-ir-to-fern docs", async () => {
                         `Failed to load OpenAPI fixture ${fixture.name}\n${JSON.stringify(workspace.failures)}`
                     );
                 }
+
                 const definition = await workspace.workspace.getDefinition(
-                    { context },
+                    {
+                        context,
+                        absoluteFilePath: AbsoluteFilePath.of("/DUMMY_PATH")
+                    },
                     { enableUniqueErrorsPerEndpoint: true, preserveSchemaIds: true }
                 );
+
                 // eslint-disable-next-line jest/no-standalone-expect
                 expect(definition).toMatchFileSnapshot(`./__snapshots__/openapi-docs/${fixture.name}.json`);
             },

diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/tsconfig.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/tsconfig.json
@@ -22,13 +22,13 @@
       "path": "../../../task-context"
     },
     {
-      "path": "../../../workspace-loader"
+      "path": "../../../workspace/browser-compatible-fern-workspace"
     },
     {
-      "path": "../../../lazy-fern-workspace"
+      "path": "../../../workspace/loader"
     },
     {
-      "path": "../openapi-ir-parser"
+      "path": "../../../workspace/lazy-fern-workspace"
     }
   ]
 }
diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/tsconfig.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern/tsconfig.json
@@ -30,9 +30,6 @@
     {
       "path": "../../../task-context"
     },
-    {
-      "path": "../../../workspace-commons"
-    },
     {
       "path": "../../commons"
     },

diff --git a/packages/cli/cli-source-resolver/tsconfig.json b/packages/cli/cli-source-resolver/tsconfig.json
@@ -25,7 +25,7 @@
       "path": "../task-context"
     },
     {
-      "path": "../workspace-commons"
+      "path": "../workspace/commons"
     }
   ]
 }
diff --git a/packages/cli/cli/tsconfig.json b/packages/cli/cli/tsconfig.json
@@ -88,13 +88,13 @@
       "path": "../task-context"
     },
     {
-      "path": "../workspace-loader"
+      "path": "../workspace/loader"
     },
     {
-      "path": "../workspace-commons"
+      "path": "../workspace/commons"
     },
     {
-      "path": "../lazy-fern-workspace"
+      "path": "../workspace/lazy-fern-workspace"
     },
     {
       "path": "../yaml/docs-validator"

diff --git a/packages/cli/docs-resolver/tsconfig.json b/packages/cli/docs-resolver/tsconfig.json
@@ -37,7 +37,7 @@
       "path": "../task-context"
     },
     {
-      "path": "../workspace-loader"
+      "path": "../workspace/loader"
     }
   ]
 }
diff --git a/packages/cli/fern-definition/formatter/tsconfig.json b/packages/cli/fern-definition/formatter/tsconfig.json
@@ -6,7 +6,7 @@
     { "path": "../../../commons/core-utils" },
     { "path": "../../../commons/fs-utils" },
     { "path": "../../task-context" },
-    { "path": "../../workspace-commons" },
+    { "path": "../../workspace/commons" },
     { "path": "../schema" }
   ]
 }
diff --git a/packages/cli/fern-definition/ir-to-jsonschema/tsconfig.json b/packages/cli/fern-definition/ir-to-jsonschema/tsconfig.json
@@ -31,7 +31,7 @@
       "path": "../../task-context"
     },
     {
-      "path": "../../workspace-loader"
+      "path": "../../workspace/loader"
     },
   ]
 }
diff --git a/packages/cli/fern-definition/validator/tsconfig.json b/packages/cli/fern-definition/validator/tsconfig.json
@@ -31,10 +31,10 @@
       "path": "../../task-context"
     },
     {
-      "path": "../../workspace-commons"
+      "path": "../../workspace/commons"
     },
     {
-      "path": "../../lazy-fern-workspace"
+      "path": "../../workspace/lazy-fern-workspace"
     },
     {
       "path": "../schema"

diff --git a/packages/cli/generation/ir-generator-tests/tsconfig.json b/packages/cli/generation/ir-generator-tests/tsconfig.json
@@ -31,10 +31,10 @@
       "path": "../../task-context"
     },
     {
-      "path": "../../workspace-loader"
+      "path": "../../workspace/loader"
     },
     {
-      "path": "../../workspace-commons"
+      "path": "../../workspace/commons"
     },
     {
       "path": "../../fern-definition/schema"

diff --git a/packages/cli/generation/ir-generator/tsconfig.json b/packages/cli/generation/ir-generator/tsconfig.json
@@ -25,7 +25,7 @@
       "path": "../../task-context"
     },
     {
-      "path": "../../workspace-commons"
+      "path": "../../workspace/commons"
     },
     {
       "path": "../../fern-definition/schema"

diff --git a/packages/cli/generation/ir-migrations/tsconfig.json b/packages/cli/generation/ir-migrations/tsconfig.json
@@ -34,7 +34,7 @@
       "path": "../../task-context"
     },
     {
-      "path": "../../workspace-loader"
+      "path": "../../workspace/loader"
     },
     {
       "path": "../ir-generator"

diff --git a/.../generation/local-generation/local-workspace-runner/src/runLocalGenerationForWorkspace.ts b/.../generation/local-generation/local-workspace-runner/src/runLocalGenerationForWorkspace.ts
@@ -1,6 +1,9 @@
 import { fernConfigJson, generatorsYml } from "@fern-api/configuration";
 import { TaskContext } from "@fern-api/task-context";
-import { AbstractAPIWorkspace, getOSSWorkspaceSettingsFromGeneratorInvocation } from "@fern-api/workspace-loader";
+import {
+    AbstractAPIWorkspace,
+    getBaseOpenAPIWorkspaceSettingsFromGeneratorInvocation
+} from "@fern-api/workspace-loader";
 import chalk from "chalk";
 import os from "os";
 import path from "path";
@@ -32,7 +35,7 @@ export async function runLocalGenerationForWorkspace({
                 } else {
                     const fernWorkspace = await workspace.toFernWorkspace(
                         { context },
-                        getOSSWorkspaceSettingsFromGeneratorInvocation(generatorInvocation)
+                        getBaseOpenAPIWorkspaceSettingsFromGeneratorInvocation(generatorInvocation)
                     );
 
                     await writeFilesToDiskAndRunGenerator({

diff --git a/packages/cli/generation/local-generation/local-workspace-runner/tsconfig.json b/packages/cli/generation/local-generation/local-workspace-runner/tsconfig.json
@@ -34,10 +34,10 @@
       "path": "../../../task-context"
     },
     {
-      "path": "../../../workspace-loader"
+      "path": "../../../workspace/loader"
     },
     {
-      "path": "../../../workspace-commons"
+      "path": "../../../workspace/commons"
     },
     {
       "path": "../../ir-generator"

diff --git a/...ation/remote-generation/remote-workspace-runner/src/runRemoteGenerationForAPIWorkspace.ts b/...ation/remote-generation/remote-workspace-runner/src/runRemoteGenerationForAPIWorkspace.ts
@@ -2,7 +2,10 @@ import { FernToken } from "@fern-api/auth";
 import { fernConfigJson, generatorsYml } from "@fern-api/configuration";
 import { AbsoluteFilePath } from "@fern-api/fs-utils";
 import { TaskContext } from "@fern-api/task-context";
-import { AbstractAPIWorkspace, getOSSWorkspaceSettingsFromGeneratorInvocation } from "@fern-api/workspace-loader";
+import {
+    AbstractAPIWorkspace,
+    getBaseOpenAPIWorkspaceSettingsFromGeneratorInvocation
+} from "@fern-api/workspace-loader";
 import { FernFiddle } from "@fern-fern/fiddle-sdk";
 import { downloadSnippetsForTask } from "./downloadSnippetsForTask";
 import { runRemoteGenerationForGenerator } from "./runRemoteGenerationForGenerator";
@@ -49,7 +52,7 @@ export async function runRemoteGenerationForAPIWorkspace({
             context.runInteractiveTask({ name: generatorInvocation.name }, async (interactiveTaskContext) => {
                 const fernWorkspace = await workspace.toFernWorkspace(
                     { context },
-                    getOSSWorkspaceSettingsFromGeneratorInvocation(generatorInvocation)
+                    getBaseOpenAPIWorkspaceSettingsFromGeneratorInvocation(generatorInvocation)
                 );
 
                 const remoteTaskHandlerResponse = await runRemoteGenerationForGenerator({

diff --git a/packages/cli/generation/remote-generation/remote-workspace-runner/tsconfig.json b/packages/cli/generation/remote-generation/remote-workspace-runner/tsconfig.json
@@ -43,7 +43,7 @@
       "path": "../../../task-context"
     },
     {
-      "path": "../../../workspace-loader"
+      "path": "../../../workspace/loader"
     },
     {
       "path": "../../ir-generator"

diff --git a/packages/cli/lazy-fern-workspace/.prettierrc.cjs b/packages/cli/lazy-fern-workspace/.prettierrc.cjs
-Original file line number
+Diff line change
@@ Expand Up / @@ -30,9 +30,6 @@ @@
         {
           "path": "../../../task-context"
         },
-        {
-          "path": "../../../workspace-commons"
-        },
         {
           "path": "../../commons"
         },
@@ Expand Down @@