@intentrax/sdk 1.0.0

package/LICENSE

@@ -0,0 +1,185 @@
+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.
+
+"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. Do not 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 2026 Intentrax
+
+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/README.md

@@ -0,0 +1,148 @@
+# TypeScript / Node.js SDK
+
+First-wave SDK lane for AI apps, MCP clients, SaaS products, browser-adjacent
+tooling, and Node.js service integrations.
+
+This package must consume shared Intentrax specs and conformance vectors from
+`../shared-specs` and `../conformance`. It must not redefine EEO, AEP,
+canonical serialization, proof verification, policy decisions, or tier
+enforcement.
+
+Public surfaces:
+- `@intentrax/sdk` for deterministic canonicalization and verification envelopes
+- `@intentrax/sdk/http` for explicit HTTP API-wrapper execution
+- `intentrax init <adapter>` for local developer adapter onboarding
+- `intentrax check-init --output-dir <dir>` for offline adapter init verification
+- `intentrax verify-proof <proof-export.json>` for local proof export hash and
+  boundary verification
+- `intentrax verify-pdf-receipt <receipt.pdf>` for local downloaded PDF receipt
+  byte/hash verification
+
+The published package exports Node-runnable `.js` modules with `.d.ts` type
+declarations and is gated on Node 20 and Node 24.
+
+One-command adapter onboarding:
+
+```bash
+npx @intentrax/sdk init claude-code --dry-run
+npx @intentrax/sdk init cursor
+npx @intentrax/sdk init mcp
+npx @intentrax/sdk init langchain
+npx @intentrax/sdk init langgraph
+npx @intentrax/sdk init vercel-ai-sdk
+npx @intentrax/sdk init cursor --force
+npx @intentrax/sdk check-init --output-dir .
+```
+
+The MVP-native adapter set is Claude Code, Cursor, MCP, LangChain, LangGraph,
+and Vercel AI SDK. The same command also exposes expanded scaffold aliases for
+Custom Agent, CrewAI, AutoGen, OpenClaw, n8n, and DeepFlow so teams can try the
+admission-only path without changing AEVN/AEP authority or treating those
+aliases as MVP-native hooks.
+
+The init command creates `.intentrax/agent-adapter.json`,
+`.intentrax/sample-admission-request.json`, `.intentrax/action-receipt.json`,
+`.intentrax/submit_sample.curl`, and
+`.intentrax/hooks/<adapter-native-hook>.mjs`, plus
+`.intentrax/wiring/<adapter-host-wiring>.md`, when not run with `--dry-run`. It
+does not store API keys, signing keys, or tenant secrets. The sample admission
+request uses the locked private-alpha Agent Gateway refs and an allowed
+contract-only action for the selected adapter surface.
+
+The command is safe to rerun when generated files are unchanged. If an existing
+`.intentrax` file has local edits, `intentrax init` fails closed before writing
+anything; pass `--force` only after reviewing the local changes you intend to
+replace.
+
+The generated hook starter builds a fresh admission request for the local
+adapter event, drops auth-like fields before hashing, and fails closed when a
+submitted admission is denied or unavailable. It still does not execute tools,
+mutate payloads, re-run policy, or generate proofs inside the adapter.
+
+The generated host wiring guide shows where to import the hook starter in the
+selected host surface and is hash-bound into both `.intentrax/agent-adapter.json`
+and `.intentrax/action-receipt.json`. It is developer setup guidance only, not
+canonical evidence or production authorization.
+
+After writing files, the CLI prints a no-secret `curl` command that submits the
+sample with `X-Intentrax-Tenant-ID`, `X-Intentrax-Api-Key`, and
+`X-Intentrax-Idempotency-Key`. Set `INTENTRAX_API_KEY` from your secret manager
+before running it.
+
+`.intentrax/action-receipt.json` is a hash-bound developer summary for the
+generated sample. It links the adapter profile, admission envelope, hook
+starter, host wiring guide, submit command, and future AEVN/AEP proof export or
+registry reference path. It is not canonical proof and does not authorize
+production traffic.
+
+Offline init verification:
+
+```bash
+npx @intentrax/sdk check-init --output-dir . --json
+```
+
+`check-init` verifies the initialized `.intentrax` directory without
+`INTENTRAX_API_KEY`, runtime access, or network submission. It checks the
+expected files, validates the Agent Gateway sample fixture through the SDK
+admission semantics, recomputes the action receipt, generated hook source, and
+host wiring guide hash bindings, and imports the generated hook in no-submit
+mode with a
+secret-bearing fixture to confirm the starter does not leak secrets or require
+network access. Human output is a concise pass/fail line; `--json` emits the
+deterministic status, boundary assertions, file hashes, and errors.
+
+Expanded scaffold aliases:
+
+```bash
+npx @intentrax/sdk init custom-agent
+npx @intentrax/sdk init crewai
+npx @intentrax/sdk init autogen
+npx @intentrax/sdk init openclaw
+npx @intentrax/sdk init n8n
+npx @intentrax/sdk init deepflow
+```
+
+Local proof export verification:
+
+```bash
+npx @intentrax/sdk verify-proof \
+  .intentrax-runtime/pilot-local-sovereign/local-sovereign-proof-export.json \
+  --report-out .intentrax/offline-proof-verification.report.json
+```
+
+`verify-proof` reads a registry-backed proof lookup JSON export, recomputes the
+proof lookup hash, proof record hash, and verification bundle hash, rejects
+private key material markers, and writes a deterministic local verification
+report. It does not require the runtime server, network access, or private keys.
+The JSON proof export remains authoritative. Downloaded PDF receipts are
+human-readable companions and should be checked against their exported hash
+metadata, not treated as replacement proof material.
+
+Local PDF receipt verification:
+
+```bash
+npx @intentrax/sdk verify-pdf-receipt \
+  .intentrax/proof-001-aep-receipt.pdf \
+  --pdf-hash "$X_INTENTRAX_PDF_HASH" \
+  --report-out .intentrax/pdf-receipt-verification.report.json
+```
+
+`verify-pdf-receipt` reads downloaded PDF bytes, checks the `%PDF-` header,
+recomputes SHA-256, and compares it with the runtime `X-Intentrax-PDF-Hash`
+header. It validates only the human-readable PDF companion. The canonical JSON
+proof export and AEP evidence remain the source of truth.
+
+Programmatic receipt and export helpers:
+
+```js
+import {
+  buildProofExportHttpRequest,
+  buildReceiptVerificationHttpRequest,
+} from "@intentrax/sdk/http";
+```
+
+`buildReceiptVerificationHttpRequest` builds the runtime/OpenAPI receipt
+verification request for `POST /v1/proofs/verify`. `buildProofExportHttpRequest`
+builds `GET /v1/proofs/{proof_id}/export?format=json|aep-json|pdf`; JSON and
+AEP JSON are authoritative proof exports, while PDF is a deterministic
+human-readable receipt.