@telia-ace/widget-services 0.0.1

package/index.d.ts

@@ -0,0 +1,2 @@
+export { createStorageWriter, LegacyStorage as StorageService, LegacyStorageProvider as StorageProvider, readStorage, StorageCategory, StorageMedium, storagePolicyConfigurationApi, StorageScope, } from './storage';
+export type { Duration, StorageWriter, StorageWriterOptions } from './storage';

package/index.js

@@ -0,0 +1,19 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=require("@telia-ace/widget-utilities"),L=require("@webprovisions/platform");var l=(e=>(e.Cookie="cookie",e.Local="local",e.Session="session",e))(l||{}),f=(e=>(e.Tenant="tenant",e.Implementation="implementation",e.Widget="widget",e))(f||{}),d=(e=>(e.Necessary="necessary",e.Functional="functional",e.Analytical="analytical",e.Marketing="marketing",e))(d||{});const K=(e,t,n,o={})=>k(e,n).then(s=>(process.env.NODE_ENV!=="production"&&s&&c.Logger.warn(`createStorageWriter: Attempted to create storage writer using unallowed category.
+                    Key: ${t}
+                    Category: ${JSON.stringify(n)}
+                    Options: ${JSON.stringify(o)}`),r=>(D(e),k(e,n).then(i=>{if(i){process.env.NODE_ENV!=="production"&&c.Logger.warn(`storageWriter: Attempted to write to storage using unallowed category.
+                                Key: ${t}
+                                Category: ${JSON.stringify(n)}
+                                Value: ${JSON.stringify(r)}
+                                Options: ${JSON.stringify(o)}`);return}const{scope:g=f.Widget,medium:a=l.Session,duration:u}=o,m=T();return m[g][t]=J(r,n,u),a===l.Cookie?M(e,m):q(e,a,m)})))),b=(e,t,n=l.Session)=>(D(e),typeof t>"u"?(process.env.NODE_ENV!=="production"&&c.Logger.warn("readStorage: Undefined key passed when reading storage. ",t,n),Promise.resolve(void 0)):n===l.Cookie?j(e).then(o=>h(o,t)):U(e,n).then(o=>h(o,t))),y=e=>!!Object.entries(e).filter(([t,n])=>typeof n<"u").length,$=e=>Object.entries(e).filter(([t,n])=>typeof n<"u").forEach(([t,{value:n}])=>{typeof n>"u"&&delete e[t]}),_=(e,t)=>{const n={tenant:{...e.tenant,...t.tenant},implementation:{...e.implementation,...t.implementation},widget:{...e.widget,...t.widget}};return $(n.tenant),$(n.implementation),$(n.widget),n},x=e=>Object.entries(e).reduce((n,o)=>{const[s,r]=o;return Object.entries(r).forEach(i=>{const[g,{expiration:a}]=i;a&&n.push(a)}),n},[]).slice().sort((n,o)=>new Date(o).valueOf()-new Date(n).valueOf()).shift()||v(),O=e=>{const{name:t,implementation:{name:n,tenant:o}}=e.get("$widget");return[`humany_${o}`,`humany_${c.hash(o+n)}`,`humany_${c.hash(o+n+t)}`]},E=e=>{const t=new RegExp(`(?:^|;)\\s?${e}=(.*?)(?:;|$)`,"i"),n=document.cookie.match(t);return n&&n[1]&&JSON.parse(n[1])||void 0},A=(e,t,n)=>{const o=`${e}=${JSON.stringify(t).trim()}`,s=`expires=${new Date(n).toUTCString()}`,r="path=/",i="SameSite=None;Secure";return document.cookie=`${o}; ${s}; ${r}; ${i}`},P=e=>{const[t,n,o]=O(e),s=E(t)||{},r=E(n)||{},i=E(o)||{};return{tenant:s,implementation:r,widget:i}},I=(e,t)=>{const n=P(e),o=_(n,t),[s,r,i]=O(e),{tenant:g,implementation:a,widget:u}=o,m=x(t),p=v({days:-1});A(s,g,y(g)?m:p),A(r,a,y(a)?m:p),A(i,u,y(u)?m:p)},N=(e,t)=>{const[n,o,s]=O(e),r=t.getItem(n)||"{}",i=t.getItem(o)||"{}",g=t.getItem(s)||"{}";return{tenant:JSON.parse(r),implementation:JSON.parse(i),widget:JSON.parse(g)}},C=(e,t,n)=>{const o=N(e,t),s=_(o,n),[r,i,g]=O(e),{tenant:a,implementation:u,widget:m}=s;y(a)?t.setItem(r,JSON.stringify(a)):t.removeItem(r),y(u)?t.setItem(i,JSON.stringify(u)):t.removeItem(i),y(m)?t.setItem(g,JSON.stringify(m)):t.removeItem(g);const{events:p}=e.get("$widget");p.dispatch("storage:changed",{})},T=()=>({tenant:{},implementation:{},widget:{}}),V=e=>e?!!e&&new Date>new Date(e):!1,h=(e,t)=>{const n=e.widget[t]||e.implementation[t]||e.tenant[t];return n==null?void 0:n.value},J=(e,t,n)=>n?{value:e,category:t,expiration:typeof n=="object"?v(n):n}:{value:e,category:t},S=(e,t)=>{const n=c.deepClone(e);return Object.entries(n).forEach(([o,s])=>{Object.entries(s).forEach(([r,i])=>{const{expiration:g,category:a}=i;(V(g)||W(t,a))&&(s[r]=J(void 0,a,g))})}),n},k=(e,t)=>b(e,"storagePolicy",l.Cookie).then((n=[d.Necessary])=>!!t&&n.indexOf(t)===-1),W=(e=[d.Necessary],t)=>!!t&&e.indexOf(t)===-1,D=e=>{const t=P(e),n=N(e,window.localStorage),o=N(e,sessionStorage),s=h(t,"storagePolicy"),[r,i,g]=[t,n,o].map(a=>S(a,s));I(e,r),C(e,window.localStorage,i),C(e,window.sessionStorage,g)},v=(e={days:30})=>{const{days:t=0,hours:n=0,minutes:o=0,seconds:s=0}=e,r=new Date;return r.setTime(r.getTime()+n*60*60*1e3),r.setTime(r.getTime()+t*24*60*60*1e3),r.setTime(r.getTime()+o*60*1e3),r.setTime(r.getTime()+s*1e3),r.toISOString()},j=e=>c.lock(document)(()=>P(e)),M=(e,t)=>c.lock(document)(()=>I(e,t)),U=(e,t)=>{const n=t===l.Local?window.localStorage:window.sessionStorage;return c.lock(n)(()=>N(e,n))},q=(e,t,n)=>{const o=t===l.Local?window.localStorage:window.sessionStorage;return c.lock(o)(()=>C(e,o,n))};class w{constructor(){this.memory={tenant:{},implementation:{},widget:{}}}async setItem(t,n,o={}){return c.lock(this)(()=>{const s=S(this.memory,[d.Necessary]),{scope:r=f.Tenant,expiration:i}=o;s[r][t]=J(n,d.Necessary,(i==null?void 0:i.toISOString())||v()),this.memory=s,process.env.NODE_ENV!=="production"&&c.Logger.warn(`StorageProvider: StorageProvider is deprecated, use createStorageWriter and readStorage instead, value stored temporarily in memory.
+                    Key: ${t}
+                    Value: ${JSON.stringify(n)}
+                    Options: ${JSON.stringify(o)}
+                    Memory: ${JSON.stringify(s)}`)})}async getItem(t){return c.lock(this)(()=>{const n=S(this.memory,[d.Necessary]);process.env.NODE_ENV!=="production"&&c.Logger.warn(`StorageProvider: StorageProvider is deprecated, use createStorageWriter and readStorage instead, value fetched from legacy memory storage.
+                    Key: ${t}
+                    Memory: ${JSON.stringify(n)}`);const o=h(n,t);return this.memory=n,o})}async removeItem(t){return c.lock(this)(()=>{const n=S(this.memory,[d.Necessary]);delete n.tenant[t],delete n.implementation[t],delete n.widget[t],this.memory=n,process.env.NODE_ENV!=="production"&&c.Logger.warn(`StorageProvider: StorageProvider is deprecated, use createStorageWriter and readStorage instead, value removed from memory.
+                    Key: ${t}
+                    Memory: ${JSON.stringify(n)}`)})}async clear(){return Promise.resolve()}}class F{constructor(){this.cookies=new w,this.session=new w,this.local=new w}}const R=L.createConfigurationApi(e=>{e.createCommand("storage",t=>(n={})=>{const{consent:o}=n;if(typeof o<"u"){if(typeof o!="number"&&typeof o!="string"&&!Array.isArray(o)){process.env.NODE_ENV!=="production"&&c.Logger.warn(`storagePolicyConfigurationApi: passed consent is not valid. Consent either has to be a number, a string, an array of strings or an array of numbers.
+                        Passed consent: ${JSON.stringify(o)}`);return}if(Array.isArray(o)&&!o.every(r=>typeof r=="number"||typeof r=="string")){process.env.NODE_ENV!=="production"&&c.Logger.warn(`storagePolicyConfigurationApi: passed consent is not valid. Consent either has to be a number, a string, an array of strings or an array of numbers.
+                        Passed consent: ${JSON.stringify(o)}`);return}const s=[d.Necessary,d.Functional,d.Analytical,d.Marketing].filter((r,i,g)=>typeof o=="number"?o>i:typeof o=="string"?g.indexOf(o)+1>i:Array.isArray(o)?o.findIndex(a=>a===i+1||a===r)>-1:!0);return s.indexOf(d.Necessary)===-1&&(process.env.NODE_ENV!=="production"&&c.Logger.warn(`storagePolicyConfigurationApi: passed consent does not include category: '${d.Necessary}'. Consent has to atleast include the '${d.Necessary}' category.
+                        Passed consent: ${JSON.stringify(o)}`),s.unshift(d.Necessary)),K(t.container,"storagePolicy",d.Necessary,{medium:l.Cookie,scope:f.Tenant,duration:{days:365}}).then(r=>r(s)).then(()=>{D(t.container),t.events.dispatch("storage:policy-changed",s)})}})});exports.StorageCategory=d;exports.StorageMedium=l;exports.StorageProvider=F;exports.StorageScope=f;exports.StorageService=w;exports.createStorageWriter=K;exports.readStorage=b;exports.storagePolicyConfigurationApi=R;

