@medusajs/types 3.0.0-preview-20250211091350 → 3.0.0-preview-20250406180144

package/dist/locking/index.d.ts

@@ -1,35 +1,501 @@
 import { Context } from "../shared-context";
+/**
+ * ### constructor
+ *
+ * The constructor allows you to access resources from the module's container using the first parameter,
+ * and the module's options using the second parameter.
+ *
+ * If you're creating a client or establishing a connection with a third-party service, do it in the constructor.
+ *
+ * #### Example
+ *
+ * ```ts
+ * import { ILockingProvider } from "@medusajs/framework/types"
+ * import { Logger } from "@medusajs/framework/types"
+ *
+ * type InjectedDependencies = {
+ *   logger: Logger
+ * }
+ *
+ * type Options = {
+ *   url: string
+ * }
+ *
+ * class MyLockingProviderService implements ILockingProvider {
+ *   static identifier = "my-lock"
+ *   protected logger_: Logger
+ *   protected options_: Options
+ *   // assuming you're initializing a client
+ *   protected client
+ *
+ *   constructor (
+ *     { logger }: InjectedDependencies,
+ *     options: Options
+ *   ) {
+ *     this.logger_ = logger
+ *     this.options_ = options
+ *
+ *     // assuming you're initializing a client
+ *     this.client = new Client(options)
+ *   }
+ *
+ *   // ...
+ * }
+ *
+ * export default MyLockingProviderService
+ * ```
+ *
+ * ### Identifier
+ *
+ * Every locking module provider must have an `identifier` static property. The provider's ID
+ * will be stored as `lp_{identifier}`.
+ *
+ * For example:
+ *
+ * ```ts
+ * class MyLockingProviderService implements ILockingProvider {
+ *   static identifier = "my-lock"
+ *   // ...
+ * }
+ * ```
+ */
 export interface ILockingProvider {
+    /**
+     * This method executes a given asynchronous job with a lock on the given keys. The Locking Module uses this method
+     * when you call its `execute` method and your provider is the default provider, or you pass your provider's identifier to its `execute` method.
+     *
+     * In the method, you should first try to acquire the lock on the given keys before the specified timeout passes.
+     * Then, once the lock is acquired, you execute the job. Otherwise, if the timeout passes before the lock is acquired, you cancel the job.
+     *
+     * @param keys - The keys to lock during the job's execution.
+     * @param job - The asynchronous job to execute while the keys are locked.
+     * @param args - Additional arguments for the job execution.
+     * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns The result of the job.
+     * @typeParam T - The type of the job's result.
+     *
+     * @example
+     * An example of how to implement the `execute` method:
+     *
+     * ```ts
+     * // other imports...
+     * import { Context } from "@medusajs/framework/types"
+     * import { setTimeout } from "node:timers/promises"
+     *
+     * class MyLockingProviderService implements ILockingProvider {
+     *   // ...
+     * async execute<T>(
+     *     keys: string | string[],
+     *     job: () => Promise<T>,
+     *     args?: { timeout?: number },
+     *     sharedContext?: Context
+     *   ): Promise<T> {
+     *     // TODO you can add actions using the third-party client you initialized in the constructor
+     *     const timeout = Math.max(args?.timeout ?? 5, 1)
+     *     const timeoutSeconds = Number.isNaN(timeout) ? 1 : timeout
+     *     const cancellationToken = { cancelled: false }
+     *     const promises: Promise<any>[] = []
+     *
+     *     if (timeoutSeconds > 0) {
+     *       promises.push(this.getTimeout(timeoutSeconds, cancellationToken))
+     *     }
+     *
+     *     promises.push(
+     *       this.acquire_(
+     *         keys,
+     *         {
+     *           expire: args?.timeout ? timeoutSeconds : 0,
+     *         },
+     *         cancellationToken
+     *       )
+     *     )
+     *
+     *     await Promise.race(promises)
+     *
+     *     try {
+     *       return await job()
+     *     } finally {
+     *       await this.release(keys)
+     *     }
+     *   }
+     *
+     *   private async getTimeout(
+     *     seconds: number,
+     *     cancellationToken: { cancelled: boolean }
+     *   ): Promise<void> {
+     *     return new Promise(async (_, reject) => {
+     *       await setTimeout(seconds * 1000)
+     *       cancellationToken.cancelled = true
+     *       reject(new Error("Timed-out acquiring lock."))
+     *     })
+     *   }
+     * }
+     * ```
+     *
+     * In this example, you first determine the timeout for acquiring the lock. You also create a `cancellationToken` object that you'll use to determine if the lock aquisition has timed out.
+     *
+     * You then create an array of the following promises:
+     *
+     * - A timeout promise that, if the lock acquisition takes longer than the timeout, sets the `cancelled` property of the `cancellationToken` object to `true`.
+     * - A promise that acquires the lock. You use a private `acquire_` method which you can find its implementation in the `aquire` method's example. If the first promise
+     * resolves and cancels the lock acquisition, the lock will not be acquired.
+     *
+     * Finally, if the lock is acquired, you execute the job and release the lock after the job is done using the `release` method.
+     */
     execute<T>(keys: string | string[], job: () => Promise<T>, args?: {
+        /**
+         * The timeout (in seconds) for acquiring the lock. If the time out is passed, the job is canceled and the lock is released.
+         */
         timeout?: number;
     }, sharedContext?: Context): Promise<T>;
+    /**
+     * This method acquires a lock on the given keys. The Locking Module uses this method when you call its `acquire` method and your provider is the default provider,
+     * or you pass your provider's identifier to its `acquire` method.
+     *
+     * In this method, you should only aquire the lock if the timeout hasn't passed. As explained in the {@link execute} method's example,
+     * you can use a `cancellationToken` object to determine if the lock acquisition has timed out.
+     *
+     * If the lock aquisition isn't canceled, you should aquire the lock, setting its expiry and owner. You should account for the following scenarios:
+     *
+     * - The lock doesn't have an owner and you don't pass an owner, in which case the lock can be extended or released by anyone.
+     * - The lock doesn't have an owner or has the same owner that you pass, in which case you can extend the lock's expiration time and set the owner.
+     * - The lock has an owner, but you pass a different owner, in which case the method should throw an error.
+     *
+     * @param keys - The keys to acquire the lock on.
+     * @param args - Additional arguments for acquiring the lock.
+     * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns Resolves when the lock is acquired.
+     *
+     * @example
+     * An example of how to implement the `acquire` method:
+     *
+     * ```ts
+     * type ResolvablePromise = {
+     *   promise: Promise<any>
+     *   resolve: () => void
+     * }
+     *
+     * class MyLockingProviderService implements ILockingProvider {
+     *   // ...
+     *   async acquire(
+     *     keys: string | string[],
+     *     args?: {
+     *       ownerId?: string | null
+     *       expire?: number
+     *       awaitQueue?: boolean
+     *     }
+     *   ): Promise<void> {
+     *     return this.acquire_(keys, args)
+     *   }
+     *
+     *   async acquire_(
+     *     keys: string | string[],
+     *     args?: {
+     *       ownerId?: string | null
+     *       expire?: number
+     *       awaitQueue?: boolean
+     *     },
+     *     cancellationToken?: { cancelled: boolean }
+     *   ): Promise<void> {
+     *     keys = Array.isArray(keys) ? keys : [keys]
+     *     const { ownerId, expire } = args ?? {}
+     *
+     *     for (const key of keys) {
+     *       if (cancellationToken?.cancelled) {
+     *         throw new Error("Timed-out acquiring lock.")
+     *       }
+     *
+     *       // assuming your client has this method and it validates the owner and expiration
+     *       const result = await this.client.acquireLock(key, ownerId, expire)
+     *
+     *       if (result !== 1) {
+     *         throw new Error(`Failed to acquire lock for key "${key}"`)
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * In this example, you add a private `acquire_` method that you use to acquire the lock. This method accepts an additional `cancellationToken` argument that you can use to determine if the lock acquisition has timed out.
+     * You can then use this method in other methods, such as the `execute` method.
+     *
+     * In the `acquire_` method, you loop through the keys and try to acquire the lock on each key if the lock acquisition hasn't timed out. If the lock acquisition fails, you throw an error.
+     * This method assumes that the client you're integrating has a method called `acquireLock` that validates the owner and expiration time, and returns `1` if the lock is successfully acquired.
+     */
     acquire(keys: string | string[], args?: {
+        /**
+         * The ID of the lock's owner. If specified, only the owner can release the lock or extend its expiration time.
+         */
         ownerId?: string | null;
+        /**
+         * The expiration time (in seconds) for the lock. If the lock is already acquired and the owner is the same, the expiration time is extended
+         * by the value passed. If not specified, the lock does not expire.
+         */
         expire?: number;
     }, sharedContext?: Context): Promise<void>;
+    /**
+     * This method releases a lock on the given keys. The Locking Module uses this method when you call its `release` method and your provider is the default provider,
+     * or you pass your provider's identifier to its `release` method.
+     *
+     * In this method, you should release the lock on the given keys. If the lock has an owner, you should only release the lock if the owner is the same as the one passed.
+     *
+     * @param keys - The keys to release the lock from.
+     * @param args - Additional arguments for releasing the lock.
+     * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns Whether the lock was successfully released. If the lock has a different owner than the one passed, the method returns `false`.
+     *
+     * @example
+     * An example of how to implement the `release` method:
+     *
+     * ```ts
+     * // other imports...
+     * import { promiseAll } from "@medusajs/framework/utils"
+     *
+     * class MyLockingProviderService implements ILockingProvider {
+     *   // ...
+     *   async release(
+     *     keys: string | string[],
+     *     args?: { ownerId?: string | null },
+     *     sharedContext?: Context
+     *   ): Promise<boolean> {
+     *     const ownerId = args?.ownerId ?? "*"
+     *     keys = Array.isArray(keys) ? keys : [keys]
+     *
+     *     const releasePromises = keys.map(async (key) => {
+     *       // assuming your client has this method and it validates the owner
+     *       const result = await this.client.releaseLock(key, ownerId)
+     *       return result === 1
+     *     })
+     *
+     *     const results = await promiseAll(releasePromises)
+     *
+     *     return results.every((released) => released)
+     *   }
+     * }
+     * ```
+     *
+     * In this example, you loop through the keys and try to release the lock on each key using the client you're integrating. This implementation assumes that the client validates
+     * ownership of the lock and returns a result of `1` if the lock is successfully released.
+     */
     release(keys: string | string[], args?: {
+        /**
+         * The ID of the lock's owner. The lock can be released either if it doesn't have an owner, or
+         * if its owner ID matches the one passed in this property.
+         */
         ownerId?: string | null;
     }, sharedContext?: Context): Promise<boolean>;
+    /**
+     * This method releases all locks. The Locking Module uses this method when you call its `releaseAll` method and your provider is the default provider,
+     * or you pass your provider's identifier to its `releaseAll` method.
+     *
+     * In this method, you should release all locks if no owner is passed. If an owner is passed, you should only release the locks that the owner has acquired.
+     *
+     * @param args - Additional arguments for releasing the locks.
+     * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     *
+     * @example
+     * An example of how to implement the `releaseAll` method:
+     *
+     * ```ts
+     * class MyLockingProviderService implements ILockingProvider {
+     *   // ...
+     *   async releaseAll(
+     *     args?: { ownerId?: string | null },
+     *     sharedContext?: Context
+     *   ): Promise<void> {
+     *     const ownerId = args?.ownerId ?? "*"
+     *
+     *     await this.client.releaseAllLock(ownerId)
+     *   }
+     * }
+     * ```
+     *
+     * In this example, you release all locks either of all owners or the owner passed as an argument. This implementation assumes that the client you're integrating has a method called `releaseAllLock` that releases all locks
+     * for all owners or a specific owner.
+     */
     releaseAll(args?: {
+        /**
+         * The ID of a lock owner. If specified, all locks that the owner has acquired are released.
+         */
         ownerId?: string | null;
     }, sharedContext?: Context): Promise<void>;
 }
 export interface ILockingModule {
+    /**
+     * This method executes a giuven asynchronous job with a lock on the given keys. You can optionally pass a
+     * provider name to be used for locking. If no provider is passed, the default provider (in-memory or the
+     * provider configuerd in `medusa-config.ts`) will be used.
+     *
+     * @param keys - The keys to lock durng the job's execution.
+     * @param job - The asynchronous job to execute while the keys are locked.
+     * @param args - Additional arguments for the job execution.
+     * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns The result of the job execution.
+     * @typeParam T - The type of the job's result.
+     *
+     * @example
+     * For example, to use the lock module when deleting a product:
+     *
+     * ```ts
+     * await lockingModuleService.execute("prod_123", async () => {
+     *    // assuming you've resolved the product service from the container
+     *    await productModuleService.delete("prod_123")
+     * })
+     * ```
+     *
+     * In the above example, the product of ID `prod_123` is locked while it's being deleted.
+     *
+     * To specify the provider to use for locking, you can pass the provider name in the `args` argument:
+     *
+     * ```ts
+     * await lockingModuleService.execute("prod_123", async () => {
+     *   // assuming you've resolved the product service from the container
+     *   await productModuleService.delete("prod_123")
+     * }, {
+     *   provider: "lp_my-lock"
+     * })
+     * ```
+     */
     execute<T>(keys: string | string[], job: () => Promise<T>, args?: {
+        /**
+         * The timeout (in seconds) for acquiring the lock. If the time out is passed, the job is canceled and the lock is released.
+         * Its value defaults to `5` seconds if no value is passed or if you pass a value less than `1`.
+         */
         timeout?: number;
+        /**
+         * The provider name to use for locking. If no provider is passed, the default provider (in-memory or the provider configuerd in `medusa-config.ts`) will be used.
+         */
         provider?: string;
     }, sharedContext?: Context): Promise<T>;
+    /**
+     * This method acquires a lock on the given keys. You can optionally pass a provider name to be used for locking.
+     * If no provider is passed, the default provider (in-memory or the provider configuerd in `medusa-config.ts`) will be used.
+     *
+     * You can pass an owner for the lock, which limits who can extend or release the acquired lock. Then, if you use this method again
+     * passing the same owner, the lock's expiration time is extended with the value passed in the `expire` argument. Otherwise, if you pass a
+     * different owner, the method throws an error.
+     *
+     * @param keys - The keys to acquire the lock on.
+     * @param args - Additional arguments for acquiring the lock.
+     * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns Resolves when the lock is acquired.
+     *
+     * @example
+     * For example, to acquire a lock on a product with ID `prod_123` for a user with ID `user_123`:
+     *
+     * ```ts
+     * await lockingModuleService.acquire("prod_123", {
+     *   ownerId: "user_123",
+     *   expire: 60
+     * })
+     * ```
+     *
+     * In this example, you acquire a lock on the product with ID `prod_123` for the user with ID `user_123`. You extend the
+     * lock's expiration time by `60` seconds.
+     *
+     * To specify the provider to use for locking, you can pass the provider name in the `args` argument:
+     *
+     * ```ts
+     * await lockingModuleService.acquire("prod_123", {
+     *   ownerId: "user_123",
+     *   expire: 60,
+     *   provider: "lp_my-lock"
+     * })
+     * ```
+     */
     acquire(keys: string | string[], args?: {
+        /**
+         * The owner ID for the lock. If specified, only the owner can release the lock or extend its expiration time.
+         */
         ownerId?: string | null;
+        /**
+         * The expiration time (in seconds) for the lock. If the lock is already acquired and the owner is the same, the expiration time is extended
+         * by the value passed. If not specified, the lock does not expire.
+         */
         expire?: number;
+        /**
+         * The provider name to use for locking. If no provider is passed, the default provider (in-memory or the provider configuerd in `medusa-config.ts`) will be used.
+         */
         provider?: string;
     }, sharedContext?: Context): Promise<void>;
+    /**
+     * This method releases a lock on the given keys. You can optionally pass a provider name to be used for locking.
+     * If no provider is passed, the default provider (in-memory or the provider configuerd in `medusa-config.ts`) will be used.
+     *
+     * If the lock has an owner, you must pass the same owner to release the lock.
+     *
+     * @param keys - The keys to release the lock from.
+     * @param args - Additional arguments for releasing the lock.
+     * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns Whether the lock was successfully released. If the lock has a different owner than the one passed, the method returns `false`.
+     *
+     * @example
+     * For example, to release a lock on a product with ID `prod_123` for a user with ID `user_123`:
+     *
+     * ```ts
+     * await lockingModuleService.release("prod_123", {
+     *   ownerId: "user_123"
+     * })
+     * ```
+     *
+     * In this example, you release the lock on the product with ID `prod_123` for the user with ID `user_123`.
+     *
+     * To specify the provider to use for locking, you can pass the provider name in the `args` argument:
+     *
+     * ```ts
+     * await lockingModuleService.release("prod_123", {
+     *   ownerId: "user_123",
+     *   provider: "lp_my-lock"
+     * })
+     * ```
+     */
     release(keys: string | string[], args?: {
+        /**
+         * The ID of the lock's owner. The lock can be released either if it doesn't have an owner, or
+         * if its owner ID matches the one passed in this property.
+         */
         ownerId?: string | null;
+        /**
+         * The provider name to use for locking. If no provider is passed, the default provider (in-memory or the provider configuerd in `medusa-config.ts`) will be used.
+         */
         provider?: string;
     }, sharedContext?: Context): Promise<boolean>;
+    /**
+     * This method releases all locks. If you specify an owner ID, then all locks that the owner has acquired are released.
+     *
+     * You can also pass a provider name to be used for locking. If no provider is passed, the default provider (in-memory or the provider configuerd in `medusa-config.ts`) will be used.
+     *
+     * @param args - Additional arguments for releasing the locks.
+     * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     *
+     * @example
+     * For example, to release all locks for a user with ID `user_123`:
+     *
+     * ```ts
+     * await lockingModuleService.releaseAll({
+     *   ownerId: "user_123"
+     * })
+     * ```
+     *
+     * In this example, you release all locks for the user with ID `user_123`.
+     *
+     * To specify the provider to use for locking, you can pass the provider name in the `args` argument:
+     *
+     * ```ts
+     * await lockingModuleService.releaseAll({
+     *   ownerId: "user_123",
+     *   provider: "lp_my-lock"
+     * })
+     * ```
+     */
     releaseAll(args?: {
+        /**
+         * The ID of a lock owner. If specified, all locks that the owner has acquired are released.
+         */
         ownerId?: string | null;
+        /**
+         * The provider name to use for locking. If no provider is passed, the default provider (in-memory or the provider configuerd in `medusa-config.ts`) will be used.
+         */
         provider?: string;
     }, sharedContext?: Context): Promise<void>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/locking/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAE3C,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,CAAC,EACP,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACrB,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,CAAC,CAAA;IACb,OAAO,CACL,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,OAAO,CACL,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACxB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,OAAO,CAAC,CAAA;IACnB,UAAU,CACR,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACxB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,CAAC,EACP,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACrB,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,CAAC,CAAA;IACb,OAAO,CACL,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,OAAO,CACL,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,OAAO,CAAC,CAAA;IACnB,UAAU,CACR,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/locking/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiFG;IACH,OAAO,CAAC,CAAC,EACP,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACrB,IAAI,CAAC,EAAE;QACL;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,CAAC,CAAA;IACb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,OAAO,CACL,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,IAAI,CAAC,EAAE;QACL;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,OAAO,CACL,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,IAAI,CAAC,EAAE;QACL;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACxB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,OAAO,CAAC,CAAA;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,UAAU,CACR,IAAI,CAAC,EAAE;QACL;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACxB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,OAAO,CAAC,CAAC,EACP,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACrB,IAAI,CAAC,EAAE;QACL;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,CAAC,CAAA;IACb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,OAAO,CACL,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,IAAI,CAAC,EAAE;QACL;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAA;QACf;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,OAAO,CACL,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,IAAI,CAAC,EAAE;QACL;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,OAAO,CAAC,CAAA;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,UAAU,CACR,IAAI,CAAC,EAAE;QACL;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB"}

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

@@ -136,7 +136,7 @@ export type ModuleJoinerConfig = Omit<JoinerServiceConfig, "serviceName" | "prim
             forwardArgumentsOnPath?: string[];
             isList?: boolean;
         }>;
