exact-mirror 0.0.0 → 0.0.2

package/README.md

@@ -4,6 +4,18 @@ Enforce value to TypeBox/OpenAPI model
 
 By providing model ahead of time, the library will generate a function to mirror a value to an exact type
 
+```
+$ bun benchmarks/small
+
+clk: ~3.13 GHz
+cpu: Apple M1 Max
+runtime: bun 1.2.4 (arm64-darwin)
+
+summary
+  Exact Mirror
+   556.23x faster than TypeBox Value.Clean
+```
+
 ## Installation
 
 ```bash

package/dist/cjs/index.d.ts

@@ -1,4 +1,23 @@
+import { TypeCompiler, type TypeCheck } from '@sinclair/typebox/compiler';
 import type { TAnySchema } from '@sinclair/typebox';
 export declare const mergeObjectIntersection: (schema: TAnySchema) => TAnySchema;
-export declare const createMirror: <T extends TAnySchema>(schema: T) => ((v: T["static"]) => T["static"]);
+interface Instruction {
+    optionals: string[];
+    optionalsInArray: string[][];
+    parentIsOptional: boolean;
+    array: number;
+    unions: TypeCheck<any>[][];
+    unionKeys: Record<string, 1>;
+    /**
+     * TypeCompiler is required when using Union
+     *
+     * Left as opt-in to reduce bundle size
+     * many end-user doesn't use Union
+     *
+     * @default undefined
+     */
+    TypeCompiler?: typeof TypeCompiler;
+    typeCompilerWanred?: boolean;
+}
+export declare const createMirror: <T extends TAnySchema>(schema: T, { TypeCompiler }?: Pick<Instruction, "TypeCompiler">) => ((v: T["static"]) => T["static"]);
 export default createMirror;

package/dist/cjs/index.js

@@ -25,12 +25,13 @@ __export(index_exports, {
   mergeObjectIntersection: () => mergeObjectIntersection
 });
 module.exports = __toCommonJS(index_exports);
+var import_compiler = require("@sinclair/typebox/compiler");
 var Kind = Symbol.for("TypeBox.Kind");
-var OptionalKind = Symbol.for("TypeBox.Optional");
 var isSpecialProperty = (name) => /(\ |-|\t|\n)/.test(name);
-var joinProperty = (v1, v2) => {
-  if (isSpecialProperty(v2)) return `${v1}["${v2}"]`;
-  return `${v1}.${v2}`;
+var joinProperty = (v1, v2, isOptional = false) => {
+  if (typeof v2 === "number") return `${v1}[${v2}]`;
+  if (isSpecialProperty(v2)) return `${v1}${isOptional ? "?." : ""}["${v2}"]`;
+  return `${v1}${isOptional ? "?" : ""}.${v2}`;
 };
 var encodeProperty = (v) => isSpecialProperty(v) ? `"${v}"` : v;
 var mergeObjectIntersection = (schema) => {
@@ -52,27 +53,86 @@ var mergeObjectIntersection = (schema) => {
   }
   return newSchema;
 };
+var handleRecord = (schema, property, instruction) => {
+  const child = schema.patternProperties["^(.*)$"] ?? schema.patternProperties[Object.keys(schema.patternProperties)[0]];
+  if (!child) return property;
+  const i = instruction.array;
+  instruction.array++;
+  return `(()=>{const ar${i}s=Object.keys(${property}),ar${i}v={};for(let i=0;i<ar${i}s.length;i++){const ar${i}p=${property}[ar${i}s[i]];ar${i}v[ar${i}s[i]]=${mirror(child, `ar${i}p`, instruction)}}return ar${i}v})()`;
+};
+var handleTuple = (schema, property, instruction) => {
+  const i = instruction.array;
+  instruction.array++;
+  const isRoot = property === "v" && !instruction.unions.length;
+  let v = "";
+  if (!isRoot) v = `(()=>{`;
+  v += `const ar${i}v=[`;
+  for (let i2 = 0; i2 < schema.length; i2++) {
+    if (i2 !== 0) v += ",";
+    v += mirror(
+      schema[i2],
+      joinProperty(property, i2, instruction.parentIsOptional),
+      instruction
+    );
+  }
+  v += `];`;
+  if (!isRoot) v += `return ar${i}v})()`;
+  return v;
+};
+var handleUnion = (schemas, property, instruction) => {
+  if (instruction.TypeCompiler === void 0) {
+    if (!instruction.typeCompilerWanred) {
+      console.warn(
+        new Error("TypeBox's TypeCompiler is required to use Union")
+      );
+      instruction.typeCompilerWanred = true;
+    }
+    return property;
+  }
+  instruction.unionKeys[property] = 1;
+  const ui = instruction.unions.length;
+  const typeChecks = instruction.unions[ui] = [];
+  let v = `(()=>{
+`;
+  for (let i = 0; i < schemas.length; i++) {
+    typeChecks.push(import_compiler.TypeCompiler.Compile(schemas[i]));
+    v += `if(d.unions[${ui}][${i}].Check(${property})){return ${mirror(schemas[i], property, instruction)}}
+`;
+  }
+  v += `return undefined})()`;
+  return v;
+};
 var mirror = (schema, property, instruction) => {
   if (!schema) return "";
-  const isRoot = property === "v";
-  if (isRoot && schema.type !== "object" && schema.type !== "array")
+  const isRoot = property === "v" && !instruction.unions.length;
+  if (isRoot && schema.type !== "object" && schema.type !== "array" && !schema.anyOf)
     return `return v`;
   let v = "";
   switch (schema.type) {
     case "object":
+      if (schema[Kind] === "Record") {
+        v = handleRecord(schema, property, instruction);
+        break;
+      }
       schema = mergeObjectIntersection(schema);
       v += "{";
       if (schema.additionalProperties) v += `...${property}`;
       const keys = Object.keys(schema.properties);
       for (let i2 = 0; i2 < keys.length; i2++) {
         const key = keys[i2];
-        const name = joinProperty(property, key);
-        if (!schema.required.includes(key)) {
+        let isOptional = schema.required && !schema.required.includes(key) || Array.isArray(schema.properties[key].anyOf);
+        const name = joinProperty(
+          property,
+          key,
+          instruction.parentIsOptional
+        );
+        if (isOptional) {
           const index = instruction.array;
           if (property.startsWith("ar")) {
+            const refName = name.slice(name.indexOf(".") + 1);
             const array = instruction.optionalsInArray;
-            if (array[index]) array[index].push(name.slice(5));
-            else array[index] = [name.slice(5)];
+            if (array[index]) array[index].push(refName);
+            else array[index] = [refName];
           } else {
             instruction.optionals.push(name);
           }
@@ -81,32 +141,45 @@ var mirror = (schema, property, instruction) => {
         if (schema.additionalProperties && child.type !== "object")
           continue;
         if (i2 !== 0) v += ",";
-        v += `${encodeProperty(key)}:${mirror(child, name, instruction)}`;
+        v += `${encodeProperty(key)}:${isOptional ? `${name}===undefined?undefined:` : ""}${mirror(
+          child,
+          name,
+          {
+            ...instruction,
+            parentIsOptional: isOptional
+          }
+        )}`;
       }
       v += "}";
       break;
     case "array":
-      const i = instruction.array;
-      instruction.array++;
       if (schema.items.type !== "object" && schema.items.type !== "array") {
-        v = property;
+        if (Array.isArray(schema.items))
+          v = handleTuple(schema.items, property, instruction);
+        else v = property;
         break;
       }
+      const i = instruction.array;
+      instruction.array++;
       if (!isRoot) v = `(()=>{`;
-      v += `const ar${i}s=${property},ar${i}v=new Array(${property}.length);for(let i=0;i<ar${i}s.length;i++){const ar${i}p=ar${i}s[i];ar${i}v[i]=${mirror(schema.items, `ar${i}p`, instruction)};`;
+      v += `const ar${i}s=${property},ar${i}v=new Array(${property}.length);for(let i=0;i<ar${i}s.length;i++){const ar${i}p=ar${i}s[i];ar${i}v[i]=${mirror(schema.items, `ar${i}p`, instruction)}`;
       const optionals = instruction.optionalsInArray[i + 1];
       if (optionals) {
         for (let oi = 0; oi < optionals.length; oi++) {
-          const key = `ar${i}v[i].${optionals[oi]}`;
-          if (oi !== 0) v += ";";
-          v += `if(${key}===undefined)delete ${key}`;
+          const target = `ar${i}v[i].${optionals[oi]}`;
+          v += `;if(${target}===undefined)delete ${target}`;
         }
       }
       v += `}`;
-      if (!isRoot) v += `}return ar${i}v})()`;
+      if (!isRoot) v += `return ar${i}v})()`;
       break;
     default:
+      if (Array.isArray(schema.anyOf)) {
+        v = handleUnion(schema.anyOf, property, instruction);
+        break;
+      }
       v = property;
+      break;
   }
   if (!isRoot) return v;
   if (schema.type === "array") return `${v}return ar0v`;
@@ -114,18 +187,33 @@ var mirror = (schema, property, instruction) => {
 `;
   for (let i = 0; i < instruction.optionals.length; i++) {
     const key = instruction.optionals[i];
-    v += `if(${key}===undefined)delete x${key.slice(1)}
+    const prop = key.slice(1);
+    v += `if(${key}===undefined`;
+    if (instruction.unionKeys[key]) v += `||x${prop}===undefined`;
+    v += `)delete x?${prop}
 `;
   }
   return `${v}return x`;
 };
-var createMirror = (schema) => {
+var createMirror = (schema, { TypeCompiler: TypeCompiler2 } = {}) => {
+  const unions = [];
   const f = mirror(schema, "v", {
     optionals: [],
     optionalsInArray: [],
-    array: 0
+    array: 0,
+    parentIsOptional: false,
+    unions,
+    unionKeys: {},
+    TypeCompiler: TypeCompiler2
+  });
+  if (!unions.length) return Function("v", f);
+  const fn = `return function mirror(v){${f}}`;
+  return Function(
+    "d",
+    fn
+  )({
+    unions
   });
-  return Function("v", f);
 };
 var index_default = createMirror;
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.d.ts

@@ -1,4 +1,23 @@
+import { TypeCompiler, type TypeCheck } from '@sinclair/typebox/compiler';
 import type { TAnySchema } from '@sinclair/typebox';
 export declare const mergeObjectIntersection: (schema: TAnySchema) => TAnySchema;
-export declare const createMirror: <T extends TAnySchema>(schema: T) => ((v: T["static"]) => T["static"]);
+interface Instruction {
+    optionals: string[];
+    optionalsInArray: string[][];
+    parentIsOptional: boolean;
+    array: number;
+    unions: TypeCheck<any>[][];
+    unionKeys: Record<string, 1>;
+    /**
+     * TypeCompiler is required when using Union
+     *
+     * Left as opt-in to reduce bundle size
+     * many end-user doesn't use Union
+     *
+     * @default undefined
+     */
+    TypeCompiler?: typeof TypeCompiler;
+    typeCompilerWanred?: boolean;
+}
+export declare const createMirror: <T extends TAnySchema>(schema: T, { TypeCompiler }?: Pick<Instruction, "TypeCompiler">) => ((v: T["static"]) => T["static"]);
 export default createMirror;

package/dist/index.mjs

@@ -1,10 +1,11 @@
 // src/index.ts
+import { TypeCompiler } from "@sinclair/typebox/compiler";
 var Kind = Symbol.for("TypeBox.Kind");
-var OptionalKind = Symbol.for("TypeBox.Optional");
 var isSpecialProperty = (name) => /(\ |-|\t|\n)/.test(name);
-var joinProperty = (v1, v2) => {
-  if (isSpecialProperty(v2)) return `${v1}["${v2}"]`;
-  return `${v1}.${v2}`;
+var joinProperty = (v1, v2, isOptional = false) => {
+  if (typeof v2 === "number") return `${v1}[${v2}]`;
+  if (isSpecialProperty(v2)) return `${v1}${isOptional ? "?." : ""}["${v2}"]`;
+  return `${v1}${isOptional ? "?" : ""}.${v2}`;
 };
 var encodeProperty = (v) => isSpecialProperty(v) ? `"${v}"` : v;
 var mergeObjectIntersection = (schema) => {
@@ -26,27 +27,86 @@ var mergeObjectIntersection = (schema) => {
   }
   return newSchema;
 };
+var handleRecord = (schema, property, instruction) => {
+  const child = schema.patternProperties["^(.*)$"] ?? schema.patternProperties[Object.keys(schema.patternProperties)[0]];
+  if (!child) return property;
+  const i = instruction.array;
+  instruction.array++;
+  return `(()=>{const ar${i}s=Object.keys(${property}),ar${i}v={};for(let i=0;i<ar${i}s.length;i++){const ar${i}p=${property}[ar${i}s[i]];ar${i}v[ar${i}s[i]]=${mirror(child, `ar${i}p`, instruction)}}return ar${i}v})()`;
+};
+var handleTuple = (schema, property, instruction) => {
+  const i = instruction.array;
+  instruction.array++;
+  const isRoot = property === "v" && !instruction.unions.length;
+  let v = "";
+  if (!isRoot) v = `(()=>{`;
+  v += `const ar${i}v=[`;
+  for (let i2 = 0; i2 < schema.length; i2++) {
+    if (i2 !== 0) v += ",";
+    v += mirror(
+      schema[i2],
+      joinProperty(property, i2, instruction.parentIsOptional),
+      instruction
+    );
+  }
+  v += `];`;
+  if (!isRoot) v += `return ar${i}v})()`;
+  return v;
+};
+var handleUnion = (schemas, property, instruction) => {
+  if (instruction.TypeCompiler === void 0) {
+    if (!instruction.typeCompilerWanred) {
+      console.warn(
+        new Error("TypeBox's TypeCompiler is required to use Union")
+      );
+      instruction.typeCompilerWanred = true;
+    }
+    return property;
+  }
+  instruction.unionKeys[property] = 1;
+  const ui = instruction.unions.length;
+  const typeChecks = instruction.unions[ui] = [];
+  let v = `(()=>{
+`;
+  for (let i = 0; i < schemas.length; i++) {
+    typeChecks.push(TypeCompiler.Compile(schemas[i]));
+    v += `if(d.unions[${ui}][${i}].Check(${property})){return ${mirror(schemas[i], property, instruction)}}
+`;
+  }
+  v += `return undefined})()`;
+  return v;
+};
 var mirror = (schema, property, instruction) => {
   if (!schema) return "";
-  const isRoot = property === "v";
-  if (isRoot && schema.type !== "object" && schema.type !== "array")
+  const isRoot = property === "v" && !instruction.unions.length;
+  if (isRoot && schema.type !== "object" && schema.type !== "array" && !schema.anyOf)
     return `return v`;
   let v = "";
   switch (schema.type) {
     case "object":
+      if (schema[Kind] === "Record") {
+        v = handleRecord(schema, property, instruction);
+        break;
+      }
       schema = mergeObjectIntersection(schema);
       v += "{";
       if (schema.additionalProperties) v += `...${property}`;
       const keys = Object.keys(schema.properties);
       for (let i2 = 0; i2 < keys.length; i2++) {
         const key = keys[i2];
-        const name = joinProperty(property, key);
-        if (!schema.required.includes(key)) {
+        let isOptional = schema.required && !schema.required.includes(key) || Array.isArray(schema.properties[key].anyOf);
+        const name = joinProperty(
+          property,
+          key,
+          instruction.parentIsOptional
+        );
+        if (isOptional) {
           const index = instruction.array;
           if (property.startsWith("ar")) {
+            const refName = name.slice(name.indexOf(".") + 1);
             const array = instruction.optionalsInArray;
-            if (array[index]) array[index].push(name.slice(5));
-            else array[index] = [name.slice(5)];
+            if (array[index]) array[index].push(refName);
+            else array[index] = [refName];
           } else {
             instruction.optionals.push(name);
           }
@@ -55,32 +115,45 @@ var mirror = (schema, property, instruction) => {
         if (schema.additionalProperties && child.type !== "object")
           continue;
         if (i2 !== 0) v += ",";
-        v += `${encodeProperty(key)}:${mirror(child, name, instruction)}`;
+        v += `${encodeProperty(key)}:${isOptional ? `${name}===undefined?undefined:` : ""}${mirror(
+          child,
+          name,
+          {
+            ...instruction,
+            parentIsOptional: isOptional
+          }
+        )}`;
       }
       v += "}";
       break;
     case "array":
-      const i = instruction.array;
-      instruction.array++;
       if (schema.items.type !== "object" && schema.items.type !== "array") {
-        v = property;
+        if (Array.isArray(schema.items))
+          v = handleTuple(schema.items, property, instruction);
+        else v = property;
         break;
       }
+      const i = instruction.array;
+      instruction.array++;
       if (!isRoot) v = `(()=>{`;
-      v += `const ar${i}s=${property},ar${i}v=new Array(${property}.length);for(let i=0;i<ar${i}s.length;i++){const ar${i}p=ar${i}s[i];ar${i}v[i]=${mirror(schema.items, `ar${i}p`, instruction)};`;
+      v += `const ar${i}s=${property},ar${i}v=new Array(${property}.length);for(let i=0;i<ar${i}s.length;i++){const ar${i}p=ar${i}s[i];ar${i}v[i]=${mirror(schema.items, `ar${i}p`, instruction)}`;
       const optionals = instruction.optionalsInArray[i + 1];
       if (optionals) {
         for (let oi = 0; oi < optionals.length; oi++) {
-          const key = `ar${i}v[i].${optionals[oi]}`;
-          if (oi !== 0) v += ";";
-          v += `if(${key}===undefined)delete ${key}`;
+          const target = `ar${i}v[i].${optionals[oi]}`;
+          v += `;if(${target}===undefined)delete ${target}`;
         }
       }
       v += `}`;
-      if (!isRoot) v += `}return ar${i}v})()`;
+      if (!isRoot) v += `return ar${i}v})()`;
       break;
     default:
+      if (Array.isArray(schema.anyOf)) {
+        v = handleUnion(schema.anyOf, property, instruction);
+        break;
+      }
       v = property;
+      break;
   }
   if (!isRoot) return v;
   if (schema.type === "array") return `${v}return ar0v`;
@@ -88,18 +161,33 @@ var mirror = (schema, property, instruction) => {
 `;
   for (let i = 0; i < instruction.optionals.length; i++) {
     const key = instruction.optionals[i];
-    v += `if(${key}===undefined)delete x${key.slice(1)}
+    const prop = key.slice(1);
+    v += `if(${key}===undefined`;
+    if (instruction.unionKeys[key]) v += `||x${prop}===undefined`;
+    v += `)delete x?${prop}
 `;
   }
   return `${v}return x`;
 };
-var createMirror = (schema) => {
+var createMirror = (schema, { TypeCompiler: TypeCompiler2 } = {}) => {
+  const unions = [];
   const f = mirror(schema, "v", {
     optionals: [],
     optionalsInArray: [],
-    array: 0
+    array: 0,
+    parentIsOptional: false,
+    unions,
+    unionKeys: {},
+    TypeCompiler: TypeCompiler2
+  });
+  if (!unions.length) return Function("v", f);
+  const fn = `return function mirror(v){${f}}`;
+  return Function(
+    "d",
+    fn
+  )({
+    unions
   });
-  return Function("v", f);
 };
 var index_default = createMirror;
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "exact-mirror",
-	"version": "0.0.0",
+	"version": "0.0.2",
 	"description": "Mirror exact value to TypeBox/OpenAPI model",
 	"license": "MIT",
 	"scripts": {