@xproof/xproof 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 xProof
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,138 @@
+# xproof
+
+Official TypeScript/JavaScript SDK for the [xProof](https://xproof.app) blockchain certification API — proof and accountability layer for autonomous agents.
+
+## Installation
+
+```bash
+npm install @xproof/xproof
+```
+
+Requires Node.js 18+ (uses native `fetch`).
+
+## Quick Start
+
+```typescript
+import { XProofClient } from "@xproof/xproof";
+
+// 1. Register (zero-friction, no wallet needed)
+const client = await XProofClient.register("my-agent");
+console.log(client.registration?.trial.remaining); // 10 free certs
+
+// 2. Certify a file (hashes locally, sends hash to API)
+const cert = await client.certify("./report.pdf", "my-agent");
+console.log(cert.transactionHash);
+
+// 3. Verify
+const proof = await client.verifyHash(cert.fileHash);
+console.log(proof.id);
+```
+
+Or use an existing API key:
+
+```typescript
+const client = new XProofClient({ apiKey: "pm_your_key" });
+```
+
+## 4W Framework (WHO / WHAT / WHEN / WHY)
+
+Certifications support the 4W accountability framework:
+
+```typescript
+import { XProofClient, hashString } from "@xproof/xproof";
+
+const client = new XProofClient({ apiKey: "pm_your_key" });
+
+const cert = await client.certifyHash(
+  hashString('{"action": "generate_report"}'),
+  "agent-action.json",
+  "research-agent",
+  {
+    who: "erd1abc...or-agent-id",
+    what: hashString("generate_report"),
+    when: new Date().toISOString(),
+    why: hashString("Summarize Q1 earnings"),
+    metadata: { model: "gpt-4", session: "sess-123" },
+  }
+);
+```
+
+## Batch Certification
+
+Certify up to 50 files in a single call:
+
+```typescript
+const result = await client.batchCertify([
+  { fileHash: "abc123...", fileName: "file1.pdf", author: "my-agent" },
+  { fileHash: "def456...", fileName: "file2.pdf" },
+]);
+
+console.log(result.summary.total);   // 2
+console.log(result.summary.created); // 2
+```
+
+## Hash Utilities
+
+```typescript
+import { hashFile, hashBuffer, hashString } from "@xproof/xproof";
+
+const fileHash = await hashFile("./document.pdf");
+const bufferHash = hashBuffer(Buffer.from("hello"));
+const stringHash = hashString("hello world");
+```
+
+## Pricing
+
+```typescript
+const pricing = await client.getPricing();
+console.log(pricing.priceUsd);
+```
+
+## Error Handling
+
+```typescript
+import {
+  XProofError,
+  AuthenticationError,
+  ConflictError,
+  RateLimitError,
+} from "@xproof/xproof";
+
+try {
+  await client.certifyHash(hash, name, author);
+} catch (err) {
+  if (err instanceof ConflictError) {
+    console.log("Already certified:", err.certificationId);
+  } else if (err instanceof RateLimitError) {
+    console.log("Slow down, retry later");
+  } else if (err instanceof AuthenticationError) {
+    console.log("Check your API key");
+  }
+}
+```
+
+## API Reference
+
+### `new XProofClient(options?)`
+
+| Option    | Type     | Default                 |
+|-----------|----------|-------------------------|
+| `apiKey`  | `string` | `""`                    |
+| `baseUrl` | `string` | `"https://xproof.app"`  |
+| `timeout` | `number` | `30000` (ms)            |
+
+### Methods
+
+| Method | Description |
+|--------|-------------|
+| `XProofClient.register(agentName)` | Register agent, get trial key |
+| `certify(path, author, fileName?, fourW?)` | Certify file (hashes locally) |
+| `certifyHash(hash, name, author, fourW?)` | Certify by pre-computed hash |
+| `batchCertify(files)` | Batch certify (up to 50) |
+| `verify(proofId)` | Look up by proof ID |
+| `verifyHash(fileHash)` | Look up by file hash |
+| `getPricing()` | Get current pricing |
+
+## License
+
+MIT

package/dist/client-DOH3QHZm.d.mts

@@ -0,0 +1,93 @@
+interface Certification {
+    id: string;
+    fileName: string;
+    fileHash: string;
+    transactionHash: string;
+    transactionUrl: string;
+    createdAt: string;
+    authorName: string;
+    blockchainStatus: string;
+    isPublic: boolean;
+    certificateUrl: string;
+    verifyUrl: string;
+}
+interface BatchResultSummary {
+    total: number;
+    created: number;
+    existing: number;
+    certified: number;
+    failed: number;
+}
+interface BatchResult {
+    batchId: string;
+    results: Certification[];
+    summary: BatchResultSummary;
+}
+interface PricingTier {
+    minCertifications: number;
+    maxCertifications: number | null;
+    priceUsd: number;
+}
+interface PricingInfo {
+    protocol: string;
+    version: string;
+    priceUsd: number;
+    tiers: PricingTier[];
+    paymentMethods: Array<Record<string, string>>;
+    raw: Record<string, unknown>;
+}
+interface TrialInfo {
+    quota: number;
+    used: number;
+    remaining: number;
+}
+interface RegistrationResult {
+    apiKey: string;
+    agentName: string;
+    trial: TrialInfo;
+    endpoints: Record<string, string>;
+    raw: Record<string, unknown>;
+}
+interface FourWOptions {
+    who?: string;
+    what?: string;
+    when?: string;
+    why?: string;
+    metadata?: Record<string, unknown>;
+}
+interface CertifyHashOptions extends FourWOptions {
+    fileHash: string;
+    fileName: string;
+    author: string;
+}
+interface BatchFileEntry {
+    fileHash: string;
+    fileName?: string;
+    author?: string;
+    metadata?: Record<string, unknown>;
+}
+interface XProofClientOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+}
+
+declare class XProofClient {
+    private apiKey;
+    private baseUrl;
+    private timeout;
+    registration: RegistrationResult | null;
+    constructor(options?: XProofClientOptions);
+    static register(agentName: string, options?: Omit<XProofClientOptions, "apiKey">): Promise<XProofClient>;
+    certify(path: string, author: string, fileName?: string, fourW?: FourWOptions): Promise<Certification>;
+    certifyHash(fileHash: string, fileName: string, author: string, fourW?: FourWOptions): Promise<Certification>;
+    batchCertify(files: BatchFileEntry[]): Promise<BatchResult>;
+    verify(proofId: string): Promise<Certification>;
+    verifyHash(fileHash: string): Promise<Certification>;
+    getPricing(): Promise<PricingInfo>;
+    private requireAuth;
+    private request;
+    private handleError;
+}
+
+export { type BatchFileEntry as B, type Certification as C, type FourWOptions as F, type PricingInfo as P, type RegistrationResult as R, type TrialInfo as T, XProofClient as X, type BatchResult as a, type BatchResultSummary as b, type CertifyHashOptions as c, type PricingTier as d, type XProofClientOptions as e };

