@ada-support/web-storage 0.0.5 → 0.1.0

package/.github/workflows/notify-people.yml

@@ -2,19 +2,27 @@ name: "Notify people"
 
 on: 
   pull_request:
-    types: [ready_for_review]
+    types: [opened, reopened, ready_for_review]
 jobs:
   notify:
     runs-on: ubuntu-latest
+    env:
+      SLACK_CHANNEL: "#chatx-engineering-internal" #default
+      SLACK_USERNAME: "`@ada-support/web-storage` package updates"
+      SLACK_ICON_EMOJI: ":sparkles:"
+      SLACK_COLOR: "#f5e512"
+      SLACK_TITLE: "Changes to `web-storage` are ready for review"
+      SLACK_MESSAGE: "Pull request: ${{ github.server_url }}/${{ github.repository }}/pull/${{ github.event.number }}"
+      SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK_URL }}
+      MSG_MINIMAL: true
+
     steps:
-      - name: Slack Notification
+      - name: "Notify ChatX team"
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_CHANNEL: "#chatx-engineering-internal"
+
+      - name: "Notify #p-cookies-updates-management"
         uses: rtCamp/action-slack-notify@v2
         env:
-          SLACK_USERNAME: "`@ada-support/web-storage` package updates"
-          SLACK_ICON_EMOJI: ":sparkles:"
-          SLACK_CHANNEL: "chatx"
-          SLACK_COLOR: "#f5e512"
-          SLACK_TITLE: "Changes to `web-storage` are ready for review"
-          SLACK_MESSAGE: "Pull request: ${{ github.server_url }}/${{ github.repository }}/pull/${{ github.event.number }}"
-          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK_URL }}
-          MSG_MINIMAL: true
+          SLACK_CHANNEL: "#p-cookies-updates-management"

package/CODEOWNERS

@@ -0,0 +1 @@
+src/ @AdaSupport/chatx

package/dist/functional-storage.d.ts

@@ -0,0 +1,8 @@
+export interface AdaFunctionalStorageValue {
+    rolloutGroup: {
+        [clientHandle: string]: "A" | "B";
+    };
+    rolloutLastValue: {
+        [clientHandle: string]: number;
+    };
+}

package/dist/functional-storage.js

@@ -0,0 +1,2 @@
+"use strict";
+exports.__esModule = true;

package/dist/index.d.ts

@@ -1,9 +1,26 @@
-import type { AdaFunctionalStorageValue, StorageValueByKey } from "./storage-keys";
+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;
+};
 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` localStorage key */
+    /** 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;
+};
+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 an value under `ada-functional` localStorage key */
+    /** 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/index.js

@@ -11,37 +11,43 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 exports.__esModule = true;
-exports.adaLocalStorage = void 0;
-var LOCAL_STORAGE_ACCESS_ERROR_MESSAGE = "Cannot access localStorage";
-exports.adaLocalStorage = {
-    setItem: function (key, value) {
-        try {
-            localStorage.setItem(key, JSON.stringify(value));
+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;
         }
-        catch (e) {
-            console.warn(LOCAL_STORAGE_ACCESS_ERROR_MESSAGE);
-        }
-    },
-    getItem: function (key) {
-        try {
-            var rawStorageValue = localStorage.getItem(key);
-            return rawStorageValue && JSON.parse(rawStorageValue);
-        }
-        catch (e) {
-            console.warn(LOCAL_STORAGE_ACCESS_ERROR_MESSAGE);
-            return null;
-        }
-    },
-    /** Stores a key/value pair within `ada-functional` localStorage key */
-    setFnItem: function (key, value) {
-        var _a;
-        var currentValue = exports.adaLocalStorage.getItem("ada-functional") || {};
-        var newValue = __assign(__assign({}, currentValue), (_a = {}, _a[key] = value, _a));
-        exports.adaLocalStorage.setItem("ada-functional", newValue);
-    },
-    /** Gets an value under `ada-functional` localStorage key */
-    getFnItem: function (key) {
-        var value = exports.adaLocalStorage.getItem("ada-functional");
-        return (value && value[key]) || null;
-    }
+    };
+    return storage;
 };
+exports.createStorage = createStorage;
+exports.adaLocalStorage = (0, exports.createStorage)(localStorage);
+exports.adaSessionStorage = (0, exports.createStorage)(sessionStorage);

package/dist/storage-keys.d.ts

@@ -1,14 +1,14 @@
-export interface AdaFunctionalStorageValue {
-    rolloutGroup: {
-        [clientHandle: string]: "A" | "B";
-    };
-    rolloutLastValue: {
-        [clientHandle: string]: number;
-    };
-}
+import type { AdaFunctionalStorageValue } from "./functional-storage";
 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;
+    /** 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. */
+    "ada-functional-storage": Partial<AdaFunctionalStorageValue>;
+    /** Used to identify the user within Ada. */
     "chatter": string;
-    "ada-functional": Partial<AdaFunctionalStorageValue>;
 }
 export declare type StorageKey = keyof StorageValueByKey;

package/package.json

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

package/src/functional-storage.ts

@@ -0,0 +1,8 @@
+export interface AdaFunctionalStorageValue {
+  rolloutGroup: {
+    [clientHandle: string]: "A" | "B";
+  };
+  rolloutLastValue: {
+    [clientHandle: string]: number;
+  };
+}

package/src/index.ts

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

package/src/storage-keys.ts

@@ -1,16 +1,20 @@
-export interface AdaFunctionalStorageValue {
-  rolloutGroup: {
-    [clientHandle: string]: "A" | "B";
-  };
-  rolloutLastValue: {
-    [clientHandle: string]: number;
-  };
-}
+import type { AdaFunctionalStorageValue } from "./functional-storage";
 
 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;
+
+  /** 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. */
+  "ada-functional-storage": Partial<AdaFunctionalStorageValue>;
+
+  /** Used to identify the user within Ada. */
   "chatter": string;
-  "ada-functional": Partial<AdaFunctionalStorageValue>;
 }
 
 export type StorageKey = keyof StorageValueByKey;