chore(cli): consolidate small CliError migration branches

Author: FedeZara

packages/cli/api-importers/asyncapi-to-ir/package.json

@@ -33,6 +33,7 @@
   "dependencies": {
     "@fern-api/ir-sdk": "workspace:*",
     "@fern-api/ir-utils": "workspace:*",
+    "@fern-api/task-context": "workspace:*",
     "@fern-api/v3-importer-commons": "workspace:*",
     "lodash-es": "catalog:",
     "openapi-types": "^12.1.3",

packages/cli/api-importers/asyncapi-to-ir/src/3.0/channel/ChannelConverter3_0.ts

@@ -1,5 +1,6 @@
 import { HttpHeader, PathParameter, QueryParameter, WebSocketMessage, WebSocketMessageBody } from "@fern-api/ir-sdk";
 import { constructHttpPath } from "@fern-api/ir-utils";
+import { CliError } from "@fern-api/task-context";
 import { Converters } from "@fern-api/v3-importer-commons";
 import { OpenAPIV3 } from "openapi-types";
 import { AbstractChannelConverter } from "../../converters/AbstractChannelConverter.js";
@@ -310,7 +311,10 @@ export class ChannelConverter3_0 extends AbstractChannelConverter<AsyncAPIV3.Cha
 
     private getChannelPathFromOperation(operation: AsyncAPIV3.Operation): string {
         if (!operation.channel.$ref.startsWith(CHANNEL_REFERENCE_PREFIX)) {
-            throw new Error(`Failed to resolve channel path from operation ${operation.channel.$ref}`);
+            throw new CliError({
+                message: `Failed to resolve channel path from operation ${operation.channel.$ref}`,
+                code: CliError.Code.ReferenceError
+            });
         }
         return operation.channel.$ref.substring(CHANNEL_REFERENCE_PREFIX.length);
     }

packages/cli/api-importers/commons/src/utils/FernDefinitionDirectory.ts

@@ -1,5 +1,6 @@
 import { RawSchemas } from "@fern-api/fern-definition-schema";
 import { RelativeFilePath, sep } from "@fern-api/path-utils";
+import { CliError } from "@fern-api/task-context";
 
 export class FernDefinitionDirectory {
     private files: Record<RelativeFilePath, RawSchemas.DefinitionFileSchema> = {};
@@ -41,7 +42,10 @@ export class FernDefinitionDirectory {
         }
         const [directory, ...remainingPath] = pathParts;
         if (directory == null) {
-            throw new Error(`Internal error; cannot add file with path: ${pathParts}`);
+            throw new CliError({
+                message: `Internal error; cannot add file with path: ${pathParts}`,
+                code: CliError.Code.InternalError
+            });
         }
         if (!this.directories[directory]) {
             this.directories[directory] = new FernDefinitionDirectory();

packages/cli/api-importers/conjure/conjure-to-fern/package.json

@@ -37,6 +37,7 @@
     "@fern-api/fern-definition-schema": "workspace:*",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/importer-commons": "workspace:*",
+    "@fern-api/task-context": "workspace:*",
     "js-yaml": "catalog:"
   },
   "devDependencies": {

packages/cli/api-importers/conjure/conjure-to-fern/src/ConjureImporter.ts

@@ -3,6 +3,7 @@ import { parseEndpointLocator, removeSuffix } from "@fern-api/core-utils";
 import { RawSchemas } from "@fern-api/fern-definition-schema";
 import { AbsoluteFilePath, dirname, getFilename, join, RelativeFilePath, relativize } from "@fern-api/fs-utils";
 import { APIDefinitionImporter, FernDefinitionBuilderImpl, HttpServiceInfo } from "@fern-api/importer-commons";
+import { CliError } from "@fern-api/task-context";
 
 import { listConjureFiles } from "./utils/listConjureFiles.js";
 import { visitConjureTypeDeclaration } from "./utils/visitConjureTypeDeclaration.js";
@@ -77,7 +78,10 @@ export class ConjureImporter extends APIDefinitionImporter<ConjureImporter.Args>
             if (definition.services == null || Object.keys(definition.services ?? {}).length === 0) {
                 const fernFilePath = this.conjureFilepathToFernFilepath[filepath];
                 if (fernFilePath == null) {
-                    throw new Error(`Failed to find corresponding fern filepath for conjure file ${filepath}`);
+                    throw new CliError({
+                        message: `Failed to find corresponding fern filepath for conjure file ${filepath}`,
+                        code: CliError.Code.InternalError
+                    });
                 }
 
                 for (const [import_, importedFilepath] of Object.entries(definition.types?.conjureImports ?? {})) {
@@ -151,9 +155,10 @@ export class ConjureImporter extends APIDefinitionImporter<ConjureImporter.Args>
                         for (const pathParameter of endpointLocator.pathParameters) {
                             const pathParameterType = endpointDeclaration.args[pathParameter];
                             if (pathParameterType == null) {
-                                throw new Error(
-                                    `Failed to find path parameter ${pathParameter} in ${endpointDeclaration.http}`
-                                );
+                                throw new CliError({
+                                    message: `Failed to find path parameter ${pathParameter} in ${endpointDeclaration.http}`,
+                                    code: CliError.Code.InternalError
+                                });
                             }
                             pathParameters[pathParameter] =
                                 typeof pathParameterType === "string"
@@ -338,9 +343,10 @@ export class ConjureImporter extends APIDefinitionImporter<ConjureImporter.Args>
         );
         const correspondingFernFilePath = this.conjureFilepathToFernFilepath[relativeFilePathToImportedFile];
         if (correspondingFernFilePath == null) {
-            throw new Error(
-                `Failed to find corresponding fern filepath for conjure file ${relativeFilePathToImportedFile}`
-            );
+            throw new CliError({
+                message: `Failed to find corresponding fern filepath for conjure file ${relativeFilePathToImportedFile}`,
+                code: CliError.Code.InternalError
+            });
         }
         return correspondingFernFilePath;
     }

packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildEndpoint.ts

@@ -3,6 +3,7 @@ import { assertNever, MediaType } from "@fern-api/core-utils";
 import { RawSchemas } from "@fern-api/fern-definition-schema";
 import { Endpoint, EndpointExample, Request, RetriesConfiguration, Schema, SchemaId } from "@fern-api/openapi-ir";
 import { RelativeFilePath } from "@fern-api/path-utils";
+import { CliError } from "@fern-api/task-context";
 import { buildEndpointExample } from "./buildEndpointExample.js";
 import { ERROR_DECLARATIONS_FILENAME, EXTERNAL_AUDIENCE } from "./buildFernDefinition.js";
 import { buildHeader } from "./buildHeader.js";
@@ -283,7 +284,10 @@ export function buildEndpoint({
                 };
             },
             _other: () => {
-                throw new Error("Unrecognized Response type: " + endpoint.response?.type);
+                throw new CliError({
+                    message: "Unrecognized Response type: " + endpoint.response?.type,
+                    code: CliError.Code.InternalError
+                });
             }
         });
     }

packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildWebhooks.ts

@@ -13,6 +13,7 @@ import {
     WebhookTimestampFormat
 } from "@fern-api/openapi-ir";
 import { join, RelativeFilePath } from "@fern-api/path-utils";
+import { CliError } from "@fern-api/task-context";
 import { camelCase, isEqual } from "lodash-es";
 import { buildHeader } from "./buildHeader.js";
 import { buildTypeReference } from "./buildTypeReference.js";
@@ -142,7 +143,10 @@ export function buildWebhooks(context: OpenApiIrConverterContext): void {
                     };
                 },
                 _other: () => {
-                    throw new Error("Unrecognized Response type: " + webhook.response?.type);
+                    throw new CliError({
+                        message: "Unrecognized Response type: " + webhook.response?.type,
+                        code: CliError.Code.InternalError
+                    });
                 }
             });
         }