package/dist/client-DOH3QHZm.d.ts

@@ -0,0 +1,93 @@
+interface Certification {
+    id: string;
+    fileName: string;
+    fileHash: string;
+    transactionHash: string;
+    transactionUrl: string;
+    createdAt: string;
+    authorName: string;
+    blockchainStatus: string;
+    isPublic: boolean;
+    certificateUrl: string;
+    verifyUrl: string;
+}
+interface BatchResultSummary {
+    total: number;
+    created: number;
+    existing: number;
+    certified: number;
+    failed: number;
+}
+interface BatchResult {
+    batchId: string;
+    results: Certification[];
+    summary: BatchResultSummary;
+}
+interface PricingTier {
+    minCertifications: number;
+    maxCertifications: number | null;
+    priceUsd: number;
+}
+interface PricingInfo {
+    protocol: string;
+    version: string;
+    priceUsd: number;
+    tiers: PricingTier[];
+    paymentMethods: Array<Record<string, string>>;
+    raw: Record<string, unknown>;
+}
+interface TrialInfo {
+    quota: number;
+    used: number;
+    remaining: number;
+}
+interface RegistrationResult {
+    apiKey: string;
+    agentName: string;
+    trial: TrialInfo;
+    endpoints: Record<string, string>;
+    raw: Record<string, unknown>;
+}
+interface FourWOptions {
+    who?: string;
+    what?: string;
+    when?: string;
+    why?: string;
+    metadata?: Record<string, unknown>;
+}
+interface CertifyHashOptions extends FourWOptions {
+    fileHash: string;
+    fileName: string;
+    author: string;
+}
+interface BatchFileEntry {
+    fileHash: string;
+    fileName?: string;
+    author?: string;
+    metadata?: Record<string, unknown>;
+}
+interface XProofClientOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+}
+
+declare class XProofClient {
+    private apiKey;
+    private baseUrl;
+    private timeout;
+    registration: RegistrationResult | null;
+    constructor(options?: XProofClientOptions);
+    static register(agentName: string, options?: Omit<XProofClientOptions, "apiKey">): Promise<XProofClient>;
+    certify(path: string, author: string, fileName?: string, fourW?: FourWOptions): Promise<Certification>;
+    certifyHash(fileHash: string, fileName: string, author: string, fourW?: FourWOptions): Promise<Certification>;
+    batchCertify(files: BatchFileEntry[]): Promise<BatchResult>;
+    verify(proofId: string): Promise<Certification>;
+    verifyHash(fileHash: string): Promise<Certification>;
+    getPricing(): Promise<PricingInfo>;
+    private requireAuth;
+    private request;
+    private handleError;
+}
+
+export { type BatchFileEntry as B, type Certification as C, type FourWOptions as F, type PricingInfo as P, type RegistrationResult as R, type TrialInfo as T, XProofClient as X, type BatchResult as a, type BatchResultSummary as b, type CertifyHashOptions as c, type PricingTier as d, type XProofClientOptions as e };

