@salla.sa/twilight 2.0.230 → 2.0.231

package/package.json

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

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

@@ -0,0 +1,15 @@
+import {SuccessResponse} from "../../common";
+
+export * from "./request";
+export * from "./response";
+import {AuthRequest} from "./request";
+import {AuthResponse} from "./response";
+
+export default interface AuthApi {
+    login: (data: AuthRequest.loginByMobile | AuthRequest.loginByEmail) => Promise<SuccessResponse>;
+    logout: () => Promise<SuccessResponse>;
+    verify: (type: 'mobile' | 'email', data: AuthRequest.verifyByMobile | AuthRequest.verifyByEmail, supportWebAuth: boolean) => Promise<AuthResponse.verify>;
+    resend: (data: AuthRequest.resend) => Promise<AuthResponse.resend>;
+    register: (data: AuthRequest.register) => Promise<AuthResponse.verify>;
+    refresh: () => Promise<AuthResponse.verify>;
+}

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

@@ -0,0 +1,41 @@
+export namespace AuthRequest {
+    export interface loginByMobile {
+        phone: string;
+        type: 'mobile';
+        country_code: string | 'SA';
+    }
+
+    export interface loginByEmail {
+        email: string;
+        type: 'email';
+    }
+
+    export interface verifyByEmail {
+        code: string;
+        email: string;
+    }
+
+    export interface verifyByMobile {
+        code: string;
+        phone: string;
+        country_code: string | "SA";
+    }
+
+    export interface register {
+        first_name: string;
+        last_name: string;
+        phone: string;
+        country_code: string | 'SA';
+        country_key: string | '+966';
+        verified_by: 'email' | 'phone';
+        email?: string;
+        code: number;
+    }
+
+    export interface resend {
+        resend_by: 'sms' | 'email';
+        phone?: string;
+        country_code?: string | "SA";
+        email?: string;
+    }
+}

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

@@ -0,0 +1,17 @@
+import {SuccessResponse} from "../../common";
+
+export namespace AuthResponse {
+    export interface verify extends SuccessResponse {
+        data: {
+            case: 'authenticated' | 'new_customer';
+            redirect_url?: string;
+            token?: string;
+        }
+    }
+
+    export interface resend extends SuccessResponse {
+        data: {
+            resend_counter: 2 | 3 | 4;
+        }
+    }
+}

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

