@salla.sa/twilight 2.0.229 → 2.0.231

package/types/event/currency.d.ts

@@ -3,7 +3,7 @@ import {RequestErrorEvent} from "../common";
 
 export default interface CurrencyEvent {
     changed: (callback: (response: ChangeCurrencyResponse, currency: 'SAR' | string) => void) => void;
-    fetched: (callback: (response: ListCurrenciesResponse, currency: 'SAR' | string) => void) => void,
-    failed: RequestErrorEvent,
-    failedToFetch: RequestErrorEvent,
+    fetched: (callback: (response: ListCurrenciesResponse, currency: 'SAR' | string) => void) => void;
+    failed: RequestErrorEvent;
+    failedToFetch: RequestErrorEvent;
 }

package/types/event/document.d.ts

@@ -1,13 +1,13 @@
-import {Nullable, RequestError} from "../common";
+import { RequestError} from "../common";
 
 export interface requestPayload {
-    namespace: string | 'cart',
-    action: string | 'latest',
-    hook: string | 'latest',
-    url: string | 'cart/latest',
-    payload: {} | { params: {} },
-    method: 'get' | 'post' | 'put' | 'delete',
-    headers: Nullable<{}>,
+    namespace: string | 'cart';
+    action: string | 'latest';
+    hook: string | 'latest';
+    url: string | 'cart/latest';
+    payload: {} | { params: {} };
+    method: 'get' | 'post' | 'put' | 'delete';
+    headers?: {};
 }
 
 export default interface DocumentEvent {

package/types/event/gift.d.ts

@@ -1,7 +1,7 @@
-import {Nullable, RequestErrorEventWithData} from "../common";
+import { RequestErrorEventWithData} from "../common";
 import {GiftResponse} from "../api/gift";
 
 export default interface GiftEvent {
     onBuyingSucceeded: (callback: (response: GiftResponse, product_id: number) => void) => void;
-    onBuyingFailed: RequestErrorEventWithData</*product_id*/Nullable<number>>;
+    onBuyingFailed: RequestErrorEventWithData</*product_id*/number|undefined>;
 }

package/types/event/index.d.ts

@@ -38,8 +38,8 @@ export {
 }
 
 export default interface SallaEvent extends EventEmitter2 {
-    auth: AuthEvent,
-    cart: CartEvent,
+    auth: AuthEvent;
+    cart: CartEvent;
     gift: GiftEvent;
     order: OrderEvent;
     offer: OfferEvent;

package/types/event/order.d.ts

@@ -1,12 +1,12 @@
-import {Nullable, RequestError, TwilightResponse} from "../common";
+import {RequestError, SuccessResponse} from "../common";
 import {ReOrderResponse} from "../api/order";
 
 
 export default interface OrderEvent {
-    onCanceled: (callback: (response: TwilightResponse, order_id: Nullable<number>) => void) => void;
-    onNotCanceled: (callback: (error: RequestError, order_id: Nullable<number>) => void) => void;
-    onReOrdered: (callback: (response: ReOrderResponse, order_id: Nullable<number>) => void) => void;
-    onReOrderFailed: (callback: (error: RequestError, order_id: Nullable<number>) => void) => void;
-    onSent: (callback: (response: TwilightResponse, order_id: Nullable<number>) => void) => void;
-    onNotSent: (callback: (error: RequestError | 'There is no id!', order_id: Nullable<number>) => void) => void;
+    onCanceled: (callback: (response: SuccessResponse, order_id?: number) => void) => void;
+    onNotCanceled: (callback: (error: RequestError, order_id?: number) => void) => void;
+    onReOrdered: (callback: (response: ReOrderResponse, order_id?: number) => void) => void;
+    onReOrderFailed: (callback: (error: RequestError, order_id?: number) => void) => void;
+    onSent: (callback: (response: SuccessResponse, order_id?: number) => void) => void;
+    onNotSent: (callback: (error: RequestError | 'There is no id!', order_id?: number) => void) => void;
 }

package/types/event/product.d.ts

@@ -1,9 +1,9 @@
 import {GetPriceResponse} from "../api/product";
-import {RequestErrorEventWithData, TwilightResponse} from "../common";
+import {RequestErrorEventWithData, SuccessResponse} from "../common";
 
 export default interface ProductEvent {
     onPriceUpdated: (callback: (response: GetPriceResponse, product_id: number) => void) => void;
     onPriceUpdateFailed: RequestErrorEventWithData</*product_id*/ number>;
-    onAvailabilitySubscribed: (callback: (response: TwilightResponse, product_id: number) => void) => void;
+    onAvailabilitySubscribed: (callback: (response: SuccessResponse, product_id: number) => void) => void;
     onAvailabilitySubscribeFailed: RequestErrorEventWithData</*product_id*/ number>;
 }

package/types/event/rating.d.ts

@@ -1,18 +1,13 @@
-import {
-    SuccessRatingResponse,
-    OrderDetailsResponse,
-    RatingStorePayload,
-    RatingProductsPayload, RatingShippingPayload
-} from "../api/rating";
-import {RequestErrorEventWithData} from "../common";
+import {OrderDetailsResponse, RatingStorePayload, RatingProductsPayload, RatingShippingPayload} from "../api/rating";
+import {RequestErrorEventWithData, SuccessResponse} from "../common";
 
 export default interface RatingEvent {
     onOrderFetched: (callback: (response: OrderDetailsResponse, order_id: number) => void) => void;
     onOrderNotFetched: RequestErrorEventWithData</*order_id*/number>;
-    onStoreRated: (callback: (response: SuccessRatingResponse, data: RatingStorePayload) => void) => void;
+    onStoreRated: (callback: (response: SuccessResponse, data: RatingStorePayload) => void) => void;
     onStoreFailed: RequestErrorEventWithData</*data*/RatingStorePayload>;
-    onProductRated: (callback: (response: SuccessRatingResponse, data: RatingProductsPayload) => void) => void;
+    onProductRated: (callback: (response: SuccessResponse, data: RatingProductsPayload) => void) => void;
     onProductFailed: RequestErrorEventWithData</*data*/RatingProductsPayload>;
-    onShippingRated: (callback: (response: SuccessRatingResponse, data: RatingShippingPayload) => void) => void;
+    onShippingRated: (callback: (response: SuccessResponse, data: RatingShippingPayload) => void) => void;
     onShippingFailed: RequestErrorEventWithData</*data*/RatingShippingPayload>;
 }

package/types/event/search.d.ts

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

package/types/event/wishlist.d.ts

@@ -1,8 +1,8 @@
-import {RequestErrorEventWithData, TwilightResponse} from "../common";
+import {RequestErrorEventWithData, SuccessResponse} from "../common";
 
 export default interface WishlistEvent {
-    onAdded: (callback: (response: TwilightResponse, product_id: number) => void) => void;
-    onRemoved: (callback: (response: TwilightResponse, product_id: number) => void) => void;
+    onAdded: (callback: (response: SuccessResponse, product_id: number) => void) => void;
+    onRemoved: (callback: (response: SuccessResponse, product_id: number) => void) => void;
     onAdditionFailed: RequestErrorEventWithData</*product_id*/number>;
     onRemovingFailed: RequestErrorEventWithData</*product_id*/number>;
 }

package/types/helpers/salla-helpers.d.ts

@@ -3,14 +3,14 @@ import {Price} from "../common";
 export type UrlHelper = (path: string) => string; //add any path to current url, ex: `salla.url('cart?anything=data')` output => `https://store_domain.com/cart?anything=data`
 export default interface SallaHelpers {
     //Numbers helpers
-    digitsOnly: (num: string | number) => number,
-    inputDigitsOnly: (input: string | HTMLInputElement) => number,
-    number: (num: number) => number | string,
-    money: (num: number | Price) => string,
+    digitsOnly: (num: string | number) => number;
+    inputDigitsOnly: (input: string | HTMLInputElement) => number;
+    number: (num: number) => number | string;
+    money: (num: number | Price) => string;
 
     //Nested objects helpers
-    setNested: (object: Object, key: `${string}.${string}` | string, value: any) => Object,
-    getNested: (object: Object, key: `${string}.${string}` | string, default_?: any) => any,
+    setNested: (object: Object, key: `${string}.${string}` | string, value: any) => Object;
+    getNested: (object: Object, key: `${string}.${string}` | string, default_?: any) => any;
     /**
      * @example
      * 1- initial data:         `let data={items:{total:100,...}};`
@@ -18,12 +18,12 @@ export default interface SallaHelpers {
      * 3- getData as Object:    `salla.helpers.inputData('items[total]', 'new-value', data)`
      * 4- output:               `{name: items: value:{total:[100, 'new-value'],...}}`
      */
-    inputData: (inputName: `${string}[${null | string | number}]`, inputValue: any, data?: Object) => { name: string, value: string | number | Object | string[] | number[] },
+    inputData: (inputName: `${string}[${null | string | number}]`, inputValue: any, data?: Object) => { name: string, value: string | number | Object | string[] | number[] };
 
     //Url helpers
-    url: UrlHelper,
+    url: UrlHelper;
     addParamToUrl: (key: string, value: string | number) => string, //`salla.helpers.addParamToUrl('lang','ar')` => `https://store_domain.com/cart?lang=ar`
 
     //for advance usage:
-    debounce: (callback: Function, delay: number) => (...[]) => Promise<unknown>,
+    debounce: (callback: Function, delay: number) => (...[]) => Promise<unknown>;
 }

package/types/api/auth.d.ts

@@ -1,69 +0,0 @@
-import {Nullable, TwilightResponse} from "../common";
-
-export interface LogoutResponse extends TwilightResponse {
-
-}
-
-export interface LoginResponse extends TwilightResponse {
-
-}
-
-export interface VerifyResponse extends TwilightResponse {
-    case: 'authenticated' | 'new_customer',
-    redirect_url: Nullable<null>,
-    token: Nullable<string>,
-}
-
-export interface ResendResponse extends TwilightResponse {
-    data: {
-        resend_counter: 2 | 3 | 4,
-    }
-}
-
-export interface LoginByMobilePayload {
-    phone: string;
-    type: 'mobile';
-    country_code: string | 'SA';
-}
-
-export interface LoginByEmailPayload {
-    email: string;
-    type: 'email';
-}
-
-export interface VerifyByEmailPayload {
-    code: string;
-    email: string;
-}
-
-export interface VerifyByMobilePayload {
-    code: string;
-    phone: string,
-    country_code: string | "SA",
-}
-
-export interface RegisterPayload {
-    first_name: string;
-    last_name: string;
-    phone: string;
-    country_code: string | 'SA';
-    country_key: string | '+966';
-    verified_by: 'email' | 'phone';
-    email: Nullable<string>;
-    code: number;
-}
-
-export interface ResendPayload {
-    resend_by: 'sms' | 'email',
-    phone: string,
-    country_code: string | "SA",
-}
-
-export default interface AuthApi {
-    login: (data: LoginByMobilePayload | LoginByEmailPayload) => Promise<LoginResponse>;
-    logout: () => Promise<LogoutResponse>;
-    verify: (type: 'mobile' | 'email', data: VerifyByMobilePayload | VerifyByEmailPayload, supportWebAuth: boolean) => Promise<VerifyResponse>;
-    resend: (data: ResendPayload) => Promise<ResendResponse>,
-    register: (data: RegisterPayload) => Promise<VerifyResponse>,
-    refresh: () => Promise<VerifyResponse>,
-}

package/types/api/cart.d.ts

@@ -1,101 +0,0 @@
-import {Nullable, TwilightResponse} from "../common";
-import {ProductPayload} from "./product";
-
-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: Nullable<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: Nullable<{
-        minimum_amount: number,
-        has_free_shipping: boolean,
-        percent: number | 0 | 100,
-        remaining: number
-    }>,
-    sub_total: number,
-    discount: number,
-    total: number,
-    count: number,
-    items: Nullable<CartItem[]>,
-}
-
-export interface OfferSummary {
-    id: number,
-    product_id: number,
-}
-
-
-export interface CartLatestResponse extends TwilightResponse {
-    data: {
-        cart: {
-            id: number;
-            user_id: number | string;
-        }
-    };
-}
-
-export interface CartUpdateResponse extends TwilightResponse {
-    data: {
-        product_id: Nullable<number>;
-        offer: Nullable<OfferSummary>;
-        googleTags: string;//json string
-        cart: CartSummary
-    }
-}
-
-
-export interface AddToCartResponse extends CartUpdateResponse {
-}
-
-export interface UpdateCartItemResponse extends CartUpdateResponse {
-}
-
-export interface DeleteCartItemResponse extends CartUpdateResponse {
-}
-
-export interface CartStatusResponse extends TwilightResponse {
-    data: {
-        active: boolean;
-        next_step: {
-            to: 'refresh' | 'login' | 'checkout';
-            url: Nullable<string>;
-        };
-    }
-}
-
-export interface AddItemPayload extends ProductPayload {
-    notes?: Nullable<string>;
-    file?: Nullable<BinaryType | string>;
-}
-
-export default interface CartApi {
-    latest: () => Promise<CartLatestResponse>;
-    details: () => Promise<CartUpdateResponse>;
-    summary: () => Promise<CartUpdateResponse>;
-    quickAdd: (product_id: number) => Promise<CartUpdateResponse>;
-    addItem: (data: AddItemPayload) => Promise<CartUpdateResponse>;
-    deleteItem: (item_id: number) => Promise<CartUpdateResponse>;
-    updateItem: (data: AddItemPayload) => Promise<CartUpdateResponse>;
-    deleteImage: (file_id: number) => Promise<TwilightResponse>;
-    status: () => Promise<CartStatusResponse>;
-    reset: () => void;
-    submit: () => void;
-}