@ada-support/web-storage 0.3.1 → 0.5.0

package/README.md

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

package/dist/create-storage.d.ts

@@ -3,8 +3,9 @@ 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;
+    readonly removeItem: <K_2 extends keyof StorageValueByKey>(key: K_2) => void;
     /** 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;
+    readonly setFnItem: <K_3 extends keyof AdaFunctionalStorageValue>(key: K_3, value: AdaFunctionalStorageValue[K_3]) => 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 getFnItem: <K_4 extends keyof AdaFunctionalStorageValue>(key: K_4) => AdaFunctionalStorageValue[K_4] | null;
 };

package/dist/create-storage.js

@@ -33,6 +33,14 @@ var createStorage = function (storageProvider) {
                 return null;
             }
         },
+        removeItem: function (key) {
+            try {
+                storageProvider.removeItem(key);
+            }
+            catch (e) {
+                console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
+            }
+        },
         /** Stores a key/value pair within `ada-functional-storage` Storage key */
         setFnItem: function (key, value) {
             var _a;

package/dist/index.d.ts

@@ -1,14 +1,19 @@
-import type { StorageKey } from "./storage-keys";
+import type { StorageKey, StorageValueByKey } from "./storage-keys";
 export declare const adaLocalStorage: {
-    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;
+    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;
+    readonly removeItem: <K_2 extends keyof StorageValueByKey>(key: K_2) => void;
+    readonly setFnItem: <K_3 extends keyof import("./functional-storage").AdaFunctionalStorageValue>(key: K_3, value: import("./functional-storage").AdaFunctionalStorageValue[K_3]) => void;
+    readonly getFnItem: <K_4 extends keyof import("./functional-storage").AdaFunctionalStorageValue>(key: K_4) => import("./functional-storage").AdaFunctionalStorageValue[K_4] | null;
 };
 export declare const adaSessionStorage: {
-    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;
+    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;
+    readonly removeItem: <K_2 extends keyof StorageValueByKey>(key: K_2) => void;
+    readonly setFnItem: <K_3 extends keyof import("./functional-storage").AdaFunctionalStorageValue>(key: K_3, value: import("./functional-storage").AdaFunctionalStorageValue[K_3]) => void;
+    readonly getFnItem: <K_4 extends keyof import("./functional-storage").AdaFunctionalStorageValue>(key: K_4) => import("./functional-storage").AdaFunctionalStorageValue[K_4] | null;
 };
 export declare type AdaStorageKey = StorageKey;
+export declare type AdaStorageValueByKey = StorageValueByKey;
+/** Checks if Web Storage API is supported */
+export declare const isWebStorageSupported: () => boolean;

package/dist/index.js

@@ -1,6 +1,19 @@
 "use strict";
 exports.__esModule = true;
-exports.adaSessionStorage = exports.adaLocalStorage = void 0;
+exports.isWebStorageSupported = 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);
+/** Checks if Web Storage API is supported */
+var isWebStorageSupported = function () {
+    try {
+        var key = "key_to_test_local_storage";
+        localStorage.setItem(key, key);
+        localStorage.removeItem(key);
+        return true;
+    }
+    catch (e) {
+        return false;
+    }
+};
+exports.isWebStorageSupported = isWebStorageSupported;

package/dist/storage-keys.d.ts

@@ -8,6 +8,14 @@ export interface StorageValueByKey {
     "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 cache Zendesk tags assigned to a conversation. */
+    "ada-embed_zd-previous-tags": string;
+    /** Stores Zendesk session id. */
+    "ada-embed_zd-session-id": string;
+    /** Used to determine whether Zendesk session is expired. */
+    "ada-embed_zd-messaging-chatter-created": string;
+    /** Stores Zendesk internal user id. */
+    "ada-embed_zd-messaging-external-user-id": string;
     /** Used to store general information about Ada application state. */
     "ada-functional-storage": Partial<AdaFunctionalStorageValue>;
     /** Used to identify the user within Ada. */
@@ -16,7 +24,7 @@ export interface StorageValueByKey {
     "inLiveChat": boolean;
     /** Indicates whether user is waiting to connect to a live agent. */
     "liveChatPending": boolean;
-    /** Used for chatter authentication */
+    /** 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.3.1",
+  "version": "0.5.0",
   "description": "A package to provide access to Web Storage API",
   "main": "dist/index.js",
   "publishConfig": {

package/src/create-storage.ts

@@ -5,6 +5,7 @@ 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));
@@ -25,6 +26,14 @@ export const createStorage = (storageProvider: Storage) => {
       }
     },
 
+    removeItem: <K extends StorageKey>(key: K): void => {
+      try {
+        storageProvider.removeItem(key);
+      } catch (e) {
+        console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
+      }
+    },
+
     /** 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") || {};

package/src/index.ts

@@ -1,6 +1,20 @@
 import { createStorage } from "./create-storage";
-import type { StorageKey } from "./storage-keys";
+import type { StorageKey, StorageValueByKey } from "./storage-keys";
 
 export const adaLocalStorage = createStorage(localStorage);
 export const adaSessionStorage = createStorage(sessionStorage);
-export type AdaStorageKey = StorageKey
+export type AdaStorageKey = StorageKey;
+export type AdaStorageValueByKey = StorageValueByKey;
+
+/** Checks if Web Storage API is supported */
+export const isWebStorageSupported = (): boolean => {
+  try {
+    const key = "key_to_test_local_storage";
+    localStorage.setItem(key, key);
+    localStorage.removeItem(key);
+
+    return true;
+  } catch (e) {
+    return false;
+  }
+};

package/src/storage-keys.ts

@@ -13,6 +13,18 @@ export interface StorageValueByKey {
   /** 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 cache Zendesk tags assigned to a conversation. */
+  "ada-embed_zd-previous-tags": string;
+
+  /** Stores Zendesk session id. */
+  "ada-embed_zd-session-id": string;
+
+  /** Used to determine whether Zendesk session is expired. */
+  "ada-embed_zd-messaging-chatter-created": string;
+
+  /** Stores Zendesk internal user id. */
+  "ada-embed_zd-messaging-external-user-id": string;
+
   /** Used to store general information about Ada application state. */
   "ada-functional-storage": Partial<AdaFunctionalStorageValue>;
 
@@ -25,7 +37,7 @@ export interface StorageValueByKey {
   /** Indicates whether user is waiting to connect to a live agent. */
   "liveChatPending": boolean;
 
-  /** Used for chatter authentication */
+  /** Used for chatter authentication. */
   "session_token": string;
 }