@knocklabs/client 0.15.1 → 0.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist/cjs/api.js +1 -1
  3. package/dist/cjs/api.js.map +1 -1
  4. package/dist/cjs/clients/guide/client.js +1 -1
  5. package/dist/cjs/clients/guide/client.js.map +1 -1
  6. package/dist/cjs/clients/guide/helpers.js +2 -0
  7. package/dist/cjs/clients/guide/helpers.js.map +1 -0
  8. package/dist/cjs/clients/users/index.js.map +1 -1
  9. package/dist/esm/api.mjs +5 -1
  10. package/dist/esm/api.mjs.map +1 -1
  11. package/dist/esm/clients/guide/client.mjs +273 -117
  12. package/dist/esm/clients/guide/client.mjs.map +1 -1
  13. package/dist/esm/clients/guide/helpers.mjs +43 -0
  14. package/dist/esm/clients/guide/helpers.mjs.map +1 -0
  15. package/dist/esm/clients/users/index.mjs.map +1 -1
  16. package/dist/types/api.d.ts +1 -0
  17. package/dist/types/api.d.ts.map +1 -1
  18. package/dist/types/clients/guide/client.d.ts +17 -86
  19. package/dist/types/clients/guide/client.d.ts.map +1 -1
  20. package/dist/types/clients/guide/helpers.d.ts +16 -0
  21. package/dist/types/clients/guide/helpers.d.ts.map +1 -0
  22. package/dist/types/clients/guide/index.d.ts +1 -1
  23. package/dist/types/clients/guide/index.d.ts.map +1 -1
  24. package/dist/types/clients/guide/types.d.ts +147 -0
  25. package/dist/types/clients/guide/types.d.ts.map +1 -0
  26. package/dist/types/clients/users/index.d.ts +1 -1
  27. package/dist/types/clients/users/index.d.ts.map +1 -1
  28. package/package.json +2 -2
  29. package/src/api.ts +10 -0
  30. package/src/clients/guide/client.ts +466 -225
  31. package/src/clients/guide/helpers.ts +98 -0
  32. package/src/clients/guide/index.ts +1 -1
  33. package/src/clients/guide/types.ts +206 -0
  34. package/src/clients/users/index.ts +2 -4
