@vixor/contracts 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,37 @@
-# Temporary Holding Version
-
-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.
+# @vixor/contracts
+
+Zero-runtime-dependency TypeScript contracts for VIXOR integration boundaries.
+
+## Install
+
+```sh
+npm install @vixor/contracts
+```
+
+## Runtime
+
+Node.js 20 or newer is supported. The published package contains compiled
+ES modules and TypeScript declaration files under `dist/`; consumers do not
+need a TypeScript runtime loader.
+
+## Example
+
+```ts
+import { validateEnvelope, validateOpportunityPayload, fixtureEnvelope } from "@vixor/contracts";
+
+const result = validateEnvelope(fixtureEnvelope(), validateOpportunityPayload);
+if (!result.ok) throw new Error(result.errors.join("; "));
+```
+
+Package SemVer (currently 0.2.0) is independent of the wire `SCHEMA_VERSION`
+(currently `0.1`). Consumers must validate the wire schema version independently.
+
+This package validates VIXOR event envelopes, opportunity payloads, Shield risk
+assessments, and publication candidates. It does not authenticate requests,
+verify HMAC signatures, authorize channels, or replace persistence/idempotency.
+
+## License
+
+The package is published with `UNLICENSED` metadata. Public npm visibility makes
+the artifact downloadable; it does not grant third-party rights to reuse or
+redistribute the code. Obtain separate written permission before external reuse.

package/package.json

@@ -1,6 +1,42 @@
-{
-  "name": "@vixor/contracts",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@vixor/contracts",
+  "version": "0.2.0",
+  "description": "Zero-dependency runtime contracts and validators for VIXOR crypto-intelligence integrations.",
+  "license": "UNLICENSED",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "node --experimental-strip-types --test test/contracts.test.ts",
+    "pack:check": "node scripts/verify-pack.mjs"
+  },
+  "devDependencies": {
+    "@types/node": "^22.16.5",
+    "typescript": "^5.8.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kam65624-cmd/vixor-packages.git",
+    "directory": "packages/vixor-contracts"
+  }
+}