@knocklabs/react-core 0.5.0-rc.0 → 0.5.0-rc.2.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## 0.5.0-rc.0
+## 0.5.0-rc.2.0
 
 ### Minor Changes
 
@@ -9,7 +9,7 @@
 ### Patch Changes
 
 - Updated dependencies [0fc5f2d]
-  - @knocklabs/client@0.12.0-rc.0
+  - @knocklabs/client@0.12.0-rc.2.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"}});function r(e){return e.store}function u(e,t){const o=r(e)();return t?t(o):o}exports.default=u;exports.useCreateNotificationStore=r;
+"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;
 //# 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\";\n\n// A hook designed to create a `UseBoundStore` instance.\n// We used to have to do some extra work to do this, but\n// with zustand updated we can just use the feedClient.store\n// directly.\nfunction useCreateNotificationStore(feedClient: Feed) {\n  return feedClient.store;\n}\n\n/**\n * Below we do some typing to specify that if a selector is provided,\n * the return type will be the type returned by the selector.\n *\n * This is important because the store state type is not always the same as the\n * return type of the selector.\n *\n */\n\ntype StateSelector<T, U> = (state: T) => U;\ntype FeedStoreStateSelector<T> = StateSelector<FeedStoreState, T>;\n\n// Function overload for when no selector is provided\nfunction useNotificationStore(feedClient: Feed): FeedStoreState;\n\n// Function overload for when a selector is provided\nfunction useNotificationStore<T>(\n  feedClient: Feed,\n  selector: FeedStoreStateSelector<T>,\n): T;\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<T>(\n  feedClient: Feed,\n  selector?: FeedStoreStateSelector<T>,\n): T | FeedStoreState {\n  const useStore = useCreateNotificationStore(feedClient);\n  const storeState = useStore();\n  return selector ? selector(storeState) : storeState;\n}\n\nexport { useCreateNotificationStore };\nexport default useNotificationStore;\n"],"names":["useCreateNotificationStore","feedClient","store","useNotificationStore","selector","storeState"],"mappings":"4GAMA,SAASA,EAA2BC,EAAkB,CACpD,OAAOA,EAAWC,KACpB,CAqCA,SAASC,EACPF,EACAG,EACoB,CAEpB,MAAMC,EADWL,EAA2BC,CAAU,EAC1B,EACrBG,OAAAA,EAAWA,EAASC,CAAU,EAAIA,CAC3C"}
+{"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"}

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

@@ -1,12 +1,16 @@
-function r(t) {
-  return t.store;
-}
+import { useStore as i } from "zustand";
 function u(t, e) {
-  const o = r(t)();
-  return e ? e(o) : o;
+  const o = i(t.store);
+  return (n) => {
+    const r = n ?? e;
+    return r ? r(o) : o;
+  };
+}
+function c(t, e) {
+  return u(t, e);
 }
 export {
-  u as default,
-  r as useCreateNotificationStore
+  c as default,
+  u 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\";\n\n// A hook designed to create a `UseBoundStore` instance.\n// We used to have to do some extra work to do this, but\n// with zustand updated we can just use the feedClient.store\n// directly.\nfunction useCreateNotificationStore(feedClient: Feed) {\n  return feedClient.store;\n}\n\n/**\n * Below we do some typing to specify that if a selector is provided,\n * the return type will be the type returned by the selector.\n *\n * This is important because the store state type is not always the same as the\n * return type of the selector.\n *\n */\n\ntype StateSelector<T, U> = (state: T) => U;\ntype FeedStoreStateSelector<T> = StateSelector<FeedStoreState, T>;\n\n// Function overload for when no selector is provided\nfunction useNotificationStore(feedClient: Feed): FeedStoreState;\n\n// Function overload for when a selector is provided\nfunction useNotificationStore<T>(\n  feedClient: Feed,\n  selector: FeedStoreStateSelector<T>,\n): T;\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<T>(\n  feedClient: Feed,\n  selector?: FeedStoreStateSelector<T>,\n): T | FeedStoreState {\n  const useStore = useCreateNotificationStore(feedClient);\n  const storeState = useStore();\n  return selector ? selector(storeState) : storeState;\n}\n\nexport { useCreateNotificationStore };\nexport default useNotificationStore;\n"],"names":["useCreateNotificationStore","feedClient","store","useNotificationStore","selector","storeState"],"mappings":"AAMA,SAASA,EAA2BC,GAAkB;AACpD,SAAOA,EAAWC;AACpB;AAqCA,SAASC,EACPF,GACAG,GACoB;AAEpB,QAAMC,IADWL,EAA2BC,CAAU,EAC1B;AACrBG,SAAAA,IAAWA,EAASC,CAAU,IAAIA;AAC3C;"}
+{"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;"}

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

