@salla.sa/twilight 1.0.19 → 1.6.13

package/package.json

@@ -1,55 +1,66 @@
 {
-  "name": "@salla.sa/twilight",
-  "version": "1.0.19",
-  "description": "Salla Theme Toolkit, Webcomponents, Events, Requests, Utils",
-  "main": "dist/twilight.js",
-  "scripts": {
-    "prod": "webpack --mode production",
-    "watch": "webpack --mode development --watch",
-    "postinstall": "node ./postInstall.js"
-  },
-  "keywords": [
-    "salla",
-    "theme",
-    "utils",
-    "events",
-    "requests"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/SallaApp/twilight-js.git"
-  },
-  "author": "Salla.sa",
-  "license": "MIT",
-  "files": [
-    "dist",
-    "watcher.js",
-    "tailwind.js",
-    "package.json",
-    "components.js",
-    "postInstall.js",
-    "components/dist",
-    "components/loader",
-    "tailwind_css_list.js"
-  ],
-  "homepage": "https://salla.dev",
-  "dependencies": {
-    "@salla.sa/applepay": "~1.0",
-    "axios": "^0.23.0",
-    "eventemitter2": "^6.4.5",
-    "infinite-scroll": "^4.0.1",
-    "lang.js": "^1.1.14",
-    "store": "^2.0.12"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.16.0",
-    "babel-loader": "^8.2.3",
-    "glob": "^7.2.0",
-    "webpack": "^5.64.2",
-    "webpack-build-notifier": "^2.3.0",
-    "webpack-cli": "^4.9.1"
-  },
-  "peerDependencies": {
-    "webpack": "^4 || ^5"
-  }
+    "name": "@salla.sa/twilight",
+    "version": "1.6.13",
+    "description": "Salla Theme Toolkit, Webcomponents, Events, Requests, Utils",
+    "main": "dist/cjs",
+    "module": "dist/esm",
+    "types": "types/index.d.ts",
+    "scripts": {
+        "build": "npx rollup --config --preserveSymlinks=true",
+        "watch": "npx rollup --watch --config --preserveSymlinks=true"
+    },
+    "keywords": [
+        "salla",
+        "theme",
+        "utils",
+        "events",
+        "requests"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/SallaApp/twilight.git"
+    },
+    "author": "Salla.sa",
+    "license": "MIT",
+    "files": [
+        "dist",
+        "types",
+        "watcher.js",
+        "package.json",
+        "postInstall.js"
+    ],
+    "homepage": "https://salla.dev",
+    "dependencies": {
+        "@salla.sa/applepay": "~1.0",
+        "@salla.sa/base": "^1.6.13",
+        "@salla.sa/twilight-tailwind-theme": "^1.5.14",
+        "axios": "^0.27.2",
+        "infinite-scroll": "^4.0.1",
+        "jwt-decode": "^3.1.2",
+        "lang.js": "^1.1.14",
+        "websocket": "^1.0.34"
+    },
+    "devDependencies": {
+        "@babel/core": "^7.18.10",
+        "@babel/preset-env": "^7.18.10",
+        "@rollup/plugin-babel": "^5.3.1",
+        "@rollup/plugin-commonjs": "^22.0.2",
+        "@rollup/plugin-node-resolve": "^13.1.3",
+        "babel-loader": "^8.2.5",
+        "rollup-plugin-analyzer": "^4.0.0",
+        "rollup-plugin-cleaner": "^1.0.0",
+        "rollup-plugin-exclude-dependencies-from-bundle": "^1.1.22",
+        "rollup-plugin-node-polyfills": "^0.2.1",
+        "rollup-plugin-serve": "^2.0.1",
+        "rollup-plugin-terser": "^7.0.2",
+        "rollup-plugin-version-injector": "^1.3.3",
+        "rollup-plugin-watch": "^1.0.1",
+        "webpack": "^5.74.0",
+        "webpack-build-notifier": "^2.3.0",
+        "webpack-cli": "^4.10.0"
+    },
+    "peerDependencies": {
+        "webpack": "^4 || ^5"
+    },
+    "gitHead": "46e8084d1dcdbf7feddec0eb68fe856cabfa7a42"
 }

package/types/actions.d.ts

