@ada-support/web-storage 0.1.0 → 0.3.0

package/README.md

@@ -1,2 +1,2 @@
 # web-storage
-A module to provide access to Web Storage API
+A module to provide access to Web Storage API.

package/README_NPM.md

@@ -0,0 +1 @@
+> _This module is meant to be used internally by Ada projects only._

package/dist/create-storage.d.ts

@@ -0,0 +1,10 @@
+import type { AdaFunctionalStorageValue } from "./functional-storage";
+import type { StorageValueByKey } from "./storage-keys";
+export declare const createStorage: (storageProvider: Storage) => {
+    readonly setItem: <K extends keyof StorageValueByKey>(key: K, value: StorageValueByKey[K]) => void;
+    readonly getItem: <K_1 extends keyof StorageValueByKey>(key: K_1) => StorageValueByKey[K_1] | null;
+    /** Stores a key/value pair within `ada-functional-storage` Storage key */
+    readonly setFnItem: <K_2 extends keyof AdaFunctionalStorageValue>(key: K_2, value: AdaFunctionalStorageValue[K_2]) => void;
+    /** Gets a value under `ada-functional-storage` Storage key */
+    readonly getFnItem: <K_3 extends keyof AdaFunctionalStorageValue>(key: K_3) => AdaFunctionalStorageValue[K_3] | null;
+};

package/dist/create-storage.js

@@ -0,0 +1,51 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+exports.__esModule = true;
+exports.createStorage = void 0;
+var WEB_STORAGE_ACCESS_ERROR_MESSAGE = "Cannot access Web Storage API";
+var createStorage = function (storageProvider) {
+    var storage = {
+        setItem: function (key, value) {
+            try {
+                storageProvider.setItem(key, JSON.stringify(value));
+            }
+            catch (e) {
+                console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
+            }
+        },
+        getItem: function (key) {
+            try {
+                var rawStorageValue = storageProvider.getItem(key);
+                return rawStorageValue && JSON.parse(rawStorageValue);
+            }
+            catch (e) {
+                console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
+                return null;
+            }
+        },
+        /** Stores a key/value pair within `ada-functional-storage` Storage key */
+        setFnItem: function (key, value) {
+            var _a;
+            var currentValue = storage.getItem("ada-functional-storage") || {};
+            var newValue = __assign(__assign({}, currentValue), (_a = {}, _a[key] = value, _a));
+            storage.setItem("ada-functional-storage", newValue);
+        },
+        /** Gets a value under `ada-functional-storage` Storage key */
+        getFnItem: function (key) {
+            var value = storage.getItem("ada-functional-storage");
+            return (value && value[key]) || null;
+        }
+    };
+    return storage;
+};
+exports.createStorage = createStorage;

package/dist/functional-storage.d.ts

@@ -5,4 +5,7 @@ export interface AdaFunctionalStorageValue {
     rolloutLastValue: {
         [clientHandle: string]: number;
     };
+    marketing_campaigns_shown: {
+        [clientHandle: string]: string;
+    };
 }

package/dist/index.d.ts

