@salla.sa/twilight 2.0.274 → 2.0.276

package/package.json

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

package/types/actions.d.ts

@@ -1,9 +1,9 @@
 import {
-    AuthApi, CartApi, CommentApi, CurrencyApi, DocumentApi, RatingApi, GiftApi, OfferApi, OrderApi,
+    AuthApi, CartApi, CommentApi, CurrencyApi, DocumentApi, RatingApi, GiftApi, OrderApi,
     ProductApi, ProfileApi, TwilightApi, WishlistApi, LoyaltyApi
 } from "./api";
 import {
-    AuthEvent, CartEvent, CommentEvent, CurrencyEvent, DocumentEvent, RatingEvent, GiftEvent, OfferEvent,
+    AuthEvent, CartEvent, CommentEvent, CurrencyEvent, DocumentEvent, RatingEvent, GiftEvent,
     InfiniteScrollEvent, OrderEvent, ProductEvent, ProfileEvent, TwilightEvent, WishlistEvent, LoyaltyEvent
 } from "./event";
 
@@ -12,7 +12,6 @@ export default interface SallaActions {
     auth: AuthApi & { api: AuthApi, event: AuthEvent };
     gift: GiftApi & { api: GiftApi, event: GiftEvent };
     order: OrderApi & { api: OrderApi, event: OrderEvent };
-    offer: OfferApi & { api: OfferApi, event: OfferEvent };
     rating: RatingApi & { api: RatingApi, event: RatingEvent };
     comment: CommentApi & { api: CommentApi, event: CommentEvent };
     loyalty: LoyaltyApi & { api: LoyaltyApi, event: LoyaltyEvent };

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

@@ -1,5 +1,4 @@
 import {SuccessResponse} from "../../common";
-export {SuccessResponse} from "../../common";
 export namespace CartResponse {
     export interface update extends SuccessResponse {
         data: CartUpdatedData;

package/types/api/index.d.ts

@@ -3,7 +3,6 @@ import CartApi from "./cart";
 import AuthApi from "./auth";
 import GiftApi from "./gift";
 import OrderApi from "./order";
-import OfferApi from "./offer";
 import RatingApi from "./rating";
 import CommentApi from "./comment";
 import LoyaltyApi from "./loyalty";
@@ -19,7 +18,6 @@ export {
     AuthApi,
     GiftApi,
     OrderApi,
-    OfferApi,
     RatingApi,
     CommentApi,
     LoyaltyApi,
@@ -53,12 +51,12 @@ export type ApiActionName =
     | 'order.cancel'
     | 'order.reOrder'
     | 'order.send'
-    | 'offer.increase'
-    | 'offer.details'
     | 'product.getPrice'
     | 'product.availabilitySubscribe'
     | 'product.purchaseNow'
     | 'product.search'
+    | 'product.categories'
+    | 'product.offers'
     | 'profile.update'
     | 'comment.add'
     | 'currency.change'
@@ -77,7 +75,6 @@ export default interface SallaApi extends Axios {
     auth: AuthApi;
     gift: GiftApi;
     order: OrderApi;
-    offer: OfferApi;
     rating: RatingApi;
     comment: CommentApi;
     loyalty: LoyaltyApi;

package/types/api/order.d.ts

@@ -11,4 +11,5 @@ 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
 }

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

@@ -0,0 +1,14 @@
+import {SuccessResponse} from "../../common";
+import {ProductResponse} from "./response";
+import {ProductRequest} from "./request";
+
+export * from "./request";
+export * from "./response";
+
+export default interface ProductApi {
+    getPrice: (data: /*product_id*/number | ProductRequest.addItem) => Promise<ProductResponse.getPrice>;
+    availabilitySubscribe: (product_id: number | ProductRequest.availability) => Promise<SuccessResponse>;
+    search: (keyword: string | ProductRequest.search) => Promise<ProductResponse.search>;
+    categories: (categoryId?: number) => Promise<ProductResponse.categories>; //get all categories or sub_categories
+    offers: (product_id: number) => Promise<ProductResponse.offers>; //get all categories or sub_categories
+}

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

@@ -0,0 +1,35 @@
+export interface Category {
+    id: string;
+    id_: number;
+    name: string;
+    url: string;
+    sub_categories: Category[];
+}
+
+export type ProductOption = { [key: number]: number | string | number[] };
+
+export namespace ProductRequest {
+    export interface addItem {
+        id: number;
+        quantity: 1 | number;
+        options?: ProductOption;
+    }
+
+    export interface search {
+        query: string;
+        type?: 'keyword' | 'tag';//default => 'keyword'
+        sort_by?: 'ourSuggest' | 'default' | 'bestSell' | 'topRated' | 'priceFromTopToLow' | 'priceFromLowToTop'; //default => 'ourSuggest'
+        per_page?: 32 | number;//max 50
+        brands?: number[];
+        categories?: number[];// max 5 ids
+        branches?: number[];// max 5 ids
+    }
+
+    export interface availability {
+        id: number;
+        //💡 Following properties required for guests
+        email?: string;//required when request without mobile
+        country_code?: string | 'SA';//required when request without email
+        phone?: string | '555555555';//required when request without email
+    }
+}

package/types/api/{offer.d.ts → product/response.d.ts}

@@ -1,12 +1,11 @@
-import {Category, Product, SuccessResponse} from "../common";
-
+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 Offer {
     id: number;
     name: string;
@@ -19,14 +18,14 @@ export interface Offer {
         type: 'product' | 'category';
         quantity: number;
         products?: Product[];
-        categories?: Category[];
+        categories?: ShortCategory[];
         min_amount?: number; //when offer_type != 'buy_x_get_y'
         min_items?: number; //when offer_type != 'buy_x_get_y'
         payment_methods: paymentMethod[];
     };
     get: {
         products?: Product[];
-        categories?: Category[];
+        categories?: ShortCategory[];
         type: 'product' | 'category';
         discount_type: 'free-product' | 'percentage';
         quantity?: number;//when discount_type == 'percentage'
@@ -34,10 +33,30 @@ export interface Offer {
     }
 }
 
-export interface OfferDetailsResponse extends SuccessResponse {
-    data: Offer[] | [];
-}
+export namespace ProductResponse {
+    export interface search extends SuccessResponse {
+        data: Product[];
+        cursor: {
+            current: number;
+            previous?: string;
+            next?: string;
+            count: number;
+        };
+    }
 
-export default interface OfferApi {
-    details: (product_id: number) => Promise<OfferDetailsResponse>;
+    export interface getPrice extends SuccessResponse {
+        data: {
+            price: number;
+            regular_price: number;
+            has_sale_price: boolean;
+        }
+    }
+
+    export interface categories extends SuccessResponse {
+        data: Category | Category[]; //single category when getting subCategories by passing categoryId
+    }
+
+    export interface offers extends SuccessResponse {
+        data: Offer[] | [];
+    }
 }

package/types/event/index.d.ts

@@ -2,7 +2,6 @@ import AuthEvent from "./auth";
 import CartEvent from "./cart";
 import GiftEvent from "./gift";
 import OrderEvent from "./order";
-import OfferEvent from "./offer";
 import RatingEvent from "./rating";
 import CommentEvent from "./comment";
 import LoyaltyEvent from "./loyalty";
@@ -62,11 +61,6 @@ export type EventName = string
     | 'order::re.order.failed'
     | 'order::invoice.sent'
     | 'order::invoice.not.sent'
-    | 'offer::existed'
-    | 'offer::increase'
-    | 'offer::increase.failed'
-    | 'offer::fetch.details.failed'
-    | 'offer::details.fetched'
     | 'rating::order.not.fetched'
     | 'rating::order.fetched'
     | 'rating::store.rated'
@@ -81,6 +75,11 @@ export type EventName = string
     | 'product::availability.subscribe.failed'
     | 'product::search.failed'
     | 'product::search.results'
+    | 'product::offers.existed'
+    | 'product::fetch.offers.failed'
+    | 'product::offers.fetched'
+    | 'product::categories.fetched'
+    | 'product::categories.failed'
     | 'profile::updated'
     | 'profile::update.failed'
     | 'profile::mobile.updated'
@@ -112,7 +111,6 @@ export {
     CartEvent,
     GiftEvent,
     OrderEvent,
-    OfferEvent,
     RatingEvent,
     CommentEvent,
     LoyaltyEvent,
@@ -130,7 +128,6 @@ export default interface SallaEvent extends EventEmitter2 {
     cart: CartEvent;
     gift: GiftEvent;
     order: OrderEvent;
-    offer: OfferEvent;
     rating: RatingEvent;
     comment: CommentEvent;
     loyalty: LoyaltyEvent;

package/types/event/product.d.ts

@@ -1,13 +1,18 @@
-import {GetCategoriesResponse, GetPriceResponse, ProductsSearchResponse} from "../api/product";
-import {RequestError, RequestErrorEventWithData, SuccessResponse} from "../common";
+import {ProductResponse} from "../api/product";
+import {RequestError, RequestErrorEvent, RequestErrorEventWithData, SuccessResponse} from "../common";
+import {OfferSummary} from "../api/cart";
 
 export default interface ProductEvent {
-    onPriceUpdated: (callback: (response: GetPriceResponse, product_id: number) => void) => void;
+    onPriceUpdated: (callback: (response: ProductResponse.getPrice, product_id: number) => void) => void;
     onPriceUpdateFailed: RequestErrorEventWithData</*product_id*/ number>;
     onAvailabilitySubscribed: (callback: (response: SuccessResponse, product_id: number) => void) => void;
     onAvailabilitySubscribeFailed: RequestErrorEventWithData</*product_id*/ number>;
-    onCategoriesFetched: (callback: (response: GetCategoriesResponse) => void) => void;
+    onCategoriesFetched: (callback: (response: ProductResponse.categories) => void) => void;
     onCategoriesFailed: RequestError;
-    onSearchResults: (callback: (response: ProductsSearchResponse, query?: string) => void) => void;
+    onSearchResults: (callback: (response: ProductResponse.search, query?: string) => void) => void;
     onSearchFailed: RequestErrorEventWithData</*query*/string|undefined>;
+
+    onOffersExisted: (callback: (offer: OfferSummary) => void) => void;
+    ondOffersFetched: (callback: (response: ProductResponse.offers) => void) => void;
+    onFetchOffersFailed: RequestErrorEvent;
 }

package/types/api/product.d.ts

@@ -1,65 +0,0 @@
-import {Product, SuccessResponse} from "../common";
-
-type ProductOption = { [key: number]: number | string | number[] };
-
-export interface ProductPayload {
-    id: number;
-    quantity: 1 | number;
-    options?: ProductOption;
-}
-
-export interface SearchPayload {
-    query: string;
-    type?: 'keyword' | 'tag';//default => 'keyword'
-    sort_by?: 'ourSuggest' | 'default' | 'bestSell' | 'topRated' | 'priceFromTopToLow' | 'priceFromLowToTop'; //default => 'ourSuggest'
-    per_page?: 32 | number;//max 50
-    brands?: number[];
-    categories?: number[];// max 5 ids
-    branches?: number[];// max 5 ids
-}
-
-export interface AvailabilityPayload {
-    id: number;
-    //💡 Following properties required for guests
-    email?: string;//required when request without mobile
-    country_code?: string | 'SA';//required when request without email
-    phone?: string | '555555555';//required when request without email
-}
-
-export interface ProductsSearchResponse extends SuccessResponse {
-    data: Product[];
-    cursor: {
-        current: number;
-        previous?: string;
-        next?: string;
-        count: number;
-    };
-}
-
-
-export interface GetPriceResponse extends SuccessResponse {
-    data: {
-        price: number;
-        regular_price: number;
-        has_sale_price: boolean;
-    }
-}
-
-export interface Category {
-    id: string;
-    id_: number;
-    name: string;
-    url: string;
-    sub_categories: Category[];
-}
-
-export interface GetCategoriesResponse extends SuccessResponse {
-    data: Category | Category[]; //single category when getting subCategories by passing categoryId
-}
-
-export default interface ProductApi {
-    getPrice: (data: /*product_id*/number | ProductPayload) => Promise<GetPriceResponse>;
-    availabilitySubscribe: (product_id: number | AvailabilityPayload) => Promise<SuccessResponse>;
-    search: (keyword: string | SearchPayload) => Promise<ProductsSearchResponse>;
-    categories: (categoryId?: number) => Promise<GetCategoriesResponse>; //get all categories or sub_categories
-}

package/types/event/offer.d.ts

@@ -1,9 +0,0 @@
-import {OfferDetailsResponse} from "../api/offer";
-import {RequestErrorEvent} from "../common";
-import {OfferSummary} from "../api/cart";
-
-export default interface OfferEvent {
-    onExisted: (callback: (offer: OfferSummary) => void) => void;
-    ondDetailsFetched: (callback: (response: OfferDetailsResponse) => void) => void;
-    onFetchDetailsFailed: RequestErrorEvent;
-}