@salla.sa/twilight 2.0.262 → 2.0.263

package/package.json

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

package/types/actions.d.ts

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

package/types/api/index.d.ts

@@ -4,7 +4,6 @@ import AuthApi from "./auth";
 import GiftApi from "./gift";
 import OrderApi from "./order";
 import OfferApi from "./offer";
-import SearchApi from "./search";
 import RatingApi from "./rating";
 import CommentApi from "./comment";
 import LoyaltyApi from "./loyalty";
@@ -21,7 +20,6 @@ export {
     GiftApi,
     OrderApi,
     OfferApi,
-    SearchApi,
     RatingApi,
     CommentApi,
     LoyaltyApi,
@@ -57,10 +55,10 @@ export type ApiActionName =
     | 'order.send'
     | 'offer.increase'
     | 'offer.details'
-    | 'search.search'
     | 'product.getPrice'
     | 'product.availabilitySubscribe'
     | 'product.purchaseNow'
+    | 'product.search'
     | 'profile.update'
     | 'comment.add'
     | 'currency.change'
@@ -80,7 +78,6 @@ export default interface SallaApi extends Axios {
     gift: GiftApi;
     order: OrderApi;
     offer: OfferApi;
-    search: SearchApi;
     rating: RatingApi;
     comment: CommentApi;
     loyalty: LoyaltyApi;

package/types/api/product.d.ts

@@ -1,4 +1,4 @@
-import { SuccessResponse} from "../common";
+import { Product, SuccessResponse} from "../common";
 
 type ProductOption = { [key: number]: number | string | number[] };
 
@@ -8,6 +8,16 @@ export interface ProductPayload {
     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
@@ -15,6 +25,16 @@ export interface AvailabilityPayload {
     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: {
@@ -27,4 +47,5 @@ export interface GetPriceResponse extends SuccessResponse {
 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>;
 }

package/types/event/index.d.ts

@@ -3,7 +3,6 @@ import CartEvent from "./cart";
 import GiftEvent from "./gift";
 import OrderEvent from "./order";
 import OfferEvent from "./offer";
-import SearchEvent from "./search";
 import RatingEvent from "./rating";
 import CommentEvent from "./comment";
 import LoyaltyEvent from "./loyalty";
@@ -76,12 +75,12 @@ export type EventName = string
     | 'rating::products.failed'
     | 'rating::shipping.rated'
     | 'rating::shipping.failed'
-    | 'search::finished'
-    | 'search::failed'
     | 'product::price.updated'
     | 'product::price.updated.failed'
     | 'product::availability.subscribed'
     | 'product::availability.subscribe.failed'
+    | 'product::search.failed'
+    | 'product::search.results'
     | 'profile::updated'
     | 'profile::update.failed'
     | 'profile::mobile.updated'
@@ -114,7 +113,6 @@ export {
     GiftEvent,
     OrderEvent,
     OfferEvent,
-    SearchEvent,
     RatingEvent,
     CommentEvent,
     LoyaltyEvent,
@@ -133,7 +131,6 @@ export default interface SallaEvent extends EventEmitter2 {
     gift: GiftEvent;
     order: OrderEvent;
     offer: OfferEvent;
-    search: SearchEvent;
     rating: RatingEvent;
     comment: CommentEvent;
     loyalty: LoyaltyEvent;

package/types/event/product.d.ts

@@ -1,4 +1,4 @@
-import {GetPriceResponse} from "../api/product";
+import {GetPriceResponse, ProductsSearchResponse} from "../api/product";
 import {RequestErrorEventWithData, SuccessResponse} from "../common";
 
 export default interface ProductEvent {
@@ -6,4 +6,6 @@ export default interface ProductEvent {
     onPriceUpdateFailed: RequestErrorEventWithData</*product_id*/ number>;
     onAvailabilitySubscribed: (callback: (response: SuccessResponse, product_id: number) => void) => void;
     onAvailabilitySubscribeFailed: RequestErrorEventWithData</*product_id*/ number>;
+    onSearchResults: (callback: (response: ProductsSearchResponse, query?: string) => void) => void;
+    onSearchFailed: RequestErrorEventWithData</*query*/string|undefined>;
 }

package/types/api/search.d.ts

@@ -1,15 +0,0 @@
-import { Product, SuccessResponse} from "../common";
-
-export interface SearchProductsResponse extends SuccessResponse {
-    data: Product[];
-    cursor: {
-        current: number;
-        previous?: string;
-        next?: string;
-        count: number;
-    };
-}
-
-export default interface SearchApi {
-    products: (query: string) => Promise<SearchProductsResponse>;
-}

package/types/event/search.d.ts

@@ -1,7 +0,0 @@
-import { RequestErrorEventWithData} from "../common";
-import {SearchProductsResponse} from "../api/search";
-
-export default interface SearchEvent {
-    onFinished: (callback: (response: SearchProductsResponse, query?: string) => void) => void;
-    onFailed: RequestErrorEventWithData</*query*/string|undefined>;
-}