@salla.sa/twilight 2.13.39 → 2.13.41

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salla.sa/twilight",
-    "version": "2.13.39",
+    "version": "2.13.41",
     "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 -- landing.test",
+        "test": "jest --detectOpenHandles -- order.test",
         "express": "node tests/server/index.js"
     },
     "keywords": [
@@ -33,7 +33,7 @@
     ],
     "homepage": "https://salla.dev",
     "dependencies": {
-        "@salla.sa/base": "^2.13.39",
+        "@salla.sa/base": "^2.13.41",
         "axios": "^0.27.2",
         "infinite-scroll": "^4.0.1",
         "jwt-decode": "^3.1.2",
@@ -62,10 +62,10 @@
         "rollup-plugin-watch": "^1.0.1",
         "webpack": "^5.74.0",
         "webpack-build-notifier": "^2.3.0",
-        "webpack-cli": "^4.10.0"
+        "webpack-cli": "^5.1.4"
     },
     "peerDependencies": {
         "webpack": "^4 || ^5"
     },
-    "gitHead": "fae2c9f3a1f1171d5a961668d41b79ba7413d114"
+    "gitHead": "383c01510d89d457a0ff13d9a5d7b4cb3c00e5fb"
 }

package/types/api/component.d.ts

@@ -81,12 +81,50 @@ export interface Footer {
     links?: FooterSocialLink[]
 }
 
+// Review types
+export interface Review {
+    rating?:      number;
+    content?:     string;
+    status?:      string;
+    created_at?:  CreatedAt;
+    replies?:     any[];
+    text?:        string;
+    type?:        string;
+    avatar?:      string;
+    name?:        string;
+    stars?:       number;
+    is_pending?:  boolean;
+    has_order?:   boolean;
+    kind?:        string;
+    session_id?:  string;
+    customer_id?: number;
+    city?:        string;
+    date?:        string;
+}
+
+export interface CreatedAt {
+    date?:          string;
+    timezone_type?: number;
+    timezone?:      string;
+}
+
+export interface ReviewQueryParams {
+    limit?: number;
+    source: 'all' | 'store' | 'categories' | 'products' | 'json';
+    source_value: number | string | object | Array<string | number>;
+}
+
 export namespace ComponentApiResponse {
     export interface menus extends SuccessResponse {
         data: HeaderMenuItem[] | FooterMenu[] | []
     }
+
+    export interface reviews extends SuccessResponse {
+        data: Array<Review> | []
+    }
 }
 
 export default interface ComponentApi {
-    menus?: (component: string) => Promise<ComponentApiResponse.menus>
+    menus?: (component: string) => Promise<ComponentApiResponse.menus>,
+    getReviews?: (queryParams: ReviewQueryParams) => Promise<ComponentApiResponse.reviews>
 }

package/types/api/index.d.ts

@@ -11,25 +11,25 @@ import DocumentApi from "./document";
 import WishlistApi from "./wishlist";
 import ScopeApi from "./scope";
 import LandingApi from "./landing";
-import BookingApi, {Booking} from "./booking";
+import BookingApi from "./booking";
 import {AxiosInstance} from "axios";
 import {ErrorResponse, SuccessResponse} from "@salla.sa/base/types/common";
 
 export {
-    CartApi,
-    AuthApi,
-    OrderApi,
-    RatingApi,
-    CommentApi,
-    LoyaltyApi,
-    ProductApi,
-    ProfileApi,
-    CurrencyApi,
-    DocumentApi,
-    WishlistApi,
-    ScopeApi,
-    BookingApi,
-    LandingApi,
+	CartApi,
+	AuthApi,
+	OrderApi,
+	RatingApi,
+	CommentApi,
+	LoyaltyApi,
+	ProductApi,
+	ProfileApi,
+	CurrencyApi,
+	DocumentApi,
+	WishlistApi,
+	ScopeApi,
+	BookingApi,
+	LandingApi,
 };
 export type ApiActionName =
     'auth.login'
@@ -57,6 +57,7 @@ export type ApiActionName =
     | 'order.cancel'
     | 'order.reOrder'
     | 'order.send'
+    | 'order.fetch'
     | 'product.getPrice'
     | 'product.availabilitySubscribe'
     | 'product.purchaseNow'
