@oh-my-pi/omptype 17.2.6 → 17.2.7

package/CHANGELOG.md

@@ -2,7 +2,22 @@
 
 ## [Unreleased]
 
+## [17.2.7] - 2026-08-03
+
 ### Added
 
-- Initial release: ArkType-compatible schema validation with a lazy JIT runtime. Schemas interpret their first two calls and compile a specialized validator via `new Function` on the third, making `type()` construction ~100x cheaper than arktype while beating its hot-path validation speed. Supports the string definition DSL (primitives, literals, unions, arrays, bounds, `number.integer`, `string.url`, inline defaults, value-suffix `?` optionals), object definitions (`"+": "reject"/"delete"`, `"[string]"` index signatures), `type.errors`/`OmpErrors` with per-entry `path`/`problem`, `type.enumerated`, `type.raw`, keyword statics, composition methods (`.or/.and/.array/.pipe/.narrow/.describe/.default/.allows/.assert`), static inference via `typeof schema.infer`, and draft-2020-12 `toJsonSchema()` emission.
-- TypeBox-style (`@oh-my-pi/omptype/typebox`) and Zod-style (`@oh-my-pi/omptype/zod`) authoring adapters producing native omptype schemas.
+- Introduced omptype, an ArkType-compatible schema validation library featuring a lazy JIT runtime that compiles specialized validators on the third call for ultra-fast hot-path validation and low construction overhead.
+- Added support for a rich string definition DSL (primitives, literals, unions, arrays, bounds, inline defaults, and optional keys), object definitions (including index signatures and strict key rejection/deletion), and comprehensive composition methods (.or, .and, .array, .pipe, .narrow, .describe, .default, .allows, .assert).
+- Added TypeBox-style (@oh-my-pi/omptype/typebox) and Zod-style (@oh-my-pi/omptype/zod) authoring adapters that produce native omptype schemas.
+- Added support for recursive named scopes, modules, runtime generics, fixed/optional/variadic tuples, Date literals/bounds, disjointness-aware intersections, separate input/output inference, and draft-2020-12 JSON Schema emission.
+- Shipped transpiled ESM and TypeScript declarations in the npm package to support plain Node.js environments, while preserving TS source resolution for Bun consumers.
+
+### Changed
+
+- Optimized the lazy JIT compiler to support tuples, refinements, morphs, intersections, instances, and recursive aliases, while reducing schema construction overhead.
+
+### Fixed
+
+- Fixed a TypeScript compiler error (TS2589: "type instantiation is excessively deep") when using generic fluent composition methods on nested schemas.
+- Fixed type.raw() results (BaseType) to correctly expose fluent composition methods like .array(), .or(), and .pipe().
+- Fixed an issue in the TypeBox adapter where keyword-carrying schemas (e.g., uniqueItems arrays) would throw an error during JSON Schema emission.

package/README.md

@@ -1,16 +1,20 @@
 # @oh-my-pi/omptype
 
-Fast, ArkType-compatible schema validation for Bun. Schemas start with a small
-interpreter and lazily compile after repeated use, keeping construction cheap
-without giving up hot-path validation speed.
+Fast, ArkType-compatible schema validation for JavaScript and TypeScript.
+Schemas start with a small interpreter and lazily compile after repeated use,
+keeping construction cheap without giving up hot-path validation speed.
 
 ## Installation
 
 ```sh
+npm install @oh-my-pi/omptype
+# or
 bun add @oh-my-pi/omptype
 ```
 
-Omptype requires Bun 1.3.14 or newer.
+Runs on Node 20+ (published as compiled ESM with bundled type declarations)
+and Bun 1.3.14+ (which resolves the TypeScript source directly via the `bun`
+export condition). No runtime dependencies.
 
 ## Usage
 
@@ -18,9 +22,9 @@ Omptype requires Bun 1.3.14 or newer.
 import { type } from "@oh-my-pi/omptype";
 
 const Config = type({
-	name: "string",
-	"retries?": "number.integer >= 0",
-	enabled: "boolean = true",
+  name: "string",
+  "retries?": "number.integer >= 0",
+  enabled: "boolean = true",
 });
 
 const config = Config.assert({ name: "worker" });
