@salla.sa/twilight 2.11.90 → 2.11.92

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salla.sa/twilight",
-    "version": "2.11.90",
+    "version": "2.11.92",
     "description": "Salla Theme Toolkit, Webcomponents, Events, Requests, Utils",
     "main": "dist/cjs",
     "module": "dist/esm",
@@ -8,7 +8,7 @@
     "scripts": {
         "build": "npx rollup --config --preserveSymlinks=true",
         "watch": "npx rollup --watch --config --preserveSymlinks=true",
-        "test": "jest --detectOpenHandles",
+        "test": "jest --detectOpenHandles -- product.test.js",
         "express": "node tests/server/index.js"
     },
     "keywords": [
@@ -67,5 +67,5 @@
     "peerDependencies": {
         "webpack": "^4 || ^5"
     },
-    "gitHead": "e0f8bf0c63b6abcc91c8a1664a9bb6f0b31f9b92"
+    "gitHead": "8da3cb22ccdec75291d69699e6be1b21d71a9e7c"
 }

package/types/api/auth/index.d.ts

@@ -4,14 +4,18 @@ export * from "./request";
 export * from "./response";
 import {AuthRequest} from "./request";
 import {AuthResponse} from "./response";
+import {ApiActionName} from "../index";
 
 export default interface AuthApi {
     canRedirect: () => boolean; //change it to false when you don't want page to reload or redirect automatically after logged in, use `salla.auth.event.onLoggedIn(response=>{...})`
-    setCanRedirect: (canRedirect: boolean) => void;
-    login: (data: AuthRequest.loginByMobile | AuthRequest.loginByEmail) => Promise<AuthResponse.loginOrResendCode>;
+    login: (data: AuthRequest.loginByMobile | AuthRequest.loginByEmail | object | FormData) => Promise<AuthResponse.loginOrResendCode | AuthResponse.sendVerification>;
     logout: () => Promise<SuccessResponse>;
     verify: (data: AuthRequest.verifyByMobile | AuthRequest.verifyByEmail, supportWebAuth: boolean) => Promise<AuthResponse.verify>;
     resend: (data: AuthRequest.resend) => Promise<AuthResponse.loginOrResendCode>;
     register: (data: AuthRequest.register) => Promise<AuthResponse.verify>;
     refresh: () => Promise<AuthResponse.verify>;
+    // Voids
+    setAfterLoginEvent: (event: ApiActionName, payload: any) => void;
+    setCanRedirect: (canRedirect: boolean) => void;
+    afterUserLogin: () => void;
 }

package/types/api/auth/response.d.ts

@@ -14,6 +14,10 @@ export namespace AuthResponse {
         }
     }
 
