@misiki/gocommerce-connector 0.4.3 → 0.4.5

package/dist/{index-wGZwLTCe.d.cts → index-CmPI-hcH.d.cts}

@@ -4534,7 +4534,124 @@ declare class OrderService extends BaseService {
         noOfPage: number;
         page: number;
     }>;
-    getOrderByEmailAndOTP(): Promise<never>;
+    /**
+     * Sends a 4-digit code to the email or phone on the order, when `contact`
+     * is that email or phone. The engine answers the same either way, so this
+     * resolves whether or not anything was sent.
+     */
+    requestOrderCode({ orderNo, contact }: {
+        orderNo: string;
+        contact: string;
+    }): Promise<{
+        expiresInMinutes: number;
+    }>;
+    /**
+     * Opens an order with the code `requestOrderCode` sent. The token it answers
+     * is kept like an order placed in this browser, so the order page and
+     * `getOrder` read it again without another code.
+     */
+    getOrderByEmailAndOTP({ orderNo, otp }: {
+        orderNo: string;
+        otp: string;
+        email?: string;
+    }): Promise<{
+        data: {
+            id: string;
+            orderNo: string;
+            orderNumber: string;
+            number: string;
+            parentOrderNo: string;
+            status: string;
+            engineStatus: string;
+            paymentStatus: string;
+            paymentMethod: string;
+            currencyCode: string;
+            subtotal: number;
+            shippingCharges: number;
+            discount: number;
+            tax: number;
+            taxIncluded: boolean;
+            total: number;
+            refunded: number;
+            codCharges: number;
+            coupon: {
+                code: string;
+            } | null;
+            userEmail: string;
+            email: string;
+            phone: string | null;
+            shippingAddress: {
+                firstName: string;
+                lastName: string;
+                email: string | null;
+                phone: string | null;
+                address_1: string;
+                address_2: string;
+                city: string;
+                state: string;
+                zip: string;
+                country: string;
+                countryCode: string;
+            } | null;
+            billingAddress: {
+                firstName: string;
+                lastName: string;
+                email: string | null;
+                phone: string | null;
+                address_1: string;
+                address_2: string;
+                city: string;
+                state: string;
+                zip: string;
+                country: string;
+                countryCode: string;
+            } | null;
+            shippingMethod: string | null;
+            shippingRate: {
+                name: string;
+            } | null;
+            lineItems: {
+                id: string;
+                productId: string;
+                variantId: string;
+                sku: string;
+                title: string;
+                name: string;
+                slug: string;
+                thumbnail: string | null;
+                img: string | null;
+                variantTitle: string;
+                qty: number;
+                shippedQty: number;
+                price: number;
+                mrp: number;
+                subtotal: number;
+                total: number;
+                currencyCode: string;
+                status: string;
+                files: never[];
+                usedOptions: never[];
+            }[];
+            fulfillments: {
+                id: string;
+                status: string;
+                carrier: string;
+                trackingNumber: string | null;
+                trackingUrl: string | null;
+                lineItems: {
+                    id: string;
+                    title: string;
+                    qty: number;
+                }[];
+                createdAt: string;
+            }[];
+            tracking: never[];
+            orderHistory: never[];
+            isReplaceOrReturn: boolean;
+            createdAt: string;
+            updatedAt: string;
+        }[];
+    }>;
 }
 declare const orderService: OrderService;
 
@@ -4784,15 +4901,35 @@ declare class UserService extends BaseService {
     deleteUser(): Promise<never>;
     checkEmail(): Promise<never>;
     joinAsVendor(): Promise<never>;
-    private signedIn;
+    protected signedIn(auth: AuthResponse): Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        phone: string | null;
+        firstName: string;
+        lastName: string;
+        name: string;
+        fullName: string;
+        avatar: null;
+        role: string;
+        emailVerified: boolean;
+        storeId: null;
+    }>;
     /** An identity call, with a 404 from a build without the module said in words. */
     protected account<T>(path: string, req?: Parameters<BaseService['engine']>[1]): Promise<T>;
 }
 /**
- * Password resets and email confirmation. Phone sign-in by one-time code is a
- * Litekart flow; the engine has no such thing and says so.
+ * Password resets, email confirmation, and phone sign-in. A store signs its
+ * customers in one way (D116), read from `loginMethod`; the engine refuses
+ * the other.
  */
 declare class AuthService extends UserService {
+    private readonly facts;
+    /**
+     * 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'>;
     forgotPassword({ email }: {
         email: string;
         referrer?: string;
@@ -4839,8 +4976,30 @@ declare class AuthService extends UserService {
         errorCode: string;
         message: string;
     }>;
-    getOtp(): Promise<never>;
-    verifyOtp(): Promise<never>;
+    /** Texts a 4-digit sign-in code to `phone`, which needs its country code. */
+    getOtp({ phone }: {
+        phone: string;
+    }): Promise<{
+        expiresInMinutes: number;
+    }>;
+    /** Signs in the account on `phone` with the code it was sent, opening one the first time. */
+    verifyOtp({ phone, otp }: {
+        phone: string;
+        otp: string;
+    }): Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        phone: string | null;
+        firstName: string;
+        lastName: string;
+        name: string;
+        fullName: string;
+        avatar: null;
+        role: string;
+        emailVerified: boolean;
+        storeId: null;
+    }>;
     joinAsAdmin(): Promise<never>;
 }
 /** The `/my/profile` form: the same account, read and saved. */

