@deenruv/core 1.0.0

package/dist/common/configurable-operation.js

@@ -0,0 +1,193 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurableOperationDef = void 0;
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const constants_1 = require("./constants");
+const errors_1 = require("./error/errors");
+/**
+ * @description
+ * A ConfigurableOperationDef is a special type of object used extensively by Deenruv to define
+ * code blocks which have arguments which are configurable at run-time by the administrator.
+ *
+ * This is the mechanism used by:
+ *
+ * * {@link CollectionFilter}
+ * * {@link PaymentMethodHandler}
+ * * {@link PromotionAction}
+ * * {@link PromotionCondition}
+ * * {@link ShippingCalculator}
+ * * {@link ShippingEligibilityChecker}
+ *
+ * Any class which extends ConfigurableOperationDef works in the same way: it takes a
+ * config object as the constructor argument. That config object extends the {@link ConfigurableOperationDefOptions}
+ * interface and typically adds some kind of business logic function to it.
+ *
+ * For example, in the case of `ShippingEligibilityChecker`,
+ * it adds the `check()` function to the config object which defines the logic for checking whether an Order is eligible
+ * for a particular ShippingMethod.
+ *
+ * ## The `args` property
+ *
+ * The key feature of the ConfigurableOperationDef is the `args` property. This is where we define those
+ * arguments that are exposed via the Admin UI as data input components. This allows their values to
+ * be set at run-time by the Administrator. Those values can then be accessed in the business logic
+ * of the operation.
+ *
+ * The data type of the args can be one of {@link ConfigArgType}, and the configuration is further explained in
+ * the docs of {@link ConfigArgs}.
+ *
+ * ## Dependency Injection
+ * If your business logic relies on injectable providers, such as the `TransactionalConnection` object, or any of the
+ * internal Deenruv services or those defined in a plugin, you can inject them by using the config object's
+ * `init()` method, which exposes the {@link Injector}.
+ *
+ * Here's an example of a ShippingCalculator that injects a service which has been defined in a plugin:
+ *
+ * @example
+ * ```ts
+ * import { Injector, ShippingCalculator } from '\@deenruv/core';
+ * import { ShippingRatesService } from './shipping-rates.service';
+ *
+ * // We keep reference to our injected service by keeping it
+ * // in the top-level scope of the file.
+ * let shippingRatesService: ShippingRatesService;
+ *
+ * export const customShippingCalculator = new ShippingCalculator({
+ *   code: 'custom-shipping-calculator',
+ *   description: [],
+ *   args: {},
+ *
+ *   init(injector: Injector) {
+ *     // The init function is called during bootstrap, and allows
+ *     // us to inject any providers we need.
+ *     shippingRatesService = injector.get(ShippingRatesService);
+ *   },
+ *
+ *   calculate: async (order, args) => {
+ *     // We can now use the injected provider in the business logic.
+ *     const { price, priceWithTax } = await shippingRatesService.getRate({
+ *       destination: order.shippingAddress,
+ *       contents: order.lines,
+ *     });
+ *
+ *     return {
+ *       price,
+ *       priceWithTax,
+ *     };
+ *   },
+ * });
+ * ```
+ *
+ * @docsCategory ConfigurableOperationDef
+ */
+class ConfigurableOperationDef {
+    get code() {
+        return this.options.code;
+    }
+    get args() {
+        return this.options.args;
+    }
+    get description() {
+        return this.options.description;
+    }
+    constructor(options) {
+        this.options = options;
+    }
+    async init(injector) {
+        if (typeof this.options.init === "function") {
+            await this.options.init(injector);
+        }
+    }
+    async destroy() {
+        if (typeof this.options.destroy === "function") {
+            await this.options.destroy();
+        }
+    }
+    /**
+     * @description
+     * Convert a ConfigurableOperationDef into a ConfigurableOperationDefinition object, typically
+     * so that it can be sent via the API.
+     */
+    toGraphQlType(ctx) {
+        return {
+            code: this.code,
+            description: localizeString(this.description, ctx.languageCode, ctx.channel.defaultLanguageCode),
+            args: Object.entries(this.args).map(([name, arg]) => {
+                var _a, _b;
+                return ({
+                    name,
+                    type: arg.type,
+                    list: (_a = arg.list) !== null && _a !== void 0 ? _a : false,
+                    required: (_b = arg.required) !== null && _b !== void 0 ? _b : true,
+                    defaultValue: arg.defaultValue,
+                    ui: arg.ui,
+                    label: arg.label &&
+                        localizeString(arg.label, ctx.languageCode, ctx.channel.defaultLanguageCode),
+                    description: arg.description &&
+                        localizeString(arg.description, ctx.languageCode, ctx.channel.defaultLanguageCode),
+                });
+            }),
+        };
+    }
+    /**
+     * @description
+     * Coverts an array of ConfigArgs into a hash object:
+     *
+     * from:
+     * `[{ name: 'foo', type: 'string', value: 'bar'}]`
+     *
+     * to:
+     * `{ foo: 'bar' }`
+     **/
+    argsArrayToHash(args) {
+        const output = {};
+        for (const arg of args) {
+            if (arg && arg.value != null && this.args[arg.name] != null) {
+                output[arg.name] = coerceValueToType(arg.value, this.args[arg.name].type, this.args[arg.name].list || false);
+            }
+        }
+        return output;
+    }
+}
+exports.ConfigurableOperationDef = ConfigurableOperationDef;
+function localizeString(stringArray, languageCode, channelLanguageCode) {
+    let match = stringArray.find((x) => x.languageCode === languageCode);
+    if (!match) {
+        match = stringArray.find((x) => x.languageCode === channelLanguageCode);
+    }
+    if (!match) {
+        match = stringArray.find((x) => x.languageCode === constants_1.DEFAULT_LANGUAGE_CODE);
+    }
+    if (!match) {
+        match = stringArray[0];
+    }
+    return match.value;
+}
+function coerceValueToType(value, type, isList) {
+    if (isList) {
+        try {
+            return JSON.parse(value).map((v) => coerceValueToType(v, type, false));
+        }
+        catch (err) {
+            throw new errors_1.InternalServerError(`Could not parse list value "${value}": ` + JSON.stringify(err.message));
+        }
+    }
+    switch (type) {
+        case "string":
+            return value;
+        case "int":
+            return Number.parseInt(value || "", 10);
+        case "float":
+            return Number.parseFloat(value || "");
+        case "datetime":
+            return Date.parse(value || "");
+        case "boolean":
+            return !!(value &&
+                (value.toLowerCase() === "true" || value === "1"));
+        case "ID":
+            return value;
+        default:
+            (0, shared_utils_1.assertNever)(type);
+    }
+}
+//# sourceMappingURL=configurable-operation.js.map

