@salla.sa/twilight 2.2.8 → 2.4.0

package/package.json

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

package/types/api/branches.d.ts

@@ -0,0 +1,42 @@
+import { SuccessResponse } from "../common";
+
+export interface Scope {
+    id: number;
+    name: string;
+    selected: boolean;
+}
+
+export interface ProductAvailability {
+    name: string;
+    selected: boolean;
+    availability: Availability;
+}
+
+export interface Availability {
+    label: string;
+    key: string;
+    color: string;
+}
+
+
+export namespace ScopeApiResponse {
+
+    export interface scopeList extends SuccessResponse {
+        data: Scope[];
+    }
+
+    export interface scopeAddition extends SuccessResponse {
+        data: Scope
+    }
+
+    export interface availability extends SuccessResponse {
+        data: ProductAvailability[];
+    }
+}
+
+
+export default interface ScopeApi {
+    get: () => Promise<ScopeApiResponse.scopeList>
+    createScope: (payload: Object) => Promise<SuccessResponse>
+    getProductAvailability: (product_id: number) => Promise<ScopeApiResponse.availability>
+}

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

@@ -1,4 +1,4 @@
-import {SuccessResponse} from "../../common";
+import { SuccessResponse } from "../../common";
 export namespace CartResponse {
     export interface update extends SuccessResponse {
         data: CartUpdatedData;

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

@@ -1,6 +1,6 @@
-import {SuccessResponse} from "../../common";
-import {ProductResponse} from "./response";
-import {ProductRequest} from "./request";
+import { SuccessResponse } from "../../common";
+import { ProductResponse } from "./response";
+import { ProductRequest } from "./request";
 
 export * from "./request";
 export * from "./response";
@@ -11,4 +11,6 @@ export default interface ProductApi {
     search: (keyword: string | ProductRequest.search) => Promise<ProductResponse.search>;
     categories: (categoryId?: number) => Promise<ProductResponse.categories>; //get all categories or sub_categories
     offers: (product_id: number) => Promise<ProductResponse.offers>; //get all categories or sub_categories
+    getGiftDetails: (product_id: number) => Promise<ProductResponse.giftResponse>;
+    addGiftToCart: (product_id: number, payload: Object, withRedirect: boolean);
 }

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

@@ -8,6 +8,14 @@ export interface Category {
 
 export type ProductOption = { [key: number]: number | string | number[] };
 
+
+export interface Receiver {
+    name: string;
+    country_code: string;
+    mobile: string;
+}
+
+
 export namespace ProductRequest {
     export interface addItem {
         id: number;
@@ -32,4 +40,14 @@ export namespace ProductRequest {
         country_code?: string | 'SA';//required when request without email
         phone?: string | '555555555';//required when request without email
     }
+
+    export interface giftToCart {
+        text: string;
+        sender_name: string;
+        receiver: Receiver;
+        quantity: number;
+        deliver_at: string;
+        image_url: string;
+        time_zone: string;
+    }
 }

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

@@ -37,6 +37,27 @@ export interface Offer {
     }
 }
 
+/**
+ * Gifting System
+ */
+ export interface Gift {
+    quantity: number;
+    product: Product;
+    sender_name: string;
+    images: GiftImage[];
+    texts: GiftText[];
+}
+
+export interface GiftImage {
+    id: number;
+    url: string;
+}
+
+export interface GiftText {
+    id: number;
+    text: string;
+}
+
 export namespace ProductResponse {
     export interface search extends SuccessResponse {
         data: Product[];
@@ -67,7 +88,16 @@ export namespace ProductResponse {
     export interface sizeGuides extends SuccessResponse {
         data: Array<SizeGuide>;
     }
-    
 
+    export interface giftResponse extends SuccessResponse {
+        data: Gift
+    }
+
+    export interface giftToCart extends SuccessResponse {
+        data: Object
+    }
 
+    export interface giftImageUpload extends SuccessResponse {
+        data: Object | String
+    }
 }

package/types/event/branches.d.ts

@@ -0,0 +1,14 @@
+import { RequestErrorEvent } from "../common";
+import { ScopeApiResponse } from '../api/branches'
+
+export default interface BranchesEvent {
+    onScopeFetched: (callback: (response: ScopeApiResponse.scopeList) => void) => void;
+    onScopeFetchFailed: RequestErrorEvent;
+    // POST
+    onNewScopeSubmitted: (callback: (response: ScopeApiResponse.scopeAddition) => void) => void;
+    onscopeChangeFailed: RequestErrorEvent;
+
+    // Availability
+    onproductAvailableFetched: (callback: (response: ScopeApiResponse.availability, product_id: number) => void) => void;
+    onProductAvailabilityFetchFailed: RequestErrorEvent;
+}

package/types/event/product.d.ts

@@ -1,6 +1,6 @@
-import {OfferSummary} from "../api/cart";
-import {ProductResponse} from "../api/product";
-import {RequestError, RequestErrorEvent, RequestErrorEventWithData, SuccessResponse} from "../common";
+import { OfferSummary } from "../api/cart";
+import { ProductResponse } from "../api/product";
+import { RequestError, RequestErrorEvent, RequestErrorEventWithData, SuccessResponse } from "../common";
 
 export default interface ProductEvent {
     onPriceUpdated: (callback: (response: ProductResponse.getPrice, product_id: number) => void) => void;
@@ -10,7 +10,7 @@ export default interface ProductEvent {
     onCategoriesFetched: (callback: (response: ProductResponse.categories) => void) => void;
     onCategoriesFailed: RequestError;
     onSearchResults: (callback: (response: ProductResponse.search, query?: string) => void) => void;
-    onSearchFailed: RequestErrorEventWithData</*query*/string|undefined>;
+    onSearchFailed: RequestErrorEventWithData</*query*/string | undefined>;
 
     onOfferExisted: (callback: (offer: OfferSummary) => void) => void;
     onOffersFetched: (callback: (response: ProductResponse.offers) => void) => void;
@@ -18,4 +18,13 @@ export default interface ProductEvent {
 
     onSizeGuideFetched: (callback: (response: ProductResponse.sizeGuides, prod_id: number) => void) => void;
     onSizeGuideFetchFailed: RequestErrorEvent;
+
+    onGiftFetched: (callback: (response: ProductResponse.giftResponse, product_id: number) => void) => void;
+    onGiftFetchFailed: RequestErrorEvent;
+
+    onAddGiftToCartSucceeded: (callback: (response: ProductResponse.giftToCart, product_id: number) => void) => void;
+    onAddGiftToCartFailed: RequestErrorEvent;
+
+    onGiftImageUploadSucceeded: (callback: (response: ProductResponse.giftImageUpload) => void) => void;
+    onGiftImageUploadFailed: RequestErrorEvent;
 }

package/types/api/gift.d.ts

@@ -1,27 +0,0 @@
-import {SuccessResponse} from "../common";
-
-export interface GiftPayload {
-    id: number;
-    image?: BinaryType;
-    image_url_id?: number;
-    text_id?: number;//required if text not provided
-    text?: string;//required if text_id not provided
-    sender_name?: string;
-    receiver: {
-        name: string;
-        mobile: number;
-        country_code: string | 'SA';
-        email?: string;
-    };
-    deliver_at: string | '2022-02-22 02:22 pm';
-}
-
-export interface GiftResponse extends SuccessResponse {
-    data:{
-        redirect: string;
-    }
-}
-
-export default interface GiftApi {
-    buy: (GiftPayload) => Promise<GiftResponse>;
-}

package/types/event/gift.d.ts

@@ -1,7 +0,0 @@
-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*/number|undefined>;
-}