-        relationship: ModuleJoinerRelationship;
+        relationship: Omit<ModuleJoinerRelationship, "hasMany">;
     }[];
     serviceName?: string;
     primaryKeys?: string[];
@@ -174,6 +174,11 @@ export declare type ModuleJoinerRelationship = JoinerRelationship & {
      * If true, the link joiner will cascade deleting the relationship
      */
     deleteCascade?: boolean;
+    /**
+     * Allow multiple relationships to exist for this
+     * entity
+     */
+    hasMany?: boolean;
 };
 export type ModuleExports<T = Constructor<any>> = {
     service: T;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAEnE,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,EAClC,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,GAClC,CAAA;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAA;AAEtE,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,6BAA6B,CAAA;AAC3C,cAAc,mBAAmB,CAAA;AAEjC,MAAM,MAAM,QAAQ,GAChB,OAAO,GACP,QAAQ,GACR,OAAO,GACP,MAAM,GACN,MAAM,GACN,KAAK,GACL,WAAW,CAAA;AACf,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,EAAE,CAAA;AAExD,MAAM,MAAM,sBAAsB,GAAG;IACnC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,UAAU,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,UAAU,CAAC,EAAE,sBAAsB,CAAA;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,WAAW,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,UAAU,CAAA;IACjB,UAAU,CAAC,EAAE,sBAAsB,CAAA;IACnC,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,SAAS,EAAE,OAAO,CAAA;KACnB,CAAA;IACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;CACf,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,MAAM,GAAG,KAAK,CAAA;IAC9B,UAAU,EAAE,gBAAgB,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,iBAAiB,CAAC,EAAE,yBAAyB,GAAG,yBAAyB,CAAA;IACzE,aAAa,CAAC,EAAE,aAAa,GAAG,qBAAqB,CAAA;CACtD,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAA;IACX,cAAc,EAAE,MAAM,GAAG,KAAK,CAAA;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,uGAAuG;IACvG,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,wBAAwB,EACpB,yBAAyB,GACzB,yBAAyB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,wBAAwB,EAAE,yBAAyB,CAAA;CACpD,CAAA;AAED,KAAK,iBAAiB,GAAG,yBAAyB,GAAG,yBAAyB,CAAA;AAC9E,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,gBAAgB,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG;IACnC,cAAc,EAAE,kBAAkB,CAAA;IAClC,YAAY,EAAE,gBAAgB,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC9D,SAAS,EAAE,eAAe,CAAA;IAC1B,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,KAC1C,OAAO,CAAC,IAAI,CAAC,CAAA;AAElB,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,GAAG,KAAK,CAAA;CAC3B,EAAE,CAAA;AAEH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACzC,MAAM,EACN;IACE,IAAI,EACA,MAAM,GACN,MAAM,GACN,UAAU,GACV,QAAQ,GACR,MAAM,GACN,YAAY,GACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,MAAM,GACN,SAAS,GACT,UAAU,GACV,SAAS,GACT,WAAW,GACX,OAAO,GACP,QAAQ,GACR,SAAS,GACT,SAAS,GACT,QAAQ,GACR,MAAM,GACN,MAAM,CAAA;IACV,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,UAAU,EAAE,MAAM,GAAG;QAEpB,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAA;KACzB,CAAA;CACF,GAAG;IACF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,mBAAmB,EACnB,aAAa,GAAG,aAAa,GAAG,eAAe,GAAG,SAAS,CAC5D,GAAG;IACF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,wBAAwB,EAAE,CAAA;IAC1C,OAAO,CAAC,EAAE;QACR,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACJ,MAAM,GACN;YACE,IAAI,EAAE,MAAM,CAAA;YACZ,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAA;YACjC,MAAM,CAAC,EAAE,OAAO,CAAA;SACjB,CACJ,CAAA;QACD,YAAY,EAAE,wBAAwB,CAAA;KACvC,EAAE,CAAA;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,cAAc,CAAC,EAAE;QACf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,WAAW,CAAC,EAAE,sBAAsB,CAAA;KACrC,CAAA;CACF,CAAA;AAED,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG,kBAAkB,GAAG;IAClE;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI;IAChD,OAAO,EAAE,CAAC,CAAA;IACV,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAChC,aAAa,CAAC,CACZ,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,eAAe,CAAC,CACd,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,iBAAiB,CAAC,CAChB,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE;QACR;;WAEG;QACH,UAAU,CAAC,EAAE,GAAG,CAAA;QAChB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;YACxC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SACrC,CAAA;QACD,KAAK,CAAC,EAAE,OAAO,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAC/B,CAAA;CACF;AAED,MAAM,MAAM,6CAA6C,GAAG;IAC1D,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAA;KAC9C,CAAA;CACF,CAAA;AAED,MAAM,MAAM,0BAA0B,GAClC,yBAAyB,GACzB,yBAAyB,CAAA;AAK7B,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,cAAc,CAAC,IAAI,kBAAkB,CAAA;IAErC;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QACxC,qBAAqB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QAC3C,4BAA4B,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;KACnD,CAAA;CACF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAEnE,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,EAClC,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,GAClC,CAAA;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAA;AAEtE,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,6BAA6B,CAAA;AAC3C,cAAc,mBAAmB,CAAA;AAEjC,MAAM,MAAM,QAAQ,GAChB,OAAO,GACP,QAAQ,GACR,OAAO,GACP,MAAM,GACN,MAAM,GACN,KAAK,GACL,WAAW,CAAA;AACf,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,EAAE,CAAA;AAExD,MAAM,MAAM,sBAAsB,GAAG;IACnC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,UAAU,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,UAAU,CAAC,EAAE,sBAAsB,CAAA;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,WAAW,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,UAAU,CAAA;IACjB,UAAU,CAAC,EAAE,sBAAsB,CAAA;IACnC,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,SAAS,EAAE,OAAO,CAAA;KACnB,CAAA;IACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;CACf,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,MAAM,GAAG,KAAK,CAAA;IAC9B,UAAU,EAAE,gBAAgB,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,iBAAiB,CAAC,EAAE,yBAAyB,GAAG,yBAAyB,CAAA;IACzE,aAAa,CAAC,EAAE,aAAa,GAAG,qBAAqB,CAAA;CACtD,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAA;IACX,cAAc,EAAE,MAAM,GAAG,KAAK,CAAA;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,uGAAuG;IACvG,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,wBAAwB,EACpB,yBAAyB,GACzB,yBAAyB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,wBAAwB,EAAE,yBAAyB,CAAA;CACpD,CAAA;AAED,KAAK,iBAAiB,GAAG,yBAAyB,GAAG,yBAAyB,CAAA;AAC9E,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,gBAAgB,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG;IACnC,cAAc,EAAE,kBAAkB,CAAA;IAClC,YAAY,EAAE,gBAAgB,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC9D,SAAS,EAAE,eAAe,CAAA;IAC1B,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,KAC1C,OAAO,CAAC,IAAI,CAAC,CAAA;AAElB,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,GAAG,KAAK,CAAA;CAC3B,EAAE,CAAA;AAEH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACzC,MAAM,EACN;IACE,IAAI,EACA,MAAM,GACN,MAAM,GACN,UAAU,GACV,QAAQ,GACR,MAAM,GACN,YAAY,GACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,MAAM,GACN,SAAS,GACT,UAAU,GACV,SAAS,GACT,WAAW,GACX,OAAO,GACP,QAAQ,GACR,SAAS,GACT,SAAS,GACT,QAAQ,GACR,MAAM,GACN,MAAM,CAAA;IACV,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,UAAU,EAAE,MAAM,GAAG;QAEpB,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAA;KACzB,CAAA;CACF,GAAG;IACF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,mBAAmB,EACnB,aAAa,GAAG,aAAa,GAAG,eAAe,GAAG,SAAS,CAC5D,GAAG;IACF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,wBAAwB,EAAE,CAAA;IAC1C,OAAO,CAAC,EAAE;QACR,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACJ,MAAM,GACN;YACE,IAAI,EAAE,MAAM,CAAA;YACZ,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAA;YACjC,MAAM,CAAC,EAAE,OAAO,CAAA;SACjB,CACJ,CAAA;QACD,YAAY,EAAE,IAAI,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAA;KACxD,EAAE,CAAA;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,cAAc,CAAC,EAAE;QACf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,WAAW,CAAC,EAAE,sBAAsB,CAAA;KACrC,CAAA;CACF,CAAA;AAED,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG,kBAAkB,GAAG;IAClE;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI;IAChD,OAAO,EAAE,CAAC,CAAA;IACV,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAChC,aAAa,CAAC,CACZ,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,eAAe,CAAC,CACd,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,iBAAiB,CAAC,CAChB,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE;QACR;;WAEG;QACH,UAAU,CAAC,EAAE,GAAG,CAAA;QAChB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;YACxC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SACrC,CAAA;QACD,KAAK,CAAC,EAAE,OAAO,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAC/B,CAAA;CACF;AAED,MAAM,MAAM,6CAA6C,GAAG;IAC1D,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAA;KAC9C,CAAA;CACF,CAAA;AAED,MAAM,MAAM,0BAA0B,GAClC,yBAAyB,GACzB,yBAAyB,CAAA;AAK7B,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,cAAc,CAAC,IAAI,kBAAkB,CAAA;IAErC;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QACxC,qBAAqB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QAC3C,4BAA4B,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;KACnD,CAAA;CACF"}

package/dist/modules-sdk/medusa-internal-service.d.ts

@@ -20,13 +20,13 @@ export interface IMedusaInternalService<TEntity extends {}, TContainer extends o
         selector: FilterQuery<any> | BaseFilterable<FilterQuery<any>>;
         data: any;
     }[], sharedContext?: Context): Promise<InferEntityType<TEntity>[]>;