@@ -28,13 +32,42 @@ const config = Config.assert({ name: "worker" });
 
 const result = Config({ name: 42 });
 if (result instanceof type.errors) {
-	console.error(result.summary);
+  console.error(result.summary);
 }
 ```
 
-Schemas are callable and expose `.assert()`, `.allows()`, `.toJsonSchema()`,
-`.or()`, `.and()`, `.array()`, `.pipe()`, `.narrow()`, `.describe()`, and
-`.default()`.
+Schemas are callable and expose composition (`.or()`, `.and()`, `.array()`,
+`.pipe()`, `.narrow()`), object transforms (`.pick()`, `.omit()`, `.partial()`,
+`.required()`, `.merge()`, `.map()`), refinements, semantic comparison, error
+configuration, and JSON Schema emission.
+
+Built-in keyword modules include `type.string.email`, `type.string.uuid.v4`,
+`type.string.date.iso.parse`, `type.string.normalize.NFKC`,
+`type.number.integer`, and the parsers under `type.parse`.
+
+## Named and recursive schemas
+
+```ts
+const models = type
+  .scope({
+    User: { name: "string", "manager?": "User" },
+    Users: "User[]",
+    PublicUser: "Pick<User, 'name'>",
+  })
+  .export();
+
+models.User.assert({ name: "Ada", manager: { name: "Grace" } });
+```
+
+Scopes resolve aliases lazily, including cycles. `type.module()` exports a
+scope directly, `type.define()` preserves literal definitions, and
+`type.generic("<value>", definition)` builds parameterized runtime schemas.
+
+Failed validation returns `OmpErrors`; each entry exposes `code`, `path`,
+`expected`, `actual`, `problem`, and `message`, while the aggregate exposes
+`summary` and `byPath`. `.configure()` accepts string or callback overrides for
+error text. `.toJsonSchema()` accepts `target`, `dialect`, and `fallback`
+options.
 
 ## Compatibility adapters
 
@@ -51,9 +84,45 @@ const ZodUser = z.object({ name: z.string() });
 const user = ZodUser.parse({ name: "Ada" });
 ```
 
-`@oh-my-pi/omptype/ark` provides the repository's ArkType compatibility facade.
-Its `scope()` export remains available as an alias-free no-op for existing
-callers; new code should import `type` directly from `@oh-my-pi/omptype`.
+`@oh-my-pi/omptype/ark` provides the repository's ArkType compatibility facade
+and re-exports the same `type` and `scope` implementations.
+
+## Performance
+
+Run the benchmark from the repository root:
+
+```sh
+bun packages/omptype/bench/bench.ts
+```
+
+The harness first requires every candidate to accept, reject, and transform the
+same fixtures correctly. Compile and cold-start results use 400 unique object
+schemas and report the fastest of five repetitions. Hot validation mixes valid
+and invalid inputs after 2,000 warmup calls. The valid-only row uses each
+library's public boolean path after 20,000 warmup calls.
+
+Representative result on an Apple M4 Max with Darwin 25.6.0 and Bun 1.3.14:
+
+| Phase                   |    omptype |           ArkType |               Zod |         TypeBox |
+| ----------------------- | ---------: | ----------------: | ----------------: | --------------: |
+| Compile `type()`        |  **509ns** | 271.08µs (532.3×) |  77.95µs (153.1×) | 27.36µs (53.7×) |
+| Compile + 2 validations | **2.18µs** | 526.46µs (241.5×) | 222.55µs (102.1×) | 46.90µs (21.5×) |
+
+| Hot workload               |  omptype |         ArkType |             Zod |         TypeBox |
+| -------------------------- | -------: | --------------: | --------------: | --------------: |
+| `flat-small`               | **25ns** | 5.10µs (203.7×) | 4.55µs (181.4×) |  1.23µs (49.2×) |
+| `enum-union`               | **27ns** | 4.92µs (185.0×) | 4.38µs (164.7×) |  2.20µs (83.0×) |
+| `nested-arrays`            | **29ns** | 4.80µs (163.0×) | 7.05µs (239.6×) | 3.01µs (102.2×) |
+| `strict-defaults`          | **40ns** | 4.85µs (122.1×) | 6.71µs (169.2×) | 4.92µs (123.9×) |
+| `delete-extras`            | **22ns** | 4.12µs (191.6×) | 2.55µs (118.6×) |  2.07µs (96.0×) |
+| `record-mixed`             | **43ns** | 4.32µs (100.4×) | 8.80µs (204.5×) |  3.35µs (77.9×) |
+| `deep-message`             | **31ns** | 6.32µs (202.5×) | 9.16µs (293.7×) | 5.13µs (164.5×) |
+| `nested-arrays` valid-only | **15ns** |     28ns (1.8×) |  1.05µs (68.3×) |     45ns (2.9×) |
+
+Lower times are better. Parenthetical values show how many times slower each
+candidate was than omptype in this run. Results vary with hardware, runtime,
+thermal state, and dependency versions; use the command above for local
+measurements.
 
 ## License
 

package/dist/js/ark.js

@@ -0,0 +1,16 @@
+/**
+ * ArkType compatibility facade — `@oh-my-pi/omptype/ark`.
+ *
+ * Lets code written against arktype keep its imports and names while running
+ * on the omptype lazy-JIT runtime: swap `from "arktype"` for
+ * `from "@oh-my-pi/omptype/ark"` and nothing else changes. New code should
+ * import `@oh-my-pi/omptype` directly.
+ *
+ * Compatibility affordance: `ArkError` / `ArkErrors` alias `OmpError` /
+ * `OmpErrors`. All schema builders, including recursive `scope()`, are
+ * re-exported unchanged.
+ */
+import { OmpError, OmpErrors } from "./errors.js";
+export * from "./index.js";
+export const ArkError = OmpError;
+export const ArkErrors = OmpErrors;