@@ -1,26 +1,14 @@
-import type { AdaFunctionalStorageValue } from "./functional-storage";
-import type { StorageValueByKey } from "./storage-keys";
-export declare const createStorage: (storageProvider: Storage) => {
-    readonly setItem: <K extends keyof StorageValueByKey>(key: K, value: StorageValueByKey[K]) => void;
-    readonly getItem: <K_1 extends keyof StorageValueByKey>(key: K_1) => StorageValueByKey[K_1] | null;
-    /** Stores a key/value pair within `ada-functional-storage` Storage key */
-    readonly setFnItem: <K_2 extends keyof AdaFunctionalStorageValue>(key: K_2, value: AdaFunctionalStorageValue[K_2]) => void;
-    /** Gets a value under `ada-functional-storage` Storage key */
-    readonly getFnItem: <K_3 extends keyof AdaFunctionalStorageValue>(key: K_3) => AdaFunctionalStorageValue[K_3] | null;
-};
+import type { StorageKey } from "./storage-keys";
 export declare const adaLocalStorage: {
-    readonly setItem: <K extends keyof StorageValueByKey>(key: K, value: StorageValueByKey[K]) => void;
-    readonly getItem: <K_1 extends keyof StorageValueByKey>(key: K_1) => StorageValueByKey[K_1] | null;
-    /** Stores a key/value pair within `ada-functional-storage` Storage key */
-    readonly setFnItem: <K_2 extends keyof AdaFunctionalStorageValue>(key: K_2, value: AdaFunctionalStorageValue[K_2]) => void;
-    /** Gets a value under `ada-functional-storage` Storage key */
-    readonly getFnItem: <K_3 extends keyof AdaFunctionalStorageValue>(key: K_3) => AdaFunctionalStorageValue[K_3] | null;
+    readonly setItem: <K extends keyof import("./storage-keys").StorageValueByKey>(key: K, value: import("./storage-keys").StorageValueByKey[K]) => void;
+    readonly getItem: <K_1 extends keyof import("./storage-keys").StorageValueByKey>(key: K_1) => import("./storage-keys").StorageValueByKey[K_1] | null;
+    readonly setFnItem: <K_2 extends keyof import("./functional-storage").AdaFunctionalStorageValue>(key: K_2, value: import("./functional-storage").AdaFunctionalStorageValue[K_2]) => void;
+    readonly getFnItem: <K_3 extends keyof import("./functional-storage").AdaFunctionalStorageValue>(key: K_3) => import("./functional-storage").AdaFunctionalStorageValue[K_3] | null;
 };
 export declare const adaSessionStorage: {
-    readonly setItem: <K extends keyof StorageValueByKey>(key: K, value: StorageValueByKey[K]) => void;
-    readonly getItem: <K_1 extends keyof StorageValueByKey>(key: K_1) => StorageValueByKey[K_1] | null;
-    /** Stores a key/value pair within `ada-functional-storage` Storage key */
-    readonly setFnItem: <K_2 extends keyof AdaFunctionalStorageValue>(key: K_2, value: AdaFunctionalStorageValue[K_2]) => void;
-    /** Gets a value under `ada-functional-storage` Storage key */
-    readonly getFnItem: <K_3 extends keyof AdaFunctionalStorageValue>(key: K_3) => AdaFunctionalStorageValue[K_3] | null;
+    readonly setItem: <K extends keyof import("./storage-keys").StorageValueByKey>(key: K, value: import("./storage-keys").StorageValueByKey[K]) => void;
+    readonly getItem: <K_1 extends keyof import("./storage-keys").StorageValueByKey>(key: K_1) => import("./storage-keys").StorageValueByKey[K_1] | null;
+    readonly setFnItem: <K_2 extends keyof import("./functional-storage").AdaFunctionalStorageValue>(key: K_2, value: import("./functional-storage").AdaFunctionalStorageValue[K_2]) => void;
+    readonly getFnItem: <K_3 extends keyof import("./functional-storage").AdaFunctionalStorageValue>(key: K_3) => import("./functional-storage").AdaFunctionalStorageValue[K_3] | null;
 };
+export declare type AdaStorageKey = StorageKey;

package/dist/index.js