+    export interface sendVerification extends SuccessResponse {
+        data: VerificationStatus
+    }
+
     export interface loginOrResendCode extends SuccessResponse {
         data: {
             resend_counter?: 2 | 3 | 4;//when resend code

package/types/api/booking.d.ts

@@ -1,4 +1,4 @@
-import { SuccessResponse } from '../common'
+import {SuccessResponse} from '../common'
 
 
 export interface RedirectPayload {
@@ -17,5 +17,5 @@ export namespace BookingApiResponse {
 }
 
 export default interface BookingApi {
-    add: (productId: number) => Promise<BookingApiResponse.add>
+    add: (productId: number, withRedirect: boolean) => Promise<BookingApiResponse.add>
 }

package/types/api/cart/index.d.ts

@@ -1,27 +1,32 @@
 export * from "./request";
 export * from "./response";
-import { SuccessResponse } from "../../common";
-import { CartResponse } from "./response";
-import { CartRequest } from "./request";
+import {SuccessResponse} from "../../common";
+import {CartResponse} from "./response";
+import {CartRequest} from "./request";
 
 export default interface CartApi {
     latest: () => Promise<CartResponse.update>;
-    details: () => Promise<CartResponse.update>;
-    quickAdd: (/*product_id*/id: number) => Promise<CartResponse.update>;
+    details: (cartId: number | null, withItems: ['options' | 'attachments']) => Promise<CartResponse.update>;
+    quickAdd: (/*product_id*/id: number, quantity: number) => Promise<CartResponse.update>;
     addItem: (data: CartRequest.addItem) => Promise<CartResponse.update>;
     deleteItem: (item_id: number) => Promise<CartResponse.update>;
     updateItem: (data: CartRequest.addItem) => Promise<CartResponse.update>;
     deleteImage: (file_id: number) => Promise<SuccessResponse>;
-    status: () => Promise<CartResponse.status>;
+    status: (cartId: number) => Promise<CartResponse.status>;
     reset: () => void;
     submit: () => void;
 
+    getCurrentCartId: () => Promise<number>;
+    getCartPayload: (productIdOrObject: CartRequest.addItem) => CartResponse.cartPayload;
+    normalRequest: (endpoint: string, formData?: Object, method?: string) => Promise<any>;
+    priceQuote: (cartId: number) => Promise<CartResponse.PriceQuote>;
+
     getUploadImageEndpoint: (cartId?: number) => string;
 
     getQuickOrderSettings: () => Promise<CartResponse.quickOrderSettingResponse>;
     createQuickOrder: (payload: CartRequest.quickOrderPayload) => Promise<SuccessResponse>;
 
     //coupons
-    addCoupon: (coupon: string) => Promise<CartResponse.update>;
-    deleteCoupon: () => Promise<CartResponse.update>;
+    addCoupon: (coupon: string | Object | FormData) => Promise<CartResponse.latest>;
+    deleteCoupon: () => Promise<CartResponse.latest>;
 }

package/types/api/cart/response.d.ts

@@ -1,5 +1,16 @@
-import { SuccessResponse } from "../../common";
+import {SuccessResponse} from "../../common";
+import {CartRequest} from "./request";
+
 export namespace CartResponse {
+    export interface latest extends SuccessResponse {
+        data: CartSummary;
+    }
+
+    export interface cartPayload {
+        id: number,
+        payload: CartRequest.addItem
+    }
+
     export interface update extends SuccessResponse {
         data: CartUpdatedData;
     }
@@ -81,7 +92,7 @@ export interface QuickOrderSetting {
     is_email_required: boolean;
     show_agreement: boolean;
     allowed_countries: string[];
-    style: 'default'|'white'|'gray';
+    style: 'default' | 'white' | 'gray';
     confirm_button: string;
     agreement: string;
 }

package/types/api/comment.d.ts

@@ -7,12 +7,28 @@ export interface AddCommentResponse extends SuccessResponse {
     }
 }
 
+export interface FetchCommentsResponse extends SuccessResponse {
+    data: any[]
+}
+
 export interface AddCommentPayload {
     id: number;
     comment: string;
     type: 'product' | 'page';
 }
 
+export interface CommentPayload {
+    id: number;
+    comment: string;
+    type: 'product' | 'page';
+    'per_page': number | null,
+    'page': number | null
+}
+
 export default interface CommentApi {
     add: (data: AddCommentPayload) => Promise<AddCommentResponse>;
+    getCommentPayload: (data: AddCommentPayload) => CommentPayload;
+    fetch: (data: AddCommentPayload) => Promise<FetchCommentsResponse>;
+    getPageComments: (pageId: number, page: number, per_page: number) => Promise<FetchCommentsResponse>;
+    getProductComments: (productId: number, page: number, per_page: number) => Promise<FetchCommentsResponse>;
 }

package/types/api/currency.d.ts

@@ -11,7 +11,12 @@ export interface ListCurrenciesResponse extends SuccessResponse {
     data: Array<Currency>
 }
 
+export interface CurrencyPayload {
+    currency: string | null;
+    code: string | null;
+}
+
 export default interface CurrencyApi {
-    change: (currency_code: 'SAR' | 'USD' | string) => Promise<ChangeCurrencyResponse>;
+    change: (currency_code: CurrencyPayload | string) => Promise<ChangeCurrencyResponse>;
     list: () => Promise<ListCurrenciesResponse>;
 }

package/types/api/index.d.ts

@@ -11,9 +11,9 @@ import DocumentApi from "./document";
 import WishlistApi from "./wishlist";
 import ScopeApi from "./scope";
 import LandingApi from "./landing";
-import BookingApi, { Booking } from "./booking";
-import { AxiosInstance } from "axios";
-import { ErrorResponse, SuccessResponse } from "@salla.sa/base/types/common";
+import BookingApi, {Booking} from "./booking";
+import {AxiosInstance} from "axios";
+import {ErrorResponse, SuccessResponse} from "@salla.sa/base/types/common";
 
 export {
     CartApi,
@@ -115,13 +115,22 @@ export default interface Api {
         "accept-language"?: string | 'ar',
         Authorization?: string
     }
-    request(endPoint: string, formData?:object, method?: string | 'get' | 'post' | 'put', options?: object): Promise<any>
+
+    request(endPoint: string, formData?: object, method?: string | 'get' | 'post' | 'put', options?: object): Promise<any>
+
     handleAfterResponseActions(response: SuccessResponse | ErrorResponse | any): void;
+
     fireEventsForResponse(response: SuccessResponse | ErrorResponse | any): void;
+
     showAlert(response: SuccessResponse | ErrorResponse | any): void;
+
     handleErrorResponse(error: object): void;
+
     handleInvalidFields(error: object): void;
+
     errorPromise(data: any): Promise<any>;
+
     successPromise(data: any): Promise<any>;
+
     isFastRequestsAllowed(): boolean;
 }

package/types/api/loyalty.d.ts

@@ -1,4 +1,4 @@
-import { SuccessResponse } from '../common'
+import {SuccessResponse} from '../common'
 
 
 export interface Loyalty {
@@ -205,6 +205,12 @@ export interface ExchangePrize {
     points: number;
 }
 
+export interface PrizeObject {
+    'id': number | null,
+    'loyalty_prize_id': number | null,
+    'prize_id': number | null
+}
+
 
 export namespace LoyaltyApiResponse {
 
@@ -221,6 +227,6 @@ export namespace LoyaltyApiResponse {
 
 export default interface LoyaltyApi {
     getProgram: () => Promise<LoyaltyApiResponse.program>
-    exchange: (prize_id: number, cart_id?: number) => Promise<LoyaltyApiResponse.point>
-    reset: () => Promise<SuccessResponse>
+    exchange: (prize_id: number | PrizeObject, cart_id?: number) => Promise<LoyaltyApiResponse.point>
+    reset: (cart_id?: number) => Promise<SuccessResponse>
 }

package/types/api/order.d.ts

@@ -7,9 +7,18 @@ export interface CreateCartFromOrderResponse extends SuccessResponse {
     };
 }
 
+export interface ShowOrderPayload {
+    order_id: number,
+    url: string
+}
+
+export interface SendInvoicePayload {
+    id: number
+}
+
 export default interface OrderApi {
     createCartFromOrder: (order_id?: number) => Promise<CreateCartFromOrderResponse>;
     cancel: (order_id?: number) => Promise<SuccessResponse>;
-    sendInvoice: (order_id?: number) => Promise<SuccessResponse>;
-    show: (payload: { order_id: number, url: string }) => Promise<void>; //should be called from thank you page to trigger native order details page in apps
+    sendInvoice: (payload: SendInvoicePayload) => Promise<SuccessResponse>;
+    show: (payload: ShowOrderPayload) => Promise<void>; //should be called from thank you page to trigger native order details page in apps
 }

package/types/api/product/index.d.ts

@@ -15,5 +15,7 @@ export default interface ProductApi {
     getGiftDetails: (product_id: number) => Promise<ProductResponse.giftResponse>;
     addGiftToCart: (product_id: number, payload: Object, withRedirect: boolean) => Promise<ProductResponse.giftToCart>;
     uploadGiftImage: (multiPartData: FormData) => Promise<ProductResponse.giftImageUpload>;
-    getDetails: (product_id: number, advancedItems: Array<'images' | 'brand' | 'tags' | 'notify_availability' | 'rating' | 'donation' | 'options' | 'sold_quantity' | 'category'>) => Promise<ProductResponse.detail>;
+    getDetails: (product_id: number, withItems: Array<'images' | 'brand' | 'tags' | 'notify_availability' | 'rating' | 'donation' | 'options' | 'sold_quantity' | 'category'>) => Promise<ProductResponse.detail>;
+    getSizeGuides: (product_id: number) => Promise<ProductResponse.sizeGuides>;
+    fetch: (queryParam: ProductRequest.FetchProductsQueryParams) => Promise<ProductResponse.lists>
 }

package/types/api/product/request.d.ts

@@ -50,4 +50,11 @@ export namespace ProductRequest {
         image_url: string;
         time_zone: string;
     }
+
+    export interface FetchProductsQueryParams {
+        source: 'categories' | 'latest' | 'related' | 'brands' | 'json' | 'search' | 'tags' | 'selected' | 'offers' | 'landing-page';
+        sourceValue: number | string | object | string[];
+        filters?: object;
+        limit?: number;
+    }
 }

package/types/api/product/response.d.ts

@@ -1,15 +1,18 @@
-import { Category as ShortCategory, Product, SuccessResponse } from "../../common";
-import { Category } from "./request";
+import {Category as ShortCategory, Product, SuccessResponse} from "../../common";
+import {Category} from "./request";
+
 type offerType = 'buy_x_get_y' | 'percentage' | 'fixed_amount';
 type paymentMethod = {
     id: number;
     slug: 'bank';
     name: 'BankTransfer';
 };
+
 export interface SizeGuide {
     name: string;
     description: string;
 }
+
 export interface Offer {
     id: number;
     name: string;
@@ -275,4 +278,8 @@ export namespace ProductResponse {
     export interface detail extends SuccessResponse {
         data: ProductDetail
     }
+
+    export interface lists extends SuccessResponse {
+        data: Array<ProductDetail>
+    }
 }

package/types/api/profile.d.ts

@@ -58,5 +58,6 @@ export default interface ProfileApi {
     verify: (data: AuthRequest.verifyByMobile | AuthRequest.verifyByEmail) => Promise<VerifyContactResponse>;
     updateContacts: (data: ProfileUpdateContactPayload) => Promise<ProfileResponse>;//need to verify after success event
     setNotification: (data: NotificationSettingPayload) => Promise<SuccessResponse>;
-    deleteAccount: (data: AccountDeletionPayload) => Promise<SuccessResponse>
+    delete: () => Promise<SuccessResponse>;
+    updateSettings: (data: NotificationSettingPayload) => Promise<SuccessResponse>;
 }

package/types/api/rating.d.ts

@@ -1,4 +1,4 @@
-import { Product, Rating, SuccessResponse} from "../common";
+import {Product, Rating, SuccessResponse} from "../common";
 
 export interface OrderDetailsResponse extends SuccessResponse {
     data: {
@@ -20,6 +20,11 @@ export interface OrderDetailsResponse extends SuccessResponse {
     }
 }
 
+export interface OrderDetailPayload {
+    id: number,
+    order_id: number
+}
+
 export interface RatingContent {
     content: string;
     rating: Rating;
@@ -42,7 +47,7 @@ export interface RatingShippingPayload extends RatingStorePayload {
 }
 
 export default interface RatingApi {
-    order: (order_id: number) => Promise<OrderDetailsResponse>;
+    order: (order_id: number | OrderDetailPayload) => Promise<OrderDetailsResponse>;
     store: (data: RatingStorePayload) => Promise<SuccessResponse>;
     products: (data: RatingProductsPayload) => Promise<SuccessResponse>;
     shipping: (data: RatingShippingPayload) => Promise<SuccessResponse>;

package/types/api/scope.d.ts

@@ -1,4 +1,4 @@
-import { SuccessResponse } from "../common";
+import {SuccessResponse} from "../common";
 
 export interface Scope {
     id: number;

package/types/api/wishlist.d.ts

@@ -4,4 +4,5 @@ export default interface WishlistApi {
     add: (product_id: number) => Promise<SuccessResponse>;
     remove: (product_id: number) => Promise<SuccessResponse>;
     toggle: (product_id: number) => Promise<SuccessResponse>;
+    updateWishlistStorage: (id: number, isAdded: boolean) => void;
 }

package/types/event/product.d.ts

@@ -1,6 +1,6 @@
-import { OfferSummary } from "../api/cart";
-import { ProductResponse } from "../api/product";
-import { RequestError, RequestErrorEvent, RequestErrorEventWithData, SuccessResponse } from "../common";
+import {OfferSummary} from "../api/cart";
+import {ProductResponse} from "../api/product";
+import {RequestError, RequestErrorEvent, RequestErrorEventWithData, SuccessResponse} from "../common";
 
 export default interface ProductEvent {
     onPriceUpdated: (callback: (response: ProductResponse.getPrice, product_id: number) => void) => void;
@@ -30,4 +30,7 @@ export default interface ProductEvent {
 
     onGiftImageUploadSucceeded: (callback: (response: ProductResponse.giftImageUpload) => void) => void;
     onGiftImageUploadFailed: RequestErrorEvent;
+
+    onProductListFetchSucceeded: (callback: (response: ProductResponse.lists) => void) => void;
+    onProductListFetchFailed: RequestErrorEvent;
 }