package/dist/common/configurable-operation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configurable-operation.js","sourceRoot":"","sources":["../../src/common/configurable-operation.ts"],"names":[],"mappings":";;;AAgBA,mEAA+D;AAI/D,2CAAoD;AACpD,2CAAqD;AA+OrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,MAAa,wBAAwB;IACnC,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IACD,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IACD,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;IAClC,CAAC;IACD,YAAsB,OAA2C;QAA3C,YAAO,GAAP,OAAO,CAAoC;IAAG,CAAC;IAErE,KAAK,CAAC,IAAI,CAAC,QAAkB;QAC3B,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC5C,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IACD,KAAK,CAAC,OAAO;QACX,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YAC/C,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAC/B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,GAAmB;QAC/B,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,cAAc,CACzB,IAAI,CAAC,WAAW,EAChB,GAAG,CAAC,YAAY,EAChB,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAChC;YACD,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CACjC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE;;gBACd,OAAA,CAAC;oBACC,IAAI;oBACJ,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,IAAI,EAAE,MAAA,GAAG,CAAC,IAAI,mCAAI,KAAK;oBACvB,QAAQ,EAAE,MAAA,GAAG,CAAC,QAAQ,mCAAI,IAAI;oBAC9B,YAAY,EAAE,GAAG,CAAC,YAAY;oBAC9B,EAAE,EAAE,GAAG,CAAC,EAAE;oBACV,KAAK,EACH,GAAG,CAAC,KAAK;wBACT,cAAc,CACZ,GAAG,CAAC,KAAK,EACT,GAAG,CAAC,YAAY,EAChB,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAChC;oBACH,WAAW,EACT,GAAG,CAAC,WAAW;wBACf,cAAc,CACZ,GAAG,CAAC,WAAW,EACf,GAAG,CAAC,YAAY,EAChB,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAChC;iBACJ,CAAkC,CAAA;aAAA,CACtC;SACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;QASI;IACM,eAAe,CAAC,IAAiB;QACzC,MAAM,MAAM,GAAuB,EAAS,CAAC;QAC7C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,GAAG,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;gBAC5D,MAAM,CAAC,GAAG,CAAC,IAAgC,CAAC,GAAG,iBAAiB,CAC9D,GAAG,CAAC,KAAK,EACT,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,EACxB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,KAAK,CAClC,CAAC;YACJ,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAvFD,4DAuFC;AAED,SAAS,cAAc,CACrB,WAAiC,EACjC,YAA0B,EAC1B,mBAAiC;IAEjC,IAAI,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,YAAY,CAAC,CAAC;IACrE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,mBAAmB,CAAC,CAAC;IAC1E,CAAC;IACD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,iCAAqB,CAAC,CAAC;IAC5E,CAAC;IACD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IACzB,CAAC;IACD,OAAO,KAAK,CAAC,KAAK,CAAC;AACrB,CAAC;AAED,SAAS,iBAAiB,CACxB,KAAa,EACb,IAAmB,EACnB,MAAe;IAEf,IAAI,MAAM,EAAE,CAAC;QACX,IAAI,CAAC;YACH,OAAQ,IAAI,CAAC,KAAK,CAAC,KAAK,CAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC/C,iBAAiB,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAC3B,CAAC;QACX,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,4BAAmB,CAC3B,+BAA+B,KAAK,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CACxE,CAAC;QACJ,CAAC;IACH,CAAC;IACD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,QAAQ;YACX,OAAO,KAAY,CAAC;QACtB,KAAK,KAAK;YACR,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,EAAE,EAAE,CAAQ,CAAC;QACjD,KAAK,OAAO;YACV,OAAO,MAAM,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE,CAAQ,CAAC;QAC/C,KAAK,UAAU;YACb,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAQ,CAAC;QACxC,KAAK,SAAS;YACZ,OAAO,CAAC,CAAC,CACP,KAAK;gBACL,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,IAAI,KAAK,KAAK,GAAG,CAAC,CAC3C,CAAC;QACX,KAAK,IAAI;YACP,OAAO,KAAY,CAAC;QACtB;YACE,IAAA,0BAAW,EAAC,IAAI,CAAC,CAAC;IACtB,CAAC;AACH,CAAC"}

