@scalar/nestjs-api-reference 1.0.7 → 1.0.8

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 (2) hide show
  1. package/README.md +16 -5
  2. package/package.json +20 -5
package/README.md CHANGED
@@ -1,19 +1,30 @@
1
+ <!--
2
+ This file is auto-generated by the Scalar README generator.
3
+ Command: pnpm --filter @scalar-internal/build-scripts start generate-readme
4
+
5
+ Do not edit this file manually. Changes will be lost when the file is regenerated.
6
+ -->
7
+
1
8
  # Scalar API Reference Plugin for NestJS
2
9
 
3
- [![Version](https://img.shields.io/npm/v/%40scalar/nestjs-api-reference)](https://www.npmjs.com/package/@scalar/nestjs-api-reference)
4
- [![Downloads](https://img.shields.io/npm/dm/%40scalar/nestjs-api-reference)](https://www.npmjs.com/package/@scalar/nestjs-api-reference)
5
- [![License](https://img.shields.io/npm/l/%40scalar%2Fnestjs-api-reference)](https://www.npmjs.com/package/@scalar/nestjs-api-reference)
10
+ [![Version](https://img.shields.io/npm/v/@scalar/nestjs-api-reference)](https://www.npmjs.com/package/@scalar/nestjs-api-reference)
11
+ [![Downloads](https://img.shields.io/npm/dm/@scalar/nestjs-api-reference)](https://www.npmjs.com/package/@scalar/nestjs-api-reference)
12
+ [![License](https://img.shields.io/npm/l/@scalar/nestjs-api-reference)](https://www.npmjs.com/package/@scalar/nestjs-api-reference)
6
13
  [![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/scalar)
7
14
 
8
- This middleware provides an easy way to render a beautiful API reference based on an OpenAPI/Swagger file with NestJS.
15
+ NestJS module to serve beautiful, interactive API documentation from OpenAPI/Swagger documents.
9
16
 
10
17
  ## Documentation
11
18
 
12
19
  [Read the documentation here](https://guides.scalar.com/scalar/scalar-api-references/integrations/nestjs)
13
20
 
21
+ ## Changelog
22
+
23
+ See [CHANGELOG.md](https://github.com/scalar/scalar/blob/main/integrations/nestjs/CHANGELOG.md) for a list of changes.
24
+
14
25
  ## Community
15
26
 
16
- We are API nerds. You too? Let's chat on Discord: <https://discord.gg/scalar>
27
+ We are API nerds. You too? Let’s chat on Discord: <https://discord.gg/scalar>
17
28
 
18
29
  ## License
19
30
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scalar/nestjs-api-reference",
3
- "description": "A middleware for using the Scalar API reference with NestJS",
3
+ "description": "NestJS module to serve beautiful, interactive API documentation from OpenAPI/Swagger documents.",
4
4
  "license": "MIT",
5
5
  "author": "Scalar (https://github.com/scalar)",
6
6
  "homepage": "https://github.com/scalar/scalar",
@@ -10,12 +10,13 @@
10
10
  "url": "git+https://github.com/scalar/scalar.git",
11
11
  "directory": "integrations/nestjs"
12
12
  },
13
- "version": "1.0.7",
13
+ "version": "1.0.8",
14
14
  "engines": {
15
15
  "node": ">=20"
16
16
  },
17
17
  "type": "module",
18
18
  "main": "dist/index.cjs",
19
+ "module": "dist/index.js",
19
20
  "types": "dist/index.d.cts",
20
21
  "exports": {
21
22
  ".": {
@@ -32,9 +33,23 @@
32
33
  "files": [
33
34
  "dist"
34
35
  ],
35
- "module": "dist/index.js",
36
+ "readme": {
37
+ "title": "Scalar API Reference Plugin for NestJS",
38
+ "badges": [
39
+ {
40
+ "type": "npm-version"
41
+ },
42
+ {
43
+ "type": "npm-downloads"
44
+ },
45
+ {
46
+ "type": "npm-license"
47
+ }
48
+ ],
49
+ "documentation": "https://guides.scalar.com/scalar/scalar-api-references/integrations/nestjs"
50
+ },
36
51
  "dependencies": {
37
- "@scalar/core": "0.3.22"
52
+ "@scalar/core": "0.3.23"
38
53
  },
39
54
  "devDependencies": {
40
55
  "@nestjs/common": "^11.1.6",
@@ -50,7 +65,7 @@
50
65
  "tsup": "^8.3.5",
51
66
  "vite": "7.1.11",
52
67
  "vitest": "3.2.4",
53
- "@scalar/api-reference": "1.39.2"
68
+ "@scalar/api-reference": "1.40.0"
54
69
  },
55
70
  "scripts": {
56
71
  "build": "tsup ./src/index.ts --format esm,cjs --dts",