@knocklabs/react-core 0.13.0 → 0.13.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.13.1
+
+### Patch Changes
+
+- 7f8bdfe: Add accessible labels to `UnseenBadge` so screen readers announce the count with context (e.g. "3 unseen notifications") instead of just the bare number
+- Updated dependencies [ddd7981]
+  - @knocklabs/client@0.21.1
+
 ## 0.13.0
 
 ### Minor Changes

package/dist/cjs/index.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("./modules/core/context/KnockProvider.js"),c=require("./modules/core/hooks/useAuthenticatedKnockClient.js"),a=require("./modules/core/hooks/useStableOptions.js"),d=require("./modules/core/hooks/useAuthPostMessageListener.js"),l=require("./modules/core/hooks/useAuthPolling.js"),k=require("./modules/core/constants.js"),e=require("./modules/core/utils.js"),n=require("./modules/feed/context/KnockFeedProvider.js"),C=require("./modules/feed/hooks/useNotifications.js"),K=require("./modules/feed/hooks/useFeedSettings.js"),t=require("./modules/feed/hooks/useNotificationStore.js"),o=require("./modules/guide/context/KnockGuideProvider.js"),P=require("./modules/guide/hooks/useGuide.js"),S=require("./modules/guide/hooks/useGuides.js"),m=require("./modules/guide/hooks/useGuideContext.js"),r=require("./modules/ms-teams/context/KnockMsTeamsProvider.js"),q=require("./modules/ms-teams/hooks/useMsTeamsConnectionStatus.js"),v=require("./modules/ms-teams/hooks/useMsTeamsAuth.js"),T=require("./modules/ms-teams/hooks/useMsTeamsTeams.js"),h=require("./modules/ms-teams/hooks/useMsTeamsChannels.js"),M=require("./modules/ms-teams/hooks/useConnectedMsTeamsChannels.js"),u=require("./modules/slack/context/KnockSlackProvider.js"),f=require("./modules/slack/hooks/useSlackConnectionStatus.js"),G=require("./modules/slack/hooks/useSlackChannels.js"),g=require("./modules/slack/hooks/useConnectedSlackChannels.js"),A=require("./modules/slack/hooks/useSlackAuth.js"),i=require("./modules/i18n/context/KnockI18nProvider.js"),F=require("./modules/i18n/hooks/useTranslations.js"),y=require("./modules/i18n/languages/index.js"),b=require("./modules/preferences/hooks/usePreferences.js"),x=require("@tanstack/react-store");exports.KnockProvider=s.KnockProvider;exports.useKnockClient=s.useKnockClient;exports.useAuthenticatedKnockClient=c;exports.useStableOptions=a;exports.useAuthPostMessageListener=d.useAuthPostMessageListener;exports.useAuthPolling=l.useAuthPolling;exports.FilterStatus=k.FilterStatus;exports.feedProviderKey=e.feedProviderKey;exports.formatBadgeCount=e.formatBadgeCount;exports.formatTimestamp=e.formatTimestamp;exports.msTeamsProviderKey=e.msTeamsProviderKey;exports.renderNodeOrFallback=e.renderNodeOrFallback;exports.slackProviderKey=e.slackProviderKey;exports.toSentenceCase=e.toSentenceCase;exports.KnockFeedProvider=n.KnockFeedProvider;exports.useKnockFeed=n.useKnockFeed;exports.useNotifications=C;exports.useFeedSettings=K;exports.useCreateNotificationStore=t.useCreateNotificationStore;exports.useNotificationStore=t.default;exports.KnockGuideContext=o.KnockGuideContext;exports.KnockGuideProvider=o.KnockGuideProvider;exports.useGuide=P.useGuide;exports.useGuides=S.useGuides;exports.useGuideContext=m.useGuideContext;exports.KnockMsTeamsProvider=r.KnockMsTeamsProvider;exports.useKnockMsTeamsClient=r.useKnockMsTeamsClient;exports.useMsTeamsConnectionStatus=q;exports.useMsTeamsAuth=v;exports.useMsTeamsTeams=T;exports.useMsTeamsChannels=h;exports.useConnectedMsTeamsChannels=M;exports.KnockSlackProvider=u.KnockSlackProvider;exports.useKnockSlackClient=u.useKnockSlackClient;exports.useSlackConnectionStatus=f;exports.useSlackChannels=G;exports.useConnectedSlackChannels=g;exports.useSlackAuth=A;exports.I18nContext=i.I18nContext;exports.KnockI18nProvider=i.KnockI18nProvider;exports.useTranslations=F.useTranslations;exports.locales=y.locales;exports.usePreferences=b.usePreferences;Object.defineProperty(exports,"useStore",{enumerable:!0,get:()=>x.useStore});
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("./modules/core/context/KnockProvider.js"),c=require("./modules/core/hooks/useAuthenticatedKnockClient.js"),a=require("./modules/core/hooks/useStableOptions.js"),d=require("./modules/core/hooks/useAuthPostMessageListener.js"),l=require("./modules/core/hooks/useAuthPolling.js"),k=require("./modules/core/constants.js"),e=require("./modules/core/utils.js"),n=require("./modules/feed/context/KnockFeedProvider.js"),C=require("./modules/feed/hooks/useNotifications.js"),K=require("./modules/feed/hooks/useFeedSettings.js"),t=require("./modules/feed/hooks/useNotificationStore.js"),r=require("./modules/guide/context/KnockGuideProvider.js"),P=require("./modules/guide/hooks/useGuide.js"),S=require("./modules/guide/hooks/useGuides.js"),m=require("./modules/guide/hooks/useGuideContext.js"),o=require("./modules/ms-teams/context/KnockMsTeamsProvider.js"),q=require("./modules/ms-teams/hooks/useMsTeamsConnectionStatus.js"),v=require("./modules/ms-teams/hooks/useMsTeamsAuth.js"),T=require("./modules/ms-teams/hooks/useMsTeamsTeams.js"),h=require("./modules/ms-teams/hooks/useMsTeamsChannels.js"),M=require("./modules/ms-teams/hooks/useConnectedMsTeamsChannels.js"),u=require("./modules/slack/context/KnockSlackProvider.js"),f=require("./modules/slack/hooks/useSlackConnectionStatus.js"),g=require("./modules/slack/hooks/useSlackChannels.js"),A=require("./modules/slack/hooks/useConnectedSlackChannels.js"),G=require("./modules/slack/hooks/useSlackAuth.js"),i=require("./modules/i18n/context/KnockI18nProvider.js"),F=require("./modules/i18n/hooks/useTranslations.js"),b=require("./modules/i18n/languages/index.js"),y=require("./modules/preferences/hooks/usePreferences.js"),x=require("@tanstack/react-store");exports.KnockProvider=s.KnockProvider;exports.useKnockClient=s.useKnockClient;exports.useAuthenticatedKnockClient=c;exports.useStableOptions=a;exports.useAuthPostMessageListener=d.useAuthPostMessageListener;exports.useAuthPolling=l.useAuthPolling;exports.FilterStatus=k.FilterStatus;exports.feedProviderKey=e.feedProviderKey;exports.formatBadgeCount=e.formatBadgeCount;exports.formatTimestamp=e.formatTimestamp;exports.getBadgeAriaLabel=e.getBadgeAriaLabel;exports.msTeamsProviderKey=e.msTeamsProviderKey;exports.renderNodeOrFallback=e.renderNodeOrFallback;exports.slackProviderKey=e.slackProviderKey;exports.toSentenceCase=e.toSentenceCase;exports.KnockFeedProvider=n.KnockFeedProvider;exports.useKnockFeed=n.useKnockFeed;exports.useNotifications=C;exports.useFeedSettings=K;exports.useCreateNotificationStore=t.useCreateNotificationStore;exports.useNotificationStore=t.default;exports.KnockGuideContext=r.KnockGuideContext;exports.KnockGuideProvider=r.KnockGuideProvider;exports.useGuide=P.useGuide;exports.useGuides=S.useGuides;exports.useGuideContext=m.useGuideContext;exports.KnockMsTeamsProvider=o.KnockMsTeamsProvider;exports.useKnockMsTeamsClient=o.useKnockMsTeamsClient;exports.useMsTeamsConnectionStatus=q;exports.useMsTeamsAuth=v;exports.useMsTeamsTeams=T;exports.useMsTeamsChannels=h;exports.useConnectedMsTeamsChannels=M;exports.KnockSlackProvider=u.KnockSlackProvider;exports.useKnockSlackClient=u.useKnockSlackClient;exports.useSlackConnectionStatus=f;exports.useSlackChannels=g;exports.useConnectedSlackChannels=A;exports.useSlackAuth=G;exports.I18nContext=i.I18nContext;exports.KnockI18nProvider=i.KnockI18nProvider;exports.useTranslations=F.useTranslations;exports.locales=b.locales;exports.usePreferences=y.usePreferences;Object.defineProperty(exports,"useStore",{enumerable:!0,get:()=>x.useStore});
 //# sourceMappingURL=index.js.map

package/dist/cjs/modules/core/utils.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("date-fns");function i(e){return e>9?"9+":e}function c(e,t={}){try{const r=o.parseISO(e);return o.intlFormatDistance(r,new Date,{locale:t.locale})}catch{return e}}function d(e){return e.charAt(0).toUpperCase()+e.slice(1)}function l(e,t){return e!==void 0?e:t}function u(e,t,r={}){return[e,t,r.source,r.tenant,r.has_tenant,r.archived].filter(n=>n!=null).join("-")}function s({knockSlackChannelId:e,tenantId:t,connectionStatus:r,errorLabel:n}){return[e,t,r,n].filter(a=>a!=null).join("-")}function f({knockMsTeamsChannelId:e,tenantId:t,connectionStatus:r,errorLabel:n}){return[e,t,r,n].filter(a=>a!=null).join("-")}exports.feedProviderKey=u;exports.formatBadgeCount=i;exports.formatTimestamp=c;exports.msTeamsProviderKey=f;exports.renderNodeOrFallback=l;exports.slackProviderKey=s;exports.toSentenceCase=d;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("date-fns");function i(e){return e>9?"9+":e}function c(e,t){const r=t==="all"?"":`${t} `;return`${e} ${r}${e===1?"notification":"notifications"}`}function l(e,t={}){try{const r=o.parseISO(e);return o.intlFormatDistance(r,new Date,{locale:t.locale})}catch{return e}}function u(e){return e.charAt(0).toUpperCase()+e.slice(1)}function d(e,t){return e!==void 0?e:t}function s(e,t,r={}){return[e,t,r.source,r.tenant,r.has_tenant,r.archived].filter(n=>n!=null).join("-")}function f({knockSlackChannelId:e,tenantId:t,connectionStatus:r,errorLabel:n}){return[e,t,r,n].filter(a=>a!=null).join("-")}function m({knockMsTeamsChannelId:e,tenantId:t,connectionStatus:r,errorLabel:n}){return[e,t,r,n].filter(a=>a!=null).join("-")}exports.feedProviderKey=s;exports.formatBadgeCount=i;exports.formatTimestamp=l;exports.getBadgeAriaLabel=c;exports.msTeamsProviderKey=m;exports.renderNodeOrFallback=d;exports.slackProviderKey=f;exports.toSentenceCase=u;
 //# sourceMappingURL=utils.js.map

