@ata-project/unplugin 0.4.0 → 0.6.0

package/README.md

@@ -177,6 +177,11 @@ library build is 122.5 KB gzipped without it and 16.7 KB with it (gzip level 9),
 ata-validator 1.39.2. Across the 977 schemas of SchemaStore, 725 can be compiled
 away this way.
 
+Where the code only ever calls `isValidObject()` or `isValidJSON()`, the plugin
+uses a smaller wrapper without the error machinery (needs ata-validator 1.40.0):
+a small app that only asks for a boolean bundles to 2.6 KB gzipped, against 12.1 KB with
+the full wrapper and 102.0 KB for the runtime, on 0.5.0 with ata-validator 1.40.0.
+
 The replacement answers `validate()`, `isValidObject()`, `validateJSON()` and
 `isValidJSON()` as a `Validator` with default options does: the same verdicts,
 defaults filled in, `data` on success, and the same errors, enriched the same
@@ -190,14 +195,20 @@ otherwise:
 - `Validator` is a named import from `ata-validator`;
 - the schema argument is an object literal, a top-level `const` bound to one,
   the default import of a relative `.json` file, or `defineSchema(...)` around
-  one of those;
+  one of those; calls to the `t` builder from `ata-validator/t` whose arguments are
+  such values are run at build time, since the builder returns plain JSON Schema,
+  and are marked pure so a schema only the replaced call used leaves the bundle
+  with the builder (`t.refine` and `t.recursive`, which take a function, stay on
+  the runtime);
 - there is no second argument, or it is `{ useDefaults: false }` (or
   `{ useDefaults: true }`), written as a literal or a top-level `const`; that
   one option needs ata-validator 1.37.0, and older versions keep such calls on
   the runtime;
 - the result goes into a `const` that is not exported and is only used as
   `name.validate(...)`, `name.isValidObject(...)`, `name.validateJSON(...)` or
-  `name.isValidJSON(...)`;
+  `name.isValidJSON(...)`; the call may be wrapped in `withKeywords(...)` from
+  `@ata-project/keywords`, which then registers its keywords on the compiled
+  validator as it does on a `Validator` (needs ata-validator 1.40.0);
 - ata-validator can compile the schema to the same results. It declines custom
   `errorMessage`s and shapes its code generator cannot express, which the
   runtime answers with its interpreted engine.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ata-project/unplugin",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Build-time JSON Schema for Vite, Webpack, Rollup, Rolldown, esbuild and Rspack. compileAway takes the runtime compiler out of the bundle.",
   "type": "module",
   "main": "./src/index.js",
@@ -77,8 +77,9 @@
     "unplugin": "^3.3.0"
   },
   "devDependencies": {
+    "@ata-project/keywords": "^0.3.3",
     "@rspack/core": "^1.7.0",
-    "ata-validator": "^1.39.2",
+    "ata-validator": "^1.40.0",
     "esbuild": "^0.28.0",
     "rolldown": "^1.2.8",
     "rollup": "^4.60.0",

package/src/compile-away.js

@@ -29,6 +29,9 @@ import MagicString from 'magic-string'
 
 const METHODS = new Set(['validate', 'isValidObject', 'validateJSON', 'isValidJSON'])
 const NOT_STATIC = Symbol('not static')
+// The builders of ata-validator/t that take only values. refine and
+// recursive take a function and stay on the runtime.
+const T_PURE = new Set(['string', 'number', 'integer', 'boolean', 'null', 'literal', 'const', 'enum', 'array', 'tuple', 'record', 'object', 'optional', 'union', 'intersect', 'ref', 'any', 'unknown', 'never', 'pick', 'omit', 'partial', 'required', 'composite'])
 
 // Keys that hold child nodes. Types are left out on purpose: they are erased
 // before anything runs, so a name used in a type annotation says nothing about
@@ -134,9 +137,30 @@ function staticValue(node, ctx, seen = new Set()) {
       seen.delete(node.name)
       return v
     }
-    case 'CallExpression':
+    case 'CallExpression': {
       if (node.callee.type === 'Identifier' && node.callee.name === ctx.defineSchema && node.arguments.length === 1) return staticValue(node.arguments[0], ctx, seen)
+      // `t.object(...)` and the rest of the builder from ata-validator/t. It
+      // returns plain JSON Schema and holds no state, so a call whose
+      // arguments the build can read gives here what it gives at run time.
+      // The builders that take a function are left out.
+      const c = node.callee
+      if (ctx.t && ctx.tName && c.type === 'MemberExpression' && !c.computed && c.object.type === 'Identifier' &&
+          c.object.name === ctx.tName && ctx.declared.get(ctx.tName) === 1 && c.property.type === 'Identifier' && T_PURE.has(c.property.name) &&
+          typeof ctx.t[c.property.name] === 'function') {
+        const args = []
+        for (const a of node.arguments) {
+          if (a.type === 'SpreadElement') return NOT_STATIC
+          const v = staticValue(a, ctx, seen)
+          if (v === NOT_STATIC) return NOT_STATIC
+          args.push(v)
+        }
+        let v
+        try { v = ctx.t[c.property.name](...args) } catch { return NOT_STATIC }
+        ctx.tCalls.add(node)
+        return v
+      }
       return NOT_STATIC
+    }
   }
   return NOT_STATIC
 }
