@decaf-ts/integrations 0.12.0 → 0.14.2

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 (156) hide show
  1. package/dist/integrations.cjs +1 -1
  2. package/lib/cjs/calendar/environment.cjs +48 -0
  3. package/lib/cjs/calendar/environment.cjs.map +1 -0
  4. package/lib/cjs/calendar/google-calendar/GoogleCalendarService.cjs +338 -0
  5. package/lib/cjs/calendar/google-calendar/GoogleCalendarService.cjs.map +1 -0
  6. package/lib/cjs/calendar/google-calendar/index.cjs +20 -0
  7. package/lib/cjs/calendar/google-calendar/index.cjs.map +1 -0
  8. package/lib/cjs/comms/discord/DiscordService.cjs +318 -0
  9. package/lib/cjs/comms/discord/DiscordService.cjs.map +1 -0
  10. package/lib/cjs/comms/discord/index.cjs +19 -0
  11. package/lib/cjs/comms/discord/index.cjs.map +1 -0
  12. package/lib/cjs/comms/environment.cjs +16 -0
  13. package/lib/cjs/comms/environment.cjs.map +1 -1
  14. package/lib/cjs/comms/index.cjs +3 -0
  15. package/lib/cjs/comms/index.cjs.map +1 -1
  16. package/lib/cjs/comms/outlook/MicrosoftOutlookService.cjs +325 -0
  17. package/lib/cjs/comms/outlook/MicrosoftOutlookService.cjs.map +1 -0
  18. package/lib/cjs/comms/outlook/index.cjs +19 -0
  19. package/lib/cjs/comms/outlook/index.cjs.map +1 -0
  20. package/lib/cjs/comms/whatsapp/WhatsAppService.cjs +274 -0
  21. package/lib/cjs/comms/whatsapp/WhatsAppService.cjs.map +1 -0
  22. package/lib/cjs/comms/whatsapp/index.cjs +19 -0
  23. package/lib/cjs/comms/whatsapp/index.cjs.map +1 -0
  24. package/lib/cjs/index.cjs +3 -3
  25. package/lib/cjs/io/confluence/ConfluenceService.cjs +317 -0
  26. package/lib/cjs/io/confluence/ConfluenceService.cjs.map +1 -0
  27. package/lib/cjs/io/confluence/index.cjs +19 -0
  28. package/lib/cjs/io/confluence/index.cjs.map +1 -0
  29. package/lib/cjs/io/environment.cjs +28 -0
  30. package/lib/cjs/io/environment.cjs.map +1 -1
  31. package/lib/cjs/io/google-docs/GoogleDocsService.cjs +275 -0
  32. package/lib/cjs/io/google-docs/GoogleDocsService.cjs.map +1 -0
  33. package/lib/cjs/io/google-docs/index.cjs +19 -0
  34. package/lib/cjs/io/google-docs/index.cjs.map +1 -0
  35. package/lib/cjs/io/index.cjs +5 -0
  36. package/lib/cjs/io/index.cjs.map +1 -1
  37. package/lib/cjs/io/jira/JiraService.cjs +354 -0
  38. package/lib/cjs/io/jira/JiraService.cjs.map +1 -0
  39. package/lib/cjs/io/jira/index.cjs +19 -0
  40. package/lib/cjs/io/jira/index.cjs.map +1 -0
  41. package/lib/cjs/io/microsoft-excel/MicrosoftExcelService.cjs +253 -0
  42. package/lib/cjs/io/microsoft-excel/MicrosoftExcelService.cjs.map +1 -0
  43. package/lib/cjs/io/microsoft-excel/index.cjs +19 -0
  44. package/lib/cjs/io/microsoft-excel/index.cjs.map +1 -0
  45. package/lib/cjs/io/microsoft-sharepoint/MicrosoftSharePointService.cjs +261 -0
  46. package/lib/cjs/io/microsoft-sharepoint/MicrosoftSharePointService.cjs.map +1 -0
  47. package/lib/cjs/io/microsoft-sharepoint/index.cjs +19 -0
  48. package/lib/cjs/io/microsoft-sharepoint/index.cjs.map +1 -0
  49. package/lib/cjs/sftp/aws/index.cjs +24 -0
  50. package/lib/cjs/sftp/aws/index.cjs.map +1 -0
  51. package/lib/cjs/sftp/ssh2/index.cjs +24 -0
  52. package/lib/cjs/sftp/ssh2/index.cjs.map +1 -0
  53. package/lib/esm/calendar/environment.js +44 -0
  54. package/lib/esm/calendar/environment.js.map +1 -0
  55. package/lib/esm/calendar/google-calendar/GoogleCalendarService.js +333 -0
  56. package/lib/esm/calendar/google-calendar/GoogleCalendarService.js.map +1 -0
  57. package/lib/esm/calendar/google-calendar/index.js +3 -0
  58. package/lib/esm/calendar/google-calendar/index.js.map +1 -0
  59. package/lib/esm/comms/discord/DiscordService.js +313 -0
  60. package/lib/esm/comms/discord/DiscordService.js.map +1 -0
  61. package/lib/esm/comms/discord/index.js +2 -0
  62. package/lib/esm/comms/discord/index.js.map +1 -0
  63. package/lib/esm/comms/environment.js +16 -0
  64. package/lib/esm/comms/environment.js.map +1 -1
  65. package/lib/esm/comms/index.js +3 -0
  66. package/lib/esm/comms/index.js.map +1 -1
  67. package/lib/esm/comms/outlook/MicrosoftOutlookService.js +320 -0
  68. package/lib/esm/comms/outlook/MicrosoftOutlookService.js.map +1 -0
  69. package/lib/esm/comms/outlook/index.js +2 -0
  70. package/lib/esm/comms/outlook/index.js.map +1 -0
  71. package/lib/esm/comms/whatsapp/WhatsAppService.js +269 -0
  72. package/lib/esm/comms/whatsapp/WhatsAppService.js.map +1 -0
  73. package/lib/esm/comms/whatsapp/index.js +2 -0
  74. package/lib/esm/comms/whatsapp/index.js.map +1 -0
  75. package/lib/esm/index.js +3 -3
  76. package/lib/esm/io/confluence/ConfluenceService.js +312 -0
  77. package/lib/esm/io/confluence/ConfluenceService.js.map +1 -0
  78. package/lib/esm/io/confluence/index.js +2 -0
  79. package/lib/esm/io/confluence/index.js.map +1 -0
  80. package/lib/esm/io/environment.js +28 -0
  81. package/lib/esm/io/environment.js.map +1 -1
  82. package/lib/esm/io/google-docs/GoogleDocsService.js +270 -0
  83. package/lib/esm/io/google-docs/GoogleDocsService.js.map +1 -0
  84. package/lib/esm/io/google-docs/index.js +2 -0
  85. package/lib/esm/io/google-docs/index.js.map +1 -0
  86. package/lib/esm/io/index.js +5 -0
  87. package/lib/esm/io/index.js.map +1 -1
  88. package/lib/esm/io/jira/JiraService.js +349 -0
  89. package/lib/esm/io/jira/JiraService.js.map +1 -0
  90. package/lib/esm/io/jira/index.js +2 -0
  91. package/lib/esm/io/jira/index.js.map +1 -0
  92. package/lib/esm/io/microsoft-excel/MicrosoftExcelService.js +248 -0
  93. package/lib/esm/io/microsoft-excel/MicrosoftExcelService.js.map +1 -0
  94. package/lib/esm/io/microsoft-excel/index.js +2 -0
  95. package/lib/esm/io/microsoft-excel/index.js.map +1 -0
  96. package/lib/esm/io/microsoft-sharepoint/MicrosoftSharePointService.js +256 -0
  97. package/lib/esm/io/microsoft-sharepoint/MicrosoftSharePointService.js.map +1 -0
  98. package/lib/esm/io/microsoft-sharepoint/index.js +2 -0
  99. package/lib/esm/io/microsoft-sharepoint/index.js.map +1 -0
  100. package/lib/esm/sftp/aws/index.js +7 -0
  101. package/lib/esm/sftp/aws/index.js.map +1 -0
  102. package/lib/esm/sftp/ssh2/index.js +7 -0
  103. package/lib/esm/sftp/ssh2/index.js.map +1 -0
  104. package/lib/types/calendar/environment.d.cts +48 -0
  105. package/lib/types/calendar/environment.d.mts +48 -0
  106. package/lib/types/calendar/google-calendar/GoogleCalendarService.d.cts +316 -0
  107. package/lib/types/calendar/google-calendar/GoogleCalendarService.d.mts +316 -0
  108. package/lib/types/calendar/google-calendar/index.d.cts +2 -0
  109. package/lib/types/calendar/google-calendar/index.d.mts +2 -0
  110. package/lib/types/comms/discord/DiscordService.d.cts +285 -0
  111. package/lib/types/comms/discord/DiscordService.d.mts +285 -0
  112. package/lib/types/comms/discord/index.d.cts +1 -0
  113. package/lib/types/comms/discord/index.d.mts +1 -0
  114. package/lib/types/comms/environment.d.cts +34 -8
  115. package/lib/types/comms/environment.d.mts +34 -8
  116. package/lib/types/comms/index.d.cts +3 -0
  117. package/lib/types/comms/index.d.mts +3 -0
  118. package/lib/types/comms/outlook/MicrosoftOutlookService.d.cts +282 -0
  119. package/lib/types/comms/outlook/MicrosoftOutlookService.d.mts +282 -0
  120. package/lib/types/comms/outlook/index.d.cts +1 -0
  121. package/lib/types/comms/outlook/index.d.mts +1 -0
  122. package/lib/types/comms/whatsapp/WhatsAppService.d.cts +258 -0
  123. package/lib/types/comms/whatsapp/WhatsAppService.d.mts +258 -0
  124. package/lib/types/comms/whatsapp/index.d.cts +1 -0
  125. package/lib/types/comms/whatsapp/index.d.mts +1 -0
  126. package/lib/types/index.d.cts +2 -2
  127. package/lib/types/index.d.mts +2 -2
  128. package/lib/types/io/confluence/ConfluenceService.d.cts +250 -0
  129. package/lib/types/io/confluence/ConfluenceService.d.mts +250 -0
  130. package/lib/types/io/confluence/index.d.cts +1 -0
  131. package/lib/types/io/confluence/index.d.mts +1 -0
  132. package/lib/types/io/environment.d.cts +52 -12
  133. package/lib/types/io/environment.d.mts +52 -12
  134. package/lib/types/io/google-docs/GoogleDocsService.d.cts +188 -0
  135. package/lib/types/io/google-docs/GoogleDocsService.d.mts +188 -0
  136. package/lib/types/io/google-docs/index.d.cts +1 -0
  137. package/lib/types/io/google-docs/index.d.mts +1 -0
  138. package/lib/types/io/index.d.cts +5 -0
  139. package/lib/types/io/index.d.mts +5 -0
  140. package/lib/types/io/jira/JiraService.d.cts +300 -0
  141. package/lib/types/io/jira/JiraService.d.mts +300 -0
  142. package/lib/types/io/jira/index.d.cts +1 -0
  143. package/lib/types/io/jira/index.d.mts +1 -0
  144. package/lib/types/io/microsoft-excel/MicrosoftExcelService.d.cts +230 -0
  145. package/lib/types/io/microsoft-excel/MicrosoftExcelService.d.mts +230 -0
  146. package/lib/types/io/microsoft-excel/index.d.cts +1 -0
  147. package/lib/types/io/microsoft-excel/index.d.mts +1 -0
  148. package/lib/types/io/microsoft-sharepoint/MicrosoftSharePointService.d.cts +226 -0
  149. package/lib/types/io/microsoft-sharepoint/MicrosoftSharePointService.d.mts +226 -0
  150. package/lib/types/io/microsoft-sharepoint/index.d.cts +1 -0
  151. package/lib/types/io/microsoft-sharepoint/index.d.mts +1 -0
  152. package/lib/types/sftp/aws/index.d.cts +6 -0
  153. package/lib/types/sftp/aws/index.d.mts +6 -0
  154. package/lib/types/sftp/ssh2/index.d.cts +6 -0
  155. package/lib/types/sftp/ssh2/index.d.mts +6 -0
  156. package/package.json +263 -59
