@agent-assembly/sdk 0.0.1-alpha.3

package/LICENSE

@@ -0,0 +1,176 @@
+                                 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

package/README.md

@@ -0,0 +1,182 @@
+# @agent-assembly/sdk
+
+[![npm version](https://img.shields.io/npm/v/@agent-assembly/sdk.svg)](https://www.npmjs.com/package/@agent-assembly/sdk)
+[![CI](https://github.com/AI-agent-assembly/node-sdk/actions/workflows/test-matrix.yml/badge.svg?branch=master)](https://github.com/AI-agent-assembly/node-sdk/actions/workflows/test-matrix.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=AI-agent-assembly_node-sdk&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=AI-agent-assembly_node-sdk)
+[![codecov](https://codecov.io/gh/AI-agent-assembly/node-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/AI-agent-assembly/node-sdk)
+
+TypeScript/Node.js SDK for Agent Assembly, licensed under Apache 2.0.
+
+## Prerequisites
+
+Before installing or contributing, ensure your environment has:
+
+- **Node.js** ≥ 18.18.0 (LTS). The active LTS lines (18, 20, 22, 24) are exercised in CI.
+- **pnpm** ≥ 10. The repository enforces pnpm via `engines` and ships a `pnpm-lock.yaml`.
+- **Rust toolchain** (only required when rebuilding the native `aa-ffi-node` binding from
+  source — most consumers receive a prebuilt platform binary via `optionalDependencies`).
+
+## Installation
+
+```bash
+pnpm add @agent-assembly/sdk
+# or
+npm install @agent-assembly/sdk
+# or
+yarn add @agent-assembly/sdk
+```
+
+The SDK ships dual ESM/CJS entries and selects a prebuilt native binding for your platform
+during `postinstall`. No additional build step is required for typical consumers.
+
+## Quickstart
+
+### ESM (`import`)
+
+```ts
+import { initAssembly, withAssembly } from "@agent-assembly/sdk";
+import { ChatOpenAI } from "@langchain/openai";
+
+const ctx = await initAssembly({ gatewayUrl: "http://localhost:8080", agentId: "demo" });
+const governedTools = withAssembly(myTools, { context: ctx });
+const model = new ChatOpenAI({ model: "gpt-4o-mini" }).bindTools(governedTools);
+```
+
+### CJS (`require`)
+
+```js
+const { initAssembly, withAssembly } = require("@agent-assembly/sdk");
+const { ChatOpenAI } = require("@langchain/openai");
+
+const ctx = await initAssembly({ gatewayUrl: "http://localhost:8080", agentId: "demo" });
+const governedTools = withAssembly(myTools, { context: ctx });
+const model = new ChatOpenAI({ model: "gpt-4o-mini" }).bindTools(governedTools);
+```
+
+Both entrypoints resolve to the same governance pipeline; the package's `exports` field
+selects ESM or CJS automatically based on how the consumer imports it.
+
+`initAssembly()` registers the LangChain callback handler and the AdapterRegistry, so any
+tool wrapped by `withAssembly()` is checked against gateway policy before invocation.
+
+## Supported Node.js versions
+
+The SDK is tested against every active Node.js LTS line on every supported operating
+system. The matrix is enforced by `.github/workflows/test-matrix.yml`:
+
+| Node.js | Linux (ubuntu-latest) | macOS (macos-latest) | Windows (windows-latest) |
+| ------- | --------------------- | -------------------- | ------------------------ |
+| 18      | ✅                    | ✅                   | ✅                       |
+| 20      | ✅                    | ✅                   | ✅                       |
+| 22      | ✅                    | ✅                   | ✅                       |
+| 24      | ✅                    | ✅                   | ✅                       |
+
+Older Node.js lines (≤ 16) are unsupported because the napi-rs ABI used by the native
+binding requires Node 18.18 or newer.
+
+## Goal
+
+Provide a thin wrapper around the Agent Assembly Rust runtime through:
+
+- gRPC sidecar client (default)
+- native in-process binding (napi-rs)
+
+The primary entrypoint is `initAssembly()`, which prepares runtime governance and
+registers framework hooks for supported tool ecosystems.
+
+## Public Entrypoints
+
+- `initAssembly(config)`
+- `withAssembly(tools, options)`
+
+## Policy Matching Constraint
+
+Vercel AI SDK tools do not expose a `.name` field. Governance policies must match
+by tool description content (or tool map key in wrapper context), not by strict
+framework-level tool name.
+
+## LangChain Blocking Model
+
+LangChain callback `handleToolStart` cannot preempt execution by return value, so
+this SDK applies a two-layer model:
+
+- callback layer (`AssemblyCallbackHandler`) tracks deferred denials and redacts at `handleToolEnd`
+- wrapper layer (`wrapToolWithAssembly`) enforces true pre-execution deny/pending checks
+
+`initAssembly()` auto-registers the callback handler and auto-wraps configured
+LangChain tools.
+
+## Current Architecture Layout
+
+```text
+src/
+  index.ts
+  core/
+    init-assembly.ts
+  adapters/
+    adapter.ts
+    adapter-registry.ts
+    langchain/
+      assembly-callback-handler.ts
+      wrap-tool-with-assembly.ts
+  gateway/
+    client.ts
+  wrappers/
+    with-assembly.ts
+  errors/
+    policy-violation-error.ts
+  types/
+    assembly-mode.ts
+    assembly-config.ts
+    assembly-context.ts
+    gateway-governance.ts
+    langchain-adapter.ts
+    tool-map.ts
+tests/
+  architecture/
+.github/workflows/
+```
+
+## Native napi-rs Binding (AAASM-60)
+
+The `aa-ffi-node` Rust crate is located at `native/aa-ffi-node`.
+
+Build commands:
+
+- `pnpm native:build` (debug/local)
+- `pnpm native:build:release` (release + platform artifact)
+- `pnpm native:check-types` (strict check for generated napi `.d.ts`)
+
+Native integration acceptance test:
+
+- `AA_NATIVE_TEST=1 pnpm vitest run tests/native-napi-integration.test.ts`
+
+The `build-addon` GitHub workflow produces prebuilt `index.node` artifacts
+for Node 18/20/22 on Linux/macOS/Windows.
+
+## Packaging Layout (AAASM-61)
+
+The package now publishes dual module outputs with explicit conditional exports:
+
+- ESM entry: `./dist/esm/index.js`
+- CJS entry: `./dist/cjs/index.js`
+- Type declarations: `./dist/types/index.d.ts`
+
+Platform-native binaries are declared via `optionalDependencies` and selected
+during `postinstall` based on `process.platform` and `process.arch`.
+
+Package verification checks include:
+
+- ESM and CJS entry smoke tests
+- export `types` mapping assertion
+- `npm pack` content and package size guard tests
+
+## Documentation
+
+Full guides, architecture deep-dives, and the complete API reference are published at:
+
+**https://ai-agent-assembly.github.io/node-sdk/**
+
+The site is built from the `docs/` (content) and `website/` (Docusaurus app) directories
+and is re-published on every push to `master` via the `publish-docs.yml` workflow.

package/dist/cjs/adapters/adapter-registry.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/adapters/adapter.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/adapters/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/adapters/langchain/assembly-callback-handler.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssemblyCallbackHandler = void 0;
+const base_1 = require("@langchain/core/callbacks/base");
+const BLOCKED_OUTPUT = "[BLOCKED] This action was flagged as a policy violation.";
+function getSerializedName(value) {
+    if (!value || typeof value !== "object") {
+        return undefined;
+    }
+    const candidate = value.name;
+    return typeof candidate === "string" ? candidate : undefined;
+}
+class AssemblyCallbackHandler extends base_1.BaseCallbackHandler {
+    gateway;
+    now;
+    pendingDenialMaxAgeMs;
+    name = "assembly_handler";
+    pendingDenials = new Map();
+    constructor(gateway, now = () => Date.now(), pendingDenialMaxAgeMs = 5 * 60 * 1000) {
+        super();
+        this.gateway = gateway;
+        this.now = now;
+        this.pendingDenialMaxAgeMs = pendingDenialMaxAgeMs;
+    }
+    async handleToolStart(tool, input, runId) {
+        this.cleanupExpiredPendingDenials();
+        const toolName = tool.name ?? getSerializedName(tool) ?? "unknown_tool";
+        const decision = await this.gateway.check({
+            action: "tool_call",
+            toolName,
+            args: input,
+            runId
+        });
+        await this.gateway.record({
+            action: "tool_start_check",
+            runId,
+            ...(decision.reason ? { reason: decision.reason } : {})
+        });
+        if (decision.denied) {
+            this.pendingDenials.set(runId, {
+                reason: decision.reason ?? "Tool denied by policy.",
+                at: this.now()
+            });
+        }
+    }
+    async handleToolEnd(output, runId) {
+        this.cleanupExpiredPendingDenials();
+        const pending = this.pendingDenials.get(runId);
+        if (pending) {
+            this.pendingDenials.delete(runId);
+            await this.gateway.record({
+                action: "policy_post_block",
+                runId,
+                reason: pending.reason
+            });
+            return BLOCKED_OUTPUT;
+        }
+        await this.gateway.recordResult({ runId, output });
+        return output;
+    }
+    async handleLLMStart(llm, prompts, runId) {
+        this.cleanupExpiredPendingDenials();
+        const modelName = llm.name ?? getSerializedName(llm);
+        await this.gateway.scanPrompts({
+            prompts,
+            runId,
+            ...(modelName ? { modelName } : {})
+        });
+    }
+    async handleLLMEnd(output, runId) {
+        this.cleanupExpiredPendingDenials();
+        await this.gateway.record({
+            action: "llm_response",
+            runId,
+            output
+        });
+    }
+    cleanupExpiredPendingDenials(now = this.now()) {
+        let removed = 0;
+        for (const [runId, denial] of this.pendingDenials.entries()) {
+            if (now - denial.at >= this.pendingDenialMaxAgeMs) {
+                this.pendingDenials.delete(runId);
+                removed += 1;
+            }
+        }
+        return removed;
+    }
+    // Exposed for deterministic unit testing around cleanup behavior.
+    getPendingDenialCount() {
+        return this.pendingDenials.size;
+    }
+}
+exports.AssemblyCallbackHandler = AssemblyCallbackHandler;

package/dist/cjs/adapters/langchain/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapToolWithAssembly = exports.getRunId = exports.AssemblyCallbackHandler = void 0;
+var assembly_callback_handler_js_1 = require("./assembly-callback-handler.js");
+Object.defineProperty(exports, "AssemblyCallbackHandler", { enumerable: true, get: function () { return assembly_callback_handler_js_1.AssemblyCallbackHandler; } });
+var wrap_tool_with_assembly_js_1 = require("./wrap-tool-with-assembly.js");
+Object.defineProperty(exports, "getRunId", { enumerable: true, get: function () { return wrap_tool_with_assembly_js_1.getRunId; } });
+Object.defineProperty(exports, "wrapToolWithAssembly", { enumerable: true, get: function () { return wrap_tool_with_assembly_js_1.wrapToolWithAssembly; } });

package/dist/cjs/adapters/langchain/wrap-tool-with-assembly.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapToolWithAssembly = wrapToolWithAssembly;
+exports.getRunId = getRunId;
+const node_crypto_1 = require("node:crypto");
+const policy_violation_error_js_1 = require("../../errors/policy-violation-error.js");
+const DEFAULT_APPROVAL_TIMEOUT_MS = 30_000;
+function createRunId() {
+    return `run_${(0, node_crypto_1.randomUUID)()}`;
+}
+async function waitForApprovalWithTimeout(gateway, toolName, runId, timeoutMs) {
+    let timeoutId;
+    const timeoutPromise = new Promise((resolve) => {
+        timeoutId = setTimeout(() => {
+            resolve({ denied: true, reason: `Approval timeout after ${timeoutMs}ms` });
+        }, timeoutMs);
+    });
+    try {
+        const approvalPromise = gateway.waitForApproval(toolName, runId, timeoutMs);
+        return await Promise.race([approvalPromise, timeoutPromise]);
+    }
+    finally {
+        if (timeoutId) {
+            clearTimeout(timeoutId);
+        }
+    }
+}
+function wrapToolWithAssembly(tool, gateway, options = {}) {
+    const originalInvoke = tool.invoke.bind(tool);
+    const generateRunId = options.generateRunId ?? createRunId;
+    const approvalTimeoutMs = options.approvalTimeoutMs ?? DEFAULT_APPROVAL_TIMEOUT_MS;
+    tool.invoke = async (input, config) => {
+        const runId = getRunId(config, generateRunId);
+        const decision = await gateway.check({
+            action: "tool_call",
+            toolName: tool.name,
+            args: input,
+            runId
+        });
+        if (decision.denied) {
+            throw new policy_violation_error_js_1.PolicyViolationError(`Tool '${tool.name}' blocked: ${decision.reason ?? "Denied"}`);
+        }
+        if (decision.pending) {
+            const finalDecision = await waitForApprovalWithTimeout(gateway, tool.name, runId, approvalTimeoutMs);
+            if (finalDecision.denied) {
+                throw new policy_violation_error_js_1.PolicyViolationError(`Approval rejected for '${tool.name}': ${finalDecision.reason ?? "Rejected"}`);
+            }
+        }
+        return originalInvoke(input, config ? { ...config, runId } : { runId });
+    };
+    return tool;
+}
+function getRunId(config, generateRunId) {
+    return config?.runId ?? generateRunId();
+}