@@ -163,26 +187,44 @@ function constantsOf(ast, id) {
 // `const name = new Validator(...)`, declared once, not exported, and used only
 // as `name.<method>(...)` with a supported method.
 function replaceableBinding(newExpr, ctx) {
-  const decl = newExpr.__parent
-  if (!decl || decl.type !== 'VariableDeclarator' || decl.init !== newExpr || decl.id.type !== 'Identifier') return null
+  let decl = newExpr.__parent
+  // `withKeywords(new Validator(schema))` from @ata-project/keywords: the
+  // wrapper takes the keywords' check the way a Validator does, so the inner
+  // call is replaced and withKeywords stays to register the check on it.
+  if (decl && decl.type === 'CallExpression' && ctx.withKeywords && ctx.extendChecks &&
+      decl.callee.type === 'Identifier' && decl.callee.name === ctx.withKeywords &&
+      ctx.declared.get(ctx.withKeywords) === 1 && decl.arguments.length === 1 && decl.arguments[0] === newExpr) {
+    decl = decl.__parent
+    if (!decl || decl.type !== 'VariableDeclarator' || decl.init !== newExpr.__parent) return null
+  }
+  if (!decl || decl.type !== 'VariableDeclarator' || decl.id.type !== 'Identifier') return null
+  if (decl.init !== newExpr && decl.init !== newExpr.__parent) return null
   const list = decl.__parent
   if (!list || list.type !== 'VariableDeclaration' || list.kind !== 'const') return null
   if (list.__parent && list.__parent.type === 'ExportNamedDeclaration') return null
   const name = decl.id.name
   if (ctx.declared.get(name) !== 1) return null
+  const methods = new Set()
   for (const r of ctx.refs) {
     if (r.node.name !== name) continue
     const p = r.parent
     const member = p && (p.type === 'MemberExpression' || p.type === 'OptionalMemberExpression') && r.key === 'object' && !p.computed && p.property.type === 'Identifier' && METHODS.has(p.property.name)
     const called = member && p.__parent && (p.__parent.type === 'CallExpression' || p.__parent.type === 'OptionalCallExpression') && p.__parent.callee === p
     if (!called) return null
+    methods.add(p.property.name)
   }
-  return name
+  return { name, methods }
 }
 
-function inlineModule(src, index) {
+// Code that only asks for a boolean never reads an error.
+const VERDICT_METHODS = new Set(['isValidObject', 'isValidJSON'])
+const verdictOnly = (methods) => [...methods].every((m) => VERDICT_METHODS.has(m))
+
+// A verdict-only module hands out isValid alone, so the error function inside
+// it is unreferenced and the bundler drops it.
+function inlineModule(src, index, verdict) {
   const body = src.split('\n').filter((l) => !/^export\s/.test(l)).join('\n')
-  return `const __ataCompiled${index} = (() => {\n${body}\nreturn { validate, isValid };\n})();\n`
+  return `const __ataCompiled${index} = (() => {\n${body}\nreturn ${verdict ? '{ isValid }' : '{ validate, isValid }'};\n})();\n`
 }
 
 // The options of `new Validator(schema, options)` as a third argument for
@@ -226,14 +268,33 @@ export function compileAway(code, id, ata) {
     }
   }
   if (!validatorName) return null
+  let tName = null
+  for (const stmt of ast.program.body) {
+    if (stmt.type !== 'ImportDeclaration' || stmt.source.value !== 'ata-validator/t' || stmt.importKind === 'type') continue
+    for (const sp of stmt.specifiers) {
+      if (sp.type !== 'ImportSpecifier' || sp.importKind === 'type') continue
+      const imported = sp.imported.type === 'Identifier' ? sp.imported.name : sp.imported.value
+      if (imported === 't') tName = sp.local.name
+    }
+  }
+  let withKeywords = null
+  for (const stmt of ast.program.body) {
+    if (stmt.type !== 'ImportDeclaration' || stmt.source.value !== '@ata-project/keywords' || stmt.importKind === 'type') continue
+    for (const sp of stmt.specifiers) {
+      if (sp.type !== 'ImportSpecifier' || sp.importKind === 'type') continue
+      const imported = sp.imported.type === 'Identifier' ? sp.imported.name : sp.imported.value
+      if (imported === 'withKeywords') withKeywords = sp.local.name
+    }
+  }
 
   const { declared, refs } = scan(ast)
   if (declared.get(validatorName) !== 1) return null
-  const ctx = { declared, refs, constants: constantsOf(ast, id), defineSchema }
+  const ctx = { declared, refs, constants: constantsOf(ast, id), defineSchema, withKeywords, extendChecks: ata.compiledExtendChecks === true, t: ata.t || null, tName, tCalls: new Set() }
 
   const s = new MagicString(code)
   const modules = []
   const done = new Set()
+  const wrappers = { full: false, verdict: false }
   for (const r of refs) {
     if (r.node.name !== validatorName) continue
     const expr = r.parent
@@ -244,15 +305,19 @@ export function compileAway(code, id, ata) {
       optionsArg = compiledOptionsArg(expr.arguments[1], ctx, supportedOptions)
       if (optionsArg === NOT_STATIC) continue
     }
-    if (!replaceableBinding(expr, ctx)) continue
+    const binding = replaceableBinding(expr, ctx)
+    if (!binding) continue
     const schema = staticValue(expr.arguments[0], ctx)
     if (schema === NOT_STATIC || schema === null || typeof schema !== 'object' || Array.isArray(schema)) continue
     let src = null
     try { src = compiledModuleFor(schema, { format: 'esm' }) } catch { src = null }
     if (!src) continue
     const index = modules.length
-    modules.push(inlineModule(src, index))
-    s.overwrite(expr.start, expr.end, `__ataFromCompiled(__ataCompiled${index}, ${JSON.stringify(compiledSchemaFor(schema))}${optionsArg ? ', ' + optionsArg : ''})`)
+    const verdict = ata.compiledVerdict === true && verdictOnly(binding.methods)
+    modules.push(inlineModule(src, index, verdict))
+    const wrap = verdict ? '__ataFromCompiledVerdict' : '__ataFromCompiled'
+    if (verdict) wrappers.verdict = true; else wrappers.full = true
+    s.overwrite(expr.start, expr.end, `${wrap}(__ataCompiled${index}, ${JSON.stringify(compiledSchemaFor(schema))}${optionsArg ? ', ' + optionsArg : ''})`)
     done.add(expr)
   }
   if (done.size === 0) return null
@@ -278,7 +343,12 @@ export function compileAway(code, id, ata) {
     const clause = [def ? text(def) : null, named.length ? `{ ${named.map(text).join(', ')} }` : null].filter(Boolean).join(', ')
     s.overwrite(importDecl.start, importDecl.end, `import ${clause} from ${code.slice(importDecl.source.start, importDecl.source.end)}`)
   }
-  s.prepend(`import { fromCompiled as __ataFromCompiled } from 'ata-validator/compiled';\n`)
+  // The builder calls read here are pure, and marked so: a schema constant
+  // only the replaced call used, and the builder with it, can then leave the
+  // bundle.
+  for (const call of ctx.tCalls) s.appendLeft(call.start, '/*#__PURE__*/ ')
+  if (wrappers.verdict) s.prepend(`import { fromCompiledVerdict as __ataFromCompiledVerdict } from 'ata-validator/compiled-verdict';\n`)
+  if (wrappers.full) s.prepend(`import { fromCompiled as __ataFromCompiled } from 'ata-validator/compiled';\n`)
   s.appendLeft(lastImportEnd, '\n' + modules.join(''))
   return { code: s.toString(), map: s.generateMap({ hires: true, source: id, includeContent: true }), replaced: done.size }
 }

