@deenruv/core 1.0.0

package/dist/common/permission-definition.d.ts

@@ -0,0 +1,158 @@
+import { Permission } from "@deenruv/common/lib/generated-types";
+/**
+ * @description
+ * Configures a {@link PermissionDefinition}
+ *
+ * @docsCategory auth
+ * @docsPage PermissionDefinition
+ */
+export interface PermissionDefinitionConfig {
+    /**
+     * @description
+     * The name of the permission. By convention this should be
+     * UpperCamelCased.
+     */
+    name: string;
+    /**
+     * @description
+     * A description of the permission.
+     */
+    description?: string;
+    /**
+     * @description
+     * Whether this permission can be assigned to a Role. In general this
+     * should be left as the default `true` except in special cases.
+     *
+     * @default true
+     */
+    assignable?: boolean;
+    /**
+     * @description
+     * Internal permissions are not exposed via the API and are reserved for
+     * special use-cases such at the `Owner` or `Public` permissions.
+     *
+     * @default false
+     */
+    internal?: boolean;
+}
+/**
+ * @description
+ * Permission metadata used internally in generating the GraphQL `Permissions` enum.
+ *
+ * @internal
+ */
+export type PermissionMetadata = Required<PermissionDefinitionConfig>;
+/**
+ * @description
+ * Defines a new Permission with which to control access to GraphQL resolvers & REST controllers.
+ * Used in conjunction with the {@link Allow} decorator (see example below).
+ *
+ * **Note:** To define CRUD permissions, use the {@link CrudPermissionDefinition}.
+ *
+ * @example
+ * ```ts
+ * export const sync = new PermissionDefinition({
+ *   name: 'SyncInventory',
+ *   description: 'Allows syncing stock levels via Admin API'
+ * });
+ * ```
+ *
+ * ```ts
+ * const config: DeenruvConfig = {
+ *   authOptions: {
+ *     customPermissions: [sync],
+ *   },
+ * }
+ * ```
+ *
+ * ```ts
+ * \@Resolver()
+ * export class ExternalSyncResolver {
+ *
+ *   \@Allow(sync.Permission)
+ *   \@Mutation()
+ *   syncStockLevels() {
+ *     // ...
+ *   }
+ * }
+ * ```
+ * @docsCategory auth
+ * @docsPage PermissionDefinition
+ * @docsWeight 0
+ */
+export declare class PermissionDefinition {
+    protected config: PermissionDefinitionConfig;
+    constructor(config: PermissionDefinitionConfig);
+    /** @internal */
+    getMetadata(): PermissionMetadata[];
+    /**
+     * @description
+     * Returns the permission defined by this definition, for use in the
+     * {@link Allow} decorator.
+     */
+    get Permission(): Permission;
+}
+/**
+ * @description
+ * Defines a set of CRUD Permissions for the given name, i.e. a `name` of 'Wishlist' will create
+ * 4 Permissions: 'CreateWishlist', 'ReadWishlist', 'UpdateWishlist' & 'DeleteWishlist'.
+ *
+ * @example
+ * ```ts
+ * export const wishlist = new CrudPermissionDefinition('Wishlist');
+ * ```
+ *
+ * ```ts
+ * const config: DeenruvConfig = {
+ *   authOptions: {
+ *     customPermissions: [wishlist],
+ *   },
+ * }
+ * ```
+ *
+ * ```ts
+ * \@Resolver()
+ * export class WishlistResolver {
+ *
+ *   \@Allow(wishlist.Create)
+ *   \@Mutation()
+ *   createWishlist() {
+ *     // ...
+ *   }
+ * }
+ * ```
+ *
+ * @docsCategory auth
+ * @docsPage PermissionDefinition
+ * @docsWeight 1
+ */
+export declare class CrudPermissionDefinition extends PermissionDefinition {
+    private descriptionFn?;
+    constructor(name: string, descriptionFn?: ((operation: "create" | "read" | "update" | "delete") => string) | undefined);
+    /** @internal */
+    getMetadata(): PermissionMetadata[];
+    /**
+     * @description
+     * Returns the 'Create' CRUD permission defined by this definition, for use in the
+     * {@link Allow} decorator.
+     */
+    get Create(): Permission;
+    /**
+     * @description
+     * Returns the 'Read' CRUD permission defined by this definition, for use in the
+     * {@link Allow} decorator.
+     */
+    get Read(): Permission;
+    /**
+     * @description
+     * Returns the 'Update' CRUD permission defined by this definition, for use in the
+     * {@link Allow} decorator.
+     */
+    get Update(): Permission;
+    /**
+     * @description
+     * Returns the 'Delete' CRUD permission defined by this definition, for use in the
+     * {@link Allow} decorator.
+     */
+    get Delete(): Permission;
+}

