@bitspark/horos 0.0.0-stage → 0.7.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bitspark
+
+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/NOTICE

@@ -0,0 +1,6 @@
+horos
+Copyright 2026 Bitspark
+
+The public 0.6.0 work is distributed under Apache License 2.0.
+The MIT notice covering the pre-public source is preserved in LICENSE-MIT.
+Dependency licenses remain with their respective packages.

package/README.md

@@ -1,3 +1,11 @@
-# Temporary Holding Version
+# horos for TypeScript
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`npm install @bitspark/horos@0.7.0`
+
+Import `wf` and `conforms` from `@bitspark/horos`, and `diagnose` and
+`checkingProfile` from `@bitspark/horos/diagnose`. Values come from the public
+@bitspark/ontos-core 0.16.0 package.
+
+See the [form contract](https://github.com/Bitspark/horos/blob/v0.7.0/docs/spec/horos.md).
+The package exports declarations for both entrypoints. There are no private
+proof/witness entrypoints or compatibility aliases.

package/dist/src/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/src/cli.js

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+/** Evaluate wf/conforms over ontos-codec-v1 hex. */
+import { decode } from "@bitspark/ontos-codec";
+import { conforms, wf } from "./index.js";
+function value(hex) {
+    if (!/^(?:[0-9a-f]{2})*$/u.test(hex))
+        throw new Error("invalid lowercase hex");
+    return decode(Uint8Array.from(Buffer.from(hex, "hex")));
+}
+try {
+    const args = process.argv.slice(2);
+    if (args[0] === "wf" && args.length === 2) {
+        console.log(wf(value(args[1])));
+    }
+    else if (args[0] === "conforms" && args.length === 3) {
+        console.log(conforms(value(args[2]), value(args[1])));
+    }
+    else {
+        throw new Error("usage: horos-conform wf <descriptor> | conforms <descriptor> <value>");
+    }
+}
+catch (error) {
+    console.error(error instanceof Error ? error.message : String(error));
+    process.exitCode = 1;
+}
+//# sourceMappingURL=cli.js.map

package/dist/src/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":";AACA,oDAAoD;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,YAAY,CAAC;AAE1C,SAAS,KAAK,CAAC,GAAW;IACxB,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC/E,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED,IAAI,CAAC;IACH,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1C,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC;SAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC;IAC1D,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;IACJ,CAAC;AACH,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACtE,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC"}

package/dist/src/core.d.ts

@@ -0,0 +1,77 @@
+import { type Value } from "@bitspark/ontos-core";
+/** The ontos core value type that horos classifies (descriptors) and checks (values). */
+export type { Value } from "@bitspark/ontos-core";
+/**
+ * The reserved descriptor-label namespace. Every descriptor combinator is a
+ * `Tuple(Atom("horos/<ctor>"), args...)`; a tuple whose first child is not an atom
+ * under this prefix is not a horos descriptor (per ontos-data §1.1 reservation).
+ */
+export declare const NAMESPACE = "horos/";
+/**
+ * The inclusive i128 range an `atom-len` bound must fit in to be well-formed (horos-internal#18):
+ * `[-2^127, 2^127 - 1]`. The Rust reference reads bounds into an `i128` and errors
+ * (→ non-wf / false) past this range; our `readInt` returns an unbounded `bigint`, so we
+ * apply the SAME cap explicitly via {@link atomLenBoundInRange}. The three cores then
+ * agree byte-for-byte at the cap — a bound = 2^127 is non-wf in all of them — and below
+ * it for every real byte-length bound. This makes atom-len byte-identity a theorem rather
+ * than a "never happens" argument; byte-length bounds are tiny, so it rejects nothing
+ * meaningful. (The Go core mirrors this with `atomLenBound*`, the Rust core implicitly via
+ * its `read_int` → i128 materialization.)
+ */
+export declare const ATOM_LEN_BOUND_MAX: bigint;
+export declare const ATOM_LEN_BOUND_MIN: bigint;
+/**
+ * The shared recursion-depth guard (horos-internal#37) — the SAME constant in all three cores (Rust
+ * `MAX_RECURSION_DEPTH`, Go `MaxRecursionDepth`). `conformsIn`/`wfIn` recurse on the
+ * native stack; termination is bounded by `|v|` (the `pending` guard) but there is no
+ * stack bound, so an adversarial-but-finite value (e.g. a tuple nested hundreds of
+ * thousands deep) could overflow the stack — a `RangeError: Maximum call stack size
+ * exceeded` — at a core-dependent depth, breaking the total/never-throws contract.
+ *
+ * Past `MAX_RECURSION_DEPTH` frames, `conformsIn`/`wfIn` return a DETERMINISTIC result
+ * (`false` / non-wf), never a throw, at the same logical depth as Rust and Go (each
+ * increments a depth counter at identical recursion points). Termination is thus bounded
+ * by `min(|v|, MAX_RECURSION_DEPTH)`; the cap is a robustness guardrail, not a change to
+ * the recognized language for in-bound inputs. `512` is far above any descriptor/value
+ * the spec, tests, or vectors exercise (< ~30, so no judgment changes) and comfortably
+ * below the smallest native stack budget of the three cores (validated empirically).
+ */
+export declare const MAX_RECURSION_DEPTH = 512;
+/**
+ * Decide `v : T` — "does the value `v` exhibit the form described by `T`?"
+ *
+ * TOTAL and search-free. A value that does not conform — and a `T` that is not a
+ * well-formed descriptor — both yield `false`; this never errors and never throws. A
+ * value may conform to many descriptors at once (overlapping classification, not a
+ * new identity).
+ */
+export declare function conforms(v: Value, t: Value): boolean;
+/**
+ * Whether `ctor` is a LEAF descriptor (a §4 leaf / §5 refinement / `exact`) — i.e. NOT a
+ */
+export declare function isLeafCtor(ctor: string): boolean;
+/**
+ * Decide a LEAF descriptor `t` against `v` (the `horos/leaf(T, v)` builtin). `false` for any
+ * non-leaf ctor. Reuses the recognizer's leaf arms via `conformsIn` at depth 0 with empty
+ * scopes — a leaf arm never recurses into a value position, so the scopes are inert.
+ */
+export declare function leafClassifies(v: Value, t: Value): boolean;
+/** Decide whether a LEAF descriptor `t` is well-formed (the `horos/wf-leaf(T)` builtin). */
+export declare function leafWellFormed(t: Value): boolean;
+/** Read a field descriptor for diagnostics. */
+export declare function readFieldDescriptor(f: Value): {
+    name: string;
+    required: boolean;
+    ty: Value;
+} | undefined;
+/**
+ * Decide `wf(T)` — "is `T` a well-formed horos descriptor?" Total and search-free;
+ * recurses into sub-descriptors (which are finite). A descriptor that fails `wf` is a
+ * valid ontos value, simply not a recognized descriptor; `conforms(_, T)` over such a
+ * `T` is `false`.
+ *
+ * For rec/ref: a `ref` must be BOUND by an enclosing `rec` and GUARDED — reachable
+ * only after a descent into the value. An unbound or unguarded `ref` (e.g.
+ * `rec(x, ref(x))` or `rec(x, union(ref(x), …))`) is not well-formed.
+ */
+export declare function wf(t: Value): boolean;