package/dist/common/constants.d.ts

@@ -0,0 +1,18 @@
+import { LanguageCode } from "@deenruv/common/lib/generated-types";
+import { PermissionDefinition, PermissionMetadata } from "./permission-definition";
+/**
+ * This value should be rarely used - only in those contexts where we have no access to the
+ * DeenruvConfig to ensure at least a valid LanguageCode is available.
+ */
+export declare const DEFAULT_LANGUAGE_CODE = LanguageCode.en;
+export declare const TRANSACTION_MANAGER_KEY: unique symbol;
+export declare const REQUEST_CONTEXT_KEY = "deenruvRequestContext";
+export declare const REQUEST_CONTEXT_MAP_KEY = "deenruvRequestContextMap";
+export declare const DEFAULT_PERMISSIONS: PermissionDefinition[];
+export declare function getAllPermissionsMetadata(customPermissions: PermissionDefinition[]): PermissionMetadata[];
+export declare const CacheKey: {
+    GlobalSettings: string;
+    AllZones: string;
+    ActiveTaxZone: string;
+    ActiveTaxZone_PPA: string;
+};

package/dist/common/constants.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CacheKey = exports.getAllPermissionsMetadata = exports.DEFAULT_PERMISSIONS = exports.REQUEST_CONTEXT_MAP_KEY = exports.REQUEST_CONTEXT_KEY = exports.TRANSACTION_MANAGER_KEY = exports.DEFAULT_LANGUAGE_CODE = void 0;
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const permission_definition_1 = require("./permission-definition");
+/**
+ * This value should be rarely used - only in those contexts where we have no access to the
+ * DeenruvConfig to ensure at least a valid LanguageCode is available.
+ */
+exports.DEFAULT_LANGUAGE_CODE = generated_types_1.LanguageCode.en;
+exports.TRANSACTION_MANAGER_KEY = Symbol("TRANSACTION_MANAGER");
+exports.REQUEST_CONTEXT_KEY = "deenruvRequestContext";
+exports.REQUEST_CONTEXT_MAP_KEY = "deenruvRequestContextMap";
+exports.DEFAULT_PERMISSIONS = [
+    new permission_definition_1.PermissionDefinition({
+        name: "Authenticated",
+        description: "Authenticated means simply that the user is logged in",
+        assignable: true,
+        internal: true,
+    }),
+    new permission_definition_1.PermissionDefinition({
+        name: "SuperAdmin",
+        description: "SuperAdmin has unrestricted access to all operations",
+        assignable: true,
+        internal: true,
+    }),
+    new permission_definition_1.PermissionDefinition({
+        name: "Owner",
+        description: "Owner means the user owns this entity, e.g. a Customer's own Order",
+        assignable: false,
+        internal: true,
+    }),
+    new permission_definition_1.PermissionDefinition({
+        name: "Public",
+        description: "Public means any unauthenticated user may perform the operation",
+        assignable: false,
+        internal: true,
+    }),
+    new permission_definition_1.PermissionDefinition({
+        name: "UpdateGlobalSettings",
+        description: "Grants permission to update GlobalSettings",
+        assignable: true,
+        internal: false,
+    }),
+    new permission_definition_1.CrudPermissionDefinition("Catalog", (operation) => `Grants permission to ${operation} Products, Facets, Assets, Collections`),
+    new permission_definition_1.CrudPermissionDefinition("Settings", (operation) => `Grants permission to ${operation} PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings`),
+    new permission_definition_1.CrudPermissionDefinition("Administrator"),
+    new permission_definition_1.CrudPermissionDefinition("Asset"),
+    new permission_definition_1.CrudPermissionDefinition("Channel"),
+    new permission_definition_1.CrudPermissionDefinition("Collection"),
+    new permission_definition_1.CrudPermissionDefinition("Country"),
+    new permission_definition_1.CrudPermissionDefinition("Customer"),
+    new permission_definition_1.CrudPermissionDefinition("CustomerGroup"),
+    new permission_definition_1.CrudPermissionDefinition("Facet"),
+    new permission_definition_1.CrudPermissionDefinition("Order"),
+    new permission_definition_1.CrudPermissionDefinition("PaymentMethod"),
+    new permission_definition_1.CrudPermissionDefinition("Product"),
+    new permission_definition_1.CrudPermissionDefinition("Promotion"),
+    new permission_definition_1.CrudPermissionDefinition("ShippingMethod"),
+    new permission_definition_1.CrudPermissionDefinition("Tag"),
+    new permission_definition_1.CrudPermissionDefinition("TaxCategory"),
+    new permission_definition_1.CrudPermissionDefinition("TaxRate"),
+    new permission_definition_1.CrudPermissionDefinition("Seller"),
+    new permission_definition_1.CrudPermissionDefinition("StockLocation"),
+    new permission_definition_1.CrudPermissionDefinition("System"),
+    new permission_definition_1.CrudPermissionDefinition("Zone"),
+];
+function getAllPermissionsMetadata(customPermissions) {
+    const allPermissions = [...exports.DEFAULT_PERMISSIONS, ...customPermissions];
+    return allPermissions.reduce((all, def) => [...all, ...def.getMetadata()], []);
+}
+exports.getAllPermissionsMetadata = getAllPermissionsMetadata;
+exports.CacheKey = {
+    GlobalSettings: "GlobalSettings",
+    AllZones: "AllZones",
+    ActiveTaxZone: "ActiveTaxZone",
+    ActiveTaxZone_PPA: "ActiveTaxZone_PPA",
+};
+//# sourceMappingURL=constants.js.map