package/dist/common/permission-definition.js

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrudPermissionDefinition = exports.PermissionDefinition = void 0;
+/**
+ * @description
+ * Defines a new Permission with which to control access to GraphQL resolvers & REST controllers.
+ * Used in conjunction with the {@link Allow} decorator (see example below).
+ *
+ * **Note:** To define CRUD permissions, use the {@link CrudPermissionDefinition}.
+ *
+ * @example
+ * ```ts
+ * export const sync = new PermissionDefinition({
+ *   name: 'SyncInventory',
+ *   description: 'Allows syncing stock levels via Admin API'
+ * });
+ * ```
+ *
+ * ```ts
+ * const config: DeenruvConfig = {
+ *   authOptions: {
+ *     customPermissions: [sync],
+ *   },
+ * }
+ * ```
+ *
+ * ```ts
+ * \@Resolver()
+ * export class ExternalSyncResolver {
+ *
+ *   \@Allow(sync.Permission)
+ *   \@Mutation()
+ *   syncStockLevels() {
+ *     // ...
+ *   }
+ * }
+ * ```
+ * @docsCategory auth
+ * @docsPage PermissionDefinition
+ * @docsWeight 0
+ */
+class PermissionDefinition {
+    constructor(config) {
+        this.config = config;
+    }
+    /** @internal */
+    getMetadata() {
+        const { name, description, assignable, internal } = this.config;
+        return [
+            {
+                name,
+                description: description || `Grants permissions on ${name} operations`,
+                assignable: assignable !== null && assignable !== void 0 ? assignable : true,
+                internal: internal !== null && internal !== void 0 ? internal : false,
+            },
+        ];
+    }
+    /**
+     * @description
+     * Returns the permission defined by this definition, for use in the
+     * {@link Allow} decorator.
+     */
+    get Permission() {
+        return this.config.name;
+    }
+}
+exports.PermissionDefinition = PermissionDefinition;
+/**
+ * @description
+ * Defines a set of CRUD Permissions for the given name, i.e. a `name` of 'Wishlist' will create
+ * 4 Permissions: 'CreateWishlist', 'ReadWishlist', 'UpdateWishlist' & 'DeleteWishlist'.
+ *
+ * @example
+ * ```ts
+ * export const wishlist = new CrudPermissionDefinition('Wishlist');
+ * ```
+ *
+ * ```ts
+ * const config: DeenruvConfig = {
+ *   authOptions: {
+ *     customPermissions: [wishlist],
+ *   },
+ * }
+ * ```
+ *
+ * ```ts
+ * \@Resolver()
+ * export class WishlistResolver {
+ *
+ *   \@Allow(wishlist.Create)
+ *   \@Mutation()
+ *   createWishlist() {
+ *     // ...
+ *   }
+ * }
+ * ```
+ *
+ * @docsCategory auth
+ * @docsPage PermissionDefinition
+ * @docsWeight 1
+ */
+class CrudPermissionDefinition extends PermissionDefinition {
+    constructor(name, descriptionFn) {
+        super({ name });
+        this.descriptionFn = descriptionFn;
+    }
+    /** @internal */
+    getMetadata() {
+        return ["Create", "Read", "Update", "Delete"].map((operation) => ({
+            name: `${operation}${this.config.name}`,
+            description: typeof this.descriptionFn === "function"
+                ? this.descriptionFn(operation.toLocaleLowerCase())
+                : `Grants permission to ${operation.toLocaleLowerCase()} ${this.config.name}`,
+            assignable: true,
+            internal: false,
+        }));
+    }
+    /**
+     * @description
+     * Returns the 'Create' CRUD permission defined by this definition, for use in the
+     * {@link Allow} decorator.
+     */
+    get Create() {
+        return `Create${this.config.name}`;
+    }
+    /**
+     * @description
+     * Returns the 'Read' CRUD permission defined by this definition, for use in the
+     * {@link Allow} decorator.
+     */
+    get Read() {
+        return `Read${this.config.name}`;
+    }
+    /**
+     * @description
+     * Returns the 'Update' CRUD permission defined by this definition, for use in the
+     * {@link Allow} decorator.
+     */
+    get Update() {
+        return `Update${this.config.name}`;
+    }
+    /**
+     * @description
+     * Returns the 'Delete' CRUD permission defined by this definition, for use in the
+     * {@link Allow} decorator.
+     */
+    get Delete() {
+        return `Delete${this.config.name}`;
+    }
+}
+exports.CrudPermissionDefinition = CrudPermissionDefinition;
+//# sourceMappingURL=permission-definition.js.map

