npm - @elysiajs/openapi - Versions diffs - 1.4.10 → 1.4.11 - Mend

@elysiajs/openapi 1.4.10 → 1.4.11

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 (11) hide show

package/README.md CHANGED Viewed

@@ -83,7 +83,7 @@ The endpoint to expose OpenAPI documentation frontend
 OpenAPI documentation frontend between:
 - [Scalar](https://github.com/scalar/scalar)
-- [SwaggerUI](https://github.com/openapi-api/openapi-ui)
+- [SwaggerUI](https://github.com/swagger-api/swagger-ui)
 - null: disable frontend
 ## references

package/dist/cjs/index.d.ts CHANGED Viewed

@@ -5,7 +5,7 @@ import type { ElysiaOpenAPIConfig } from './types';
  *
  * @see https://github.com/elysiajs/elysia-swagger
  */
-export declare const openapi: <const Enabled extends boolean = true, const Path extends string = "/openapi">({ enabled, path, provider, specPath, documentation, exclude, swagger, scalar, references, mapJsonSchema }?: ElysiaOpenAPIConfig<Enabled, Path>) => Elysia<"", {
+export declare const openapi: <const Enabled extends boolean = true, const Path extends string = "/openapi">({ enabled, path, provider, specPath, documentation, exclude, swagger, scalar, references, mapJsonSchema, embedSpec }?: ElysiaOpenAPIConfig<Enabled, Path>) => Elysia<"", {
     decorator: {};
     store: {};
     derive: {};

package/dist/cjs/index.js CHANGED Viewed

@@ -250,7 +250,7 @@ var elysiaCSS = `.light-mode {
   background-image: var(--stripes), var(--rainbow);
   filter: opacity(4%) saturate(200%);
 }`;
-var ScalarRender = (info, config2) => `<!doctype html>
+var ScalarRender = (info, config2, embedSpec) => `<!doctype html>
 <html>
   <head>
     <title>${info.title}</title>
@@ -278,7 +278,14 @@ var ScalarRender = (info, config2) => `<!doctype html>
   <body>
     <script
       id="api-reference"
-      data-url="${config2.url}"
+      data-configuration='${JSON.stringify(
+  Object.assign(
+    config2,
+    {
+      content: embedSpec
+    }
+  )
+)}'
     >
     </script>
     <script src="${config2.cdn}" crossorigin></script>
@@ -9273,7 +9280,8 @@ var openapi = ({
   swagger,
   scalar,
   references,
-  mapJsonSchema
+  mapJsonSchema,
+  embedSpec
 } = {}) => {
   if (!enabled) return new import_elysia2.Elysia({ name: "@elysiajs/openapi" });
   const info = {
@@ -9285,6 +9293,35 @@ var openapi = ({
   const relativePath = specPath.startsWith("/") ? specPath.slice(1) : specPath;
   let totalRoutes = 0;
   let cachedSchema;
+  const toFullSchema = ({
+    paths,
+    components: { schemas }
+  }) => {
+    return cachedSchema = {
+      openapi: "3.0.3",
+      ...documentation,
+      tags: !exclude?.tags ? documentation.tags : documentation.tags?.filter(
+        (tag) => !exclude.tags?.includes(tag.name)
+      ),
+      info: {
+        title: "Elysia Documentation",
+        description: "Development documentation",
+        version: "0.0.0",
+        ...documentation.info
+      },
+      paths: {
+        ...paths,
+        ...documentation.paths
+      },
+      components: {
+        ...documentation.components,
+        schemas: {
+          ...schemas,
+          ...documentation.components?.schemas
+        }
+      }
+    };
+  };
   const app = new import_elysia2.Elysia({ name: "@elysiajs/openapi" }).use((app2) => {
     if (provider === null) return app2;
     const page = () => new Response(
@@ -9294,57 +9331,50 @@ var openapi = ({
         version: "latest",
         autoDarkMode: true,
         ...swagger
-      }) : ScalarRender(info, {
-        url: relativePath,
-        version: "latest",
-        cdn: `https://cdn.jsdelivr.net/npm/@scalar/api-reference@${scalar?.version ?? "latest"}/dist/browser/standalone.min.js`,
-        ...scalar,
-        _integration: "elysiajs"
-      }),
+      }) : ScalarRender(
+        info,
+        {
+          url: relativePath,
+          version: "latest",
+          cdn: `https://cdn.jsdelivr.net/npm/@scalar/api-reference@${scalar?.version ?? "latest"}/dist/browser/standalone.min.js`,
+          ...scalar,
+          _integration: "elysiajs"
+        },
+        embedSpec ? JSON.stringify(
+          totalRoutes === app2.routes.length ? cachedSchema : toFullSchema(
+            toOpenAPISchema(
+              app2,
+              exclude,
+              references,
+              mapJsonSchema
+            )
+          )
+        ) : void 0
+      ),
       {
         headers: {
           "content-type": "text/html; charset=utf8"
         }
       }
     );
