@knocklabs/client 0.13.1 → 0.14.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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.14.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 711948c: feat: add guide client, hooks, provider, and components
8
+
3
9
  ## 0.13.1
4
10
 
5
11
  ### Patch Changes
@@ -0,0 +1,2 @@
1
+ "use strict";var l=Object.defineProperty;var m=(o,e,t)=>e in o?l(o,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):o[e]=t;var u=(o,e,t)=>m(o,typeof e!="symbol"?e+"":e,t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const g=require("@tanstack/store"),h=o=>[...o].sort((e,t)=>t.priority-e.priority||new Date(t.inserted_at).getTime()-new Date(e.inserted_at).getTime()),k=o=>`/v1/users/${o}/guides`;class y{constructor(e,t,s={}){u(this,"store");u(this,"socket");u(this,"socketChannel");u(this,"socketChannelTopic");u(this,"socketEventTypes",["guide.added","guide.updated","guide.removed"]);this.knock=e,this.channelId=t,this.targetParams=s,this.store=new g.Store({guides:[],queries:{}});const{socket:r}=this.knock.client();this.socket=r,this.socketChannelTopic=`guides:${t}`,this.knock.log("[Guide] Initialized a guide client")}async fetch(e){this.knock.failIfNotAuthenticated(),this.knock.log("[Guide] Loading all eligible guides");const t=this.buildQueryParams(e==null?void 0:e.filters),s=this.formatQueryKey(t),r=this.store.state.queries[s];if(r)return r;this.store.setState(i=>({...i,queries:{...i.queries,[s]:{status:"loading"}}}));let n;try{const i=await this.knock.user.getGuides(this.channelId,t);n={status:"ok"},this.store.setState(a=>({...a,guides:i.entries.map(d=>this.localCopy(d)),queries:{...a.queries,[s]:n}}))}catch(i){n={status:"error",error:i},this.store.setState(a=>({...a,queries:{...a.queries,[s]:n}}))}return n}subscribe(){if(!this.socket)return;this.knock.failIfNotAuthenticated(),this.knock.log("[Guide] Subscribing to real time updates"),this.socket.isConnected()||this.socket.connect(),this.socketChannel&&this.unsubscribe();const e={...this.targetParams,user_id:this.knock.userId},t=this.socket.channel(this.socketChannelTopic,e);for(const s of this.socketEventTypes)t.on(s,r=>this.handleSocketEvent(r));["closed","errored"].includes(t.state)&&t.join(),this.socketChannel=t}unsubscribe(){if(this.socketChannel){this.knock.log("[Guide] Unsubscribing from real time updates");for(const e of this.socketEventTypes)this.socketChannel.off(e);this.socketChannel.leave(),this.socketChannel=void 0}}handleSocketEvent(e){const{event:t,data:s}=e;switch(t){case"guide.added":return this.addGuide(e);case"guide.updated":return s.eligible?this.replaceOrAddGuide(e):this.removeGuide(e);case"guide.removed":return this.removeGuide(e);default:return}}select(e,t={}){return e.guides.filter(s=>!(t.type&&t.type!==s.type||t.key&&t.key!==s.key))}async markAsSeen(e,t){this.knock.log(`[Guide] Marking as seen (Guide key: ${e.key}, Step ref:${t.ref})`);const s=this.setStepMessageAttrs(e.key,t.ref,{seen_at:new Date().toISOString()});if(!s)return;const r={...this.buildEngagementEventBaseParams(e,s),content:s.content,data:this.targetParams.data,tenant:this.targetParams.tenant};return this.knock.user.markGuideStepAs("seen",r),s}async markAsInteracted(e,t,s){this.knock.log(`[Guide] Marking as interacted (Guide key: ${e.key}, Step ref:${t.ref})`);const r=new Date().toISOString(),n=this.setStepMessageAttrs(e.key,t.ref,{read_at:r,interacted_at:r});if(!n)return;const i={...this.buildEngagementEventBaseParams(e,n),metadata:s};return this.knock.user.markGuideStepAs("interacted",i),n}async markAsArchived(e,t){this.knock.log(`[Guide] Marking as archived (Guide key: ${e.key}, Step ref:${t.ref})`);const s=this.setStepMessageAttrs(e.key,t.ref,{archived_at:new Date().toISOString()});if(!s)return;const r=this.buildEngagementEventBaseParams(e,s);return this.knock.user.markGuideStepAs("archived",r),s}localCopy(e){const t=this,s={...e};return s.steps=e.steps.map(({message:r,...n})=>{const i={...n,message:{...r},markAsSeen(){if(!this.message.seen_at)return t.markAsSeen(s,this)},markAsInteracted({metadata:a}={}){return t.markAsInteracted(s,this,a)},markAsArchived(){if(!this.message.archived_at)return t.markAsArchived(s,this)}};return i.markAsSeen=i.markAsSeen.bind(i),i.markAsInteracted=i.markAsInteracted.bind(i),i.markAsArchived=i.markAsArchived.bind(i),i}),s}buildQueryParams(e={}){const t={...this.targetParams,...e};let s=Object.fromEntries(Object.entries(t).filter(([r,n])=>n!=null));return s=s.data?{...s,data:JSON.stringify(s.data)}:s,s}formatQueryKey(e){const s=Object.keys(e).sort().map(n=>`${encodeURIComponent(n)}=${encodeURIComponent(e[n])}`).join("&"),r=k(this.knock.userId);return s?`${r}?${s}`:r}setStepMessageAttrs(e,t,s){let r;return this.store.setState(n=>{const i=n.guides.map(a=>{if(a.key!==e)return a;const d=a.steps.map(c=>(c.ref!==t||(c.message={...c.message,...s},r=c),c));return{...a,steps:d}});return{...n,guides:i}}),r}buildEngagementEventBaseParams(e,t){return{message_id:t.message.id,channel_id:e.channel_id,guide_key:e.key,guide_id:e.id,guide_step_ref:t.ref}}addGuide({data:e}){const t=this.localCopy(e.guide);this.store.setState(s=>({...s,guides:h([...s.guides,t])}))}replaceOrAddGuide({data:e}){const t=this.localCopy(e.guide);this.store.setState(s=>{let r=!1;const n=s.guides.map(i=>i.key!==t.key?i:(r=!0,t));return{...s,guides:h(r?n:[...n,t])}})}removeGuide({data:e}){this.store.setState(t=>{const s=t.guides.filter(r=>r.key!==e.guide.key);return{...t,guides:s}})}}exports.KnockGuideClient=y;exports.guidesApiRootPath=k;
2
+ //# sourceMappingURL=client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.js","sources":["../../../../src/clients/guide/client.ts"],"sourcesContent":["import { GenericData } from \"@knocklabs/types\";\nimport { Store } from \"@tanstack/store\";\nimport { Channel, Socket } from \"phoenix\";\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 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 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\nexport interface KnockGuide extends GuideData {\n steps: KnockGuideStep[];\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};\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\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 constructor(\n readonly knock: Knock,\n readonly channelId: string,\n readonly targetParams: TargetParams = {},\n ) {\n this.store = new Store<StoreState>({\n guides: [],\n queries: {},\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 this.knock.log(\"[Guide] Initialized a guide client\");\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 // TODO(KNO-7790): Need to evaluate activation rules also.\n\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 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 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"],"names":["sortGuides","guides","a","b","guidesApiRootPath","userId","KnockGuideClient","knock","channelId","targetParams","__publicField","Store","maybeSocket","opts","queryParams","queryKey","maybeQueryStatus","state","queryStatus","data","g","e","params","newChannel","eventType","payload","event","filters","guide","step","updatedStep","metadata","ts","remoteGuide","self","localGuide","message","rest","localStep","filterParams","combinedParams","_k","v","queryStr","key","basePath","guideKey","stepRef","attrs","steps","replaced"],"mappings":"uRAMMA,EAAcC,GACX,CAAC,GAAGA,CAAM,EAAE,KACjB,CAACC,EAAGC,IACFA,EAAE,SAAWD,EAAE,UACf,IAAI,KAAKC,EAAE,WAAW,EAAE,UAAY,IAAI,KAAKD,EAAE,WAAW,EAAE,QAAQ,CACxE,EAOWE,EAAqBC,GAChC,aAAaA,CAAM,UAkId,MAAMC,CAAiB,CAS5B,YACWC,EACAC,EACAC,EAA6B,CAAA,EACtC,CAZKC,EAAA,cAGCA,EAAA,eACAA,EAAA,sBACAA,EAAA,2BACAA,EAAA,wBAAmB,CAAC,cAAe,gBAAiB,eAAe,GAGhE,KAAA,MAAAH,EACA,KAAA,UAAAC,EACA,KAAA,aAAAC,EAEJ,KAAA,MAAQ,IAAIE,QAAkB,CACjC,OAAQ,CAAC,EACT,QAAS,CAAA,CAAC,CACX,EAGD,KAAM,CAAE,OAAQC,CAAA,EAAgB,KAAK,MAAM,OAAO,EAClD,KAAK,OAASA,EACT,KAAA,mBAAqB,UAAUJ,CAAS,GAExC,KAAA,MAAM,IAAI,oCAAoC,CAAA,CAGrD,MAAM,MAAMK,EAAwC,CAClD,KAAK,MAAM,uBAAuB,EAC7B,KAAA,MAAM,IAAI,qCAAqC,EAEpD,MAAMC,EAAc,KAAK,iBAAiBD,GAAA,YAAAA,EAAM,OAAO,EACjDE,EAAW,KAAK,eAAeD,CAAW,EAG1CE,EAAmB,KAAK,MAAM,MAAM,QAAQD,CAAQ,EAC1D,GAAIC,EACK,OAAAA,EAIJ,KAAA,MAAM,SAAUC,IAAW,CAC9B,GAAGA,EACH,QAAS,CAAE,GAAGA,EAAM,QAAS,CAACF,CAAQ,EAAG,CAAE,OAAQ,SAAY,CAAA,CAAA,EAC/D,EAEE,IAAAG,EACA,GAAA,CACI,MAAAC,EAAO,MAAM,KAAK,MAAM,KAAK,UAGjC,KAAK,UAAWL,CAAW,EACfI,EAAA,CAAE,OAAQ,IAAK,EAExB,KAAA,MAAM,SAAUD,IAAW,CAC9B,GAAGA,EAIH,OAAQE,EAAK,QAAQ,IAAKC,GAAM,KAAK,UAAUA,CAAC,CAAC,EACjD,QAAS,CAAE,GAAGH,EAAM,QAAS,CAACF,CAAQ,EAAGG,CAAY,CAAA,EACrD,QACKG,EAAG,CACVH,EAAc,CAAE,OAAQ,QAAS,MAAOG,CAAW,EAE9C,KAAA,MAAM,SAAUJ,IAAW,CAC9B,GAAGA,EACH,QAAS,CAAE,GAAGA,EAAM,QAAS,CAACF,CAAQ,EAAGG,CAAY,CAAA,EACrD,CAAA,CAGG,OAAAA,CAAA,CAGT,WAAY,CACN,GAAA,CAAC,KAAK,OAAQ,OAClB,KAAK,MAAM,uBAAuB,EAC7B,KAAA,MAAM,IAAI,0CAA0C,EAGpD,KAAK,OAAO,eACf,KAAK,OAAO,QAAQ,EAIlB,KAAK,eACP,KAAK,YAAY,EAIb,MAAAI,EAAS,CAAE,GAAG,KAAK,aAAc,QAAS,KAAK,MAAM,MAAO,EAC5DC,EAAa,KAAK,OAAO,QAAQ,KAAK,mBAAoBD,CAAM,EAE3D,UAAAE,KAAa,KAAK,iBAC3BD,EAAW,GAAGC,EAAYC,GAAY,KAAK,kBAAkBA,CAAO,CAAC,EAGnE,CAAC,SAAU,SAAS,EAAE,SAASF,EAAW,KAAK,GACjDA,EAAW,KAAK,EAIlB,KAAK,cAAgBA,CAAA,CAGvB,aAAc,CACR,GAAC,KAAK,cACL,MAAA,MAAM,IAAI,8CAA8C,EAGlD,UAAAC,KAAa,KAAK,iBACtB,KAAA,cAAc,IAAIA,CAAS,EAElC,KAAK,cAAc,MAAM,EAGzB,KAAK,cAAgB,OAAA,CAGf,kBAAkBC,EAA2B,CAC7C,KAAA,CAAE,MAAAC,EAAO,KAAAP,CAAA,EAASM,EAExB,OAAQC,EAAO,CACb,IAAK,cACI,OAAA,KAAK,SAASD,CAAO,EAE9B,IAAK,gBACI,OAAAN,EAAK,SACR,KAAK,kBAAkBM,CAAO,EAC9B,KAAK,YAAYA,CAAO,EAE9B,IAAK,gBACI,OAAA,KAAK,YAAYA,CAAO,EAEjC,QACE,MAAA,CACJ,CAOF,OAAOR,EAAmBU,EAA8B,GAAI,CAG1D,OAAOV,EAAM,OAAO,OAAQW,GACtB,EAAAD,EAAQ,MAAQA,EAAQ,OAASC,EAAM,MAIvCD,EAAQ,KAAOA,EAAQ,MAAQC,EAAM,IAK1C,CAAA,CAUH,MAAM,WAAWA,EAAkBC,EAAqB,CACtD,KAAK,MAAM,IACT,uCAAuCD,EAAM,GAAG,cAAcC,EAAK,GAAG,GACxE,EAEA,MAAMC,EAAc,KAAK,oBAAoBF,EAAM,IAAKC,EAAK,IAAK,CAChE,QAAS,IAAI,KAAK,EAAE,YAAY,CAAA,CACjC,EACD,GAAI,CAACC,EAAa,OAElB,MAAMR,EAAS,CACb,GAAG,KAAK,+BAA+BM,EAAOE,CAAW,EACzD,QAASA,EAAY,QACrB,KAAM,KAAK,aAAa,KACxB,OAAQ,KAAK,aAAa,MAC5B,EAEA,YAAK,MAAM,KAAK,gBACd,OACAR,CACF,EAEOQ,CAAA,CAGT,MAAM,iBACJF,EACAC,EACAE,EACA,CACA,KAAK,MAAM,IACT,6CAA6CH,EAAM,GAAG,cAAcC,EAAK,GAAG,GAC9E,EAEA,MAAMG,EAAK,IAAI,KAAK,EAAE,YAAY,EAC5BF,EAAc,KAAK,oBAAoBF,EAAM,IAAKC,EAAK,IAAK,CAChE,QAASG,EACT,cAAeA,CAAA,CAChB,EACD,GAAI,CAACF,EAAa,OAElB,MAAMR,EAAS,CACb,GAAG,KAAK,+BAA+BM,EAAOE,CAAW,EACzD,SAAAC,CACF,EAEA,YAAK,MAAM,KAAK,gBAGd,aAAcT,CAAM,EAEfQ,CAAA,CAGT,MAAM,eAAeF,EAAkBC,EAAqB,CAC1D,KAAK,MAAM,IACT,2CAA2CD,EAAM,GAAG,cAAcC,EAAK,GAAG,GAC5E,EAEA,MAAMC,EAAc,KAAK,oBAAoBF,EAAM,IAAKC,EAAK,IAAK,CAChE,YAAa,IAAI,KAAK,EAAE,YAAY,CAAA,CACrC,EACD,GAAI,CAACC,EAAa,OAElB,MAAMR,EAAS,KAAK,+BAA+BM,EAAOE,CAAW,EAErE,YAAK,MAAM,KAAK,gBACd,WACAR,CACF,EAEOQ,CAAA,CAOD,UAAUG,EAAwB,CAExC,MAAMC,EAAO,KAGPC,EAAa,CAAE,GAAGF,CAAY,EAEzB,OAAAE,EAAA,MAAQF,EAAY,MAAM,IAAI,CAAC,CAAE,QAAAG,EAAS,GAAGC,KAAW,CACjE,MAAMC,EAAY,CAChB,GAAGD,EACH,QAAS,CAAE,GAAGD,CAAQ,EACtB,YAAa,CAEP,GAAA,MAAK,QAAQ,QACV,OAAAF,EAAK,WAAWC,EAAY,IAAI,CACzC,EACA,iBAAiB,CAAE,SAAAJ,CAAS,EAAgC,GAAI,CAE9D,OAAOG,EAAK,iBAAiBC,EAAY,KAAMJ,CAAQ,CACzD,EACA,gBAAiB,CAEX,GAAA,MAAK,QAAQ,YACV,OAAAG,EAAK,eAAeC,EAAY,IAAI,CAAA,CAE/C,EAIA,OAAAG,EAAU,WAAaA,EAAU,WAAW,KAAKA,CAAS,EAC1DA,EAAU,iBAAmBA,EAAU,iBAAiB,KAAKA,CAAS,EACtEA,EAAU,eAAiBA,EAAU,eAAe,KAAKA,CAAS,EAE3DA,CAAA,CACR,EAEMH,CAAA,CAGD,iBAAiBI,EAAkC,GAAI,CAE7D,MAAMC,EAAiB,CAAE,GAAG,KAAK,aAAc,GAAGD,CAAa,EAG/D,IAAIjB,EAAS,OAAO,YAClB,OAAO,QAAQkB,CAAc,EAAE,OAC7B,CAAC,CAACC,EAAIC,CAAC,IAAyBA,GAAM,IAAA,CAE1C,EAGS,OAAApB,EAAAA,EAAO,KACZ,CAAE,GAAGA,EAAQ,KAAM,KAAK,UAAUA,EAAO,IAAI,CAC7C,EAAAA,EAEGA,CAAA,CAGD,eAAeR,EAA0B,CAG/C,MAAM6B,EAFa,OAAO,KAAK7B,CAAW,EAAE,KAAK,EAG9C,IACE8B,GACC,GAAG,mBAAmBA,CAAG,CAAC,IAAI,mBAAmB9B,EAAY8B,CAAG,CAAC,CAAC,EAAA,EAErE,KAAK,GAAG,EAELC,EAAWzC,EAAkB,KAAK,MAAM,MAAM,EACpD,OAAOuC,EAAW,GAAGE,CAAQ,IAAIF,CAAQ,GAAKE,CAAA,CAGxC,oBACNC,EACAC,EACAC,EACA,CACI,IAAAlB,EAEC,YAAA,MAAM,SAAUb,GAAU,CAC7B,MAAMhB,EAASgB,EAAM,OAAO,IAAKW,GAAU,CACrC,GAAAA,EAAM,MAAQkB,EAAiB,OAAAlB,EAEnC,MAAMqB,EAAQrB,EAAM,MAAM,IAAKC,IACzBA,EAAK,MAAQkB,IAIjBlB,EAAK,QAAU,CAAE,GAAGA,EAAK,QAAS,GAAGmB,CAAM,EAC7BlB,EAAAD,GAEPA,EACR,EACM,MAAA,CAAE,GAAGD,EAAO,MAAAqB,CAAM,CAAA,CAC1B,EACM,MAAA,CAAE,GAAGhC,EAAO,OAAAhB,CAAO,CAAA,CAC3B,EAEM6B,CAAA,CAGD,+BACNF,EACAC,EACA,CACO,MAAA,CACL,WAAYA,EAAK,QAAQ,GACzB,WAAYD,EAAM,WAClB,UAAWA,EAAM,IACjB,SAAUA,EAAM,GAChB,eAAgBC,EAAK,GACvB,CAAA,CAGM,SAAS,CAAE,KAAAV,GAAyB,CAC1C,MAAMS,EAAQ,KAAK,UAAUT,EAAK,KAAK,EAElC,KAAA,MAAM,SAAUF,IACZ,CAAE,GAAGA,EAAO,OAAQjB,EAAW,CAAC,GAAGiB,EAAM,OAAQW,CAAK,CAAC,CAAE,EACjE,CAAA,CAGK,kBAAkB,CAAE,KAAAT,GAA2B,CACrD,MAAMS,EAAQ,KAAK,UAAUT,EAAK,KAAK,EAElC,KAAA,MAAM,SAAUF,GAAU,CAC7B,IAAIiC,EAAW,GAEf,MAAMjD,EAASgB,EAAM,OAAO,IAAKG,GAC3BA,EAAE,MAAQQ,EAAM,IAAYR,GACrB8B,EAAA,GACJtB,EACR,EAEM,MAAA,CACL,GAAGX,EACH,OAAmBjB,EAAXkD,EAAsBjD,EAAqB,CAAC,GAAGA,EAAQ2B,CAAK,CAAhC,CACtC,CAAA,CACD,CAAA,CAGK,YAAY,CAAE,KAAAT,GAA+C,CAC9D,KAAA,MAAM,SAAUF,GAAU,CACvB,MAAAhB,EAASgB,EAAM,OAAO,OAAQG,GAAMA,EAAE,MAAQD,EAAK,MAAM,GAAG,EAC3D,MAAA,CAAE,GAAGF,EAAO,OAAAhB,CAAO,CAAA,CAC3B,CAAA,CAEL"}
@@ -1,2 +1,2 @@
1
- "use strict";var c=Object.defineProperty;var u=(s,e,t)=>e in s?c(s,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):s[e]=t;var a=(s,e,t)=>u(s,typeof e!="symbol"?e+"":e,t);Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const i="default";class h{constructor(e){a(this,"instance");this.instance=e}async get(){this.instance.failIfNotAuthenticated();const e=await this.instance.client().makeRequest({method:"GET",url:`/v1/users/${this.instance.userId}`});return this.handleResponse(e)}async identify(e={}){this.instance.failIfNotAuthenticated();const t=await this.instance.client().makeRequest({method:"PUT",url:`/v1/users/${this.instance.userId}`,params:e});return this.handleResponse(t)}async getAllPreferences(){this.instance.failIfNotAuthenticated();const e=await this.instance.client().makeRequest({method:"GET",url:`/v1/users/${this.instance.userId}/preferences`});return this.handleResponse(e)}async getPreferences(e={}){this.instance.failIfNotAuthenticated();const t=e.preferenceSet||i,n=await this.instance.client().makeRequest({method:"GET",url:`/v1/users/${this.instance.userId}/preferences/${t}`,params:{tenant:e.tenant}});return this.handleResponse(n)}async setPreferences(e,t={}){this.instance.failIfNotAuthenticated();const n=t.preferenceSet||i,r=await this.instance.client().makeRequest({method:"PUT",url:`/v1/users/${this.instance.userId}/preferences/${n}`,data:e});return this.handleResponse(r)}async getChannelData(e){this.instance.failIfNotAuthenticated();const t=await this.instance.client().makeRequest({method:"GET",url:`/v1/users/${this.instance.userId}/channel_data/${e.channelId}`});return this.handleResponse(t)}async setChannelData({channelId:e,channelData:t}){this.instance.failIfNotAuthenticated();const n=await this.instance.client().makeRequest({method:"PUT",url:`/v1/users/${this.instance.userId}/channel_data/${e}`,data:{data:t}});return this.handleResponse(n)}handleResponse(e){if(e.statusCode==="error")throw new Error(e.error||e.body);return e.body}}exports.default=h;
1
+ "use strict";var u=Object.defineProperty;var h=(n,e,t)=>e in n?u(n,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):n[e]=t;var a=(n,e,t)=>h(n,typeof e!="symbol"?e+"":e,t);Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const i=require("../guide/client.js"),r="default";class l{constructor(e){a(this,"instance");this.instance=e}async get(){this.instance.failIfNotAuthenticated();const e=await this.instance.client().makeRequest({method:"GET",url:`/v1/users/${this.instance.userId}`});return this.handleResponse(e)}async identify(e={}){this.instance.failIfNotAuthenticated();const t=await this.instance.client().makeRequest({method:"PUT",url:`/v1/users/${this.instance.userId}`,params:e});return this.handleResponse(t)}async getAllPreferences(){this.instance.failIfNotAuthenticated();const e=await this.instance.client().makeRequest({method:"GET",url:`/v1/users/${this.instance.userId}/preferences`});return this.handleResponse(e)}async getPreferences(e={}){this.instance.failIfNotAuthenticated();const t=e.preferenceSet||r,s=await this.instance.client().makeRequest({method:"GET",url:`/v1/users/${this.instance.userId}/preferences/${t}`,params:{tenant:e.tenant}});return this.handleResponse(s)}async setPreferences(e,t={}){this.instance.failIfNotAuthenticated();const s=t.preferenceSet||r,c=await this.instance.client().makeRequest({method:"PUT",url:`/v1/users/${this.instance.userId}/preferences/${s}`,data:e});return this.handleResponse(c)}async getChannelData(e){this.instance.failIfNotAuthenticated();const t=await this.instance.client().makeRequest({method:"GET",url:`/v1/users/${this.instance.userId}/channel_data/${e.channelId}`});return this.handleResponse(t)}async setChannelData({channelId:e,channelData:t}){this.instance.failIfNotAuthenticated();const s=await this.instance.client().makeRequest({method:"PUT",url:`/v1/users/${this.instance.userId}/channel_data/${e}`,data:{data:t}});return this.handleResponse(s)}async getGuides(e,t){const s=await this.instance.client().makeRequest({method:"GET",url:`${i.guidesApiRootPath(this.instance.userId)}/${e}`,params:t});return this.handleResponse(s)}async markGuideStepAs(e,t){const s=await this.instance.client().makeRequest({method:"PUT",url:`${i.guidesApiRootPath(this.instance.userId)}/messages/${t.message_id}/${e}`,data:t});return this.handleResponse(s)}handleResponse(e){if(e.statusCode==="error")throw new Error(e.error||e.body);return e.body}}exports.default=l;
2
2
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","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 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 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","response"],"mappings":"gRAcA,MAAMA,EAA4B,UAElC,MAAMC,CAAW,CAGf,YAAYC,EAAiB,CAFrBC,EAAA,iBAGN,KAAK,SAAWD,CAAA,CAGlB,MAAM,KAAM,CACV,KAAK,SAAS,uBAAuB,EAErC,MAAME,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,EAAA,CACvC,EAEM,OAAA,KAAK,eAAqBA,CAAM,CAAA,CAGzC,MAAM,SAASC,EAAqB,GAAI,CACtC,KAAK,SAAS,uBAAuB,EAErC,MAAMD,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,GACtC,OAAQC,CAAA,CACT,EAEM,OAAA,KAAK,eAAqBD,CAAM,CAAA,CAGzC,MAAM,mBAAoB,CACxB,KAAK,SAAS,uBAAuB,EAErC,MAAMA,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,cAAA,CACvC,EAEM,OAAA,KAAK,eAAgCA,CAAM,CAAA,CAGpD,MAAM,eACJE,EAAiC,GACT,CACxB,KAAK,SAAS,uBAAuB,EAC/B,MAAAC,EAAkBD,EAAQ,eAAiBN,EAE3CI,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe,GACrE,OAAQ,CAAE,OAAQD,EAAQ,MAAO,CAAA,CAClC,EAEM,OAAA,KAAK,eAA8BF,CAAM,CAAA,CAGlD,MAAM,eACJI,EACAF,EAA6B,GACL,CACxB,KAAK,SAAS,uBAAuB,EAC/B,MAAAC,EAAkBD,EAAQ,eAAiBN,EAE3CI,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe,GACrE,KAAMC,CAAA,CACP,EAEM,OAAA,KAAK,eAA8BJ,CAAM,CAAA,CAGlD,MAAM,eAAgCK,EAA6B,CACjE,KAAK,SAAS,uBAAuB,EAErC,MAAML,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBK,EAAO,SAAS,EAAA,CACxE,EAEM,OAAA,KAAK,eAA+BL,CAAM,CAAA,CAGnD,MAAM,eAAgC,CACpC,UAAAM,EACA,YAAAC,CAAA,EACsB,CACtB,KAAK,SAAS,uBAAuB,EAErC,MAAMP,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBM,CAAS,GAChE,KAAM,CAAE,KAAMC,CAAY,CAAA,CAC3B,EAEM,OAAA,KAAK,eAA+BP,CAAM,CAAA,CAG3C,eAAkBQ,EAAuB,CAC3C,GAAAA,EAAS,aAAe,QAC1B,MAAM,IAAI,MAAMA,EAAS,OAASA,EAAS,IAAI,EAGjD,OAAOA,EAAS,IAAA,CAEpB"}
1
+ {"version":3,"file":"index.js","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":"sTAkBMA,EAA4B,UAElC,MAAMC,CAAW,CAGf,YAAYC,EAAiB,CAFrBC,EAAA,iBAGN,KAAK,SAAWD,CAAA,CAGlB,MAAM,KAAM,CACV,KAAK,SAAS,uBAAuB,EAErC,MAAME,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,EAAA,CACvC,EAEM,OAAA,KAAK,eAAqBA,CAAM,CAAA,CAGzC,MAAM,SAASC,EAAqB,GAAI,CACtC,KAAK,SAAS,uBAAuB,EAErC,MAAMD,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,GACtC,OAAQC,CAAA,CACT,EAEM,OAAA,KAAK,eAAqBD,CAAM,CAAA,CAGzC,MAAM,mBAAoB,CACxB,KAAK,SAAS,uBAAuB,EAErC,MAAMA,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,cAAA,CACvC,EAEM,OAAA,KAAK,eAAgCA,CAAM,CAAA,CAGpD,MAAM,eACJE,EAAiC,GACT,CACxB,KAAK,SAAS,uBAAuB,EAC/B,MAAAC,EAAkBD,EAAQ,eAAiBN,EAE3CI,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe,GACrE,OAAQ,CAAE,OAAQD,EAAQ,MAAO,CAAA,CAClC,EAEM,OAAA,KAAK,eAA8BF,CAAM,CAAA,CAGlD,MAAM,eACJI,EACAF,EAA6B,GACL,CACxB,KAAK,SAAS,uBAAuB,EAC/B,MAAAC,EAAkBD,EAAQ,eAAiBN,EAE3CI,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe,GACrE,KAAMC,CAAA,CACP,EAEM,OAAA,KAAK,eAA8BJ,CAAM,CAAA,CAGlD,MAAM,eAAgCK,EAA6B,CACjE,KAAK,SAAS,uBAAuB,EAErC,MAAML,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBK,EAAO,SAAS,EAAA,CACxE,EAEM,OAAA,KAAK,eAA+BL,CAAM,CAAA,CAGnD,MAAM,eAAgC,CACpC,UAAAM,EACA,YAAAC,CAAA,EACsB,CACtB,KAAK,SAAS,uBAAuB,EAErC,MAAMP,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBM,CAAS,GAChE,KAAM,CAAE,KAAMC,CAAY,CAAA,CAC3B,EAEM,OAAA,KAAK,eAA+BP,CAAM,CAAA,CAGnD,MAAM,UAAgBM,EAAmBD,EAAW,CAClD,MAAML,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,GAAGQ,EAAAA,kBAAkB,KAAK,SAAS,MAAM,CAAC,IAAIF,CAAS,GAC5D,OAAAD,CAAA,CACD,EAEM,OAAA,KAAK,eAAkBL,CAAM,CAAA,CAGtC,MAAM,gBACJS,EACAJ,EACA,CACA,MAAML,EAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY,CACtD,OAAQ,MACR,IAAK,GAAGQ,oBAAkB,KAAK,SAAS,MAAM,CAAC,aAAaH,EAAO,UAAU,IAAII,CAAM,GACvF,KAAMJ,CAAA,CACP,EAEM,OAAA,KAAK,eAAkBL,CAAM,CAAA,CAG9B,eAAkBU,EAAuB,CAC3C,GAAAA,EAAS,aAAe,QAC1B,MAAM,IAAI,MAAMA,EAAS,OAASA,EAAS,IAAI,EAGjD,OAAOA,EAAS,IAAA,CAEpB"}
package/dist/cjs/index.js CHANGED
@@ -1,2 +1,2 @@
1
- "use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const t=require("./clients/feed/index.js"),u=require("./knock.js"),r=require("./clients/objects/constants.js"),e=require("./networkStatus.js"),s=require("./clients/feed/feed.js");exports.FeedClient=t.default;exports.default=u.default;exports.TENANT_OBJECT_COLLECTION=r.TENANT_OBJECT_COLLECTION;exports.NetworkStatus=e.NetworkStatus;exports.isRequestInFlight=e.isRequestInFlight;exports.Feed=s.default;
1
+ "use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const t=require("./clients/feed/index.js"),u=require("./knock.js"),i=require("./clients/guide/client.js"),n=require("./clients/objects/constants.js"),e=require("./networkStatus.js"),r=require("./clients/feed/feed.js");exports.FeedClient=t.default;exports.default=u.default;exports.KnockGuideClient=i.KnockGuideClient;exports.TENANT_OBJECT_COLLECTION=n.TENANT_OBJECT_COLLECTION;exports.NetworkStatus=e.NetworkStatus;exports.isRequestInFlight=e.isRequestInFlight;exports.Feed=r.default;
2
2
  //# sourceMappingURL=index.js.map
@@ -0,0 +1,225 @@
1
+ var k = Object.defineProperty;
2
+ var l = (o, e, t) => e in o ? k(o, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : o[e] = t;
3
+ var u = (o, e, t) => l(o, typeof e != "symbol" ? e + "" : e, t);
4
+ import { Store as m } from "@tanstack/store";
5
+ const h = (o) => [...o].sort(
6
+ (e, t) => t.priority - e.priority || new Date(t.inserted_at).getTime() - new Date(e.inserted_at).getTime()
7
+ ), g = (o) => `/v1/users/${o}/guides`;
8
+ class p {
9
+ constructor(e, t, s = {}) {
10
+ u(this, "store");
11
+ // Phoenix channels for real time guide updates over websocket
12
+ u(this, "socket");
13
+ u(this, "socketChannel");
14
+ u(this, "socketChannelTopic");
15
+ u(this, "socketEventTypes", ["guide.added", "guide.updated", "guide.removed"]);
16
+ this.knock = e, this.channelId = t, this.targetParams = s, this.store = new m({
17
+ guides: [],
18
+ queries: {}
19
+ });
20
+ const { socket: r } = this.knock.client();
21
+ this.socket = r, this.socketChannelTopic = `guides:${t}`, this.knock.log("[Guide] Initialized a guide client");
22
+ }
23
+ async fetch(e) {
24
+ this.knock.failIfNotAuthenticated(), this.knock.log("[Guide] Loading all eligible guides");
25
+ const t = this.buildQueryParams(e == null ? void 0 : e.filters), s = this.formatQueryKey(t), r = this.store.state.queries[s];
26
+ if (r)
27
+ return r;
28
+ this.store.setState((i) => ({
29
+ ...i,
30
+ queries: { ...i.queries, [s]: { status: "loading" } }
31
+ }));
32
+ let n;
33
+ try {
34
+ const i = await this.knock.user.getGuides(this.channelId, t);
35
+ n = { status: "ok" }, this.store.setState((a) => ({
36
+ ...a,
37
+ // For now assume a single fetch to get all eligible guides. When/if
38
+ // we implement incremental loads, then this will need to be a merge
39
+ // and sort operation.
40
+ guides: i.entries.map((d) => this.localCopy(d)),
41
+ queries: { ...a.queries, [s]: n }
42
+ }));
43
+ } catch (i) {
44
+ n = { status: "error", error: i }, this.store.setState((a) => ({
45
+ ...a,
46
+ queries: { ...a.queries, [s]: n }
47
+ }));
48
+ }
49
+ return n;
50
+ }
51
+ subscribe() {
52
+ if (!this.socket) return;
53
+ this.knock.failIfNotAuthenticated(), this.knock.log("[Guide] Subscribing to real time updates"), this.socket.isConnected() || this.socket.connect(), this.socketChannel && this.unsubscribe();
54
+ const e = { ...this.targetParams, user_id: this.knock.userId }, t = this.socket.channel(this.socketChannelTopic, e);
55
+ for (const s of this.socketEventTypes)
56
+ t.on(s, (r) => this.handleSocketEvent(r));
57
+ ["closed", "errored"].includes(t.state) && t.join(), this.socketChannel = t;
58
+ }
59
+ unsubscribe() {
60
+ if (this.socketChannel) {
61
+ this.knock.log("[Guide] Unsubscribing from real time updates");
62
+ for (const e of this.socketEventTypes)
63
+ this.socketChannel.off(e);
64
+ this.socketChannel.leave(), this.socketChannel = void 0;
65
+ }
66
+ }
67
+ handleSocketEvent(e) {
68
+ const { event: t, data: s } = e;
69
+ switch (t) {
70
+ case "guide.added":
71
+ return this.addGuide(e);
72
+ case "guide.updated":
73
+ return s.eligible ? this.replaceOrAddGuide(e) : this.removeGuide(e);
74
+ case "guide.removed":
75
+ return this.removeGuide(e);
76
+ default:
77
+ return;
78
+ }
79
+ }
80
+ //
81
+ // Store selector
82
+ //
83
+ select(e, t = {}) {
84
+ return e.guides.filter((s) => !(t.type && t.type !== s.type || t.key && t.key !== s.key));
85
+ }
86
+ //
87
+ // Engagement event handlers
88
+ //
89
+ // Make an optimistic update on the client side first, then send an engagement
90
+ // event to the backend.
91
+ //
92
+ async markAsSeen(e, t) {
93
+ this.knock.log(
94
+ `[Guide] Marking as seen (Guide key: ${e.key}, Step ref:${t.ref})`
95
+ );
96
+ const s = this.setStepMessageAttrs(e.key, t.ref, {
97
+ seen_at: (/* @__PURE__ */ new Date()).toISOString()
98
+ });
99
+ if (!s) return;
100
+ const r = {
101
+ ...this.buildEngagementEventBaseParams(e, s),
102
+ content: s.content,
103
+ data: this.targetParams.data,
104
+ tenant: this.targetParams.tenant
105
+ };
106
+ return this.knock.user.markGuideStepAs(
107
+ "seen",
108
+ r
109
+ ), s;
110
+ }
111
+ async markAsInteracted(e, t, s) {
112
+ this.knock.log(
113
+ `[Guide] Marking as interacted (Guide key: ${e.key}, Step ref:${t.ref})`
114
+ );
115
+ const r = (/* @__PURE__ */ new Date()).toISOString(), n = this.setStepMessageAttrs(e.key, t.ref, {
116
+ read_at: r,
117
+ interacted_at: r
118
+ });
119
+ if (!n) return;
120
+ const i = {
121
+ ...this.buildEngagementEventBaseParams(e, n),
122
+ metadata: s
123
+ };
124
+ return this.knock.user.markGuideStepAs("interacted", i), n;
125
+ }
126
+ async markAsArchived(e, t) {
127
+ this.knock.log(
128
+ `[Guide] Marking as archived (Guide key: ${e.key}, Step ref:${t.ref})`
129
+ );
130
+ const s = this.setStepMessageAttrs(e.key, t.ref, {
131
+ archived_at: (/* @__PURE__ */ new Date()).toISOString()
132
+ });
133
+ if (!s) return;
134
+ const r = this.buildEngagementEventBaseParams(e, s);
135
+ return this.knock.user.markGuideStepAs(
136
+ "archived",
137
+ r
138
+ ), s;
139
+ }
140
+ //
141
+ // Helpers
142
+ //
143
+ localCopy(e) {
144
+ const t = this, s = { ...e };
145
+ return s.steps = e.steps.map(({ message: r, ...n }) => {
146
+ const i = {
147
+ ...n,
148
+ message: { ...r },
149
+ markAsSeen() {
150
+ if (!this.message.seen_at)
151
+ return t.markAsSeen(s, this);
152
+ },
153
+ markAsInteracted({ metadata: a } = {}) {
154
+ return t.markAsInteracted(s, this, a);
155
+ },
156
+ markAsArchived() {
157
+ if (!this.message.archived_at)
158
+ return t.markAsArchived(s, this);
159
+ }
160
+ };
161
+ return i.markAsSeen = i.markAsSeen.bind(i), i.markAsInteracted = i.markAsInteracted.bind(i), i.markAsArchived = i.markAsArchived.bind(i), i;
162
+ }), s;
163
+ }
164
+ buildQueryParams(e = {}) {
165
+ const t = { ...this.targetParams, ...e };
166
+ let s = Object.fromEntries(
167
+ Object.entries(t).filter(
168
+ ([r, n]) => n != null
169
+ )
170
+ );
171
+ return s = s.data ? { ...s, data: JSON.stringify(s.data) } : s, s;
172
+ }
173
+ formatQueryKey(e) {
174
+ const s = Object.keys(e).sort().map(
175
+ (n) => `${encodeURIComponent(n)}=${encodeURIComponent(e[n])}`
176
+ ).join("&"), r = g(this.knock.userId);
177
+ return s ? `${r}?${s}` : r;
178
+ }
179
+ setStepMessageAttrs(e, t, s) {
180
+ let r;
181
+ return this.store.setState((n) => {
182
+ const i = n.guides.map((a) => {
183
+ if (a.key !== e) return a;
184
+ const d = a.steps.map((c) => (c.ref !== t || (c.message = { ...c.message, ...s }, r = c), c));
185
+ return { ...a, steps: d };
186
+ });
187
+ return { ...n, guides: i };
188
+ }), r;
189
+ }
190
+ buildEngagementEventBaseParams(e, t) {
191
+ return {
192
+ message_id: t.message.id,
193
+ channel_id: e.channel_id,
194
+ guide_key: e.key,
195
+ guide_id: e.id,
196
+ guide_step_ref: t.ref
197
+ };
198
+ }
199
+ addGuide({ data: e }) {
200
+ const t = this.localCopy(e.guide);
201
+ this.store.setState((s) => ({ ...s, guides: h([...s.guides, t]) }));
202
+ }
203
+ replaceOrAddGuide({ data: e }) {
204
+ const t = this.localCopy(e.guide);
205
+ this.store.setState((s) => {
206
+ let r = !1;
207
+ const n = s.guides.map((i) => i.key !== t.key ? i : (r = !0, t));
208
+ return {
209
+ ...s,
210
+ guides: h(r ? n : [...n, t])
211
+ };
212
+ });
213
+ }
214
+ removeGuide({ data: e }) {
215
+ this.store.setState((t) => {
216
+ const s = t.guides.filter((r) => r.key !== e.guide.key);
217
+ return { ...t, guides: s };
218
+ });
219
+ }
220
+ }
221
+ export {
222
+ p as KnockGuideClient,
223
+ g as guidesApiRootPath
224
+ };
225
+ //# sourceMappingURL=client.mjs.map
@@ -0,0 +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\";\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 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 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\nexport interface KnockGuide extends GuideData {\n steps: KnockGuideStep[];\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};\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\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 constructor(\n readonly knock: Knock,\n readonly channelId: string,\n readonly targetParams: TargetParams = {},\n ) {\n this.store = new Store<StoreState>({\n guides: [],\n queries: {},\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 this.knock.log(\"[Guide] Initialized a guide client\");\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 // TODO(KNO-7790): Need to evaluate activation rules also.\n\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 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 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"],"names":["sortGuides","guides","a","b","guidesApiRootPath","userId","KnockGuideClient","knock","channelId","targetParams","__publicField","Store","maybeSocket","opts","queryParams","queryKey","maybeQueryStatus","state","queryStatus","data","g","e","params","newChannel","eventType","payload","event","filters","guide","step","updatedStep","metadata","ts","remoteGuide","self","localGuide","message","rest","localStep","filterParams","combinedParams","_k","v","queryStr","key","basePath","guideKey","stepRef","attrs","steps","replaced"],"mappings":";;;;AAMA,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;AAkId,MAAMC,EAAiB;AAAA,EAS5B,YACWC,GACAC,GACAC,IAA6B,CAAA,GACtC;AAZK,IAAAC,EAAA;AAGC;AAAA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA,0BAAmB,CAAC,eAAe,iBAAiB,eAAe;AAGhE,SAAA,QAAAH,GACA,KAAA,YAAAC,GACA,KAAA,eAAAC,GAEJ,KAAA,QAAQ,IAAIE,EAAkB;AAAA,MACjC,QAAQ,CAAC;AAAA,MACT,SAAS,CAAA;AAAA,IAAC,CACX;AAGD,UAAM,EAAE,QAAQC,EAAA,IAAgB,KAAK,MAAM,OAAO;AAClD,SAAK,SAASA,GACT,KAAA,qBAAqB,UAAUJ,CAAS,IAExC,KAAA,MAAM,IAAI,oCAAoC;AAAA,EAAA;AAAA,EAGrD,MAAM,MAAMK,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,CAACC,OAAW;AAAA,MAC9B,GAAGA;AAAA,MACH,SAAS,EAAE,GAAGA,EAAM,SAAS,CAACF,CAAQ,GAAG,EAAE,QAAQ,UAAY,EAAA;AAAA,IAAA,EAC/D;AAEE,QAAAG;AACA,QAAA;AACI,YAAAC,IAAO,MAAM,KAAK,MAAM,KAAK,UAGjC,KAAK,WAAWL,CAAW;AACf,MAAAI,IAAA,EAAE,QAAQ,KAAK,GAExB,KAAA,MAAM,SAAS,CAACD,OAAW;AAAA,QAC9B,GAAGA;AAAA;AAAA;AAAA;AAAA,QAIH,QAAQE,EAAK,QAAQ,IAAI,CAACC,MAAM,KAAK,UAAUA,CAAC,CAAC;AAAA,QACjD,SAAS,EAAE,GAAGH,EAAM,SAAS,CAACF,CAAQ,GAAGG,EAAY;AAAA,MAAA,EACrD;AAAA,aACKG,GAAG;AACV,MAAAH,IAAc,EAAE,QAAQ,SAAS,OAAOG,EAAW,GAE9C,KAAA,MAAM,SAAS,CAACJ,OAAW;AAAA,QAC9B,GAAGA;AAAA,QACH,SAAS,EAAE,GAAGA,EAAM,SAAS,CAACF,CAAQ,GAAGG,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,OAAOR,GAAmBU,IAA8B,IAAI;AAG1D,WAAOV,EAAM,OAAO,OAAO,CAACW,MACtB,EAAAD,EAAQ,QAAQA,EAAQ,SAASC,EAAM,QAIvCD,EAAQ,OAAOA,EAAQ,QAAQC,EAAM,IAK1C;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUH,MAAM,WAAWA,GAAkBC,GAAqB;AACtD,SAAK,MAAM;AAAA,MACT,uCAAuCD,EAAM,GAAG,cAAcC,EAAK,GAAG;AAAA,IACxE;AAEA,UAAMC,IAAc,KAAK,oBAAoBF,EAAM,KAAKC,EAAK,KAAK;AAAA,MAChE,UAAS,oBAAI,KAAK,GAAE,YAAY;AAAA,IAAA,CACjC;AACD,QAAI,CAACC,EAAa;AAElB,UAAMR,IAAS;AAAA,MACb,GAAG,KAAK,+BAA+BM,GAAOE,CAAW;AAAA,MACzD,SAASA,EAAY;AAAA,MACrB,MAAM,KAAK,aAAa;AAAA,MACxB,QAAQ,KAAK,aAAa;AAAA,IAC5B;AAEA,gBAAK,MAAM,KAAK;AAAA,MACd;AAAA,MACAR;AAAA,IACF,GAEOQ;AAAA,EAAA;AAAA,EAGT,MAAM,iBACJF,GACAC,GACAE,GACA;AACA,SAAK,MAAM;AAAA,MACT,6CAA6CH,EAAM,GAAG,cAAcC,EAAK,GAAG;AAAA,IAC9E;AAEA,UAAMG,KAAK,oBAAI,KAAK,GAAE,YAAY,GAC5BF,IAAc,KAAK,oBAAoBF,EAAM,KAAKC,EAAK,KAAK;AAAA,MAChE,SAASG;AAAA,MACT,eAAeA;AAAA,IAAA,CAChB;AACD,QAAI,CAACF,EAAa;AAElB,UAAMR,IAAS;AAAA,MACb,GAAG,KAAK,+BAA+BM,GAAOE,CAAW;AAAA,MACzD,UAAAC;AAAA,IACF;AAEA,gBAAK,MAAM,KAAK,gBAGd,cAAcT,CAAM,GAEfQ;AAAA,EAAA;AAAA,EAGT,MAAM,eAAeF,GAAkBC,GAAqB;AAC1D,SAAK,MAAM;AAAA,MACT,2CAA2CD,EAAM,GAAG,cAAcC,EAAK,GAAG;AAAA,IAC5E;AAEA,UAAMC,IAAc,KAAK,oBAAoBF,EAAM,KAAKC,EAAK,KAAK;AAAA,MAChE,cAAa,oBAAI,KAAK,GAAE,YAAY;AAAA,IAAA,CACrC;AACD,QAAI,CAACC,EAAa;AAElB,UAAMR,IAAS,KAAK,+BAA+BM,GAAOE,CAAW;AAErE,gBAAK,MAAM,KAAK;AAAA,MACd;AAAA,MACAR;AAAA,IACF,GAEOQ;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,GAEMH;AAAA,EAAA;AAAA,EAGD,iBAAiBI,IAAkC,IAAI;AAE7D,UAAMC,IAAiB,EAAE,GAAG,KAAK,cAAc,GAAGD,EAAa;AAG/D,QAAIjB,IAAS,OAAO;AAAA,MAClB,OAAO,QAAQkB,CAAc,EAAE;AAAA,QAC7B,CAAC,CAACC,GAAIC,CAAC,MAAyBA,KAAM;AAAA,MAAA;AAAA,IAE1C;AAGS,WAAApB,IAAAA,EAAO,OACZ,EAAE,GAAGA,GAAQ,MAAM,KAAK,UAAUA,EAAO,IAAI,EAC7C,IAAAA,GAEGA;AAAA,EAAA;AAAA,EAGD,eAAeR,GAA0B;AAG/C,UAAM6B,IAFa,OAAO,KAAK7B,CAAW,EAAE,KAAK,EAG9C;AAAA,MACC,CAAC8B,MACC,GAAG,mBAAmBA,CAAG,CAAC,IAAI,mBAAmB9B,EAAY8B,CAAG,CAAC,CAAC;AAAA,IAAA,EAErE,KAAK,GAAG,GAELC,IAAWzC,EAAkB,KAAK,MAAM,MAAM;AACpD,WAAOuC,IAAW,GAAGE,CAAQ,IAAIF,CAAQ,KAAKE;AAAA,EAAA;AAAA,EAGxC,oBACNC,GACAC,GACAC,GACA;AACI,QAAAlB;AAEC,gBAAA,MAAM,SAAS,CAACb,MAAU;AAC7B,YAAMhB,IAASgB,EAAM,OAAO,IAAI,CAACW,MAAU;AACrC,YAAAA,EAAM,QAAQkB,EAAiB,QAAAlB;AAEnC,cAAMqB,IAAQrB,EAAM,MAAM,IAAI,CAACC,OACzBA,EAAK,QAAQkB,MAIjBlB,EAAK,UAAU,EAAE,GAAGA,EAAK,SAAS,GAAGmB,EAAM,GAC7BlB,IAAAD,IAEPA,EACR;AACM,eAAA,EAAE,GAAGD,GAAO,OAAAqB,EAAM;AAAA,MAAA,CAC1B;AACM,aAAA,EAAE,GAAGhC,GAAO,QAAAhB,EAAO;AAAA,IAAA,CAC3B,GAEM6B;AAAA,EAAA;AAAA,EAGD,+BACNF,GACAC,GACA;AACO,WAAA;AAAA,MACL,YAAYA,EAAK,QAAQ;AAAA,MACzB,YAAYD,EAAM;AAAA,MAClB,WAAWA,EAAM;AAAA,MACjB,UAAUA,EAAM;AAAA,MAChB,gBAAgBC,EAAK;AAAA,IACvB;AAAA,EAAA;AAAA,EAGM,SAAS,EAAE,MAAAV,KAAyB;AAC1C,UAAMS,IAAQ,KAAK,UAAUT,EAAK,KAAK;AAElC,SAAA,MAAM,SAAS,CAACF,OACZ,EAAE,GAAGA,GAAO,QAAQjB,EAAW,CAAC,GAAGiB,EAAM,QAAQW,CAAK,CAAC,EAAE,EACjE;AAAA,EAAA;AAAA,EAGK,kBAAkB,EAAE,MAAAT,KAA2B;AACrD,UAAMS,IAAQ,KAAK,UAAUT,EAAK,KAAK;AAElC,SAAA,MAAM,SAAS,CAACF,MAAU;AAC7B,UAAIiC,IAAW;AAEf,YAAMjD,IAASgB,EAAM,OAAO,IAAI,CAACG,MAC3BA,EAAE,QAAQQ,EAAM,MAAYR,KACrB8B,IAAA,IACJtB,EACR;AAEM,aAAA;AAAA,QACL,GAAGX;AAAA,QACH,QAAmBjB,EAAXkD,IAAsBjD,IAAqB,CAAC,GAAGA,GAAQ2B,CAAK,CAAhC;AAAA,MACtC;AAAA,IAAA,CACD;AAAA,EAAA;AAAA,EAGK,YAAY,EAAE,MAAAT,KAA+C;AAC9D,SAAA,MAAM,SAAS,CAACF,MAAU;AACvB,YAAAhB,IAASgB,EAAM,OAAO,OAAO,CAACG,MAAMA,EAAE,QAAQD,EAAK,MAAM,GAAG;AAC3D,aAAA,EAAE,GAAGF,GAAO,QAAAhB,EAAO;AAAA,IAAA,CAC3B;AAAA,EAAA;AAEL;"}
@@ -1,8 +1,9 @@
1
- var c = Object.defineProperty;
2
- var h = (s, e, t) => e in s ? c(s, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : s[e] = t;
3
- var a = (s, e, t) => h(s, typeof e != "symbol" ? e + "" : e, t);
4
- const i = "default";
5
- class l {
1
+ var h = Object.defineProperty;
2
+ var u = (n, e, t) => e in n ? h(n, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : n[e] = t;
3
+ var a = (n, e, t) => u(n, typeof e != "symbol" ? e + "" : e, t);
4
+ import { guidesApiRootPath as i } from "../guide/client.mjs";
5
+ const r = "default";
6
+ class o {
6
7
  constructor(e) {
7
8
  a(this, "instance");
8
9
  this.instance = e;
@@ -34,21 +35,21 @@ class l {
34
35
  }
35
36
  async getPreferences(e = {}) {
36
37
  this.instance.failIfNotAuthenticated();
37
- const t = e.preferenceSet || i, n = await this.instance.client().makeRequest({
38
+ const t = e.preferenceSet || r, s = await this.instance.client().makeRequest({
38
39
  method: "GET",
39
40
  url: `/v1/users/${this.instance.userId}/preferences/${t}`,
40
41
  params: { tenant: e.tenant }
41
42
  });
42
- return this.handleResponse(n);
43
+ return this.handleResponse(s);
43
44
  }
44
45
  async setPreferences(e, t = {}) {
45
46
  this.instance.failIfNotAuthenticated();
46
- const n = t.preferenceSet || i, r = await this.instance.client().makeRequest({
47
+ const s = t.preferenceSet || r, c = await this.instance.client().makeRequest({
47
48
  method: "PUT",
48
- url: `/v1/users/${this.instance.userId}/preferences/${n}`,
49
+ url: `/v1/users/${this.instance.userId}/preferences/${s}`,
49
50
  data: e
50
51
  });
51
- return this.handleResponse(r);
52
+ return this.handleResponse(c);
52
53
  }
53
54
  async getChannelData(e) {
54
55
  this.instance.failIfNotAuthenticated();
@@ -63,12 +64,28 @@ class l {
63
64
  channelData: t
64
65
  }) {
65
66
  this.instance.failIfNotAuthenticated();
66
- const n = await this.instance.client().makeRequest({
67
+ const s = await this.instance.client().makeRequest({
67
68
  method: "PUT",
68
69
  url: `/v1/users/${this.instance.userId}/channel_data/${e}`,
69
70
  data: { data: t }
70
71
  });
71
- return this.handleResponse(n);
72
+ return this.handleResponse(s);
73
+ }
74
+ async getGuides(e, t) {
75
+ const s = await this.instance.client().makeRequest({
76
+ method: "GET",
77
+ url: `${i(this.instance.userId)}/${e}`,
78
+ params: t
79
+ });
80
+ return this.handleResponse(s);
81
+ }
82
+ async markGuideStepAs(e, t) {
83
+ const s = await this.instance.client().makeRequest({
84
+ method: "PUT",
85
+ url: `${i(this.instance.userId)}/messages/${t.message_id}/${e}`,
86
+ data: t
87
+ });
88
+ return this.handleResponse(s);
72
89
  }
73
90
  handleResponse(e) {
74
91
  if (e.statusCode === "error")
@@ -77,6 +94,6 @@ class l {
77
94
  }
78
95
  }
79
96
  export {
80
- l as default
97
+ o as default
81
98
  };
82
99
  //# sourceMappingURL=index.mjs.map
@@ -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 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 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","response"],"mappings":";;;AAcA,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,EAG3C,eAAkBQ,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 {\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,14 +1,16 @@
1
1
  import { default as f } from "./clients/feed/index.mjs";
2
2
  import t from "./knock.mjs";
3
- import { TENANT_OBJECT_COLLECTION as m } from "./clients/objects/constants.mjs";
4
- import { NetworkStatus as s, isRequestInFlight as d } from "./networkStatus.mjs";
5
- import { default as u } from "./clients/feed/feed.mjs";
3
+ import { KnockGuideClient as m } from "./clients/guide/client.mjs";
4
+ import { TENANT_OBJECT_COLLECTION as d } from "./clients/objects/constants.mjs";
5
+ import { NetworkStatus as l, isRequestInFlight as s } from "./networkStatus.mjs";
6
+ import { default as x } from "./clients/feed/feed.mjs";
6
7
  export {
7
- u as Feed,
8
+ x as Feed,
8
9
  f as FeedClient,
9
- s as NetworkStatus,
10
- m as TENANT_OBJECT_COLLECTION,
10
+ m as KnockGuideClient,
11
+ l as NetworkStatus,
12
+ d as TENANT_OBJECT_COLLECTION,
11
13
  t as default,
12
- d as isRequestInFlight
14
+ s as isRequestInFlight
13
15
  };
14
16
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}
1
+ {"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;"}