@@ -0,0 +1,320 @@
1
+ /**
2
+ * @module integrations/comms/outlook/service
3
+ * @summary Microsoft Outlook mail and calendar integration service (Microsoft Graph).
4
+ * @description Exposes Outlook mail (`sendMail`, `listMessages`, `getMessage`)
5
+ * and calendar (`listEvents`, `createEvent`, `deleteEvent`) operations through
6
+ * Microsoft Graph `v1.0` as an undecorated client-based service built on
7
+ * {@link HttpApiService}. Configuration comes from an explicit
8
+ * `OutlookServiceConfig` or the `comms.outlook` environment slice; the access
9
+ * token is sent as `Authorization: Bearer <token>`. Credentials are referenced
10
+ * from configuration (and, from as-graph nodes, from the resolved
11
+ * `microsoft-outlook` credential secret) and are never embedded in source.
12
+ * Failures are mapped to decaf errors via {@link httpError}.
13
+ */
14
+ import { InternalError } from "@decaf-ts/db-decorators";
15
+ import { CommsEnvironment } from "./../environment.js";
16
+ import { envNumber, envString } from "./../../shared/environmentValue.js";
17
+ import { HttpApiService, httpError, } from "./../../shared/http/index.js";
18
+ /**
19
+ * @description Normalizes Outlook recipient addresses into Graph recipients
20
+ * @summary Accepts a single address, an array, or a comma/semicolon-separated
21
+ * string, trims entries, drops blanks, and maps each address to the Graph
22
+ * `{ emailAddress: { address } }` envelope.
23
+ * @param {string | string[] | undefined} value - The raw recipient value.
24
+ * @returns {Array<{ emailAddress: { address: string } }>} The Graph recipient envelopes.
25
+ */
26
+ function recipientList(value) {
27
+ if (!value)
28
+ return [];
29
+ const values = Array.isArray(value)
30
+ ? value
31
+ : value.split(/[,;]/).map((entry) => entry.trim());
32
+ return values
33
+ .map((entry) => entry.trim())
34
+ .filter((entry) => entry.length > 0)
35
+ .map((address) => ({ emailAddress: { address } }));
36
+ }
37
+ /**
38
+ * @description Microsoft Outlook (Graph) mail and calendar integration service
39
+ * @summary An undecorated HTTP service for sending and reading mail and for
40
+ * listing, creating, and deleting calendar events on the signed-in user
41
+ * (`/me`). Every operation requires a Graph access token; missing credentials
42
+ * or identifiers raise `InternalError`, and transport failures are mapped to
43
+ * decaf errors via {@link httpError}.
44
+ * @class MicrosoftOutlookService
45
+ * @extends HttpApiService
46
+ * @category Comms
47
+ * @example
48
+ * ```ts
49
+ * import { MicrosoftOutlookService } from "@decaf-ts/integrations/comms/outlook";
50
+ *
51
+ * const outlook = new MicrosoftOutlookService();
52
+ * await outlook.initialize({
53
+ * token: process.env.GRAPH_CREDENTIAL_MICROSOFT_OUTLOOK_TOKEN,
54
+ * });
55
+ * await outlook.sendMail({
56
+ * to: "team@example.com",
57
+ * subject: "Deployment finished",
58
+ * body: "Release 1.2.0 is live",
59
+ * });
60
+ * ```
61
+ * @mermaid
62
+ * sequenceDiagram
63
+ * autonumber
64
+ * participant Caller
65
+ * participant Service as MicrosoftOutlookService
66
+ * participant Graph as Microsoft Graph
67
+ * Caller->>Service: sendMail(input)
68
+ * activate Service
69
+ * Service->>Service: requireAccessToken()
70
+ * Service->>Graph: POST /me/sendMail
71
+ * activate Graph
72
+ * Graph-->>Service: 202 Accepted
73
+ * deactivate Graph
74
+ * Service-->>Caller: { sent, to, subject }
75
+ * deactivate Service
76
+ * @memberOf module:integrations/comms/outlook/service
77
+ */
78
+ export class MicrosoftOutlookService extends HttpApiService {
79
+ constructor() {
80
+ super(...arguments);
81
+ /**
82
+ * @description The provider name used in error messages
83
+ */
84
+ this.serviceName = "Microsoft Outlook";
85
+ }
86
+ /**
87
+ * @description The Microsoft Graph base URL
88
+ * @summary Used when the resolved config carries no `baseUrl`.
89
+ * @returns {string} `"https://graph.microsoft.com/v1.0"`.
90
+ */
91
+ defaultBaseUrl() {
92
+ return "https://graph.microsoft.com/v1.0";
93
+ }
94
+ /**
95
+ * @description Builds the Microsoft Graph bearer authorization headers
96
+ * @summary Returns `Authorization: Bearer <token>` when configured, and no
97
+ * headers otherwise.
98
+ * @param {OutlookServiceConfig} config - The resolved service configuration.
99
+ * @returns {Record<string, string>} The authorization headers (empty without a token).
100
+ */
101
+ authHeaders(config) {
102
+ return config.token ? { Authorization: `Bearer ${config.token}` } : {};
103
+ }
104
+ /**
105
+ * @description Reads the Outlook credentials and defaults from the environment
106
+ * @summary Reads the `comms.outlook` slice and returns a partial config when
107
+ * an access token is configured, `undefined` otherwise. Values pass through
108
+ * `envString`/`envNumber` to reject unset-leaf proxies.
109
+ * @returns {Partial<OutlookServiceConfig> | undefined} A partial config, or `undefined` when no Outlook token is configured.
110
+ */
111
+ configFromEnvironment() {
112
+ const env = CommsEnvironment.comms.outlook;
113
+ const token = envString(env?.token);
114
+ if (!token)
115
+ return undefined;
116
+ return {
117
+ token,
118
+ baseUrl: envString(env.baseUrl),
119
+ timeout: envNumber(env.timeout),
120
+ };
121
+ }
122
+ /**
123
+ * @description Asserts that a Microsoft Graph access token is configured
124
+ * @summary Delegates to the shared `requireToken()` guard used by every
125
+ * operation.
126
+ * @returns {void}
127
+ * @throws {InternalError} When the resolved config has no `token`.
128
+ */
129
+ requireAccessToken() {
130
+ this.requireToken();
131
+ }
132
+ /**
133
+ * @description Sends a mail message through Outlook
134
+ * @summary `POST`s the message to `/me/sendMail`; recipients are normalized
135
+ * to Graph envelopes and `saveToSentItems` defaults to `true`.
136
+ * @param {OutlookMailInput} input - The recipients, subject, body, and content options.
137
+ * @returns {Promise<unknown>} `{ sent: true, to, subject }` on success.
138
+ * @throws {InternalError} When no token is configured, or recipients or subject are missing.
139
+ * @throws {BadRequestError} When Graph rejects the request.
140
+ * @example
141
+ * ```ts
142
+ * await outlook.sendMail({
143
+ * to: ["a@example.com", "b@example.com"],
144
+ * subject: "Status",
145
+ * body: "All systems operational",
146
+ * contentType: "Text",
147
+ * });
148
+ * ```
149
+ */
150
+ async sendMail(input) {
151
+ this.requireAccessToken();
152
+ if (!input.to || !input.subject) {
153
+ throw new InternalError("Microsoft Outlook sendMail requires recipients and a subject");
154
+ }
155
+ try {
156
+ await this.client.post("/me/sendMail", {
157
+ message: {
158
+ subject: input.subject,
159
+ body: {
160
+ contentType: input.contentType ?? "Text",
161
+ content: input.body ?? "",
162
+ },
163
+ toRecipients: recipientList(input.to),
164
+ ...(input.cc ? { ccRecipients: recipientList(input.cc) } : {}),
165
+ ...(input.bcc ? { bccRecipients: recipientList(input.bcc) } : {}),
166
+ },
167
+ saveToSentItems: input.saveToSentItems ?? true,
168
+ });
169
+ return { sent: true, to: input.to, subject: input.subject };
170
+ }
171
+ catch (error) {
172
+ throw httpError("Microsoft Outlook", "send mail", error);
173
+ }
174
+ }
175
+ /**
176
+ * @description Lists messages in an Outlook mail folder
177
+ * @summary `GET`s `/me/mailFolders/<folder>/messages` (default `inbox`)
178
+ * applying the optional `$top`, `$filter`, and `$search` parameters.
179
+ * @param {OutlookListInput} [input] - The folder and OData query options.
180
+ * @returns {Promise<unknown>} The Graph message collection.
181
+ * @throws {InternalError} When no token is configured.
182
+ * @throws {NotFoundError} When the folder does not exist (HTTP 404).
183
+ * @throws {BadRequestError} When Graph rejects the query.
184
+ */
185
+ async listMessages(input = {}) {
186
+ this.requireAccessToken();
187
+ const folder = input.folderId ?? "inbox";
188
+ try {
189
+ const response = await this.client.get(`/me/mailFolders/${encodeURIComponent(folder)}/messages`, {
190
+ params: {
191
+ ...(input.top !== undefined ? { $top: input.top } : {}),
192
+ ...(input.filter ? { $filter: input.filter } : {}),
193
+ ...(input.search ? { $search: input.search } : {}),
194
+ },
195
+ });
196
+ return response.data;
197
+ }
198
+ catch (error) {
199
+ throw httpError("Microsoft Outlook", "list messages", error);
200
+ }
201
+ }
202
+ /**
203
+ * @description Fetches a single Outlook message
204
+ * @summary `GET`s `/me/messages/<id>` and returns the message payload.
205
+ * @param {string} messageId - The Graph message ID.
206
+ * @returns {Promise<unknown>} The message payload.
207
+ * @throws {InternalError} When no token is configured or the message ID is empty.
208
+ * @throws {NotFoundError} When the message does not exist (HTTP 404).
209
+ * @throws {BadRequestError} When Graph rejects the request.
210
+ */
211
+ async getMessage(messageId) {
212
+ this.requireAccessToken();
213
+ if (!messageId) {
214
+ throw new InternalError("Microsoft Outlook requires a message id");
215
+ }
216
+ try {
217
+ const response = await this.client.get(`/me/messages/${encodeURIComponent(messageId)}`);
218
+ return response.data;
219
+ }
220
+ catch (error) {
221
+ throw httpError("Microsoft Outlook", "get message", error);
222
+ }
223
+ }
224
+ /**
225
+ * @description Lists Outlook calendar events
226
+ * @summary `GET`s `/me/events` applying the optional `$top`, `$filter`, and
227
+ * `$search` parameters; the mail `folderId` is not used.
228
+ * @param {OutlookListInput} [input] - The OData query options.
229
+ * @returns {Promise<unknown>} The Graph event collection.
230
+ * @throws {InternalError} When no token is configured.
231
+ * @throws {BadRequestError} When Graph rejects the query.
232
+ */
233
+ async listEvents(input = {}) {
234
+ this.requireAccessToken();
235
+ try {
236
+ const response = await this.client.get("/me/events", {
237
+ params: {
238
+ ...(input.top !== undefined ? { $top: input.top } : {}),
239
+ ...(input.filter ? { $filter: input.filter } : {}),
240
+ ...(input.search ? { $search: input.search } : {}),
241
+ },
242
+ });
243
+ return response.data;
244
+ }
245
+ catch (error) {
246
+ throw httpError("Microsoft Outlook", "list events", error);
247
+ }
248
+ }
249
+ /**
250
+ * @description Creates an Outlook calendar event
251
+ * @summary `POST`s the event to `/me/events`; `start`/`end` are sent with the
252
+ * configured or default (`UTC`) time zone and attendees as required.
253
+ * @param {OutlookEventInput} input - The event definition.
254
+ * @returns {Promise<unknown>} The created Graph event.
255
+ * @throws {InternalError} When no token is configured, or subject, start, or end is missing.
256
+ * @throws {BadRequestError} When Graph rejects the event.
257
+ * @example
258
+ * ```ts
259
+ * await outlook.createEvent({
260
+ * subject: "Release review",
261
+ * start: "2026-11-01T09:00:00",
262
+ * end: "2026-11-01T10:00:00",
263
+ * timeZone: "Europe/Lisbon",
264
+ * });
265
+ * ```
266
+ */
267
+ async createEvent(input) {
268
+ this.requireAccessToken();
269
+ if (!input.subject || !input.start || !input.end) {
270
+ throw new InternalError("Microsoft Outlook createEvent requires subject, start, and end");
271
+ }
272
+ const timeZone = input.timeZone ?? "UTC";
273
+ try {
274
+ const response = await this.client.post("/me/events", {
275
+ subject: input.subject,
276
+ ...(input.body
277
+ ? { body: { contentType: "Text", content: input.body } }
278
+ : {}),
279
+ start: { dateTime: input.start, timeZone },
280
+ end: { dateTime: input.end, timeZone },
281
+ ...(input.location ? { location: { displayName: input.location } } : {}),
282
+ ...(input.attendees
283
+ ? {
284
+ attendees: recipientList(input.attendees).map((entry) => ({
285
+ emailAddress: entry.emailAddress,
286
+ type: "required",
287
+ })),
288
+ }
289
+ : {}),
290
+ });
291
+ return response.data;
292
+ }
293
+ catch (error) {
294
+ throw httpError("Microsoft Outlook", "create event", error);
295
+ }
296
+ }
297
+ /**
298
+ * @description Deletes an Outlook calendar event
299
+ * @summary `DELETE`s `/me/events/<id>` and returns `{ deleted: true, eventId }`.
300
+ * @param {string} eventId - The Graph event ID.
301
+ * @returns {Promise<unknown>} `{ deleted: true, eventId }` on success.
302
+ * @throws {InternalError} When no token is configured or the event ID is empty.
303
+ * @throws {NotFoundError} When the event does not exist (HTTP 404).
304
+ * @throws {BadRequestError} When Graph rejects the request.
305
+ */
306
+ async deleteEvent(eventId) {
307
+ this.requireAccessToken();
308
+ if (!eventId) {
309
+ throw new InternalError("Microsoft Outlook requires an event id");
310
+ }
311
+ try {
312
+ await this.client.delete(`/me/events/${encodeURIComponent(eventId)}`);
313
+ return { deleted: true, eventId };
314
+ }
315
+ catch (error) {
316
+ throw httpError("Microsoft Outlook", "delete event", error);
317
+ }
318
+ }
319
+ }
320
+ //# sourceMappingURL=MicrosoftOutlookService.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"MicrosoftOutlookService.js","sourceRoot":"","sources":["../../../../src/comms/outlook/MicrosoftOutlookService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,4BAAuB;AAClD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,2CAAsC;AACrE,OAAO,EACL,cAAc,EAEd,SAAS,GACV,qCAA0B;AAoI3B;;;;;;;GAOG;AACH,SAAS,aAAa,CACpB,KAAoC;IAEpC,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACjC,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IACrD,OAAO,MAAM;SACV,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;SAC5B,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;SACnC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,OAAO,uBAAwB,SAAQ,cAAoC;IAAjF;;QACE;;WAEG;QACgB,gBAAW,GAAG,mBAAmB,CAAC;IA0PvD,CAAC;IAxPC;;;;OAIG;IACO,cAAc;QACtB,OAAO,kCAAkC,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACO,WAAW,CACnB,MAA4B;QAE5B,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,CAAC;IAED;;;;;;OAMG;IACO,qBAAqB;QAG7B,MAAM,GAAG,GAAG,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC;QAC3C,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK;YAAE,OAAO,SAAS,CAAC;QAC7B,OAAO;YACL,KAAK;YACL,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC;YAC/B,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC;SAChC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACO,kBAAkB;QAC1B,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,QAAQ,CAAC,KAAuB;QACpC,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YAChC,MAAM,IAAI,aAAa,CACrB,8DAA8D,CAC/D,CAAC;QACJ,CAAC;QACD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE;gBACrC,OAAO,EAAE;oBACP,OAAO,EAAE,KAAK,CAAC,OAAO;oBACtB,IAAI,EAAE;wBACJ,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,MAAM;wBACxC,OAAO,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE;qBAC1B;oBACD,YAAY,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC9D,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAClE;gBACD,eAAe,EAAE,KAAK,CAAC,eAAe,IAAI,IAAI;aAC/C,CAAC,CAAC;YACH,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,mBAAmB,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,YAAY,CAAC,QAA0B,EAAE;QAC7C,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,IAAI,OAAO,CAAC;QACzC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,mBAAmB,kBAAkB,CAAC,MAAM,CAAC,WAAW,EACxD;gBACE,MAAM,EAAE;oBACN,GAAG,CAAC,KAAK,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBACvD,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBAClD,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACnD;aACF,CACF,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,mBAAmB,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CAAC,SAAiB;QAChC,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,aAAa,CAAC,yCAAyC,CAAC,CAAC;QACrE,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,gBAAgB,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAChD,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,mBAAmB,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CAAC,QAA0B,EAAE;QAC3C,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE;gBACnD,MAAM,EAAE;oBACN,GAAG,CAAC,KAAK,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBACvD,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBAClD,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACnD;aACF,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,mBAAmB,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,WAAW,CAAC,KAAwB;QACxC,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACjD,MAAM,IAAI,aAAa,CACrB,gEAAgE,CACjE,CAAC;QACJ,CAAC;QACD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC;QACzC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE;gBACpD,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,GAAG,CAAC,KAAK,CAAC,IAAI;oBACZ,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE;oBACxD,CAAC,CAAC,EAAE,CAAC;gBACP,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE;gBAC1C,GAAG,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,GAAG,EAAE,QAAQ,EAAE;gBACtC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,WAAW,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACxE,GAAG,CAAC,KAAK,CAAC,SAAS;oBACjB,CAAC,CAAC;wBACE,SAAS,EAAE,aAAa,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;4BACxD,YAAY,EAAE,KAAK,CAAC,YAAY;4BAChC,IAAI,EAAE,UAAU;yBACjB,CAAC,CAAC;qBACJ;oBACH,CAAC,CAAC,EAAE,CAAC;aACR,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,mBAAmB,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,WAAW,CAAC,OAAe;QAC/B,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,aAAa,CAAC,wCAAwC,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACtE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,mBAAmB,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;CACF"}
@@ -0,0 +1,2 @@
1
+ export * from "./MicrosoftOutlookService.js";
2
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/comms/outlook/index.ts"],"names":[],"mappings":"AAAA,6CAA0C"}
@@ -0,0 +1,269 @@
1
+ /**
2
+ * @module integrations/comms/whatsapp/service
3
+ * @summary WhatsApp Cloud API integration service for text, template, and media messages.
4
+ * @description Exposes the Meta WhatsApp Cloud API (Graph `v19.0`) as an
5
+ * undecorated client-based service built on {@link HttpApiService}.
6
+ * Configuration comes from an explicit `WhatsAppServiceConfig` or the
7
+ * `comms.whatsApp` environment slice; the access token is sent as
8
+ * `Authorization: Bearer <token>` and the sender is identified by the
9
+ * configured `phoneNumberId`. Credentials are referenced from configuration
10
+ * (and, from as-graph nodes, from the resolved `whatsapp` credential secret)
11
+ * and are never embedded in source. Failures are mapped to decaf errors via
12
+ * {@link httpError}.
13
+ */
14
+ import { InternalError } from "@decaf-ts/db-decorators";
15
+ import { CommsEnvironment } from "./../environment.js";
16
+ import { envNumber, envString } from "./../../shared/environmentValue.js";
17
+ import { HttpApiService, httpError, } from "./../../shared/http/index.js";
18
+ /**
19
+ * @description WhatsApp Cloud API integration service
20
+ * @summary An undecorated HTTP service for text, template, and media
21
+ * messages, read receipts, and media metadata. Every message operation needs
22
+ * both the access token and the sender phone number ID; missing credentials or
23
+ * identifiers raise `InternalError`, and transport failures are mapped to decaf
24
+ * errors via {@link httpError}.
25
+ * @class WhatsAppService
26
+ * @extends HttpApiService
27
+ * @category Comms
28
+ * @example
29
+ * ```ts
30
+ * import { WhatsAppService } from "@decaf-ts/integrations/comms/whatsapp";
31
+ *
32
+ * const whatsapp = new WhatsAppService();
33
+ * await whatsapp.initialize({
34
+ * token: process.env.GRAPH_CREDENTIAL_WHATSAPP_TOKEN,
35
+ * phoneNumberId: process.env.WHATSAPP_PHONE_NUMBER_ID,
36
+ * });
37
+ * await whatsapp.sendText({ to: "15551234567", text: "Hello" });
38
+ * ```
39
+ * @mermaid
40
+ * sequenceDiagram
41
+ * autonumber
42
+ * participant Caller
43
+ * participant Service as WhatsAppService
44
+ * participant Graph as WhatsApp Cloud API
45
+ * Caller->>Service: sendText(input)
46
+ * activate Service
47
+ * Service->>Service: requireTokenAndPhone()
48
+ * Service->>Graph: POST /{phoneNumberId}/messages
49
+ * activate Graph
50
+ * Graph-->>Service: message payload
51
+ * deactivate Graph
52
+ * Service-->>Caller: message payload
53
+ * deactivate Service
54
+ * @memberOf module:integrations/comms/whatsapp/service
55
+ */
56
+ export class WhatsAppService extends HttpApiService {
57
+ constructor() {
58
+ super(...arguments);
59
+ /**
60
+ * @description The provider name used in error messages
61
+ */
62
+ this.serviceName = "WhatsApp";
63
+ }
64
+ /**
65
+ * @description The WhatsApp Cloud API base URL
66
+ * @summary Used when the resolved config carries no `baseUrl`.
67
+ * @returns {string} `"https://graph.facebook.com/v19.0"`.
68
+ */
69
+ defaultBaseUrl() {
70
+ return "https://graph.facebook.com/v19.0";
71
+ }
72
+ /**
73
+ * @description Builds the WhatsApp bearer authorization headers
74
+ * @summary Returns `Authorization: Bearer <token>` when configured, and no
75
+ * headers otherwise.
76
+ * @param {WhatsAppServiceConfig} config - The resolved service configuration.
77
+ * @returns {Record<string, string>} The authorization headers (empty without a token).
78
+ */
79
+ authHeaders(config) {
80
+ return config.token ? { Authorization: `Bearer ${config.token}` } : {};
81
+ }
82
+ /**
83
+ * @description Reads the WhatsApp credentials and defaults from the environment
84
+ * @summary Reads the `comms.whatsApp` slice and returns a partial config
85
+ * when a token or phone number ID is configured, `undefined` otherwise.
86
+ * Values pass through `envString`/`envNumber` to reject unset-leaf proxies.
87
+ * @returns {Partial<WhatsAppServiceConfig> | undefined} A partial config, or `undefined` when neither credential is configured.
88
+ */
89
+ configFromEnvironment() {
90
+ const env = CommsEnvironment.comms.whatsApp;
91
+ const token = envString(env?.token);
92
+ const phoneNumberId = envString(env?.phoneNumberId);
93
+ if (!token && !phoneNumberId)
94
+ return undefined;
95
+ return {
96
+ token,
97
+ phoneNumberId,
98
+ baseUrl: envString(env.baseUrl),
99
+ timeout: envNumber(env.timeout),
100
+ };
101
+ }
102
+ /**
103
+ * @description Asserts the access token and sender phone number ID
104
+ * @summary Calls `requireToken()` and returns the configured
105
+ * `phoneNumberId` used to build the messages path.
106
+ * @returns {string} The configured sender phone number ID.
107
+ * @throws {InternalError} When no token or phone number ID is configured.
108
+ */
109
+ requireTokenAndPhone() {
110
+ this.requireToken();
111
+ const phoneNumberId = this.config.phoneNumberId;
112
+ if (!phoneNumberId) {
113
+ throw new InternalError("WhatsApp requires a phone number id");
114
+ }
115
+ return phoneNumberId;
116
+ }
117
+ /**
118
+ * @description Builds the encoded messages path for a sender
119
+ * @summary Encodes the phone number ID into `/<id>/messages`.
120
+ * @param {string} phoneNumberId - The sender phone number ID.
121
+ * @returns {string} The messages API path.
122
+ */
123
+ messagesPath(phoneNumberId) {
124
+ return `/${encodeURIComponent(phoneNumberId)}/messages`;
125
+ }
126
+ /**
127
+ * @description Sends a WhatsApp text message
128
+ * @summary `POST`s a `text` message to the sender's `/messages` endpoint
129
+ * and returns the WhatsApp message payload.
130
+ * @param {WhatsAppTextInput} input - The recipient, text, and preview flag.
131
+ * @returns {Promise<unknown>} The WhatsApp message payload.
132
+ * @throws {InternalError} When credentials or the phone number ID are missing.
133
+ * @throws {BadRequestError} When WhatsApp rejects the message.
134
+ * @example
135
+ * ```ts
136
+ * await whatsapp.sendText({ to: "15551234567", text: "Deployment finished" });
137
+ * ```
138
+ */
139
+ async sendText(input) {
140
+ const phoneNumberId = this.requireTokenAndPhone();
141
+ try {
142
+ const response = await this.client.post(this.messagesPath(phoneNumberId), {
143
+ messaging_product: "whatsapp",
144
+ recipient_type: "individual",
145
+ to: input.to,
146
+ type: "text",
147
+ text: {
148
+ body: input.text,
149
+ preview_url: input.previewUrl ?? false,
150
+ },
151
+ });
152
+ return response.data;
153
+ }
154
+ catch (error) {
155
+ throw httpError("WhatsApp", "send text message", error);
156
+ }
157
+ }
158
+ /**
159
+ * @description Sends a WhatsApp template message
160
+ * @summary `POST`s a `template` message referencing an approved template
161
+ * name and language, with optional components.
162
+ * @param {WhatsAppTemplateInput} input - The recipient and template definition.
163
+ * @returns {Promise<unknown>} The WhatsApp message payload.
164
+ * @throws {InternalError} When credentials or the phone number ID are missing.
165
+ * @throws {BadRequestError} When WhatsApp rejects the template message.
166
+ */
167
+ async sendTemplate(input) {
168
+ const phoneNumberId = this.requireTokenAndPhone();
169
+ try {
170
+ const response = await this.client.post(this.messagesPath(phoneNumberId), {
171
+ messaging_product: "whatsapp",
172
+ to: input.to,
173
+ type: "template",
174
+ template: {
175
+ name: input.templateName,
176
+ language: { code: input.languageCode },
177
+ ...(input.components ? { components: input.components } : {}),
178
+ },
179
+ });
180
+ return response.data;
181
+ }
182
+ catch (error) {
183
+ throw httpError("WhatsApp", "send template message", error);
184
+ }
185
+ }
186
+ /**
187
+ * @description Sends a WhatsApp media message
188
+ * @summary `POST`s an `image`/`audio`/`video`/`document` message using
189
+ * either an uploaded `mediaId` or a public `link`, with optional caption and
190
+ * filename.
191
+ * @param {WhatsAppMediaInput} input - The recipient and media reference.
192
+ * @returns {Promise<unknown>} The WhatsApp message payload.
193
+ * @throws {InternalError} When credentials or the phone number ID are missing, or neither `mediaId` nor `link` is provided.
194
+ * @throws {BadRequestError} When WhatsApp rejects the media message.
195
+ */
196
+ async sendMedia(input) {
197
+ const phoneNumberId = this.requireTokenAndPhone();
198
+ if (!input.mediaId && !input.link) {
199
+ throw new InternalError("WhatsApp media messages require a media id or link");
200
+ }
201
+ try {
202
+ const response = await this.client.post(this.messagesPath(phoneNumberId), {
203
+ messaging_product: "whatsapp",
204
+ recipient_type: "individual",
205
+ to: input.to,
206
+ type: input.type,
207
+ [input.type]: {
208
+ ...(input.mediaId ? { id: input.mediaId } : { link: input.link }),
209
+ ...(input.caption ? { caption: input.caption } : {}),
210
+ ...(input.filename ? { filename: input.filename } : {}),
211
+ },
212
+ });
213
+ return response.data;
214
+ }
215
+ catch (error) {
216
+ throw httpError("WhatsApp", "send media message", error);
217
+ }
218
+ }
219
+ /**
220
+ * @description Marks an inbound WhatsApp message as read
221
+ * @summary `POST`s a `read` status for the message to the sender's
222
+ * `/messages` endpoint.
223
+ * @param {WhatsAppReadInput} input - The inbound message ID to acknowledge.
224
+ * @returns {Promise<unknown>} The WhatsApp status payload.
225
+ * @throws {InternalError} When credentials, the phone number ID, or the message ID are missing.
226
+ * @throws {BadRequestError} When WhatsApp rejects the request.
227
+ */
228
+ async markAsRead(input) {
229
+ const phoneNumberId = this.requireTokenAndPhone();
230
+ if (!input.messageId) {
231
+ throw new InternalError("WhatsApp requires a message id");
232
+ }
233
+ try {
234
+ const response = await this.client.post(this.messagesPath(phoneNumberId), {
235
+ messaging_product: "whatsapp",
236
+ status: "read",
237
+ message_id: input.messageId,
238
+ });
239
+ return response.data;
240
+ }
241
+ catch (error) {
242
+ throw httpError("WhatsApp", "mark message as read", error);
243
+ }
244
+ }
245
+ /**
246
+ * @description Fetches WhatsApp media metadata
247
+ * @summary `GET`s the media descriptor (URL, MIME type, size) by media ID;
248
+ * the descriptor's URL is then used to download the binary.
249
+ * @param {string} mediaId - The WhatsApp media ID.
250
+ * @returns {Promise<unknown>} The media metadata payload.
251
+ * @throws {InternalError} When no token is configured or the media ID is empty.
252
+ * @throws {NotFoundError} When the media does not exist (HTTP 404).
253
+ * @throws {BadRequestError} When WhatsApp rejects the request.
254
+ */
255
+ async getMedia(mediaId) {
256
+ this.requireToken();
257
+ if (!mediaId) {
258
+ throw new InternalError("WhatsApp requires a media id");
259
+ }
260
+ try {
261
+ const response = await this.client.get(`/${encodeURIComponent(mediaId)}`);
262
+ return response.data;
263
+ }
264
+ catch (error) {
265
+ throw httpError("WhatsApp", "get media", error);
266
+ }
267
+ }
268
+ }
269
+ //# sourceMappingURL=WhatsAppService.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"WhatsAppService.js","sourceRoot":"","sources":["../../../../src/comms/whatsapp/WhatsAppService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,4BAAuB;AAClD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,2CAAsC;AACrE,OAAO,EACL,cAAc,EAEd,SAAS,GACV,qCAA0B;AAgI3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,OAAO,eAAgB,SAAQ,cAAqC;IAA1E;;QACE;;WAEG;QACgB,gBAAW,GAAG,UAAU,CAAC;IAqO9C,CAAC;IAnOC;;;;OAIG;IACO,cAAc;QACtB,OAAO,kCAAkC,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACO,WAAW,CACnB,MAA6B;QAE7B,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,CAAC;IAED;;;;;;OAMG;IACO,qBAAqB;QAG7B,MAAM,GAAG,GAAG,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC5C,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACpC,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACpD,IAAI,CAAC,KAAK,IAAI,CAAC,aAAa;YAAE,OAAO,SAAS,CAAC;QAC/C,OAAO;YACL,KAAK;YACL,aAAa;YACb,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC;YAC/B,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC;SAChC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACO,oBAAoB;QAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;QAChD,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,aAAa,CAAC,qCAAqC,CAAC,CAAC;QACjE,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACK,YAAY,CAAC,aAAqB;QACxC,OAAO,IAAI,kBAAkB,CAAC,aAAa,CAAC,WAAW,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,QAAQ,CAAC,KAAwB;QACrC,MAAM,aAAa,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAClD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,EAChC;gBACE,iBAAiB,EAAE,UAAU;gBAC7B,cAAc,EAAE,YAAY;gBAC5B,EAAE,EAAE,KAAK,CAAC,EAAE;gBACZ,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE;oBACJ,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,WAAW,EAAE,KAAK,CAAC,UAAU,IAAI,KAAK;iBACvC;aACF,CACF,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,UAAU,EAAE,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY,CAAC,KAA4B;QAC7C,MAAM,aAAa,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAClD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,EAChC;gBACE,iBAAiB,EAAE,UAAU;gBAC7B,EAAE,EAAE,KAAK,CAAC,EAAE;gBACZ,IAAI,EAAE,UAAU;gBAChB,QAAQ,EAAE;oBACR,IAAI,EAAE,KAAK,CAAC,YAAY;oBACxB,QAAQ,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,YAAY,EAAE;oBACtC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC9D;aACF,CACF,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,UAAU,EAAE,uBAAuB,EAAE,KAAK,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,SAAS,CAAC,KAAyB;QACvC,MAAM,aAAa,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAClD,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAClC,MAAM,IAAI,aAAa,CACrB,oDAAoD,CACrD,CAAC;QACJ,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,EAChC;gBACE,iBAAiB,EAAE,UAAU;gBAC7B,cAAc,EAAE,YAAY;gBAC5B,EAAE,EAAE,KAAK,CAAC,EAAE;gBACZ,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;oBACZ,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;oBACjE,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBACpD,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACxD;aACF,CACF,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,UAAU,EAAE,oBAAoB,EAAE,KAAK,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CAAC,KAAwB;QACvC,MAAM,aAAa,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAClD,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;YACrB,MAAM,IAAI,aAAa,CAAC,gCAAgC,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,EAChC;gBACE,iBAAiB,EAAE,UAAU;gBAC7B,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE,KAAK,CAAC,SAAS;aAC5B,CACF,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,UAAU,EAAE,sBAAsB,EAAE,KAAK,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,aAAa,CAAC,8BAA8B,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,IAAI,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAClC,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,UAAU,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;CACF"}
@@ -0,0 +1,2 @@
1
+ export * from "./WhatsAppService.js";
2
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/comms/whatsapp/index.ts"],"names":[],"mappings":"AAAA,qCAAkC"}
package/lib/esm/index.js CHANGED
@@ -6,8 +6,8 @@
6
6
  export * from "./utils.js";
7
7
  export * from "./namespaces/index.js";
8
8
  export * from "./feature-flags/index.js";
9
- export const VERSION = "0.11.0";
10
- export const COMMIT = "004735e";
11
- export const FULL_VERSION = "0.11.0-004735e";
9
+ export const VERSION = "0.14.1";
10
+ export const COMMIT = "b661b6f";
11
+ export const FULL_VERSION = "0.14.1-b661b6f";
12
12
  export const PACKAGE_NAME = "@decaf-ts/integrations";
13
13
  //# sourceMappingURL=index.js.map