@misiki/gocommerce-connector 0.4.6 → 0.4.8

package/dist/{index-B0Gf_Bvg.d.cts → index-Bjx8kR8G.d.cts}

@@ -374,6 +374,8 @@ type Customer = {
     id: number;
     email: string;
     email_verified: boolean;
+    /** The phone was proved with a code and signs in to this account (D118). */
+    phone_verified?: boolean;
     name: string;
     phone: string;
     created_at: string;
@@ -1126,6 +1128,7 @@ declare function toUser(c: Customer): {
     email: string;
     emailVerified: boolean;
     phone: string | null;
+    phoneVerified: boolean;
     firstName: string;
     lastName: string;
     name: string;
@@ -4669,10 +4672,16 @@ declare const orderService: OrderService;
  * as "Accounts are not available on this store" rather than as a route error.
  */
 declare class UserService extends BaseService {
-    /** Email and password. The answer is the user object the storefront keeps in its `me` cookie. */
-    login({ email, password }: {
+    /**
+     * Email and password. The answer is the user object the storefront keeps in its `me` cookie.
+     * With `phone` and `phoneToken` from `verifyOtp({ askIfNew: true })`, the phone is added to
+     * the account as it signs in (D123).
+     */
+    login({ email, password, phone, phoneToken, }: {
         email: string;
         password: string;
+        phone?: string;
+        phoneToken?: string;
         cartId?: string | null;
     }): Promise<{
         id: string;
@@ -4686,6 +4695,7 @@ declare class UserService extends BaseService {
         avatar: null;
         role: string;
         emailVerified: boolean;
+        phoneVerified: boolean;
         storeId: null;
     }>;
     signup({ email, password, firstName, lastName, phone, }: {
@@ -4708,6 +4718,7 @@ declare class UserService extends BaseService {
         avatar: null;
         role: string;
         emailVerified: boolean;
+        phoneVerified: boolean;
         storeId: null;
     }>;
     /** Signs out here and on the engine. The storefront assigns the answer to its user: `null`. */
@@ -4718,6 +4729,7 @@ declare class UserService extends BaseService {
         email: string;
         emailVerified: boolean;
         phone: string | null;
+        phoneVerified: boolean;
         firstName: string;
         lastName: string;
         name: string;
@@ -4739,6 +4751,7 @@ declare class UserService extends BaseService {
         email: string;
         emailVerified: boolean;
         phone: string | null;
+        phoneVerified: boolean;
         firstName: string;
         lastName: string;
         name: string;
@@ -4763,6 +4776,7 @@ declare class UserService extends BaseService {
         email: string;
         emailVerified: boolean;
         phone: string | null;
+        phoneVerified: boolean;
         firstName: string;
         lastName: string;
         name: string;
@@ -4793,6 +4807,7 @@ declare class UserService extends BaseService {
         avatar: null;
         role: string;
         emailVerified: boolean;
+        phoneVerified: boolean;
         storeId: null;
     }>;
     /**
@@ -4918,6 +4933,7 @@ declare class UserService extends BaseService {
         avatar: null;
         role: string;
         emailVerified: boolean;
+        phoneVerified: boolean;
         storeId: null;
     }>;
     /** An identity call, with a 404 from a build without the module said in words. */
@@ -4934,7 +4950,7 @@ declare class AuthService extends UserService {
      * How this store signs customers in: `email_password` or `phone_otp`.
      * A store whose accounts module says nothing signs in by email.
      */
-    loginMethod(): Promise<'email_password' | 'phone_otp'>;
+    loginMethod(): Promise<'email_password' | 'phone_otp' | 'email_or_phone'>;
     forgotPassword({ email }: {
         email: string;
         referrer?: string;
@@ -4958,6 +4974,7 @@ declare class AuthService extends UserService {
         avatar: null;
         role: string;
         emailVerified: boolean;
+        phoneVerified: boolean;
         storeId: null;
     }>;
     /** Answers `{ errorCode, message }` on failure rather than throwing: that is how the page reads it. */
@@ -4968,6 +4985,7 @@ declare class AuthService extends UserService {
         email: string;
         emailVerified: boolean;
         phone: string | null;
+        phoneVerified: boolean;
         firstName: string;
         lastName: string;
         name: string;
@@ -4987,10 +5005,38 @@ declare class AuthService extends UserService {
     }): Promise<{
         expiresInMinutes: number;
     }>;
-    /** Signs in the account on `phone` with the code it was sent, opening one the first time. */
-    verifyOtp({ phone, otp }: {
+    /**
+     * Signs in the account on `phone` with the code it was sent, opening one the first time.
+     * With `askIfNew`, on a store that signs in either way, a phone with no account opens none:
+     * the answer is `{ newPhone: true, phoneToken }`, and the storefront asks "Already have an
+     * account?" — `login` with the token adds the phone to it, `openPhoneAccount` opens a new one (D123).
+     */
+    verifyOtp({ phone, otp, askIfNew }: {
         phone: string;
         otp: string;
+        askIfNew?: boolean;
+    }): Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        phone: string | null;
+        firstName: string;
+        lastName: string;
+        name: string;
+        fullName: string;
+        avatar: null;
+        role: string;
+        emailVerified: boolean;
+        phoneVerified: boolean;
+        storeId: null;
+    } | {
+        newPhone: true;
+        phoneToken: string;
+    }>;
+    /** Opens a new account on a phone `verifyOtp({ askIfNew: true })` proved, and signs it in (D123). */
+    openPhoneAccount({ phone, phoneToken }: {
+        phone: string;
+        phoneToken: string;
     }): Promise<{
         id: string;
         userId: string;
@@ -5003,6 +5049,7 @@ declare class AuthService extends UserService {
         avatar: null;
         role: string;
         emailVerified: boolean;
+        phoneVerified: boolean;
         storeId: null;
     }>;
     joinAsAdmin(): Promise<never>;
@@ -5015,6 +5062,7 @@ declare class ProfileService extends UserService {
         email: string;
         emailVerified: boolean;
         phone: string | null;
+        phoneVerified: boolean;
         firstName: string;
         lastName: string;
         name: string;
@@ -5035,6 +5083,33 @@ declare class ProfileService extends UserService {
         email: string;
         emailVerified: boolean;
         phone: string | null;
+        phoneVerified: boolean;
+        firstName: string;
+        lastName: string;
+        name: string;
+        fullName: string;
+        avatar: null;
+        role: string;
+        createdAt: string;
+        updatedAt: string;
+    }>;
+    /** Texts a code to a phone the signed-in shopper wants to add (D118). */
+    requestPhoneLink({ phone }: {
+        phone: string;
+    }): Promise<{
+        expiresInMinutes: number;
+    }>;
+    /** Adds the phone with its code; from then on it signs in to this account too. */
+    verifyPhoneLink({ phone, otp }: {
+        phone: string;
+        otp: string;
+    }): Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        emailVerified: boolean;
+        phone: string | null;
+        phoneVerified: boolean;
         firstName: string;
         lastName: string;
         name: string;

package/dist/{index-B0Gf_Bvg.d.ts → index-Bjx8kR8G.d.ts}

@@ -374,6 +374,8 @@ type Customer = {
     id: number;
     email: string;
     email_verified: boolean;
+    /** The phone was proved with a code and signs in to this account (D118). */
+    phone_verified?: boolean;
     name: string;
     phone: string;
     created_at: string;
@@ -1126,6 +1128,7 @@ declare function toUser(c: Customer): {
     email: string;
     emailVerified: boolean;
     phone: string | null;
+    phoneVerified: boolean;
     firstName: string;
     lastName: string;
     name: string;
@@ -4669,10 +4672,16 @@ declare const orderService: OrderService;
  * as "Accounts are not available on this store" rather than as a route error.
  */
 declare class UserService extends BaseService {
-    /** Email and password. The answer is the user object the storefront keeps in its `me` cookie. */
-    login({ email, password }: {
+    /**
+     * Email and password. The answer is the user object the storefront keeps in its `me` cookie.
+     * With `phone` and `phoneToken` from `verifyOtp({ askIfNew: true })`, the phone is added to
+     * the account as it signs in (D123).
+     */
+    login({ email, password, phone, phoneToken, }: {
         email: string;
         password: string;
+        phone?: string;
+        phoneToken?: string;
         cartId?: string | null;
     }): Promise<{
         id: string;
@@ -4686,6 +4695,7 @@ declare class UserService extends BaseService {
         avatar: null;
         role: string;
         emailVerified: boolean;
+        phoneVerified: boolean;
         storeId: null;
     }>;
     signup({ email, password, firstName, lastName, phone, }: {
@@ -4708,6 +4718,7 @@ declare class UserService extends BaseService {
         avatar: null;
         role: string;
         emailVerified: boolean;
+        phoneVerified: boolean;
         storeId: null;
     }>;
     /** Signs out here and on the engine. The storefront assigns the answer to its user: `null`. */
@@ -4718,6 +4729,7 @@ declare class UserService extends BaseService {
         email: string;
         emailVerified: boolean;
         phone: string | null;
+        phoneVerified: boolean;
         firstName: string;
         lastName: string;
         name: string;
@@ -4739,6 +4751,7 @@ declare class UserService extends BaseService {
         email: string;
         emailVerified: boolean;
         phone: string | null;
+        phoneVerified: boolean;
         firstName: string;
         lastName: string;
         name: string;
@@ -4763,6 +4776,7 @@ declare class UserService extends BaseService {
         email: string;
         emailVerified: boolean;
         phone: string | null;
+        phoneVerified: boolean;
         firstName: string;
         lastName: string;
         name: string;
@@ -4793,6 +4807,7 @@ declare class UserService extends BaseService {
         avatar: null;
         role: string;
         emailVerified: boolean;
+        phoneVerified: boolean;
         storeId: null;
     }>;
     /**
@@ -4918,6 +4933,7 @@ declare class UserService extends BaseService {
         avatar: null;
         role: string;
         emailVerified: boolean;
+        phoneVerified: boolean;
         storeId: null;
     }>;
     /** An identity call, with a 404 from a build without the module said in words. */
@@ -4934,7 +4950,7 @@ declare class AuthService extends UserService {
      * How this store signs customers in: `email_password` or `phone_otp`.
      * A store whose accounts module says nothing signs in by email.
      */
-    loginMethod(): Promise<'email_password' | 'phone_otp'>;
+    loginMethod(): Promise<'email_password' | 'phone_otp' | 'email_or_phone'>;
     forgotPassword({ email }: {
         email: string;
         referrer?: string;
@@ -4958,6 +4974,7 @@ declare class AuthService extends UserService {
         avatar: null;
         role: string;
         emailVerified: boolean;
+        phoneVerified: boolean;
         storeId: null;
     }>;
     /** Answers `{ errorCode, message }` on failure rather than throwing: that is how the page reads it. */
@@ -4968,6 +4985,7 @@ declare class AuthService extends UserService {
         email: string;
         emailVerified: boolean;
         phone: string | null;
+        phoneVerified: boolean;
         firstName: string;
         lastName: string;
         name: string;
@@ -4987,10 +5005,38 @@ declare class AuthService extends UserService {
     }): Promise<{
         expiresInMinutes: number;
     }>;
-    /** Signs in the account on `phone` with the code it was sent, opening one the first time. */
-    verifyOtp({ phone, otp }: {
+    /**
+     * Signs in the account on `phone` with the code it was sent, opening one the first time.
+     * With `askIfNew`, on a store that signs in either way, a phone with no account opens none:
+     * the answer is `{ newPhone: true, phoneToken }`, and the storefront asks "Already have an
+     * account?" — `login` with the token adds the phone to it, `openPhoneAccount` opens a new one (D123).
+     */
+    verifyOtp({ phone, otp, askIfNew }: {
         phone: string;
         otp: string;
+        askIfNew?: boolean;
+    }): Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        phone: string | null;
+        firstName: string;
+        lastName: string;
+        name: string;
+        fullName: string;
+        avatar: null;
+        role: string;
+        emailVerified: boolean;
+        phoneVerified: boolean;
+        storeId: null;
+    } | {
+        newPhone: true;
+        phoneToken: string;
+    }>;
+    /** Opens a new account on a phone `verifyOtp({ askIfNew: true })` proved, and signs it in (D123). */
+    openPhoneAccount({ phone, phoneToken }: {
+        phone: string;
+        phoneToken: string;
     }): Promise<{
         id: string;
         userId: string;
@@ -5003,6 +5049,7 @@ declare class AuthService extends UserService {
         avatar: null;
         role: string;
         emailVerified: boolean;
+        phoneVerified: boolean;
         storeId: null;
     }>;
     joinAsAdmin(): Promise<never>;
@@ -5015,6 +5062,7 @@ declare class ProfileService extends UserService {
         email: string;
         emailVerified: boolean;
         phone: string | null;
+        phoneVerified: boolean;
         firstName: string;
         lastName: string;
         name: string;
@@ -5035,6 +5083,33 @@ declare class ProfileService extends UserService {
         email: string;
         emailVerified: boolean;
         phone: string | null;
+        phoneVerified: boolean;
+        firstName: string;
+        lastName: string;
+        name: string;
+        fullName: string;
+        avatar: null;
+        role: string;
+        createdAt: string;
+        updatedAt: string;
+    }>;
+    /** Texts a code to a phone the signed-in shopper wants to add (D118). */
+    requestPhoneLink({ phone }: {
+        phone: string;
+    }): Promise<{
+        expiresInMinutes: number;
+    }>;
+    /** Adds the phone with its code; from then on it signs in to this account too. */
+    verifyPhoneLink({ phone, otp }: {
+        phone: string;
+        otp: string;
+    }): Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        emailVerified: boolean;
+        phone: string | null;
+        phoneVerified: boolean;
         firstName: string;
         lastName: string;
         name: string;

package/dist/index.cjs

@@ -205,6 +205,7 @@ function toMe(c) {
     avatar: null,
     role: "USER",
     emailVerified: c.email_verified,
+    phoneVerified: !!c.phone_verified,
     storeId: null
   };
 }
@@ -986,6 +987,7 @@ function toUser(c) {
     email: c.email,
     emailVerified: c.email_verified,
     phone: c.phone || null,
+    phoneVerified: !!c.phone_verified,
     firstName: firstName || "",
     lastName: rest.join(" "),
     name: c.name,
@@ -2083,11 +2085,24 @@ var orderService = new OrderService();
 
 // src/services/user-service.ts
 var UserService = class extends BaseService {
-  /** Email and password. The answer is the user object the storefront keeps in its `me` cookie. */
-  async login({ email, password }) {
+  /**
+   * Email and password. The answer is the user object the storefront keeps in its `me` cookie.
+   * With `phone` and `phoneToken` from `verifyOtp({ askIfNew: true })`, the phone is added to
+   * the account as it signs in (D123).
+   */
+  async login({
+    email,
+    password,
+    phone,
+    phoneToken
+  }) {
     const auth = await this.account("/x/identity/login", {
       method: "POST",
-      body: { email: String(email ?? "").trim(), password: String(password ?? "") }
+      body: {
+        email: String(email ?? "").trim(),
+        password: String(password ?? ""),
+        ...phoneToken ? { phone: String(phone ?? "").trim(), phone_token: phoneToken } : {}
+      }
     });
     return this.signedIn(auth);
   }
@@ -2220,7 +2235,7 @@ var AuthService = class extends UserService {
   async loginMethod() {
     try {
       const method = (await this.facts.plugins()).get("identity")?.settings?.login_method;
-      return method === "phone_otp" ? "phone_otp" : "email_password";
+      return method === "phone_otp" || method === "email_or_phone" ? method : "email_password";
     } catch {
       return "email_password";
     }
@@ -2259,11 +2274,29 @@ var AuthService = class extends UserService {
     });
     return { expiresInMinutes: res?.expires_in_minutes ?? 10 };
   }
-  /** Signs in the account on `phone` with the code it was sent, opening one the first time. */
-  async verifyOtp({ phone, otp }) {
-    const auth = await this.account("/x/identity/otp/verify", {
+  /**
+   * Signs in the account on `phone` with the code it was sent, opening one the first time.
+   * With `askIfNew`, on a store that signs in either way, a phone with no account opens none:
+   * the answer is `{ newPhone: true, phoneToken }`, and the storefront asks "Already have an
+   * account?" — `login` with the token adds the phone to it, `openPhoneAccount` opens a new one (D123).
+   */
+  async verifyOtp({ phone, otp, askIfNew }) {
+    const res = await this.account("/x/identity/otp/verify", {
       method: "POST",
-      body: { phone: String(phone ?? "").trim(), code: String(otp ?? "").trim() }
+      body: {
+        phone: String(phone ?? "").trim(),
+        code: String(otp ?? "").trim(),
+        ...askIfNew ? { ask_if_new: true } : {}
+      }
+    });
+    if ("new_phone" in res && res.new_phone) return { newPhone: true, phoneToken: res.phone_token };
+    return this.signedIn(res);
+  }
+  /** Opens a new account on a phone `verifyOtp({ askIfNew: true })` proved, and signs it in (D123). */
+  async openPhoneAccount({ phone, phoneToken }) {
+    const auth = await this.account("/x/identity/otp/new-account", {
+      method: "POST",
+      body: { phone: String(phone ?? "").trim(), phone_token: phoneToken }
     });
     return this.signedIn(auth);
   }
@@ -2278,6 +2311,25 @@ var ProfileService = class extends UserService {
   async save(profile) {
     return this.updateProfile(profile);
   }
+  /** Texts a code to a phone the signed-in shopper wants to add (D118). */
+  async requestPhoneLink({ phone }) {
+    const res = await this.account("/x/identity/me/phone", {
+      method: "POST",
+      auth: true,
+      body: { phone: String(phone ?? "").trim() }
+    });
+    return { expiresInMinutes: res?.expires_in_minutes ?? 10 };
+  }
+  /** Adds the phone with its code; from then on it signs in to this account too. */
+  async verifyPhoneLink({ phone, otp }) {
+    const c = await this.account("/x/identity/me/phone/verify", {
+      method: "POST",
+      auth: true,
+      body: { phone: String(phone ?? "").trim(), code: String(otp ?? "").trim() }
+    });
+    updateMe(c);
+    return toUser(c);
+  }
 };
 var userService = new UserService();
 var authService = new AuthService();
@@ -2624,7 +2676,7 @@ var StoreService = class extends BaseService {
       // The one way this store signs customers in (D116), which the sign-in
       // form reads as PHONE or EMAIL. Without the accounts module the static
       // record says.
-      ...plugins.has("identity") ? { loginType: plugins.get("identity")?.settings?.login_method === "phone_otp" ? "PHONE" : "EMAIL" } : {}
+      ...plugins.has("identity") ? { loginType: LOGIN_TYPES[String(plugins.get("identity")?.settings?.login_method)] ?? "EMAIL" } : {}
     };
   }
 };
@@ -2643,6 +2695,7 @@ function regionName(code) {
     return code;
   }
 }
+var LOGIN_TYPES = { phone_otp: "PHONE", email_or_phone: "BOTH", email_password: "EMAIL" };
 
 // src/services/page-service.ts
 var PageService = class extends BaseService {