@knocklabs/client 0.11.0-rc.0 → 0.11.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 (105) hide show
  1. package/CHANGELOG.md +26 -4
  2. package/dist/cjs/api.js +1 -1
  3. package/dist/cjs/api.js.map +1 -1
  4. package/dist/cjs/clients/feed/feed.js +1 -1
  5. package/dist/cjs/clients/feed/feed.js.map +1 -1
  6. package/dist/cjs/clients/feed/store.js +1 -1
  7. package/dist/cjs/clients/feed/store.js.map +1 -1
  8. package/dist/cjs/clients/ms-teams/index.js +2 -0
  9. package/dist/cjs/clients/ms-teams/index.js.map +1 -0
  10. package/dist/cjs/clients/slack/index.js +1 -1
  11. package/dist/cjs/clients/slack/index.js.map +1 -1
  12. package/dist/cjs/clients/users/index.js +1 -1
  13. package/dist/cjs/clients/users/index.js.map +1 -1
  14. package/dist/cjs/index.js +1 -1
  15. package/dist/cjs/knock.js +1 -5
  16. package/dist/cjs/knock.js.map +1 -1
  17. package/dist/esm/clients/feed/feed.mjs +45 -32
  18. package/dist/esm/clients/feed/feed.mjs.map +1 -1
  19. package/dist/esm/clients/ms-teams/index.mjs +54 -0
  20. package/dist/esm/clients/ms-teams/index.mjs.map +1 -0
  21. package/dist/esm/clients/slack/index.mjs +11 -11
  22. package/dist/esm/clients/slack/index.mjs.map +1 -1
  23. package/dist/esm/clients/users/index.mjs +20 -28
  24. package/dist/esm/clients/users/index.mjs.map +1 -1
  25. package/dist/esm/index.mjs +7 -11
  26. package/dist/esm/index.mjs.map +1 -1
  27. package/dist/esm/knock.mjs +22 -26
  28. package/dist/esm/knock.mjs.map +1 -1
  29. package/dist/types/api.d.ts +0 -1
  30. package/dist/types/clients/feed/feed.d.ts +0 -1
  31. package/dist/types/clients/feed/feed.d.ts.map +1 -1
  32. package/dist/types/clients/feed/index.d.ts +0 -1
  33. package/dist/types/clients/feed/interfaces.d.ts +0 -1
  34. package/dist/types/clients/feed/store.d.ts +0 -1
  35. package/dist/types/clients/feed/types.d.ts +0 -1
  36. package/dist/types/clients/feed/utils.d.ts +0 -1
  37. package/dist/types/clients/messages/index.d.ts +0 -1
  38. package/dist/types/clients/messages/interfaces.d.ts +1 -2
  39. package/dist/types/clients/messages/interfaces.d.ts.map +1 -1
  40. package/dist/types/clients/ms-teams/index.d.ts +11 -0
  41. package/dist/types/clients/ms-teams/index.d.ts.map +1 -0
  42. package/dist/types/clients/objects/index.d.ts +0 -1
  43. package/dist/types/clients/preferences/index.d.ts +0 -1
  44. package/dist/types/clients/preferences/interfaces.d.ts +9 -7
  45. package/dist/types/clients/preferences/interfaces.d.ts.map +1 -1
  46. package/dist/types/clients/slack/index.d.ts +2 -2
  47. package/dist/types/clients/slack/index.d.ts.map +1 -1
  48. package/dist/types/clients/slack/interfaces.d.ts +0 -8
  49. package/dist/types/clients/slack/interfaces.d.ts.map +1 -1
  50. package/dist/types/clients/users/index.d.ts +1 -4
  51. package/dist/types/clients/users/index.d.ts.map +1 -1
  52. package/dist/types/clients/users/interfaces.d.ts +0 -7
  53. package/dist/types/clients/users/interfaces.d.ts.map +1 -1
  54. package/dist/types/index.d.ts +1 -2
  55. package/dist/types/index.d.ts.map +1 -1
  56. package/dist/types/interfaces.d.ts +8 -1
  57. package/dist/types/interfaces.d.ts.map +1 -1
  58. package/dist/types/knock.d.ts +2 -1
  59. package/dist/types/knock.d.ts.map +1 -1
  60. package/package.json +15 -17
  61. package/src/clients/feed/feed.ts +25 -10
  62. package/src/clients/messages/interfaces.ts +9 -1
  63. package/src/clients/ms-teams/index.ts +60 -0
  64. package/src/clients/preferences/interfaces.ts +11 -6
  65. package/src/clients/slack/index.ts +6 -11
  66. package/src/clients/slack/interfaces.ts +0 -10
  67. package/src/clients/users/index.ts +1 -19
  68. package/src/clients/users/interfaces.ts +0 -8
  69. package/src/index.ts +1 -1
  70. package/src/interfaces.ts +10 -0
  71. package/src/knock.ts +2 -10
  72. package/dist/cjs/clients/in-app-messages/channel-client.js +0 -2
  73. package/dist/cjs/clients/in-app-messages/channel-client.js.map +0 -1
  74. package/dist/cjs/clients/in-app-messages/message-client.js +0 -2
  75. package/dist/cjs/clients/in-app-messages/message-client.js.map +0 -1
  76. package/dist/cjs/clients/in-app-messages/socket-manager.js +0 -2
  77. package/dist/cjs/clients/in-app-messages/socket-manager.js.map +0 -1
  78. package/dist/cjs/clients/in-app-messages/store.js +0 -2
  79. package/dist/cjs/clients/in-app-messages/store.js.map +0 -1
  80. package/dist/esm/clients/in-app-messages/channel-client.mjs +0 -80
  81. package/dist/esm/clients/in-app-messages/channel-client.mjs.map +0 -1
  82. package/dist/esm/clients/in-app-messages/message-client.mjs +0 -153
  83. package/dist/esm/clients/in-app-messages/message-client.mjs.map +0 -1
  84. package/dist/esm/clients/in-app-messages/socket-manager.mjs +0 -83
  85. package/dist/esm/clients/in-app-messages/socket-manager.mjs.map +0 -1
  86. package/dist/esm/clients/in-app-messages/store.mjs +0 -11
  87. package/dist/esm/clients/in-app-messages/store.mjs.map +0 -1
  88. package/dist/types/clients/in-app-messages/channel-client.d.ts +0 -23
  89. package/dist/types/clients/in-app-messages/channel-client.d.ts.map +0 -1
  90. package/dist/types/clients/in-app-messages/index.d.ts +0 -4
  91. package/dist/types/clients/in-app-messages/index.d.ts.map +0 -1
  92. package/dist/types/clients/in-app-messages/message-client.d.ts +0 -52
  93. package/dist/types/clients/in-app-messages/message-client.d.ts.map +0 -1
  94. package/dist/types/clients/in-app-messages/socket-manager.d.ts +0 -27
  95. package/dist/types/clients/in-app-messages/socket-manager.d.ts.map +0 -1
  96. package/dist/types/clients/in-app-messages/store.d.ts +0 -6
  97. package/dist/types/clients/in-app-messages/store.d.ts.map +0 -1
  98. package/dist/types/clients/in-app-messages/types.d.ts +0 -52
  99. package/dist/types/clients/in-app-messages/types.d.ts.map +0 -1
  100. package/src/clients/in-app-messages/channel-client.ts +0 -129
  101. package/src/clients/in-app-messages/index.ts +0 -3
  102. package/src/clients/in-app-messages/message-client.ts +0 -271
  103. package/src/clients/in-app-messages/socket-manager.ts +0 -187
  104. package/src/clients/in-app-messages/store.ts +0 -15
  105. package/src/clients/in-app-messages/types.ts +0 -79
