@knocklabs/react-core 0.5.0-rc.1.0 → 0.5.0-rc.3.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## 0.5.0-rc.1.0
+## 0.5.0-rc.3.0
 
 ### Minor Changes
 
@@ -9,7 +9,7 @@
 ### Patch Changes
 
 - Updated dependencies [0fc5f2d]
-  - @knocklabs/client@0.12.0-rc.1.0
+  - @knocklabs/client@0.12.0-rc.3.0
 
 ## 0.4.0
 

package/dist/cjs/modules/feed/hooks/useNotificationStore.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const i=require("zustand");function n(e,t){const o=i.useStore(e.store);return u=>{const r=u??t;return r?r(o):o}}function s(e,t){return n(e,t)}exports.default=s;exports.useCreateNotificationStore=n;
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const n=require("zustand");function r(e){return u=>n.useStore(e.store,u??(t=>t))}function s(e,o){return r(e)(o??(t=>t))}exports.default=s;exports.useCreateNotificationStore=r;
 //# sourceMappingURL=useNotificationStore.js.map

package/dist/cjs/modules/feed/hooks/useNotificationStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"useNotificationStore.js","sources":["../../../../../src/modules/feed/hooks/useNotificationStore.ts"],"sourcesContent":["import { Feed, type FeedStoreState } from \"@knocklabs/client\";\nimport { type StoreApi, type UseBoundStore, useStore } from \"zustand\";\n\n// A hook designed to create a `UseBoundStore` instance.\n// https://zustand.docs.pmnd.rs/guides/typescript#bounded-usestore-hook-for-vanilla-stores\nfunction useCreateNotificationStore(\n  feedClient: Feed,\n): UseBoundStore<StoreApi<FeedStoreState>>;\nfunction useCreateNotificationStore<T, U = T>(\n  feedClient: Feed,\n  externalSelector: (state: FeedStoreState) => U,\n): U;\n/**\n * Access a Bounded Store instance\n * Allow passing a selector down from useCreateNotificationStore OR useNotificationStore\n * We'll favor the the one passed later outside of useCreateNotificationStore instantiation\n */\nfunction useCreateNotificationStore<T, U = T>(\n  feedClient: Feed,\n  externalSelector?: (state: FeedStoreState) => U,\n) {\n  const store = useStore(feedClient.store);\n\n  return (selector?: (state: FeedStoreState) => U) => {\n    const innerSelector = selector ?? externalSelector;\n    return innerSelector ? innerSelector(store) : store;\n  };\n}\n\n/**\n * A hook used to access content within the notification store.\n *\n * A selector can be used to access a subset of the store state.\n *\n * @example\n *\n * ```ts\n * const { items, metadata } = useNotificationStore(feedClient, (state) => ({\n *   items: state.items,\n *   metadata: state.metadata,\n * }));\n * ```\n */\nfunction useNotificationStore(\n  feedClient: Feed,\n): UseBoundStore<StoreApi<FeedStoreState>>;\nfunction useNotificationStore<T>(\n  feedClient: Feed,\n  selector: (state: FeedStoreState) => T,\n): T;\nfunction useNotificationStore<T, U = T>(\n  feedClient: Feed,\n  selector?: (state: FeedStoreState) => U,\n) {\n  return useCreateNotificationStore(feedClient, selector!);\n}\n\nexport { useCreateNotificationStore };\nexport default useNotificationStore;\n"],"names":["useCreateNotificationStore","feedClient","externalSelector","store","useStore","selector","innerSelector","useNotificationStore"],"mappings":"uIAiBA,SAASA,EACPC,EACAC,EACA,CACMC,MAAAA,EAAQC,EAAAA,SAASH,EAAWE,KAAK,EAEvC,OAAQE,GAA4C,CAClD,MAAMC,EAAgBD,GAAYH,EAC3BI,OAAAA,EAAgBA,EAAcH,CAAK,EAAIA,CAChD,CACF,CAuBA,SAASI,EACPN,EACAI,EACA,CACOL,OAAAA,EAA2BC,EAAYI,CAAS,CACzD"}
+{"version":3,"file":"useNotificationStore.js","sources":["../../../../../src/modules/feed/hooks/useNotificationStore.ts"],"sourcesContent":["import { Feed, type FeedStoreState } from \"@knocklabs/client\";\nimport { type StoreApi, type UseBoundStore, useStore } from \"zustand\";\n\nexport type Selector<T> = (state: FeedStoreState) => T;\n\n/**\n * Access a Bounded Store instance by converting our vanilla store to a UseBoundStore\n * https://zustand.docs.pmnd.rs/guides/typescript#bounded-usestore-hook-for-vanilla-stores\n * Allow passing a selector down from useCreateNotificationStore OR useNotificationStore\n * We'll favor the the one passed later outside of useCreateNotificationStore instantiation\n */\nfunction useCreateNotificationStore<T>(\n  feedClient: Feed,\n): UseBoundStore<StoreApi<FeedStoreState>> {\n  // Keep selector optional for external use\n  // useStore requires a selector so we'll pass in a default one when not provided\n  const useBoundedStore = (selector?: Selector<T>) =>\n    useStore(feedClient.store, selector ?? ((state) => state as T));\n  return useBoundedStore as UseBoundStore<StoreApi<FeedStoreState>>;\n}\n\n/**\n * A hook used to access content within the notification store.\n *\n * @example\n *\n * ```ts\n * const { items, metadata } = useNotificationStore(feedClient);\n * ```\n *\n * A selector can be used to access a subset of the store state.\n *\n * @example\n *\n * ```ts\n * const { items, metadata } = useNotificationStore(feedClient, (state) => ({\n *   items: state.items,\n *   metadata: state.metadata,\n * }));\n * ```\n */\nfunction useNotificationStore(feedClient: Feed): FeedStoreState;\nfunction useNotificationStore<T>(feedClient: Feed, selector: Selector<T>): T;\nfunction useNotificationStore<T>(\n  feedClient: Feed,\n  selector?: Selector<T>,\n): T | FeedStoreState {\n  const useStoreLocal = useCreateNotificationStore(feedClient);\n  return useStoreLocal(selector ?? ((state) => state as T));\n}\n\nexport { useCreateNotificationStore };\nexport default useNotificationStore;\n"],"names":["useCreateNotificationStore","feedClient","useBoundedStore","selector","useStore","store","state","useNotificationStore","useStoreLocal"],"mappings":"uIAWA,SAASA,EACPC,EACyC,CAKlCC,OAFkBC,GACvBC,WAASH,EAAWI,MAAOF,OAAwBG,EAAW,CAElE,CAwBA,SAASC,EACPN,EACAE,EACoB,CAEbK,OADeR,EAA2BC,CAAU,EACtCE,IAAcG,GAAUA,EAAW,CAC1D"}

