@etohq/utils 1.3.0 → 1.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Etohq
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/analytics/abstract-analytics-provider.d.ts

@@ -0,0 +1,110 @@
+import { IAnalyticsProvider, ProviderIdentifyAnalyticsEventDTO, ProviderTrackAnalyticsEventDTO } from "@etohq/types";
+/**
+ * ### constructor
+ *
+ * The constructor allows you to access resources from the module's container using the first parameter,
+ * and the module's options using the second parameter.
+ *
+ * If you're creating a client or establishing a connection with a third-party service, do it in the constructor.
+ *
+ * #### Example
+ *
+ * ```ts
+ * import { Logger } from "@etohq/framework/types"
+ * import { AbstractAnalyticsProviderService } from "@etohq/framework/utils"
+ *
+ * type InjectedDependencies = {
+ *   logger: Logger
+ * }
+ *
+ * type Options = {
+ *   apiKey: string
+ * }
+ *
+ * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+ *   protected logger_: Logger
+ *   protected options_: Options
+ *   static identifier = "my-analytics"
+ *   // assuming you're initializing a client
+ *   protected client
+ *
+ *   constructor (
+ *     { logger }: InjectedDependencies,
+ *     options: Options
+ *   ) {
+ *     super()
+ *
+ *     this.logger_ = logger
+ *     this.options_ = options
+ *
+ *     // assuming you're initializing a client
+ *     this.client = new Client(options)
+ *   }
+ * }
+ *
+ * export default MyAnalyticsProviderService
+ * ```
+ */
+export declare class AbstractAnalyticsProviderService implements IAnalyticsProvider {
+    /**
+     * Each analytics provider has a unique ID used to identify it. The provider's ID
+     * will be stored as `aly_{identifier}_{id}`, where `{id}` is the provider's `id`
+     * property in the `eto-config.ts`.
+     *
+     * @example
+     * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+     *   static identifier = "my-analytics"
+     *   // ...
+     * }
+     */
+    static identifier: string;
+    /**
+     * @ignore
+     */
+    getIdentifier(): any;
+    /**
+     * This method tracks an event with the third-party analytics provider. The Analytics Module
+     * will use this method in its `track` method if your provider is configured in `eto-config.ts`.
+     *
+     * You can send the event to the third-party provider based on its semantics.
+     *
+     * @param {ProviderTrackAnalyticsEventDTO} data - The event's details.
+     * @returns {Promise<void>} Resolves when the event is tracked successfully.
+     *
+     * @example
+     * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+     *   // ...
+     *   async track(
+     *     data: ProviderTrackAnalyticsEventDTO
+     *   ): Promise<void> {
+     *     // track event to third-party provider
+     *     // or using custom logic
+     *     // for example:
+     *     this.client.track(data)
+     *   }
+     * }
+     */
+    track(data: ProviderTrackAnalyticsEventDTO): Promise<void>;
+    /**
+     * This method identifies an actor or group in the third-party analytics provider. The Analytics Module
+     * will use this method in its `identify` method if your provider is configured in `eto-config.ts`.
+     *
+     * @param {ProviderIdentifyAnalyticsEventDTO} data - The details of the actor or group.
+     * @returns {Promise<void>} Resolves when the actor or group is identified successfully.
+     *
+     * @example
+     * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+     *   // ...
+     *   async identify(
+     *     data: ProviderIdentifyAnalyticsEventDTO
+     *   ): Promise<void> {
+     *     // identify actor or group in the analytics provider
+     *     // or using custom logic
+     *     // for example:
+     *     this.client.identify(data)
+     *   }
+     * }
+     */
+    identify(data: ProviderIdentifyAnalyticsEventDTO): Promise<void>;
+}
+//# sourceMappingURL=abstract-analytics-provider.d.ts.map

package/dist/analytics/abstract-analytics-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-analytics-provider.d.ts","sourceRoot":"","sources":["../../src/analytics/abstract-analytics-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,iCAAiC,EACjC,8BAA8B,EAC/B,MAAM,cAAc,CAAA;AAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,qBAAa,gCAAiC,YAAW,kBAAkB;IACzE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,aAAa;IAIb;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,KAAK,CAAC,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,QAAQ,CAAC,IAAI,EAAE,iCAAiC,GAAG,OAAO,CAAC,IAAI,CAAC;CAGvE"}

