@salla.sa/twilight 3.0.0-alpha.0 → 3.0.0-beta.1

package/types/tiwlight-config.d.ts

@@ -8,6 +8,213 @@ export interface Language {
     country_code: string;
 }
 
+type Networks = 'mada' | 'masterCard' | 'visa';
+
+export type Apps = {
+    appstore?: string;
+    googleplay?: string;
+};
+
+export type DevelopmentStoreTemplate = {
+    price: number;
+    price_details: {
+        currency: string;
+        items: {
+            product_price: number;
+            price: number;
+            quantity: number;
+        }[];
+        total: number;
+    };
+    developer?: {
+        name: string;
+        url?: string;
+    };
+};
+
+export type StoreSettings = {
+    auth: {
+        email_allowed: boolean;
+        mobile_allowed: boolean;
+        is_email_required: boolean;
+        countries?: string[];
+        force_login?: boolean;
+    };
+    cart?: {
+        apply_coupon_enabled: boolean;
+    };
+    product?: {
+        total_sold_enabled: boolean;
+        manual_quantity: boolean;
+        fit_type?: string;
+        related_products_enabled: boolean;
+        filters: {
+            category_id?: boolean;
+            brand_id?: boolean;
+            price?: boolean;
+            variants?: boolean;
+            rating?: boolean;
+            tag_name?: boolean;
+        };
+        show_comments?: boolean;
+        user_can_comment?: boolean;
+        show_price_as_dash?: boolean;
+        notify_options_availability?: boolean;
+        show_special_offers?: boolean;
+        show_more?: boolean;
+        availability_notify?: {
+            email?: boolean;
+            mobile?: boolean;
+            sms?: boolean;
+            whatsapp?: boolean;
+        };
+        category?: {
+            testimonial_enabled?: boolean;
+        };
+    };
+    payments: PaymentName[];
+    arabic_numbers_enabled: boolean;
+    content_copyright?: boolean;
+    use_sar_symbol?: boolean;
+    is_multilingual?: boolean;
+    currencies_enabled?: boolean;
+    rating_enabled?: boolean;
+    rating?: {
+        is_enabled?: boolean;
+        show_on_category?: boolean;
+        show_on_product?: boolean;
+        can_rate_store?: boolean;
+        can_rate_product?: boolean;
+        can_rate_shipping?: boolean;
+        show_rating_summary?: boolean;
+        show_recommendation?: boolean;
+        allow_likes?: boolean;
+        allow_attach_images?: boolean;
+        allow_contact_support?: boolean;
+        allow_update?: boolean;
+        update_period?: number;
+        can_customer_hide_name?: boolean;
+        visitor_can_comment?:boolean;
+        page_feedback_enabled?:boolean;
+    };
+    blog?: {
+        is_enabled?: boolean;
+        allow_likes_and_comments?: boolean;
+    };
+    is_loyalty_enabled?: boolean;
+    keys?: {
+        maps?: string;
+        gtm?: string[];
+    };
+    is_salla_gateway?: boolean;
+    upload_size?: number;
+    tax?: {
+        number?: string;
+        certificate?: string;
+        taxable_prices_enabled?: boolean;
+    };
+    certificate?: string;
+    made_in_ksa?: boolean;
+    commercial_number?: string;
+    freelance_number?: string;
+    buy_now?: {
+        networks?: Networks[];
+        countries: string[];
+        multi_currency: boolean;
+        is_digital: boolean;
+    };
+    installments: Installment[];
+    quick_order?: {
+        title?: string;
+        sub_title?: string;
+        thanks_message?: string;
+        order_now_button?: string;
+        is_email_required?: boolean;
+        show_agreement?: boolean;
+        style?: 'grey' | 'white' | 'default';
+        confirm_button?: string;
+        agreement?: string;
+        allowed_countries?: string[];
+    };
+    bullet_delivery?: {
+        enabled?: boolean;
+        supports_pickup?: boolean;
+        supports_delivery?: boolean;
+        customer_location?: {
+            country?: string;
+            city?: string;
+        };
+        settings?: {
+            type?: string;
+            is_required?: boolean;
+            remember_last_session?: boolean;
+        };
+    };
+};
+
+export type StoreContacts = {
+    whatsapp?: string;
+    mobile?: string;
+    phone?: string;
+    email?: string;
+    telegram?: string;
+};
+
+export type StoreSocial = {
+    instagram?: string;
+    twitter?: string;
+    snapchat?: string;
+    tiktok?: string;
+    youtube?: string;
+    facebook?: string;
+    pinterest?: string;
+};
+
+export type StoreScope = {
+    id: number;
+    name: string;
+    selected: boolean;
+    type: string;
+    is_open: boolean;
+    display_as?: string;
+    languages: string[];
+    currencies: string[];
+    countries: string[];
+    always_ask: boolean;
+    allocation?: {
+        type: string;
+        branch_id: number;
+    };
+};
+
+export interface StoreConfig {
+    id: number;
+    url: string;
+    logo?: string;
+    name?: string;
+    username?: string;
+    description?: string;
+    icon?: string;
+    api?: string;
+    settings?: StoreSettings;
+    meta?: {
+        title?: string;
+        description?: string;
+        keywords?: string;
+    };
+    contacts?: StoreContacts;
+    social?: StoreSocial;
+    scope?: StoreScope;
+    store_country: string; // TODO: should be replace with country but for backward compatibility, we need to keep it for now.
+    country?: string;
+    /** Numeric store ray/shard identifier from the API. */
+    ray?: number;
+    /** Feature flags enabled for this store, e.g. ["guest-checkout", "salla-account"]. */
+    features?: string[];
+    template?: DevelopmentStoreTemplate;
+    apps?: Apps;
+}
+
 type Installment = 'tabby_installment' | 'tamara_installment' | 'spotii_pay';
 type PaymentName = Installment | 'mada' | 'credit_card' | 'paypal' | 'bank' | 'stc_pay' | 'apple_pay' | 'knet';
 export type TwilightConfigName = 'maintenance'
