@knocklabs/react-core 0.6.15 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.7.0
+
+### Minor Changes
+
+- 2a0b3e2: Adds support for inline user `identify` calls when authenticating a user via the Knock client.
+  You can now pass a `user` object, for example `{ id: "123" }`, directly to the `authenticate` function.
+  Additional properties can also be included to update the user record, such as `{ id: "123", name: "Knock" }`.
+
+  This update also applies to `KnockProvider`, where you can now pass a `user` prop instead of a `userId` prop to achieve the same behavior.
+
+### Patch Changes
+
+- Updated dependencies [2a0b3e2]
+  - @knocklabs/client@0.15.0
+
 ## 0.6.15
 
 ### Patch Changes

package/dist/cjs/modules/core/context/KnockProvider.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const f=require("react"),b=require("../../i18n/context/KnockI18nProvider.js"),K=require("../hooks/useAuthenticatedKnockClient.js");require("fast-deep-equal");function m(e){if(e&&typeof e=="object"&&"default"in e)return e;const n=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(e){for(const t in e)if(t!=="default"){const r=Object.getOwnPropertyDescriptor(e,t);Object.defineProperty(n,t,r.get?r:{enumerable:!0,get:()=>e[t]})}}return n.default=e,Object.freeze(n)}const o=m(f),i=o.createContext(null),P=({apiKey:e,host:n,logLevel:t,userId:r,userToken:s,onUserTokenExpiring:c,timeBeforeExpirationInMs:u,children:a,i18n:l})=>{const d=o.useMemo(()=>({host:n,onUserTokenExpiring:c,timeBeforeExpirationInMs:u,logLevel:t}),[n,c,u,t]),k=K(e??"",r,s,d);return o.createElement(i.Provider,{value:{knock:k}},o.createElement(b.KnockI18nProvider,{i18n:l},a))},p=()=>{const e=o.useContext(i);if(!e)throw new Error("useKnockClient must be used within a KnockProvider");return e.knock};exports.KnockProvider=P;exports.useKnockClient=p;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const b=require("react"),K=require("../../i18n/context/KnockI18nProvider.js"),P=require("../hooks/useAuthenticatedKnockClient.js");require("fast-deep-equal");function m(e){if(e&&typeof e=="object"&&"default"in e)return e;const n=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(e){for(const t in e)if(t!=="default"){const o=Object.getOwnPropertyDescriptor(e,t);Object.defineProperty(n,t,o.get?o:{enumerable:!0,get:()=>e[t]})}}return n.default=e,Object.freeze(n)}const r=m(b),a=r.createContext(null),v=({apiKey:e,host:n,logLevel:t,userToken:o,onUserTokenExpiring:u,timeBeforeExpirationInMs:i,children:s,i18n:l,...c})=>{const d=(c==null?void 0:c.user)||(c==null?void 0:c.userId),k=r.useMemo(()=>({host:n,onUserTokenExpiring:u,timeBeforeExpirationInMs:i,logLevel:t}),[n,u,i,t]),f=P(e??"",d,o,k);return r.createElement(a.Provider,{value:{knock:f}},r.createElement(K.KnockI18nProvider,{i18n:l},s))},C=()=>{const e=r.useContext(a);if(!e)throw new Error("useKnockClient must be used within a KnockProvider");return e.knock};exports.KnockProvider=v;exports.useKnockClient=C;
 //# sourceMappingURL=KnockProvider.js.map

