acrylblends 0.7.1 → 0.7.3

package/plugins/acryl-node-server/src/transpile.ts

@@ -0,0 +1,120 @@
+/**
+ * One TypeScript module compiled to JavaScript with the app's own `typescript`: the transform behind `acrylblends/node-server/register`
+ * (server JSX on Node) and `clientModules` (browser modules). `typescript` is loaded from the app on first use, so the framework itself has
+ * no dependencies.
+ */
+
+import { createRequire } from 'node:module'
+import { existsSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+
+/** The part of the TypeScript compiler API the framework uses. */
+interface Compiler {
+  transpileModule(input: string, options: { fileName: string, compilerOptions: Record<string, unknown> }): { outputText: string }
+  findConfigFile(searchPath: string, fileExists: (path: string) => boolean): string | undefined
+  readConfigFile(path: string, readFile: (path: string) => string | undefined): { config?: unknown }
+  parseJsonConfigFileContent(json: unknown, host: unknown, basePath: string): { options: { jsxImportSource?: string } }
+  preProcessFile(text: string, readImportFiles: boolean, detectJavaScriptImports: boolean): { importedFiles: { fileName: string, pos: number }[] }
+  sys: { fileExists(path: string): boolean, readFile(path: string): string | undefined }
+}
+
+/** Thrown when the app has no `typescript` to compile a file with. */
+export class MissingTypeScriptError extends Error {
+  constructor(file: string, what: string) {
+    super(`acrylblends: ${file} ${what}, and compiling it needs the typescript package in this app: npm install --save-dev typescript`)
+    this.name = 'MissingTypeScriptError'
+  }
+}
+
+const compilers = new Map<string, Compiler>()
+const importSources = new Map<string, string>()
+
+/**
+ * The app's own `typescript`, resolved from the file, so each app compiles with the version it pinned.
+ * @param file - the module to compile.
+ * @param what - what the file needs compiling for, for the error message.
+ * @returns the compiler.
+ * @throws MissingTypeScriptError when the app has no `typescript`.
+ */
+function compilerFor(file: string, what: string): Compiler {
+  // Only the app's own node_modules chain counts: Node's global folders (NODE_PATH, which a package manager's shims may set) are not the app.
+  let owner: string | undefined
+  for (let dir = dirname(file); owner === undefined; dir = dirname(dir)) {
+    if (existsSync(join(dir, 'node_modules', 'typescript', 'package.json'))) owner = dir
+    else if (dirname(dir) === dir) throw new MissingTypeScriptError(file, what)
+  }
+  const path = createRequire(join(owner, 'package.json')).resolve('typescript')
+  let compiler = compilers.get(path)
+  if (compiler === undefined) {
+    compiler = createRequire(path)(path) as Compiler
+    compilers.set(path, compiler)
+  }
+  return compiler
+}
+
+/** `jsxImportSource` of the tsconfig.json nearest to the file (following `extends`), read once per config. */
+function importSourceFor(file: string, ts: Compiler, fallback: string): string {
+  const config = ts.findConfigFile(dirname(file), path => existsSync(path))
+  if (config === undefined) return fallback
+  let source = importSources.get(`${config}\0${fallback}`)
+  if (source === undefined) {
+    const { config: json } = ts.readConfigFile(config, path => ts.sys.readFile(path))
+    source = ts.parseJsonConfigFileContent(json ?? {}, ts.sys, dirname(config)).options.jsxImportSource ?? fallback
+    importSources.set(`${config}\0${fallback}`, source)
+  }
+  return source
+}
+
+/** How {@link compileModule} compiles one file. */
+export interface CompileOptions {
+  /** The JSX runtime package; without it, the nearest tsconfig.json's `jsxImportSource`, then `defaultImportSource`. */
+  readonly importSource?: string | undefined
+  /** The runtime when neither `importSource` nor a tsconfig.json names one. */
+  readonly defaultImportSource: string
+  /** What the file needs compiling for, as the missing-typescript message says it. */
+  readonly what: string
+  /** Replaces an import specifier of the output (static, `export ... from` and dynamic); `undefined` keeps it. */
+  readonly rewrite?: ((specifier: string) => string | undefined) | undefined
+}
+
+/**
+ * A TypeScript or JSX module compiled to an ES module, with its source map inline (a file's own `@jsxImportSource` pragma wins over the
+ * options).
+ * @param file - absolute path of the module, which also locates the app's `typescript` and tsconfig.json.
+ * @param text - its source.
+ * @param options - the JSX runtime and the specifier rewrite.
+ * @returns the JavaScript.
+ * @throws MissingTypeScriptError when the app has no `typescript`.
+ */
+export function compileModule(file: string, text: string, options: CompileOptions): string {
+  const ts = compilerFor(file, options.what)
+  const output = ts.transpileModule(text, {
+    fileName: file,
+    compilerOptions: {
+      module: 'esnext',
+      target: 'es2022',
+      jsx: 'react-jsx',
+      jsxImportSource: options.importSource ?? importSourceFor(file, ts, options.defaultImportSource),
+      allowImportingTsExtensions: true,
+      inlineSourceMap: true,
+      inlineSources: true,
+    },
+  }).outputText
+  return options.rewrite === undefined ? output : rewriteSpecifiers(ts, output, options.rewrite)
+}
+
+/** The output with each import specifier `rewrite` maps replaced; TypeScript's lexer finds them, so strings and comments are left alone. */
+function rewriteSpecifiers(ts: Compiler, code: string, rewrite: (specifier: string) => string | undefined): string {
+  let result = ''
+  let last = 0
+  for (const { fileName, pos } of ts.preProcessFile(code, true, true).importedFiles.toSorted((a, b) => a.pos - b.pos)) {
+    // `pos` is the opening quote; a specifier written with escapes does not match its text and is left as it is.
+    const start = pos + 1
+    if (code.slice(start, start + fileName.length) !== fileName) continue
+    const replacement = rewrite(fileName)
+    if (replacement === undefined) continue
+    result += code.slice(last, start) + replacement
+    last = start + fileName.length
+  }
+  return result + code.slice(last)
+}

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

@@ -2,16 +2,17 @@
   "source": {
     "repo": "acryldev/acryl",
     "path": "plugins/acryl-node-server",
-    "commit": "524406d2033cdc5ca5e01207f9ce29543bbf221b"
+    "commit": "e79bf3de59c700667ae617f5d367cc1fd2f8e037"
   },
   "vendored": [
     "src",
     "tests",
     "LICENSE"
   ],
-  "rewrittenSpecifiers": 28,
-  "digest": "sha256:c830697a6c09e4f9137f5589cffb56e55d07a06044f22c4087206bcfc3e62ea6",
+  "rewrittenSpecifiers": 31,
+  "digest": "sha256:0a3278e006540d0dbecdfb6ada3ca865f3a9a78b649edd9454dab0c76281eda0",
   "testsNotRun": {
+    "tests/client-modules.spec.ts": "links typescript from the plugin's own node_modules (ACRYL's workspace layout); clientModules and build-client are exercised here by the templates' tests and verify:scaffolder",
     "tests/register.spec.ts": "links typescript from the plugin's own node_modules (ACRYL's workspace layout); the hook is exercised here by the templates' own .tsx tests and verify:scaffolder"
   },
   "notice": [

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

@@ -0,0 +1,3 @@
+/** The typed RPC client (`acrylblends/client`) as one browser module with no imports, served by `clientModules`. */
+
+export * from '../core/client/index.ts'

package/plugins/acryl-router/src/browser/jsx-dom.ts

@@ -0,0 +1,9 @@
+/**
+ * The DOM renderer as one browser module: `acrylblends/jsx/dom`, its JSX runtimes and `client`, in a single file with no imports, so a page
+ * loads it without a bundler and the runtime and the hooks share one module. `clientModules` serves it and points those imports here.
+ */
+
+export * from '../core/jsx/dom/index.ts'
+export { jsx, jsxs } from '../core/jsx/dom/jsx-runtime.ts'
+export { jsxDEV } from '../core/jsx/dom/jsx-dev-runtime.ts'
+export { createRoot, hydrateRoot } from '../core/jsx/dom/client.ts'

package/plugins/acryl-router/src/helpers/index.ts

@@ -13,5 +13,5 @@ export { testClient } from '../core/helper/testing/index.ts'
 export { defaultPlugin, disableSSG, isSSGContext, onlySSG, redirectPlugin, ssgParams, toSSG, X_ACRYL_DISABLE_SSG_HEADER_KEY, type SSGPlugin, type ToSSGOptions } from '../core/helper/ssg/index.ts'
 export { stream, streamSSE, streamText, SSEStreamingApi, type SSEMessage } from '../core/helper/streaming/index.ts'
 export { validator, type ValidationFunction } from '../core/validator/index.ts'
-export { schemaValidator, type StandardSchema } from './schema-validator.ts'
+export { schemaValidator, type StandardIssue, type StandardResult, type StandardSchema, type StandardSchemaOptions, type StandardSchemaProps } from './schema-validator.ts'
 export { createWSMessageEvent, defineWebSocketHelper, WSContext, type SendOptions, type UpgradeWebSocket, type WSContextInit, type WSEvents, type WSMessageReceive, type WSReadyState } from '../core/helper/websocket/index.ts'

package/plugins/acryl-router/src/helpers/schema-validator.ts

@@ -1,27 +1,54 @@
 import type { Env, MiddlewareHandler, ValidationTargets } from '../core/types.ts'
 import { validator } from '../core/validator/index.ts'
 
-/** The slice of the Standard Schema interface this needs; Schemastery (what Cordis uses), Zod and Valibot all implement it. */
-export interface StandardSchema<T = unknown> {
-  readonly '~standard': {
-    validate(value: unknown): StandardResult<T> | Promise<StandardResult<T>>
-  }
+/**
+ * The Standard Schema v1 interface (https://standardschema.dev), declared here so the framework needs no dependency for it. Schemastery
+ * (what Cordis uses), Zod and Valibot implement it, and a hand-written schema object of the same shape is accepted as well. Only
+ * `validate` is called, so `version` and `vendor` may be left out of a hand-written schema.
+ */
+export interface StandardSchema<Input = unknown, Output = Input> {
+  readonly '~standard': StandardSchemaProps<Input, Output>
+}
+
+/** The `~standard` properties of a {@link StandardSchema}. */
+export interface StandardSchemaProps<Input = unknown, Output = Input> {
+  /** The version of the standard; every library sets it. */
+  readonly version?: 1 | undefined
+  /** The name of the schema library; every library sets it. */
+  readonly vendor?: string | undefined
+  /** Validates an unknown value. */
+  readonly validate: (value: unknown, options?: StandardSchemaOptions | undefined) => StandardResult<Output> | Promise<StandardResult<Output>>
+  /** The input and output types, for inference only. */
+  readonly types?: { readonly input: Input, readonly output: Output } | undefined
+}
+
+/** Options a caller may pass to `validate`. */
+export interface StandardSchemaOptions {
+  /** Library-specific parameters. */
+  readonly libraryOptions?: Record<string, unknown> | undefined
+}
+
+/** One validation issue: a message and where in the value it applies. */
+export interface StandardIssue {
+  readonly message: string
+  readonly path?: readonly (PropertyKey | { readonly key: PropertyKey })[] | undefined
 }
 
-type StandardResult<T> =
-  | { readonly value: T, readonly issues?: undefined }
-  | { readonly issues: readonly { readonly message: string, readonly path?: readonly unknown[] | undefined }[] }
+/** What `validate` answers: the parsed value, or the issues. */
+export type StandardResult<Output> =
+  | { readonly value: Output, readonly issues?: undefined }
+  | { readonly issues: readonly StandardIssue[] }
 
-const pathOf = (path: readonly unknown[] | undefined): string =>
-  (path ?? []).map(part => String(typeof part === 'object' && part !== null && 'key' in part ? (part as { key: unknown }).key : part)).join('.')
+const pathOf = (path: StandardIssue['path']): string =>
+  (path ?? []).map(part => String(typeof part === 'object' ? part.key : part)).join('.')
 
 /**
  * The core `validator` driven by a Standard Schema. A failure answers 400 with `{ error, issues }`; success makes the parsed value the
- * handler's `c.req.valid(target)`, typed by the schema.
+ * handler's `c.req.valid(target)`, typed by the schema's output.
  */
 export function schemaValidator<Target extends keyof ValidationTargets, Out, E extends Env = Env, P extends string = string>(
   target: Target,
-  schema: StandardSchema<Out>,
+  schema: StandardSchema<unknown, Out>,
 ): MiddlewareHandler<E, P, { in: { [K in Target]: Out }, out: { [K in Target]: Out } }> {
   const middleware = validator(target, async (value, c) => {
     const result = await schema['~standard'].validate(value)

package/plugins/acryl-router/upstream.json

@@ -2,7 +2,7 @@
   "source": {
     "repo": "acryldev/acryl",
     "path": "plugins/acryl-router",
-    "commit": "524406d2033cdc5ca5e01207f9ce29543bbf221b"
+    "commit": "e79bf3de59c700667ae617f5d367cc1fd2f8e037"
   },
   "vendored": [
     "src",
@@ -10,7 +10,7 @@
     "LICENSE"
   ],
   "rewrittenSpecifiers": 6,
-  "digest": "sha256:dde4e173c7004c7aadd3d96866e65b29230c31562a4fab9e186fd4499821282b",
+  "digest": "sha256:1dd20cb7b5bb87e4368ce507dfe85de3e992cc90069a3b43e24af053b1186842",
   "testsNotRun": {
     "tests/loader.spec.ts": "loads the built lib/ entry through the real Loader; the library ships source and has no build"
   },

package/plugins/acryl-router-http/upstream.json

@@ -2,7 +2,7 @@
   "source": {
     "repo": "acryldev/acryl",
     "path": "plugins/acryl-router-http",
-    "commit": "524406d2033cdc5ca5e01207f9ce29543bbf221b"
+    "commit": "e79bf3de59c700667ae617f5d367cc1fd2f8e037"
   },
   "vendored": [
     "src",

package/plugins/acryl-state/upstream.json

@@ -2,7 +2,7 @@
   "source": {
     "repo": "acryldev/acryl",
     "path": "plugins/acryl-state",
-    "commit": "524406d2033cdc5ca5e01207f9ce29543bbf221b"
+    "commit": "e79bf3de59c700667ae617f5d367cc1fd2f8e037"
   },
   "vendored": [
     "src",

package/plugins/desktop/upstream.json

@@ -5,7 +5,7 @@
       "apps/acryl-desktop/src/shell/desktop-user-data.ts": "user-data.ts",
       "apps/acryl-desktop/src/shell/shutdown.ts": "shutdown.ts"
     },
-    "commit": "524406d2033cdc5ca5e01207f9ce29543bbf221b"
+    "commit": "e79bf3de59c700667ae617f5d367cc1fd2f8e037"
   },
   "rewrittenSpecifiers": 0,
   "digest": "sha256:7dfe960a8bbb476c35540d2202a7aaa62b33492c2ac3e34314e2ecfca45f32f2"

package/plugins/desktop-web/upstream.json

@@ -5,7 +5,7 @@
       "apps/acryl-desktop/src/shell/desktop-user-data.ts": "user-data.ts",
       "apps/acryl-desktop/src/shell/shutdown.ts": "shutdown.ts"
     },
-    "commit": "524406d2033cdc5ca5e01207f9ce29543bbf221b"
+    "commit": "e79bf3de59c700667ae617f5d367cc1fd2f8e037"
   },
   "rewrittenSpecifiers": 0,
   "digest": "sha256:7dfe960a8bbb476c35540d2202a7aaa62b33492c2ac3e34314e2ecfca45f32f2"

package/templates/agent/package.json

@@ -19,9 +19,10 @@
     "save": "node src/plugins/save/cli.ts",
     "upgrade": "node src/plugins/manifest/upgrade-cli.ts"
   },
-  "dependencies": {},
-  "devDependencies": {
-    "@types/node": "^24.0.0",
+  "dependencies": {
     "typescript": "6.0.3"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0"
   }
 }

package/templates/blank/package.json

@@ -19,9 +19,10 @@
     "save": "node src/plugins/save/cli.ts",
     "upgrade": "node src/plugins/manifest/upgrade-cli.ts"
   },
-  "dependencies": {},
-  "devDependencies": {
-    "@types/node": "^24.0.0",
+  "dependencies": {
     "typescript": "6.0.3"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0"
   }
 }

package/templates/todo/package.json

@@ -19,9 +19,10 @@
     "save": "node src/plugins/save/cli.ts",
     "upgrade": "node src/plugins/manifest/upgrade-cli.ts"
   },
-  "dependencies": {},
-  "devDependencies": {
-    "@types/node": "^24.0.0",
+  "dependencies": {
     "typescript": "6.0.3"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0"
   }
 }

package/templates/todo/upstream.json

@@ -5,7 +5,7 @@
       "examples/acryl-todo/src/index.ts": "src/todo.ts",
       "examples/acryl-todo/src/page.ts": "src/page.ts"
     },
-    "commit": "524406d2033cdc5ca5e01207f9ce29543bbf221b"
+    "commit": "e79bf3de59c700667ae617f5d367cc1fd2f8e037"
   },
   "rewrittenSpecifiers": 4,
   "digest": "sha256:9093704776563001f7f472f94cc5c2fdd79206342c1cb59c11fce62aa74df3ed"