-    delete(idOrSelector: string, sharedContext?: Context): Promise<void>;
-    delete(idOrSelector: string[], sharedContext?: Context): Promise<void>;
-    delete(idOrSelector: object, sharedContext?: Context): Promise<void>;
-    delete(idOrSelector: object[], sharedContext?: Context): Promise<void>;
+    delete(idOrSelector: string, sharedContext?: Context): Promise<string[]>;
+    delete(idOrSelector: string[], sharedContext?: Context): Promise<string[]>;
+    delete(idOrSelector: object, sharedContext?: Context): Promise<string[]>;
+    delete(idOrSelector: object[], sharedContext?: Context): Promise<string[]>;
     delete(idOrSelector: {
         selector: FilterQuery<any> | BaseFilterable<FilterQuery<any>>;
-    }, sharedContext?: Context): Promise<void>;
+    }, sharedContext?: Context): Promise<string[]>;
     softDelete(idsOrFilter: string | string[] | InternalFilterQuery | InternalFilterQuery[], sharedContext?: Context): Promise<[InferEntityType<TEntity>[], Record<string, unknown[]>]>;
     restore(idsOrFilter: string[] | InternalFilterQuery, sharedContext?: Context): Promise<[InferEntityType<TEntity>[], Record<string, unknown[]>]>;
     upsert(data: any[], sharedContext?: Context): Promise<InferEntityType<TEntity>[]>;