package/dist/cjs/modules/core/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sources":["../../../../src/modules/core/utils.ts"],"sourcesContent":["import Knock, { FeedClientOptions } from \"@knocklabs/client\";\nimport { intlFormatDistance, parseISO } from \"date-fns\";\nimport { ReactNode } from \"react\";\n\nexport function formatBadgeCount(count: number): string | number {\n  return count > 9 ? \"9+\" : count;\n}\n\ntype FormatTimestampOptions = {\n  locale?: string | string[];\n};\n\nexport function formatTimestamp(\n  ts: string,\n  options: FormatTimestampOptions = {},\n) {\n  try {\n    const parsedTs = parseISO(ts);\n    const formatted = intlFormatDistance(parsedTs, new Date(), {\n      locale: options.locale,\n    });\n\n    return formatted;\n  } catch (_e) {\n    return ts;\n  }\n}\n\nexport function toSentenceCase(string: string): string {\n  return string.charAt(0).toUpperCase() + string.slice(1);\n}\n\nexport function renderNodeOrFallback(node: ReactNode, fallback: ReactNode) {\n  return node !== undefined ? node : fallback;\n}\n\n/*\n  Used to build a consistent key for the KnockFeedProvider so that React knows when\n  to trigger a re-render of the context when a key property changes.\n*/\nexport function feedProviderKey(\n  userId: Knock[\"userId\"],\n  feedId: string,\n  options: FeedClientOptions = {},\n) {\n  return [\n    userId,\n    feedId,\n    options.source,\n    options.tenant,\n    options.has_tenant,\n    options.archived,\n  ]\n    .filter((f) => f !== null && f !== undefined)\n    .join(\"-\");\n}\n\n/*\n  Used to build a consistent key for the KnockSlackProvider so that React knows when\n  to trigger a re-render of the context when a key property changes.\n*/\nexport function slackProviderKey({\n  knockSlackChannelId,\n  tenantId,\n  connectionStatus,\n  errorLabel,\n}: {\n  knockSlackChannelId: string;\n  tenantId: string;\n  connectionStatus: string;\n  errorLabel: string | null;\n}) {\n  return [knockSlackChannelId, tenantId, connectionStatus, errorLabel]\n    .filter((f) => f !== null && f !== undefined)\n    .join(\"-\");\n}\n\n/*\n  Used to build a consistent key for the KnockMsTeamsProvider so that React knows when\n  to trigger a re-render of the context when a key property changes.\n*/\nexport function msTeamsProviderKey({\n  knockMsTeamsChannelId,\n  tenantId,\n  connectionStatus,\n  errorLabel,\n}: {\n  knockMsTeamsChannelId: string;\n  tenantId: string;\n  connectionStatus: string;\n  errorLabel: string | null;\n}) {\n  return [knockMsTeamsChannelId, tenantId, connectionStatus, errorLabel]\n    .filter((f) => f !== null && f !== undefined)\n    .join(\"-\");\n}\n"],"names":["formatBadgeCount","count","formatTimestamp","ts","options","parsedTs","parseISO","formatted","intlFormatDistance","Date","locale","toSentenceCase","string","charAt","toUpperCase","slice","renderNodeOrFallback","node","fallback","undefined","feedProviderKey","userId","feedId","source","tenant","has_tenant","archived","filter","f","join","slackProviderKey","knockSlackChannelId","tenantId","connectionStatus","errorLabel","msTeamsProviderKey","knockMsTeamsChannelId"],"mappings":"4GAIO,SAASA,EAAiBC,EAAgC,CACxDA,OAAAA,EAAQ,EAAI,KAAOA,CAC5B,CAMO,SAASC,EACdC,EACAC,EAAkC,GAClC,CACI,GAAA,CACIC,MAAAA,EAAWC,WAASH,CAAE,EAKrBI,OAJWC,EAAAA,mBAAmBH,EAAU,IAAII,KAAQ,CACzDC,OAAQN,EAAQM,MAAAA,CACjB,OAGU,CACJP,OAAAA,CAAAA,CAEX,CAEO,SAASQ,EAAeC,EAAwB,CAC9CA,OAAAA,EAAOC,OAAO,CAAC,EAAEC,cAAgBF,EAAOG,MAAM,CAAC,CACxD,CAEgBC,SAAAA,EAAqBC,EAAiBC,EAAqB,CAClED,OAAAA,IAASE,OAAYF,EAAOC,CACrC,CAMO,SAASE,EACdC,EACAC,EACAlB,EAA6B,CAAA,EAC7B,CACO,MAAA,CACLiB,EACAC,EACAlB,EAAQmB,OACRnB,EAAQoB,OACRpB,EAAQqB,WACRrB,EAAQsB,QAAQ,EAEfC,UAAcC,GAAM,IAAuB,EAC3CC,KAAK,GAAG,CACb,CAMO,SAASC,EAAiB,CAC/BC,oBAAAA,EACAC,SAAAA,EACAC,iBAAAA,EACAC,WAAAA,CAMF,EAAG,CACD,MAAO,CAACH,EAAqBC,EAAUC,EAAkBC,CAAU,EAChEP,OAAcC,GAAAA,GAAM,IAAuB,EAC3CC,KAAK,GAAG,CACb,CAMO,SAASM,EAAmB,CACjCC,sBAAAA,EACAJ,SAAAA,EACAC,iBAAAA,EACAC,WAAAA,CAMF,EAAG,CACD,MAAO,CAACE,EAAuBJ,EAAUC,EAAkBC,CAAU,EAClEP,OAAcC,GAAAA,GAAM,IAAuB,EAC3CC,KAAK,GAAG,CACb"}
+{"version":3,"file":"utils.js","sources":["../../../../src/modules/core/utils.ts"],"sourcesContent":["import Knock, { FeedClientOptions } from \"@knocklabs/client\";\nimport { intlFormatDistance, parseISO } from \"date-fns\";\nimport { ReactNode } from \"react\";\n\nimport { BadgeCountType } from \"./types\";\n\nexport function formatBadgeCount(count: number): string | number {\n  return count > 9 ? \"9+\" : count;\n}\n\n/**\n * Returns a string that describes the badge count and type.\n *\n * `all` = \"12 notifications\"\n * `unread` = \"1 unread notification\"\n * `unseen` = \"7 unseen notifications\"\n */\nexport function getBadgeAriaLabel(\n  count: number,\n  badgeCountType: BadgeCountType,\n): string {\n  const qualifier = badgeCountType === \"all\" ? \"\" : `${badgeCountType} `;\n  const noun = count === 1 ? \"notification\" : \"notifications\";\n  return `${count} ${qualifier}${noun}`;\n}\n\ntype FormatTimestampOptions = {\n  locale?: string | string[];\n};\n\nexport function formatTimestamp(\n  ts: string,\n  options: FormatTimestampOptions = {},\n) {\n  try {\n    const parsedTs = parseISO(ts);\n    const formatted = intlFormatDistance(parsedTs, new Date(), {\n      locale: options.locale,\n    });\n\n    return formatted;\n  } catch (_e) {\n    return ts;\n  }\n}\n\nexport function toSentenceCase(string: string): string {\n  return string.charAt(0).toUpperCase() + string.slice(1);\n}\n\nexport function renderNodeOrFallback(node: ReactNode, fallback: ReactNode) {\n  return node !== undefined ? node : fallback;\n}\n\n/*\n  Used to build a consistent key for the KnockFeedProvider so that React knows when\n  to trigger a re-render of the context when a key property changes.\n*/\nexport function feedProviderKey(\n  userId: Knock[\"userId\"],\n  feedId: string,\n  options: FeedClientOptions = {},\n) {\n  return [\n    userId,\n    feedId,\n    options.source,\n    options.tenant,\n    options.has_tenant,\n    options.archived,\n  ]\n    .filter((f) => f !== null && f !== undefined)\n    .join(\"-\");\n}\n\n/*\n  Used to build a consistent key for the KnockSlackProvider so that React knows when\n  to trigger a re-render of the context when a key property changes.\n*/\nexport function slackProviderKey({\n  knockSlackChannelId,\n  tenantId,\n  connectionStatus,\n  errorLabel,\n}: {\n  knockSlackChannelId: string;\n  tenantId: string;\n  connectionStatus: string;\n  errorLabel: string | null;\n}) {\n  return [knockSlackChannelId, tenantId, connectionStatus, errorLabel]\n    .filter((f) => f !== null && f !== undefined)\n    .join(\"-\");\n}\n\n/*\n  Used to build a consistent key for the KnockMsTeamsProvider so that React knows when\n  to trigger a re-render of the context when a key property changes.\n*/\nexport function msTeamsProviderKey({\n  knockMsTeamsChannelId,\n  tenantId,\n  connectionStatus,\n  errorLabel,\n}: {\n  knockMsTeamsChannelId: string;\n  tenantId: string;\n  connectionStatus: string;\n  errorLabel: string | null;\n}) {\n  return [knockMsTeamsChannelId, tenantId, connectionStatus, errorLabel]\n    .filter((f) => f !== null && f !== undefined)\n    .join(\"-\");\n}\n"],"names":["formatBadgeCount","count","getBadgeAriaLabel","badgeCountType","qualifier","formatTimestamp","ts","options","parsedTs","parseISO","formatted","intlFormatDistance","Date","locale","toSentenceCase","string","charAt","toUpperCase","slice","renderNodeOrFallback","node","fallback","undefined","feedProviderKey","userId","feedId","source","tenant","has_tenant","archived","filter","f","join","slackProviderKey","knockSlackChannelId","tenantId","connectionStatus","errorLabel","msTeamsProviderKey","knockMsTeamsChannelId"],"mappings":"4GAMO,SAASA,EAAiBC,EAAgC,CACxDA,OAAAA,EAAQ,EAAI,KAAOA,CAC5B,CASgBC,SAAAA,EACdD,EACAE,EACQ,CACR,MAAMC,EAAYD,IAAmB,MAAQ,GAAK,GAAGA,CAAc,IAEnE,MAAO,GAAGF,CAAK,IAAIG,CAAS,GADfH,IAAU,EAAI,eAAiB,eACT,EACrC,CAMO,SAASI,EACdC,EACAC,EAAkC,GAClC,CACI,GAAA,CACIC,MAAAA,EAAWC,WAASH,CAAE,EAKrBI,OAJWC,EAAAA,mBAAmBH,EAAU,IAAII,KAAQ,CACzDC,OAAQN,EAAQM,MAAAA,CACjB,OAGU,CACJP,OAAAA,CAAAA,CAEX,CAEO,SAASQ,EAAeC,EAAwB,CAC9CA,OAAAA,EAAOC,OAAO,CAAC,EAAEC,cAAgBF,EAAOG,MAAM,CAAC,CACxD,CAEgBC,SAAAA,EAAqBC,EAAiBC,EAAqB,CAClED,OAAAA,IAASE,OAAYF,EAAOC,CACrC,CAMO,SAASE,EACdC,EACAC,EACAlB,EAA6B,CAAA,EAC7B,CACO,MAAA,CACLiB,EACAC,EACAlB,EAAQmB,OACRnB,EAAQoB,OACRpB,EAAQqB,WACRrB,EAAQsB,QAAQ,EAEfC,UAAcC,GAAM,IAAuB,EAC3CC,KAAK,GAAG,CACb,CAMO,SAASC,EAAiB,CAC/BC,oBAAAA,EACAC,SAAAA,EACAC,iBAAAA,EACAC,WAAAA,CAMF,EAAG,CACD,MAAO,CAACH,EAAqBC,EAAUC,EAAkBC,CAAU,EAChEP,OAAcC,GAAAA,GAAM,IAAuB,EAC3CC,KAAK,GAAG,CACb,CAMO,SAASM,EAAmB,CACjCC,sBAAAA,EACAJ,SAAAA,EACAC,iBAAAA,EACAC,WAAAA,CAMF,EAAG,CACD,MAAO,CAACE,EAAuBJ,EAAUC,EAAkBC,CAAU,EAClEP,OAAcC,GAAAA,GAAM,IAAuB,EAC3CC,KAAK,GAAG,CACb"}

