@medusajs/types 1.12.0-snapshot-20240405070935 → 1.12.0-snapshot-20240405154416

package/dist/auth/common/auth-user.d.ts

@@ -10,27 +10,29 @@ export type AuthUserDTO = {
      */
     id: string;
     /**
-     * The provider of the auth user.
+     * The ID of the provider used to authenticate the user.
      */
     provider: string;
     /**
-     * The associated providers entity's ID.
+     * The user's identifier. For example, when using the `emailpass`
+     * provider, the `entity_id` would be the user's email.
      */
     entity_id: string;
     /**
-     * The scope of the auth user.
+     * The scope of the auth user. For example,
+     * `admin` or `store`.
      */
     scope: string;
     /**
-     * The provider metadata of the auth user.
+     * Holds custom data related to the provider in key-value pairs.
      */
     provider_metadata?: Record<string, unknown>;
     /**
-     * The user metadata of the auth user.
+     * Holds custom data related to the user in key-value pairs.
      */
     user_metadata: Record<string, unknown>;
     /**
-     * The app metadata of the auth user.
+     * Holds custom data related to the third-party app in key-value pairs.
      */
     app_metadata: Record<string, unknown>;
 };
@@ -45,27 +47,30 @@ export type CreateAuthUserDTO = {
      */
     id?: string;
     /**
-     * The provider of the auth user.
+     * The ID of the provider used to authenticate
+     * the user.
      */
     provider: string;
     /**
-     * The associated entity's ID.
+     * The user's identifier. For example, when using the `emailpass`
+     * provider, the `entity_id` would be the user's email.
      */
     entity_id: string;
     /**
-     * The scope of the auth user.
+     * The scope of the auth user. For example,
+     * `admin` or `store`.
      */
     scope: string;
     /**
-     * The provider metadata of the auth user.
+     * Holds custom data related to the provider in key-value pairs.
      */
     provider_metadata?: Record<string, unknown>;
     /**
-     * The user metadata of the auth user.
+     * Holds custom data related to the user in key-value pairs.
      */
     user_metadata?: Record<string, unknown>;
     /**
-     * The app metadata of the auth user.
+     * Holds custom data related to the third-party app in key-value pairs.
      */
     app_metadata?: Record<string, unknown>;
 };
@@ -80,15 +85,15 @@ export type UpdateAuthUserDTO = {
      */
     id: string;
     /**
-     * The provider metadata of the auth user.
+     * Holds custom data related to the provider in key-value pairs.
      */
     provider_metadata?: Record<string, unknown>;
     /**
-     * The user metadata of the auth user.
+     * Holds custom data related to the user in key-value pairs.
      */
     user_metadata?: Record<string, unknown>;
     /**
-     * The app metadata of the auth user.
+     * Holds custom data related to the third-party app in key-value pairs.
      */
     app_metadata?: Record<string, unknown>;
 };
@@ -101,7 +106,7 @@ export interface FilterableAuthUserProps extends BaseFilterable<FilterableAuthUs
      */
     id?: string[];
     /**
-     * Filter the auth auth user by the associated provider(s).
+     * Filter the auth users by the ID of their auth provider.
      */
     provider?: string[] | string;
 }

