@knocklabs/client 0.14.10 → 0.15.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 (130) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/cjs/api.js +2 -0
  3. package/dist/cjs/api.js.map +1 -0
  4. package/dist/cjs/clients/feed/feed.js +2 -0
  5. package/dist/cjs/clients/feed/feed.js.map +1 -0
  6. package/dist/cjs/clients/feed/index.js +2 -0
  7. package/dist/cjs/clients/feed/index.js.map +1 -0
  8. package/dist/cjs/clients/feed/socket-manager.js +2 -0
  9. package/dist/cjs/clients/feed/socket-manager.js.map +1 -0
  10. package/dist/cjs/clients/feed/store.js +2 -0
  11. package/dist/cjs/clients/feed/store.js.map +1 -0
  12. package/dist/cjs/clients/feed/utils.js +2 -0
  13. package/dist/cjs/clients/feed/utils.js.map +1 -0
  14. package/dist/cjs/clients/guide/client.js +2 -0
  15. package/dist/cjs/clients/guide/client.js.map +1 -0
  16. package/dist/cjs/clients/messages/index.js +2 -0
  17. package/dist/cjs/clients/messages/index.js.map +1 -0
  18. package/dist/cjs/clients/ms-teams/index.js +2 -0
  19. package/dist/cjs/clients/ms-teams/index.js.map +1 -0
  20. package/dist/cjs/clients/objects/constants.js +2 -0
  21. package/dist/cjs/clients/objects/constants.js.map +1 -0
  22. package/dist/cjs/clients/objects/index.js +2 -0
  23. package/dist/cjs/clients/objects/index.js.map +1 -0
  24. package/dist/cjs/clients/preferences/index.js +2 -0
  25. package/dist/cjs/clients/preferences/index.js.map +1 -0
  26. package/dist/cjs/clients/slack/index.js +2 -0
  27. package/dist/cjs/clients/slack/index.js.map +1 -0
  28. package/dist/cjs/clients/users/index.js +2 -0
  29. package/dist/cjs/clients/users/index.js.map +1 -0
  30. package/dist/cjs/helpers.js +2 -0
  31. package/dist/cjs/helpers.js.map +1 -0
  32. package/dist/cjs/index.js +2 -0
  33. package/dist/cjs/index.js.map +1 -0
  34. package/dist/cjs/knock.js +2 -0
  35. package/dist/cjs/knock.js.map +1 -0
  36. package/dist/cjs/networkStatus.js +2 -0
  37. package/dist/cjs/networkStatus.js.map +1 -0
  38. package/dist/esm/api.mjs +58 -0
  39. package/dist/esm/api.mjs.map +1 -0
  40. package/dist/esm/clients/feed/feed.mjs +422 -0
  41. package/dist/esm/clients/feed/feed.mjs.map +1 -0
  42. package/dist/esm/clients/feed/index.mjs +47 -0
  43. package/dist/esm/clients/feed/index.mjs.map +1 -0
  44. package/dist/esm/clients/feed/socket-manager.mjs +81 -0
  45. package/dist/esm/clients/feed/socket-manager.mjs.map +1 -0
  46. package/dist/esm/clients/feed/store.mjs +104 -0
  47. package/dist/esm/clients/feed/store.mjs.map +1 -0
  48. package/dist/esm/clients/feed/utils.mjs +35 -0
  49. package/dist/esm/clients/feed/utils.mjs.map +1 -0
  50. package/dist/esm/clients/guide/client.mjs +284 -0
  51. package/dist/esm/clients/guide/client.mjs.map +1 -0
  52. package/dist/esm/clients/messages/index.mjs +64 -0
  53. package/dist/esm/clients/messages/index.mjs.map +1 -0
  54. package/dist/esm/clients/ms-teams/index.mjs +91 -0
  55. package/dist/esm/clients/ms-teams/index.mjs.map +1 -0
  56. package/dist/esm/clients/objects/constants.mjs +5 -0
  57. package/dist/esm/clients/objects/constants.mjs.map +1 -0
  58. package/dist/esm/clients/objects/index.mjs +42 -0
  59. package/dist/esm/clients/objects/index.mjs.map +1 -0
  60. package/dist/esm/clients/preferences/index.mjs +128 -0
  61. package/dist/esm/clients/preferences/index.mjs.map +1 -0
  62. package/dist/esm/clients/slack/index.mjs +72 -0
  63. package/dist/esm/clients/slack/index.mjs.map +1 -0
  64. package/dist/esm/clients/users/index.mjs +99 -0
  65. package/dist/esm/clients/users/index.mjs.map +1 -0
  66. package/dist/esm/helpers.mjs +8 -0
  67. package/dist/esm/helpers.mjs.map +1 -0
  68. package/dist/esm/index.mjs +16 -0
  69. package/dist/esm/index.mjs.map +1 -0
  70. package/dist/esm/knock.mjs +108 -0
  71. package/dist/esm/knock.mjs.map +1 -0
  72. package/dist/esm/networkStatus.mjs +15 -0
  73. package/dist/esm/networkStatus.mjs.map +1 -0
  74. package/dist/types/api.d.ts +25 -0
  75. package/dist/types/api.d.ts.map +1 -0
  76. package/dist/types/clients/feed/feed.d.ts +75 -0
  77. package/dist/types/clients/feed/feed.d.ts.map +1 -0
  78. package/dist/types/clients/feed/index.d.ts +17 -0
  79. package/dist/types/clients/feed/index.d.ts.map +1 -0
  80. package/dist/types/clients/feed/interfaces.d.ts +99 -0
  81. package/dist/types/clients/feed/interfaces.d.ts.map +1 -0
  82. package/dist/types/clients/feed/socket-manager.d.ts +31 -0
  83. package/dist/types/clients/feed/socket-manager.d.ts.map +1 -0
  84. package/dist/types/clients/feed/store.d.ts +20 -0
  85. package/dist/types/clients/feed/store.d.ts.map +1 -0
  86. package/dist/types/clients/feed/types.d.ts +35 -0
  87. package/dist/types/clients/feed/types.d.ts.map +1 -0
  88. package/dist/types/clients/feed/utils.d.ts +20 -0
  89. package/dist/types/clients/feed/utils.d.ts.map +1 -0
  90. package/dist/types/clients/guide/client.d.ts +124 -0
  91. package/dist/types/clients/guide/client.d.ts.map +1 -0
  92. package/dist/types/clients/guide/index.d.ts +3 -0
  93. package/dist/types/clients/guide/index.d.ts.map +1 -0
  94. package/dist/types/clients/messages/index.d.ts +15 -0
  95. package/dist/types/clients/messages/index.d.ts.map +1 -0
  96. package/dist/types/clients/messages/interfaces.d.ts +46 -0
  97. package/dist/types/clients/messages/interfaces.d.ts.map +1 -0
  98. package/dist/types/clients/ms-teams/index.d.ts +14 -0
  99. package/dist/types/clients/ms-teams/index.d.ts.map +1 -0
  100. package/dist/types/clients/ms-teams/interfaces.d.ts +49 -0
  101. package/dist/types/clients/ms-teams/interfaces.d.ts.map +1 -0
  102. package/dist/types/clients/objects/constants.d.ts +2 -0
  103. package/dist/types/clients/objects/constants.d.ts.map +1 -0
  104. package/dist/types/clients/objects/index.d.ts +23 -0
  105. package/dist/types/clients/objects/index.d.ts.map +1 -0
  106. package/dist/types/clients/preferences/index.d.ts +46 -0
  107. package/dist/types/clients/preferences/index.d.ts.map +1 -0
  108. package/dist/types/clients/preferences/interfaces.d.ts +29 -0
  109. package/dist/types/clients/preferences/interfaces.d.ts.map +1 -0
  110. package/dist/types/clients/slack/index.d.ts +13 -0
  111. package/dist/types/clients/slack/index.d.ts.map +1 -0
  112. package/dist/types/clients/slack/interfaces.d.ts +29 -0
  113. package/dist/types/clients/slack/interfaces.d.ts.map +1 -0
  114. package/dist/types/clients/users/index.d.ts +22 -0
  115. package/dist/types/clients/users/index.d.ts.map +1 -0
  116. package/dist/types/clients/users/interfaces.d.ts +9 -0
  117. package/dist/types/clients/users/interfaces.d.ts.map +1 -0
  118. package/dist/types/helpers.d.ts +2 -0
  119. package/dist/types/helpers.d.ts.map +1 -0
  120. package/dist/types/index.d.ts +21 -0
  121. package/dist/types/index.d.ts.map +1 -0
  122. package/dist/types/interfaces.d.ts +72 -0
  123. package/dist/types/interfaces.d.ts.map +1 -0
  124. package/dist/types/knock.d.ts +55 -0
  125. package/dist/types/knock.d.ts.map +1 -0
  126. package/dist/types/networkStatus.d.ts +8 -0
  127. package/dist/types/networkStatus.d.ts.map +1 -0
  128. package/package.json +2 -1
  129. package/src/interfaces.ts +6 -0
  130. package/src/knock.ts +52 -5
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,KAAK,MAAM,aAAa,CAAC;AAchC,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,GAAG,SAAS,GAAG,IAAI,WACrC,CAAC;AAE/B,UAAU,gBAAgB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,UAAU,aAAa;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,gBAAgB,CAAC;IAE1B,OAAO,EAAE,GAAG,CAAC;CACd;AAED,UAAU,+BAA+B;IACvC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,SAAS;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,yBAAyB,EAAE,+BAA+B,EAAE,CAAC;IAC7D,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,WAAW,CAAA;KAAE,KAAK,IAAI,CAAC;IAChE,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED,UAAU,gCACR,SAAQ,+BAA+B;IACvC,OAAO,EAAE,UAAU,CAAC;CACrB;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,yBAAyB,EAAE,gCAAgC,EAAE,CAAC;CAC/D;AAED,KAAK,oBAAoB,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAMF,MAAM,MAAM,8BAA8B,GAAG;IAE3C,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AA6CF,KAAK,QAAQ,GAAG,MAAM,CAAC;AAEvB,KAAK,WAAW,GAAG;IACjB,MAAM,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC;IACnC,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,KAAK,UAAU,GAAG;IAChB,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,KAAK,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AAE5D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,qBAAa,gBAAgB;IAczB,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,SAAS,EAAE,MAAM;IAC1B,QAAQ,CAAC,YAAY,EAAE,YAAY;IACnC,QAAQ,CAAC,OAAO,EAAE,eAAe;IAhB5B,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,UAAU,CAAC,CAAC;IAGnE,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,gBAAgB,CAAqD;IAG7E,OAAO,CAAC,WAAW,CAAmC;IACtD,OAAO,CAAC,cAAc,CAAsC;gBAGjD,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,MAAM,EACjB,YAAY,GAAE,YAAiB,EAC/B,OAAO,GAAE,eAAoB;IA0BxC,OAAO;IAKD,KAAK,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,iBAAiB,CAAA;KAAE;IA+ClD,SAAS;IA+BT,WAAW;IAcX,OAAO,CAAC,iBAAiB;IAwBzB,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,GAAE,kBAAuB;IAyDpD,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IAyBhD,gBAAgB,CACpB,KAAK,EAAE,SAAS,EAChB,IAAI,EAAE,aAAa,EACnB,QAAQ,CAAC,EAAE,WAAW;IA0BlB,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IAwB1D,OAAO,CAAC,SAAS;IA+CjB,OAAO,CAAC,gBAAgB;IAmBxB,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,mBAAmB;IA6B3B,OAAO,CAAC,8BAA8B;IAatC,OAAO,CAAC,QAAQ;IAQhB,OAAO,CAAC,iBAAiB;IAmBzB,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,oBAAoB,CAO1B;IAEF,OAAO,CAAC,kCAAkC;IAwC1C,OAAO,CAAC,oBAAoB;CAa7B"}
@@ -0,0 +1,3 @@
1
+ export { KnockGuideClient } from './client';
2
+ export type { KnockGuide, KnockGuideStep, TargetParams as KnockGuideTargetParams, SelectFilterParams as KnockGuideFilterParams, } from './client';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,YAAY,EACV,UAAU,EACV,cAAc,EACd,YAAY,IAAI,sBAAsB,EACtC,kBAAkB,IAAI,sBAAsB,GAC7C,MAAM,UAAU,CAAC"}
@@ -0,0 +1,15 @@
1
+ import { BulkOperation } from '../../interfaces';
2
+ import { default as Knock } from '../../knock';
3
+ import { BulkUpdateMessagesInChannelProperties, Message, MessageEngagementStatus, UpdateMessageStatusOptions } from './interfaces';
4
+ declare class MessageClient {
5
+ private knock;
6
+ constructor(knock: Knock);
7
+ get(messageId: string): Promise<Message>;
8
+ updateStatus(messageId: string, status: MessageEngagementStatus, options?: UpdateMessageStatusOptions): Promise<Message>;
9
+ removeStatus(messageId: string, status: Exclude<MessageEngagementStatus, "interacted">): Promise<Message>;
10
+ batchUpdateStatuses(messageIds: string[], status: MessageEngagementStatus | "unseen" | "unread" | "unarchived", options?: UpdateMessageStatusOptions): Promise<Message[]>;
11
+ bulkUpdateAllStatusesInChannel({ channelId, status, options, }: BulkUpdateMessagesInChannelProperties): Promise<BulkOperation>;
12
+ private handleResponse;
13
+ }
14
+ export default MessageClient;
15
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/messages/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,MAAM,aAAa,CAAC;AAEhC,OAAO,EACL,qCAAqC,EACrC,OAAO,EACP,uBAAuB,EACvB,0BAA0B,EAC3B,MAAM,cAAc,CAAC;AAEtB,cAAM,aAAa;IACjB,OAAO,CAAC,KAAK,CAAQ;gBAET,KAAK,EAAE,KAAK;IAIlB,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IASxC,YAAY,CAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,OAAO,CAAC;IAgBb,YAAY,CAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,OAAO,CAAC,uBAAuB,EAAE,YAAY,CAAC,GACrD,OAAO,CAAC,OAAO,CAAC;IASb,mBAAmB,CACvB,UAAU,EAAE,MAAM,EAAE,EACpB,MAAM,EAAE,uBAAuB,GAAG,QAAQ,GAAG,QAAQ,GAAG,YAAY,EACpE,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,OAAO,EAAE,CAAC;IAcf,8BAA8B,CAAC,EACnC,SAAS,EACT,MAAM,EACN,OAAO,GACR,EAAE,qCAAqC,GAAG,OAAO,CAAC,aAAa,CAAC;IAUjE,OAAO,CAAC,cAAc;CAUvB;AAED,eAAe,aAAa,CAAC"}
@@ -0,0 +1,46 @@
1
+ import { GenericData } from '@knocklabs/types';
2
+ import { RecipientRef } from '../..';
3
+ export type MessageDeliveryStatus = "queued" | "sent" | "delivered" | "delivery_attempted" | "undelivered" | "not_sent";
4
+ export interface NotificationSource {
5
+ key: string;
6
+ version_id: string;
7
+ categories: string[];
8
+ }
9
+ export type MessageEngagementStatus = "seen" | "read" | "interacted" | "archived";
10
+ export interface Message<T = GenericData> {
11
+ id: string;
12
+ channel_id: string;
13
+ recipient: RecipientRef;
14
+ actors: RecipientRef[];
15
+ inserted_at: string;
16
+ updated_at: string;
17
+ read_at: string | null;
18
+ seen_at: string | null;
19
+ archived_at: string | null;
20
+ clicked_at: string | null;
21
+ interacted_at: string | null;
22
+ link_clicked_at: string | null;
23
+ tenant: string | null;
24
+ status: MessageDeliveryStatus;
25
+ engagement_statuses: MessageEngagementStatus[];
26
+ source: NotificationSource;
27
+ data: T | null;
28
+ metadata: {
29
+ external_id?: string;
30
+ };
31
+ }
32
+ export type BulkUpdateMessagesInChannelProperties = {
33
+ channelId: string;
34
+ status: "seen" | "read" | "archive";
35
+ options: {
36
+ user_ids?: string[];
37
+ engagement_status?: "seen" | "read" | "archived" | "unseen" | "unread" | "unarchived" | "interacted" | "link_clicked";
38
+ archived?: "exclude" | "include" | "only";
39
+ has_tenant?: boolean;
40
+ tenants?: string[];
41
+ };
42
+ };
43
+ export type UpdateMessageStatusOptions = {
44
+ metadata?: Record<string, string>;
45
+ };
46
+ //# sourceMappingURL=interfaces.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/messages/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAErC,MAAM,MAAM,qBAAqB,GAC7B,QAAQ,GACR,MAAM,GACN,WAAW,GACX,oBAAoB,GACpB,aAAa,GACb,UAAU,CAAC;AAEf,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,MAAM,uBAAuB,GAC/B,MAAM,GACN,MAAM,GACN,YAAY,GACZ,UAAU,CAAC;AAEf,MAAM,WAAW,OAAO,CAAC,CAAC,GAAG,WAAW;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,YAAY,CAAC;IACxB,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,qBAAqB,CAAC;IAC9B,mBAAmB,EAAE,uBAAuB,EAAE,CAAC;IAC/C,MAAM,EAAE,kBAAkB,CAAC;IAC3B,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACf,QAAQ,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACpC,OAAO,EAAE;QACP,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,iBAAiB,CAAC,EACd,MAAM,GACN,MAAM,GACN,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,YAAY,GACZ,cAAc,CAAC;QACnB,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;QAC1C,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC,CAAC"}
@@ -0,0 +1,14 @@
1
+ import { AuthCheckInput, RevokeAccessTokenInput } from '../../interfaces';
2
+ import { default as Knock } from '../../knock';
3
+ import { GetMsTeamsChannelsInput, GetMsTeamsChannelsResponse, GetMsTeamsTeamsInput, GetMsTeamsTeamsResponse } from './interfaces';
4
+ declare class MsTeamsClient {
5
+ private instance;
6
+ constructor(instance: Knock);
7
+ authCheck({ tenant: tenantId, knockChannelId }: AuthCheckInput): Promise<any>;
8
+ getTeams(input: GetMsTeamsTeamsInput): Promise<GetMsTeamsTeamsResponse>;
9
+ getChannels(input: GetMsTeamsChannelsInput): Promise<GetMsTeamsChannelsResponse>;
10
+ revokeAccessToken({ tenant: tenantId, knockChannelId, }: RevokeAccessTokenInput): Promise<any>;
11
+ private handleResponse;
12
+ }
13
+ export default MsTeamsClient;
14
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/ms-teams/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,KAAK,MAAM,aAAa,CAAC;AAGhC,OAAO,EACL,uBAAuB,EACvB,0BAA0B,EAC1B,oBAAoB,EACpB,uBAAuB,EACxB,MAAM,cAAc,CAAC;AAEtB,cAAM,aAAa;IACjB,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,QAAQ,EAAE,KAAK;IAIrB,SAAS,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,EAAE,cAAc;IAgB9D,QAAQ,CACZ,KAAK,EAAE,oBAAoB,GAC1B,OAAO,CAAC,uBAAuB,CAAC;IAwB7B,WAAW,CACf,KAAK,EAAE,uBAAuB,GAC7B,OAAO,CAAC,0BAA0B,CAAC;IAuBhC,iBAAiB,CAAC,EACtB,MAAM,EAAE,QAAQ,EAChB,cAAc,GACf,EAAE,sBAAsB;IAgBzB,OAAO,CAAC,cAAc;CAUvB;AAED,eAAe,aAAa,CAAC"}
@@ -0,0 +1,49 @@
1
+ export type MsTeamsChannelConnection = {
2
+ ms_teams_tenant_id?: string;
3
+ ms_teams_team_id?: string;
4
+ ms_teams_channel_id?: string;
5
+ ms_teams_user_id?: null;
6
+ incoming_webhook?: {
7
+ url: string;
8
+ };
9
+ };
10
+ export type GetMsTeamsTeamsInput = {
11
+ tenant: string;
12
+ knockChannelId: string;
13
+ queryOptions?: {
14
+ $filter?: string;
15
+ $select?: string;
16
+ $top?: number;
17
+ $skiptoken?: string;
18
+ };
19
+ };
20
+ export type GetMsTeamsChannelsInput = {
21
+ tenant: string;
22
+ knockChannelId: string;
23
+ teamId: string;
24
+ queryOptions?: {
25
+ $filter?: string;
26
+ $select?: string;
27
+ };
28
+ };
29
+ export type GetMsTeamsTeamsResponse = {
30
+ ms_teams_teams: MsTeamsTeam[];
31
+ skip_token: string | null;
32
+ };
33
+ export type GetMsTeamsChannelsResponse = {
34
+ ms_teams_channels: MsTeamsChannel[];
35
+ };
36
+ export type MsTeamsTeam = {
37
+ id: string;
38
+ displayName: string;
39
+ description?: string;
40
+ };
41
+ export type MsTeamsChannel = {
42
+ id: string;
43
+ displayName: string;
44
+ description?: string;
45
+ membershipType?: string;
46
+ isArchived?: boolean;
47
+ createdDateTime?: string;
48
+ };
49
+ //# sourceMappingURL=interfaces.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/ms-teams/interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,wBAAwB,GAAG;IACrC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,gBAAgB,CAAC,EAAE,IAAI,CAAC;IACxB,gBAAgB,CAAC,EAAE;QACjB,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,cAAc,EAAE,WAAW,EAAE,CAAC;IAC9B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,iBAAiB,EAAE,cAAc,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC"}
@@ -0,0 +1,2 @@
1
+ export declare const TENANT_OBJECT_COLLECTION = "$tenants";
2
+ //# sourceMappingURL=constants.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/clients/objects/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,wBAAwB,aAAa,CAAC"}
@@ -0,0 +1,23 @@
1
+ import { GenericData } from '@knocklabs/types';
2
+ import { ChannelData } from '../../interfaces';
3
+ import { default as Knock } from '../../knock';
4
+ type GetChannelDataInput = {
5
+ objectId: string;
6
+ collection: string;
7
+ channelId: string;
8
+ };
9
+ type SetChannelDataInput = {
10
+ objectId: string;
11
+ collection: string;
12
+ channelId: string;
13
+ data: GenericData;
14
+ };
15
+ declare class ObjectClient {
16
+ private instance;
17
+ constructor(instance: Knock);
18
+ getChannelData<T = GenericData>({ collection, objectId, channelId, }: GetChannelDataInput): Promise<ChannelData<T>>;
19
+ setChannelData({ objectId, collection, channelId, data, }: SetChannelDataInput): Promise<unknown>;
20
+ private handleResponse;
21
+ }
22
+ export default ObjectClient;
23
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/objects/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,MAAM,aAAa,CAAC;AAEhC,KAAK,mBAAmB,GAAG;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,WAAW,CAAC;CACnB,CAAC;AAEF,cAAM,YAAY;IAChB,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,QAAQ,EAAE,KAAK;IAGrB,cAAc,CAAC,CAAC,GAAG,WAAW,EAAE,EACpC,UAAU,EACV,QAAQ,EACR,SAAS,GACV,EAAE,mBAAmB;IAShB,cAAc,CAAC,EACnB,QAAQ,EACR,UAAU,EACV,SAAS,EACT,IAAI,GACL,EAAE,mBAAmB;IAUtB,OAAO,CAAC,cAAc;CAOvB;AAED,eAAe,YAAY,CAAC"}
@@ -0,0 +1,46 @@
1
+ import { ChannelType } from '@knocklabs/types';
2
+ import { default as Knock } from '../../knock';
3
+ import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, SetPreferencesProperties, WorkflowPreferenceSetting, WorkflowPreferences } from './interfaces';
4
+ declare class Preferences {
5
+ private instance;
6
+ constructor(instance: Knock);
7
+ /**
8
+ * @deprecated Use `user.getAllPreferences()` instead
9
+ */
10
+ getAll(): Promise<PreferenceSet>;
11
+ /**
12
+ * @deprecated Use `user.getPreferences()` instead
13
+ */
14
+ get(options?: PreferenceOptions): Promise<PreferenceSet>;
15
+ /**
16
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
17
+ */
18
+ set(preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<PreferenceSet>;
19
+ /**
20
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
21
+ */
22
+ setChannelTypes(channelTypePreferences: ChannelTypePreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
23
+ /**
24
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
25
+ */
26
+ setChannelType(channelType: ChannelType, setting: boolean, options?: PreferenceOptions): Promise<PreferenceSet>;
27
+ /**
28
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
29
+ */
30
+ setWorkflows(workflowPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
31
+ /**
32
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
33
+ */
34
+ setWorkflow(workflowKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
35
+ /**
36
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
37
+ */
38
+ setCategories(categoryPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
39
+ /**
40
+ * @deprecated Use `user.setPreferences(preferenceSet, options)` instead
41
+ */
42
+ setCategory(categoryKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
43
+ private handleResponse;
44
+ }
45
+ export default Preferences;
46
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/preferences/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,KAAK,MAAM,aAAa,CAAC;AAEhC,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,aAAa,EACb,wBAAwB,EACxB,yBAAyB,EACzB,mBAAmB,EACpB,MAAM,cAAc,CAAC;AAYtB,cAAM,WAAW;IACf,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,QAAQ,EAAE,KAAK;IAI3B;;OAEG;IACG,MAAM;IAWZ;;OAEG;IACG,GAAG,CAAC,OAAO,GAAE,iBAAsB;IAazC;;OAEG;IACG,GAAG,CACP,aAAa,EAAE,wBAAwB,EACvC,OAAO,GAAE,iBAAsB;IAejC;;OAEG;IACG,eAAe,CACnB,sBAAsB,EAAE,sBAAsB,EAC9C,OAAO,GAAE,iBAAsB;IAcjC;;OAEG;IACG,cAAc,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,iBAAsB;IAcjC;;OAEG;IACG,YAAY,CAChB,mBAAmB,EAAE,mBAAmB,EACxC,OAAO,GAAE,iBAAsB;IAcjC;;OAEG;IACG,WAAW,CACf,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,yBAAyB,EAClC,OAAO,GAAE,iBAAsB;IAgBjC;;OAEG;IACG,aAAa,CACjB,mBAAmB,EAAE,mBAAmB,EACxC,OAAO,GAAE,iBAAsB;IAejC;;OAEG;IACG,WAAW,CACf,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,yBAAyB,EAClC,OAAO,GAAE,iBAAsB;IAgBjC,OAAO,CAAC,cAAc;CAOvB;AAED,eAAe,WAAW,CAAC"}
@@ -0,0 +1,29 @@
1
+ import { ChannelType, Condition } from '@knocklabs/types';
2
+ export type ConditionalPreferenceSettings = {
3
+ conditions: Condition[];
4
+ };
5
+ export type ChannelTypePreferences = {
6
+ [_K in ChannelType]?: boolean | ConditionalPreferenceSettings;
7
+ };
8
+ export type WorkflowPreferenceSetting = boolean | {
9
+ channel_types: ChannelTypePreferences;
10
+ } | ConditionalPreferenceSettings;
11
+ export type WorkflowPreferences = Partial<Record<string, WorkflowPreferenceSetting>>;
12
+ export interface SetPreferencesProperties {
13
+ workflows: WorkflowPreferences;
14
+ categories: WorkflowPreferences;
15
+ channel_types: ChannelTypePreferences;
16
+ }
17
+ export interface PreferenceSet {
18
+ id: string;
19
+ categories: WorkflowPreferences | null;
20
+ workflows: WorkflowPreferences | null;
21
+ channel_types: ChannelTypePreferences | null;
22
+ }
23
+ export interface PreferenceOptions {
24
+ preferenceSet?: string;
25
+ }
26
+ export interface GetPreferencesOptions extends PreferenceOptions {
27
+ tenant?: string;
28
+ }
29
+ //# sourceMappingURL=interfaces.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/preferences/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE1D,MAAM,MAAM,6BAA6B,GAAG;IAC1C,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;KAClC,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,6BAA6B;CAC9D,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,OAAO,GACP;IAAE,aAAa,EAAE,sBAAsB,CAAA;CAAE,GACzC,6BAA6B,CAAC;AAElC,MAAM,MAAM,mBAAmB,GAAG,OAAO,CACvC,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAC1C,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,UAAU,EAAE,mBAAmB,CAAC;IAChC,aAAa,EAAE,sBAAsB,CAAC;CACvC;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACvC,SAAS,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACtC,aAAa,EAAE,sBAAsB,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,iBAAiB;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
@@ -0,0 +1,13 @@
1
+ import { AuthCheckInput, RevokeAccessTokenInput } from '../../interfaces';
2
+ import { default as Knock } from '../../knock';
3
+ import { GetSlackChannelsInput, GetSlackChannelsResponse } from './interfaces';
4
+ declare class SlackClient {
5
+ private instance;
6
+ constructor(instance: Knock);
7
+ authCheck({ tenant, knockChannelId }: AuthCheckInput): Promise<any>;
8
+ getChannels(input: GetSlackChannelsInput): Promise<GetSlackChannelsResponse>;
9
+ revokeAccessToken({ tenant, knockChannelId }: RevokeAccessTokenInput): Promise<any>;
10
+ private handleResponse;
11
+ }
12
+ export default SlackClient;
13
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/slack/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,KAAK,MAAM,aAAa,CAAC;AAGhC,OAAO,EAAE,qBAAqB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAE/E,cAAM,WAAW;IACf,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,QAAQ,EAAE,KAAK;IAIrB,SAAS,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,cAAc;IAgBpD,WAAW,CACf,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,wBAAwB,CAAC;IA0B9B,iBAAiB,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,sBAAsB;IAgB1E,OAAO,CAAC,cAAc;CAUvB;AAED,eAAe,WAAW,CAAC"}
@@ -0,0 +1,29 @@
1
+ export type SlackChannelConnection = {
2
+ access_token?: string;
3
+ channel_id?: string;
4
+ incoming_webhook?: string;
5
+ user_id?: null;
6
+ };
7
+ export type GetSlackChannelsInput = {
8
+ tenant: string;
9
+ knockChannelId: string;
10
+ queryOptions?: {
11
+ limit?: number;
12
+ cursor?: string;
13
+ excludeArchived?: boolean;
14
+ teamId?: string;
15
+ types?: string;
16
+ };
17
+ };
18
+ export type GetSlackChannelsResponse = {
19
+ slack_channels: SlackChannel[];
20
+ next_cursor: string | null;
21
+ };
22
+ export type SlackChannel = {
23
+ name: string;
24
+ id: string;
25
+ is_private: boolean;
26
+ is_im: boolean;
27
+ context_team_id: boolean;
28
+ };
29
+ //# sourceMappingURL=interfaces.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/slack/interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,sBAAsB,GAAG;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,cAAc,EAAE,YAAY,EAAE,CAAC;IAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,OAAO,CAAC;IACpB,KAAK,EAAE,OAAO,CAAC;IACf,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC"}
@@ -0,0 +1,22 @@
1
+ import { GenericData } from '@knocklabs/types';
2
+ import { ChannelData, User } from '../../interfaces';
3
+ import { default as Knock } from '../../knock';
4
+ import { GuideEngagementEventBaseParams } from '../guide/client';
5
+ import { GetPreferencesOptions, PreferenceOptions, PreferenceSet, SetPreferencesProperties } from '../preferences/interfaces';
6
+ import { GetChannelDataInput, SetChannelDataInput } from './interfaces';
7
+ declare class UserClient {
8
+ private instance;
9
+ constructor(instance: Knock);
10
+ get(): Promise<User>;
11
+ identify(props?: GenericData): Promise<User>;
12
+ getAllPreferences(): Promise<PreferenceSet[]>;
13
+ getPreferences(options?: GetPreferencesOptions): Promise<PreferenceSet>;
14
+ setPreferences(preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<PreferenceSet>;
15
+ getChannelData<T = GenericData>(params: GetChannelDataInput): Promise<ChannelData<T>>;
16
+ setChannelData<T = GenericData>({ channelId, channelData, }: SetChannelDataInput): Promise<ChannelData<T>>;
17
+ getGuides<P, R>(channelId: string, params: P): Promise<R>;
18
+ markGuideStepAs<P extends GuideEngagementEventBaseParams, R>(status: "seen" | "interacted" | "archived", params: P): Promise<R>;
19
+ private handleResponse;
20
+ }
21
+ export default UserClient;
22
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/users/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,MAAM,aAAa,CAAC;AAChC,OAAO,EACL,8BAA8B,EAE/B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,aAAa,EACb,wBAAwB,EACzB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAIxE,cAAM,UAAU;IACd,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,QAAQ,EAAE,KAAK;IAIrB,GAAG;IAWH,QAAQ,CAAC,KAAK,GAAE,WAAgB;IAYhC,iBAAiB;IAWjB,cAAc,CAClB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;IAanB,cAAc,CAClB,aAAa,EAAE,wBAAwB,EACvC,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,aAAa,CAAC;IAanB,cAAc,CAAC,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,mBAAmB;IAW3D,cAAc,CAAC,CAAC,GAAG,WAAW,EAAE,EACpC,SAAS,EACT,WAAW,GACZ,EAAE,mBAAmB;IAYhB,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAU5C,eAAe,CAAC,CAAC,SAAS,8BAA8B,EAAE,CAAC,EAC/D,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,UAAU,EAC1C,MAAM,EAAE,CAAC;IAWX,OAAO,CAAC,cAAc;CAOvB;AAED,eAAe,UAAU,CAAC"}
@@ -0,0 +1,9 @@
1
+ import { GenericData } from '@knocklabs/types';
2
+ export interface SetChannelDataInput {
3
+ channelId: string;
4
+ channelData: GenericData;
5
+ }
6
+ export interface GetChannelDataInput {
7
+ channelId: string;
8
+ }
9
+ //# sourceMappingURL=interfaces.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/users/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;CACnB"}
@@ -0,0 +1,2 @@
1
+ export declare function isValidUuid(uuid: string): boolean;
2
+ //# sourceMappingURL=helpers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAGA,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,WAEvC"}
@@ -0,0 +1,21 @@
1
+ import { default as FeedClient, Feed } from './clients/feed';
2
+ import { default as Knock } from './knock';
3
+ export * from './interfaces';
4
+ export * from './clients/guide';
5
+ export * from './clients/feed/types';
6
+ export * from './clients/feed/interfaces';
7
+ export * from './clients/objects';
8
+ export * from './clients/objects/constants';
9
+ export * from './clients/preferences/interfaces';
10
+ export * from './clients/slack';
11
+ export * from './clients/slack/interfaces';
12
+ export * from './clients/ms-teams';
13
+ export * from './clients/ms-teams/interfaces';
14
+ export * from './clients/users';
15
+ export * from './clients/users/interfaces';
16
+ export * from './clients/messages';
17
+ export * from './clients/messages/interfaces';
18
+ export * from './networkStatus';
19
+ export default Knock;
20
+ export { Feed, FeedClient };
21
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iBAAiB,CAAC;AAEhC,eAAe,KAAK,CAAC;AACrB,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC"}
@@ -0,0 +1,72 @@
1
+ import { GenericData } from '@knocklabs/types';
2
+ import { JwtPayload } from 'jwt-decode';
3
+ import { default as Knock } from './knock';
4
+ export type LogLevel = "debug";
5
+ export interface KnockOptions {
6
+ host?: string;
7
+ logLevel?: LogLevel;
8
+ }
9
+ export interface KnockObject<T = GenericData> {
10
+ id: string;
11
+ collection: string;
12
+ properties: T;
13
+ updated_at: string;
14
+ created_at: string | null;
15
+ }
16
+ export interface User extends GenericData {
17
+ id: string;
18
+ email: string | null;
19
+ name: string | null;
20
+ phone_number: string | null;
21
+ avatar: string | null;
22
+ updated_at: string;
23
+ created_at: string | null;
24
+ }
25
+ export type Recipient = User | KnockObject;
26
+ export type RecipientRef = string | {
27
+ collection: string;
28
+ id: string;
29
+ };
30
+ export interface Activity<T = GenericData> {
31
+ id: string;
32
+ inserted_at: string;
33
+ updated_at: string;
34
+ recipient: Recipient;
35
+ actor: Recipient | null;
36
+ data: T | null;
37
+ }
38
+ export interface ChannelData<T = GenericData> {
39
+ channel_id: string;
40
+ data: T;
41
+ }
42
+ export type UserTokenExpiringCallback = (currentToken: string, decodedToken: JwtPayload) => Promise<string | void>;
43
+ export interface AuthenticateOptions {
44
+ onUserTokenExpiring?: UserTokenExpiringCallback;
45
+ timeBeforeExpirationInMs?: number;
46
+ }
47
+ export interface BulkOperation {
48
+ id: string;
49
+ name: string;
50
+ status: "queued" | "processing" | "completed" | "failed";
51
+ processed_rows: number;
52
+ estimated_total_rows: number;
53
+ started_at?: string;
54
+ completed_at?: string;
55
+ failed_at?: string;
56
+ inserted_at: string;
57
+ updated_at: string;
58
+ }
59
+ export type AuthCheckInput = {
60
+ tenant: string;
61
+ knockChannelId: string;
62
+ };
63
+ export type RevokeAccessTokenInput = {
64
+ tenant: string;
65
+ knockChannelId: string;
66
+ };
67
+ export type UserId = Knock["userId"];
68
+ export type UserWithProperties = {
69
+ id: UserId;
70
+ } & GenericData;
71
+ export type UserIdOrUserWithProperties = UserId | UserWithProperties;
72
+ //# sourceMappingURL=interfaces.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC;AAE/B,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,WAAW;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,CAAC,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,WAAW,CAAC;AAE3C,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvE,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,WAAW;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;CAChB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,WAAW;IAC1C,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,MAAM,yBAAyB,GAAG,CACtC,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,UAAU,KACrB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;AAE5B,MAAM,WAAW,mBAAmB;IAClC,mBAAmB,CAAC,EAAE,yBAAyB,CAAC;IAChD,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,QAAQ,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IACzD,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AACrC,MAAM,MAAM,kBAAkB,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG,WAAW,CAAC;AAC9D,MAAM,MAAM,0BAA0B,GAAG,MAAM,GAAG,kBAAkB,CAAC"}
@@ -0,0 +1,55 @@
1
+ import { default as ApiClient } from './api';
2
+ import { default as FeedClient } from './clients/feed';
3
+ import { default as MessageClient } from './clients/messages';
4
+ import { default as MsTeamsClient } from './clients/ms-teams';
5
+ import { default as ObjectClient } from './clients/objects';
6
+ import { default as Preferences } from './clients/preferences';
7
+ import { default as SlackClient } from './clients/slack';
8
+ import { default as UserClient } from './clients/users';
9
+ import { AuthenticateOptions, KnockOptions, LogLevel, UserId, UserIdOrUserWithProperties } from './interfaces';
10
+ declare class Knock {
11
+ readonly apiKey: string;
12
+ host: string;
13
+ private apiClient;
14
+ userId: string | undefined | null;
15
+ userToken?: string;
16
+ logLevel?: LogLevel;
17
+ private tokenExpirationTimer;
18
+ readonly feeds: FeedClient;
19
+ readonly objects: ObjectClient;
20
+ readonly preferences: Preferences;
21
+ readonly slack: SlackClient;
22
+ readonly msTeams: MsTeamsClient;
23
+ readonly user: UserClient;
24
+ readonly messages: MessageClient;
25
+ constructor(apiKey: string, options?: KnockOptions);
26
+ client(): ApiClient;
27
+ /**
28
+ * @deprecated Passing `userId` as a `string` is deprecated and will be removed in a future version.
29
+ * Please pass a `user` object instead containing an `id` value.
30
+ * example:
31
+ * ```ts
32
+ * knock.authenticate({ id: "user_123" });
33
+ * ```
34
+ */
35
+ authenticate(userIdOrUserWithProperties: UserId, userToken?: Knock["userToken"], options?: AuthenticateOptions): never;
36
+ authenticate(userIdOrUserWithProperties: UserIdOrUserWithProperties, userToken?: Knock["userToken"], options?: AuthenticateOptions): void;
37
+ failIfNotAuthenticated(): void;
38
+ isAuthenticated(checkUserToken?: boolean): boolean;
39
+ teardown(): void;
40
+ log(message: string, force?: boolean): void;
41
+ /**
42
+ * Initiates an API client
43
+ */
44
+ private createApiClient;
45
+ private maybeScheduleUserTokenExpiration;
46
+ /**
47
+ * Returns the user id from the given userIdOrUserWithProperties
48
+ * @param userIdOrUserWithProperties - The user id or user object
49
+ * @returns The user id
50
+ * @throws {Error} If the user object does not contain an `id` property
51
+ */
52
+ private getUserId;
53
+ }
54
+ export default Knock;
55
+ //# sourceMappingURL=knock.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"knock.d.ts","sourceRoot":"","sources":["../../src/knock.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,OAAO,CAAC;AAC9B,OAAO,UAAU,MAAM,gBAAgB,CAAC;AACxC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAChD,OAAO,WAAW,MAAM,iBAAiB,CAAC;AAC1C,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,EACL,mBAAmB,EACnB,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,0BAA0B,EAE3B,MAAM,cAAc,CAAC;AAItB,cAAM,KAAK;IAgBP,QAAQ,CAAC,MAAM,EAAE,MAAM;IAflB,IAAI,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,SAAS,CAA0B;IACpC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAC3B,OAAO,CAAC,oBAAoB,CAA8C;IAC1E,QAAQ,CAAC,KAAK,aAAwB;IACtC,QAAQ,CAAC,OAAO,eAA0B;IAC1C,QAAQ,CAAC,WAAW,cAAyB;IAC7C,QAAQ,CAAC,KAAK,cAAyB;IACvC,QAAQ,CAAC,OAAO,gBAA2B;IAC3C,QAAQ,CAAC,IAAI,aAAwB;IACrC,QAAQ,CAAC,QAAQ,gBAA2B;gBAGjC,MAAM,EAAE,MAAM,EACvB,OAAO,GAAE,YAAiB;IAe5B,MAAM;IASN;;;;;;;OAOG;IACH,YAAY,CACV,0BAA0B,EAAE,MAAM,EAClC,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,EAC9B,OAAO,CAAC,EAAE,mBAAmB,GAC5B,KAAK;IACR,YAAY,CACV,0BAA0B,EAAE,0BAA0B,EACtD,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,EAC9B,OAAO,CAAC,EAAE,mBAAmB,GAC5B,IAAI;IAuDP,sBAAsB;IAUtB,eAAe,CAAC,cAAc,UAAQ;IAKtC,QAAQ;IASR,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,UAAQ;IAMlC;;OAEG;IACH,OAAO,CAAC,eAAe;YAQT,gCAAgC;IA+B9C;;;;;OAKG;IACH,OAAO,CAAC,SAAS;CAclB;AAED,eAAe,KAAK,CAAC"}
@@ -0,0 +1,8 @@
1
+ export declare enum NetworkStatus {
2
+ loading = "loading",
3
+ fetchMore = "fetchMore",
4
+ ready = "ready",
5
+ error = "error"
6
+ }
7
+ export declare function isRequestInFlight(networkStatus: NetworkStatus): boolean;
8
+ //# sourceMappingURL=networkStatus.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"networkStatus.d.ts","sourceRoot":"","sources":["../../src/networkStatus.ts"],"names":[],"mappings":"AAAA,oBAAY,aAAa;IAEvB,OAAO,YAAY;IAGnB,SAAS,cAAc;IAGvB,KAAK,UAAU;IAGf,KAAK,UAAU;CAChB;AAED,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAIvE"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knocklabs/client",
3
- "version": "0.14.10",
3
+ "version": "0.15.0",
4
4
  "description": "The clientside library for interacting with Knock",
5
5
  "homepage": "https://github.com/knocklabs/javascript/tree/main/packages/client",
6
6
  "author": "@knocklabs",
@@ -52,6 +52,7 @@
52
52
  "@babel/plugin-transform-runtime": "^7.25.4",
53
53
  "@babel/preset-env": "^7.27.1",
54
54
  "@babel/preset-typescript": "^7.27.0",
55
+ "@codecov/vite-plugin": "^1.9.1",
55
56
  "@types/jsonwebtoken": "^9.0.9",
56
57
  "@typescript-eslint/eslint-plugin": "^8.32.0",
57
58
  "@typescript-eslint/parser": "^8.32.1",
package/src/interfaces.ts CHANGED
@@ -1,6 +1,8 @@
1
1
  import { GenericData } from "@knocklabs/types";
2
2
  import { JwtPayload } from "jwt-decode";
3
3
 
4
+ import Knock from "./knock";
5
+
4
6
  export type LogLevel = "debug";
5
7
 
6
8
  export interface KnockOptions {
@@ -76,3 +78,7 @@ export type RevokeAccessTokenInput = {
76
78
  tenant: string;
77
79
  knockChannelId: string;
78
80
  };
81
+
82
+ export type UserId = Knock["userId"];
83
+ export type UserWithProperties = { id: UserId } & GenericData;
84
+ export type UserIdOrUserWithProperties = UserId | UserWithProperties;