package/dist/esm/modules/feed/hooks/useNotificationStore.mjs

@@ -1,16 +1,12 @@
-import { useStore as i } from "zustand";
-function u(t, e) {
-  const o = i(t.store);
-  return (n) => {
-    const r = n ?? e;
-    return r ? r(o) : o;
-  };
+import { useStore as u } from "zustand";
+function n(e) {
+  return (r) => u(e.store, r ?? ((o) => o));
 }
-function c(t, e) {
-  return u(t, e);
+function i(e, t) {
+  return n(e)(t ?? ((o) => o));
 }
 export {
-  c as default,
-  u as useCreateNotificationStore
+  i as default,
+  n as useCreateNotificationStore
 };
 //# sourceMappingURL=useNotificationStore.mjs.map

package/dist/esm/modules/feed/hooks/useNotificationStore.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"useNotificationStore.mjs","sources":["../../../../../src/modules/feed/hooks/useNotificationStore.ts"],"sourcesContent":["import { Feed, type FeedStoreState } from \"@knocklabs/client\";\nimport { type StoreApi, type UseBoundStore, useStore } from \"zustand\";\n\n// A hook designed to create a `UseBoundStore` instance.\n// https://zustand.docs.pmnd.rs/guides/typescript#bounded-usestore-hook-for-vanilla-stores\nfunction useCreateNotificationStore(\n  feedClient: Feed,\n): UseBoundStore<StoreApi<FeedStoreState>>;\nfunction useCreateNotificationStore<T, U = T>(\n  feedClient: Feed,\n  externalSelector: (state: FeedStoreState) => U,\n): U;\n/**\n * Access a Bounded Store instance\n * Allow passing a selector down from useCreateNotificationStore OR useNotificationStore\n * We'll favor the the one passed later outside of useCreateNotificationStore instantiation\n */\nfunction useCreateNotificationStore<T, U = T>(\n  feedClient: Feed,\n  externalSelector?: (state: FeedStoreState) => U,\n) {\n  const store = useStore(feedClient.store);\n\n  return (selector?: (state: FeedStoreState) => U) => {\n    const innerSelector = selector ?? externalSelector;\n    return innerSelector ? innerSelector(store) : store;\n  };\n}\n\n/**\n * A hook used to access content within the notification store.\n *\n * A selector can be used to access a subset of the store state.\n *\n * @example\n *\n * ```ts\n * const { items, metadata } = useNotificationStore(feedClient, (state) => ({\n *   items: state.items,\n *   metadata: state.metadata,\n * }));\n * ```\n */\nfunction useNotificationStore(\n  feedClient: Feed,\n): UseBoundStore<StoreApi<FeedStoreState>>;\nfunction useNotificationStore<T>(\n  feedClient: Feed,\n  selector: (state: FeedStoreState) => T,\n): T;\nfunction useNotificationStore<T, U = T>(\n  feedClient: Feed,\n  selector?: (state: FeedStoreState) => U,\n) {\n  return useCreateNotificationStore(feedClient, selector!);\n}\n\nexport { useCreateNotificationStore };\nexport default useNotificationStore;\n"],"names":["useCreateNotificationStore","feedClient","externalSelector","store","useStore","selector","innerSelector","useNotificationStore"],"mappings":";AAiBA,SAASA,EACPC,GACAC,GACA;AACMC,QAAAA,IAAQC,EAASH,EAAWE,KAAK;AAEvC,SAAO,CAACE,MAA4C;AAClD,UAAMC,IAAgBD,KAAYH;AAC3BI,WAAAA,IAAgBA,EAAcH,CAAK,IAAIA;AAAAA,EAChD;AACF;AAuBA,SAASI,EACPN,GACAI,GACA;AACOL,SAAAA,EAA2BC,GAAYI,CAAS;AACzD;"}
+{"version":3,"file":"useNotificationStore.mjs","sources":["../../../../../src/modules/feed/hooks/useNotificationStore.ts"],"sourcesContent":["import { Feed, type FeedStoreState } from \"@knocklabs/client\";\nimport { type StoreApi, type UseBoundStore, useStore } from \"zustand\";\n\nexport type Selector<T> = (state: FeedStoreState) => T;\n\n/**\n * Access a Bounded Store instance by converting our vanilla store to a UseBoundStore\n * https://zustand.docs.pmnd.rs/guides/typescript#bounded-usestore-hook-for-vanilla-stores\n * Allow passing a selector down from useCreateNotificationStore OR useNotificationStore\n * We'll favor the the one passed later outside of useCreateNotificationStore instantiation\n */\nfunction useCreateNotificationStore<T>(\n  feedClient: Feed,\n): UseBoundStore<StoreApi<FeedStoreState>> {\n  // Keep selector optional for external use\n  // useStore requires a selector so we'll pass in a default one when not provided\n  const useBoundedStore = (selector?: Selector<T>) =>\n    useStore(feedClient.store, selector ?? ((state) => state as T));\n  return useBoundedStore as UseBoundStore<StoreApi<FeedStoreState>>;\n}\n\n/**\n * A hook used to access content within the notification store.\n *\n * @example\n *\n * ```ts\n * const { items, metadata } = useNotificationStore(feedClient);\n * ```\n *\n * A selector can be used to access a subset of the store state.\n *\n * @example\n *\n * ```ts\n * const { items, metadata } = useNotificationStore(feedClient, (state) => ({\n *   items: state.items,\n *   metadata: state.metadata,\n * }));\n * ```\n */\nfunction useNotificationStore(feedClient: Feed): FeedStoreState;\nfunction useNotificationStore<T>(feedClient: Feed, selector: Selector<T>): T;\nfunction useNotificationStore<T>(\n  feedClient: Feed,\n  selector?: Selector<T>,\n): T | FeedStoreState {\n  const useStoreLocal = useCreateNotificationStore(feedClient);\n  return useStoreLocal(selector ?? ((state) => state as T));\n}\n\nexport { useCreateNotificationStore };\nexport default useNotificationStore;\n"],"names":["useCreateNotificationStore","feedClient","useBoundedStore","selector","useStore","store","state","useNotificationStore","useStoreLocal"],"mappings":";AAWA,SAASA,EACPC,GACyC;AAKlCC,SAFiBA,CAACC,MACvBC,EAASH,EAAWI,OAAOF,MAAcG,OAAUA,EAAW;AAElE;AAwBA,SAASC,EACPN,GACAE,GACoB;AAEbK,SADeR,EAA2BC,CAAU,EACtCE,MAAcG,CAAAA,MAAUA,EAAW;AAC1D;"}

package/dist/types/modules/feed/hooks/index.d.ts

@@ -1,4 +1,4 @@
 export { default as useNotifications } from './useNotifications';
 export { default as useFeedSettings } from './useFeedSettings';
-export { default as useNotificationStore, useCreateNotificationStore, } from './useNotificationStore';
+export { default as useNotificationStore, useCreateNotificationStore, type Selector, } from './useNotificationStore';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/modules/feed/hooks/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/modules/feed/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EACL,OAAO,IAAI,oBAAoB,EAC/B,0BAA0B,GAC3B,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/modules/feed/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EACL,OAAO,IAAI,oBAAoB,EAC/B,0BAA0B,EAC1B,KAAK,QAAQ,GACd,MAAM,wBAAwB,CAAC"}

package/dist/types/modules/feed/hooks/useNotificationStore.d.ts

@@ -1,10 +1,22 @@
 import { Feed, FeedStoreState } from '@knocklabs/client';
 import { StoreApi, UseBoundStore } from 'zustand';
-declare function useCreateNotificationStore(feedClient: Feed): UseBoundStore<StoreApi<FeedStoreState>>;
-declare function useCreateNotificationStore<T, U = T>(feedClient: Feed, externalSelector: (state: FeedStoreState) => U): U;
+export type Selector<T> = (state: FeedStoreState) => T;
+/**
+ * Access a Bounded Store instance by converting our vanilla store to a UseBoundStore
+ * https://zustand.docs.pmnd.rs/guides/typescript#bounded-usestore-hook-for-vanilla-stores
+ * Allow passing a selector down from useCreateNotificationStore OR useNotificationStore
+ * We'll favor the the one passed later outside of useCreateNotificationStore instantiation
+ */
+declare function useCreateNotificationStore<T>(feedClient: Feed): UseBoundStore<StoreApi<FeedStoreState>>;
 /**
  * A hook used to access content within the notification store.
  *
+ * @example
+ *
+ * ```ts
+ * const { items, metadata } = useNotificationStore(feedClient);
+ * ```
+ *
  * A selector can be used to access a subset of the store state.
  *
  * @example
@@ -16,8 +28,8 @@ declare function useCreateNotificationStore<T, U = T>(feedClient: Feed, external
  * }));
  * ```
  */
-declare function useNotificationStore(feedClient: Feed): UseBoundStore<StoreApi<FeedStoreState>>;
-declare function useNotificationStore<T>(feedClient: Feed, selector: (state: FeedStoreState) => T): T;
+declare function useNotificationStore(feedClient: Feed): FeedStoreState;
+declare function useNotificationStore<T>(feedClient: Feed, selector: Selector<T>): T;
 export { useCreateNotificationStore };
 export default useNotificationStore;
 //# sourceMappingURL=useNotificationStore.d.ts.map

package/dist/types/modules/feed/hooks/useNotificationStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useNotificationStore.d.ts","sourceRoot":"","sources":["../../../../../src/modules/feed/hooks/useNotificationStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,aAAa,EAAY,MAAM,SAAS,CAAC;AAItE,iBAAS,0BAA0B,CACjC,UAAU,EAAE,IAAI,GACf,aAAa,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC;AAC3C,iBAAS,0BAA0B,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAC1C,UAAU,EAAE,IAAI,EAChB,gBAAgB,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,CAAC,GAC7C,CAAC,CAAC;AAkBL;;;;;;;;;;;;;GAaG;AACH,iBAAS,oBAAoB,CAC3B,UAAU,EAAE,IAAI,GACf,aAAa,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC;AAC3C,iBAAS,oBAAoB,CAAC,CAAC,EAC7B,UAAU,EAAE,IAAI,EAChB,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,CAAC,GACrC,CAAC,CAAC;AAQL,OAAO,EAAE,0BAA0B,EAAE,CAAC;AACtC,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"useNotificationStore.d.ts","sourceRoot":"","sources":["../../../../../src/modules/feed/hooks/useNotificationStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,aAAa,EAAY,MAAM,SAAS,CAAC;AAEtE,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,cAAc,KAAK,CAAC,CAAC;AAEvD;;;;;GAKG;AACH,iBAAS,0BAA0B,CAAC,CAAC,EACnC,UAAU,EAAE,IAAI,GACf,aAAa,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAMzC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,iBAAS,oBAAoB,CAAC,UAAU,EAAE,IAAI,GAAG,cAAc,CAAC;AAChE,iBAAS,oBAAoB,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAS7E,OAAO,EAAE,0BAA0B,EAAE,CAAC;AACtC,eAAe,oBAAoB,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@knocklabs/react-core",
   "description": "A set of React components to build notification experiences powered by Knock",
   "author": "@knocklabs",
-  "version": "0.5.0-rc.1.0",
+  "version": "0.5.0-rc.3.0",
   "license": "MIT",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.mjs",
@@ -49,7 +49,7 @@
     "react": "^16.11.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
   },
   "dependencies": {
-    "@knocklabs/client": "^0.12.0-rc.1.0",
+    "@knocklabs/client": "^0.12.0-rc.3.0",
     "date-fns": "^4.0.0",
     "swr": "^2.3.2",
     "zustand": "^4.5.6"

package/src/modules/feed/hooks/index.ts

@@ -3,4 +3,5 @@ export { default as useFeedSettings } from "./useFeedSettings";
 export {
   default as useNotificationStore,
   useCreateNotificationStore,
+  type Selector,
 } from "./useNotificationStore";

package/src/modules/feed/hooks/useNotificationStore.ts

@@ -1,35 +1,33 @@
 import { Feed, type FeedStoreState } from "@knocklabs/client";
 import { type StoreApi, type UseBoundStore, useStore } from "zustand";
 
-// A hook designed to create a `UseBoundStore` instance.
-// https://zustand.docs.pmnd.rs/guides/typescript#bounded-usestore-hook-for-vanilla-stores
-function useCreateNotificationStore(
-  feedClient: Feed,
-): UseBoundStore<StoreApi<FeedStoreState>>;
-function useCreateNotificationStore<T, U = T>(
-  feedClient: Feed,
-  externalSelector: (state: FeedStoreState) => U,
-): U;
+export type Selector<T> = (state: FeedStoreState) => T;
+
 /**
- * Access a Bounded Store instance
+ * Access a Bounded Store instance by converting our vanilla store to a UseBoundStore
+ * https://zustand.docs.pmnd.rs/guides/typescript#bounded-usestore-hook-for-vanilla-stores
  * Allow passing a selector down from useCreateNotificationStore OR useNotificationStore
  * We'll favor the the one passed later outside of useCreateNotificationStore instantiation
  */
-function useCreateNotificationStore<T, U = T>(
+function useCreateNotificationStore<T>(
   feedClient: Feed,
-  externalSelector?: (state: FeedStoreState) => U,
-) {
-  const store = useStore(feedClient.store);
-
-  return (selector?: (state: FeedStoreState) => U) => {
-    const innerSelector = selector ?? externalSelector;
-    return innerSelector ? innerSelector(store) : store;
-  };
+): UseBoundStore<StoreApi<FeedStoreState>> {
+  // Keep selector optional for external use
+  // useStore requires a selector so we'll pass in a default one when not provided
+  const useBoundedStore = (selector?: Selector<T>) =>
+    useStore(feedClient.store, selector ?? ((state) => state as T));
+  return useBoundedStore as UseBoundStore<StoreApi<FeedStoreState>>;
 }
 
 /**
  * A hook used to access content within the notification store.
  *
+ * @example
+ *
+ * ```ts
+ * const { items, metadata } = useNotificationStore(feedClient);
+ * ```
+ *
  * A selector can be used to access a subset of the store state.
  *
  * @example
@@ -41,18 +39,14 @@ function useCreateNotificationStore<T, U = T>(
  * }));
  * ```
  */
-function useNotificationStore(
-  feedClient: Feed,
-): UseBoundStore<StoreApi<FeedStoreState>>;
+function useNotificationStore(feedClient: Feed): FeedStoreState;
+function useNotificationStore<T>(feedClient: Feed, selector: Selector<T>): T;
 function useNotificationStore<T>(
   feedClient: Feed,
-  selector: (state: FeedStoreState) => T,
-): T;
-function useNotificationStore<T, U = T>(
-  feedClient: Feed,
-  selector?: (state: FeedStoreState) => U,
-) {
-  return useCreateNotificationStore(feedClient, selector!);
+  selector?: Selector<T>,
+): T | FeedStoreState {
+  const useStoreLocal = useCreateNotificationStore(feedClient);
+  return useStoreLocal(selector ?? ((state) => state as T));
 }
 
 export { useCreateNotificationStore };