package/dist/common/permission-definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission-definition.js","sourceRoot":"","sources":["../../src/common/permission-definition.ts"],"names":[],"mappings":";;;AA+CA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAa,oBAAoB;IAC/B,YAAsB,MAAkC;QAAlC,WAAM,GAAN,MAAM,CAA4B;IAAG,CAAC;IAE5D,gBAAgB;IAChB,WAAW;QACT,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAChE,OAAO;YACL;gBACE,IAAI;gBACJ,WAAW,EAAE,WAAW,IAAI,yBAAyB,IAAI,aAAa;gBACtE,UAAU,EAAE,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,IAAI;gBAC9B,QAAQ,EAAE,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,KAAK;aAC5B;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,IAAkB,CAAC;IACxC,CAAC;CACF;AAxBD,oDAwBC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAa,wBAAyB,SAAQ,oBAAoB;IAChE,YACE,IAAY,EACJ,aAEG;QAEX,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QAJR,kBAAa,GAAb,aAAa,CAEV;IAGb,CAAC;IAED,gBAAgB;IAChB,WAAW;QACT,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAChE,IAAI,EAAE,GAAG,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YACvC,WAAW,EACT,OAAO,IAAI,CAAC,aAAa,KAAK,UAAU;gBACtC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,iBAAiB,EAAS,CAAC;gBAC1D,CAAC,CAAC,wBAAwB,SAAS,CAAC,iBAAiB,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YACjF,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAC,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,SAAS,IAAI,CAAC,MAAM,CAAC,IAAI,EAAgB,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAgB,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,SAAS,IAAI,CAAC,MAAM,CAAC,IAAI,EAAgB,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,SAAS,IAAI,CAAC,MAAM,CAAC,IAAI,EAAgB,CAAC;IACnD,CAAC;CACF;AA1DD,4DA0DC"}

package/dist/common/round-money.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @description
+ * Rounds a monetary value according to the configured {@link MoneyStrategy}.
+ *
+ * @docsCategory money
+ * @since 2.0.0
+ */
+export declare function roundMoney(value: number, quantity?: number): number;

package/dist/common/round-money.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.roundMoney = void 0;
+const config_helpers_1 = require("../config/config-helpers");
+let moneyStrategy;
+/**
+ * @description
+ * Rounds a monetary value according to the configured {@link MoneyStrategy}.
+ *
+ * @docsCategory money
+ * @since 2.0.0
+ */
+function roundMoney(value, quantity = 1) {
+    if (!moneyStrategy) {
+        moneyStrategy = (0, config_helpers_1.getConfig)().entityOptions.moneyStrategy;
+    }
+    return moneyStrategy.round(value, quantity);
+}
+exports.roundMoney = roundMoney;
+//# sourceMappingURL=round-money.js.map

package/dist/common/round-money.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"round-money.js","sourceRoot":"","sources":["../../src/common/round-money.ts"],"names":[],"mappings":";;;AAAA,6DAAqD;AAGrD,IAAI,aAA4B,CAAC;AAEjC;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,KAAa,EAAE,QAAQ,GAAG,CAAC;IACpD,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,aAAa,GAAG,IAAA,0BAAS,GAAE,CAAC,aAAa,CAAC,aAAa,CAAC;IAC1D,CAAC;IACD,OAAO,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAC9C,CAAC;AALD,gCAKC"}