@@ -0,0 +1,47 @@
+import {
+    AuthApi, CartApi, CommentApi, CurrencyApi, DocumentApi, RatingApi, OrderApi,
+    ProductApi, ProfileApi, WishlistApi, LoyaltyApi,
+} from "./api";
+import {
+    AuthEvent, CartEvent, CommentEvent, CurrencyEvent, DocumentEvent, RatingEvent,
+    InfiniteScrollEvent, OrderEvent, ProductEvent, ProfileEvent, WishlistEvent, LoyaltyEvent,
+} from "./event";
+
+import Salla from "@salla.sa/base/types/index";
+
+export default interface SallaActions extends Salla {
+    cart: CartApi & { api: CartApi, event: CartEvent };
+    auth: AuthApi & { api: AuthApi, event: AuthEvent };
+    order: OrderApi & { api: OrderApi, event: OrderEvent };
+    rating: RatingApi & { api: RatingApi, event: RatingEvent };
+    comment: CommentApi & { api: CommentApi, event: CommentEvent };
+    loyalty: LoyaltyApi & { api: LoyaltyApi, event: LoyaltyEvent };
+    product: ProductApi & { api: ProductApi, event: ProductEvent };
+    profile: ProfileApi & { api: ProfileApi, event: ProfileEvent };
+    currency: CurrencyApi & { api: CurrencyApi, event: CurrencyEvent };
+    document: DocumentApi & { api: DocumentApi, event: DocumentEvent };
+    wishlist: WishlistApi & { api: WishlistApi, event: WishlistEvent };
+    infiniteScroll: InfiniteScroll & { api: null, event: InfiniteScrollEvent };
+}
+
+
+/********************* Infinite Scroll *********************/
+/**
+ * @see https://infinite-scroll.com/options.html
+ */
+export interface InfiniteScrollOptions {
+    path: '.infinite-scroll-btn' | string;
+    history: 'push' | false;
+    status: ".infinite-scroll-status" | string;
+    append: ".list-block" | string;
+    button: ".infinite-scroll-btn" | string;
+    next_page: string;
+}
+
+/**
+ * @see https://infinite-scroll.com/api.html
+ */
+export interface InfiniteScroll {
+    //💡 when there is no need to pass options, but there is need to change append selector, just pass it as string as second argument
+    initiate: (selector: string | HTMLElement, append?: string | InfiniteScrollOptions, customOptions?: InfiniteScrollOptions) => Object;
+}

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

@@ -0,0 +1,17 @@
+import {SuccessResponse} from "../../common";
+
+export * from "./request";
+export * from "./response";
+import {AuthRequest} from "./request";
+import {AuthResponse} from "./response";
+
+export default interface AuthApi {
+    canRedirect: () => boolean; //change it to false when you don't want page to reload or redirect automatically after logged in, use `salla.auth.event.onLoggedIn(response=>{...})`
+    setCanRedirect: (canRedirect: boolean) => void;
+    login: (data: AuthRequest.loginByMobile | AuthRequest.loginByEmail) => Promise<AuthResponse.loginOrResendCode>;
+    logout: () => Promise<SuccessResponse>;
+    verify: (data: AuthRequest.verifyByMobile | AuthRequest.verifyByEmail, supportWebAuth: boolean) => Promise<AuthResponse.verify>;
+    resend: (data: AuthRequest.resend) => Promise<AuthResponse.loginOrResendCode>;
+    register: (data: AuthRequest.register) => Promise<AuthResponse.verify>;
+    refresh: () => Promise<AuthResponse.verify>;
+}

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

@@ -0,0 +1,42 @@
+export namespace AuthRequest {
+    export interface loginByMobile {
+        phone: string;
+        type: 'mobile';
+        country_code: string | 'SA';
+    }
+
+    export interface loginByEmail {
+        email: string;
+        type: 'email';
+    }
+
+    export interface verifyByEmail {
+        type: 'email';
+        code: string;
+        email: string;
+    }
+
+    export interface verifyByMobile {
+        type: 'mobile';
+        code: string;
+        phone: string;
+        country_code: string | "SA";
+    }
+
+    export interface register {
+        first_name: string;
+        last_name: string;
+        phone: string;
+        country_code: string | 'SA';
+        verified_by: 'email' | 'phone';
+        email?: string;
+        code: number;
+    }
+
+    export interface resend {
+        type: 'mobile' | 'email';
+        phone?: string;
+        country_code?: string | "SA";
+        email?: string;
+    }
+}

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