package/dist/{index-wGZwLTCe.d.ts → index-CmPI-hcH.d.ts}

@@ -4534,7 +4534,124 @@ declare class OrderService extends BaseService {
         noOfPage: number;
         page: number;
     }>;
-    getOrderByEmailAndOTP(): Promise<never>;
+    /**
+     * Sends a 4-digit code to the email or phone on the order, when `contact`
+     * is that email or phone. The engine answers the same either way, so this
+     * resolves whether or not anything was sent.
+     */
+    requestOrderCode({ orderNo, contact }: {
+        orderNo: string;
+        contact: string;
+    }): Promise<{
+        expiresInMinutes: number;
+    }>;
+    /**
+     * Opens an order with the code `requestOrderCode` sent. The token it answers
+     * is kept like an order placed in this browser, so the order page and
+     * `getOrder` read it again without another code.
+     */
+    getOrderByEmailAndOTP({ orderNo, otp }: {
+        orderNo: string;
+        otp: string;
+        email?: string;
+    }): Promise<{
+        data: {
+            id: string;
+            orderNo: string;
+            orderNumber: string;
+            number: string;
+            parentOrderNo: string;
+            status: string;
+            engineStatus: string;
+            paymentStatus: string;
+            paymentMethod: string;
+            currencyCode: string;
+            subtotal: number;
+            shippingCharges: number;
+            discount: number;
+            tax: number;
+            taxIncluded: boolean;
+            total: number;
+            refunded: number;
+            codCharges: number;
+            coupon: {
+                code: string;
+            } | null;
+            userEmail: string;
+            email: string;
+            phone: string | null;
+            shippingAddress: {
+                firstName: string;
+                lastName: string;
+                email: string | null;
+                phone: string | null;
+                address_1: string;
+                address_2: string;
+                city: string;
+                state: string;
+                zip: string;
+                country: string;
+                countryCode: string;
+            } | null;
+            billingAddress: {
+                firstName: string;
+                lastName: string;
+                email: string | null;
+                phone: string | null;
+                address_1: string;
+                address_2: string;
+                city: string;
+                state: string;
+                zip: string;
+                country: string;
+                countryCode: string;
+            } | null;
+            shippingMethod: string | null;
+            shippingRate: {
+                name: string;
+            } | null;
+            lineItems: {
+                id: string;
+                productId: string;
+                variantId: string;
+                sku: string;
+                title: string;
+                name: string;
+                slug: string;
+                thumbnail: string | null;
+                img: string | null;
+                variantTitle: string;
+                qty: number;
+                shippedQty: number;
+                price: number;
+                mrp: number;
+                subtotal: number;
+                total: number;
+                currencyCode: string;
+                status: string;
+                files: never[];
+                usedOptions: never[];
+            }[];
+            fulfillments: {
+                id: string;
+                status: string;
+                carrier: string;
+                trackingNumber: string | null;
+                trackingUrl: string | null;
+                lineItems: {
+                    id: string;
+                    title: string;
+                    qty: number;
+                }[];
+                createdAt: string;
+            }[];
+            tracking: never[];
+            orderHistory: never[];
+            isReplaceOrReturn: boolean;
+            createdAt: string;
+            updatedAt: string;
+        }[];
+    }>;
 }
 declare const orderService: OrderService;
 