package/dist/common/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/common/constants.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AAEnE,mEAIiC;AAEjC;;;GAGG;AACU,QAAA,qBAAqB,GAAG,8BAAY,CAAC,EAAE,CAAC;AACxC,QAAA,uBAAuB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AACxD,QAAA,mBAAmB,GAAG,uBAAuB,CAAC;AAC9C,QAAA,uBAAuB,GAAG,0BAA0B,CAAC;AACrD,QAAA,mBAAmB,GAA2B;IACzD,IAAI,4CAAoB,CAAC;QACvB,IAAI,EAAE,eAAe;QACrB,WAAW,EAAE,uDAAuD;QACpE,UAAU,EAAE,IAAI;QAChB,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,IAAI,4CAAoB,CAAC;QACvB,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE,sDAAsD;QACnE,UAAU,EAAE,IAAI;QAChB,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,IAAI,4CAAoB,CAAC;QACvB,IAAI,EAAE,OAAO;QACb,WAAW,EACT,oEAAoE;QACtE,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,IAAI,4CAAoB,CAAC;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,iEAAiE;QACnE,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,IAAI,4CAAoB,CAAC;QACvB,IAAI,EAAE,sBAAsB;QAC5B,WAAW,EAAE,4CAA4C;QACzD,UAAU,EAAE,IAAI;QAChB,QAAQ,EAAE,KAAK;KAChB,CAAC;IACF,IAAI,gDAAwB,CAC1B,SAAS,EACT,CAAC,SAAS,EAAE,EAAE,CACZ,wBAAwB,SAAS,wCAAwC,CAC5E;IACD,IAAI,gDAAwB,CAC1B,UAAU,EACV,CAAC,SAAS,EAAE,EAAE,CACZ,wBAAwB,SAAS,sGAAsG,CAC1I;IACD,IAAI,gDAAwB,CAAC,eAAe,CAAC;IAC7C,IAAI,gDAAwB,CAAC,OAAO,CAAC;IACrC,IAAI,gDAAwB,CAAC,SAAS,CAAC;IACvC,IAAI,gDAAwB,CAAC,YAAY,CAAC;IAC1C,IAAI,gDAAwB,CAAC,SAAS,CAAC;IACvC,IAAI,gDAAwB,CAAC,UAAU,CAAC;IACxC,IAAI,gDAAwB,CAAC,eAAe,CAAC;IAC7C,IAAI,gDAAwB,CAAC,OAAO,CAAC;IACrC,IAAI,gDAAwB,CAAC,OAAO,CAAC;IACrC,IAAI,gDAAwB,CAAC,eAAe,CAAC;IAC7C,IAAI,gDAAwB,CAAC,SAAS,CAAC;IACvC,IAAI,gDAAwB,CAAC,WAAW,CAAC;IACzC,IAAI,gDAAwB,CAAC,gBAAgB,CAAC;IAC9C,IAAI,gDAAwB,CAAC,KAAK,CAAC;IACnC,IAAI,gDAAwB,CAAC,aAAa,CAAC;IAC3C,IAAI,gDAAwB,CAAC,SAAS,CAAC;IACvC,IAAI,gDAAwB,CAAC,QAAQ,CAAC;IACtC,IAAI,gDAAwB,CAAC,eAAe,CAAC;IAC7C,IAAI,gDAAwB,CAAC,QAAQ,CAAC;IACtC,IAAI,gDAAwB,CAAC,MAAM,CAAC;CACrC,CAAC;AAEF,SAAgB,yBAAyB,CACvC,iBAAyC;IAEzC,MAAM,cAAc,GAAG,CAAC,GAAG,2BAAmB,EAAE,GAAG,iBAAiB,CAAC,CAAC;IACtE,OAAO,cAAc,CAAC,MAAM,CAC1B,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC,EAC5C,EAA0B,CAC3B,CAAC;AACJ,CAAC;AARD,8DAQC;AAEY,QAAA,QAAQ,GAAG;IACtB,cAAc,EAAE,gBAAgB;IAChC,QAAQ,EAAE,UAAU;IACpB,aAAa,EAAE,eAAe;IAC9B,iBAAiB,EAAE,mBAAmB;CACvC,CAAC"}

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

