@ikas/storefront-config 4.0.0-alpha.79 → 4.0.0-alpha.8

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ikas/storefront-config",
-  "version": "4.0.0-alpha.79",
+  "version": "4.0.0-alpha.8",
   "description": "Common configuration for ikas storefront packages.",
-  "main": "./build/index.js",
-  "module": "./build/index.js",
+  "main": "./src/index.ts",
+  "module": "./src/index.ts",
   "files": [
-    "./build"
+    "./src"
   ],
   "type": "module",
   "scripts": {
@@ -17,7 +17,7 @@
   "license": "ISC",
   "dependencies": {},
   "devDependencies": {
-    "@ikas/storefront-models": "^4.0.0-alpha.79",
+    "@ikas/storefront-models": "^4.0.0-alpha.8",
     "prettier": "^2.2.1",
     "rollup": "^2.75.6",
     "rollup-plugin-terser": "^7.0.2",
@@ -27,6 +27,6 @@
     "typescript-transform-paths": "^2.2.2"
   },
   "peerDependencies": {
-    "@ikas/storefront-models": "^4.0.0-alpha.79"
+    "@ikas/storefront-models": "^4.0.0-alpha.8"
   }
 }

package/src/index.ts

@@ -0,0 +1,317 @@
+import {
+  IkasCustomerReviewSettings,
+  IkasMerchantSettings,
+  IkasProductBackInStockSettings,
+  IkasSalesChannelPaymentGateway,
+  IkasStorefrontRouting,
+  IkasThemeJsonFavicon,
+  IkasThemeJsonStockPreference,
+} from "@ikas/storefront-models";
+
+export class IkasStorefrontConfig {
+  private static themeId?: string;
+  private static apiUrl?: string;
+  private static adminApiUrl?: string;
+  private static cdnUrl?: string;
+  private static apiKey?: string;
+  private static customerToken?: string;
+  private static storefrontId?: string;
+  private static storefrontRoutingId?: string;
+  private static priceListId?: string;
+  private static stockLocationIds?: string[];
+  private static loginRequiredCallback?: LoginRequiredCallbackType;
+  private static domain?: string;
+  private static storefrontThemeId?: string;
+  private static salesChannelId?: string;
+  private static routings: IkasStorefrontRouting[] = [];
+  private static paymentGateways: IkasSalesChannelPaymentGateway[] = [];
+  private static gtmId?: string;
+  private static fbpId?: string;
+  private static analytics4Id?: string;
+  private static universalAnalyticsId?: string;
+  private static pickUpStockLocationIds?: string[] | null;
+  private static tiktokPixelId?: string;
+  private static favicon?: IkasThemeJsonFavicon;
+  private static stockPreference?: IkasThemeJsonStockPreference;
+  private static translations: Record<string, any> = {};
+  private static storefrontJSScripts: string[] = [];
+  private static customerReviewSettings?: IkasCustomerReviewSettings | null;
+  private static productBackInStockSettings?: IkasProductBackInStockSettings | null;
+  private static merchantSettings?: IkasMerchantSettings | null;
+  private static currentPageComponents?: Record<string, any>;
+  private static isEditor = false;
+
+  private static sessionId?: string;
+  private static visitorId?: string;
+  private static observers: IkasStorefrontConfigObserver[] = [];
+
+  static addObserver(observer: IkasStorefrontConfigObserver) {
+    const existingObserver = IkasStorefrontConfig.observers.find(
+      (o) => o.id === observer.id
+    );
+
+    if (existingObserver) {
+      existingObserver.callback = observer.callback;
+    } else {
+      IkasStorefrontConfig.observers.push(observer);
+    }
+
+    observer.callback(IkasStorefrontConfig);
+  }
+
+  static init(config: Partial<IkasStorefrontConfigParams>) {
+    try {
+      Object.entries(config).forEach(([key, value]) => {
+        //@ts-ignore
+        IkasStorefrontConfig[key] = value;
+      });
+      if (config.token) {
+        IkasStorefrontConfig.apiKey = config.token;
+      }
+      this.notify();
+    } catch (err) {
+      console.error(err);
+    }
+  }
+
+  static async initFromAPI(apiKey: string) {
+    // TODO
+  }
+
+  static getCurrentRouting() {
+    return IkasStorefrontConfig.routings.find(
+      (r) => r.id === IkasStorefrontConfig.storefrontRoutingId
+    );
+  }
+
+  static getCurrentLocale() {
+    const routing = IkasStorefrontConfig.getCurrentRouting();
+    return routing?.locale || "en";
+  }
+
+  private static notify() {
+    this.observers.forEach((o) => o.callback(this));
+  }
+
+  // HELPERS
+
+  static isCustomerReviewEnabled() {
+    const customerReviewSettings =
+      IkasStorefrontConfig.getCustomerReviewSettings();
+
+    return (
+      !!customerReviewSettings &&
+      !customerReviewSettings.customerPurchaseRequired
+    );
+  }
+
+  static isCustomerReviewLoginRequired() {
+    const customerReviewSettings =
+      IkasStorefrontConfig.getCustomerReviewSettings();
+
+    if (!customerReviewSettings) return true;
+
+    return customerReviewSettings.customerLoginRequired;
+  }
+
+  static isBackInStockEnabled() {
+    return !!IkasStorefrontConfig.getProductBackInStockSettings();
+  }
+
+  static isCustomerLoginRequiredForBackInStock() {
+    const productBackInStockSettings =
+      IkasStorefrontConfig.getProductBackInStockSettings();
+    return (
+      productBackInStockSettings &&
+      productBackInStockSettings.customerLoginRequired
+    );
+  }
+
+  static toJSON() {
+    const json = {
+      ...this,
+    };
+
+    //@ts-ignore
+    delete json.observers;
+
+    return json;
+  }
+
+  // GETTERS
+
+  static getThemeId() {
+    return IkasStorefrontConfig.themeId;
+  }
+
+  static getApiUrl() {
+    return IkasStorefrontConfig.apiUrl;
+  }
+
+  static getAdminApiUrl() {
+    return IkasStorefrontConfig.adminApiUrl;
+  }
+
+  static getCdnUrl() {
+    return IkasStorefrontConfig.cdnUrl;
+  }
+
+  static getApiKey() {
+    return IkasStorefrontConfig.apiKey;
+  }
+
+  static getCustomerToken() {
+    return IkasStorefrontConfig.customerToken;
+  }
+
+  static getStorefrontId() {
+    return IkasStorefrontConfig.storefrontId;
+  }
+
+  static getStorefrontRoutingId() {
+    return IkasStorefrontConfig.storefrontRoutingId;
+  }
+
+  static getPriceListId() {
+    return IkasStorefrontConfig.priceListId;
+  }
+
+  static getStockLocationIds() {
+    return IkasStorefrontConfig.stockLocationIds;
+  }
+
+  static getLoginRequiredCallback() {
+    return IkasStorefrontConfig.loginRequiredCallback;
+  }
+
+  static getDomain() {
+    return IkasStorefrontConfig.domain;
+  }
+
+  static getStorefrontThemeId() {
+    return IkasStorefrontConfig.storefrontThemeId;
+  }
+
+  static getSalesChannelId() {
+    return IkasStorefrontConfig.salesChannelId;
+  }
+
+  static getRoutings() {
+    return IkasStorefrontConfig.routings;
+  }
+
+  static getPaymentGateways() {
+    return IkasStorefrontConfig.paymentGateways;
+  }
+
+  static getGtmId() {
+    return IkasStorefrontConfig.gtmId;
+  }
+
+  static getFbpId() {
+    return IkasStorefrontConfig.fbpId;
+  }
+
+  static getAnalytics4Id() {
+    return IkasStorefrontConfig.analytics4Id;
+  }
+
+  static getUniversalAnalyticsId() {
+    return IkasStorefrontConfig.universalAnalyticsId;
+  }
+
+  static getPickupStockLocationIds() {
+    return IkasStorefrontConfig.pickUpStockLocationIds;
+  }
+
+  static getTiktokPixelId() {
+    return IkasStorefrontConfig.tiktokPixelId;
+  }
+
+  static getFavicon() {
+    return IkasStorefrontConfig.favicon;
+  }
+
+  static getStockPreference() {
+    return IkasStorefrontConfig.stockPreference;
+  }
+
+  static getTranslations() {
+    return IkasStorefrontConfig.translations;
+  }
+
+  static getStorefrontJSScripts() {
+    return IkasStorefrontConfig.storefrontJSScripts;
+  }
+
+  static getCustomerReviewSettings() {
+    return IkasStorefrontConfig.customerReviewSettings;
+  }
+
+  static getProductBackInStockSettings() {
+    return IkasStorefrontConfig.productBackInStockSettings;
+  }
+
+  static getMerchantSettings() {
+    return IkasStorefrontConfig.merchantSettings;
+  }
+
+  static getCurrentPageComponents() {
+    return IkasStorefrontConfig.currentPageComponents;
+  }
+
+  static getIsEditor() {
+    return IkasStorefrontConfig.isEditor;
+  }
+
+  static getSessionId() {
+    return IkasStorefrontConfig.sessionId;
+  }
+
+  static getVisitorId() {
+    return IkasStorefrontConfig.visitorId;
+  }
+}
+
+export type IkasStorefrontConfigObserver = {
+  id: string;
+  callback: (config: IkasStorefrontConfig) => void;
+};
+export type LoginRequiredCallbackType = () => Promise<void> | void;
+
+export type IkasStorefrontConfigParams = {
+  themeId?: string;
+  apiUrl?: string;
+  adminApiUrl?: string;
+  cdnUrl?: string;
+  apiKey?: string;
+  token?: string;
+  customerToken?: string;
+  storefrontId?: string;
+  storefrontRoutingId?: string;
+  priceListId?: string;
+  stockLocationIds?: string[];
+  loginRequiredCallback?: LoginRequiredCallbackType;
+  domain?: string;
+  storefrontThemeId?: string;
+  salesChannelId?: string;
+  routings: IkasStorefrontRouting[];
+  paymentGateways: IkasSalesChannelPaymentGateway[];
+  gtmId?: string;
+  fbpId?: string;
+  analytics4Id?: string;
+  universalAnalyticsId?: string;
+  pickUpStockLocationIds?: string[] | null;
+  tiktokPixelId?: string;
+  favicon?: IkasThemeJsonFavicon;
+  stockPreference?: IkasThemeJsonStockPreference;
+  translations: Record<string, any>;
+  storefrontJSScripts: string[];
+  customerReviewSettings?: IkasCustomerReviewSettings | null;
+  productBackInStockSettings?: IkasProductBackInStockSettings | null;
+  merchantSettings?: IkasMerchantSettings | null;
+  currentPageComponents?: Record<string, any>;
+  isEditor: boolean;
+  sessionId?: string;
+  visitorId?: string;
+};

