@ada-support/web-storage 0.0.3

package/.eslintignore

@@ -0,0 +1,2 @@
+dist/
+node_modules/

package/.eslintrc

@@ -0,0 +1,10 @@
+{
+  "root": true,
+  "extends": [
+    "@ada-support/eslint-config-ada"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  }
+}

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+### Changes
+
+> _List out the changes_
+
+### Why this is Important?
+
+> _A bit of context_
+
+---
+
+### Checklist
+
+- [ ] [Security team](https://adasupport.slack.com/archives/C030WPEMRCZ) is notified about the changes and approves them.

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,29 @@
+name: "NPM publish"
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  npm-publish:
+    name: "NPM publish"
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout source code"
+        uses: "actions/checkout@v2"
+        env:
+          GITHUB_TOKEN: ${{ secrets.PUSH_ACCESS_TOKEN }}
+        with:
+          ref: ${{ github.ref }}
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "16.x"
+          registry-url: "https://registry.npmjs.org"
+
+      - run: |
+          yarn install
+          yarn compile
+          npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/verify-code.yml

@@ -0,0 +1,28 @@
+name: "Verify code"
+
+on: 
+  pull_request:
+jobs:
+  verify:
+    name: "Verify code"
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout source code"
+        uses: "actions/checkout@v3"
+        env:
+          GITHUB_TOKEN: ${{ secrets.PUSH_ACCESS_TOKEN }}
+        with:
+          ref: ${{ github.ref }}
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "16"
+          registry-url: "https://registry.npmjs.org"
+          cache: 'npm'
+
+      - run: |
+          yarn install
+          yarn compile
+          yarn lint
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

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

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import type { AdaFunctionalStorageValue, StorageValueByKey } 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` localStorage key */
+    readonly setFnItem: <K_2 extends keyof AdaFunctionalStorageValue>(key: K_2, value: AdaFunctionalStorageValue[K_2]) => void;
+    /** Gets an value under `ada-functional` localStorage key */
+    readonly getFnItem: <K_3 extends keyof AdaFunctionalStorageValue>(key: K_3) => AdaFunctionalStorageValue[K_3] | null;
+};

package/dist/index.js

@@ -0,0 +1,47 @@
+"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.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));
+        }
+        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;
+    }
+};

package/dist/storage-keys.d.ts

@@ -0,0 +1,19 @@
+export interface AdaFunctionalStorageValue {
+    rolloutGroup: {
+        [clientHandle: string]: "A" | "B";
+    };
+    rollout: {
+        group: {
+            [clientHandle: string]: "A" | "B";
+        };
+        lastProbability: {
+            [clientHandle: string]: number;
+        };
+    };
+}
+export interface StorageValueByKey {
+    "ada-embed_is-drawer-open": boolean;
+    "chatter": string;
+    "ada-functional": Partial<AdaFunctionalStorageValue>;
+}
+export declare type StorageKey = keyof StorageValueByKey;

package/dist/storage-keys.js

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

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@ada-support/web-storage",
+  "version": "0.0.3",
+  "description": "A package to provide access to Web Storage API",
+  "main": "dist/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "lint": "tsc --noEmit && npx eslint  --ext .ts .",
+    "compile": "rm -rf dist && npx tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AdaSupport/web-storage.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "homepage": "https://github.com/AdaSupport/web-storage#readme",
+  "dependencies": {
+    "typescript": "^4.8.4"
+  },
+  "devDependencies": {
+    "@ada-support/eslint-config-ada": "^1.2.4",
+    "eslint": "^8.24.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,43 @@
+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;

package/src/storage-keys.ts

@@ -0,0 +1,21 @@
+export interface AdaFunctionalStorageValue {
+  rolloutGroup: {
+    [clientHandle: string]: "A" | "B";
+  };
+  rollout: {
+    group: {
+      [clientHandle: string]: "A" | "B";
+    };
+    lastProbability: {
+      [clientHandle: string]: number;
+    };
+  };
+}
+
+export interface StorageValueByKey {
+  "ada-embed_is-drawer-open": boolean;
+  "chatter": string;
+  "ada-functional": Partial<AdaFunctionalStorageValue>;
+}
+
+export type StorageKey = keyof StorageValueByKey;

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "dist",
+    "strict": true
+  }
+}