@@ -90,47 +91,47 @@ export type ApiActionName =
     | 'booking.add';
 
 export default interface Api {
-    cart: CartApi;
-    auth: AuthApi;
-    order: OrderApi;
-    rating: RatingApi;
-    comment: CommentApi;
-    loyalty: LoyaltyApi;
-    product: ProductApi;
-    profile: ProfileApi;
-    currency: CurrencyApi;
-    document: DocumentApi;
-    wishlist: WishlistApi;
-    scope: ScopeApi;
-    booking: BookingApi;
-    landing: LandingApi;
-    axios: AxiosInstance;
-    withoutNotifier: (callback: Function) => Promise<void>;
-    getHeaders: () => {
-        Accept: string | 'application/json, text/plain, */*',
-        "X-Requested-With": 'XMLHttpRequest',
-        "S-SOURCE": 'twilight',
-        "Store-Identifier"?: number,
-        currency?: string | 'SAR',
-        "accept-language"?: string | 'ar',
-        Authorization?: string
-    }
+	cart: CartApi;
+	auth: AuthApi;
+	order: OrderApi;
+	rating: RatingApi;
+	comment: CommentApi;
+	loyalty: LoyaltyApi;
+	product: ProductApi;
+	profile: ProfileApi;
+	currency: CurrencyApi;
+	document: DocumentApi;
+	wishlist: WishlistApi;
+	scope: ScopeApi;
+	booking: BookingApi;
+	landing: LandingApi;
+	axios: AxiosInstance;
+	withoutNotifier: (callback: Function) => Promise<void>;
+	getHeaders: () => {
+		Accept: string | 'application/json, text/plain, */*',
+		"X-Requested-With": 'XMLHttpRequest',
+		"S-SOURCE": 'twilight',
+		"Store-Identifier"?: number,
+		currency?: string | 'SAR',
+		"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;
+	handleAfterResponseActions(response: SuccessResponse | ErrorResponse | any): void;
 
-    fireEventsForResponse(response: SuccessResponse | ErrorResponse | any): void;
+	fireEventsForResponse(response: SuccessResponse | ErrorResponse | any): void;
 
-    showAlert(response: SuccessResponse | ErrorResponse | any): void;
+	showAlert(response: SuccessResponse | ErrorResponse | any): void;
 
-    handleErrorResponse(error: object): void;
+	handleErrorResponse(error: object): void;
 
-    handleInvalidFields(error: object): void;
+	handleInvalidFields(error: object): void;
 
-    errorPromise(data: any): Promise<any>;
+	errorPromise(data: any): Promise<any>;
 
-    successPromise(data: any): Promise<any>;
+	successPromise(data: any): Promise<any>;
 
-    isFastRequestsAllowed(): boolean;
+	isFastRequestsAllowed(): boolean;
 }

package/types/api/order.d.ts

@@ -16,9 +16,81 @@ export interface SendInvoicePayload {
     id: number
 }
 
+export interface OrderRequestParameters {
+    branch?: Array<number>;
+    city?: string;
+    country?: number;
+    coupon?: string;
+    customer_id?: number;
+    expanded?: boolean;
+    from_date?: string;
+    keyword?: string;
+    page?: number;
+    payment_method?: Array<string>;
+    product?: string;
+    reference_id?: number;
+    shipping_app_id?: Array<number>;
+    source?: Array<'store' | 'landing' | 'forgotten_basket' | 'abandoned-cart' | 'campaign' | 'dashboard' | 'buy_as_gift' | 'mahly-app' | 'buy_now' | 'one-click' | 'complete_order'>;
+    status?: Array<number>;
+    tags?: Array<number>;
+    to_date?: string;
+}
+
+export interface OrderResponse {
+    id?:                      number;
+    reference_id?:            number;
+    source?:                  string;
+    url?:                     string;
+    created_at?:              string;
+    total?:                   Total;
+    date?:                    DateClass;
+    status?:                  Status;
+    can_cancel?:              boolean;
+    can_reorder?:             boolean;
+    is_pending_payment?:      boolean;
+    pending_payment_ends_at?: number;
+    items?:                   Item[];
+}
+
+export interface DateClass {
+    date?:          Date;
+    timezone_type?: number;
+    timezone?:      string;
+}
+
+export interface Item {
+    name?:     string;
+    quantity?: number;
+}
+
+export interface Status {
+    id?:         number;
+    name?:       string;
+    slug?:       string;
+    color?:      string;
+    customized?: Customized;
+}
+
+export interface Customized {
+    id?:   number;
+    name?: string;
+}
+
+export interface Total {
+    amount?:   number;
+    currency?: string;
+}
+
+
+export interface FetchOrdersResponse extends SuccessResponse {
+    data: Array<OrderResponse>;
+}
+
+
 export default interface OrderApi {
     createCartFromOrder: (order_id?: number) => Promise<CreateCartFromOrderResponse>;
     cancel: (order_id?: number) => Promise<SuccessResponse>;
     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
+    fetch: (payload: OrderRequestParameters) => Promise<FetchOrdersResponse>;
 }

package/types/common.d.ts

@@ -9,6 +9,15 @@ export interface Price {
     currency: string;
 }
 
+export interface Pagination {
+    count?: number;
+    total?: number;
+    perPage?: number;
+    currentPage?: number;
+    totalPages?: number;
+    links?: Array<string>;
+}
+
 export interface SuccessResponse {
     status: 200;
     success: true;
@@ -17,6 +26,7 @@ export interface SuccessResponse {
         events?: { [event_name: string]: any };
         [key: string]: any;
     };
+    pagination?: Pagination
 }
 
 export interface ErrorResponse {

package/types/event/component.d.ts

@@ -3,6 +3,10 @@ import { ComponentApiResponse } from "../api/component";
 
 
 export default interface ComponentEvent {
-    onFetched: (callback: (response: ComponentApiResponse.menus) => void) => void;
-    onFetchFailed: RequestErrorEvent
+    onMenuFetched: (callback: (response: ComponentApiResponse.menus) => void) => void;
+    onMenuFetchFailed: RequestErrorEvent;
+
+    // Reviews
+    onReviewsFetched: (callback: (response: ComponentApiResponse.reviews) => void) => void;
+    onReviewsFetchFailed: RequestErrorEvent;
 }

package/types/event/order.d.ts

@@ -1,5 +1,5 @@
 import {RequestError, SuccessResponse} from "../common";
-import {CreateCartFromOrderResponse} from "../api/order";
+import {CreateCartFromOrderResponse, FetchOrdersResponse} from "../api/order";
 
 export default interface OrderEvent {
     onCanceled: (callback: (response: SuccessResponse, order_id?: number) => void) => void;
@@ -8,4 +8,6 @@ export default interface OrderEvent {
     onOrderCreationFailed: (callback: (error: RequestError, order_id?: number) => void) => void;
     onInvoiceSent: (callback: (response: SuccessResponse, order_id?: number) => void) => void;
     onInvoiceNotSent: (callback: (error: RequestError | 'There is no id!', order_id?: number) => void) => void;
+    onOrdersFetched: (callback: (response: FetchOrdersResponse) => void) => void;
+    onOrdersNotFetched:  (callback: (error: RequestError) => void) => void;
 }