package/build/_virtual/_tslib.js

@@ -1 +0,0 @@
-var n=function(){return n=Object.assign||function(n){for(var t,e=1,r=arguments.length;e<r;e++)for(var o in t=arguments[e])Object.prototype.hasOwnProperty.call(t,o)&&(n[o]=t[o]);return n},n.apply(this,arguments)};function t(n,t,e,r){return new(e||(e=Promise))((function(o,a){function u(n){try{c(r.next(n))}catch(n){a(n)}}function l(n){try{c(r.throw(n))}catch(n){a(n)}}function c(n){var t;n.done?o(n.value):(t=n.value,t instanceof e?t:new e((function(n){n(t)}))).then(u,l)}c((r=r.apply(n,t||[])).next())}))}function e(n,t){var e,r,o,a,u={label:0,sent:function(){if(1&o[0])throw o[1];return o[1]},trys:[],ops:[]};return a={next:l(0),throw:l(1),return:l(2)},"function"==typeof Symbol&&(a[Symbol.iterator]=function(){return this}),a;function l(a){return function(l){return function(a){if(e)throw new TypeError("Generator is already executing.");for(;u;)try{if(e=1,r&&(o=2&a[0]?r.return:a[0]?r.throw||((o=r.return)&&o.call(r),0):r.next)&&!(o=o.call(r,a[1])).done)return o;switch(r=0,o&&(a=[2&a[0],o.value]),a[0]){case 0:case 1:o=a;break;case 4:return u.label++,{value:a[1],done:!1};case 5:u.label++,r=a[1],a=[0];continue;case 7:a=u.ops.pop(),u.trys.pop();continue;default:if(!(o=u.trys,(o=o.length>0&&o[o.length-1])||6!==a[0]&&2!==a[0])){u=0;continue}if(3===a[0]&&(!o||a[1]>o[0]&&a[1]<o[3])){u.label=a[1];break}if(6===a[0]&&u.label<o[1]){u.label=o[1],o=a;break}if(o&&u.label<o[2]){u.label=o[2],u.ops.push(a);break}o[2]&&u.ops.pop(),u.trys.pop();continue}a=t.call(n,u)}catch(n){a=[6,n],r=0}finally{e=o=0}if(5&a[0])throw a[1];return{value:a[0]?a[1]:void 0,done:!0}}([a,l])}}}export{n as __assign,t as __awaiter,e as __generator};