@@ -0,0 +1,19 @@
+export * from "./request";
+export * from "./response";
+import { SuccessResponse} from "../../common";
+import {CartResponse} from "./response";
+import {CartRequest} from "./request";
+
+export default interface CartApi {
+    latest: () => Promise<CartResponse.latest>;
+    details: () => Promise<CartResponse.update>;
+    summary: () => Promise<CartResponse.update>;
+    quickAdd: (product_id: 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>;
+    reset: () => void;
+    submit: () => void;
+}

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

@@ -0,0 +1,8 @@
+import {ProductPayload} from "../product";
+
+export namespace CartRequest {
+    export interface addItem extends ProductPayload {
+        notes?: string;
+        file?: BinaryType | string;
+    }
+}

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

@@ -0,0 +1,75 @@
+import {SuccessResponse} from "../../common";
+export {SuccessResponse} from "../../common";
+export namespace CartResponse {
+    export interface latest extends SuccessResponse {
+        data: {
+            cart: {
+                id: number;
+                user_id: number | string;
+            }
+        };
+    }
+
+    export interface update extends SuccessResponse {
+        data: CartUpdatedData;
+    }
+
+    export interface status extends SuccessResponse {
+        data: {
+            active: boolean;
+            next_step: {
+                to: 'refresh' | 'login' | 'checkout';
+                url?: string;
+            };
+        }
+    }
+}
+
+
+export interface CartUpdatedData extends Object {
+    product_id?: number;
+    offer?: OfferSummary;
+    googleTags: string;//json string
+    cart: CartSummary;
+}
+
+export interface itemOffer {
+    discount: number;
+    is_free: boolean;
+    names: string;
+}
+
+export interface CartItem {
+    id: number;
+    product_id: number;
+    product_price: number;
+    price: number;
+    total: number;
+    is_available: true;
+    offer?: itemOffer;
+    quantity: number;
+    total_special_price: number;
+    special_price: number;
+}
+
+export interface CartSummary {
+    id: number;
+    user_id: number | string;
+    real_shipping_cost: number;
+    free_shipping_bar?: {
+        minimum_amount: number;
+        has_free_shipping: boolean;
+        percent: number | 0 | 100;
+        remaining: number;
+    };
+    sub_total: number;
+    discount: number;
+    total: number;
+    count: number;
+    items?: CartItem[];
+}
+
+export interface OfferSummary {
+    id: number;
+    product_id: number;
+}

package/types/api/comment.d.ts

@@ -1,9 +1,9 @@
-import {TwilightResponse} from "../common";
+import {SuccessResponse} from "../common";
 
-export interface SendCommentResponse extends TwilightResponse {
+export interface SendCommentResponse extends SuccessResponse {
     data: {
-        case: 'success' | 'error',
-        message: string,
+        case: 'success' | 'error';
+        message: string;
     }
 }
 

package/types/api/coupon.d.ts

@@ -1,12 +1,6 @@
-import {CartUpdateResponse} from "./cart";
-
-export interface AddCouponResponse extends CartUpdateResponse {
-}
-
-export interface RemoveCouponResponse extends CartUpdateResponse {
-}
+import {CartResponse} from "./cart";
 
 export default interface CouponApi {
-    add: (coupon: string) => Promise<AddCouponResponse>;
-    remove: () => Promise<RemoveCouponResponse>;
+    add: (coupon: string) => Promise<CartResponse.update>;
+    remove: () => Promise<CartResponse.update>;
 }

package/types/api/currency.d.ts

@@ -1,13 +1,13 @@
-import {Currency, TwilightResponse} from "../common";
+import {Currency, SuccessResponse} from "../common";
 
-export interface ChangeCurrencyResponse extends TwilightResponse {
+export interface ChangeCurrencyResponse extends SuccessResponse {
     data: {
-        code: 'SAR' | string,
-        symbol: string,
+        code: 'SAR' | string;
+        symbol: string;
     }
 }
 
-export interface ListCurrenciesResponse extends TwilightResponse {
+export interface ListCurrenciesResponse extends SuccessResponse {
     data: Array<Currency>
 }
 

package/types/api/gift.d.ts

@@ -1,4 +1,4 @@
-import {TwilightResponse} from "../common";
+import {SuccessResponse} from "../common";
 
 export interface GiftPayload {
     id: number;
@@ -16,11 +16,12 @@ export interface GiftPayload {
     deliver_at: string | '2022-02-22 02:22 pm';
 }
 
-export interface GiftResponse extends TwilightResponse {
-    redirect: string;
+export interface GiftResponse extends SuccessResponse {
+    data:{
+        redirect: string;
+    }
 }
 
 export default interface GiftApi {
     buy: (GiftPayload) => Promise<GiftResponse>;
-
 }

package/types/api/offer.d.ts

@@ -1,4 +1,4 @@
-import {Category, Product, TwilightResponse} from "../common";
+import {Category, Product, SuccessResponse} from "../common";
 
 type offerType = 'buy_x_get_y' | 'percentage' | 'fixed_amount';
 type paymentMethod = {
@@ -23,7 +23,7 @@ export interface Offer {
         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[];
@@ -34,7 +34,7 @@ export interface Offer {
     }
 }
 
-export interface OfferDetailsResponse extends TwilightResponse {
+export interface OfferDetailsResponse extends SuccessResponse {
     data: Offer[] | [];
 }
 

package/types/api/order.d.ts

@@ -1,6 +1,6 @@
-import {Nullable, TwilightResponse} from "../common";
+import { SuccessResponse} from "../common";
 
-export interface ReOrderResponse extends TwilightResponse {
+export interface ReOrderResponse extends SuccessResponse {
     data: {
         cart_id: number;
         url: string;
@@ -8,7 +8,7 @@ export interface ReOrderResponse extends TwilightResponse {
 }
 
 export default interface OrderApi {
-    reOrder: (order_id?: Nullable<number>) => Promise<ReOrderResponse>;
-    cancel: (order_id?: Nullable<number>) => Promise<TwilightResponse>;
-    send: (order_id?: Nullable<number>) => Promise<TwilightResponse>;
+    reOrder: (order_id?: number) => Promise<ReOrderResponse>;
+    cancel: (order_id?: number) => Promise<SuccessResponse>;
+    send: (order_id?: number) => Promise<SuccessResponse>;
 }

package/types/api/product.d.ts

@@ -1,11 +1,11 @@
-import {Nullable, TwilightResponse} from "../common";
+import { SuccessResponse} from "../common";
 
 type ProductOption = { [key: number]: number | string | number[] };
 
 export interface ProductPayload {
     id: number;
     quantity: 1 | number;
-    options?: Nullable<ProductOption>;
+    options?: ProductOption;
 }
 
 export interface AvailabilityPayload {
@@ -16,7 +16,7 @@ export interface AvailabilityPayload {
     mobile?: string | '555555555';//required when request without email
 }
 
-export interface GetPriceResponse extends TwilightResponse {
+export interface GetPriceResponse extends SuccessResponse {
     data: {
         price: number;
         regular_price: number;
@@ -26,5 +26,5 @@ export interface GetPriceResponse extends TwilightResponse {
 
 export default interface ProductApi {
     getPrice: (data: /*product_id*/number | ProductPayload) => Promise<GetPriceResponse>;
-    availabilitySubscribe: (product_id: number | AvailabilityPayload) => Promise<TwilightResponse>;
+    availabilitySubscribe: (product_id: number | AvailabilityPayload) => Promise<SuccessResponse>;
 }

package/types/api/profile.d.ts

@@ -1,10 +1,10 @@
-import {Nullable, TwilightResponse} from "../common";
+import { SuccessResponse} from "../common";
 
 export interface ProfilePayload {
     first_name: string;
     last_name: string;
-    birthday?: Nullable<string | '2022-02-22'>;
-    gender: Nullable<'male' | 'female'>;
+    birthday?: string | '2022-02-22';
+    gender?: 'male' | 'female';
     email: string;
     mobile: string | number;
     country_code: string | 'SA';
@@ -12,7 +12,7 @@ export interface ProfilePayload {
     avatar?: BinaryType;
 }
 
-export interface UpdateProfileResponse extends TwilightResponse {
+export interface UpdateProfileResponse extends SuccessResponse {
     data: {
         first_name: string;
         last_name: string;
@@ -20,10 +20,10 @@ export interface UpdateProfileResponse extends TwilightResponse {
             code: string | "+966";
             number: string | number;
             country: string | "SA";
-        },
+        };
         email: string;
         avatar: string;
-        gender: Nullable<'male' | 'female'>;
+        gender?: 'male' | 'female';
         birthday: string | '2022-02-22';
     };
 }

package/types/api/rating.d.ts

@@ -1,24 +1,17 @@
-import {Nullable, Product, Rating, TwilightResponse} from "../common";
+import { Product, Rating, SuccessResponse} from "../common";
 
-export interface SuccessRatingResponse extends TwilightResponse {
-    data: {
-        case: "success";
-        message: string;
-    }
-}
-
-export interface OrderDetailsResponse extends TwilightResponse {
+export interface OrderDetailsResponse extends SuccessResponse {
     data: {
         id: number;
-        store: Nullable<{ feedback: RatingContent }>;
-        shipping: Nullable<{
+        store?: { feedback: RatingContent };
+        shipping?: {
             feedback: RatingContent;
             company: {
                 id: number;
                 name: string;
-                logo: Nullable<string>;
+                logo?: string;
             }
-        }>;
+        };
         products: Array<{ feedback: RatingContent; product: Product; }>;
         testimonials_enabled: boolean;
         shipping_enabled: boolean;
@@ -28,7 +21,7 @@ export interface OrderDetailsResponse extends TwilightResponse {
 }
 
 export interface RatingContent {
-    content: string,
+    content: string;
     rating: Rating;
     status?: 'approved' | 'pending';
 }
@@ -50,7 +43,7 @@ export interface RatingShippingPayload extends RatingStorePayload {
 
 export default interface RatingApi {
     order: (order_id: number) => Promise<OrderDetailsResponse>;
-    store: (data: RatingStorePayload) => Promise<SuccessRatingResponse>;
-    products: (data: RatingProductsPayload) => Promise<SuccessRatingResponse>;
-    shipping: (data: RatingShippingPayload) => Promise<SuccessRatingResponse>;
+    store: (data: RatingStorePayload) => Promise<SuccessResponse>;
+    products: (data: RatingProductsPayload) => Promise<SuccessResponse>;
+    shipping: (data: RatingShippingPayload) => Promise<SuccessResponse>;
 }

package/types/api/search.d.ts

@@ -1,20 +1,13 @@
-import {Nullable, Product, TwilightResponse} from "../common";
+import { Product, SuccessResponse} from "../common";
 
-type SortOption = {
-    id: "ourSuggest" | "bestSell" | "topRated" | "priceFromTopToLow" | "priceFromLowToTop";
-    name: string
-};
-
-export interface SearchProductsResponse extends TwilightResponse {
+export interface SearchProductsResponse extends SuccessResponse {
     data: Product[];
     cursor: {
         current: number;
-        previous: Nullable<string>;
-        next: Nullable<string>;
+        previous?: string;
+        next?: string;
         count: number;
     };
-    features?: { sorting?: true };
-    sort_options: SortOption[];
 }
 
 export default interface SearchApi {

package/types/api/wishlist.d.ts

@@ -1,7 +1,7 @@
-import {TwilightResponse} from "../common";
+import {SuccessResponse} from "../common";
 
 export default interface WishlistApi {
-    add: (product_id: number) => Promise<TwilightResponse>;
-    remove: (product_id: number) => Promise<TwilightResponse>;
-    toggle: (product_id: number) => Promise<TwilightResponse>;
+    add: (product_id: number) => Promise<SuccessResponse>;
+    remove: (product_id: number) => Promise<SuccessResponse>;
+    toggle: (product_id: number) => Promise<SuccessResponse>;
 }

package/types/common.d.ts

@@ -1,4 +1,3 @@
-type Nullable<T> = T | undefined | null | '';
 type ProductType = 'product' | 'service' | 'group_products' | 'codes' | 'digital' | 'food' | 'donating';
 type Rating = 1 | 2 | 3 | 4 | 5;
 type RequestError = Error & { response: any }
@@ -10,25 +9,30 @@ export interface Price {
     currency: string;
 }
 
-export interface TwilightResponse {
-    data: Nullable<any>,
-    status: 200 | 422 | 404,
-    success: boolean,
-    message: string,
-    events: Nullable<string>
-    error: Nullable<{
-        message: Nullable<string | 'alert.invalid_fields'>,
-        code: Nullable<any>
-        case: Nullable<string | 'resend_counter' | 'invalid_code'>
-        events: Nullable<string>
-        fields: Nullable<{
-            [key: string]: Array<string>
-        }>
-    }>
+export interface SuccessResponse {
+    status: 200;
+    success: true;
+    data: {
+        message?: string;
+        events?: { [event_name: string]: any };
+        [key:string]:any;
+    };
+}
+
+export interface ErrorResponse {
+    status: 422 | 404;
+    success: false;
+    error: object | {
+        message?: string | 'alert.invalid_fields';
+        code?: any;
+        case?: string | 'resend_counter' | 'invalid_code';
+        events?: { [event_name: string]: any };
+        fields?: { [field_name: string]: Array<string> };
+    }
 }
 
 export interface Currency {
-    code: string| 'SAR';
+    code: string | 'SAR';
     name: string;
     symbol: string;
     amount?: number;
@@ -40,20 +44,20 @@ export interface Product {
     name: string;
     type: ProductType;
     promotion: {
-        title: Nullable<string>;
-        sub_title: Nullable<string>;
+        title?: string;
+        sub_title?: string;
     };
     price: Price;
-    sale_price: Nullable<Price>;
+    sale_price?: Price;
     regular_price: Price;
     has_special_price: boolean;
     status: 'sale' | 'out';
     is_available: boolean;
-    sku: Nullable<string>;
+    sku?: string;
     currency: string | 'SAR';
     url: string;
     thumbnail: string;
-    calories: Nullable<number>;
+    calories?: number;
 }
 
 export interface Category {

package/types/event/auth.d.ts

@@ -1,18 +1,17 @@
-import {LoginResponse, LogoutResponse, ResendPayload, ResendResponse, VerifyResponse} from "../api/auth";
-import {Nullable, TwilightResponse} from "../common";
+import {AuthRequest, AuthResponse} from "../api/auth";
+import {SuccessResponse} from "../common";
 
 export default interface AuthEvent {
-    onCodeSent: (callback: (response: LoginResponse, type: Nullable<'mobile' | 'email'>) => void) => void;
-    onCodeNotSent: (callback: (error: TwilightResponse | string, type: Nullable<'mobile' | 'email'>) => void) => void;
-    onCodeReSent: (callback: (response: ResendResponse, data: ResendPayload) => void) => void;
-    onCodeNotReSent: (callback: (error: TwilightResponse | string, data: ResendPayload) => void) => void;
-    onVerified: (callback: (response: VerifyResponse, type: Nullable<'mobile' | 'email'>) => void) => void;
-    onVerificationFailed: (callback: (error: TwilightResponse | string, type: Nullable<'mobile' | 'email'>) => void) => void;
-    // onLoggedIn: (callback: (response: LoginResponse, data: ResendPayload) => void) => void;
-    onRegistered: (callback: (response: VerifyResponse) => void) => void;
-    onRegistrationFailed: (callback: (error: TwilightResponse) => void) => void;
-    onLoggedOut: (callback: (response: LogoutResponse) => void) => void;
-    onFailedLogout: (callback: (error: TwilightResponse) => void) => void;
+    onCodeSent: (callback: (response: SuccessResponse, type?: 'mobile' | 'email') => void) => void;
+    onCodeNotSent: (callback: (error: SuccessResponse | string, type?: 'mobile' | 'email') => void) => void;
+    onCodeReSent: (callback: (response: AuthResponse.resend, data: AuthRequest.resend) => void) => void;
+    onCodeNotReSent: (callback: (error: SuccessResponse | string, data: AuthRequest.resend) => void) => void;
+    onVerified: (callback: (response: AuthResponse.verify, type?: 'mobile' | 'email') => void) => void;
+    onVerificationFailed: (callback: (error: SuccessResponse | string, type?: 'mobile' | 'email') => void) => void;
+    onRegistered: (callback: (response: AuthResponse.verify) => void) => void;
+    onRegistrationFailed: (callback: (error: SuccessResponse) => void) => void;
+    onLoggedOut: (callback: (response: SuccessResponse) => void) => void;
+    onFailedLogout: (callback: (error: SuccessResponse) => void) => void;
     onTokenFetched: (callback: (token: string) => void) => void;
-    onRefreshFailed: (callback: (error: TwilightResponse) => void) => void;
+    onRefreshFailed: (callback: (error: SuccessResponse) => void) => void;
 }

package/types/event/cart.d.ts

@@ -1,31 +1,25 @@
-import {
-    CartSummary,
-    AddToCartResponse,
-    UpdateCartItemResponse,
-    DeleteCartItemResponse,
-    CartLatestResponse, CartStatusResponse
-} from "../api/cart";
-import {Nullable, RequestError, TwilightResponse} from "../common";
+import {CartResponse, CartSummary} from "../api/cart";
+import { RequestError, SuccessResponse} from "../common";
 
 export default interface CartEvent {
     onUpdated: (callback: (cart_summary: CartSummary) => void) => void;
-    onItemAdded: (callback: (response: AddToCartResponse, product_id: number) => void) => void;
-    onItemUpdated: (callback: (response: UpdateCartItemResponse, product_id: number) => void) => void;
-    onItemDeleted: (callback: (response: DeleteCartItemResponse, product_id: number) => void) => void;
-    onLatestFetched: (callback: (response: CartLatestResponse) => void) => void;
-    onSubmitted: (callback: (response: CartStatusResponse) => void) => void;
-    onImageDeleted: (callback: (response: TwilightResponse, file_id: number) => void) => void;
-    onSummaryFetched: (callback: (response: CartStatusResponse) => void) => void;
-    onDetailsFetched: (callback: (response: CartStatusResponse) => void) => void;
+    onItemAdded: (callback: (response: CartResponse.update, product_id: number) => void) => void;
+    onItemUpdated: (callback: (response: CartResponse.update, product_id: number) => void) => void;
+    onItemDeleted: (callback: (response: CartResponse.update, product_id: number) => void) => void;
+    onLatestFetched: (callback: (response: CartResponse.latest) => void) => void;
+    onSubmitted: (callback: (response: CartResponse.status) => void) => void;
+    onImageDeleted: (callback: (response: SuccessResponse, file_id: number) => void) => void;
+    onSummaryFetched: (callback: (response: CartResponse.status) => void) => void;
+    onDetailsFetched: (callback: (response: CartResponse.status) => void) => void;
     onSuccessReset: (callback: () => void) => void;
 
     //errors
     onLatestFailed: (callback: (error: RequestError) => void) => void;
-    onItemUpdatedFailed: (callback: (error: RequestError | 'There is no "id"!', item_id: Nullable<number>) => void) => void;
-    onItemAddedFailed: (callback: (error: RequestError | 'There is no product "id"!', product_id: Nullable<number>) => void) => void;
-    onItemDeletedFailed: (callback: (error: RequestError | 'There is no "id"!', item_id: Nullable<number>) => void) => void;
+    onItemUpdatedFailed: (callback: (error: RequestError | 'There is no "id"!', item_id?: number) => void) => void;
+    onItemAddedFailed: (callback: (error: RequestError | 'There is no product "id"!', product_id?: number) => void) => void;
+    onItemDeletedFailed: (callback: (error: RequestError | 'There is no "id"!', item_id?: number) => void) => void;
     onSubmitFailed: (callback: (error: RequestError | "Can't find next_step );") => void) => void;
-    onImageNotDeleted: (callback: (error: RequestError | 'There is no "id"!', file_id: Nullable<number>) => void) => void;
+    onImageNotDeleted: (callback: (error: RequestError | 'There is no "id"!', file_id?: number) => void) => void;
     onSummaryNotFetched: (callback: (error: RequestError) => void) => void;
     onDetailsNotFetched: (callback: (error: RequestError) => void) => void;
 }

package/types/event/coupon.d.ts

@@ -1,9 +1,9 @@
-import {AddCouponResponse, RemoveCouponResponse} from "../api/coupon";
-import {Nullable, RequestError} from "../common";
+import {CartResponse} from "../api/cart";
+import {RequestError} from "../common";
 
 export default interface CouponEvent {
-    onAdded: (callback: (response: AddCouponResponse, cart_id: number) => void) => void,
-    onRemoved: (callback: (response: RemoveCouponResponse, cart_id: number) => void) => void,
-    onAddedFailed: (callback: (error: RequestError, cart_id: Nullable<number>) => void) => void,
-    onRemovedFailed: (callback: (error: RequestError, cart_id: Nullable<number>) => void) => void,
+    onAdded: (callback: (response: CartResponse.update, cart_id: number) => void) => void;
+    onRemoved: (callback: (response: CartResponse.update, cart_id: number) => void) => void;
+    onAddedFailed: (callback: (error: RequestError, cart_id?: number) => void) => void;
+    onRemovedFailed: (callback: (error: RequestError, cart_id?: number) => void) => void;
 }