@@ -0,0 +1,22 @@
+import {SuccessResponse} from "../../common";
+
+export type VerificationStatus = {
+    type: 'mobile' | 'email';
+    status: 'success' | 'pending' | 'failed';
+}
+export namespace AuthResponse {
+    export interface verify extends SuccessResponse {
+        data: {
+            case: 'authenticated' | 'new_customer';
+            redirect_url?: string;
+            token?: string;
+            verification?: VerificationStatus;
+        }
+    }
+
+    export interface loginOrResendCode extends SuccessResponse {
+        data: {
+            resend_counter?: 2 | 3 | 4;//when resend code
+        }
+    }
+}

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

@@ -0,0 +1,24 @@
+export * from "./request";
+export * from "./response";
+import {SuccessResponse} from "../../common";
+import {CartResponse} from "./response";
+import {CartRequest} from "./request";
+
+export default interface CartApi {
+    latest: () => Promise<CartResponse.update>;
+    details: () => Promise<CartResponse.update>;
+    quickAdd: (/*product_id*/id: number) => Promise<CartResponse.update>;
+    addItem: (data: CartRequest.addItem) => Promise<CartResponse.update>;
+    deleteItem: (item_id: number) => Promise<CartResponse.update>;
+    updateItem: (data: CartRequest.addItem) => Promise<CartResponse.update>;
+    deleteImage: (file_id: number) => Promise<SuccessResponse>;
+    status: () => Promise<CartResponse.status>;
+    reset: () => void;
+    submit: () => void;
+
+    getUploadImageEndpoint: (cartId?: number) => string;
+
+    //coupons
+    addCoupon: (coupon: string) => Promise<CartResponse.update>;
+    deleteCoupon: () => Promise<CartResponse.update>;
+}

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

@@ -0,0 +1,8 @@
+import ProductPayload from "../product";
+
+export namespace CartRequest {
+    export interface addItem extends ProductPayload {
+        notes?: string;
+        file?: BinaryType | string;
+    }
+}

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

@@ -0,0 +1,66 @@
+import { SuccessResponse } from "../../common";
+export namespace CartResponse {
+    export interface update extends SuccessResponse {
+        data: CartUpdatedData;
+    }
+
+    export interface status extends SuccessResponse {
+        data: {
+            active: boolean;
+            next_step: {
+                to: 'refresh' | 'login' | 'checkout';
+                url?: string;
+            };
+        }
+    }
+}
+
+
+export interface CartUpdatedData extends Object {
+    product_id?: number;
+    offer?: OfferSummary;
+    googleTags: string;//json string
+    cart: CartSummary;
+}
+
+export interface itemOffer {
+    discount: number;
+    is_free: boolean;
+    names: string;
+}
+
+export interface CartItem {
+    id: number;
+    product_id: number;
+    product_price: number;
+    price: number;
+    total: number;
+    is_available: true;
+    offer?: itemOffer;
+    quantity: number;
+    total_special_price: number;
+    special_price: number;
+}
+
+export interface CartSummary {
+    id: number;
+    user_id: number | string;
+    store_id: number;
+    real_shipping_cost?: number;
+    free_shipping_bar?: {
+        minimum_amount: number;
+        has_free_shipping: boolean;
+        percent: number | 0 | 100;
+        remaining: number;
+    };
+    sub_total: number;
+    discount: number;
+    total: number;
+    count: number;
+    items?: CartItem[];
+}
+
+export interface OfferSummary {
+    id: number;
+    product_id: number;
+}

package/types/api/comment.d.ts

@@ -0,0 +1,18 @@
+import {SuccessResponse} from "../common";
+
+export interface AddCommentResponse extends SuccessResponse {
+    data: {
+        case: 'success' | 'error';
+        message: string;
+    }
+}
+
+export interface AddCommentPayload {
+    id: number;
+    comment: string;
+    type: 'product' | 'page';
+}
+
+export default interface CommentApi {
+    add: (data: AddCommentPayload) => Promise<AddCommentResponse>;
+}

package/types/api/currency.d.ts