package/dist/modules-sdk/medusa-internal-service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"medusa-internal-service.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/medusa-internal-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,cAAc,EACd,WAAW,IAAI,mBAAmB,EAClC,WAAW,EACX,gBAAgB,EAChB,uBAAuB,EACxB,MAAM,QAAQ,CAAA;AACf,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAA;AAExC,MAAM,WAAW,sBAAsB,CACrC,OAAO,SAAS,EAAE,EAClB,UAAU,SAAS,MAAM,GAAG,MAAM;IAElC,IAAI,aAAa,IAAI,UAAU,CAAA;IAE/B,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;IACpC,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;IAEpC,IAAI,CACF,OAAO,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAC7D,MAAM,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAEtC,YAAY,CACV,OAAO,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAC7D,MAAM,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEhD,MAAM,CACJ,IAAI,EAAE,GAAG,EAAE,EACX,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACtC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;IAE7E,MAAM,CACJ,IAAI,EAAE,GAAG,EAAE,EACX,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACtC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;IAC7E,MAAM,CACJ,eAAe,EAAE;QACf,QAAQ,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;QAC7D,IAAI,EAAE,GAAG,CAAA;KACV,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACtC,MAAM,CACJ,eAAe,EAAE;QACf,QAAQ,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;QAC7D,IAAI,EAAE,GAAG,CAAA;KACV,EAAE,EACH,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAEtC,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpE,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACtE,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpE,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACtE,MAAM,CACJ,YAAY,EAAE;QACZ,QAAQ,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;KAC9D,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB,UAAU,CACR,WAAW,EACP,MAAM,GACN,MAAM,EAAE,GACR,mBAAmB,GACnB,mBAAmB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAEnE,OAAO,CACL,WAAW,EAAE,MAAM,EAAE,GAAG,mBAAmB,EAC3C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAEnE,MAAM,CACJ,IAAI,EAAE,GAAG,EAAE,EACX,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACtC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;IAE7E,iBAAiB,CACf,IAAI,EAAE,GAAG,EAAE,EACX,MAAM,CAAC,EAAE,uBAAuB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,EAC1D,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC;QACT,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,CAAA;QACpC,gBAAgB,EAAE,gBAAgB,CAAA;KACnC,CAAC,CAAA;CACH"}
+{"version":3,"file":"medusa-internal-service.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/medusa-internal-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,cAAc,EACd,WAAW,IAAI,mBAAmB,EAClC,WAAW,EACX,gBAAgB,EAChB,uBAAuB,EACxB,MAAM,QAAQ,CAAA;AACf,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAA;AAExC,MAAM,WAAW,sBAAsB,CACrC,OAAO,SAAS,EAAE,EAClB,UAAU,SAAS,MAAM,GAAG,MAAM;IAElC,IAAI,aAAa,IAAI,UAAU,CAAA;IAE/B,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;IACpC,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;IAEpC,IAAI,CACF,OAAO,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAC7D,MAAM,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAEtC,YAAY,CACV,OAAO,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAC7D,MAAM,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEhD,MAAM,CACJ,IAAI,EAAE,GAAG,EAAE,EACX,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACtC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;IAE7E,MAAM,CACJ,IAAI,EAAE,GAAG,EAAE,EACX,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACtC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;IAC7E,MAAM,CACJ,eAAe,EAAE;QACf,QAAQ,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;QAC7D,IAAI,EAAE,GAAG,CAAA;KACV,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACtC,MAAM,CACJ,eAAe,EAAE;QACf,QAAQ,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;QAC7D,IAAI,EAAE,GAAG,CAAA;KACV,EAAE,EACH,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAEtC,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IACxE,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAC1E,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IACxE,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAC1E,MAAM,CACJ,YAAY,EAAE;QACZ,QAAQ,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;KAC9D,EACD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAEpB,UAAU,CACR,WAAW,EACP,MAAM,GACN,MAAM,EAAE,GACR,mBAAmB,GACnB,mBAAmB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAEnE,OAAO,CACL,WAAW,EAAE,MAAM,EAAE,GAAG,mBAAmB,EAC3C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAEnE,MAAM,CACJ,IAAI,EAAE,GAAG,EAAE,EACX,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACtC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;IAE7E,iBAAiB,CACf,IAAI,EAAE,GAAG,EAAE,EACX,MAAM,CAAC,EAAE,uBAAuB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,EAC1D,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC;QACT,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,CAAA;QACpC,gBAAgB,EAAE,gBAAgB,CAAA;KACnC,CAAC,CAAA;CACH"}

