acrylblends 0.4.1 → 0.5.0

package/plugins/acryl-node-server/tests/server.spec.ts

@@ -4,7 +4,7 @@ import { createServer } from 'node:http'
 import type { AddressInfo } from 'node:net'
 import { fileURLToPath } from 'node:url'
 import { Context } from '@deepseek-ai/cordis'
-import { App, apply as routerApply, connectionOf, name as routerName } from '../../acryl-router/src/index.ts'
+import { Acryl, apply as routerApply, connectionOf, name as routerName } from '../../acryl-router/src/index.ts'
 import { streamSSE } from '../../acryl-router/src/helpers/index.ts'
 import { afterEach, describe, expect, it } from 'vitest'
 import * as nodeServer from '../src/index.ts'
@@ -42,7 +42,7 @@ const portIsFree = async (port: number): Promise<boolean> => {
 describe('acryl-node-server', () => {
   it('serves the router over a real socket with the peer and port as connection facts', async () => {
     const ctx = await boot()
-    ctx.router.route('/', new App().get('/who', c => c.json({ peer: connectionOf(c).remoteAddress, port: connectionOf(c).localPort })))
+    ctx.router.route('/', new Acryl().get('/who', c => c.json({ peer: connectionOf(c).remoteAddress, port: connectionOf(c).localPort })))
     const body = await (await fetch(`${ctx.nodeServer.url}/who`)).json() as { peer: string, port: number }
     expect(ctx.nodeServer.url).toMatch(/^http:\/\/127\.0\.0\.1:\d+$/u)
     expect(body.port).toBe(ctx.nodeServer.port)
@@ -52,7 +52,7 @@ describe('acryl-node-server', () => {
 
   it('hands a request body to the handler', async () => {
     const ctx = await boot()
-    ctx.router.route('/', new App().post('/echo', async c => c.json(await c.req.json())))
+    ctx.router.route('/', new Acryl().post('/echo', async c => c.json(await c.req.json())))
     const response = await fetch(`${ctx.nodeServer.url}/echo`, { method: 'POST', headers: { 'content-type': 'application/json' }, body: '{"n":1}' })
     expect(await response.json()).toEqual({ n: 1 })
   })
@@ -60,7 +60,7 @@ describe('acryl-node-server', () => {
   it('serves files from disk through a mounted app', async () => {
     const ctx = await boot()
     const root = fileURLToPath(new URL('./adapter/assets', import.meta.url))
-    ctx.router.route('/', new App().use('/static/*', nodeServer.serveStatic({ root })))
+    ctx.router.route('/', new Acryl().use('/static/*', nodeServer.serveStatic({ root })))
     const found = await fetch(`${ctx.nodeServer.url}/static/plain.txt`)
     expect(found.status).toBe(200)
     expect(found.headers.get('content-type')).toBe('text/plain; charset=utf-8')
@@ -72,7 +72,7 @@ describe('acryl-node-server', () => {
     const ctx = await boot()
     let aborted!: () => void
     const seen = new Promise<void>(resolve => { aborted = resolve })
-    ctx.router.route('/', new App().get('/wait', c => new Promise<Response>(resolve => {
+    ctx.router.route('/', new Acryl().get('/wait', c => new Promise<Response>(resolve => {
       c.req.raw.signal.addEventListener('abort', () => { aborted(); resolve(new Response(null, { status: 499 })) }, { once: true })
     })))
     const client = new AbortController()
@@ -110,7 +110,7 @@ describe('acryl-node-server', () => {
 
   it('on dispose ends open event streams and frees the port', async () => {
     const ctx = await boot()
-    ctx.router.route('/', new App().get('/events', c => streamSSE(c, async stream => {
+    ctx.router.route('/', new Acryl().get('/events', c => streamSSE(c, async stream => {
       await stream.writeSSE({ data: 'hello' })
       await new Promise<void>(resolve => { stream.onAbort(resolve) })
     })))

package/plugins/acryl-node-server/upstream.json

@@ -2,7 +2,7 @@
   "source": {
     "repo": "acryldev/acryl",
     "path": "plugins/acryl-node-server",
-    "commit": "64e7c9d2e787f74b2da82492644fbbb46a601074"
+    "commit": "f5151e7f0c4de3b81bddb5cc686b5ef329e48e1c"
   },
   "vendored": [
     "src",
@@ -10,7 +10,7 @@
     "LICENSE"
   ],
   "rewrittenSpecifiers": 28,
-  "digest": "sha256:34c46038d5d69212247430c46ccf52c01cc6ceaf2c9c48fea39c1053de0820d2",
+  "digest": "sha256:551c97b074171e63d4dd09ae7624b2c4cd15050e4a8021603bc2e2e95ab790b3",
   "testsNotRun": {},
   "notice": [
     "LICENSE"

package/plugins/acryl-router/src/client.ts

@@ -1,2 +1,2 @@
-/** The typed client for an `App`: request it with the route types the server declared. Runs in a browser or any fetch runtime, without Cordis. */
+/** The typed client for an `Acryl`: request it with the route types the server declared. Runs in a browser or any fetch runtime, without Cordis. */
 export * from './core/client/index.ts'

package/plugins/acryl-router/src/connection.ts

@@ -20,14 +20,14 @@ export interface RouterBindings {
   readonly connection: ConnectionInfo
 }
 
-/** The `Env` of an `App` that wants `c.env.connection` typed: `new App<RouterEnv>()`. */
+/** The `Env` of an `Acryl` that wants `c.env.connection` typed: `new Acryl<RouterEnv>()`. */
 export interface RouterEnv {
   Bindings: RouterBindings
 }
 
 const NONE: ConnectionInfo = Object.freeze({})
 
-/** The transport facts of this request; empty for an in-process call or an `App` run outside the router. */
+/** The transport facts of this request; empty for an in-process call or an `Acryl` run outside the router. */
 export function connectionOf(c: Context): ConnectionInfo {
   const env = c.env as Partial<RouterBindings> | undefined
   return env?.connection ?? NONE

package/plugins/acryl-router/src/core/app-base.ts

@@ -1,6 +1,6 @@
 /**
  * @module
- * This module is the base module for the App object.
+ * This module is the base module for the Acryl object.
  */
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -43,14 +43,14 @@ const errorHandler: ErrorHandler = (err, c) => {
 
 type GetPath<E extends Env> = (request: Request, options?: { env?: E['Bindings'] }) => string
 
-export type AppOptions<E extends Env> = {
+export type AcrylOptions<E extends Env> = {
   /**
    * `router` option specifies which router to use.
    *
    *
    * @example
    * ```ts
-   * const app = new App({ router: new RegExpRouter() })
+   * const app = new Acryl({ router: new RegExpRouter() })
    * ```
    */
   router?: Router<[H, RouterRoute]>
@@ -69,7 +69,7 @@ export type AppOptions<E extends Env> = {
        *
        * @example
        * ```ts
-       * const app = new App({
+       * const app = new Acryl({
        *  getPath: (req) =>
        *   '/' + req.headers.get('host') + req.url.replace(/^https?:\/\/[^/]+(\/[^?]*)/, '$1'),
        * })
@@ -106,7 +106,7 @@ type MountOptions =
       replaceRequest?: MountReplaceRequest | false
     }
 
-class App<
+class Acryl<
   E extends Env = Env,
   S extends Schema = {},
   BasePath extends string = '/',
@@ -135,7 +135,7 @@ class App<
 
   routes: RouterRoute[] = []
 
-  constructor(options: AppOptions<E> = {}) {
+  constructor(options: AcrylOptions<E> = {}) {
     // Implementation of app.get(...handlers[]) or app.get(path, ...handlers[])
     const allMethods = [...METHODS, METHOD_NAME_ALL_LOWERCASE]
     allMethods.forEach((method) => {
@@ -186,8 +186,8 @@ class App<
     this.getPath = (strict ?? true) ? (options.getPath ?? getPath) : getPathNoStrict
   }
 
-  #clone(): App<E, S, BasePath, CurrentPath> {
-    const clone = new App<E, S, BasePath, CurrentPath>({
+  #clone(): Acryl<E, S, BasePath, CurrentPath> {
+    const clone = new Acryl<E, S, BasePath, CurrentPath>({
       router: this.router,
       getPath: this.getPath,
     })
@@ -202,17 +202,17 @@ class App<
   private errorHandler: ErrorHandler = errorHandler
 
   /**
-   * `.route()` allows grouping other App instance in routes.
+   * `.route()` allows grouping other Acryl instance in routes.
    *
    *
    * @param {string} path - base Path
-   * @param {App} app - other App instance
-   * @returns {App} routed App instance
+   * @param {Acryl} app - other Acryl instance
+   * @returns {Acryl} routed Acryl instance
    *
    * @example
    * ```ts
-   * const app = new App()
-   * const app2 = new App()
+   * const app = new Acryl()
+   * const app2 = new Acryl()
    *
    * app2.get("/user", (c) => c.text("user"))
    * app.route("/api", app2) // GET /api/user
@@ -226,8 +226,8 @@ class App<
     SubCurrentPath extends string,
   >(
     path: SubPath,
-    app: App<SubEnv, SubSchema, SubBasePath, SubCurrentPath>
-  ): App<E, MergeSchemaPath<SubSchema, MergePath<BasePath, SubPath>> | S, BasePath, CurrentPath> {
+    app: Acryl<SubEnv, SubSchema, SubBasePath, SubCurrentPath>
+  ): Acryl<E, MergeSchemaPath<SubSchema, MergePath<BasePath, SubPath>> | S, BasePath, CurrentPath> {
     const subApp = this.basePath(path)
     app.routes.map((r) => {
       let handler
@@ -249,16 +249,16 @@ class App<
    *
    *
    * @param {string} path - base Path
-   * @returns {App} changed App instance
+   * @returns {Acryl} changed Acryl instance
    *
    * @example
    * ```ts
-   * const api = new App().basePath('/api')
+   * const api = new Acryl().basePath('/api')
    * ```
    */
   basePath<SubPath extends string>(
     path: SubPath
-  ): App<E, S, MergePath<BasePath, SubPath>, MergePath<BasePath, SubPath>> {
+  ): Acryl<E, S, MergePath<BasePath, SubPath>, MergePath<BasePath, SubPath>> {
     const subApp = this.#clone()
     subApp._basePath = mergePath(this._basePath, path)
     return subApp
@@ -269,7 +269,7 @@ class App<
    *
    *
    * @param {ErrorHandler} handler - request Handler for error
-   * @returns {App} changed App instance
+   * @returns {Acryl} changed Acryl instance
    *
    * @example
    * ```ts
@@ -279,7 +279,7 @@ class App<
    * })
    * ```
    */
-  onError = (handler: ErrorHandler<E>): App<E, S, BasePath, CurrentPath> => {
+  onError = (handler: ErrorHandler<E>): Acryl<E, S, BasePath, CurrentPath> => {
     this.errorHandler = handler
     return this
   }
@@ -289,7 +289,7 @@ class App<
    *
    *
    * @param {NotFoundHandler} handler - request handler for not-found
-   * @returns {App} changed App instance
+   * @returns {Acryl} changed Acryl instance
    *
    * @example
    * ```ts
@@ -298,13 +298,13 @@ class App<
    * })
    * ```
    */
-  notFound = (handler: NotFoundHandler<E>): App<E, S, BasePath, CurrentPath> => {
+  notFound = (handler: NotFoundHandler<E>): Acryl<E, S, BasePath, CurrentPath> => {
     this.#notFoundHandler = handler
     return this
   }
 
   /**
-   * `.mount()` allows you to mount applications built with other frameworks into your App application.
+   * `.mount()` allows you to mount applications built with other frameworks into your Acryl application.
    *
    * @deprecated Use `mount()` from `acryl-router/mount` instead. `.mount()` will be removed in v5.
    *
@@ -312,24 +312,24 @@ class App<
    * @param {string} path - base Path
    * @param {Function} applicationHandler - other Request Handler
    * @param {MountOptions} [options] - options of `.mount()`
-   * @returns {App} mounted App instance
+   * @returns {Acryl} mounted Acryl instance
    *
    * @example
    * ```ts
    * import { Router as IttyRouter } from 'itty-router'
-   * import { App } from 'acryl-router'
+   * import { Acryl } from 'acrylblends'
    * // Create itty-router application
    * const ittyRouter = IttyRouter()
    * // GET /itty-router/hello
    * ittyRouter.get('/hello', () => new Response('Hello from itty-router'))
    *
-   * const app = new App()
+   * const app = new Acryl()
    * app.mount('/itty-router', ittyRouter.handle)
    * ```
    *
    * @example
    * ```ts
-   * const app = new App()
+   * const app = new Acryl()
    * // Send the request to another application without modification.
    * app.mount('/app', anotherApp, {
    *   replaceRequest: (req) => req,
@@ -340,7 +340,7 @@ class App<
     path: string,
     applicationHandler: (request: Request, ...args: any) => Response | Promise<Response>,
     options?: MountOptions
-  ): App<E, S, BasePath, CurrentPath> {
+  ): Acryl<E, S, BasePath, CurrentPath> {
     // handle options
     let replaceRequest: MountReplaceRequest | undefined
     let optionHandler: MountOptionHandler | undefined
@@ -541,4 +541,4 @@ class App<
   }
 }
 
-export { App as AppBase }
+export { Acryl as AcrylBase }