package/dist/common/self-refreshing-cache.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @description
+ * A cache which automatically refreshes itself if the value is found to be stale.
+ */
+export interface SelfRefreshingCache<V, RefreshArgs extends any[] = []> {
+    /**
+     * @description
+     * The current value of the cache. If the value is stale, the data will be refreshed and then
+     * the fresh value will be returned.
+     */
+    value(...refreshArgs: RefreshArgs | [undefined] | []): Promise<V>;
+    /**
+     * @description
+     * Allows a memoized function to be defined. For the given arguments, the `fn` function will
+     * be invoked only once and its output cached and returned.
+     * The results cache is cleared along with the rest of the cache according to the configured
+     * `ttl` value.
+     */
+    memoize<Args extends any[], R>(args: Args, refreshArgs: RefreshArgs, fn: (value: V, ...args: Args) => R): Promise<R>;
+    /**
+     * @description
+     * Force a refresh of the value, e.g. when it is known that the value has changed such as after
+     * an update operation to the source data in the database.
+     */
+    refresh(...args: RefreshArgs): Promise<V>;
+}
+export interface SelfRefreshingCacheConfig<V, RefreshArgs extends any[]> {
+    name: string;
+    ttl: number;
+    refresh: {
+        fn: (...args: RefreshArgs) => Promise<V>;
+        /**
+         * Default arguments, passed to refresh function
+         */
+        defaultArgs: RefreshArgs;
+    };
+    /**
+     * Intended for unit testing the SelfRefreshingCache only.
+     * By default uses `() => new Date().getTime()`
+     */
+    getTimeFn?: () => number;
+}
+/**
+ * @description
+ * Creates a {@link SelfRefreshingCache} object, which is used to cache a single frequently-accessed value. In this type
+ * of cache, the function used to populate the value (`refreshFn`) is defined during the creation of the cache, and
+ * it is immediately used to populate the initial value.
+ *
+ * From there, when the `.value` property is accessed, it will return a value from the cache, and if the
+ * value has expired, it will automatically run the `refreshFn` to update the value and then return the
+ * fresh value.
+ */
+export declare function createSelfRefreshingCache<V, RefreshArgs extends any[]>(config: SelfRefreshingCacheConfig<V, RefreshArgs>, refreshArgs?: RefreshArgs): Promise<SelfRefreshingCache<V, RefreshArgs>>;

package/dist/common/self-refreshing-cache.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSelfRefreshingCache = void 0;
+const deenruv_logger_1 = require("../config/logger/deenruv-logger");
+/**
+ * @description
+ * Creates a {@link SelfRefreshingCache} object, which is used to cache a single frequently-accessed value. In this type
+ * of cache, the function used to populate the value (`refreshFn`) is defined during the creation of the cache, and
+ * it is immediately used to populate the initial value.
+ *
+ * From there, when the `.value` property is accessed, it will return a value from the cache, and if the
+ * value has expired, it will automatically run the `refreshFn` to update the value and then return the
+ * fresh value.
+ */
+async function createSelfRefreshingCache(config, refreshArgs) {
+    const { ttl, name, refresh, getTimeFn } = config;
+    const getTimeNow = getTimeFn !== null && getTimeFn !== void 0 ? getTimeFn : (() => new Date().getTime());
+    const initialValue = await refresh.fn(...(refreshArgs !== null && refreshArgs !== void 0 ? refreshArgs : refresh.defaultArgs));
+    let value = initialValue;
+    let expires = getTimeNow() + ttl;
+    const memoCache = new Map();
+    const refreshValue = (resetMemoCache = true, args) => {
+        return refresh
+            .fn(...args)
+            .then((newValue) => {
+            value = newValue;
+            expires = getTimeNow() + ttl;
+            if (resetMemoCache) {
+                memoCache.clear();
+            }
+            return value;
+        })
+            .catch((err) => {
+            const _message = err.message;
+            const message = typeof _message === "string" ? _message : JSON.stringify(err.message);
+            deenruv_logger_1.Logger.error(`Failed to update SelfRefreshingCache "${name}": ${message}`, undefined, err.stack);
+            return value;
+        });
+    };
+    const getValue = async (_refreshArgs, resetMemoCache = true) => {
+        const now = getTimeNow();
+        if (expires < now) {
+            return refreshValue(resetMemoCache, _refreshArgs !== null && _refreshArgs !== void 0 ? _refreshArgs : refresh.defaultArgs);
+        }
+        return value;
+    };
+    const memoize = async (args, _refreshArgs, fn) => {
+        const key = JSON.stringify(args);
+        const cached = memoCache.get(key);
+        const now = getTimeNow();
+        if (cached && now < cached.expires) {
+            return cached.value;
+        }
+        const result = getValue(_refreshArgs, false).then((val) => fn(val, ...args));
+        memoCache.set(key, {
+            expires: now + ttl,
+            value: result,
+        });
+        return result;
+    };
+    return {
+        value: (...args) => getValue(!args.length || (args.length === 1 && args[0] === undefined)
+            ? undefined
+            : args),
+        refresh: (...args) => refreshValue(true, args),
+        memoize,
+    };
+}
+exports.createSelfRefreshingCache = createSelfRefreshingCache;
+//# sourceMappingURL=self-refreshing-cache.js.map

