zephyr-edge-contract 0.0.14 → 0.0.16

package/dist/lib/zephyr-build-stats.d.ts

@@ -0,0 +1,122 @@
+export interface ZephyrBuildStats {
+    /** */
+    project: string;
+    /** @description application_uid */
+    id: string;
+    /** */
+    name: string;
+    /**  */
+    version: string;
+    /**  */
+    environment: string;
+    /** */
+    posted?: Date;
+    /** @description default to `remoteEntry.js` unless user defines it
+     */
+    remote: string | undefined;
+    /**  */
+    metadata: unknown;
+    /** @description this is for understanding what dependencies are being shared and created by the remote
+     * @question how are we going to use it in the future  ?
+     */
+    overrides: ApplicationOverride[];
+    /** @description the remotes this app is consuming */
+    consumes: ApplicationConsumes[];
+    /**
+     * @description this is the component this app is exposing, includes the component name and file name
+     */
+    modules: ApplicationModule[];
+    /** */
+    tags: string[];
+    /** @description dependencies in package.json */
+    dependencies?: RawDependency[];
+    /** @description optionalDependencies in package.json */
+    optionalDependencies?: RawDependency[];
+    /** @description peerDependencies in package.json */
+    peerDependencies?: RawDependency[];
+    /** @description  devDependencies in package.json */
+    devDependencies?: RawDependency[];
+    /** What does this default means and what it indicates? */
+    default?: boolean;
+    /** @description if this is a host app all the remotes goes into here from the mFConfig*/
+    remotes?: string[];
+    app: {
+        /** @description name field from package.json */
+        name: string;
+        /** @description version field form package.json */
+        version: string;
+        /** @description if the repository's git remote url is https://github.com/ZephyrCloudIO/zephyr-mono, ZephyrCloudIO would be the org field here */
+        org: string;
+        /** @description if the repository's git remote url is https://github.com/ZephyrCloudIO/zephyr-mono, zephyr-mono would be the project field here */
+        project: string;
+        /** @description this is the user's uuid */
+        buildId: string;
+    };
+    git: {
+        /** @required To build a successfully through Zephyr user must have this field
+      @description if the local git configuration sets a username this `git.name` would be the `git user.name`, see [ze-util-get-git-info] in zephyr-agent */
+        name: string;
+        /** @required To build a successfully through Zephyr user must have this field
+     @description if the email of local git config is set this email is the `git user.email` */
+        email: string;
+        /** @required To build a successfully through Zephyr user must have this field
+        @description if the branch of this repository is set this would be the result after running `git rev-parse --abbrev-ref HEAD` */
+        branch: string;
+        /** @requires To build a successfully through Zephyr user must have this field
+      @description if there has been commit of this repo, this would be the result of `git rev-parse HEAD` */
+        commit: string;
+    };
+    context: {
+        /**  */
+        /** */
+        username?: string;
+        isCI: boolean;
+    };
+    /** @description  become the first part of `remote_host` and `remote_entry_url` in database in `ApplicationTag` table
+     */
+    edge: {
+        url: string;
+        versionUrl?: string;
+    };
+    /** */
+    domain?: string | undefined;
+    platform?: DeploymentIntegrationPlatform | undefined;
+    /**   */
+    type: unknown;
+}
+declare enum DeploymentIntegrationPlatform {
+    CLOUDFLARE = "cloudflare",
+    AWS = "aws",
+    NETLIFY = "netlify",
+    AZURE = "azure",
+    GCP = "gcp"
+}
+export interface RawDependency {
+    name: string;
+    version: string;
+}
+export interface ApplicationModule {
+    id: string;
+    name: string;
+    applicationID: string;
+    requires: string[];
+    file: string;
+}
+export interface ApplicationOverride {
+    id: string;
+    name: string;
+    version: string;
+    location: string;
+    applicationID: string;
+}
+export interface ApplicationConsumes {
+    consumingApplicationID: string;
+    applicationID: string;
+    name: string;
+    usedIn: UsedIn[];
+}
+export interface UsedIn {
+    file: string;
+    url: string;
+}
+export {};

package/dist/lib/zephyr-build-stats.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var DeploymentIntegrationPlatform;
+(function (DeploymentIntegrationPlatform) {
+    DeploymentIntegrationPlatform["CLOUDFLARE"] = "cloudflare";
+    DeploymentIntegrationPlatform["AWS"] = "aws";
+    DeploymentIntegrationPlatform["NETLIFY"] = "netlify";
+    DeploymentIntegrationPlatform["AZURE"] = "azure";
+    DeploymentIntegrationPlatform["GCP"] = "gcp";
+})(DeploymentIntegrationPlatform || (DeploymentIntegrationPlatform = {}));
+//# sourceMappingURL=zephyr-build-stats.js.map

