@acmekit/utils 2.13.1

package/dist/modules-sdk/definition.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModuleRegistrationName = exports.TEMPORARY_REDIS_MODULE_PACKAGE_NAMES = exports.REVERSED_MODULE_PACKAGE_NAMES = exports.MODULE_PACKAGE_NAMES = exports.Modules = void 0;
+exports.Modules = {
+    ANALYTICS: "analytics",
+    AUTH: "auth",
+    CACHE: "cache",
+    CART: "cart",
+    CUSTOMER: "customer",
+    EVENT_BUS: "event_bus",
+    INVENTORY: "inventory",
+    LINK: "link_modules",
+    PAYMENT: "payment",
+    PRICING: "pricing",
+    PRODUCT: "product",
+    PROMOTION: "promotion",
+    SALES_CHANNEL: "sales_channel",
+    TAX: "tax",
+    FULFILLMENT: "fulfillment",
+    STOCK_LOCATION: "stock_location",
+    USER: "user",
+    WORKFLOW_ENGINE: "workflows",
+    REGION: "region",
+    ORDER: "order",
+    API_KEY: "api_key",
+    STORE: "store",
+    CURRENCY: "currency",
+    FILE: "file",
+    NOTIFICATION: "notification",
+    INDEX: "index",
+    LOCKING: "locking",
+    SETTINGS: "settings",
+    CACHING: "caching",
+    TRANSLATION: "translation",
+    RBAC: "rbac",
+};
+exports.MODULE_PACKAGE_NAMES = {
+    [exports.Modules.ANALYTICS]: "@acmekit/acmekit/analytics",
+    [exports.Modules.AUTH]: "@acmekit/acmekit/auth",
+    [exports.Modules.CACHE]: "@acmekit/acmekit/cache-inmemory",
+    [exports.Modules.CART]: "@acmekit/acmekit/cart",
+    [exports.Modules.CUSTOMER]: "@acmekit/acmekit/customer",
+    [exports.Modules.EVENT_BUS]: "@acmekit/acmekit/event-bus-local",
+    [exports.Modules.INVENTORY]: "@acmekit/acmekit/inventory",
+    [exports.Modules.LINK]: "@acmekit/acmekit/link-modules",
+    [exports.Modules.PAYMENT]: "@acmekit/acmekit/payment",
+    [exports.Modules.PRICING]: "@acmekit/acmekit/pricing",
+    [exports.Modules.PRODUCT]: "@acmekit/acmekit/product",
+    [exports.Modules.PROMOTION]: "@acmekit/acmekit/promotion",
+    [exports.Modules.SALES_CHANNEL]: "@acmekit/acmekit/sales-channel",
+    [exports.Modules.FULFILLMENT]: "@acmekit/acmekit/fulfillment",
+    [exports.Modules.STOCK_LOCATION]: "@acmekit/acmekit/stock-location",
+    [exports.Modules.TAX]: "@acmekit/acmekit/tax",
+    [exports.Modules.USER]: "@acmekit/acmekit/user",
+    [exports.Modules.WORKFLOW_ENGINE]: "@acmekit/acmekit/workflow-engine-inmemory",
+    [exports.Modules.REGION]: "@acmekit/acmekit/region",
+    [exports.Modules.ORDER]: "@acmekit/acmekit/order",
+    [exports.Modules.API_KEY]: "@acmekit/acmekit/api-key",
+    [exports.Modules.STORE]: "@acmekit/acmekit/store",
+    [exports.Modules.CURRENCY]: "@acmekit/acmekit/currency",
+    [exports.Modules.FILE]: "@acmekit/acmekit/file",
+    [exports.Modules.NOTIFICATION]: "@acmekit/acmekit/notification",
+    [exports.Modules.INDEX]: "@acmekit/acmekit/index-module",
+    [exports.Modules.LOCKING]: "@acmekit/acmekit/locking",
+    [exports.Modules.SETTINGS]: "@acmekit/acmekit/settings",
+    [exports.Modules.CACHING]: "@acmekit/acmekit/caching",
+    [exports.Modules.TRANSLATION]: "@acmekit/acmekit/translation",
+    [exports.Modules.RBAC]: "@acmekit/acmekit/rbac",
+};
+exports.REVERSED_MODULE_PACKAGE_NAMES = Object.entries(exports.MODULE_PACKAGE_NAMES).reduce((acc, [key, value]) => {
+    acc[value] = key;
+    return acc;
+}, {});
+// TODO: temporary fix until the event bus, cache and workflow engine are migrated to use providers and therefore only a single resolution will be good
+exports.TEMPORARY_REDIS_MODULE_PACKAGE_NAMES = {
+    [exports.Modules.EVENT_BUS]: "@acmekit/acmekit/event-bus-redis",
+    [exports.Modules.CACHE]: "@acmekit/acmekit/cache-redis",
+    [exports.Modules.WORKFLOW_ENGINE]: "@acmekit/acmekit/workflow-engine-redis",
+    [exports.Modules.LOCKING]: "@acmekit/acmekit/locking-redis",
+};
+exports.REVERSED_MODULE_PACKAGE_NAMES[exports.TEMPORARY_REDIS_MODULE_PACKAGE_NAMES[exports.Modules.EVENT_BUS]] = exports.Modules.EVENT_BUS;
+exports.REVERSED_MODULE_PACKAGE_NAMES[exports.TEMPORARY_REDIS_MODULE_PACKAGE_NAMES[exports.Modules.CACHE]] = exports.Modules.CACHE;
+exports.REVERSED_MODULE_PACKAGE_NAMES[exports.TEMPORARY_REDIS_MODULE_PACKAGE_NAMES[exports.Modules.WORKFLOW_ENGINE]] = exports.Modules.WORKFLOW_ENGINE;
+exports.REVERSED_MODULE_PACKAGE_NAMES[exports.TEMPORARY_REDIS_MODULE_PACKAGE_NAMES[exports.Modules.LOCKING]] = exports.Modules.LOCKING;
+exports.ModuleRegistrationName = exports.Modules;
+//# sourceMappingURL=definition.js.map