@@ -1,53 +1,6 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 exports.__esModule = true;
-exports.adaSessionStorage = exports.adaLocalStorage = exports.createStorage = void 0;
-var WEB_STORAGE_ACCESS_ERROR_MESSAGE = "Cannot access Web Storage API";
-var createStorage = function (storageProvider) {
-    var storage = {
-        setItem: function (key, value) {
-            try {
-                storageProvider.setItem(key, JSON.stringify(value));
-            }
-            catch (e) {
-                console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
-            }
-        },
-        getItem: function (key) {
-            try {
-                var rawStorageValue = storageProvider.getItem(key);
-                return rawStorageValue && JSON.parse(rawStorageValue);
-            }
-            catch (e) {
-                console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
-                return null;
-            }
-        },
-        /** Stores a key/value pair within `ada-functional-storage` Storage key */
-        setFnItem: function (key, value) {
-            var _a;
-            var currentValue = storage.getItem("ada-functional-storage") || {};
-            var newValue = __assign(__assign({}, currentValue), (_a = {}, _a[key] = value, _a));
-            storage.setItem("ada-functional-storage", newValue);
-        },
-        /** Gets a value under `ada-functional-storage` Storage key */
-        getFnItem: function (key) {
-            var value = storage.getItem("ada-functional-storage");
-            return (value && value[key]) || null;
-        }
-    };
-    return storage;
-};
-exports.createStorage = createStorage;
-exports.adaLocalStorage = (0, exports.createStorage)(localStorage);
-exports.adaSessionStorage = (0, exports.createStorage)(sessionStorage);
+exports.adaSessionStorage = exports.adaLocalStorage = void 0;
+var create_storage_1 = require("./create-storage");
+exports.adaLocalStorage = (0, create_storage_1.createStorage)(localStorage);
+exports.adaSessionStorage = (0, create_storage_1.createStorage)(sessionStorage);

package/dist/storage-keys.d.ts

