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

package/LICENSE

@@ -0,0 +1,7 @@
+@333eco/heartbank-api is offered under your choice of two licenses (SPDX: CC0-1.0 OR Apache-2.0):
+
+  - CC0 1.0 Universal (public domain dedication): see LICENSE-CC0
+  - Apache License 2.0: see LICENSE-APACHE
+
+Pick whichever suits you; you need follow only the one you pick. Neither grants any right in the HeartBank® or other
+trademarks, which are not licensed here.

package/LICENSE-APACHE

@@ -0,0 +1,73 @@
+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
+
+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. (Don't 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 [yyyy] [name of copyright owner]
+
+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/LICENSE-CC0

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

package/README.md

@@ -1,3 +1,53 @@
-# Temporary Holding Version
+# @333eco/heartbank-api
 
-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.
+The typed client for every HeartBank® API: **Log in with HeartBank®**, **Sign with HeartBank®**, **Thank with HeartBank®**, **Lookup** and **Verify**. Generated from the APIs' own OpenAPI descriptions, so it cannot drift from them.
+
+```sh
+npm install @333eco/heartbank-api
+```
+
+**It is for your server, and it never holds a key.** Your server signs; the client asks it to. A key inside an app is not a secret, so never ship one there.
+
+## Read the public logs (free, no account)
+
+```js
+import { VerifyClient, LookupClient } from "@333eco/heartbank-api";
+
+const verify = new VerifyClient();
+const checkpoint = await verify.checkpoint({ log: "ledger" });      // the signed checkpoint, as text
+const proof = await verify.zeroSumProof({ from: 0, to: 512 });     // the zero-sum proof for those entries
+
+const name = await new LookupClient().byName({ name: "@thon" });   // what that person's public page shows
+```
+
+A name nobody holds, a name held with no page, and a name let go all answer the same `404 not_found`. Lookup never returns an identity, never the other way round, and never a list.
+
+## Calls that need your app's key
+
+Pass functions, never keys:
+
+```js
+import { ThankClient, LoginClient, ApiError } from "@333eco/heartbank-api";
+
+const thank = new ThankClient({
+  assertion: async (aud) => signClientAssertion(aud), // a fresh ES256 JWT: iss = sub = your client id, aud as given, one-use jti
+});
+const ticket = await thank.prepare({ body: { ref, pidToken, sub, ledger: "kiitos", to } });
+if ("ticket" in ticket) {
+  // send the person to https://sign.333.eco/press with the ticket; they press their own passkey
+}
+```
+
+- **An agent can do everything except the press.** Every thank and every signature needs the person's own passkey.
+- **A refusal from Thank says nothing**: `{ written: false }`, with no reason and no count. It protects the people involved; it is not a bug.
+- Log in authenticates; Sign attests. A log-in session can never sign.
+- The browser steps are links the client builds, never calls: `LoginClient#authorizeUrl`, `LoginClient#logOutUrl`, `SignClient#signPageUrl`.
+- Any answer outside 2xx throws an `ApiError` with the service's own `error` and `why`.
+
+## Docs
+
+The full docs open at developers.333.eco. Until then, this README and the types are the docs; every method links the page it will live on.
+
+## License
+
+Your choice of **CC0-1.0** or **Apache-2.0** (see `LICENSE`). Neither grants any right in the HeartBank® or other trademarks.

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export { ApiError, type ClientOptions } from "./runtime.js";
+export { LoginClient } from "./login.js";
+export * as login from "./login.js";
+export { SignClient } from "./sign.js";
+export * as sign from "./sign.js";
+export { ThankClient } from "./thank.js";
+export * as thank from "./thank.js";
+export { LookupClient } from "./lookup.js";
+export * as lookup from "./lookup.js";
+export { VerifyClient } from "./verify.js";
+export * as verify from "./verify.js";

package/dist/index.js

@@ -0,0 +1,12 @@
+// Generated by scripts/gen-client.mjs. ⛔ Do not edit.
+export { ApiError } from "./runtime.js";
+export { LoginClient } from "./login.js";
+export * as login from "./login.js";
+export { SignClient } from "./sign.js";
+export * as sign from "./sign.js";
+export { ThankClient } from "./thank.js";
+export * as thank from "./thank.js";
+export { LookupClient } from "./lookup.js";
+export * as lookup from "./lookup.js";
+export { VerifyClient } from "./verify.js";
+export * as verify from "./verify.js";

package/dist/login.d.ts

@@ -0,0 +1,113 @@
+import { type ClientOptions } from "./runtime.js";
+export type ErrorBody = {
+    error: string;
+    error_description?: string;
+};
+export type Claims = {
+    /** Pairwise: this person's ID in YOUR app only. */ sub?: string;
+    /** How they logged in, for example a passkey with the user verified. */ amr?: Array<string>;
+    locale?: "en" | "km";
+    /** Scope `poh`: the verified-human layers this person has, when they choose to show them. */ poh?: Array<string>;
+    poh_updated_at?: number;
+    /** Scope `ledger`: the person's token for Thank with HeartBank®, opaque to your app. */ pid_token?: string;
+};
+/** Log in with HeartBank®: Prove who someone is, with a passkey. OpenID Connect on the FAPI 2.0 profile. */
+export declare class LoginClient {
+    private readonly o;
+    constructor(o?: ClientOptions);
+    /** The discovery document: every endpoint, scope and algorithm. @see https://developers.333.eco/log-in#discovery */
+    discovery(): Promise<Record<string, unknown>>;
+    /** The keys login signs ID tokens with. @see https://developers.333.eco/log-in#jwks */
+    jwks(): Promise<Record<string, unknown>>;
+    /** Push the log-in request (PAR, required). @see https://developers.333.eco/log-in#pushauthorizationrequest */
+    pushAuthorizationRequest(input: {
+        body: Omit<{
+            client_id: string;
+            client_assertion_type: string;
+            client_assertion: string;
+            response_type: "code";
+            /** `openid`, plus `poh` or `ledger` if your app was approved for them. */ scope: string;
+            redirect_uri: string;
+            state: string;
+            nonce: string;
+            code_challenge: string;
+            code_challenge_method: "S256";
+            max_age?: number;
+            ui_locales?: "en" | "km";
+        }, "client_assertion_type" | "client_assertion">;
+    }): Promise<{
+        request_uri: string;
+        expires_in: number;
+    }>;
+    /** Send the browser here (one tap from where the person is). @see https://developers.333.eco/log-in#authorize */
+    authorizeUrl(input: {
+        client_id: string;
+        request_uri: string;
+    }): string;
+    /** Exchange the code. @see https://developers.333.eco/log-in#token */
+    token(input: {
+        body: Omit<{
+            grant_type: "authorization_code";
+            code: string;
+            redirect_uri: string;
+            code_verifier: string;
+            client_assertion_type: string;
+            client_assertion: string;
+        }, "client_assertion_type" | "client_assertion">;
+    }): Promise<{
+        access_token: string;
+        token_type: "DPoP";
+        /** ES256; check `iss`, `aud`, `nonce`, `auth_time` (for a fresh log-in, on your server). */ id_token: string;
+        expires_in?: number;
+    }>;
+    /** The person's claims. @see https://developers.333.eco/log-in#userinfo */
+    userinfo(input: {
+        /** The access token from token(). */ accessToken: string;
+    }): Promise<Claims>;
+    /** Revoke a token. @see https://developers.333.eco/log-in#revoke */
+    revoke(input: {
+        body: {
+            token: string;
+        };
+    }): Promise<void>;
+    /** Log out of HeartBank® too. @see https://developers.333.eco/log-in#logout */
+    logOutUrl(input: {
+        client_id: string;
+        post_logout_redirect_uri: string;
+    }): string;
+    /** Is this browser logged in at HeartBank®? (display only). @see https://developers.333.eco/log-in#sessionstate */
+    sessionState(): Promise<{
+        loggedIn: boolean;
+    }>;
+    /** Announce a security change before making it. @see https://developers.333.eco/log-in#notice */
+    notice(input: {
+        body: Omit<{
+            client_assertion_type: string;
+            client_assertion: string;
+            sub: string;
+            /** `rails`: the person's ways to receive money changed. */ kind: "rails";
+            lang?: "en" | "km";
+        }, "client_assertion_type" | "client_assertion">;
+    }): Promise<{
+        ok?: true;
+    }>;
+    /** Read a person's verified-human layers again. @see https://developers.333.eco/log-in#verifiedhuman */
+    verifiedHuman(input: {
+        body: Omit<{
+            client_assertion_type: string;
+            client_assertion: string;
+            sub: string;
+        }, "client_assertion_type" | "client_assertion">;
+    }): Promise<{
+        poh?: Array<string>;
+        poh_updated_at: number;
+    }>;
+    /** Thank with HeartBank®: exchange a press for a pressToken. @see https://developers.333.eco/log-in#wrappress */
+    wrapPress(input: {
+        body: {
+            result: string;
+        };
+    }): Promise<{
+        pressToken: string;
+    }>;
+}

package/dist/login.js

@@ -0,0 +1,165 @@
+// Generated by scripts/gen-client.mjs from openapi/login.json. ⛔ Do not edit: change the description and run npm run client.
+import { send, urlOf } from "./runtime.js";
+/** Log in with HeartBank®: Prove who someone is, with a passkey. OpenID Connect on the FAPI 2.0 profile. */
+export class LoginClient {
+    o;
+    constructor(o = {}) {
+        this.o = o;
+    }
+    /** The discovery document: every endpoint, scope and algorithm. @see https://developers.333.eco/log-in#discovery */
+    discovery() {
+        return send(this.o, {
+            method: "GET",
+            base: "https://login.333.eco",
+            path: "/.well-known/openid-configuration",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            security: "none",
+            accept: "json",
+        });
+    }
+    /** The keys login signs ID tokens with. @see https://developers.333.eco/log-in#jwks */
+    jwks() {
+        return send(this.o, {
+            method: "GET",
+            base: "https://login.333.eco",
+            path: "/.well-known/jwks.json",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            security: "none",
+            accept: "json",
+        });
+    }
+    /** Push the log-in request (PAR, required). @see https://developers.333.eco/log-in#pushauthorizationrequest */
+    pushAuthorizationRequest(input) {
+        return send(this.o, {
+            method: "POST",
+            base: "https://login.333.eco",
+            path: "/request",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            body: input.body,
+            contentType: "application/x-www-form-urlencoded",
+            security: "privateKeyJwt",
+            audience: "endpoint",
+            accept: "json",
+        });
+    }
+    /** Send the browser here (one tap from where the person is). @see https://developers.333.eco/log-in#authorize */
+    authorizeUrl(input) {
+        return urlOf(this.o.baseUrl ?? "https://login.333.eco", "/auth", undefined, { client_id: input.client_id, request_uri: input.request_uri });
+    }
+    /** Exchange the code. @see https://developers.333.eco/log-in#token */
+    token(input) {
+        return send(this.o, {
+            method: "POST",
+            base: "https://login.333.eco",
+            path: "/token",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            body: input.body,
+            contentType: "application/x-www-form-urlencoded",
+            security: "privateKeyJwt+dpop",
+            audience: "endpoint",
+            accept: "json",
+        });
+    }
+    /** The person's claims. @see https://developers.333.eco/log-in#userinfo */
+    userinfo(input) {
+        return send(this.o, {
+            method: "GET",
+            base: "https://login.333.eco",
+            path: "/me",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            security: "dpop",
+            accessToken: input.accessToken,
+            accept: "json",
+        });
+    }
+    /** Revoke a token. @see https://developers.333.eco/log-in#revoke */
+    revoke(input) {
+        return send(this.o, {
+            method: "POST",
+            base: "https://login.333.eco",
+            path: "/token/revocation",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            body: input.body,
+            contentType: "application/x-www-form-urlencoded",
+            security: "privateKeyJwt",
+            audience: "endpoint",
+            accept: "none",
+        });
+    }
+    /** Log out of HeartBank® too. @see https://developers.333.eco/log-in#logout */
+    logOutUrl(input) {
+        return urlOf(this.o.baseUrl ?? "https://login.333.eco", "/session/end", undefined, { client_id: input.client_id, post_logout_redirect_uri: input.post_logout_redirect_uri });
+    }
+    /** Is this browser logged in at HeartBank®? (display only). @see https://developers.333.eco/log-in#sessionstate */
+    sessionState() {
+        return send(this.o, {
+            method: "GET",
+            base: "https://login.333.eco",
+            path: "/session/state",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            security: "none",
+            accept: "json",
+        });
+    }
+    /** Announce a security change before making it. @see https://developers.333.eco/log-in#notice */
+    notice(input) {
+        return send(this.o, {
+            method: "POST",
+            base: "https://login.333.eco",
+            path: "/notice",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            body: input.body,
+            contentType: "application/x-www-form-urlencoded",
+            security: "privateKeyJwt",
+            audience: "endpoint",
+            accept: "json",
+        });
+    }
+    /** Read a person's verified-human layers again. @see https://developers.333.eco/log-in#verifiedhuman */
+    verifiedHuman(input) {
+        return send(this.o, {
+            method: "POST",
+            base: "https://login.333.eco",
+            path: "/poh",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            body: input.body,
+            contentType: "application/x-www-form-urlencoded",
+            security: "privateKeyJwt",
+            audience: "endpoint",
+            accept: "json",
+        });
+    }
+    /** Thank with HeartBank®: exchange a press for a pressToken. @see https://developers.333.eco/log-in#wrappress */
+    wrapPress(input) {
+        return send(this.o, {
+            method: "POST",
+            base: "https://login.333.eco",
+            path: "/press/wrap",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            body: input.body,
+            contentType: "application/x-www-form-urlencoded",
+            security: "none",
+            accept: "json",
+        });
+    }
+}

package/dist/lookup.d.ts

@@ -0,0 +1,23 @@
+import { type ClientOptions } from "./runtime.js";
+export type Name = {
+    /** The name in the form its holder chose, with @ (for example @sokha.keo). */ name: string;
+    /** Their page. */ page: string;
+    /** What they are called, as they wrote it (any script). */ said: string;
+    /** Their one line, or empty. */ line: string;
+    /** Up to three https links they chose. */ links: Array<string>;
+    /** Their photo's address, or null. */ photo: string | null;
+    /** Their own recording of their name, or null. */ voice: string | null;
+    /** Whether they let search engines list their page. */ searchable: boolean;
+};
+export type ErrorBody = {
+    error: string;
+};
+/** Lookup: One exact name on B-Registry℠, and what that person's public page shows. Free, with no key. */
+export declare class LookupClient {
+    private readonly o;
+    constructor(o?: ClientOptions);
+    /** Look up one exact name. @see https://developers.333.eco/lookup#byname */
+    byName(input: {
+        /** The name, with or without @; the registry folds case and punctuation, so sokha.keo, SOKHA-KEO and sokhakeo are one name. */ name: string;
+    }): Promise<Name>;
+}

package/dist/lookup.js

@@ -0,0 +1,22 @@
+// Generated by scripts/gen-client.mjs from openapi/lookup.json. ⛔ Do not edit: change the description and run npm run client.
+import { send } from "./runtime.js";
+/** Lookup: One exact name on B-Registry℠, and what that person's public page shows. Free, with no key. */
+export class LookupClient {
+    o;
+    constructor(o = {}) {
+        this.o = o;
+    }
+    /** Look up one exact name. @see https://developers.333.eco/lookup#byname */
+    byName(input) {
+        return send(this.o, {
+            method: "GET",
+            base: "https://333.eco",
+            path: "/api/v1/names/{name}",
+            pathParams: { name: input.name },
+            query: undefined,
+            headers: undefined,
+            security: "none",
+            accept: "json",
+        });
+    }
+}

package/dist/runtime.d.ts

@@ -0,0 +1,46 @@
+/**
+ * The runtime the generated clients share. It knows HOW to send a request and names no endpoint: every endpoint, field
+ * and type comes from openapi/ through scripts/gen-client.mjs (SPEC §7: no hand-written second copy).
+ *
+ * ⛔ The client never holds a key. Your server signs: `assertion(aud)` returns a fresh ES256 client assertion (one use,
+ * at most five minutes old) and `dpop(method, url, accessToken?)` a DPoP proof. A key inside an app is not a secret, so
+ * this client is for your SERVER; the browser steps (log in, log out, the signing page) are links it builds for you.
+ */
+export interface ClientOptions {
+    /** Replaces the server named in the description (for a test double; the sandbox when it exists). */
+    baseUrl?: string;
+    fetch?: typeof globalThis.fetch;
+    /** A fresh client assertion whose `aud` is the given address (private_key_jwt). */
+    assertion?: (aud: string) => Promise<string>;
+    /** A DPoP proof for this request; `accessToken` is given when the request carries one. */
+    dpop?: (method: string, url: string, accessToken?: string) => Promise<string>;
+    /** A B-Origin℠ API key (it begins `bo_live_`). ⛔ Keep it on your server. */
+    apiKey?: string;
+}
+/** Any answer outside 2xx. `error` and `why` are the service's own words; a refusal from Thank never reaches here (it is `{written: false}`). */
+export declare class ApiError extends Error {
+    status: number;
+    error: string;
+    why?: string | undefined;
+    body?: unknown | undefined;
+    constructor(status: number, error: string, why?: string | undefined, body?: unknown | undefined);
+}
+export type Security = "none" | "clientAssertion" | "privateKeyJwt" | "dpop" | "privateKeyJwt+dpop" | "apiKey";
+export interface Call {
+    method: string;
+    base: string;
+    path: string;
+    pathParams?: Record<string, string | number>;
+    query?: Record<string, string | number | undefined>;
+    headers?: Record<string, string | undefined>;
+    body?: unknown;
+    contentType?: string;
+    security: Security;
+    accessToken?: string;
+    /** The client assertion's `aud`: the server's address, or this endpoint's (each security scheme's `x-aud` says which). */
+    audience?: "server" | "endpoint";
+    /** What the success answer is: parsed JSON, text, or bytes. */
+    accept: "json" | "text" | "bytes" | "none";
+}
+export declare function urlOf(base: string, path: string, pathParams?: Record<string, string | number>, query?: Record<string, string | number | undefined>): string;
+export declare function send<T>(o: ClientOptions, c: Call): Promise<T>;

package/dist/runtime.js

@@ -0,0 +1,98 @@
+/** Any answer outside 2xx. `error` and `why` are the service's own words; a refusal from Thank never reaches here (it is `{written: false}`). */
+export class ApiError extends Error {
+    status;
+    error;
+    why;
+    body;
+    constructor(status, error, why, body) {
+        super(`${status} ${error}${why ? `: ${why}` : ""}`);
+        this.status = status;
+        this.error = error;
+        this.why = why;
+        this.body = body;
+        this.name = "ApiError";
+    }
+}
+const ASSERTION_TYPE = "urn:ietf:params:oauth:client-assertion-type:jwt-bearer";
+export function urlOf(base, path, pathParams = {}, query = {}) {
+    const filled = path.replace(/\{(\w+)\}/g, (_, k) => {
+        if (pathParams[k] === undefined)
+            throw new TypeError(`missing path parameter ${k}`);
+        return encodeURIComponent(String(pathParams[k]));
+    });
+    const u = new URL(base.replace(/\/$/, "") + filled);
+    for (const [k, v] of Object.entries(query))
+        if (v !== undefined)
+            u.searchParams.set(k, String(v));
+    return u.toString();
+}
+export async function send(o, c) {
+    const f = o.fetch ?? globalThis.fetch;
+    const url = urlOf(o.baseUrl ?? c.base, c.path, c.pathParams, c.query);
+    // The address the service checks, never the test double's.
+    const aud = c.audience === "server" ? c.base.replace(/\/$/, "") : urlOf(c.base, c.path, c.pathParams);
+    const headers = {};
+    for (const [k, v] of Object.entries(c.headers ?? {}))
+        if (v !== undefined)
+            headers[k] = v;
+    let body;
+    let form;
+    if (c.contentType === "application/x-www-form-urlencoded")
+        form = { ...c.body };
+    if (c.security === "clientAssertion") {
+        if (!o.assertion)
+            throw new TypeError("this call needs options.assertion");
+        headers["x-client-assertion"] = await o.assertion(aud);
+    }
+    if (c.security === "privateKeyJwt" || c.security === "privateKeyJwt+dpop") {
+        if (!o.assertion)
+            throw new TypeError("this call needs options.assertion");
+        form = { ...form, client_assertion_type: ASSERTION_TYPE, client_assertion: await o.assertion(aud) };
+    }
+    if (c.security === "dpop" || c.security === "privateKeyJwt+dpop") {
+        if (!o.dpop)
+            throw new TypeError("this call needs options.dpop");
+        headers["DPoP"] = await o.dpop(c.method, aud, c.accessToken);
+        if (c.accessToken)
+            headers["Authorization"] = `DPoP ${c.accessToken}`;
+    }
+    if (c.security === "apiKey") {
+        if (!o.apiKey)
+            throw new TypeError("this call needs options.apiKey");
+        headers["Authorization"] = `Bearer ${o.apiKey}`;
+    }
+    if (form) {
+        const p = new URLSearchParams();
+        for (const [k, v] of Object.entries(form))
+            if (v !== undefined)
+                p.set(k, String(v));
+        body = p;
+        headers["Content-Type"] = "application/x-www-form-urlencoded";
+    }
+    else if (c.body !== undefined) {
+        if (c.contentType === "application/json") {
+            body = JSON.stringify(c.body);
+            headers["Content-Type"] = "application/json";
+        }
+        else {
+            body = c.body;
+            headers["Content-Type"] = c.contentType ?? "application/octet-stream";
+        }
+    }
+    const r = await f(url, { method: c.method, headers, body, redirect: "manual" });
+    if (r.status < 200 || r.status > 299) {
+        let j = null;
+        try {
+            j = await r.json();
+        }
+        catch { /* not JSON */ }
+        throw new ApiError(r.status, j?.error ?? (r.statusText || "error"), j?.why ?? j?.error_description, j);
+    }
+    if (c.accept === "none")
+        return undefined;
+    if (c.accept === "bytes")
+        return new Uint8Array(await r.arrayBuffer());
+    if (c.accept === "text")
+        return (await r.text());
+    return (await r.json());
+}

package/dist/sign.d.ts

@@ -0,0 +1,68 @@
+import { type ClientOptions } from "./runtime.js";
+export type ErrorBody = {
+    error: string;
+    why?: string;
+};
+/** Built by `claimFor()` in the package; send it as built. It names the file by its fingerprints only. */
+export type Claim = {
+    v: 2;
+    sha256: string;
+    pixels?: string;
+    phash?: string;
+    mime: string;
+    bytes: number;
+    /** An IPTC digital source type, for example `digitalCreation`. From the package, `sourceFromHistory({imports, mostly: 0.8})` works it out from what went into the work. */ source: string;
+    /** Your app's registered name. ⚠️ It goes into every record your app signs, permanently, so keep it short and plain. */ tool: string;
+    declared: boolean;
+    /** Optional, for example `CC0-1.0`. */ rights?: string;
+    imports?: Array<Record<string, unknown>>;
+    createdAtDeclared?: string;
+};
+export type RecordEntry = {
+    /** The record's number in the public log. */ index: number;
+    /** `similar` is a hint that two pictures look alike, nothing more. */ how: "exact" | "same pixels" | "similar";
+    distance?: number;
+    signedWith: "passkey";
+    at: string;
+    source: string;
+    declared: boolean;
+    rights?: string;
+    /** Present when the signer withdrew it: it stays in the log, marked as withdrawn by them. */ withdrawnAt?: string;
+};
+export type Trace = {
+    /** The file's SHA-256. */ fingerprint: string;
+    records: Array<RecordEntry>;
+    /** The file's C2PA manifest when present; `check.state` is `trusted` (signer on the C2PA trust list; it still says only what the signer declared), `valid` (signer not on the list, so anyone could have made it) or `invalid` (`failures` says why). */ c2pa?: Record<string, unknown>;
+    iptc?: Record<string, unknown>;
+    generators: Array<string>;
+    watermarks: Array<{
+        kind?: string;
+        model?: string;
+        agreement?: number;
+    }>;
+    /** B-Signal℠: the AI markers found in the file, recomputable from this same answer. ⛔ Never a measure of how human a work is, and never shown as a grade of someone's work (you agree to this when you make a key). */ signal: number;
+    /** What this answer did not look for, on every answer (SynthID has no public check). */ notChecked: Array<string>;
+};
+/** Sign with HeartBank®: Let the people who use your app sign what they made, and let anyone check it. B-Origin℠. */
+export declare class SignClient {
+    private readonly o;
+    constructor(o?: ClientOptions);
+    /** Look up what a file carries (B-Trace℠, metered). @see https://developers.333.eco/sign#trace */
+    trace(input: {
+        body: Uint8Array | ArrayBuffer | Blob;
+    }): Promise<Trace>;
+    /** Ask a person to sign a file (from your web page). @see https://developers.333.eco/sign#requestsign */
+    requestSign(input: {
+        body: {
+            claim: Claim;
+            state?: string;
+        };
+    }): Promise<{
+        request_uri: string;
+        expires_in: number;
+    }>;
+    /** The page where the person signs. @see https://developers.333.eco/sign#signpage */
+    signPageUrl(input: {
+        request_uri: string;
+    }): string;
+}

package/dist/sign.js

@@ -0,0 +1,43 @@
+// Generated by scripts/gen-client.mjs from openapi/sign.json. ⛔ Do not edit: change the description and run npm run client.
+import { send, urlOf } from "./runtime.js";
+/** Sign with HeartBank®: Let the people who use your app sign what they made, and let anyone check it. B-Origin℠. */
+export class SignClient {
+    o;
+    constructor(o = {}) {
+        this.o = o;
+    }
+    /** Look up what a file carries (B-Trace℠, metered). @see https://developers.333.eco/sign#trace */
+    trace(input) {
+        return send(this.o, {
+            method: "POST",
+            base: "https://origin.333.eco",
+            path: "/api/v1/trace",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            body: input.body,
+            contentType: "application/octet-stream",
+            security: "apiKey",
+            accept: "json",
+        });
+    }
+    /** Ask a person to sign a file (from your web page). @see https://developers.333.eco/sign#requestsign */
+    requestSign(input) {
+        return send(this.o, {
+            method: "POST",
+            base: "https://sign.333.eco",
+            path: "/sign/par",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            body: input.body,
+            contentType: "application/json",
+            security: "none",
+            accept: "json",
+        });
+    }
+    /** The page where the person signs. @see https://developers.333.eco/sign#signpage */
+    signPageUrl(input) {
+        return urlOf(this.o.baseUrl ?? "https://sign.333.eco", "/sign", undefined, { request_uri: input.request_uri });
+    }
+}

package/dist/thank.d.ts

@@ -0,0 +1,89 @@
+import { type ClientOptions } from "./runtime.js";
+/** The ledger declined, or there is no season open. ⛔ No reason and no count, by design. */
+export type NotWritten = {
+    written: false;
+};
+export type Prepared = {
+    /** Send back unchanged at commit. */ pending: string;
+    /** Signed by the ledger with the challenge and a description of what is being signed (ledger, units, season, to, and for Kiitti the direction and kind); sign.333.eco shows the person that description before they press. */ ticket: string;
+};
+export type Written = {
+    written: true;
+    /** ⛔ Only the entry's id reaches your app (threat T16: an index or a signature would count other apps' thanks). The full receipt goes to the two people, in their own records. */ receipt: {
+        id: string;
+    };
+    /** One-use tokens, one per side, to place that side on the public map later with /v1/place. A token knows neither the person nor the entry. */ place?: {
+        from?: string;
+        to?: string;
+    };
+};
+/** ⏳ Outside apps will name the receiver by registry handle instead, never another person's token (A591 (3)). */
+export type Person = {
+    /** From the person's log-in at login.333.eco (scope `ledger`). */ pidToken: string;
+    sub: string;
+};
+export type PrepareKiitos = {
+    /** Your id for this thank. The same ref returns the same answer and writes once. */ ref: string;
+    pidToken: string;
+    sub: string;
+    ledger: "kiitos";
+    to: Person;
+    /** Optional: exactly 32 bytes of your own, committed with a salt (never stored as sent); it reaches the two people in their records. */ cargo?: string;
+};
+/** First-party only (B-Twin, thank.333.eco): care for a thing, plant or animal, decided by the ledger's public rule on witnessed evidence. ⛔ Never an outside app: from season 2 an outside app's Kiitti is only a person's thanks to all of life, a call with no direction, twin or evidence field (directive #94). */
+export type PrepareKiitti = {
+    ref: string;
+    pidToken: string;
+    sub: string;
+    ledger: "kiitti";
+    dir: "kind" | "thankful";
+    evidence: {
+        kind: "thing" | "plant" | "animal";
+        twinId: string;
+        attested: boolean;
+        match?: number;
+    };
+};
+export type ErrorBody = {
+    error: string;
+};
+export type Ring = {
+    /** The ring's color. */ color: string;
+    /** The ring's width, drawn as a ring: ⛔ never shown as a number to chase. */ ring: number;
+};
+/** Thank with HeartBank®: Record a thank on the gratitude ledger. Your app prepares it, the person presses their own passkey, your app commits it. */
+export declare class ThankClient {
+    private readonly o;
+    constructor(o?: ClientOptions);
+    /** Step 1: prepare a thank. @see https://developers.333.eco/thank#prepare */
+    prepare(input: {
+        body: PrepareKiitos | PrepareKiitti;
+    }): Promise<Prepared | NotWritten>;
+    /** Step 3: commit the pressed thank. @see https://developers.333.eco/thank#commit */
+    commit(input: {
+        body: {
+            ref: string;
+            pending: string;
+            /** From POST https://login.333.eco/press/wrap. */ pressToken: string;
+        };
+    }): Promise<Written | NotWritten>;
+    /** Place one side of a written thank on the public map. @see https://developers.333.eco/thank#place */
+    place(input: {
+        body: {
+            token: string;
+            /** An area about 100 km across (0.9° bands), from the ledger's open cell function. */ cell: number;
+        };
+    }): Promise<{
+        placed: boolean;
+    }>;
+    /** Read a person's ring. @see https://developers.333.eco/thank#ring */
+    ring(input: {
+        sub: string;
+        "x-pid-token": string;
+    }): Promise<{
+        kiitos?: Ring;
+        kiitti?: Ring;
+    }>;
+    /** Retired: a thank without a press (retired). @see https://developers.333.eco/thank#submit */
+    submit(): Promise<void>;
+}

package/dist/thank.js

@@ -0,0 +1,85 @@
+// Generated by scripts/gen-client.mjs from openapi/thank.json. ⛔ Do not edit: change the description and run npm run client.
+import { send } from "./runtime.js";
+/** Thank with HeartBank®: Record a thank on the gratitude ledger. Your app prepares it, the person presses their own passkey, your app commits it. */
+export class ThankClient {
+    o;
+    constructor(o = {}) {
+        this.o = o;
+    }
+    /** Step 1: prepare a thank. @see https://developers.333.eco/thank#prepare */
+    prepare(input) {
+        return send(this.o, {
+            method: "POST",
+            base: "https://ledger.heartbank.net",
+            path: "/v1/prepare",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            body: input.body,
+            contentType: "application/json",
+            security: "clientAssertion",
+            audience: "server",
+            accept: "json",
+        });
+    }
+    /** Step 3: commit the pressed thank. @see https://developers.333.eco/thank#commit */
+    commit(input) {
+        return send(this.o, {
+            method: "POST",
+            base: "https://ledger.heartbank.net",
+            path: "/v1/commit",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            body: input.body,
+            contentType: "application/json",
+            security: "clientAssertion",
+            audience: "server",
+            accept: "json",
+        });
+    }
+    /** Place one side of a written thank on the public map. @see https://developers.333.eco/thank#place */
+    place(input) {
+        return send(this.o, {
+            method: "POST",
+            base: "https://ledger.heartbank.net",
+            path: "/v1/place",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            body: input.body,
+            contentType: "application/json",
+            security: "clientAssertion",
+            audience: "server",
+            accept: "json",
+        });
+    }
+    /** Read a person's ring. @see https://developers.333.eco/thank#ring */
+    ring(input) {
+        return send(this.o, {
+            method: "GET",
+            base: "https://ledger.heartbank.net",
+            path: "/v1/aura",
+            pathParams: undefined,
+            query: { sub: input.sub },
+            headers: { "x-pid-token": input["x-pid-token"] },
+            security: "clientAssertion",
+            audience: "server",
+            accept: "json",
+        });
+    }
+    /** Retired: a thank without a press (retired). @see https://developers.333.eco/thank#submit */
+    submit() {
+        return send(this.o, {
+            method: "POST",
+            base: "https://ledger.heartbank.net",
+            path: "/v1/submit",
+            pathParams: undefined,
+            query: undefined,
+            headers: undefined,
+            security: "clientAssertion",
+            audience: "server",
+            accept: "none",
+        });
+    }
+}

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.1.0",
+  "description": "The typed client for every HeartBank® API (Log in, Sign and Thank with HeartBank®, 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"
+  ]
+}