package/dist/modules-sdk/definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition.js","sourceRoot":"","sources":["../../src/modules-sdk/definition.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG;IACrB,SAAS,EAAE,WAAW;IACtB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,IAAI,EAAE,cAAc;IACpB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,aAAa,EAAE,eAAe;IAC9B,GAAG,EAAE,KAAK;IACV,WAAW,EAAE,aAAa;IAC1B,cAAc,EAAE,gBAAgB;IAChC,IAAI,EAAE,MAAM;IACZ,eAAe,EAAE,WAAW;IAC5B,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,cAAc;IAC5B,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;IAC1B,IAAI,EAAE,MAAM;CACJ,CAAA;AAEG,QAAA,oBAAoB,GAAG;IAClC,CAAC,eAAO,CAAC,SAAS,CAAC,EAAE,4BAA4B;IACjD,CAAC,eAAO,CAAC,IAAI,CAAC,EAAE,uBAAuB;IACvC,CAAC,eAAO,CAAC,KAAK,CAAC,EAAE,iCAAiC;IAClD,CAAC,eAAO,CAAC,IAAI,CAAC,EAAE,uBAAuB;IACvC,CAAC,eAAO,CAAC,QAAQ,CAAC,EAAE,2BAA2B;IAC/C,CAAC,eAAO,CAAC,SAAS,CAAC,EAAE,kCAAkC;IACvD,CAAC,eAAO,CAAC,SAAS,CAAC,EAAE,4BAA4B;IACjD,CAAC,eAAO,CAAC,IAAI,CAAC,EAAE,+BAA+B;IAC/C,CAAC,eAAO,CAAC,OAAO,CAAC,EAAE,0BAA0B;IAC7C,CAAC,eAAO,CAAC,OAAO,CAAC,EAAE,0BAA0B;IAC7C,CAAC,eAAO,CAAC,OAAO,CAAC,EAAE,0BAA0B;IAC7C,CAAC,eAAO,CAAC,SAAS,CAAC,EAAE,4BAA4B;IACjD,CAAC,eAAO,CAAC,aAAa,CAAC,EAAE,gCAAgC;IACzD,CAAC,eAAO,CAAC,WAAW,CAAC,EAAE,8BAA8B;IACrD,CAAC,eAAO,CAAC,cAAc,CAAC,EAAE,iCAAiC;IAC3D,CAAC,eAAO,CAAC,GAAG,CAAC,EAAE,sBAAsB;IACrC,CAAC,eAAO,CAAC,IAAI,CAAC,EAAE,uBAAuB;IACvC,CAAC,eAAO,CAAC,eAAe,CAAC,EAAE,2CAA2C;IACtE,CAAC,eAAO,CAAC,MAAM,CAAC,EAAE,yBAAyB;IAC3C,CAAC,eAAO,CAAC,KAAK,CAAC,EAAE,wBAAwB;IACzC,CAAC,eAAO,CAAC,OAAO,CAAC,EAAE,0BAA0B;IAC7C,CAAC,eAAO,CAAC,KAAK,CAAC,EAAE,wBAAwB;IACzC,CAAC,eAAO,CAAC,QAAQ,CAAC,EAAE,2BAA2B;IAC/C,CAAC,eAAO,CAAC,IAAI,CAAC,EAAE,uBAAuB;IACvC,CAAC,eAAO,CAAC,YAAY,CAAC,EAAE,+BAA+B;IACvD,CAAC,eAAO,CAAC,KAAK,CAAC,EAAE,+BAA+B;IAChD,CAAC,eAAO,CAAC,OAAO,CAAC,EAAE,0BAA0B;IAC7C,CAAC,eAAO,CAAC,QAAQ,CAAC,EAAE,2BAA2B;IAC/C,CAAC,eAAO,CAAC,OAAO,CAAC,EAAE,0BAA0B;IAC7C,CAAC,eAAO,CAAC,WAAW,CAAC,EAAE,8BAA8B;IACrD,CAAC,eAAO,CAAC,IAAI,CAAC,EAAE,uBAAuB;CACxC,CAAA;AAEY,QAAA,6BAA6B,GAAG,MAAM,CAAC,OAAO,CACzD,4BAAoB,CACrB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;IAC7B,GAAG,CAAC,KAAK,CAAC,GAAG,GAAG,CAAA;IAChB,OAAO,GAAG,CAAA;AACZ,CAAC,EAAE,EAAE,CAAC,CAAA;AAEN,uJAAuJ;AAC1I,QAAA,oCAAoC,GAAG;IAClD,CAAC,eAAO,CAAC,SAAS,CAAC,EAAE,kCAAkC;IACvD,CAAC,eAAO,CAAC,KAAK,CAAC,EAAE,8BAA8B;IAC/C,CAAC,eAAO,CAAC,eAAe,CAAC,EAAE,wCAAwC;IACnE,CAAC,eAAO,CAAC,OAAO,CAAC,EAAE,gCAAgC;CACpD,CAAA;AAED,qCAA6B,CAC3B,4CAAoC,CAAC,eAAO,CAAC,SAAS,CAAC,CACxD,GAAG,eAAO,CAAC,SAAS,CAAA;AACrB,qCAA6B,CAC3B,4CAAoC,CAAC,eAAO,CAAC,KAAK,CAAC,CACpD,GAAG,eAAO,CAAC,KAAK,CAAA;AACjB,qCAA6B,CAC3B,4CAAoC,CAAC,eAAO,CAAC,eAAe,CAAC,CAC9D,GAAG,eAAO,CAAC,eAAe,CAAA;AAC3B,qCAA6B,CAC3B,4CAAoC,CAAC,eAAO,CAAC,OAAO,CAAC,CACtD,GAAG,eAAO,CAAC,OAAO,CAAA;AAMN,QAAA,sBAAsB,GAAG,eAAO,CAAA"}

