@salla.sa/twilight 2.3.0 → 2.5.0

package/package.json

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

package/types/api/branches.d.ts

@@ -0,0 +1,42 @@
+import { SuccessResponse } from "../common";
+
+export interface Scope {
+    id: number;
+    name: string;
+    selected: boolean;
+}
+
+export interface ProductAvailability {
+    name: string;
+    selected: boolean;
+    availability: Availability;
+}
+
+export interface Availability {
+    label: string;
+    key: string;
+    color: string;
+}
+
+
+export namespace ScopeApiResponse {
+
+    export interface scopeList extends SuccessResponse {
+        data: Scope[];
+    }
+
+    export interface scopeAddition extends SuccessResponse {
+        data: Scope
+    }
+
+    export interface availability extends SuccessResponse {
+        data: ProductAvailability[];
+    }
+}
+
+
+export default interface ScopeApi {
+    get: () => Promise<ScopeApiResponse.scopeList>
+    createScope: (payload: Object) => Promise<SuccessResponse>
+    getProductAvailability: (product_id: number) => Promise<ScopeApiResponse.availability>
+}

package/types/api/index.d.ts

@@ -1,4 +1,4 @@
-import {Axios} from "axios";
+import { Axios } from "axios";
 import CartApi from "./cart";
 import AuthApi from "./auth";
 import GiftApi from "./gift";
@@ -12,6 +12,7 @@ import CurrencyApi from "./currency";
 import DocumentApi from "./document";
 import WishlistApi from "./wishlist";
 import TwilightApi from "./twilight";
+import ScopeApi from "./scope";
 
 export {
     CartApi,
@@ -27,6 +28,7 @@ export {
     DocumentApi,
     TwilightApi,
     WishlistApi,
+    ScopeApi,
 };
 export type ApiActionName =
     'auth.login'
@@ -67,8 +69,9 @@ export type ApiActionName =
     | 'rating.order'
     | 'wishlist.add'
     | 'wishlist.remove'
-    | 'scope.getAll'
-    | 'scope.submit';
+    | 'scope.get'
+    | 'scope.change'
+    | 'scope.getProductAvailability';
 
 export default interface SallaApi extends Axios {
     cart: CartApi;
@@ -84,6 +87,7 @@ export default interface SallaApi extends Axios {
     document: DocumentApi;
     twilight: TwilightApi;
     wishlist: WishlistApi;
+    scope: ScopeApi;
     getHeaders: () => {
         Accept: string | 'application/json, text/plain, */*',
         "X-Requested-With": 'XMLHttpRequest',

package/types/api/scope.d.ts

@@ -0,0 +1,42 @@
+import { SuccessResponse } from "../common";
+
+export interface Scope {
+    id: number;
+    name: string;
+    selected: boolean;
+}
+
+export interface ProductAvailability {
+    name: string;
+    selected: boolean;
+    availability: Availability;
+}
+
+export interface Availability {
+    label: string;
+    key: string;
+    color: string;
+}
+
+
+export namespace ScopeApiResponse {
+
+    export interface scopeList extends SuccessResponse {
+        data: Scope[];
+    }
+
+    export interface scopeAddition extends SuccessResponse {
+        data: Scope
+    }
+
+    export interface availability extends SuccessResponse {
+        data: ProductAvailability[];
+    }
+}
+
+
+export default interface ScopeApi {
+    get: () => Promise<ScopeApiResponse.scopeList>
+    change: (payload: Object) => Promise<SuccessResponse>
+    getProductAvailability: (product_id: number) => Promise<ScopeApiResponse.availability>
+}

package/types/event/branches.d.ts

@@ -0,0 +1,14 @@
+import { RequestErrorEvent } from "../common";
+import { ScopeApiResponse } from '../api/branches'
+
+export default interface BranchesEvent {
+    onScopeFetched: (callback: (response: ScopeApiResponse.scopeList) => void) => void;
+    onScopeFetchFailed: RequestErrorEvent;
+    // POST
+    onNewScopeSubmitted: (callback: (response: ScopeApiResponse.scopeAddition) => void) => void;
+    onscopeChangeFailed: RequestErrorEvent;
+
+    // Availability
+    onproductAvailableFetched: (callback: (response: ScopeApiResponse.availability, product_id: number) => void) => void;
+    onProductAvailabilityFetchFailed: RequestErrorEvent;
+}

package/types/event/index.d.ts

@@ -12,7 +12,8 @@ import DocumentEvent from "./document";
 import TwilightEvent from "./twilight";
 import WishlistEvent from "./wishlist";
 import InfiniteScrollEvent from "./infiniteScroll";
-import {EventEmitter2} from "eventemitter2";
+import ScopeEvents from "./scope";
+import { EventEmitter2 } from "eventemitter2";
 
 export type event = (symbol | string);
 export type EventName = string
@@ -106,6 +107,12 @@ export type EventName = string
     | 'wishlist::removed'
     | 'wishlist::addition.failed'
     | 'wishlist::removing.failed'
+    | 'scope::fetched'
+    | 'scope::not.fetched'
+    | 'scope::changed'
+    | 'scope::not.changed'
+    | 'scope::product-availability.fetched'
+    | 'scope::product-availability.not.fetched';
 export {
     AuthEvent,
     CartEvent,
@@ -121,6 +128,7 @@ export {
     TwilightEvent,
     WishlistEvent,
     InfiniteScrollEvent,
+    ScopeEvents,
 }
 
 export default interface SallaEvent extends EventEmitter2 {
@@ -137,6 +145,7 @@ export default interface SallaEvent extends EventEmitter2 {
     document: DocumentEvent;
     twilight: TwilightEvent;
     wishlist: WishlistEvent;
+    scope: ScopeEvents,
     infiniteScroll: InfiniteScrollEvent;
     dispatchEvents: (events: { [event_name: string]: any }) => void;
     dispatch: (event_name: EventName, ...data: undefined | any) => void;

package/types/event/scope.d.ts

@@ -0,0 +1,15 @@
+import { RequestErrorEvent } from "../common";
+import { ScopeApiResponse } from '../api/scope'
+
+export default interface ScopeEvents {
+    onFetched: (callback: (response: ScopeApiResponse.scopeList) => void) => void;
+    onNotFetched: RequestErrorEvent;
+    
+    // POST
+    onChanged: (callback: (response: ScopeApiResponse.scopeAddition) => void) => void;
+    onChangeFailed: RequestErrorEvent;
+
+    // Availability
+    onProductAvailabilityFetched: (callback: (response: ScopeApiResponse.availability, product_id: number) => void) => void;
+    onProductAvailabilityNotFetched: RequestErrorEvent;
+}