nesthub 1.0.3 → 1.1.0

package/dist/index.d.ts

@@ -2,3 +2,4 @@ export * from './typeorm';
 export * from './cache';
 export * from './queue';
 export * from './notification';
+export * from './swagger';

package/dist/index.js

@@ -18,4 +18,5 @@ __exportStar(require("./typeorm"), exports);
 __exportStar(require("./cache"), exports);
 __exportStar(require("./queue"), exports);
 __exportStar(require("./notification"), exports);
+__exportStar(require("./swagger"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,0CAAwB;AACxB,0CAAwB;AACxB,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,0CAAwB;AACxB,0CAAwB;AACxB,iDAA+B;AAC/B,4CAA0B"}

package/dist/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).

package/dist/swagger/index.d.ts

@@ -0,0 +1,2 @@
+export type { SwaggerSetupOptions } from './swagger.interfaces.js';
+export { setupSwaggerUI } from './swagger-setup.js';

package/dist/swagger/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupSwaggerUI = void 0;
+var swagger_setup_js_1 = require("./swagger-setup.js");
+Object.defineProperty(exports, "setupSwaggerUI", { enumerable: true, get: function () { return swagger_setup_js_1.setupSwaggerUI; } });
+//# sourceMappingURL=index.js.map

package/dist/swagger/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/swagger/index.ts"],"names":[],"mappings":";;;AACA,uDAAoD;AAA3C,kHAAA,cAAc,OAAA"}

package/dist/swagger/swagger-setup.d.ts

@@ -0,0 +1,3 @@
+import type { INestApplication } from '@nestjs/common';
+import type { SwaggerSetupOptions } from './swagger.interfaces.js';
+export declare function setupSwaggerUI(app: INestApplication, options: SwaggerSetupOptions): void;

package/dist/swagger/swagger-setup.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupSwaggerUI = setupSwaggerUI;
+const swagger_1 = require("@nestjs/swagger");
+const nestjs_api_reference_1 = require("@scalar/nestjs-api-reference");
+function setupSwaggerUI(app, options) {
+    const path = (options.path || 'api-docs').replace(/^\/+|\/+$/g, '');
+    const config = new swagger_1.DocumentBuilder()
+        .setTitle(options.title || 'API Documentation')
+        .setDescription(options.description || '')
+        .setVersion(options.version || '1.0');
+    if (options.serverUrl) {
+        config.addServer(options.serverUrl, options.serverDescription);
+    }
+    const document = swagger_1.SwaggerModule.createDocument(app, config.build());
+    app.use(`/${path}`, (0, nestjs_api_reference_1.apiReference)({
+        content: document,
+        ...(options.persistAuth && { persistAuth: true }),
+    }));
+}
+//# sourceMappingURL=swagger-setup.js.map

package/dist/swagger/swagger-setup.js.map

@@ -0,0 +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"}

package/dist/swagger/swagger.interfaces.d.ts

@@ -0,0 +1,9 @@
+export interface SwaggerSetupOptions {
+    path?: string;
+    title?: string;
+    description?: string;
+    version?: string;
+    serverUrl?: string;
+    serverDescription?: string;
+    persistAuth?: boolean;
+}

package/dist/swagger/swagger.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=swagger.interfaces.js.map

package/dist/swagger/swagger.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger.interfaces.js","sourceRoot":"","sources":["../../src/swagger/swagger.interfaces.ts"],"names":[],"mappings":""}