package/dist/cjs/modules/core/context/KnockProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"KnockProvider.js","sources":["../../../../../src/modules/core/context/KnockProvider.tsx"],"sourcesContent":["import Knock, { AuthenticateOptions, LogLevel } from \"@knocklabs/client\";\nimport * as React from \"react\";\nimport { PropsWithChildren } from \"react\";\n\nimport { I18nContent, KnockI18nProvider } from \"../../i18n\";\nimport { useAuthenticatedKnockClient } from \"../hooks\";\n\nexport interface KnockProviderState {\n  knock: Knock;\n}\n\nconst KnockContext = React.createContext<KnockProviderState | null>(null);\n\nexport interface KnockProviderProps {\n  // Knock client props\n  apiKey: string | undefined;\n  host?: string;\n  // Authentication props\n  userId: Knock[\"userId\"];\n  userToken?: Knock[\"userToken\"];\n  onUserTokenExpiring?: AuthenticateOptions[\"onUserTokenExpiring\"];\n  timeBeforeExpirationInMs?: AuthenticateOptions[\"timeBeforeExpirationInMs\"];\n  // i18n translations\n  i18n?: I18nContent;\n  logLevel?: LogLevel;\n}\n\nexport const KnockProvider: React.FC<PropsWithChildren<KnockProviderProps>> = ({\n  apiKey,\n  host,\n  logLevel,\n  userId,\n  userToken,\n  onUserTokenExpiring,\n  timeBeforeExpirationInMs,\n  children,\n  i18n,\n}) => {\n  // We memoize the options here so that we don't create a new object on every re-render\n  const authenticateOptions = React.useMemo(\n    () => ({\n      host,\n      onUserTokenExpiring,\n      timeBeforeExpirationInMs,\n      logLevel,\n    }),\n    [host, onUserTokenExpiring, timeBeforeExpirationInMs, logLevel],\n  );\n\n  const knock = useAuthenticatedKnockClient(\n    apiKey ?? \"\",\n    userId,\n    userToken,\n    authenticateOptions,\n  );\n\n  return (\n    <KnockContext.Provider value={{ knock }}>\n      <KnockI18nProvider i18n={i18n}>{children}</KnockI18nProvider>\n    </KnockContext.Provider>\n  );\n};\n\nexport const useKnockClient = (): Knock => {\n  const context = React.useContext(KnockContext);\n  if (!context) {\n    throw new Error(\"useKnockClient must be used within a KnockProvider\");\n  }\n  return context.knock;\n};\n"],"names":["KnockContext","React","createContext","KnockProvider","apiKey","host","logLevel","userId","userToken","onUserTokenExpiring","timeBeforeExpirationInMs","children","i18n","authenticateOptions","useMemo","knock","useAuthenticatedKnockClient","KnockI18nProvider","useKnockClient","context","useContext","Error"],"mappings":"yjBAWMA,EAAeC,EAAMC,cAAyC,IAAI,EAgB3DC,EAAiEA,CAAC,CAC7EC,OAAAA,EACAC,KAAAA,EACAC,SAAAA,EACAC,OAAAA,EACAC,UAAAA,EACAC,oBAAAA,EACAC,yBAAAA,EACAC,SAAAA,EACAC,KAAAA,CACF,IAAM,CAEEC,MAAAA,EAAsBZ,EAAMa,QAChC,KAAO,CACLT,KAAAA,EACAI,oBAAAA,EACAC,yBAAAA,EACAJ,SAAAA,IAEF,CAACD,EAAMI,EAAqBC,EAA0BJ,CAAQ,CAChE,EAEMS,EAAQC,EACZZ,GAAU,GACVG,EACAC,EACAK,CACF,EAEA,OACGZ,EAAA,cAAAD,EAAa,SAAb,CAAsB,MAAO,CAAEe,MAAAA,CAAAA,CAC9B,EAAAd,EAAA,cAACgB,EAAAA,kBAAkB,CAAA,KAAAL,CAAA,EAAaD,CAAS,CAC3C,CAEJ,EAEaO,EAAiBA,IAAa,CACnCC,MAAAA,EAAUlB,EAAMmB,WAAWpB,CAAY,EAC7C,GAAI,CAACmB,EACG,MAAA,IAAIE,MAAM,oDAAoD,EAEtE,OAAOF,EAAQJ,KACjB"}
+{"version":3,"file":"KnockProvider.js","sources":["../../../../../src/modules/core/context/KnockProvider.tsx"],"sourcesContent":["import Knock, {\n  AuthenticateOptions,\n  LogLevel,\n  UserWithProperties,\n} from \"@knocklabs/client\";\nimport * as React from \"react\";\nimport { PropsWithChildren } from \"react\";\n\nimport { I18nContent, KnockI18nProvider } from \"../../i18n\";\nimport { useAuthenticatedKnockClient } from \"../hooks\";\n\nexport interface KnockProviderState {\n  knock: Knock;\n}\n\nconst KnockContext = React.createContext<KnockProviderState | null>(null);\n\nexport type KnockProviderProps = {\n  // Knock client props\n  apiKey: string | undefined;\n  host?: string;\n  userToken?: Knock[\"userToken\"];\n  onUserTokenExpiring?: AuthenticateOptions[\"onUserTokenExpiring\"];\n  timeBeforeExpirationInMs?: AuthenticateOptions[\"timeBeforeExpirationInMs\"];\n  // i18n translations\n  i18n?: I18nContent;\n  logLevel?: LogLevel;\n} & (\n  | {\n      /**\n       * @deprecated The `userId` prop is deprecated and will be removed in a future version.\n       * Please pass the `user` prop instead containing an `id` value.\n       * example:\n       * ```ts\n       * <KnockProvider user={{ id: \"user_123\" }}></KnockProvider>\n       * ```\n       */\n      userId: Knock[\"userId\"];\n      user?: never;\n    }\n  | {\n      user: UserWithProperties;\n      /**\n       * @deprecated The `userId` prop is deprecated and will be removed in a future version.\n       * Please pass the `user` prop instead containing an `id` value.\n       * example:\n       * ```ts\n       * <KnockProvider user={{ id: \"user_123\" }}></KnockProvider>\n       * ```\n       */\n      userId?: never;\n    }\n);\n\nexport const KnockProvider: React.FC<PropsWithChildren<KnockProviderProps>> = ({\n  apiKey,\n  host,\n  logLevel,\n  userToken,\n  onUserTokenExpiring,\n  timeBeforeExpirationInMs,\n  children,\n  i18n,\n  ...props\n}) => {\n  const userIdOrUserWithProperties = props?.user || props?.userId;\n\n  // We memoize the options here so that we don't create a new object on every re-render\n  const authenticateOptions = React.useMemo(\n    () => ({\n      host,\n      onUserTokenExpiring,\n      timeBeforeExpirationInMs,\n      logLevel,\n    }),\n    [host, onUserTokenExpiring, timeBeforeExpirationInMs, logLevel],\n  );\n\n  const knock = useAuthenticatedKnockClient(\n    apiKey ?? \"\",\n    userIdOrUserWithProperties,\n    userToken,\n    authenticateOptions,\n  );\n\n  return (\n    <KnockContext.Provider value={{ knock }}>\n      <KnockI18nProvider i18n={i18n}>{children}</KnockI18nProvider>\n    </KnockContext.Provider>\n  );\n};\n\nexport const useKnockClient = (): Knock => {\n  const context = React.useContext(KnockContext);\n  if (!context) {\n    throw new Error(\"useKnockClient must be used within a KnockProvider\");\n  }\n  return context.knock;\n};\n"],"names":["KnockContext","React","createContext","KnockProvider","apiKey","host","logLevel","userToken","onUserTokenExpiring","timeBeforeExpirationInMs","children","i18n","props","userIdOrUserWithProperties","user","userId","authenticateOptions","useMemo","knock","useAuthenticatedKnockClient","KnockI18nProvider","useKnockClient","context","useContext","Error"],"mappings":"yjBAeMA,EAAeC,EAAMC,cAAyC,IAAI,EAuC3DC,EAAiEA,CAAC,CAC7EC,OAAAA,EACAC,KAAAA,EACAC,SAAAA,EACAC,UAAAA,EACAC,oBAAAA,EACAC,yBAAAA,EACAC,SAAAA,EACAC,KAAAA,EACA,GAAGC,CACL,IAAM,CACEC,MAAAA,GAA6BD,GAAAA,YAAAA,EAAOE,QAAQF,GAAAA,YAAAA,EAAOG,QAGnDC,EAAsBf,EAAMgB,QAChC,KAAO,CACLZ,KAAAA,EACAG,oBAAAA,EACAC,yBAAAA,EACAH,SAAAA,IAEF,CAACD,EAAMG,EAAqBC,EAA0BH,CAAQ,CAChE,EAEMY,EAAQC,EACZf,GAAU,GACVS,EACAN,EACAS,CACF,EAEA,OACGf,EAAA,cAAAD,EAAa,SAAb,CAAsB,MAAO,CAAEkB,MAAAA,CAAAA,CAC9B,EAAAjB,EAAA,cAACmB,EAAAA,kBAAkB,CAAA,KAAAT,CAAA,EAAaD,CAAS,CAC3C,CAEJ,EAEaW,EAAiBA,IAAa,CACnCC,MAAAA,EAAUrB,EAAMsB,WAAWvB,CAAY,EAC7C,GAAI,CAACsB,EACG,MAAA,IAAIE,MAAM,oDAAoD,EAEtE,OAAOF,EAAQJ,KACjB"}

package/dist/cjs/modules/core/hooks/useAuthenticatedKnockClient.js

@@ -1,2 +1,2 @@
-"use strict";const s=require("@knocklabs/client"),d=require("react");require("../context/KnockProvider.js");const k=require("./useStableOptions.js");require("date-fns");const l=e=>e&&typeof e=="object"&&"default"in e?e:{default:e},h=l(s),o=l(d);function f(e,r,c,t={}){e.authenticate(r,c,{onUserTokenExpiring:t==null?void 0:t.onUserTokenExpiring,timeBeforeExpirationInMs:t==null?void 0:t.timeBeforeExpirationInMs})}function q(e,r,c,t={}){const a=o.default.useRef(),u=k(t);return o.default.useMemo(()=>{const n=a.current;if(n&&n.isAuthenticated()&&(n.userId!==r||n.userToken!==c))return f(n,r,c,u),n;n&&n.teardown();const i=new h.default(e,{host:u.host,logLevel:u.logLevel});return f(i,r,c,u),a.current=i,i},[e,r,c,u])}module.exports=q;
+"use strict";const q=require("@knocklabs/client"),x=require("react");require("../context/KnockProvider.js");const _=require("./useStableOptions.js");require("date-fns");const i=n=>n&&typeof n=="object"&&"default"in n?n:{default:n},d=i(q),o=i(x);function k(n,t,a,c={}){n.authenticate(t,a,{onUserTokenExpiring:c==null?void 0:c.onUserTokenExpiring,timeBeforeExpirationInMs:c==null?void 0:c.timeBeforeExpirationInMs})}function m(n,t,a,c={}){const l=o.default.useRef(),u=_(c);return o.default.useMemo(()=>{const g=typeof t=="string"?t:t==null?void 0:t.id,e=l.current;if(e&&e.isAuthenticated()&&(e.userId!==g||e.userToken!==a))return k(e,t,a,u),e;e&&e.teardown();const f=new d.default(n,{host:u.host,logLevel:u.logLevel});return k(f,t,a,u),l.current=f,f},[n,t,a,u])}module.exports=m;
 //# sourceMappingURL=useAuthenticatedKnockClient.js.map

