@333eco/heartbank-api 0.0.0-stage → 0.2.0

package/dist/verify.d.ts

@@ -0,0 +1,58 @@
+import { type ClientOptions } from "./runtime.js";
+/** Verify: Check anything we say, from the public logs, free forever, with no account and no key. */
+export declare class VerifyClient {
+    private readonly o;
+    constructor(o?: ClientOptions);
+    /** The latest signed checkpoint: the log's size and root. @see https://developers.333.eco/verify#checkpoint */
+    checkpoint(input?: {
+        log?: "origin" | "ledger";
+    }): Promise<string>;
+    /** Every earlier checkpoint, locked (written once, never replaced). @see https://developers.333.eco/verify#checkpointat */
+    checkpointAt(input: {
+        log?: "origin" | "ledger";
+        size: number;
+    }): Promise<string>;
+    /** A tile of the Merkle tree. @see https://developers.333.eco/verify#tile */
+    tile(input: {
+        log?: "origin" | "ledger";
+        level: number;
+        index: string;
+    }): Promise<Uint8Array>;
+    /** A bundle of the log's entries. @see https://developers.333.eco/verify#entries */
+    entries(input: {
+        log?: "origin" | "ledger";
+        index: string;
+    }): Promise<Uint8Array>;
+    /** Which checkpoints carry which clock. @see https://developers.333.eco/verify#stampsindex */
+    stampsIndex(input?: {
+        log?: "origin" | "ledger";
+    }): Promise<{
+        tsa: Array<number>;
+        ots: Array<number>;
+    }>;
+    /** A timestamp authority's token (RFC 3161) over a checkpoint. @see https://developers.333.eco/verify#timestamptoken */
+    timestampToken(input: {
+        log?: "origin" | "ledger";
+        size: number;
+        authority: "aped-gr" | "accv-es" | "freetsa-de";
+    }): Promise<Uint8Array>;
+    /** An OpenTimestamps proof over a checkpoint, reaching Bitcoin. @see https://developers.333.eco/verify#bitcoinproof */
+    bitcoinProof(input: {
+        log?: "origin" | "ledger";
+        size: number;
+    }): Promise<Uint8Array>;
+    /** The ledger only: the zero-sum proof over entries from…to. @see https://developers.333.eco/verify#zerosumproof */
+    zeroSumProof(input: {
+        from: number;
+        to: number;
+    }): Promise<{
+        v: number;
+        from: number;
+        to: number;
+        genesis: string;
+        origin?: string;
+        circuit: string;
+        K: number;
+        windows: Array<Record<string, unknown>>;
+    }>;
+}

package/dist/verify.js

