domainforge 0.13.0

package/domainforge-typescript/LICENSE

@@ -0,0 +1,201 @@
+                                 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/domainforge-typescript/MIGRATING.md

@@ -0,0 +1,24 @@
+# Migrating from `@godspeedai/sea` to `@godspeedai/domainforge` (npm)
+
+The TypeScript/npm package was renamed:
+
+| Before                       | After                          |
+|------------------------------|--------------------------------|
+| `@godspeedai/sea` (npm)      | `@godspeedai/domainforge`      |
+| native binary `sea-core.*.node` | `domainforge-core.*.node`   |
+
+## Install
+
+```bash
+# old: npm install @godspeedai/sea
+npm install @godspeedai/domainforge
+```
+
+## Import
+
+```ts
+// old: import { Graph, Entity } from '@godspeedai/sea';
+import { Graph, Entity } from '@godspeedai/domainforge';
+```
+
+The API surface is otherwise unchanged.

package/domainforge-typescript/README.md

@@ -0,0 +1,305 @@
+# @godspeedai/domainforge
+
+[![npm](https://img.shields.io/npm/v/@godspeedai/domainforge.svg)](https://www.npmjs.com/package/@godspeedai/domainforge)
+[![npm downloads](https://img.shields.io/npm/dm/@godspeedai/domainforge.svg)](https://www.npmjs.com/package/@godspeedai/domainforge)
+[![License](https://img.shields.io/npm/l/@godspeedai/domainforge.svg)](https://github.com/GodSpeedAI/DomainForge/blob/main/LICENSE)
+[![CI](https://github.com/GodSpeedAI/DomainForge/actions/workflows/ci.yml/badge.svg)](https://github.com/GodSpeedAI/DomainForge/actions/workflows/ci.yml)
+[![Node Version](https://img.shields.io/node/v/@godspeedai/domainforge.svg)](https://nodejs.org)
+
+TypeScript/Node.js bindings for the **SEA DSL** (Semantic Enterprise Architecture) domain-specific language. Part of the [DomainForge](https://github.com/GodSpeedAI/DomainForge) ecosystem.
+
+## Features
+
+- 🏗️ **Domain Primitives** — Entities, Resources, Flows, Roles, Relations, Instances
+- 📐 **Unit System** — First-class dimensional analysis with type-safe quantities
+- ✅ **Policy Engine** — Constraint validation with three-valued logic
+- 🔄 **DSL Parsing** — Parse SEA source code into queryable graph structures
+- 🌐 **CALM Integration** — Export/import FINOS CALM architecture-as-code format
+- ⚡ **Native Performance** — Rust-powered core via N-API
+- 📦 **Full TypeScript Support** — Complete type definitions included
+
+## Installation
+
+```bash
+npm install @godspeedai/domainforge
+```
+
+```bash
+yarn add @godspeedai/domainforge
+```
+
+```bash
+pnpm add @godspeedai/domainforge
+```
+
+**Requires:** Node.js 18+
+
+## Quick Start
+
+### Parse from DSL
+
+```typescript
+import { Graph } from "@godspeedai/domainforge";
+
+const source = `
+  @namespace "supply_chain"
+  
+  Entity "Warehouse" in logistics
+  Entity "Factory" in manufacturing
+  
+  Resource "Cameras" units
+  
+  Flow "Cameras" from "Warehouse" to "Factory" quantity 100
+`;
+
+const graph = Graph.parse(source);
+
+console.log(`Entities: ${graph.entityCount()}`);
+console.log(`Resources: ${graph.resourceCount()}`);
+console.log(`Flows: ${graph.flowCount()}`);
+```
+
+### Build Programmatically
+
+```typescript
+import { Graph, Entity, Resource, Flow } from "@godspeedai/domainforge";
+
+const graph = new Graph();
+
+// Create primitives
+const warehouse = new Entity("Warehouse", "logistics");
+const factory = new Entity("Factory", "manufacturing");
+const cameras = new Resource("Cameras", "units");
+
+graph.addEntity(warehouse);
+graph.addEntity(factory);
+graph.addResource(cameras);
+
+// Create flow
+const flow = new Flow(cameras.id, warehouse.id, factory.id, 100);
+graph.addFlow(flow);
+
+// Query the graph
+for (const entity of graph.allEntities()) {
+  console.log(`${entity.name} in ${entity.namespace}`);
+}
+```
+
+### Work with Attributes
+
+```typescript
+const entity = new Entity("Warehouse");
+entity.setAttribute("capacity", JSON.stringify(10000));
+entity.setAttribute("location", JSON.stringify({ lat: 40.7128, lng: -74.006 }));
+
+const capacity = JSON.parse(entity.getAttribute("capacity")!); // 10000
+const location = JSON.parse(entity.getAttribute("location")!);
+```
+
+### CALM Integration
+
+```typescript
+// Export to CALM JSON
+const calmJson = graph.exportCalm();
+
+// Import from CALM
+const imported = Graph.importCalm(calmJson);
+```
+
+## API Reference
+
+### Core Classes
+
+| Class              | Description                                            |
+| ------------------ | ------------------------------------------------------ |
+| `Entity`           | Business actors, locations, organizational units (WHO) |
+| `Resource`         | Quantifiable subjects of value (WHAT)                  |
+| `Flow`             | Transfers of resources between entities                |
+| `Instance`         | Entity type instances with named fields                |
+| `ResourceInstance` | Physical instances at entity locations                 |
+| `Role`             | Roles that entities can play                           |
+| `Relation`         | Relationships between roles                            |
+| `Graph`            | Container with validation and query capabilities       |
+
+### Entity
+
+```typescript
+class Entity {
+  constructor(name: string, namespace?: string | null);
+
+  get id(): string;
+  get name(): string;
+  get namespace(): string | null;
+  setAttribute(key: string, valueJson: string): void;
+  getAttribute(key: string): string | null;
+}
+```
+
+### Resource
+
+```typescript
+class Resource {
+  constructor(name: string, unit: string, namespace?: string | null);
+
+  get id(): string;
+  get name(): string;
+  get unit(): string;
+  get namespace(): string | null;
+}
+```
+
+### Flow
+
+```typescript
+class Flow {
+  constructor(
+    resourceId: string,
+    fromId: string,
+    toId: string,
+    quantity: number
+  );
+
+  get id(): string;
+  get resourceId(): string;
+  get fromId(): string;
+  get toId(): string;
+  get quantity(): number;
+}
+```
+
+### Graph
+
+```typescript
+class Graph {
+  constructor();
+
+  // Add primitives
+  addEntity(entity: Entity): void;
+  addResource(resource: Resource): void;
+  addFlow(flow: Flow): void;
+
+  // Counts
+  entityCount(): number;
+  resourceCount(): number;
+  flowCount(): number;
+
+  // Lookup
+  findEntityByName(name: string): string | null;
+  findResourceByName(name: string): string | null;
+  getEntity(id: string): Entity | null;
+  getResource(id: string): Resource | null;
+
+  // Flow queries
+  flowsFrom(entityId: string): Flow[];
+  flowsTo(entityId: string): Flow[];
+
+  // Get all
+  allEntities(): Entity[];
+  allResources(): Resource[];
+  allFlows(): Flow[];
+
+  // Parsing
+  static parse(source: string): Graph;
+
+  // CALM integration
+  exportCalm(): string;
+  static importCalm(calmJson: string): Graph;
+
+  // Policy evaluation
+  addPolicy(policyJson: string): void;
+  evaluatePolicy(policyJson: string): EvaluationResult;
+  setEvaluationMode(useThreeValuedLogic: boolean): void;
+}
+```
+
+### NamespaceRegistry
+
+```typescript
+import { NamespaceRegistry } from "@godspeedai/domainforge";
+
+// Load workspace registry
+const reg = NamespaceRegistry.fromFile(".sea-registry.toml");
+
+// Resolve files
+for (const binding of reg.resolveFiles()) {
+  console.log(`${binding.path} => ${binding.namespace}`);
+}
+
+// Query namespace for file
+const ns = reg.namespaceFor("/path/to/file.sea");
+```
+
+## Platform Support
+
+Pre-built binaries are available for:
+
+| Platform | Architecture               |
+| -------- | -------------------------- |
+| Linux    | x64, arm64                 |
+| macOS    | x64, arm64 (Apple Silicon) |
+| Windows  | x64                        |
+
+Build from source for other platforms using `npm run build`.
+
+## Development
+
+### Building from Source
+
+```bash
+# Clone the repository
+git clone https://github.com/GodSpeedAI/DomainForge.git
+cd DomainForge
+
+# Install dependencies
+npm install
+
+# Build the native module
+npm run build
+
+# Run tests
+npm test
+```
+
+## Related Packages
+
+| Package                                                              | Registry  | Description                        |
+| -------------------------------------------------------------------- | --------- | ---------------------------------- |
+| [`domainforge-core`](https://crates.io/crates/domainforge-core)                      | crates.io | Rust core library                  |
+| [`domainforge`](https://pypi.org/project/domainforge/)                       | PyPI      | Python bindings                    |
+| [`@godspeedai/domainforge`](https://www.npmjs.com/package/@godspeedai/domainforge) | npm       | TypeScript bindings (this package) |
+
+## Policy Authority
+
+DomainForge includes a Policy Authority system for executable business authority:
+
+```typescript
+import { evaluateAuthority, FinalDecision, PolicyModality, SourceClass, ClaimLevel } from '@godspeedai/domainforge';
+
+const result = evaluateAuthority(configJson, requestJson, factsJson);
+const decision = JSON.parse(result.decisionJson);
+
+if (decision.finalDecision === FinalDecision.Deny) {
+  console.log('Action denied:', decision.reasonCode);
+}
+```
+
+**Available exports:**
+- `FinalDecision` enum — Allow, Deny, Escalate, NotApplicable, Reject
+- `PolicyModality` enum — Permission, Prohibition, Obligation, Override
+- `SourceClass` enum — CallerSupplied, RuntimeObserved, SystemOfRecord, etc.
+- `ClaimLevel` enum — AuditBacked, Validated, FormallyProven
+- `evaluateAuthority(configJson, requestJson, factsJson?)` — One-shot evaluation
+
+## Documentation
+
+- 📖 [SEA DSL Guide](https://github.com/GodSpeedAI/DomainForge/blob/main/docs/reference/grammar-spec.md) — Language specification
+- 🏗️ [Architecture](https://github.com/GodSpeedAI/DomainForge/blob/main/docs/explanations/architecture-overview.md) — Design overview
+- 📚 [API Reference](https://github.com/GodSpeedAI/DomainForge/blob/main/docs/reference/typescript-api.md) — Full TypeScript API
+
+## License
+
+[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)
+
+---
+
+Part of the [DomainForge](https://github.com/GodSpeedAI/DomainForge) project.