@salla.sa/twilight 1.6.15 → 2.0.0

package/types/index.d.ts

@@ -1,37 +0,0 @@
-import TwilightEmitter from './event';
-import Api, {ApiActionName} from "./api";
-import SallaActions from "./actions";
-
-import Config from "./lib/config";
-import AppHelpers from "./helpers/app-helpers";
-import SallaNotify from "./lib/notify";
-import SallaLang from "./lib/lang";
-import SallaForm from "./lib/form";
-import {TwilightConfig} from "./tiwlight-config";
-
-export default interface Salla extends SallaActions {
-    onReady: (callback: (event: Event) => unknown) => void; //relay on it, it will be available even salla object is not loaded yet
-
-    api: Api;
-    event: TwilightEmitter;
-
-    config: TwilightConfig;
-    lang: SallaLang;
-
-    notify: SallaNotify;
-    success: (message: string, data?: any) => void;
-    error: (message: string, data?: any) => void;
-
-    AppHelpers: AppHelpers;
-    form: SallaForm;
-    isInitiated: boolean; // will be true when firing event `twilight::initiated`
-    init: (config: TwilightConfig) => void; // an alias for `salla.twilight.init(config)`
-    call: (action: ApiActionName | string) => any;
-
-    onInitiated: (callback) => void; // don't relay on it because Salla may not existed yet
-}
-
-declare global {
-    // @ts-ignore
-    let salla: Salla, Salla: Salla;
-}

package/types/lib/config.ts

@@ -1,14 +0,0 @@
-import { Language, TwilightConfig } from "../tiwlight-config";
-import { Currency, Price } from "../common";
-import { default as SallaConfig } from "@salla.sa/base/types/config";
-
-export default interface Config extends SallaConfig {
-    merge: (config: TwilightConfig) => Config;
-    isRTL: () => boolean;
-    money: (money: number | Price) => string;
-    isUser: () => boolean;
-    isGuest: () => boolean;
-    currency: (code?: string | 'SAR') => Currency;
-    currencies: () => Promise<{ SAR: Currency, [iso_code: string]: Currency }>;
-    languages: () => Promise<Language[]>;
-}

package/types/lib/form.d.ts

@@ -1,8 +0,0 @@
-import {ApiActionName} from "../api";
-
-export default interface SallaForm {
-    submit: (action: ApiActionName|string, eventOrData: Event | Object) => Promise<any>;
-    onSubmit: (action: ApiActionName|string, eventOrData: Event | Object) => false;
-    onChange: (action: ApiActionName|string, eventOrData: Event | Object) => false;
-    getPossibleValue(formData: object|FormData, possibleNames: Array<string>, objectable?: boolean): object | FormData | string | undefined;
-}

package/types/lib/lang.d.ts

@@ -1,14 +0,0 @@
-import Lang from 'lang.js'
-
-type Replacements = { [key: string]: string }
-
-/**
- * @Example
- * salla.lang.get('pages.cart.free_shipping_alert',{amount:salla.money(100)})
- */
-export default interface SallaLang extends Lang {
-    translationsLoaded: boolean;
-    onLoaded: (callback: Function) => void;
-    get: (key: string, replacements?: Replacements, locale?: string | 'ar') => string;
-    set: (key: string, message: string) => SallaLang;
-}

package/types/lib/notify.d.ts

@@ -1,14 +0,0 @@
-export type NotifyType = 'error' | 'success' | 'info' | string;
-export type Notifier = (message: string, type: NotifyType, data?: object | any) => void | unknown;
-export type Logger = (...data: string[]) => void | unknown;
-export default interface SallaNotify {
-    fire: (message: string, type: NotifyType, data?: object | any) => Notifier; //default is just `alert(message)
-    setNotifier: (callback: Notifier) => void;// handy to override notifier used by salla.notify.fire(salla.success, salla.error, salla.info)
-    log: Logger; //default is just `console.log(...data)`
-    setLogger: (callback: Logger) => void;// handy to override logger used by salla.log()
-    error: (message: string, data?: object | any) => Notifier; //an alias for fire(message, salla.notify.types.error, data)
-    success: (message: string, data?: object | any) => Notifier; //an alias for fire(message, salla.notify.types.success, data)
-    info: (message: string, data?: object | any) => Notifier; //an alias for fire(message, salla.notify.types.info, data)
-    sallaInitiated;
-    types: { error: 'error', success: 'success', info: 'info' }; //handy to be overridden, to be passed via salla.error, salla.info, salla.success second argument when calling salla.notify.fire(message, /*{type}*/, data)
-}

package/types/tiwlight-config.d.ts

@@ -1,74 +0,0 @@
-import {Currency} from "./common";
-
-export interface Language {
-    name: string;
-    code: string;
-    url: string;
-    is_rtl: boolean;
-    country_code: string;
-}
-
-type Installment = 'tabby_installment' | 'tamara_installment' | 'spotii_pay';
-type PaymentName = Installment | 'mada' | 'credit_card' | 'paypal' | 'bank' | 'stc_pay' | 'apple_pay' | 'knet';
-
-export interface TwilightConfig {
-    /**
-     * @deprecated
-     */
-    _token?: string;
-
-    maintenance?: boolean;
-    debug?: boolean;
-    events?: { [event_name: string]: any };
-    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[];
-        };
-    };
-    user?: {
-        type?: 'user' | 'guest';
-        id?: string | number;
-        email?: any;
-        mobile?: any;
-        language_code?: string;
-        currency_code?: string;
-        country_code?: string;
-    };
-    theme?: {
-        name?: string;
-        mode?: string;
-        translations_hash?: string;
-        color?: {
-            primary: string | '#5cd5c4';
-            text: string | '#ffffff';
-            is_dark: boolean;
-            reverse_primary: string | '#5cd5c4';
-            reverse_text: string | '#005544';
-        }
-    };
-    languages?: Language[];
-    currencies?: {
-        SAR?: Currency;
-        [key: string]: Currency;
-    };
-    page?: {
-        title?: string;
-        slug?: string;
-        id?: number;//available in product.single, customer.orders.single, cart, thank-you, page-single
-    };
-}