package/dist/cjs/modules/core/hooks/useAuthenticatedKnockClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"useAuthenticatedKnockClient.js","sources":["../../../../../src/modules/core/hooks/useAuthenticatedKnockClient.ts"],"sourcesContent":["import Knock, { AuthenticateOptions, KnockOptions } from \"@knocklabs/client\";\nimport React from \"react\";\n\nimport { useStableOptions } from \"../../core\";\n\nfunction authenticateWithOptions(\n  knock: Knock,\n  userId: Knock[\"userId\"],\n  userToken?: Knock[\"userToken\"],\n  options: AuthenticateOptions = {},\n) {\n  knock.authenticate(userId, userToken, {\n    onUserTokenExpiring: options?.onUserTokenExpiring,\n    timeBeforeExpirationInMs: options?.timeBeforeExpirationInMs,\n  });\n}\n\nexport type AuthenticatedKnockClientOptions = KnockOptions &\n  AuthenticateOptions;\n\nfunction useAuthenticatedKnockClient(\n  apiKey: string,\n  userId: Knock[\"userId\"],\n  userToken?: Knock[\"userToken\"],\n  options: AuthenticatedKnockClientOptions = {},\n) {\n  const knockRef = React.useRef<Knock | undefined>();\n  const stableOptions = useStableOptions(options);\n\n  return React.useMemo(() => {\n    const currentKnock = knockRef.current;\n\n    // If the userId and the userToken changes then just reauth\n    if (\n      currentKnock &&\n      currentKnock.isAuthenticated() &&\n      (currentKnock.userId !== userId || currentKnock.userToken !== userToken)\n    ) {\n      authenticateWithOptions(currentKnock, userId, userToken, stableOptions);\n      return currentKnock;\n    }\n\n    if (currentKnock) {\n      currentKnock.teardown();\n    }\n\n    // Otherwise instantiate a new Knock client\n    const knock = new Knock(apiKey, {\n      host: stableOptions.host,\n      logLevel: stableOptions.logLevel,\n    });\n\n    authenticateWithOptions(knock, userId, userToken, stableOptions);\n    knockRef.current = knock;\n\n    return knock;\n  }, [apiKey, userId, userToken, stableOptions]);\n}\n\nexport default useAuthenticatedKnockClient;\n"],"names":["authenticateWithOptions","knock","userId","userToken","options","authenticate","onUserTokenExpiring","timeBeforeExpirationInMs","useAuthenticatedKnockClient","apiKey","knockRef","React","useRef","stableOptions","useStableOptions","useMemo","currentKnock","current","isAuthenticated","teardown","Knock","host","logLevel"],"mappings":"qPAKA,SAASA,EACPC,EACAC,EACAC,EACAC,EAA+B,CAAA,EAC/B,CACMC,EAAAA,aAAaH,EAAQC,EAAW,CACpCG,oBAAqBF,GAAAA,YAAAA,EAASE,oBAC9BC,yBAA0BH,GAAAA,YAAAA,EAASG,wBAAAA,CACpC,CACH,CAKA,SAASC,EACPC,EACAP,EACAC,EACAC,EAA2C,CAAA,EAC3C,CACMM,MAAAA,EAAWC,UAAMC,OAA0B,EAC3CC,EAAgBC,EAAiBV,CAAO,EAEvCO,OAAAA,EAAAA,QAAMI,QAAQ,IAAM,CACzB,MAAMC,EAAeN,EAASO,QAI5BD,GAAAA,GACAA,EAAaE,gBAAgB,IAC5BF,EAAad,SAAWA,GAAUc,EAAab,YAAcA,GAEtCa,OAAAA,EAAAA,EAAcd,EAAQC,EAAWU,CAAa,EAC/DG,EAGLA,GACFA,EAAaG,SAAS,EAIlBlB,MAAAA,EAAQ,IAAImB,EAAAA,QAAMX,EAAQ,CAC9BY,KAAMR,EAAcQ,KACpBC,SAAUT,EAAcS,QAAAA,CACzB,EAEuBrB,OAAAA,EAAAA,EAAOC,EAAQC,EAAWU,CAAa,EAC/DH,EAASO,QAAUhB,EAEZA,GACN,CAACQ,EAAQP,EAAQC,EAAWU,CAAa,CAAC,CAC/C"}
+{"version":3,"file":"useAuthenticatedKnockClient.js","sources":["../../../../../src/modules/core/hooks/useAuthenticatedKnockClient.ts"],"sourcesContent":["import Knock, {\n  AuthenticateOptions,\n  KnockOptions,\n  UserId,\n  UserIdOrUserWithProperties,\n} from \"@knocklabs/client\";\nimport React from \"react\";\n\nimport { useStableOptions } from \"../../core\";\n\nfunction authenticateWithOptions(\n  knock: Knock,\n  userIdOrUserWithProperties: UserIdOrUserWithProperties,\n  userToken?: Knock[\"userToken\"],\n  options: AuthenticateOptions = {},\n) {\n  knock.authenticate(userIdOrUserWithProperties, userToken, {\n    onUserTokenExpiring: options?.onUserTokenExpiring,\n    timeBeforeExpirationInMs: options?.timeBeforeExpirationInMs,\n  });\n}\n\nexport type AuthenticatedKnockClientOptions = KnockOptions &\n  AuthenticateOptions;\n\n/**\n * @deprecated Passing `userId` as a `string` is deprecated and will be removed in a future version.\n * Please pass a `user` object instead containing an `id` value.\n * example:\n * ```ts\n * useAuthenticatedKnockClient(\"pk_test_12345\", { id: \"user_123\" });\n * ```\n */\nfunction useAuthenticatedKnockClient(\n  apiKey: string,\n  userIdOrUserWithProperties: UserId,\n  userToken?: Knock[\"userToken\"],\n  options?: AuthenticatedKnockClientOptions,\n): Knock;\nfunction useAuthenticatedKnockClient(\n  apiKey: string,\n  userIdOrUserWithProperties: UserIdOrUserWithProperties,\n  userToken?: Knock[\"userToken\"],\n  options?: AuthenticatedKnockClientOptions,\n): Knock;\nfunction useAuthenticatedKnockClient(\n  apiKey: string,\n  userIdOrUserWithProperties: UserIdOrUserWithProperties,\n  userToken?: Knock[\"userToken\"],\n  options: AuthenticatedKnockClientOptions = {},\n) {\n  const knockRef = React.useRef<Knock | undefined>();\n  const stableOptions = useStableOptions(options);\n\n  return React.useMemo(() => {\n    const userId =\n      typeof userIdOrUserWithProperties === \"string\"\n        ? userIdOrUserWithProperties\n        : userIdOrUserWithProperties?.id;\n\n    const currentKnock = knockRef.current;\n\n    // If the userId and the userToken changes then just reauth\n    if (\n      currentKnock &&\n      currentKnock.isAuthenticated() &&\n      (currentKnock.userId !== userId || currentKnock.userToken !== userToken)\n    ) {\n      authenticateWithOptions(\n        currentKnock,\n        userIdOrUserWithProperties,\n        userToken,\n        stableOptions,\n      );\n      return currentKnock;\n    }\n\n    if (currentKnock) {\n      currentKnock.teardown();\n    }\n\n    // Otherwise instantiate a new Knock client\n    const knock = new Knock(apiKey, {\n      host: stableOptions.host,\n      logLevel: stableOptions.logLevel,\n    });\n\n    authenticateWithOptions(\n      knock,\n      userIdOrUserWithProperties,\n      userToken,\n      stableOptions,\n    );\n    knockRef.current = knock;\n\n    return knock;\n  }, [apiKey, userIdOrUserWithProperties, userToken, stableOptions]);\n}\n\nexport default useAuthenticatedKnockClient;\n"],"names":["authenticateWithOptions","knock","userIdOrUserWithProperties","userToken","options","authenticate","onUserTokenExpiring","timeBeforeExpirationInMs","useAuthenticatedKnockClient","apiKey","knockRef","React","useRef","stableOptions","useStableOptions","useMemo","userId","id","currentKnock","current","isAuthenticated","teardown","Knock","host","logLevel"],"mappings":"qPAUA,SAASA,EACPC,EACAC,EACAC,EACAC,EAA+B,CAAA,EAC/B,CACMC,EAAAA,aAAaH,EAA4BC,EAAW,CACxDG,oBAAqBF,GAAAA,YAAAA,EAASE,oBAC9BC,yBAA0BH,GAAAA,YAAAA,EAASG,wBAAAA,CACpC,CACH,CAyBA,SAASC,EACPC,EACAP,EACAC,EACAC,EAA2C,CAAA,EAC3C,CACMM,MAAAA,EAAWC,UAAMC,OAA0B,EAC3CC,EAAgBC,EAAiBV,CAAO,EAEvCO,OAAAA,EAAAA,QAAMI,QAAQ,IAAM,CACzB,MAAMC,EACJ,OAAOd,GAA+B,SAClCA,EACAA,GAAAA,YAAAA,EAA4Be,GAE5BC,EAAeR,EAASS,QAI5BD,GAAAA,GACAA,EAAaE,gBAAgB,IAC5BF,EAAaF,SAAWA,GAAUE,EAAaf,YAAcA,GAG5De,OAAAA,EAAAA,EACAhB,EACAC,EACAU,CACF,EACOK,EAGLA,GACFA,EAAaG,SAAS,EAIlBpB,MAAAA,EAAQ,IAAIqB,EAAAA,QAAMb,EAAQ,CAC9Bc,KAAMV,EAAcU,KACpBC,SAAUX,EAAcW,QAAAA,CACzB,EAGCvB,OAAAA,EAAAA,EACAC,EACAC,EACAU,CACF,EACAH,EAASS,QAAUlB,EAEZA,GACN,CAACQ,EAAQP,EAA4BC,EAAWU,CAAa,CAAC,CACnE"}