package/dist/analytics/abstract-analytics-provider.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractAnalyticsProviderService = void 0;
+/**
+ * ### constructor
+ *
+ * The constructor allows you to access resources from the module's container using the first parameter,
+ * and the module's options using the second parameter.
+ *
+ * If you're creating a client or establishing a connection with a third-party service, do it in the constructor.
+ *
+ * #### Example
+ *
+ * ```ts
+ * import { Logger } from "@etohq/framework/types"
+ * import { AbstractAnalyticsProviderService } from "@etohq/framework/utils"
+ *
+ * type InjectedDependencies = {
+ *   logger: Logger
+ * }
+ *
+ * type Options = {
+ *   apiKey: string
+ * }
+ *
+ * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+ *   protected logger_: Logger
+ *   protected options_: Options
+ *   static identifier = "my-analytics"
+ *   // assuming you're initializing a client
+ *   protected client
+ *
+ *   constructor (
+ *     { logger }: InjectedDependencies,
+ *     options: Options
+ *   ) {
+ *     super()
+ *
+ *     this.logger_ = logger
+ *     this.options_ = options
+ *
+ *     // assuming you're initializing a client
+ *     this.client = new Client(options)
+ *   }
+ * }
+ *
+ * export default MyAnalyticsProviderService
+ * ```
+ */
+class AbstractAnalyticsProviderService {
+    /**
+     * @ignore
+     */
+    getIdentifier() {
+        return this.constructor.identifier;
+    }
+    /**
+     * This method tracks an event with the third-party analytics provider. The Analytics Module
+     * will use this method in its `track` method if your provider is configured in `eto-config.ts`.
+     *
+     * You can send the event to the third-party provider based on its semantics.
+     *
+     * @param {ProviderTrackAnalyticsEventDTO} data - The event's details.
+     * @returns {Promise<void>} Resolves when the event is tracked successfully.
+     *
+     * @example
+     * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+     *   // ...
+     *   async track(
+     *     data: ProviderTrackAnalyticsEventDTO
+     *   ): Promise<void> {
+     *     // track event to third-party provider
+     *     // or using custom logic
+     *     // for example:
+     *     this.client.track(data)
+     *   }
+     * }
+     */
+    async track(data) {
+        throw Error("track must be overridden by the child class");
+    }
+    /**
+     * This method identifies an actor or group in the third-party analytics provider. The Analytics Module
+     * will use this method in its `identify` method if your provider is configured in `eto-config.ts`.
+     *
+     * @param {ProviderIdentifyAnalyticsEventDTO} data - The details of the actor or group.
+     * @returns {Promise<void>} Resolves when the actor or group is identified successfully.
+     *
+     * @example
+     * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+     *   // ...
+     *   async identify(
+     *     data: ProviderIdentifyAnalyticsEventDTO
+     *   ): Promise<void> {
+     *     // identify actor or group in the analytics provider
+     *     // or using custom logic
+     *     // for example:
+     *     this.client.identify(data)
+     *   }
+     * }
+     */
+    async identify(data) {
+        throw Error("identify must be overridden by the child class");
+    }
+}
+exports.AbstractAnalyticsProviderService = AbstractAnalyticsProviderService;
+//# sourceMappingURL=abstract-analytics-provider.js.map

package/dist/analytics/abstract-analytics-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-analytics-provider.js","sourceRoot":"","sources":["../../src/analytics/abstract-analytics-provider.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAa,gCAAgC;IAc3C;;OAEG;IACH,aAAa;QACX,OAAQ,IAAI,CAAC,WAAmB,CAAC,UAAU,CAAA;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,KAAK,CAAC,IAAoC;QAC9C,MAAM,KAAK,CAAC,6CAA6C,CAAC,CAAA;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,QAAQ,CAAC,IAAuC;QACpD,MAAM,KAAK,CAAC,gDAAgD,CAAC,CAAA;IAC/D,CAAC;CACF;AAtED,4EAsEC"}

package/dist/analytics/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./abstract-analytics-provider";
+//# sourceMappingURL=index.d.ts.map

package/dist/analytics/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/analytics/index.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAA"}

package/dist/analytics/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./abstract-analytics-provider"), exports);
+//# sourceMappingURL=index.js.map

package/dist/analytics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/analytics/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA6C"}

package/dist/auth/token.d.ts

@@ -1,5 +1,7 @@
+import { type Secret, type SignOptions } from "jsonwebtoken";
 export declare const generateJwtToken: (tokenPayload: Record<string, unknown>, jwtConfig: {
-    secret: string | undefined;
-    expiresIn: string | undefined;
-}) => string;
+    secret?: Secret;
+    expiresIn?: number | string;
+    jwtOptions?: SignOptions;
+}) => any;
 //# sourceMappingURL=token.d.ts.map