@@ -1,153 +0,0 @@
1
- var o = Object.defineProperty;
2
- var l = (a, e, t) => e in a ? o(a, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : a[e] = t;
3
- var r = (a, e, t) => l(a, typeof e != "symbol" ? e + "" : e, t);
4
- import { nanoid as g } from "nanoid";
5
- import { NetworkStatus as i, isRequestInFlight as k } from "../../networkStatus.mjs";
6
- import { SocketEventType as y } from "./socket-manager.mjs";
7
- class w {
8
- constructor(e, t, s = {}) {
9
- r(this, "knock");
10
- r(this, "queryKey");
11
- r(this, "referenceId");
12
- r(this, "unsub");
13
- this.channelClient = e, this.messageType = t, this.defaultOptions = s, this.defaultOptions = {
14
- ...e.defaultOptions,
15
- ...s
16
- }, this.knock = e.knock, this.queryKey = this.buildQueryKey(this.defaultOptions), this.referenceId = g(), this.knock.log(`[IAM] Initialized a client for message ${t}`);
17
- }
18
- // ----------------------------------------------
19
- // Data fetching
20
- // ----------------------------------------------
21
- async fetch() {
22
- const e = this.defaultOptions;
23
- this.queryKey = this.buildQueryKey(e);
24
- const s = (this.channelClient.store.state.queries[this.queryKey] ?? {
25
- loading: !1,
26
- networkStatus: i.ready
27
- }).networkStatus;
28
- if (!(s && k(s))) {
29
- this.channelClient.setQueryStatus(this.queryKey, {
30
- networkStatus: i.loading,
31
- loading: !0
32
- });
33
- try {
34
- const n = await this.knock.user.getInAppMessages({
35
- channelId: this.channelClient.channelId,
36
- messageType: this.messageType,
37
- params: e
38
- });
39
- return this.channelClient.setQueryResponse(this.queryKey, n), { data: n, status: "ok" };
40
- } catch (n) {
41
- return this.channelClient.setQueryStatus(this.queryKey, {
42
- networkStatus: i.error,
43
- loading: !1
44
- }), {
45
- status: "error",
46
- error: n
47
- };
48
- }
49
- }
50
- }
51
- getQueryInfoSelector(e) {
52
- var h;
53
- const t = e.queries[this.queryKey];
54
- return {
55
- messages: (((h = t == null ? void 0 : t.data) == null ? void 0 : h.messageIds) ?? []).reduce(
56
- (c, d) => {
57
- const u = e.messages[d];
58
- return u && c.push(u), c;
59
- },
60
- []
61
- ),
62
- networkStatus: (t == null ? void 0 : t.networkStatus) ?? i.ready,
63
- loading: (t == null ? void 0 : t.loading) ?? !1
64
- };
65
- }
66
- // ----------------------------------------------
67
- // Message engagement
68
- // ----------------------------------------------
69
- async markAsSeen(e) {
70
- const t = this.getItemIds(e);
71
- return this.channelClient.setMessageAttrs(t, {
72
- seen_at: (/* @__PURE__ */ new Date()).toISOString()
73
- }), this.makeStatusUpdate(e, "seen");
74
- }
75
- async markAsUnseen(e) {
76
- const t = this.getItemIds(e);
77
- return this.channelClient.setMessageAttrs(t, {
78
- seen_at: null
79
- }), this.makeStatusUpdate(e, "unseen");
80
- }
81
- async markAsRead(e) {
82
- const t = this.getItemIds(e);
83
- return this.channelClient.setMessageAttrs(t, {
84
- read_at: (/* @__PURE__ */ new Date()).toISOString()
85
- }), this.makeStatusUpdate(e, "read");
86
- }
87
- async markAsUnread(e) {
88
- const t = this.getItemIds(e);
89
- return this.channelClient.setMessageAttrs(t, {
90
- read_at: null
91
- }), this.makeStatusUpdate(e, "unread");
92
- }
93
- async markAsInteracted(e, t) {
94
- const s = (/* @__PURE__ */ new Date()).toISOString(), n = this.getItemIds(e);
95
- return this.channelClient.setMessageAttrs(n, {
96
- read_at: s,
97
- interacted_at: s
98
- }), this.makeStatusUpdate(e, "interacted", t);
99
- }
100
- async markAsArchived(e) {
101
- const t = this.getItemIds(e);
102
- return this.channelClient.setMessageAttrs(t, {
103
- archived_at: (/* @__PURE__ */ new Date()).toISOString()
104
- }), this.makeStatusUpdate(e, "archived");
105
- }
106
- async markAsUnarchived(e) {
107
- const t = this.getItemIds(e);
108
- return this.channelClient.setMessageAttrs(t, {
109
- archived_at: null
110
- }), this.makeStatusUpdate(e, "unarchived");
111
- }
112
- async makeStatusUpdate(e, t, s) {
113
- const n = this.getItemIds(e);
114
- return await this.knock.messages.batchUpdateStatuses(
115
- n,
116
- t,
117
- { metadata: s }
118
- );
119
- }
120
- // ----------------------------------------------
121
- // Helpers
122
- // ----------------------------------------------
123
- buildQueryKey(e) {
124
- const t = `/v1/users/${this.knock.userId}/in-app-messages/${this.channelClient.channelId}/${this.messageType}`, s = new URLSearchParams(e).toString();
125
- return s ? `${t}?${s}` : t;
126
- }
127
- subscribe() {
128
- this.unsub = this.channelClient.subscribe(this);
129
- }
130
- unsubscribe() {
131
- this.channelClient.unsubscribe(this);
132
- }
133
- // This is a callback function that will be invoked when a new socket event
134
- // relevant for this message client is received (and if subscribed).
135
- async handleSocketEvent(e) {
136
- switch (e.event) {
137
- case y.MessageCreated:
138
- return await this.fetch();
139
- default:
140
- throw new Error(`Unhandled socket event: ${e.event}`);
141
- }
142
- }
143
- socketChannelTopic() {
144
- return `in_app:${this.messageType}:${this.channelClient.channelId}:${this.knock.userId}`;
145
- }
146
- getItemIds(e) {
147
- return (Array.isArray(e) ? e : [e]).map((s) => s.id);
148
- }
149
- }
150
- export {
151
- w as InAppMessagesClient
152
- };
153
- //# sourceMappingURL=message-client.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"message-client.mjs","sources":["../../../../src/clients/in-app-messages/message-client.ts"],"sourcesContent":["import { GenericData } from \"@knocklabs/types\";\nimport { nanoid } from \"nanoid\";\n\nimport Knock from \"../../knock\";\nimport { NetworkStatus, isRequestInFlight } from \"../../networkStatus\";\nimport { MessageEngagementStatus } from \"../messages/interfaces\";\n\nimport { InAppMessagesChannelClient } from \"./channel-client\";\nimport { SocketEventPayload, SocketEventType } from \"./socket-manager\";\nimport {\n InAppMessage,\n InAppMessagesClientOptions,\n InAppMessagesResponse,\n InAppMessagesStoreState,\n} from \"./types\";\n\n/**\n * Manages realtime connection to in app messages service.\n */\nexport class InAppMessagesClient {\n private knock: Knock;\n\n public queryKey: string;\n public referenceId: string;\n public unsub?: () => void;\n\n constructor(\n readonly channelClient: InAppMessagesChannelClient,\n readonly messageType: string,\n readonly defaultOptions: InAppMessagesClientOptions = {},\n ) {\n this.defaultOptions = {\n ...channelClient.defaultOptions,\n ...defaultOptions,\n };\n this.knock = channelClient.knock;\n this.queryKey = this.buildQueryKey(this.defaultOptions);\n this.referenceId = nanoid();\n\n this.knock.log(`[IAM] Initialized a client for message ${messageType}`);\n }\n\n // ----------------------------------------------\n // Data fetching\n // ----------------------------------------------\n async fetch<\n TContent extends GenericData = GenericData,\n TData extends GenericData = GenericData,\n >(): Promise<\n | {\n status: \"ok\";\n data: InAppMessagesResponse<TContent, TData>;\n }\n | {\n status: \"error\";\n error: Error;\n }\n | undefined\n > {\n const params = this.defaultOptions;\n\n this.queryKey = this.buildQueryKey(params);\n\n const queryState = this.channelClient.store.state.queries[\n this.queryKey\n ] ?? {\n loading: false,\n networkStatus: NetworkStatus.ready,\n };\n const networkStatus = queryState.networkStatus;\n\n // If there's an existing request in flight, then do nothing\n if (networkStatus && isRequestInFlight(networkStatus)) {\n return;\n }\n\n // Set the loading type based on the request type it is\n this.channelClient.setQueryStatus(this.queryKey, {\n networkStatus: NetworkStatus.loading,\n loading: true,\n });\n\n try {\n const response = await this.knock.user.getInAppMessages<TContent, TData>({\n channelId: this.channelClient.channelId,\n messageType: this.messageType,\n params,\n });\n\n this.channelClient.setQueryResponse(this.queryKey, response);\n\n return { data: response, status: \"ok\" };\n } catch (error) {\n this.channelClient.setQueryStatus(this.queryKey, {\n networkStatus: NetworkStatus.error,\n loading: false,\n });\n\n return {\n status: \"error\",\n error: error as Error,\n };\n }\n }\n\n getQueryInfoSelector<\n TContent extends GenericData = GenericData,\n TData extends GenericData = GenericData,\n >(\n state: InAppMessagesStoreState,\n ): {\n messages: InAppMessage<TContent, TData>[];\n loading: boolean;\n networkStatus: NetworkStatus;\n } {\n const queryInfo = state.queries[this.queryKey];\n const messageIds = queryInfo?.data?.messageIds ?? [];\n\n const messages = messageIds.reduce<InAppMessage<TContent, TData>[]>(\n (messages, messageId) => {\n const message = state.messages[messageId];\n if (message) {\n messages.push(message as InAppMessage<TContent, TData>);\n }\n return messages;\n },\n [],\n );\n\n return {\n messages,\n networkStatus: queryInfo?.networkStatus ?? NetworkStatus.ready,\n loading: queryInfo?.loading ?? false,\n };\n }\n\n // ----------------------------------------------\n // Message engagement\n // ----------------------------------------------\n async markAsSeen(itemOrItems: InAppMessage | InAppMessage[]) {\n const itemIds = this.getItemIds(itemOrItems);\n\n this.channelClient.setMessageAttrs(itemIds, {\n seen_at: new Date().toISOString(),\n });\n\n return this.makeStatusUpdate(itemOrItems, \"seen\");\n }\n\n async markAsUnseen(itemOrItems: InAppMessage | InAppMessage[]) {\n const itemIds = this.getItemIds(itemOrItems);\n\n this.channelClient.setMessageAttrs(itemIds, {\n seen_at: null,\n });\n\n return this.makeStatusUpdate(itemOrItems, \"unseen\");\n }\n\n async markAsRead(itemOrItems: InAppMessage | InAppMessage[]) {\n const itemIds = this.getItemIds(itemOrItems);\n\n this.channelClient.setMessageAttrs(itemIds, {\n read_at: new Date().toISOString(),\n });\n\n return this.makeStatusUpdate(itemOrItems, \"read\");\n }\n\n async markAsUnread(itemOrItems: InAppMessage | InAppMessage[]) {\n const itemIds = this.getItemIds(itemOrItems);\n\n this.channelClient.setMessageAttrs(itemIds, {\n read_at: null,\n });\n\n return this.makeStatusUpdate(itemOrItems, \"unread\");\n }\n\n async markAsInteracted(\n itemOrItems: InAppMessage | InAppMessage[],\n metadata?: Record<string, string>,\n ) {\n const now = new Date().toISOString();\n const itemIds = this.getItemIds(itemOrItems);\n\n this.channelClient.setMessageAttrs(itemIds, {\n read_at: now,\n interacted_at: now,\n });\n\n return this.makeStatusUpdate(itemOrItems, \"interacted\", metadata);\n }\n\n async markAsArchived(itemOrItems: InAppMessage | InAppMessage[]) {\n const itemIds = this.getItemIds(itemOrItems);\n\n this.channelClient.setMessageAttrs(itemIds, {\n archived_at: new Date().toISOString(),\n });\n\n return this.makeStatusUpdate(itemOrItems, \"archived\");\n }\n\n async markAsUnarchived(itemOrItems: InAppMessage | InAppMessage[]) {\n const itemIds = this.getItemIds(itemOrItems);\n\n this.channelClient.setMessageAttrs(itemIds, {\n archived_at: null,\n });\n\n return this.makeStatusUpdate(itemOrItems, \"unarchived\");\n }\n\n private async makeStatusUpdate(\n itemOrItems: InAppMessage | InAppMessage[],\n type: MessageEngagementStatus | \"unread\" | \"unseen\" | \"unarchived\",\n metadata?: Record<string, string>,\n ) {\n // Always treat items as a batch to use the corresponding batch endpoint\n const itemIds = this.getItemIds(itemOrItems);\n\n const result = await this.knock.messages.batchUpdateStatuses(\n itemIds,\n type,\n { metadata },\n );\n\n return result;\n }\n\n // ----------------------------------------------\n // Helpers\n // ----------------------------------------------\n private buildQueryKey(params: GenericData): string {\n const baseKey = `/v1/users/${this.knock.userId}/in-app-messages/${this.channelClient.channelId}/${this.messageType}`;\n const paramsString = new URLSearchParams(params).toString();\n return paramsString ? `${baseKey}?${paramsString}` : baseKey;\n }\n\n subscribe() {\n this.unsub = this.channelClient.subscribe(this);\n }\n\n unsubscribe() {\n this.channelClient.unsubscribe(this);\n }\n\n // This is a callback function that will be invoked when a new socket event\n // relevant for this message client is received (and if subscribed).\n async handleSocketEvent(payload: SocketEventPayload) {\n switch (payload.event) {\n case SocketEventType.MessageCreated:\n // TODO(KNO-7169): Explore using an in-app message in the socket event\n // directly instead of re-fetching.\n return await this.fetch();\n\n default:\n throw new Error(`Unhandled socket event: ${payload.event}`);\n }\n }\n\n socketChannelTopic() {\n return `in_app:${this.messageType}:${this.channelClient.channelId}:${this.knock.userId}`;\n }\n\n private getItemIds(itemOrItems: InAppMessage | InAppMessage[]): string[] {\n const items = Array.isArray(itemOrItems) ? itemOrItems : [itemOrItems];\n return items.map((item) => item.id);\n }\n}\n"],"names":["InAppMessagesClient","channelClient","messageType","defaultOptions","__publicField","nanoid","params","networkStatus","NetworkStatus","isRequestInFlight","response","error","state","queryInfo","_a","messages","messageId","message","itemOrItems","itemIds","metadata","now","type","baseKey","paramsString","payload","SocketEventType","item"],"mappings":";;;;;;AAmBO,MAAMA,EAAoB;AAAA,EAO/B,YACWC,GACAC,GACAC,IAA6C,CAAA,GACtD;AAVM,IAAAC,EAAA;AAED,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AAGI,SAAA,gBAAAH,GACA,KAAA,cAAAC,GACA,KAAA,iBAAAC,GAET,KAAK,iBAAiB;AAAA,MACpB,GAAGF,EAAc;AAAA,MACjB,GAAGE;AAAA,IAAA,GAEL,KAAK,QAAQF,EAAc,OAC3B,KAAK,WAAW,KAAK,cAAc,KAAK,cAAc,GACtD,KAAK,cAAcI,KAEnB,KAAK,MAAM,IAAI,0CAA0CH,CAAW,EAAE;AAAA,EACxE;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,QAaJ;AACA,UAAMI,IAAS,KAAK;AAEf,SAAA,WAAW,KAAK,cAAcA,CAAM;AAQzC,UAAMC,KANa,KAAK,cAAc,MAAM,MAAM,QAChD,KAAK,QACP,KAAK;AAAA,MACH,SAAS;AAAA,MACT,eAAeC,EAAc;AAAA,IAAA,GAEE;AAG7B,QAAA,EAAAD,KAAiBE,EAAkBF,CAAa,IAK/C;AAAA,WAAA,cAAc,eAAe,KAAK,UAAU;AAAA,QAC/C,eAAeC,EAAc;AAAA,QAC7B,SAAS;AAAA,MAAA,CACV;AAEG,UAAA;AACF,cAAME,IAAW,MAAM,KAAK,MAAM,KAAK,iBAAkC;AAAA,UACvE,WAAW,KAAK,cAAc;AAAA,UAC9B,aAAa,KAAK;AAAA,UAClB,QAAAJ;AAAA,QAAA,CACD;AAED,oBAAK,cAAc,iBAAiB,KAAK,UAAUI,CAAQ,GAEpD,EAAE,MAAMA,GAAU,QAAQ,KAAK;AAAA,eAC/BC,GAAO;AACT,oBAAA,cAAc,eAAe,KAAK,UAAU;AAAA,UAC/C,eAAeH,EAAc;AAAA,UAC7B,SAAS;AAAA,QAAA,CACV,GAEM;AAAA,UACL,QAAQ;AAAA,UACR,OAAAG;AAAA,QAAA;AAAA,MAEJ;AAAA;AAAA,EACF;AAAA,EAEA,qBAIEC,GAKA;;AACA,UAAMC,IAAYD,EAAM,QAAQ,KAAK,QAAQ;AActC,WAAA;AAAA,MACL,aAdiBE,IAAAD,KAAA,gBAAAA,EAAW,SAAX,gBAAAC,EAAiB,eAAc,CAAA,GAEtB;AAAA,QAC1B,CAACC,GAAUC,MAAc;AACjB,gBAAAC,IAAUL,EAAM,SAASI,CAAS;AACxC,iBAAIC,KACFF,EAAS,KAAKE,CAAwC,GAEjDF;AAAAA,QACT;AAAA,QACA,CAAC;AAAA,MAAA;AAAA,MAKD,gBAAeF,KAAA,gBAAAA,EAAW,kBAAiBL,EAAc;AAAA,MACzD,UAASK,KAAA,gBAAAA,EAAW,YAAW;AAAA,IAAA;AAAA,EAEnC;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,WAAWK,GAA4C;AACrD,UAAAC,IAAU,KAAK,WAAWD,CAAW;AAEtC,gBAAA,cAAc,gBAAgBC,GAAS;AAAA,MAC1C,UAAS,oBAAI,KAAK,GAAE,YAAY;AAAA,IAAA,CACjC,GAEM,KAAK,iBAAiBD,GAAa,MAAM;AAAA,EAClD;AAAA,EAEA,MAAM,aAAaA,GAA4C;AACvD,UAAAC,IAAU,KAAK,WAAWD,CAAW;AAEtC,gBAAA,cAAc,gBAAgBC,GAAS;AAAA,MAC1C,SAAS;AAAA,IAAA,CACV,GAEM,KAAK,iBAAiBD,GAAa,QAAQ;AAAA,EACpD;AAAA,EAEA,MAAM,WAAWA,GAA4C;AACrD,UAAAC,IAAU,KAAK,WAAWD,CAAW;AAEtC,gBAAA,cAAc,gBAAgBC,GAAS;AAAA,MAC1C,UAAS,oBAAI,KAAK,GAAE,YAAY;AAAA,IAAA,CACjC,GAEM,KAAK,iBAAiBD,GAAa,MAAM;AAAA,EAClD;AAAA,EAEA,MAAM,aAAaA,GAA4C;AACvD,UAAAC,IAAU,KAAK,WAAWD,CAAW;AAEtC,gBAAA,cAAc,gBAAgBC,GAAS;AAAA,MAC1C,SAAS;AAAA,IAAA,CACV,GAEM,KAAK,iBAAiBD,GAAa,QAAQ;AAAA,EACpD;AAAA,EAEA,MAAM,iBACJA,GACAE,GACA;AACA,UAAMC,KAAM,oBAAI,KAAK,GAAE,YAAY,GAC7BF,IAAU,KAAK,WAAWD,CAAW;AAEtC,gBAAA,cAAc,gBAAgBC,GAAS;AAAA,MAC1C,SAASE;AAAA,MACT,eAAeA;AAAA,IAAA,CAChB,GAEM,KAAK,iBAAiBH,GAAa,cAAcE,CAAQ;AAAA,EAClE;AAAA,EAEA,MAAM,eAAeF,GAA4C;AACzD,UAAAC,IAAU,KAAK,WAAWD,CAAW;AAEtC,gBAAA,cAAc,gBAAgBC,GAAS;AAAA,MAC1C,cAAa,oBAAI,KAAK,GAAE,YAAY;AAAA,IAAA,CACrC,GAEM,KAAK,iBAAiBD,GAAa,UAAU;AAAA,EACtD;AAAA,EAEA,MAAM,iBAAiBA,GAA4C;AAC3D,UAAAC,IAAU,KAAK,WAAWD,CAAW;AAEtC,gBAAA,cAAc,gBAAgBC,GAAS;AAAA,MAC1C,aAAa;AAAA,IAAA,CACd,GAEM,KAAK,iBAAiBD,GAAa,YAAY;AAAA,EACxD;AAAA,EAEA,MAAc,iBACZA,GACAI,GACAF,GACA;AAEM,UAAAD,IAAU,KAAK,WAAWD,CAAW;AAQpC,WANQ,MAAM,KAAK,MAAM,SAAS;AAAA,MACvCC;AAAA,MACAG;AAAA,MACA,EAAE,UAAAF,EAAS;AAAA,IAAA;AAAA,EAIf;AAAA;AAAA;AAAA;AAAA,EAKQ,cAAcd,GAA6B;AAC3C,UAAAiB,IAAU,aAAa,KAAK,MAAM,MAAM,oBAAoB,KAAK,cAAc,SAAS,IAAI,KAAK,WAAW,IAC5GC,IAAe,IAAI,gBAAgBlB,CAAM,EAAE,SAAS;AAC1D,WAAOkB,IAAe,GAAGD,CAAO,IAAIC,CAAY,KAAKD;AAAA,EACvD;AAAA,EAEA,YAAY;AACV,SAAK,QAAQ,KAAK,cAAc,UAAU,IAAI;AAAA,EAChD;AAAA,EAEA,cAAc;AACP,SAAA,cAAc,YAAY,IAAI;AAAA,EACrC;AAAA;AAAA;AAAA,EAIA,MAAM,kBAAkBE,GAA6B;AACnD,YAAQA,EAAQ,OAAO;AAAA,MACrB,KAAKC,EAAgB;AAGZ,eAAA,MAAM,KAAK;MAEpB;AACE,cAAM,IAAI,MAAM,2BAA2BD,EAAQ,KAAK,EAAE;AAAA,IAC9D;AAAA,EACF;AAAA,EAEA,qBAAqB;AACZ,WAAA,UAAU,KAAK,WAAW,IAAI,KAAK,cAAc,SAAS,IAAI,KAAK,MAAM,MAAM;AAAA,EACxF;AAAA,EAEQ,WAAWP,GAAsD;AAEvE,YADc,MAAM,QAAQA,CAAW,IAAIA,IAAc,CAACA,CAAW,GACxD,IAAI,CAACS,MAASA,EAAK,EAAE;AAAA,EACpC;AACF;"}
@@ -1,83 +0,0 @@
1
- var u = Object.defineProperty;
2
- var m = (t, e, s) => e in t ? u(t, e, { enumerable: !0, configurable: !0, writable: !0, value: s }) : t[e] = s;
3
- var h = (t, e, s) => m(t, typeof e != "symbol" ? e + "" : e, s);
4
- import { Store as b } from "@tanstack/store";
5
- var k = /* @__PURE__ */ ((t) => (t.MessageCreated = "message.created", t))(k || {});
6
- const f = [
7
- "message.created"
8
- /* MessageCreated */
9
- ];
10
- class x {
11
- constructor(e) {
12
- // Mapping of live channels by topic. Note, there can be one or more in-app
13
- // message client(s) that can subscribe.
14
- h(this, "channels");
15
- // Mapping of query params for each in-app message client, partitioned by its
16
- // reference id, and grouped by channel topic. It's a double nested object
17
- // that looks like:
18
- // {
19
- // "in_app:card:...": {
20
- // "ref-1": {
21
- // "workflow_key": "foo",
22
- // },
23
- // "ref-2": {
24
- // "workflow_key": "bar",
25
- // },
26
- // },
27
- // "in_app:banner:...": {
28
- // "ref-3": {
29
- // "workflow_key": "baz",
30
- // },
31
- // }
32
- // }
33
- //
34
- // Each time a new in-app message client joins a channel, we send all cumulated
35
- // params such that the socket API can apply filtering rules and figure out
36
- // which in-app message clients should be notified basd on reference ids in
37
- // "attn" field of the event payload when sending out an event.
38
- h(this, "params");
39
- // A reactive store that captures a new socket event, that notifies any in-app
40
- // message clients that have subscribed.
41
- h(this, "inbox");
42
- this.socket = e, this.channels = {}, this.params = {}, this.inbox = new b({});
43
- }
44
- join(e) {
45
- const s = e.socketChannelTopic(), n = e.referenceId, o = e.defaultOptions;
46
- this.socket.isConnected() || this.socket.connect(), this.params[s] || (this.params[s] = {});
47
- const a = this.params[s][n], p = !a || JSON.stringify(a) !== JSON.stringify(o);
48
- if (p && (this.params[s] = { ...this.params[s], [n]: o }), !this.channels[s] || p) {
49
- const c = this.socket.channel(s, this.params[s]);
50
- for (const l of f)
51
- c.on(l, (d) => this.setInbox(d));
52
- this.channels[s] = c;
53
- }
54
- const r = this.channels[s];
55
- return ["closed", "errored"].includes(r.state) && r.join(), this.inbox.subscribe(() => {
56
- const c = this.inbox.state[n];
57
- c && e.handleSocketEvent(c);
58
- });
59
- }
60
- leave(e) {
61
- e.unsub && e.unsub();
62
- const s = e.socketChannelTopic(), n = e.referenceId, o = { ...this.params }, a = o[s] || {};
63
- a[n] && delete a[n];
64
- const r = { ...this.channels }, i = r[s];
65
- if (i && Object.keys(a).length === 0) {
66
- for (const c of f)
67
- i.off(c);
68
- i.leave(), delete r[s];
69
- }
70
- this.params = o, this.channels = r;
71
- }
72
- setInbox(e) {
73
- const { attn: s, ...n } = e;
74
- this.inbox.setState(
75
- () => s.reduce((o, a) => ({ ...o, [a]: n }), {})
76
- );
77
- }
78
- }
79
- export {
80
- x as InAppMessageSocketManager,
81
- k as SocketEventType
82
- };
83
- //# sourceMappingURL=socket-manager.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"socket-manager.mjs","sources":["../../../../src/clients/in-app-messages/socket-manager.ts"],"sourcesContent":["import { Store } from \"@tanstack/store\";\nimport { Channel, Socket } from \"phoenix\";\n\nimport { InAppMessagesClient } from \"./message-client\";\nimport { InAppMessage, InAppMessagesClientOptions } from \"./types\";\n\nexport enum SocketEventType {\n MessageCreated = \"message.created\",\n}\n\nconst SOCKET_EVENT_TYPES = [SocketEventType.MessageCreated];\n\ntype ClientQueryParams = InAppMessagesClientOptions;\n\n// e.g. in_app:<message-type>:<channel_id>:<user_id>\ntype ChannelTopic = string;\n\n// Unique reference id of an in-app message client\ntype ClientReferenceId = string;\n\ntype MessageCreatedEventPayload = {\n event: SocketEventType.MessageCreated;\n topic: string;\n data: {\n in_app_message: InAppMessage;\n };\n};\n\nexport type SocketEventPayload = MessageCreatedEventPayload;\n\n// \"attn\" field contains a list of client reference ids that should be notified\n// of a socket event.\ntype WithAttn<P> = P & { attn: Array<ClientReferenceId> };\n\ntype InAppMessageSocketInbox = Record<ClientReferenceId, SocketEventPayload>;\n\n/*\n * Manages socket subscriptions for in-app messages, allowing multiple in-app\n * message clients or components to listen for real time updates from the socket\n * API via a single socket connection. It's expected to be instantiated once\n * per an in-app channel.\n */\nexport class InAppMessageSocketManager {\n // Mapping of live channels by topic. Note, there can be one or more in-app\n // message client(s) that can subscribe.\n private channels: Record<ChannelTopic, Channel>;\n\n // Mapping of query params for each in-app message client, partitioned by its\n // reference id, and grouped by channel topic. It's a double nested object\n // that looks like:\n // {\n // \"in_app:card:...\": {\n // \"ref-1\": {\n // \"workflow_key\": \"foo\",\n // },\n // \"ref-2\": {\n // \"workflow_key\": \"bar\",\n // },\n // },\n // \"in_app:banner:...\": {\n // \"ref-3\": {\n // \"workflow_key\": \"baz\",\n // },\n // }\n // }\n //\n // Each time a new in-app message client joins a channel, we send all cumulated\n // params such that the socket API can apply filtering rules and figure out\n // which in-app message clients should be notified basd on reference ids in\n // \"attn\" field of the event payload when sending out an event.\n private params: Record<\n ChannelTopic,\n Record<ClientReferenceId, ClientQueryParams>\n >;\n\n // A reactive store that captures a new socket event, that notifies any in-app\n // message clients that have subscribed.\n private inbox: Store<\n InAppMessageSocketInbox,\n (cb: InAppMessageSocketInbox) => InAppMessageSocketInbox\n >;\n\n constructor(readonly socket: Socket) {\n this.channels = {};\n this.params = {};\n this.inbox = new Store<InAppMessageSocketInbox>({});\n }\n\n join(iamClient: InAppMessagesClient) {\n const topic = iamClient.socketChannelTopic();\n const referenceId = iamClient.referenceId;\n const params = iamClient.defaultOptions;\n\n // Ensure a live socket connection if not yet connected.\n if (!this.socket.isConnected()) {\n this.socket.connect();\n }\n\n // If a new in-app message client joins, or has updated query params then\n // track the updated params and (re)join with the latest query params.\n // Note, each time we send combined params of all in-app message clients that\n // have subscribed for a given message type (and an in-app channel and a\n // user), grouped by client's reference id.\n if (!this.params[topic]) {\n this.params[topic] = {};\n }\n\n const maybeParams = this.params[topic][referenceId];\n const hasNewOrUpdatedParams =\n !maybeParams || JSON.stringify(maybeParams) !== JSON.stringify(params);\n\n if (hasNewOrUpdatedParams) {\n // Tracks all subscribed client's params by its reference id and by topic.\n this.params[topic] = { ...this.params[topic], [referenceId]: params };\n }\n\n if (!this.channels[topic] || hasNewOrUpdatedParams) {\n const newChannel = this.socket.channel(topic, this.params[topic]);\n for (const eventType of SOCKET_EVENT_TYPES) {\n newChannel.on(eventType, (payload) => this.setInbox(payload));\n }\n // Tracks live channels by channel topic.\n this.channels[topic] = newChannel;\n }\n\n const channel = this.channels[topic];\n\n // Join the channel if not already joined or joining or leaving.\n if ([\"closed\", \"errored\"].includes(channel.state)) {\n channel.join();\n }\n\n // Let the in-app message client subscribe to the \"inbox\", so it can be\n // notified when there's a new socket event that is relevant for the client.\n const unsub = this.inbox.subscribe(() => {\n const payload = this.inbox.state[referenceId];\n if (!payload) return;\n\n iamClient.handleSocketEvent(payload);\n });\n\n return unsub;\n }\n\n leave(iamClient: InAppMessagesClient) {\n if (iamClient.unsub) {\n iamClient.unsub();\n }\n\n const topic = iamClient.socketChannelTopic();\n const referenceId = iamClient.referenceId;\n\n const partitionedParams = { ...this.params };\n const paramsForTopic = partitionedParams[topic] || {};\n const paramsForReferenceClient = paramsForTopic[referenceId];\n\n if (paramsForReferenceClient) {\n delete paramsForTopic[referenceId];\n }\n\n const channels = { ...this.channels };\n const channelForTopic = channels[topic];\n if (channelForTopic && Object.keys(paramsForTopic).length === 0) {\n for (const eventType of SOCKET_EVENT_TYPES) {\n channelForTopic.off(eventType);\n }\n channelForTopic.leave();\n delete channels[topic];\n }\n\n this.params = partitionedParams;\n this.channels = channels;\n }\n\n private setInbox(payload: WithAttn<SocketEventPayload>) {\n const { attn, ...rest } = payload;\n\n // Set the incoming socket event into the inbox, keyed by relevant client\n // reference ids provided by the server (via attn field), so we can notify\n // only the clients that need to be notified.\n this.inbox.setState(() =>\n attn.reduce((acc, referenceId) => {\n return { ...acc, [referenceId]: rest };\n }, {}),\n );\n }\n}\n"],"names":["SocketEventType","SOCKET_EVENT_TYPES","InAppMessageSocketManager","socket","__publicField","Store","iamClient","topic","referenceId","params","maybeParams","hasNewOrUpdatedParams","newChannel","eventType","payload","channel","partitionedParams","paramsForTopic","channels","channelForTopic","attn","rest","acc"],"mappings":";;;;AAMY,IAAAA,sBAAAA,OACVA,EAAA,iBAAiB,mBADPA,IAAAA,KAAA,CAAA,CAAA;AAIZ,MAAMC,IAAqB;AAAA,EAAC;AAAA;;AAgCrB,MAAMC,EAA0B;AAAA,EAwCrC,YAAqBC,GAAgB;AArC7B;AAAA;AAAA,IAAAC,EAAA;AAyBA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,EAAA;AAOA;AAAA;AAAA,IAAAA,EAAA;AAKa,SAAA,SAAAD,GACnB,KAAK,WAAW,IAChB,KAAK,SAAS,IACd,KAAK,QAAQ,IAAIE,EAA+B,CAAE,CAAA;AAAA,EACpD;AAAA,EAEA,KAAKC,GAAgC;AAC7B,UAAAC,IAAQD,EAAU,sBAClBE,IAAcF,EAAU,aACxBG,IAASH,EAAU;AAGzB,IAAK,KAAK,OAAO,iBACf,KAAK,OAAO,WAQT,KAAK,OAAOC,CAAK,MACf,KAAA,OAAOA,CAAK,IAAI;AAGvB,UAAMG,IAAc,KAAK,OAAOH,CAAK,EAAEC,CAAW,GAC5CG,IACJ,CAACD,KAAe,KAAK,UAAUA,CAAW,MAAM,KAAK,UAAUD,CAAM;AAOvE,QALIE,MAEF,KAAK,OAAOJ,CAAK,IAAI,EAAE,GAAG,KAAK,OAAOA,CAAK,GAAG,CAACC,CAAW,GAAGC,EAAO,IAGlE,CAAC,KAAK,SAASF,CAAK,KAAKI,GAAuB;AAC5C,YAAAC,IAAa,KAAK,OAAO,QAAQL,GAAO,KAAK,OAAOA,CAAK,CAAC;AAChE,iBAAWM,KAAaZ;AACtB,QAAAW,EAAW,GAAGC,GAAW,CAACC,MAAY,KAAK,SAASA,CAAO,CAAC;AAGzD,WAAA,SAASP,CAAK,IAAIK;AAAA,IACzB;AAEM,UAAAG,IAAU,KAAK,SAASR,CAAK;AAGnC,WAAI,CAAC,UAAU,SAAS,EAAE,SAASQ,EAAQ,KAAK,KAC9CA,EAAQ,KAAK,GAKD,KAAK,MAAM,UAAU,MAAM;AACvC,YAAMD,IAAU,KAAK,MAAM,MAAMN,CAAW;AAC5C,MAAKM,KAELR,EAAU,kBAAkBQ,CAAO;AAAA,IAAA,CACpC;AAAA,EAGH;AAAA,EAEA,MAAMR,GAAgC;AACpC,IAAIA,EAAU,SACZA,EAAU,MAAM;AAGZ,UAAAC,IAAQD,EAAU,sBAClBE,IAAcF,EAAU,aAExBU,IAAoB,EAAE,GAAG,KAAK,OAAO,GACrCC,IAAiBD,EAAkBT,CAAK,KAAK,CAAA;AAGnD,IAFiCU,EAAeT,CAAW,KAGzD,OAAOS,EAAeT,CAAW;AAGnC,UAAMU,IAAW,EAAE,GAAG,KAAK,SAAS,GAC9BC,IAAkBD,EAASX,CAAK;AACtC,QAAIY,KAAmB,OAAO,KAAKF,CAAc,EAAE,WAAW,GAAG;AAC/D,iBAAWJ,KAAaZ;AACtB,QAAAkB,EAAgB,IAAIN,CAAS;AAE/B,MAAAM,EAAgB,MAAM,GACtB,OAAOD,EAASX,CAAK;AAAA,IACvB;AAEA,SAAK,SAASS,GACd,KAAK,WAAWE;AAAA,EAClB;AAAA,EAEQ,SAASJ,GAAuC;AACtD,UAAM,EAAE,MAAAM,GAAM,GAAGC,EAAA,IAASP;AAK1B,SAAK,MAAM;AAAA,MAAS,MAClBM,EAAK,OAAO,CAACE,GAAKd,OACT,EAAE,GAAGc,GAAK,CAACd,CAAW,GAAGa,EAAK,IACpC,EAAE;AAAA,IAAA;AAAA,EAET;AACF;"}
@@ -1,11 +0,0 @@
1
- import { Store as e } from "@tanstack/store";
2
- function t() {
3
- return new e({
4
- messages: {},
5
- queries: {}
6
- });
7
- }
8
- export {
9
- t as createStore
10
- };
11
- //# sourceMappingURL=store.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"store.mjs","sources":["../../../../src/clients/in-app-messages/store.ts"],"sourcesContent":["import { Store } from \"@tanstack/store\";\n\nimport { InAppMessagesStoreState } from \"./types\";\n\nexport type InAppMessagesStore = Store<\n InAppMessagesStoreState,\n (cb: InAppMessagesStoreState) => InAppMessagesStoreState\n>;\n\nexport function createStore() {\n return new Store<InAppMessagesStoreState>({\n messages: {},\n queries: {},\n });\n}\n"],"names":["createStore","Store"],"mappings":";AASO,SAASA,IAAc;AAC5B,SAAO,IAAIC,EAA+B;AAAA,IACxC,UAAU,CAAC;AAAA,IACX,SAAS,CAAC;AAAA,EAAA,CACX;AACH;"}
@@ -1,23 +0,0 @@
1
- import { default as Knock } from '../../knock';
2
- import { InAppMessagesClient } from './message-client';
3
- import { InAppMessagesStore } from './store';
4
- import { InAppMessage, InAppMessagesClientOptions, InAppMessagesQueryInfo, InAppMessagesResponse } from './types';
5
-
6
- /**
7
- * Manages the configuration for an in app channel.
8
- * Stores all fetched messages to support optimistic updates.
9
- */
10
- export declare class InAppMessagesChannelClient {
11
- readonly knock: Knock;
12
- readonly channelId: string;
13
- readonly defaultOptions: InAppMessagesClientOptions;
14
- store: InAppMessagesStore;
15
- private socketManager;
16
- constructor(knock: Knock, channelId: string, defaultOptions?: InAppMessagesClientOptions);
17
- setMessageAttrs(messageIds: string[], attrs: Partial<InAppMessage>): void;
18
- setQueryResponse(queryKey: string, response: InAppMessagesResponse): void;
19
- setQueryStatus(queryKey: string, status: Pick<InAppMessagesQueryInfo, "loading" | "networkStatus">): void;
20
- subscribe(client: InAppMessagesClient): (() => void) | undefined;
21
- unsubscribe(client: InAppMessagesClient): void;
22
- }
23
- //# sourceMappingURL=channel-client.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"channel-client.d.ts","sourceRoot":"","sources":["../../../../src/clients/in-app-messages/channel-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,aAAa,CAAC;AAGhC,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,EAAE,kBAAkB,EAAe,MAAM,SAAS,CAAC;AAC1D,OAAO,EACL,YAAY,EACZ,0BAA0B,EAC1B,sBAAsB,EACtB,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,qBAAa,0BAA0B;IAMnC,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,SAAS,EAAE,MAAM;IAC1B,QAAQ,CAAC,cAAc,EAAE,0BAA0B;IAP9C,KAAK,EAAE,kBAAkB,CAAC;IAEjC,OAAO,CAAC,aAAa,CAAwC;gBAGlD,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,MAAM,EACjB,cAAc,GAAE,0BAA+B;IAmB1D,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC;IAkBlE,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,qBAAqB;IA2BlE,cAAc,CACZ,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,IAAI,CAAC,sBAAsB,EAAE,SAAS,GAAG,eAAe,CAAC;IAkBnE,SAAS,CAAC,MAAM,EAAE,mBAAmB;IAWrC,WAAW,CAAC,MAAM,EAAE,mBAAmB;CAQxC"}
@@ -1,4 +0,0 @@
1
- export * from './channel-client';
2
- export * from './message-client';
3
- export * from './types';
4
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/in-app-messages/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC"}
@@ -1,52 +0,0 @@
1
- import { GenericData } from '@knocklabs/types';
2
- import { NetworkStatus } from '../../networkStatus';
3
- import { InAppMessagesChannelClient } from './channel-client';
4
- import { SocketEventPayload } from './socket-manager';
5
- import { InAppMessage, InAppMessagesClientOptions, InAppMessagesResponse, InAppMessagesStoreState } from './types';
6
-
7
- /**
8
- * Manages realtime connection to in app messages service.
9
- */
10
- export declare class InAppMessagesClient {
11
- readonly channelClient: InAppMessagesChannelClient;
12
- readonly messageType: string;
13
- readonly defaultOptions: InAppMessagesClientOptions;
14
- private knock;
15
- queryKey: string;
16
- referenceId: string;
17
- unsub?: () => void;
18
- constructor(channelClient: InAppMessagesChannelClient, messageType: string, defaultOptions?: InAppMessagesClientOptions);
19
- fetch<TContent extends GenericData = GenericData, TData extends GenericData = GenericData>(): Promise<{
20
- status: "ok";
21
- data: InAppMessagesResponse<TContent, TData>;
22
- } | {
23
- status: "error";
24
- error: Error;
25
- } | undefined>;
26
- getQueryInfoSelector<TContent extends GenericData = GenericData, TData extends GenericData = GenericData>(state: InAppMessagesStoreState): {
27
- messages: InAppMessage<TContent, TData>[];
28
- loading: boolean;
29
- networkStatus: NetworkStatus;
30
- };
31
- markAsSeen(itemOrItems: InAppMessage | InAppMessage[]): Promise<import('../messages/interfaces').Message<GenericData>[]>;
32
- markAsUnseen(itemOrItems: InAppMessage | InAppMessage[]): Promise<import('../messages/interfaces').Message<GenericData>[]>;
33
- markAsRead(itemOrItems: InAppMessage | InAppMessage[]): Promise<import('../messages/interfaces').Message<GenericData>[]>;
34
- markAsUnread(itemOrItems: InAppMessage | InAppMessage[]): Promise<import('../messages/interfaces').Message<GenericData>[]>;
35
- markAsInteracted(itemOrItems: InAppMessage | InAppMessage[], metadata?: Record<string, string>): Promise<import('../messages/interfaces').Message<GenericData>[]>;
36
- markAsArchived(itemOrItems: InAppMessage | InAppMessage[]): Promise<import('../messages/interfaces').Message<GenericData>[]>;
37
- markAsUnarchived(itemOrItems: InAppMessage | InAppMessage[]): Promise<import('../messages/interfaces').Message<GenericData>[]>;
38
- private makeStatusUpdate;
39
- private buildQueryKey;
40
- subscribe(): void;
41
- unsubscribe(): void;
42
- handleSocketEvent(payload: SocketEventPayload): Promise<{
43
- status: "error";
44
- error: Error;
45
- } | {
46
- status: "ok";
47
- data: InAppMessagesResponse<GenericData, GenericData>;
48
- } | undefined>;
49
- socketChannelTopic(): string;
50
- private getItemIds;
51
- }
52
- //# sourceMappingURL=message-client.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"message-client.d.ts","sourceRoot":"","sources":["../../../../src/clients/in-app-messages/message-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAI/C,OAAO,EAAE,aAAa,EAAqB,MAAM,qBAAqB,CAAC;AAGvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAmB,MAAM,kBAAkB,CAAC;AACvE,OAAO,EACL,YAAY,EACZ,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACxB,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,qBAAa,mBAAmB;IAQ5B,QAAQ,CAAC,aAAa,EAAE,0BAA0B;IAClD,QAAQ,CAAC,WAAW,EAAE,MAAM;IAC5B,QAAQ,CAAC,cAAc,EAAE,0BAA0B;IATrD,OAAO,CAAC,KAAK,CAAQ;IAEd,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;gBAGf,aAAa,EAAE,0BAA0B,EACzC,WAAW,EAAE,MAAM,EACnB,cAAc,GAAE,0BAA+B;IAgBpD,KAAK,CACT,QAAQ,SAAS,WAAW,GAAG,WAAW,EAC1C,KAAK,SAAS,WAAW,GAAG,WAAW,KACpC,OAAO,CACR;QACE,MAAM,EAAE,IAAI,CAAC;QACb,IAAI,EAAE,qBAAqB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;KAC9C,GACD;QACE,MAAM,EAAE,OAAO,CAAC;QAChB,KAAK,EAAE,KAAK,CAAC;KACd,GACD,SAAS,CACZ;IA+CD,oBAAoB,CAClB,QAAQ,SAAS,WAAW,GAAG,WAAW,EAC1C,KAAK,SAAS,WAAW,GAAG,WAAW,EAEvC,KAAK,EAAE,uBAAuB,GAC7B;QACD,QAAQ,EAAE,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;QAC1C,OAAO,EAAE,OAAO,CAAC;QACjB,aAAa,EAAE,aAAa,CAAC;KAC9B;IAyBK,UAAU,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE;IAUrD,YAAY,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE;IAUvD,UAAU,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE;IAUrD,YAAY,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE;IAUvD,gBAAgB,CACpB,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE,EAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAa7B,cAAc,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE;IAUzD,gBAAgB,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE;YAUnD,gBAAgB;IAoB9B,OAAO,CAAC,aAAa;IAMrB,SAAS;IAIT,WAAW;IAML,iBAAiB,CAAC,OAAO,EAAE,kBAAkB;gBApMrC,OAAO;eACR,KAAK;;gBALJ,IAAI;;;IAoNlB,kBAAkB;IAIlB,OAAO,CAAC,UAAU;CAInB"}
@@ -1,27 +0,0 @@
1
- import { Socket } from 'phoenix';
2
- import { InAppMessagesClient } from './message-client';
3
- import { InAppMessage } from './types';
4
-
5
- export declare enum SocketEventType {
6
- MessageCreated = "message.created"
7
- }
8
- type MessageCreatedEventPayload = {
9
- event: SocketEventType.MessageCreated;
10
- topic: string;
11
- data: {
12
- in_app_message: InAppMessage;
13
- };
14
- };
15
- export type SocketEventPayload = MessageCreatedEventPayload;
16
- export declare class InAppMessageSocketManager {
17
- readonly socket: Socket;
18
- private channels;
19
- private params;
20
- private inbox;
21
- constructor(socket: Socket);
22
- join(iamClient: InAppMessagesClient): () => void;
23
- leave(iamClient: InAppMessagesClient): void;
24
- private setInbox;
25
- }
26
- export {};
27
- //# sourceMappingURL=socket-manager.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"socket-manager.d.ts","sourceRoot":"","sources":["../../../../src/clients/in-app-messages/socket-manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAW,MAAM,EAAE,MAAM,SAAS,CAAC;AAE1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,YAAY,EAA8B,MAAM,SAAS,CAAC;AAEnE,oBAAY,eAAe;IACzB,cAAc,oBAAoB;CACnC;AAYD,KAAK,0BAA0B,GAAG;IAChC,KAAK,EAAE,eAAe,CAAC,cAAc,CAAC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE;QACJ,cAAc,EAAE,YAAY,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,0BAA0B,CAAC;AAc5D,qBAAa,yBAAyB;IAwCxB,QAAQ,CAAC,MAAM,EAAE,MAAM;IArCnC,OAAO,CAAC,QAAQ,CAAgC;IAyBhD,OAAO,CAAC,MAAM,CAGZ;IAIF,OAAO,CAAC,KAAK,CAGX;gBAEmB,MAAM,EAAE,MAAM;IAMnC,IAAI,CAAC,SAAS,EAAE,mBAAmB;IAwDnC,KAAK,CAAC,SAAS,EAAE,mBAAmB;IA8BpC,OAAO,CAAC,QAAQ;CAYjB"}
@@ -1,6 +0,0 @@
1
- import { Store } from '@tanstack/store';
2
- import { InAppMessagesStoreState } from './types';
3
-
4
- export type InAppMessagesStore = Store<InAppMessagesStoreState, (cb: InAppMessagesStoreState) => InAppMessagesStoreState>;
5
- export declare function createStore(): Store<InAppMessagesStoreState, (cb: InAppMessagesStoreState) => InAppMessagesStoreState>;
6
- //# sourceMappingURL=store.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../../src/clients/in-app-messages/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAElD,MAAM,MAAM,kBAAkB,GAAG,KAAK,CACpC,uBAAuB,EACvB,CAAC,EAAE,EAAE,uBAAuB,KAAK,uBAAuB,CACzD,CAAC;AAEF,wBAAgB,WAAW,6FAK1B"}
@@ -1,52 +0,0 @@
1
- import { GenericData, PageInfo, Tenant } from '@knocklabs/types';
2
- import { NetworkStatus } from '../../networkStatus';
3
- import { NotificationSource } from '../messages/interfaces';
4
-
5
- export interface InAppMessage<TContent extends GenericData = GenericData, TData extends GenericData = GenericData, TTenantProperties = GenericData> {
6
- __cursor: string;
7
- id: string;
8
- message_type: string;
9
- schema_variant: string;
10
- schema_version: string;
11
- content: TContent;
12
- data: TData | null;
13
- inserted_at: string;
14
- updated_at: string;
15
- seen_at: string | null;
16
- read_at: string | null;
17
- interacted_at: string | null;
18
- archived_at: string | null;
19
- link_clicked_at: string | null;
20
- source: NotificationSource;
21
- tenant: Tenant<TTenantProperties>;
22
- }
23
- export interface InAppMessagesResponse<TContent extends GenericData = GenericData, TData extends GenericData = GenericData> {
24
- entries: InAppMessage<TContent, TData>[];
25
- pageInfo: PageInfo;
26
- }
27
- export interface InAppMessagesQueryInfo {
28
- networkStatus: NetworkStatus;
29
- loading: boolean;
30
- data?: {
31
- messageIds: string[];
32
- pageInfo: PageInfo;
33
- };
34
- }
35
- export interface InAppMessagesStoreState {
36
- messages: Record<string, InAppMessage>;
37
- queries: Record<string, InAppMessagesQueryInfo>;
38
- }
39
- export type InAppMessageEngagementStatus = "read" | "unread" | "seen" | "unseen" | "link_clicked" | "link_unclicked" | "interacted" | "uninteracted";
40
- export interface InAppMessagesClientOptions {
41
- order?: "asc" | "desc";
42
- before?: string;
43
- after?: string;
44
- page_size?: number;
45
- engagement_status?: InAppMessageEngagementStatus[];
46
- tenant_id?: string | string[];
47
- workflow_key?: string | string[];
48
- workflow_categories?: string[];
49
- archived?: "include" | "exclude" | "only";
50
- trigger_data?: GenericData;
51
- }
52
- //# sourceMappingURL=types.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/clients/in-app-messages/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAE5D,MAAM,WAAW,YAAY,CAC3B,QAAQ,SAAS,WAAW,GAAG,WAAW,EAC1C,KAAK,SAAS,WAAW,GAAG,WAAW,EACvC,iBAAiB,GAAG,WAAW;IAE/B,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,QAAQ,CAAC;IAClB,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,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;IAC/B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB,CACpC,QAAQ,SAAS,WAAW,GAAG,WAAW,EAC1C,KAAK,SAAS,WAAW,GAAG,WAAW;IAEvC,OAAO,EAAE,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;IACzC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,aAAa,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE;QACL,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,QAAQ,EAAE,QAAQ,CAAC;KACpB,CAAC;CACH;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACvC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;CACjD;AAED,MAAM,MAAM,4BAA4B,GACpC,MAAM,GACN,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,cAAc,GACd,gBAAgB,GAChB,YAAY,GACZ,cAAc,CAAC;AAEnB,MAAM,WAAW,0BAA0B;IACzC,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAEnD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE9B,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAEjC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAI1C,YAAY,CAAC,EAAE,WAAW,CAAC;CAC5B"}
@@ -1,129 +0,0 @@
1
- import Knock from "../../knock";
2
- import { NetworkStatus } from "../../networkStatus";
3
-
4
- import { InAppMessagesClient } from "./message-client";
5
- import { InAppMessageSocketManager } from "./socket-manager";
6
- import { InAppMessagesStore, createStore } from "./store";
7
- import {
8
- InAppMessage,
9
- InAppMessagesClientOptions,
10
- InAppMessagesQueryInfo,
11
- InAppMessagesResponse,
12
- } from "./types";
13
-
14
- /**
15
- * Manages the configuration for an in app channel.
16
- * Stores all fetched messages to support optimistic updates.
17
- */
18
- export class InAppMessagesChannelClient {
19
- public store: InAppMessagesStore;
20
-
21
- private socketManager: InAppMessageSocketManager | undefined;
22
-
23
- constructor(
24
- readonly knock: Knock,
25
- readonly channelId: string,
26
- readonly defaultOptions: InAppMessagesClientOptions = {},
27
- ) {
28
- this.store = createStore();
29
-
30
- // Initialize a socket manager for the in-app channel client, which there
31
- // should be one per in-app channel client but it's abstracted out as a
32
- // separate module for the organization/encapsulation purposes.
33
- const { socket } = this.knock.client();
34
- if (socket) {
35
- this.socketManager = new InAppMessageSocketManager(socket);
36
- }
37
-
38
- this.knock.log(`[IAM] Initialized a client on channel ${channelId}`);
39
- }
40
-
41
- // ----------------------------------------------
42
- // Store helpers
43
- // ----------------------------------------------
44
-
45
- setMessageAttrs(messageIds: string[], attrs: Partial<InAppMessage>) {
46
- this.store.setState((state) => ({
47
- ...state,
48
- messages: {
49
- ...state.messages,
50
- ...messageIds.reduce<Record<string, InAppMessage>>((messages, id) => {
51
- if (state.messages[id]) {
52
- messages[id] = {
53
- ...state.messages[id],
54
- ...attrs,
55
- };
56
- }
57
- return messages;
58
- }, {}),
59
- },
60
- }));
61
- }
62
-
63
- setQueryResponse(queryKey: string, response: InAppMessagesResponse) {
64
- const queryInfo: InAppMessagesQueryInfo = {
65
- loading: false,
66
- networkStatus: NetworkStatus.ready,
67
- data: {
68
- messageIds: response.entries.map((iam) => iam.id),
69
- pageInfo: response.pageInfo,
70
- },
71
- };
72
-
73
- this.store.setState((state) => {
74
- return {
75
- ...state,
76
- // Store new messages in store
77
- messages: response.entries.reduce((messages, message) => {
78
- messages[message.id] = message;
79
- return messages;
80
- }, state.messages),
81
- // Store query results
82
- queries: {
83
- ...state.queries,
84
- [queryKey]: queryInfo,
85
- },
86
- };
87
- });
88
- }
89
-
90
- setQueryStatus(
91
- queryKey: string,
92
- status: Pick<InAppMessagesQueryInfo, "loading" | "networkStatus">,
93
- ) {
94
- this.store.setState((state) => ({
95
- ...state,
96
- queries: {
97
- ...state.queries,
98
- [queryKey]: {
99
- ...state.queries[queryKey],
100
- ...status,
101
- },
102
- },
103
- }));
104
- }
105
-
106
- /*
107
- * Socket
108
- */
109
-
110
- subscribe(client: InAppMessagesClient) {
111
- if (!this.socketManager) return;
112
- this.knock.log(
113
- `[InAppMessagesClient] Subscribe a client ${client.referenceId} to socket events`,
114
- );
115
-
116
- // Pass the unsub func back to iam client so it can be used when
117
- // unsubscribing.
118
- return this.socketManager.join(client);
119
- }
120
-
121
- unsubscribe(client: InAppMessagesClient) {
122
- if (!this.socketManager) return;
123
- this.knock.log(
124
- `[InAppMessagesClient] Unsubscribe a client ${client.referenceId}`,
125
- );
126
-
127
- this.socketManager.leave(client);
128
- }
129
- }
@@ -1,3 +0,0 @@
1
- export * from "./channel-client";
2
- export * from "./message-client";
3
- export * from "./types";