@@ -1 +1 @@
1
- {"version":3,"file":"client.mjs","sources":["../../../../src/clients/guide/client.ts"],"sourcesContent":["import { GenericData } from \"@knocklabs/types\";\nimport { Store } from \"@tanstack/store\";\nimport { Channel, Socket } from \"phoenix\";\nimport { URLPattern } from \"urlpattern-polyfill\";\n\nimport Knock from \"../../knock\";\n\nconst sortGuides = (guides: KnockGuide[]) => {\n return [...guides].sort(\n (a, b) =>\n b.priority - a.priority ||\n new Date(b.inserted_at).getTime() - new Date(a.inserted_at).getTime(),\n );\n};\n\n//\n// Guides API (via User client)\n//\n\nexport const guidesApiRootPath = (userId: string | undefined | null) =>\n `/v1/users/${userId}/guides`;\n\ninterface StepMessageState {\n id: string;\n seen_at: string | null;\n read_at: string | null;\n interacted_at: string | null;\n archived_at: string | null;\n link_clicked_at: string | null;\n}\n\ninterface GuideStepData {\n ref: string;\n schema_key: string;\n schema_semver: string;\n schema_variant_key: string;\n message: StepMessageState;\n // eslint-disable-next-line\n content: any;\n}\n\ninterface GuideActivationLocationRuleData {\n directive: \"allow\" | \"block\";\n pathname: string;\n}\n\ninterface GuideData {\n __typename: \"Guide\";\n channel_id: string;\n id: string;\n key: string;\n priority: number;\n type: string;\n semver: string;\n steps: GuideStepData[];\n activation_location_rules: GuideActivationLocationRuleData[];\n inserted_at: string;\n updated_at: string;\n}\n\nexport interface KnockGuideStep extends GuideStepData {\n markAsSeen: () => void;\n markAsInteracted: (params?: { metadata?: GenericData }) => void;\n markAsArchived: () => void;\n}\n\ninterface KnockGuideActivationLocationRule\n extends GuideActivationLocationRuleData {\n pattern: URLPattern;\n}\n\nexport interface KnockGuide extends GuideData {\n steps: KnockGuideStep[];\n activation_location_rules: KnockGuideActivationLocationRule[];\n}\n\ntype GetGuidesQueryParams = {\n data?: string;\n tenant?: string;\n type?: string;\n};\n\ntype GetGuidesResponse = {\n entries: GuideData[];\n};\n\nexport type GuideEngagementEventBaseParams = {\n // Base params required for all engagement update events\n message_id: string;\n channel_id: string;\n guide_key: string;\n guide_id: string;\n guide_step_ref: string;\n};\n\ntype MarkAsSeenParams = GuideEngagementEventBaseParams & {\n // Rendered step content seen by the recipient\n content: GenericData;\n // Target params\n data?: GenericData;\n tenant?: string;\n};\ntype MarkAsInteractedParams = GuideEngagementEventBaseParams;\ntype MarkAsArchivedParams = GuideEngagementEventBaseParams;\n\ntype MarkGuideAsResponse = {\n status: \"ok\";\n};\n\ntype SocketEventType = \"guide.added\" | \"guide.updated\" | \"guide.removed\";\n\ntype SocketEventPayload<E extends SocketEventType, D> = {\n topic: string;\n event: E;\n data: D;\n};\n\ntype GuideAddedEvent = SocketEventPayload<\n \"guide.added\",\n { guide: GuideData; eligible: true }\n>;\n\ntype GuideUpdatedEvent = SocketEventPayload<\n \"guide.updated\",\n { guide: GuideData; eligible: boolean }\n>;\n\ntype GuideRemovedEvent = SocketEventPayload<\n \"guide.removed\",\n { guide: Pick<GuideData, \"key\"> }\n>;\n\ntype GuideSocketEvent = GuideAddedEvent | GuideUpdatedEvent | GuideRemovedEvent;\n\n//\n// Guides client\n//\n\ntype QueryKey = string;\n\ntype QueryStatus = {\n status: \"loading\" | \"ok\" | \"error\";\n error?: Error;\n};\n\ntype StoreState = {\n guides: KnockGuide[];\n queries: Record<QueryKey, QueryStatus>;\n location: string | undefined;\n};\n\ntype QueryFilterParams = Pick<GetGuidesQueryParams, \"type\">;\n\nexport type SelectFilterParams = {\n key?: string;\n type?: string;\n};\n\nexport type TargetParams = {\n data?: GenericData | undefined;\n tenant?: string | undefined;\n};\n\ntype ConstructorOpts = {\n trackLocationFromWindow?: boolean;\n};\n\nexport class KnockGuideClient {\n public store: Store<StoreState, (state: StoreState) => StoreState>;\n\n // Phoenix channels for real time guide updates over websocket\n private socket: Socket | undefined;\n private socketChannel: Channel | undefined;\n private socketChannelTopic: string;\n private socketEventTypes = [\"guide.added\", \"guide.updated\", \"guide.removed\"];\n\n // Original history methods to monkey patch, or restore in cleanups.\n private pushStateFn: History[\"pushState\"] | undefined;\n private replaceStateFn: History[\"replaceState\"] | undefined;\n\n constructor(\n readonly knock: Knock,\n readonly channelId: string,\n readonly targetParams: TargetParams = {},\n readonly options: ConstructorOpts = {},\n ) {\n const { trackLocationFromWindow = true } = options;\n\n const location = trackLocationFromWindow\n ? window?.location.href\n : undefined;\n\n this.store = new Store<StoreState>({\n guides: [],\n queries: {},\n location,\n });\n\n // In server environments we might not have a socket connection.\n const { socket: maybeSocket } = this.knock.client();\n this.socket = maybeSocket;\n this.socketChannelTopic = `guides:${channelId}`;\n\n if (trackLocationFromWindow) {\n this.listenForLocationChangesFromWindow();\n }\n\n this.knock.log(\"[Guide] Initialized a guide client\");\n }\n\n cleanup() {\n this.unsubscribe();\n this.removeEventListeners();\n }\n\n async fetch(opts?: { filters?: QueryFilterParams }) {\n this.knock.failIfNotAuthenticated();\n this.knock.log(\"[Guide] Loading all eligible guides\");\n\n const queryParams = this.buildQueryParams(opts?.filters);\n const queryKey = this.formatQueryKey(queryParams);\n\n // If already fetched before, then noop.\n const maybeQueryStatus = this.store.state.queries[queryKey];\n if (maybeQueryStatus) {\n return maybeQueryStatus;\n }\n\n // Mark this query status as loading.\n this.store.setState((state) => ({\n ...state,\n queries: { ...state.queries, [queryKey]: { status: \"loading\" } },\n }));\n\n let queryStatus: QueryStatus;\n try {\n const data = await this.knock.user.getGuides<\n GetGuidesQueryParams,\n GetGuidesResponse\n >(this.channelId, queryParams);\n queryStatus = { status: \"ok\" };\n\n this.store.setState((state) => ({\n ...state,\n // For now assume a single fetch to get all eligible guides. When/if\n // we implement incremental loads, then this will need to be a merge\n // and sort operation.\n guides: data.entries.map((g) => this.localCopy(g)),\n queries: { ...state.queries, [queryKey]: queryStatus },\n }));\n } catch (e) {\n queryStatus = { status: \"error\", error: e as Error };\n\n this.store.setState((state) => ({\n ...state,\n queries: { ...state.queries, [queryKey]: queryStatus },\n }));\n }\n\n return queryStatus;\n }\n\n subscribe() {\n if (!this.socket) return;\n this.knock.failIfNotAuthenticated();\n this.knock.log(\"[Guide] Subscribing to real time updates\");\n\n // Ensure a live socket connection if not yet connected.\n if (!this.socket.isConnected()) {\n this.socket.connect();\n }\n\n // If there's an existing connected channel, then disconnect.\n if (this.socketChannel) {\n this.unsubscribe();\n }\n\n // Join the channel topic and subscribe to supported events.\n const params = { ...this.targetParams, user_id: this.knock.userId };\n const newChannel = this.socket.channel(this.socketChannelTopic, params);\n\n for (const eventType of this.socketEventTypes) {\n newChannel.on(eventType, (payload) => this.handleSocketEvent(payload));\n }\n\n if ([\"closed\", \"errored\"].includes(newChannel.state)) {\n newChannel.join();\n }\n\n // Track the joined channel.\n this.socketChannel = newChannel;\n }\n\n unsubscribe() {\n if (!this.socketChannel) return;\n this.knock.log(\"[Guide] Unsubscribing from real time updates\");\n\n // Unsubscribe from the socket events and leave the channel.\n for (const eventType of this.socketEventTypes) {\n this.socketChannel.off(eventType);\n }\n this.socketChannel.leave();\n\n // Unset the channel.\n this.socketChannel = undefined;\n }\n\n private handleSocketEvent(payload: GuideSocketEvent) {\n const { event, data } = payload;\n\n switch (event) {\n case \"guide.added\":\n return this.addGuide(payload);\n\n case \"guide.updated\":\n return data.eligible\n ? this.replaceOrAddGuide(payload)\n : this.removeGuide(payload);\n\n case \"guide.removed\":\n return this.removeGuide(payload);\n\n default:\n return;\n }\n }\n\n //\n // Store selector\n //\n\n select(state: StoreState, filters: SelectFilterParams = {}) {\n return state.guides.filter((guide) => {\n if (filters.type && filters.type !== guide.type) {\n return false;\n }\n\n if (filters.key && filters.key !== guide.key) {\n return false;\n }\n\n const locationRules = guide.activation_location_rules || [];\n\n if (locationRules.length > 0 && state.location) {\n const allowed = locationRules.reduce<boolean | undefined>(\n (acc, rule) => {\n // Any matched block rule prevails so no need to evaluate further\n // as soon as there is one.\n if (acc === false) return false;\n\n // At this point we either have a matched allow rule (acc is true),\n // or no matched rule found yet (acc is undefined).\n\n switch (rule.directive) {\n case \"allow\": {\n // No need to evaluate more allow rules once we matched one\n // since any matched allowed rule means allow.\n if (acc === true) return true;\n\n const matched = rule.pattern.test(state.location);\n return matched ? true : undefined;\n }\n\n case \"block\": {\n // Always test block rules (unless already matched to block)\n // because they'd prevail over matched allow rules.\n const matched = rule.pattern.test(state.location);\n return matched ? false : acc;\n }\n }\n },\n undefined,\n );\n\n if (!allowed) return false;\n }\n\n return true;\n });\n }\n\n //\n // Engagement event handlers\n //\n // Make an optimistic update on the client side first, then send an engagement\n // event to the backend.\n //\n\n async markAsSeen(guide: GuideData, step: GuideStepData) {\n this.knock.log(\n `[Guide] Marking as seen (Guide key: ${guide.key}, Step ref:${step.ref})`,\n );\n\n const updatedStep = this.setStepMessageAttrs(guide.key, step.ref, {\n seen_at: new Date().toISOString(),\n });\n if (!updatedStep) return;\n\n const params = {\n ...this.buildEngagementEventBaseParams(guide, updatedStep),\n content: updatedStep.content,\n data: this.targetParams.data,\n tenant: this.targetParams.tenant,\n };\n\n this.knock.user.markGuideStepAs<MarkAsSeenParams, MarkGuideAsResponse>(\n \"seen\",\n params,\n );\n\n return updatedStep;\n }\n\n async markAsInteracted(\n guide: GuideData,\n step: GuideStepData,\n metadata?: GenericData,\n ) {\n this.knock.log(\n `[Guide] Marking as interacted (Guide key: ${guide.key}, Step ref:${step.ref})`,\n );\n\n const ts = new Date().toISOString();\n const updatedStep = this.setStepMessageAttrs(guide.key, step.ref, {\n read_at: ts,\n interacted_at: ts,\n });\n if (!updatedStep) return;\n\n const params = {\n ...this.buildEngagementEventBaseParams(guide, updatedStep),\n metadata,\n };\n\n this.knock.user.markGuideStepAs<\n MarkAsInteractedParams,\n MarkGuideAsResponse\n >(\"interacted\", params);\n\n return updatedStep;\n }\n\n async markAsArchived(guide: GuideData, step: GuideStepData) {\n this.knock.log(\n `[Guide] Marking as archived (Guide key: ${guide.key}, Step ref:${step.ref})`,\n );\n\n const updatedStep = this.setStepMessageAttrs(guide.key, step.ref, {\n archived_at: new Date().toISOString(),\n });\n if (!updatedStep) return;\n\n const params = this.buildEngagementEventBaseParams(guide, updatedStep);\n\n this.knock.user.markGuideStepAs<MarkAsArchivedParams, MarkGuideAsResponse>(\n \"archived\",\n params,\n );\n\n return updatedStep;\n }\n\n //\n // Helpers\n //\n\n private localCopy(remoteGuide: GuideData) {\n // eslint-disable-next-line @typescript-eslint/no-this-alias\n const self = this;\n\n // Build a local copy with helper methods added.\n const localGuide = { ...remoteGuide };\n\n localGuide.steps = remoteGuide.steps.map(({ message, ...rest }) => {\n const localStep = {\n ...rest,\n message: { ...message },\n markAsSeen() {\n // Send a seen event if it has not been previously seen.\n if (this.message.seen_at) return;\n return self.markAsSeen(localGuide, this);\n },\n markAsInteracted({ metadata }: { metadata?: GenericData } = {}) {\n // Always send an interaction event through.\n return self.markAsInteracted(localGuide, this, metadata);\n },\n markAsArchived() {\n // Send an archived event if it has not been previously archived.\n if (this.message.archived_at) return;\n return self.markAsArchived(localGuide, this);\n },\n };\n\n // Bind all engagement action handler methods to the local step object so\n // they can operate on itself.\n localStep.markAsSeen = localStep.markAsSeen.bind(localStep);\n localStep.markAsInteracted = localStep.markAsInteracted.bind(localStep);\n localStep.markAsArchived = localStep.markAsArchived.bind(localStep);\n\n return localStep;\n });\n\n localGuide.activation_location_rules =\n remoteGuide.activation_location_rules.map((rule) => {\n return {\n ...rule,\n pattern: new URLPattern({ pathname: rule.pathname }),\n };\n });\n\n return localGuide as KnockGuide;\n }\n\n private buildQueryParams(filterParams: QueryFilterParams = {}) {\n // Combine the target params with the given filter params.\n const combinedParams = { ...this.targetParams, ...filterParams };\n\n // Prune out any keys that have an undefined or null value.\n let params = Object.fromEntries(\n Object.entries(combinedParams).filter(\n ([_k, v]) => v !== undefined && v !== null,\n ),\n );\n\n // Encode target data as a JSON string, if provided.\n params = params.data\n ? { ...params, data: JSON.stringify(params.data) }\n : params;\n\n return params as GetGuidesQueryParams;\n }\n\n private formatQueryKey(queryParams: GenericData) {\n const sortedKeys = Object.keys(queryParams).sort();\n\n const queryStr = sortedKeys\n .map(\n (key) =>\n `${encodeURIComponent(key)}=${encodeURIComponent(queryParams[key])}`,\n )\n .join(\"&\");\n\n const basePath = guidesApiRootPath(this.knock.userId);\n return queryStr ? `${basePath}?${queryStr}` : basePath;\n }\n\n private setStepMessageAttrs(\n guideKey: string,\n stepRef: string,\n attrs: Partial<StepMessageState>,\n ) {\n let updatedStep: KnockGuideStep | undefined;\n\n this.store.setState((state) => {\n const guides = state.guides.map((guide) => {\n if (guide.key !== guideKey) return guide;\n\n const steps = guide.steps.map((step) => {\n if (step.ref !== stepRef) return step;\n\n // Mutate in place and maintain the same obj ref so to make it easier\n // to use in hook deps.\n step.message = { ...step.message, ...attrs };\n updatedStep = step;\n\n return step;\n });\n return { ...guide, steps };\n });\n return { ...state, guides };\n });\n\n return updatedStep;\n }\n\n private buildEngagementEventBaseParams(\n guide: GuideData,\n step: GuideStepData,\n ) {\n return {\n message_id: step.message.id,\n channel_id: guide.channel_id,\n guide_key: guide.key,\n guide_id: guide.id,\n guide_step_ref: step.ref,\n };\n }\n\n private addGuide({ data }: GuideAddedEvent) {\n const guide = this.localCopy(data.guide);\n\n this.store.setState((state) => {\n return { ...state, guides: sortGuides([...state.guides, guide]) };\n });\n }\n\n private replaceOrAddGuide({ data }: GuideUpdatedEvent) {\n const guide = this.localCopy(data.guide);\n\n this.store.setState((state) => {\n let replaced = false;\n\n const guides = state.guides.map((g) => {\n if (g.key !== guide.key) return g;\n replaced = true;\n return guide;\n });\n\n return {\n ...state,\n guides: replaced ? sortGuides(guides) : sortGuides([...guides, guide]),\n };\n });\n }\n\n private removeGuide({ data }: GuideUpdatedEvent | GuideRemovedEvent) {\n this.store.setState((state) => {\n const guides = state.guides.filter((g) => g.key !== data.guide.key);\n return { ...state, guides };\n });\n }\n\n // Define as an arrow func property to always bind this to the class instance.\n private handleLocationChange = () => {\n const href = window.location.href;\n if (this.store.state.location === href) return;\n\n this.knock.log(`[Guide] Handle Location change: ${href}`);\n\n this.store.setState((state) => ({ ...state, location: href }));\n };\n\n private listenForLocationChangesFromWindow() {\n if (window?.history) {\n // 1. Listen for browser back/forward button clicks.\n window.addEventListener(\"popstate\", this.handleLocationChange);\n\n // 2. Listen for hash changes in case it's used for routing.\n window.addEventListener(\"hashchange\", this.handleLocationChange);\n\n // 3. Monkey-patch history methods to catch programmatic navigation.\n const pushStateFn = window.history.pushState;\n const replaceStateFn = window.history.replaceState;\n\n // Use setTimeout to allow the browser state to potentially settle.\n window.history.pushState = new Proxy(pushStateFn, {\n apply: (target, history, args) => {\n Reflect.apply(target, history, args);\n setTimeout(() => {\n this.handleLocationChange();\n }, 0);\n },\n });\n window.history.replaceState = new Proxy(replaceStateFn, {\n apply: (target, history, args) => {\n Reflect.apply(target, history, args);\n setTimeout(() => {\n this.handleLocationChange();\n }, 0);\n },\n });\n\n // 4. Keep refs to the original handlers so we can restore during cleanup.\n this.pushStateFn = pushStateFn;\n this.replaceStateFn = replaceStateFn;\n } else {\n this.knock.log(\n \"[Guide] Unable to access the `window.history` object to detect location changes\",\n );\n }\n }\n\n private removeEventListeners() {\n window.removeEventListener(\"popstate\", this.handleLocationChange);\n window.removeEventListener(\"hashchange\", this.handleLocationChange);\n\n if (this.pushStateFn) {\n window.history.pushState = this.pushStateFn;\n this.pushStateFn = undefined;\n }\n if (this.replaceStateFn) {\n window.history.replaceState = this.replaceStateFn;\n this.replaceStateFn = undefined;\n }\n }\n}\n"],"names":["sortGuides","guides","a","b","guidesApiRootPath","userId","KnockGuideClient","knock","channelId","targetParams","options","__publicField","href","state","trackLocationFromWindow","location","Store","maybeSocket","opts","queryParams","queryKey","maybeQueryStatus","queryStatus","data","g","e","params","newChannel","eventType","payload","event","filters","guide","locationRules","acc","rule","step","updatedStep","metadata","ts","remoteGuide","self","localGuide","message","rest","localStep","URLPattern","filterParams","combinedParams","_k","v","queryStr","key","basePath","guideKey","stepRef","attrs","steps","replaced","pushStateFn","replaceStateFn","target","history","args"],"mappings":";;;;;AAOA,MAAMA,IAAa,CAACC,MACX,CAAC,GAAGA,CAAM,EAAE;AAAA,EACjB,CAACC,GAAGC,MACFA,EAAE,WAAWD,EAAE,YACf,IAAI,KAAKC,EAAE,WAAW,EAAE,YAAY,IAAI,KAAKD,EAAE,WAAW,EAAE,QAAQ;AACxE,GAOWE,IAAoB,CAACC,MAChC,aAAaA,CAAM;AAmJd,MAAMC,EAAiB;AAAA,EAa5B,YACWC,GACAC,GACAC,IAA6B,CAC7B,GAAAC,IAA2B,IACpC;AAjBK,IAAAC,EAAA;AAGC;AAAA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA,0BAAmB,CAAC,eAAe,iBAAiB,eAAe;AAGnE;AAAA,IAAAA,EAAA;AACA,IAAAA,EAAA;AA6bA;AAAA,IAAAA,EAAA,8BAAuB,MAAM;AAC7B,YAAAC,IAAO,OAAO,SAAS;AAC7B,MAAI,KAAK,MAAM,MAAM,aAAaA,MAElC,KAAK,MAAM,IAAI,mCAAmCA,CAAI,EAAE,GAEnD,KAAA,MAAM,SAAS,CAACC,OAAW,EAAE,GAAGA,GAAO,UAAUD,EAAA,EAAO;AAAA,IAC/D;AAjcW,SAAA,QAAAL,GACA,KAAA,YAAAC,GACA,KAAA,eAAAC,GACA,KAAA,UAAAC;AAEH,UAAA,EAAE,yBAAAI,IAA0B,GAAA,IAASJ,GAErCK,IAAWD,IACb,iCAAQ,SAAS,OACjB;AAEC,SAAA,QAAQ,IAAIE,EAAkB;AAAA,MACjC,QAAQ,CAAC;AAAA,MACT,SAAS,CAAC;AAAA,MACV,UAAAD;AAAA,IAAA,CACD;AAGD,UAAM,EAAE,QAAQE,EAAA,IAAgB,KAAK,MAAM,OAAO;AAClD,SAAK,SAASA,GACT,KAAA,qBAAqB,UAAUT,CAAS,IAEzCM,KACF,KAAK,mCAAmC,GAGrC,KAAA,MAAM,IAAI,oCAAoC;AAAA,EAAA;AAAA,EAGrD,UAAU;AACR,SAAK,YAAY,GACjB,KAAK,qBAAqB;AAAA,EAAA;AAAA,EAG5B,MAAM,MAAMI,GAAwC;AAClD,SAAK,MAAM,uBAAuB,GAC7B,KAAA,MAAM,IAAI,qCAAqC;AAEpD,UAAMC,IAAc,KAAK,iBAAiBD,KAAA,gBAAAA,EAAM,OAAO,GACjDE,IAAW,KAAK,eAAeD,CAAW,GAG1CE,IAAmB,KAAK,MAAM,MAAM,QAAQD,CAAQ;AAC1D,QAAIC;AACK,aAAAA;AAIJ,SAAA,MAAM,SAAS,CAACR,OAAW;AAAA,MAC9B,GAAGA;AAAA,MACH,SAAS,EAAE,GAAGA,EAAM,SAAS,CAACO,CAAQ,GAAG,EAAE,QAAQ,UAAY,EAAA;AAAA,IAAA,EAC/D;AAEE,QAAAE;AACA,QAAA;AACI,YAAAC,IAAO,MAAM,KAAK,MAAM,KAAK,UAGjC,KAAK,WAAWJ,CAAW;AACf,MAAAG,IAAA,EAAE,QAAQ,KAAK,GAExB,KAAA,MAAM,SAAS,CAACT,OAAW;AAAA,QAC9B,GAAGA;AAAA;AAAA;AAAA;AAAA,QAIH,QAAQU,EAAK,QAAQ,IAAI,CAACC,MAAM,KAAK,UAAUA,CAAC,CAAC;AAAA,QACjD,SAAS,EAAE,GAAGX,EAAM,SAAS,CAACO,CAAQ,GAAGE,EAAY;AAAA,MAAA,EACrD;AAAA,aACKG,GAAG;AACV,MAAAH,IAAc,EAAE,QAAQ,SAAS,OAAOG,EAAW,GAE9C,KAAA,MAAM,SAAS,CAACZ,OAAW;AAAA,QAC9B,GAAGA;AAAA,QACH,SAAS,EAAE,GAAGA,EAAM,SAAS,CAACO,CAAQ,GAAGE,EAAY;AAAA,MAAA,EACrD;AAAA,IAAA;AAGG,WAAAA;AAAA,EAAA;AAAA,EAGT,YAAY;AACN,QAAA,CAAC,KAAK,OAAQ;AAClB,SAAK,MAAM,uBAAuB,GAC7B,KAAA,MAAM,IAAI,0CAA0C,GAGpD,KAAK,OAAO,iBACf,KAAK,OAAO,QAAQ,GAIlB,KAAK,iBACP,KAAK,YAAY;AAIb,UAAAI,IAAS,EAAE,GAAG,KAAK,cAAc,SAAS,KAAK,MAAM,OAAO,GAC5DC,IAAa,KAAK,OAAO,QAAQ,KAAK,oBAAoBD,CAAM;AAE3D,eAAAE,KAAa,KAAK;AAC3B,MAAAD,EAAW,GAAGC,GAAW,CAACC,MAAY,KAAK,kBAAkBA,CAAO,CAAC;AAGvE,IAAI,CAAC,UAAU,SAAS,EAAE,SAASF,EAAW,KAAK,KACjDA,EAAW,KAAK,GAIlB,KAAK,gBAAgBA;AAAA,EAAA;AAAA,EAGvB,cAAc;AACR,QAAC,KAAK,eACL;AAAA,WAAA,MAAM,IAAI,8CAA8C;AAGlD,iBAAAC,KAAa,KAAK;AACtB,aAAA,cAAc,IAAIA,CAAS;AAElC,WAAK,cAAc,MAAM,GAGzB,KAAK,gBAAgB;AAAA;AAAA,EAAA;AAAA,EAGf,kBAAkBC,GAA2B;AAC7C,UAAA,EAAE,OAAAC,GAAO,MAAAP,EAAA,IAASM;AAExB,YAAQC,GAAO;AAAA,MACb,KAAK;AACI,eAAA,KAAK,SAASD,CAAO;AAAA,MAE9B,KAAK;AACI,eAAAN,EAAK,WACR,KAAK,kBAAkBM,CAAO,IAC9B,KAAK,YAAYA,CAAO;AAAA,MAE9B,KAAK;AACI,eAAA,KAAK,YAAYA,CAAO;AAAA,MAEjC;AACE;AAAA,IAAA;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAOF,OAAOhB,GAAmBkB,IAA8B,IAAI;AAC1D,WAAOlB,EAAM,OAAO,OAAO,CAACmB,MAAU;AAKpC,UAJID,EAAQ,QAAQA,EAAQ,SAASC,EAAM,QAIvCD,EAAQ,OAAOA,EAAQ,QAAQC,EAAM;AAChC,eAAA;AAGH,YAAAC,IAAgBD,EAAM,6BAA6B,CAAC;AAE1D,aAAI,EAAAC,EAAc,SAAS,KAAKpB,EAAM,YA+BhC,CA9BYoB,EAAc;AAAA,QAC5B,CAACC,GAAKC,MAAS;AAGT,cAAAD,MAAQ,GAAc,QAAA;AAK1B,kBAAQC,EAAK,WAAW;AAAA,YACtB,KAAK;AAGC,qBAAAD,MAAQ,MAEIC,EAAK,QAAQ,KAAKtB,EAAM,QAAQ,IAFvB,KAGD;AAAA,YAG1B,KAAK;AAIH,qBADgBsB,EAAK,QAAQ,KAAKtB,EAAM,QAAQ,IAC/B,KAAQqB;AAAA,UAC3B;AAAA,QAEJ;AAAA,QACA;AAAA,MACF;AAAA,IAKK,CACR;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUH,MAAM,WAAWF,GAAkBI,GAAqB;AACtD,SAAK,MAAM;AAAA,MACT,uCAAuCJ,EAAM,GAAG,cAAcI,EAAK,GAAG;AAAA,IACxE;AAEA,UAAMC,IAAc,KAAK,oBAAoBL,EAAM,KAAKI,EAAK,KAAK;AAAA,MAChE,UAAS,oBAAI,KAAK,GAAE,YAAY;AAAA,IAAA,CACjC;AACD,QAAI,CAACC,EAAa;AAElB,UAAMX,IAAS;AAAA,MACb,GAAG,KAAK,+BAA+BM,GAAOK,CAAW;AAAA,MACzD,SAASA,EAAY;AAAA,MACrB,MAAM,KAAK,aAAa;AAAA,MACxB,QAAQ,KAAK,aAAa;AAAA,IAC5B;AAEA,gBAAK,MAAM,KAAK;AAAA,MACd;AAAA,MACAX;AAAA,IACF,GAEOW;AAAA,EAAA;AAAA,EAGT,MAAM,iBACJL,GACAI,GACAE,GACA;AACA,SAAK,MAAM;AAAA,MACT,6CAA6CN,EAAM,GAAG,cAAcI,EAAK,GAAG;AAAA,IAC9E;AAEA,UAAMG,KAAK,oBAAI,KAAK,GAAE,YAAY,GAC5BF,IAAc,KAAK,oBAAoBL,EAAM,KAAKI,EAAK,KAAK;AAAA,MAChE,SAASG;AAAA,MACT,eAAeA;AAAA,IAAA,CAChB;AACD,QAAI,CAACF,EAAa;AAElB,UAAMX,IAAS;AAAA,MACb,GAAG,KAAK,+BAA+BM,GAAOK,CAAW;AAAA,MACzD,UAAAC;AAAA,IACF;AAEA,gBAAK,MAAM,KAAK,gBAGd,cAAcZ,CAAM,GAEfW;AAAA,EAAA;AAAA,EAGT,MAAM,eAAeL,GAAkBI,GAAqB;AAC1D,SAAK,MAAM;AAAA,MACT,2CAA2CJ,EAAM,GAAG,cAAcI,EAAK,GAAG;AAAA,IAC5E;AAEA,UAAMC,IAAc,KAAK,oBAAoBL,EAAM,KAAKI,EAAK,KAAK;AAAA,MAChE,cAAa,oBAAI,KAAK,GAAE,YAAY;AAAA,IAAA,CACrC;AACD,QAAI,CAACC,EAAa;AAElB,UAAMX,IAAS,KAAK,+BAA+BM,GAAOK,CAAW;AAErE,gBAAK,MAAM,KAAK;AAAA,MACd;AAAA,MACAX;AAAA,IACF,GAEOW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAOD,UAAUG,GAAwB;AAExC,UAAMC,IAAO,MAGPC,IAAa,EAAE,GAAGF,EAAY;AAEzB,WAAAE,EAAA,QAAQF,EAAY,MAAM,IAAI,CAAC,EAAE,SAAAG,GAAS,GAAGC,QAAW;AACjE,YAAMC,IAAY;AAAA,QAChB,GAAGD;AAAA,QACH,SAAS,EAAE,GAAGD,EAAQ;AAAA,QACtB,aAAa;AAEP,cAAA,MAAK,QAAQ;AACV,mBAAAF,EAAK,WAAWC,GAAY,IAAI;AAAA,QACzC;AAAA,QACA,iBAAiB,EAAE,UAAAJ,EAAS,IAAgC,IAAI;AAE9D,iBAAOG,EAAK,iBAAiBC,GAAY,MAAMJ,CAAQ;AAAA,QACzD;AAAA,QACA,iBAAiB;AAEX,cAAA,MAAK,QAAQ;AACV,mBAAAG,EAAK,eAAeC,GAAY,IAAI;AAAA,QAAA;AAAA,MAE/C;AAIA,aAAAG,EAAU,aAAaA,EAAU,WAAW,KAAKA,CAAS,GAC1DA,EAAU,mBAAmBA,EAAU,iBAAiB,KAAKA,CAAS,GACtEA,EAAU,iBAAiBA,EAAU,eAAe,KAAKA,CAAS,GAE3DA;AAAA,IAAA,CACR,GAEDH,EAAW,4BACTF,EAAY,0BAA0B,IAAI,CAACL,OAClC;AAAA,MACL,GAAGA;AAAA,MACH,SAAS,IAAIW,EAAW,EAAE,UAAUX,EAAK,SAAU,CAAA;AAAA,IACrD,EACD,GAEIO;AAAA,EAAA;AAAA,EAGD,iBAAiBK,IAAkC,IAAI;AAE7D,UAAMC,IAAiB,EAAE,GAAG,KAAK,cAAc,GAAGD,EAAa;AAG/D,QAAIrB,IAAS,OAAO;AAAA,MAClB,OAAO,QAAQsB,CAAc,EAAE;AAAA,QAC7B,CAAC,CAACC,GAAIC,CAAC,MAAyBA,KAAM;AAAA,MAAA;AAAA,IAE1C;AAGS,WAAAxB,IAAAA,EAAO,OACZ,EAAE,GAAGA,GAAQ,MAAM,KAAK,UAAUA,EAAO,IAAI,EAC7C,IAAAA,GAEGA;AAAA,EAAA;AAAA,EAGD,eAAeP,GAA0B;AAG/C,UAAMgC,IAFa,OAAO,KAAKhC,CAAW,EAAE,KAAK,EAG9C;AAAA,MACC,CAACiC,MACC,GAAG,mBAAmBA,CAAG,CAAC,IAAI,mBAAmBjC,EAAYiC,CAAG,CAAC,CAAC;AAAA,IAAA,EAErE,KAAK,GAAG,GAELC,IAAWjD,EAAkB,KAAK,MAAM,MAAM;AACpD,WAAO+C,IAAW,GAAGE,CAAQ,IAAIF,CAAQ,KAAKE;AAAA,EAAA;AAAA,EAGxC,oBACNC,GACAC,GACAC,GACA;AACI,QAAAnB;AAEC,gBAAA,MAAM,SAAS,CAACxB,MAAU;AAC7B,YAAMZ,IAASY,EAAM,OAAO,IAAI,CAACmB,MAAU;AACrC,YAAAA,EAAM,QAAQsB,EAAiB,QAAAtB;AAEnC,cAAMyB,IAAQzB,EAAM,MAAM,IAAI,CAACI,OACzBA,EAAK,QAAQmB,MAIjBnB,EAAK,UAAU,EAAE,GAAGA,EAAK,SAAS,GAAGoB,EAAM,GAC7BnB,IAAAD,IAEPA,EACR;AACM,eAAA,EAAE,GAAGJ,GAAO,OAAAyB,EAAM;AAAA,MAAA,CAC1B;AACM,aAAA,EAAE,GAAG5C,GAAO,QAAAZ,EAAO;AAAA,IAAA,CAC3B,GAEMoC;AAAA,EAAA;AAAA,EAGD,+BACNL,GACAI,GACA;AACO,WAAA;AAAA,MACL,YAAYA,EAAK,QAAQ;AAAA,MACzB,YAAYJ,EAAM;AAAA,MAClB,WAAWA,EAAM;AAAA,MACjB,UAAUA,EAAM;AAAA,MAChB,gBAAgBI,EAAK;AAAA,IACvB;AAAA,EAAA;AAAA,EAGM,SAAS,EAAE,MAAAb,KAAyB;AAC1C,UAAMS,IAAQ,KAAK,UAAUT,EAAK,KAAK;AAElC,SAAA,MAAM,SAAS,CAACV,OACZ,EAAE,GAAGA,GAAO,QAAQb,EAAW,CAAC,GAAGa,EAAM,QAAQmB,CAAK,CAAC,EAAE,EACjE;AAAA,EAAA;AAAA,EAGK,kBAAkB,EAAE,MAAAT,KAA2B;AACrD,UAAMS,IAAQ,KAAK,UAAUT,EAAK,KAAK;AAElC,SAAA,MAAM,SAAS,CAACV,MAAU;AAC7B,UAAI6C,IAAW;AAEf,YAAMzD,IAASY,EAAM,OAAO,IAAI,CAACW,MAC3BA,EAAE,QAAQQ,EAAM,MAAYR,KACrBkC,IAAA,IACJ1B,EACR;AAEM,aAAA;AAAA,QACL,GAAGnB;AAAA,QACH,QAAmBb,EAAX0D,IAAsBzD,IAAqB,CAAC,GAAGA,GAAQ+B,CAAK,CAAhC;AAAA,MACtC;AAAA,IAAA,CACD;AAAA,EAAA;AAAA,EAGK,YAAY,EAAE,MAAAT,KAA+C;AAC9D,SAAA,MAAM,SAAS,CAACV,MAAU;AACvB,YAAAZ,IAASY,EAAM,OAAO,OAAO,CAACW,MAAMA,EAAE,QAAQD,EAAK,MAAM,GAAG;AAC3D,aAAA,EAAE,GAAGV,GAAO,QAAAZ,EAAO;AAAA,IAAA,CAC3B;AAAA,EAAA;AAAA,EAaK,qCAAqC;AAC3C,QAAI,yBAAQ,SAAS;AAEZ,aAAA,iBAAiB,YAAY,KAAK,oBAAoB,GAGtD,OAAA,iBAAiB,cAAc,KAAK,oBAAoB;AAGzD,YAAA0D,IAAc,OAAO,QAAQ,WAC7BC,IAAiB,OAAO,QAAQ;AAGtC,aAAO,QAAQ,YAAY,IAAI,MAAMD,GAAa;AAAA,QAChD,OAAO,CAACE,GAAQC,GAASC,MAAS;AACxB,kBAAA,MAAMF,GAAQC,GAASC,CAAI,GACnC,WAAW,MAAM;AACf,iBAAK,qBAAqB;AAAA,aACzB,CAAC;AAAA,QAAA;AAAA,MACN,CACD,GACD,OAAO,QAAQ,eAAe,IAAI,MAAMH,GAAgB;AAAA,QACtD,OAAO,CAACC,GAAQC,GAASC,MAAS;AACxB,kBAAA,MAAMF,GAAQC,GAASC,CAAI,GACnC,WAAW,MAAM;AACf,iBAAK,qBAAqB;AAAA,aACzB,CAAC;AAAA,QAAA;AAAA,MACN,CACD,GAGD,KAAK,cAAcJ,GACnB,KAAK,iBAAiBC;AAAA,IAAA;AAEtB,WAAK,MAAM;AAAA,QACT;AAAA,MACF;AAAA,EACF;AAAA,EAGM,uBAAuB;AACtB,WAAA,oBAAoB,YAAY,KAAK,oBAAoB,GACzD,OAAA,oBAAoB,cAAc,KAAK,oBAAoB,GAE9D,KAAK,gBACA,OAAA,QAAQ,YAAY,KAAK,aAChC,KAAK,cAAc,SAEjB,KAAK,mBACA,OAAA,QAAQ,eAAe,KAAK,gBACnC,KAAK,iBAAiB;AAAA,EACxB;AAEJ;"}
1
+ {"version":3,"file":"client.mjs","sources":["../../../../src/clients/guide/client.ts"],"sourcesContent":["import { GenericData } from \"@knocklabs/types\";\nimport { Store } from \"@tanstack/store\";\nimport { Channel, Socket } from \"phoenix\";\nimport { URLPattern } from \"urlpattern-polyfill\";\n\nimport Knock from \"../../knock\";\n\nimport {\n DEFAULT_GROUP_KEY,\n SelectionResult,\n byKey,\n checkIfThrottled,\n findDefaultGroup,\n formatFilters,\n mockDefaultGroup,\n} from \"./helpers\";\nimport {\n ConstructorOpts,\n GetGuidesQueryParams,\n GetGuidesResponse,\n GroupStage,\n GuideAddedEvent,\n GuideData,\n GuideGroupAddedEvent,\n GuideGroupUpdatedEvent,\n GuideRemovedEvent,\n GuideSocketEvent,\n GuideStepData,\n GuideUpdatedEvent,\n KnockGuide,\n KnockGuideStep,\n MarkAsArchivedParams,\n MarkAsInteractedParams,\n MarkAsSeenParams,\n MarkGuideAsResponse,\n QueryFilterParams,\n QueryStatus,\n SelectFilterParams,\n StepMessageState,\n StoreState,\n TargetParams,\n} from \"./types\";\n\n// How long to wait until we resolve the guides order and determine the\n// prevailing guide.\nconst DEFAULT_ORDER_RESOLUTION_DURATION = 50; // in milliseconds\n\n// How often we should increment the counter to refresh the store state and\n// trigger subscribed callbacks.\nconst DEFAULT_COUNTER_INCREMENT_INTERVAL = 30 * 1000; // in milliseconds\n\nexport const guidesApiRootPath = (userId: string | undefined | null) =>\n `/v1/users/${userId}/guides`;\n\nconst select = (state: StoreState, filters: SelectFilterParams = {}) => {\n // A map of selected guides as values, with its order index as keys.\n const result = new SelectionResult();\n\n const defaultGroup = findDefaultGroup(state.guideGroups);\n if (!defaultGroup) return result;\n\n const displaySequence = defaultGroup.display_sequence;\n const location = state.location;\n\n for (const [index, guideKey] of displaySequence.entries()) {\n const guide = state.guides[guideKey];\n if (!guide) continue;\n\n const affirmed = predicate(guide, { location, filters });\n if (!affirmed) continue;\n\n result.set(index, guide);\n }\n\n result.metadata = { guideGroup: defaultGroup };\n return result;\n};\n\ntype PredicateOpts = {\n location?: string | undefined;\n filters?: SelectFilterParams | undefined;\n};\n\nconst predicate = (\n guide: KnockGuide,\n { location, filters = {} }: PredicateOpts,\n) => {\n if (filters.type && filters.type !== guide.type) {\n return false;\n }\n\n if (filters.key && filters.key !== guide.key) {\n return false;\n }\n\n if (guide.steps.every((s) => !!s.message.archived_at)) {\n return false;\n }\n\n const locationRules = guide.activation_location_rules || [];\n\n if (locationRules.length > 0 && location) {\n const allowed = locationRules.reduce<boolean | undefined>((acc, rule) => {\n // Any matched block rule prevails so no need to evaluate further\n // as soon as there is one.\n if (acc === false) return false;\n\n // At this point we either have a matched allow rule (acc is true),\n // or no matched rule found yet (acc is undefined).\n\n switch (rule.directive) {\n case \"allow\": {\n // No need to evaluate more allow rules once we matched one\n // since any matched allowed rule means allow.\n if (acc === true) return true;\n\n const matched = rule.pattern.test(location);\n return matched ? true : undefined;\n }\n\n case \"block\": {\n // Always test block rules (unless already matched to block)\n // because they'd prevail over matched allow rules.\n const matched = rule.pattern.test(location);\n return matched ? false : acc;\n }\n }\n }, undefined);\n\n if (!allowed) return false;\n }\n\n return true;\n};\n\nexport class KnockGuideClient {\n public store: Store<StoreState, (state: StoreState) => StoreState>;\n\n // Phoenix channels for real time guide updates over websocket\n private socket: Socket | undefined;\n private socketChannel: Channel | undefined;\n private socketChannelTopic: string;\n private socketEventTypes = [\n \"guide.added\",\n \"guide.updated\",\n \"guide.removed\",\n \"guide_group.added\",\n \"guide_group.updated\",\n ];\n\n // Original history methods to monkey patch, or restore in cleanups.\n private pushStateFn: History[\"pushState\"] | undefined;\n private replaceStateFn: History[\"replaceState\"] | undefined;\n\n // Guides that are competing to render are \"staged\" first without rendering\n // and ranked based on its relative order in the group over a duration of time\n // to resolve and render the prevailing one.\n private stage: GroupStage | undefined;\n\n private counterIntervalId: ReturnType<typeof setInterval> | undefined;\n\n constructor(\n readonly knock: Knock,\n readonly channelId: string,\n readonly targetParams: TargetParams = {},\n readonly options: ConstructorOpts = {},\n ) {\n const { trackLocationFromWindow = true } = options;\n\n const location = trackLocationFromWindow\n ? window?.location.href\n : undefined;\n\n this.store = new Store<StoreState>({\n guideGroups: [],\n guideGroupDisplayLogs: {},\n guides: {},\n queries: {},\n location,\n // Increment to update the state store and trigger re-selection.\n counter: 0,\n });\n\n // In server environments we might not have a socket connection.\n const { socket: maybeSocket } = this.knock.client();\n this.socket = maybeSocket;\n this.socketChannelTopic = `guides:${channelId}`;\n\n if (trackLocationFromWindow) {\n this.listenForLocationChangesFromWindow();\n }\n\n // Start the counter loop to increment at an interval.\n this.startCounterInterval();\n\n this.knock.log(\"[Guide] Initialized a guide client\");\n }\n\n private incrementCounter() {\n this.knock.log(\"[Guide] Incrementing the counter\");\n this.store.setState((state) => ({ ...state, counter: state.counter + 1 }));\n }\n\n private startCounterInterval() {\n const {\n throttleCheckInterval: delay = DEFAULT_COUNTER_INCREMENT_INTERVAL,\n } = this.options;\n\n this.counterIntervalId = setInterval(() => {\n this.knock.log(\"[Guide] Counter interval tick\");\n if (this.stage && this.stage.status !== \"closed\") return;\n\n this.incrementCounter();\n }, delay);\n }\n\n private clearCounterInterval() {\n if (this.counterIntervalId) {\n clearInterval(this.counterIntervalId);\n this.counterIntervalId = undefined;\n }\n }\n\n cleanup() {\n this.unsubscribe();\n this.removeEventListeners();\n this.clearGroupStage();\n this.clearCounterInterval();\n }\n\n async fetch(opts?: { filters?: QueryFilterParams }) {\n this.knock.failIfNotAuthenticated();\n this.knock.log(\"[Guide] Loading all eligible guides\");\n\n const queryParams = this.buildQueryParams(opts?.filters);\n const queryKey = this.formatQueryKey(queryParams);\n\n // If already fetched before, then noop.\n const maybeQueryStatus = this.store.state.queries[queryKey];\n if (maybeQueryStatus) {\n return maybeQueryStatus;\n }\n\n // Mark this query status as loading.\n this.store.setState((state) => ({\n ...state,\n queries: { ...state.queries, [queryKey]: { status: \"loading\" } },\n }));\n\n let queryStatus: QueryStatus;\n try {\n const data = await this.knock.user.getGuides<\n GetGuidesQueryParams,\n GetGuidesResponse\n >(this.channelId, queryParams);\n queryStatus = { status: \"ok\" };\n\n const {\n entries,\n guide_groups: groups,\n guide_group_display_logs: guideGroupDisplayLogs,\n } = data;\n\n this.store.setState((state) => ({\n ...state,\n guideGroups: groups?.length > 0 ? groups : [mockDefaultGroup(entries)],\n guideGroupDisplayLogs,\n guides: byKey(entries.map((g) => this.localCopy(g))),\n queries: { ...state.queries, [queryKey]: queryStatus },\n }));\n } catch (e) {\n queryStatus = { status: \"error\", error: e as Error };\n\n this.store.setState((state) => ({\n ...state,\n queries: { ...state.queries, [queryKey]: queryStatus },\n }));\n }\n\n return queryStatus;\n }\n\n subscribe() {\n if (!this.socket) return;\n this.knock.failIfNotAuthenticated();\n this.knock.log(\"[Guide] Subscribing to real time updates\");\n\n // Ensure a live socket connection if not yet connected.\n if (!this.socket.isConnected()) {\n this.socket.connect();\n }\n\n // If there's an existing connected channel, then disconnect.\n if (this.socketChannel) {\n this.unsubscribe();\n }\n\n // Join the channel topic and subscribe to supported events.\n const params = { ...this.targetParams, user_id: this.knock.userId };\n const newChannel = this.socket.channel(this.socketChannelTopic, params);\n\n for (const eventType of this.socketEventTypes) {\n newChannel.on(eventType, (payload) => this.handleSocketEvent(payload));\n }\n\n if ([\"closed\", \"errored\"].includes(newChannel.state)) {\n newChannel.join();\n }\n\n // Track the joined channel.\n this.socketChannel = newChannel;\n }\n\n unsubscribe() {\n if (!this.socketChannel) return;\n this.knock.log(\"[Guide] Unsubscribing from real time updates\");\n\n // Unsubscribe from the socket events and leave the channel.\n for (const eventType of this.socketEventTypes) {\n this.socketChannel.off(eventType);\n }\n this.socketChannel.leave();\n\n // Unset the channel.\n this.socketChannel = undefined;\n }\n\n private handleSocketEvent(payload: GuideSocketEvent) {\n const { event, data } = payload;\n\n switch (event) {\n case \"guide.added\":\n return this.addOrReplaceGuide(payload);\n\n case \"guide.updated\":\n return data.eligible\n ? this.addOrReplaceGuide(payload)\n : this.removeGuide(payload);\n\n case \"guide.removed\":\n return this.removeGuide(payload);\n\n case \"guide_group.added\":\n case \"guide_group.updated\":\n return this.addOrReplaceGuideGroup(payload);\n\n default:\n return;\n }\n }\n\n setLocation(href: string) {\n // Make sure to clear out the stage.\n this.clearGroupStage();\n\n this.store.setState((state) => ({ ...state, location: href }));\n }\n\n //\n // Store selector\n //\n\n selectGuides(state: StoreState, filters: SelectFilterParams = {}) {\n if (Object.keys(state.guides).length === 0) {\n return [];\n }\n this.knock.log(`[Guide] Selecting guides for: ${formatFilters(filters)}`);\n\n const result = select(state, filters);\n\n if (result.size === 0) {\n this.knock.log(\"[Guide] Selection returned zero result\");\n return [];\n }\n\n // Return all selected guides, since we cannot apply the one-at-a-time limit\n // or throttle settings, but rather defer to the caller to decide which ones\n // to render. Note\n return [...result.values()];\n }\n\n selectGuide(state: StoreState, filters: SelectFilterParams = {}) {\n if (Object.keys(state.guides).length === 0) {\n return undefined;\n }\n this.knock.log(`[Guide] Selecting a guide for: ${formatFilters(filters)}`);\n\n const result = select(state, filters);\n\n if (result.size === 0) {\n this.knock.log(\"[Guide] Selection returned zero result\");\n return undefined;\n }\n\n const [index, guide] = [...result][0]!;\n\n // If a guide ignores the group limit, then return immediately to render\n // always.\n if (guide.bypass_global_group_limit) {\n return guide;\n }\n\n // Check if inside the throttle window (i.e. throttled) and if so stop and\n // return undefined.\n const defaultGroup = findDefaultGroup(state.guideGroups);\n const throttleWindowStartedAt =\n state.guideGroupDisplayLogs[DEFAULT_GROUP_KEY];\n\n if (\n defaultGroup &&\n defaultGroup.display_interval &&\n throttleWindowStartedAt\n ) {\n const throttled = checkIfThrottled(\n throttleWindowStartedAt,\n defaultGroup.display_interval,\n );\n if (throttled) return undefined;\n }\n\n // Starting here to the end of this method represents the core logic of how\n // \"group stage\" works. It provides a mechanism for 1) figuring out which\n // guide components are about to render on a page, 2) determining which\n // among them ranks highest in the configured display sequence, and 3)\n // returning only the prevailing guide to render at a time.\n //\n // Imagine N number of components that use the `useGuide()` hook which\n // calls this `selectGuide()` method, and the logic works like this:\n // * The first time this method is called, we don't have an \"open\" group\n // stage, so we open one (this occurs when a new page/route is rendering).\n // * While it is open, we record which guide was selected and its order\n // index from each call, but we do NOT return any guide to render yet.\n // * When a group stage opens, it schedules a timer to close itself. How\n // long this timer waits is configurable. Note, `setTimeout` with 0\n // delay seems to work well for React apps, where we \"yield\" to React\n // for one render cycle and close the group right after.\n // * When a group stage closes, we evaluate which guides were selected and\n // recorded, then determine the winning guide (i.e. the one with the\n // lowest order index value).\n // * Then increment the internal counter to trigger a store state update,\n // which allows `useGuide()` and `selectGuide()` to re-run. This second\n // round of `selectGuide()` calls, occurring when the group stage is\n // closed, results in returning the prevailing guide.\n // * Whenever a user navigates to a new page, we repeat the same process\n // above.\n // * There's a third status called \"patch,\" which is for handling real-time\n // updates received from the API. It's similar to the \"open\" to \"closed\"\n // flow, except we keep the resolved guide in place while we recalculate.\n // This is done so that we don't cause flickers or CLS.\n if (!this.stage) {\n this.stage = this.openGroupStage(); // Assign here to make tsc happy\n }\n\n switch (this.stage.status) {\n case \"open\": {\n this.knock.log(`[Guide] Addng to the group stage: ${guide.key}`);\n this.stage.ordered[index] = guide.key;\n return undefined;\n }\n\n case \"patch\": {\n this.knock.log(`[Guide] Patching the group stage: ${guide.key}`);\n this.stage.ordered[index] = guide.key;\n return this.stage.resolved === guide.key ? guide : undefined;\n }\n\n case \"closed\": {\n return this.stage.resolved === guide.key ? guide : undefined;\n }\n }\n }\n\n private openGroupStage() {\n this.knock.log(\"[Guide] Opening a new group stage\");\n\n const {\n orderResolutionDuration: delay = DEFAULT_ORDER_RESOLUTION_DURATION,\n } = this.options;\n\n const timeoutId = setTimeout(() => {\n this.closePendingGroupStage();\n this.incrementCounter();\n }, delay);\n\n this.stage = {\n status: \"open\",\n ordered: [],\n timeoutId,\n };\n\n return this.stage;\n }\n\n // Close the current non-closed stage to resolve the prevailing guide up next\n // for display amongst the ones that have been staged.\n private closePendingGroupStage() {\n if (!this.stage || this.stage.status === \"closed\") return;\n\n this.knock.log(\"[Guide] Closing the current group stage\");\n\n // Should have been cleared already since this method should be called as a\n // callback to a setTimeout, but just to be safe.\n this.ensureClearTimeout();\n\n this.stage = {\n ...this.stage,\n status: \"closed\",\n resolved: this.stage.ordered.find((x) => x !== undefined),\n timeoutId: null,\n };\n\n return this.stage;\n }\n\n // Set the current closed stage status to \"patch\" to allow re-running\n // selections and re-building a group stage with the latest/updated state,\n // while keeping the currently resolved guide in place so that it stays\n // rendered until we are ready to resolve the updated stage and re-render.\n // Note, must be called ahead of updating the state store.\n private patchClosedGroupStage() {\n if (this.stage?.status !== \"closed\") return;\n\n this.knock.log(\"[Guide] Patching the current group stage\");\n\n const { orderResolutionDuration: delay = 0 } = this.options;\n\n const timeoutId = setTimeout(() => {\n this.closePendingGroupStage();\n this.incrementCounter();\n }, delay);\n\n // Just to be safe.\n this.ensureClearTimeout();\n\n this.stage = {\n ...this.stage,\n status: \"patch\",\n ordered: [],\n timeoutId,\n };\n\n return this.stage;\n }\n\n private clearGroupStage() {\n if (!this.stage) return;\n\n this.knock.log(\"[Guide] Clearing the current group stage\");\n\n this.ensureClearTimeout();\n this.stage = undefined;\n }\n\n private ensureClearTimeout() {\n if (this.stage?.timeoutId) {\n clearTimeout(this.stage.timeoutId);\n }\n }\n\n // Test helper that opens and closes the group stage to return the select\n // result immediately.\n private _selectGuide(state: StoreState, filters: SelectFilterParams = {}) {\n this.openGroupStage();\n\n this.selectGuide(state, filters);\n this.closePendingGroupStage();\n\n return this.selectGuide(state, filters);\n }\n\n //\n // Engagement event handlers\n //\n // Make an optimistic update on the client side first, then send an engagement\n // event to the backend.\n //\n\n async markAsSeen(guide: GuideData, step: GuideStepData) {\n if (step.message.seen_at) return;\n\n this.knock.log(\n `[Guide] Marking as seen (Guide key: ${guide.key}, Step ref:${step.ref})`,\n );\n\n const updatedStep = this.setStepMessageAttrs(guide.key, step.ref, {\n seen_at: new Date().toISOString(),\n });\n if (!updatedStep) return;\n\n const params = {\n ...this.buildEngagementEventBaseParams(guide, updatedStep),\n content: updatedStep.content,\n data: this.targetParams.data,\n tenant: this.targetParams.tenant,\n };\n\n this.knock.user.markGuideStepAs<MarkAsSeenParams, MarkGuideAsResponse>(\n \"seen\",\n params,\n );\n\n return updatedStep;\n }\n\n async markAsInteracted(\n guide: GuideData,\n step: GuideStepData,\n metadata?: GenericData,\n ) {\n this.knock.log(\n `[Guide] Marking as interacted (Guide key: ${guide.key}, Step ref:${step.ref})`,\n );\n\n const ts = new Date().toISOString();\n const updatedStep = this.setStepMessageAttrs(guide.key, step.ref, {\n read_at: ts,\n interacted_at: ts,\n });\n if (!updatedStep) return;\n\n const params = {\n ...this.buildEngagementEventBaseParams(guide, updatedStep),\n metadata,\n };\n\n this.knock.user.markGuideStepAs<\n MarkAsInteractedParams,\n MarkGuideAsResponse\n >(\"interacted\", params);\n\n return updatedStep;\n }\n\n async markAsArchived(guide: GuideData, step: GuideStepData) {\n if (step.message.archived_at) return;\n\n this.knock.log(\n `[Guide] Marking as archived (Guide key: ${guide.key}, Step ref:${step.ref})`,\n );\n\n const updatedStep = this.setStepMessageAttrs(guide.key, step.ref, {\n archived_at: new Date().toISOString(),\n });\n if (!updatedStep) return;\n\n const params = this.buildEngagementEventBaseParams(guide, updatedStep);\n\n this.knock.user.markGuideStepAs<MarkAsArchivedParams, MarkGuideAsResponse>(\n \"archived\",\n {\n ...params,\n unthrottled: guide.bypass_global_group_limit,\n },\n );\n\n return updatedStep;\n }\n\n //\n // Helpers\n //\n\n private localCopy(remoteGuide: GuideData) {\n // eslint-disable-next-line @typescript-eslint/no-this-alias\n const self = this;\n\n // Build a local copy with helper methods added.\n const localGuide = {\n ...remoteGuide,\n // Get the next unarchived step.\n getStep() {\n return this.steps.find((s) => !s.message.archived_at);\n },\n } as KnockGuide;\n\n localGuide.getStep = localGuide.getStep.bind(localGuide);\n\n localGuide.steps = remoteGuide.steps.map(({ message, ...rest }) => {\n const localStep = {\n ...rest,\n message: { ...message },\n markAsSeen() {\n // Send a seen event if it has not been previously seen.\n if (this.message.seen_at) return;\n return self.markAsSeen(localGuide, this);\n },\n markAsInteracted({ metadata }: { metadata?: GenericData } = {}) {\n // Always send an interaction event through.\n return self.markAsInteracted(localGuide, this, metadata);\n },\n markAsArchived() {\n // Send an archived event if it has not been previously archived.\n if (this.message.archived_at) return;\n return self.markAsArchived(localGuide, this);\n },\n };\n\n // Bind all engagement action handler methods to the local step object so\n // they can operate on itself.\n localStep.markAsSeen = localStep.markAsSeen.bind(localStep);\n localStep.markAsInteracted = localStep.markAsInteracted.bind(localStep);\n localStep.markAsArchived = localStep.markAsArchived.bind(localStep);\n\n return localStep;\n });\n\n localGuide.activation_location_rules =\n remoteGuide.activation_location_rules.map((rule) => {\n return {\n ...rule,\n pattern: new URLPattern({ pathname: rule.pathname }),\n };\n });\n\n return localGuide;\n }\n\n private buildQueryParams(filterParams: QueryFilterParams = {}) {\n // Combine the target params with the given filter params.\n const combinedParams = { ...this.targetParams, ...filterParams };\n\n // Prune out any keys that have an undefined or null value.\n let params = Object.fromEntries(\n Object.entries(combinedParams).filter(\n ([_k, v]) => v !== undefined && v !== null,\n ),\n );\n\n // Encode target data as a JSON string, if provided.\n params = params.data\n ? { ...params, data: JSON.stringify(params.data) }\n : params;\n\n return params as GetGuidesQueryParams;\n }\n\n private formatQueryKey(queryParams: GenericData) {\n const sortedKeys = Object.keys(queryParams).sort();\n\n const queryStr = sortedKeys\n .map(\n (key) =>\n `${encodeURIComponent(key)}=${encodeURIComponent(queryParams[key])}`,\n )\n .join(\"&\");\n\n const basePath = guidesApiRootPath(this.knock.userId);\n return queryStr ? `${basePath}?${queryStr}` : basePath;\n }\n\n private setStepMessageAttrs(\n guideKey: string,\n stepRef: string,\n attrs: Partial<StepMessageState>,\n ) {\n let updatedStep: KnockGuideStep | undefined;\n\n // If we are marking as archived, clear the group stage so we can render\n // the next guide in the group.\n if (attrs.archived_at) {\n this.clearGroupStage();\n }\n\n this.store.setState((state) => {\n const guide = state.guides[guideKey];\n if (!guide) return state;\n\n const steps = guide.steps.map((step) => {\n if (step.ref !== stepRef) return step;\n\n // Mutate in place and maintain the same obj ref so to make it easier\n // to use in hook deps.\n step.message = { ...step.message, ...attrs };\n updatedStep = step;\n\n return step;\n });\n // Mutate in place and maintain the same obj ref.\n guide.steps = steps;\n const guides = { ...state.guides, [guide.key]: guide };\n\n // If the guide is subject to throttled settings and we are marking as\n // archived, then update the display logs to start a new throttle window.\n const guideGroupDisplayLogs =\n attrs.archived_at && !guide.bypass_global_group_limit\n ? {\n ...state.guideGroupDisplayLogs,\n [DEFAULT_GROUP_KEY]: attrs.archived_at,\n }\n : state.guideGroupDisplayLogs;\n\n return { ...state, guides, guideGroupDisplayLogs };\n });\n\n return updatedStep;\n }\n\n private buildEngagementEventBaseParams(\n guide: GuideData,\n step: GuideStepData,\n ) {\n return {\n message_id: step.message.id,\n channel_id: guide.channel_id,\n guide_key: guide.key,\n guide_id: guide.id,\n guide_step_ref: step.ref,\n };\n }\n\n private addOrReplaceGuide({ data }: GuideAddedEvent | GuideUpdatedEvent) {\n this.patchClosedGroupStage();\n\n const guide = this.localCopy(data.guide);\n\n this.store.setState((state) => {\n const guides = { ...state.guides, [guide.key]: guide };\n\n return { ...state, guides };\n });\n }\n\n private removeGuide({ data }: GuideUpdatedEvent | GuideRemovedEvent) {\n this.patchClosedGroupStage();\n\n this.store.setState((state) => {\n const { [data.guide.key]: _, ...rest } = state.guides;\n return { ...state, guides: rest };\n });\n }\n\n private addOrReplaceGuideGroup({\n data,\n }: GuideGroupAddedEvent | GuideGroupUpdatedEvent) {\n this.patchClosedGroupStage();\n\n this.store.setState((state) => {\n // Currently we only support a single default global group, so we can just\n // update the list with the added/updated group.\n const guideGroups = [data.guide_group];\n\n // A guide group event can include lists of unthrottled vs throttled guide\n // keys which we can use to bulk update the guides in the store already.\n const unthrottled = data.guide_group.display_sequence_unthrottled || [];\n const throttled = data.guide_group.display_sequence_throttled || [];\n\n let guides = state.guides;\n\n guides = unthrottled.reduce((acc, key) => {\n if (!acc[key]) return acc;\n const guide = { ...acc[key], bypass_global_group_limit: true };\n return { ...acc, [key]: guide };\n }, guides);\n\n guides = throttled.reduce((acc, key) => {\n if (!acc[key]) return acc;\n const guide = { ...acc[key], bypass_global_group_limit: false };\n return { ...acc, [key]: guide };\n }, guides);\n\n return { ...state, guides, guideGroups };\n });\n }\n\n // Define as an arrow func property to always bind this to the class instance.\n private handleLocationChange = () => {\n const href = window.location.href;\n if (this.store.state.location === href) return;\n\n this.knock.log(`[Guide] Handle Location change: ${href}`);\n this.setLocation(href);\n };\n\n private listenForLocationChangesFromWindow() {\n if (window?.history) {\n // 1. Listen for browser back/forward button clicks.\n window.addEventListener(\"popstate\", this.handleLocationChange);\n\n // 2. Listen for hash changes in case it's used for routing.\n window.addEventListener(\"hashchange\", this.handleLocationChange);\n\n // 3. Monkey-patch history methods to catch programmatic navigation.\n const pushStateFn = window.history.pushState;\n const replaceStateFn = window.history.replaceState;\n\n // Use setTimeout to allow the browser state to potentially settle.\n window.history.pushState = new Proxy(pushStateFn, {\n apply: (target, history, args) => {\n Reflect.apply(target, history, args);\n setTimeout(() => {\n this.handleLocationChange();\n }, 0);\n },\n });\n window.history.replaceState = new Proxy(replaceStateFn, {\n apply: (target, history, args) => {\n Reflect.apply(target, history, args);\n setTimeout(() => {\n this.handleLocationChange();\n }, 0);\n },\n });\n\n // 4. Keep refs to the original handlers so we can restore during cleanup.\n this.pushStateFn = pushStateFn;\n this.replaceStateFn = replaceStateFn;\n } else {\n this.knock.log(\n \"[Guide] Unable to access the `window.history` object to detect location changes\",\n );\n }\n }\n\n private removeEventListeners() {\n window.removeEventListener(\"popstate\", this.handleLocationChange);\n window.removeEventListener(\"hashchange\", this.handleLocationChange);\n\n if (this.pushStateFn) {\n window.history.pushState = this.pushStateFn;\n this.pushStateFn = undefined;\n }\n if (this.replaceStateFn) {\n window.history.replaceState = this.replaceStateFn;\n this.replaceStateFn = undefined;\n }\n }\n}\n"],"names":["DEFAULT_ORDER_RESOLUTION_DURATION","DEFAULT_COUNTER_INCREMENT_INTERVAL","guidesApiRootPath","userId","select","state","filters","result","SelectionResult","defaultGroup","findDefaultGroup","displaySequence","location","index","guideKey","guide","predicate","s","locationRules","acc","rule","KnockGuideClient","knock","channelId","targetParams","options","__publicField","href","trackLocationFromWindow","Store","maybeSocket","delay","opts","queryParams","queryKey","maybeQueryStatus","queryStatus","data","entries","groups","guideGroupDisplayLogs","mockDefaultGroup","byKey","g","e","params","newChannel","eventType","payload","event","formatFilters","throttleWindowStartedAt","DEFAULT_GROUP_KEY","checkIfThrottled","timeoutId","x","_a","step","updatedStep","metadata","ts","remoteGuide","self","localGuide","message","rest","localStep","URLPattern","filterParams","combinedParams","_k","v","queryStr","key","basePath","stepRef","attrs","steps","guides","_","guideGroups","unthrottled","throttled","pushStateFn","replaceStateFn","target","history","args"],"mappings":";;;;;;AA6CA,MAAMA,IAAoC,IAIpCC,IAAqC,KAAK,KAEnCC,IAAoB,CAACC,MAChC,aAAaA,CAAM,WAEfC,IAAS,CAACC,GAAmBC,IAA8B,OAAO;AAEhE,QAAAC,IAAS,IAAIC,EAAgB,GAE7BC,IAAeC,EAAiBL,EAAM,WAAW;AACnD,MAAA,CAACI,EAAqB,QAAAF;AAE1B,QAAMI,IAAkBF,EAAa,kBAC/BG,IAAWP,EAAM;AAEvB,aAAW,CAACQ,GAAOC,CAAQ,KAAKH,EAAgB,WAAW;AACnD,UAAAI,IAAQV,EAAM,OAAOS,CAAQ;AAInC,IAHI,CAACC,KAGD,CADaC,EAAUD,GAAO,EAAE,UAAAH,GAAU,SAAAN,GAAS,KAGhDC,EAAA,IAAIM,GAAOE,CAAK;AAAA,EAAA;AAGlB,SAAAR,EAAA,WAAW,EAAE,YAAYE,EAAa,GACtCF;AACT,GAOMS,IAAY,CAChBD,GACA,EAAE,UAAAH,GAAU,SAAAN,IAAU,SACnB;AASC,MARAA,EAAQ,QAAQA,EAAQ,SAASS,EAAM,QAIvCT,EAAQ,OAAOA,EAAQ,QAAQS,EAAM,OAIrCA,EAAM,MAAM,MAAM,CAACE,MAAM,CAAC,CAACA,EAAE,QAAQ,WAAW;AAC3C,WAAA;AAGH,QAAAC,IAAgBH,EAAM,6BAA6B,CAAC;AAEtD,SAAA,EAAAG,EAAc,SAAS,KAAKN,KA4B1B,CA3BYM,EAAc,OAA4B,CAACC,GAAKC,MAAS;AAGnE,QAAAD,MAAQ,GAAc,QAAA;AAK1B,YAAQC,EAAK,WAAW;AAAA,MACtB,KAAK;AAGC,eAAAD,MAAQ,MAEIC,EAAK,QAAQ,KAAKR,CAAQ,IAFjB,KAGD;AAAA,MAG1B,KAAK;AAIH,eADgBQ,EAAK,QAAQ,KAAKR,CAAQ,IACzB,KAAQO;AAAA,IAC3B;AAAA,KAED,MAAS;AAMhB;AAEO,MAAME,EAAiB;AAAA,EA0B5B,YACWC,GACAC,GACAC,IAA6B,CAC7B,GAAAC,IAA2B,IACpC;AA9BK,IAAAC,EAAA;AAGC;AAAA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA,0BAAmB;AAAA,MACzB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAGQ;AAAA,IAAAA,EAAA;AACA,IAAAA,EAAA;AAKA;AAAA;AAAA;AAAA,IAAAA,EAAA;AAEA,IAAAA,EAAA;AAksBA;AAAA,IAAAA,EAAA,8BAAuB,MAAM;AAC7B,YAAAC,IAAO,OAAO,SAAS;AAC7B,MAAI,KAAK,MAAM,MAAM,aAAaA,MAElC,KAAK,MAAM,IAAI,mCAAmCA,CAAI,EAAE,GACxD,KAAK,YAAYA,CAAI;AAAA,IACvB;AArsBW,SAAA,QAAAL,GACA,KAAA,YAAAC,GACA,KAAA,eAAAC,GACA,KAAA,UAAAC;AAEH,UAAA,EAAE,yBAAAG,IAA0B,GAAA,IAASH,GAErCb,IAAWgB,IACb,iCAAQ,SAAS,OACjB;AAEC,SAAA,QAAQ,IAAIC,EAAkB;AAAA,MACjC,aAAa,CAAC;AAAA,MACd,uBAAuB,CAAC;AAAA,MACxB,QAAQ,CAAC;AAAA,MACT,SAAS,CAAC;AAAA,MACV,UAAAjB;AAAA;AAAA,MAEA,SAAS;AAAA,IAAA,CACV;AAGD,UAAM,EAAE,QAAQkB,EAAA,IAAgB,KAAK,MAAM,OAAO;AAClD,SAAK,SAASA,GACT,KAAA,qBAAqB,UAAUP,CAAS,IAEzCK,KACF,KAAK,mCAAmC,GAI1C,KAAK,qBAAqB,GAErB,KAAA,MAAM,IAAI,oCAAoC;AAAA,EAAA;AAAA,EAG7C,mBAAmB;AACpB,SAAA,MAAM,IAAI,kCAAkC,GAC5C,KAAA,MAAM,SAAS,CAACvB,OAAW,EAAE,GAAGA,GAAO,SAASA,EAAM,UAAU,EAAI,EAAA;AAAA,EAAA;AAAA,EAGnE,uBAAuB;AACvB,UAAA;AAAA,MACJ,uBAAuB0B,IAAQ9B;AAAA,QAC7B,KAAK;AAEJ,SAAA,oBAAoB,YAAY,MAAM;AAEzC,MADK,KAAA,MAAM,IAAI,+BAA+B,GAC1C,OAAK,SAAS,KAAK,MAAM,WAAW,aAExC,KAAK,iBAAiB;AAAA,OACrB8B,CAAK;AAAA,EAAA;AAAA,EAGF,uBAAuB;AAC7B,IAAI,KAAK,sBACP,cAAc,KAAK,iBAAiB,GACpC,KAAK,oBAAoB;AAAA,EAC3B;AAAA,EAGF,UAAU;AACR,SAAK,YAAY,GACjB,KAAK,qBAAqB,GAC1B,KAAK,gBAAgB,GACrB,KAAK,qBAAqB;AAAA,EAAA;AAAA,EAG5B,MAAM,MAAMC,GAAwC;AAClD,SAAK,MAAM,uBAAuB,GAC7B,KAAA,MAAM,IAAI,qCAAqC;AAEpD,UAAMC,IAAc,KAAK,iBAAiBD,KAAA,gBAAAA,EAAM,OAAO,GACjDE,IAAW,KAAK,eAAeD,CAAW,GAG1CE,IAAmB,KAAK,MAAM,MAAM,QAAQD,CAAQ;AAC1D,QAAIC;AACK,aAAAA;AAIJ,SAAA,MAAM,SAAS,CAAC9B,OAAW;AAAA,MAC9B,GAAGA;AAAA,MACH,SAAS,EAAE,GAAGA,EAAM,SAAS,CAAC6B,CAAQ,GAAG,EAAE,QAAQ,UAAY,EAAA;AAAA,IAAA,EAC/D;AAEE,QAAAE;AACA,QAAA;AACI,YAAAC,IAAO,MAAM,KAAK,MAAM,KAAK,UAGjC,KAAK,WAAWJ,CAAW;AACf,MAAAG,IAAA,EAAE,QAAQ,KAAK;AAEvB,YAAA;AAAA,QACJ,SAAAE;AAAA,QACA,cAAcC;AAAA,QACd,0BAA0BC;AAAA,MAAA,IACxBH;AAEC,WAAA,MAAM,SAAS,CAAChC,OAAW;AAAA,QAC9B,GAAGA;AAAA,QACH,cAAakC,KAAA,gBAAAA,EAAQ,UAAS,IAAIA,IAAS,CAACE,EAAiBH,CAAO,CAAC;AAAA,QACrE,uBAAAE;AAAA,QACA,QAAQE,EAAMJ,EAAQ,IAAI,CAACK,MAAM,KAAK,UAAUA,CAAC,CAAC,CAAC;AAAA,QACnD,SAAS,EAAE,GAAGtC,EAAM,SAAS,CAAC6B,CAAQ,GAAGE,EAAY;AAAA,MAAA,EACrD;AAAA,aACKQ,GAAG;AACV,MAAAR,IAAc,EAAE,QAAQ,SAAS,OAAOQ,EAAW,GAE9C,KAAA,MAAM,SAAS,CAACvC,OAAW;AAAA,QAC9B,GAAGA;AAAA,QACH,SAAS,EAAE,GAAGA,EAAM,SAAS,CAAC6B,CAAQ,GAAGE,EAAY;AAAA,MAAA,EACrD;AAAA,IAAA;AAGG,WAAAA;AAAA,EAAA;AAAA,EAGT,YAAY;AACN,QAAA,CAAC,KAAK,OAAQ;AAClB,SAAK,MAAM,uBAAuB,GAC7B,KAAA,MAAM,IAAI,0CAA0C,GAGpD,KAAK,OAAO,iBACf,KAAK,OAAO,QAAQ,GAIlB,KAAK,iBACP,KAAK,YAAY;AAIb,UAAAS,IAAS,EAAE,GAAG,KAAK,cAAc,SAAS,KAAK,MAAM,OAAO,GAC5DC,IAAa,KAAK,OAAO,QAAQ,KAAK,oBAAoBD,CAAM;AAE3D,eAAAE,KAAa,KAAK;AAC3B,MAAAD,EAAW,GAAGC,GAAW,CAACC,MAAY,KAAK,kBAAkBA,CAAO,CAAC;AAGvE,IAAI,CAAC,UAAU,SAAS,EAAE,SAASF,EAAW,KAAK,KACjDA,EAAW,KAAK,GAIlB,KAAK,gBAAgBA;AAAA,EAAA;AAAA,EAGvB,cAAc;AACR,QAAC,KAAK,eACL;AAAA,WAAA,MAAM,IAAI,8CAA8C;AAGlD,iBAAAC,KAAa,KAAK;AACtB,aAAA,cAAc,IAAIA,CAAS;AAElC,WAAK,cAAc,MAAM,GAGzB,KAAK,gBAAgB;AAAA;AAAA,EAAA;AAAA,EAGf,kBAAkBC,GAA2B;AAC7C,UAAA,EAAE,OAAAC,GAAO,MAAAZ,EAAA,IAASW;AAExB,YAAQC,GAAO;AAAA,MACb,KAAK;AACI,eAAA,KAAK,kBAAkBD,CAAO;AAAA,MAEvC,KAAK;AACI,eAAAX,EAAK,WACR,KAAK,kBAAkBW,CAAO,IAC9B,KAAK,YAAYA,CAAO;AAAA,MAE9B,KAAK;AACI,eAAA,KAAK,YAAYA,CAAO;AAAA,MAEjC,KAAK;AAAA,MACL,KAAK;AACI,eAAA,KAAK,uBAAuBA,CAAO;AAAA,MAE5C;AACE;AAAA,IAAA;AAAA,EACJ;AAAA,EAGF,YAAYrB,GAAc;AAExB,SAAK,gBAAgB,GAEhB,KAAA,MAAM,SAAS,CAACtB,OAAW,EAAE,GAAGA,GAAO,UAAUsB,EAAA,EAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAO/D,aAAatB,GAAmBC,IAA8B,IAAI;AAChE,QAAI,OAAO,KAAKD,EAAM,MAAM,EAAE,WAAW;AACvC,aAAO,CAAC;AAEV,SAAK,MAAM,IAAI,iCAAiC6C,EAAc5C,CAAO,CAAC,EAAE;AAElE,UAAAC,IAASH,EAAOC,GAAOC,CAAO;AAEhC,WAAAC,EAAO,SAAS,KACb,KAAA,MAAM,IAAI,wCAAwC,GAChD,CAAC,KAMH,CAAC,GAAGA,EAAO,QAAQ;AAAA,EAAA;AAAA,EAG5B,YAAYF,GAAmBC,IAA8B,IAAI;AAC/D,QAAI,OAAO,KAAKD,EAAM,MAAM,EAAE,WAAW;AAChC;AAET,SAAK,MAAM,IAAI,kCAAkC6C,EAAc5C,CAAO,CAAC,EAAE;AAEnE,UAAAC,IAASH,EAAOC,GAAOC,CAAO;AAEhC,QAAAC,EAAO,SAAS,GAAG;AAChB,WAAA,MAAM,IAAI,wCAAwC;AAChD;AAAA,IAAA;AAGH,UAAA,CAACM,GAAOE,CAAK,IAAI,CAAC,GAAGR,CAAM,EAAE,CAAC;AAIpC,QAAIQ,EAAM;AACD,aAAAA;AAKH,UAAAN,IAAeC,EAAiBL,EAAM,WAAW,GACjD8C,IACJ9C,EAAM,sBAAsB+C,CAAiB;AAG7C,QAAA,EAAA3C,KACAA,EAAa,oBACb0C,KAEkBE;AAAA,MAChBF;AAAA,MACA1C,EAAa;AAAA,IACf;AAqCM,cAJH,KAAK,UACH,KAAA,QAAQ,KAAK,eAAe,IAG3B,KAAK,MAAM,QAAQ;AAAA,QACzB,KAAK,QAAQ;AACX,eAAK,MAAM,IAAI,qCAAqCM,EAAM,GAAG,EAAE,GAC/D,KAAK,MAAM,QAAQF,CAAK,IAAIE,EAAM;AAC3B;AAAA,QAAA;AAAA,QAGT,KAAK;AACH,sBAAK,MAAM,IAAI,qCAAqCA,EAAM,GAAG,EAAE,GAC/D,KAAK,MAAM,QAAQF,CAAK,IAAIE,EAAM,KAC3B,KAAK,MAAM,aAAaA,EAAM,MAAMA,IAAQ;AAAA,QAGrD,KAAK;AACH,iBAAO,KAAK,MAAM,aAAaA,EAAM,MAAMA,IAAQ;AAAA,MACrD;AAAA,EACF;AAAA,EAGM,iBAAiB;AAClB,SAAA,MAAM,IAAI,mCAAmC;AAE5C,UAAA;AAAA,MACJ,yBAAyBgB,IAAQ/B;AAAA,QAC/B,KAAK,SAEHsD,IAAY,WAAW,MAAM;AACjC,WAAK,uBAAuB,GAC5B,KAAK,iBAAiB;AAAA,OACrBvB,CAAK;AAER,gBAAK,QAAQ;AAAA,MACX,QAAQ;AAAA,MACR,SAAS,CAAC;AAAA,MACV,WAAAuB;AAAA,IACF,GAEO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA,EAKN,yBAAyB;AAC/B,QAAI,GAAC,KAAK,SAAS,KAAK,MAAM,WAAW;AAEpC,kBAAA,MAAM,IAAI,yCAAyC,GAIxD,KAAK,mBAAmB,GAExB,KAAK,QAAQ;AAAA,QACX,GAAG,KAAK;AAAA,QACR,QAAQ;AAAA,QACR,UAAU,KAAK,MAAM,QAAQ,KAAK,CAACC,MAAMA,MAAM,MAAS;AAAA,QACxD,WAAW;AAAA,MACb,GAEO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQN,wBAAwB;;AAC1B,UAAAC,IAAA,KAAK,UAAL,gBAAAA,EAAY,YAAW,SAAU;AAEhC,SAAA,MAAM,IAAI,0CAA0C;AAEzD,UAAM,EAAE,yBAAyBzB,IAAQ,MAAM,KAAK,SAE9CuB,IAAY,WAAW,MAAM;AACjC,WAAK,uBAAuB,GAC5B,KAAK,iBAAiB;AAAA,OACrBvB,CAAK;AAGR,gBAAK,mBAAmB,GAExB,KAAK,QAAQ;AAAA,MACX,GAAG,KAAK;AAAA,MACR,QAAQ;AAAA,MACR,SAAS,CAAC;AAAA,MACV,WAAAuB;AAAA,IACF,GAEO,KAAK;AAAA,EAAA;AAAA,EAGN,kBAAkB;AACpB,IAAC,KAAK,UAEL,KAAA,MAAM,IAAI,0CAA0C,GAEzD,KAAK,mBAAmB,GACxB,KAAK,QAAQ;AAAA,EAAA;AAAA,EAGP,qBAAqB;;AACvB,KAAAE,IAAA,KAAK,UAAL,QAAAA,EAAY,aACD,aAAA,KAAK,MAAM,SAAS;AAAA,EACnC;AAAA;AAAA;AAAA,EAKM,aAAanD,GAAmBC,IAA8B,IAAI;AACxE,gBAAK,eAAe,GAEf,KAAA,YAAYD,GAAOC,CAAO,GAC/B,KAAK,uBAAuB,GAErB,KAAK,YAAYD,GAAOC,CAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUxC,MAAM,WAAWS,GAAkB0C,GAAqB;AAClD,QAAAA,EAAK,QAAQ,QAAS;AAE1B,SAAK,MAAM;AAAA,MACT,uCAAuC1C,EAAM,GAAG,cAAc0C,EAAK,GAAG;AAAA,IACxE;AAEA,UAAMC,IAAc,KAAK,oBAAoB3C,EAAM,KAAK0C,EAAK,KAAK;AAAA,MAChE,UAAS,oBAAI,KAAK,GAAE,YAAY;AAAA,IAAA,CACjC;AACD,QAAI,CAACC,EAAa;AAElB,UAAMb,IAAS;AAAA,MACb,GAAG,KAAK,+BAA+B9B,GAAO2C,CAAW;AAAA,MACzD,SAASA,EAAY;AAAA,MACrB,MAAM,KAAK,aAAa;AAAA,MACxB,QAAQ,KAAK,aAAa;AAAA,IAC5B;AAEA,gBAAK,MAAM,KAAK;AAAA,MACd;AAAA,MACAb;AAAA,IACF,GAEOa;AAAA,EAAA;AAAA,EAGT,MAAM,iBACJ3C,GACA0C,GACAE,GACA;AACA,SAAK,MAAM;AAAA,MACT,6CAA6C5C,EAAM,GAAG,cAAc0C,EAAK,GAAG;AAAA,IAC9E;AAEA,UAAMG,KAAK,oBAAI,KAAK,GAAE,YAAY,GAC5BF,IAAc,KAAK,oBAAoB3C,EAAM,KAAK0C,EAAK,KAAK;AAAA,MAChE,SAASG;AAAA,MACT,eAAeA;AAAA,IAAA,CAChB;AACD,QAAI,CAACF,EAAa;AAElB,UAAMb,IAAS;AAAA,MACb,GAAG,KAAK,+BAA+B9B,GAAO2C,CAAW;AAAA,MACzD,UAAAC;AAAA,IACF;AAEA,gBAAK,MAAM,KAAK,gBAGd,cAAcd,CAAM,GAEfa;AAAA,EAAA;AAAA,EAGT,MAAM,eAAe3C,GAAkB0C,GAAqB;AACtD,QAAAA,EAAK,QAAQ,YAAa;AAE9B,SAAK,MAAM;AAAA,MACT,2CAA2C1C,EAAM,GAAG,cAAc0C,EAAK,GAAG;AAAA,IAC5E;AAEA,UAAMC,IAAc,KAAK,oBAAoB3C,EAAM,KAAK0C,EAAK,KAAK;AAAA,MAChE,cAAa,oBAAI,KAAK,GAAE,YAAY;AAAA,IAAA,CACrC;AACD,QAAI,CAACC,EAAa;AAElB,UAAMb,IAAS,KAAK,+BAA+B9B,GAAO2C,CAAW;AAErE,gBAAK,MAAM,KAAK;AAAA,MACd;AAAA,MACA;AAAA,QACE,GAAGb;AAAA,QACH,aAAa9B,EAAM;AAAA,MAAA;AAAA,IAEvB,GAEO2C;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAOD,UAAUG,GAAwB;AAExC,UAAMC,IAAO,MAGPC,IAAa;AAAA,MACjB,GAAGF;AAAA;AAAA,MAEH,UAAU;AACD,eAAA,KAAK,MAAM,KAAK,CAAC5C,MAAM,CAACA,EAAE,QAAQ,WAAW;AAAA,MAAA;AAAA,IAExD;AAEA,WAAA8C,EAAW,UAAUA,EAAW,QAAQ,KAAKA,CAAU,GAE5CA,EAAA,QAAQF,EAAY,MAAM,IAAI,CAAC,EAAE,SAAAG,GAAS,GAAGC,QAAW;AACjE,YAAMC,IAAY;AAAA,QAChB,GAAGD;AAAA,QACH,SAAS,EAAE,GAAGD,EAAQ;AAAA,QACtB,aAAa;AAEP,cAAA,MAAK,QAAQ;AACV,mBAAAF,EAAK,WAAWC,GAAY,IAAI;AAAA,QACzC;AAAA,QACA,iBAAiB,EAAE,UAAAJ,EAAS,IAAgC,IAAI;AAE9D,iBAAOG,EAAK,iBAAiBC,GAAY,MAAMJ,CAAQ;AAAA,QACzD;AAAA,QACA,iBAAiB;AAEX,cAAA,MAAK,QAAQ;AACV,mBAAAG,EAAK,eAAeC,GAAY,IAAI;AAAA,QAAA;AAAA,MAE/C;AAIA,aAAAG,EAAU,aAAaA,EAAU,WAAW,KAAKA,CAAS,GAC1DA,EAAU,mBAAmBA,EAAU,iBAAiB,KAAKA,CAAS,GACtEA,EAAU,iBAAiBA,EAAU,eAAe,KAAKA,CAAS,GAE3DA;AAAA,IAAA,CACR,GAEDH,EAAW,4BACTF,EAAY,0BAA0B,IAAI,CAACzC,OAClC;AAAA,MACL,GAAGA;AAAA,MACH,SAAS,IAAI+C,EAAW,EAAE,UAAU/C,EAAK,SAAU,CAAA;AAAA,IACrD,EACD,GAEI2C;AAAA,EAAA;AAAA,EAGD,iBAAiBK,IAAkC,IAAI;AAE7D,UAAMC,IAAiB,EAAE,GAAG,KAAK,cAAc,GAAGD,EAAa;AAG/D,QAAIvB,IAAS,OAAO;AAAA,MAClB,OAAO,QAAQwB,CAAc,EAAE;AAAA,QAC7B,CAAC,CAACC,GAAIC,CAAC,MAAyBA,KAAM;AAAA,MAAA;AAAA,IAE1C;AAGS,WAAA1B,IAAAA,EAAO,OACZ,EAAE,GAAGA,GAAQ,MAAM,KAAK,UAAUA,EAAO,IAAI,EAC7C,IAAAA,GAEGA;AAAA,EAAA;AAAA,EAGD,eAAeZ,GAA0B;AAG/C,UAAMuC,IAFa,OAAO,KAAKvC,CAAW,EAAE,KAAK,EAG9C;AAAA,MACC,CAACwC,MACC,GAAG,mBAAmBA,CAAG,CAAC,IAAI,mBAAmBxC,EAAYwC,CAAG,CAAC,CAAC;AAAA,IAAA,EAErE,KAAK,GAAG,GAELC,IAAWxE,EAAkB,KAAK,MAAM,MAAM;AACpD,WAAOsE,IAAW,GAAGE,CAAQ,IAAIF,CAAQ,KAAKE;AAAA,EAAA;AAAA,EAGxC,oBACN5D,GACA6D,GACAC,GACA;AACI,QAAAlB;AAIJ,WAAIkB,EAAM,eACR,KAAK,gBAAgB,GAGlB,KAAA,MAAM,SAAS,CAACvE,MAAU;AACvB,YAAAU,IAAQV,EAAM,OAAOS,CAAQ;AAC/B,UAAA,CAACC,EAAc,QAAAV;AAEnB,YAAMwE,IAAQ9D,EAAM,MAAM,IAAI,CAAC0C,OACzBA,EAAK,QAAQkB,MAIjBlB,EAAK,UAAU,EAAE,GAAGA,EAAK,SAAS,GAAGmB,EAAM,GAC7BlB,IAAAD,IAEPA,EACR;AAED,MAAA1C,EAAM,QAAQ8D;AACR,YAAAC,IAAS,EAAE,GAAGzE,EAAM,QAAQ,CAACU,EAAM,GAAG,GAAGA,EAAM,GAI/CyB,IACJoC,EAAM,eAAe,CAAC7D,EAAM,4BACxB;AAAA,QACE,GAAGV,EAAM;AAAA,QACT,CAAC+C,CAAiB,GAAGwB,EAAM;AAAA,UAE7BvE,EAAM;AAEZ,aAAO,EAAE,GAAGA,GAAO,QAAAyE,GAAQ,uBAAAtC,EAAsB;AAAA,IAAA,CAClD,GAEMkB;AAAA,EAAA;AAAA,EAGD,+BACN3C,GACA0C,GACA;AACO,WAAA;AAAA,MACL,YAAYA,EAAK,QAAQ;AAAA,MACzB,YAAY1C,EAAM;AAAA,MAClB,WAAWA,EAAM;AAAA,MACjB,UAAUA,EAAM;AAAA,MAChB,gBAAgB0C,EAAK;AAAA,IACvB;AAAA,EAAA;AAAA,EAGM,kBAAkB,EAAE,MAAApB,KAA6C;AACvE,SAAK,sBAAsB;AAE3B,UAAMtB,IAAQ,KAAK,UAAUsB,EAAK,KAAK;AAElC,SAAA,MAAM,SAAS,CAAChC,MAAU;AACvB,YAAAyE,IAAS,EAAE,GAAGzE,EAAM,QAAQ,CAACU,EAAM,GAAG,GAAGA,EAAM;AAE9C,aAAA,EAAE,GAAGV,GAAO,QAAAyE,EAAO;AAAA,IAAA,CAC3B;AAAA,EAAA;AAAA,EAGK,YAAY,EAAE,MAAAzC,KAA+C;AACnE,SAAK,sBAAsB,GAEtB,KAAA,MAAM,SAAS,CAAChC,MAAU;AACvB,YAAA,EAAE,CAACgC,EAAK,MAAM,GAAG,GAAG0C,GAAG,GAAGd,MAAS5D,EAAM;AAC/C,aAAO,EAAE,GAAGA,GAAO,QAAQ4D,EAAK;AAAA,IAAA,CACjC;AAAA,EAAA;AAAA,EAGK,uBAAuB;AAAA,IAC7B,MAAA5B;AAAA,EAAA,GACgD;AAChD,SAAK,sBAAsB,GAEtB,KAAA,MAAM,SAAS,CAAChC,MAAU;AAGvB,YAAA2E,IAAc,CAAC3C,EAAK,WAAW,GAI/B4C,IAAc5C,EAAK,YAAY,gCAAgC,CAAC,GAChE6C,IAAY7C,EAAK,YAAY,8BAA8B,CAAC;AAElE,UAAIyC,IAASzE,EAAM;AAEnB,aAAAyE,IAASG,EAAY,OAAO,CAAC9D,GAAKsD,MAAQ;AACxC,YAAI,CAACtD,EAAIsD,CAAG,EAAU,QAAAtD;AACtB,cAAMJ,IAAQ,EAAE,GAAGI,EAAIsD,CAAG,GAAG,2BAA2B,GAAK;AAC7D,eAAO,EAAE,GAAGtD,GAAK,CAACsD,CAAG,GAAG1D,EAAM;AAAA,SAC7B+D,CAAM,GAETA,IAASI,EAAU,OAAO,CAAC/D,GAAKsD,MAAQ;AACtC,YAAI,CAACtD,EAAIsD,CAAG,EAAU,QAAAtD;AACtB,cAAMJ,IAAQ,EAAE,GAAGI,EAAIsD,CAAG,GAAG,2BAA2B,GAAM;AAC9D,eAAO,EAAE,GAAGtD,GAAK,CAACsD,CAAG,GAAG1D,EAAM;AAAA,SAC7B+D,CAAM,GAEF,EAAE,GAAGzE,GAAO,QAAAyE,GAAQ,aAAAE,EAAY;AAAA,IAAA,CACxC;AAAA,EAAA;AAAA,EAYK,qCAAqC;AAC3C,QAAI,yBAAQ,SAAS;AAEZ,aAAA,iBAAiB,YAAY,KAAK,oBAAoB,GAGtD,OAAA,iBAAiB,cAAc,KAAK,oBAAoB;AAGzD,YAAAG,IAAc,OAAO,QAAQ,WAC7BC,IAAiB,OAAO,QAAQ;AAGtC,aAAO,QAAQ,YAAY,IAAI,MAAMD,GAAa;AAAA,QAChD,OAAO,CAACE,GAAQC,GAASC,MAAS;AACxB,kBAAA,MAAMF,GAAQC,GAASC,CAAI,GACnC,WAAW,MAAM;AACf,iBAAK,qBAAqB;AAAA,aACzB,CAAC;AAAA,QAAA;AAAA,MACN,CACD,GACD,OAAO,QAAQ,eAAe,IAAI,MAAMH,GAAgB;AAAA,QACtD,OAAO,CAACC,GAAQC,GAASC,MAAS;AACxB,kBAAA,MAAMF,GAAQC,GAASC,CAAI,GACnC,WAAW,MAAM;AACf,iBAAK,qBAAqB;AAAA,aACzB,CAAC;AAAA,QAAA;AAAA,MACN,CACD,GAGD,KAAK,cAAcJ,GACnB,KAAK,iBAAiBC;AAAA,IAAA;AAEtB,WAAK,MAAM;AAAA,QACT;AAAA,MACF;AAAA,EACF;AAAA,EAGM,uBAAuB;AACtB,WAAA,oBAAoB,YAAY,KAAK,oBAAoB,GACzD,OAAA,oBAAoB,cAAc,KAAK,oBAAoB,GAE9D,KAAK,gBACA,OAAA,QAAQ,YAAY,KAAK,aAChC,KAAK,cAAc,SAEjB,KAAK,mBACA,OAAA,QAAQ,eAAe,KAAK,gBACnC,KAAK,iBAAiB;AAAA,EACxB;AAEJ;"}
@@ -0,0 +1,43 @@
1
+ var a = Object.defineProperty;
2
+ var i = (t, e, n) => e in t ? a(t, e, { enumerable: !0, configurable: !0, writable: !0, value: n }) : t[e] = n;
3
+ var r = (t, e, n) => i(t, typeof e != "symbol" ? e + "" : e, n);
4
+ class y extends Map {
5
+ constructor() {
6
+ super();
7
+ r(this, "metadata");
8
+ }
9
+ }
10
+ const p = (t = {}) => [
11
+ t.key && `key=${t.key}`,
12
+ t.type && `type=${t.type}`
13
+ ].filter((e) => e).join(", "), _ = (t) => t.reduce((e, n) => ({ ...e, [n.key]: n }), {}), c = (t) => [...t].sort(
14
+ (e, n) => new Date(e.inserted_at).getTime() - new Date(n.inserted_at).getTime()
15
+ ), d = "default", o = "$default", m = (t = []) => {
16
+ const e = /* @__PURE__ */ new Date();
17
+ return {
18
+ __typename: "GuideGroup",
19
+ key: o,
20
+ display_sequence: c(t).map((n) => n.key),
21
+ display_interval: null,
22
+ inserted_at: e.toISOString(),
23
+ updated_at: e.toISOString()
24
+ };
25
+ }, k = (t) => t.find(
26
+ (e) => e.key === d || e.key === o
27
+ ), D = (t, e) => {
28
+ const n = new Date(t);
29
+ if (isNaN(n.getTime()))
30
+ return !1;
31
+ const s = n.getTime() + e * 1e3;
32
+ return (/* @__PURE__ */ new Date()).getTime() <= s;
33
+ };
34
+ export {
35
+ d as DEFAULT_GROUP_KEY,
36
+ y as SelectionResult,
37
+ _ as byKey,
38
+ D as checkIfThrottled,
39
+ k as findDefaultGroup,
40
+ p as formatFilters,
41
+ m as mockDefaultGroup
42
+ };
43
+ //# sourceMappingURL=helpers.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helpers.mjs","sources":["../../../../src/clients/guide/helpers.ts"],"sourcesContent":["import {\n GuideData,\n GuideGroupData,\n KnockGuide,\n SelectFilterParams,\n} from \"./types\";\n\n// Extends the map class to allow having metadata on it, which is used to record\n// the guide group context for the selection result (though currently only a\n// default global group is supported).\nexport class SelectionResult<K = number, V = KnockGuide> extends Map<K, V> {\n metadata: { guideGroup: GuideGroupData } | undefined;\n\n constructor() {\n super();\n }\n}\n\nexport const formatFilters = (filters: SelectFilterParams = {}) => {\n return [\n filters.key && `key=${filters.key}`,\n filters.type && `type=${filters.type}`,\n ]\n .filter((x) => x)\n .join(\", \");\n};\n\nexport const byKey = <T extends { key: string }>(items: T[]) => {\n return items.reduce((acc, item) => ({ ...acc, [item.key]: item }), {});\n};\n\nconst sortGuides = <T extends GuideData>(guides: T[]) => {\n return [...guides].sort(\n (a, b) =>\n new Date(a.inserted_at).getTime() - new Date(b.inserted_at).getTime(),\n );\n};\n\n// Default global guide group key.\nexport const DEFAULT_GROUP_KEY = \"default\";\n\n// Prefixed with a special char $ to distinguish from an actual default group.\nconst MOCK_DEFAULT_GROUP_KEY = \"$default\";\n\n// Build a notional default group to fall back on in case there is none, only\n// for safety as there should always be a default guide group created.\nexport const mockDefaultGroup = (entries: GuideData[] = []) => {\n const now = new Date();\n\n return {\n __typename: \"GuideGroup\",\n key: MOCK_DEFAULT_GROUP_KEY,\n display_sequence: sortGuides(entries).map((g) => g.key),\n display_interval: null,\n inserted_at: now.toISOString(),\n updated_at: now.toISOString(),\n } as GuideGroupData;\n};\n\nexport const findDefaultGroup = (guideGroups: GuideGroupData[]) =>\n guideGroups.find(\n (group) =>\n group.key === DEFAULT_GROUP_KEY || group.key === MOCK_DEFAULT_GROUP_KEY,\n );\n\n// Checks whether we are currently throttled (inside a \"throttle window\").\n// A throttle window opens when a user dismisses (archives) a guide, and lasts\n// for the configured display interval of the guide group used (currently only\n// the default global group).\nexport const checkIfThrottled = (\n throttleWindowStartedAtTs: string,\n windowDurationInSeconds: number,\n) => {\n // 1. Parse the given timestamp string into a Date object.\n // Date.parse() handles ISO 8601 strings correctly and returns milliseconds\n // since epoch. This inherently handles timezones by converting everything to\n // a universal time representation (UTC).\n const throttleWindowStartDate = new Date(throttleWindowStartedAtTs);\n\n // Check if the given throttle window start timestamp string was valid, and\n // if not disregard.\n if (isNaN(throttleWindowStartDate.getTime())) {\n return false;\n }\n\n // 2. Calculate the throttle window end time in milliseconds by adding the\n // duration to the throttle window start time.\n const throttleWindowEndInMilliseconds =\n throttleWindowStartDate.getTime() + windowDurationInSeconds * 1000;\n\n // 3. Get the current timestamp in milliseconds since epoch.\n const currentTimeInMilliseconds = new Date().getTime();\n\n // 4. Compare the current timestamp with the calculated future timestamp.\n // Both are in milliseconds since epoch (UTC), so direct comparison is\n // accurate regardless of local timezones.\n return currentTimeInMilliseconds <= throttleWindowEndInMilliseconds;\n};\n"],"names":["SelectionResult","__publicField","formatFilters","filters","x","byKey","items","acc","item","sortGuides","guides","a","b","DEFAULT_GROUP_KEY","MOCK_DEFAULT_GROUP_KEY","mockDefaultGroup","entries","now","g","findDefaultGroup","guideGroups","group","checkIfThrottled","throttleWindowStartedAtTs","windowDurationInSeconds","throttleWindowStartDate","throttleWindowEndInMilliseconds"],"mappings":";;;AAUO,MAAMA,UAAoD,IAAU;AAAA,EAGzE,cAAc;AACN,UAAA;AAHR,IAAAC,EAAA;AAAA,EAGQ;AAEV;AAEO,MAAMC,IAAgB,CAACC,IAA8B,OACnD;AAAA,EACLA,EAAQ,OAAO,OAAOA,EAAQ,GAAG;AAAA,EACjCA,EAAQ,QAAQ,QAAQA,EAAQ,IAAI;AAAA,EAEnC,OAAO,CAACC,MAAMA,CAAC,EACf,KAAK,IAAI,GAGDC,IAAQ,CAA4BC,MACxCA,EAAM,OAAO,CAACC,GAAKC,OAAU,EAAE,GAAGD,GAAK,CAACC,EAAK,GAAG,GAAGA,EAAK,IAAI,CAAA,CAAE,GAGjEC,IAAa,CAAsBC,MAChC,CAAC,GAAGA,CAAM,EAAE;AAAA,EACjB,CAACC,GAAGC,MACF,IAAI,KAAKD,EAAE,WAAW,EAAE,QAAA,IAAY,IAAI,KAAKC,EAAE,WAAW,EAAE,QAAQ;AACxE,GAIWC,IAAoB,WAG3BC,IAAyB,YAIlBC,IAAmB,CAACC,IAAuB,OAAO;AACvD,QAAAC,wBAAU,KAAK;AAEd,SAAA;AAAA,IACL,YAAY;AAAA,IACZ,KAAKH;AAAA,IACL,kBAAkBL,EAAWO,CAAO,EAAE,IAAI,CAACE,MAAMA,EAAE,GAAG;AAAA,IACtD,kBAAkB;AAAA,IAClB,aAAaD,EAAI,YAAY;AAAA,IAC7B,YAAYA,EAAI,YAAY;AAAA,EAC9B;AACF,GAEaE,IAAmB,CAACC,MAC/BA,EAAY;AAAA,EACV,CAACC,MACCA,EAAM,QAAQR,KAAqBQ,EAAM,QAAQP;AACrD,GAMWQ,IAAmB,CAC9BC,GACAC,MACG;AAKG,QAAAC,IAA0B,IAAI,KAAKF,CAAyB;AAIlE,MAAI,MAAME,EAAwB,QAAQ,CAAC;AAClC,WAAA;AAKT,QAAMC,IACJD,EAAwB,QAAQ,IAAID,IAA0B;AAQhE,UALkC,oBAAI,KAAK,GAAE,QAAQ,KAKjBE;AACtC;"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","sources":["../../../../src/clients/users/index.ts"],"sourcesContent":["import { GenericData } from \"@knocklabs/types\";\n\nimport { ApiResponse } from \"../../api\";\nimport { ChannelData, User } from \"../../interfaces\";\nimport Knock from \"../../knock\";\nimport {\n GuideEngagementEventBaseParams,\n guidesApiRootPath,\n} from \"../guide/client\";\nimport {\n GetPreferencesOptions,\n PreferenceOptions,\n PreferenceSet,\n SetPreferencesProperties,\n} from \"../preferences/interfaces\";\n\nimport { GetChannelDataInput, SetChannelDataInput } from \"./interfaces\";\n\nconst DEFAULT_PREFERENCE_SET_ID = \"default\";\n\nclass UserClient {\n private instance: Knock;\n\n constructor(instance: Knock) {\n this.instance = instance;\n }\n\n async get() {\n this.instance.failIfNotAuthenticated();\n\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.instance.userId}`,\n });\n\n return this.handleResponse<User>(result);\n }\n\n async identify(props: GenericData = {}) {\n this.instance.failIfNotAuthenticated();\n\n const result = await this.instance.client().makeRequest({\n method: \"PUT\",\n url: `/v1/users/${this.instance.userId}`,\n params: props,\n });\n\n return this.handleResponse<User>(result);\n }\n\n async getAllPreferences() {\n this.instance.failIfNotAuthenticated();\n\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.instance.userId}/preferences`,\n });\n\n return this.handleResponse<PreferenceSet[]>(result);\n }\n\n async getPreferences(\n options: GetPreferencesOptions = {},\n ): Promise<PreferenceSet> {\n this.instance.failIfNotAuthenticated();\n const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n params: { tenant: options.tenant },\n });\n\n return this.handleResponse<PreferenceSet>(result);\n }\n\n async setPreferences(\n preferenceSet: SetPreferencesProperties,\n options: PreferenceOptions = {},\n ): Promise<PreferenceSet> {\n this.instance.failIfNotAuthenticated();\n const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n const result = await this.instance.client().makeRequest({\n method: \"PUT\",\n url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n data: preferenceSet,\n });\n\n return this.handleResponse<PreferenceSet>(result);\n }\n\n async getChannelData<T = GenericData>(params: GetChannelDataInput) {\n this.instance.failIfNotAuthenticated();\n\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.instance.userId}/channel_data/${params.channelId}`,\n });\n\n return this.handleResponse<ChannelData<T>>(result);\n }\n\n async setChannelData<T = GenericData>({\n channelId,\n channelData,\n }: SetChannelDataInput) {\n this.instance.failIfNotAuthenticated();\n\n const result = await this.instance.client().makeRequest({\n method: \"PUT\",\n url: `/v1/users/${this.instance.userId}/channel_data/${channelId}`,\n data: { data: channelData },\n });\n\n return this.handleResponse<ChannelData<T>>(result);\n }\n\n async getGuides<P, R>(channelId: string, params: P) {\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `${guidesApiRootPath(this.instance.userId)}/${channelId}`,\n params,\n });\n\n return this.handleResponse<R>(result);\n }\n\n async markGuideStepAs<P extends GuideEngagementEventBaseParams, R>(\n status: \"seen\" | \"interacted\" | \"archived\",\n params: P,\n ) {\n const result = await this.instance.client().makeRequest({\n method: \"PUT\",\n url: `${guidesApiRootPath(this.instance.userId)}/messages/${params.message_id}/${status}`,\n data: params,\n });\n\n return this.handleResponse<R>(result);\n }\n\n private handleResponse<T>(response: ApiResponse) {\n if (response.statusCode === \"error\") {\n throw new Error(response.error || response.body);\n }\n\n return response.body as T;\n }\n}\n\nexport default UserClient;\n"],"names":["DEFAULT_PREFERENCE_SET_ID","UserClient","instance","__publicField","result","props","options","preferenceSetId","preferenceSet","params","channelId","channelData","guidesApiRootPath","status","response"],"mappings":";;;;AAkBA,MAAMA,IAA4B;AAElC,MAAMC,EAAW;AAAA,EAGf,YAAYC,GAAiB;AAFrB,IAAAC,EAAA;AAGN,SAAK,WAAWD;AAAA,EAAA;AAAA,EAGlB,MAAM,MAAM;AACV,SAAK,SAAS,uBAAuB;AAErC,UAAME,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,IAAA,CACvC;AAEM,WAAA,KAAK,eAAqBA,CAAM;AAAA,EAAA;AAAA,EAGzC,MAAM,SAASC,IAAqB,IAAI;AACtC,SAAK,SAAS,uBAAuB;AAErC,UAAMD,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,MACtC,QAAQC;AAAA,IAAA,CACT;AAEM,WAAA,KAAK,eAAqBD,CAAM;AAAA,EAAA;AAAA,EAGzC,MAAM,oBAAoB;AACxB,SAAK,SAAS,uBAAuB;AAErC,UAAMA,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,IAAA,CACvC;AAEM,WAAA,KAAK,eAAgCA,CAAM;AAAA,EAAA;AAAA,EAGpD,MAAM,eACJE,IAAiC,IACT;AACxB,SAAK,SAAS,uBAAuB;AAC/B,UAAAC,IAAkBD,EAAQ,iBAAiBN,GAE3CI,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe;AAAA,MACrE,QAAQ,EAAE,QAAQD,EAAQ,OAAO;AAAA,IAAA,CAClC;AAEM,WAAA,KAAK,eAA8BF,CAAM;AAAA,EAAA;AAAA,EAGlD,MAAM,eACJI,GACAF,IAA6B,IACL;AACxB,SAAK,SAAS,uBAAuB;AAC/B,UAAAC,IAAkBD,EAAQ,iBAAiBN,GAE3CI,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe;AAAA,MACrE,MAAMC;AAAA,IAAA,CACP;AAEM,WAAA,KAAK,eAA8BJ,CAAM;AAAA,EAAA;AAAA,EAGlD,MAAM,eAAgCK,GAA6B;AACjE,SAAK,SAAS,uBAAuB;AAErC,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBK,EAAO,SAAS;AAAA,IAAA,CACxE;AAEM,WAAA,KAAK,eAA+BL,CAAM;AAAA,EAAA;AAAA,EAGnD,MAAM,eAAgC;AAAA,IACpC,WAAAM;AAAA,IACA,aAAAC;AAAA,EAAA,GACsB;AACtB,SAAK,SAAS,uBAAuB;AAErC,UAAMP,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBM,CAAS;AAAA,MAChE,MAAM,EAAE,MAAMC,EAAY;AAAA,IAAA,CAC3B;AAEM,WAAA,KAAK,eAA+BP,CAAM;AAAA,EAAA;AAAA,EAGnD,MAAM,UAAgBM,GAAmBD,GAAW;AAClD,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,GAAGQ,EAAkB,KAAK,SAAS,MAAM,CAAC,IAAIF,CAAS;AAAA,MAC5D,QAAAD;AAAA,IAAA,CACD;AAEM,WAAA,KAAK,eAAkBL,CAAM;AAAA,EAAA;AAAA,EAGtC,MAAM,gBACJS,GACAJ,GACA;AACA,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,GAAGQ,EAAkB,KAAK,SAAS,MAAM,CAAC,aAAaH,EAAO,UAAU,IAAII,CAAM;AAAA,MACvF,MAAMJ;AAAA,IAAA,CACP;AAEM,WAAA,KAAK,eAAkBL,CAAM;AAAA,EAAA;AAAA,EAG9B,eAAkBU,GAAuB;AAC3C,QAAAA,EAAS,eAAe;AAC1B,YAAM,IAAI,MAAMA,EAAS,SAASA,EAAS,IAAI;AAGjD,WAAOA,EAAS;AAAA,EAAA;AAEpB;"}
1
+ {"version":3,"file":"index.mjs","sources":["../../../../src/clients/users/index.ts"],"sourcesContent":["import { GenericData } from \"@knocklabs/types\";\n\nimport { ApiResponse } from \"../../api\";\nimport { ChannelData, User } from \"../../interfaces\";\nimport Knock from \"../../knock\";\nimport { guidesApiRootPath } from \"../guide/client\";\nimport { GuideEngagementEventBaseParams } from \"../guide/types\";\nimport {\n GetPreferencesOptions,\n PreferenceOptions,\n PreferenceSet,\n SetPreferencesProperties,\n} from \"../preferences/interfaces\";\n\nimport { GetChannelDataInput, SetChannelDataInput } from \"./interfaces\";\n\nconst DEFAULT_PREFERENCE_SET_ID = \"default\";\n\nclass UserClient {\n private instance: Knock;\n\n constructor(instance: Knock) {\n this.instance = instance;\n }\n\n async get() {\n this.instance.failIfNotAuthenticated();\n\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.instance.userId}`,\n });\n\n return this.handleResponse<User>(result);\n }\n\n async identify(props: GenericData = {}) {\n this.instance.failIfNotAuthenticated();\n\n const result = await this.instance.client().makeRequest({\n method: \"PUT\",\n url: `/v1/users/${this.instance.userId}`,\n params: props,\n });\n\n return this.handleResponse<User>(result);\n }\n\n async getAllPreferences() {\n this.instance.failIfNotAuthenticated();\n\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.instance.userId}/preferences`,\n });\n\n return this.handleResponse<PreferenceSet[]>(result);\n }\n\n async getPreferences(\n options: GetPreferencesOptions = {},\n ): Promise<PreferenceSet> {\n this.instance.failIfNotAuthenticated();\n const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n params: { tenant: options.tenant },\n });\n\n return this.handleResponse<PreferenceSet>(result);\n }\n\n async setPreferences(\n preferenceSet: SetPreferencesProperties,\n options: PreferenceOptions = {},\n ): Promise<PreferenceSet> {\n this.instance.failIfNotAuthenticated();\n const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n const result = await this.instance.client().makeRequest({\n method: \"PUT\",\n url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n data: preferenceSet,\n });\n\n return this.handleResponse<PreferenceSet>(result);\n }\n\n async getChannelData<T = GenericData>(params: GetChannelDataInput) {\n this.instance.failIfNotAuthenticated();\n\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `/v1/users/${this.instance.userId}/channel_data/${params.channelId}`,\n });\n\n return this.handleResponse<ChannelData<T>>(result);\n }\n\n async setChannelData<T = GenericData>({\n channelId,\n channelData,\n }: SetChannelDataInput) {\n this.instance.failIfNotAuthenticated();\n\n const result = await this.instance.client().makeRequest({\n method: \"PUT\",\n url: `/v1/users/${this.instance.userId}/channel_data/${channelId}`,\n data: { data: channelData },\n });\n\n return this.handleResponse<ChannelData<T>>(result);\n }\n\n async getGuides<P, R>(channelId: string, params: P) {\n const result = await this.instance.client().makeRequest({\n method: \"GET\",\n url: `${guidesApiRootPath(this.instance.userId)}/${channelId}`,\n params,\n });\n\n return this.handleResponse<R>(result);\n }\n\n async markGuideStepAs<P extends GuideEngagementEventBaseParams, R>(\n status: \"seen\" | \"interacted\" | \"archived\",\n params: P,\n ) {\n const result = await this.instance.client().makeRequest({\n method: \"PUT\",\n url: `${guidesApiRootPath(this.instance.userId)}/messages/${params.message_id}/${status}`,\n data: params,\n });\n\n return this.handleResponse<R>(result);\n }\n\n private handleResponse<T>(response: ApiResponse) {\n if (response.statusCode === \"error\") {\n throw new Error(response.error || response.body);\n }\n\n return response.body as T;\n }\n}\n\nexport default UserClient;\n"],"names":["DEFAULT_PREFERENCE_SET_ID","UserClient","instance","__publicField","result","props","options","preferenceSetId","preferenceSet","params","channelId","channelData","guidesApiRootPath","status","response"],"mappings":";;;;AAgBA,MAAMA,IAA4B;AAElC,MAAMC,EAAW;AAAA,EAGf,YAAYC,GAAiB;AAFrB,IAAAC,EAAA;AAGN,SAAK,WAAWD;AAAA,EAAA;AAAA,EAGlB,MAAM,MAAM;AACV,SAAK,SAAS,uBAAuB;AAErC,UAAME,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,IAAA,CACvC;AAEM,WAAA,KAAK,eAAqBA,CAAM;AAAA,EAAA;AAAA,EAGzC,MAAM,SAASC,IAAqB,IAAI;AACtC,SAAK,SAAS,uBAAuB;AAErC,UAAMD,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,MACtC,QAAQC;AAAA,IAAA,CACT;AAEM,WAAA,KAAK,eAAqBD,CAAM;AAAA,EAAA;AAAA,EAGzC,MAAM,oBAAoB;AACxB,SAAK,SAAS,uBAAuB;AAErC,UAAMA,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,IAAA,CACvC;AAEM,WAAA,KAAK,eAAgCA,CAAM;AAAA,EAAA;AAAA,EAGpD,MAAM,eACJE,IAAiC,IACT;AACxB,SAAK,SAAS,uBAAuB;AAC/B,UAAAC,IAAkBD,EAAQ,iBAAiBN,GAE3CI,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe;AAAA,MACrE,QAAQ,EAAE,QAAQD,EAAQ,OAAO;AAAA,IAAA,CAClC;AAEM,WAAA,KAAK,eAA8BF,CAAM;AAAA,EAAA;AAAA,EAGlD,MAAM,eACJI,GACAF,IAA6B,IACL;AACxB,SAAK,SAAS,uBAAuB;AAC/B,UAAAC,IAAkBD,EAAQ,iBAAiBN,GAE3CI,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe;AAAA,MACrE,MAAMC;AAAA,IAAA,CACP;AAEM,WAAA,KAAK,eAA8BJ,CAAM;AAAA,EAAA;AAAA,EAGlD,MAAM,eAAgCK,GAA6B;AACjE,SAAK,SAAS,uBAAuB;AAErC,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBK,EAAO,SAAS;AAAA,IAAA,CACxE;AAEM,WAAA,KAAK,eAA+BL,CAAM;AAAA,EAAA;AAAA,EAGnD,MAAM,eAAgC;AAAA,IACpC,WAAAM;AAAA,IACA,aAAAC;AAAA,EAAA,GACsB;AACtB,SAAK,SAAS,uBAAuB;AAErC,UAAMP,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBM,CAAS;AAAA,MAChE,MAAM,EAAE,MAAMC,EAAY;AAAA,IAAA,CAC3B;AAEM,WAAA,KAAK,eAA+BP,CAAM;AAAA,EAAA;AAAA,EAGnD,MAAM,UAAgBM,GAAmBD,GAAW;AAClD,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,GAAGQ,EAAkB,KAAK,SAAS,MAAM,CAAC,IAAIF,CAAS;AAAA,MAC5D,QAAAD;AAAA,IAAA,CACD;AAEM,WAAA,KAAK,eAAkBL,CAAM;AAAA,EAAA;AAAA,EAGtC,MAAM,gBACJS,GACAJ,GACA;AACA,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,GAAGQ,EAAkB,KAAK,SAAS,MAAM,CAAC,aAAaH,EAAO,UAAU,IAAII,CAAM;AAAA,MACvF,MAAMJ;AAAA,IAAA,CACP;AAEM,WAAA,KAAK,eAAkBL,CAAM;AAAA,EAAA;AAAA,EAG9B,eAAkBU,GAAuB;AAC3C,QAAAA,EAAS,eAAe;AAC1B,YAAM,IAAI,MAAMA,EAAS,SAASA,EAAS,IAAI;AAGjD,WAAOA,EAAS;AAAA,EAAA;AAEpB;"}
@@ -20,6 +20,7 @@ declare class ApiClient {
20
20
  constructor(options: ApiClientOptions);
21
21
  makeRequest(req: AxiosRequestConfig): Promise<ApiResponse>;
22
22
  private canRetryRequest;
23
+ private getUserAgent;
23
24
  }