package/dist/modules-sdk/event-builder-factory.d.ts

@@ -0,0 +1,37 @@
+import { Context } from "@acmekit/types";
+/**
+ *
+ * Factory function to create event builders for different entities
+ *
+ * @example
+ * const createdFulfillment = moduleEventBuilderFactory({
+ *   source: Modules.FULFILLMENT,
+ *   action: CommonEvents.CREATED,
+ *   object: "fulfillment",
+ *   eventsEnum: FulfillmentEvents,
+ * })
+ *
+ * createdFulfillment({
+ *   data,
+ *   sharedContext,
+ * })
+ *
+ * @param action
+ * @param object
+ * @param eventsEnum
+ * @param service
+ */
+export declare function moduleEventBuilderFactory({ action, object, eventName, source, }: {
+    action: string;
+    object: string;
+    eventName?: string;
+    source: string;
+}): ({ data, sharedContext, }: {
+    data: {
+        id: string;
+    } | {
+        id: string;
+    }[];
+    sharedContext: Context;
+}) => void;
+//# sourceMappingURL=event-builder-factory.d.ts.map

package/dist/modules-sdk/event-builder-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-builder-factory.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/event-builder-factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAiB,MAAM,gBAAgB,CAAA;AAKvD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,yBAAyB,CAAC,EACxC,MAAM,EACN,MAAM,EACN,SAAS,EACT,MAAM,GACP,EAAE;IACD,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;CACf,IACkB,0BAGd;IACD,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACvC,aAAa,EAAE,OAAO,CAAA;CACvB,UA+BF"}