@@ -0,0 +1,62 @@
+import { DeenruvEntity } from "../../entity/base/base.entity";
+export type GraphQLErrorResult = {
+    errorCode: string;
+    message: string;
+};
+/**
+ * @description
+ * Takes an ErrorResult union type (i.e. a generated union type consisting of some query/mutation result
+ * plus one or more ErrorResult types) and returns a union of _just_ the ErrorResult types.
+ *
+ * @example
+ * ```ts
+ * type UpdateOrderItemsResult = Order | OrderModificationError | OrderLimitError | NegativeQuantityError;
+ *
+ * type T1 = JustErrorResults<UpdateOrderItemsResult>;
+ * // T1 = OrderModificationError | OrderLimitError | NegativeQuantityError
+ * ```
+ */
+export type JustErrorResults<T extends GraphQLErrorResult | U, U = any> = Exclude<T, T extends GraphQLErrorResult ? never : T>;
+/**
+ * @description
+ * Used to construct a TypeScript return type for a query or mutation which, in the GraphQL schema,
+ * returns a union type composed of a success result (e.g. Order) plus one or more ErrorResult
+ * types.
+ *
+ * Since the TypeScript entities do not correspond 1-to-1 with their GraphQL type counterparts,
+ * we use this type to substitute them.
+ *
+ * @example
+ * ```ts
+ * type UpdateOrderItemsResult = Order | OrderModificationError | OrderLimitError | NegativeQuantityError;
+ * type T1 = ErrorResultUnion<UpdateOrderItemsResult, DeenruvEntityOrder>;
+ * // T1 = DeenruvEntityOrder | OrderModificationError | OrderLimitError | NegativeQuantityError;
+ * ```
+ *
+ * @docsCategory errors
+ */
+export type ErrorResultUnion<T extends GraphQLErrorResult | U, E extends DeenruvEntity, U = any> = JustErrorResults<T> | E;
+/**
+ * @description
+ * Returns true if the {@link ErrorResultUnion} is actually an ErrorResult type. This is useful when dealing with
+ * certain internal service method that return an ErrorResultUnion.
+ *
+ * @example
+ * ```ts
+ * import { isGraphQlErrorResult } from '\@deenruv/core';
+ *
+ * // ...
+ *
+ * const transitionResult = await this.orderService.transitionToState(ctx, order.id, newState);
+ * if (isGraphQlErrorResult(transitionResult)) {
+ *     // The transition failed with an ErrorResult
+ *     throw transitionResult;
+ * } else {
+ *     // TypeScript will correctly infer the type of `transitionResult` to be `Order`
+ *     return transitionResult;
+ * }
+ * ```
+ *
+ * @docsCategory errors
+ */
+export declare function isGraphQlErrorResult<T extends GraphQLErrorResult | U, U = any>(input: T): input is JustErrorResults<T>;