package/dist/cjs/modules/guide/context/KnockGuideProvider.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const k=require("@knocklabs/client"),p=require("react"),K=require("../../core/context/KnockProvider.js"),P=require("../../core/hooks/useStableOptions.js");require("date-fns");function m(e){if(e&&typeof e=="object"&&"default"in e)return e;const r=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(e){for(const t in e)if(t!=="default"){const c=Object.getOwnPropertyDescriptor(e,t);Object.defineProperty(r,t,c.get?c:{enumerable:!0,get:()=>e[t]})}}return r.default=e,Object.freeze(r)}const o=m(p),l=o.createContext(void 0),v=({channelId:e,readyToTarget:r,listenForUpdates:t=!0,colorMode:c="light",targetParams:f={},trackLocationFromWindow:u=!0,orderResolutionDuration:s=0,throttleCheckInterval:a,children:b})=>{let i;try{i=K.useKnockClient()}catch{throw new Error("KnockGuideProvider must be used within a KnockProvider")}const d=P(f),n=o.useMemo(()=>new k.KnockGuideClient(i,e,d,{trackLocationFromWindow:u,orderResolutionDuration:s,throttleCheckInterval:a}),[i,e,d,u,s,a]);return o.useEffect(()=>(r&&(n.fetch(),t&&n.subscribe()),()=>n.cleanup()),[r,t,n]),o.createElement(l.Provider,{value:{client:n,colorMode:c}},b)};exports.KnockGuideContext=l;exports.KnockGuideProvider=v;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=require("@knocklabs/client"),K=require("react"),v=require("../../core/context/KnockProvider.js"),P=require("../../core/hooks/useStableOptions.js");require("date-fns");function m(e){if(e&&typeof e=="object"&&"default"in e)return e;const r=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(r,t,o.get?o:{enumerable:!0,get:()=>e[t]})}}return r.default=e,Object.freeze(r)}const c=m(K),a=c.createContext(void 0),g=({channelId:e,readyToTarget:r,listenForUpdates:t=!0,colorMode:o="light",targetParams:b={},trackLocationFromWindow:u=!0,trackDebugParams:s=!1,orderResolutionDuration:l=0,throttleCheckInterval:d,children:k})=>{let i;try{i=v.useKnockClient()}catch{throw new Error("KnockGuideProvider must be used within a KnockProvider")}const f=P(b),n=c.useMemo(()=>new p.KnockGuideClient(i,e,f,{trackLocationFromWindow:u,trackDebugParams:s,orderResolutionDuration:l,throttleCheckInterval:d}),[i,e,f,u,s,l,d]);return c.useEffect(()=>(r&&(n.fetch(),t&&n.subscribe()),()=>n.cleanup()),[r,t,n]),c.createElement(a.Provider,{value:{client:n,colorMode:o}},k)};exports.KnockGuideContext=a;exports.KnockGuideProvider=g;
 //# sourceMappingURL=KnockGuideProvider.js.map

package/dist/cjs/modules/guide/context/KnockGuideProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"KnockGuideProvider.js","sources":["../../../../../src/modules/guide/context/KnockGuideProvider.tsx"],"sourcesContent":["import Knock, {\n  KnockGuideClient,\n  KnockGuideTargetParams,\n} from \"@knocklabs/client\";\nimport * as React from \"react\";\n\nimport { useKnockClient, useStableOptions } from \"../../core\";\nimport { ColorMode } from \"../../core/constants\";\n\ntype KnockGuideProviderValue = {\n  client: KnockGuideClient;\n  colorMode: ColorMode;\n};\n\nexport const KnockGuideContext = React.createContext<\n  KnockGuideProviderValue | undefined\n>(undefined);\n\nexport type KnockGuideProviderProps = {\n  channelId: string;\n  readyToTarget: boolean;\n  listenForUpdates?: boolean;\n  colorMode?: ColorMode;\n  targetParams?: KnockGuideTargetParams;\n  trackLocationFromWindow?: boolean;\n  orderResolutionDuration?: number; // in milliseconds\n  throttleCheckInterval?: number; // in milliseconds\n};\n\nexport const KnockGuideProvider: React.FC<\n  React.PropsWithChildren<KnockGuideProviderProps>\n> = ({\n  channelId,\n  readyToTarget,\n  listenForUpdates = true,\n  colorMode = \"light\",\n  targetParams = {},\n  trackLocationFromWindow = true,\n  // Default to 0 which works well for react apps as this \"yields\" to react for\n  // one render cyle first and close the group stage.\n  orderResolutionDuration = 0,\n  throttleCheckInterval,\n  children,\n}) => {\n  let knock: Knock;\n\n  try {\n    knock = useKnockClient();\n  } catch (_) {\n    throw new Error(\"KnockGuideProvider must be used within a KnockProvider\");\n  }\n\n  const stableTargetParams = useStableOptions(targetParams);\n\n  const knockGuideClient = React.useMemo(() => {\n    return new KnockGuideClient(knock, channelId, stableTargetParams, {\n      trackLocationFromWindow,\n      orderResolutionDuration,\n      throttleCheckInterval,\n    });\n  }, [\n    knock,\n    channelId,\n    stableTargetParams,\n    trackLocationFromWindow,\n    orderResolutionDuration,\n    throttleCheckInterval,\n  ]);\n\n  React.useEffect(() => {\n    if (readyToTarget) {\n      knockGuideClient.fetch();\n      if (listenForUpdates) knockGuideClient.subscribe();\n    }\n\n    return () => knockGuideClient.cleanup();\n  }, [readyToTarget, listenForUpdates, knockGuideClient]);\n\n  return (\n    <KnockGuideContext.Provider\n      value={{\n        client: knockGuideClient,\n        colorMode,\n      }}\n    >\n      {children}\n    </KnockGuideContext.Provider>\n  );\n};\n"],"names":["KnockGuideContext","React","createContext","undefined","KnockGuideProvider","channelId","readyToTarget","listenForUpdates","colorMode","targetParams","trackLocationFromWindow","orderResolutionDuration","throttleCheckInterval","children","knock","useKnockClient","Error","stableTargetParams","useStableOptions","knockGuideClient","useMemo","KnockGuideClient","useEffect","fetch","subscribe","cleanup","client"],"mappings":"0kBAcaA,EAAoBC,EAAMC,cAErCC,MAAS,EAaEC,EAETA,CAAC,CACHC,UAAAA,EACAC,cAAAA,EACAC,iBAAAA,EAAmB,GACnBC,UAAAA,EAAY,QACZC,aAAAA,EAAe,CAAC,EAChBC,wBAAAA,EAA0B,GAG1BC,wBAAAA,EAA0B,EAC1BC,sBAAAA,EACAC,SAAAA,CACF,IAAM,CACAC,IAAAA,EAEA,GAAA,CACFA,EAAQC,EAAAA,eAAe,OACb,CACJ,MAAA,IAAIC,MAAM,wDAAwD,CAAA,CAGpEC,MAAAA,EAAqBC,EAAiBT,CAAY,EAElDU,EAAmBlB,EAAMmB,QAAQ,IAC9B,IAAIC,EAAAA,iBAAiBP,EAAOT,EAAWY,EAAoB,CAChEP,wBAAAA,EACAC,wBAAAA,EACAC,sBAAAA,CAAAA,CACD,EACA,CACDE,EACAT,EACAY,EACAP,EACAC,EACAC,CAAqB,CACtB,EAEDX,OAAAA,EAAMqB,UAAU,KACVhB,IACFa,EAAiBI,MAAM,EACnBhB,KAAmCiB,UAAU,GAG5C,IAAML,EAAiBM,QAAQ,GACrC,CAACnB,EAAeC,EAAkBY,CAAgB,CAAC,EAGnDlB,EAAA,cAAAD,EAAkB,SAAlB,CACC,MAAO,CACL0B,OAAQP,EACRX,UAAAA,IAGDK,CACH,CAEJ"}
+{"version":3,"file":"KnockGuideProvider.js","sources":["../../../../../src/modules/guide/context/KnockGuideProvider.tsx"],"sourcesContent":["import Knock, {\n  KnockGuideClient,\n  KnockGuideTargetParams,\n} from \"@knocklabs/client\";\nimport * as React from \"react\";\n\nimport { useKnockClient, useStableOptions } from \"../../core\";\nimport { ColorMode } from \"../../core/constants\";\n\ntype KnockGuideProviderValue = {\n  client: KnockGuideClient;\n  colorMode: ColorMode;\n};\n\nexport const KnockGuideContext = React.createContext<\n  KnockGuideProviderValue | undefined\n>(undefined);\n\nexport type KnockGuideProviderProps = {\n  channelId: string;\n  readyToTarget: boolean;\n  listenForUpdates?: boolean;\n  colorMode?: ColorMode;\n  targetParams?: KnockGuideTargetParams;\n  trackLocationFromWindow?: boolean;\n  trackDebugParams?: boolean;\n  orderResolutionDuration?: number; // in milliseconds\n  throttleCheckInterval?: number; // in milliseconds\n};\n\nexport const KnockGuideProvider: React.FC<\n  React.PropsWithChildren<KnockGuideProviderProps>\n> = ({\n  channelId,\n  readyToTarget,\n  listenForUpdates = true,\n  colorMode = \"light\",\n  targetParams = {},\n  trackLocationFromWindow = true,\n  // Whether the guide client should look for debug params in url/local storage\n  // to launch guide toolbar. Set to true if using toolbar v1.\n  // TODO(KNO-11523): Remove this once we ship v2.\n  trackDebugParams = false,\n  // Default to 0 which works well for react apps as this \"yields\" to react for\n  // one render cyle first and close the group stage.\n  orderResolutionDuration = 0,\n  throttleCheckInterval,\n  children,\n}) => {\n  let knock: Knock;\n\n  try {\n    knock = useKnockClient();\n  } catch (_) {\n    throw new Error(\"KnockGuideProvider must be used within a KnockProvider\");\n  }\n\n  const stableTargetParams = useStableOptions(targetParams);\n\n  const knockGuideClient = React.useMemo(() => {\n    return new KnockGuideClient(knock, channelId, stableTargetParams, {\n      trackLocationFromWindow,\n      trackDebugParams,\n      orderResolutionDuration,\n      throttleCheckInterval,\n    });\n  }, [\n    knock,\n    channelId,\n    stableTargetParams,\n    trackLocationFromWindow,\n    trackDebugParams,\n    orderResolutionDuration,\n    throttleCheckInterval,\n  ]);\n\n  React.useEffect(() => {\n    if (readyToTarget) {\n      knockGuideClient.fetch();\n      if (listenForUpdates) knockGuideClient.subscribe();\n    }\n\n    return () => knockGuideClient.cleanup();\n  }, [readyToTarget, listenForUpdates, knockGuideClient]);\n\n  return (\n    <KnockGuideContext.Provider\n      value={{\n        client: knockGuideClient,\n        colorMode,\n      }}\n    >\n      {children}\n    </KnockGuideContext.Provider>\n  );\n};\n"],"names":["KnockGuideContext","React","createContext","undefined","KnockGuideProvider","channelId","readyToTarget","listenForUpdates","colorMode","targetParams","trackLocationFromWindow","trackDebugParams","orderResolutionDuration","throttleCheckInterval","children","knock","useKnockClient","Error","stableTargetParams","useStableOptions","knockGuideClient","useMemo","KnockGuideClient","useEffect","fetch","subscribe","cleanup","client"],"mappings":"0kBAcaA,EAAoBC,EAAMC,cAErCC,MAAS,EAcEC,EAETA,CAAC,CACHC,UAAAA,EACAC,cAAAA,EACAC,iBAAAA,EAAmB,GACnBC,UAAAA,EAAY,QACZC,aAAAA,EAAe,CAAC,EAChBC,wBAAAA,EAA0B,GAI1BC,iBAAAA,EAAmB,GAGnBC,wBAAAA,EAA0B,EAC1BC,sBAAAA,EACAC,SAAAA,CACF,IAAM,CACAC,IAAAA,EAEA,GAAA,CACFA,EAAQC,EAAAA,eAAe,OACb,CACJ,MAAA,IAAIC,MAAM,wDAAwD,CAAA,CAGpEC,MAAAA,EAAqBC,EAAiBV,CAAY,EAElDW,EAAmBnB,EAAMoB,QAAQ,IAC9B,IAAIC,EAAAA,iBAAiBP,EAAOV,EAAWa,EAAoB,CAChER,wBAAAA,EACAC,iBAAAA,EACAC,wBAAAA,EACAC,sBAAAA,CAAAA,CACD,EACA,CACDE,EACAV,EACAa,EACAR,EACAC,EACAC,EACAC,CAAqB,CACtB,EAEDZ,OAAAA,EAAMsB,UAAU,KACVjB,IACFc,EAAiBI,MAAM,EACnBjB,KAAmCkB,UAAU,GAG5C,IAAML,EAAiBM,QAAQ,GACrC,CAACpB,EAAeC,EAAkBa,CAAgB,CAAC,EAGnDnB,EAAA,cAAAD,EAAkB,SAAlB,CACC,MAAO,CACL2B,OAAQP,EACRZ,UAAAA,IAGDM,CACH,CAEJ"}

