@etohq/framework 1.0.0 → 1.2.0

package/dist/error/index.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=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/error/index.ts"],"names":[],"mappings":"AAAA,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"}

package/dist/error/index.js

@@ -0,0 +1,273 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrCode = exports.APIError = void 0;
+class APIError extends Error {
+    // Constructs an APIError with the Canceled error code.
+    static canceled(msg, cause) {
+        return new APIError(ErrCode.Canceled, msg, cause);
+    }
+    // Constructs an APIError with the Unknown error code.
+    static unknown(msg, cause) {
+        return new APIError(ErrCode.Unknown, msg, cause);
+    }
+    // Constructs an APIError with the InvalidArgument error code.
+    static invalidArgument(msg, cause) {
+        return new APIError(ErrCode.InvalidArgument, msg, cause);
+    }
+    // Constructs an APIError with the DeadlineExceeded error code.
+    static deadlineExceeded(msg, cause) {
+        return new APIError(ErrCode.DeadlineExceeded, msg, cause);
+    }
+    // Constructs an APIError with the NotFound error code.
+    static notFound(msg, cause) {
+        return new APIError(ErrCode.NotFound, msg, cause);
+    }
+    // Constructs an APIError with the AlreadyExists error code.
+    static alreadyExists(msg, cause) {
+        return new APIError(ErrCode.AlreadyExists, msg, cause);
+    }
+    // Constructs an APIError with the PermissionDenied error code.
+    static permissionDenied(msg, cause) {
+        return new APIError(ErrCode.PermissionDenied, msg, cause);
+    }
+    // Constructs an APIError with the ResourceExhausted error code.
+    static resourceExhausted(msg, cause) {
+        return new APIError(ErrCode.ResourceExhausted, msg, cause);
+    }
+    // Constructs an APIError with the FailedPrecondition error code.
+    static failedPrecondition(msg, cause) {
+        return new APIError(ErrCode.FailedPrecondition, msg, cause);
+    }
+    // Constructs an APIError with the Aborted error code.
+    static aborted(msg, cause) {
+        return new APIError(ErrCode.Aborted, msg, cause);
+    }
+    // Constructs an APIError with the OutOfRange error code.
+    static outOfRange(msg, cause) {
+        return new APIError(ErrCode.OutOfRange, msg, cause);
+    }
+    // Constructs an APIError with the Unimplemented error code.
+    static unimplemented(msg, cause) {
+        return new APIError(ErrCode.Unimplemented, msg, cause);
+    }
+    // Constructs an APIError with the Internal error code.
+    static internal(msg, cause) {
+        return new APIError(ErrCode.Internal, msg, cause);
+    }
+    // Constructs an APIError with the Unavailable error code.
+    static unavailable(msg, cause) {
+        return new APIError(ErrCode.Unavailable, msg, cause);
+    }
+    // Constructs an APIError with the DataLoss error code.
+    static dataLoss(msg, cause) {
+        return new APIError(ErrCode.DataLoss, msg, cause);
+    }
+    // Constructs an APIError with the Unauthenticated error code.
+    static unauthenticated(msg, cause) {
+        return new APIError(ErrCode.Unauthenticated, msg, cause);
+    }
+    // Constructs a new APIError from the previous one with the provided details
+    withDetails(details) {
+        // @ts-ignore
+        return new APIError(this.code, this.message, this.cause, details);
+    }
+    // Constructs an APIError with the given error code, message, and (optionally) cause.
+    constructor(code, msg, cause, details) {
+        // extending errors causes issues after you construct them, unless you apply the following fixes
+        // @ts-ignore
+        super(msg, { cause });
+        this.code = code;
+        this.details = details;
+        // set error name as constructor name, make it not enumerable to keep native Error behavior
+        // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/new.target#new.target_in_constructors
+        Object.defineProperty(this, "name", {
+            value: "APIError",
+            enumerable: false,
+            configurable: true,
+        });
+        // Fix the prototype chain, capture stack trace.
+        Object.setPrototypeOf(this, APIError.prototype);
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+exports.APIError = APIError;
+var ErrCode;
+(function (ErrCode) {
+    /**
+     * OK indicates the operation was successful.
+     */
+    ErrCode["OK"] = "ok";
+    /**
+     * Canceled indicates the operation was canceled (typically by the caller).
+     *
+     * Encore will generate this error code when cancellation is requested.
+     */
+    ErrCode["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.
+     */
+    ErrCode["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.
+     */
+    ErrCode["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.
+     */
+    ErrCode["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.
+     */
+    ErrCode["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.
+     */
+    ErrCode["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.
+     */
+    ErrCode["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.
+     */
+    ErrCode["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.
+     */
+    ErrCode["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.
+     */
+    ErrCode["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.
+     */
+    ErrCode["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.
+     */
+    ErrCode["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.
+     */
+    ErrCode["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.
+     */
+    ErrCode["Unavailable"] = "unavailable";
+    /**
+     * DataLoss indicates unrecoverable data loss or corruption.
+     *
+     * This error code will not be generated by the gRPC framework.
+     */
+    ErrCode["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.
+     */
+    ErrCode["Unauthenticated"] = "unauthenticated";
+})(ErrCode || (exports.ErrCode = ErrCode = {}));
+//# sourceMappingURL=index.js.map

package/dist/error/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/error/index.ts"],"names":[],"mappings":";;;AAAA,MAAa,QAAS,SAAQ,KAAK;IAOjC,uDAAuD;IACvD,MAAM,CAAC,QAAQ,CAAC,GAAW,EAAE,KAAa;QACxC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IACnD,CAAC;IAED,sDAAsD;IACtD,MAAM,CAAC,OAAO,CAAC,GAAW,EAAE,KAAa;QACvC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IAClD,CAAC;IAED,8DAA8D;IAC9D,MAAM,CAAC,eAAe,CAAC,GAAW,EAAE,KAAa;QAC/C,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IAC1D,CAAC;IAED,+DAA+D;IAC/D,MAAM,CAAC,gBAAgB,CAAC,GAAW,EAAE,KAAa;QAChD,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IAC3D,CAAC;IAED,uDAAuD;IACvD,MAAM,CAAC,QAAQ,CAAC,GAAW,EAAE,KAAa;QACxC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IACnD,CAAC;IAED,4DAA4D;IAC5D,MAAM,CAAC,aAAa,CAAC,GAAW,EAAE,KAAa;QAC7C,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IACxD,CAAC;IAED,+DAA+D;IAC/D,MAAM,CAAC,gBAAgB,CAAC,GAAW,EAAE,KAAa;QAChD,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IAC3D,CAAC;IAED,gEAAgE;IAChE,MAAM,CAAC,iBAAiB,CAAC,GAAW,EAAE,KAAa;QACjD,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IAC5D,CAAC;IAED,iEAAiE;IACjE,MAAM,CAAC,kBAAkB,CAAC,GAAW,EAAE,KAAa;QAClD,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,kBAAkB,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IAC7D,CAAC;IAED,sDAAsD;IACtD,MAAM,CAAC,OAAO,CAAC,GAAW,EAAE,KAAa;QACvC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IAClD,CAAC;IAED,yDAAyD;IACzD,MAAM,CAAC,UAAU,CAAC,GAAW,EAAE,KAAa;QAC1C,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IACrD,CAAC;IAED,4DAA4D;IAC5D,MAAM,CAAC,aAAa,CAAC,GAAW,EAAE,KAAa;QAC7C,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IACxD,CAAC;IAED,uDAAuD;IACvD,MAAM,CAAC,QAAQ,CAAC,GAAW,EAAE,KAAa;QACxC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IACnD,CAAC;IAED,0DAA0D;IAC1D,MAAM,CAAC,WAAW,CAAC,GAAW,EAAE,KAAa;QAC3C,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IACtD,CAAC;IAED,uDAAuD;IACvD,MAAM,CAAC,QAAQ,CAAC,GAAW,EAAE,KAAa;QACxC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IACnD,CAAC;IAED,8DAA8D;IAC9D,MAAM,CAAC,eAAe,CAAC,GAAW,EAAE,KAAa;QAC/C,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IAC1D,CAAC;IAED,4EAA4E;IAC5E,WAAW,CAAC,OAAmB;QACzB,aAAa;QACjB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAc,EAAE,OAAO,CAAC,CAAA;IAC5E,CAAC;IAED,qFAAqF;IACrF,YAAY,IAAa,EAAE,GAAW,EAAE,KAAa,EAAE,OAAoB;QACzE,gGAAgG;QAChG,aAAa;QACb,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QAEtB,2FAA2F;QAC3F,oHAAoH;QACpH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE;YAClC,KAAK,EAAE,UAAU;YACjB,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,IAAI;SACnB,CAAC,CAAA;QAEF,gDAAgD;QAChD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;QAC/C,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;IACjD,CAAC;CACF;AAjHD,4BAiHC;AAID,IAAY,OAiMX;AAjMD,WAAY,OAAO;IACjB;;OAEG;IACH,oBAAS,CAAA;IAET;;;;OAIG;IACH,gCAAqB,CAAA;IAErB;;;;;;;;OAQG;IACH,8BAAmB,CAAA;IAEnB;;;;;;;OAOG;IACH,+CAAoC,CAAA;IAEpC;;;;;;;;;OASG;IACH,iDAAsC,CAAA;IAEtC;;;;;OAKG;IACH,iCAAsB,CAAA;IAEtB;;;;;OAKG;IACH,2CAAgC,CAAA;IAEhC;;;;;;;;;;OAUG;IACH,iDAAsC,CAAA;IAEtC;;;;;;;OAOG;IACH,mDAAwC,CAAA;IAExC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,qDAA0C,CAAA;IAE1C;;;;;;;OAOG;IACH,8BAAmB,CAAA;IAEnB;;;;;;;;;;;;;;;;;;OAkBG;IACH,sCAA2B,CAAA;IAE3B;;;;;;;;;OASG;IACH,0CAA+B,CAAA;IAE/B;;;;;;;OAOG;IACH,gCAAqB,CAAA;IAErB;;;;;;;;;;;OAWG;IACH,sCAA2B,CAAA;IAE3B;;;;OAIG;IACH,iCAAsB,CAAA;IAEtB;;;;;;;OAOG;IACH,8CAAmC,CAAA;AACrC,CAAC,EAjMW,OAAO,uBAAP,OAAO,QAiMlB"}

package/dist/eto-app-loader.d.ts

@@ -1,10 +1,12 @@
 import { EtoAppOutput, RegisterModuleJoinerConfig } from "@etohq/modules-sdk";
-import { CommonTypes, ILinkMigrationsPlanner, InternalModuleDeclaration, ModuleServiceInitializeOptions } from "@etohq/types";
-import { EtoContainer } from "./container";
+import { CommonTypes, DefaultModulesDefinition, ILinkMigrationsPlanner, InternalModuleDeclaration, ModuleServiceInitializeOptions } from "@etohq/types";
 import type { Knex } from "@mikro-orm/knex";
-export declare class EtoAppLoader {
+import { EtoContainer } from "./container";
+export declare class EtoAppLoader<TKey extends string = string> {
     #private;
-    constructor({ container, customLinksModules, }?: {
+    constructor({ modulesDefinition, linkModule, container, customLinksModules, }: {
+        modulesDefinition: DefaultModulesDefinition<TKey>;
+        linkModule: any;
         container?: EtoContainer;
         customLinksModules?: RegisterModuleJoinerConfig | RegisterModuleJoinerConfig[];
     });

package/dist/eto-app-loader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eto-app-loader.d.ts","sourceRoot":"","sources":["../src/eto-app-loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,YAAY,EAEZ,0BAA0B,EAC3B,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EACL,WAAW,EAEX,sBAAsB,EACtB,yBAAyB,EAGzB,8BAA8B,EAC/B,MAAM,cAAc,CAAA;AAYrB,OAAO,EAGL,YAAY,EACb,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAE3C,qBAAa,YAAY;;gBAkBX,EACV,SAAS,EACT,kBAAkB,GACnB,GAAE;QACD,SAAS,CAAC,EAAE,YAAY,CAAA;QACxB,kBAAkB,CAAC,EACf,0BAA0B,GAC1B,0BAA0B,EAAE,CAAA;KAC5B;IAKN,SAAS,CAAC,mBAAmB,CAC3B,aAAa,EAAE,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC;;;IAsCpD,SAAS,CAAC,6BAA6B;;;;;;;IA6BvC;;;;;;OAMG;IACG,oBAAoB,CACxB,EACE,WAAW,EACX,MAAc,GACf,GACG;QACE,WAAW,CAAC,EAAE,KAAK,CAAA;QACnB,MAAM,EAAE,KAAK,CAAA;KACd,GACD;QACE,WAAW,EAAE,MAAM,EAAE,CAAA;QACrB,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAA;KAGlC,GACA,OAAO,CAAC,IAAI,CAAC;IAuBhB;;OAEG;IACG,wBAAwB,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAgBjE;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAevC;;;OAGG;IACG,IAAI,CAAC,MAAM;;KAAgC,GAAG,OAAO,CAAC,YAAY,CAAC;CAqE1E"}
+{"version":3,"file":"eto-app-loader.d.ts","sourceRoot":"","sources":["../src/eto-app-loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,YAAY,EACZ,0BAA0B,EAC3B,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EACL,WAAW,EAEX,wBAAwB,EACxB,sBAAsB,EACtB,yBAAyB,EAGzB,8BAA8B,EAC/B,MAAM,cAAc,CAAA;AAUrB,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAG3C,OAAO,EACL,YAAY,EAGb,MAAM,aAAa,CAAA;AAEpB,qBAAa,YAAY,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM;;gBA6BxC,EACV,iBAAiB,EACjB,UAAU,EACV,SAAS,EACT,kBAAkB,GACnB,EAAE;QACD,iBAAiB,EAAE,wBAAwB,CAAC,IAAI,CAAC,CAAA;QACjD,UAAU,EAAE,GAAG,CAAA;QACf,SAAS,CAAC,EAAE,YAAY,CAAA;QACxB,kBAAkB,CAAC,EACf,0BAA0B,GAC1B,0BAA0B,EAAE,CAAA;KACjC;IAQD,SAAS,CAAC,mBAAmB,CAC3B,aAAa,EAAE,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC;;;IAsEpD,SAAS,CAAC,6BAA6B;;;;;;;IA6BvC;;;;;;OAMG;IACG,oBAAoB,CACxB,EACE,WAAW,EACX,MAAc,GACf,GACG;QACE,WAAW,CAAC,EAAE,KAAK,CAAA;QACnB,MAAM,EAAE,KAAK,CAAA;KACd,GACD;QACE,WAAW,EAAE,MAAM,EAAE,CAAA;QACrB,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAA;KAGlC,GACA,OAAO,CAAC,IAAI,CAAC;IAuBhB;;OAEG;IACG,wBAAwB,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAgBjE;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAevC;;;OAGG;IACG,IAAI,CAAC,MAAM;;KAAgC,GAAG,OAAO,CAAC,YAAY,CAAC;CAwE1E"}

package/dist/eto-app-loader.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _EtoAppLoader_container, _EtoAppLoader_customLinksModules;
+var _EtoAppLoader_defaultModulesDefinition, _EtoAppLoader_container, _EtoAppLoader_linkModule, _EtoAppLoader_customLinksModules;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EtoAppLoader = void 0;
 const modules_sdk_1 = require("@etohq/modules-sdk");
@@ -22,35 +22,49 @@ class EtoAppLoader {
     // TODO: Adjust all loaders to accept an optional container such that in test env it is possible if needed to provide a specific container otherwise use the main container
     // Maybe also adjust the different places to resolve the config from the container instead of the configManager for the same reason
     // To be discussed
-    constructor({ container, customLinksModules, } = {}) {
+    constructor({ modulesDefinition, linkModule, container, customLinksModules, }) {
+        /**
+         * Default module override eto base default.
+         * @private
+         */
+        _EtoAppLoader_defaultModulesDefinition.set(this, void 0);
         /**
          * Container from where to resolve resources
          * @private
          */
         _EtoAppLoader_container.set(this, void 0);
+        /**
+         * link module.
+         * @private
+         */
+        _EtoAppLoader_linkModule.set(this, void 0); // todo fix type.
         /**
          * Extra links modules config which should be added manually to the links to be loaded
          * @private
          */
         _EtoAppLoader_customLinksModules.set(this, void 0);
+        __classPrivateFieldSet(this, _EtoAppLoader_defaultModulesDefinition, modulesDefinition, "f");
         __classPrivateFieldSet(this, _EtoAppLoader_container, container ?? container_1.container, "f");
+        __classPrivateFieldSet(this, _EtoAppLoader_linkModule, linkModule, "f");
         __classPrivateFieldSet(this, _EtoAppLoader_customLinksModules, customLinksModules ?? [], "f");
     }
+    // todo this should move up to generateModulesDefinition so modules from it will be used directly...
     mergeDefaultModules(modulesConfig) {
-        const defaultModules = Object.values(modules_sdk_1.ModulesDefinition).filter((definition) => {
+        const filteredDefaultModules = Object.values(__classPrivateFieldGet(this, _EtoAppLoader_defaultModulesDefinition, "f")).filter((definition) => {
             return !!definition.defaultPackage;
         });
         const configModules = { ...modulesConfig };
-        for (const defaultModule of defaultModules) {
+        for (const defaultModule of filteredDefaultModules) {
             configModules[defaultModule.key] ??=
                 defaultModule.defaultModuleDeclaration;
         }
         for (const [key, value] of Object.entries(configModules)) {
             const def = {};
             def.key ??= key;
-            def.label ??= modules_sdk_1.ModulesDefinition[key]?.label ?? (0, utils_1.upperCaseFirst)(key);
-            def.isQueryable = modules_sdk_1.ModulesDefinition[key]?.isQueryable ?? true;
-            const orignalDef = value?.definition ?? modules_sdk_1.ModulesDefinition[key];
+            def.label ??=
+                __classPrivateFieldGet(this, _EtoAppLoader_defaultModulesDefinition, "f")[key]?.label ?? (0, utils_1.upperCaseFirst)(key);
+            def.isQueryable = __classPrivateFieldGet(this, _EtoAppLoader_defaultModulesDefinition, "f")[key]?.isQueryable ?? true;
+            const orignalDef = value?.definition ?? __classPrivateFieldGet(this, _EtoAppLoader_defaultModulesDefinition, "f")[key];
             if (!(0, utils_1.isBoolean)(value) &&
                 ((0, utils_1.isObject)(orignalDef) || !(0, utils_1.isPresent)(value.definition))) {
                 value.definition = {
@@ -58,6 +72,33 @@ class EtoAppLoader {
                     ...orignalDef,
                 };
             }
+            // base from loader
+            //       {
+            //   scope: 'internal',
+            //   resolve: { default: [Getter], discoveryPath: [Getter], __esModule: [Getter] },
+            //   definition: {
+            //     key: 'inventory',
+            //     label: 'Inventory',
+            //     isQueryable: true,
+            //     dependencies: [ 'event_bus' ]
+            //   }
+            // }
+            // imported from builder ()
+            //       {
+            //   resolve: { default: [Getter], discoveryPath: [Getter], __esModule: [Getter] },
+            //   options: { providers: [ [Object] ] },
+            //   definition: {
+            //     key: 'auth',
+            //     label: 'Auth',
+            //     isQueryable: true,
+            //     defaultPackage: '/Users/solarsoft0/workspace/obigtech/shopabox/shopabox-platform-api/ts/node_modules/@etohq/auth/dist/index.js',
+            //     dependencies: [ 'cache', 'logger' ],
+            //     defaultModuleDeclaration: { scope: 'internal', resolve: [Object] },
+            //     isRequired: true
+            //   }
+            // } 
+            // todo normalize
+            //  console.log(value, "from ETOAPPLOADER")
         }
         return configModules;
     }
@@ -147,9 +188,10 @@ class EtoAppLoader {
         __classPrivateFieldGet(this, _EtoAppLoader_container, "f").register(utils_1.ContainerRegistrationKeys.REMOTE_QUERY, (0, awilix_1.asValue)(undefined));
         __classPrivateFieldGet(this, _EtoAppLoader_container, "f").register(utils_1.ContainerRegistrationKeys.QUERY, (0, awilix_1.asValue)(undefined));
         __classPrivateFieldGet(this, _EtoAppLoader_container, "f").register(utils_1.ContainerRegistrationKeys.LINK, (0, awilix_1.asValue)(undefined));
-        __classPrivateFieldGet(this, _EtoAppLoader_container, "f").register(utils_1.ContainerRegistrationKeys.REMOTE_LINK, (0, awilix_1.aliasTo)(utils_1.ContainerRegistrationKeys.LINK));
+        __classPrivateFieldGet(this, _EtoAppLoader_container, "f").register(utils_1.ContainerRegistrationKeys.LINK, (0, awilix_1.aliasTo)(utils_1.ContainerRegistrationKeys.LINK));
         const configModules = this.mergeDefaultModules(configModule.modules);
         const etoApp = await (0, modules_sdk_1.EtoApp)({
+            linkModule: __classPrivateFieldGet(this, _EtoAppLoader_linkModule, "f"),
             workerMode: configModule.projectConfig.workerMode,
             modulesConfig: configModules,
             sharedContainer: __classPrivateFieldGet(this, _EtoAppLoader_container, "f"),
@@ -161,7 +203,7 @@ class EtoAppLoader {
             return etoApp;
         }
         __classPrivateFieldGet(this, _EtoAppLoader_container, "f").register(utils_1.ContainerRegistrationKeys.LINK, (0, awilix_1.asValue)(etoApp.link));
-        __classPrivateFieldGet(this, _EtoAppLoader_container, "f").register(utils_1.ContainerRegistrationKeys.REMOTE_LINK, (0, awilix_1.aliasTo)(utils_1.ContainerRegistrationKeys.LINK));
+        __classPrivateFieldGet(this, _EtoAppLoader_container, "f").register(utils_1.ContainerRegistrationKeys.LINK, (0, awilix_1.aliasTo)(utils_1.ContainerRegistrationKeys.LINK));
         __classPrivateFieldGet(this, _EtoAppLoader_container, "f").register(utils_1.ContainerRegistrationKeys.REMOTE_QUERY, (0, awilix_1.asValue)(etoApp.query));
         __classPrivateFieldGet(this, _EtoAppLoader_container, "f").register(utils_1.ContainerRegistrationKeys.QUERY, (0, awilix_1.asValue)(etoApp.query));
         for (const moduleService of Object.values(etoApp.modules)) {
@@ -170,7 +212,7 @@ class EtoAppLoader {
         }
         // Register all unresolved modules as undefined to be present in the container with undefined value by default
         // but still resolvable
-        for (const moduleDefinition of Object.values(modules_sdk_1.ModulesDefinition)) {
+        for (const moduleDefinition of Object.values(__classPrivateFieldGet(this, _EtoAppLoader_defaultModulesDefinition, "f"))) {
             if (!container_1.container.hasRegistration(moduleDefinition.key)) {
                 container_1.container.register(moduleDefinition.key, (0, awilix_1.asValue)(undefined));
             }
@@ -179,5 +221,5 @@ class EtoAppLoader {
     }
 }
 exports.EtoAppLoader = EtoAppLoader;
-_EtoAppLoader_container = new WeakMap(), _EtoAppLoader_customLinksModules = new WeakMap();
+_EtoAppLoader_defaultModulesDefinition = new WeakMap(), _EtoAppLoader_container = new WeakMap(), _EtoAppLoader_linkModule = new WeakMap(), _EtoAppLoader_customLinksModules = new WeakMap();
 //# sourceMappingURL=eto-app-loader.js.map