package/dist/index.d.mts

@@ -0,0 +1,32 @@
+export { B as BatchFileEntry, a as BatchResult, b as BatchResultSummary, C as Certification, c as CertifyHashOptions, F as FourWOptions, P as PricingInfo, d as PricingTier, R as RegistrationResult, T as TrialInfo, X as XProofClient, e as XProofClientOptions } from './client-DOH3QHZm.mjs';
+
+declare class XProofError extends Error {
+    statusCode: number;
+    response: Record<string, unknown> | null;
+    constructor(message: string, statusCode?: number, response?: Record<string, unknown> | null);
+}
+declare class AuthenticationError extends XProofError {
+    constructor(message?: string, response?: Record<string, unknown> | null);
+}
+declare class ValidationError extends XProofError {
+    constructor(message?: string, response?: Record<string, unknown> | null);
+}
+declare class NotFoundError extends XProofError {
+    constructor(message?: string, response?: Record<string, unknown> | null);
+}
+declare class ConflictError extends XProofError {
+    certificationId: string;
+    constructor(message?: string, certificationId?: string, response?: Record<string, unknown> | null);
+}
+declare class RateLimitError extends XProofError {
+    constructor(message?: string, response?: Record<string, unknown> | null);
+}
+declare class ServerError extends XProofError {
+    constructor(message?: string, statusCode?: number, response?: Record<string, unknown> | null);
+}
+
+declare function hashFile(path: string): Promise<string>;
+declare function hashBuffer(data: Buffer | Uint8Array): string;
+declare function hashString(data: string): string;
+
+export { AuthenticationError, ConflictError, NotFoundError, RateLimitError, ServerError, ValidationError, XProofError, hashBuffer, hashFile, hashString };

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+export { B as BatchFileEntry, a as BatchResult, b as BatchResultSummary, C as Certification, c as CertifyHashOptions, F as FourWOptions, P as PricingInfo, d as PricingTier, R as RegistrationResult, T as TrialInfo, X as XProofClient, e as XProofClientOptions } from './client-DOH3QHZm.js';
+
+declare class XProofError extends Error {
+    statusCode: number;
+    response: Record<string, unknown> | null;
+    constructor(message: string, statusCode?: number, response?: Record<string, unknown> | null);
+}
+declare class AuthenticationError extends XProofError {
+    constructor(message?: string, response?: Record<string, unknown> | null);
+}
+declare class ValidationError extends XProofError {
+    constructor(message?: string, response?: Record<string, unknown> | null);
+}
+declare class NotFoundError extends XProofError {
+    constructor(message?: string, response?: Record<string, unknown> | null);
+}
+declare class ConflictError extends XProofError {
+    certificationId: string;
+    constructor(message?: string, certificationId?: string, response?: Record<string, unknown> | null);
+}
+declare class RateLimitError extends XProofError {
+    constructor(message?: string, response?: Record<string, unknown> | null);
+}
+declare class ServerError extends XProofError {
+    constructor(message?: string, statusCode?: number, response?: Record<string, unknown> | null);
+}
+
+declare function hashFile(path: string): Promise<string>;
+declare function hashBuffer(data: Buffer | Uint8Array): string;
+declare function hashString(data: string): string;
+
+export { AuthenticationError, ConflictError, NotFoundError, RateLimitError, ServerError, ValidationError, XProofError, hashBuffer, hashFile, hashString };