@@ -0,0 +1,113 @@
+// Generated by scripts/gen-client.mjs from openapi/verify.json. ⛔ Do not edit: change the description and run npm run client.
+import { send } from "./runtime.js";
+/** Verify: Check anything we say, from the public logs, free forever, with no account and no key. */
+export class VerifyClient {
+    o;
+    constructor(o = {}) {
+        this.o = o;
+    }
+    /** The latest signed checkpoint: the log's size and root. @see https://developers.333.eco/verify#checkpoint */
+    checkpoint(input) {
+        return send(this.o, {
+            method: "GET",
+            base: "https://log.333.eco/{log}".replace(/\{(\w+)\}/g, (_, k) => String({ log: input?.log ?? "origin" }[k])),
+            path: "/checkpoint",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            security: "none",
+            accept: "text",
+        });
+    }
+    /** Every earlier checkpoint, locked (written once, never replaced). @see https://developers.333.eco/verify#checkpointat */
+    checkpointAt(input) {
+        return send(this.o, {
+            method: "GET",
+            base: "https://log.333.eco/{log}".replace(/\{(\w+)\}/g, (_, k) => String({ log: input?.log ?? "origin" }[k])),
+            path: "/checkpoints/{size}",
+            pathParams: { size: input.size },
+            query: undefined,
+            headers: undefined,
+            security: "none",
+            accept: "text",
+        });
+    }
+    /** A tile of the Merkle tree. @see https://developers.333.eco/verify#tile */
+    tile(input) {
+        return send(this.o, {
+            method: "GET",
+            base: "https://log.333.eco/{log}".replace(/\{(\w+)\}/g, (_, k) => String({ log: input?.log ?? "origin" }[k])),
+            path: "/tile/{level}/{index}",
+            pathParams: { level: input.level, index: input.index },
+            query: undefined,
+            headers: undefined,
+            security: "none",
+            accept: "bytes",
+        });
+    }
+    /** A bundle of the log's entries. @see https://developers.333.eco/verify#entries */
+    entries(input) {
+        return send(this.o, {
+            method: "GET",
+            base: "https://log.333.eco/{log}".replace(/\{(\w+)\}/g, (_, k) => String({ log: input?.log ?? "origin" }[k])),
+            path: "/tile/entries/{index}",
+            pathParams: { index: input.index },
+            query: undefined,
+            headers: undefined,
+            security: "none",
+            accept: "bytes",
+        });
+    }
+    /** Which checkpoints carry which clock. @see https://developers.333.eco/verify#stampsindex */
+    stampsIndex(input) {
+        return send(this.o, {
+            method: "GET",
+            base: "https://log.333.eco/{log}".replace(/\{(\w+)\}/g, (_, k) => String({ log: input?.log ?? "origin" }[k])),
+            path: "/stamps/index.json",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            security: "none",
+            accept: "json",
+        });
+    }
+    /** A timestamp authority's token (RFC 3161) over a checkpoint. @see https://developers.333.eco/verify#timestamptoken */
+    timestampToken(input) {
+        return send(this.o, {
+            method: "GET",
+            base: "https://log.333.eco/{log}".replace(/\{(\w+)\}/g, (_, k) => String({ log: input?.log ?? "origin" }[k])),
+            path: "/stamps/{size}.{authority}.tsr",
+            pathParams: { size: input.size, authority: input.authority },
+            query: undefined,
+            headers: undefined,
+            security: "none",
+            accept: "bytes",
+        });
+    }
+    /** An OpenTimestamps proof over a checkpoint, reaching Bitcoin. @see https://developers.333.eco/verify#bitcoinproof */
+    bitcoinProof(input) {
+        return send(this.o, {
+            method: "GET",
+            base: "https://log.333.eco/{log}".replace(/\{(\w+)\}/g, (_, k) => String({ log: input?.log ?? "origin" }[k])),
+            path: "/stamps/{size}.ots",
+            pathParams: { size: input.size },
+            query: undefined,
+            headers: undefined,
+            security: "none",
+            accept: "bytes",
+        });
+    }
+    /** The ledger only: the zero-sum proof over entries from…to. @see https://developers.333.eco/verify#zerosumproof */
+    zeroSumProof(input) {
+        return send(this.o, {
+            method: "GET",
+            base: "https://log.333.eco/ledger",
+            path: "/proof/{from}-{to}.json",
+            pathParams: { from: input.from, to: input.to },
+            query: undefined,
+            headers: undefined,
+            security: "none",
+            accept: "json",
+        });
+    }
+}

package/package.json

@@ -1,6 +1,28 @@
 {
   "name": "@333eco/heartbank-api",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "The typed client for every HeartBank® API (Log in, Sign, Confirm and Thank with HeartBank®, Lookup and Verify), generated from developers.333.eco's OpenAPI descriptions. For your server: it never holds a key.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "LICENSE-CC0",
+    "LICENSE-APACHE"
+  ],
+  "x-publishing": "Name and license approved by the founder 2026-11-11 (\"CC0-1.0 OR Apache-2.0\": each user picks one). The first publish: approved the same day.",
+  "license": "CC0-1.0 OR Apache-2.0",
+  "engines": {
+    "node": ">=18"
+  },
+  "homepage": "https://developers.333.eco",
+  "keywords": [
+    "heartbank",
+    "passkey",
+    "openid-connect",
+    "provenance",
+    "gratitude"
+  ]
+}