package/dist/esm/index.mjs

@@ -4,75 +4,76 @@ import { default as n } from "./modules/core/hooks/useStableOptions.mjs";
 import { useAuthPostMessageListener as m } from "./modules/core/hooks/useAuthPostMessageListener.mjs";
 import { useAuthPolling as l } from "./modules/core/hooks/useAuthPolling.mjs";
 import { FilterStatus as x } from "./modules/core/constants.mjs";
-import { feedProviderKey as c, formatBadgeCount as k, formatTimestamp as C, msTeamsProviderKey as K, renderNodeOrFallback as S, slackProviderKey as P, toSentenceCase as T } from "./modules/core/utils.mjs";
-import { KnockFeedProvider as v, useKnockFeed as M } from "./modules/feed/context/KnockFeedProvider.mjs";
+import { feedProviderKey as c, formatBadgeCount as k, formatTimestamp as C, getBadgeAriaLabel as K, msTeamsProviderKey as S, renderNodeOrFallback as P, slackProviderKey as T, toSentenceCase as h } from "./modules/core/utils.mjs";
+import { KnockFeedProvider as M, useKnockFeed as g } from "./modules/feed/context/KnockFeedProvider.mjs";
 import { default as F } from "./modules/feed/hooks/useNotifications.mjs";
-import { default as g } from "./modules/feed/hooks/useFeedSettings.mjs";
-import { useCreateNotificationStore as y, default as b } from "./modules/feed/hooks/useNotificationStore.mjs";
-import { KnockGuideContext as O, KnockGuideProvider as B } from "./modules/guide/context/KnockGuideProvider.mjs";
-import { useGuide as j } from "./modules/guide/hooks/useGuide.mjs";
-import { useGuides as w } from "./modules/guide/hooks/useGuides.mjs";
-import { useGuideContext as D } from "./modules/guide/hooks/useGuideContext.mjs";
-import { KnockMsTeamsProvider as H, useKnockMsTeamsClient as J } from "./modules/ms-teams/context/KnockMsTeamsProvider.mjs";
-import { default as R } from "./modules/ms-teams/hooks/useMsTeamsConnectionStatus.mjs";
-import { default as V } from "./modules/ms-teams/hooks/useMsTeamsAuth.mjs";
-import { default as X } from "./modules/ms-teams/hooks/useMsTeamsTeams.mjs";
-import { default as Z } from "./modules/ms-teams/hooks/useMsTeamsChannels.mjs";
-import { default as $ } from "./modules/ms-teams/hooks/useConnectedMsTeamsChannels.mjs";
-import { KnockSlackProvider as oe, useKnockSlackClient as te } from "./modules/slack/context/KnockSlackProvider.mjs";
-import { default as se } from "./modules/slack/hooks/useSlackConnectionStatus.mjs";
-import { default as ue } from "./modules/slack/hooks/useSlackChannels.mjs";
-import { default as fe } from "./modules/slack/hooks/useConnectedSlackChannels.mjs";
-import { default as de } from "./modules/slack/hooks/useSlackAuth.mjs";
-import { I18nContext as ie, KnockI18nProvider as xe } from "./modules/i18n/context/KnockI18nProvider.mjs";
-import { useTranslations as ce } from "./modules/i18n/hooks/useTranslations.mjs";
-import { locales as Ce } from "./modules/i18n/languages/index.mjs";
-import { usePreferences as Se } from "./modules/preferences/hooks/usePreferences.mjs";
-import { useStore as Te } from "@tanstack/react-store";
+import { default as N } from "./modules/feed/hooks/useFeedSettings.mjs";
+import { useCreateNotificationStore as y, default as B } from "./modules/feed/hooks/useNotificationStore.mjs";
+import { KnockGuideContext as L, KnockGuideProvider as O } from "./modules/guide/context/KnockGuideProvider.mjs";
+import { useGuide as q } from "./modules/guide/hooks/useGuide.mjs";
+import { useGuides as z } from "./modules/guide/hooks/useGuides.mjs";
+import { useGuideContext as E } from "./modules/guide/hooks/useGuideContext.mjs";
+import { KnockMsTeamsProvider as J, useKnockMsTeamsClient as Q } from "./modules/ms-teams/context/KnockMsTeamsProvider.mjs";
+import { default as U } from "./modules/ms-teams/hooks/useMsTeamsConnectionStatus.mjs";
+import { default as W } from "./modules/ms-teams/hooks/useMsTeamsAuth.mjs";
+import { default as Y } from "./modules/ms-teams/hooks/useMsTeamsTeams.mjs";
+import { default as _ } from "./modules/ms-teams/hooks/useMsTeamsChannels.mjs";
+import { default as ee } from "./modules/ms-teams/hooks/useConnectedMsTeamsChannels.mjs";
+import { KnockSlackProvider as te, useKnockSlackClient as re } from "./modules/slack/context/KnockSlackProvider.mjs";
+import { default as ae } from "./modules/slack/hooks/useSlackConnectionStatus.mjs";
+import { default as ne } from "./modules/slack/hooks/useSlackChannels.mjs";
+import { default as me } from "./modules/slack/hooks/useConnectedSlackChannels.mjs";
+import { default as le } from "./modules/slack/hooks/useSlackAuth.mjs";
+import { I18nContext as xe, KnockI18nProvider as pe } from "./modules/i18n/context/KnockI18nProvider.mjs";
+import { useTranslations as ke } from "./modules/i18n/hooks/useTranslations.mjs";
+import { locales as Ke } from "./modules/i18n/languages/index.mjs";
+import { usePreferences as Pe } from "./modules/preferences/hooks/usePreferences.mjs";
+import { useStore as he } from "@tanstack/react-store";
 export {
   x as FilterStatus,
-  ie as I18nContext,
-  v as KnockFeedProvider,
-  O as KnockGuideContext,
-  B as KnockGuideProvider,
-  xe as KnockI18nProvider,
-  H as KnockMsTeamsProvider,
+  xe as I18nContext,
+  M as KnockFeedProvider,
+  L as KnockGuideContext,
+  O as KnockGuideProvider,
+  pe as KnockI18nProvider,
+  J as KnockMsTeamsProvider,
   t as KnockProvider,
-  oe as KnockSlackProvider,
+  te as KnockSlackProvider,
   c as feedProviderKey,
   k as formatBadgeCount,
   C as formatTimestamp,
-  Ce as locales,
-  K as msTeamsProviderKey,
-  S as renderNodeOrFallback,
-  P as slackProviderKey,
-  T as toSentenceCase,
+  K as getBadgeAriaLabel,
+  Ke as locales,
+  S as msTeamsProviderKey,
+  P as renderNodeOrFallback,
+  T as slackProviderKey,
+  h as toSentenceCase,
   l as useAuthPolling,
   m as useAuthPostMessageListener,
   a as useAuthenticatedKnockClient,
-  $ as useConnectedMsTeamsChannels,
-  fe as useConnectedSlackChannels,
+  ee as useConnectedMsTeamsChannels,
+  me as useConnectedSlackChannels,
   y as useCreateNotificationStore,
-  g as useFeedSettings,
-  j as useGuide,
-  D as useGuideContext,
-  w as useGuides,
+  N as useFeedSettings,
+  q as useGuide,
+  E as useGuideContext,
+  z as useGuides,
   r as useKnockClient,
-  M as useKnockFeed,
-  J as useKnockMsTeamsClient,
-  te as useKnockSlackClient,
-  V as useMsTeamsAuth,
-  Z as useMsTeamsChannels,
-  R as useMsTeamsConnectionStatus,
-  X as useMsTeamsTeams,
-  b as useNotificationStore,
+  g as useKnockFeed,
+  Q as useKnockMsTeamsClient,
+  re as useKnockSlackClient,
+  W as useMsTeamsAuth,
+  _ as useMsTeamsChannels,
+  U as useMsTeamsConnectionStatus,
+  Y as useMsTeamsTeams,
+  B as useNotificationStore,
   F as useNotifications,
-  Se as usePreferences,
-  de as useSlackAuth,
-  ue as useSlackChannels,
-  se as useSlackConnectionStatus,
+  Pe as usePreferences,
+  le as useSlackAuth,
+  ne as useSlackChannels,
+  ae as useSlackConnectionStatus,
   n as useStableOptions,
-  Te as useStore,
-  ce as useTranslations
+  he as useStore,
+  ke as useTranslations
 };
 //# sourceMappingURL=index.mjs.map