package/dist/modules-sdk/event-builder-factory.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.moduleEventBuilderFactory = moduleEventBuilderFactory;
+const utils_1 = require("../event-bus/utils");
+// TODO should that move closer to the event bus? and maybe be rename to modulemoduleEventBuilderFactory
+/**
+ *
+ * Factory function to create event builders for different entities
+ *
+ * @example
+ * const createdFulfillment = moduleEventBuilderFactory({
+ *   source: Modules.FULFILLMENT,
+ *   action: CommonEvents.CREATED,
+ *   object: "fulfillment",
+ *   eventsEnum: FulfillmentEvents,
+ * })
+ *
+ * createdFulfillment({
+ *   data,
+ *   sharedContext,
+ * })
+ *
+ * @param action
+ * @param object
+ * @param eventsEnum
+ * @param service
+ */
+function moduleEventBuilderFactory({ action, object, eventName, source, }) {
+    return function ({ data, sharedContext, }) {
+        data = Array.isArray(data) ? data : [data];
+        if (!data.length) {
+            return;
+        }
+        const aggregator = sharedContext.messageAggregator;
+        const messages = [];
+        if (!eventName) {
+            eventName = (0, utils_1.buildModuleResourceEventName)({
+                prefix: source,
+                objectName: object,
+                action,
+            });
+        }
+        messages.push({
+            source,
+            action,
+            context: sharedContext,
+            data: {
+                id: data.length === 1 ? data[0].id : data.map((item) => item.id),
+            },
+            eventName: eventName,
+            object,
+        });
+        aggregator.saveRawMessageData(messages);
+    };
+}
+//# sourceMappingURL=event-builder-factory.js.map

package/dist/modules-sdk/event-builder-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-builder-factory.js","sourceRoot":"","sources":["../../src/modules-sdk/event-builder-factory.ts"],"names":[],"mappings":";;AA2BA,8DAgDC;AA1ED,8CAAiE;AAEjE,wGAAwG;AAExG;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,yBAAyB,CAAC,EACxC,MAAM,EACN,MAAM,EACN,SAAS,EACT,MAAM,GAMP;IACC,OAAO,UAAU,EACf,IAAI,EACJ,aAAa,GAId;QACC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QAE1C,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,OAAM;QACR,CAAC;QAED,MAAM,UAAU,GAAG,aAAa,CAAC,iBAAkB,CAAA;QACnD,MAAM,QAAQ,GAAqC,EAAE,CAAA;QAErD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS,GAAG,IAAA,oCAA4B,EAAC;gBACvC,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE,MAAM;gBAClB,MAAM;aACP,CAAC,CAAA;QACJ,CAAC;QAED,QAAQ,CAAC,IAAI,CAAC;YACZ,MAAM;YACN,MAAM;YACN,OAAO,EAAE,aAAa;YACtB,IAAI,EAAE;gBACJ,EAAE,EAAE,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;aACjE;YACD,SAAS,EAAE,SAAU;YACrB,MAAM;SACP,CAAC,CAAA;QAEF,UAAU,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAA;IACzC,CAAC,CAAA;AACH,CAAC"}

