exact-mirror 0.0.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 saltyAom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,40 @@
+# Exact Mirror
+
+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
+
+## Installation
+
+```bash
+# Using either one of the package manager
+npm install exact-mirror
+yarn add exact-mirror
+pnpm add exact-mirror
+bun add exact-mirror
+```
+
+## Usage
+
+It is designed to be used with [TypeBox](https://github.com/sinclairzx81/typebox) but an OpenAPI schema should also work.
+
+```typescript
+import { Type as t } from '@sinclair/typebox'
+import { createMirror } from 'exact-mirror'
+
+const shape = t.Object({
+	name: t.String(),
+	id: t.Number()
+})
+
+const value = {
+	id: 0,
+	name: 'saltyaom',
+	// @ts-expect-error
+	shoudBeRemoved: true
+} satisfies typeof shape.static
+
+const mirror = createMirror(shape)
+
+console.log(mirror(value)) // {"id":0,"name":"saltyaom"}
+```

package/bunfig.toml

@@ -0,0 +1,2 @@
+[install]
+registry = "https://registry.npmjs.org/"

package/dist/cjs/index.d.ts

@@ -0,0 +1,4 @@
+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"]);
+export default createMirror;

package/dist/cjs/index.js

@@ -0,0 +1,135 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createMirror: () => createMirror,
+  default: () => index_default,
+  mergeObjectIntersection: () => mergeObjectIntersection
+});
+module.exports = __toCommonJS(index_exports);
+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 encodeProperty = (v) => isSpecialProperty(v) ? `"${v}"` : v;
+var mergeObjectIntersection = (schema) => {
+  if (!schema.allOf || Kind in schema && (schema[Kind] !== "Intersect" || schema.type !== "object"))
+    return schema;
+  const { allOf, ...newSchema } = schema;
+  newSchema.properties = {};
+  if (Kind in newSchema) newSchema[Kind] = "Object";
+  for (const type of allOf) {
+    if (type.type !== "object") continue;
+    const { properties, required, type: _, [Kind]: __, ...rest } = type;
+    if (required)
+      newSchema.required = newSchema.required ? newSchema.required.concat(required) : required;
+    Object.assign(newSchema, rest);
+    for (const property in type.properties)
+      newSchema.properties[property] = mergeObjectIntersection(
+        type.properties[property]
+      );
+  }
+  return newSchema;
+};
+var mirror = (schema, property, instruction) => {
+  if (!schema) return "";
+  const isRoot = property === "v";
+  if (isRoot && schema.type !== "object" && schema.type !== "array")
+    return `return v`;
+  let v = "";
+  switch (schema.type) {
+    case "object":
+      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)) {
+          const index = instruction.array;
+          if (property.startsWith("ar")) {
+            const array = instruction.optionalsInArray;
+            if (array[index]) array[index].push(name.slice(5));
+            else array[index] = [name.slice(5)];
+          } else {
+            instruction.optionals.push(name);
+          }
+        }
+        const child = schema.properties[key];
+        if (schema.additionalProperties && child.type !== "object")
+          continue;
+        if (i2 !== 0) v += ",";
+        v += `${encodeProperty(key)}:${mirror(child, name, instruction)}`;
+      }
+      v += "}";
+      break;
+    case "array":
+      const i = instruction.array;
+      instruction.array++;
+      if (schema.items.type !== "object" && schema.items.type !== "array") {
+        v = property;
+        break;
+      }
+      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)};`;
+      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}`;
+        }
+      }
+      v += `}`;
+      if (!isRoot) v += `}return ar${i}v})()`;
+      break;
+    default:
+      v = property;
+  }
+  if (!isRoot) return v;
+  if (schema.type === "array") return `${v}return ar0v`;
+  v = `const x=${v}
+`;
+  for (let i = 0; i < instruction.optionals.length; i++) {
+    const key = instruction.optionals[i];
+    v += `if(${key}===undefined)delete x${key.slice(1)}
+`;
+  }
+  return `${v}return x`;
+};
+var createMirror = (schema) => {
+  const f = mirror(schema, "v", {
+    optionals: [],
+    optionalsInArray: [],
+    array: 0
+  });
+  return Function("v", f);
+};
+var index_default = createMirror;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createMirror,
+  mergeObjectIntersection
+});

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+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"]);
+export default createMirror;

package/dist/index.mjs

