@scalar/nextjs-openapi 0.1.19 → 0.2.3

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @scalar/nextjs-openapi
 
+## 0.2.3
+
+### Patch Changes
+
+- 66e2768: Removed app router route group from url
+  - @scalar/nextjs-api-reference@0.8.3
+  - @scalar/ts-to-openapi@0.1.0
+  - @scalar/types@0.2.1
+
+## 0.2.2
+
+### Patch Changes
+
+- Updated dependencies [e660779]
+  - @scalar/nextjs-api-reference@0.8.3
+
+## 0.2.1
+
+### Patch Changes
+
+- Updated dependencies [4440949]
+  - @scalar/types@0.2.1
+  - @scalar/nextjs-api-reference@0.8.1
+
+## 0.2.0
+
+### Minor Changes
+
+- 483ca93: chore: require Node 20 (or above)
+
+### Patch Changes
+
+- Updated dependencies [483ca93]
+  - @scalar/ts-to-openapi@0.1.0
+  - @scalar/nextjs-api-reference@0.8.0
+  - @scalar/types@0.2.0
+
 ## 0.1.19
 
 ### Patch Changes

package/dist/openapi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../src/openapi.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAE5E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAa9C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAA;AA+BtC;;;;;;;;;GASG;AACH,eAAO,MAAM,OAAO,YAAY,aAAa;eAmCxB,WAAW;CAe/B,CAAA"}
+{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../src/openapi.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAE5E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAa9C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAA;AA+BtC;;;;;;;;;GASG;AACH,eAAO,MAAM,OAAO,YAAY,aAAa;eAoCxB,WAAW;CAe/B,CAAA"}

package/dist/openapi.js

@@ -46,7 +46,7 @@ const OpenAPI = (config = {}) => {
     const sourceFile = program.getSourceFile(fileName);
     if (sourceFile) {
       const resp = getPathSchema(sourceFile, program);
-      const rawPath = fileName.replace(/^(?:src\/)?app|\/route\.ts$/g, "").replace(/\[/g, "{").replace(/]/g, "}");
+      const rawPath = fileName.replace(/^(?:src\/)?app|\/route\.ts$/g, "").replace(/\[/g, "{").replace(/\/\(\w+\)/g, "").replace(/]/g, "}");
       const path = rawPath.startsWith("/") ? rawPath : "/" + rawPath;
       spec.paths[path] = resp;
     }

package/dist/openapi.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/openapi.ts"],
-  "sourcesContent": ["import { readFileSync } from 'node:fs'\nimport { ApiReference } from '@scalar/nextjs-api-reference'\nimport type { ApiReferenceConfiguration } from '@scalar/types/api-reference'\nimport { sync } from 'fast-glob'\nimport type { NextRequest } from 'next/server'\nimport type { OpenAPIV3_1 } from 'openapi-types'\nimport {\n  type CompilerHost,\n  JSDocParsingMode,\n  ScriptKind,\n  ScriptTarget,\n  createProgram,\n  createSourceFile,\n} from 'typescript'\n\nimport { getPathSchema } from './path'\n\n/**\n * Scalar OpenAPI config\n */\nexport type OpenAPIConfig = {\n  /**\n   * The base directory for your API files\n   * @default 'app/api'\n   */\n  apiDirectory?: string\n} & Partial<ApiReferenceConfiguration>\n\n// TODO switch to watcher\n// @see https://github.com/microsoft/TypeScript-wiki/blob/main/Using-the-Compiler-API.md#writing-an-incremental-program-watcher\nconst compilerHost: CompilerHost = {\n  fileExists: () => true,\n  getCanonicalFileName: (filename) => filename,\n  getCurrentDirectory: () => '',\n  getDefaultLibFileName: () => '',\n  getNewLine: () => '\\n',\n  getSourceFile: (filename) =>\n    createSourceFile(filename, readFileSync(filename).toString(), ScriptTarget.Latest, false, ScriptKind.TS),\n  jsDocParsingMode: JSDocParsingMode.ParseAll,\n  readFile: () => undefined,\n  useCaseSensitiveFileNames: () => true,\n  writeFile: () => null,\n}\n\n/** OpenAPI 3.1.0 Spec */\nconst spec: OpenAPIV3_1.Document = {\n  openapi: '3.1.0',\n  info: {\n    title: `${process.env.npm_package_name} - Next.js OpenAPI Spec by Scalar`,\n    description:\n      process.env.npm_package_description ||\n      'This file has been autogenerated, check out the docs to see how to customize these options',\n    version: process.env.npm_package_version || '0.0.0',\n  },\n  paths: {},\n}\n\n/**\n * Scalar Next.js OpenAPI schema generation\n *\n * Handles both the schema generation as well as the references\n *\n * TODO:\n * - Docs\n * - file watcher\n * - caching\n */\nexport const OpenAPI = (config: OpenAPIConfig = {}) => {\n  const apiDirectory = config.apiDirectory ?? 'app/api'\n  /** All ts files required for the schema */\n  const programFileNames = sync(apiDirectory + '/**/*.ts')\n  /** Specific route files to generate paths */\n  const routeFileNames = sync(apiDirectory + '/**/route.ts')\n\n  const program = createProgram(\n    programFileNames,\n    {\n      noResolve: true,\n      target: ScriptTarget.Latest,\n    },\n    compilerHost,\n  )\n\n  // Loop over all non scalar files to extract openapi data using AST\n  routeFileNames.forEach((fileName) => {\n    const sourceFile = program.getSourceFile(fileName)\n\n    if (sourceFile) {\n      const resp = getPathSchema(sourceFile, program)\n\n      // Grab the path from the fileName\n      const rawPath = fileName\n        .replace(/^(?:src\\/)?app|\\/route\\.ts$/g, '')\n        .replace(/\\[/g, '{')\n        .replace(/]/g, '}')\n      const path = rawPath.startsWith('/') ? rawPath : '/' + rawPath\n\n      spec.paths[path] = resp\n    }\n  })\n\n  return {\n    GET: async (req: NextRequest) => {\n      // OpenAPI Schema JSON\n      if (req.nextUrl.pathname.endsWith('.json')) {\n        // Just grabbing the origin here but we can be smarter and look for the greatest common few segments\n        spec.servers = [{ url: req.nextUrl.origin }]\n\n        return Response.json(spec)\n      }\n      // References\n\n      return await ApiReference({\n        url: req.nextUrl.pathname + '/schema.json',\n      })()\n    },\n  }\n}\n"],
-  "mappings": "AAAA,SAAS,oBAAoB;AAC7B,SAAS,oBAAoB;AAE7B,SAAS,YAAY;AAGrB;AAAA,EAEE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,qBAAqB;AAe9B,MAAM,eAA6B;AAAA,EACjC,YAAY,MAAM;AAAA,EAClB,sBAAsB,CAAC,aAAa;AAAA,EACpC,qBAAqB,MAAM;AAAA,EAC3B,uBAAuB,MAAM;AAAA,EAC7B,YAAY,MAAM;AAAA,EAClB,eAAe,CAAC,aACd,iBAAiB,UAAU,aAAa,QAAQ,EAAE,SAAS,GAAG,aAAa,QAAQ,OAAO,WAAW,EAAE;AAAA,EACzG,kBAAkB,iBAAiB;AAAA,EACnC,UAAU,MAAM;AAAA,EAChB,2BAA2B,MAAM;AAAA,EACjC,WAAW,MAAM;AACnB;AAGA,MAAM,OAA6B;AAAA,EACjC,SAAS;AAAA,EACT,MAAM;AAAA,IACJ,OAAO,GAAG,QAAQ,IAAI,gBAAgB;AAAA,IACtC,aACE,QAAQ,IAAI,2BACZ;AAAA,IACF,SAAS,QAAQ,IAAI,uBAAuB;AAAA,EAC9C;AAAA,EACA,OAAO,CAAC;AACV;AAYO,MAAM,UAAU,CAAC,SAAwB,CAAC,MAAM;AACrD,QAAM,eAAe,OAAO,gBAAgB;AAE5C,QAAM,mBAAmB,KAAK,eAAe,UAAU;AAEvD,QAAM,iBAAiB,KAAK,eAAe,cAAc;AAEzD,QAAM,UAAU;AAAA,IACd;AAAA,IACA;AAAA,MACE,WAAW;AAAA,MACX,QAAQ,aAAa;AAAA,IACvB;AAAA,IACA;AAAA,EACF;AAGA,iBAAe,QAAQ,CAAC,aAAa;AACnC,UAAM,aAAa,QAAQ,cAAc,QAAQ;AAEjD,QAAI,YAAY;AACd,YAAM,OAAO,cAAc,YAAY,OAAO;AAG9C,YAAM,UAAU,SACb,QAAQ,gCAAgC,EAAE,EAC1C,QAAQ,OAAO,GAAG,EAClB,QAAQ,MAAM,GAAG;AACpB,YAAM,OAAO,QAAQ,WAAW,GAAG,IAAI,UAAU,MAAM;AAEvD,WAAK,MAAM,IAAI,IAAI;AAAA,IACrB;AAAA,EACF,CAAC;AAED,SAAO;AAAA,IACL,KAAK,OAAO,QAAqB;AAE/B,UAAI,IAAI,QAAQ,SAAS,SAAS,OAAO,GAAG;AAE1C,aAAK,UAAU,CAAC,EAAE,KAAK,IAAI,QAAQ,OAAO,CAAC;AAE3C,eAAO,SAAS,KAAK,IAAI;AAAA,MAC3B;AAGA,aAAO,MAAM,aAAa;AAAA,QACxB,KAAK,IAAI,QAAQ,WAAW;AAAA,MAC9B,CAAC,EAAE;AAAA,IACL;AAAA,EACF;AACF;",
+  "sourcesContent": ["import { readFileSync } from 'node:fs'\nimport { ApiReference } from '@scalar/nextjs-api-reference'\nimport type { ApiReferenceConfiguration } from '@scalar/types/api-reference'\nimport { sync } from 'fast-glob'\nimport type { NextRequest } from 'next/server'\nimport type { OpenAPIV3_1 } from 'openapi-types'\nimport {\n  type CompilerHost,\n  JSDocParsingMode,\n  ScriptKind,\n  ScriptTarget,\n  createProgram,\n  createSourceFile,\n} from 'typescript'\n\nimport { getPathSchema } from './path'\n\n/**\n * Scalar OpenAPI config\n */\nexport type OpenAPIConfig = {\n  /**\n   * The base directory for your API files\n   * @default 'app/api'\n   */\n  apiDirectory?: string\n} & Partial<ApiReferenceConfiguration>\n\n// TODO switch to watcher\n// @see https://github.com/microsoft/TypeScript-wiki/blob/main/Using-the-Compiler-API.md#writing-an-incremental-program-watcher\nconst compilerHost: CompilerHost = {\n  fileExists: () => true,\n  getCanonicalFileName: (filename) => filename,\n  getCurrentDirectory: () => '',\n  getDefaultLibFileName: () => '',\n  getNewLine: () => '\\n',\n  getSourceFile: (filename) =>\n    createSourceFile(filename, readFileSync(filename).toString(), ScriptTarget.Latest, false, ScriptKind.TS),\n  jsDocParsingMode: JSDocParsingMode.ParseAll,\n  readFile: () => undefined,\n  useCaseSensitiveFileNames: () => true,\n  writeFile: () => null,\n}\n\n/** OpenAPI 3.1.0 Spec */\nconst spec: OpenAPIV3_1.Document = {\n  openapi: '3.1.0',\n  info: {\n    title: `${process.env.npm_package_name} - Next.js OpenAPI Spec by Scalar`,\n    description:\n      process.env.npm_package_description ||\n      'This file has been autogenerated, check out the docs to see how to customize these options',\n    version: process.env.npm_package_version || '0.0.0',\n  },\n  paths: {},\n}\n\n/**\n * Scalar Next.js OpenAPI schema generation\n *\n * Handles both the schema generation as well as the references\n *\n * TODO:\n * - Docs\n * - file watcher\n * - caching\n */\nexport const OpenAPI = (config: OpenAPIConfig = {}) => {\n  const apiDirectory = config.apiDirectory ?? 'app/api'\n  /** All ts files required for the schema */\n  const programFileNames = sync(apiDirectory + '/**/*.ts')\n  /** Specific route files to generate paths */\n  const routeFileNames = sync(apiDirectory + '/**/route.ts')\n\n  const program = createProgram(\n    programFileNames,\n    {\n      noResolve: true,\n      target: ScriptTarget.Latest,\n    },\n    compilerHost,\n  )\n\n  // Loop over all non scalar files to extract openapi data using AST\n  routeFileNames.forEach((fileName) => {\n    const sourceFile = program.getSourceFile(fileName)\n\n    if (sourceFile) {\n      const resp = getPathSchema(sourceFile, program)\n\n      // Grab the path from the fileName\n      const rawPath = fileName\n        .replace(/^(?:src\\/)?app|\\/route\\.ts$/g, '')\n        .replace(/\\[/g, '{')\n        .replace(/\\/\\(\\w+\\)/g, '')\n        .replace(/]/g, '}')\n      const path = rawPath.startsWith('/') ? rawPath : '/' + rawPath\n\n      spec.paths[path] = resp\n    }\n  })\n\n  return {\n    GET: async (req: NextRequest) => {\n      // OpenAPI Schema JSON\n      if (req.nextUrl.pathname.endsWith('.json')) {\n        // Just grabbing the origin here but we can be smarter and look for the greatest common few segments\n        spec.servers = [{ url: req.nextUrl.origin }]\n\n        return Response.json(spec)\n      }\n      // References\n\n      return await ApiReference({\n        url: req.nextUrl.pathname + '/schema.json',\n      })()\n    },\n  }\n}\n"],
+  "mappings": "AAAA,SAAS,oBAAoB;AAC7B,SAAS,oBAAoB;AAE7B,SAAS,YAAY;AAGrB;AAAA,EAEE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,qBAAqB;AAe9B,MAAM,eAA6B;AAAA,EACjC,YAAY,MAAM;AAAA,EAClB,sBAAsB,CAAC,aAAa;AAAA,EACpC,qBAAqB,MAAM;AAAA,EAC3B,uBAAuB,MAAM;AAAA,EAC7B,YAAY,MAAM;AAAA,EAClB,eAAe,CAAC,aACd,iBAAiB,UAAU,aAAa,QAAQ,EAAE,SAAS,GAAG,aAAa,QAAQ,OAAO,WAAW,EAAE;AAAA,EACzG,kBAAkB,iBAAiB;AAAA,EACnC,UAAU,MAAM;AAAA,EAChB,2BAA2B,MAAM;AAAA,EACjC,WAAW,MAAM;AACnB;AAGA,MAAM,OAA6B;AAAA,EACjC,SAAS;AAAA,EACT,MAAM;AAAA,IACJ,OAAO,GAAG,QAAQ,IAAI,gBAAgB;AAAA,IACtC,aACE,QAAQ,IAAI,2BACZ;AAAA,IACF,SAAS,QAAQ,IAAI,uBAAuB;AAAA,EAC9C;AAAA,EACA,OAAO,CAAC;AACV;AAYO,MAAM,UAAU,CAAC,SAAwB,CAAC,MAAM;AACrD,QAAM,eAAe,OAAO,gBAAgB;AAE5C,QAAM,mBAAmB,KAAK,eAAe,UAAU;AAEvD,QAAM,iBAAiB,KAAK,eAAe,cAAc;AAEzD,QAAM,UAAU;AAAA,IACd;AAAA,IACA;AAAA,MACE,WAAW;AAAA,MACX,QAAQ,aAAa;AAAA,IACvB;AAAA,IACA;AAAA,EACF;AAGA,iBAAe,QAAQ,CAAC,aAAa;AACnC,UAAM,aAAa,QAAQ,cAAc,QAAQ;AAEjD,QAAI,YAAY;AACd,YAAM,OAAO,cAAc,YAAY,OAAO;AAG9C,YAAM,UAAU,SACb,QAAQ,gCAAgC,EAAE,EAC1C,QAAQ,OAAO,GAAG,EAClB,QAAQ,cAAc,EAAE,EACxB,QAAQ,MAAM,GAAG;AACpB,YAAM,OAAO,QAAQ,WAAW,GAAG,IAAI,UAAU,MAAM;AAEvD,WAAK,MAAM,IAAI,IAAI;AAAA,IACrB;AAAA,EACF,CAAC;AAED,SAAO;AAAA,IACL,KAAK,OAAO,QAAqB;AAE/B,UAAI,IAAI,QAAQ,SAAS,SAAS,OAAO,GAAG;AAE1C,aAAK,UAAU,CAAC,EAAE,KAAK,IAAI,QAAQ,OAAO,CAAC;AAE3C,eAAO,SAAS,KAAK,IAAI;AAAA,MAC3B;AAGA,aAAO,MAAM,aAAa;AAAA,QACxB,KAAK,IAAI,QAAQ,WAAW;AAAA,MAC9B,CAAC,EAAE;AAAA,IACL;AAAA,EACF;AACF;",
   "names": []
 }

package/package.json

@@ -16,9 +16,9 @@
     "scalar",
     "references"
   ],
-  "version": "0.1.19",
+  "version": "0.2.3",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "type": "module",
   "exports": {
@@ -34,9 +34,9 @@
   ],
   "dependencies": {
     "fast-glob": "^3.3.2",
-    "@scalar/nextjs-api-reference": "0.7.17",
-    "@scalar/ts-to-openapi": "0.0.6",
-    "@scalar/types": "0.1.16"
+    "@scalar/nextjs-api-reference": "0.8.3",
+    "@scalar/ts-to-openapi": "0.1.0",
+    "@scalar/types": "0.2.1"
   },
   "devDependencies": {
     "@types/node": "^20.17.10",
@@ -44,7 +44,7 @@
     "@types/react-dom": "^19.0.2",
     "next": "^15.2.3",
     "openapi-types": "^12.1.3",
-    "@scalar/build-tooling": "0.1.19"
+    "@scalar/build-tooling": "0.2.1"
   },
   "scripts": {
     "build": "scalar-build-esbuild",