package/dist/modules-sdk/index.d.ts

@@ -0,0 +1,27 @@
+export * from "./build-query";
+export * from "./create-acmekit-mikro-orm-event-subscriber";
+export * from "./create-pg-connection";
+export * from "./decorators";
+export * from "./define-link";
+export * from "./define-policies";
+export * from "./definition";
+export * from "./event-builder-factory";
+export * from "./joiner-config-builder";
+export * from "./load-module-database-config";
+export * from "./loaders/container-loader-factory";
+export * from "./loaders/load-models";
+export * from "./loaders/mikro-orm-connection-loader";
+export * from "./loaders/mikro-orm-connection-loader-factory";
+export * from "./acmekit-internal-service";
+export * from "./acmekit-service";
+export * from "./migration-scripts";
+export * from "./mikro-orm-cli-config-builder";
+export * from "./module";
+export * from "./module-provider";
+export * from "./module-provider-registration-key";
+export * from "./modules-to-container-types";
+export * from "./policy-to-types";
+export * from "./query-context";
+export * from "./types/links-config";
+export * from "./types/acmekit-service";
+//# sourceMappingURL=index.d.ts.map

package/dist/modules-sdk/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,6CAA6C,CAAA;AAC3D,cAAc,wBAAwB,CAAA;AACtC,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,cAAc,CAAA;AAC5B,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,oCAAoC,CAAA;AAClD,cAAc,uBAAuB,CAAA;AACrC,cAAc,uCAAuC,CAAA;AACrD,cAAc,+CAA+C,CAAA;AAC7D,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mBAAmB,CAAA;AACjC,cAAc,qBAAqB,CAAA;AACnC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,oCAAoC,CAAA;AAClD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,sBAAsB,CAAA;AACpC,cAAc,yBAAyB,CAAA"}

package/dist/modules-sdk/index.js