package/dist/esm/modules/core/context/KnockProvider.mjs

@@ -1,35 +1,35 @@
-import * as t from "react";
-import { KnockI18nProvider as d } from "../../i18n/context/KnockI18nProvider.mjs";
-import l from "../hooks/useAuthenticatedKnockClient.mjs";
+import * as e from "react";
+import { KnockI18nProvider as l } from "../../i18n/context/KnockI18nProvider.mjs";
+import C from "../hooks/useAuthenticatedKnockClient.mjs";
 import "fast-deep-equal";
-const u = t.createContext(null), P = ({
-  apiKey: e,
-  host: o,
-  logLevel: n,
-  userId: i,
-  userToken: s,
+const i = e.createContext(null), f = ({
+  apiKey: n,
+  host: c,
+  logLevel: o,
+  userToken: k,
   onUserTokenExpiring: r,
-  timeBeforeExpirationInMs: c,
-  children: k,
-  i18n: m
+  timeBeforeExpirationInMs: u,
+  children: m,
+  i18n: a,
+  ...t
 }) => {
-  const a = t.useMemo(() => ({
-    host: o,
+  const s = (t == null ? void 0 : t.user) || (t == null ? void 0 : t.userId), d = e.useMemo(() => ({
+    host: c,
     onUserTokenExpiring: r,
-    timeBeforeExpirationInMs: c,
-    logLevel: n
-  }), [o, r, c, n]), K = l(e ?? "", i, s, a);
-  return /* @__PURE__ */ t.createElement(u.Provider, { value: {
+    timeBeforeExpirationInMs: u,
+    logLevel: o
+  }), [c, r, u, o]), K = C(n ?? "", s, k, d);
+  return /* @__PURE__ */ e.createElement(i.Provider, { value: {
     knock: K
-  } }, /* @__PURE__ */ t.createElement(d, { i18n: m }, k));
-}, f = () => {
-  const e = t.useContext(u);
-  if (!e)
+  } }, /* @__PURE__ */ e.createElement(l, { i18n: a }, m));
+}, w = () => {
+  const n = e.useContext(i);
+  if (!n)
     throw new Error("useKnockClient must be used within a KnockProvider");
-  return e.knock;
+  return n.knock;
 };
 export {
-  P as KnockProvider,
-  f as useKnockClient
+  f as KnockProvider,
+  w as useKnockClient
 };
 //# sourceMappingURL=KnockProvider.mjs.map

package/dist/esm/modules/core/context/KnockProvider.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"KnockProvider.mjs","sources":["../../../../../src/modules/core/context/KnockProvider.tsx"],"sourcesContent":["import Knock, { AuthenticateOptions, LogLevel } from \"@knocklabs/client\";\nimport * as React from \"react\";\nimport { PropsWithChildren } from \"react\";\n\nimport { I18nContent, KnockI18nProvider } from \"../../i18n\";\nimport { useAuthenticatedKnockClient } from \"../hooks\";\n\nexport interface KnockProviderState {\n  knock: Knock;\n}\n\nconst KnockContext = React.createContext<KnockProviderState | null>(null);\n\nexport interface KnockProviderProps {\n  // Knock client props\n  apiKey: string | undefined;\n  host?: string;\n  // Authentication props\n  userId: Knock[\"userId\"];\n  userToken?: Knock[\"userToken\"];\n  onUserTokenExpiring?: AuthenticateOptions[\"onUserTokenExpiring\"];\n  timeBeforeExpirationInMs?: AuthenticateOptions[\"timeBeforeExpirationInMs\"];\n  // i18n translations\n  i18n?: I18nContent;\n  logLevel?: LogLevel;\n}\n\nexport const KnockProvider: React.FC<PropsWithChildren<KnockProviderProps>> = ({\n  apiKey,\n  host,\n  logLevel,\n  userId,\n  userToken,\n  onUserTokenExpiring,\n  timeBeforeExpirationInMs,\n  children,\n  i18n,\n}) => {\n  // We memoize the options here so that we don't create a new object on every re-render\n  const authenticateOptions = React.useMemo(\n    () => ({\n      host,\n      onUserTokenExpiring,\n      timeBeforeExpirationInMs,\n      logLevel,\n    }),\n    [host, onUserTokenExpiring, timeBeforeExpirationInMs, logLevel],\n  );\n\n  const knock = useAuthenticatedKnockClient(\n    apiKey ?? \"\",\n    userId,\n    userToken,\n    authenticateOptions,\n  );\n\n  return (\n    <KnockContext.Provider value={{ knock }}>\n      <KnockI18nProvider i18n={i18n}>{children}</KnockI18nProvider>\n    </KnockContext.Provider>\n  );\n};\n\nexport const useKnockClient = (): Knock => {\n  const context = React.useContext(KnockContext);\n  if (!context) {\n    throw new Error(\"useKnockClient must be used within a KnockProvider\");\n  }\n  return context.knock;\n};\n"],"names":["KnockContext","React","createContext","KnockProvider","apiKey","host","logLevel","userId","userToken","onUserTokenExpiring","timeBeforeExpirationInMs","children","i18n","authenticateOptions","useMemo","knock","useAuthenticatedKnockClient","KnockI18nProvider","useKnockClient","context","useContext","Error"],"mappings":";;;;AAWA,MAAMA,IAAeC,EAAMC,cAAyC,IAAI,GAgB3DC,IAAiEA,CAAC;AAAA,EAC7EC,QAAAA;AAAAA,EACAC,MAAAA;AAAAA,EACAC,UAAAA;AAAAA,EACAC,QAAAA;AAAAA,EACAC,WAAAA;AAAAA,EACAC,qBAAAA;AAAAA,EACAC,0BAAAA;AAAAA,EACAC,UAAAA;AAAAA,EACAC,MAAAA;AACF,MAAM;AAEEC,QAAAA,IAAsBZ,EAAMa,QAChC,OAAO;AAAA,IACLT,MAAAA;AAAAA,IACAI,qBAAAA;AAAAA,IACAC,0BAAAA;AAAAA,IACAJ,UAAAA;AAAAA,MAEF,CAACD,GAAMI,GAAqBC,GAA0BJ,CAAQ,CAChE,GAEMS,IAAQC,EACZZ,KAAU,IACVG,GACAC,GACAK,CACF;AAEA,SACG,gBAAAZ,EAAA,cAAAD,EAAa,UAAb,EAAsB,OAAO;AAAA,IAAEe,OAAAA;AAAAA,EAAAA,EAC9B,GAAA,gBAAAd,EAAA,cAACgB,GAAkB,EAAA,MAAAL,EAAA,GAAaD,CAAS,CAC3C;AAEJ,GAEaO,IAAiBA,MAAa;AACnCC,QAAAA,IAAUlB,EAAMmB,WAAWpB,CAAY;AAC7C,MAAI,CAACmB;AACG,UAAA,IAAIE,MAAM,oDAAoD;AAEtE,SAAOF,EAAQJ;AACjB;"}
+{"version":3,"file":"KnockProvider.mjs","sources":["../../../../../src/modules/core/context/KnockProvider.tsx"],"sourcesContent":["import Knock, {\n  AuthenticateOptions,\n  LogLevel,\n  UserWithProperties,\n} from \"@knocklabs/client\";\nimport * as React from \"react\";\nimport { PropsWithChildren } from \"react\";\n\nimport { I18nContent, KnockI18nProvider } from \"../../i18n\";\nimport { useAuthenticatedKnockClient } from \"../hooks\";\n\nexport interface KnockProviderState {\n  knock: Knock;\n}\n\nconst KnockContext = React.createContext<KnockProviderState | null>(null);\n\nexport type KnockProviderProps = {\n  // Knock client props\n  apiKey: string | undefined;\n  host?: string;\n  userToken?: Knock[\"userToken\"];\n  onUserTokenExpiring?: AuthenticateOptions[\"onUserTokenExpiring\"];\n  timeBeforeExpirationInMs?: AuthenticateOptions[\"timeBeforeExpirationInMs\"];\n  // i18n translations\n  i18n?: I18nContent;\n  logLevel?: LogLevel;\n} & (\n  | {\n      /**\n       * @deprecated The `userId` prop is deprecated and will be removed in a future version.\n       * Please pass the `user` prop instead containing an `id` value.\n       * example:\n       * ```ts\n       * <KnockProvider user={{ id: \"user_123\" }}></KnockProvider>\n       * ```\n       */\n      userId: Knock[\"userId\"];\n      user?: never;\n    }\n  | {\n      user: UserWithProperties;\n      /**\n       * @deprecated The `userId` prop is deprecated and will be removed in a future version.\n       * Please pass the `user` prop instead containing an `id` value.\n       * example:\n       * ```ts\n       * <KnockProvider user={{ id: \"user_123\" }}></KnockProvider>\n       * ```\n       */\n      userId?: never;\n    }\n);\n\nexport const KnockProvider: React.FC<PropsWithChildren<KnockProviderProps>> = ({\n  apiKey,\n  host,\n  logLevel,\n  userToken,\n  onUserTokenExpiring,\n  timeBeforeExpirationInMs,\n  children,\n  i18n,\n  ...props\n}) => {\n  const userIdOrUserWithProperties = props?.user || props?.userId;\n\n  // We memoize the options here so that we don't create a new object on every re-render\n  const authenticateOptions = React.useMemo(\n    () => ({\n      host,\n      onUserTokenExpiring,\n      timeBeforeExpirationInMs,\n      logLevel,\n    }),\n    [host, onUserTokenExpiring, timeBeforeExpirationInMs, logLevel],\n  );\n\n  const knock = useAuthenticatedKnockClient(\n    apiKey ?? \"\",\n    userIdOrUserWithProperties,\n    userToken,\n    authenticateOptions,\n  );\n\n  return (\n    <KnockContext.Provider value={{ knock }}>\n      <KnockI18nProvider i18n={i18n}>{children}</KnockI18nProvider>\n    </KnockContext.Provider>\n  );\n};\n\nexport const useKnockClient = (): Knock => {\n  const context = React.useContext(KnockContext);\n  if (!context) {\n    throw new Error(\"useKnockClient must be used within a KnockProvider\");\n  }\n  return context.knock;\n};\n"],"names":["KnockContext","React","createContext","KnockProvider","apiKey","host","logLevel","userToken","onUserTokenExpiring","timeBeforeExpirationInMs","children","i18n","props","userIdOrUserWithProperties","user","userId","authenticateOptions","useMemo","knock","useAuthenticatedKnockClient","KnockI18nProvider","useKnockClient","context","useContext","Error"],"mappings":";;;;AAeA,MAAMA,IAAeC,EAAMC,cAAyC,IAAI,GAuC3DC,IAAiEA,CAAC;AAAA,EAC7EC,QAAAA;AAAAA,EACAC,MAAAA;AAAAA,EACAC,UAAAA;AAAAA,EACAC,WAAAA;AAAAA,EACAC,qBAAAA;AAAAA,EACAC,0BAAAA;AAAAA,EACAC,UAAAA;AAAAA,EACAC,MAAAA;AAAAA,EACA,GAAGC;AACL,MAAM;AACEC,QAAAA,KAA6BD,KAAAA,gBAAAA,EAAOE,UAAQF,KAAAA,gBAAAA,EAAOG,SAGnDC,IAAsBf,EAAMgB,QAChC,OAAO;AAAA,IACLZ,MAAAA;AAAAA,IACAG,qBAAAA;AAAAA,IACAC,0BAAAA;AAAAA,IACAH,UAAAA;AAAAA,MAEF,CAACD,GAAMG,GAAqBC,GAA0BH,CAAQ,CAChE,GAEMY,IAAQC,EACZf,KAAU,IACVS,GACAN,GACAS,CACF;AAEA,SACG,gBAAAf,EAAA,cAAAD,EAAa,UAAb,EAAsB,OAAO;AAAA,IAAEkB,OAAAA;AAAAA,EAAAA,EAC9B,GAAA,gBAAAjB,EAAA,cAACmB,GAAkB,EAAA,MAAAT,EAAA,GAAaD,CAAS,CAC3C;AAEJ,GAEaW,IAAiBA,MAAa;AACnCC,QAAAA,IAAUrB,EAAMsB,WAAWvB,CAAY;AAC7C,MAAI,CAACsB;AACG,UAAA,IAAIE,MAAM,oDAAoD;AAEtE,SAAOF,EAAQJ;AACjB;"}

package/dist/esm/modules/core/hooks/useAuthenticatedKnockClient.mjs

@@ -1,29 +1,29 @@
-import m from "@knocklabs/client";
+import g from "@knocklabs/client";
 import u from "react";
 import "../context/KnockProvider.mjs";
-import l from "./useStableOptions.mjs";
+import x from "./useStableOptions.mjs";
 import "date-fns";
-function f(i, n, r, t = {}) {
-  i.authenticate(n, r, {
+function k(m, n, a, t = {}) {
+  m.authenticate(n, a, {
     onUserTokenExpiring: t == null ? void 0 : t.onUserTokenExpiring,
     timeBeforeExpirationInMs: t == null ? void 0 : t.timeBeforeExpirationInMs
   });
 }
-function E(i, n, r, t = {}) {
-  const a = u.useRef(), c = l(t);
+function v(m, n, a, t = {}) {
+  const l = u.useRef(), f = x(t);
   return u.useMemo(() => {
-    const e = a.current;
-    if (e && e.isAuthenticated() && (e.userId !== n || e.userToken !== r))
-      return f(e, n, r, c), e;
-    e && e.teardown();
-    const o = new m(i, {
-      host: c.host,
-      logLevel: c.logLevel
+    const e = typeof n == "string" ? n : n == null ? void 0 : n.id, c = l.current;
+    if (c && c.isAuthenticated() && (c.userId !== e || c.userToken !== a))
+      return k(c, n, a, f), c;
+    c && c.teardown();
+    const o = new g(m, {
+      host: f.host,
+      logLevel: f.logLevel
     });
-    return f(o, n, r, c), a.current = o, o;
-  }, [i, n, r, c]);
+    return k(o, n, a, f), l.current = o, o;
+  }, [m, n, a, f]);
 }
 export {
-  E as default
+  v as default
 };
 //# sourceMappingURL=useAuthenticatedKnockClient.mjs.map

package/dist/esm/modules/core/hooks/useAuthenticatedKnockClient.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"useAuthenticatedKnockClient.mjs","sources":["../../../../../src/modules/core/hooks/useAuthenticatedKnockClient.ts"],"sourcesContent":["import Knock, { AuthenticateOptions, KnockOptions } from \"@knocklabs/client\";\nimport React from \"react\";\n\nimport { useStableOptions } from \"../../core\";\n\nfunction authenticateWithOptions(\n  knock: Knock,\n  userId: Knock[\"userId\"],\n  userToken?: Knock[\"userToken\"],\n  options: AuthenticateOptions = {},\n) {\n  knock.authenticate(userId, userToken, {\n    onUserTokenExpiring: options?.onUserTokenExpiring,\n    timeBeforeExpirationInMs: options?.timeBeforeExpirationInMs,\n  });\n}\n\nexport type AuthenticatedKnockClientOptions = KnockOptions &\n  AuthenticateOptions;\n\nfunction useAuthenticatedKnockClient(\n  apiKey: string,\n  userId: Knock[\"userId\"],\n  userToken?: Knock[\"userToken\"],\n  options: AuthenticatedKnockClientOptions = {},\n) {\n  const knockRef = React.useRef<Knock | undefined>();\n  const stableOptions = useStableOptions(options);\n\n  return React.useMemo(() => {\n    const currentKnock = knockRef.current;\n\n    // If the userId and the userToken changes then just reauth\n    if (\n      currentKnock &&\n      currentKnock.isAuthenticated() &&\n      (currentKnock.userId !== userId || currentKnock.userToken !== userToken)\n    ) {\n      authenticateWithOptions(currentKnock, userId, userToken, stableOptions);\n      return currentKnock;\n    }\n\n    if (currentKnock) {\n      currentKnock.teardown();\n    }\n\n    // Otherwise instantiate a new Knock client\n    const knock = new Knock(apiKey, {\n      host: stableOptions.host,\n      logLevel: stableOptions.logLevel,\n    });\n\n    authenticateWithOptions(knock, userId, userToken, stableOptions);\n    knockRef.current = knock;\n\n    return knock;\n  }, [apiKey, userId, userToken, stableOptions]);\n}\n\nexport default useAuthenticatedKnockClient;\n"],"names":["authenticateWithOptions","knock","userId","userToken","options","authenticate","onUserTokenExpiring","timeBeforeExpirationInMs","useAuthenticatedKnockClient","apiKey","knockRef","React","useRef","stableOptions","useStableOptions","useMemo","currentKnock","current","isAuthenticated","teardown","Knock","host","logLevel"],"mappings":";;;;;AAKA,SAASA,EACPC,GACAC,GACAC,GACAC,IAA+B,CAAA,GAC/B;AACMC,EAAAA,EAAAA,aAAaH,GAAQC,GAAW;AAAA,IACpCG,qBAAqBF,KAAAA,gBAAAA,EAASE;AAAAA,IAC9BC,0BAA0BH,KAAAA,gBAAAA,EAASG;AAAAA,EAAAA,CACpC;AACH;AAKA,SAASC,EACPC,GACAP,GACAC,GACAC,IAA2C,CAAA,GAC3C;AACMM,QAAAA,IAAWC,EAAMC,OAA0B,GAC3CC,IAAgBC,EAAiBV,CAAO;AAEvCO,SAAAA,EAAMI,QAAQ,MAAM;AACzB,UAAMC,IAAeN,EAASO;AAI5BD,QAAAA,KACAA,EAAaE,gBAAgB,MAC5BF,EAAad,WAAWA,KAAUc,EAAab,cAAcA;AAEtCa,aAAAA,EAAAA,GAAcd,GAAQC,GAAWU,CAAa,GAC/DG;AAGT,IAAIA,KACFA,EAAaG,SAAS;AAIlBlB,UAAAA,IAAQ,IAAImB,EAAMX,GAAQ;AAAA,MAC9BY,MAAMR,EAAcQ;AAAAA,MACpBC,UAAUT,EAAcS;AAAAA,IAAAA,CACzB;AAEuBrB,WAAAA,EAAAA,GAAOC,GAAQC,GAAWU,CAAa,GAC/DH,EAASO,UAAUhB,GAEZA;AAAAA,KACN,CAACQ,GAAQP,GAAQC,GAAWU,CAAa,CAAC;AAC/C;"}
+{"version":3,"file":"useAuthenticatedKnockClient.mjs","sources":["../../../../../src/modules/core/hooks/useAuthenticatedKnockClient.ts"],"sourcesContent":["import Knock, {\n  AuthenticateOptions,\n  KnockOptions,\n  UserId,\n  UserIdOrUserWithProperties,\n} from \"@knocklabs/client\";\nimport React from \"react\";\n\nimport { useStableOptions } from \"../../core\";\n\nfunction authenticateWithOptions(\n  knock: Knock,\n  userIdOrUserWithProperties: UserIdOrUserWithProperties,\n  userToken?: Knock[\"userToken\"],\n  options: AuthenticateOptions = {},\n) {\n  knock.authenticate(userIdOrUserWithProperties, userToken, {\n    onUserTokenExpiring: options?.onUserTokenExpiring,\n    timeBeforeExpirationInMs: options?.timeBeforeExpirationInMs,\n  });\n}\n\nexport type AuthenticatedKnockClientOptions = KnockOptions &\n  AuthenticateOptions;\n\n/**\n * @deprecated Passing `userId` as a `string` is deprecated and will be removed in a future version.\n * Please pass a `user` object instead containing an `id` value.\n * example:\n * ```ts\n * useAuthenticatedKnockClient(\"pk_test_12345\", { id: \"user_123\" });\n * ```\n */\nfunction useAuthenticatedKnockClient(\n  apiKey: string,\n  userIdOrUserWithProperties: UserId,\n  userToken?: Knock[\"userToken\"],\n  options?: AuthenticatedKnockClientOptions,\n): Knock;\nfunction useAuthenticatedKnockClient(\n  apiKey: string,\n  userIdOrUserWithProperties: UserIdOrUserWithProperties,\n  userToken?: Knock[\"userToken\"],\n  options?: AuthenticatedKnockClientOptions,\n): Knock;\nfunction useAuthenticatedKnockClient(\n  apiKey: string,\n  userIdOrUserWithProperties: UserIdOrUserWithProperties,\n  userToken?: Knock[\"userToken\"],\n  options: AuthenticatedKnockClientOptions = {},\n) {\n  const knockRef = React.useRef<Knock | undefined>();\n  const stableOptions = useStableOptions(options);\n\n  return React.useMemo(() => {\n    const userId =\n      typeof userIdOrUserWithProperties === \"string\"\n        ? userIdOrUserWithProperties\n        : userIdOrUserWithProperties?.id;\n\n    const currentKnock = knockRef.current;\n\n    // If the userId and the userToken changes then just reauth\n    if (\n      currentKnock &&\n      currentKnock.isAuthenticated() &&\n      (currentKnock.userId !== userId || currentKnock.userToken !== userToken)\n    ) {\n      authenticateWithOptions(\n        currentKnock,\n        userIdOrUserWithProperties,\n        userToken,\n        stableOptions,\n      );\n      return currentKnock;\n    }\n\n    if (currentKnock) {\n      currentKnock.teardown();\n    }\n\n    // Otherwise instantiate a new Knock client\n    const knock = new Knock(apiKey, {\n      host: stableOptions.host,\n      logLevel: stableOptions.logLevel,\n    });\n\n    authenticateWithOptions(\n      knock,\n      userIdOrUserWithProperties,\n      userToken,\n      stableOptions,\n    );\n    knockRef.current = knock;\n\n    return knock;\n  }, [apiKey, userIdOrUserWithProperties, userToken, stableOptions]);\n}\n\nexport default useAuthenticatedKnockClient;\n"],"names":["authenticateWithOptions","knock","userIdOrUserWithProperties","userToken","options","authenticate","onUserTokenExpiring","timeBeforeExpirationInMs","useAuthenticatedKnockClient","apiKey","knockRef","React","useRef","stableOptions","useStableOptions","useMemo","userId","id","currentKnock","current","isAuthenticated","teardown","Knock","host","logLevel"],"mappings":";;;;;AAUA,SAASA,EACPC,GACAC,GACAC,GACAC,IAA+B,CAAA,GAC/B;AACMC,EAAAA,EAAAA,aAAaH,GAA4BC,GAAW;AAAA,IACxDG,qBAAqBF,KAAAA,gBAAAA,EAASE;AAAAA,IAC9BC,0BAA0BH,KAAAA,gBAAAA,EAASG;AAAAA,EAAAA,CACpC;AACH;AAyBA,SAASC,EACPC,GACAP,GACAC,GACAC,IAA2C,CAAA,GAC3C;AACMM,QAAAA,IAAWC,EAAMC,OAA0B,GAC3CC,IAAgBC,EAAiBV,CAAO;AAEvCO,SAAAA,EAAMI,QAAQ,MAAM;AACzB,UAAMC,IACJ,OAAOd,KAA+B,WAClCA,IACAA,KAAAA,gBAAAA,EAA4Be,IAE5BC,IAAeR,EAASS;AAI5BD,QAAAA,KACAA,EAAaE,gBAAgB,MAC5BF,EAAaF,WAAWA,KAAUE,EAAaf,cAAcA;AAG5De,aAAAA,EAAAA,GACAhB,GACAC,GACAU,CACF,GACOK;AAGT,IAAIA,KACFA,EAAaG,SAAS;AAIlBpB,UAAAA,IAAQ,IAAIqB,EAAMb,GAAQ;AAAA,MAC9Bc,MAAMV,EAAcU;AAAAA,MACpBC,UAAUX,EAAcW;AAAAA,IAAAA,CACzB;AAGCvB,WAAAA,EAAAA,GACAC,GACAC,GACAU,CACF,GACAH,EAASS,UAAUlB,GAEZA;AAAAA,KACN,CAACQ,GAAQP,GAA4BC,GAAWU,CAAa,CAAC;AACnE;"}

package/dist/types/modules/core/context/KnockProvider.d.ts

@@ -1,20 +1,41 @@
-import { default as Knock, AuthenticateOptions, LogLevel } from '@knocklabs/client';
+import { default as Knock, AuthenticateOptions, LogLevel, UserWithProperties } from '@knocklabs/client';
 import { PropsWithChildren } from 'react';
 import { I18nContent } from '../../i18n';
 import * as React from "react";
 export interface KnockProviderState {
     knock: Knock;
 }
-export interface KnockProviderProps {
+export type KnockProviderProps = {
     apiKey: string | undefined;
     host?: string;
-    userId: Knock["userId"];
     userToken?: Knock["userToken"];
     onUserTokenExpiring?: AuthenticateOptions["onUserTokenExpiring"];
     timeBeforeExpirationInMs?: AuthenticateOptions["timeBeforeExpirationInMs"];
     i18n?: I18nContent;
     logLevel?: LogLevel;
-}
+} & ({
+    /**
+     * @deprecated The `userId` prop is deprecated and will be removed in a future version.
+     * Please pass the `user` prop instead containing an `id` value.
+     * example:
+     * ```ts
+     * <KnockProvider user={{ id: "user_123" }}></KnockProvider>
+     * ```
+     */
+    userId: Knock["userId"];
+    user?: never;
+} | {
+    user: UserWithProperties;
+    /**
+     * @deprecated The `userId` prop is deprecated and will be removed in a future version.
+     * Please pass the `user` prop instead containing an `id` value.
+     * example:
+     * ```ts
+     * <KnockProvider user={{ id: "user_123" }}></KnockProvider>
+     * ```
+     */
+    userId?: never;
+});
 export declare const KnockProvider: React.FC<PropsWithChildren<KnockProviderProps>>;
 export declare const useKnockClient: () => Knock;
 //# sourceMappingURL=KnockProvider.d.ts.map

package/dist/types/modules/core/context/KnockProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KnockProvider.d.ts","sourceRoot":"","sources":["../../../../../src/modules/core/context/KnockProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,EAAE,WAAW,EAAqB,MAAM,YAAY,CAAC;AAG5D,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,KAAK,CAAC;CACd;AAID,MAAM,WAAW,kBAAkB;IAEjC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACxB,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC/B,mBAAmB,CAAC,EAAE,mBAAmB,CAAC,qBAAqB,CAAC,CAAC;IACjE,wBAAwB,CAAC,EAAE,mBAAmB,CAAC,0BAA0B,CAAC,CAAC;IAE3E,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAkCzE,CAAC;AAEF,eAAO,MAAM,cAAc,QAAO,KAMjC,CAAC"}
+{"version":3,"file":"KnockProvider.d.ts","sourceRoot":"","sources":["../../../../../src/modules/core/context/KnockProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EACZ,mBAAmB,EACnB,QAAQ,EACR,kBAAkB,EACnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,EAAE,WAAW,EAAqB,MAAM,YAAY,CAAC;AAG5D,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,KAAK,CAAC;CACd;AAID,MAAM,MAAM,kBAAkB,GAAG;IAE/B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC/B,mBAAmB,CAAC,EAAE,mBAAmB,CAAC,qBAAqB,CAAC,CAAC;IACjE,wBAAwB,CAAC,EAAE,mBAAmB,CAAC,0BAA0B,CAAC,CAAC;IAE3E,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,GAAG,CACA;IACE;;;;;;;OAOG;IACH,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACxB,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,GACD;IACE,IAAI,EAAE,kBAAkB,CAAC;IACzB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC;CAChB,CACJ,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAoCzE,CAAC;AAEF,eAAO,MAAM,cAAc,QAAO,KAMjC,CAAC"}

package/dist/types/modules/core/hooks/useAuthenticatedKnockClient.d.ts

@@ -1,5 +1,14 @@
-import { default as Knock, AuthenticateOptions, KnockOptions } from '@knocklabs/client';
+import { default as Knock, AuthenticateOptions, KnockOptions, UserId, UserIdOrUserWithProperties } from '@knocklabs/client';
 export type AuthenticatedKnockClientOptions = KnockOptions & AuthenticateOptions;
-declare function useAuthenticatedKnockClient(apiKey: string, userId: Knock["userId"], userToken?: Knock["userToken"], options?: AuthenticatedKnockClientOptions): Knock;
+/**
+ * @deprecated Passing `userId` as a `string` is deprecated and will be removed in a future version.
+ * Please pass a `user` object instead containing an `id` value.
+ * example:
+ * ```ts
+ * useAuthenticatedKnockClient("pk_test_12345", { id: "user_123" });
+ * ```
+ */
+declare function useAuthenticatedKnockClient(apiKey: string, userIdOrUserWithProperties: UserId, userToken?: Knock["userToken"], options?: AuthenticatedKnockClientOptions): Knock;
+declare function useAuthenticatedKnockClient(apiKey: string, userIdOrUserWithProperties: UserIdOrUserWithProperties, userToken?: Knock["userToken"], options?: AuthenticatedKnockClientOptions): Knock;
 export default useAuthenticatedKnockClient;
 //# sourceMappingURL=useAuthenticatedKnockClient.d.ts.map

package/dist/types/modules/core/hooks/useAuthenticatedKnockClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useAuthenticatedKnockClient.d.ts","sourceRoot":"","sources":["../../../../../src/modules/core/hooks/useAuthenticatedKnockClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAiB7E,MAAM,MAAM,+BAA+B,GAAG,YAAY,GACxD,mBAAmB,CAAC;AAEtB,iBAAS,2BAA2B,CAClC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,EACvB,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,EAC9B,OAAO,GAAE,+BAAoC,SAiC9C;AAED,eAAe,2BAA2B,CAAC"}
+{"version":3,"file":"useAuthenticatedKnockClient.d.ts","sourceRoot":"","sources":["../../../../../src/modules/core/hooks/useAuthenticatedKnockClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EACZ,mBAAmB,EACnB,YAAY,EACZ,MAAM,EACN,0BAA0B,EAC3B,MAAM,mBAAmB,CAAC;AAiB3B,MAAM,MAAM,+BAA+B,GAAG,YAAY,GACxD,mBAAmB,CAAC;AAEtB;;;;;;;GAOG;AACH,iBAAS,2BAA2B,CAClC,MAAM,EAAE,MAAM,EACd,0BAA0B,EAAE,MAAM,EAClC,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,EAC9B,OAAO,CAAC,EAAE,+BAA+B,GACxC,KAAK,CAAC;AACT,iBAAS,2BAA2B,CAClC,MAAM,EAAE,MAAM,EACd,0BAA0B,EAAE,0BAA0B,EACtD,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,EAC9B,OAAO,CAAC,EAAE,+BAA+B,GACxC,KAAK,CAAC;AAuDT,eAAe,2BAA2B,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.6.15",
+  "version": "0.7.0",
   "license": "MIT",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.mjs",
@@ -47,13 +47,14 @@
     "react": "^16.11.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
   },
   "dependencies": {
-    "@knocklabs/client": "^0.14.11",
+    "@knocklabs/client": "^0.15.0",
     "@tanstack/react-store": "^0.7.1",
     "date-fns": "^4.0.0",
     "fast-deep-equal": "^3.1.3",
     "swr": "^2.3.3"
   },
   "devDependencies": {
+    "@codecov/vite-plugin": "^1.9.1",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/react": "^16.3.0",
     "@types/react": "^18.3.6",

package/src/modules/core/context/KnockProvider.tsx

@@ -1,4 +1,8 @@
-import Knock, { AuthenticateOptions, LogLevel } from "@knocklabs/client";
+import Knock, {
+  AuthenticateOptions,
+  LogLevel,
+  UserWithProperties,
+} from "@knocklabs/client";
 import * as React from "react";
 import { PropsWithChildren } from "react";
 
@@ -11,31 +15,56 @@ export interface KnockProviderState {
 
 const KnockContext = React.createContext<KnockProviderState | null>(null);
 
-export interface KnockProviderProps {
+export type KnockProviderProps = {
   // Knock client props
   apiKey: string | undefined;
   host?: string;
-  // Authentication props
-  userId: Knock["userId"];
   userToken?: Knock["userToken"];
   onUserTokenExpiring?: AuthenticateOptions["onUserTokenExpiring"];
   timeBeforeExpirationInMs?: AuthenticateOptions["timeBeforeExpirationInMs"];
   // i18n translations
   i18n?: I18nContent;
   logLevel?: LogLevel;
-}
+} & (
+  | {
+      /**
+       * @deprecated The `userId` prop is deprecated and will be removed in a future version.
+       * Please pass the `user` prop instead containing an `id` value.
+       * example:
+       * ```ts
+       * <KnockProvider user={{ id: "user_123" }}></KnockProvider>
+       * ```
+       */
+      userId: Knock["userId"];
+      user?: never;
+    }
+  | {
+      user: UserWithProperties;
+      /**
+       * @deprecated The `userId` prop is deprecated and will be removed in a future version.
+       * Please pass the `user` prop instead containing an `id` value.
+       * example:
+       * ```ts
+       * <KnockProvider user={{ id: "user_123" }}></KnockProvider>
+       * ```
+       */
+      userId?: never;
+    }
+);
 
 export const KnockProvider: React.FC<PropsWithChildren<KnockProviderProps>> = ({
   apiKey,
   host,
   logLevel,
-  userId,
   userToken,
   onUserTokenExpiring,
   timeBeforeExpirationInMs,
   children,
   i18n,
+  ...props
 }) => {
+  const userIdOrUserWithProperties = props?.user || props?.userId;
+
   // We memoize the options here so that we don't create a new object on every re-render
   const authenticateOptions = React.useMemo(
     () => ({
@@ -49,7 +78,7 @@ export const KnockProvider: React.FC<PropsWithChildren<KnockProviderProps>> = ({
 
   const knock = useAuthenticatedKnockClient(
     apiKey ?? "",
-    userId,
+    userIdOrUserWithProperties,
     userToken,
     authenticateOptions,
   );

package/src/modules/core/hooks/useAuthenticatedKnockClient.ts

@@ -1,15 +1,20 @@
-import Knock, { AuthenticateOptions, KnockOptions } from "@knocklabs/client";
+import Knock, {
+  AuthenticateOptions,
+  KnockOptions,
+  UserId,
+  UserIdOrUserWithProperties,
+} from "@knocklabs/client";
 import React from "react";
 
 import { useStableOptions } from "../../core";
 
 function authenticateWithOptions(
   knock: Knock,
-  userId: Knock["userId"],
+  userIdOrUserWithProperties: UserIdOrUserWithProperties,
   userToken?: Knock["userToken"],
   options: AuthenticateOptions = {},
 ) {
-  knock.authenticate(userId, userToken, {
+  knock.authenticate(userIdOrUserWithProperties, userToken, {
     onUserTokenExpiring: options?.onUserTokenExpiring,
     timeBeforeExpirationInMs: options?.timeBeforeExpirationInMs,
   });
@@ -18,9 +23,29 @@ function authenticateWithOptions(
 export type AuthenticatedKnockClientOptions = KnockOptions &
   AuthenticateOptions;
 
+/**
+ * @deprecated Passing `userId` as a `string` is deprecated and will be removed in a future version.
+ * Please pass a `user` object instead containing an `id` value.
+ * example:
+ * ```ts
+ * useAuthenticatedKnockClient("pk_test_12345", { id: "user_123" });
+ * ```
+ */
 function useAuthenticatedKnockClient(
   apiKey: string,
-  userId: Knock["userId"],
+  userIdOrUserWithProperties: UserId,
+  userToken?: Knock["userToken"],
+  options?: AuthenticatedKnockClientOptions,
+): Knock;
+function useAuthenticatedKnockClient(
+  apiKey: string,
+  userIdOrUserWithProperties: UserIdOrUserWithProperties,
+  userToken?: Knock["userToken"],
+  options?: AuthenticatedKnockClientOptions,
+): Knock;
+function useAuthenticatedKnockClient(
+  apiKey: string,
+  userIdOrUserWithProperties: UserIdOrUserWithProperties,
   userToken?: Knock["userToken"],
   options: AuthenticatedKnockClientOptions = {},
 ) {
@@ -28,6 +53,11 @@ function useAuthenticatedKnockClient(
   const stableOptions = useStableOptions(options);
 
   return React.useMemo(() => {
+    const userId =
+      typeof userIdOrUserWithProperties === "string"
+        ? userIdOrUserWithProperties
+        : userIdOrUserWithProperties?.id;
+
     const currentKnock = knockRef.current;
 
     // If the userId and the userToken changes then just reauth
@@ -36,7 +66,12 @@ function useAuthenticatedKnockClient(
       currentKnock.isAuthenticated() &&
       (currentKnock.userId !== userId || currentKnock.userToken !== userToken)
     ) {
-      authenticateWithOptions(currentKnock, userId, userToken, stableOptions);
+      authenticateWithOptions(
+        currentKnock,
+        userIdOrUserWithProperties,
+        userToken,
+        stableOptions,
+      );
       return currentKnock;
     }
 
@@ -50,11 +85,16 @@ function useAuthenticatedKnockClient(
       logLevel: stableOptions.logLevel,
     });
 
-    authenticateWithOptions(knock, userId, userToken, stableOptions);
+    authenticateWithOptions(
+      knock,
+      userIdOrUserWithProperties,
+      userToken,
+      stableOptions,
+    );
     knockRef.current = knock;
 
     return knock;
-  }, [apiKey, userId, userToken, stableOptions]);
+  }, [apiKey, userIdOrUserWithProperties, userToken, stableOptions]);
 }
 
 export default useAuthenticatedKnockClient;