package/dist/common/error/error-result.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isGraphQlErrorResult = void 0;
+function isGraphQlErrorResult(input) {
+    return (input &&
+        !!(input.errorCode &&
+            input.message != null) &&
+        input.__typename);
+}
+exports.isGraphQlErrorResult = isGraphQlErrorResult;
+//# sourceMappingURL=error-result.js.map

package/dist/common/error/error-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-result.js","sourceRoot":"","sources":["../../../src/common/error/error-result.ts"],"names":[],"mappings":";;;AA2EA,SAAgB,oBAAoB,CAClC,KAA6B;IAE7B,OAAO,CACL,KAAK;QACL,CAAC,CAAC,CACC,KAAuC,CAAC,SAAS;YACjD,KAAuC,CAAC,OAAO,IAAI,IAAI,CACzD;QACA,KAAa,CAAC,UAAU,CAC1B,CAAC;AACJ,CAAC;AAXD,oDAWC"}

package/dist/common/error/errors.d.ts

@@ -0,0 +1,83 @@
+import { ID } from "@deenruv/common/lib/shared-types";
+import { LogLevel } from "../../config/logger/deenruv-logger";
+import { coreEntitiesMap } from "../../entity/entities";
+import { I18nError } from "../../i18n/i18n-error";
+/**
+ * @description
+ * This error should be thrown when some unexpected and exceptional case is encountered.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+export declare class InternalServerError extends I18nError {
+    constructor(message: string, variables?: {
+        [key: string]: string | number;
+    });
+}
+/**
+ * @description
+ * This error should be thrown when user input is not as expected.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+export declare class UserInputError extends I18nError {
+    constructor(message: string, variables?: {
+        [key: string]: string | number;
+    });
+}
+/**
+ * @description
+ * This error should be thrown when an operation is attempted which is not allowed.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+export declare class IllegalOperationError extends I18nError {
+    constructor(message: string, variables?: {
+        [key: string]: string | number;
+    });
+}
+/**
+ * @description
+ * This error should be thrown when the user's authentication credentials do not match.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+export declare class UnauthorizedError extends I18nError {
+    constructor();
+}
+/**
+ * @description
+ * This error should be thrown when a user attempts to access a resource which is outside of
+ * his or her privileges.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+export declare class ForbiddenError extends I18nError {
+    constructor(logLevel?: LogLevel);
+}
+/**
+ * @description
+ * This error should be thrown when a {@link Channel} cannot be found based on the provided
+ * channel token.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+export declare class ChannelNotFoundError extends I18nError {
+    constructor(token: string);
+}
+/**
+ * @description
+ * This error should be thrown when an entity cannot be found in the database, i.e. no entity of
+ * the given entityName (Product, User etc.) exists with the provided id.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+export declare class EntityNotFoundError extends I18nError {
+    constructor(entityName: keyof typeof coreEntitiesMap | string, id: ID);
+}

package/dist/common/error/errors.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityNotFoundError = exports.ChannelNotFoundError = exports.ForbiddenError = exports.UnauthorizedError = exports.IllegalOperationError = exports.UserInputError = exports.InternalServerError = void 0;
+const deenruv_logger_1 = require("../../config/logger/deenruv-logger");
+const i18n_error_1 = require("../../i18n/i18n-error");
+/**
+ * @description
+ * This error should be thrown when some unexpected and exceptional case is encountered.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+class InternalServerError extends i18n_error_1.I18nError {
+    constructor(message, variables = {}) {
+        super(message, variables, "INTERNAL_SERVER_ERROR", deenruv_logger_1.LogLevel.Error);
+    }
+}
+exports.InternalServerError = InternalServerError;
+/**
+ * @description
+ * This error should be thrown when user input is not as expected.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+class UserInputError extends i18n_error_1.I18nError {
+    constructor(message, variables = {}) {
+        super(message, variables, "USER_INPUT_ERROR", deenruv_logger_1.LogLevel.Warn);
+    }
+}
+exports.UserInputError = UserInputError;
+/**
+ * @description
+ * This error should be thrown when an operation is attempted which is not allowed.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+class IllegalOperationError extends i18n_error_1.I18nError {
+    constructor(message, variables = {}) {
+        super(message, variables, "ILLEGAL_OPERATION", deenruv_logger_1.LogLevel.Warn);
+    }
+}
+exports.IllegalOperationError = IllegalOperationError;
+/**
+ * @description
+ * This error should be thrown when the user's authentication credentials do not match.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+class UnauthorizedError extends i18n_error_1.I18nError {
+    constructor() {
+        super("error.unauthorized", {}, "UNAUTHORIZED", deenruv_logger_1.LogLevel.Info);
+    }
+}
+exports.UnauthorizedError = UnauthorizedError;
+/**
+ * @description
+ * This error should be thrown when a user attempts to access a resource which is outside of
+ * his or her privileges.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+class ForbiddenError extends i18n_error_1.I18nError {
+    constructor(logLevel = deenruv_logger_1.LogLevel.Warn) {
+        super("error.forbidden", {}, "FORBIDDEN", logLevel);
+    }
+}
+exports.ForbiddenError = ForbiddenError;
+/**
+ * @description
+ * This error should be thrown when a {@link Channel} cannot be found based on the provided
+ * channel token.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+class ChannelNotFoundError extends i18n_error_1.I18nError {
+    constructor(token) {
+        super("error.channel-not-found", { token }, "CHANNEL_NOT_FOUND", deenruv_logger_1.LogLevel.Info);
+    }
+}
+exports.ChannelNotFoundError = ChannelNotFoundError;
+/**
+ * @description
+ * This error should be thrown when an entity cannot be found in the database, i.e. no entity of
+ * the given entityName (Product, User etc.) exists with the provided id.
+ *
+ * @docsCategory errors
+ * @docsPage Error Types
+ */
+class EntityNotFoundError extends i18n_error_1.I18nError {
+    constructor(entityName, id) {
+        super("error.entity-with-id-not-found", { entityName, id }, "ENTITY_NOT_FOUND", deenruv_logger_1.LogLevel.Warn);
+    }
+}
+exports.EntityNotFoundError = EntityNotFoundError;
+//# sourceMappingURL=errors.js.map

