nesthub 1.0.2 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/notification/README.md +53 -0
- package/dist/notification/channels/email.channel.js +2 -1
- package/dist/notification/channels/email.channel.js.map +1 -1
- package/dist/notification/channels/firebase.channel.js +15 -0
- package/dist/notification/channels/firebase.channel.js.map +1 -1
- package/dist/notification/channels/sms.channel.js +9 -6
- package/dist/notification/channels/sms.channel.js.map +1 -1
- package/dist/notification/channels/telegram.channel.d.ts +3 -0
- package/dist/notification/channels/telegram.channel.js +108 -0
- package/dist/notification/channels/telegram.channel.js.map +1 -1
- package/dist/swagger/README.md +53 -0
- package/dist/swagger/index.d.ts +2 -0
- package/dist/swagger/index.js +6 -0
- package/dist/swagger/index.js.map +1 -0
- package/dist/swagger/swagger-setup.d.ts +3 -0
- package/dist/swagger/swagger-setup.js +21 -0
- package/dist/swagger/swagger-setup.js.map +1 -0
- package/dist/swagger/swagger.interfaces.d.ts +9 -0
- package/dist/swagger/swagger.interfaces.js +3 -0
- package/dist/swagger/swagger.interfaces.js.map +1 -0
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +35 -5
- package/src/notification/README.md +53 -0
- package/src/swagger/README.md +53 -0
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -18,4 +18,5 @@ __exportStar(require("./typeorm"), exports);
|
|
|
18
18
|
__exportStar(require("./cache"), exports);
|
|
19
19
|
__exportStar(require("./queue"), exports);
|
|
20
20
|
__exportStar(require("./notification"), exports);
|
|
21
|
+
__exportStar(require("./swagger"), exports);
|
|
21
22
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,0CAAwB;AACxB,0CAAwB;AACxB,iDAA+B"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,0CAAwB;AACxB,0CAAwB;AACxB,iDAA+B;AAC/B,4CAA0B"}
|
|
@@ -235,3 +235,56 @@ export class AppModule {}
|
|
|
235
235
|
| `createdAt` | `created_at` |
|
|
236
236
|
| `updatedAt` | `updated_at` |
|
|
237
237
|
| `sentAt` | `sent_at` |
|
|
238
|
+
|
|
239
|
+
## Telegram Channel
|
|
240
|
+
|
|
241
|
+
### Configuration
|
|
242
|
+
|
|
243
|
+
```typescript
|
|
244
|
+
channels: {
|
|
245
|
+
telegram: { botToken: '123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11' },
|
|
246
|
+
}
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### Sending messages
|
|
250
|
+
|
|
251
|
+
**Text only** — sends via `/sendMessage`:
|
|
252
|
+
```typescript
|
|
253
|
+
await notification.send({
|
|
254
|
+
channel: 'telegram',
|
|
255
|
+
to: '1077316390',
|
|
256
|
+
content: '<b>Hello</b> from HTML',
|
|
257
|
+
});
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
**With file attachment** — sends via `/sendDocument`, `content` becomes the caption:
|
|
261
|
+
```typescript
|
|
262
|
+
await notification.send({
|
|
263
|
+
channel: 'telegram',
|
|
264
|
+
to: '1077316390',
|
|
265
|
+
content: 'Report attached',
|
|
266
|
+
attachments: [{ filename: 'report.xlsx', content: buffer }],
|
|
267
|
+
});
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
**Multiple files** — sends via `/sendMediaGroup` (single request), caption on last file:
|
|
271
|
+
```typescript
|
|
272
|
+
await notification.send({
|
|
273
|
+
channel: 'telegram',
|
|
274
|
+
to: '1077316390',
|
|
275
|
+
content: 'Monthly reports',
|
|
276
|
+
attachments: [
|
|
277
|
+
{ filename: 'jan.xlsx', content: buf1 },
|
|
278
|
+
{ filename: 'feb.xlsx', content: buf2 },
|
|
279
|
+
],
|
|
280
|
+
});
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
**Attachment from file path:**
|
|
284
|
+
```typescript
|
|
285
|
+
await notification.send({
|
|
286
|
+
channel: 'telegram',
|
|
287
|
+
to: '1077316390',
|
|
288
|
+
attachments: [{ filename: 'photo.jpg', path: '/tmp/photo.jpg' }],
|
|
289
|
+
});
|
|
290
|
+
```
|
|
@@ -39,8 +39,9 @@ class EmailChannel {
|
|
|
39
39
|
const mailOptions = {
|
|
40
40
|
to: Array.isArray(input.to) ? input.to.join(', ') : input.to,
|
|
41
41
|
subject: input.subject,
|
|
42
|
-
html: input.content,
|
|
43
42
|
};
|
|
43
|
+
if (input.content)
|
|
44
|
+
mailOptions.html = input.content;
|
|
44
45
|
if (input.sender)
|
|
45
46
|
mailOptions.from = input.sender;
|
|
46
47
|
if (input.attachments?.length)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email.channel.js","sourceRoot":"","sources":["../../../src/notification/channels/email.channel.ts"],"names":[],"mappings":";;;AAOA,SAAS,eAAe,CACtB,IAA6C;IAE7C,MAAM,SAAS,GAA4B;QACzC,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG;KACzC,CAAC;IACF,IAAI,IAAI,CAAC,IAAI;QAAE,SAAS,CAAC,IAAI,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;IAC3E,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAa,YAAY;IAKH;IAJX,WAAW,GAAG,OAAO,CAAC;IACvB,WAAW,CAAM;IACjB,WAAW,GAAyB,IAAI,CAAC;IAEjD,YAAoB,MAA0B;QAA1B,WAAM,GAAN,MAAM,CAAoB;IAAG,CAAC;IAE1C,KAAK,CAAC,iBAAiB;QAC7B,IAAI,IAAI,CAAC,WAAW;YAAE,OAAO;QAC7B,IAAI,IAAI,CAAC,WAAW;YAAE,OAAO,IAAI,CAAC,WAAW,CAAC;QAE9C,IAAI,CAAC,WAAW,GAAG,CAAC,KAAK,IAAI,EAAE;YAC7B,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;YAC9C,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI;gBACpC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACnC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;YAClC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CACnD,aAAa,EACb,IAAI,CAAC,MAAM,CAAC,QAAQ,CACrB,CAAC;QACJ,CAAC,CAAC,EAAE,CAAC;QAEL,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAA4B;QACrC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAE/B,MAAM,WAAW,GAA4B;gBAC3C,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;gBAC5D,OAAO,EAAE,KAAK,CAAC,OAAO;
|
|
1
|
+
{"version":3,"file":"email.channel.js","sourceRoot":"","sources":["../../../src/notification/channels/email.channel.ts"],"names":[],"mappings":";;;AAOA,SAAS,eAAe,CACtB,IAA6C;IAE7C,MAAM,SAAS,GAA4B;QACzC,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG;KACzC,CAAC;IACF,IAAI,IAAI,CAAC,IAAI;QAAE,SAAS,CAAC,IAAI,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;IAC3E,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAa,YAAY;IAKH;IAJX,WAAW,GAAG,OAAO,CAAC;IACvB,WAAW,CAAM;IACjB,WAAW,GAAyB,IAAI,CAAC;IAEjD,YAAoB,MAA0B;QAA1B,WAAM,GAAN,MAAM,CAAoB;IAAG,CAAC;IAE1C,KAAK,CAAC,iBAAiB;QAC7B,IAAI,IAAI,CAAC,WAAW;YAAE,OAAO;QAC7B,IAAI,IAAI,CAAC,WAAW;YAAE,OAAO,IAAI,CAAC,WAAW,CAAC;QAE9C,IAAI,CAAC,WAAW,GAAG,CAAC,KAAK,IAAI,EAAE;YAC7B,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;YAC9C,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI;gBACpC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACnC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;YAClC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CACnD,aAAa,EACb,IAAI,CAAC,MAAM,CAAC,QAAQ,CACrB,CAAC;QACJ,CAAC,CAAC,EAAE,CAAC;QAEL,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAA4B;QACrC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAE/B,MAAM,WAAW,GAA4B;gBAC3C,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;gBAC5D,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB,CAAC;YAEF,IAAI,KAAK,CAAC,OAAO;gBAAE,WAAW,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;YACpD,IAAI,KAAK,CAAC,MAAM;gBAAE,WAAW,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC;YAClD,IAAI,KAAK,CAAC,WAAW,EAAE,MAAM;gBAC3B,WAAW,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;YAE9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YAE1D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;QACtD,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QAC5C,CAAC;IACH,CAAC;CACF;AA/CD,oCA+CC"}
|
|
@@ -1,6 +1,15 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.FirebaseChannel = void 0;
|
|
4
|
+
function serializeAttachments(attachments) {
|
|
5
|
+
return JSON.stringify(attachments.map((a) => ({
|
|
6
|
+
filename: a.filename,
|
|
7
|
+
contentType: a.contentType,
|
|
8
|
+
content: a.content instanceof Buffer
|
|
9
|
+
? a.content.toString('base64')
|
|
10
|
+
: (a.content ?? null),
|
|
11
|
+
})));
|
|
12
|
+
}
|
|
4
13
|
class FirebaseChannel {
|
|
5
14
|
config;
|
|
6
15
|
channelType = 'firebase';
|
|
@@ -48,6 +57,12 @@ class FirebaseChannel {
|
|
|
48
57
|
},
|
|
49
58
|
data: input.metadata,
|
|
50
59
|
};
|
|
60
|
+
if (input.attachments?.length) {
|
|
61
|
+
message.data = {
|
|
62
|
+
...message.data,
|
|
63
|
+
_attachments: serializeAttachments(input.attachments),
|
|
64
|
+
};
|
|
65
|
+
}
|
|
51
66
|
const response = await admin
|
|
52
67
|
.messaging()
|
|
53
68
|
.sendEachForMulticast(message);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"firebase.channel.js","sourceRoot":"","sources":["../../../src/notification/channels/firebase.channel.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"firebase.channel.js","sourceRoot":"","sources":["../../../src/notification/channels/firebase.channel.ts"],"names":[],"mappings":";;;AAWA,SAAS,oBAAoB,CAAC,WAAyB;IACrD,OAAO,IAAI,CAAC,SAAS,CACnB,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACtB,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,OAAO,EACL,CAAC,CAAC,OAAO,YAAY,MAAM;YACzB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC9B,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,IAAI,CAAC;KAC1B,CAAC,CAAC,CACJ,CAAC;AACJ,CAAC;AAED,MAAa,eAAe;IAKN;IAJX,WAAW,GAAG,UAAU,CAAC;IAC1B,WAAW,GAAG,KAAK,CAAC;IACpB,WAAW,GAAyB,IAAI,CAAC;IAEjD,YAAoB,MAA6B;QAA7B,WAAM,GAAN,MAAM,CAAuB;IAAG,CAAC;IAE7C,KAAK,CAAC,iBAAiB;QAC7B,IAAI,IAAI,CAAC,WAAW;YAAE,OAAO;QAC7B,IAAI,IAAI,CAAC,WAAW;YAAE,OAAO,IAAI,CAAC,WAAW,CAAC;QAE9C,IAAI,CAAC,WAAW,GAAG,CAAC,KAAK,IAAI,EAAE;YAC7B,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC;YAE7C,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB;oBAC/C,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBACvD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc;wBAC1B,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;wBACnD,CAAC,CAAC,SAAS,CAAC;gBAEhB,KAAK,CAAC,aAAa,CAAC;oBAClB,UAAU;oBACV,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW;iBACrC,CAAC,CAAC;YACL,CAAC;YAED,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAC1B,CAAC,CAAC,EAAE,CAAC;QAEL,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAA4B;QACrC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC;YAE7C,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAElC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,2BAA2B,EAAE,CAAC;YAChE,CAAC;YAED,MAAM,OAAO,GAA4B;gBACvC,MAAM;gBACN,YAAY,EAAE;oBACZ,KAAK,EAAE,KAAK,CAAC,OAAO;oBACpB,IAAI,EAAE,KAAK,CAAC,OAAO;iBACpB;gBACD,IAAI,EAAE,KAAK,CAAC,QAAQ;aACrB,CAAC;YAEF,IAAI,KAAK,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;gBAC9B,OAAO,CAAC,IAAI,GAAG;oBACb,GAAI,OAAO,CAAC,IAA+B;oBAC3C,YAAY,EAAE,oBAAoB,CAAC,KAAK,CAAC,WAAW,CAAC;iBACtD,CAAC;YACJ,CAAC;YAED,MAAM,QAAQ,GAAG,MAAO,KAAa;iBAClC,SAAS,EAAE;iBACX,oBAAoB,CAAC,OAAc,CAAC,CAAC;YACxC,MAAM,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC;YAC3C,MAAM,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC;YAE3C,OAAO;gBACL,OAAO,EAAE,YAAY,GAAG,CAAC;gBACzB,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS;gBACpE,KAAK,EAAE,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,YAAY,gBAAgB,CAAC,CAAC,CAAC,SAAS;aACtE,CAAC;QACJ,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QAC5C,CAAC;IACH,CAAC;CACF;AA7ED,0CA6EC"}
|
|
@@ -49,6 +49,14 @@ class SmsChannel {
|
|
|
49
49
|
const url = this.config.credentials.url;
|
|
50
50
|
if (!url)
|
|
51
51
|
return { success: false, error: 'HTTP URL not configured' };
|
|
52
|
+
const body = {
|
|
53
|
+
to,
|
|
54
|
+
content: input.content,
|
|
55
|
+
from: input.sender ?? this.config.from,
|
|
56
|
+
...input.metadata,
|
|
57
|
+
};
|
|
58
|
+
if (input.attachments?.length)
|
|
59
|
+
body.attachments = input.attachments;
|
|
52
60
|
const response = await fetch(url, {
|
|
53
61
|
method: 'POST',
|
|
54
62
|
headers: {
|
|
@@ -57,12 +65,7 @@ class SmsChannel {
|
|
|
57
65
|
? `Bearer ${this.config.credentials.apiKey}`
|
|
58
66
|
: '',
|
|
59
67
|
},
|
|
60
|
-
body: JSON.stringify(
|
|
61
|
-
to,
|
|
62
|
-
content: input.content,
|
|
63
|
-
from: input.sender ?? this.config.from,
|
|
64
|
-
...input.metadata,
|
|
65
|
-
}),
|
|
68
|
+
body: JSON.stringify(body),
|
|
66
69
|
});
|
|
67
70
|
if (!response.ok) {
|
|
68
71
|
return {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sms.channel.js","sourceRoot":"","sources":["../../../src/notification/channels/sms.channel.ts"],"names":[],"mappings":";;;AAOA,MAAa,UAAU;IAGD;IAFX,WAAW,GAAG,KAAK,CAAC;IAE7B,YAAoB,MAAwB;QAAxB,WAAM,GAAN,MAAM,CAAkB;IAAG,CAAC;IAEhD,KAAK,CAAC,IAAI,CAAC,KAA4B;QACrC,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YAE5D,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC7B,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;oBACtC,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAC3B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,EAClC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAClC,CAAC;oBACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;wBAC1C,IAAI,EAAE,KAAK,CAAC,OAAO;wBACnB,EAAE;wBACF,IAAI,EAAE,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI;qBACvC,CAAC,CAAC;oBACH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;gBAClD,CAAC;gBAED,KAAK,SAAS,CAAC,CAAC,CAAC;oBACf,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,GACjC,MAAM,MAAM,CAAC,qBAAqB,CAAC,CAAC;oBACtC,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;wBAC3B,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM;wBACtC,WAAW,EAAE;4BACX,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW;4BAChD,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,eAAe;yBACzD;qBACF,CAAC,CAAC;oBACH,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC;wBACjC,OAAO,EAAE,KAAK,CAAC,OAAO;wBACtB,WAAW,EAAE,EAAE;wBACf,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;4BACjC,CAAC,CAAC;gCACE,sBAAsB,EAAE;oCACtB,QAAQ,EAAE,QAAQ;oCAClB,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;iCAC9B;6BACF;4BACH,CAAC,CAAC,SAAS;qBACd,CAAC,CAAC;oBACH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC1C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;gBACxD,CAAC;gBAED,KAAK,MAAM,CAAC,CAAC,CAAC;oBACZ,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC;oBACxC,IAAI,CAAC,GAAG;wBAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,EAAE,CAAC;oBACtE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;wBAChC,MAAM,EAAE,MAAM;wBACd,OAAO,EAAE;4BACP,cAAc,EAAE,kBAAkB;4BAClC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM;gCAC3C,CAAC,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE;gCAC5C,CAAC,CAAC,EAAE;yBACP;wBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC
|
|
1
|
+
{"version":3,"file":"sms.channel.js","sourceRoot":"","sources":["../../../src/notification/channels/sms.channel.ts"],"names":[],"mappings":";;;AAOA,MAAa,UAAU;IAGD;IAFX,WAAW,GAAG,KAAK,CAAC;IAE7B,YAAoB,MAAwB;QAAxB,WAAM,GAAN,MAAM,CAAkB;IAAG,CAAC;IAEhD,KAAK,CAAC,IAAI,CAAC,KAA4B;QACrC,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YAE5D,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC7B,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;oBACtC,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAC3B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,EAClC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAClC,CAAC;oBACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;wBAC1C,IAAI,EAAE,KAAK,CAAC,OAAO;wBACnB,EAAE;wBACF,IAAI,EAAE,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI;qBACvC,CAAC,CAAC;oBACH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;gBAClD,CAAC;gBAED,KAAK,SAAS,CAAC,CAAC,CAAC;oBACf,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,GACjC,MAAM,MAAM,CAAC,qBAAqB,CAAC,CAAC;oBACtC,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;wBAC3B,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM;wBACtC,WAAW,EAAE;4BACX,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW;4BAChD,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,eAAe;yBACzD;qBACF,CAAC,CAAC;oBACH,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC;wBACjC,OAAO,EAAE,KAAK,CAAC,OAAO;wBACtB,WAAW,EAAE,EAAE;wBACf,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;4BACjC,CAAC,CAAC;gCACE,sBAAsB,EAAE;oCACtB,QAAQ,EAAE,QAAQ;oCAClB,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;iCAC9B;6BACF;4BACH,CAAC,CAAC,SAAS;qBACd,CAAC,CAAC;oBACH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC1C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;gBACxD,CAAC;gBAED,KAAK,MAAM,CAAC,CAAC,CAAC;oBACZ,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC;oBACxC,IAAI,CAAC,GAAG;wBAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,EAAE,CAAC;oBACtE,MAAM,IAAI,GAA4B;wBACpC,EAAE;wBACF,OAAO,EAAE,KAAK,CAAC,OAAO;wBACtB,IAAI,EAAE,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI;wBACtC,GAAG,KAAK,CAAC,QAAQ;qBAClB,CAAC;oBACF,IAAI,KAAK,CAAC,WAAW,EAAE,MAAM;wBAAE,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;oBACpE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;wBAChC,MAAM,EAAE,MAAM;wBACd,OAAO,EAAE;4BACP,cAAc,EAAE,kBAAkB;4BAClC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM;gCAC3C,CAAC,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE;gCAC5C,CAAC,CAAC,EAAE;yBACP;wBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;qBAC3B,CAAC,CAAC;oBACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;wBACjB,OAAO;4BACL,OAAO,EAAE,KAAK;4BACd,KAAK,EAAE,QAAQ,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE;yBACzD,CAAC;oBACJ,CAAC;oBACD,MAAM,IAAI,GAAQ,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;oBACxC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACjE,CAAC;gBAED;oBACE,OAAO;wBACL,OAAO,EAAE,KAAK;wBACd,KAAK,EAAE,0BAA0B;qBAClC,CAAC;YACN,CAAC;QACH,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QAC5C,CAAC;IACH,CAAC;CACF;AA3FD,gCA2FC"}
|
|
@@ -7,4 +7,7 @@ export declare class TelegramChannel implements NotificationChannel {
|
|
|
7
7
|
constructor(config: TelegramChannelConfig);
|
|
8
8
|
send(input: SendNotificationInput): Promise<SendChannelResult>;
|
|
9
9
|
private sendToChat;
|
|
10
|
+
private sendMessage;
|
|
11
|
+
private sendDocument;
|
|
12
|
+
private sendMediaGroup;
|
|
10
13
|
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.TelegramChannel = void 0;
|
|
4
|
+
const promises_1 = require("node:fs/promises");
|
|
4
5
|
class TelegramChannel {
|
|
5
6
|
config;
|
|
6
7
|
channelType = 'telegram';
|
|
@@ -11,6 +12,9 @@ class TelegramChannel {
|
|
|
11
12
|
config.apiBaseUrl ?? `https://api.telegram.org/bot${config.botToken}`;
|
|
12
13
|
}
|
|
13
14
|
async send(input) {
|
|
15
|
+
if (!input.content && !input.attachments?.length) {
|
|
16
|
+
return { success: false, error: 'Message content is empty' };
|
|
17
|
+
}
|
|
14
18
|
try {
|
|
15
19
|
const to = Array.isArray(input.to) ? input.to : [input.to];
|
|
16
20
|
const results = await Promise.all(to.map((chatId) => this.sendToChat(chatId, input)));
|
|
@@ -29,6 +33,16 @@ class TelegramChannel {
|
|
|
29
33
|
}
|
|
30
34
|
}
|
|
31
35
|
async sendToChat(chatId, input) {
|
|
36
|
+
const attachments = input.attachments ?? [];
|
|
37
|
+
if (attachments.length > 0) {
|
|
38
|
+
if (attachments.length === 1) {
|
|
39
|
+
return this.sendDocument(chatId, input.content ?? '', attachments[0]);
|
|
40
|
+
}
|
|
41
|
+
return this.sendMediaGroup(chatId, input.content ?? '', attachments);
|
|
42
|
+
}
|
|
43
|
+
return this.sendMessage(chatId, input);
|
|
44
|
+
}
|
|
45
|
+
async sendMessage(chatId, input) {
|
|
32
46
|
const payload = {
|
|
33
47
|
chat_id: chatId,
|
|
34
48
|
text: input.content,
|
|
@@ -54,6 +68,100 @@ class TelegramChannel {
|
|
|
54
68
|
}
|
|
55
69
|
return { success: true, messageId: String(data.result?.message_id) };
|
|
56
70
|
}
|
|
71
|
+
async sendDocument(chatId, caption, attachment) {
|
|
72
|
+
const formData = new FormData();
|
|
73
|
+
formData.append('chat_id', chatId);
|
|
74
|
+
if (caption) {
|
|
75
|
+
formData.append('caption', caption);
|
|
76
|
+
formData.append('parse_mode', 'HTML');
|
|
77
|
+
}
|
|
78
|
+
let content;
|
|
79
|
+
if (attachment.content) {
|
|
80
|
+
content = new Blob([attachment.content], {
|
|
81
|
+
type: attachment.contentType ?? 'application/octet-stream',
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
else if (attachment.path) {
|
|
85
|
+
const buf = await (0, promises_1.readFile)(attachment.path);
|
|
86
|
+
content = new Blob([buf], {
|
|
87
|
+
type: attachment.contentType ?? 'application/octet-stream',
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
else {
|
|
91
|
+
return { success: false, error: 'Attachment has no content or path' };
|
|
92
|
+
}
|
|
93
|
+
formData.append('document', content, attachment.filename);
|
|
94
|
+
const response = await fetch(`${this.apiBase}/sendDocument`, {
|
|
95
|
+
method: 'POST',
|
|
96
|
+
body: formData,
|
|
97
|
+
});
|
|
98
|
+
if (!response.ok) {
|
|
99
|
+
const body = await response.text();
|
|
100
|
+
return {
|
|
101
|
+
success: false,
|
|
102
|
+
error: `Telegram API ${response.status}: ${body}`,
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
const data = (await response.json());
|
|
106
|
+
if (!data.ok) {
|
|
107
|
+
return { success: false, error: 'Telegram API returned not ok' };
|
|
108
|
+
}
|
|
109
|
+
return { success: true, messageId: String(data.result?.message_id) };
|
|
110
|
+
}
|
|
111
|
+
async sendMediaGroup(chatId, caption, attachments) {
|
|
112
|
+
const formData = new FormData();
|
|
113
|
+
formData.append('chat_id', chatId);
|
|
114
|
+
const media = [];
|
|
115
|
+
for (let i = 0; i < attachments.length; i++) {
|
|
116
|
+
const a = attachments[i];
|
|
117
|
+
const fileKey = `file${i}`;
|
|
118
|
+
const item = {
|
|
119
|
+
type: 'document',
|
|
120
|
+
media: `attach://${fileKey}`,
|
|
121
|
+
};
|
|
122
|
+
if (i === attachments.length - 1 && caption) {
|
|
123
|
+
item.caption = caption;
|
|
124
|
+
item.parse_mode = 'HTML';
|
|
125
|
+
}
|
|
126
|
+
media.push(item);
|
|
127
|
+
let content;
|
|
128
|
+
if (a.content) {
|
|
129
|
+
content = new Blob([a.content], {
|
|
130
|
+
type: a.contentType ?? 'application/octet-stream',
|
|
131
|
+
});
|
|
132
|
+
}
|
|
133
|
+
else if (a.path) {
|
|
134
|
+
const buf = await (0, promises_1.readFile)(a.path);
|
|
135
|
+
content = new Blob([buf], {
|
|
136
|
+
type: a.contentType ?? 'application/octet-stream',
|
|
137
|
+
});
|
|
138
|
+
}
|
|
139
|
+
else {
|
|
140
|
+
return { success: false, error: 'Attachment has no content or path' };
|
|
141
|
+
}
|
|
142
|
+
formData.append(fileKey, content, a.filename);
|
|
143
|
+
}
|
|
144
|
+
formData.append('media', JSON.stringify(media));
|
|
145
|
+
const response = await fetch(`${this.apiBase}/sendMediaGroup`, {
|
|
146
|
+
method: 'POST',
|
|
147
|
+
body: formData,
|
|
148
|
+
});
|
|
149
|
+
if (!response.ok) {
|
|
150
|
+
const body = await response.text();
|
|
151
|
+
return {
|
|
152
|
+
success: false,
|
|
153
|
+
error: `Telegram API ${response.status}: ${body}`,
|
|
154
|
+
};
|
|
155
|
+
}
|
|
156
|
+
const data = (await response.json());
|
|
157
|
+
if (!data.ok) {
|
|
158
|
+
return { success: false, error: 'Telegram API returned not ok' };
|
|
159
|
+
}
|
|
160
|
+
return {
|
|
161
|
+
success: true,
|
|
162
|
+
messageId: String(data.result?.[0]?.message_id ?? ''),
|
|
163
|
+
};
|
|
164
|
+
}
|
|
57
165
|
}
|
|
58
166
|
exports.TelegramChannel = TelegramChannel;
|
|
59
167
|
//# sourceMappingURL=telegram.channel.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"telegram.channel.js","sourceRoot":"","sources":["../../../src/notification/channels/telegram.channel.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"telegram.channel.js","sourceRoot":"","sources":["../../../src/notification/channels/telegram.channel.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAW5C,MAAa,eAAe;IAIN;IAHX,WAAW,GAAG,UAAU,CAAC;IAC1B,OAAO,CAAS;IAExB,YAAoB,MAA6B;QAA7B,WAAM,GAAN,MAAM,CAAuB;QAC/C,IAAI,CAAC,OAAO;YACV,MAAM,CAAC,UAAU,IAAI,+BAA+B,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAA4B;QACrC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;YACjD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,0BAA0B,EAAE,CAAC;QAC/D,CAAC;QAED,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC3D,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CACnD,CAAC;YAEF,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YACpD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAErE,OAAO;gBACL,OAAO;gBACP,SAAS,EAAE,YAAY,EAAE,SAAS;gBAClC,KAAK,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;aACzD,CAAC;QACJ,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QAC5C,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,UAAU,CACtB,MAAc,EACd,KAA4B;QAE5B,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;QAE5C,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;YACxE,CAAC;YACD,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC;QACvE,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC;IAEO,KAAK,CAAC,WAAW,CACvB,MAAc,EACd,KAA4B;QAE5B,MAAM,OAAO,GAA4B;YACvC,OAAO,EAAE,MAAM;YACf,IAAI,EAAE,KAAK,CAAC,OAAO;YACnB,UAAU,EAAE,MAAM;SACnB,CAAC;QAEF,IAAI,KAAK,CAAC,MAAM;YAAE,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC;QAElD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,cAAc,EAAE;YAC1D,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;SAC9B,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,gBAAgB,QAAQ,CAAC,MAAM,KAAK,IAAI,EAAE;aAClD,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAGlC,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,8BAA8B,EAAE,CAAC;QACnE,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC;IACvE,CAAC;IAEO,KAAK,CAAC,YAAY,CACxB,MAAc,EACd,OAAe,EACf,UAAsB;QAEtB,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACnC,IAAI,OAAO,EAAE,CAAC;YACZ,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACpC,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,OAAa,CAAC;QAClB,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;YACvB,OAAO,GAAG,IAAI,IAAI,CAAC,CAAC,UAAU,CAAC,OAAmB,CAAC,EAAE;gBACnD,IAAI,EAAE,UAAU,CAAC,WAAW,IAAI,0BAA0B;aAC3D,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,MAAM,IAAA,mBAAQ,EAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAC5C,OAAO,GAAG,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE;gBACxB,IAAI,EAAE,UAAU,CAAC,WAAW,IAAI,0BAA0B;aAC3D,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,mCAAmC,EAAE,CAAC;QACxE,CAAC;QAED,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,eAAe,EAAE;YAC3D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,gBAAgB,QAAQ,CAAC,MAAM,KAAK,IAAI,EAAE;aAClD,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAGlC,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,8BAA8B,EAAE,CAAC;QACnE,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC;IACvE,CAAC;IAEO,KAAK,CAAC,cAAc,CAC1B,MAAc,EACd,OAAe,EACf,WAAyB;QAEzB,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAEnC,MAAM,KAAK,GAA8B,EAAE,CAAC;QAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACzB,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,GAA4B;gBACpC,IAAI,EAAE,UAAU;gBAChB,KAAK,EAAE,YAAY,OAAO,EAAE;aAC7B,CAAC;YAEF,IAAI,CAAC,KAAK,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,EAAE,CAAC;gBAC5C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;gBACvB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;YAC3B,CAAC;YAED,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEjB,IAAI,OAAa,CAAC;YAClB,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;gBACd,OAAO,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,OAAmB,CAAC,EAAE;oBAC1C,IAAI,EAAE,CAAC,CAAC,WAAW,IAAI,0BAA0B;iBAClD,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;gBAClB,MAAM,GAAG,GAAG,MAAM,IAAA,mBAAQ,EAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBACnC,OAAO,GAAG,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE;oBACxB,IAAI,EAAE,CAAC,CAAC,WAAW,IAAI,0BAA0B;iBAClD,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,mCAAmC,EAAE,CAAC;YACxE,CAAC;YAED,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;QAChD,CAAC;QAED,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAEhD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,iBAAiB,EAAE;YAC7D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,gBAAgB,QAAQ,CAAC,MAAM,KAAK,IAAI,EAAE;aAClD,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAGlC,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,8BAA8B,EAAE,CAAC;QACnE,CAAC;QAED,OAAO;YACL,OAAO,EAAE,IAAI;YACb,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,IAAI,EAAE,CAAC;SACtD,CAAC;IACJ,CAAC;CACF;AAjND,0CAiNC"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# @nesthub/swagger
|
|
2
|
+
|
|
3
|
+
Scalar API reference for NestJS — powered by `@scalar/nestjs-api-reference`.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @nestjs/swagger @scalar/nestjs-api-reference
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { NestFactory } from '@nestjs/core';
|
|
15
|
+
import { setupSwaggerUI } from 'nesthub/swagger';
|
|
16
|
+
import { AppModule } from './app.module';
|
|
17
|
+
|
|
18
|
+
async function bootstrap() {
|
|
19
|
+
const app = await NestFactory.create(AppModule);
|
|
20
|
+
|
|
21
|
+
setupSwaggerUI(app, {
|
|
22
|
+
title: 'My API',
|
|
23
|
+
description: 'API documentation',
|
|
24
|
+
version: '1.0.0',
|
|
25
|
+
persistAuth: true,
|
|
26
|
+
serverUrl: 'http://localhost:3000',
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
await app.listen(3000);
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Options
|
|
34
|
+
|
|
35
|
+
| Option | Type | Default | Description |
|
|
36
|
+
|--------|------|---------|-------------|
|
|
37
|
+
| `path` | `string` | `'api-docs'` | Path to serve Scalar |
|
|
38
|
+
| `title` | `string` | `'API Documentation'` | API title |
|
|
39
|
+
| `description` | `string` | `''` | API description |
|
|
40
|
+
| `version` | `string` | `'1.0'` | API version |
|
|
41
|
+
| `persistAuth` | `boolean` | `false` | Persist auth in localStorage |
|
|
42
|
+
| `serverUrl` | `string` | `undefined` | Server URL |
|
|
43
|
+
| `serverDescription` | `string` | `undefined` | Server description |
|
|
44
|
+
|
|
45
|
+
## Content Security Policy
|
|
46
|
+
|
|
47
|
+
Scalar loads UI assets from `https://cdn.jsdelivr.net` and uses inline scripts. If your app sets a `Content-Security-Policy` header, update `script-src` to allow:
|
|
48
|
+
|
|
49
|
+
```http
|
|
50
|
+
Content-Security-Policy: script-src 'self' https://cdn.jsdelivr.net 'unsafe-inline'; style-src 'self' 'unsafe-inline'
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
For stricter security, use a nonce or hash (the hash changes per Scalar version — generate it from the inline script content or pin a specific version).
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.setupSwaggerUI = void 0;
|
|
4
|
+
var swagger_setup_js_1 = require("./swagger-setup.js");
|
|
5
|
+
Object.defineProperty(exports, "setupSwaggerUI", { enumerable: true, get: function () { return swagger_setup_js_1.setupSwaggerUI; } });
|
|
6
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/swagger/index.ts"],"names":[],"mappings":";;;AACA,uDAAoD;AAA3C,kHAAA,cAAc,OAAA"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.setupSwaggerUI = setupSwaggerUI;
|
|
4
|
+
const swagger_1 = require("@nestjs/swagger");
|
|
5
|
+
const nestjs_api_reference_1 = require("@scalar/nestjs-api-reference");
|
|
6
|
+
function setupSwaggerUI(app, options) {
|
|
7
|
+
const path = (options.path || 'api-docs').replace(/^\/+|\/+$/g, '');
|
|
8
|
+
const config = new swagger_1.DocumentBuilder()
|
|
9
|
+
.setTitle(options.title || 'API Documentation')
|
|
10
|
+
.setDescription(options.description || '')
|
|
11
|
+
.setVersion(options.version || '1.0');
|
|
12
|
+
if (options.serverUrl) {
|
|
13
|
+
config.addServer(options.serverUrl, options.serverDescription);
|
|
14
|
+
}
|
|
15
|
+
const document = swagger_1.SwaggerModule.createDocument(app, config.build());
|
|
16
|
+
app.use(`/${path}`, (0, nestjs_api_reference_1.apiReference)({
|
|
17
|
+
content: document,
|
|
18
|
+
...(options.persistAuth && { persistAuth: true }),
|
|
19
|
+
}));
|
|
20
|
+
}
|
|
21
|
+
//# sourceMappingURL=swagger-setup.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"swagger-setup.js","sourceRoot":"","sources":["../../src/swagger/swagger-setup.ts"],"names":[],"mappings":";;AAKA,wCAwBC;AA5BD,6CAAiE;AACjE,uEAA4D;AAG5D,SAAgB,cAAc,CAC5B,GAAqB,EACrB,OAA4B;IAE5B,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,UAAU,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAEpE,MAAM,MAAM,GAAG,IAAI,yBAAe,EAAE;SACjC,QAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,mBAAmB,CAAC;SAC9C,cAAc,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC;SACzC,UAAU,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC;IAExC,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACtB,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,QAAQ,GAAG,uBAAa,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAEnE,GAAG,CAAC,GAAG,CACL,IAAI,IAAI,EAAE,EACV,IAAA,mCAAY,EAAC;QACX,OAAO,EAAE,QAAQ;QACjB,GAAG,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;KAClD,CAAC,CACH,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"swagger.interfaces.js","sourceRoot":"","sources":["../../src/swagger/swagger.interfaces.ts"],"names":[],"mappings":""}
|