zephyr-edge-contract 0.0.26 → 0.0.28

package/dist/lib/errors/codes.js

@@ -1,371 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isZeErrorEqual = exports.ZeErrors = exports.ZeErrorCategories = void 0;
-/** Categories for all error codes. */
-exports.ZeErrorCategories = {
-    /** Error we have yet catched and known */
-    unknown: '00',
-    /** Stage 0 build error */
-    build: '10',
-    /** Stage 1 Deployment error */
-    deploy: '20',
-    /** Browser error */
-    browser: '30',
-    /** Module Federation/Config related error */
-    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.
- */
-exports.ZeErrors = {
-    ERR_UNKNOWN: {
-        id: '000',
-        message: `
-Unknown error: {{ message }}
-
-`,
-        kind: 'unknown',
-    },
-    /** Package.json not found error */
-    // TODO: this error is less likely to happen
-    ERR_PACKAGE_JSON_NOT_FOUND: {
-        id: '010',
-        message: 'package.json not found',
-        kind: 'build',
-    },
-    /** Package.json is not in a valid json format */
-    ERR_PACKAGE_JSON_NOT_VALID: {
-        id: '011',
-        message: 'Package.json is not in a valid json format.',
-        kind: 'build',
-    },
-    /** Webpack config error */
-    ERR_WEBPACK_CONFIG: {
-        id: '012',
-        message: 'Webpack config error.',
-        kind: 'build',
-    },
-    ERR_PACKAGE_JSON_MUST_HAVE_NAME_VERSION: {
-        id: '013',
-        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.',
-        kind: 'build',
-    },
-    ERR_GIT_REMOTE_ORIGIN: {
-        id: '014',
-        message: `
-Could not detect a git remote called 'origin'. This is required for Zephyr to work properly.
-
-Please set the git remote origin by running the following command:
-
-\`\`\`sh
-git init
-git remote add origin <url>
-\`\`\`
-`,
-        kind: 'build',
-    },
-    /** Git username or email is not configured. */
-    ERR_NO_GIT_USERNAME_EMAIL: {
-        id: '015',
-        message: `
-Git username or email is not configured:
-- please set valid 'git config user.name' and 'git config user.email'
-- or provide ZE_USER_TOKEN as environment variable
-`,
-        kind: 'build',
-    },
-    /** Could not get git info */
-    ERR_NO_GIT_INFO: {
-        id: '016',
-        message: `
-
-Failed to load git information:
-
-{{ message }}
-
-`,
-        kind: 'build',
-    },
-    /** Build error application_uid missing. */
-    ERR_MISSING_APPLICATION_UID: {
-        id: '017',
-        message: '`application_uid` missing.',
-        kind: 'build',
-    },
-    /** Auth error */
-    ERR_AUTH_ERROR: {
-        id: '018',
-        message: `
-Failed to authenticate with Zephyr.
-
-Please make sure you have a valid Zephyr account and you are logged in.
-
-{{ message }}
-`,
-        kind: 'build',
-    },
-    ERR_GET_BUILD_ID: {
-        id: '019',
-        message: `
-Could not generate Build ID. Ensure you meet the following requirements:
-
-1. Your Zephyr Account ({{ username }}) has write access to {{ application_uid }}
-2. You own the repository or is a collaborator with write access.
-3. This repository has commit history and has a proper git remote origin url.
-
-When trying out public examples, make sure to fork the repository to your account so you can have write access.
-
-`,
-        kind: 'build',
-    },
-    /** Could not initialize Zephyr Agent. */
-    ERR_INITIALIZE_ZEPHYR_AGENT: {
-        id: '020',
-        message: 'Could not initialize Zephyr Agent.',
-        kind: 'build',
-    },
-    /** Cloudflare specific error */
-    ERR_UNABLE_CREATE_DIST_FOLDER: {
-        id: '021',
-        message: 'Error creating dist folder.',
-        kind: 'build',
-    },
-    /** Auth forbidden error */
-    ERR_AUTH_FORBIDDEN_ERROR: {
-        id: '022',
-        message: `
-User not allowed to access the requested resource.
-
-Please make sure you are logged in with the correct Zephyr account.
-
-{{ message }}
-`,
-        kind: 'build',
-    },
-    /** Deployment error, assets not found */
-    ERR_ASSETS_NOT_FOUND: {
-        id: '010',
-        message: 'Assets not found.',
-        kind: 'deploy',
-    },
-    /** Assets not found in snapshot */
-    ERR_ASSETS_NOT_FOUND_IN_SNAPSHOT: {
-        id: '011',
-        message: 'Assets not found in snapshot.',
-        kind: 'deploy',
-    },
-    /** Application_uid missing */
-    ERR_DEPLOY_MISSING_APPLICATION_UID: {
-        id: '012',
-        message: '`application_uid` is required.',
-        kind: 'deploy',
-    },
-    ERR_MISSING_FILE_HASH: {
-        id: '013',
-        message: 'Missing file hash.',
-        kind: 'deploy',
-    },
-    /** Failed to load application configuration. */
-    ERR_LOAD_APP_CONFIG: {
-        id: '014',
-        message: `
-
-Failed to load Application Configuration for {{ application_uid }}.
-
-Try to remove ~/.zephyr folder and try again.
-
-    `,
-        kind: 'deploy',
-    },
-    /** Did not receive envs from build stats upload */
-    ERR_NOT_RECEIVE_ENVS_FROM_BUILD_STATS: {
-        id: '016',
-        message: 'Did not receive envs from build stats upload.',
-        kind: 'deploy',
-    },
-    /** Failed to upload assets. */
-    ERR_FAILED_UPLOAD: {
-        id: '017',
-        message: `
-
-Could not upload {{ type }} to your Edge Provider. This error will affect your tags and environments and it might fail deployments to custom domains.
-
-Please check your network connection and try again.
-
-    `,
-        kind: 'deploy',
-    },
-    /** Snapshot uploads gave no results. */
-    ERR_SNAPSHOT_UPLOADS_NO_RESULTS: {
-        id: '019',
-        message: 'Snapshot uploads gave no results.',
-        kind: 'deploy',
-    },
-    /** Failed to get application hash list */
-    ERR_GET_APPLICATION_HASH_LIST: {
-        id: '020',
-        message: 'Failed to get application hash list.',
-        kind: 'deploy',
-    },
-    ERR_SNAPSHOT_ID_NOT_FOUND: {
-        id: '022',
-        message: '`snapshot_id` not found.',
-        kind: 'deploy',
-    },
-    ERR_SNAPSHOT_NOT_FOUND: {
-        id: '023',
-        message: 'Snapshot not found.',
-        kind: 'deploy',
-    },
-    ERR_DEPLOY_LOCAL_BUILD: {
-        id: '024',
-        message: 'Failed to deploy local build.',
-        kind: 'deploy',
-    },
-    /** Cloudflare specific error */
-    ERR_WRANGLER_DEPENDENCY: {
-        id: '025',
-        message: 'Wrangler dependency is needed for Cloudflare deployment. Please install dependencies without --no-optional flag.',
-        kind: 'deploy',
-    },
-    ERR_CONVERT_GRAPH_TO_DASHBOARD: {
-        id: '026',
-        message: `
-Failed to convert federation configuration to needed information. We are reading your Module Federation configuration to understand your shared dependencies:
-
-- host application's name
-- remote application's name
-- shared dependencies.
-
-Please refer to the official Module Federation guide https://module-federation.io/configure/index.html to make sure your have required inputs.
-`,
-        kind: 'browser',
-    },
-    ERR_UPLOAD_TO_CLOUDFLARE_PAGES: {
-        id: '027',
-        message: 'Error upload to Cloudflare pages.',
-        kind: 'deploy',
-    },
-    ERR_USER_IDENTITY: {
-        id: '036',
-        message: `
-Git username or email is not configured
-  - please set valid 'git config user.name' and 'git config user.email'
-  - or provide ZE_USER_TOKEN as environment variable
-`,
-        kind: 'deploy',
-    },
-    ERR_TLS_CERT_ALTNAME_INVALID: {
-        id: '034',
-        message: "You domain's TLS Certificate is invalid. Have you updated your domain settings with your Registrar?",
-        kind: 'deploy',
-    },
-    ERR_HTTP_ERROR: {
-        id: '035',
-        message: `
-
-HTTP request for {{ method }} {{ url }} failed with status code {{ status }}.
-
-Please check your network connection and try again.
-
-{{ content }}
-
-`,
-        kind: 'config',
-    },
-    ERR_NO_WRANGLER: {
-        id: '028',
-        message: `Wrangler is not installed. It's needed for Cloudflare deployment. Please install dependencies without --no-optional flag.`,
-        kind: 'build',
-    },
-    ERR_CREATE_DIST_FOLDER: {
-        id: '029',
-        message: `Error on creating dist folder. Zephyr is unable to create dist folder for your application's configuration.`,
-        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"
-     *   }
-     */
-    ERR_NO_RESPONSE_FOR_APP_CONFIG: {
-        id: '030',
-        message: 'Failed to load application configuration.',
-        kind: 'build',
-    },
-    ERR_NO_JWT: {
-        id: '031',
-        message: `You don't have valid JWT token. Try to log out from the dashboard and log in again. https://app.zephyr-cloud.io`,
-        kind: 'build',
-    },
-    ERR_JWT_INVALID: {
-        id: '032',
-        message: 'Your JWT token is invalid. Try to log out from the dashboard and log in again. https://app.zephyr-cloud.io',
-        kind: 'build',
-    },
-    ERR_WEBSOCKET_CONNECTION: {
-        id: '034',
-        message: 'Websocket connection error during login.',
-        kind: 'build',
-    },
-    ERR_GET_APP_CONFIG: {
-        id: '035',
-        message: 'Error when getting application configuration from API. Could not find application configuration. Please try again after removing ~/.zephyr folder.',
-        kind: 'build',
-    },
-    ERR_GIT_COMMIT_HASH: {
-        id: '036',
-        message: 'Failed to get git commit hash. Can you make sure this git repository has commit history?',
-        kind: 'build',
-    },
-    ERR_RESOLVE_REMOTES: {
-        id: '001',
-        message: `
-Please build {{ appUid }} with Zephyr first or add as Unmanaged applications.
-
-Note: you can read application uid as follows:
-- {{ appName }} - project.json 'name' field of remote application
-- {{ projectName }} - git repository name
-- {{ orgName }} - git organization name
-
-`,
-        kind: 'config',
-    },
-    ERR_CANNOT_RESOLVE_APP_NAME_WITH_VERSION: {
-        id: '003',
-        message: `
-Is the remote application being built? We are not able to find your remote application based on application_uid and remote name in configuration.
-Note that we typically map your remote based on below values
-
-- git username
-- git repository name
-- name in package.json
-- name in micro-frontend configuration.
-
-We have a complete checklist for Micro-Frontend application configuration here: https://docs.zephyr-cloud.io/how-to/mf-guide
-      `,
-        kind: 'config',
-    },
-};
-/** Ensures `a` and `b` are the same error type. */
-function isZeErrorEqual(a, b) {
-    return a.id === b.id && a.kind === b.kind;
-}
-exports.isZeErrorEqual = isZeErrorEqual;
-//# sourceMappingURL=codes.js.map

package/dist/lib/errors/codes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"codes.js","sourceRoot":"","sources":["../../../src/lib/errors/codes.ts"],"names":[],"mappings":";;;AAEA,sCAAsC;AACzB,QAAA,iBAAiB,GAAG;IAC/B,0CAA0C;IAC1C,OAAO,EAAE,IAAI;IACb,0BAA0B;IAC1B,KAAK,EAAE,IAAI;IACX,+BAA+B;IAC/B,MAAM,EAAE,IAAI;IACZ,oBAAoB;IACpB,OAAO,EAAE,IAAI;IACb,6CAA6C;IAC7C,MAAM,EAAE,IAAI;CAGb,CAAC;AAEF;;;;;;;;;;;;GAYG;AACU,QAAA,QAAQ,GAAG;IACtB,WAAW,EAAE;QACX,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;CAGZ;QACG,IAAI,EAAE,SAAS;KAChB;IAED,mCAAmC;IACnC,4CAA4C;IAC5C,0BAA0B,EAAE;QAC1B,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,wBAAwB;QACjC,IAAI,EAAE,OAAO;KACd;IAED,iDAAiD;IACjD,0BAA0B,EAAE;QAC1B,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,6CAA6C;QACtD,IAAI,EAAE,OAAO;KACd;IAED,2BAA2B;IAC3B,kBAAkB,EAAE;QAClB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,uBAAuB;QAChC,IAAI,EAAE,OAAO;KACd;IAED,uCAAuC,EAAE;QACvC,EAAE,EAAE,KAAK;QACT,OAAO,EACL,sKAAsK;QACxK,IAAI,EAAE,OAAO;KACd;IAED,qBAAqB,EAAE;QACrB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;;;;;;CASZ;QACG,IAAI,EAAE,OAAO;KACd;IAED,+CAA+C;IAC/C,yBAAyB,EAAE;QACzB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;CAIZ;QACG,IAAI,EAAE,OAAO;KACd;IAED,6BAA6B;IAC7B,eAAe,EAAE;QACf,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;;;CAMZ;QACG,IAAI,EAAE,OAAO;KACd;IAED,2CAA2C;IAC3C,2BAA2B,EAAE;QAC3B,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,4BAA4B;QACrC,IAAI,EAAE,OAAO;KACd;IAED,iBAAiB;IACjB,cAAc,EAAE;QACd,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;;;CAMZ;QACG,IAAI,EAAE,OAAO;KACd;IAED,gBAAgB,EAAE;QAChB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;;;;;;CASZ;QACG,IAAI,EAAE,OAAO;KACd;IAED,yCAAyC;IACzC,2BAA2B,EAAE;QAC3B,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,oCAAoC;QAC7C,IAAI,EAAE,OAAO;KACd;IAED,gCAAgC;IAChC,6BAA6B,EAAE;QAC7B,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,6BAA6B;QACtC,IAAI,EAAE,OAAO;KACd;IAED,2BAA2B;IAC3B,wBAAwB,EAAE;QACxB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;;;CAMZ;QACG,IAAI,EAAE,OAAO;KACd;IAED,yCAAyC;IACzC,oBAAoB,EAAE;QACpB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,mBAAmB;QAC5B,IAAI,EAAE,QAAQ;KACf;IAED,mCAAmC;IACnC,gCAAgC,EAAE;QAChC,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,+BAA+B;QACxC,IAAI,EAAE,QAAQ;KACf;IAED,8BAA8B;IAC9B,kCAAkC,EAAE;QAClC,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,gCAAgC;QACzC,IAAI,EAAE,QAAQ;KACf;IAED,qBAAqB,EAAE;QACrB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,oBAAoB;QAC7B,IAAI,EAAE,QAAQ;KACf;IAED,gDAAgD;IAChD,mBAAmB,EAAE;QACnB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;;;KAMR;QACD,IAAI,EAAE,QAAQ;KACf;IAED,mDAAmD;IACnD,qCAAqC,EAAE;QACrC,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,+CAA+C;QACxD,IAAI,EAAE,QAAQ;KACf;IAED,+BAA+B;IAC/B,iBAAiB,EAAE;QACjB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;;;KAMR;QACD,IAAI,EAAE,QAAQ;KACf;IAED,wCAAwC;IACxC,+BAA+B,EAAE;QAC/B,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,mCAAmC;QAC5C,IAAI,EAAE,QAAQ;KACf;IAED,0CAA0C;IAC1C,6BAA6B,EAAE;QAC7B,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,sCAAsC;QAC/C,IAAI,EAAE,QAAQ;KACf;IAED,yBAAyB,EAAE;QACzB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,0BAA0B;QACnC,IAAI,EAAE,QAAQ;KACf;IAED,sBAAsB,EAAE;QACtB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,qBAAqB;QAC9B,IAAI,EAAE,QAAQ;KACf;IAED,sBAAsB,EAAE;QACtB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,+BAA+B;QACxC,IAAI,EAAE,QAAQ;KACf;IAED,gCAAgC;IAChC,uBAAuB,EAAE;QACvB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,kHAAkH;QAC3H,IAAI,EAAE,QAAQ;KACf;IAED,8BAA8B,EAAE;QAC9B,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;;;;;CAQZ;QACG,IAAI,EAAE,SAAS;KAChB;IAED,8BAA8B,EAAE;QAC9B,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,mCAAmC;QAC5C,IAAI,EAAE,QAAQ;KACf;IAED,iBAAiB,EAAE;QACjB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;CAIZ;QACG,IAAI,EAAE,QAAQ;KACf;IAED,4BAA4B,EAAE;QAC5B,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,qGAAqG;QAC9G,IAAI,EAAE,QAAQ;KACf;IAED,cAAc,EAAE;QACd,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;;;;;CAQZ;QACG,IAAI,EAAE,QAAQ;KACf;IAED,eAAe,EAAE;QACf,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,2HAA2H;QACpI,IAAI,EAAE,OAAO;KACd;IAED,sBAAsB,EAAE;QACtB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,6GAA6G;QACtH,IAAI,EAAE,OAAO;KACd;IAED;;;;;;;;;;OAUG;IACH,8BAA8B,EAAE;QAC9B,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,2CAA2C;QACpD,IAAI,EAAE,OAAO;KACd;IAED,UAAU,EAAE;QACV,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,iHAAiH;QAC1H,IAAI,EAAE,OAAO;KACd;IAED,eAAe,EAAE;QACf,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,4GAA4G;QACrH,IAAI,EAAE,OAAO;KACd;IAED,wBAAwB,EAAE;QACxB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,0CAA0C;QACnD,IAAI,EAAE,OAAO;KACd;IAED,kBAAkB,EAAE;QAClB,EAAE,EAAE,KAAK;QACT,OAAO,EACL,oJAAoJ;QACtJ,IAAI,EAAE,OAAO;KACd;IAED,mBAAmB,EAAE;QACnB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE,0FAA0F;QACnG,IAAI,EAAE,OAAO;KACd;IAED,mBAAmB,EAAE;QACnB,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;;;;;CAQZ;QACG,IAAI,EAAE,QAAQ;KACf;IAED,wCAAwC,EAAE;QACxC,EAAE,EAAE,KAAK;QACT,OAAO,EAAE;;;;;;;;;;OAUN;QACH,IAAI,EAAE,QAAQ;KACf;CAUF,CAAC;AAiBF,mDAAmD;AACnD,SAAgB,cAAc,CAAC,CAAc,EAAE,CAAc;IAC3D,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC;AAC5C,CAAC;AAFD,wCAEC"}

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

@@ -1,2 +0,0 @@
-export * from './codes';
-export * from './zephyr';

package/dist/lib/errors/index.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./codes"), exports);
-tslib_1.__exportStar(require("./zephyr"), exports);
-//# sourceMappingURL=index.js.map

package/dist/lib/errors/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/errors/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,mDAAyB"}