package/index.mjs

@@ -0,0 +1,265 @@
+import { Logger as g, lock as y, deepClone as k, hash as _ } from "@telia-ace/widget-utilities";
+import { createConfigurationApi as T } from "@webprovisions/platform";
+var l = /* @__PURE__ */ ((e) => (e.Cookie = "cookie", e.Local = "local", e.Session = "session", e))(l || {}), h = /* @__PURE__ */ ((e) => (e.Tenant = "tenant", e.Implementation = "implementation", e.Widget = "widget", e))(h || {}), d = /* @__PURE__ */ ((e) => (e.Necessary = "necessary", e.Functional = "functional", e.Analytical = "analytical", e.Marketing = "marketing", e))(d || {});
+const V = (e, t, n, r = {}) => I(e, n).then((s) => (process.env.NODE_ENV !== "production" && s && g.warn(
+  `createStorageWriter: Attempted to create storage writer using unallowed category.
+                    Key: ${t}
+                    Category: ${JSON.stringify(n)}
+                    Options: ${JSON.stringify(r)}`
+), (o) => (K(e), I(e, n).then((i) => {
+  if (i) {
+    process.env.NODE_ENV !== "production" && g.warn(
+      `storageWriter: Attempted to write to storage using unallowed category.
+                                Key: ${t}
+                                Category: ${JSON.stringify(n)}
+                                Value: ${JSON.stringify(o)}
+                                Options: ${JSON.stringify(r)}`
+    );
+    return;
+  }
+  const {
+    scope: c = h.Widget,
+    medium: a = l.Session,
+    duration: u
+  } = r, m = j();
+  return m[c][t] = D(o, n, u), a === l.Cookie ? R(e, m) : z(e, a, m);
+})))), L = (e, t, n = l.Session) => (K(e), typeof t > "u" ? (process.env.NODE_ENV !== "production" && g.warn(
+  "readStorage: Undefined key passed when reading storage. ",
+  t,
+  n
+), Promise.resolve(void 0)) : n === l.Cookie ? F(e).then((r) => N(r, t)) : q(e, n).then(
+  (r) => N(r, t)
+)), p = (e) => !!Object.entries(e).filter(([t, n]) => typeof n < "u").length, $ = (e) => Object.entries(e).filter(([t, n]) => typeof n < "u").forEach(([t, { value: n }]) => {
+  typeof n > "u" && delete e[t];
+}), b = (e, t) => {
+  const n = {
+    tenant: { ...e.tenant, ...t.tenant },
+    implementation: { ...e.implementation, ...t.implementation },
+    widget: { ...e.widget, ...t.widget }
+  };
+  return $(n.tenant), $(n.implementation), $(n.widget), n;
+}, W = (e) => Object.entries(e).reduce(
+  (n, r) => {
+    const [s, o] = r;
+    return Object.entries(o).forEach((i) => {
+      const [c, { expiration: a }] = i;
+      a && n.push(a);
+    }), n;
+  },
+  []
+).slice().sort((n, r) => new Date(r).valueOf() - new Date(n).valueOf()).shift() || v(), O = (e) => {
+  const {
+    name: t,
+    implementation: { name: n, tenant: r }
+  } = e.get("$widget");
+  return [
+    `humany_${r}`,
+    `humany_${_(r + n)}`,
+    `humany_${_(r + n + t)}`
+  ];
+}, E = (e) => {
+  const t = new RegExp(`(?:^|;)\\s?${e}=(.*?)(?:;|$)`, "i"), n = document.cookie.match(t);
+  return n && n[1] && JSON.parse(n[1]) || void 0;
+}, A = (e, t, n) => {
+  const r = `${e}=${JSON.stringify(t).trim()}`, s = `expires=${new Date(n).toUTCString()}`, o = "path=/", i = "SameSite=None;Secure";
+  return document.cookie = `${r}; ${s}; ${o}; ${i}`;
+}, P = (e) => {
+  const [t, n, r] = O(e), s = E(t) || {}, o = E(n) || {}, i = E(r) || {};
+  return {
+    tenant: s,
+    implementation: o,
+    widget: i
+  };
+}, x = (e, t) => {
+  const n = P(e), r = b(n, t), [s, o, i] = O(e), { tenant: c, implementation: a, widget: u } = r, m = W(t), f = v({ days: -1 });
+  A(
+    s,
+    c,
+    p(c) ? m : f
+  ), A(
+    o,
+    a,
+    p(a) ? m : f
+  ), A(
+    i,
+    u,
+    p(u) ? m : f
+  );
+}, w = (e, t) => {
+  const [n, r, s] = O(e), o = t.getItem(n) || "{}", i = t.getItem(r) || "{}", c = t.getItem(s) || "{}";
+  return {
+    tenant: JSON.parse(o),
+    implementation: JSON.parse(i),
+    widget: JSON.parse(c)
+  };
+}, J = (e, t, n) => {
+  const r = w(e, t), s = b(r, n), [o, i, c] = O(e), { tenant: a, implementation: u, widget: m } = s;
+  p(a) ? t.setItem(o, JSON.stringify(a)) : t.removeItem(o), p(u) ? t.setItem(
+    i,
+    JSON.stringify(u)
+  ) : t.removeItem(i), p(m) ? t.setItem(c, JSON.stringify(m)) : t.removeItem(c);
+  const { events: f } = e.get("$widget");
+  f.dispatch("storage:changed", {});
+}, j = () => ({
+  tenant: {},
+  implementation: {},
+  widget: {}
+}), M = (e) => e ? !!e && /* @__PURE__ */ new Date() > new Date(e) : !1, N = (e, t) => {
+  const n = e.widget[t] || e.implementation[t] || e.tenant[t];
+  return n == null ? void 0 : n.value;
+}, D = (e, t, n) => n ? {
+  value: e,
+  category: t,
+  expiration: typeof n == "object" ? v(n) : n
+} : {
+  value: e,
+  category: t
+}, S = (e, t) => {
+  const n = k(e);
+  return Object.entries(n).forEach(([r, s]) => {
+    Object.entries(s).forEach(([o, i]) => {
+      const { expiration: c, category: a } = i;
+      (M(c) || U(t, a)) && (s[o] = D(void 0, a, c));
+    });
+  }), n;
+}, I = (e, t) => L(
+  e,
+  "storagePolicy",
+  l.Cookie
+).then(
+  (n = [d.Necessary]) => !!t && n.indexOf(t) === -1
+), U = (e = [d.Necessary], t) => !!t && e.indexOf(t) === -1, K = (e) => {
+  const t = P(e), n = w(e, window.localStorage), r = w(e, sessionStorage), s = N(t, "storagePolicy"), [o, i, c] = [
+    t,
+    n,
+    r
+  ].map((a) => S(a, s));
+  x(e, o), J(e, window.localStorage, i), J(e, window.sessionStorage, c);
+}, v = (e = { days: 30 }) => {
+  const { days: t = 0, hours: n = 0, minutes: r = 0, seconds: s = 0 } = e, o = /* @__PURE__ */ new Date();
+  return o.setTime(o.getTime() + n * 60 * 60 * 1e3), o.setTime(o.getTime() + t * 24 * 60 * 60 * 1e3), o.setTime(o.getTime() + r * 60 * 1e3), o.setTime(o.getTime() + s * 1e3), o.toISOString();
+}, F = (e) => y(document)(() => P(e)), R = (e, t) => y(document)(() => x(e, t)), q = (e, t) => {
+  const n = t === l.Local ? window.localStorage : window.sessionStorage;
+  return y(n)(() => w(e, n));
+}, z = (e, t, n) => {
+  const r = t === l.Local ? window.localStorage : window.sessionStorage;
+  return y(r)(() => J(e, r, n));
+};
+class C {
+  constructor() {
+    this.memory = {
+      tenant: {},
+      implementation: {},
+      widget: {}
+    };
+  }
+  async setItem(t, n, r = {}) {
+    return y(this)(() => {
+      const s = S(this.memory, [
+        d.Necessary
+      ]), { scope: o = h.Tenant, expiration: i } = r;
+      s[o][t] = D(
+        n,
+        d.Necessary,
+        (i == null ? void 0 : i.toISOString()) || v()
+      ), this.memory = s, process.env.NODE_ENV !== "production" && g.warn(
+        `StorageProvider: StorageProvider is deprecated, use createStorageWriter and readStorage instead, value stored temporarily in memory.
+                    Key: ${t}
+                    Value: ${JSON.stringify(n)}
+                    Options: ${JSON.stringify(r)}
+                    Memory: ${JSON.stringify(s)}`
+      );
+    });
+  }
+  async getItem(t) {
+    return y(this)(() => {
+      const n = S(this.memory, [
+        d.Necessary
+      ]);
+      process.env.NODE_ENV !== "production" && g.warn(
+        `StorageProvider: StorageProvider is deprecated, use createStorageWriter and readStorage instead, value fetched from legacy memory storage.
+                    Key: ${t}
+                    Memory: ${JSON.stringify(n)}`
+      );
+      const r = N(n, t);
+      return this.memory = n, r;
+    });
+  }
+  async removeItem(t) {
+    return y(this)(() => {
+      const n = S(this.memory, [
+        d.Necessary
+      ]);
+      delete n.tenant[t], delete n.implementation[t], delete n.widget[t], this.memory = n, process.env.NODE_ENV !== "production" && g.warn(
+        `StorageProvider: StorageProvider is deprecated, use createStorageWriter and readStorage instead, value removed from memory.
+                    Key: ${t}
+                    Memory: ${JSON.stringify(n)}`
+      );
+    });
+  }
+  async clear() {
+    return Promise.resolve();
+  }
+}
+class H {
+  constructor() {
+    this.cookies = new C(), this.session = new C(), this.local = new C();
+  }
+}
+const Q = T((e) => {
+  e.createCommand(
+    "storage",
+    (t) => (n = {}) => {
+      const { consent: r } = n;
+      if (typeof r < "u") {
+        if (typeof r != "number" && typeof r != "string" && !Array.isArray(r)) {
+          process.env.NODE_ENV !== "production" && g.warn(
+            `storagePolicyConfigurationApi: passed consent is not valid. Consent either has to be a number, a string, an array of strings or an array of numbers.
+                        Passed consent: ${JSON.stringify(r)}`
+          );
+          return;
+        }
+        if (Array.isArray(r) && !r.every(
+          (o) => typeof o == "number" || typeof o == "string"
+        )) {
+          process.env.NODE_ENV !== "production" && g.warn(
+            `storagePolicyConfigurationApi: passed consent is not valid. Consent either has to be a number, a string, an array of strings or an array of numbers.
+                        Passed consent: ${JSON.stringify(r)}`
+          );
+          return;
+        }
+        const s = [
+          d.Necessary,
+          d.Functional,
+          d.Analytical,
+          d.Marketing
+        ].filter((o, i, c) => typeof r == "number" ? r > i : typeof r == "string" ? c.indexOf(r) + 1 > i : Array.isArray(r) ? r.findIndex((a) => a === i + 1 || a === o) > -1 : !0);
+        return s.indexOf(d.Necessary) === -1 && (process.env.NODE_ENV !== "production" && g.warn(
+          `storagePolicyConfigurationApi: passed consent does not include category: '${d.Necessary}'. Consent has to atleast include the '${d.Necessary}' category.
+                        Passed consent: ${JSON.stringify(r)}`
+        ), s.unshift(d.Necessary)), V(
+          t.container,
+          "storagePolicy",
+          d.Necessary,
+          {
+            medium: l.Cookie,
+            scope: h.Tenant,
+            duration: { days: 365 }
+          }
+        ).then((o) => o(s)).then(() => {
+          K(t.container), t.events.dispatch("storage:policy-changed", s);
+        });
+      }
+    }
+  );
+});
+export {
+  d as StorageCategory,
+  l as StorageMedium,
+  H as StorageProvider,
+  h as StorageScope,
+  C as StorageService,
+  V as createStorageWriter,
+  L as readStorage,
+  Q as storagePolicyConfigurationApi
+};

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@telia-ace/widget-services",
+  "version": "0.0.1",
+  "dependencies": {
+    "@telia-ace/widget-utilities": "*",
+    "@webprovisions/platform": "^1.1.4"
+  },
+  "main": "./index.js",
+  "module": "./index.mjs",
+  "typings": "./index.d.ts"
+}