-    return app2.get(path, isCloudflareWorker() ? page : page(), {
-      detail: {
-        hide: true
+    return app2.get(
+      path,
+      embedSpec || isCloudflareWorker() ? page : page(),
+      {
+        detail: {
+          hide: true
+        }
       }
-    });
+    );
   }).get(
     specPath,
     function openAPISchema() {
-      if (totalRoutes === app.routes.length) return cachedSchema;
+      if (totalRoutes === app.routes.length && cachedSchema)
+        return cachedSchema;
       totalRoutes = app.routes.length;
-      const {
-        paths,
-        components: { schemas }
-      } = toOpenAPISchema(app, exclude, references, mapJsonSchema);
-      return cachedSchema = {
-        openapi: "3.0.3",
-        ...documentation,
-        tags: !exclude?.tags ? documentation.tags : documentation.tags?.filter(
-          (tag) => !exclude.tags?.includes(tag.name)
-        ),
-        info: {
-          title: "Elysia Documentation",
-          description: "Development documentation",
-          version: "0.0.0",
-          ...documentation.info
-        },
-        paths: {
-          ...paths,
-          ...documentation.paths
-        },
-        components: {
-          ...documentation.components,
-          schemas: {
-            ...schemas,
-            ...documentation.components?.schemas
-          }
-        }
-      };
+      return toFullSchema(
+        toOpenAPISchema(app, exclude, references, mapJsonSchema)
+      );
     },
     {
       error({ error }) {

package/dist/cjs/scalar/index.js CHANGED Viewed

@@ -143,7 +143,7 @@ var elysiaCSS = `.light-mode {
   background-image: var(--stripes), var(--rainbow);
   filter: opacity(4%) saturate(200%);
 }`;
-var ScalarRender = (info, config) => `<!doctype html>
+var ScalarRender = (info, config, embedSpec) => `<!doctype html>
 <html>
   <head>
     <title>${info.title}</title>
@@ -171,7 +171,14 @@ var ScalarRender = (info, config) => `<!doctype html>
   <body>
     <script
       id="api-reference"
-      data-url="${config.url}"
+      data-configuration='${JSON.stringify(
+  Object.assign(
+    config,
+    {
+      content: embedSpec
+    }
+  )
+)}'
     >
     </script>
     <script src="${config.cdn}" crossorigin></script>

package/dist/cjs/types.d.ts CHANGED Viewed

@@ -74,6 +74,14 @@ export interface ElysiaOpenAPIConfig<Enabled extends boolean = true, Path extend
      * Additional reference for each endpoint
      */
     references?: AdditionalReferences;
+    /**
+     * Embed OpenAPI schema to provider body if possible
+     *
+     * This is highly discouraged, unless you really have to inline OpenAPI schema
+     *
+     * @default false
+     */
+    embedSpec?: boolean;
     /**
      * Mapping function from Standard schema to OpenAPI schema
      *

package/dist/index.d.ts CHANGED Viewed

@@ -5,7 +5,7 @@ import type { ElysiaOpenAPIConfig } from './types';
  *
  * @see https://github.com/elysiajs/elysia-swagger
  */
-export declare const openapi: <const Enabled extends boolean = true, const Path extends string = "/openapi">({ enabled, path, provider, specPath, documentation, exclude, swagger, scalar, references, mapJsonSchema }?: ElysiaOpenAPIConfig<Enabled, Path>) => Elysia<"", {
+export declare const openapi: <const Enabled extends boolean = true, const Path extends string = "/openapi">({ enabled, path, provider, specPath, documentation, exclude, swagger, scalar, references, mapJsonSchema, embedSpec }?: ElysiaOpenAPIConfig<Enabled, Path>) => Elysia<"", {
     decorator: {};
     store: {};
     derive: {};

package/dist/index.mjs CHANGED Viewed

@@ -228,7 +228,7 @@ var elysiaCSS = `.light-mode {
   background-image: var(--stripes), var(--rainbow);
   filter: opacity(4%) saturate(200%);
 }`;
-var ScalarRender = (info, config2) => `<!doctype html>
+var ScalarRender = (info, config2, embedSpec) => `<!doctype html>
 <html>
   <head>
     <title>${info.title}</title>
@@ -256,7 +256,14 @@ var ScalarRender = (info, config2) => `<!doctype html>
   <body>
     <script
       id="api-reference"
-      data-url="${config2.url}"
+      data-configuration='${JSON.stringify(
+  Object.assign(
+    config2,
+    {
+      content: embedSpec
+    }
+  )
+)}'
     >
     </script>
     <script src="${config2.cdn}" crossorigin></script>
@@ -9251,7 +9258,8 @@ var openapi = ({
   swagger,
   scalar,
   references,
-  mapJsonSchema
+  mapJsonSchema,
+  embedSpec
 } = {}) => {
   if (!enabled) return new Elysia({ name: "@elysiajs/openapi" });
   const info = {
@@ -9263,6 +9271,35 @@ var openapi = ({
   const relativePath = specPath.startsWith("/") ? specPath.slice(1) : specPath;
   let totalRoutes = 0;
   let cachedSchema;
+  const toFullSchema = ({
+    paths,
+    components: { schemas }
+  }) => {
+    return cachedSchema = {
+      openapi: "3.0.3",
+      ...documentation,
+      tags: !exclude?.tags ? documentation.tags : documentation.tags?.filter(
+        (tag) => !exclude.tags?.includes(tag.name)
+      ),
+      info: {
+        title: "Elysia Documentation",
+        description: "Development documentation",
+        version: "0.0.0",
+        ...documentation.info
+      },
+      paths: {
+        ...paths,
+        ...documentation.paths
+      },
+      components: {
+        ...documentation.components,
+        schemas: {
+          ...schemas,
+          ...documentation.components?.schemas
+        }
+      }
+    };
+  };
   const app = new Elysia({ name: "@elysiajs/openapi" }).use((app2) => {
     if (provider === null) return app2;
     const page = () => new Response(
@@ -9272,57 +9309,50 @@ var openapi = ({
         version: "latest",
         autoDarkMode: true,
         ...swagger
-      }) : ScalarRender(info, {
-        url: relativePath,
-        version: "latest",
-        cdn: `https://cdn.jsdelivr.net/npm/@scalar/api-reference@${scalar?.version ?? "latest"}/dist/browser/standalone.min.js`,
-        ...scalar,
-        _integration: "elysiajs"
-      }),
+      }) : ScalarRender(
+        info,
+        {
+          url: relativePath,
+          version: "latest",
+          cdn: `https://cdn.jsdelivr.net/npm/@scalar/api-reference@${scalar?.version ?? "latest"}/dist/browser/standalone.min.js`,
+          ...scalar,
+          _integration: "elysiajs"
+        },
+        embedSpec ? JSON.stringify(
+          totalRoutes === app2.routes.length ? cachedSchema : toFullSchema(
+            toOpenAPISchema(
+              app2,
+              exclude,
+              references,
+              mapJsonSchema
+            )
+          )
+        ) : void 0
+      ),
       {
         headers: {
           "content-type": "text/html; charset=utf8"
         }
       }
     );
-    return app2.get(path, isCloudflareWorker() ? page : page(), {
-      detail: {
-        hide: true
+    return app2.get(
+      path,
+      embedSpec || isCloudflareWorker() ? page : page(),
+      {
+        detail: {
+          hide: true
+        }
       }
-    });
+    );
   }).get(
     specPath,
     function openAPISchema() {
-      if (totalRoutes === app.routes.length) return cachedSchema;
+      if (totalRoutes === app.routes.length && cachedSchema)
+        return cachedSchema;
       totalRoutes = app.routes.length;
-      const {
-        paths,
-        components: { schemas }
-      } = toOpenAPISchema(app, exclude, references, mapJsonSchema);
-      return cachedSchema = {
-        openapi: "3.0.3",
-        ...documentation,
-        tags: !exclude?.tags ? documentation.tags : documentation.tags?.filter(
-          (tag) => !exclude.tags?.includes(tag.name)
-        ),
-        info: {
-          title: "Elysia Documentation",
-          description: "Development documentation",
-          version: "0.0.0",
-          ...documentation.info
-        },
-        paths: {
-          ...paths,
-          ...documentation.paths
-        },
-        components: {
-          ...documentation.components,
-          schemas: {
-            ...schemas,
-            ...documentation.components?.schemas
-          }
-        }
-      };
+      return toFullSchema(
+        toOpenAPISchema(app, exclude, references, mapJsonSchema)
+      );
     },
     {
       error({ error }) {

package/dist/scalar/index.d.ts CHANGED Viewed

@@ -1,3 +1,3 @@
 import type { OpenAPIV3 } from 'openapi-types';
 import { ElysiaOpenAPIConfig } from '../types';
-export declare const ScalarRender: (info: OpenAPIV3.InfoObject, config: NonNullable<ElysiaOpenAPIConfig["scalar"]>) => string;
+export declare const ScalarRender: (info: OpenAPIV3.InfoObject, config: NonNullable<ElysiaOpenAPIConfig["scalar"]>, embedSpec?: string) => string;

package/dist/scalar/index.mjs CHANGED Viewed

@@ -119,7 +119,7 @@ var elysiaCSS = `.light-mode {
   background-image: var(--stripes), var(--rainbow);
   filter: opacity(4%) saturate(200%);
 }`;
-var ScalarRender = (info, config) => `<!doctype html>
+var ScalarRender = (info, config, embedSpec) => `<!doctype html>
 <html>
   <head>
     <title>${info.title}</title>
@@ -147,7 +147,14 @@ var ScalarRender = (info, config) => `<!doctype html>
   <body>
     <script
       id="api-reference"
-      data-url="${config.url}"
+      data-configuration='${JSON.stringify(
+  Object.assign(
+    config,
+    {
+      content: embedSpec
+    }
+  )
+)}'
     >
     </script>
     <script src="${config.cdn}" crossorigin></script>

package/dist/types.d.ts CHANGED Viewed

@@ -74,6 +74,14 @@ export interface ElysiaOpenAPIConfig<Enabled extends boolean = true, Path extend
      * Additional reference for each endpoint
      */
     references?: AdditionalReferences;
+    /**
+     * Embed OpenAPI schema to provider body if possible
+     *
+     * This is highly discouraged, unless you really have to inline OpenAPI schema
+     *
+     * @default false
+     */
+    embedSpec?: boolean;
     /**
      * Mapping function from Standard schema to OpenAPI schema
      *

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@elysiajs/openapi",
-    "version": "1.4.10",
+    "version": "1.4.11",
     "description": "Plugin for Elysia to auto-generate API documentation",
     "author": {
         "name": "saltyAom",