@@ -3,12 +3,20 @@ export interface StorageValueByKey {
     /** Used to store the chat version assigned to a user (for A/B testing purposes). */
     "ada-embed_chat-assigned-version": string;
     /** Used to store information about current versions available (“canary” or “stable”). */
-    "ada-embed_chat-manifest-cache": object;
+    "ada-embed_chat-manifest-cache": string;
+    /** Used to determine whether chatter session is expired. */
+    "ada-embed_chatter-created": string;
     /** Used to determine if the drawer was opened previously so when users navigate to other pages we can automatically open chat. */
     "ada-embed_is-drawer-open": boolean;
-    /** Use to store general information about Ada application state. */
+    /** Used to store general information about Ada application state. */
     "ada-functional-storage": Partial<AdaFunctionalStorageValue>;
     /** Used to identify the user within Ada. */
     "chatter": string;
+    /** Indicates whether user is connected to a live agent. */
+    "inLiveChat": boolean;
+    /** Indicates whether user is waiting to connect to a live agent. */
+    "liveChatPending": boolean;
+    /** Used for chatter authentication */
+    "session_token": string;
 }
 export declare type StorageKey = keyof StorageValueByKey;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ada-support/web-storage",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "A package to provide access to Web Storage API",
   "main": "dist/index.js",
   "publishConfig": {

package/src/create-storage.ts

@@ -0,0 +1,48 @@
+import type { AdaFunctionalStorageValue } from "./functional-storage";
+import type { StorageKey, StorageValueByKey } from "./storage-keys";
+
+const WEB_STORAGE_ACCESS_ERROR_MESSAGE = "Cannot access Web Storage API";
+
+export const createStorage = (storageProvider: Storage) => {
+  const storage = {
+    setItem: <K extends StorageKey>(key: K, value: StorageValueByKey[K]): void => {
+      try {
+        storageProvider.setItem(key, JSON.stringify(value));
+      } catch (e) {
+        console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
+      }
+    },
+
+    getItem: <K extends StorageKey>(key: K): StorageValueByKey[K] | null => {
+      try {
+        const rawStorageValue = storageProvider.getItem(key);
+
+        return rawStorageValue && JSON.parse(rawStorageValue);
+      } catch (e) {
+        console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
+
+        return null;
+      }
+    },
+
+    /** Stores a key/value pair within `ada-functional-storage` Storage key */
+    setFnItem: <K extends keyof AdaFunctionalStorageValue>(key: K, value: AdaFunctionalStorageValue[K]): void => {
+      const currentValue = storage.getItem("ada-functional-storage") || {};
+      const newValue = {
+        ...currentValue,
+        [key]: value,
+      };
+
+      storage.setItem("ada-functional-storage", newValue);
+    },
+
+    /** Gets a value under `ada-functional-storage` Storage key */
+    getFnItem: <K extends keyof AdaFunctionalStorageValue>(key: K): AdaFunctionalStorageValue[K] | null => {
+      const value = storage.getItem("ada-functional-storage");
+
+      return (value && value[key]) || null;
+    },
+  } as const;
+
+  return storage;
+};

package/src/functional-storage.ts

@@ -5,4 +5,7 @@ export interface AdaFunctionalStorageValue {
   rolloutLastValue: {
     [clientHandle: string]: number;
   };
+  marketing_campaigns_shown: {
+    [clientHandle: string]: string;
+  };
 }

package/src/index.ts

@@ -1,51 +1,6 @@
-import type { AdaFunctionalStorageValue } from "./functional-storage";
-import type { StorageKey, StorageValueByKey } from "./storage-keys";
-
-const WEB_STORAGE_ACCESS_ERROR_MESSAGE = "Cannot access Web Storage API";
-
-export const createStorage = (storageProvider: Storage) => {
-  const storage = {
-    setItem: <K extends StorageKey>(key: K, value: StorageValueByKey[K]): void => {
-      try {
-        storageProvider.setItem(key, JSON.stringify(value));
-      } catch (e) {
-        console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
-      }
-    },
-
-    getItem: <K extends StorageKey>(key: K): StorageValueByKey[K] | null => {
-      try {
-        const rawStorageValue = storageProvider.getItem(key);
-
-        return rawStorageValue && JSON.parse(rawStorageValue);
-      } catch (e) {
-        console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
-
-        return null;
-      }
-    },
-
-    /** Stores a key/value pair within `ada-functional-storage` Storage key */
-    setFnItem: <K extends keyof AdaFunctionalStorageValue>(key: K, value: AdaFunctionalStorageValue[K]): void => {
-      const currentValue = storage.getItem("ada-functional-storage") || {};
-      const newValue = {
-        ...currentValue,
-        [key]: value,
-      };
-
-      storage.setItem("ada-functional-storage", newValue);
-    },
-
-    /** Gets a value under `ada-functional-storage` Storage key */
-    getFnItem: <K extends keyof AdaFunctionalStorageValue>(key: K): AdaFunctionalStorageValue[K] | null => {
-      const value = storage.getItem("ada-functional-storage");
-
-      return (value && value[key]) || null;
-    },
-  } as const;
-
-  return storage;
-};
+import { createStorage } from "./create-storage";
+import type { StorageKey } from "./storage-keys";
 
 export const adaLocalStorage = createStorage(localStorage);
 export const adaSessionStorage = createStorage(sessionStorage);
+export type AdaStorageKey = StorageKey

package/src/storage-keys.ts

@@ -5,16 +5,28 @@ export interface StorageValueByKey {
   "ada-embed_chat-assigned-version": string;
 
   /** Used to store information about current versions available (“canary” or “stable”). */
-  "ada-embed_chat-manifest-cache": object;
+  "ada-embed_chat-manifest-cache": string;
+
+  /** Used to determine whether chatter session is expired. */
+  "ada-embed_chatter-created": string;
 
   /** Used to determine if the drawer was opened previously so when users navigate to other pages we can automatically open chat. */
   "ada-embed_is-drawer-open": boolean;
 
-  /** Use to store general information about Ada application state. */
+  /** Used to store general information about Ada application state. */
   "ada-functional-storage": Partial<AdaFunctionalStorageValue>;
 
   /** Used to identify the user within Ada. */
   "chatter": string;
+
+  /** Indicates whether user is connected to a live agent. */
+  "inLiveChat": boolean;
+
+  /** Indicates whether user is waiting to connect to a live agent. */
+  "liveChatPending": boolean;
+
+  /** Used for chatter authentication */
+  "session_token": string;
 }
 
 export type StorageKey = keyof StorageValueByKey;