package/dist/modules-sdk/remote-query-object-from-string.d.ts

@@ -45,6 +45,10 @@ export type RemoteQueryInput<TEntry extends string> = {
      * Apply a query context on the retrieved data. For example, to retrieve product prices for a certain context.
      */
     context?: any;
+    /**
+     * Apply a `withDeleted` flag on the retrieved data to retrieve soft deleted items.
+     */
+    withDeleted?: boolean;
 };
 export type RemoteQueryGraph<TEntry extends string> = {
     __TConfig: RemoteQueryObjectConfig<TEntry>;

package/dist/modules-sdk/remote-query-object-from-string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"remote-query-object-from-string.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/remote-query-object-from-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wDAAwD,CAAA;AACrF,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAEtD,MAAM,MAAM,uBAAuB,CAAC,MAAM,SAAS,MAAM,IAAI;IAE3D,UAAU,EAAE,MAAM,GAAG,MAAM,sBAAsB,CAAA;IACjD,SAAS,CAAC,EAAE,GAAG,CAAA;IACf,MAAM,EAAE,yBAAyB,CAC/B,sBAAsB,CAAC,MAAM,GAAG,MAAM,sBAAsB,CAAC,CAC9D,SAAS,KAAK,GACX,MAAM,EAAE,GAEJ,yBAAyB,CACvB,sBAAsB,CAAC,MAAM,GAAG,MAAM,sBAAsB,CAAC,CAC9D,EAAE,GACH,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,iCAAiC,CAC3C,OAAO,SAAS,uBAAuB,CAAC,GAAG,CAAC,IAC1C;IACF,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,IAAI;IAEpD;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,MAAM,sBAAsB,CAAA;IAC7C;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAC/B,sBAAsB,CAAC,MAAM,GAAG,MAAM,sBAAsB,CAAC,CAC9D,SAAS,KAAK,GACX,MAAM,EAAE,GAEJ,yBAAyB,CACvB,sBAAsB,CAAC,MAAM,GAAG,MAAM,sBAAsB,CAAC,CAC9D,EAAE,GACH,MAAM,EAAE,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,KAAK,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;KAC7B,CAAA;IACD;;OAEG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAA;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,GAAG,CAAA;CACd,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,IAAI;IACpD,SAAS,EAAE,uBAAuB,CAAC,MAAM,CAAC,CAAA;CAC3C,CAAA"}
+{"version":3,"file":"remote-query-object-from-string.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/remote-query-object-from-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wDAAwD,CAAA;AACrF,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAEtD,MAAM,MAAM,uBAAuB,CAAC,MAAM,SAAS,MAAM,IAAI;IAE3D,UAAU,EAAE,MAAM,GAAG,MAAM,sBAAsB,CAAA;IACjD,SAAS,CAAC,EAAE,GAAG,CAAA;IACf,MAAM,EAAE,yBAAyB,CAC/B,sBAAsB,CAAC,MAAM,GAAG,MAAM,sBAAsB,CAAC,CAC9D,SAAS,KAAK,GACX,MAAM,EAAE,GAEJ,yBAAyB,CACvB,sBAAsB,CAAC,MAAM,GAAG,MAAM,sBAAsB,CAAC,CAC9D,EAAE,GACH,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,iCAAiC,CAC3C,OAAO,SAAS,uBAAuB,CAAC,GAAG,CAAC,IAC1C;IACF,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,IAAI;IAEpD;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,MAAM,sBAAsB,CAAA;IAC7C;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAC/B,sBAAsB,CAAC,MAAM,GAAG,MAAM,sBAAsB,CAAC,CAC9D,SAAS,KAAK,GACX,MAAM,EAAE,GAEJ,yBAAyB,CACvB,sBAAsB,CAAC,MAAM,GAAG,MAAM,sBAAsB,CAAC,CAC9D,EAAE,GACH,MAAM,EAAE,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,KAAK,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;KAC7B,CAAA;IACD;;OAEG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAA;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,GAAG,CAAA;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,IAAI;IACpD,SAAS,EAAE,uBAAuB,CAAC,MAAM,CAAC,CAAA;CAC3C,CAAA"}

