@formaui-net/nexo 0.0.0 → 1.0.0-preview.1

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/NOTICE

@@ -0,0 +1,2 @@
+Nexo, https://github.com/FormaUI/Nexo
+Copyright 2026 Eyal Alon <eyal@formaui.net>

package/README.md

@@ -1,11 +1,153 @@
-# @formaui-net/nexo
+# Nexo
 
-This version is a placeholder. It holds npm's `latest` tag until Nexo's first stable release, so no preview becomes the default install.
+Nexo lets an application expose its own concepts through a typed scripting language, so people can express rules and produce structured results in those terms.
 
-Install a preview by its tag:
+The application declares what scripts may use: its records, their properties and the operations it implements. Nexo checks each script against those declarations before it runs, and evaluates it into plain, immutable data.
 
-```sh
-npm install @formaui-net/nexo@preview
+## An example
+
+A billing application keeps customers and their invoices. It gives each script one `customer`, with a name, a credit limit and invoices. It declares what scripts can read: a customer's `invoices`, an invoice's `amount`, whether it is `paid`, and `daysOverdue`, which the application computes from the invoice's due date and the date it gives the evaluation.
+
+This script summarizes what a customer owes, charging a 5% late fee on any invoice more than 30 days overdue:
+
+```nexo
+import Billing
+
+let outstanding = customer.invoices.where(not it.paid)
+let lateFee = invoice => if invoice.daysOverdue > 30 then invoice.amount * 0.05 else 0 end
+let owed = outstanding.sum(it.amount + lateFee(it))
+
+return {
+    account = customer.name,
+    amountDue = owed,
+    status = if owed > customer.creditLimit then "on hold" else "in good standing" end,
+    overdue = outstanding.where(it.daysOverdue > 0) {
+        number = it.number,
+        daysOverdue = it.daysOverdue,
+        fee = lateFee(it)
+    },
+    summary = $"{outstanding.count} of {customer.invoices.count} invoices outstanding"
+}
 ```
 
-Nexo's [README](https://github.com/FormaUI/Nexo#readme) says what Nexo is and how to use it.
+The application evaluates the script on November 1, 2026. Northwind Traders then has four invoices: one paid, one 42 days overdue, one 7 days overdue and one not yet due. Its credit limit is 1,000. The script gives:
+
+```json
+{
+    "account": "Northwind Traders",
+    "amountDue": 1015,
+    "status": "on hold",
+    "overdue": [
+        { "number": "INV-102", "daysOverdue": 42, "fee": 15 },
+        { "number": "INV-103", "daysOverdue": 7, "fee": 0 }
+    ],
+    "summary": "3 of 4 invoices outstanding"
+}
+```
+
+What the example shows:
+
+- **The application's terms.** `customer.invoices` and `invoice.daysOverdue` are the billing application's concepts. `daysOverdue` runs the application's own code, and the script reads it as it reads any property.
+- **A rule stated once.** `lateFee` is written once, and both the amount due and each overdue line apply it.
+- **One readable place.** Filtering, the total, the credit check and the shape of the result are in one script, rather than spread through application code.
+- **Plain data out.** The result has the shape the script writes, ready to send, store or compare.
+
+## Why embed Nexo
+
+| Strength | Why it matters |
+| --- | --- |
+| The application's own vocabulary | The script works with `customer.invoices` and `daysOverdue`, the billing application's concepts, not a generic data model. `daysOverdue` is an operation the application implements. |
+| Checked before it runs | Writing `it.amout` in the total is refused before anything runs: "'amout' is no member of the vocabulary", at line 5, column 28. Leaving out `import Billing`, or comparing `customer.name` with a number, is refused the same way, with its location. |
+| Expressions, collections and structured output | One script filters the invoices, totals them, checks the credit limit, writes the summary's text and shapes the result. |
+| Functions and composition | `lateFee` is written once, and both the total and each overdue line apply it, so the fee changes in one place. |
+| An explicit host boundary | The script reads only the `customer` the application binds, as a frozen copy, through members `Billing` and Nexo declare. `daysOverdue` runs the application's code, and nothing the script does changes the application's data. |
+| Definitions as data, with canonical text | `nexo.parse` gives the script as a JSON definition to store or inspect, and `nexo.format` gives the text above back from it, so a definition a tool generates reads as a script written by hand. |
+| Reads reported as it evaluates | Hooks the application gives an evaluation are told of each member it invokes, `daysOverdue` among them, so the application knows what the summary read. Each member also declares how it changes: `daysOverdue` is `unobserved`, since nothing signals that a day has passed, so when to evaluate again is the application's choice. |
+
+## Run it
+
+The application declares its vocabulary as a module, binds its data and evaluates the script. `script` holds the script's text above:
+
+```js
+import { nexo } from '@formaui-net/nexo';
+
+const { createPropertyDeclaration: property } = nexo.declarations;
+const DAY = 24 * 60 * 60 * 1000;
+
+const billing = nexo.createModule('Billing', {
+    types: [
+        {
+            name: 'Customer',
+            kind: 'structured',
+            members: [property('name', 'String'), property('creditLimit', 'Number'), property('invoices', 'List<Invoice>')],
+        },
+        {
+            name: 'Invoice',
+            kind: 'structured',
+            members: [
+                property('number', 'String'),
+                property('amount', 'Number'),
+                property('paid', 'Boolean'),
+                property('dueDate', 'String'),
+                // The application's code, reading the date it gives the evaluation. Nothing signals
+                // that the date has moved on, so the property is unobserved.
+                property('daysOverdue', 'Number', {
+                    updates: { changes: 'unobserved', reads: 'fresh' },
+                    impl: ({ receiver, env }) => Math.max(0, Math.round((env.today - Date.parse(receiver.dueDate)) / DAY)),
+                }),
+            ],
+        },
+    ],
+});
+
+const customer = {
+    name: 'Northwind Traders',
+    creditLimit: 1000,
+    invoices: [
+        { number: 'INV-101', amount: 450, paid: true, dueDate: '2026-09-15' },
+        { number: 'INV-102', amount: 300, paid: false, dueDate: '2026-09-20' },
+        { number: 'INV-103', amount: 520, paid: false, dueDate: '2026-10-25' },
+        { number: 'INV-104', amount: 180, paid: false, dueDate: '2026-11-20' },
+    ],
+};
+
+const registry = nexo.createRegistry([billing]);
+const bindings = registry.createBindings({ customer }, { types: { customer: 'Billing.Customer' } });
+
+// Resolving checks the script against the vocabulary, before anything runs.
+const resolution = registry.resolve(script, bindings);
+
+resolution.type; // '{ account: String, amountDue: Number, status: String, overdue: List<{ number: String, daysOverdue: Number, fee: Number }>, summary: String }'
+
+const summary = resolution.createEvaluator(bindings, { today: Date.parse('2026-11-01') }).evaluate().value;
+```
+
+`summary` is the result shown above, on any day, since the date comes from the evaluation and not the clock. A resolution serves any bindings of the same types, so the script is resolved once and evaluated for each customer. [Embedding Nexo](https://github.com/FormaUI/Nexo/blob/main/docs/embedding-guide.md) goes on to functions a module declares, calls the application carries out, and following what an evaluation reads.
+
+## Availability
+
+> **Preview.** Until the first release candidate, a decision may be replaced where a host's experience, correctness or a measured cost justifies it, and a version that breaks what the one before it allowed says how to migrate; from `1.0.0-rc.1` on, nothing breaks before 2.0. Neither package is published yet: build them locally, as [Build](#build) shows, to try Nexo. The implementation, `1.0.0-preview.1`, implements language version `1.0.0-preview.1`. [The status overview](https://github.com/FormaUI/Nexo/blob/main/docs/features-status.md) says what is implemented, what remains, and [what 1.0 requires](https://github.com/FormaUI/Nexo/blob/main/docs/features-status.md#what-1-0-requires).
+
+## Documents
+
+| Document | What it holds |
+| --- | --- |
+| [Guide](https://github.com/FormaUI/Nexo/blob/main/docs/embedding-guide.md) | Embedding Nexo in an application, by example |
+| [Specification](https://github.com/FormaUI/Nexo/blob/main/spec/README.md) | The contract, in two parts: the language, what a script means, and the runtime, what an application provides to run it |
+| [Language history](https://github.com/FormaUI/Nexo/blob/main/LANGUAGE-HISTORY.md) | Each language version and what it changed |
+| [Changelog](https://github.com/FormaUI/Nexo/blob/main/CHANGELOG.md) | Each release of the packages and what it changed |
+| [Status](https://github.com/FormaUI/Nexo/blob/main/docs/features-status.md) | What is implemented, and what remains |
+| [Design](https://github.com/FormaUI/Nexo/blob/main/docs/nexo-design.md) | How Nexo is built: its stages, modules, evaluation and tooling |
+| [Contributing](https://github.com/FormaUI/Nexo/blob/main/CONTRIBUTING.md) | Report a bug, develop a change and run the checks |
+
+## Build
+
+```powershell
+./build.ps1
+```
+
+The gate runs the tests, bundles Nexo, builds the NuGet package project with no warnings and checks its formatting. The full gate, `./build.ps1 -Full`, runs it, then packs the npm package `@formaui-net/nexo` and the NuGet package `formaui-net.Nexo` into `artifacts/`, and verifies each as a consumer installs it.
+
+## License
+
+Apache License 2.0; see [LICENSE](https://github.com/FormaUI/Nexo/blob/main/LICENSE) and [NOTICE](https://github.com/FormaUI/Nexo/blob/main/NOTICE).

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@formaui-net/nexo",
-    "version": "0.0.0",
-    "description": "A placeholder that holds npm's latest tag until Nexo's first stable release. Install @formaui-net/nexo@preview.",
+    "version": "1.0.0-preview.1",
+    "description": "Nexo is an embeddable language with no domain of its own: the host declares the typed vocabulary, and scripts use it to compute and shape data. Nexo checks every script against that vocabulary before it runs, and evaluates it, read-only, into immutable data.",
     "license": "Apache-2.0",
     "author": "Eyal Alon",
     "homepage": "https://github.com/FormaUI/Nexo#readme",
@@ -9,7 +9,27 @@
         "type": "git",
         "url": "https://github.com/FormaUI/Nexo.git"
     },
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./src/nexo.d.ts",
+            "default": "./src/nexo.js"
+        }
+    },
     "files": [
+        "src",
+        "LICENSE",
+        "NOTICE",
         "README.md"
-    ]
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "bundle": "node scripts/bundle.mjs",
+        "benchmark": "node benchmarks/run.mjs"
+    },
+    "devDependencies": {
+        "esbuild": "^0.25.0"
+    }
 }

package/src/common/ArrayUtils.mjs

@@ -0,0 +1,16 @@
+/**
+ * ArrayUtils — operations on JavaScript arrays that need no knowledge of the language
+ */
+
+export class ArrayUtils {
+    /** The first index of the list that holds no value at all, a hole, or -1 where every index holds one; an index that holds `undefined` holds a value. */
+    static findMissingIndex(list) {
+        for (let index = 0; index < list.length; index++) {
+            if (!(index in list)) {
+                return index;
+            }
+        }
+
+        return -1;
+    }
+}

package/src/common/ObjectUtils.mjs

@@ -0,0 +1,33 @@
+/**
+ * ObjectUtils — tests and a write on JavaScript objects that need no knowledge of the language
+ */
+
+export class ObjectUtils {
+    /** Whether the value is an object that is neither null nor an array, class instances included. */
+    static isNonArrayObject(value) {
+        return typeof value === 'object' && value !== null && !Array.isArray(value);
+    }
+
+    /** Whether the value is an object whose prototype is `Object.prototype` or null, as an object literal, parsed JSON and `Object.create(null)` are. */
+    static isPlainObject(value) {
+        if (typeof value !== 'object' || value === null) {
+            return false;
+        }
+
+        const prototype = Object.getPrototypeOf(value);
+
+        return prototype === Object.prototype || prototype === null;
+    }
+
+    /**
+     * Writes the value to the object's field by assignment, as an ordinary data object takes one, and defines a field named `__proto__` as an own data property, which assigning it would not do,
+     * changing the object's prototype instead. It makes no promise about an object whose fields have setters of their own.
+     */
+    static defineDataProperty(object, name, value) {
+        if (name === '__proto__') {
+            Object.defineProperty(object, name, { value, writable: true, enumerable: true, configurable: true });
+        } else {
+            object[name] = value;
+        }
+    }
+}

package/src/language/DefinitionLocations.mjs

@@ -0,0 +1,41 @@
+/**
+ * DefinitionLocations — where in a definition its caller supplied each part of its canonical copy came from, for one whose validation moved a part
+ */
+
+export class DefinitionLocations {
+    #definition;
+    #partIndexes;
+
+    /**
+     * @param {object} definition The canonical copy.
+     * @param {WeakMap<object, number[]>} partIndexes The index each part of an interpolated string had in the caller's definition, by the canonical node, for each node whose parts validation moved.
+     */
+    constructor(definition, partIndexes) {
+        this.#definition = definition;
+        this.#partIndexes = partIndexes;
+    }
+
+    /** The pointer into the caller's definition of the part the pointer names in the canonical copy: the same pointer, but for each part of an interpolated string validation moved, which its original index names. */
+    locate(pointer) {
+        const segments = pointer.split('/').slice(1);
+        const original = [];
+        let node = this.#definition;
+
+        for (let index = 0; index < segments.length; index++) {
+            const segment = segments[index];
+
+            original.push(segment);
+
+            if (segment === 'parts' && this.#partIndexes.has(node) && index + 1 < segments.length) {
+                const part = Number(segments[++index]);
+
+                original.push(String(this.#partIndexes.get(node)[part] ?? part));
+                node = node.parts[part];
+            } else {
+                node = node?.[segment];
+            }
+        }
+
+        return { pointer: segments.length === 0 ? pointer : `/${original.join('/')}` };
+    }
+}