package/build/index.d.ts

@@ -1,128 +0,0 @@
-import { IkasCustomerReviewSettings, IkasCustomerSettings, IkasMerchantSettings, IkasProductBackInStockSettings, IkasSalesChannelPaymentGateway, IkasStorefontMetaTemplates, IkasStorefrontRouting, IkasThemeJsonFavicon, IkasThemeJsonStockPreference } from "@ikas/storefront-models";
-export declare class IkasStorefrontConfig {
-    private static themeId?;
-    private static apiUrl?;
-    private static adminApiUrl?;
-    private static cdnUrl?;
-    private static apiKey?;
-    private static customerToken?;
-    private static storefrontId?;
-    private static storefrontRoutingId?;
-    private static priceListId?;
-    private static stockLocationIds?;
-    private static loginRequiredCallback?;
-    private static domain?;
-    private static storefrontThemeId?;
-    private static salesChannelId?;
-    private static routings;
-    private static paymentGateways;
-    private static gtmId?;
-    private static fbpId?;
-    private static analytics4Id?;
-    private static universalAnalyticsId?;
-    private static pickUpStockLocationIds?;
-    private static tiktokPixelId?;
-    private static favicon?;
-    private static stockPreference?;
-    private static translations;
-    private static storefrontJSScripts;
-    private static customerReviewSettings?;
-    private static productBackInStockSettings?;
-    private static merchantSettings?;
-    private static currentPageComponents?;
-    private static isEditor;
-    private static customerSettings?;
-    private static metaTemplates;
-    private static sessionId?;
-    private static visitorId?;
-    private static observers;
-    static addObserver(observer: IkasStorefrontConfigObserver): void;
-    static init(config: Partial<IkasStorefrontConfigParams>): void;
-    static initFromAPI(apiKey: string): Promise<void>;
-    static getCurrentRouting(): IkasStorefrontRouting | undefined;
-    static getCurrentLocale(): string;
-    private static notify;
-    static isCustomerReviewEnabled(): boolean;
-    static isCustomerReviewLoginRequired(): boolean;
-    static isBackInStockEnabled(): boolean;
-    static isCustomerLoginRequiredForBackInStock(): boolean | null | undefined;
-    static toJSON(): {};
-    static getThemeId(): string | undefined;
-    static getApiUrl(): string | undefined;
-    static getAdminApiUrl(): string | undefined;
-    static getCdnUrl(): string | undefined;
-    static getApiKey(): string | undefined;
-    static getCustomerToken(): string | undefined;
-    static getStorefrontId(): string | undefined;
-    static getStorefrontRoutingId(): string | undefined;
-    static getPriceListId(): string | undefined;
-    static getStockLocationIds(): string[] | undefined;
-    static getLoginRequiredCallback(): LoginRequiredCallbackType | undefined;
-    static getDomain(): string | undefined;
-    static getStorefrontThemeId(): string | undefined;
-    static getSalesChannelId(): string | undefined;
-    static getRoutings(): IkasStorefrontRouting[];
-    static getPaymentGateways(): IkasSalesChannelPaymentGateway[];
-    static getGtmId(): string | undefined;
-    static getFbpId(): string | undefined;
-    static getAnalytics4Id(): string | undefined;
-    static getUniversalAnalyticsId(): string | undefined;
-    static getPickupStockLocationIds(): string[] | null | undefined;
-    static getTiktokPixelId(): string | undefined;
-    static getFavicon(): IkasThemeJsonFavicon | undefined;
-    static getStockPreference(): IkasThemeJsonStockPreference | undefined;
-    static getTranslations(): Record<string, any>;
-    static getStorefrontJSScripts(): string[];
-    static getCustomerReviewSettings(): IkasCustomerReviewSettings | null | undefined;
-    static getProductBackInStockSettings(): IkasProductBackInStockSettings | null | undefined;
-    static getMerchantSettings(): IkasMerchantSettings | null | undefined;
-    static getCurrentPageComponents(): Record<string, any> | undefined;
-    static getIsEditor(): boolean;
-    static getSessionId(): string | undefined;
-    static getVisitorId(): string | undefined;
-    static getCustomerSettings(): IkasCustomerSettings | undefined;
-    static getMetaTemplates(): IkasStorefontMetaTemplates[] | null;
-}
-export declare type IkasStorefrontConfigObserver = {
-    id: string;
-    callback: (config: IkasStorefrontConfig) => void;
-};
-export declare type LoginRequiredCallbackType = () => Promise<void> | void;
-export declare type IkasStorefrontConfigParams = {
-    themeId?: string;
-    apiUrl?: string;
-    adminApiUrl?: string;
-    cdnUrl?: string;
-    apiKey?: string;
-    token?: string;
-    customerToken?: string;
-    storefrontId?: string;
-    storefrontRoutingId?: string;
-    priceListId?: string;
-    stockLocationIds?: string[];
-    loginRequiredCallback?: LoginRequiredCallbackType;
-    domain?: string;
-    storefrontThemeId?: string;
-    salesChannelId?: string;
-    routings: IkasStorefrontRouting[];
-    paymentGateways: IkasSalesChannelPaymentGateway[];
-    gtmId?: string;
-    fbpId?: string;
-    analytics4Id?: string;
-    universalAnalyticsId?: string;
-    pickUpStockLocationIds?: string[] | null;
-    tiktokPixelId?: string;
-    favicon?: IkasThemeJsonFavicon;
-    stockPreference?: IkasThemeJsonStockPreference;
-    translations: Record<string, any>;
-    storefrontJSScripts: string[];
-    customerReviewSettings?: IkasCustomerReviewSettings | null;
-    productBackInStockSettings?: IkasProductBackInStockSettings | null;
-    merchantSettings?: IkasMerchantSettings | null;
-    currentPageComponents?: Record<string, any>;
-    isEditor: boolean;
-    customerSettings?: IkasCustomerSettings;
-    sessionId?: string;
-    visitorId?: string;
-    metaTemplates: IkasStorefontMetaTemplates[] | null;
-};

