@artsy/dismissible 0.1.0 → 0.3.0

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# v0.3.0 (Fri Dec 22 2023)
+
+#### 🚀  Enhancement
+
+- docs(readme): Add readme docs [#7](https://github.com/artsy/dismissible/pull/7) ([@damassi](https://github.com/damassi))
+
+#### Authors: 1
+
+- Christopher Pappas ([@damassi](https://github.com/damassi))
+
+---
+
+# v0.2.0 (Wed Dec 20 2023)
+
+#### 🚀  Enhancement
+
+- fix(ci): Fixes NPM deploys and renames to @artsy/dismissible [#5](https://github.com/artsy/dismissible/pull/5) ([@damassi](https://github.com/damassi))
+- feat(onboarding): Add and adapt code from force [#4](https://github.com/artsy/dismissible/pull/4) ([@damassi](https://github.com/damassi))
+
+#### 🐛  Bug Fix
+
+- chore(lib): 0.1.0 [#6](https://github.com/artsy/dismissible/pull/6) ([@damassi](https://github.com/damassi))
+- chore(setup): Initial file addition [#1](https://github.com/artsy/dismissible/pull/1) ([@damassi](https://github.com/damassi))
+
+#### ⚠️ Pushed to `main`
+
+- Initial commit ([@damassi](https://github.com/damassi))
+
+#### Authors: 1
+
+- Christopher Pappas ([@damassi](https://github.com/damassi))

package/README.md

@@ -2,11 +2,80 @@
 
 A package that stores dismissible key/value entries in localStorage, which can be used in apps that require progressive onboarding and the like.
 
-## Use
+## Setup and Use
 
-TODO
+```bash
+yarn install @artsy/dismissible
+```
+
+Once the package is installed, add the `DismissibleProvider` context to your app, pass in localStorage `keys` to be dismissed later, and (optionally) add a `userID` to attach the key identifiers to:
+
+```jsx
+const Root = () => {
+  return (
+    <DismissibleProvider
+      keys={["newFeature", "newFeature2"]}
+      userID="some-user-id"
+    >
+      <NewFeatureAlert>
+        <NewFeature />
+      </NewFeatureAlert>
+
+      <NewFeature2Alert>
+        <NewFeature2>
+      </NewFeature2Alert>
+    </DismissibleProvider>
+  )
+}
+```
+
+Then from `<NewFeatureAlert />`, can manage dismissible keys like so:
+
+```jsx
+const NewFeatureAlert = () => {
+  const { dismiss, isDismissed } = useDismissibleContext()
+
+  const isDisplayable = !isDismissed("newFeature").status
+
+  const handleClose = () => {
+    dismiss(ALERT_ID)
+  }
+
+  if (!isDisplayable) {
+    return <>{children}</>
+  }
+
+  return <Popover message="Check out this new feature!">{children}</Popover>
+}
+```
 
-## Commands
+## API
+
+The `useDismissibleContext` hook returns a few useful things for managing dismissibles:
+
+```jsx
+const App = () => {
+  const { dismiss, dismissed, isDismissed, keys, syncFromLoggedOutUser } =
+    useDismissibleContext()
+
+  // Dismisses a key
+  dismiss("id")
+
+  // All dismissed keys
+  dismissed()
+
+  // Status of the thing dismissed, including timestamp
+  isDismissied("id")
+
+  // If a logged-out user logs in, resync so that dismissed keys don't reappear
+  syncFromLoggedOutUser()
+
+  // All dismissible keys
+  console.log(keys)
+}
+```
+
+## Development
 
 ```bash
 yarn test
@@ -15,3 +84,20 @@ yarn lint
 yarn compile
 yarn watch
 ```
+
+This project uses [auto-release](https://github.com/intuit/auto-release#readme)
+to automatically release on every PR. Every PR should have a label that matches
+one of the following
+
+- Version: Trivial
+- Version: Patch
+- Version: Minor
+- Version: Major
+
+Major, minor, and patch will cause a new release to be generated. Use major for
+breaking changes, minor for new non-breaking features, and patch for bug fixes.
+Trivial will not cause a release and should be used when updating documentation
+or non-project code.
+
+If you don't want to release on a particular PR but the changes aren't trivial
+then use the `Skip Release` tag along side the appropriate version tag.

package/dist/DismissibleContext.d.ts

@@ -0,0 +1,47 @@
+import * as Yup from "yup";
+import React from "react";
+declare type DismissibleKey = DismissibleContextProps["keys"][number];
+declare type DismissibleKeys = DismissibleKey[];
+interface DismissedKey {
+    key: DismissibleKey;
+    timestamp: number;
+}
+interface DismissedKeyStatus {
+    status: boolean;
+    timestamp: number;
+}
+interface DismissibleContextProps {
+    dismissed: DismissedKey[];
+    dismiss: (key: DismissibleKey | readonly DismissibleKey[]) => void;
+    isDismissed: (key: DismissibleKey) => DismissedKeyStatus;
+    keys: string[];
+    syncFromLoggedOutUser: () => void;
+    /** An optional userID to track against  */
+    userID?: string | null;
+}
+export declare const DismissibleProvider: React.FC<{
+    children: React.ReactNode;
+    keys: DismissibleKeys;
+    userID?: DismissibleContextProps["userID"];
+}>;
+export declare const useDismissibleContext: () => DismissibleContextProps;
+export declare const DISMISSIBLE_LOGGED_OUT_USER_ID: "user";
+export declare const localStorageKey: (id: string) => string;
+interface UseLocalStorageUtilsProps {
+    keys: DismissibleContextProps["keys"];
+}
+export declare const useLocalStorageUtils: ({ keys }: UseLocalStorageUtilsProps) => {
+    __dismiss__: (id: string, timestamp: number, key: DismissibleKey | DismissibleKey[]) => void;
+    get: (id: string) => DismissedKey[];
+    isValid: (value: DismissedKey) => value is DismissedKey;
+    parse: (value: string | null) => DismissedKey[];
+    reset: (id: string) => void;
+    schema: Yup.ObjectSchema<{
+        key: string | undefined;
+        timestamp: number | undefined;
+    }, Yup.AnyObject, {
+        key: undefined;
+        timestamp: undefined;
+    }, "">;
+};
+export {};

package/dist/DismissibleContext.js

@@ -0,0 +1,168 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useLocalStorageUtils = exports.localStorageKey = exports.DISMISSIBLE_LOGGED_OUT_USER_ID = exports.useDismissibleContext = exports.DismissibleProvider = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const Yup = __importStar(require("yup"));
+const react_1 = require("react");
+const lodash_uniqby_1 = __importDefault(require("lodash.uniqby"));
+const DismissibleContext = (0, react_1.createContext)({
+    dismissed: [],
+    keys: [],
+    isDismissed: () => ({ status: false, timestamp: 0 }),
+});
+const DismissibleProvider = ({ children, keys = [], userID }) => {
+    const id = userID !== null && userID !== void 0 ? userID : exports.DISMISSIBLE_LOGGED_OUT_USER_ID;
+    const [dismissed, setDismissed] = (0, react_1.useState)([]);
+    const localStorageUtils = (0, exports.useLocalStorageUtils)({ keys });
+    const { __dismiss__, get } = localStorageUtils;
+    const dismiss = (0, react_1.useCallback)((key) => {
+        const keys = Array.isArray(key) ? key : [key];
+        const timestamp = Date.now();
+        __dismiss__(id, timestamp, keys);
+        setDismissed((prevDismissed) => {
+            return (0, lodash_uniqby_1.default)([...prevDismissed, ...keys.map((k) => ({ key: k, timestamp }))], (d) => d.key);
+        });
+    }, [id]);
+    (0, react_1.useEffect)(() => {
+        setDismissed(get(id));
+    }, [id]);
+    const mounted = useDidMount();
+    const isDismissed = (0, react_1.useCallback)((key) => {
+        if (!mounted) {
+            return {
+                status: false,
+                timestamp: 0,
+            };
+        }
+        const dismissedKey = dismissed.find((d) => d.key === key);
+        return dismissedKey
+            ? { status: true, timestamp: dismissedKey.timestamp }
+            : { status: false, timestamp: 0 };
+    }, [dismissed, mounted]);
+    /**
+     * If the user is logged out, and performs some action which causes them
+     * to login, we need to sync up the dismissed state from the logged out user
+     */
+    const syncFromLoggedOutUser = (0, react_1.useCallback)(() => {
+        if (id === exports.DISMISSIBLE_LOGGED_OUT_USER_ID) {
+            return;
+        }
+        const loggedOutDismissals = get(exports.DISMISSIBLE_LOGGED_OUT_USER_ID);
+        const loggedInDismissals = get(id);
+        const dismissals = (0, lodash_uniqby_1.default)([...loggedOutDismissals, ...loggedInDismissals], (d) => d.key);
+        setDismissed(dismissals);
+        localStorage.setItem((0, exports.localStorageKey)(id), JSON.stringify(dismissals));
+        localStorage.removeItem((0, exports.localStorageKey)(exports.DISMISSIBLE_LOGGED_OUT_USER_ID));
+    }, [id]);
+    // Ensure that the dismissed state stays in sync incase the user
+    // has multiple tabs open.
+    (0, react_1.useEffect)(() => {
+        const current = get(id);
+        if (current.length === 0)
+            return;
+        const handleFocus = () => {
+            setDismissed(current);
+        };
+        window.addEventListener("focus", handleFocus);
+        return () => {
+            window.removeEventListener("focus", handleFocus);
+        };
+    }, [id]);
+    return ((0, jsx_runtime_1.jsx)(DismissibleContext.Provider, Object.assign({ value: {
+            dismissed,
+            dismiss,
+            isDismissed,
+            keys,
+            syncFromLoggedOutUser,
+        } }, { children: children })));
+};
+exports.DismissibleProvider = DismissibleProvider;
+const useDismissibleContext = () => {
+    return (0, react_1.useContext)(DismissibleContext);
+};
+exports.useDismissibleContext = useDismissibleContext;
+exports.DISMISSIBLE_LOGGED_OUT_USER_ID = "user";
+const localStorageKey = (id) => {
+    return `progressive-onboarding.dismissed.${id}`;
+};
+exports.localStorageKey = localStorageKey;
+const useLocalStorageUtils = ({ keys }) => {
+    const schema = Yup.object().shape({
+        key: Yup.string().oneOf([...keys]),
+        timestamp: Yup.number(),
+    });
+    const isValid = (value) => {
+        return schema.isValidSync(value);
+    };
+    const parse = (value) => {
+        if (!value)
+            return [];
+        try {
+            const parsed = JSON.parse(value);
+            return parsed.filter((obj) => {
+                return isValid(obj) && keys.includes(obj.key);
+            });
+        }
+        catch (err) {
+            return [];
+        }
+    };
+    const __dismiss__ = (id, timestamp, key) => {
+        const keys = Array.isArray(key) ? key : [key];
+        keys.forEach((key) => {
+            const item = localStorage.getItem((0, exports.localStorageKey)(id));
+            const dismissed = parse(item);
+            localStorage.setItem((0, exports.localStorageKey)(id), JSON.stringify((0, lodash_uniqby_1.default)([...dismissed, { key, timestamp }], ({ key }) => key)));
+        });
+    };
+    const get = (id) => {
+        const item = localStorage.getItem((0, exports.localStorageKey)(id));
+        return parse(item);
+    };
+    const reset = (id) => {
+        localStorage.removeItem((0, exports.localStorageKey)(id));
+    };
+    return {
+        __dismiss__,
+        get,
+        isValid,
+        parse,
+        reset,
+        schema,
+    };
+};
+exports.useLocalStorageUtils = useLocalStorageUtils;
+function useDidMount(defaultMounted = false) {
+    const [isMounted, toggleMounted] = (0, react_1.useState)(defaultMounted);
+    (0, react_1.useEffect)(() => {
+        toggleMounted(true);
+    }, []);
+    return isMounted;
+}
+//# sourceMappingURL=DismissibleContext.js.map

package/dist/DismissibleContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DismissibleContext.js","sourceRoot":"","sources":["../src/DismissibleContext.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA0B;AAC1B,iCAMc;AACd,kEAAkC;AAyBlC,MAAM,kBAAkB,GAAG,IAAA,qBAAa,EAA0B;IAChE,SAAS,EAAE,EAAE;IACb,IAAI,EAAE,EAAE;IACR,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;CACf,CAAC,CAAA;AAEjC,MAAM,mBAAmB,GAI3B,CAAC,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;IACvC,MAAM,EAAE,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,sCAA8B,CAAA;IAEnD,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,IAAA,gBAAQ,EAAiB,EAAE,CAAC,CAAA;IAE9D,MAAM,iBAAiB,GAAG,IAAA,4BAAoB,EAAC,EAAE,IAAI,EAAE,CAAC,CAAA;IACxD,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAA;IAE9C,MAAM,OAAO,GAAG,IAAA,mBAAW,EACzB,CAAC,GAAsC,EAAE,EAAE;QACzC,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QAC7C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAE5B,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;QAEhC,YAAY,CAAC,CAAC,aAAa,EAAE,EAAE;YAC7B,OAAO,IAAA,uBAAM,EACX,CAAC,GAAG,aAAa,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAC/D,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CACb,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,EACD,CAAC,EAAE,CAAC,CACL,CAAA;IAED,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;IACvB,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAER,MAAM,OAAO,GAAG,WAAW,EAAE,CAAA;IAE7B,MAAM,WAAW,GAAG,IAAA,mBAAW,EAC7B,CAAC,GAAmB,EAAE,EAAE;QACtB,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO;gBACL,MAAM,EAAE,KAAK;gBACb,SAAS,EAAE,CAAC;aACb,CAAA;SACF;QAED,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAA;QAEzD,OAAO,YAAY;YACjB,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,CAAC,SAAS,EAAE;YACrD,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE,CAAA;IACrC,CAAC,EACD,CAAC,SAAS,EAAE,OAAO,CAAC,CACrB,CAAA;IAED;;;OAGG;IACH,MAAM,qBAAqB,GAAG,IAAA,mBAAW,EAAC,GAAG,EAAE;QAC7C,IAAI,EAAE,KAAK,sCAA8B,EAAE;YACzC,OAAM;SACP;QAED,MAAM,mBAAmB,GAAG,GAAG,CAAC,sCAA8B,CAAC,CAAA;QAC/D,MAAM,kBAAkB,GAAG,GAAG,CAAC,EAAE,CAAC,CAAA;QAElC,MAAM,UAAU,GAAG,IAAA,uBAAM,EACvB,CAAC,GAAG,mBAAmB,EAAE,GAAG,kBAAkB,CAAC,EAC/C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CACb,CAAA;QAED,YAAY,CAAC,UAAU,CAAC,CAAA;QAExB,YAAY,CAAC,OAAO,CAAC,IAAA,uBAAe,EAAC,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAA;QACrE,YAAY,CAAC,UAAU,CAAC,IAAA,uBAAe,EAAC,sCAA8B,CAAC,CAAC,CAAA;IAC1E,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAER,gEAAgE;IAChE,0BAA0B;IAC1B,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,MAAM,OAAO,GAAG,GAAG,CAAC,EAAE,CAAC,CAAA;QAEvB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAM;QAEhC,MAAM,WAAW,GAAG,GAAG,EAAE;YACvB,YAAY,CAAC,OAAO,CAAC,CAAA;QACvB,CAAC,CAAA;QAED,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAE7C,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAClD,CAAC,CAAA;IACH,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAER,OAAO,CACL,uBAAC,kBAAkB,CAAC,QAAQ,kBAC1B,KAAK,EAAE;YACL,SAAS;YACT,OAAO;YACP,WAAW;YACX,IAAI;YACJ,qBAAqB;SACtB,gBAEA,QAAQ,IACmB,CAC/B,CAAA;AACH,CAAC,CAAA;AA3GY,QAAA,mBAAmB,uBA2G/B;AAEM,MAAM,qBAAqB,GAAG,GAAG,EAAE;IACxC,OAAO,IAAA,kBAAU,EAAC,kBAAkB,CAAC,CAAA;AACvC,CAAC,CAAA;AAFY,QAAA,qBAAqB,yBAEjC;AAEY,QAAA,8BAA8B,GAAG,MAAe,CAAA;AAEtD,MAAM,eAAe,GAAG,CAAC,EAAU,EAAE,EAAE;IAC5C,OAAO,oCAAoC,EAAE,EAAE,CAAA;AACjD,CAAC,CAAA;AAFY,QAAA,eAAe,mBAE3B;AAMM,MAAM,oBAAoB,GAAG,CAAC,EAAE,IAAI,EAA6B,EAAE,EAAE;IAC1E,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC;QAChC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QAClC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE;KACxB,CAAC,CAAA;IAEF,MAAM,OAAO,GAAG,CAAC,KAAmB,EAAyB,EAAE;QAC7D,OAAO,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC,CAAA;IAED,MAAM,KAAK,GAAG,CAAC,KAAoB,EAAkB,EAAE;QACrD,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,CAAA;QAErB,IAAI;YACF,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YAEhC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,GAAiB,EAAE,EAAE;gBACzC,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC/C,CAAC,CAAC,CAAA;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,EAAE,CAAA;SACV;IACH,CAAC,CAAA;IAED,MAAM,WAAW,GAAG,CAClB,EAAU,EACV,SAAiB,EACjB,GAAsC,EACtC,EAAE;QACF,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QAE7C,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,IAAA,uBAAe,EAAC,EAAE,CAAC,CAAC,CAAA;YACtD,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,CAAA;YAE7B,YAAY,CAAC,OAAO,CAClB,IAAA,uBAAe,EAAC,EAAE,CAAC,EACnB,IAAI,CAAC,SAAS,CACZ,IAAA,uBAAM,EAAC,CAAC,GAAG,SAAS,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAC7D,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;IAED,MAAM,GAAG,GAAG,CAAC,EAAU,EAAE,EAAE;QACzB,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,IAAA,uBAAe,EAAC,EAAE,CAAC,CAAC,CAAA;QACtD,OAAO,KAAK,CAAC,IAAI,CAAC,CAAA;IACpB,CAAC,CAAA;IAED,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE;QAC3B,YAAY,CAAC,UAAU,CAAC,IAAA,uBAAe,EAAC,EAAE,CAAC,CAAC,CAAA;IAC9C,CAAC,CAAA;IAED,OAAO;QACL,WAAW;QACX,GAAG;QACH,OAAO;QACP,KAAK;QACL,KAAK;QACL,MAAM;KACP,CAAA;AACH,CAAC,CAAA;AA7DY,QAAA,oBAAoB,wBA6DhC;AAED,SAAS,WAAW,CAAC,cAAc,GAAG,KAAK;IACzC,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC,GAAG,IAAA,gBAAQ,EAAC,cAAc,CAAC,CAAA;IAE3D,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,aAAa,CAAC,IAAI,CAAC,CAAA;IACrB,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,OAAO,SAAS,CAAA;AAClB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { DismissibleProvider, useDismissibleContext, } from "./DismissibleContext";

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,2DAG6B;AAF3B,yHAAA,mBAAmB,OAAA;AACnB,2HAAA,qBAAqB,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artsy/dismissible",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "private": false,
   "main": "dist/index.js",
   "license": "MIT",

package/src/DismissibleContext.tsx

@@ -8,8 +8,8 @@ import React, {
 } from "react"
 import uniqBy from "lodash.uniqby"
 
-export type DismissibleKey = DismissibleContextProps["keys"][number]
-export type DismissibleKeys = DismissibleKey[]
+type DismissibleKey = DismissibleContextProps["keys"][number]
+type DismissibleKeys = DismissibleKey[]
 
 interface DismissedKey {
   key: DismissibleKey
@@ -21,7 +21,7 @@ interface DismissedKeyStatus {
   timestamp: number
 }
 
-export interface DismissibleContextProps {
+interface DismissibleContextProps {
   dismissed: DismissedKey[]
   dismiss: (key: DismissibleKey | readonly DismissibleKey[]) => void
   isDismissed: (key: DismissibleKey) => DismissedKeyStatus
@@ -29,10 +29,9 @@ export interface DismissibleContextProps {
   syncFromLoggedOutUser: () => void
   /** An optional userID to track against  */
   userID?: string | null
-  __internal__: ReturnType<typeof useLocalStorageUtils>
 }
 
-export const DismissibleContext = createContext<DismissibleContextProps>({
+const DismissibleContext = createContext<DismissibleContextProps>({
   dismissed: [],
   keys: [],
   isDismissed: () => ({ status: false, timestamp: 0 }),
@@ -43,7 +42,7 @@ export const DismissibleProvider: React.FC<{
   keys: DismissibleKeys
   userID?: DismissibleContextProps["userID"]
 }> = ({ children, keys = [], userID }) => {
-  const id = userID ?? PROGRESSIVE_ONBOARDING_LOGGED_OUT_USER_ID
+  const id = userID ?? DISMISSIBLE_LOGGED_OUT_USER_ID
 
   const [dismissed, setDismissed] = useState<DismissedKey[]>([])
 
@@ -96,11 +95,11 @@ export const DismissibleProvider: React.FC<{
    * to login, we need to sync up the dismissed state from the logged out user
    */
   const syncFromLoggedOutUser = useCallback(() => {
-    if (id === PROGRESSIVE_ONBOARDING_LOGGED_OUT_USER_ID) {
+    if (id === DISMISSIBLE_LOGGED_OUT_USER_ID) {
       return
     }
 
-    const loggedOutDismissals = get(PROGRESSIVE_ONBOARDING_LOGGED_OUT_USER_ID)
+    const loggedOutDismissals = get(DISMISSIBLE_LOGGED_OUT_USER_ID)
     const loggedInDismissals = get(id)
 
     const dismissals = uniqBy(
@@ -111,9 +110,7 @@ export const DismissibleProvider: React.FC<{
     setDismissed(dismissals)
 
     localStorage.setItem(localStorageKey(id), JSON.stringify(dismissals))
-    localStorage.removeItem(
-      localStorageKey(PROGRESSIVE_ONBOARDING_LOGGED_OUT_USER_ID)
-    )
+    localStorage.removeItem(localStorageKey(DISMISSIBLE_LOGGED_OUT_USER_ID))
   }, [id])
 
   // Ensure that the dismissed state stays in sync incase the user
@@ -142,7 +139,6 @@ export const DismissibleProvider: React.FC<{
         isDismissed,
         keys,
         syncFromLoggedOutUser,
-        __internal__: localStorageUtils,
       }}
     >
       {children}
@@ -154,7 +150,7 @@ export const useDismissibleContext = () => {
   return useContext(DismissibleContext)
 }
 
-export const PROGRESSIVE_ONBOARDING_LOGGED_OUT_USER_ID = "user" as const
+export const DISMISSIBLE_LOGGED_OUT_USER_ID = "user" as const
 
 export const localStorageKey = (id: string) => {
   return `progressive-onboarding.dismissed.${id}`

package/src/__tests__/DismissibleContext.jest.tsx

@@ -1,7 +1,7 @@
 import React from "react"
 import { renderHook } from "@testing-library/react-hooks"
 import {
-  PROGRESSIVE_ONBOARDING_LOGGED_OUT_USER_ID,
+  DISMISSIBLE_LOGGED_OUT_USER_ID,
   DismissibleProvider,
   useLocalStorageUtils,
   useDismissibleContext,
@@ -230,7 +230,7 @@ describe("DismissibleContext", () => {
 
     describe("logged in", () => {
       it("syncs the dismissed state from the logged out user", () => {
-        const loggedOutUserId = PROGRESSIVE_ONBOARDING_LOGGED_OUT_USER_ID
+        const loggedOutUserId = DISMISSIBLE_LOGGED_OUT_USER_ID
 
         const loggedOutDismissals = [
           { key: "follow-artist", timestamp: 555 },