24
25
  export default ApiClient;
25
26
  //# sourceMappingURL=api.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA,OAAc,EAA6B,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE7E,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,WAAW;IAE1B,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,UAAU,EAAE,IAAI,GAAG,OAAO,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,cAAM,SAAS;IACb,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,WAAW,CAAgB;IAE5B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEtB,OAAO,EAAE,gBAAgB;IAgC/B,WAAW,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAwBhE,OAAO,CAAC,eAAe;CAuBxB;AAED,eAAe,SAAS,CAAC"}
1
+ {"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA,OAAc,EAA6B,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE7E,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,WAAW;IAE1B,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,UAAU,EAAE,IAAI,GAAG,OAAO,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,cAAM,SAAS;IACb,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,WAAW,CAAgB;IAE5B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEtB,OAAO,EAAE,gBAAgB;IAiC/B,WAAW,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAwBhE,OAAO,CAAC,eAAe;IAwBvB,OAAO,CAAC,YAAY;CAQrB;AAED,eAAe,SAAS,CAAC"}
@@ -1,89 +1,8 @@
1
1
  import { GenericData } from '@knocklabs/types';
2
2
  import { Store } from '@tanstack/store';
3
- import { URLPattern } from 'urlpattern-polyfill';
4
3
  import { default as Knock } from '../../knock';