@@ -0,0 +1,43 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./build-query"), exports);
+__exportStar(require("./create-acmekit-mikro-orm-event-subscriber"), exports);
+__exportStar(require("./create-pg-connection"), exports);
+__exportStar(require("./decorators"), exports);
+__exportStar(require("./define-link"), exports);
+__exportStar(require("./define-policies"), exports);
+__exportStar(require("./definition"), exports);
+__exportStar(require("./event-builder-factory"), exports);
+__exportStar(require("./joiner-config-builder"), exports);
+__exportStar(require("./load-module-database-config"), exports);
+__exportStar(require("./loaders/container-loader-factory"), exports);
+__exportStar(require("./loaders/load-models"), exports);
+__exportStar(require("./loaders/mikro-orm-connection-loader"), exports);
+__exportStar(require("./loaders/mikro-orm-connection-loader-factory"), exports);
+__exportStar(require("./acmekit-internal-service"), exports);
+__exportStar(require("./acmekit-service"), exports);
+__exportStar(require("./migration-scripts"), exports);
+__exportStar(require("./mikro-orm-cli-config-builder"), exports);
+__exportStar(require("./module"), exports);
+__exportStar(require("./module-provider"), exports);
+__exportStar(require("./module-provider-registration-key"), exports);
+__exportStar(require("./modules-to-container-types"), exports);
+__exportStar(require("./policy-to-types"), exports);
+__exportStar(require("./query-context"), exports);
+__exportStar(require("./types/links-config"), exports);
+__exportStar(require("./types/acmekit-service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/modules-sdk/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/modules-sdk/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA6B;AAC7B,8EAA2D;AAC3D,yDAAsC;AACtC,+CAA4B;AAC5B,gDAA6B;AAC7B,oDAAiC;AACjC,+CAA4B;AAC5B,0DAAuC;AACvC,0DAAuC;AACvC,gEAA6C;AAC7C,qEAAkD;AAClD,wDAAqC;AACrC,wEAAqD;AACrD,gFAA6D;AAC7D,6DAA0C;AAC1C,oDAAiC;AACjC,sDAAmC;AACnC,iEAA8C;AAC9C,2CAAwB;AACxB,oDAAiC;AACjC,qEAAkD;AAClD,+DAA4C;AAC5C,oDAAiC;AACjC,kDAA+B;AAC/B,uDAAoC;AACpC,0DAAuC"}

package/dist/modules-sdk/joiner-config-builder.d.ts

@@ -0,0 +1,121 @@
+import { IDmlEntity, JoinerServiceConfigAlias, ModuleJoinerConfig } from "@acmekit/types";
+import { MapToConfig } from "../common";
+import { DmlEntity } from "../dml";
+import { InferLinkableKeys, InfersLinksConfig } from "./types/links-config";
+/**
+ * Define joiner config for a module based on the models (object representation or entities) present in the models directory. This action will be sync until
+ * we move to at least es2022 to have access to top-leve await.
+ *
+ * The aliases will be built from the entityQueryingConfig and custom aliases if provided, in case of aliases provided if the methodSuffix is not provided
+ * then it will be inferred from the entity name of the alias args.
+ *
+ * @param serviceName
+ * @param alias custom aliases will be merged with the computed aliases from the provided models. Though, if a custom alias correspond to a computed alias for the same model then the custom alias will take place. Also, note that the methodSuffix will be inferred from the entity name if not provided as part of the args.
+ * @param schema
+ * @param models
+ * @param linkableKeys
+ * @param primaryKeys
+ */
+export declare function defineJoinerConfig(serviceName: string, { alias, schema, models, linkableKeys, primaryKeys, idPrefixToEntityName, }?: {
+    alias?: JoinerServiceConfigAlias[];
+    idPrefixToEntityName?: Record<string, string>;
+    schema?: string;
+    models?: DmlEntity<any, any>[] | {
+        name: string;
+    }[];
+    linkableKeys?: ModuleJoinerConfig["linkableKeys"];
+    primaryKeys?: string[];
+}): Omit<ModuleJoinerConfig, "serviceName" | "primaryKeys" | "linkableKeys" | "alias"> & Required<Pick<ModuleJoinerConfig, "serviceName" | "primaryKeys" | "linkableKeys" | "alias">>;
+/**
+ * Build the id prefix to entity name map from the DML objects
+ * @param models
+ */
+export declare function buildIdPrefixToEntityNameFromDmlObjects(models: DmlEntity<any, any>[]): Record<string, string>;
+/**
+ * From a set of DML objects, build the linkable keys
+ *
+ * @example
+ * const user = model.define("user", {
+ *   id: model.id(),
+ *   name: model.text(),
+ * })
+ *
+ * const car = model.define("car", {
+ *   id: model.id(),
+ *   number_plate: model.text().primaryKey(),
+ *   test: model.text(),
+ * })
+ *
+ * const linkableKeys = buildLinkableKeysFromDmlObjects([user, car])
+ *
+ * // output:
+ * // {
+ * //   user_id: 'User',
+ * //   car_number_plate: 'Car',
+ * // }
+ *
+ * @param models
+ */
+export declare function buildLinkableKeysFromDmlObjects<const T extends DmlEntity<any, any>[], LinkableKeys = InferLinkableKeys<T>>(models: T): LinkableKeys;
+/**
+ * Build linkable keys from MikroORM objects
+ * @deprecated
+ * @param models
+ */
+export declare function buildLinkableKeysFromMikroOrmObjects(models: Function[]): Record<string, string>;
+/**
+ * Build entities name to linkable keys map
+ *
+ * @example
+ * const user = model.define("user", {
+ *   id: model.id(),
+ *   name: model.text(),
+ * })
+ *
+ * const car = model.define("car", {
+ *   id: model.id(),
+ *   number_plate: model.text().primaryKey(),
+ *   test: model.text(),
+ * })
+ *
+ * const links = buildLinkConfigFromModelObjects('userService', { user, car })
+ *
+ * // output:
+ * // {
+ * //   user: {
+ * //     id: {
+ * //       serviceName: 'userService', // The name of the module service it originate from
+ * //       field: 'user',              // The field name of the entity, the query field is inferred from it as kebab cased singular/plural
+ * //       linkable: 'user_id',        // The linkable key
+ * //       primaryKey: 'id'            // The primary key if refers to in the original object representation, it will be used to be passed to the filters of the corresponding public service method
+ * //     },
+ * //     toJSON() { ... }
+ * //   },
+ * //   car: {
+ * //     number_plate: {
+ * //       serviceName: 'userService',
+ * //       field: 'car',
+ * //       linkable: 'car_number_plate',
+ * //       primaryKey: 'number_plate'
+ * //     },
+ * //     toJSON() { ... }
+ * //   }
+ * // }
+ *
+ * @param serviceName
+ * @param models
+ */
+export declare function buildLinkConfigFromModelObjects<const ServiceName extends string, const T extends Record<string, IDmlEntity<any, any>>>(serviceName: ServiceName, models: T, linkableKeys?: Record<string, string>): InfersLinksConfig<ServiceName, T>;
+/**
+ * @deprecated temporary supports for mikro orm entities to get the linkable available from the module export while waiting for the migration to DML
+ *
+ * @param serviceName
+ * @param linkableKeys
+ */
+export declare function buildLinkConfigFromLinkableKeys<const ServiceName extends string, const T extends Record<string, string>>(serviceName: ServiceName, linkableKeys: T): Record<string, any>;
+/**
+ * Reversed map from linkableKeys to entity name to linkable keys
+ * @param linkableKeys
+ */
+export declare function buildModelsNameToLinkableKeysMap(linkableKeys: Record<string, string>): MapToConfig;
+//# sourceMappingURL=joiner-config-builder.d.ts.map

package/dist/modules-sdk/joiner-config-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"joiner-config-builder.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/joiner-config-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,wBAAwB,EACxB,kBAAkB,EAEnB,MAAM,gBAAgB,CAAA;AAIvB,OAAO,EAKL,WAAW,EAIZ,MAAM,WAAW,CAAA;AAClB,OAAO,EAAE,SAAS,EAAc,MAAM,QAAQ,CAAA;AAK9C,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAE3E;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,MAAM,EACnB,EACE,KAAK,EACL,MAAM,EACN,MAAM,EACN,YAAY,EACZ,WAAW,EACX,oBAAoB,GACrB,GAAE;IACD,KAAK,CAAC,EAAE,wBAAwB,EAAE,CAAA;IAClC,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACnD,YAAY,CAAC,EAAE,kBAAkB,CAAC,cAAc,CAAC,CAAA;IACjD,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB,GACL,IAAI,CACL,kBAAkB,EAClB,aAAa,GAAG,aAAa,GAAG,cAAc,GAAG,OAAO,CACzD,GACC,QAAQ,CACN,IAAI,CACF,kBAAkB,EAClB,aAAa,GAAG,aAAa,GAAG,cAAc,GAAG,OAAO,CACzD,CACF,CA6KF;AAED;;;GAGG;AACH,wBAAgB,uCAAuC,CACrD,MAAM,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,GAC5B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAiBxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,+BAA+B,CAC7C,KAAK,CAAC,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EACrC,YAAY,GAAG,iBAAiB,CAAC,CAAC,CAAC,EACnC,MAAM,EAAE,CAAC,GAAG,YAAY,CAiCzB;AAED;;;;GAIG;AACH,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,QAAQ,EAAE,GACjB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAKxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,+BAA+B,CAC7C,KAAK,CAAC,WAAW,SAAS,MAAM,EAChC,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAEpD,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,CAAC,EACT,YAAY,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GACxC,iBAAiB,CAAC,WAAW,EAAE,CAAC,CAAC,CAgGnC;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAC7C,KAAK,CAAC,WAAW,SAAS,MAAM,EAChC,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACtC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CA2BhE;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAC9C,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACnC,WAAW,CAUb"}