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

package/package.json

@@ -1,71 +1,75 @@
 {
-    "name": "@salla.sa/twilight",
-    "version": "2.15.1-alpha.0",
-    "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",
-        "test": "jest --detectOpenHandles",
-        "express": "node tests/server/index.js"
-    },
-    "keywords": [
-        "salla",
-        "theme",
-        "utils",
-        "events",
-        "requests"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/SallaApp/twilight.git"
-    },
-    "author": "Salla.sa",
-    "license": "GPL-3.0",
-    "files": [
-        "dist",
-        "types",
-        "watcher.js",
-        "package.json",
-        "postInstall.js"
-    ],
-    "homepage": "https://salla.dev",
-    "dependencies": {
-        "@salla.sa/base": "^2.15.1-alpha.0",
-        "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": "^6.0.4",
-        "@rollup/plugin-commonjs": "^25.0.4",
-        "@rollup/plugin-node-resolve": "^15.2.1",
-        "babel-loader": "^9.1.3",
-        "form-data": "^4.0.0",
-        "jest": "^29.3.1",
-        "jest-environment-jsdom": "^29.3.1",
-        "load-script": "^2.0.0",
-        "rollup-jest": "^3.1.0",
-        "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": "^5.1.4"
-    },
-    "peerDependencies": {
-        "webpack": "^4 || ^5"
-    },
-    "gitHead": "53ecc1108f14af383cfd588ee203b254dd5c5ef1"
-}
+  "name": "@salla.sa/twilight",
+  "version": "3.0.0-beta.1",
+  "description": "Salla Theme Toolkit, Webcomponents, Events, Requests, Utils",
+  "main": "dist/cjs",
+  "module": "dist/esm",
+  "types": "types/index.d.ts",
+  "keywords": [
+    "salla",
+    "theme",
+    "utils",
+    "events",
+    "requests"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SallaApp/twilight.git"
+  },
+  "author": "Salla.sa",
+  "license": "GPL-3.0",
+  "files": [
+    "dist",
+    "types",
+    "watcher.js",
+    "package.json",
+    "postInstall.js"
+  ],
+  "homepage": "https://salla.dev",
+  "dependencies": {
+    "@jitsu/js": "^1.10.4",
+    "axios": "^1.13.6",
+    "infinite-scroll": "^4.0.1",
+    "jwt-decode": "^4.0.0",
+    "lang.js": "^1.1.14",
+    "websocket": "^1.0.35",
+    "@salla.sa/base": "3.0.0-beta.1"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.29.0",
+    "@babel/preset-env": "^7.29.0",
+    "@rollup/plugin-babel": "^7.0.0",
+    "@rollup/plugin-commonjs": "^29.0.2",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-terser": "^1.0.0",
+    "babel-loader": "^10.1.0",
+    "ev-emitter": "^2.1.0",
+    "fizzy-ui-utils": "^3.0.0",
+    "form-data": "^4.0.5",
+    "jest": "^30.2.0",
+    "jest-environment-jsdom": "^30.2.0",
+    "load-script": "^2.0.0",
+    "nock": "^13.5.6",
+    "rollup": "^4.59.0",
+    "rollup-jest": "^3.1.0",
+    "rollup-plugin-analyzer": "^4.0.0",
+    "rollup-plugin-cleaner": "^1.0.0",
+    "rollup-plugin-exclude-dependencies-from-bundle": "^1.1.24",
+    "rollup-plugin-serve": "^3.0.0",
+    "rollup-plugin-version-injector": "^1.3.3",
+    "rollup-plugin-watch": "^1.0.5",
+    "webpack": "^5.105.4",
+    "webpack-build-notifier": "^3.1.0",
+    "webpack-cli": "^6.0.1"
+  },
+  "peerDependencies": {
+    "webpack": "^4 || ^5"
+  },
+  "gitHead": "e43ccbe0086ed916ecad8ac8cf952ece4e035e2e",
+  "scripts": {
+    "build": "npx rollup --config --bundleConfigAsCjs --preserveSymlinks=true",
+    "watch": "npx rollup --watch --config --bundleConfigAsCjs --preserveSymlinks=true",
+    "test": "jest --detectOpenHandles",
+    "test:ci": "jest --config jest.ci.config.js --forceExit"
+  }
+}

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