@@ -1,17 +1,23 @@
 import { Feed, FeedStoreState } from '@knocklabs/client';
-declare function useCreateNotificationStore(feedClient: Feed): import('zustand').UseBoundStore<import('zustand').StoreApi<FeedStoreState>>;
+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;
 /**
- * Below we do some typing to specify that if a selector is provided,
- * the return type will be the type returned by the selector.
+ * A hook used to access content within the notification store.
  *
- * This is important because the store state type is not always the same as the
- * return type of the selector.
+ * A selector can be used to access a subset of the store state.
  *
+ * @example
+ *
+ * ```ts
+ * const { items, metadata } = useNotificationStore(feedClient, (state) => ({
+ *   items: state.items,
+ *   metadata: state.metadata,
+ * }));
+ * ```
  */
-type StateSelector<T, U> = (state: T) => U;
-type FeedStoreStateSelector<T> = StateSelector<FeedStoreState, T>;
-declare function useNotificationStore(feedClient: Feed): FeedStoreState;
-declare function useNotificationStore<T>(feedClient: Feed, selector: FeedStoreStateSelector<T>): T;
+declare function useNotificationStore(feedClient: Feed): UseBoundStore<StoreApi<FeedStoreState>>;
+declare function useNotificationStore<T>(feedClient: Feed, selector: (state: FeedStoreState) => 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;AAM9D,iBAAS,0BAA0B,CAAC,UAAU,EAAE,IAAI,+EAEnD;AAED;;;;;;;GAOG;AAEH,KAAK,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;AAC3C,KAAK,sBAAsB,CAAC,CAAC,IAAI,aAAa,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;AAGlE,iBAAS,oBAAoB,CAAC,UAAU,EAAE,IAAI,GAAG,cAAc,CAAC;AAGhE,iBAAS,oBAAoB,CAAC,CAAC,EAC7B,UAAU,EAAE,IAAI,EAChB,QAAQ,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAClC,CAAC,CAAC;AAyBL,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;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"}

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.0",
+  "version": "0.5.0-rc.2.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.0",
+    "@knocklabs/client": "^0.12.0-rc.2.0",
     "date-fns": "^4.0.0",
     "swr": "^2.3.2",
     "zustand": "^4.5.6"

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

@@ -1,33 +1,31 @@
 import { Feed, type FeedStoreState } from "@knocklabs/client";
+import { type StoreApi, type UseBoundStore, useStore } from "zustand";
 
 // A hook designed to create a `UseBoundStore` instance.
-// We used to have to do some extra work to do this, but
-// with zustand updated we can just use the feedClient.store
-// directly.
-function useCreateNotificationStore(feedClient: Feed) {
-  return feedClient.store;
-}
-
+// 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;
 /**
- * Below we do some typing to specify that if a selector is provided,
- * the return type will be the type returned by the selector.
- *
- * This is important because the store state type is not always the same as the
- * return type of the selector.
- *
+ * Access a Bounded Store instance
+ * Allow passing a selector down from useCreateNotificationStore OR useNotificationStore
+ * We'll favor the the one passed later outside of useCreateNotificationStore instantiation
  */
-
-type StateSelector<T, U> = (state: T) => U;
-type FeedStoreStateSelector<T> = StateSelector<FeedStoreState, T>;
-
-// Function overload for when no selector is provided
-function useNotificationStore(feedClient: Feed): FeedStoreState;
-
-// Function overload for when a selector is provided
-function useNotificationStore<T>(
+function useCreateNotificationStore<T, U = T>(
   feedClient: Feed,
-  selector: FeedStoreStateSelector<T>,
-): T;
+  externalSelector?: (state: FeedStoreState) => U,
+) {
+  const store = useStore(feedClient.store);
+
+  return (selector?: (state: FeedStoreState) => U) => {
+    const innerSelector = selector ?? externalSelector;
+    return innerSelector ? innerSelector(store) : store;
+  };
+}
 
 /**
  * A hook used to access content within the notification store.
@@ -43,13 +41,18 @@ function useNotificationStore<T>(
  * }));
  * ```
  */
+function useNotificationStore(
+  feedClient: Feed,
+): UseBoundStore<StoreApi<FeedStoreState>>;
 function useNotificationStore<T>(
   feedClient: Feed,
-  selector?: FeedStoreStateSelector<T>,
-): T | FeedStoreState {
-  const useStore = useCreateNotificationStore(feedClient);
-  const storeState = useStore();
-  return selector ? selector(storeState) : storeState;
+  selector: (state: FeedStoreState) => T,
+): T;
+function useNotificationStore<T, U = T>(
+  feedClient: Feed,
+  selector?: (state: FeedStoreState) => U,
+) {
+  return useCreateNotificationStore(feedClient, selector!);
 }
 
 export { useCreateNotificationStore };