acrylblends 0.4.1 → 0.5.0

package/plugins/acryl-router/src/core/middleware/method-not-allowed/index.ts

@@ -1,11 +1,11 @@
 /**
  * @module
- * Method Not Allowed Middleware for App.
+ * Method Not Allowed Middleware for Acryl.
  */
 
 import type { Context } from '../../context.ts'
 import { basePath, matchedRoutes } from '../../helper/route/index.ts'
-import type { App } from '../../app.ts'
+import type { Acryl } from '../../app.ts'
 import { METHOD_NAME_ALL } from '../../router.ts'
 import { TrieRouter } from '../../router/trie-router/index.ts'
 import type { Env, MiddlewareHandler } from '../../types.ts'
@@ -17,24 +17,24 @@ type MethodNotAllowedHandler<E extends Env> = (
 
 type MethodNotAllowedOptions<E extends Env> = {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  app: App<E, any, any>
+  app: Acryl<E, any, any>
   onMethodNotAllowed?: MethodNotAllowedHandler<E>
 }
 
 /**
- * Method Not Allowed Middleware for App.
+ * Method Not Allowed Middleware for Acryl.
  *
  * Returns a `405 Method Not Allowed` response with an `Allow` header when the request path
  * matches a registered route but the request method is not supported.
  *
  * @param {MethodNotAllowedOptions} options - The options for the middleware.
- * @param {App} options.app - The App instance used by the application.
+ * @param {Acryl} options.app - The Acryl instance used by the application.
  * @param {MethodNotAllowedHandler} [options.onMethodNotAllowed] - Generates the response, including its `Allow` header.
  * @returns {MiddlewareHandler} The middleware handler function.
  *
  * @example
  * ```ts
- * const app = new App()
+ * const app = new Acryl()
  *
  * app.use(methodNotAllowed({ app }))
  *
@@ -77,7 +77,7 @@ export const methodNotAllowed = <E extends Env = Env>(
       const methodsByPath = new Map<string, Set<string>>()
 
       for (const route of options.app.routes) {
-        // App does not distinguish middleware registered with `app.use()` from handlers
+        // Acryl does not distinguish middleware registered with `app.use()` from handlers
         // registered with `app.all()`, so `ALL` routes cannot contribute to the Allow header.
         if (route.method === METHOD_NAME_ALL || route.method === 'HEAD') {
           continue
@@ -86,7 +86,7 @@ export const methodNotAllowed = <E extends Env = Env>(
         const methods = methodsByPath.get(route.path) ?? new Set<string>()
         methods.add(route.method)
 
-        // App dispatches HEAD requests to GET routes.
+        // Acryl dispatches HEAD requests to GET routes.
         if (route.method === 'GET') {
           methods.add('HEAD')
         }

package/plugins/acryl-router/src/core/middleware/method-override/index.test.ts

@@ -1,9 +1,9 @@
-import { App } from '../../app.ts'
+import { Acryl } from '../../app.ts'
 import { methodOverride } from './index.ts'
 
 describe('Method Override Middleware', () => {
   describe('Form', () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('/posts/*', methodOverride({ app }))
     app.use('/posts-custom/*', methodOverride({ app, form: 'custom-input-name' }))
     app.on(['post', 'delete'], ['/posts', '/posts-custom'], async (c) => {
@@ -126,7 +126,7 @@ describe('Method Override Middleware', () => {
   })
 
   describe('Header', () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('/posts/*', methodOverride({ app, header: 'X-METHOD-OVERRIDE' }))
     app.on(['get', 'post', 'delete'], '/posts', async (c) => {
       return c.json({
@@ -165,7 +165,7 @@ describe('Method Override Middleware', () => {
   })
 
   describe('Query', () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('/posts/*', methodOverride({ app, query: '_method' }))
     app.on(['get', 'post', 'delete'], '/posts', async (c) => {
       return c.json({
@@ -186,7 +186,7 @@ describe('Method Override Middleware', () => {
     })
 
     it('Should override POST to DELETE when the request has a body', async () => {
-      const app = new App()
+      const app = new Acryl()
       app.use('/posts/*', methodOverride({ app, query: '_method' }))
       app.on(['post', 'delete'], '/posts', async (c) => {
         return c.json({

package/plugins/acryl-router/src/core/middleware/method-override/index.ts

@@ -1,16 +1,16 @@
 /**
  * @module
- * Method Override Middleware for App.
+ * Method Override Middleware for Acryl.
  */
 
 import type { Context, ExecutionContext } from '../../context.ts'
-import type { App } from '../../app.ts'
+import type { Acryl } from '../../app.ts'
 import type { MiddlewareHandler } from '../../types.ts'
 import { parseBody } from '../../utils/body.ts'
 
 type MethodOverrideOptions = {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  app: App<any, any, any>
+  app: Acryl<any, any, any>
 } & (
   | {
       // Default is 'form' and the value is `_method`
@@ -33,11 +33,11 @@ type MethodOverrideOptions = {
 const DEFAULT_METHOD_FORM_NAME = '_method'
 
 /**
- * Method Override Middleware for App.
+ * Method Override Middleware for Acryl.
  *
  *
  * @param {MethodOverrideOptions} options - The options for the method override middleware.
- * @param {App} options.app - The instance of App is used in your application.
+ * @param {Acryl} options.app - The instance of Acryl is used in your application.
  * @param {string} [options.form=_method] - Form key with a value containing the method name.
  * @param {string} [options.header] - Header name with a value containing the method name.
  * @param {string} [options.query] - Query parameter key with a value containing the method name.
@@ -45,7 +45,7 @@ const DEFAULT_METHOD_FORM_NAME = '_method'
  *
  * @example
  * ```ts
- * const app = new App()
+ * const app = new Acryl()
  *
  * // If no options are specified, the value of `_method` in the form,
  * // e.g. DELETE, is used as the method.

package/plugins/acryl-router/src/core/middleware/powered-by/index.test.ts

@@ -1,8 +1,8 @@
 import { poweredBy } from './index.ts'
-import { App } from '../../app.ts'
+import { Acryl } from '../../app.ts'
 
 describe('Powered by Middleware', () => {
-  const app = new App()
+  const app = new Acryl()
 
   app.use('/poweredBy/*', poweredBy())
   app.get('/poweredBy', (c) => c.text('root'))
@@ -18,14 +18,14 @@ describe('Powered by Middleware', () => {
     const res = await app.request('http://localhost/poweredBy')
     expect(res).not.toBeNull()
     expect(res.status).toBe(200)
-    expect(res.headers.get('X-Powered-By')).toBe('ACRYL')
+    expect(res.headers.get('X-Powered-By')).toBe('Acryl')
   })
 
   it('Should not return duplicate values', async () => {
     const res = await app.request('http://localhost/poweredBy2')
     expect(res).not.toBeNull()
     expect(res.status).toBe(200)
-    expect(res.headers.get('X-Powered-By')).toBe('ACRYL')
+    expect(res.headers.get('X-Powered-By')).toBe('Acryl')
   })
 
   it('Should return custom serverName', async () => {

package/plugins/acryl-router/src/core/middleware/powered-by/index.ts

@@ -1,28 +1,28 @@
 /**
  * @module
- * Powered By Middleware for App.
+ * Powered By Middleware for Acryl.
  */
 import type { MiddlewareHandler } from '../../types.ts'
 
 type PoweredByOptions = {
   /**
    * The value for X-Powered-By header.
-   * @default App
+   * @default Acryl
    */
   serverName?: string
 }
 
 /**
- * Powered By Middleware for App.
+ * Powered By Middleware for Acryl.
  *
  * @param options - The options for the Powered By Middleware.
  * @returns {MiddlewareHandler} The middleware handler function.
  *
  * @example
  * ```ts
- * import { poweredBy } from 'acryl-router/middleware'
+ * import { poweredBy } from 'acrylblends/powered-by'
  *
- * const app = new App()
+ * const app = new Acryl()
  *
  * app.use(poweredBy()) // With options: poweredBy({ serverName: "My Server" })
  * ```
@@ -30,6 +30,6 @@ type PoweredByOptions = {
 export const poweredBy = (options?: PoweredByOptions): MiddlewareHandler => {
   return async function poweredBy(c, next) {
     await next()
-    c.res.headers.set('X-Powered-By', options?.serverName ?? 'ACRYL')
+    c.res.headers.set('X-Powered-By', options?.serverName ?? 'Acryl')
   }
 }

package/plugins/acryl-router/src/core/middleware/pretty-json/index.test.ts

@@ -1,41 +1,41 @@
 import { prettyJSON } from './index.ts'
-import { App } from '../../app.ts'
+import { Acryl } from '../../app.ts'
 
 describe('JSON pretty by Middleware', () => {
   it('Should return pretty JSON output', async () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('*', prettyJSON())
     app.get('/', (c) => {
-      return c.json({ message: 'App!' })
+      return c.json({ message: 'Acryl!' })
     })
 
     const res = await app.request('http://localhost/?pretty')
     expect(res).not.toBeNull()
     expect(res.status).toBe(200)
     expect(await res.text()).toBe(`{
-  "message": "App!"
+  "message": "Acryl!"
 }`)
   })
 
   it('Should return pretty JSON output with 4 spaces', async () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('*', prettyJSON({ space: 4 }))
     app.get('/', (c) => {
-      return c.json({ message: 'App!' })
+      return c.json({ message: 'Acryl!' })
     })
 
     const res = await app.request('http://localhost/?pretty')
     expect(res).not.toBeNull()
     expect(res.status).toBe(200)
     expect(await res.text()).toBe(`{
-    "message": "App!"
+    "message": "Acryl!"
 }`)
   })
 
   it('Should return pretty JSON output when middleware received custom query', async () => {
     const targetQuery = 'format'
 
-    const app = new App()
+    const app = new Acryl()
     app.use(
       '*',
       prettyJSON({
@@ -44,38 +44,38 @@ describe('JSON pretty by Middleware', () => {
     )
     app.get('/', (c) =>
       c.json({
-        message: 'App!',
+        message: 'Acryl!',
       })
     )
 
     const prettyText = await (await app.request(`?${targetQuery}`)).text()
     expect(prettyText).toBe(`{
-  "message": "App!"
+  "message": "Acryl!"
 }`)
     const nonPrettyText = await (await app.request('?pretty')).text()
-    expect(nonPrettyText).toBe('{"message":"App!"}')
+    expect(nonPrettyText).toBe('{"message":"Acryl!"}')
   })
 
   it('Should force pretty JSON output when force option is true', async () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('*', prettyJSON({ force: true }))
     app.get('/', (c) => {
-      return c.json({ message: 'App!' })
+      return c.json({ message: 'Acryl!' })
     })
 
     const resWithoutQuery = await (await app.request('http://localhost/')).text()
     expect(resWithoutQuery).toBe(`{
-  "message": "App!"
+  "message": "Acryl!"
 }`)
 
     const resWithQuery = await (await app.request('http://localhost/?pretty')).text()
     expect(resWithQuery).toBe(`{
-  "message": "App!"
+  "message": "Acryl!"
 }`)
   })
 
   it('Should return pretty JSON output for structured JSON content-types (+json)', async () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('*', prettyJSON({ force: true }))
     app.get('/problem', (c) => {
       return c.newResponse(JSON.stringify({ type: 'about:blank', title: 'Bad Request' }), 400, {
@@ -104,24 +104,24 @@ describe('JSON pretty by Middleware', () => {
   })
 
   it('Should not touch responses with non-JSON content-types', async () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('*', prettyJSON({ force: true }))
-    app.get('/text', (c) => c.text('{"message":"App!"}'))
+    app.get('/text', (c) => c.text('{"message":"Acryl!"}'))
     app.get('/json-seq', (c) => {
-      return c.body('{"message":"App!"}', 200, {
+      return c.body('{"message":"Acryl!"}', 200, {
         'Content-Type': 'application/json-seq',
       })
     })
 
     const textRes = await app.request('http://localhost/text')
-    expect(await textRes.text()).toBe('{"message":"App!"}')
+    expect(await textRes.text()).toBe('{"message":"Acryl!"}')
 
     const jsonSeqRes = await app.request('http://localhost/json-seq')
-    expect(await jsonSeqRes.text()).toBe('{"message":"App!"}')
+    expect(await jsonSeqRes.text()).toBe('{"message":"Acryl!"}')
   })
 
   it('Should not break 204 responses with a JSON content-type', async () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('*', prettyJSON({ force: true }))
     app.delete('/x', (c) => {
       c.header('Content-Type', 'application/json')
@@ -134,7 +134,7 @@ describe('JSON pretty by Middleware', () => {
   })
 
   it('Should not break 304 responses with a JSON content-type', async () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('*', prettyJSON({ force: true }))
     app.get('/x', (c) => {
       c.header('Content-Type', 'application/json')
@@ -147,7 +147,7 @@ describe('JSON pretty by Middleware', () => {
   })
 
   it('Should not break empty responses with a JSON content-type', async () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('*', prettyJSON())
     app.get('/x', () => new Response('', { headers: { 'Content-Type': 'application/json' } }))
 
@@ -157,7 +157,7 @@ describe('JSON pretty by Middleware', () => {
   })
 
   it('Should pass through a response with an invalid JSON body unchanged', async () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('*', prettyJSON({ force: true }))
     app.get(
       '/x',
@@ -182,13 +182,13 @@ describe('JSON pretty by Middleware', () => {
   })
 
   it('Should pass through a response whose body was already consumed by another middleware', async () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('*', prettyJSON({ force: true }))
     app.use('*', async (c, next) => {
       await next()
       await c.res.text()
     })
-    app.get('/x', (c) => c.json({ message: 'App!' }))
+    app.get('/x', (c) => c.json({ message: 'Acryl!' }))
 
     // The other middleware has read the body, so the bytes are no longer available;
     // pretty JSON must not turn this into a 500 and must leave the response as is.
@@ -199,19 +199,19 @@ describe('JSON pretty by Middleware', () => {
   })
 
   it('Should remove a stale Content-Length when the body is prettified', async () => {
-    const app = new App()
+    const app = new Acryl()
     app.use('*', prettyJSON({ force: true }))
     app.get(
       '/x',
       () =>
-        new Response('{"message":"App!"}', {
+        new Response('{"message":"Acryl!"}', {
           headers: { 'Content-Type': 'application/json', 'Content-Length': '19' },
         })
     )
 
     const res = await app.request('http://localhost/x')
     expect(await res.text()).toBe(`{
-  "message": "App!"
+  "message": "Acryl!"
 }`)
     expect(res.headers.get('Content-Length')).toBeNull()
   })

package/plugins/acryl-router/src/core/middleware/pretty-json/index.ts

@@ -1,6 +1,6 @@
 /**
  * @module
- * Pretty JSON Middleware for App.
+ * Pretty JSON Middleware for Acryl.
  */
 
 import type { MiddlewareHandler } from '../../types.ts'
@@ -28,7 +28,7 @@ interface PrettyOptions {
 const jsonContentTypeRegex = /^application\/(?:[a-z0-9._-]+\+)?json(?=$|[;\s])/i
 
 /**
- * Pretty JSON Middleware for App.
+ * Pretty JSON Middleware for Acryl.
  *
  *
  * @param options - The options for the pretty JSON middleware.
@@ -36,11 +36,11 @@ const jsonContentTypeRegex = /^application\/(?:[a-z0-9._-]+\+)?json(?=$|[;\s])/i
  *
  * @example
  * ```ts
- * const app = new App()
+ * const app = new Acryl()
  *
  * app.use(prettyJSON()) // With options: prettyJSON({ space: 4 })
  * app.get('/', (c) => {
- *   return c.json({ message: 'App!' })
+ *   return c.json({ message: 'Acryl!' })
  * })
  * ```
  */

package/plugins/acryl-router/src/core/middleware/request-id/index.test.ts

@@ -1,11 +1,11 @@
 import { requestId } from './index.ts'
 import type { Context } from '../../context.ts'
-import { App } from '../../app.ts'
+import { Acryl } from '../../app.ts'
 
 const regexUUIDv4 = /([0-9a-f]{8})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{12})/
 
 describe('Request ID Middleware', () => {
-  const app = new App()
+  const app = new Acryl()
   app.use('*', requestId())
   app.get('/requestId', (c) => c.text(c.get('requestId') ?? 'No Request ID'))
 
@@ -57,17 +57,17 @@ describe('Request ID Middleware', () => {
 
 describe('Request ID Middleware with custom generator', () => {
   function generateWord() {
-    return 'AppIsWebFramework'
+    return 'AcrylIsWebFramework'
   }
   function generateDoubleRequestId(c: Context) {
-    const appId = c.req.header('App-Request-Id')
+    const acrylId = c.req.header('Acryl-Request-Id')
     const ohnoId = c.req.header('Ohno-Request-Id')
-    if (appId && ohnoId) {
-      return appId + ohnoId
+    if (acrylId && ohnoId) {
+      return acrylId + ohnoId
     }
     return crypto.randomUUID()
   }
-  const app = new App()
+  const app = new Acryl()
   app.use('/word', requestId({ generator: generateWord }))
   app.use('/doubleRequestId', requestId({ generator: generateDoubleRequestId }))
   app.get('/word', (c) => c.text(c.get('requestId') ?? 'No Request ID'))
@@ -76,14 +76,14 @@ describe('Request ID Middleware with custom generator', () => {
     const res = await app.request('http://localhost/word')
     expect(res).not.toBeNull()
     expect(res.status).toBe(200)
-    expect(res.headers.get('X-Request-Id')).toBe('AppIsWebFramework')
-    expect(await res.text()).toBe('AppIsWebFramework')
+    expect(res.headers.get('X-Request-Id')).toBe('AcrylIsWebFramework')
+    expect(await res.text()).toBe('AcrylIsWebFramework')
   })
 
   it('Should return complex request id', async () => {
     const res = await app.request('http://localhost/doubleRequestId', {
       headers: {
-        'App-Request-Id': 'Hello',
+        'Acryl-Request-Id': 'Hello',
         'Ohno-Request-Id': 'World',
       },
     })
@@ -98,7 +98,7 @@ describe('Request ID Middleware with limit length', () => {
   const charactersOf255 = 'h'.repeat(255)
   const charactersOf256 = 'h'.repeat(256)
 
-  const app = new App()
+  const app = new Acryl()
   app.use('/requestId', requestId())
   app.use('/limit256', requestId({ limitLength: 256 }))
   app.get('/requestId', (c) => c.text(c.get('requestId') ?? 'No Request ID'))
@@ -140,8 +140,8 @@ describe('Request ID Middleware with limit length', () => {
 })
 
 describe('Request ID Middleware with custom header', () => {
-  const app = new App()
-  app.use('/requestId', requestId({ headerName: 'App-Request-Id' }))
+  const app = new Acryl()
+  app.use('/requestId', requestId({ headerName: 'Acryl-Request-Id' }))
   app.get('/emptyId', requestId({ headerName: '' }))
   app.get('/requestId', (c) => c.text(c.get('requestId') ?? 'No Request ID'))
   app.get('/emptyId', (c) => c.text(c.get('requestId') ?? 'No Request ID'))
@@ -149,12 +149,12 @@ describe('Request ID Middleware with custom header', () => {
   it('Should return custom request id', async () => {
     const res = await app.request('http://localhost/requestId', {
       headers: {
-        'App-Request-Id': 'acryl-is-hot',
+        'Acryl-Request-Id': 'acryl-is-hot',
       },
     })
     expect(res).not.toBeNull()
     expect(res.status).toBe(200)
-    expect(res.headers.get('App-Request-Id')).toBe('acryl-is-hot')
+    expect(res.headers.get('Acryl-Request-Id')).toBe('acryl-is-hot')
     expect(await res.text()).toBe('acryl-is-hot')
   })
 

package/plugins/acryl-router/src/core/middleware/request-id/request-id.ts

@@ -1,6 +1,6 @@
 /**
  * @module
- * Request ID Middleware for App.
+ * Request ID Middleware for Acryl.
  */
 
 import type { Context } from '../../context.ts'
@@ -17,7 +17,7 @@ export type RequestIdOptions = {
 }
 
 /**
- * Request ID Middleware for App.
+ * Request ID Middleware for Acryl.
  *
  * @param {object} options - Options for Request ID middleware.
  * @param {number} [options.limitLength=255] - The maximum length of request id.
@@ -29,7 +29,7 @@ export type RequestIdOptions = {
  * @example
  * ```ts
  * type Variables = RequestIdVariables
- * const app = new App<{Variables: Variables}>()
+ * const app = new Acryl<{Variables: Variables}>()
  *
  * app.use(requestId())
  * app.get('/', (c) => {