package/dist/common/self-refreshing-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"self-refreshing-cache.js","sourceRoot":"","sources":["../../src/common/self-refreshing-cache.ts"],"names":[],"mappings":";;;AAEA,oEAAyD;AAoDzD;;;;;;;;;GASG;AACI,KAAK,UAAU,yBAAyB,CAC7C,MAAiD,EACjD,WAAyB;IAEzB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IACjD,MAAM,UAAU,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IAC7D,MAAM,YAAY,GAAM,MAAM,OAAO,CAAC,EAAE,CACtC,GAAG,CAAC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,OAAO,CAAC,WAAW,CAAC,CACxC,CAAC;IACF,IAAI,KAAK,GAAG,YAAY,CAAC;IACzB,IAAI,OAAO,GAAG,UAAU,EAAE,GAAG,GAAG,CAAC;IACjC,MAAM,SAAS,GAAG,IAAI,GAAG,EAA2C,CAAC;IACrE,MAAM,YAAY,GAAG,CACnB,cAAc,GAAG,IAAI,EACrB,IAAiB,EACL,EAAE;QACd,OAAO,OAAO;aACX,EAAE,CAAC,GAAG,IAAI,CAAC;aACX,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,KAAK,GAAG,QAAQ,CAAC;YACjB,OAAO,GAAG,UAAU,EAAE,GAAG,GAAG,CAAC;YAC7B,IAAI,cAAc,EAAE,CAAC;gBACnB,SAAS,CAAC,KAAK,EAAE,CAAC;YACpB,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,GAAQ,EAAE,EAAE;YAClB,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC;YAC7B,MAAM,OAAO,GACX,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACxE,uBAAM,CAAC,KAAK,CACV,yCAAyC,IAAI,MAAM,OAAO,EAAE,EAC5D,SAAS,EACT,GAAG,CAAC,KAAK,CACV,CAAC;YACF,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IACF,MAAM,QAAQ,GAAG,KAAK,EACpB,YAA0B,EAC1B,cAAc,GAAG,IAAI,EACT,EAAE;QACd,MAAM,GAAG,GAAG,UAAU,EAAE,CAAC;QACzB,IAAI,OAAO,GAAG,GAAG,EAAE,CAAC;YAClB,OAAO,YAAY,CAAC,cAAc,EAAE,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,OAAO,CAAC,WAAW,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IACF,MAAM,OAAO,GAAG,KAAK,EACnB,IAAU,EACV,YAAyB,EACzB,EAAkC,EACtB,EAAE;QACd,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,GAAG,GAAG,UAAU,EAAE,CAAC;QACzB,IAAI,MAAM,IAAI,GAAG,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;YACnC,OAAO,MAAM,CAAC,KAAK,CAAC;QACtB,CAAC;QACD,MAAM,MAAM,GAAG,QAAQ,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CACxD,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CACjB,CAAC;QACF,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE;YACjB,OAAO,EAAE,GAAG,GAAG,GAAG;YAClB,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IACF,OAAO;QACL,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CACjB,QAAQ,CACN,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;YAC1D,CAAC,CAAC,SAAS;YACX,CAAC,CAAE,IAAoB,CAC1B;QACH,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC;QAC9C,OAAO;KACR,CAAC;AACJ,CAAC;AA9ED,8DA8EC"}

