@metriport/shared 0.7.6 → 0.7.7-alpha.0

package/dist/common/env-var.d.ts

@@ -0,0 +1,10 @@
+export declare enum EnvType {
+    production = "production",
+    sandbox = "sandbox",
+    staging = "staging",
+    development = "dev"
+}
+export declare const getEnvVar: (varName: string) => string | undefined;
+export declare const getEnvVarOrFail: (varName: string) => string;
+export declare function getEnvType(): EnvType;
+//# sourceMappingURL=env-var.d.ts.map

package/dist/common/env-var.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env-var.d.ts","sourceRoot":"","sources":["../../src/common/env-var.ts"],"names":[],"mappings":"AAEA,oBAAY,OAAO;IACjB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,WAAW,QAAQ;CACpB;AAED,eAAO,MAAM,SAAS,YAAa,MAAM,KAAG,MAAM,GAAG,SAAiC,CAAC;AAEvF,eAAO,MAAM,eAAe,YAAa,MAAM,KAAG,MAMjD,CAAC;AAEF,wBAAgB,UAAU,IAAI,OAAO,CAOpC"}

package/dist/common/env-var.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnvType = exports.getEnvVarOrFail = exports.getEnvVar = exports.EnvType = void 0;
+const metriport_error_1 = require("../error/metriport-error");
+var EnvType;
+(function (EnvType) {
+    EnvType["production"] = "production";
+    EnvType["sandbox"] = "sandbox";
+    EnvType["staging"] = "staging";
+    EnvType["development"] = "dev";
+})(EnvType = exports.EnvType || (exports.EnvType = {}));
+const getEnvVar = (varName) => process.env[varName];
+exports.getEnvVar = getEnvVar;
+const getEnvVarOrFail = (varName) => {
+    const value = (0, exports.getEnvVar)(varName);
+    if (!value || value.trim().length < 1) {
+        throw new Error(`Missing ${varName} env var`);
+    }
+    return value;
+};
+exports.getEnvVarOrFail = getEnvVarOrFail;
+function getEnvType() {
+    const envType = (0, exports.getEnvVarOrFail)("ENV_TYPE");
+    const envTypeValues = Object.values(EnvType).map(v => v.toString());
+    if (!envTypeValues.includes(envType)) {
+        throw new metriport_error_1.MetriportError(`Invalid ENV_TYPE`, undefined, { envType });
+    }
+    return envType;
+}
+exports.getEnvType = getEnvType;
+//# sourceMappingURL=env-var.js.map

package/dist/common/env-var.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env-var.js","sourceRoot":"","sources":["../../src/common/env-var.ts"],"names":[],"mappings":";;;AAAA,8DAA0D;AAE1D,IAAY,OAKX;AALD,WAAY,OAAO;IACjB,oCAAyB,CAAA;IACzB,8BAAmB,CAAA;IACnB,8BAAmB,CAAA;IACnB,8BAAmB,CAAA;AACrB,CAAC,EALW,OAAO,GAAP,eAAO,KAAP,eAAO,QAKlB;AAEM,MAAM,SAAS,GAAG,CAAC,OAAe,EAAsB,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAA1E,QAAA,SAAS,aAAiE;AAEhF,MAAM,eAAe,GAAG,CAAC,OAAe,EAAU,EAAE;IACzD,MAAM,KAAK,GAAG,IAAA,iBAAS,EAAC,OAAO,CAAC,CAAC;IACjC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;QACrC,MAAM,IAAI,KAAK,CAAC,WAAW,OAAO,UAAU,CAAC,CAAC;KAC/C;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AANW,QAAA,eAAe,mBAM1B;AAEF,SAAgB,UAAU;IACxB,MAAM,OAAO,GAAG,IAAA,uBAAe,EAAC,UAAU,CAAC,CAAC;IAC5C,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IACpE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACpC,MAAM,IAAI,gCAAc,CAAC,kBAAkB,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;KACtE;IACD,OAAO,OAAkB,CAAC;AAC5B,CAAC;AAPD,gCAOC"}

package/dist/error/bad-request.d.ts

@@ -0,0 +1,5 @@
+import { MetriportError } from "./metriport-error";
+export declare class BadRequestError extends MetriportError {
+    constructor(message?: string, cause?: unknown, additionalInfo?: Record<string, string | number | undefined | null>);
+}
+//# sourceMappingURL=bad-request.d.ts.map

package/dist/error/bad-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bad-request.d.ts","sourceRoot":"","sources":["../../src/error/bad-request.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAInD,qBAAa,eAAgB,SAAQ,cAAc;gBAE/C,OAAO,SAAmE,EAC1E,KAAK,CAAC,EAAE,OAAO,EACf,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;CAMtE"}

