@scalar/nestjs-api-reference 0.5.2 → 0.5.4

package/README.md

@@ -1,4 +1,4 @@
-# Scalar NestJS API Reference Plugin
+# Scalar API Reference Plugin for NestJS
 
 [![Version](https://img.shields.io/npm/v/%40scalar/nestjs-api-reference)](https://www.npmjs.com/package/@scalar/nestjs-api-reference)
 [![Downloads](https://img.shields.io/npm/dm/%40scalar/nestjs-api-reference)](https://www.npmjs.com/package/@scalar/nestjs-api-reference)
@@ -7,91 +7,14 @@
 
 This middleware provides an easy way to render a beautiful API reference based on an OpenAPI/Swagger file with NestJS.
 
-## Installation
+## Documentation
 
-```bash
-npm install @scalar/nestjs-api-reference
-```
+[Read the documentation here](https://guides.scalar.com/scalar/scalar-api-references/integrations/nestjs)
 
-## Usage
+## Community
 
-[Set up NestJS](https://docs.nestjs.com/first-steps) and [set up NestJS Swagger](https://docs.nestjs.com/openapi/introduction) and pass an OpenAPI/Swagger document to the `apiReference` middleware:
+We are API nerds. You too? Let’s chat on Discord: <https://discord.gg/scalar>
 
-```ts
-import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'
-import { apiReference } from '@scalar/nestjs-api-reference'
+## License
 
-/* ... */
-const app = await NestFactory.create(AppModule)
-
-const config = new DocumentBuilder()
-  .setTitle('Cats example')
-  .setDescription('The cats API description')
-  .setVersion('1.0')
-  .addTag('cats')
-  .build()
-
-const document = SwaggerModule.createDocument(app, config)
-/* ... */
-
-const OpenApiSpecification =
-  /* … */
-
-  app.use(
-    '/reference',
-    apiReference({
-      content: document,
-    }),
-  )
-```
-
-Recommended: If you’re serving an OpenAPI/Swagger file already, you can pass an URL, too:
-
-```ts
-import { apiReference } from '@scalar/nestjs-api-reference'
-
-app.use(
-  '/reference',
-  apiReference({
-    url: '/openapi.json',
-  }),
-)
-```
-
-The NestJS middleware takes our universal configuration object, [read more about configuration](https://github.com/scalar/scalar/tree/main/packages/api-reference#props) in the core package README.
-
-### Themes
-
-The middleware comes with a custom theme for NestJS. You can use one of [the other predefined themes](https://github.com/scalar/scalar/blob/main/packages/themes/src/index.ts#L15) (`alternate`, `default`, `moon`, `purple`, `solarized`) or overwrite it with `none`. All themes come with a light and dark color scheme.
-
-```ts
-import { apiReference } from '@scalar/nestjs-api-reference'
-
-app.use(
-  '/reference',
-  apiReference({
-    theme: 'purple',
-    url: '/openapi.json',
-  }),
-)
-```
-
-### Custom CDN
-
-You can use a custom CDN ，default is `https://cdn.jsdelivr.net/npm/@scalar/api-reference`.
-
-You can also pin the CDN to a specific version by specifying it in the CDN string like `https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.25.28`
-
-You can find all available CDN versions [here](https://www.jsdelivr.com/package/npm/@scalar/api-reference?tab=files)
-
-```ts
-import { apiReference } from '@scalar/nestjs-api-reference'
-
-app.use(
-  '/reference',
-  apiReference({
-    cdn: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@latest',
-    content: OpenApiSpecification,
-  }),
-)
-```
+The source code in this repository is licensed under [MIT](https://github.com/scalar/scalar/blob/main/LICENSE).

package/dist/index.cjs

@@ -3,6 +3,7 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -95,7 +96,7 @@ var customThemeCSS = `
   --scalar-scrollbar-color-active: rgba(255, 255, 255, 0.48);
 }
 `;
-var ApiReference = (options) => {
+var ApiReference = /* @__PURE__ */ __name((options) => {
   const configuration = {
     _integration: "nestjs",
     ...options
@@ -107,7 +108,7 @@ var ApiReference = (options) => {
       data-configuration="${JSON.stringify(configuration).split('"').join("&quot;")}">${configuration.content ? typeof configuration.content === "function" ? JSON.stringify(configuration.content()) : JSON.stringify(configuration.content) : ""}</script>
     <script src="${configuration.cdn || "https://cdn.jsdelivr.net/npm/@scalar/api-reference"}"></script>
   `;
-};
+}, "ApiReference");
 function apiReference(options) {
   const content = `
     <!DOCTYPE html>
@@ -129,7 +130,9 @@ function apiReference(options) {
   `;
   if (options.withFastify) {
     return (_req, res) => {
-      res.writeHead(200, { "Content-Type": "text/html" });
+      res.writeHead(200, {
+        "Content-Type": "text/html"
+      });
       res.write(content);
       res.end();
     };
@@ -138,6 +141,7 @@ function apiReference(options) {
     res.send(content);
   };
 }
+__name(apiReference, "apiReference");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ApiReference,

package/dist/index.js

@@ -1,3 +1,6 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
 // src/nestJSApiReference.ts
 var customThemeCSS = `
 /* basic theme */
@@ -67,7 +70,7 @@ var customThemeCSS = `
   --scalar-scrollbar-color-active: rgba(255, 255, 255, 0.48);
 }
 `;
-var ApiReference = (options) => {
+var ApiReference = /* @__PURE__ */ __name((options) => {
   const configuration = {
     _integration: "nestjs",
     ...options
@@ -79,7 +82,7 @@ var ApiReference = (options) => {
       data-configuration="${JSON.stringify(configuration).split('"').join("&quot;")}">${configuration.content ? typeof configuration.content === "function" ? JSON.stringify(configuration.content()) : JSON.stringify(configuration.content) : ""}</script>
     <script src="${configuration.cdn || "https://cdn.jsdelivr.net/npm/@scalar/api-reference"}"></script>
   `;
-};
+}, "ApiReference");
 function apiReference(options) {
   const content = `
     <!DOCTYPE html>
@@ -101,7 +104,9 @@ function apiReference(options) {
   `;
   if (options.withFastify) {
     return (_req, res) => {
-      res.writeHead(200, { "Content-Type": "text/html" });
+      res.writeHead(200, {
+        "Content-Type": "text/html"
+      });
       res.write(content);
       res.end();
     };
@@ -110,6 +115,7 @@ function apiReference(options) {
     res.send(content);
   };
 }
+__name(apiReference, "apiReference");
 export {
   ApiReference,
   apiReference,

package/package.json

@@ -10,7 +10,7 @@
     "url": "git+https://github.com/scalar/scalar.git",
     "directory": "integrations/nestjs"
   },
-  "version": "0.5.2",
+  "version": "0.5.4",
   "engines": {
     "node": ">=20"
   },
@@ -34,16 +34,21 @@
   ],
   "module": "dist/index.js",
   "dependencies": {
-    "@scalar/types": "0.2.2"
+    "@scalar/types": "0.2.3"
   },
   "devDependencies": {
+    "@nestjs/common": "^11.0.16",
+    "@nestjs/platform-fastify": "^10.3.8",
+    "@nestjs/testing": "^10.0.0",
     "@types/express": "^5.0.1",
+    "@types/supertest": "^2.0.12",
     "express": "^5.1.0",
     "fastify": "^4.26.2",
+    "supertest": "^6.3.3",
     "tsup": "^8.3.5",
     "vite": "5.4.19",
     "vitest": "^1.6.0",
-    "@scalar/api-reference": "1.31.4"
+    "@scalar/api-reference": "1.31.15"
   },
   "scripts": {
     "build": "tsup ./src/index.ts --format esm,cjs --dts",
@@ -57,7 +62,7 @@
     "docker:run-fastify": "docker run -p 5057:5057 nestjs-api-reference-fastify",
     "lint:check": "eslint .",
     "lint:fix": "eslint .  --fix",
-    "test": "vitest run",
+    "test": "vitest",
     "types:check": "tsc --noEmit"
   }
 }