@acmekit/types 2.13.1

package/dist/store/mutations/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../src/store/mutations/store.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,oBAAoB,CAAC,EAAE,sBAAsB,EAAE,CAAA;IAE/C;;OAEG;IACH,iBAAiB,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAE1C;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAA;IAEjC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,oBAAoB,CAAC,EAAE,sBAAsB,EAAE,CAAA;IAE/C;;OAEG;IACH,iBAAiB,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAE1C;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEjC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC"}

package/dist/store/mutations/store.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=store.js.map

package/dist/store/mutations/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../../../src/store/mutations/store.ts"],"names":[],"mappings":""}

package/dist/store/service.d.ts

@@ -0,0 +1,245 @@
+import { FindConfig } from "../common";
+import { RestoreReturn, SoftDeleteReturn } from "../dal";
+import { IModuleService } from "../modules-sdk";
+import { Context } from "../shared-context";
+import { FilterableStoreProps, StoreDTO } from "./common";
+import { CreateStoreDTO, UpdateStoreDTO, UpsertStoreDTO } from "./mutations";
+/**
+ * The main service interface for the Store Module.
+ */
+export interface IStoreModuleService extends IModuleService {
+    /**
+     * This method creates stores.
+     *
+     * @param {CreateStoreDTO[]} data - The stores to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<StoreDTO[]>} The created stores.
+     *
+     * @example
+     * const stores = await storeModuleService.createStores([
+     *   {
+     *     name: "Acme",
+     *     supported_currencies: [{ currency_code: "usd", is_default: true }, { currency_code: "eur" }],
+     *   },
+     *   {
+     *     name: "Acme 2",
+     *     supported_currencies: [{currency_code: "usd", is_default: true}],
+     *   },
+     * ])
+     */
+    createStores(data: CreateStoreDTO[], sharedContext?: Context): Promise<StoreDTO[]>;
+    /**
+     * This method creates a store.
+     *
+     * @param {CreateStoreDTO} data - The store to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<StoreDTO>} The created store.
+     *
+     * @example
+     * const store = await storeModuleService.createStores({
+     *   name: "Acme",
+     *   supported_currencies: [{ currency_code: "usd", is_default: true }, { currency_code: "eur" }],
+     * })
+     */
+    createStores(data: CreateStoreDTO, sharedContext?: Context): Promise<StoreDTO>;
+    /**
+     * This method updates or creates stores if they don't exist.
+     *
+     * @param {UpsertStoreDTO[]} data - The attributes in the stores to be created or updated.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<StoreDTO[]>} The created or updated stores.
+     *
+     * @example
+     * const stores = await storeModuleService.upsertStores([
+     *   {
+     *     id: "store_123",
+     *     name: "Acme",
+     *   },
+     *   {
+     *     name: "Acme 2",
+     *     supported_currencies: [{currency_code: "usd", is_default: true}],
+     *   },
+     * ])
+     */
+    upsertStores(data: UpsertStoreDTO[], sharedContext?: Context): Promise<StoreDTO[]>;
+    /**
+     * This method updates or creates a store if it doesn't exist.
+     *
+     * @param {UpsertStoreDTO} data - The attributes in the store to be created or updated.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<StoreDTO>} The created or updated store.
+     *
+     * @example
+     * const store = await storeModuleService.upsertStores({
+     *   id: "store_123",
+     *   name: "Acme",
+     * })
+     */
+    upsertStores(data: UpsertStoreDTO, sharedContext?: Context): Promise<StoreDTO>;
+    /**
+     * This method updates an existing store.
+     *
+     * @param {string} id - The ID of the store.
+     * @param {UpdateStoreDTO} data - The attributes to update in the store.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<StoreDTO>} The updated store.
+     *
+     * @example
+     * const store = await storeModuleService.updateStores("store_123", {
+     *   name: "Acme",
+     * })
+     */
+    updateStores(id: string, data: UpdateStoreDTO, sharedContext?: Context): Promise<StoreDTO>;
+    /**
+     * This method updates existing stores matching the specified filters.
+     *
+     * @param {FilterableStoreProps} selector - The filters specifying which stores to update.
+     * @param {UpdateStoreDTO} data - The attributes to update in the store.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<StoreDTO[]>} The updated stores.
+     *
+     * @example
+     * const store = await storeModuleService.updateStores(
+     *   {
+     *     name: ["Acme"],
+     *   },
+     *   {
+     *   }
+     * )
+     */
+    updateStores(selector: FilterableStoreProps, data: UpdateStoreDTO, sharedContext?: Context): Promise<StoreDTO[]>;
+    /**
+     * This method deletes stores by their IDs.
+     *
+     * @param {string[]} ids - The IDs of the stores.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the stores are deleted successfully.
+     *
+     * @example
+     * await storeModuleService.deleteStores(["store_123", "store_321"])
+     */
+    deleteStores(ids: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method deletes a store by its ID.
+     *
+     * @param {string} id - The ID of the store.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the store is deleted successfully.
+     *
+     * @example
+     * await storeModuleService.deleteStores("store_123")
+     */
+    deleteStores(id: string, sharedContext?: Context): Promise<void>;
+    /**
+     * This method retrieves a store by its ID.
+     *
+     * @param {string} id - The ID of the store.
+     * @param {FindConfig<StoreDTO>} config - The configurations determining how the store is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a store.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<StoreDTO>} The retrieved store.
+     *
+     * @example
+     * const store = await storeModuleService.retrieveStore("store_123")
+     */
+    retrieveStore(id: string, config?: FindConfig<StoreDTO>, sharedContext?: Context): Promise<StoreDTO>;
+    /**
+     * This method retrieves a paginated list of stores based on optional filters and configuration.
+     *
+     * @param {FilterableStoreProps} filters - The filters to apply on the retrieved stores.
+     * @param {FindConfig<StoreDTO>} config - The configurations determining how the store is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a store.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<StoreDTO[]>} The list of stores.
+     *
+     * @example
+     * To retrieve a list of stores using their IDs:
+     *
+     * ```ts
+     * const stores = await storeModuleService.listStores({
+     *   id: ["store_123", "store_321"],
+     * })
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const stores = await storeModuleService.listStores(
+     *   {
+     *     id: ["store_123", "store_321"],
+     *   },
+     *   {
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
+    listStores(filters?: FilterableStoreProps, config?: FindConfig<StoreDTO>, sharedContext?: Context): Promise<StoreDTO[]>;
+    /**
+     * This method retrieves a paginated list of stores along with the total count of available stores satisfying the provided filters.
+     *
+     * @param {FilterableStoreProps} filters - The filters to apply on the retrieved stores.
+     * @param {FindConfig<StoreDTO>} config - The configurations determining how the store is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a store.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<[StoreDTO[], number]>} The list of stores along with their total count.
+     *
+     * @example
+     * To retrieve a list of stores using their IDs:
+     *
+     * ```ts
+     * const [stores, count] = await storeModuleService.listAndCountStores(
+     *   {
+     *     id: ["store_123", "store_321"],
+     *   }
+     * )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const [stores, count] = await storeModuleService.listAndCountStores(
+     *   {
+     *     id: ["store_123", "store_321"],
+     *   },
+     *   {
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
+    listAndCountStores(filters?: FilterableStoreProps, config?: FindConfig<StoreDTO>, sharedContext?: Context): Promise<[StoreDTO[], number]>;
+    /**
+     * This method soft deletes a store by its IDs.
+     *
+     * @param {string[]} storeIds - The IDs of the stores.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted.
+     * If there are no related records, the promise resolves to `void`.
+     *
+     * @example
+     * await storeModuleService.softDeleteStores([
+     *   "store_123",
+     *   "store_321",
+     * ])
+     */
+    softDeleteStores<TReturnableLinkableKeys extends string = string>(storeIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method restores a soft deleted store by its IDs.
+     *
+     * @param {string[]} storeIds - The IDs of the stores.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the store. You can pass to its `returnLinkableKeys`
+     * property any of the store's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
+     * If there are no related records restored, the promise resolves to `void`.
+     *
+     * @example
+     * await storeModuleService.restoreStores(["store_123", "store_321"])
+     */
+    restoreStores<TReturnableLinkableKeys extends string = string>(storeIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+}
+//# sourceMappingURL=service.d.ts.map

package/dist/store/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/store/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACzD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAE5E;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,cAAc;IACzD;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CACV,IAAI,EAAE,cAAc,EAAE,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAA;IAEtB;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,IAAI,EAAE,cAAc,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE9E;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CACV,IAAI,EAAE,cAAc,EAAE,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAA;IAEtB;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,IAAI,EAAE,cAAc,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE9E;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,cAAc,EACpB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,QAAQ,CAAC,CAAA;IAEpB;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CACV,QAAQ,EAAE,oBAAoB,EAC9B,IAAI,EAAE,cAAc,EACpB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAA;IAEtB;;;;;;;;;OASG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEnE;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhE;;;;;;;;;;;OAWG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,QAAQ,CAAC,CAAA;IAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,UAAU,CACR,OAAO,CAAC,EAAE,oBAAoB,EAC9B,MAAM,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAA;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,kBAAkB,CAChB,OAAO,CAAC,EAAE,oBAAoB,EAC9B,MAAM,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEhC;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC9D,QAAQ,EAAE,MAAM,EAAE,EAClB,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC3D,QAAQ,EAAE,MAAM,EAAE,EAClB,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;CAC5C"}

package/dist/store/service.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=service.js.map

package/dist/store/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../src/store/service.ts"],"names":[],"mappings":""}