package/dist/common/tax-utils.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Returns the tax component of a given gross price.
+ */
+export declare function taxComponentOf(grossPrice: number, taxRatePc: number): number;
+/**
+ * Given a gross (tax-inclusive) price, returns the net price.
+ */
+export declare function netPriceOf(grossPrice: number, taxRatePc: number): number;
+/**
+ * Returns the tax applicable to the given net price.
+ */
+export declare function taxPayableOn(netPrice: number, taxRatePc: number): number;
+/**
+ * Given a net price, return the gross price (net + tax)
+ */
+export declare function grossPriceOf(netPrice: number, taxRatePc: number): number;

package/dist/common/tax-utils.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.grossPriceOf = exports.taxPayableOn = exports.netPriceOf = exports.taxComponentOf = void 0;
+/**
+ * Returns the tax component of a given gross price.
+ */
+function taxComponentOf(grossPrice, taxRatePc) {
+    return grossPrice - grossPrice / ((100 + taxRatePc) / 100);
+}
+exports.taxComponentOf = taxComponentOf;
+/**
+ * Given a gross (tax-inclusive) price, returns the net price.
+ */
+function netPriceOf(grossPrice, taxRatePc) {
+    return grossPrice - taxComponentOf(grossPrice, taxRatePc);
+}
+exports.netPriceOf = netPriceOf;
+/**
+ * Returns the tax applicable to the given net price.
+ */
+function taxPayableOn(netPrice, taxRatePc) {
+    return netPrice * (taxRatePc / 100);
+}
+exports.taxPayableOn = taxPayableOn;
+/**
+ * Given a net price, return the gross price (net + tax)
+ */
+function grossPriceOf(netPrice, taxRatePc) {
+    return netPrice + taxPayableOn(netPrice, taxRatePc);
+}
+exports.grossPriceOf = grossPriceOf;
+//# sourceMappingURL=tax-utils.js.map

package/dist/common/tax-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-utils.js","sourceRoot":"","sources":["../../src/common/tax-utils.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,SAAgB,cAAc,CAAC,UAAkB,EAAE,SAAiB;IAClE,OAAO,UAAU,GAAG,UAAU,GAAG,CAAC,CAAC,GAAG,GAAG,SAAS,CAAC,GAAG,GAAG,CAAC,CAAC;AAC7D,CAAC;AAFD,wCAEC;AAED;;GAEG;AACH,SAAgB,UAAU,CAAC,UAAkB,EAAE,SAAiB;IAC9D,OAAO,UAAU,GAAG,cAAc,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;AAC5D,CAAC;AAFD,gCAEC;AAED;;GAEG;AACH,SAAgB,YAAY,CAAC,QAAgB,EAAE,SAAiB;IAC9D,OAAO,QAAQ,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC;AACtC,CAAC;AAFD,oCAEC;AAED;;GAEG;AACH,SAAgB,YAAY,CAAC,QAAgB,EAAE,SAAiB;IAC9D,OAAO,QAAQ,GAAG,YAAY,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;AACtD,CAAC;AAFD,oCAEC"}

package/dist/common/ttl-cache.d.ts

@@ -0,0 +1,19 @@
+/**
+ * An in-memory cache with a configurable TTL (time to live) which means cache items
+ * expire after they have been in the cache longer than that time.
+ *
+ * The `ttl` config option is in milliseconds. Defaults to 30 seconds TTL and a cache size of 1000.
+ */
+export declare class TtlCache<K, V> {
+    private cache;
+    private readonly ttl;
+    private readonly cacheSize;
+    constructor(config?: {
+        ttl?: number;
+        cacheSize?: number;
+    });
+    get(key: K): V | undefined;
+    set(key: K, value: V): void;
+    delete(key: K): void;
+    private first;
+}