@@ -4784,15 +4901,35 @@ declare class UserService extends BaseService {
     deleteUser(): Promise<never>;
     checkEmail(): Promise<never>;
     joinAsVendor(): Promise<never>;
-    private signedIn;
+    protected signedIn(auth: AuthResponse): Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        phone: string | null;
+        firstName: string;
+        lastName: string;
+        name: string;
+        fullName: string;
+        avatar: null;
+        role: string;
+        emailVerified: boolean;
+        storeId: null;
+    }>;
     /** An identity call, with a 404 from a build without the module said in words. */
     protected account<T>(path: string, req?: Parameters<BaseService['engine']>[1]): Promise<T>;
 }
 /**
- * Password resets and email confirmation. Phone sign-in by one-time code is a
- * Litekart flow; the engine has no such thing and says so.
+ * Password resets, email confirmation, and phone sign-in. A store signs its
+ * customers in one way (D116), read from `loginMethod`; the engine refuses
+ * the other.
  */
 declare class AuthService extends UserService {
+    private readonly facts;
+    /**
+     * 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'>;
     forgotPassword({ email }: {
         email: string;
         referrer?: string;
@@ -4839,8 +4976,30 @@ declare class AuthService extends UserService {
         errorCode: string;
         message: string;
     }>;
-    getOtp(): Promise<never>;
-    verifyOtp(): Promise<never>;
+    /** Texts a 4-digit sign-in code to `phone`, which needs its country code. */
+    getOtp({ phone }: {
+        phone: string;
+    }): Promise<{
+        expiresInMinutes: number;
+    }>;
+    /** Signs in the account on `phone` with the code it was sent, opening one the first time. */
+    verifyOtp({ phone, otp }: {
+        phone: string;
+        otp: string;
+    }): Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        phone: string | null;
+        firstName: string;
+        lastName: string;
+        name: string;
+        fullName: string;
+        avatar: null;
+        role: string;
+        emailVerified: boolean;
+        storeId: null;
+    }>;
     joinAsAdmin(): Promise<never>;
 }
 /** The `/my/profile` form: the same account, read and saved. */

package/dist/index.cjs

@@ -2044,12 +2044,31 @@ var OrderService = class extends BaseService {
   async listPublic(_args = {}) {
     return emptyPage();
   }
-  async getOrderByEmailAndOTP() {
-    throw new NotSupportedError(
-      "OrderService",
-      "getOrderByEmailAndOTP",
-      "the engine sends no one-time codes; a guest reads an order with its access token"
+  /**
+   * Sends a 4-digit code to the email or phone on the order, when `contact`
+   * is that email or phone. The engine answers the same either way, so this
+   * resolves whether or not anything was sent.
+   */
+  async requestOrderCode({ orderNo, contact }) {
+    const res = await this.data(
+      `/api/orders/${encodeURIComponent(orderNo.trim())}/code`,
+      { method: "POST", body: { contact: contact.trim() } }
+    );
+    return { expiresInMinutes: res?.expires_in_minutes ?? 10 };
+  }
+  /**
+   * Opens an order with the code `requestOrderCode` sent. The token it answers
+   * is kept like an order placed in this browser, so the order page and
+   * `getOrder` read it again without another code.
+   */
+  async getOrderByEmailAndOTP({ orderNo, otp }) {
+    const number = orderNo.trim();
+    const res = await this.data(
+      `/api/orders/${encodeURIComponent(number)}/code/verify`,
+      { method: "POST", body: { code: String(otp).trim() } }
     );
+    rememberOrder({ number: res.order.number, token: res.access_token, cartId: "" });
+    return { data: [toOrder(res.order)] };
   }
 };
 var clean2 = (v) => v && v !== "undefined" && v !== "null" ? v : void 0;
@@ -2186,6 +2205,19 @@ var UserService = class extends BaseService {
   }
 };
 var AuthService = class extends UserService {
+  facts = new StoreFacts(this._fetch);
+  /**
+   * How this store signs customers in: `email_password` or `phone_otp`.
+   * A store whose accounts module says nothing signs in by email.
+   */
+  async loginMethod() {
+    try {
+      const method = (await this.facts.plugins()).get("identity")?.settings?.login_method;
+      return method === "phone_otp" ? "phone_otp" : "email_password";
+    } catch {
+      return "email_password";
+    }
+  }
   async forgotPassword({ email }) {
     return this.account("/x/identity/password-reset", {
       method: "POST",
@@ -2212,11 +2244,21 @@ var AuthService = class extends UserService {
       return { errorCode: err.code ?? "invalid_token", message: err.message };
     }
   }
-  async getOtp() {
-    throw new NotSupportedError("AuthService", "getOtp", "sign in with an email and password");
+  /** Texts a 4-digit sign-in code to `phone`, which needs its country code. */
+  async getOtp({ phone }) {
+    const res = await this.account("/x/identity/otp", {
+      method: "POST",
+      body: { phone: String(phone ?? "").trim() }
+    });
+    return { expiresInMinutes: res?.expires_in_minutes ?? 10 };
   }
-  async verifyOtp() {
-    throw new NotSupportedError("AuthService", "verifyOtp", "sign in with an email and password");
+  /** 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", {
+      method: "POST",
+      body: { phone: String(phone ?? "").trim(), code: String(otp ?? "").trim() }
+    });
+    return this.signedIn(auth);
   }
   async joinAsAdmin() {
     throw new NotSupportedError("AuthService", "joinAsAdmin", "operators are invited from the admin panel");
@@ -2568,7 +2610,11 @@ var StoreService = class extends BaseService {
           ...flag(plugins.has("product-reviews"))
         }
       },
-      ...menus?.length ? { menu: menus } : {}
+      ...menus?.length ? { menu: menus } : {},
+      // 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" } : {}
     };
   }
 };