package/dist/common/error/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/common/error/errors.ts"],"names":[],"mappings":";;;AAEA,uEAA8D;AAE9D,sDAAkD;AAElD;;;;;;GAMG;AACH,MAAa,mBAAoB,SAAQ,sBAAS;IAChD,YACE,OAAe,EACf,YAAgD,EAAE;QAElD,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,yBAAQ,CAAC,KAAK,CAAC,CAAC;IACrE,CAAC;CACF;AAPD,kDAOC;AAED;;;;;;GAMG;AACH,MAAa,cAAe,SAAQ,sBAAS;IAC3C,YACE,OAAe,EACf,YAAgD,EAAE;QAElD,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,yBAAQ,CAAC,IAAI,CAAC,CAAC;IAC/D,CAAC;CACF;AAPD,wCAOC;AAED;;;;;;GAMG;AACH,MAAa,qBAAsB,SAAQ,sBAAS;IAClD,YACE,OAAe,EACf,YAAgD,EAAE;QAElD,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,yBAAQ,CAAC,IAAI,CAAC,CAAC;IAChE,CAAC;CACF;AAPD,sDAOC;AAED;;;;;;GAMG;AACH,MAAa,iBAAkB,SAAQ,sBAAS;IAC9C;QACE,KAAK,CAAC,oBAAoB,EAAE,EAAE,EAAE,cAAc,EAAE,yBAAQ,CAAC,IAAI,CAAC,CAAC;IACjE,CAAC;CACF;AAJD,8CAIC;AAED;;;;;;;GAOG;AACH,MAAa,cAAe,SAAQ,sBAAS;IAC3C,YAAY,WAAqB,yBAAQ,CAAC,IAAI;QAC5C,KAAK,CAAC,iBAAiB,EAAE,EAAE,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;CACF;AAJD,wCAIC;AAED;;;;;;;GAOG;AACH,MAAa,oBAAqB,SAAQ,sBAAS;IACjD,YAAY,KAAa;QACvB,KAAK,CACH,yBAAyB,EACzB,EAAE,KAAK,EAAE,EACT,mBAAmB,EACnB,yBAAQ,CAAC,IAAI,CACd,CAAC;IACJ,CAAC;CACF;AATD,oDASC;AAED;;;;;;;GAOG;AACH,MAAa,mBAAoB,SAAQ,sBAAS;IAChD,YAAY,UAAiD,EAAE,EAAM;QACnE,KAAK,CACH,gCAAgC,EAChC,EAAE,UAAU,EAAE,EAAE,EAAE,EAClB,kBAAkB,EAClB,yBAAQ,CAAC,IAAI,CACd,CAAC;IACJ,CAAC;CACF;AATD,kDASC"}