@scalar/fastify-api-reference 0.6.2 → 0.6.3

package/dist/index.cjs

@@ -0,0 +1,37 @@
+"use strict";
+const ejs = require("ejs");
+const fp = require("fastify-plugin");
+const fs = require("node:fs");
+const path = require("node:path");
+const fastifyApiReference = async (fastify, options) => {
+  var _a, _b;
+  if (!((_a = options.apiReference) == null ? void 0 : _a.spec) && !((_b = options.apiReference) == null ? void 0 : _b.specUrl)) {
+    console.warn(
+      "[@scalar/fastify-api-reference] You didn’t provide a spec or specUrl. Please provide one of these options."
+    );
+    return;
+  }
+  fastify.get(options.routePrefix ?? "/", async (_, reply) => {
+    reply.header("Content-Type", "text/html; charset=utf-8");
+    const html = await ejs.renderFile(
+      path.resolve(`${__dirname}/../dist/templates/index.ejs`),
+      {
+        options
+      }
+    );
+    reply.send(html);
+  });
+  fastify.get(
+    (options.routePrefix ?? "/") + "/fastify-api-reference.js",
+    async (_, reply) => {
+      reply.header("Content-Type", "application/javascript; charset=utf-8");
+      const content = fs.readFileSync(
+        path.resolve(`${__dirname}/../dist/templates/fastify-api-reference.js`),
+        "utf8"
+      );
+      reply.send(content);
+    }
+  );
+};
+const fastifyApiReference$1 = fp(fastifyApiReference);
+module.exports = fastifyApiReference$1;

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { default } from './fastifyApiReference.js';
+export { default } from './fastifyApiReference';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1 +1,47 @@
-export { default } from './fastifyApiReference.js';
+import __path from "path";
+import { fileURLToPath as __fileURLToPath } from "url";
+import { createRequire as __createRequire } from "module";
+const __getFilename = () => __fileURLToPath(import.meta.url);
+const __getDirname = () => __path.dirname(__getFilename());
+const __dirname = __getDirname();
+const __filename = __getFilename();
+const self = globalThis;
+const require2 = __createRequire(import.meta.url);
+import ejs from "ejs";
+import fp from "fastify-plugin";
+import fs from "node:fs";
+import path from "node:path";
+const fastifyApiReference = async (fastify, options) => {
+  var _a, _b;
+  if (!((_a = options.apiReference) == null ? void 0 : _a.spec) && !((_b = options.apiReference) == null ? void 0 : _b.specUrl)) {
+    console.warn(
+      "[@scalar/fastify-api-reference] You didn’t provide a spec or specUrl. Please provide one of these options."
+    );
+    return;
+  }
+  fastify.get(options.routePrefix ?? "/", async (_, reply) => {
+    reply.header("Content-Type", "text/html; charset=utf-8");
+    const html = await ejs.renderFile(
+      path.resolve(`${__dirname}/../dist/templates/index.ejs`),
+      {
+        options
+      }
+    );
+    reply.send(html);
+  });
+  fastify.get(
+    (options.routePrefix ?? "/") + "/fastify-api-reference.js",
+    async (_, reply) => {
+      reply.header("Content-Type", "application/javascript; charset=utf-8");
+      const content = fs.readFileSync(
+        path.resolve(`${__dirname}/../dist/templates/fastify-api-reference.js`),
+        "utf8"
+      );
+      reply.send(content);
+    }
+  );
+};
+const fastifyApiReference$1 = fp(fastifyApiReference);
+export {
+  fastifyApiReference$1 as default
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scalar/fastify-api-reference",
   "description": "a fastify plugin to render an API reference from a Swagger spec",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "author": "Scalar (https://github.com/scalar)",
   "bugs": "https://github.com/scalar/scalar/issues/new",
   "dependencies": {
@@ -28,7 +28,8 @@
     "node": ">=18"
   },
   "exports": {
-    "import": "./dist/index.js"
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
   },
   "files": [
     "dist"
@@ -42,7 +43,7 @@
     "swagger"
   ],
   "license": "MIT",
-  "main": "./dist/index.umd.cjs",
+  "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "peerDependencies": {
     "@types/ejs": "3.1.3",
@@ -58,7 +59,7 @@
   "type": "module",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "vite build && pnpm run build:template && pnpm types:build && tsc-alias -p tsconfig.build.json",
+    "build": "vite build && pnpm run build:template && tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
     "build:template": "vite build -c vite.template.config.ts",
     "lint:check": "eslint .",
     "lint:fix": "eslint .  --fix",

package/dist/fastifyApiReference.js

@@ -1,23 +0,0 @@
-import ejs from 'ejs';
-import fp from 'fastify-plugin';
-import fs from 'fs';
-import path from 'path';
-const fastifyApiReference = async (fastify, options) => {
-    if (!options.apiReference?.spec && !options.apiReference?.specUrl) {
-        console.warn('[@scalar/fastify-api-reference] You didn’t provide a spec or specUrl. Please provide one of these options.');
-        return;
-    }
-    fastify.get(options.routePrefix ?? '/', async (_, reply) => {
-        reply.header('Content-Type', 'text/html; charset=utf-8');
-        const html = await ejs.renderFile(path.resolve(`${__dirname}/../dist/templates/index.ejs`), {
-            options,
-        });
-        reply.send(html);
-    });
-    fastify.get((options.routePrefix ?? '/') + '/fastify-api-reference.js', async (_, reply) => {
-        reply.header('Content-Type', 'application/javascript; charset=utf-8');
-        const content = fs.readFileSync(path.resolve(`${__dirname}/../dist/templates/fastify-api-reference.js`), 'utf8');
-        reply.send(content);
-    });
-};
-export default fp(fastifyApiReference);

package/dist/templates/render.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=render.d.ts.map

package/dist/templates/render.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../src/templates/render.ts"],"names":[],"mappings":""}

package/dist/templates/render.js

@@ -1,69 +0,0 @@
-import { ApiReference } from '@scalar/api-reference';
-import { createApp } from 'vue';
-const specScriptTag = document.querySelector('#api-reference');
-const specElement = document.querySelector('[data-spec]');
-const specUrlElement = document.querySelector('[data-spec-url]');
-const getSpecUrl = () => {
-    // <script id="api-reference" data-url="/scalar.json" />
-    if (specScriptTag) {
-        const urlFromScriptTag = specScriptTag.getAttribute('data-url');
-        if (urlFromScriptTag) {
-            return urlFromScriptTag;
-        }
-    }
-    // <div data-spec-url="/scalar.json" />
-    if (specUrlElement) {
-        console.warn('[@scalar/api-reference] The [data-spec-url] HTML API is deprecated. Use the new <script id="api-reference" data-url="/scalar.json" /> API instead.');
-        const urlFromSpecUrlElement = specUrlElement.getAttribute('data-spec-url');
-        if (urlFromSpecUrlElement) {
-            return urlFromSpecUrlElement;
-        }
-    }
-    return null;
-};
-const getSpec = () => {
-    // <script id="api-reference" type="application/json">{"openapi":"3.1.0","info":{"title":"Example"},"paths":{}}</script>
-    if (specScriptTag) {
-        const specFromScriptTag = specScriptTag.innerHTML;
-        if (specFromScriptTag) {
-            return specFromScriptTag.trim();
-        }
-    }
-    // <div data-spec='{"openapi":"3.1.0","info":{"title":"Example"},"paths":{}}' />
-    if (specElement) {
-        console.warn('[@scalar/api-reference] The [data-spec] HTML API is deprecated. Use the new <script id="api-reference" type="application/json">{"openapi":"3.1.0","info":{"title":"Example"},"paths":{}}</script> API instead.');
-        const specFromSpecElement = specElement.getAttribute('data-spec');
-        if (specFromSpecElement) {
-            return specFromSpecElement;
-        }
-    }
-    return null;
-};
-if (!specUrlElement && !specElement && !specScriptTag) {
-    console.error('Couldn’t find a [data-spec], [data-spec-url] or <script id="api-reference" /> element. Try adding it like this: %c<div data-spec-url="https://petstore.swagger.io/v2/swagger.json" />', 'font-family: monospace;');
-}
-else {
-    const properties = getSpec()
-        ? {
-            spec: getSpec(),
-        }
-        : {
-            specUrl: getSpecUrl(),
-        };
-    document.querySelector('body')?.classList.add('light-mode');
-    // If it’s a script tag, we can’t mount the Vue.js app inside that tag.
-    // We need to add a new container div before the script tag.
-    if (specScriptTag) {
-        const container = document.createElement('div');
-        specScriptTag?.parentNode?.insertBefore(container, specScriptTag);
-        createApp(ApiReference, properties).mount(container);
-    }
-    else {
-        const container = specElement
-            ? '[data-spec]'
-            : specUrlElement
-                ? '[data-spec-url]'
-                : 'body';
-        createApp(ApiReference, properties).mount(container);
-    }
-}

package/dist/vite-plugins/index.d.ts

@@ -1,3 +0,0 @@
-export * from './nodeExternals.js';
-export * from './nodeShims.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/vite-plugins/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/vite-plugins/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,aAAa,CAAA"}

package/dist/vite-plugins/index.js

@@ -1,2 +0,0 @@
-export * from './nodeExternals.js';
-export * from './nodeShims.js';

package/dist/vite-plugins/nodeExternals.d.ts

@@ -1,8 +0,0 @@
-import { type Plugin } from 'vite';
-/**
- * Here, to simplify, we use the existing rollup-plugin-node-externals plugin. It can exclude node dependencies and
- * will automatically exclude based on the dependencies and devDependencies in package.json. However, some minor
- * compatibility modifications for Vite are needed.
- */
-export declare const nodeExternals: () => Plugin;
-//# sourceMappingURL=nodeExternals.d.ts.map

package/dist/vite-plugins/nodeExternals.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeExternals.d.ts","sourceRoot":"","sources":["../../src/vite-plugins/nodeExternals.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,MAAM,CAAA;AAElC;;;;GAIG;AACH,eAAO,MAAM,aAAa,QAAO,MAOhC,CAAA"}

package/dist/vite-plugins/nodeExternals.js

@@ -1,14 +0,0 @@
-import { nodeExternals as RollupNodeExternals } from 'rollup-plugin-node-externals';
-/**
- * Here, to simplify, we use the existing rollup-plugin-node-externals plugin. It can exclude node dependencies and
- * will automatically exclude based on the dependencies and devDependencies in package.json. However, some minor
- * compatibility modifications for Vite are needed.
- */
-export const nodeExternals = () => {
-    return {
-        ...RollupNodeExternals(),
-        name: 'node-externals',
-        enforce: 'pre',
-        apply: 'build',
-    };
-};

package/dist/vite-plugins/nodeShims.d.ts

@@ -1,6 +0,0 @@
-import { type Plugin } from 'vite';
-/**
- * Build-time polyfill for cjs features
- */
-export declare const nodeShims: () => Plugin;
-//# sourceMappingURL=nodeShims.d.ts.map

package/dist/vite-plugins/nodeShims.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeShims.d.ts","sourceRoot":"","sources":["../../src/vite-plugins/nodeShims.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,MAAM,CAAA;AAElC;;GAEG;AACH,eAAO,MAAM,SAAS,QAAO,MA8B5B,CAAA"}

package/dist/vite-plugins/nodeShims.js

@@ -1,32 +0,0 @@
-import MagicString from 'magic-string';
-/**
- * Build-time polyfill for cjs features
- */
-export const nodeShims = () => {
-    return {
-        name: 'node-shims',
-        renderChunk(code, chunk) {
-            if (!chunk.fileName.endsWith('.js')) {
-                return;
-            }
-            const s = new MagicString(code);
-            s.prepend(`
-import __path from 'path'
-import { fileURLToPath as __fileURLToPath } from 'url'
-import { createRequire as __createRequire } from 'module'
-
-const __getFilename = () => __fileURLToPath(import.meta.url)
-const __getDirname = () => __path.dirname(__getFilename())
-const __dirname = __getDirname()
-const __filename = __getFilename()
-const self = globalThis
-const require = __createRequire(import.meta.url)
-`);
-            return {
-                code: s.toString(),
-                map: s.generateMap(),
-            };
-        },
-        apply: 'build',
-    };
-};