packages/cli/api-importers/openapi/openapi-ir-to-fern/src/utils/convertToHttpMethod.ts

@@ -1,5 +1,6 @@
 import { RawSchemas } from "@fern-api/fern-definition-schema";
 import { HttpMethod } from "@fern-api/openapi-ir";
+import { CliError } from "@fern-api/task-context";
 
 export function convertToHttpMethod(httpMethod: HttpMethod): RawSchemas.HttpMethodSchema {
     return HttpMethod._visit<RawSchemas.HttpMethodSchema>(httpMethod, {
@@ -10,13 +11,13 @@ export function convertToHttpMethod(httpMethod: HttpMethod): RawSchemas.HttpMeth
         delete: () => RawSchemas.HttpMethodSchema.Delete,
         head: () => RawSchemas.HttpMethodSchema.Head,
         options: () => {
-            throw new Error("OPTIONS is unsupported");
+            throw new CliError({ message: "OPTIONS is unsupported", code: CliError.Code.ConfigError });
         },
         trace: () => {
-            throw new Error("TRACE is unsupported");
+            throw new CliError({ message: "TRACE is unsupported", code: CliError.Code.ConfigError });
         },
         _other: () => {
-            throw new Error("Unknown http method is unsupported");
+            throw new CliError({ message: "Unknown http method is unsupported", code: CliError.Code.ConfigError });
         }
     });
 }

packages/cli/api-importers/openapi/openapi-ir-to-fern/src/utils/getEndpointLocation.ts

@@ -1,8 +1,8 @@
 import { FERN_PACKAGE_MARKER_FILENAME } from "@fern-api/configuration";
 import { Endpoint, HttpMethod } from "@fern-api/openapi-ir";
 import { join, RelativeFilePath } from "@fern-api/path-utils";
+import { CliError } from "@fern-api/task-context";
 import { camelCase, compact, isEqual } from "lodash-es";
-
 import { convertEndpointSdkNameToFileWithoutExtension } from "./convertSdkGroupName.js";
 
 export interface EndpointLocation {
@@ -108,7 +108,10 @@ function getUnresolvedEndpointLocation(endpoint: Endpoint): EndpointLocation {
     }
 
     if (fileParts.length >= operationIdTokens.length) {
-        throw new Error(`Cannot get file for endpoint ${JSON.stringify(endpoint)}`);
+        throw new CliError({
+            message: `Cannot get file for endpoint ${JSON.stringify(endpoint)}`,
+            code: CliError.Code.InternalError
+        });
     }
 
     return {

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

@@ -40,6 +40,7 @@
     "@fern-api/ir-sdk": "workspace:*",
     "@fern-api/ir-utils": "workspace:*",
     "@fern-api/logger": "workspace:*",
+    "@fern-api/task-context": "workspace:*",
     "js-yaml": "catalog:",
     "js-yaml-source-map": "catalog:",
     "lodash-es": "catalog:",