package/dist/auth/common/auth-user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth-user.d.ts","sourceRoot":"","sources":["../../../src/auth/common/auth-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACtC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,uBACf,SAAQ,cAAc,CAAC,uBAAuB,CAAC;IAC/C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC7B"}
+{"version":3,"file":"auth-user.d.ts","sourceRoot":"","sources":["../../../src/auth/common/auth-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACtC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,uBACf,SAAQ,cAAc,CAAC,uBAAuB,CAAC;IAC/C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC7B"}

package/dist/auth/common/provider.d.ts

@@ -9,52 +9,65 @@ export type AuthenticationResponse = {
      */
     success: boolean;
     /**
-     * The authenticated user's details. The details shape
-     * depends on the used provider ID.
+     * The authenticated user's details.
      */
     authUser?: any;
     /**
-     * The error message, if an error occurs.
+     * If an error occurs during the authentication process,
+     * whether within the Auth Module or a third-party provider,
+     * the error message is set in this field.
      */
     error?: string;
     /**
-     * Redirect location. Location takes precedence over success.
+     * The URL to redirect to for further authentication action
+     * with a third-party provider. This takes precedence before
+     * the `success` field.
+     *
+     * So, after checking that authentication is successful,
+     * you should check whether this field is defined and, if so, redirect to the
+     * specified location.
      */
     location?: string;
     /**
-     * Redirect url for successful authentication.
+     * Some authentication providers support redirecting to a specified URL on
+     * success. In those cases, the URL to redirect to is set in this field.
+     *
+     * So, if `success` is true, there's no `location` set, and this field
+     * is set, you can redirect to this URL.
      */
     successRedirectUrl?: string;
 };
 /**
  * @interface
  *
- * Provider configuration for the Medusa auth module.
+ * The configurations of the `providers` option
+ * passed to the Auth Module.
  */
 export type AuthModuleProviderConfig = {
     /**
-     * Provider name
+     * The provider's name.
      */
     name: string;
     /**
-     * Scope configurations for the provider
+     * The scopes configuration of that provider.
      */
     scopes: Record<string, AuthProviderScope>;
 };
 /**
  * @interface
  *
- * Configuration of a single provider scope
+ * The scope configurations of an auth provider.
  */
 export type AuthProviderScope = Record<string, unknown>;
 /**
  * @interface
  *
- * Input for authentication and callback validation methods.
+ * The data passed to the auth provider when authenticating a user
+ * or validating a callback.
  */
 export type AuthenticationInput = {
     /**
-     * url of incoming authentication request.
+     * URL of the incoming authentication request.
      */
     url: string;
     /**
@@ -62,19 +75,19 @@ export type AuthenticationInput = {
      */
     headers: Record<string, string>;
     /**
-     *  Query params of incoming authentication request.
+     *  Query params of the incoming authentication request.
      */
     query: Record<string, string>;
     /**
-     * Body of incoming authentication request.
+     * Body of the incoming authentication request.
      */
     body: Record<string, string>;
     /**
-     * Scope for authentication request.
+     * Scope for the authentication request.
      */
     authScope: string;
     /**
-     * Protocol of incoming authentication request (For example, `https`).
+     * Protocol of the incoming authentication request (For example, `https`).
      */
     protocol: string;
 };

package/dist/auth/common/provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/auth/common/provider.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EAAE,GAAG,CAAA;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;CAC1C,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEvD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA"}
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/auth/common/provider.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,CAAA;IAEd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;CAC1C,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEvD;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA"}

package/dist/auth/service.d.ts

@@ -9,171 +9,233 @@ export type JWTGenerationOptions = {
     expiresIn?: string | number;
 };
 /**
- * The main service interface for the authentication module.
+ * The main service interface for the Auth Module.
  */
 export interface IAuthModuleService extends IModuleService {
     /**
-     * This method is the first invoked method of the authentication flow. It handles the incoming authentication request.
+     * This method is used to authenticate a user using a provider. The `authenticate` method of the
+     * underlying provider is called, passing it the `providerData` parameter as a parameter. The method
+     * returns the data returned by the provider.
      *
-     * @param {string} provider - The provider to use for authentication.
-     * @param {AuthenticationInput} providerData - The authentication data necessary to pass to the provider
-     * @returns {Promise<AuthenticationResponse>} The authentication's result.
+     * Refer to [this guide](https://docs.medusajs.com/experimental/auth/auth-flows) to learn more about the authentication flows.
+     *
+     * @param {string} provider - The ID of the provider to authenticate the user with.
+     * @param {AuthenticationInput} providerData - The data to pass to the provider to authenticate the user.
+     * @returns {Promise<AuthenticationResponse>} The details of the authentication result.
      *
      * @example
-     * {example-code}
+     * The following example is in the context of an API route, where
+     * `req` is an instance of the `MedusaRequest` object:
+     *
+     * ```ts
+     * const { success, authUser, location, error } =
+     *   await authModuleService.authenticate("emailpass", {
+     *     url: req.url,
+     *     headers: req.headers,
+     *     query: req.query,
+     *     body: req.body,
+     *     authScope: "admin",
+     *     protocol: req.protocol,
+     *   } as AuthenticationInput)
+     * ```
      */
     authenticate(provider: string, providerData: AuthenticationInput): Promise<AuthenticationResponse>;
     /**
-     * This method handles the callback from an authentication provider when an authentication has been initialized and the user is redirected.
+     * When authenticating users with a third-party provider, such as Google, the user performs an
+     * action to finish the authentication, such as enter their credentials in Google's sign-in
+     * form.
      *
-     * @param {string} provider - The provider to use for callback validation.
-     * @param {AuthenticationInput} providerData - The authentication data necessary to pass to the provider
-     * @returns {Promise<AuthenticationResponse>} The authentication's result.
+     * In those cases, you must create an API route or endpoint that's called by the third-party
+     * provider when the user finishes performing the required action.
+     *
+     * In that API route, you can call this method to validate the third-party provider's
+     * callback and authenticate the user.
+     *
+     * Learn more about this authentication flow in [this guide](https://docs.medusajs.com/experimental/auth/auth-flows#authentication-with-third-party-service).
+     *
+     * @param {string} provider - The ID of the provider to use to validate the callback.
+     * @param {AuthenticationInput} providerData - The data to pass to the provider to validate the callback.
+     * @returns {Promise<AuthenticationResponse>} The details of the authentication result.
      *
      * @example
-     * {example-code}
+     * The following example is in the context of an API route, where
+     * `req` is an instance of the `MedusaRequest` object:
+     *
+     * ```ts
+     * const { success, authUser, error, successRedirectUrl } =
+     *   await authModuleService.validateCallback("google", {
+     *     url: req.url,
+     *     headers: req.headers,
+     *     query: req.query,
+     *     body: req.body,
+     *     authScope: "admin",
+     *     protocol: req.protocol,
+     *   } as AuthenticationInput)
+     * ```
+     *
      */
     validateCallback(provider: string, providerData: AuthenticationInput): Promise<AuthenticationResponse>;
     /**
-     * This method retrieves the user by its ID.
+     * This method retrieves an auth user by its ID.
      *
-     * @param {string} id - The ID of the retrieve.
+     * @param {string} id - The ID of the auth user.
      * @param {FindConfig<AuthUserDTO>} config - The configurations determining how the auth user is retrieved. Its properties, such as `select` or `relations`, accept the
      * attributes or relations associated with a auth user.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<AuthUserDTO>} The retrieved user.
+     * @returns {Promise<AuthUserDTO>} The retrieved auth user.
      *
      * @example
-     * A simple example that retrieves a {type name} by its ID:
-     *
-     * ```ts
-     * {example-code}
-     * ```
-     *
-     * To specify relations that should be retrieved:
-     *
-     * ```ts
-     * {example-code}
-     * ```
-     *
-     *
+     * const authUser = await authModuleService.retrieve("authusr_1")
      */
     retrieve(id: string, config?: FindConfig<AuthUserDTO>, sharedContext?: Context): Promise<AuthUserDTO>;
     /**
-     * This method retrieves a paginated list of users based on optional filters and configuration.
+     * This method retrieves a paginated list of auth users based on optional filters and configuration.
      *
-     * @param {FilterableAuthUserProps} filters - The filters to apply on the retrieved auth user.
+     * @param {FilterableAuthUserProps} filters - The filters to apply on the retrieved auth users.
      * @param {FindConfig<AuthUserDTO>} config - The configurations determining how the auth user is retrieved. Its properties, such as `select` or `relations`, accept the
      * attributes or relations associated with a auth user.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<AuthUserDTO[]>} The list of users.
+     * @returns {Promise<AuthUserDTO[]>} The list of auth users.
      *
      * @example
-     * To retrieve a list of {type name} using their IDs:
-     *
-     * ```ts
-     * {example-code}
-     * ```
-     *
-     * To specify relations that should be retrieved within the {type name}:
+     * To retrieve a list of auth users using their IDs:
      *
      * ```ts
-     * {example-code}
+     * const authUsers = await authModuleService.list({
+     *   id: ["authusr_123", "authusr_321"],
+     * })
      * ```
      *
-     * By default, only the first `{default limit}` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     * 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
-     * {example-code}
+     * const authUsers = await authModuleService.list(
+     *   {
+     *     id: ["authusr_123", "authusr_321"],
+     *   },
+     *   {
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
      * ```
-     *
-     *
      */
     list(filters?: FilterableAuthUserProps, config?: FindConfig<AuthUserDTO>, sharedContext?: Context): Promise<AuthUserDTO[]>;
     /**
-     * This method retrieves a paginated list of user along with the total count of available users satisfying the provided filters.
+     * This method retrieves a paginated list of auth users along with the total count of available auth users satisfying the provided filters.
      *
-     * @param {FilterableAuthUserProps} filters - The filters to apply on the retrieved auth user.
+     * @param {FilterableAuthUserProps} filters - The filters to apply on the retrieved auth users.
      * @param {FindConfig<AuthUserDTO>} config - The configurations determining how the auth user is retrieved. Its properties, such as `select` or `relations`, accept the
      * attributes or relations associated with a auth user.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<[AuthUserDTO[], number]>} The list of users along with their total count.
+     * @returns {Promise<[AuthUserDTO[], number]>} The list of auth users along with their total count.
      *
      * @example
-     * To retrieve a list of {type name} using their IDs:
-     *
-     * ```ts
-     * {example-code}
-     * ```
-     *
-     * To specify relations that should be retrieved within the {type name}:
+     * To retrieve a list of auth users using their IDs:
      *
      * ```ts
-     * {example-code}
+     * const [authUsers, count] =
+     *   await authModuleService.listAndCount({
+     *     id: ["authusr_123", "authusr_321"],
+     *   })
      * ```
      *
-     * By default, only the first `{default limit}` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     * 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
-     * {example-code}
+     * const [authUsers, count] =
+     *   await authModuleService.listAndCount(
+     *     {
+     *       id: ["authusr_123", "authusr_321"],
+     *     },
+     *     {
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
      * ```
-     *
-     *
      */
     listAndCount(filters?: FilterableAuthUserProps, config?: FindConfig<AuthUserDTO>, sharedContext?: Context): Promise<[AuthUserDTO[], number]>;
     /**
-     * This method creates users
+     * This method creates auth users.
      *
-     * @param {CreateAuthUserDTO[]} data - The auth user to be created.
+     * @param {CreateAuthUserDTO[]} data - The auth users to be created.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<AuthUserDTO[]>} The created users.
+     * @returns {Promise<AuthUserDTO[]>} The created auth users.
      *
      * @example
-     * {example-code}
+     * const authUsers = await authModuleService.create([
+     *   {
+     *     provider: "emailpass",
+     *     entity_id: "user@example.com",
+     *     scope: "admin",
+     *   },
+     *   {
+     *     provider: "google",
+     *     entity_id: "user@gmail.com",
+     *     scope: "email profile",
+     *   },
+     * ])
      */
     create(data: CreateAuthUserDTO[], sharedContext?: Context): Promise<AuthUserDTO[]>;
     /**
-     * This method creates a user
+     * This method creates an auth user.
      *
      * @param {CreateAuthUserDTO} data - The auth user to be created.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<AuthUserDTO>} The created user.
+     * @returns {Promise<AuthUserDTO>} The created auth user.
      *
      * @example
-     * {example-code}
+     * const authUser = await authModuleService.create({
+     *   provider: "emailpass",
+     *   entity_id: "user@example.com",
+     *   scope: "admin",
+     * })
      */
     create(data: CreateAuthUserDTO, sharedContext?: Context): Promise<AuthUserDTO>;
     /**
-     * This method updates existing users.
+     * This method updates existing auths.
      *
-     * @param {UpdateAuthUserDTO[]} data - The attributes to update in the auth user.
+     * @param {UpdateAuthUserDTO[]} data - The attributes to update in the auth users.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<AuthUserDTO[]>} The updated users.
+     * @returns {Promise<AuthUserDTO[]>} The updated auths.
      *
      * @example
-     * {example-code}
+     * const authUsers = await authModuleService.update([
+     *   {
+     *     id: "authusr_123",
+     *     app_metadata: {
+     *       test: true,
+     *     },
+     *   },
+     * ])
      */
     update(data: UpdateAuthUserDTO[], sharedContext?: Context): Promise<AuthUserDTO[]>;
     /**
-     * This method updates existing user.
+     * This method updates an existing auth.
      *
      * @param {UpdateAuthUserDTO} data - The attributes to update in the auth user.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<AuthUserDTO>} The updated user.
+     * @returns {Promise<AuthUserDTO>} The updated auth.
      *
      * @example
-     * {example-code}
+     * const authUser = await authModuleService.update({
+     *   id: "authusr_123",
+     *   app_metadata: {
+     *     test: true,
+     *   },
+     * })
      */
     update(data: UpdateAuthUserDTO, sharedContext?: Context): Promise<AuthUserDTO>;
     /**
-     * This method deletes users by their IDs.
+     * This method deletes a auth by its ID.
      *
-     * @param {string[]} ids - The list of IDs of users to delete.
+     * @param {string[]} ids - The IDs of the auth.
      * @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 users are deleted.
+     * @returns {Promise<void>} Resolves when {summary}
      *
      * @example
-     * {example-code}
+     * await authModuleService.delete(["authusr_123", "authusr_321"])
      */
     delete(ids: string[], sharedContext?: Context): Promise<void>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/auth/service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EAClB,MAAM,UAAU,CAAA;AAEjB,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE/C;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC5B,CAAA;AACD;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;;;;;;;;OASG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC;;;;;;;;;OASG;IACH,gBAAgB,CACd,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,YAAY,CACV,OAAO,CAAC,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEnC;;;;;;;;;OASG;IACH,MAAM,CACJ,IAAI,EAAE,iBAAiB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;IAE9E;;;;;;;;;OASG;IACH,MAAM,CACJ,IAAI,EAAE,iBAAiB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;IAE9E;;;;;;;;;OASG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC9D"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/auth/service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EAClB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE/C;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC5B,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,gBAAgB,CACd,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,YAAY,CACV,OAAO,CAAC,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,IAAI,EAAE,iBAAiB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;IAE9E;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,IAAI,EAAE,iBAAiB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;IAE9E;;;;;;;;;OASG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC9D"}

package/dist/bundles.d.ts

@@ -25,4 +25,6 @@ export * as WorkflowTypes from "./workflow";
 export * as ApiKeyTypes from "./api-key";
 export * as StoreTypes from "./store";
 export * as CurrencyTypes from "./currency";
+export * as HttpTypes from "./http";
+export * as FileTypes from "./file";
 //# sourceMappingURL=bundles.d.ts.map

package/dist/bundles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bundles.d.ts","sourceRoot":"","sources":["../src/bundles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,UAAU,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,aAAa,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,GAAG,MAAM,OAAO,CAAA;AAC5B,OAAO,KAAK,aAAa,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,gBAAgB,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,gBAAgB,MAAM,eAAe,CAAA;AACjD,OAAO,KAAK,cAAc,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,eAAe,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,UAAU,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,YAAY,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,YAAY,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,cAAc,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAC/C,OAAO,KAAK,iBAAiB,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,kBAAkB,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,QAAQ,MAAM,OAAO,CAAA;AACjC,OAAO,KAAK,oBAAoB,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,aAAa,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,WAAW,MAAM,WAAW,CAAA;AACxC,OAAO,KAAK,UAAU,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,aAAa,MAAM,YAAY,CAAA"}
+{"version":3,"file":"bundles.d.ts","sourceRoot":"","sources":["../src/bundles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,UAAU,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,aAAa,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,GAAG,MAAM,OAAO,CAAA;AAC5B,OAAO,KAAK,aAAa,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,gBAAgB,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,gBAAgB,MAAM,eAAe,CAAA;AACjD,OAAO,KAAK,cAAc,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,eAAe,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,UAAU,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,YAAY,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,YAAY,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,cAAc,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAC/C,OAAO,KAAK,iBAAiB,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,kBAAkB,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,QAAQ,MAAM,OAAO,CAAA;AACjC,OAAO,KAAK,oBAAoB,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,aAAa,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,WAAW,MAAM,WAAW,CAAA;AACxC,OAAO,KAAK,UAAU,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,aAAa,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA"}

package/dist/bundles.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CurrencyTypes = exports.StoreTypes = exports.ApiKeyTypes = exports.WorkflowTypes = exports.UserTypes = exports.TransactionBaseTypes = exports.TaxTypes = exports.StockLocationTypes = exports.SearchTypes = exports.SalesChannelTypes = exports.RegionTypes = exports.PromotionTypes = exports.ProductTypes = exports.PricingTypes = exports.OrderTypes = exports.ModulesSdkTypes = exports.LoggerTypes = exports.InventoryTypes = exports.FulfillmentTypes = exports.FeatureFlagTypes = exports.EventBusTypes = exports.DAL = exports.CustomerTypes = exports.CommonTypes = exports.CartTypes = exports.CacheTypes = exports.AuthTypes = void 0;
+exports.FileTypes = exports.HttpTypes = exports.CurrencyTypes = exports.StoreTypes = exports.ApiKeyTypes = exports.WorkflowTypes = exports.UserTypes = exports.TransactionBaseTypes = exports.TaxTypes = exports.StockLocationTypes = exports.SearchTypes = exports.SalesChannelTypes = exports.RegionTypes = exports.PromotionTypes = exports.ProductTypes = exports.PricingTypes = exports.OrderTypes = exports.ModulesSdkTypes = exports.LoggerTypes = exports.InventoryTypes = exports.FulfillmentTypes = exports.FeatureFlagTypes = exports.EventBusTypes = exports.DAL = exports.CustomerTypes = exports.CommonTypes = exports.CartTypes = exports.CacheTypes = exports.AuthTypes = void 0;
 exports.AuthTypes = __importStar(require("./auth"));
 exports.CacheTypes = __importStar(require("./cache"));
 exports.CartTypes = __importStar(require("./cart"));
@@ -51,4 +51,6 @@ exports.WorkflowTypes = __importStar(require("./workflow"));
 exports.ApiKeyTypes = __importStar(require("./api-key"));
 exports.StoreTypes = __importStar(require("./store"));
 exports.CurrencyTypes = __importStar(require("./currency"));
+exports.HttpTypes = __importStar(require("./http"));
+exports.FileTypes = __importStar(require("./file"));
 //# sourceMappingURL=bundles.js.map

package/dist/bundles.js.map

@@ -1 +1 @@
-{"version":3,"file":"bundles.js","sourceRoot":"","sources":["../src/bundles.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAmC;AACnC,sDAAqC;AACrC,oDAAmC;AACnC,wDAAuC;AACvC,4DAA2C;AAC3C,6CAA4B;AAC5B,6DAA4C;AAC5C,mEAAkD;AAClD,kEAAiD;AACjD,8DAA6C;AAC7C,wDAAuC;AACvC,iEAAgD;AAChD,sDAAqC;AACrC,0DAAyC;AACzC,0DAAyC;AACzC,8DAA6C;AAC7C,gEAA+C;AAC/C,qEAAoD;AACpD,wDAAuC;AACvC,uEAAsD;AACtD,kDAAiC;AACjC,2EAA0D;AAC1D,oDAAmC;AACnC,4DAA2C;AAC3C,yDAAwC;AACxC,sDAAqC;AACrC,4DAA2C"}
+{"version":3,"file":"bundles.js","sourceRoot":"","sources":["../src/bundles.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAmC;AACnC,sDAAqC;AACrC,oDAAmC;AACnC,wDAAuC;AACvC,4DAA2C;AAC3C,6CAA4B;AAC5B,6DAA4C;AAC5C,mEAAkD;AAClD,kEAAiD;AACjD,8DAA6C;AAC7C,wDAAuC;AACvC,iEAAgD;AAChD,sDAAqC;AACrC,0DAAyC;AACzC,0DAAyC;AACzC,8DAA6C;AAC7C,gEAA+C;AAC/C,qEAAoD;AACpD,wDAAuC;AACvC,uEAAsD;AACtD,kDAAiC;AACjC,2EAA0D;AAC1D,oDAAmC;AACnC,4DAA2C;AAC3C,yDAAwC;AACxC,sDAAqC;AACrC,4DAA2C;AAC3C,oDAAmC;AACnC,oDAAmC"}