@@ -20,6 +227,18 @@ export type TwilightConfigName = 'maintenance'
     | 'store.id'
     | 'store.logo'
     | 'store.name'
+    | 'store.username'
+    | 'store.description'
+    | 'store.icon'
+    | 'store.contacts'
+    | 'store.social'
+    | 'store.scope'
+    | 'store.store_country'
+    | 'store.country'
+    | 'store.ray'
+    | 'store.features'
+    | 'store.template'
+    | 'store.apps'
     | 'store.api'
     | 'store.settings'
     | 'store.settings.auth'
@@ -74,23 +293,7 @@ export interface TwilightConfig {
     sdk?: {
         notifier_handler_disabled: boolean
     },
-    store: {
-        url: string;
-        id: number;
-        logo?: string;
-        name?: string;
-        api?: string;
-        settings?: {
-            auth: {
-                email_allowed: boolean;
-                mobile_allowed: boolean;
-                is_email_required: boolean;
-            };
-            arabic_numbers_enabled: boolean;
-            payments: PaymentName[];
-            installments: Installment[];
-        };
-    };
+    store: StoreConfig;
     user?: {
         type?: 'user' | 'guest';
         id?: string | number;
@@ -122,4 +325,4 @@ export interface TwilightConfig {
         slug?: string;
         id?: number;//available in product.single, customer.orders.single, cart, thank-you, page-single
     };
-}
+}

package/watcher.js

@@ -155,7 +155,7 @@ class WatcherPlugin {
         if (this.files[file]) clearTimeout(this.files[file]);
         this.files[file] = setTimeout(() => {
           execSync(
-            `${this.sallaCli} theme sync -f "${file}" -id ${this.theme_id}  -store_id ${this.store_id} -draft_id ${this.draft_id}  -upload_url ${this.upload_url}`,
+            `"${this.sallaCli}" theme sync -f "${file}" -i "${this.theme_id}" --store_id "${this.store_id}" --draft_id "${this.draft_id}" --upload_url "${this.upload_url}"`,
             { stdio: "inherit" }
           );
           delete this.files[file];