@salla.sa/twilight 2.0.254 → 2.0.256

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salla.sa/twilight",
-  "version": "2.0.254",
+  "version": "2.0.256",
   "description": "Salla Theme Toolkit, Webcomponents, Events, Requests, Utils",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

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

@@ -47,7 +47,7 @@ export interface CartSummary {
     id: number;
     user_id: number | string;
     store_id: number;
-    real_shipping_cost: number;
+    real_shipping_cost?: number;
     free_shipping_bar?: {
         minimum_amount: number;
         has_free_shipping: boolean;

package/types/event/document.d.ts

@@ -1,4 +1,4 @@
-import { RequestError} from "../common";
+import {RequestError} from "../common";
 
 export interface requestPayload {
     namespace: string | 'cart';
@@ -10,6 +10,7 @@ export interface requestPayload {
     headers?: {};
 }
 
+
 export default interface DocumentEvent {
     onClick: (selector: string | ((event) => void), callback?: (event) => void) => void;
     onChange: (selector: string | ((event) => void), callback?: (event) => void) => void;
@@ -18,4 +19,11 @@ export default interface DocumentEvent {
     onLeaving: (event: BeforeUnloadEvent) => boolean; //return false to show alert 'Changes you made may not be saved.'
     onRequest: (payload: requestPayload) => void; //💡handy when there is need to prevent request by throwing an error `throw 'stop the request';`.
     onRequestFailed: (payload: requestPayload, error?: RequestError) => void;
+    /**
+     * Helper method to fake firing event on element, for
+     * @example someInput.addEventListener("change",()=>{...});
+     * we want to fire this event programmatically, we can do that by:
+     * @example salla.document.event.fireEvent(someInput, 'change', {'bubbles': true})
+     */
+    fireEvent: (element: HTMLElement, eventName: 'click' | 'change' | string, payload: undefined | Object) => void;
 }

package/types/event/index.d.ts

@@ -16,6 +16,98 @@ import WishlistEvent from "./wishlist";
 import InfiniteScrollEvent from "./infiniteScroll";
 import {EventEmitter2} from "eventemitter2";
 
+export type event = (symbol | string);
+export type EventName = string
+    | 'auth::login'
+    | 'auth::logout'
+    | 'auth::code.sent'
+    | 'auth::code.not-sent'
+    | 'auth::code.re-sent'
+    | 'auth::code.not.re-sent'
+    | 'auth::verified'
+    | 'auth::verification.failed'
+    | 'auth::logged.in'
+    | 'auth::registered'
+    | 'auth::registration.failed'
+    | 'auth::logged.out'
+    | 'auth::failed.logout'
+    | 'auth::token.fetched'
+    | 'auth::refresh.failed'
+    | 'cart::latest.fetched'
+    | 'cart::latest.failed'
+    | 'cart::updated'
+    | 'cart::item.updated'
+    | 'cart::item.updated.failed'
+    | 'cart::item.added'
+    | 'cart::item.added.failed'
+    | 'cart::item.deleted'
+    | 'cart::item.deleted.failed'
+    | 'cart::submitted'
+    | 'cart::submit.failed'
+    | 'cart::image.deleted'
+    | 'cart::image.not.deleted'
+    | 'cart::details.fetched'
+    | 'cart::details.not.fetched'
+    | 'cart::success.reset'
+    | 'cart::coupon.added'
+    | 'cart::coupon.deleted'
+    | 'cart::coupon.addition.failed'
+    | 'cart::coupon.deletion.failed'
+    | 'gift::buying.succeeded'
+    | 'gift::buying.failed'
+    | 'loyalty::exchange.succeeded'
+    | 'loyalty::exchange.failed'
+    | 'order::canceled'
+    | 'order::not.canceled'
+    | 'order::re.ordered'
+    | 'order::re.order.failed'
+    | 'order::invoice.sent'
+    | 'order::invoice.not.sent'
+    | 'offer::existed'
+    | 'offer::increase'
+    | 'offer::increase.failed'
+    | 'offer::fetch.details.failed'
+    | 'offer::details.fetched'
+    | 'rating::order.not.fetched'
+    | 'rating::order.fetched'
+    | 'rating::store.rated'
+    | 'rating::store.failed'
+    | 'rating::products.rated'
+    | 'rating::products.failed'
+    | 'rating::shipping.rated'
+    | 'rating::shipping.failed'
+    | 'search::finished'
+    | 'search::failed'
+    | 'product::price.updated'
+    | 'product::price.updated.failed'
+    | 'product::availability.subscribed'
+    | 'product::availability.subscribe.failed'
+    | 'profile::updated'
+    | 'profile::update.failed'
+    | 'profile::mobile.updated'
+    | 'profile::update.mobile.failed'
+    | 'profile::email.updated'
+    | 'profile::update.email.failed'
+    | 'profile::verified'
+    | 'profile::unverified'
+    | 'comment::added'
+    | 'comment::addition.failed'
+    | 'currency::changed'
+    | 'currency::failed'
+    | 'currency::fetched'
+    | 'currency::failed.to.fetch'
+    | 'document::click'
+    | 'document::change'
+    | 'document::submit'
+    | 'document::keyup'
+    | 'document::leaving'
+    | 'document::request'
+    | 'document::request.failed'
+    | 'twilight::initiated'
+    | 'wishlist::added'
+    | 'wishlist::removed'
+    | 'wishlist::addition.failed'
+    | 'wishlist::removing.failed';
 export {
     AuthEvent,
     CartEvent,
@@ -53,5 +145,9 @@ export default interface SallaEvent extends EventEmitter2 {
     wishlist: WishlistEvent;
     infiniteScroll: InfiniteScrollEvent;
     dispatchEvents: (events: { [event_name: string]: any }) => void;
-    dispatch: (event_name: string, ...data: undefined | any) => void;
+    dispatch: (event_name: EventName, ...data: undefined | any) => void;
+
+    on(event: EventName, listener: (...values: any[]) => void, options?: boolean | Object): this;
+
+    once(event: EventName, listener: (...values: any[]) => void, options?: boolean | Object): this;
 }

package/types/index.d.ts

@@ -31,7 +31,7 @@ export default interface Salla extends SallaActions {
     form: SallaForm;
     money: (money: number | Price) => string;
     url: UrlHelper;
-
+    isInitiated: boolean; // will be true when firing event `twilight::initiated`
     onReady: (callback: (event: Event) => unknown) => void; //don't relay on it because Salla may not existed yet
     init: (config: SallaConfig) => void; // an alias for `salla.twilight.init(config)`
     call: (action: ApiActionName | string) => any;

package/types/lib/salla-config.ts

@@ -1,5 +1,5 @@
 import {Language, TwilightConfig} from "../tiwlight-config";
-import {Currency, Nullable, Price} from "../common";
+import {Currency, Price} from "../common";
 
 export type ConfigKey =
     '_token'
@@ -44,7 +44,7 @@ export default interface SallaConfig {
     isUser: () => boolean;
     isGuest: () => boolean;
     languageCode: () => string | 'ar';
-    currency: (code: Nullable<string | 'SAR'>) => Currency;
+    currency: (code?: string | 'SAR') => Currency;
     currencies: () => Promise<{ SAR: Currency, [code: string]: Currency }>;
     languages: () => Promise<{ ar: Language, [code: string]: Language }>;
 }