@@ -7,7 +7,7 @@ import {CartRequest} from "./request";
 export default interface CartApi {
     latest: () => Promise<CartResponse.update>;
     details: (cartId: number | null, withItems: ['options' | 'attachments']) => Promise<CartResponse.update>;
-    quickAdd: (/*product_id*/id: number, quantity: number) => Promise<CartResponse.update>;
+    quickAdd: (/*product_id*/id: number, quantity: number, offerType: string | null) => Promise<CartResponse.update>;
     addItem: (data: CartRequest.addItem) => Promise<CartResponse.update>;
     deleteItem: (item_id: number) => Promise<CartResponse.update>;
     updateItem: (data: CartRequest.addItem) => Promise<CartResponse.update>;

package/types/api/index.d.ts

@@ -13,6 +13,7 @@ import ScopeApi from "./scope";
 import LandingApi from "./landing";
 import BookingApi from "./booking";
 import NavigationApi from "./navigation"
+import MetadataApi from "./metadata"
 import {AxiosInstance} from "axios";
 import {ErrorResponse, SuccessResponse} from "@salla.sa/base/types/common";
 
@@ -56,6 +57,7 @@ export type ApiActionName =
     | 'loyalty.exchange'
     | 'loyalty.getProgram'
     | 'loyalty.reset'
+    | 'loyalty.getPoints'
     | 'order.cancel'
     | 'order.reOrder'
     | 'order.send'
@@ -73,8 +75,10 @@ export type ApiActionName =
     | 'product.uploadGiftImage'
     | 'product.fetch'
     | 'product.fetchOptions'
+    | 'product.fetchImages'
     | 'profile.update'
     | 'profile.info'
+    | 'profile.fields'
     | 'profile.updateContacts'
     | 'profile.verify'
     | 'profile.updateSettings'
@@ -97,7 +101,8 @@ export type ApiActionName =
     | 'scope.getProductAvailability'
     | 'withoutNotifier'
     | 'booking.add'
-    | 'navigation.fetchBreadcrumbs';
+    | 'navigation.fetchBreadcrumbs'
+    | 'metadata.fetchValues';
 
 export default interface Api {
 	cart: CartApi;
@@ -115,6 +120,7 @@ export default interface Api {
 	booking: BookingApi;
 	landing: LandingApi;
     navigation: NavigationApi;
+    metadata: MetadataApi;
 
 	axios: AxiosInstance;
 	withoutNotifier: (callback: Function) => Promise<void>;

package/types/api/loyalty.d.ts

@@ -212,6 +212,10 @@ export interface PrizeObject {
 }
 
 
+export interface UserLoyaltyPoint {
+    points: number | null
+}
+
 export namespace LoyaltyApiResponse {
 
     export interface program extends SuccessResponse {
@@ -222,11 +226,16 @@ export namespace LoyaltyApiResponse {
     export interface point extends SuccessResponse {
         data: ExchangePoint
     }
+
+    export interface userPoints extends SuccessResponse {
+        data: UserLoyaltyPoint
+    }
 }
 
 
 export default interface LoyaltyApi {
     getProgram: () => Promise<LoyaltyApiResponse.program>
-    exchange: (prize_id: number | PrizeObject, cart_id?: number) => Promise<LoyaltyApiResponse.point>
+    exchange: (prize_id: number | PrizeObject, cart_id?: number, selected_product_id?: number | null) => Promise<LoyaltyApiResponse.point>
     reset: (cart_id?: number) => Promise<SuccessResponse>
+    getPoints: () => Promise<LoyaltyApiResponse.userPoints>
 }

package/types/api/metadata.d.ts

@@ -0,0 +1,33 @@
+import { SuccessResponse } from '../common';
+
+export interface MetadataValue {
+    entity_id?: number;
+    sections?: Section[];
+}
+
+export interface Section {
+    id?: string;
+    name?: string;
+    fields?: Field[];
+}
+
+export interface Field {
+    id?: string;
+    name?: string;
+    type?: string;
+    value?: string;
+}
+
+export interface Metadata {
+    values: MetadataValue[];
+}
+
+export namespace MetadataApiResponse {
+    export interface value extends SuccessResponse {
+        data: Metadata;
+    }
+}
+
+export default interface MetadataApi {
+    fetchValues: (entity: string, entityIds: number[] | number) => Promise<MetadataApiResponse.value>;
+}

package/types/api/order.d.ts

@@ -1,4 +1,4 @@
-import {SuccessResponse} from "../common";
+import type {SuccessResponse} from "../common";
 
 export interface CreateCartFromOrderResponse extends SuccessResponse {
     data: {
@@ -46,6 +46,7 @@ export interface OrderResponse {
     date?:                    DateClass;
     status?:                  Status;
     can_cancel?:              boolean;
+    cancellation_reasons?:    CancellationReason[];
     can_reorder?:             boolean;
     is_pending_payment?:      boolean;
     pending_payment_ends_at?: number;
@@ -86,10 +87,25 @@ export interface FetchOrdersResponse extends SuccessResponse {
     data: Array<OrderResponse>;
 }
 
+export interface CancellationReason {
+    id: number;
+    name: string;
+    type: 'system' | 'custom';
+    slug: string | null;
+    sort: number;
+    is_active: boolean;
+    translations?: Record<string, { name: string }>;
+}
+
+export interface CancelOrderPayload {
+    reasons?: Array<number | string>;
+    reason_note?: string;
+}
 
 export default interface OrderApi {
     createCartFromOrder: (order_id?: number) => Promise<CreateCartFromOrderResponse>;
-    cancel: (order_id?: number) => Promise<SuccessResponse>;
+    cancel: (order_id?: number, payload?: CancelOrderPayload) => Promise<SuccessResponse>;
+    getDetails: (order_id?: number) => Promise<OrderResponse>;
     sendInvoice: (payload: SendInvoicePayload) => Promise<SuccessResponse>;
     show: (payload: ShowOrderPayload) => Promise<void>; //should be called from thank you page to trigger native order details page in apps
     fetch: (payload: OrderRequestParameters) => Promise<FetchOrdersResponse>;

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

@@ -55,6 +55,7 @@ export namespace ProductRequest {
         source_value: number | string | object | string[];
         filters?: object;
         limit?: number;
-        includes?: Array<string>
+        includes?: Array<string>;
+        with?: Array<'images' | 'three_d_image'>;
     }
 }

package/types/api/profile.d.ts

@@ -9,6 +9,11 @@ export interface ProfileUpdatePayload {
     avatar?: BinaryType;
 }
 
+export interface ProfileUpdateCustomFields {
+	id:number,
+    fields: { [key: string]: unknown };
+}
+
 export interface ProfileUpdateContactPayload {
     phone?: string | number; //required if there is no email
     country_code?: string | 'SA'; //required if there is phone

package/types/common.d.ts

@@ -51,7 +51,7 @@ export interface Currency {
 }
 
 export interface Product {
-    id?:                         number;
+    id?:                         number|string;//it's coming string sometimes🌚
     name?:                       string;
     sku?:                        null | string;
     subtitle?:                   null | string;
@@ -119,6 +119,7 @@ export interface Product {
     attachments?:                any;
     add_to_cart_label?:          string;
     show_availability?:          boolean;
+    metadata?:                   any;
 }
 
 export interface MainImage {
@@ -187,4 +188,22 @@ export interface Phone {
 export enum Genders {
     Female = 'female',
     Male = 'male',
+}
+
+export interface ProductMetadata {
+    entity_id?: number;
+    sections?: Section[];
+}
+
+export interface Section {
+    id?: string;
+    name?: string;
+    fields?: Field[];
+}
+
+export interface Field {
+    id?: string;
+    name?: string;
+    type?: string;
+    value?: string;
 }

package/types/event/index.d.ts

@@ -14,6 +14,7 @@ import ScopeEvents from "./scope";
 import BookingEvent from "./booking";
 import LandingEvent from "./landing";
 import NavigationEvent from "./navigation";
+import MetadataEvent from "./metadata";
 
 import Emitter from "@salla.sa/base/types/event";
 
@@ -36,6 +37,7 @@ export {
     BookingEvent,
     LandingEvent,
     NavigationEvent,
+    MetadataEvent,
 }
 
 export default interface TwilightEmitter extends Emitter {
@@ -55,4 +57,5 @@ export default interface TwilightEmitter extends Emitter {
     booking: BookingEvent;
     infiniteScroll: InfiniteScrollEvent;
     navigation: NavigationEvent;
+    metadata: MetadataEvent;
 }

package/types/event/loyalty.d.ts

@@ -10,5 +10,9 @@ export default interface LoyaltyEvent {
     onExchangeFailed: RequestErrorEvent;
     // Reset Exchange
     onResetSucceeded: (callback: (response: SuccessResponse) => void) => void;
-    onResetFailed: RequestErrorEvent
+    onResetFailed: RequestErrorEvent;
+
+    // User Loyalty Points
+    onLoyaltyPointsFetched: (callback: (response: LoyaltyApiResponse.userPoints) => void) => void;
+    onLoyaltyPointsNotFetched: RequestErrorEvent;
 }

package/types/event/metadata.d.ts

@@ -0,0 +1,7 @@
+import { RequestErrorEvent } from "../common";
+import { MetadataApiResponse } from "../api/metadata";
+
+export default interface MetadataEvent {
+    onValueFetched: (callback: (response: MetadataApiResponse.value) => void) => void;
+    onValueNotFetched: RequestErrorEvent;
+}

package/types/event/product.d.ts

@@ -35,5 +35,5 @@ export default interface ProductEvent {
     onProductListFetchFailed: RequestErrorEvent;
 
     onProductOptionsFetched: (callback: (response: ProductResponse.options) => void) => void;
-    onProductOptionsNotFetched: RequestErrorEvent
+    onProductOptionsNotFetched: RequestErrorEvent;
 }

package/types/lib/lang.d.ts

@@ -8,7 +8,8 @@ type Replacements = { [key: string]: string }
  */
 export default interface SallaLang extends Lang {
     translationsLoaded: boolean;
-    onLoaded: (callback: Function) => void;
+    onLoaded: (callback?: Function) => Promise<void>;
+    subscribe: (fn: () => void) => () => void;
     get: (key: string, replacements?: Replacements, locale?: string | 'ar') => string;
     set: (key: string, message: string) => SallaLang;
 }