package/dist/esm/modules/core/utils.mjs

@@ -1,12 +1,16 @@
-import { parseISO as a, intlFormatDistance as i } from "date-fns";
-function u(e) {
+import { parseISO as i, intlFormatDistance as a } from "date-fns";
+function l(e) {
   return e > 9 ? "9+" : e;
 }
-function l(e, t = {}) {
+function u(e, r) {
+  const n = r === "all" ? "" : `${r} `;
+  return `${e} ${n}${e === 1 ? "notification" : "notifications"}`;
+}
+function f(e, r = {}) {
   try {
-    const r = a(e);
-    return i(r, /* @__PURE__ */ new Date(), {
-      locale: t.locale
+    const n = i(e);
+    return a(n, /* @__PURE__ */ new Date(), {
+      locale: r.locale
     });
   } catch {
     return e;
@@ -15,35 +19,36 @@ function l(e, t = {}) {
 function d(e) {
   return e.charAt(0).toUpperCase() + e.slice(1);
 }
-function f(e, t) {
-  return e !== void 0 ? e : t;
+function s(e, r) {
+  return e !== void 0 ? e : r;
 }
-function m(e, t, r = {}) {
-  return [e, t, r.source, r.tenant, r.has_tenant, r.archived].filter((n) => n != null).join("-");
+function m(e, r, n = {}) {
+  return [e, r, n.source, n.tenant, n.has_tenant, n.archived].filter((t) => t != null).join("-");
 }
-function s({
+function v({
   knockSlackChannelId: e,
-  tenantId: t,
-  connectionStatus: r,
-  errorLabel: n
+  tenantId: r,
+  connectionStatus: n,
+  errorLabel: t
 }) {
-  return [e, t, r, n].filter((o) => o != null).join("-");
+  return [e, r, n, t].filter((o) => o != null).join("-");
 }
-function v({
+function h({
   knockMsTeamsChannelId: e,
-  tenantId: t,
-  connectionStatus: r,
-  errorLabel: n
+  tenantId: r,
+  connectionStatus: n,
+  errorLabel: t
 }) {
-  return [e, t, r, n].filter((o) => o != null).join("-");
+  return [e, r, n, t].filter((o) => o != null).join("-");
 }
 export {
   m as feedProviderKey,
-  u as formatBadgeCount,
-  l as formatTimestamp,
-  v as msTeamsProviderKey,
-  f as renderNodeOrFallback,
-  s as slackProviderKey,
+  l as formatBadgeCount,
+  f as formatTimestamp,
+  u as getBadgeAriaLabel,
+  h as msTeamsProviderKey,
+  s as renderNodeOrFallback,
+  v as slackProviderKey,
   d as toSentenceCase
 };
 //# sourceMappingURL=utils.mjs.map

package/dist/esm/modules/core/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.mjs","sources":["../../../../src/modules/core/utils.ts"],"sourcesContent":["import Knock, { FeedClientOptions } from \"@knocklabs/client\";\nimport { intlFormatDistance, parseISO } from \"date-fns\";\nimport { ReactNode } from \"react\";\n\nexport function formatBadgeCount(count: number): string | number {\n  return count > 9 ? \"9+\" : count;\n}\n\ntype FormatTimestampOptions = {\n  locale?: string | string[];\n};\n\nexport function formatTimestamp(\n  ts: string,\n  options: FormatTimestampOptions = {},\n) {\n  try {\n    const parsedTs = parseISO(ts);\n    const formatted = intlFormatDistance(parsedTs, new Date(), {\n      locale: options.locale,\n    });\n\n    return formatted;\n  } catch (_e) {\n    return ts;\n  }\n}\n\nexport function toSentenceCase(string: string): string {\n  return string.charAt(0).toUpperCase() + string.slice(1);\n}\n\nexport function renderNodeOrFallback(node: ReactNode, fallback: ReactNode) {\n  return node !== undefined ? node : fallback;\n}\n\n/*\n  Used to build a consistent key for the KnockFeedProvider so that React knows when\n  to trigger a re-render of the context when a key property changes.\n*/\nexport function feedProviderKey(\n  userId: Knock[\"userId\"],\n  feedId: string,\n  options: FeedClientOptions = {},\n) {\n  return [\n    userId,\n    feedId,\n    options.source,\n    options.tenant,\n    options.has_tenant,\n    options.archived,\n  ]\n    .filter((f) => f !== null && f !== undefined)\n    .join(\"-\");\n}\n\n/*\n  Used to build a consistent key for the KnockSlackProvider so that React knows when\n  to trigger a re-render of the context when a key property changes.\n*/\nexport function slackProviderKey({\n  knockSlackChannelId,\n  tenantId,\n  connectionStatus,\n  errorLabel,\n}: {\n  knockSlackChannelId: string;\n  tenantId: string;\n  connectionStatus: string;\n  errorLabel: string | null;\n}) {\n  return [knockSlackChannelId, tenantId, connectionStatus, errorLabel]\n    .filter((f) => f !== null && f !== undefined)\n    .join(\"-\");\n}\n\n/*\n  Used to build a consistent key for the KnockMsTeamsProvider so that React knows when\n  to trigger a re-render of the context when a key property changes.\n*/\nexport function msTeamsProviderKey({\n  knockMsTeamsChannelId,\n  tenantId,\n  connectionStatus,\n  errorLabel,\n}: {\n  knockMsTeamsChannelId: string;\n  tenantId: string;\n  connectionStatus: string;\n  errorLabel: string | null;\n}) {\n  return [knockMsTeamsChannelId, tenantId, connectionStatus, errorLabel]\n    .filter((f) => f !== null && f !== undefined)\n    .join(\"-\");\n}\n"],"names":["formatBadgeCount","count","formatTimestamp","ts","options","parsedTs","parseISO","formatted","intlFormatDistance","Date","locale","toSentenceCase","string","charAt","toUpperCase","slice","renderNodeOrFallback","node","fallback","undefined","feedProviderKey","userId","feedId","source","tenant","has_tenant","archived","filter","f","join","slackProviderKey","knockSlackChannelId","tenantId","connectionStatus","errorLabel","msTeamsProviderKey","knockMsTeamsChannelId"],"mappings":";AAIO,SAASA,EAAiBC,GAAgC;AACxDA,SAAAA,IAAQ,IAAI,OAAOA;AAC5B;AAMO,SAASC,EACdC,GACAC,IAAkC,IAClC;AACI,MAAA;AACIC,UAAAA,IAAWC,EAASH,CAAE;AAKrBI,WAJWC,EAAmBH,GAAU,oBAAII,QAAQ;AAAA,MACzDC,QAAQN,EAAQM;AAAAA,IAAAA,CACjB;AAAA,UAGU;AACJP,WAAAA;AAAAA,EAAAA;AAEX;AAEO,SAASQ,EAAeC,GAAwB;AAC9CA,SAAAA,EAAOC,OAAO,CAAC,EAAEC,gBAAgBF,EAAOG,MAAM,CAAC;AACxD;AAEgBC,SAAAA,EAAqBC,GAAiBC,GAAqB;AAClED,SAAAA,MAASE,SAAYF,IAAOC;AACrC;AAMO,SAASE,EACdC,GACAC,GACAlB,IAA6B,CAAA,GAC7B;AACO,SAAA,CACLiB,GACAC,GACAlB,EAAQmB,QACRnB,EAAQoB,QACRpB,EAAQqB,YACRrB,EAAQsB,QAAQ,EAEfC,OAAQC,OAAMA,KAAM,IAAuB,EAC3CC,KAAK,GAAG;AACb;AAMO,SAASC,EAAiB;AAAA,EAC/BC,qBAAAA;AAAAA,EACAC,UAAAA;AAAAA,EACAC,kBAAAA;AAAAA,EACAC,YAAAA;AAMF,GAAG;AACD,SAAO,CAACH,GAAqBC,GAAUC,GAAkBC,CAAU,EAChEP,OAAQC,CAAMA,MAAAA,KAAM,IAAuB,EAC3CC,KAAK,GAAG;AACb;AAMO,SAASM,EAAmB;AAAA,EACjCC,uBAAAA;AAAAA,EACAJ,UAAAA;AAAAA,EACAC,kBAAAA;AAAAA,EACAC,YAAAA;AAMF,GAAG;AACD,SAAO,CAACE,GAAuBJ,GAAUC,GAAkBC,CAAU,EAClEP,OAAQC,CAAMA,MAAAA,KAAM,IAAuB,EAC3CC,KAAK,GAAG;AACb;"}
+{"version":3,"file":"utils.mjs","sources":["../../../../src/modules/core/utils.ts"],"sourcesContent":["import Knock, { FeedClientOptions } from \"@knocklabs/client\";\nimport { intlFormatDistance, parseISO } from \"date-fns\";\nimport { ReactNode } from \"react\";\n\nimport { BadgeCountType } from \"./types\";\n\nexport function formatBadgeCount(count: number): string | number {\n  return count > 9 ? \"9+\" : count;\n}\n\n/**\n * Returns a string that describes the badge count and type.\n *\n * `all` = \"12 notifications\"\n * `unread` = \"1 unread notification\"\n * `unseen` = \"7 unseen notifications\"\n */\nexport function getBadgeAriaLabel(\n  count: number,\n  badgeCountType: BadgeCountType,\n): string {\n  const qualifier = badgeCountType === \"all\" ? \"\" : `${badgeCountType} `;\n  const noun = count === 1 ? \"notification\" : \"notifications\";\n  return `${count} ${qualifier}${noun}`;\n}\n\ntype FormatTimestampOptions = {\n  locale?: string | string[];\n};\n\nexport function formatTimestamp(\n  ts: string,\n  options: FormatTimestampOptions = {},\n) {\n  try {\n    const parsedTs = parseISO(ts);\n    const formatted = intlFormatDistance(parsedTs, new Date(), {\n      locale: options.locale,\n    });\n\n    return formatted;\n  } catch (_e) {\n    return ts;\n  }\n}\n\nexport function toSentenceCase(string: string): string {\n  return string.charAt(0).toUpperCase() + string.slice(1);\n}\n\nexport function renderNodeOrFallback(node: ReactNode, fallback: ReactNode) {\n  return node !== undefined ? node : fallback;\n}\n\n/*\n  Used to build a consistent key for the KnockFeedProvider so that React knows when\n  to trigger a re-render of the context when a key property changes.\n*/\nexport function feedProviderKey(\n  userId: Knock[\"userId\"],\n  feedId: string,\n  options: FeedClientOptions = {},\n) {\n  return [\n    userId,\n    feedId,\n    options.source,\n    options.tenant,\n    options.has_tenant,\n    options.archived,\n  ]\n    .filter((f) => f !== null && f !== undefined)\n    .join(\"-\");\n}\n\n/*\n  Used to build a consistent key for the KnockSlackProvider so that React knows when\n  to trigger a re-render of the context when a key property changes.\n*/\nexport function slackProviderKey({\n  knockSlackChannelId,\n  tenantId,\n  connectionStatus,\n  errorLabel,\n}: {\n  knockSlackChannelId: string;\n  tenantId: string;\n  connectionStatus: string;\n  errorLabel: string | null;\n}) {\n  return [knockSlackChannelId, tenantId, connectionStatus, errorLabel]\n    .filter((f) => f !== null && f !== undefined)\n    .join(\"-\");\n}\n\n/*\n  Used to build a consistent key for the KnockMsTeamsProvider so that React knows when\n  to trigger a re-render of the context when a key property changes.\n*/\nexport function msTeamsProviderKey({\n  knockMsTeamsChannelId,\n  tenantId,\n  connectionStatus,\n  errorLabel,\n}: {\n  knockMsTeamsChannelId: string;\n  tenantId: string;\n  connectionStatus: string;\n  errorLabel: string | null;\n}) {\n  return [knockMsTeamsChannelId, tenantId, connectionStatus, errorLabel]\n    .filter((f) => f !== null && f !== undefined)\n    .join(\"-\");\n}\n"],"names":["formatBadgeCount","count","getBadgeAriaLabel","badgeCountType","qualifier","formatTimestamp","ts","options","parsedTs","parseISO","formatted","intlFormatDistance","Date","locale","toSentenceCase","string","charAt","toUpperCase","slice","renderNodeOrFallback","node","fallback","undefined","feedProviderKey","userId","feedId","source","tenant","has_tenant","archived","filter","f","join","slackProviderKey","knockSlackChannelId","tenantId","connectionStatus","errorLabel","msTeamsProviderKey","knockMsTeamsChannelId"],"mappings":";AAMO,SAASA,EAAiBC,GAAgC;AACxDA,SAAAA,IAAQ,IAAI,OAAOA;AAC5B;AASgBC,SAAAA,EACdD,GACAE,GACQ;AACR,QAAMC,IAAYD,MAAmB,QAAQ,KAAK,GAAGA,CAAc;AAEnE,SAAO,GAAGF,CAAK,IAAIG,CAAS,GADfH,MAAU,IAAI,iBAAiB,eACT;AACrC;AAMO,SAASI,EACdC,GACAC,IAAkC,IAClC;AACI,MAAA;AACIC,UAAAA,IAAWC,EAASH,CAAE;AAKrBI,WAJWC,EAAmBH,GAAU,oBAAII,QAAQ;AAAA,MACzDC,QAAQN,EAAQM;AAAAA,IAAAA,CACjB;AAAA,UAGU;AACJP,WAAAA;AAAAA,EAAAA;AAEX;AAEO,SAASQ,EAAeC,GAAwB;AAC9CA,SAAAA,EAAOC,OAAO,CAAC,EAAEC,gBAAgBF,EAAOG,MAAM,CAAC;AACxD;AAEgBC,SAAAA,EAAqBC,GAAiBC,GAAqB;AAClED,SAAAA,MAASE,SAAYF,IAAOC;AACrC;AAMO,SAASE,EACdC,GACAC,GACAlB,IAA6B,CAAA,GAC7B;AACO,SAAA,CACLiB,GACAC,GACAlB,EAAQmB,QACRnB,EAAQoB,QACRpB,EAAQqB,YACRrB,EAAQsB,QAAQ,EAEfC,OAAQC,OAAMA,KAAM,IAAuB,EAC3CC,KAAK,GAAG;AACb;AAMO,SAASC,EAAiB;AAAA,EAC/BC,qBAAAA;AAAAA,EACAC,UAAAA;AAAAA,EACAC,kBAAAA;AAAAA,EACAC,YAAAA;AAMF,GAAG;AACD,SAAO,CAACH,GAAqBC,GAAUC,GAAkBC,CAAU,EAChEP,OAAQC,CAAMA,MAAAA,KAAM,IAAuB,EAC3CC,KAAK,GAAG;AACb;AAMO,SAASM,EAAmB;AAAA,EACjCC,uBAAAA;AAAAA,EACAJ,UAAAA;AAAAA,EACAC,kBAAAA;AAAAA,EACAC,YAAAA;AAMF,GAAG;AACD,SAAO,CAACE,GAAuBJ,GAAUC,GAAkBC,CAAU,EAClEP,OAAQC,CAAMA,MAAAA,KAAM,IAAuB,EAC3CC,KAAK,GAAG;AACb;"}

package/dist/esm/modules/guide/context/KnockGuideProvider.mjs

@@ -1,39 +1,44 @@
 import { KnockGuideClient as d } from "@knocklabs/client";
 import * as t from "react";
-import { useKnockClient as l } from "../../core/context/KnockProvider.mjs";
-import K from "../../core/hooks/useStableOptions.mjs";
+import { useKnockClient as K } from "../../core/context/KnockProvider.mjs";
+import v from "../../core/hooks/useStableOptions.mjs";
 import "date-fns";
-const a = t.createContext(void 0), w = ({
+const G = t.createContext(void 0), x = ({
   channelId: o,
   readyToTarget: i,
   listenForUpdates: n = !0,
-  colorMode: f = "light",
-  targetParams: k = {},
+  colorMode: k = "light",
+  targetParams: l = {},
   trackLocationFromWindow: c = !0,
+  // Whether the guide client should look for debug params in url/local storage
+  // to launch guide toolbar. Set to true if using toolbar v1.
+  // TODO(KNO-11523): Remove this once we ship v2.
+  trackDebugParams: u = !1,
   // Default to 0 which works well for react apps as this "yields" to react for
   // one render cyle first and close the group stage.
-  orderResolutionDuration: u = 0,
-  throttleCheckInterval: s,
+  orderResolutionDuration: s = 0,
+  throttleCheckInterval: m,
   children: p
 }) => {
   let r;
   try {
-    r = l();
+    r = K();
   } catch {
     throw new Error("KnockGuideProvider must be used within a KnockProvider");
   }
-  const m = K(k), e = t.useMemo(() => new d(r, o, m, {
+  const f = v(l), e = t.useMemo(() => new d(r, o, f, {
     trackLocationFromWindow: c,
-    orderResolutionDuration: u,
-    throttleCheckInterval: s
-  }), [r, o, m, c, u, s]);
-  return t.useEffect(() => (i && (e.fetch(), n && e.subscribe()), () => e.cleanup()), [i, n, e]), /* @__PURE__ */ t.createElement(a.Provider, { value: {
+    trackDebugParams: u,
+    orderResolutionDuration: s,
+    throttleCheckInterval: m
+  }), [r, o, f, c, u, s, m]);
+  return t.useEffect(() => (i && (e.fetch(), n && e.subscribe()), () => e.cleanup()), [i, n, e]), /* @__PURE__ */ t.createElement(G.Provider, { value: {
     client: e,
-    colorMode: f
+    colorMode: k
   } }, p);
 };
 export {
-  a as KnockGuideContext,
-  w as KnockGuideProvider
+  G as KnockGuideContext,
+  x as KnockGuideProvider
 };
 //# sourceMappingURL=KnockGuideProvider.mjs.map

package/dist/esm/modules/guide/context/KnockGuideProvider.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"KnockGuideProvider.mjs","sources":["../../../../../src/modules/guide/context/KnockGuideProvider.tsx"],"sourcesContent":["import Knock, {\n  KnockGuideClient,\n  KnockGuideTargetParams,\n} from \"@knocklabs/client\";\nimport * as React from \"react\";\n\nimport { useKnockClient, useStableOptions } from \"../../core\";\nimport { ColorMode } from \"../../core/constants\";\n\ntype KnockGuideProviderValue = {\n  client: KnockGuideClient;\n  colorMode: ColorMode;\n};\n\nexport const KnockGuideContext = React.createContext<\n  KnockGuideProviderValue | undefined\n>(undefined);\n\nexport type KnockGuideProviderProps = {\n  channelId: string;\n  readyToTarget: boolean;\n  listenForUpdates?: boolean;\n  colorMode?: ColorMode;\n  targetParams?: KnockGuideTargetParams;\n  trackLocationFromWindow?: boolean;\n  orderResolutionDuration?: number; // in milliseconds\n  throttleCheckInterval?: number; // in milliseconds\n};\n\nexport const KnockGuideProvider: React.FC<\n  React.PropsWithChildren<KnockGuideProviderProps>\n> = ({\n  channelId,\n  readyToTarget,\n  listenForUpdates = true,\n  colorMode = \"light\",\n  targetParams = {},\n  trackLocationFromWindow = true,\n  // Default to 0 which works well for react apps as this \"yields\" to react for\n  // one render cyle first and close the group stage.\n  orderResolutionDuration = 0,\n  throttleCheckInterval,\n  children,\n}) => {\n  let knock: Knock;\n\n  try {\n    knock = useKnockClient();\n  } catch (_) {\n    throw new Error(\"KnockGuideProvider must be used within a KnockProvider\");\n  }\n\n  const stableTargetParams = useStableOptions(targetParams);\n\n  const knockGuideClient = React.useMemo(() => {\n    return new KnockGuideClient(knock, channelId, stableTargetParams, {\n      trackLocationFromWindow,\n      orderResolutionDuration,\n      throttleCheckInterval,\n    });\n  }, [\n    knock,\n    channelId,\n    stableTargetParams,\n    trackLocationFromWindow,\n    orderResolutionDuration,\n    throttleCheckInterval,\n  ]);\n\n  React.useEffect(() => {\n    if (readyToTarget) {\n      knockGuideClient.fetch();\n      if (listenForUpdates) knockGuideClient.subscribe();\n    }\n\n    return () => knockGuideClient.cleanup();\n  }, [readyToTarget, listenForUpdates, knockGuideClient]);\n\n  return (\n    <KnockGuideContext.Provider\n      value={{\n        client: knockGuideClient,\n        colorMode,\n      }}\n    >\n      {children}\n    </KnockGuideContext.Provider>\n  );\n};\n"],"names":["KnockGuideContext","React","createContext","undefined","KnockGuideProvider","channelId","readyToTarget","listenForUpdates","colorMode","targetParams","trackLocationFromWindow","orderResolutionDuration","throttleCheckInterval","children","knock","useKnockClient","Error","stableTargetParams","useStableOptions","knockGuideClient","useMemo","KnockGuideClient","useEffect","fetch","subscribe","cleanup","client"],"mappings":";;;;;AAcaA,MAAAA,IAAoBC,EAAMC,cAErCC,MAAS,GAaEC,IAETA,CAAC;AAAA,EACHC,WAAAA;AAAAA,EACAC,eAAAA;AAAAA,EACAC,kBAAAA,IAAmB;AAAA,EACnBC,WAAAA,IAAY;AAAA,EACZC,cAAAA,IAAe,CAAC;AAAA,EAChBC,yBAAAA,IAA0B;AAAA;AAAA;AAAA,EAG1BC,yBAAAA,IAA0B;AAAA,EAC1BC,uBAAAA;AAAAA,EACAC,UAAAA;AACF,MAAM;AACAC,MAAAA;AAEA,MAAA;AACFA,IAAAA,IAAQC,EAAe;AAAA,UACb;AACJ,UAAA,IAAIC,MAAM,wDAAwD;AAAA,EAAA;AAGpEC,QAAAA,IAAqBC,EAAiBT,CAAY,GAElDU,IAAmBlB,EAAMmB,QAAQ,MAC9B,IAAIC,EAAiBP,GAAOT,GAAWY,GAAoB;AAAA,IAChEP,yBAAAA;AAAAA,IACAC,yBAAAA;AAAAA,IACAC,uBAAAA;AAAAA,EAAAA,CACD,GACA,CACDE,GACAT,GACAY,GACAP,GACAC,GACAC,CAAqB,CACtB;AAEDX,SAAAA,EAAMqB,UAAU,OACVhB,MACFa,EAAiBI,MAAM,GACnBhB,OAAmCiB,UAAU,IAG5C,MAAML,EAAiBM,QAAQ,IACrC,CAACnB,GAAeC,GAAkBY,CAAgB,CAAC,GAGnD,gBAAAlB,EAAA,cAAAD,EAAkB,UAAlB,EACC,OAAO;AAAA,IACL0B,QAAQP;AAAAA,IACRX,WAAAA;AAAAA,OAGDK,CACH;AAEJ;"}
+{"version":3,"file":"KnockGuideProvider.mjs","sources":["../../../../../src/modules/guide/context/KnockGuideProvider.tsx"],"sourcesContent":["import Knock, {\n  KnockGuideClient,\n  KnockGuideTargetParams,\n} from \"@knocklabs/client\";\nimport * as React from \"react\";\n\nimport { useKnockClient, useStableOptions } from \"../../core\";\nimport { ColorMode } from \"../../core/constants\";\n\ntype KnockGuideProviderValue = {\n  client: KnockGuideClient;\n  colorMode: ColorMode;\n};\n\nexport const KnockGuideContext = React.createContext<\n  KnockGuideProviderValue | undefined\n>(undefined);\n\nexport type KnockGuideProviderProps = {\n  channelId: string;\n  readyToTarget: boolean;\n  listenForUpdates?: boolean;\n  colorMode?: ColorMode;\n  targetParams?: KnockGuideTargetParams;\n  trackLocationFromWindow?: boolean;\n  trackDebugParams?: boolean;\n  orderResolutionDuration?: number; // in milliseconds\n  throttleCheckInterval?: number; // in milliseconds\n};\n\nexport const KnockGuideProvider: React.FC<\n  React.PropsWithChildren<KnockGuideProviderProps>\n> = ({\n  channelId,\n  readyToTarget,\n  listenForUpdates = true,\n  colorMode = \"light\",\n  targetParams = {},\n  trackLocationFromWindow = true,\n  // Whether the guide client should look for debug params in url/local storage\n  // to launch guide toolbar. Set to true if using toolbar v1.\n  // TODO(KNO-11523): Remove this once we ship v2.\n  trackDebugParams = false,\n  // Default to 0 which works well for react apps as this \"yields\" to react for\n  // one render cyle first and close the group stage.\n  orderResolutionDuration = 0,\n  throttleCheckInterval,\n  children,\n}) => {\n  let knock: Knock;\n\n  try {\n    knock = useKnockClient();\n  } catch (_) {\n    throw new Error(\"KnockGuideProvider must be used within a KnockProvider\");\n  }\n\n  const stableTargetParams = useStableOptions(targetParams);\n\n  const knockGuideClient = React.useMemo(() => {\n    return new KnockGuideClient(knock, channelId, stableTargetParams, {\n      trackLocationFromWindow,\n      trackDebugParams,\n      orderResolutionDuration,\n      throttleCheckInterval,\n    });\n  }, [\n    knock,\n    channelId,\n    stableTargetParams,\n    trackLocationFromWindow,\n    trackDebugParams,\n    orderResolutionDuration,\n    throttleCheckInterval,\n  ]);\n\n  React.useEffect(() => {\n    if (readyToTarget) {\n      knockGuideClient.fetch();\n      if (listenForUpdates) knockGuideClient.subscribe();\n    }\n\n    return () => knockGuideClient.cleanup();\n  }, [readyToTarget, listenForUpdates, knockGuideClient]);\n\n  return (\n    <KnockGuideContext.Provider\n      value={{\n        client: knockGuideClient,\n        colorMode,\n      }}\n    >\n      {children}\n    </KnockGuideContext.Provider>\n  );\n};\n"],"names":["KnockGuideContext","React","createContext","undefined","KnockGuideProvider","channelId","readyToTarget","listenForUpdates","colorMode","targetParams","trackLocationFromWindow","trackDebugParams","orderResolutionDuration","throttleCheckInterval","children","knock","useKnockClient","Error","stableTargetParams","useStableOptions","knockGuideClient","useMemo","KnockGuideClient","useEffect","fetch","subscribe","cleanup","client"],"mappings":";;;;;AAcaA,MAAAA,IAAoBC,EAAMC,cAErCC,MAAS,GAcEC,IAETA,CAAC;AAAA,EACHC,WAAAA;AAAAA,EACAC,eAAAA;AAAAA,EACAC,kBAAAA,IAAmB;AAAA,EACnBC,WAAAA,IAAY;AAAA,EACZC,cAAAA,IAAe,CAAC;AAAA,EAChBC,yBAAAA,IAA0B;AAAA;AAAA;AAAA;AAAA,EAI1BC,kBAAAA,IAAmB;AAAA;AAAA;AAAA,EAGnBC,yBAAAA,IAA0B;AAAA,EAC1BC,uBAAAA;AAAAA,EACAC,UAAAA;AACF,MAAM;AACAC,MAAAA;AAEA,MAAA;AACFA,IAAAA,IAAQC,EAAe;AAAA,UACb;AACJ,UAAA,IAAIC,MAAM,wDAAwD;AAAA,EAAA;AAGpEC,QAAAA,IAAqBC,EAAiBV,CAAY,GAElDW,IAAmBnB,EAAMoB,QAAQ,MAC9B,IAAIC,EAAiBP,GAAOV,GAAWa,GAAoB;AAAA,IAChER,yBAAAA;AAAAA,IACAC,kBAAAA;AAAAA,IACAC,yBAAAA;AAAAA,IACAC,uBAAAA;AAAAA,EAAAA,CACD,GACA,CACDE,GACAV,GACAa,GACAR,GACAC,GACAC,GACAC,CAAqB,CACtB;AAEDZ,SAAAA,EAAMsB,UAAU,OACVjB,MACFc,EAAiBI,MAAM,GACnBjB,OAAmCkB,UAAU,IAG5C,MAAML,EAAiBM,QAAQ,IACrC,CAACpB,GAAeC,GAAkBa,CAAgB,CAAC,GAGnD,gBAAAnB,EAAA,cAAAD,EAAkB,UAAlB,EACC,OAAO;AAAA,IACL2B,QAAQP;AAAAA,IACRZ,WAAAA;AAAAA,OAGDM,CACH;AAEJ;"}

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export { FilterStatus, KnockProvider, feedProviderKey, formatBadgeCount, formatTimestamp, msTeamsProviderKey, renderNodeOrFallback, slackProviderKey, toSentenceCase, type AuthCheckResult, type ColorMode, type ConnectionStatus, type KnockProviderProps, type KnockProviderState, useAuthenticatedKnockClient, useAuthPolling, useAuthPostMessageListener, useKnockClient, useStableOptions, } from './modules/core';
+export { FilterStatus, KnockProvider, feedProviderKey, type BadgeCountType, formatBadgeCount, getBadgeAriaLabel, formatTimestamp, msTeamsProviderKey, renderNodeOrFallback, slackProviderKey, toSentenceCase, type AuthCheckResult, type ColorMode, type ConnectionStatus, type KnockProviderProps, type KnockProviderState, useAuthenticatedKnockClient, useAuthPolling, useAuthPostMessageListener, useKnockClient, useStableOptions, } from './modules/core';
 export { KnockFeedProvider, type KnockFeedProviderProps, type KnockFeedProviderState, type Selector, useCreateNotificationStore, useFeedSettings, useKnockFeed, useNotificationStore, useNotifications, } from './modules/feed';
 export { KnockGuideProvider, KnockGuideContext, type KnockGuideProviderProps, useGuide, useGuides, useGuideContext, } from './modules/guide';
 export { type MsTeamsChannelQueryOptions, type MsTeamsTeamQueryOptions, KnockMsTeamsProvider, type KnockMsTeamsProviderProps, type KnockMsTeamsProviderState, useConnectedMsTeamsChannels, useKnockMsTeamsClient, useMsTeamsAuth, useMsTeamsChannels, useMsTeamsConnectionStatus, useMsTeamsTeams, } from './modules/ms-teams';

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,cAAc,EACd,KAAK,eAAe,EACpB,KAAK,SAAS,EACd,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,2BAA2B,EAC3B,cAAc,EACd,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,iBAAiB,EACjB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,QAAQ,EACb,0BAA0B,EAC1B,eAAe,EACf,YAAY,EACZ,oBAAoB,EACpB,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,KAAK,uBAAuB,EAC5B,QAAQ,EACR,SAAS,EACT,eAAe,GAChB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,oBAAoB,EACpB,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,2BAA2B,EAC3B,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,0BAA0B,EAC1B,eAAe,GAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,kBAAkB,EAClB,KAAK,eAAe,EACpB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,yBAAyB,EACzB,mBAAmB,EACnB,YAAY,EACZ,gBAAgB,EAChB,wBAAwB,GACzB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,OAAO,EACP,KAAK,WAAW,EAChB,KAAK,sBAAsB,EAC3B,KAAK,YAAY,EACjB,eAAe,GAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAMvD,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,aAAa,EACb,eAAe,EACf,KAAK,cAAc,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,cAAc,EACd,KAAK,eAAe,EACpB,KAAK,SAAS,EACd,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,2BAA2B,EAC3B,cAAc,EACd,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,iBAAiB,EACjB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,QAAQ,EACb,0BAA0B,EAC1B,eAAe,EACf,YAAY,EACZ,oBAAoB,EACpB,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,KAAK,uBAAuB,EAC5B,QAAQ,EACR,SAAS,EACT,eAAe,GAChB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,oBAAoB,EACpB,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,2BAA2B,EAC3B,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,0BAA0B,EAC1B,eAAe,GAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,kBAAkB,EAClB,KAAK,eAAe,EACpB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,yBAAyB,EACzB,mBAAmB,EACnB,YAAY,EACZ,gBAAgB,EAChB,wBAAwB,GACzB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,OAAO,EACP,KAAK,WAAW,EAChB,KAAK,sBAAsB,EAC3B,KAAK,YAAY,EACjB,eAAe,GAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAMvD,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/types/modules/core/index.d.ts

@@ -1,6 +1,6 @@
 export { KnockProvider, useKnockClient, type KnockProviderProps, type KnockProviderState, } from './context';
 export { useAuthenticatedKnockClient, useStableOptions, useAuthPostMessageListener, useAuthPolling, } from './hooks';
 export { FilterStatus, type ColorMode } from './constants';
-export { formatBadgeCount, formatTimestamp, toSentenceCase, renderNodeOrFallback, feedProviderKey, slackProviderKey, msTeamsProviderKey, } from './utils';
-export { type ConnectionStatus, type AuthCheckResult } from './types';
+export { formatBadgeCount, getBadgeAriaLabel, formatTimestamp, toSentenceCase, renderNodeOrFallback, feedProviderKey, slackProviderKey, msTeamsProviderKey, } from './utils';
+export { type BadgeCountType, type ConnectionStatus, type AuthCheckResult, } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/modules/core/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,cAAc,EACd,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,GACxB,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,2BAA2B,EAC3B,gBAAgB,EAChB,0BAA0B,EAC1B,cAAc,GACf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,YAAY,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,eAAe,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,cAAc,EACd,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,GACxB,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,2BAA2B,EAC3B,gBAAgB,EAChB,0BAA0B,EAC1B,cAAc,GACf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,YAAY,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,eAAe,GACrB,MAAM,SAAS,CAAC"}

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

@@ -1,3 +1,7 @@
+/**
+ * Represents the badge count type for notification badges.
+ */
+export type BadgeCountType = "unseen" | "unread" | "all";
 /**
  * Represents the connection status for OAuth-based integrations (Slack, MS Teams, etc.)
  */

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/modules/core/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,YAAY,GACZ,WAAW,GACX,cAAc,GACd,OAAO,GACP,eAAe,CAAC;AAEpB;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,CAAC,EAAE;QACX,EAAE,CAAC,EAAE,OAAO,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE;YACL,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;KACH,CAAC;CACH"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/modules/core/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,YAAY,GACZ,WAAW,GACX,cAAc,GACd,OAAO,GACP,eAAe,CAAC;AAEpB;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,CAAC,EAAE;QACX,EAAE,CAAC,EAAE,OAAO,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE;YACL,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;KACH,CAAC;CACH"}

package/dist/types/modules/core/utils.d.ts

@@ -1,6 +1,15 @@
 import { default as Knock, FeedClientOptions } from '@knocklabs/client';
 import { ReactNode } from 'react';
+import { BadgeCountType } from './types';
 export declare function formatBadgeCount(count: number): string | number;
+/**
+ * Returns a string that describes the badge count and type.
+ *
+ * `all` = "12 notifications"
+ * `unread` = "1 unread notification"
+ * `unseen` = "7 unseen notifications"
+ */
+export declare function getBadgeAriaLabel(count: number, badgeCountType: BadgeCountType): string;
 type FormatTimestampOptions = {
     locale?: string | string[];
 };

package/dist/types/modules/core/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/modules/core/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE7D,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAE/D;AAED,KAAK,sBAAsB,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC5B,CAAC;AAEF,wBAAgB,eAAe,CAC7B,EAAE,EAAE,MAAM,EACV,OAAO,GAAE,sBAA2B,UAYrC;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAErD;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,aAExE;AAMD,wBAAgB,eAAe,CAC7B,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,EACvB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,iBAAsB,UAYhC;AAMD,wBAAgB,gBAAgB,CAAC,EAC/B,mBAAmB,EACnB,QAAQ,EACR,gBAAgB,EAChB,UAAU,GACX,EAAE;IACD,mBAAmB,EAAE,MAAM,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,UAIA;AAMD,wBAAgB,kBAAkB,CAAC,EACjC,qBAAqB,EACrB,QAAQ,EACR,gBAAgB,EAChB,UAAU,GACX,EAAE;IACD,qBAAqB,EAAE,MAAM,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,UAIA"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/modules/core/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE7D,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAE/D;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,EACb,cAAc,EAAE,cAAc,GAC7B,MAAM,CAIR;AAED,KAAK,sBAAsB,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC5B,CAAC;AAEF,wBAAgB,eAAe,CAC7B,EAAE,EAAE,MAAM,EACV,OAAO,GAAE,sBAA2B,UAYrC;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAErD;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,aAExE;AAMD,wBAAgB,eAAe,CAC7B,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,EACvB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,iBAAsB,UAYhC;AAMD,wBAAgB,gBAAgB,CAAC,EAC/B,mBAAmB,EACnB,QAAQ,EACR,gBAAgB,EAChB,UAAU,GACX,EAAE;IACD,mBAAmB,EAAE,MAAM,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,UAIA;AAMD,wBAAgB,kBAAkB,CAAC,EACjC,qBAAqB,EACrB,QAAQ,EACR,gBAAgB,EAChB,UAAU,GACX,EAAE;IACD,qBAAqB,EAAE,MAAM,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,UAIA"}

package/dist/types/modules/guide/context/KnockGuideProvider.d.ts

@@ -13,6 +13,7 @@ export type KnockGuideProviderProps = {
     colorMode?: ColorMode;
     targetParams?: KnockGuideTargetParams;
     trackLocationFromWindow?: boolean;
+    trackDebugParams?: boolean;
     orderResolutionDuration?: number;
     throttleCheckInterval?: number;
 };

package/dist/types/modules/guide/context/KnockGuideProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KnockGuideProvider.d.ts","sourceRoot":"","sources":["../../../../../src/modules/guide/context/KnockGuideProvider.tsx"],"names":[],"mappings":"AAAA,OAAc,EACZ,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,KAAK,uBAAuB,GAAG;IAC7B,MAAM,EAAE,gBAAgB,CAAC;IACzB,SAAS,EAAE,SAAS,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,iBAAiB,oDAElB,CAAC;AAEb,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,sBAAsB,CAAC;IACtC,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,KAAK,CAAC,EAAE,CACvC,KAAK,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,CA0DjD,CAAC"}
+{"version":3,"file":"KnockGuideProvider.d.ts","sourceRoot":"","sources":["../../../../../src/modules/guide/context/KnockGuideProvider.tsx"],"names":[],"mappings":"AAAA,OAAc,EACZ,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,KAAK,uBAAuB,GAAG;IAC7B,MAAM,EAAE,gBAAgB,CAAC;IACzB,SAAS,EAAE,SAAS,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,iBAAiB,oDAElB,CAAC;AAEb,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,sBAAsB,CAAC;IACtC,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,KAAK,CAAC,EAAE,CACvC,KAAK,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,CAgEjD,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.13.0",
+  "version": "0.13.1",
   "license": "MIT",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.mjs",
@@ -47,7 +47,7 @@
     "react": "^16.11.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
   },
   "dependencies": {
-    "@knocklabs/client": "^0.21.0",
+    "@knocklabs/client": "^0.21.1",
     "@tanstack/react-store": "^0.7.3",
     "date-fns": "^4.0.0",
     "fast-deep-equal": "^3.1.3",
@@ -75,6 +75,6 @@
     "vite": "^5.4.19",
     "vite-plugin-dts": "^4.5.0",
     "vite-plugin-no-bundle": "^4.0.0",
-    "vitest": "^3.1.1"
+    "vitest": "^3.2.4"
   }
 }

package/src/index.ts

@@ -2,7 +2,9 @@ export {
   FilterStatus,
   KnockProvider,
   feedProviderKey,
+  type BadgeCountType,
   formatBadgeCount,
+  getBadgeAriaLabel,
   formatTimestamp,
   msTeamsProviderKey,
   renderNodeOrFallback,

package/src/modules/core/index.ts

@@ -13,6 +13,7 @@ export {
 export { FilterStatus, type ColorMode } from "./constants";
 export {
   formatBadgeCount,
+  getBadgeAriaLabel,
   formatTimestamp,
   toSentenceCase,
   renderNodeOrFallback,
@@ -20,4 +21,8 @@ export {
   slackProviderKey,
   msTeamsProviderKey,
 } from "./utils";
-export { type ConnectionStatus, type AuthCheckResult } from "./types";
+export {
+  type BadgeCountType,
+  type ConnectionStatus,
+  type AuthCheckResult,
+} from "./types";

package/src/modules/core/types.ts

@@ -1,3 +1,8 @@
+/**
+ * Represents the badge count type for notification badges.
+ */
+export type BadgeCountType = "unseen" | "unread" | "all";
+
 /**
  * Represents the connection status for OAuth-based integrations (Slack, MS Teams, etc.)
  */

package/src/modules/core/utils.ts

@@ -2,10 +2,28 @@ import Knock, { FeedClientOptions } from "@knocklabs/client";
 import { intlFormatDistance, parseISO } from "date-fns";
 import { ReactNode } from "react";
 
+import { BadgeCountType } from "./types";
+
 export function formatBadgeCount(count: number): string | number {
   return count > 9 ? "9+" : count;
 }
 
+/**
+ * Returns a string that describes the badge count and type.
+ *
+ * `all` = "12 notifications"
+ * `unread` = "1 unread notification"
+ * `unseen` = "7 unseen notifications"
+ */
+export function getBadgeAriaLabel(
+  count: number,
+  badgeCountType: BadgeCountType,
+): string {
+  const qualifier = badgeCountType === "all" ? "" : `${badgeCountType} `;
+  const noun = count === 1 ? "notification" : "notifications";
+  return `${count} ${qualifier}${noun}`;
+}
+
 type FormatTimestampOptions = {
   locale?: string | string[];
 };

package/src/modules/guide/context/KnockGuideProvider.tsx

@@ -23,6 +23,7 @@ export type KnockGuideProviderProps = {
   colorMode?: ColorMode;
   targetParams?: KnockGuideTargetParams;
   trackLocationFromWindow?: boolean;
+  trackDebugParams?: boolean;
   orderResolutionDuration?: number; // in milliseconds
   throttleCheckInterval?: number; // in milliseconds
 };
@@ -36,6 +37,10 @@ export const KnockGuideProvider: React.FC<
   colorMode = "light",
   targetParams = {},
   trackLocationFromWindow = true,
+  // Whether the guide client should look for debug params in url/local storage
+  // to launch guide toolbar. Set to true if using toolbar v1.
+  // TODO(KNO-11523): Remove this once we ship v2.
+  trackDebugParams = false,
   // Default to 0 which works well for react apps as this "yields" to react for
   // one render cyle first and close the group stage.
   orderResolutionDuration = 0,
@@ -55,6 +60,7 @@ export const KnockGuideProvider: React.FC<
   const knockGuideClient = React.useMemo(() => {
     return new KnockGuideClient(knock, channelId, stableTargetParams, {
       trackLocationFromWindow,
+      trackDebugParams,
       orderResolutionDuration,
       throttleCheckInterval,
     });
@@ -63,6 +69,7 @@ export const KnockGuideProvider: React.FC<
     channelId,
     stableTargetParams,
     trackLocationFromWindow,
+    trackDebugParams,
     orderResolutionDuration,
     throttleCheckInterval,
   ]);