@productcraft/auth 0.5.2 → 0.6.0

package/dist/index.d.cts

@@ -1702,6 +1702,18 @@ type ConsumerRequestPasswordResetDto = {
     phone?: string;
 };
 
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+type ConsumerSendPasswordResetEmailDto = {
+    /**
+     * @description Email contact value to send the password-reset code to.
+     * @type string
+     */
+    email: string;
+};
+
 /**
  * Generated by Kubb (https://kubb.dev/).
  * Do not edit manually.
@@ -2241,12 +2253,40 @@ declare class ConsumerScope {
         refresh: (data: ConsumerRefreshDto) => Promise<ConsumerTokenResponseDto>;
         logout: (data: ConsumerLogoutDto) => Promise<any>;
         /**
-         * PAK-required: caller must instantiate `Auth` with
+         * Mint a 6-digit password-reset code. **Sends no email.** Returns
+         * `{ code, expires_at }` for delivery via your own channel — or
+         * `{}` when the contact doesn't match a verified account (uniform
+         * shape — no account enumeration).
+         *
+         * If you want Mail to deliver the code for you, call
+         * {@link sendPasswordResetEmail} instead. Calling this one and
+         * discarding the `code` means the user never hears anything.
+         *
+         * PAK-required with `auth.user.password-reset.create`: caller must
+         * instantiate `Auth` with
          * `auth: { type: "apiKey", key: "pcft_live_..." }`. The
          * kubb-generated `headers.authorization` slot is a stub — the
          * HTTP client's auth middleware overrides whatever's passed.
          */
         requestReset: (data: ConsumerRequestPasswordResetDto) => Promise<ConsumerCodeIssueResponseDto>;
+        /**
+         * Mint + dispatch a password-reset email via Mail in one call.
+         * Returns `{ expires_at }` on success; the plaintext code is NOT
+         * returned. Returns `{}` when the contact is missing or unverified
+         * (same enumeration defence as {@link requestReset}).
+         *
+         * This is the counterpart to {@link sendVerificationEmail} for the
+         * reset slot, and the method you want for a plain "forgot
+         * password" flow — {@link requestReset} only mints, it does not
+         * email.
+         *
+         * PAK-required with `auth.user.password-reset.send-email` —
+         * distinct permission from the bare mint so customers can enable
+         * mint without enabling outbound Mail traffic. Surfaces typed 412
+         * precondition errors (e.g. `ENVOI_NOT_ENABLED`,
+         * `ENVOI_TEMPLATE_NOT_CONFIGURED`) rather than failing silently.
+         */
+        sendPasswordResetEmail: (data: ConsumerSendPasswordResetEmailDto) => Promise<ConsumerCodeDispatchResponseDto>;
         resetPassword: (data: ConsumerResetPasswordDto) => Promise<any>;
         /**
          * Mint a 6-digit contact-verification code bound to the email or

package/dist/index.d.ts

@@ -1702,6 +1702,18 @@ type ConsumerRequestPasswordResetDto = {
     phone?: string;
 };
 
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+type ConsumerSendPasswordResetEmailDto = {
+    /**
+     * @description Email contact value to send the password-reset code to.
+     * @type string
+     */
+    email: string;
+};
+
 /**
  * Generated by Kubb (https://kubb.dev/).
  * Do not edit manually.
@@ -2241,12 +2253,40 @@ declare class ConsumerScope {
         refresh: (data: ConsumerRefreshDto) => Promise<ConsumerTokenResponseDto>;
         logout: (data: ConsumerLogoutDto) => Promise<any>;
         /**
-         * PAK-required: caller must instantiate `Auth` with
+         * Mint a 6-digit password-reset code. **Sends no email.** Returns
+         * `{ code, expires_at }` for delivery via your own channel — or
+         * `{}` when the contact doesn't match a verified account (uniform
+         * shape — no account enumeration).
+         *
+         * If you want Mail to deliver the code for you, call
+         * {@link sendPasswordResetEmail} instead. Calling this one and
+         * discarding the `code` means the user never hears anything.
+         *
+         * PAK-required with `auth.user.password-reset.create`: caller must
+         * instantiate `Auth` with
          * `auth: { type: "apiKey", key: "pcft_live_..." }`. The
          * kubb-generated `headers.authorization` slot is a stub — the
          * HTTP client's auth middleware overrides whatever's passed.
          */
         requestReset: (data: ConsumerRequestPasswordResetDto) => Promise<ConsumerCodeIssueResponseDto>;
