@salla.sa/twilight 2.12.64 → 2.12.65

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salla.sa/twilight",
-    "version": "2.12.64",
+    "version": "2.12.65",
     "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 -- advertisement.test",
+        "test": "jest --detectOpenHandles -- component.test",
         "express": "node tests/server/index.js"
     },
     "keywords": [
@@ -67,5 +67,5 @@
     "peerDependencies": {
         "webpack": "^4 || ^5"
     },
-    "gitHead": "bb9279af324e38f9e4b4f3d1caa34bbf418a7c5a"
+    "gitHead": "4114d79a56944bb5a339ca236240538cac4f7f6f"
 }

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

@@ -4,6 +4,7 @@ export type VerificationStatus = {
     type: 'mobile' | 'email';
     status: 'success' | 'pending' | 'failed';
 }
+
 export namespace AuthResponse {
     export interface verify extends SuccessResponse {
         data: {

package/types/api/component.d.ts

@@ -0,0 +1,92 @@
+import {SuccessResponse, Product} from '../common'
+
+export interface AdvertisementColor {
+    bg: string;
+    text: string;
+}
+
+export interface HeaderBreadcrumb {
+    title: string;
+    url: string;
+}
+
+export interface HeaderAdvertisement {
+    id: number;
+    icon: string;
+    title: string;
+    description: string;
+    url?: string;
+    close_url: string;
+    target: string;
+    colors: AdvertisementColor[];
+}
+
+export interface HeaderMenuItem {
+    has_children?: boolean;
+    url?: string;
+    title?: string;
+    attrs?: string;
+    link_attrs?: string;
+    products?: Product[];
+    children?: Header[];
+}
+
+export interface Header {
+    menu: HeaderMenuItem[];
+    advertisement?: HeaderAdvertisement[];
+    breadcrumbs: HeaderBreadcrumb[];
+}
+
+// Footer
+export interface FooterMenu {
+    id?: number;
+    title?: string;
+    url?: string;
+    target?: string;
+}
+
+export interface FooterContact {
+    name?: string;
+    type?: string;
+    icon?: string;
+    url?: string;
+    value?: string;
+}
+
+export interface FooterMobileApp {
+    name?: string;
+    url?: string;
+    // TODO?: ask @jamal to add this field to the DTO,
+    // otherwise there is no way to get the image of the mobile app. 
+    // (i.e. for the sake of simplicity)
+    icon?: string; 
+}
+
+export interface FooterPaymentMethod {
+    payment_methods
+}
+
+export interface FooterSocialLink {
+    name?: string;
+    type?: string;
+    icon?: string;
+    url?: string;
+}
+
+export interface Footer {
+    contacts?: FooterContact[];
+    apps?: FooterMobileApp[];
+    items?: FooterMenu[];
+    payment_methods?: string[];
+    links?: FooterSocialLink[]
+}
+
+export namespace ComponentApiResponse {
+    export interface menus extends SuccessResponse {
+        data: HeaderMenuItem[] | FooterMenu[] | []
+    }
+}
+
+export default interface ComponentApi {
+    menus?: (component: string) => Promise<ComponentApiResponse.menus>
+}

package/types/api/profile.d.ts

@@ -1,11 +1,11 @@
-import {SuccessResponse} from "../common";
+import {SuccessResponse, Genders} from "../common";
 import {AuthRequest, VerificationStatus} from "./auth";
 
 export interface ProfileUpdatePayload {
     first_name: string;
     last_name: string;
-    birthday?: string | '2022-02-22';
-    gender?: 'male' | 'female';
+    birthday?: string;
+    gender?: Genders.Male | Genders.Female;
     avatar?: BinaryType;
 }
 

package/types/common.d.ts

@@ -41,26 +41,104 @@ export interface Currency {
 }
 
 export interface Product {
-    id: number;
-    name: string;
-    type: ProductType;
-    promotion: {
-        title?: string;
-        sub_title?: string;
-    };
-    price: Price;
-    sale_price?: Price;
-    regular_price: Price;
-    has_special_price: boolean;
-    status: 'sale' | 'out';
-    is_available: boolean;
-    sku?: string;
-    currency: string | 'SAR';
+    id?:                         number;
+    name?:                       string;
+    sku?:                        null | string;
+    subtitle?:                   null | string;
+    url?:                        string;
+    promotion_title?:            null | string;
+    status?:                     string;
+    type?:                       string;
+    description?:                string;
+    quantity?:                   number | any;
+    max_quantity?:               number;
+    sold_quantity?:              any;
+    price?:                      any[];
+    regular_price?:              any[];
+    sale_price?:                 any[];
+    starting_price?:             any;
+    discount_ends?:              any;
+    discount_percentage?:        string;
+    image?:                      MainImage;
+    calories?:                   any;
+    weight?:                     any;
+    base_currency_price?:        any[];
+    currency?:                   string;
+    donation?:                   any;
+    images?:                     ImageElement[];
+    rating?:                     any;
+    options?:                    any[];
+    tags?:                       any[];
+    brand?:                      Brand | any;
+    notify_availability?:        any;
+    category?:                   any;
+    can_add_note?:               boolean;
+    can_donate?:                 boolean;
+    can_upload_file?:            boolean;
+    can_show_sold?:              boolean;
+    can_show_remained_quantity?: boolean;
+    has_3d_image?:               boolean;
+    has_custom_form?:            boolean;
+    has_options?:                boolean;
+    has_read_more?:              boolean;
+    has_size_guide?:             boolean;
+    is_available?:               boolean;
+    is_hidden_quantity?:         boolean;
+    is_in_wishlist?:             boolean;
+    is_on_sale?:                 boolean;
+    is_out_of_stock?:            boolean;
+    is_require_shipping?:        boolean;
+    is_taxable?:                 boolean;
+    is_giftable?:                boolean;
+    is_donation?:                boolean;
+    is_booking?:                 boolean;
+    brand_id?:                   number | any;
+    target_donating_enable?:     boolean;
+    price_as_float?:             number;
+    price_as_float_for_payment?: number;
+    currency_for_payment?:       string;
+    sale_end?:                   any;
+    customized_sku_quantity?:    any;
+    auto_include_tax?:           any;
+    with_tax?:                   boolean;
+    enabled_image_upload?:       any;
+    max_quantity_per_order?:     any;
+    source?:                     any;
+    available?:                  any;
+    notes?:                      any;
+    attachments?:                any;
+    add_to_cart_label?:          string;
+    show_availability?:          boolean;
+}
+
+export interface MainImage {
+    url?: string;
+    alt?: string;
+}
+
+export interface Brand {
+    id: string;
     url: string;
-    thumbnail: string;
-    calories?: number;
+    name: string;
+    logo: string;
+}
+
+export interface ImageElement {
+    id?:                number;
+    url?:               string;
+    main?:              boolean;
+    three_d_image_url?: string;
+    alt?:               string;
+    video_url?:         string;
+    type?:              Type;
+    sort?:              number;
 }
 
+export enum Type {
+    Image = "image",
+}
+
+
 export interface Category {
     id: number;
     name: string;
@@ -72,4 +150,31 @@ export interface RequestInfo {
     method: string;
     payload: any,
     options: {},
+}
+
+export interface UserInstance {
+    id?:                     number;
+    currency?:               string;
+    language?:               string;
+    first_name?:             string;
+    last_name?:              string;
+    phone?:                  Phone;
+    email?:                  string;
+    avatar?:                 string;
+    gender?:                 string;
+    birthday?:               string;
+    notifications?:          number;
+    loyalty_program_points?: number;
+    pending_orders?:         string;
+}
+
+export interface Phone {
+    code?:    string;
+    number?:  number;
+    country?: string;
+}
+
+export enum Genders {
+    Female = 'female',
+    Male = 'male',
 }

package/types/event/auth.d.ts

@@ -8,7 +8,7 @@ export default interface AuthEvent {
     onRegistered: (callback: (response: AuthResponse.verify) => void) => void;
     onLoggedIn: (callback: (response: AuthResponse.verify) => void) => void;
     onLoggedOut: (callback: (response: SuccessResponse) => void) => void;
-
+    
     //Error Responses
     onCodeNotSent: (callback: (error: RequestError | string, type?: 'mobile' | 'email') => void) => void;
     onVerificationFailed: (callback: (error: RequestError | string, type?: 'mobile' | 'email') => void) => void;

package/types/event/component.d.ts

@@ -0,0 +1,8 @@
+import { RequestErrorEvent } from "../common";
+import { ComponentApiResponse } from "../api/component";
+
+
+export default interface ComponentEvent {
+    onFetched: (callback: (response: ComponentApiResponse.menus) => void) => void;
+    onFetchFailed: RequestErrorEvent
+}