zephyr-edge-contract 0.0.21 → 0.0.22

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export { ZEPHYR_API_ENDPOINT, ZE_API_ENDPOINT, ze_api_gateway } from './lib/api-contract-negotiation/get-api-contract';
 export { PublishRequest, StageZeroPublishRequest } from './lib/edge-api/publish-request';
 export { ZeEnvs, ZeUploadBuildStats } from './lib/edge-api/ze-envs-request';
+export { ZeErrorCategories, ZeErrorCodes, ZeErrorKeys, ZeErrorType, ZeErrors, ZephyrError } from './lib/errors';
 export * as appDeployResultCache from './lib/node-persist/app-deploy-result-cache';
 export { getAppConfig, remoteAppConfig, saveAppConfig } from './lib/node-persist/application-configuration';
 export * as _fs_cache from './lib/node-persist/fs-cache';
@@ -17,8 +18,9 @@ export { brightBlueBgName, brightGreenBgName, brightRedBgName, brightYellowBgNam
 export * from './lib/utils/debug-enabled';
 export * from './lib/utils/picocolor';
 export * as color from './lib/utils/picocolor';
+export * as ZeUtils from './lib/utils/promise';
 export { safe_json_parse } from './lib/utils/safe-json-parse';
-export { request } from './lib/utils/ze-http-request';
+export { HttpResponse, UrlString, ZeHttpRequest } from './lib/utils/ze-http-request';
 export { ZeApplicationList } from './lib/ze-api/app-list';
 export { ZeAppVersion, ZeAppVersionResponse } from './lib/ze-api/app-version';
 export { ConvertedGraph } from './lib/ze-api/converted-graph';

package/dist/index.js

@@ -1,11 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.request = exports.safe_json_parse = exports.color = exports.ze_log = exports.ze_error = exports.dimmedName = exports.brightYellowBgName = exports.brightRedBgName = exports.brightGreenBgName = exports.brightBlueBgName = exports.createSnapshotId = exports.createApplicationUID = exports.saveToken = exports.removeToken = exports.getToken = exports.cleanTokens = exports.hasSecretToken = exports.getSecretToken = exports.savePartialAssetMap = exports.removePartialAssetMap = exports.getPartialAssetMap = exports._hash_cache = exports._fs_cache = exports.saveAppConfig = exports.remoteAppConfig = exports.getAppConfig = exports.appDeployResultCache = exports.ze_api_gateway = exports.ZE_API_ENDPOINT = exports.ZEPHYR_API_ENDPOINT = void 0;
+exports.ZeHttpRequest = exports.safe_json_parse = exports.ZeUtils = exports.color = exports.ze_log = exports.ze_error = exports.dimmedName = exports.brightYellowBgName = exports.brightRedBgName = exports.brightGreenBgName = exports.brightBlueBgName = exports.createSnapshotId = exports.createApplicationUID = exports.saveToken = exports.removeToken = exports.getToken = exports.cleanTokens = exports.hasSecretToken = exports.getSecretToken = exports.savePartialAssetMap = exports.removePartialAssetMap = exports.getPartialAssetMap = exports._hash_cache = exports._fs_cache = exports.saveAppConfig = exports.remoteAppConfig = exports.getAppConfig = exports.appDeployResultCache = exports.ZephyrError = exports.ZeErrors = exports.ZeErrorCategories = exports.ze_api_gateway = exports.ZE_API_ENDPOINT = exports.ZEPHYR_API_ENDPOINT = void 0;
 const tslib_1 = require("tslib");
 var get_api_contract_1 = require("./lib/api-contract-negotiation/get-api-contract");
 Object.defineProperty(exports, "ZEPHYR_API_ENDPOINT", { enumerable: true, get: function () { return get_api_contract_1.ZEPHYR_API_ENDPOINT; } });
 Object.defineProperty(exports, "ZE_API_ENDPOINT", { enumerable: true, get: function () { return get_api_contract_1.ZE_API_ENDPOINT; } });
 Object.defineProperty(exports, "ze_api_gateway", { enumerable: true, get: function () { return get_api_contract_1.ze_api_gateway; } });
+var errors_1 = require("./lib/errors");
+Object.defineProperty(exports, "ZeErrorCategories", { enumerable: true, get: function () { return errors_1.ZeErrorCategories; } });
+Object.defineProperty(exports, "ZeErrors", { enumerable: true, get: function () { return errors_1.ZeErrors; } });
+Object.defineProperty(exports, "ZephyrError", { enumerable: true, get: function () { return errors_1.ZephyrError; } });
 exports.appDeployResultCache = tslib_1.__importStar(require("./lib/node-persist/app-deploy-result-cache"));
 var application_configuration_1 = require("./lib/node-persist/application-configuration");
 Object.defineProperty(exports, "getAppConfig", { enumerable: true, get: function () { return application_configuration_1.getAppConfig; } });
@@ -41,8 +45,9 @@ Object.defineProperty(exports, "ze_log", { enumerable: true, get: function () {
 tslib_1.__exportStar(require("./lib/utils/debug-enabled"), exports);
 tslib_1.__exportStar(require("./lib/utils/picocolor"), exports);
 exports.color = tslib_1.__importStar(require("./lib/utils/picocolor"));
+exports.ZeUtils = tslib_1.__importStar(require("./lib/utils/promise"));
 var safe_json_parse_1 = require("./lib/utils/safe-json-parse");
 Object.defineProperty(exports, "safe_json_parse", { enumerable: true, get: function () { return safe_json_parse_1.safe_json_parse; } });
 var ze_http_request_1 = require("./lib/utils/ze-http-request");
-Object.defineProperty(exports, "request", { enumerable: true, get: function () { return ze_http_request_1.request; } });
+Object.defineProperty(exports, "ZeHttpRequest", { enumerable: true, get: function () { return ze_http_request_1.ZeHttpRequest; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,oFAAuH;AAA9G,uHAAA,mBAAmB,OAAA;AAAE,mHAAA,eAAe,OAAA;AAAE,kHAAA,cAAc,OAAA;AAG7D,2GAAmF;AACnF,0FAA4G;AAAnG,yHAAA,YAAY,OAAA;AAAE,4HAAA,eAAe,OAAA;AAAE,0HAAA,aAAa,OAAA;AACrD,iFAAyD;AACzD,qFAA6D;AAC7D,4EAAuH;AAA9G,wHAAA,kBAAkB,OAAA;AAAE,2HAAA,qBAAqB,OAAA;AAAE,yHAAA,mBAAmB,OAAA;AACvE,gEAAiF;AAAxE,8GAAA,cAAc,OAAA;AAAE,8GAAA,cAAc,OAAA;AACvC,kDAAyF;AAAhF,oGAAA,WAAW,OAAA;AAAE,iGAAA,QAAQ,OAAA;AAAE,oGAAA,WAAW,OAAA;AAAE,kGAAA,SAAS,OAAA;AACtD,qFAA2D;AAG3D,iFAA4E;AAAnE,gIAAA,oBAAoB,OAAA;AAC7B,qEAAkE;AAAzD,sHAAA,gBAAgB,OAAA;AACzB,2CAA2I;AAAlI,yGAAA,gBAAgB,OAAA;AAAE,0GAAA,iBAAiB,OAAA;AAAE,wGAAA,eAAe,OAAA;AAAE,2GAAA,kBAAkB,OAAA;AAAE,mGAAA,UAAU,OAAA;AAAE,iGAAA,QAAQ,OAAA;AAAE,+FAAA,MAAM,OAAA;AAC/G,oEAA0C;AAC1C,gEAAsC;AACtC,uEAA+C;AAC/C,+DAA8D;AAArD,kHAAA,eAAe,OAAA;AACxB,+DAAsD;AAA7C,0GAAA,OAAO,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,oFAAuH;AAA9G,uHAAA,mBAAmB,OAAA;AAAE,mHAAA,eAAe,OAAA;AAAE,kHAAA,cAAc,OAAA;AAG7D,uCAAgH;AAAvG,2GAAA,iBAAiB,OAAA;AAA0C,kGAAA,QAAQ,OAAA;AAAE,qGAAA,WAAW,OAAA;AACzF,2GAAmF;AACnF,0FAA4G;AAAnG,yHAAA,YAAY,OAAA;AAAE,4HAAA,eAAe,OAAA;AAAE,0HAAA,aAAa,OAAA;AACrD,iFAAyD;AACzD,qFAA6D;AAC7D,4EAAuH;AAA9G,wHAAA,kBAAkB,OAAA;AAAE,2HAAA,qBAAqB,OAAA;AAAE,yHAAA,mBAAmB,OAAA;AACvE,gEAAiF;AAAxE,8GAAA,cAAc,OAAA;AAAE,8GAAA,cAAc,OAAA;AACvC,kDAAyF;AAAhF,oGAAA,WAAW,OAAA;AAAE,iGAAA,QAAQ,OAAA;AAAE,oGAAA,WAAW,OAAA;AAAE,kGAAA,SAAS,OAAA;AACtD,qFAA2D;AAG3D,iFAA4E;AAAnE,gIAAA,oBAAoB,OAAA;AAC7B,qEAAkE;AAAzD,sHAAA,gBAAgB,OAAA;AACzB,2CAA2I;AAAlI,yGAAA,gBAAgB,OAAA;AAAE,0GAAA,iBAAiB,OAAA;AAAE,wGAAA,eAAe,OAAA;AAAE,2GAAA,kBAAkB,OAAA;AAAE,mGAAA,UAAU,OAAA;AAAE,iGAAA,QAAQ,OAAA;AAAE,+FAAA,MAAM,OAAA;AAC/G,oEAA0C;AAC1C,gEAAsC;AACtC,uEAA+C;AAC/C,uEAA+C;AAC/C,+DAA8D;AAArD,kHAAA,eAAe,OAAA;AACxB,+DAAqF;AAAnD,gHAAA,aAAa,OAAA"}

package/dist/lib/api-contract-negotiation/get-api-contract.d.ts

@@ -1,5 +1,7 @@
 export declare const ZEPHYR_API_ENDPOINT: () => string;
 export declare const ZE_API_ENDPOINT: () => string;
+export declare const ZE_API_ENDPOINT_HOST: () => string;
+export declare const ZE_IS_PREVIEW: () => boolean;
 export declare const ze_api_gateway: {
     logs: string;
     build_stats: string;

package/dist/lib/api-contract-negotiation/get-api-contract.js

@@ -1,10 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ze_api_gateway = exports.ZE_API_ENDPOINT = exports.ZEPHYR_API_ENDPOINT = void 0;
+exports.ze_api_gateway = exports.ZE_IS_PREVIEW = exports.ZE_API_ENDPOINT_HOST = exports.ZE_API_ENDPOINT = exports.ZEPHYR_API_ENDPOINT = void 0;
 const ZEPHYR_API_ENDPOINT = () => { var _a; return (_a = process.env['ZE_API']) !== null && _a !== void 0 ? _a : 'https://api.zephyr-cloud.io'; };
 exports.ZEPHYR_API_ENDPOINT = ZEPHYR_API_ENDPOINT;
 const ZE_API_ENDPOINT = () => { var _a; return (_a = process.env['ZE_API_GATE']) !== null && _a !== void 0 ? _a : 'https://zeapi.zephyrcloud.app'; };
 exports.ZE_API_ENDPOINT = ZE_API_ENDPOINT;
+const ZE_API_ENDPOINT_HOST = () => new URL((0, exports.ZE_API_ENDPOINT)()).host;
+exports.ZE_API_ENDPOINT_HOST = ZE_API_ENDPOINT_HOST;
+const ZE_IS_PREVIEW = () => process.env['ZE_IS_PREVIEW'] === 'true';
+exports.ZE_IS_PREVIEW = ZE_IS_PREVIEW;
 exports.ze_api_gateway = {
     logs: '/logs',
     build_stats: '/build-stats',

package/dist/lib/api-contract-negotiation/get-api-contract.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-api-contract.js","sourceRoot":"","sources":["../../../src/lib/api-contract-negotiation/get-api-contract.ts"],"names":[],"mappings":";;;AAAO,MAAM,mBAAmB,GAAG,GAAG,EAAE,WAAC,OAAA,MAAA,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,mCAAI,6BAA6B,CAAA,EAAA,CAAC;AAAnF,QAAA,mBAAmB,uBAAgE;AAEzF,MAAM,eAAe,GAAG,GAAG,EAAE,WAAC,OAAA,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,mCAAI,+BAA+B,CAAA,EAAA,CAAC;AAAtF,QAAA,eAAe,mBAAuE;AAEtF,QAAA,cAAc,GAAG;IAC5B,IAAI,EAAE,OAAO;IACb,WAAW,EAAE,cAAc;IAC3B,SAAS,EAAE,YAAY;IACvB,OAAO,EAAE,UAAU;IACnB,kBAAkB,EAAE,qBAAqB;CAC1C,CAAC"}
+{"version":3,"file":"get-api-contract.js","sourceRoot":"","sources":["../../../src/lib/api-contract-negotiation/get-api-contract.ts"],"names":[],"mappings":";;;AAAO,MAAM,mBAAmB,GAAG,GAAG,EAAE,WAAC,OAAA,MAAA,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,mCAAI,6BAA6B,CAAA,EAAA,CAAC;AAAnF,QAAA,mBAAmB,uBAAgE;AAEzF,MAAM,eAAe,GAAG,GAAG,EAAE,WAAC,OAAA,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,mCAAI,+BAA+B,CAAA,EAAA,CAAC;AAAtF,QAAA,eAAe,mBAAuE;AAE5F,MAAM,oBAAoB,GAAG,GAAG,EAAE,CAAC,IAAI,GAAG,CAAC,IAAA,uBAAe,GAAE,CAAC,CAAC,IAAI,CAAC;AAA7D,QAAA,oBAAoB,wBAAyC;AAEnE,MAAM,aAAa,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,KAAK,MAAM,CAAC;AAA9D,QAAA,aAAa,iBAAiD;AAE9D,QAAA,cAAc,GAAG;IAC5B,IAAI,EAAE,OAAO;IACb,WAAW,EAAE,cAAc;IAC3B,SAAS,EAAE,YAAY;IACvB,OAAO,EAAE,UAAU;IACnB,kBAAkB,EAAE,qBAAqB;CAC1C,CAAC"}

package/dist/lib/errors/codes.d.ts

@@ -0,0 +1,276 @@
+/** Categories for all error codes. */
+export declare const ZeErrorCategories: {
+    /** Error we have yet catched and known */
+    readonly unknown: "00";
+    /** Stage 0 build error */
+    readonly build: "10";
+    /** Stage 1 Deployment error */
+    readonly deploy: "20";
+    /** Browser error */
+    readonly browser: "30";
+    /** Module Federation/Config related error */
+    readonly config: "40";
+};
+/**
+ * A collection of error types and the error code during local/build stage
+ *
+ * If you are searching for an error globally, if it is a build related error, it starts with `ZE10`, if it's a deployment related error,
+ * search for `ZE20` and then followed with their ID.
+ *
+ * - `ZE` at the front is a constant
+ * - Two digits at the middle PP (`10` for build error or `20` for deployment error) is their categories,
+ * - Last three digits is their ID.
+ *
+ * For example, if you have a `SNAPSHOT_NOT_FOUND` error, search for `ZE20023`, if you see an error showing up on terminal or application,
+ * the last three numbers are their IDs. We might extend to have more errors in the future.
+ */
+export declare const ZeErrors: {
+    readonly ERR_UNKNOWN: {
+        readonly id: "000";
+        readonly message: "\nUnknown error: {{ message }}\n\n";
+        readonly kind: "unknown";
+    };
+    /** Package.json not found error */
+    readonly ERR_PACKAGE_JSON_NOT_FOUND: {
+        readonly id: "010";
+        readonly message: "package.json not found";
+        readonly kind: "build";
+    };
+    /** Package.json is not in a valid json format */
+    readonly ERR_PACKAGE_JSON_NOT_VALID: {
+        readonly id: "011";
+        readonly message: "Package.json is not in a valid json format.";
+        readonly kind: "build";
+    };
+    /** Webpack config error */
+    readonly ERR_WEBPACK_CONFIG: {
+        readonly id: "012";
+        readonly message: "Webpack config error.";
+        readonly kind: "build";
+    };
+    readonly ERR_PACKAGE_JSON_MUST_HAVE_NAME_VERSION: {
+        readonly id: "013";
+        readonly message: "Zephyr need package.json to have name and version field to map your application configuration in deployment. Please ensure these fields exists in your package.json.";
+        readonly kind: "build";
+    };
+    readonly ERR_GIT_REMOTE_ORIGIN: {
+        readonly id: "014";
+        readonly message: "\nGit remote origin is not configured properly. git remote origin is not configured properly\n- please set valid 'git remote origin' by using commands below\n- git init && git remote add origin <url>\n";
+        readonly kind: "build";
+    };
+    /** Git username or email is not configured. */
+    readonly ERR_NO_GIT_USERNAME_EMAIL: {
+        readonly id: "015";
+        readonly message: "\nGit username or email is not configured:\n- please set valid 'git config user.name' and 'git config user.email'\n- or provide ZE_USER_TOKEN as environment variable\n";
+        readonly kind: "build";
+    };
+    /** Could not get git info */
+    readonly ERR_NO_GIT_INFO: {
+        readonly id: "016";
+        readonly message: "Could not get git info.\nCan you confirm this directory has initialized as a git repository?";
+        readonly kind: "build";
+    };
+    /** Build error application_uid missing. */
+    readonly ERR_MISSING_APPLICATION_UID: {
+        readonly id: "017";
+        readonly message: "`application_uid` missing.";
+        readonly kind: "build";
+    };
+    /** Auth error */
+    readonly ERR_AUTH_ERROR: {
+        readonly id: "018";
+        readonly message: "\nFailed to authenticate with Zephyr.\n\nPlease make sure you have a valid Zephyr account and you are logged in.\n\n{{ message }}\n";
+        readonly kind: "build";
+    };
+    readonly ERR_GET_BUILD_ID: {
+        readonly id: "019";
+        readonly message: "\nCould not generate Build ID. Ensure you meet the following requirements:\n\n1. Your Zephyr Account ({{ username }}) has write access to {{ application_uid }}\n2. You own the repository or is a collaborator with write access.\n3. This repository has commit history and has a proper git remote origin url.\n\nWhen trying out public examples, make sure to fork the repository to your account so you can have write access.\n\n";
+        readonly kind: "build";
+    };
+    /** Could not initialize Zephyr Agent. */
+    readonly ERR_INITIALIZE_ZEPHYR_AGENT: {
+        readonly id: "020";
+        readonly message: "Could not initialize Zephyr Agent.";
+        readonly kind: "build";
+    };
+    /** Cloudflare specific error */
+    readonly ERR_UNABLE_CREATE_DIST_FOLDER: {
+        readonly id: "021";
+        readonly message: "Error creating dist folder.";
+        readonly kind: "build";
+    };
+    /** Deployment error, assets not found */
+    readonly ERR_ASSETS_NOT_FOUND: {
+        readonly id: "010";
+        readonly message: "Assets not found.";
+        readonly kind: "deploy";
+    };
+    /** Assets not found in snapshot */
+    readonly ERR_ASSETS_NOT_FOUND_IN_SNAPSHOT: {
+        readonly id: "011";
+        readonly message: "Assets not found in snapshot.";
+        readonly kind: "deploy";
+    };
+    /** Application_uid missing */
+    readonly ERR_DEPLOY_MISSING_APPLICATION_UID: {
+        readonly id: "012";
+        readonly message: "`application_uid` is required.";
+        readonly kind: "deploy";
+    };
+    readonly ERR_MISSING_FILE_HASH: {
+        readonly id: "013";
+        readonly message: "Missing file hash.";
+        readonly kind: "deploy";
+    };
+    /** Failed to load application configuration. */
+    readonly ERR_LOAD_APP_CONFIG: {
+        readonly id: "014";
+        readonly message: "\n\nFailed to load Application Configuration for {{ application_uid }}.\n\nTry to remove ~/.zephyr folder and try again.\n\n    ";
+        readonly kind: "deploy";
+    };
+    /** Did not receive envs from build stats upload */
+    readonly ERR_NOT_RECEIVE_ENVS_FROM_BUILD_STATS: {
+        readonly id: "016";
+        readonly message: "Did not receive envs from build stats upload.";
+        readonly kind: "deploy";
+    };
+    /** Failed to upload assets. */
+    readonly ERR_FAILED_UPLOAD: {
+        readonly id: "017";
+        readonly message: "\n\nCould not upload {{ type }} to your Edge Provider. This error will affect your tags and environments and it might fail deployments to custom domains.\n\nPlease check your network connection and try again.\n\n    ";
+        readonly kind: "deploy";
+    };
+    /** Snapshot uploads gave no results. */
+    readonly ERR_SNAPSHOT_UPLOADS_NO_RESULTS: {
+        readonly id: "019";
+        readonly message: "Snapshot uploads gave no results.";
+        readonly kind: "deploy";
+    };
+    /** Failed to get application hash list */
+    readonly ERR_GET_APPLICATION_HASH_LIST: {
+        readonly id: "020";
+        readonly message: "Failed to get application hash list.";
+        readonly kind: "deploy";
+    };
+    readonly ERR_SNAPSHOT_ID_NOT_FOUND: {
+        readonly id: "022";
+        readonly message: "`snapshot_id` not found.";
+        readonly kind: "deploy";
+    };
+    readonly ERR_SNAPSHOT_NOT_FOUND: {
+        readonly id: "023";
+        readonly message: "Snapshot not found.";
+        readonly kind: "deploy";
+    };
+    readonly ERR_DEPLOY_LOCAL_BUILD: {
+        readonly id: "024";
+        readonly message: "Failed to deploy local build.";
+        readonly kind: "deploy";
+    };
+    /** Cloudflare specific error */
+    readonly ERR_WRANGLER_DEPENDENCY: {
+        readonly id: "025";
+        readonly message: "Wrangler dependency is needed for Cloudflare deployment. Please install dependencies without --no-optional flag.";
+        readonly kind: "deploy";
+    };
+    readonly ERR_CONVERT_GRAPH_TO_DASHBOARD: {
+        readonly id: "026";
+        readonly message: "\nFailed to convert federation configuration to needed information. We are reading your Module Federation configuration to understand your shared dependencies:\n\n- host application's name\n- remote application's name\n- shared dependencies.\n\nPlease refer to the official Module Federation guide https://module-federation.io/configure/index.html to make sure your have required inputs.\n";
+        readonly kind: "browser";
+    };
+    readonly ERR_UPLOAD_TO_CLOUDFLARE_PAGES: {
+        readonly id: "027";
+        readonly message: "Error upload to Cloudflare pages.";
+        readonly kind: "deploy";
+    };
+    readonly ERR_USER_IDENTITY: {
+        readonly id: "036";
+        readonly message: "\nGit username or email is not configured\n  - please set valid 'git config user.name' and 'git config user.email'\n  - or provide ZE_USER_TOKEN as environment variable\n";
+        readonly kind: "deploy";
+    };
+    readonly ERR_TLS_CERT_ALTNAME_INVALID: {
+        readonly id: "034";
+        readonly message: "You domain's TLS Certificate is invalid. Have you updated your domain settings with your Registrar?";
+        readonly kind: "deploy";
+    };
+    readonly ERR_HTTP_ERROR: {
+        readonly id: "035";
+        readonly message: "\n\nHTTP request for {{ method }} {{ url }} failed with status code {{ status }}.\n\nPlease check your network connection and try again.\n\n{{ content }}\n\n";
+        readonly kind: "config";
+    };
+    readonly ERR_NO_WRANGLER: {
+        readonly id: "028";
+        readonly message: "Wrangler is not installed. It's needed for Cloudflare deployment. Please install dependencies without --no-optional flag.";
+        readonly kind: "build";
+    };
+    readonly ERR_CREATE_DIST_FOLDER: {
+        readonly id: "029";
+        readonly message: "Error on creating dist folder. Zephyr is unable to create dist folder for your application's configuration.";
+        readonly kind: "build";
+    };
+    /**
+     * This case needs to be specific without a message as the server respond with 40*, so we will need to prioritize the server status code
+     * and prints out the status
+     *
+     * @example
+     *   {
+     *     "statusCode": 401,
+     *     "timestamp": "2024-08-23T02:21:48.873Z",
+     *     "path": "/v2/builder-packages-api/application-config?application-uid=home-spa.federated_apps.zmzlois"
+     *   }
+     */
+    readonly ERR_NO_RESPONSE_FOR_APP_CONFIG: {
+        readonly id: "030";
+        readonly message: "Failed to load application configuration.";
+        readonly kind: "build";
+    };
+    readonly ERR_NO_JWT: {
+        readonly id: "031";
+        readonly message: "You don't have valid JWT token. Try to log out from the dashboard and log in again. https://app.zephyr-cloud.io";
+        readonly kind: "build";
+    };
+    readonly ERR_JWT_INVALID: {
+        readonly id: "032";
+        readonly message: "Your JWT token is invalid. Try to log out from the dashboard and log in again. https://app.zephyr-cloud.io";
+        readonly kind: "build";
+    };
+    readonly ERR_WEBSOCKET_CONNECTION: {
+        readonly id: "034";
+        readonly message: "Websocket connection error during login.";
+        readonly kind: "build";
+    };
+    readonly ERR_GET_APP_CONFIG: {
+        readonly id: "035";
+        readonly message: "Error when getting application configuration from API. Could not find application configuration. Please try again after removing ~/.zephyr folder.";
+        readonly kind: "build";
+    };
+    readonly ERR_GIT_COMMIT_HASH: {
+        readonly id: "036";
+        readonly message: "Failed to get git commit hash. Can you make sure this git repository has commit history?";
+        readonly kind: "build";
+    };
+    readonly ERR_RESOLVE_REMOTES: {
+        readonly id: "001";
+        readonly message: "\nPlease build {{ appUid }} with Zephyr first or add as Unmanaged applications.\n\nNote: you can read application uid as follows:\n- {{ appName }} - project.json 'name' field of remote application\n- {{ projectName }} - git repository name\n- {{ orgName }} - git organization name\n\n";
+        readonly kind: "config";
+    };
+    readonly ERR_CANNOT_RESOLVE_APP_NAME_WITH_VERSION: {
+        readonly id: "003";
+        readonly message: "\nIs the remote application being built? We are not able to find your remote application based on application_uid and remote name in configuration.\nNote that we typically map your remote based on below values\n\n- git username\n- git repository name\n- name in package.json\n- name in micro-frontend configuration.\n\nWe have a complete checklist for Micro-Frontend application configuration here: https://docs.zephyr-cloud.io/how-to/mf-guide\n      ";
+        readonly kind: "config";
+    };
+};
+/** Error object for Zephyr errors. */
+export type ZeErrors = typeof ZeErrors;
+/** `"ERR_UNKNOWN"`, `"ERR_PACKAGE_JSON_NOT_FOUND"` ... */
+export type ZeErrorKeys = keyof ZeErrors;
+/** `ZeErrors.ERR_UNKNOWN`, `ZeErrors.ERR_PACKAGE_JSON_NOT_FOUND` ... */
+export type ZeErrorType = ZeErrors[ZeErrorKeys];
+/** Builds a Zephyr error code from a given error type. */
+export type ZeErrorCode<K extends ZeErrorKeys> = `ZE${(typeof ZeErrorCategories)[ZeErrors[K]['kind']]}${ZeErrors[K]['id']}`;
+/** `"ZE00000"`, `"ZE10010"` ... */
+export type ZeErrorCodes = {
+    [K in ZeErrorKeys]: ZeErrorCode<K>;
+}[ZeErrorKeys];
+/** Ensures `a` and `b` are the same error type. */
+export declare function isZeErrorEqual(a: ZeErrorType, b: ZeErrorType): boolean;