@scalar/hono-api-reference 0.7.5 → 0.8.1

package/README.md

@@ -17,48 +17,34 @@ npm install @scalar/hono-api-reference
 
 ## Usage
 
-Set up [Zod OpenAPI Hono](https://github.com/honojs/middleware/tree/main/packages/zod-openapi) and pass the configured URL to the `apiReference` middleware:
+Set up [Zod OpenAPI Hono](https://github.com/honojs/middleware/tree/main/packages/zod-openapi) and pass the configured URL to the `Scalar` middleware:
 
 ```ts
-import { apiReference } from '@scalar/hono-api-reference'
-
-app.get(
-  '/reference',
-  apiReference({
-    url: '/doc',
-  }),
-)
-```
-
-The Hono middleware takes our universal configuration object, [read more about configuration](https://github.com/scalar/scalar/blob/main/documentation/configuration.md) in the core package README.
+import { Hono } from 'hono'
+import { Scalar } from '@scalar/hono-api-reference'
 
-### CORS middleware
+const app = new Hono()
 
-We recommend to allow requests from other domains to your API definition. That makes it easier to use your API with [our free web client](https://client.scalar.com/) for example.
-
-You just need to add the official Hono CORS middleware to the route of your OpenAPI document:
-
-```ts
-import { cors } from 'hono/cors'
+// Use the middleware to serve the Scalar API Reference at /scalar
+app.get('/scalar', Scalar({ url: '/doc' }))
 
-// Recommended: Allows cross-origin requests (from other domains) to your OpenAPI document
-app.use('/doc', cors())
+export default app
 ```
 
+The Hono middleware takes our universal configuration object, [read more about configuration](https://github.com/scalar/scalar/blob/main/documentation/configuration.md) in the core package README.
+
 ### Themes
 
 The middleware comes with a custom theme for Hono. 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/hono-api-reference'
-
-app.get(
-  '/reference',
-  apiReference({
-    theme: 'purple',
-    url: '/doc',
-  }),
-)
+import { Scalar } from '@scalar/hono-api-reference'
+
+// Switch the theme (or pass other options)
+app.get('/scalar', Scalar({
+  url: '/doc',
+  theme: 'purple',
+}))
 ```
 
 ### Custom page title
@@ -66,15 +52,13 @@ app.get(
 There’s one additional option to set the page title:
 
 ```ts
-import { apiReference } from '@scalar/hono-api-reference'
-
-app.get(
-  '/reference',
-  apiReference({
-    pageTitle: 'Hono API Reference',
-    url: '/doc',
-  }),
-)
+import { Scalar } from '@scalar/hono-api-reference'
+
+// Set a page title
+app.get('/scalar', Scalar({
+  url: '/doc',
+  pageTitle: 'Awesome API',
+}))
 ```
 
 ### Custom CDN
@@ -86,15 +70,14 @@ You can also pin the CDN to a specific version by specifying it in the CDN strin
 You can find all available CDN versions [here](https://www.jsdelivr.com/package/npm/@scalar/api-reference?tab=files)
 
 ```ts
-import { apiReference } from '@scalar/hono-api-reference'
-
-app.use(
-  '/reference',
-  apiReference({
-    cdn: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@latest',
-    url: '/doc',
-  }),
-)
+import { Scalar } from '@scalar/hono-api-reference'
+
+app.get('/scalar', Scalar({ url: '/doc', pageTitle: 'Awesome API' }))
+
+app.get('/scalar', Scalar({
+  url: '/doc',
+  cdn: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@latest',
+}))
 ```
 
 ## Community

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { apiReference } from './honoApiReference.ts';
+export { apiReference, Scalar } from './scalar.ts';
 export type { ApiReferenceConfiguration } from './types.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,YAAY,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAClD,YAAY,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAA"}

package/dist/index.js

@@ -1 +1 @@
-export { apiReference } from './honoApiReference.js';
+export { Scalar, apiReference } from './scalar.js';

package/dist/{honoApiReference.d.ts → scalar.d.ts}

@@ -7,5 +7,9 @@ export declare const customTheme = "\n.light-mode {\n  color-scheme: light;\n  -
 /**
  * The Hono middleware for the Scalar API Reference.
  */
+export declare const Scalar: <E extends Env>(givenConfiguration: Partial<ApiReferenceConfiguration>) => MiddlewareHandler<E>;
+/**
+ * @deprecated Use `Scalar` instead.
+ */
 export declare const apiReference: <E extends Env>(givenConfiguration: Partial<ApiReferenceConfiguration>) => MiddlewareHandler<E>;
-//# sourceMappingURL=honoApiReference.d.ts.map
+//# sourceMappingURL=scalar.d.ts.map

package/dist/scalar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scalar.d.ts","sourceRoot":"","sources":["../src/scalar.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAA;AAElD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAA;AAS3D;;GAEG;AACH,eAAO,MAAM,WAAW,mtHAoGvB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,GAAG,sBAAsB,OAAO,CAAC,yBAAyB,CAAC,KAAG,iBAAiB,CAAC,CAAC,CASjH,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,GAdF,CAAC,SAAS,GAAG,sBAAsB,OAAO,CAAC,yBAAyB,CAAC,KAAG,iBAAiB,CAAC,CAAC,CAchF,CAAA"}

package/dist/{honoApiReference.js → scalar.js}

@@ -113,7 +113,7 @@ const customTheme = `
 /**
  * The Hono middleware for the Scalar API Reference.
  */
-const apiReference = (givenConfiguration) => {
+const Scalar = (givenConfiguration) => {
     // Merge the defaults
     const configuration = {
         ...DEFAULT_CONFIGURATION,
@@ -122,5 +122,9 @@ const apiReference = (givenConfiguration) => {
     // Respond with the HTML document
     return async (c) => c.html(/* html */ `${getHtmlDocument(configuration, customTheme)}`);
 };
+/**
+ * @deprecated Use `Scalar` instead.
+ */
+const apiReference = Scalar;
 
-export { apiReference, customTheme };
+export { Scalar, apiReference, customTheme };

package/dist/scalar.test.d.ts

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

package/dist/scalar.test.d.ts.map

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

package/package.json

@@ -10,7 +10,7 @@
     "url": "git+https://github.com/scalar/scalar.git",
     "directory": "integrations/hono"
   },
-  "version": "0.7.5",
+  "version": "0.8.1",
   "engines": {
     "node": ">=18"
   },
@@ -29,7 +29,7 @@
   ],
   "module": "dist/index.js",
   "dependencies": {
-    "@scalar/core": "0.2.5"
+    "@scalar/core": "0.2.7"
   },
   "devDependencies": {
     "@hono/node-server": "^1.11.0",

package/dist/honoApiReference.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"honoApiReference.d.ts","sourceRoot":"","sources":["../src/honoApiReference.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAA;AAElD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAA;AAS3D;;GAEG;AACH,eAAO,MAAM,WAAW,mtHAoGvB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,GAAG,sBACpB,OAAO,CAAC,yBAAyB,CAAC,KACrD,iBAAiB,CAAC,CAAC,CASrB,CAAA"}

package/dist/honoApiReference.test.d.ts

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

package/dist/honoApiReference.test.d.ts.map

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