@@ -0,0 +1,109 @@
+// src/index.ts
+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 encodeProperty = (v) => isSpecialProperty(v) ? `"${v}"` : v;
+var mergeObjectIntersection = (schema) => {
+  if (!schema.allOf || Kind in schema && (schema[Kind] !== "Intersect" || schema.type !== "object"))
+    return schema;
+  const { allOf, ...newSchema } = schema;
+  newSchema.properties = {};
+  if (Kind in newSchema) newSchema[Kind] = "Object";
+  for (const type of allOf) {
+    if (type.type !== "object") continue;
+    const { properties, required, type: _, [Kind]: __, ...rest } = type;
+    if (required)
+      newSchema.required = newSchema.required ? newSchema.required.concat(required) : required;
+    Object.assign(newSchema, rest);
+    for (const property in type.properties)
+      newSchema.properties[property] = mergeObjectIntersection(
+        type.properties[property]
+      );
+  }
+  return newSchema;
+};
+var mirror = (schema, property, instruction) => {
+  if (!schema) return "";
+  const isRoot = property === "v";
+  if (isRoot && schema.type !== "object" && schema.type !== "array")
+    return `return v`;
+  let v = "";
+  switch (schema.type) {
+    case "object":
+      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)) {
+          const index = instruction.array;
+          if (property.startsWith("ar")) {
+            const array = instruction.optionalsInArray;
+            if (array[index]) array[index].push(name.slice(5));
+            else array[index] = [name.slice(5)];
+          } else {
+            instruction.optionals.push(name);
+          }
+        }
+        const child = schema.properties[key];
+        if (schema.additionalProperties && child.type !== "object")
+          continue;
+        if (i2 !== 0) v += ",";
+        v += `${encodeProperty(key)}:${mirror(child, name, instruction)}`;
+      }
+      v += "}";
+      break;
+    case "array":
+      const i = instruction.array;
+      instruction.array++;
+      if (schema.items.type !== "object" && schema.items.type !== "array") {
+        v = property;
+        break;
+      }
+      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)};`;
+      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}`;
+        }
+      }
+      v += `}`;
+      if (!isRoot) v += `}return ar${i}v})()`;
+      break;
+    default:
+      v = property;
+  }
+  if (!isRoot) return v;
+  if (schema.type === "array") return `${v}return ar0v`;
+  v = `const x=${v}
+`;
+  for (let i = 0; i < instruction.optionals.length; i++) {
+    const key = instruction.optionals[i];
+    v += `if(${key}===undefined)delete x${key.slice(1)}
+`;
+  }
+  return `${v}return x`;
+};
+var createMirror = (schema) => {
+  const f = mirror(schema, "v", {
+    optionals: [],
+    optionalsInArray: [],
+    array: 0
+  });
+  return Function("v", f);
+};
+var index_default = createMirror;
+export {
+  createMirror,
+  index_default as default,
+  mergeObjectIntersection
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+	"name": "exact-mirror",
+	"version": "0.0.0",
+	"description": "Mirror exact value to TypeBox/OpenAPI model",
+	"license": "MIT",
+	"scripts": {
+		"dev": "bun run --watch example/index.ts",
+		"test": "bun test && npm run test:node",
+		"test:node": "npm install --prefix ./test/node/cjs/ && npm install --prefix ./test/node/esm/ && node ./test/node/cjs/index.js && node ./test/node/esm/index.js",
+		"build": "bun build.ts",
+		"release": "npm run build && npm run test && npm publish --access public"
+	},
+	"peerDependencies": {
+		"@sinclair/typebox": "^0.34.15"
+	},
+	"peerDependenciesMeta": {
+		"@sinclair/typebox": {
+			"optional": true
+		}
+	},
+	"devDependencies": {
+		"@types/bun": "1.2.2",
+		"elysia": "^1.2.11",
+		"eslint": "9.6.0",
+		"mitata": "^1.0.33",
+		"tsup": "^8.1.0",
+		"tsx": "^4.19.2",
+		"typescript": "^5.5.3"
+	},
+	"main": "./dist/cjs/index.js",
+	"module": "./dist/index.mjs",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		"./package.json": "./package.json",
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.mjs",
+			"require": "./dist/cjs/index.js"
+		}
+	},
+	"keywords": [
+		"elysia",
+		"exact",
+		"mirror",
+		"typebox"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/elysiajs/exact-mirror"
+	},
+	"author": {
+		"name": "saltyAom",
+		"url": "https://github.com/SaltyAom",
+		"email": "saltyaom@gmail.com"
+	},
+	"homepage": "https://github.com/elysiajs/exact-mirror",
+	"bugs": "https://github.com/elysiajs/exact-mirror/issues"
+}