package/dist/common/ttl-cache.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TtlCache = void 0;
+/**
+ * An in-memory cache with a configurable TTL (time to live) which means cache items
+ * expire after they have been in the cache longer than that time.
+ *
+ * The `ttl` config option is in milliseconds. Defaults to 30 seconds TTL and a cache size of 1000.
+ */
+class TtlCache {
+    constructor(config) {
+        this.cache = new Map();
+        this.ttl = 30 * 1000;
+        this.cacheSize = 1000;
+        if (config === null || config === void 0 ? void 0 : config.ttl) {
+            this.ttl = config.ttl;
+        }
+        if (config === null || config === void 0 ? void 0 : config.cacheSize) {
+            this.cacheSize = config.cacheSize;
+        }
+    }
+    get(key) {
+        const hit = this.cache.get(key);
+        const now = new Date().getTime();
+        if (hit) {
+            if (now < hit.expires) {
+                return hit.value;
+            }
+            else {
+                this.cache.delete(key);
+            }
+        }
+    }
+    set(key, value) {
+        if (this.cache.has(key)) {
+            // delete key to put the item to the end of
+            // the cache, marking it as new again
+            this.cache.delete(key);
+        }
+        else if (this.cache.size === this.cacheSize) {
+            // evict oldest
+            this.cache.delete(this.first());
+        }
+        this.cache.set(key, {
+            value,
+            expires: new Date().getTime() + this.ttl,
+        });
+    }
+    delete(key) {
+        this.cache.delete(key);
+    }
+    first() {
+        return this.cache.keys().next().value;
+    }
+}
+exports.TtlCache = TtlCache;
+//# sourceMappingURL=ttl-cache.js.map

package/dist/common/ttl-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ttl-cache.js","sourceRoot":"","sources":["../../src/common/ttl-cache.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,MAAa,QAAQ;IAInB,YAAY,MAA6C;QAHjD,UAAK,GAAG,IAAI,GAAG,EAAoC,CAAC;QAC3C,QAAG,GAAW,EAAE,GAAG,IAAI,CAAC;QACxB,cAAS,GAAW,IAAI,CAAC;QAExC,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,EAAE,CAAC;YAChB,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;QACxB,CAAC;QACD,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,EAAE,CAAC;YACtB,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QACpC,CAAC;IACH,CAAC;IAED,GAAG,CAAC,GAAM;QACR,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACjC,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,GAAG,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;gBACtB,OAAO,GAAG,CAAC,KAAK,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACzB,CAAC;QACH,CAAC;IACH,CAAC;IAED,GAAG,CAAC,GAAM,EAAE,KAAQ;QAClB,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,2CAA2C;YAC3C,qCAAqC;YACrC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;aAAM,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9C,eAAe;YACf,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAClC,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YAClB,KAAK;YACL,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG;SACzC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,GAAM;QACX,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAEO,KAAK;QACX,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;IACxC,CAAC;CACF;AA/CD,4BA+CC"}

package/dist/common/types/adjustment-source.d.ts

@@ -0,0 +1,14 @@
+import { Adjustment, AdjustmentType } from "@deenruv/common/lib/generated-types";
+import { ID } from "@deenruv/common/lib/shared-types";
+import { DeenruvEntity } from "../../entity/base/base.entity";
+export type TestResult = boolean | object;
+export declare abstract class AdjustmentSource extends DeenruvEntity {
+    type: AdjustmentType;
+    getSourceId(): string;
+    static decodeSourceId(sourceId: string): {
+        type: AdjustmentType;
+        id: ID;
+    };
+    abstract test(...args: any[]): TestResult | Promise<TestResult>;
+    abstract apply(...args: any[]): Adjustment | undefined | Promise<Adjustment | undefined>;
+}

package/dist/common/types/adjustment-source.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdjustmentSource = void 0;
+const base_entity_1 = require("../../entity/base/base.entity");
+class AdjustmentSource extends base_entity_1.DeenruvEntity {
+    getSourceId() {
+        return `${this.type}:${this.id}`;
+    }
+    static decodeSourceId(sourceId) {
+        const [type, id] = sourceId.split(":");
+        return {
+            type: type,
+            id: Number.isNaN(+id) ? id : +id,
+        };
+    }
+}
+exports.AdjustmentSource = AdjustmentSource;
+//# sourceMappingURL=adjustment-source.js.map

package/dist/common/types/adjustment-source.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adjustment-source.js","sourceRoot":"","sources":["../../../src/common/types/adjustment-source.ts"],"names":[],"mappings":";;;AAMA,+DAA8D;AAI9D,MAAsB,gBAAiB,SAAQ,2BAAa;IAG1D,WAAW;QACT,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;IACnC,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,QAAgB;QACpC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,OAAO;YACL,IAAI,EAAE,IAAsB;YAC5B,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE;SACjC,CAAC;IACJ,CAAC;CAMF;AAnBD,4CAmBC"}