package/storage/index.d.ts

@@ -0,0 +1,5 @@
+export { default as LegacyStorageProvider, LegacyStorage, } from './legacy-storage-provider';
+export { createStorageWriter, readStorage } from './storage';
+export { default as storagePolicyConfigurationApi } from './storage-policy-configuration-api';
+export { StorageCategory, StorageMedium, StorageScope } from './types';
+export type { Duration, StorageWriter, StorageWriterOptions } from './types';

package/storage/legacy-storage-provider.d.ts

@@ -0,0 +1,26 @@
+import { StorageScope } from './types';
+
+type LegacyOptions = {
+    scope?: StorageScope;
+    expiration?: Date;
+};
+interface LegacyMedium {
+    setItem(key: string, value: any, options?: LegacyOptions): Promise<void>;
+    getItem(key: string): Promise<any>;
+    removeItem(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+export declare class LegacyStorage implements LegacyMedium {
+    private memory;
+    setItem(key: string, value: any, options?: LegacyOptions): Promise<void>;
+    getItem(key: string): Promise<any>;
+    removeItem(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+export default class LegacyStorageProvider {
+    cookies: LegacyStorage;
+    session: LegacyStorage;
+    local: LegacyStorage;
+    constructor();
+}
+export {};

package/storage/storage-policy-configuration-api.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('@webprovisions/platform').ConfigurationApiDefinition;
+export default _default;

package/storage/storage.d.ts

@@ -0,0 +1,20 @@
+import { Container } from '@webprovisions/platform';
+import { StorageCategory, StorageMedium, StorageWriter, StorageWriterOptions } from './types';
+
+/**
+ * Creates a writer to be used to write to cookie, local or session storage.
+ * @param container Widget Container.
+ * @param key Key to use when writing.
+ * @param category StorageCategory to use when writing.
+ * @param options StorageWriterOptions to use when writing default {scope: StorageScope.Widget, medium = StorageMedium.Session, duration = infinite }.
+ * @returns a function to be used to write a value to the storage using given settings.
+ */
+export declare const createStorageWriter: (container: Container, key: string, category: StorageCategory, options?: StorageWriterOptions) => Promise<StorageWriter>;
+/**
+ * Read the widget cookie, local or session storage.
+ * @param container Widget Container.
+ * @param key Key to read.
+ * @param medium Storage medium to read from (default: session).
+ * @returns the value stored with passed key.
+ */
+export declare const readStorage: <Type>(container: Container, key: string, medium?: StorageMedium) => Promise<Type | undefined>;

package/storage/types.d.ts

@@ -0,0 +1,45 @@
+export declare enum StorageMedium {
+    Cookie = "cookie",
+    Local = "local",
+    Session = "session"
+}
+export declare enum StorageScope {
+    Tenant = "tenant",
+    Implementation = "implementation",
+    Widget = "widget"
+}
+export type Store = {
+    tenant: StorageContainer;
+    implementation: StorageContainer;
+    widget: StorageContainer;
+};
+export type StorageContainer = {
+    [key: string]: StoredValue;
+};
+export type StoredValue = {
+    value: any;
+    expiration?: string;
+    category: StorageCategory;
+};
+export declare enum StorageCategory {
+    Necessary = "necessary",
+    Functional = "functional",
+    Analytical = "analytical",
+    Marketing = "marketing"
+}
+export type StorageWriter = (value?: any) => Promise<void>;
+export type StorageConfigurationOptions = {
+    consent?: StorageConsent;
+};
+export type StorageConsent = number | number[] | StorageCategory | StorageCategory[];
+export type Duration = {
+    days?: number;
+    hours?: number;
+    minutes?: number;
+    seconds?: number;
+};
+export type StorageWriterOptions = {
+    scope?: StorageScope;
+    duration?: Duration;
+    medium?: StorageMedium;
+};

package/storage/utils.d.ts

@@ -0,0 +1,37 @@
+import { Container } from '@webprovisions/platform';
+import { Duration, StorageCategory, StorageMedium, Store, StoredValue } from './types';
+
+export declare const createEmptyStore: () => Store;
+export declare const isExpired: (isoDateString?: string) => boolean;
+export declare const getValue: <Type>(store: Store, key: string) => Type | undefined;
+export declare const createValue: (value: any, category: StorageCategory, duration?: Duration | string) => StoredValue;
+export declare const processStore: (store: Store, policy?: StorageCategory[]) => Store;
+/**
+ * @param category Storage Category.
+ * @param policy Current Storage Policy.
+ * @returns true if not allowed, false if allowed.
+ */
+export declare const isNotAllowedAsync: (container: Container, category?: StorageCategory) => Promise<boolean>;
+/**
+ * @param category Storage Category.
+ * @param policy Current Storage Policy.
+ * @returns true if not allowed, false if allowed.
+ */
+export declare const isNotAllowed: (policy?: StorageCategory[], category?: StorageCategory) => boolean;
+/**
+ * Processes storage and removes items if they are expired or if
+ * the storage policy is defined and the category of the stored
+ * value is not allowed.
+ * @param container Widget Container
+ */
+export declare const processStorage: (container: Container) => void;
+/**
+ * Creates an expiration date string with the passed options.
+ * @param options Duration options.
+ * @returns ISO formatted date string.
+ */
+export declare const createExpirationDate: (options?: Duration) => string;
+export declare const getCookieStoreAsync: (container: Container) => Promise<Store>;
+export declare const setCookieStoreAsync: (container: Container, store: Store) => Promise<any>;
+export declare const getApplicationStoreAsync: (container: Container, type: StorageMedium.Local | StorageMedium.Session) => Promise<Store>;
+export declare const setApplicationStoreAsync: (container: Container, type: StorageMedium.Local | StorageMedium.Session, store: Store) => Promise<void>;