package/dist/error/bad-request.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadRequestError = void 0;
+const http_status_1 = __importDefault(require("http-status"));
+const metriport_error_1 = require("./metriport-error");
+const numericStatus = http_status_1.default.BAD_REQUEST;
+class BadRequestError extends metriport_error_1.MetriportError {
+    constructor(message = "Unexpected issue with the request - check inputs and try again", cause, additionalInfo) {
+        super(message, cause, additionalInfo);
+        this.status = numericStatus;
+        this.name = this.constructor.name;
+    }
+}
+exports.BadRequestError = BadRequestError;
+//# sourceMappingURL=bad-request.js.map

package/dist/error/bad-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bad-request.js","sourceRoot":"","sources":["../../src/error/bad-request.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAqC;AACrC,uDAAmD;AAEnD,MAAM,aAAa,GAAG,qBAAU,CAAC,WAAW,CAAC;AAE7C,MAAa,eAAgB,SAAQ,gCAAc;IACjD,YACE,OAAO,GAAG,gEAAgE,EAC1E,KAAe,EACf,cAAmE;QAEnE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAVD,0CAUC"}

package/dist/error/metriport-error.d.ts

@@ -0,0 +1,8 @@
+export type AdditionalInfo = Record<string, string | number | undefined | null>;
+export declare class MetriportError extends Error {
+    readonly cause?: unknown;
+    readonly additionalInfo?: AdditionalInfo | undefined;
+    status: number;
+    constructor(message: string, cause?: unknown, additionalInfo?: AdditionalInfo | undefined);
+}
+//# sourceMappingURL=metriport-error.d.ts.map

package/dist/error/metriport-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metriport-error.d.ts","sourceRoot":"","sources":["../../src/error/metriport-error.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC;AAEhF,qBAAa,cAAe,SAAQ,KAAK;IAEV,QAAQ,CAAC,KAAK,CAAC;IAAW,QAAQ,CAAC,cAAc,CAAC;IAD/E,MAAM,EAAE,MAAM,CAAgC;gBAClC,OAAO,EAAE,MAAM,EAAW,KAAK,CAAC,SAAS,EAAW,cAAc,CAAC,4BAAgB;CAIhG"}

package/dist/error/metriport-error.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetriportError = void 0;
+const http_status_1 = __importDefault(require("http-status"));
+class MetriportError extends Error {
+    constructor(message, cause, additionalInfo) {
+        super(message);
+        this.cause = cause;
+        this.additionalInfo = additionalInfo;
+        this.status = http_status_1.default.INTERNAL_SERVER_ERROR;
+        this.cause = cause;
+    }
+}
+exports.MetriportError = MetriportError;
+//# sourceMappingURL=metriport-error.js.map

package/dist/error/metriport-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metriport-error.js","sourceRoot":"","sources":["../../src/error/metriport-error.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAiC;AAIjC,MAAa,cAAe,SAAQ,KAAK;IAEvC,YAAY,OAAe,EAAW,KAAe,EAAW,cAA+B;QAC7F,KAAK,CAAC,OAAO,CAAC,CAAC;QADqB,UAAK,GAAL,KAAK,CAAU;QAAW,mBAAc,GAAd,cAAc,CAAiB;QAD/F,WAAM,GAAW,qBAAM,CAAC,qBAAqB,CAAC;QAG5C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAND,wCAMC"}

package/dist/error/not-found.d.ts

@@ -0,0 +1,5 @@
+import { AdditionalInfo, MetriportError } from "./metriport-error";
+export declare class NotFoundError extends MetriportError {
+    constructor(message?: string, cause?: unknown, additionalInfo?: AdditionalInfo);
+}
+//# sourceMappingURL=not-found.d.ts.map

package/dist/error/not-found.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"not-found.d.ts","sourceRoot":"","sources":["../../src/error/not-found.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAInE,qBAAa,aAAc,SAAQ,cAAc;gBAE7C,OAAO,SAA0C,EACjD,KAAK,CAAC,EAAE,OAAO,EACf,cAAc,CAAC,EAAE,cAAc;CAMlC"}

package/dist/error/not-found.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFoundError = void 0;
+const http_status_1 = __importDefault(require("http-status"));
+const metriport_error_1 = require("./metriport-error");
+const numericStatus = http_status_1.default.NOT_FOUND;
+class NotFoundError extends metriport_error_1.MetriportError {
+    constructor(message = "Could not find the requested resource", cause, additionalInfo) {
+        super(message, cause, additionalInfo);
+        this.status = numericStatus;
+        this.name = this.constructor.name;
+    }
+}
+exports.NotFoundError = NotFoundError;
+//# sourceMappingURL=not-found.js.map