+        /**
+         * Mint + dispatch a password-reset email via Mail in one call.
+         * Returns `{ expires_at }` on success; the plaintext code is NOT
+         * returned. Returns `{}` when the contact is missing or unverified
+         * (same enumeration defence as {@link requestReset}).
+         *
+         * This is the counterpart to {@link sendVerificationEmail} for the
+         * reset slot, and the method you want for a plain "forgot
+         * password" flow — {@link requestReset} only mints, it does not
+         * email.
+         *
+         * PAK-required with `auth.user.password-reset.send-email` —
+         * distinct permission from the bare mint so customers can enable
+         * mint without enabling outbound Mail traffic. Surfaces typed 412
+         * precondition errors (e.g. `ENVOI_NOT_ENABLED`,
+         * `ENVOI_TEMPLATE_NOT_CONFIGURED`) rather than failing silently.
+         */
+        sendPasswordResetEmail: (data: ConsumerSendPasswordResetEmailDto) => Promise<ConsumerCodeDispatchResponseDto>;
         resetPassword: (data: ConsumerResetPasswordDto) => Promise<any>;
         /**
          * Mint a 6-digit contact-verification code bound to the email or

package/dist/index.js

@@ -1359,6 +1359,36 @@ async function consumerAuthControllerRequestPasswordReset({
   return res.data;
 }
 
+// src/_generated/clients/consumerAuth/consumerAuthControllerSendPasswordResetEmail.ts
+function getConsumerAuthControllerSendPasswordResetEmailUrl({
+  appSlug
+}) {
+  const app_slug = appSlug;
+  const res = {
+    method: "POST",
+    url: `/${app_slug}/v1/auth/send-password-reset-email`
+  };
+  return res;
+}
+async function consumerAuthControllerSendPasswordResetEmail({
+  appSlug,
+  data,
+  headers
+}, config = {}) {
+  const { client: request = client, ...requestConfig } = config;
+  const requestData = data;
+  const res = await request({
+    method: "POST",
+    url: getConsumerAuthControllerSendPasswordResetEmailUrl({
+      appSlug
+    }).url.toString(),
+    data: requestData,
+    ...requestConfig,
+    headers: { ...headers, ...requestConfig.headers }
+  });
+  return res.data;
+}
+
 // src/_generated/clients/consumerAuth/consumerAuthControllerResetPassword.ts
 function getConsumerAuthControllerResetPasswordUrl({
   appSlug
@@ -1885,7 +1915,17 @@ var ConsumerScope = class {
       { client: this.client }
     ),
     /**
-     * PAK-required: caller must instantiate `Auth` with
+     * Mint a 6-digit password-reset code. **Sends no email.** Returns
+     * `{ code, expires_at }` for delivery via your own channel — or
+     * `{}` when the contact doesn't match a verified account (uniform
+     * shape — no account enumeration).
+     *
+     * If you want Mail to deliver the code for you, call
+     * {@link sendPasswordResetEmail} instead. Calling this one and
+     * discarding the `code` means the user never hears anything.
+     *
+     * PAK-required with `auth.user.password-reset.create`: caller must
+     * instantiate `Auth` with
      * `auth: { type: "apiKey", key: "pcft_live_..." }`. The
      * kubb-generated `headers.authorization` slot is a stub — the
      * HTTP client's auth middleware overrides whatever's passed.
@@ -1894,6 +1934,31 @@ var ConsumerScope = class {
       { appSlug: this.appSlug, data, headers: { authorization: "" } },
       { client: this.client }
     ),
+    /**
+     * Mint + dispatch a password-reset email via Mail in one call.
+     * Returns `{ expires_at }` on success; the plaintext code is NOT
+     * returned. Returns `{}` when the contact is missing or unverified
+     * (same enumeration defence as {@link requestReset}).
+     *
+     * This is the counterpart to {@link sendVerificationEmail} for the
+     * reset slot, and the method you want for a plain "forgot
+     * password" flow — {@link requestReset} only mints, it does not
+     * email.
+     *
+     * PAK-required with `auth.user.password-reset.send-email` —
+     * distinct permission from the bare mint so customers can enable
+     * mint without enabling outbound Mail traffic. Surfaces typed 412
+     * precondition errors (e.g. `ENVOI_NOT_ENABLED`,
+     * `ENVOI_TEMPLATE_NOT_CONFIGURED`) rather than failing silently.
+     */
+    sendPasswordResetEmail: (data) => consumerAuthControllerSendPasswordResetEmail(
+      {
+        appSlug: this.appSlug,
+        data,
+        headers: { authorization: "" }
+      },
+      { client: this.client }
+    ),
     resetPassword: (data) => consumerAuthControllerResetPassword(
       { appSlug: this.appSlug, data },
       { client: this.client }