@@ -0,0 +1,17 @@
+import {Currency, SuccessResponse} from "../common";
+
+export interface ChangeCurrencyResponse extends SuccessResponse {
+    data: {
+        code: 'SAR' | string;
+        symbol: string;
+    }
+}
+
+export interface ListCurrenciesResponse extends SuccessResponse {
+    data: Array<Currency>
+}
+
+export default interface CurrencyApi {
+    change: (currency_code: 'SAR' | 'USD' | string) => Promise<ChangeCurrencyResponse>;
+    list: () => Promise<ListCurrenciesResponse>;
+}

package/types/api/document.d.ts

@@ -0,0 +1,3 @@
+
+export default interface DocumentApi {
+}

package/types/api/index.d.ts

@@ -0,0 +1,110 @@
+import CartApi from "./cart";
+import AuthApi from "./auth";
+import OrderApi from "./order";
+import RatingApi from "./rating";
+import CommentApi from "./comment";
+import LoyaltyApi from "./loyalty";
+import ProductApi from "./product";
+import ProfileApi from "./profile";
+import CurrencyApi from "./currency";
+import DocumentApi from "./document";
+import WishlistApi from "./wishlist";
+import ScopeApi from "./scope";
+import {ErrorResponse, SuccessResponse} from "@salla.sa/base/types/common";
+
+export {
+    CartApi,
+    AuthApi,
+    OrderApi,
+    RatingApi,
+    CommentApi,
+    LoyaltyApi,
+    ProductApi,
+    ProfileApi,
+    CurrencyApi,
+    DocumentApi,
+    WishlistApi,
+    ScopeApi,
+};
+export type ApiActionName =
+    'auth.login'
+    | 'auth.resend'
+    | 'auth.verify'
+    | 'auth.register'
+    | 'auth.logout'
+    | 'auth.refresh'
+    | 'cart.latest'
+    | 'cart.details'
+    | 'cart.summary'
+    | 'cart.quickAdd'
+    | 'cart.addItem'
+    | 'cart.deleteItem'
+    | 'cart.updateItem'
+    | 'cart.deleteImage'
+    | 'cart.status'
+    | 'cart.addCoupon'
+    | 'cart.deleteCoupon'
+    | 'loyalty.exchange'
+    | 'loyalty.getProgram'
+    | 'loyalty.reset'
+    | 'order.cancel'
+    | 'order.reOrder'
+    | 'order.send'
+    | 'product.getPrice'
+    | 'product.availabilitySubscribe'
+    | 'product.purchaseNow'
+    | 'product.search'
+    | 'product.categories'
+    | 'product.offers'
+    | 'profile.update'
+    | 'profile.getSizeGuides'
+    | 'profile.getGiftDetails'
+    | 'profile.addGiftToCart'
+    | 'profile.uploadGiftImage'
+    | 'comment.add'
+    | 'currency.change'
+    | 'currency.list'
+    | 'rating.store'
+    | 'rating.products'
+    | 'rating.shipping'
+    | 'rating.order'
+    | 'wishlist.add'
+    | 'wishlist.remove'
+    | 'scope.get'
+    | 'scope.change'
+    | 'scope.getProductAvailability'
+    | 'withoutNotifier';
+
+export default interface Api {
+    cart: CartApi;
+    auth: AuthApi;
+    order: OrderApi;
+    rating: RatingApi;
+    comment: CommentApi;
+    loyalty: LoyaltyApi;
+    product: ProductApi;
+    profile: ProfileApi;
+    currency: CurrencyApi;
+    document: DocumentApi;
+    wishlist: WishlistApi;
+    scope: ScopeApi;
+    withoutNotifier: (callback: Function) => Promise<void>;
+    getHeaders: () => {
+        Accept: string | 'application/json, text/plain, */*',
+        "X-Requested-With": 'XMLHttpRequest',
+        "S-SOURCE": 'twilight',
+        "Store-Identifier"?: number,
+        currency?: string | 'SAR',
+        "accept-language"?: string | 'ar',
+        Authorization?: string
+    }
+    request(endPoint: string, formData: undefined | object, method: string, options: object): Promise<any>
+    handleAfterResponseActions(response: SuccessResponse|ErrorResponse|any): void;
+    fireEventsForResponse(response: SuccessResponse|ErrorResponse|any): void;
+    showAlert(response: SuccessResponse|ErrorResponse|any): void;
+    handleErrorResponse(error: object): void;
+    handleInvalidFields(error: object): void;
+    errorPromise(data: any): Promise<any>;
+    successPromise(data: any): Promise<any>;
+    isFastRequestsAllowed(): boolean;
+}