package/dist/auth/token.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../../src/auth/token.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,gBAAgB,GAC3B,cAAc,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,WAAW;IACT,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;CAC9B,WAYF,CAAA"}
+{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../../src/auth/token.ts"],"names":[],"mappings":"AAAA,OAAY,EAAE,KAAK,MAAM,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAA;AAGjE,eAAO,MAAM,gBAAgB,GAC3B,cAAc,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,WAAW;IACT,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC3B,UAAU,CAAC,EAAE,WAAW,CAAA;CACzB,QAiBF,CAAA"}

package/dist/auth/token.js

@@ -7,11 +7,14 @@ exports.generateJwtToken = void 0;
 const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
 const common_1 = require("../common");
 const generateJwtToken = (tokenPayload, jwtConfig) => {
-    if (!jwtConfig.secret || !jwtConfig.expiresIn) {
+    if (!jwtConfig.secret ||
+        (!jwtConfig.expiresIn && !jwtConfig.jwtOptions?.expiresIn)) {
         throw new common_1.EtoError(common_1.EtoError.Types.INVALID_ARGUMENT, "JWT secret and expiresIn must be provided when generating a token");
     }
+    const expiresIn = jwtConfig.expiresIn ?? jwtConfig.jwtOptions?.expiresIn;
     return jsonwebtoken_1.default.sign(tokenPayload, jwtConfig.secret, {
-        expiresIn: jwtConfig.expiresIn,
+        ...jwtConfig.jwtOptions,
+        expiresIn,
     });
 };
 exports.generateJwtToken = generateJwtToken;

package/dist/auth/token.js.map

@@ -1 +1 @@
-{"version":3,"file":"token.js","sourceRoot":"","sources":["../../src/auth/token.ts"],"names":[],"mappings":";;;;;;AAAA,gEAA8B;AAC9B,sCAAoC;AAE7B,MAAM,gBAAgB,GAAG,CAC9B,YAAqC,EACrC,SAGC,EACD,EAAE;IACF,IAAI,CAAC,SAAS,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;QAC9C,MAAM,IAAI,iBAAQ,CAChB,iBAAQ,CAAC,KAAK,CAAC,gBAAgB,EAC/B,mEAAmE,CACpE,CAAA;IACH,CAAC;IAED,OAAO,sBAAG,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,MAAM,EAAE;QAC9C,SAAS,EAAE,SAAS,CAAC,SAAS;KAC/B,CAAC,CAAA;AACJ,CAAC,CAAA;AAjBY,QAAA,gBAAgB,oBAiB5B"}
+{"version":3,"file":"token.js","sourceRoot":"","sources":["../../src/auth/token.ts"],"names":[],"mappings":";;;;;;AAAA,gEAAiE;AACjE,sCAAoC;AAE7B,MAAM,gBAAgB,GAAG,CAC9B,YAAqC,EACrC,SAIC,EACD,EAAE;IACF,IACE,CAAC,SAAS,CAAC,MAAM;QACjB,CAAC,CAAC,SAAS,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,EAC1D,CAAC;QACD,MAAM,IAAI,iBAAQ,CAChB,iBAAQ,CAAC,KAAK,CAAC,gBAAgB,EAC/B,mEAAmE,CACpE,CAAA;IACH,CAAC;IAED,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,IAAI,SAAS,CAAC,UAAU,EAAE,SAAS,CAAA;IACxE,OAAO,sBAAG,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,MAAM,EAAE;QAC9C,GAAG,SAAS,CAAC,UAAU;QACvB,SAAS;KACV,CAAC,CAAA;AACJ,CAAC,CAAA;AAvBY,QAAA,gBAAgB,oBAuB5B"}

package/dist/bundles.d.ts

@@ -1,4 +1,5 @@
 export * as ApiKeyUtils from "./api-key";
+export * as AnalyticsUtils from "./analytics";
 export * as DALUtils from "./dal";
 export * as DefaultsUtils from "./defaults";
 export * as DMLUtils from "./dml";

package/dist/bundles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bundles.d.ts","sourceRoot":"","sources":["../src/bundles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,WAAW,MAAM,WAAW,CAAA;AACxC,OAAO,KAAK,QAAQ,MAAM,OAAO,CAAA;AACjC,OAAO,KAAK,aAAa,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,QAAQ,MAAM,OAAO,CAAA;AACjC,OAAO,KAAK,aAAa,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,gBAAgB,MAAM,iBAAiB,CAAA;AACnD,OAAO,KAAK,YAAY,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,eAAe,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,kBAAkB,MAAM,iBAAiB,CAAA;AACrD,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA"}
+{"version":3,"file":"bundles.d.ts","sourceRoot":"","sources":["../src/bundles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,WAAW,MAAM,WAAW,CAAA;AACxC,OAAO,KAAK,cAAc,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,QAAQ,MAAM,OAAO,CAAA;AACjC,OAAO,KAAK,aAAa,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,QAAQ,MAAM,OAAO,CAAA;AACjC,OAAO,KAAK,aAAa,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,gBAAgB,MAAM,iBAAiB,CAAA;AACnD,OAAO,KAAK,YAAY,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,eAAe,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,kBAAkB,MAAM,iBAAiB,CAAA;AACrD,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA"}

package/dist/bundles.js

@@ -33,8 +33,9 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserUtils = exports.SearchUtils = exports.OrchestrationUtils = exports.ModulesSdkUtils = exports.LinkUtils = exports.GraphQLUtils = exports.FeatureFlagUtils = exports.EventBusUtils = exports.DMLUtils = exports.DefaultsUtils = exports.DALUtils = exports.ApiKeyUtils = void 0;
+exports.UserUtils = exports.SearchUtils = exports.OrchestrationUtils = exports.ModulesSdkUtils = exports.LinkUtils = exports.GraphQLUtils = exports.FeatureFlagUtils = exports.EventBusUtils = exports.DMLUtils = exports.DefaultsUtils = exports.DALUtils = exports.AnalyticsUtils = exports.ApiKeyUtils = void 0;
 exports.ApiKeyUtils = __importStar(require("./api-key"));
+exports.AnalyticsUtils = __importStar(require("./analytics"));
 exports.DALUtils = __importStar(require("./dal"));
 exports.DefaultsUtils = __importStar(require("./defaults"));
 exports.DMLUtils = __importStar(require("./dml"));

package/dist/bundles.js.map

@@ -1 +1 @@
-{"version":3,"file":"bundles.js","sourceRoot":"","sources":["../src/bundles.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yDAAwC;AACxC,kDAAiC;AACjC,4DAA2C;AAC3C,kDAAiC;AACjC,6DAA4C;AAC5C,oEAAmD;AACnD,0DAAyC;AACzC,oDAAmC;AACnC,iEAAgD;AAChD,sEAAqD;AACrD,wDAAuC;AACvC,oDAAmC"}
+{"version":3,"file":"bundles.js","sourceRoot":"","sources":["../src/bundles.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yDAAwC;AACxC,8DAA6C;AAC7C,kDAAiC;AACjC,4DAA2C;AAC3C,kDAAiC;AACjC,6DAA4C;AAC5C,oEAAmD;AACnD,0DAAyC;AACzC,oDAAmC;AACnC,iEAAgD;AAChD,sEAAqD;AACrD,wDAAuC;AACvC,oDAAmC"}

package/dist/common/api-error.d.ts

@@ -0,0 +1,205 @@
+export declare class APIError extends Error {
+    /**
+     * The error code.
+     */
+    readonly code: ErrCode;
+    readonly details?: ErrDetails;
+    static canceled(msg: string, cause?: Error): APIError;
+    static unknown(msg: string, cause?: Error): APIError;
+    static invalidArgument(msg: string, cause?: Error): APIError;
+    static deadlineExceeded(msg: string, cause?: Error): APIError;
+    static notFound(msg: string, cause?: Error): APIError;
+    static alreadyExists(msg: string, cause?: Error): APIError;
+    static permissionDenied(msg: string, cause?: Error): APIError;
+    static resourceExhausted(msg: string, cause?: Error): APIError;
+    static failedPrecondition(msg: string, cause?: Error): APIError;
+    static aborted(msg: string, cause?: Error): APIError;
+    static outOfRange(msg: string, cause?: Error): APIError;
+    static unimplemented(msg: string, cause?: Error): APIError;
+    static internal(msg: string, cause?: Error): APIError;
+    static unavailable(msg: string, cause?: Error): APIError;
+    static dataLoss(msg: string, cause?: Error): APIError;
+    static unauthenticated(msg: string, cause?: Error): APIError;
+    withDetails(details: ErrDetails): APIError;
+    constructor(code: ErrCode, msg: string, cause?: Error, details?: ErrDetails);
+}
+export type ErrDetails = Record<string, any>;
+export declare enum ErrCode {
+    /**
+     * OK indicates the operation was successful.
+     */
+    OK = "ok",
+    /**
+     * Canceled indicates the operation was canceled (typically by the caller).
+     *
+     * Encore will generate this error code when cancellation is requested.
+     */
+    Canceled = "canceled",
+    /**
+     * Unknown error. An example of where this error may be returned is
+     * if a Status value received from another address space belongs to
+     * an error-space that is not known in this address space. Also
+     * errors raised by APIs that do not return enough error information
+     * may be converted to this error.
+     *
+     * Encore will generate this error code in the above two mentioned cases.
+     */
+    Unknown = "unknown",
+    /**
+     * InvalidArgument indicates client specified an invalid argument.
+     * Note that this differs from FailedPrecondition. It indicates arguments
+     * that are problematic regardless of the state of the system
+     * (e.g., a malformed file name).
+     *
+     * This error code will not be generated by the gRPC framework.
+     */
+    InvalidArgument = "invalid_argument",
+    /**
+     * DeadlineExceeded means operation expired before completion.
+     * For operations that change the state of the system, this error may be
+     * returned even if the operation has completed successfully. For
+     * example, a successful response from a server could have been delayed
+     * long enough for the deadline to expire.
+     *
+     * The gRPC framework will generate this error code when the deadline is
+     * exceeded.
+     */
+    DeadlineExceeded = "deadline_exceeded",
+    /**
+     * NotFound means some requested entity (e.g., file or directory) was
+     * not found.
+     *
+     * This error code will not be generated by the gRPC framework.
+     */
+    NotFound = "not_found",
+    /**
+     * AlreadyExists means an attempt to create an entity failed because one
+     * already exists.
+     *
+     * This error code will not be generated by the gRPC framework.
+     */
+    AlreadyExists = "already_exists",
+    /**
+     * PermissionDenied indicates the caller does not have permission to
+     * execute the specified operation. It must not be used for rejections
+     * caused by exhausting some resource (use ResourceExhausted
+     * instead for those errors). It must not be
+     * used if the caller cannot be identified (use Unauthenticated
+     * instead for those errors).
+     *
+     * This error code will not be generated by the gRPC core framework,
+     * but expect authentication middleware to use it.
+     */
+    PermissionDenied = "permission_denied",
+    /**
+     * ResourceExhausted indicates some resource has been exhausted, perhaps
+     * a per-user quota, or perhaps the entire file system is out of space.
+     *
+     * This error code will be generated by the gRPC framework in
+     * out-of-memory and server overload situations, or when a message is
+     * larger than the configured maximum size.
+     */
+    ResourceExhausted = "resource_exhausted",
+    /**
+     * FailedPrecondition indicates operation was rejected because the
+     * system is not in a state required for the operation's execution.
+     * For example, directory to be deleted may be non-empty, an rmdir
+     * operation is applied to a non-directory, etc.
+     *
+     * A litmus test that may help a service implementor in deciding
+     * between FailedPrecondition, Aborted, and Unavailable:
+     *  (a) Use Unavailable if the client can retry just the failing call.
+     *  (b) Use Aborted if the client should retry at a higher-level
+     *      (e.g., restarting a read-modify-write sequence).
+     *  (c) Use FailedPrecondition if the client should not retry until
+     *      the system state has been explicitly fixed. E.g., if an "rmdir"
+     *      fails because the directory is non-empty, FailedPrecondition
+     *      should be returned since the client should not retry unless
+     *      they have first fixed up the directory by deleting files from it.
+     *  (d) Use FailedPrecondition if the client performs conditional
+     *      REST Get/Update/Delete on a resource and the resource on the
+     *      server does not match the condition. E.g., conflicting
+     *      read-modify-write on the same resource.
+     *
+     * This error code will not be generated by the gRPC framework.
+     */
+    FailedPrecondition = "failed_precondition",
+    /**
+     * Aborted indicates the operation was aborted, typically due to a
+     * concurrency issue like sequencer check failures, transaction aborts,
+     * etc.
+     *
+     * See litmus test above for deciding between FailedPrecondition,
+     * Aborted, and Unavailable.
+     */
+    Aborted = "aborted",
+    /**
+     * OutOfRange means operation was attempted past the valid range.
+     * E.g., seeking or reading past end of file.
+     *
+     * Unlike InvalidArgument, this error indicates a problem that may
+     * be fixed if the system state changes. For example, a 32-bit file
+     * system will generate InvalidArgument if asked to read at an
+     * offset that is not in the range [0,2^32-1], but it will generate
+     * OutOfRange if asked to read from an offset past the current
+     * file size.
+     *
+     * There is a fair bit of overlap between FailedPrecondition and
+     * OutOfRange. We recommend using OutOfRange (the more specific
+     * error) when it applies so that callers who are iterating through
+     * a space can easily look for an OutOfRange error to detect when
+     * they are done.
+     *
+     * This error code will not be generated by the gRPC framework.
+     */
+    OutOfRange = "out_of_range",
+    /**
+     * Unimplemented indicates operation is not implemented or not
+     * supported/enabled in this service.
+     *
+     * This error code will be generated by the gRPC framework. Most
+     * commonly, you will see this error code when a method implementation
+     * is missing on the server. It can also be generated for unknown
+     * compression algorithms or a disagreement as to whether an RPC should
+     * be streaming.
+     */
+    Unimplemented = "unimplemented",
+    /**
+     * Internal errors. Means some invariants expected by underlying
+     * system has been broken. If you see one of these errors,
+     * something is very broken.
+     *
+     * This error code will be generated by the gRPC framework in several
+     * internal error conditions.
+     */
+    Internal = "internal",
+    /**
+     * Unavailable indicates the service is currently unavailable.
+     * This is a most likely a transient condition and may be corrected
+     * by retrying with a backoff. Note that it is not always safe to retry
+     * non-idempotent operations.
+     *
+     * See litmus test above for deciding between FailedPrecondition,
+     * Aborted, and Unavailable.
+     *
+     * This error code will be generated by the gRPC framework during
+     * abrupt shutdown of a server process or network connection.
+     */
+    Unavailable = "unavailable",
+    /**
+     * DataLoss indicates unrecoverable data loss or corruption.
+     *
+     * This error code will not be generated by the gRPC framework.
+     */
+    DataLoss = "data_loss",
+    /**
+     * Unauthenticated indicates the request does not have valid
+     * authentication credentials for the operation.
+     *
+     * The gRPC framework will generate this error code when the
+     * authentication metadata is invalid or a Credentials callback fails,
+     * but also expect authentication middleware to generate it.
+     */
+    Unauthenticated = "unauthenticated"
+}
+//# sourceMappingURL=api-error.d.ts.map

package/dist/common/api-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-error.d.ts","sourceRoot":"","sources":["../../src/common/api-error.ts"],"names":[],"mappings":"AAGA,qBAAa,QAAS,SAAQ,KAAK;IACjC;;OAEG;IACH,SAAgB,IAAI,EAAE,OAAO,CAAA;IAC7B,SAAgB,OAAO,CAAC,EAAE,UAAU,CAAA;IAGpC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAK1C,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAKzC,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAKjD,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAKlD,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAK1C,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAK/C,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAKlD,MAAM,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAKnD,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAKpD,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAKzC,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAK5C,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAK/C,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAK1C,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAK7C,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAK1C,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAKjD,WAAW,CAAC,OAAO,EAAE,UAAU,GAAG,QAAQ;gBAM9B,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,UAAU;CAmB5E;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE5C,oBAAY,OAAO;IACjB;;OAEG;IACH,EAAE,OAAO;IAET;;;;OAIG;IACH,QAAQ,aAAa;IAErB;;;;;;;;OAQG;IACH,OAAO,YAAY;IAEnB;;;;;;;OAOG;IACH,eAAe,qBAAqB;IAEpC;;;;;;;;;OASG;IACH,gBAAgB,sBAAsB;IAEtC;;;;;OAKG;IACH,QAAQ,cAAc;IAEtB;;;;;OAKG;IACH,aAAa,mBAAmB;IAEhC;;;;;;;;;;OAUG;IACH,gBAAgB,sBAAsB;IAEtC;;;;;;;OAOG;IACH,iBAAiB,uBAAuB;IAExC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,kBAAkB,wBAAwB;IAE1C;;;;;;;OAOG;IACH,OAAO,YAAY;IAEnB;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,iBAAiB;IAE3B;;;;;;;;;OASG;IACH,aAAa,kBAAkB;IAE/B;;;;;;;OAOG;IACH,QAAQ,aAAa;IAErB;;;;;;;;;;;OAWG;IACH,WAAW,gBAAgB;IAE3B;;;;OAIG;IACH,QAAQ,cAAc;IAEtB;;;;;;;OAOG;IACH,eAAe,oBAAoB;CACpC"}