@salla.sa/twilight 2.0.214 → 2.0.216

package/package.json

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

package/types/api/cart.d.ts

@@ -1,6 +1,4 @@
-// import {CartDetailsResponse} from "./cart/cart-details-response";
 import {Nullable, TwilightResponse} from "../common";
-import {AddCouponResponse} from "./coupon";
 
 export interface itemOffer {
     discount: number,
@@ -43,12 +41,6 @@ export interface OfferSummary {
     product_id: number,
 }
 
-export interface CartUpdatedData {
-    product_id: Nullable<number>;
-    offer: Nullable<OfferSummary>;
-    googleTags: string;//json string
-    cart: CartSummary
-}
 
 export interface CartLatestResponse extends TwilightResponse {
     data: {
@@ -60,7 +52,12 @@ export interface CartLatestResponse extends TwilightResponse {
 }
 
 export interface CartUpdateResponse extends TwilightResponse {
-    data: CartUpdatedData,
+    data: {
+        product_id: Nullable<number>;
+        offer: Nullable<OfferSummary>;
+        googleTags: string;//json string
+        cart: CartSummary
+    }
 }
 
 
@@ -73,15 +70,34 @@ 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 {
+    id: number;
+    quantity: 1 | number;
+    options: Nullable<{ [key: number]: [value: number | string | Array<{ [key: number]: [value: number] }>] }>;
+    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: 'cart/{cart}/item/{product}/add',
-    deleteItem: 'cart/{cart}/item/{item}',
-    updateItem: 'cart/{cart}/item/{item}',
-    deleteImage: 'cart/{cart}/image/{image}',
-    status: 'cart/{cart}/status',
-    // details: () => Promise<CartDetailsResponse>;
+    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;
 }

package/types/api/order.d.ts

@@ -0,0 +1,14 @@
+import {Nullable, TwilightResponse} from "../common";
+
+export interface ReOrderResponse extends TwilightResponse {
+    data: {
+        cart_id: number;
+        url: string;
+    };
+}
+
+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>;
+}

package/types/api/profile.d.ts

@@ -0,0 +1,32 @@
+import {Nullable, TwilightResponse} from "../common";
+
+export interface ProfilePayload {
+    first_name: string;
+    last_name: string;
+    birthday?: Nullable<string | '2022-02-22'>;
+    gender: Nullable<'male' | 'female'>;
+    email: string;
+    mobile: string | number;
+    country_code: string | 'SA';
+    country_key: string | '+966';
+}
+
+export interface UpdateProfileResponse extends TwilightResponse {
+    data: {
+        first_name: string;
+        last_name: string;
+        phone: {
+            code: string | "+966";
+            number: string | number;
+            country: string | "SA";
+        },
+        email: string;
+        avatar: string;
+        gender: Nullable<'male' | 'female'>;
+        birthday: string | '2022-02-22';
+    };
+}
+
+export default interface ProfileApi {
+    update: (data: ProfilePayload) => Promise<UpdateProfileResponse>;
+}

package/types/common.d.ts

@@ -1,5 +1,3 @@
-import {CartUpdatedData} from "./api/cart";
-
 export interface Price {
     amount: string;
     currency: string;

package/types/event/cart.d.ts

@@ -1,8 +1,31 @@
-import {CartSummary, AddToCartResponse, UpdateCartItemResponse, DeleteCartItemResponse} from "../api/cart";
+import {
+    CartSummary,
+    AddToCartResponse,
+    UpdateCartItemResponse,
+    DeleteCartItemResponse,
+    CartLatestResponse, CartStatusResponse
+} from "../api/cart";
+import {Nullable, RequestError, TwilightResponse} from "../common";
 
 export default interface CartEvent {
-    onUpdated: (callback: (cartSummery: 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,
+    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;
+    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;
+    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;
+    onSummaryNotFetched: (callback: (error: RequestError) => void) => void;
+    onDetailsNotFetched: (callback: (error: RequestError) => void) => void;
 }

package/types/event/order.d.ts

@@ -0,0 +1,12 @@
+import {Nullable, RequestError, TwilightResponse} 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;
+}

package/types/event/profile.d.ts

@@ -0,0 +1,10 @@
+import {UpdateProfileResponse} from "../api/profile";
+import {Nullable, RequestError} from "../common";
+
+export default interface ProfileEvent {
+    updated: (response: UpdateProfileResponse) => void; //fire the event
+    updateFailed: (RequestError) => void;//fire the event
+
+    onUpdated: (callback: (response: UpdateProfileResponse) => void) => void;
+    onUpdateFailed: (callback: (error: RequestError) => void) => void;
+}

package/types/index.d.ts

@@ -8,55 +8,84 @@ import CouponEvent from "./event/coupon";
 import CouponApi from "./api/coupon";
 import AuthApi from "./api/auth";
 import AuthEvent from "./event/auth";
+import OrderApi from "./api/order";
+import OrderEvent from "./event/order";
+import ProfileApi from "./api/profile";
+import ProfileEvent from "./event/profile";
 
 export * from "./all";
 
-export default interface salla {
+export default interface Salla {
     notify: string;
     api: Axios | {
         cart: CartApi,
         auth: AuthApi;
         gift: any;
-        order: any;
+        order: OrderApi;
         offer: any;
         search: any;
         coupon: CouponApi;
         comment: any;
         loyalty: any;
         product: any;
+        profile: ProfileApi;
         currency: any;
         document: any;
         feedback: any;
         twilight: any;
         wishlist: any;
     };
-    event: string;
-    infiniteScroll: string;
+    event: {
+        auth: AuthEvent,
+        cart: CartEvent,
+        gift: any;
+        order: OrderEvent;
+        offer: any;
+        search: any;
+        coupon: CouponEvent;
+        comment: any;
+        loyalty: any;
+        product: any;
+        profile: ProfileEvent;
+        currency: any;
+        document: any;
+        feedback: any;
+        twilight: any;
+        wishlist: any;
+
+    };
+    infiniteScroll: any;
     helpers: SallaHelpers;
     config: SallaConfig;
-    localStore: string;
+    storage: any;
+    form: any;
 
     //Aliases
-    cart: { api: CartApi, event: CartEvent };
-    auth: { api: AuthApi, event: AuthEvent };
+    cart: CartApi & { api: CartApi, event: CartEvent };
+    auth: AuthApi & { api: AuthApi, event: AuthEvent };
     gift: { api: any, event: any };
-    order: { api: any, event: any };
+    order: OrderApi & { api: OrderApi, event: OrderEvent };
     offer: { api: any, event: any };
     search: { api: any, event: any };
-    coupon: { api: CouponApi, event: CouponEvent };
+    coupon: CouponApi & { api: CouponApi, event: CouponEvent };
     comment: { api: any, event: any };
     loyalty: { api: any, event: any };
     product: { api: any, event: any };
+    profile: ProfileApi & { api: ProfileApi, event: ProfileEvent };
     currency: { api: any, event: any };
     document: { api: any, event: any };
     feedback: { api: any, event: any };
     twilight: { api: any, event: any };
     wishlist: { api: any, event: any };
 
-    log: string;
-    success: string;
-    error: string;
-    onReady: string; //don't relay on it because Salla may not existed yet
-    AppHelpers: string;
+    log: any;
+    success: any;
+    error: any;
+    onReady: any; //don't relay on it because Salla may not existed yet
+    AppHelpers: any;
     money: (money: number | Price) => string;
+}
+
+declare global {
+    let salla: Salla;
 }

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

@@ -1,22 +0,0 @@
-import {Price} from "../../common";
-import {CartItem} from "./item";
-
-export interface CartDetailsResponse {
-    status: number;
-    success: boolean;
-    data: {
-        items: CartItem;
-        require_shipping: boolean;
-        cart_total: Price;
-        total_before_discount: string;
-        count: number;
-        total: string;
-        coupon_discount: number;
-        total_discount: string;
-        sub_total: string;
-        final_total: string;
-        shipping_cost: number;
-        'free-shipping-bar'?: string;
-    };
-    message: string;
-}

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

@@ -1,7 +0,0 @@
-export interface CartStatusResponse {
-    active: true;
-    next_step: {
-        to: 'refresh' | 'login' | 'checkout';
-        url?: string;
-    };
-}

package/types/api/order/re-order-response.d.ts

@@ -1,9 +0,0 @@
-export interface reOrderResponse {
-    status: number;
-    success: boolean;
-    data: {
-        cart_id: number;
-        url: string;
-    };
-    message: string;
-}