4
+ import { ConstructorOpts, GuideData, GuideStepData, KnockGuide, KnockGuideStep, QueryFilterParams, QueryStatus, SelectFilterParams, StoreState, TargetParams } from './types';
5
5
  export declare const guidesApiRootPath: (userId: string | undefined | null) => string;
6
- interface StepMessageState {
7
- id: string;
8
- seen_at: string | null;
9
- read_at: string | null;
10
- interacted_at: string | null;
11
- archived_at: string | null;
12
- link_clicked_at: string | null;
13
- }
14
- interface GuideStepData {
15
- ref: string;
16
- schema_key: string;
17
- schema_semver: string;
18
- schema_variant_key: string;
19
- message: StepMessageState;
20
- content: any;
21
- }
22
- interface GuideActivationLocationRuleData {
23
- directive: "allow" | "block";
24
- pathname: string;
25
- }
26
- interface GuideData {
27
- __typename: "Guide";
28
- channel_id: string;
29
- id: string;
30
- key: string;
31
- priority: number;
32
- type: string;
33
- semver: string;
34
- steps: GuideStepData[];
35
- activation_location_rules: GuideActivationLocationRuleData[];
36
- inserted_at: string;
37
- updated_at: string;
38
- }
39
- export interface KnockGuideStep extends GuideStepData {
40
- markAsSeen: () => void;
41
- markAsInteracted: (params?: {
42
- metadata?: GenericData;
43
- }) => void;
44
- markAsArchived: () => void;
45
- }
46
- interface KnockGuideActivationLocationRule extends GuideActivationLocationRuleData {
47
- pattern: URLPattern;
48
- }
49
- export interface KnockGuide extends GuideData {
50
- steps: KnockGuideStep[];
51
- activation_location_rules: KnockGuideActivationLocationRule[];
52
- }
53
- type GetGuidesQueryParams = {
54
- data?: string;
55
- tenant?: string;
56
- type?: string;
57
- };
58
- export type GuideEngagementEventBaseParams = {
59
- message_id: string;
60
- channel_id: string;
61
- guide_key: string;
62
- guide_id: string;
63
- guide_step_ref: string;
64
- };
65
- type QueryKey = string;
66
- type QueryStatus = {
67
- status: "loading" | "ok" | "error";
68
- error?: Error;
69
- };
70
- type StoreState = {
71
- guides: KnockGuide[];
72
- queries: Record<QueryKey, QueryStatus>;
73
- location: string | undefined;
74
- };
75
- type QueryFilterParams = Pick<GetGuidesQueryParams, "type">;
76
- export type SelectFilterParams = {
77
- key?: string;
78
- type?: string;
79
- };
80
- export type TargetParams = {
81
- data?: GenericData | undefined;
82
- tenant?: string | undefined;
83
- };
84
- type ConstructorOpts = {
85
- trackLocationFromWindow?: boolean;
86
- };
87
6
  export declare class KnockGuideClient {
88
7
  readonly knock: Knock;
89
8
  readonly channelId: string;
@@ -96,7 +15,12 @@ export declare class KnockGuideClient {
96
15
  private socketEventTypes;
97
16
  private pushStateFn;
98
17
  private replaceStateFn;
18
+ private stage;
19
+ private counterIntervalId;
99
20
  constructor(knock: Knock, channelId: string, targetParams?: TargetParams, options?: ConstructorOpts);
21
+ private incrementCounter;
22
+ private startCounterInterval;
23
+ private clearCounterInterval;
100
24
  cleanup(): void;
101
25
  fetch(opts?: {
102
26
  filters?: QueryFilterParams;
@@ -104,7 +28,15 @@ export declare class KnockGuideClient {
104
28
  subscribe(): void;
105
29
  unsubscribe(): void;
106
30
  private handleSocketEvent;
107
- select(state: StoreState, filters?: SelectFilterParams): KnockGuide[];
31
+ setLocation(href: string): void;
32
+ selectGuides(state: StoreState, filters?: SelectFilterParams): KnockGuide[];
33
+ selectGuide(state: StoreState, filters?: SelectFilterParams): KnockGuide | undefined;
34
+ private openGroupStage;
35
+ private closePendingGroupStage;
36
+ private patchClosedGroupStage;
37
+ private clearGroupStage;
38
+ private ensureClearTimeout;
39
+ private _selectGuide;
108
40
  markAsSeen(guide: GuideData, step: GuideStepData): Promise<KnockGuideStep | undefined>;
109
41
  markAsInteracted(guide: GuideData, step: GuideStepData, metadata?: GenericData): Promise<KnockGuideStep | undefined>;
110
42
  markAsArchived(guide: GuideData, step: GuideStepData): Promise<KnockGuideStep | undefined>;
@@ -113,12 +45,11 @@ export declare class KnockGuideClient {
113
45
  private formatQueryKey;
114
46
  private setStepMessageAttrs;
115
47
  private buildEngagementEventBaseParams;
116
- private addGuide;
117
- private replaceOrAddGuide;
48
+ private addOrReplaceGuide;
118
49
  private removeGuide;
50
+ private addOrReplaceGuideGroup;
119
51
  private handleLocationChange;
120
52
  private listenForLocationChangesFromWindow;
121
53
  private removeEventListeners;
122
54
  }
123
- export {};
124
55
  //# sourceMappingURL=client.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,KAAK,MAAM,aAAa,CAAC;AAchC,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,GAAG,SAAS,GAAG,IAAI,WACrC,CAAC;AAE/B,UAAU,gBAAgB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,UAAU,aAAa;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,gBAAgB,CAAC;IAE1B,OAAO,EAAE,GAAG,CAAC;CACd;AAED,UAAU,+BAA+B;IACvC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,SAAS;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,yBAAyB,EAAE,+BAA+B,EAAE,CAAC;IAC7D,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,WAAW,CAAA;KAAE,KAAK,IAAI,CAAC;IAChE,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED,UAAU,gCACR,SAAQ,+BAA+B;IACvC,OAAO,EAAE,UAAU,CAAC;CACrB;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,yBAAyB,EAAE,gCAAgC,EAAE,CAAC;CAC/D;AAED,KAAK,oBAAoB,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAMF,MAAM,MAAM,8BAA8B,GAAG;IAE3C,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AA6CF,KAAK,QAAQ,GAAG,MAAM,CAAC;AAEvB,KAAK,WAAW,GAAG;IACjB,MAAM,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC;IACnC,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,KAAK,UAAU,GAAG;IAChB,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,KAAK,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AAE5D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,qBAAa,gBAAgB;IAczB,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,SAAS,EAAE,MAAM;IAC1B,QAAQ,CAAC,YAAY,EAAE,YAAY;IACnC,QAAQ,CAAC,OAAO,EAAE,eAAe;IAhB5B,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,UAAU,CAAC,CAAC;IAGnE,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,gBAAgB,CAAqD;IAG7E,OAAO,CAAC,WAAW,CAAmC;IACtD,OAAO,CAAC,cAAc,CAAsC;gBAGjD,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,MAAM,EACjB,YAAY,GAAE,YAAiB,EAC/B,OAAO,GAAE,eAAoB;IA0BxC,OAAO;IAKD,KAAK,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,iBAAiB,CAAA;KAAE;IA+ClD,SAAS;IA+BT,WAAW;IAcX,OAAO,CAAC,iBAAiB;IAwBzB,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,GAAE,kBAAuB;IAyDpD,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IAyBhD,gBAAgB,CACpB,KAAK,EAAE,SAAS,EAChB,IAAI,EAAE,aAAa,EACnB,QAAQ,CAAC,EAAE,WAAW;IA0BlB,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IAwB1D,OAAO,CAAC,SAAS;IA+CjB,OAAO,CAAC,gBAAgB;IAmBxB,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,mBAAmB;IA6B3B,OAAO,CAAC,8BAA8B;IAatC,OAAO,CAAC,QAAQ;IAQhB,OAAO,CAAC,iBAAiB;IAmBzB,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,oBAAoB,CAO1B;IAEF,OAAO,CAAC,kCAAkC;IAwC1C,OAAO,CAAC,oBAAoB;CAa7B"}
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAIxC,OAAO,KAAK,MAAM,aAAa,CAAC;AAWhC,OAAO,EACL,eAAe,EAKf,SAAS,EAKT,aAAa,EAEb,UAAU,EACV,cAAc,EAKd,iBAAiB,EACjB,WAAW,EACX,kBAAkB,EAElB,UAAU,EACV,YAAY,EACb,MAAM,SAAS,CAAC;AAUjB,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,GAAG,SAAS,GAAG,IAAI,WACrC,CAAC;AAmF/B,qBAAa,gBAAgB;IA2BzB,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,SAAS,EAAE,MAAM;IAC1B,QAAQ,CAAC,YAAY,EAAE,YAAY;IACnC,QAAQ,CAAC,OAAO,EAAE,eAAe;IA7B5B,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,UAAU,CAAC,CAAC;IAGnE,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,gBAAgB,CAMtB;IAGF,OAAO,CAAC,WAAW,CAAmC;IACtD,OAAO,CAAC,cAAc,CAAsC;IAK5D,OAAO,CAAC,KAAK,CAAyB;IAEtC,OAAO,CAAC,iBAAiB,CAA6C;gBAG3D,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,MAAM,EACjB,YAAY,GAAE,YAAiB,EAC/B,OAAO,GAAE,eAAoB;IAiCxC,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,oBAAoB;IAO5B,OAAO;IAOD,KAAK,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,iBAAiB,CAAA;KAAE;IAoDlD,SAAS;IA+BT,WAAW;IAcX,OAAO,CAAC,iBAAiB;IAwBzB,WAAW,CAAC,IAAI,EAAE,MAAM;IAWxB,YAAY,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,GAAE,kBAAuB;IAmBhE,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,GAAE,kBAAuB;IA2F/D,OAAO,CAAC,cAAc;IAuBtB,OAAO,CAAC,sBAAsB;IAwB9B,OAAO,CAAC,qBAAqB;IAyB7B,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,YAAY;IAgBd,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IA2BhD,gBAAgB,CACpB,KAAK,EAAE,SAAS,EAChB,IAAI,EAAE,aAAa,EACnB,QAAQ,CAAC,EAAE,WAAW;IA0BlB,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IA6B1D,OAAO,CAAC,SAAS;IAuDjB,OAAO,CAAC,gBAAgB;IAmBxB,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,mBAAmB;IA+C3B,OAAO,CAAC,8BAA8B;IAatC,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,sBAAsB;IAkC9B,OAAO,CAAC,oBAAoB,CAM1B;IAEF,OAAO,CAAC,kCAAkC;IAwC1C,OAAO,CAAC,oBAAoB;CAa7B"}
@@ -0,0 +1,16 @@
1
+ import { GuideData, GuideGroupData, KnockGuide, SelectFilterParams } from './types';
2
+ export declare class SelectionResult<K = number, V = KnockGuide> extends Map<K, V> {
3
+ metadata: {
4
+ guideGroup: GuideGroupData;
5
+ } | undefined;
6
+ constructor();
7
+ }
8
+ export declare const formatFilters: (filters?: SelectFilterParams) => string;
9
+ export declare const byKey: <T extends {
10
+ key: string;
11
+ }>(items: T[]) => {};
12
+ export declare const DEFAULT_GROUP_KEY = "default";
13
+ export declare const mockDefaultGroup: (entries?: GuideData[]) => GuideGroupData;
14
+ export declare const findDefaultGroup: (guideGroups: GuideGroupData[]) => GuideGroupData | undefined;
15
+ export declare const checkIfThrottled: (throttleWindowStartedAtTs: string, windowDurationInSeconds: number) => boolean;
16
+ //# sourceMappingURL=helpers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,cAAc,EACd,UAAU,EACV,kBAAkB,EACnB,MAAM,SAAS,CAAC;AAKjB,qBAAa,eAAe,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,UAAU,CAAE,SAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IACxE,QAAQ,EAAE;QAAE,UAAU,EAAE,cAAc,CAAA;KAAE,GAAG,SAAS,CAAC;;CAKtD;AAED,eAAO,MAAM,aAAa,GAAI,UAAS,kBAAuB,WAO7D,CAAC;AAEF,eAAO,MAAM,KAAK,GAAI,CAAC,SAAS;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,EAAE,OAAO,CAAC,EAAE,OAE1D,CAAC;AAUF,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAO3C,eAAO,MAAM,gBAAgB,GAAI,UAAS,SAAS,EAAO,KAUnD,cACN,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,aAAa,cAAc,EAAE,+BAI3D,CAAC;AAMJ,eAAO,MAAM,gBAAgB,GAC3B,2BAA2B,MAAM,EACjC,yBAAyB,MAAM,YA0BhC,CAAC"}
@@ -1,3 +1,3 @@
1
1
  export { KnockGuideClient } from './client';
2
- export type { KnockGuide, KnockGuideStep, TargetParams as KnockGuideTargetParams, SelectFilterParams as KnockGuideFilterParams, } from './client';
2
+ export type { KnockGuide, KnockGuideStep, TargetParams as KnockGuideTargetParams, SelectFilterParams as KnockGuideFilterParams, } from './types';
3
3
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,YAAY,EACV,UAAU,EACV,cAAc,EACd,YAAY,IAAI,sBAAsB,EACtC,kBAAkB,IAAI,sBAAsB,GAC7C,MAAM,UAAU,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,YAAY,EACV,UAAU,EACV,cAAc,EACd,YAAY,IAAI,sBAAsB,EACtC,kBAAkB,IAAI,sBAAsB,GAC7C,MAAM,SAAS,CAAC"}
@@ -0,0 +1,147 @@
1
+ import { GenericData } from '@knocklabs/types';
2
+ export interface StepMessageState {
3
+ id: string;
4
+ seen_at: string | null;
5
+ read_at: string | null;
6
+ interacted_at: string | null;
7
+ archived_at: string | null;
8
+ link_clicked_at: string | null;
9
+ }
10
+ export interface GuideStepData {
11
+ ref: string;
12
+ schema_key: string;
13
+ schema_semver: string;
14
+ schema_variant_key: string;
15
+ message: StepMessageState;
16
+ content: any;
17
+ }
18
+ interface GuideActivationLocationRuleData {
19
+ directive: "allow" | "block";
20
+ pathname: string;
21
+ }
22
+ export interface GuideData {
23
+ __typename: "Guide";
24
+ channel_id: string;
25
+ id: string;
26
+ key: string;
27
+ type: string;
28
+ semver: string;
29
+ steps: GuideStepData[];
30
+ activation_location_rules: GuideActivationLocationRuleData[];
31
+ bypass_global_group_limit: boolean;
32
+ inserted_at: string;
33
+ updated_at: string;
34
+ }
35
+ export interface GuideGroupData {
36
+ __typename: "GuideGroup";
37
+ key: string;
38
+ display_sequence: Array<GuideData["key"]>;
39
+ display_sequence_unthrottled: Array<GuideData["key"]> | null;
40
+ display_sequence_throttled: Array<GuideData["key"]> | null;
41
+ display_interval: number | null;
42
+ inserted_at: string;
43
+ updated_at: string;
44
+ }
45
+ export type GetGuidesQueryParams = {
46
+ data?: string;
47
+ tenant?: string;
48
+ type?: string;
49
+ };
50
+ export type GetGuidesResponse = {
51
+ entries: GuideData[];
52
+ guide_groups: GuideGroupData[];
53
+ guide_group_display_logs: Record<GuideGroupData["key"], string>;
54
+ };
55
+ export type GuideEngagementEventBaseParams = {
56
+ message_id: string;
57
+ channel_id: string;
58
+ guide_key: string;
59
+ guide_id: string;
60
+ guide_step_ref: string;
61
+ };
62
+ export type MarkAsSeenParams = GuideEngagementEventBaseParams & {
63
+ content: GenericData;
64
+ data?: GenericData;
65
+ tenant?: string;
66
+ };
67
+ export type MarkAsInteractedParams = GuideEngagementEventBaseParams;
68
+ export type MarkAsArchivedParams = GuideEngagementEventBaseParams & {
69
+ unthrottled?: boolean;
70
+ };
71
+ export type MarkGuideAsResponse = {
72
+ status: "ok";
73
+ };
74
+ type SocketEventType = "guide.added" | "guide.updated" | "guide.removed" | "guide_group.added" | "guide_group.updated";
75
+ type SocketEventPayload<E extends SocketEventType, D> = {
76
+ topic: string;
77
+ event: E;
78
+ data: D;
79
+ };
80
+ export type GuideAddedEvent = SocketEventPayload<"guide.added", {
81
+ guide: GuideData;
82
+ eligible: true;
83
+ }>;
84
+ export type GuideUpdatedEvent = SocketEventPayload<"guide.updated", {
85
+ guide: GuideData;
86
+ eligible: boolean;
87
+ }>;
88
+ export type GuideRemovedEvent = SocketEventPayload<"guide.removed", {
89
+ guide: Pick<GuideData, "key">;
90
+ }>;
91
+ export type GuideGroupAddedEvent = SocketEventPayload<"guide_group.added", {
92
+ guide_group: GuideGroupData;
93
+ }>;
94
+ export type GuideGroupUpdatedEvent = SocketEventPayload<"guide_group.updated", {
95
+ guide_group: GuideGroupData;
96
+ }>;
97
+ export type GuideSocketEvent = GuideAddedEvent | GuideUpdatedEvent | GuideRemovedEvent | GuideGroupAddedEvent | GuideGroupUpdatedEvent;
98
+ export interface KnockGuideStep extends GuideStepData {
99
+ markAsSeen: () => void;
100
+ markAsInteracted: (params?: {
101
+ metadata?: GenericData;
102
+ }) => void;
103
+ markAsArchived: () => void;
104
+ }
105
+ interface KnockGuideActivationLocationRule extends GuideActivationLocationRuleData {
106
+ pattern: URLPattern;
107
+ }
108
+ export interface KnockGuide extends GuideData {
109
+ steps: KnockGuideStep[];
110
+ activation_location_rules: KnockGuideActivationLocationRule[];
111
+ getStep: () => KnockGuideStep | undefined;
112
+ }
113
+ type QueryKey = string;
114
+ export type QueryStatus = {
115
+ status: "loading" | "ok" | "error";
116
+ error?: Error;
117
+ };
118
+ export type StoreState = {
119
+ guideGroups: GuideGroupData[];
120
+ guideGroupDisplayLogs: Record<GuideGroupData["key"], string>;
121
+ guides: Record<KnockGuide["key"], KnockGuide>;
122
+ queries: Record<QueryKey, QueryStatus>;
123
+ location: string | undefined;
124
+ counter: number;
125
+ };
126
+ export type QueryFilterParams = Pick<GetGuidesQueryParams, "type">;
127
+ export type SelectFilterParams = {
128
+ key?: string;
129
+ type?: string;
130
+ };
131
+ export type TargetParams = {
132
+ data?: GenericData | undefined;
133
+ tenant?: string | undefined;
134
+ };
135
+ export type ConstructorOpts = {
136
+ trackLocationFromWindow?: boolean;
137
+ orderResolutionDuration?: number;
138
+ throttleCheckInterval?: number;
139
+ };
140
+ export type GroupStage = {
141
+ status: "open" | "closed" | "patch";
142
+ ordered: Array<KnockGuide["key"]>;
143
+ resolved?: KnockGuide["key"];
144
+ timeoutId: ReturnType<typeof setTimeout> | null;
145
+ };
146
+ export {};
147
+ //# sourceMappingURL=types.d.ts.map