package/build/index.js

@@ -1 +0,0 @@
-import{__awaiter as t,__assign as n,__generator as e}from"./_virtual/_tslib.js";var r=function(){function r(){}return r.addObserver=function(t){var n=r.observers.find((function(n){return n.id===t.id}));n?n.callback=t.callback:r.observers.push(t),t.callback(r)},r.init=function(t){try{Object.entries(t).forEach((function(t){var n=t[0],e=t[1];r[n]=e})),t.token&&(r.apiKey=t.token),this.notify()}catch(t){console.error(t)}},r.initFromAPI=function(n){return t(this,void 0,void 0,(function(){return e(this,(function(t){return[2]}))}))},r.getCurrentRouting=function(){return r.routings.find((function(t){return t.id===r.storefrontRoutingId}))},r.getCurrentLocale=function(){var t=r.getCurrentRouting();return(null==t?void 0:t.locale)||"en"},r.notify=function(){var t=this;this.observers.forEach((function(n){return n.callback(t)}))},r.isCustomerReviewEnabled=function(){var t=r.getCustomerReviewSettings();return!!t&&!t.customerPurchaseRequired},r.isCustomerReviewLoginRequired=function(){var t=r.getCustomerReviewSettings();return!t||t.customerLoginRequired},r.isBackInStockEnabled=function(){return!!r.getProductBackInStockSettings()},r.isCustomerLoginRequiredForBackInStock=function(){var t=r.getProductBackInStockSettings();return t&&t.customerLoginRequired},r.toJSON=function(){var t=n({},this);return delete t.observers,t},r.getThemeId=function(){return r.themeId},r.getApiUrl=function(){return r.apiUrl},r.getAdminApiUrl=function(){return r.adminApiUrl},r.getCdnUrl=function(){return r.cdnUrl},r.getApiKey=function(){return r.apiKey},r.getCustomerToken=function(){return r.customerToken},r.getStorefrontId=function(){return r.storefrontId},r.getStorefrontRoutingId=function(){return r.storefrontRoutingId},r.getPriceListId=function(){return r.priceListId},r.getStockLocationIds=function(){return r.stockLocationIds},r.getLoginRequiredCallback=function(){return r.loginRequiredCallback},r.getDomain=function(){return r.domain},r.getStorefrontThemeId=function(){return r.storefrontThemeId},r.getSalesChannelId=function(){return r.salesChannelId},r.getRoutings=function(){return r.routings},r.getPaymentGateways=function(){return r.paymentGateways},r.getGtmId=function(){return r.gtmId},r.getFbpId=function(){return r.fbpId},r.getAnalytics4Id=function(){return r.analytics4Id},r.getUniversalAnalyticsId=function(){return r.universalAnalyticsId},r.getPickupStockLocationIds=function(){return r.pickUpStockLocationIds},r.getTiktokPixelId=function(){return r.tiktokPixelId},r.getFavicon=function(){return r.favicon},r.getStockPreference=function(){return r.stockPreference},r.getTranslations=function(){return r.translations},r.getStorefrontJSScripts=function(){return r.storefrontJSScripts},r.getCustomerReviewSettings=function(){return r.customerReviewSettings},r.getProductBackInStockSettings=function(){return r.productBackInStockSettings},r.getMerchantSettings=function(){return r.merchantSettings},r.getCurrentPageComponents=function(){return r.currentPageComponents},r.getIsEditor=function(){return r.isEditor},r.getSessionId=function(){return r.sessionId},r.getVisitorId=function(){return r.visitorId},r.getCustomerSettings=function(){return r.customerSettings},r.getMetaTemplates=function(){return r.metaTemplates},r.routings=[],r.paymentGateways=[],r.translations={},r.storefrontJSScripts=[],r.isEditor=!1,r.observers=[],r}();export{r as IkasStorefrontConfig};