package/dist/modules-sdk/remote-query.d.ts

@@ -2,6 +2,7 @@ import { Prettify } from "../common";
 import { RemoteJoinerOptions, RemoteJoinerQuery } from "../joiner";
 import { RemoteQueryEntryPoints } from "./remote-query-entry-points";
 import { RemoteQueryInput, RemoteQueryObjectConfig, RemoteQueryObjectFromStringResult } from "./remote-query-object-from-string";
+import { RemoteQueryFilters } from "./to-remote-query";
 export type RemoteQueryFunctionReturnPagination = {
     skip: number;
     take: number;
@@ -23,6 +24,16 @@ export type GraphResultSet<TEntry extends string> = {
 export type QueryGraphFunction = {
     <const TEntry extends string>(queryConfig: RemoteQueryInput<TEntry>, options?: RemoteJoinerOptions): Promise<Prettify<GraphResultSet<TEntry>>>;
 };
+/**
+ * QueryIndexFunction is a wrapper on top of remoteQuery
+ * that simplifies the input it accepts and returns
+ * a normalized/consistent output.
+ */
+export type QueryIndexFunction = {
+    <const TEntry extends string>(queryOptions: RemoteQueryInput<TEntry> & {
+        joinFilters?: RemoteQueryFilters<TEntry>;
+    }, options?: RemoteJoinerOptions): Promise<Prettify<GraphResultSet<TEntry>>>;
+};
 export type RemoteQueryFunction = {
     /**
      * Query wrapper to provide specific API's and pre processing around remoteQuery.query
@@ -47,6 +58,11 @@ export type RemoteQueryFunction = {
      * returns a result set
      */
     graph: QueryGraphFunction;
+    /**
+     * Index function uses the index module to query and remoteQuery to hydrate the data
+     * returns a result set
+     */
+    index: QueryIndexFunction;
     /**
      * Query wrapper to provide specific GraphQL like API around remoteQuery.query
      * @param query