package/src/core.js

@@ -64,6 +64,30 @@ async function loadAta() {
   // compiledModuleFor exists from ata-validator 1.35.0; compile-away needs it
   // and is skipped with a warning when it is missing.
   const canCompileAway = typeof build.compiledModuleFor === 'function' && typeof build.compiledSchemaFor === 'function'
+  // The verdict-only wrapper, from ata-validator 1.40.0: code that never reads
+  // errors gets it and the error pipeline stays out of the bundle.
+  let compiledVerdict = false
+  if (canCompileAway) {
+    try { compiledVerdict = typeof (await import('ata-validator/compiled-verdict')).fromCompiledVerdict === 'function' } catch { compiledVerdict = false }
+  }
+  // Whether the wrappers take a check registered with _extendChecks, as
+  // withKeywords from @ata-project/keywords registers one; from 1.40.0. Asked
+  // of a wrapper itself, so an ata-validator without it keeps such calls on
+  // the runtime.
+  // The ata-validator/t builder, run at build time on calls whose arguments
+  // the build can read.
+  let t = null
+  if (canCompileAway) {
+    try { const m = await import('ata-validator/t'); t = (m.default ?? m).t ?? m.t ?? null } catch { t = null }
+  }
+  let compiledExtendChecks = false
+  if (canCompileAway) {
+    try {
+      const c = await import('ata-validator/compiled')
+      const fromCompiled = (c.default ?? c).fromCompiled ?? c.fromCompiled
+      compiledExtendChecks = typeof fromCompiled({ validate: () => ({ valid: true, errors: [] }), isValid: () => true }, {}, { useDefaults: false })._extendChecks === 'function'
+    } catch { compiledExtendChecks = false }
+  }
   return {
     ...api,
     toStandaloneModule: build.toStandaloneModule,
@@ -72,6 +96,9 @@ async function loadAta() {
     // The Validator options fromCompiled() reproduces, from ata-validator
     // 1.37.0; before it, only calls without options are replaced.
     compiledOptions: canCompileAway && Array.isArray(build.compiledOptions) ? build.compiledOptions : [],
+    compiledVerdict,
+    compiledExtendChecks,
+    t,
   }
 }