package/dist/lib/zephyr-build-stats.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zephyr-build-stats.js","sourceRoot":"","sources":["../../src/lib/zephyr-build-stats.ts"],"names":[],"mappings":";;AA4FA,IAAK,6BAMJ;AAND,WAAK,6BAA6B;IAChC,0DAAyB,CAAA;IACzB,4CAAW,CAAA;IACX,oDAAmB,CAAA;IACnB,gDAAe,CAAA;IACf,4CAAW,CAAA;AACb,CAAC,EANI,6BAA6B,KAA7B,6BAA6B,QAMjC"}

package/dist/lib/zephyr-edge-contract.d.ts

@@ -93,6 +93,9 @@ export interface ZeBuildAssetsMap {
     [key: string]: ZeBuildAsset;
 }
 export interface SnapshotUploadRes {
+    urls: {
+        version: string;
+    };
     assets: ZeBuildAsset[];
     assets_v2?: ZeBuildAsset[];
     asset_time?: number;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zephyr-edge-contract",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "license": "Apache-2.0",
   "type": "commonjs",
   "main": "dist/index.js",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zephyr-edge-contract",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "license": "Apache-2.0",
   "type": "commonjs",
   "main": "dist/index.js",

package/dist/lib/utils/error-types.d.ts

@@ -1,38 +0,0 @@
-export declare const docsPrefix = "https://docs.zephyr-cloud.io/guide/error";
-export declare enum ErrorCategories {
-    /** "BU" is the prefix for errors happen during local development. This list will grow as we go.  */
-    Build = "BU",
-    /** "DE" is the prefix for errors happen during deployment. */
-    Deploy = "DE",
-    /** "RT" is the prefix for errors happen in runtime - sometimes they are not related to us and the debugging, error handling might be living in other framework, bundler, github issues etc.
-     *
-     * keeping it here to attach 'issues not related to us but it'd be nice of us to send them the potential workaround in the terminal.
-     *
-     * For now we haven't seen enough of this error reporting back. Unless we have the statistics from user, otherwise our docs related to this part would be empty*/
-    Runtime = "RT"
-}
-export type BuildErrorCode = `${ErrorCategories.Build}100${number}`;
-export type DeployErrorCode = `${ErrorCategories.Deploy}200${number}`;
-export type RuntimeErrorCode = `${ErrorCategories.Runtime}300${number}`;
-type BuildErrorMessageType = {
-    [T in BuildErrorCode]: string;
-};
-/**
- * A collection of error types and the error code during local/build stage*/
-export declare const buildErrorMessages: BuildErrorMessageType;
-export type DeployErrorMessageType = {
-    [T in DeployErrorCode]: string;
-};
-/** Happens when users are able to "deploy" -> there'd be edge url show up in their terminal. but when they click on that link it will show them this error. */
-export declare const deployErrorMessages: DeployErrorMessageType;
-export type RuntimeErrorMessageType = {
-    [T in RuntimeErrorCode]: string;
-};
-export declare const runtimeErrorMessages: RuntimeErrorMessageType;
-export type ErrorMessageMap = {
-    buildErrorMessages: BuildErrorMessageType;
-    deployErrorMessages: DeployErrorMessageType;
-    runtimeErrorMessages: RuntimeErrorMessageType;
-};
-export declare const errorMessages: ErrorMessageMap;
-export {};

package/dist/lib/utils/error-types.js

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.errorMessages = exports.runtimeErrorMessages = exports.deployErrorMessages = exports.buildErrorMessages = exports.docsPrefix = void 0;
-// ! If anyone is adding new errors to this file please make sure the description and debugging for users are sync with documentation's error page
-exports.docsPrefix = "https://docs.zephyr-cloud.io/guide/error";
-/**
- * A collection of error types and the error code during local/build stage*/
-exports.buildErrorMessages = {
-    /** package.json not found error */
-    BU10010: "Package.json not found",
-    /** Package.json is not in a valid json format*/
-    BU10011: "Package.json is not in a valid json format.",
-    /** Webpack config error*/
-    BU10012: "Webpack config error.", // TODO: we don't detect this error yet, will we be able to separate them?
-    /** Package.json must have a name and version field. */
-    BU10013: "Package.json must have a name and version field.",
-    /** Git remote origin is not configured properly.*/
-    BU10014: "Git remote origin is not configured properly.",
-    /** Git username or email is not configured. */
-    BU10015: "Git username or email is not configured.",
-    /** Could not get git info */
-    BU10016: "Could not get git info.",
-    /** application_uid missing. */
-    BU10017: "`application_uid` missing.",
-    /** Auth error */
-    BU10018: "Auth error.",
-    /** Could not get build id. */
-    BU10019: "Could not get build id.",
-    /**Could not initialize Zephyr Agent. */
-    BU10020: "Could not initialize Zephyr Agent.",
-    /**Failed to get application hash list. */
-    BU10021: "Failed to get application hash list.",
-};
-/** Happens when users are able to "deploy" -> there'd be edge url show up in their terminal. but when they click on that link it will show them this error. */
-exports.deployErrorMessages = {
-    /** Assets not found. */
-    DE20010: "Assets not found.",
-    /** Assets not found in snapshot. */
-    DE20011: "Assets not found in snapshot.",
-    /** `application_uid` is required. */
-    DE20012: "`application_uid` is required.",
-    /** Missing file hash */
-    DE20013: "Missing file hash.",
-    /** Failed to load application configuration. */
-    DE20014: "Failed to load application configuration.",
-    /**Failed to upload build stats. */
-    DE20015: "Failed to upload build stats.",
-    /** Did not receive envs from build stats upload */
-    DE20016: "Did not receive envs from build stats upload.",
-    /** Failed to upload assets. */
-    DE20017: "Failed to upload assets.",
-    /** Failed to upload snapshots. */
-    DE20018: "Failed to upload snapshots.",
-    /** Snapshot uploads gave no results. */
-    DE20019: "Snapshot uploads gave no results.",
-    /**Failed to get application hash list */
-    DE20020: "Failed to get application hash list.",
-    /** Could not resolve ${name} with verson ${version} */
-    DE20021: "Could not resolve application name with version.",
-    /** Could not get build id */
-    DE20022: "Could not get build id."
-};
-exports.runtimeErrorMessages = {};
-exports.errorMessages = {
-    buildErrorMessages: exports.buildErrorMessages,
-    deployErrorMessages: exports.deployErrorMessages,
-    runtimeErrorMessages: exports.runtimeErrorMessages
-};
-//# sourceMappingURL=error-types.js.map

package/dist/lib/utils/error-types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"error-types.js","sourceRoot":"","sources":["../../../src/lib/utils/error-types.ts"],"names":[],"mappings":";;;AACA,kJAAkJ;AACrI,QAAA,UAAU,GAAG,0CAA0C,CAAA;AAyBpE;4EAC4E;AAC/D,QAAA,kBAAkB,GAA0B;IACvD,mCAAmC;IACnC,OAAO,EAAE,wBAAwB;IACjC,gDAAgD;IAChD,OAAO,EAAE,6CAA6C;IACtD,0BAA0B;IAC1B,OAAO,EAAE,uBAAuB,EAAE,0EAA0E;IAC5G,uDAAuD;IACvD,OAAO,EAAE,kDAAkD;IAC3D,mDAAmD;IACnD,OAAO,EAAE,+CAA+C;IACxD,+CAA+C;IAC/C,OAAO,EAAE,0CAA0C;IACnD,6BAA6B;IAC7B,OAAO,EAAE,yBAAyB;IAClC,+BAA+B;IAC/B,OAAO,EAAE,4BAA4B;IACrC,iBAAiB;IACjB,OAAO,EAAE,aAAa;IACtB,8BAA8B;IAC9B,OAAO,EAAE,yBAAyB;IAClC,wCAAwC;IACxC,OAAO,EAAE,oCAAoC;IAC7C,0CAA0C;IAC1C,OAAO,EAAE,sCAAsC;CAGhD,CAAA;AAOD,+JAA+J;AAClJ,QAAA,mBAAmB,GAA2B;IACzD,wBAAwB;IACxB,OAAO,EAAE,mBAAmB;IAC5B,oCAAoC;IACpC,OAAO,EAAE,+BAA+B;IACxC,qCAAqC;IACrC,OAAO,EAAE,gCAAgC;IACzC,wBAAwB;IACxB,OAAO,EAAE,oBAAoB;IAC7B,gDAAgD;IAChD,OAAO,EAAE,2CAA2C;IACpD,mCAAmC;IACnC,OAAO,EAAE,+BAA+B;IACxC,mDAAmD;IACnD,OAAO,EAAE,+CAA+C;IACxD,+BAA+B;IAC/B,OAAO,EAAE,0BAA0B;IACnC,kCAAkC;IAClC,OAAO,EAAE,6BAA6B;IACtC,wCAAwC;IACxC,OAAO,EAAE,mCAAmC;IAC5C,yCAAyC;IACzC,OAAO,EAAE,sCAAsC;IAC/C,uDAAuD;IACvD,OAAO,EAAE,kDAAkD;IAC3D,6BAA6B;IAC7B,OAAO,EAAE,yBAAyB;CACnC,CAAA;AAQY,QAAA,oBAAoB,GAA4B,EAE5D,CAAA;AAQY,QAAA,aAAa,GAAoB;IAC5C,kBAAkB,EAAlB,0BAAkB;IAClB,mBAAmB,EAAnB,2BAAmB;IACnB,oBAAoB,EAApB,4BAAoB;CACrB,CAAA"}