package/dist/error/not-found.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"not-found.js","sourceRoot":"","sources":["../../src/error/not-found.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAqC;AACrC,uDAAmE;AAEnE,MAAM,aAAa,GAAG,qBAAU,CAAC,SAAS,CAAC;AAE3C,MAAa,aAAc,SAAQ,gCAAc;IAC/C,YACE,OAAO,GAAG,uCAAuC,EACjD,KAAe,EACf,cAA+B;QAE/B,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAVD,sCAUC"}

package/dist/error/shared.d.ts

@@ -0,0 +1,8 @@
+export type ErrorToStringOptions = {
+    detailed: boolean;
+};
+export declare function errorToString(err: unknown, options?: ErrorToStringOptions): string;
+export declare function genericErrorToString(err: unknown): string;
+export declare function detailedErrorToString(err: any): string;
+export declare function getErrorMessage(error: unknown): string;
+//# sourceMappingURL=shared.d.ts.map

package/dist/error/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/error/shared.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IAAE,QAAQ,EAAE,OAAO,CAAA;CAAE,CAAC;AAEzD,wBAAgB,aAAa,CAC3B,GAAG,EAAE,OAAO,EACZ,OAAO,GAAE,oBAAyC,GACjD,MAAM,CAKR;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAEzD;AAGD,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,CAYtD;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,UAE7C"}

package/dist/error/shared.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getErrorMessage = exports.detailedErrorToString = exports.genericErrorToString = exports.errorToString = void 0;
+const node_util_1 = require("node:util");
+function errorToString(err, options = { detailed: true }) {
+    if (options.detailed) {
+        return detailedErrorToString(err);
+    }
+    return genericErrorToString(err);
+}
+exports.errorToString = errorToString;
+function genericErrorToString(err) {
+    return err["message"] ?? String(err); // eslint-disable-line @typescript-eslint/no-explicit-any
+}
+exports.genericErrorToString = genericErrorToString;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function detailedErrorToString(err) {
+    const thisErrorMessage = err.message;
+    // this can lead to multi-line
+    const additionalInfo = err.additionalInfo
+        ? (0, node_util_1.inspect)(err.additionalInfo, { compact: true, breakLength: undefined })
+        : undefined;
+    const causeMessage = err.cause ? detailedErrorToString(err.cause) : undefined;
+    return (`${thisErrorMessage}` +
+        `${additionalInfo ? ` (${additionalInfo})` : ""}` +
+        `${causeMessage ? `; caused by ${causeMessage}` : ""}`);
+}
+exports.detailedErrorToString = detailedErrorToString;
+function getErrorMessage(error) {
+    return errorToString(error);
+}
+exports.getErrorMessage = getErrorMessage;
+//# sourceMappingURL=shared.js.map

package/dist/error/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../../src/error/shared.ts"],"names":[],"mappings":";;;AAAA,yCAAoC;AAIpC,SAAgB,aAAa,CAC3B,GAAY,EACZ,UAAgC,EAAE,QAAQ,EAAE,IAAI,EAAE;IAElD,IAAI,OAAO,CAAC,QAAQ,EAAE;QACpB,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAC;KACnC;IACD,OAAO,oBAAoB,CAAC,GAAG,CAAC,CAAC;AACnC,CAAC;AARD,sCAQC;AAED,SAAgB,oBAAoB,CAAC,GAAY;IAC/C,OAAQ,GAAW,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,yDAAyD;AAC1G,CAAC;AAFD,oDAEC;AAED,8DAA8D;AAC9D,SAAgB,qBAAqB,CAAC,GAAQ;IAC5C,MAAM,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC;IACrC,8BAA8B;IAC9B,MAAM,cAAc,GAAG,GAAG,CAAC,cAAc;QACvC,CAAC,CAAC,IAAA,mBAAO,EAAC,GAAG,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;QACxE,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9E,OAAO,CACL,GAAG,gBAAgB,EAAE;QACrB,GAAG,cAAc,CAAC,CAAC,CAAC,KAAK,cAAc,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACjD,GAAG,YAAY,CAAC,CAAC,CAAC,eAAe,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CACvD,CAAC;AACJ,CAAC;AAZD,sDAYC;AAED,SAAgB,eAAe,CAAC,KAAc;IAC5C,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAFD,0CAEC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metriport/shared",
-  "version": "0.7.6",
+  "version": "0.7.7-alpha.0",
   "description": "Common code shared across packages - by Metriport Inc.",
   "author": "Metriport Inc. <contact@metriport.com>",
   "homepage": "https://metriport.com/",
@@ -54,5 +54,5 @@
   "devDependencies": {
     "@faker-js/faker": "^8.0.2"
   },
-  "gitHead": "5f4357457a57c01983434ad6bc070035cb0abeb9"
+  "gitHead": "d17a30ff8ba0f11f976d836425718b8a8480d4d6"
 }