@salla.sa/twilight 2.0.265 → 2.0.267

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salla.sa/twilight",
-  "version": "2.0.265",
+  "version": "2.0.267",
   "description": "Salla Theme Toolkit, Webcomponents, Events, Requests, Utils",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/types/api/profile.d.ts

@@ -9,13 +9,10 @@ export interface ProfileUpdatePayload {
     avatar?: BinaryType;
 }
 
-export interface ProfileUpdateMobilePayload {
-    phone: string | number;
-    country_code: string | 'SA';
-}
-
-export interface ProfileUpdateEmailPayload {
-    email: string;
+export interface ProfileUpdateContactPayload {
+    phone?: string | number; //required if there is no email
+    country_code?: string | 'SA'; //required if there is phone
+    email?: string; //required if there is no phone
 }
 
 export interface UpdateProfileResponse extends SuccessResponse {
@@ -31,11 +28,12 @@ export interface UpdateProfileResponse extends SuccessResponse {
         avatar: string;
         gender?: 'male' | 'female';
         birthday: string | '2022-02-22';
+        verification_type?: 'email' | 'mobile'; //exists when trying to update email/phone
     };
 }
 
 export default interface ProfileApi {
     update: (data: ProfileUpdatePayload) => Promise<UpdateProfileResponse>;
     verify: (data: AuthRequest.verifyByMobile | AuthRequest.verifyByEmail) => Promise<SuccessResponse>;
-    updateContacts: (data: ProfileUpdateMobilePayload | ProfileUpdateEmailPayload) => Promise<UpdateProfileResponse>;
+    updateContacts: (data: ProfileUpdateContactPayload) => Promise<UpdateProfileResponse>;//should verify after success event
 }

package/types/event/profile.d.ts

@@ -4,7 +4,7 @@ import {RequestErrorEvent, SuccessResponse} from "../common";
 export default interface ProfileEvent {
     onUpdated: (callback: (response: UpdateProfileResponse) => void) => void;
     onVerified: (callback: (response: SuccessResponse) => void) => void;
-    onContactsUpdated: (callback: (response: UpdateProfileResponse) => void) => void;
+    onVerificationCodeSent: (callback: (response: UpdateProfileResponse) => void) => void; //should trigger action to fill verify code, then calling salla.profile.verify(...)
 
     //errors
     onUpdateFailed: RequestErrorEvent;

package/types/helpers/salla-helpers.d.ts

@@ -1,6 +1,26 @@
 import {Price} from "../common";
 
 export type UrlHelper = (path: string) => string; //add any path to current url, ex: `salla.url('cart?anything=data')` output => `https://store_domain.com/cart?anything=data`
+export type PageName = 'blog.index'
+    | 'blog.index.author'
+    | 'blog.index.category'
+    | 'blog.index.tag'
+    | 'brands.index'
+    | 'cart'
+    | 'customer.orders.index'
+    | 'customer.orders.index.pending'
+    | 'customer.orders.single'
+    | 'customer.profile'
+    | 'customer.wishlist'
+    | 'index'
+    | 'page-single'
+    | 'product.index'
+    | 'product.index.latest'
+    | 'product.index.offers'
+    | 'product.index.search'
+    | 'product.index.tag'
+    | 'product.single'
+    | 'thank-you';
 export default interface SallaHelpers {
     //Numbers helpers
     digitsOnly: (num: string | number) => number;
@@ -25,6 +45,7 @@ export default interface SallaHelpers {
         asset: UrlHelper;
         get: UrlHelper;
         cdn: UrlHelper;
+        is_page: (pageName: PageName) => boolean;
     };
     asset: UrlHelper;
     cdn: UrlHelper;

package/types/index.d.ts

@@ -4,7 +4,7 @@ import SallaActions from "./actions";
 
 import SallaConfig from "./lib/salla-config";
 import {Price} from "./common";
-import SallaHelpers, {UrlHelper} from "./helpers/salla-helpers";
+import SallaHelpers, {PageName, UrlHelper} from "./helpers/salla-helpers";
 import AppHelpers from "./helpers/app-helpers";
 import SallaNotify, {Logger} from "./lib/salla-notify";
 import SallaStorage from "./lib/salla-storage";
@@ -34,6 +34,7 @@ export default interface Salla extends SallaActions {
         asset: UrlHelper;
         get: UrlHelper;
         cdn: UrlHelper;
+        is_page: (pageName: PageName) => boolean;
     };
     isInitiated: boolean; // will be true when firing event `twilight::initiated`
     onReady: (callback: (event: Event) => unknown) => void; //don't relay on it because Salla may not existed yet