nesthub 1.0.2 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nesthub",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "All-in-one modular toolkit for NestJS",
   "keywords": [
     "nestjs",
@@ -16,7 +16,12 @@
     "telegram",
     "sms",
     "email",
-    "crud"
+    "crud",
+    "swagger",
+    "scalar",
+    "api-docs",
+    "api-reference",
+    "excel"
   ],
   "author": "Wind Blade <vn.chemgio@yahoo.com> (https://github.com/Vn-ChemGio)",
   "funding": {
@@ -68,6 +73,11 @@
       "types": "./dist/excel/index.d.ts",
       "import": "./dist/excel/index.js",
       "require": "./dist/excel/index.js"
+    },
+    "./swagger": {
+      "types": "./dist/swagger/index.d.ts",
+      "import": "./dist/swagger/index.js",
+      "require": "./dist/swagger/index.js"
     }
   },
   "typesVersions": {
@@ -86,6 +96,9 @@
       ],
       "excel": [
         "./dist/excel/index.d.ts"
+      ],
+      "swagger": [
+        "./dist/swagger/index.d.ts"
       ]
     }
   },
@@ -101,10 +114,11 @@
     "src/cache/README.md",
     "src/queue/README.md",
     "src/notification/README.md",
-    "src/excel/README.md"
+    "src/excel/README.md",
+    "src/swagger/README.md"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.build.json && node -e \"require('fs').copyFileSync('src/typeorm/README.md','dist/typeorm/README.md');require('fs').copyFileSync('src/cache/README.md','dist/cache/README.md');require('fs').copyFileSync('src/queue/README.md','dist/queue/README.md');require('fs').copyFileSync('src/notification/README.md','dist/notification/README.md');require('fs').copyFileSync('src/excel/README.md','dist/excel/README.md')\"",
+    "build": "tsc -p tsconfig.build.json && node -e \"require('fs').copyFileSync('src/typeorm/README.md','dist/typeorm/README.md');require('fs').copyFileSync('src/cache/README.md','dist/cache/README.md');require('fs').copyFileSync('src/queue/README.md','dist/queue/README.md');require('fs').copyFileSync('src/notification/README.md','dist/notification/README.md');require('fs').copyFileSync('src/excel/README.md','dist/excel/README.md');require('fs').copyFileSync('src/swagger/README.md','dist/swagger/README.md')\"",
     "clean": "rimraf dist",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
     "lint": "eslint \"{src,test}/**/*.ts\" --fix",
@@ -122,7 +136,10 @@
     "@nestjs/common": "^11.0.1",
     "@nestjs/config": "^4.0.4",
     "@nestjs/core": "^11.0.1",
+    "@nestjs/swagger": "^11.0.0",
     "@nestjs/typeorm": "^11.0.1",
+    "@scalar/api-reference": "^1.60.0",
+    "@scalar/nestjs-api-reference": "^1.0.0",
     "bullmq": "^5.44.0",
     "exceljs": "^4.4.0",
     "firebase-admin": "^13.0.2",
@@ -167,6 +184,12 @@
     },
     "exceljs": {
       "optional": true
+    },
+    "@nestjs/swagger": {
+      "optional": true
+    },
+    "@scalar/nestjs-api-reference": {
+      "optional": true
     }
   },
   "dependencies": {
@@ -184,8 +207,10 @@
     "@nestjs/common": "^11.0.1",
     "@nestjs/config": "^4.0.4",
     "@nestjs/core": "^11.0.1",
+    "@nestjs/swagger": "^11.0.0",
     "@nestjs/testing": "^11.0.1",
     "@nestjs/typeorm": "^11.0.1",
+    "@scalar/nestjs-api-reference": "^1.0.0",
     "@types/jest": "^30.0.0",
     "@types/node": "^24.0.0",
     "bullmq": "^5.44.0",
@@ -215,7 +240,12 @@
     "rootDir": "src",
     "testRegex": ".*\\.spec\\.ts$",
     "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
+      "^.+\\.(t|j)s$": [
+        "ts-jest",
+        {
+          "tsconfig": "tsconfig.test.json"
+        }
+      ]
     },
     "moduleNameMapper": {
       "^(\\.{1,2}/.*)\\.js$": "$1"

package/src/notification/README.md

@@ -235,3 +235,56 @@ export class AppModule {}
 | `createdAt` | `created_at` |
 | `updatedAt` | `updated_at` |
 | `sentAt` | `sent_at` |
+
+## Telegram Channel
+
+### Configuration
+
+```typescript
+channels: {
+  telegram: { botToken: '123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11' },
+}
+```
+
+### Sending messages
+
+**Text only** — sends via `/sendMessage`:
+```typescript
+await notification.send({
+  channel: 'telegram',
+  to: '1077316390',
+  content: '<b>Hello</b> from HTML',
+});
+```
+
+**With file attachment** — sends via `/sendDocument`, `content` becomes the caption:
+```typescript
+await notification.send({
+  channel: 'telegram',
+  to: '1077316390',
+  content: 'Report attached',
+  attachments: [{ filename: 'report.xlsx', content: buffer }],
+});
+```
+
+**Multiple files** — sends via `/sendMediaGroup` (single request), caption on last file:
+```typescript
+await notification.send({
+  channel: 'telegram',
+  to: '1077316390',
+  content: 'Monthly reports',
+  attachments: [
+    { filename: 'jan.xlsx', content: buf1 },
+    { filename: 'feb.xlsx', content: buf2 },
+  ],
+});
+```
+
+**Attachment from file path:**
+```typescript
+await notification.send({
+  channel: 'telegram',
+  to: '1077316390',
+  attachments: [{ filename: 'photo.jpg', path: '/tmp/photo.jpg' }],
+});
+```

package/src/swagger/README.md

@@ -0,0 +1,53 @@
+# @nesthub/swagger
+
+Scalar API reference for NestJS — powered by `@scalar/nestjs-api-reference`.
+
+## Installation
+
+```bash
+npm install @nestjs/swagger @scalar/nestjs-api-reference
+```
+
+## Usage
+
+```typescript
+import { NestFactory } from '@nestjs/core';
+import { setupSwaggerUI } from 'nesthub/swagger';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+
+  setupSwaggerUI(app, {
+    title: 'My API',
+    description: 'API documentation',
+    version: '1.0.0',
+    persistAuth: true,
+    serverUrl: 'http://localhost:3000',
+  });
+
+  await app.listen(3000);
+}
+```
+
+## Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `path` | `string` | `'api-docs'` | Path to serve Scalar |
+| `title` | `string` | `'API Documentation'` | API title |
+| `description` | `string` | `''` | API description |
+| `version` | `string` | `'1.0'` | API version |
+| `persistAuth` | `boolean` | `false` | Persist auth in localStorage |
+| `serverUrl` | `string` | `undefined` | Server URL |
+| `serverDescription` | `string` | `undefined` | Server description |
+
+## Content Security Policy
+
+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:
+
+```http
+Content-Security-Policy: script-src 'self' https://cdn.jsdelivr.net 'unsafe-inline'; style-src 'self' 'unsafe-inline'
+```
+
+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).