@authenticdoc/sdk 0.1.1

package/dist/types.d.ts

@@ -0,0 +1,43 @@
+/** Role of a participant in a signing envelope. */
+export type EnvelopeRole = "viewer" | "signer";
+/**
+ * One named participant of an envelope. `relay` is an opaque hint (a WebSocket
+ * URL the SDK does not validate).
+ */
+export interface EnvelopeParticipant {
+    role: EnvelopeRole;
+    pubkey: string;
+    relay: string;
+}
+/** A participant's signature over an envelope's inner document. */
+export interface EnvelopeSignature {
+    pubkey: string;
+    id: string;
+    sig: string;
+}
+/**
+ * A Nostr event/note. Templates, envelopes, identities and badges all
+ * serialize as (or wrap) one of these on the wire. Kept loose on purpose —
+ * the SDK owns the exact shape; consumers usually round-trip it opaquely.
+ */
+export interface NostrNote {
+    id?: string;
+    pubkey?: string;
+    created_at?: number;
+    kind?: number;
+    tags?: string[][];
+    content?: string;
+    sig?: string;
+    [key: string]: unknown;
+}
+/** A template is a Nostr note (parameterized replaceable event). */
+export type Template = NostrNote;
+/** An envelope serializes as its inner Nostr note. */
+export type Envelope = NostrNote;
+/** Result of decoding a data-URL template `content`. */
+export interface DecodedDataUrl {
+    mime: string;
+    /** Standard (not URL-safe) base64 of the raw bytes. */
+    bytes_base64: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAIA,mDAAmD;AACnD,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE/C;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AAED,mEAAmE;AACnE,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,oEAAoE;AACpE,MAAM,MAAM,QAAQ,GAAG,SAAS,CAAC;AAEjC,sDAAsD;AACtD,MAAM,MAAM,QAAQ,GAAG,SAAS,CAAC;AAEjC,wDAAwD;AACxD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACtB"}

package/dist/types.js

@@ -0,0 +1,5 @@
+// TypeScript shapes mirroring the SDK's serde forms. These match exactly what
+// the wasm boundary serializes/expects, so they're the parse targets for the
+// JSON strings the wasm layer returns.
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,6EAA6E;AAC7E,uCAAuC"}

package/dist/wasm/authenticdoc.d.ts

@@ -0,0 +1,318 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * An opaque secp256k1 keypair living in WASM memory.
+ *
+ * Construct one with [`Keypair::generate`] or the `from_*` constructors. The
+ * secret key stays inside the WASM module; JS only ever holds this handle.
+ * Replaces the FFI crate's `uint64_t` handle table (and its `RwLock`).
+ */
+export class Keypair {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Load a keypair from a 64-character hex private key.
+     */
+    static fromHex(hex: string): Keypair;
+    /**
+     * Load a keypair from a BIP-39 mnemonic phrase (English, 12 or 24 words).
+     */
+    static fromMnemonic(phrase: string): Keypair;
+    /**
+     * Load a keypair from a bech32 `nsec1…` string.
+     */
+    static fromNsec(nsec: string): Keypair;
+    /**
+     * Generate a fresh extractable keypair.
+     */
+    static generate(): Keypair;
+    /**
+     * Export the 24-word BIP-39 mnemonic (secret material — handle with care).
+     */
+    mnemonic(): string;
+    /**
+     * Export the bech32 `nsec` (secret material — handle with care).
+     */
+    nsec(): string;
+    /**
+     * The hex-encoded public key.
+     */
+    readonly pubkey: string;
+}
+
+/**
+ * Unwrap a badge addressed to the holder keypair.
+ */
+export function badgeUnwrap(outer_json: string, holder_keypair: Keypair): string;
+
+/**
+ * Verify that a badge was issued by `expected_issuer_pubkey`. Throws on
+ * mismatch.
+ */
+export function badgeVerify(badge_json: string, expected_issuer_pubkey: string): void;
+
+/**
+ * Wrap a signed inner badge for delivery to a holder.
+ */
+export function badgeWrap(signed_inner_json: string, holder_pubkey: string, issuer_keypair: Keypair): string;
+
+/**
+ * Attach signatures via the (non-owner) participant path.
+ * `sigs_json` is a JSON array of `EnvelopeSignature`.
+ */
+export function envelopeAddParticipantSigs(envelope_json: string, keypair: Keypair, sigs_json: string): string;
+
+/**
+ * Attach signatures via the owner path (idempotent — replaces existing sigs).
+ */
+export function envelopeAddParticipantSigsAsOwner(envelope_json: string, owner_keypair: Keypair, sigs_json: string): string;
+
+/**
+ * Produce this keypair's participant signature over the envelope's inner
+ * document. Returns the signature as JSON.
+ */
+export function envelopeCreateParticipantSig(envelope_json: string, keypair: Keypair): string;
+
+/**
+ * Build a v2 envelope directly from raw file bytes plus metadata.
+ *
+ * Equivalent to [`template_from_bytes`] + [`envelope_new`]. `id = None`/empty
+ * mints a UUID.
+ */
+export function envelopeFromBytes(id: string | null | undefined, title: string, mime: string, bytes: Uint8Array, participants_json: string): string;
+
+/**
+ * The envelope's parameter id (matches the wrapped template id).
+ */
+export function envelopeId(envelope_json: string): string;
+
+/**
+ * Build a v2 envelope wrapping `template_json` for `participants_json`
+ * (a JSON array of `EnvelopeParticipant`).
+ */
+export function envelopeNew(template_json: string, participants_json: string): string;
+
+/**
+ * The envelope's participant list as JSON.
+ */
+export function envelopeParticipants(envelope_json: string): string;
+
+/**
+ * Sign the envelope's outer Nostr event with `keypair`.
+ */
+export function envelopeSign(envelope_json: string, keypair: Keypair): string;
+
+/**
+ * The envelope's `created_at` timestamp (Unix seconds).
+ */
+export function envelopeTimestamp(envelope_json: string): bigint;
+
+/**
+ * Decrypt the envelope title using a participant keypair.
+ */
+export function envelopeTitle(envelope_json: string, keypair: Keypair): string;
+
+/**
+ * Verify a signed envelope (outer event id + signature + shape).
+ */
+export function envelopeVerify(envelope_json: string): void;
+
+/**
+ * Verify every participant signature in the envelope, returning them as JSON.
+ */
+export function envelopeVerifyAllParticipantSigs(envelope_json: string, keypair: Keypair): string;
+
+/**
+ * Verify a single peer's signature (`peer_pubkey` hex), returning it as JSON.
+ * `keypair` must be a participant able to decrypt the body.
+ */
+export function envelopeVerifyParticipantSig(envelope_json: string, keypair: Keypair, peer_pubkey: string): string;
+
+/**
+ * Decrypt and return the inner document as a Nostr note JSON blob.
+ */
+export function envelopeViewDocument(envelope_json: string, keypair: Keypair): string;
+
+/**
+ * Parse a Nostr badge-award event into an Identity JSON object.
+ */
+export function identityFromEvent(note_json: string): string;
+
+/**
+ * Encode a hex Nostr public key as a bech32 `npub`.
+ */
+export function identityNpub(pubkey_hex: string): string;
+
+/**
+ * Build an unsigned Nostr event from an Identity JSON object.
+ */
+export function identityToEvent(identity_json: string): string;
+
+/**
+ * Sign any Nostr note with `keypair`. A zero `created_at` is replaced with the
+ * current Unix timestamp before signing.
+ */
+export function noteSign(note_json: string, keypair: Keypair): string;
+
+/**
+ * Add a `description` tag and return the updated template JSON.
+ */
+export function templateAddDescription(template_json: string, description: string): string;
+
+/**
+ * Add a custom tag and return the updated template JSON.
+ */
+export function templateAddTag(template_json: string, key: string, value: string): string;
+
+/**
+ * Extract the body content.
+ */
+export function templateContent(template_json: string): string;
+
+/**
+ * Decode a data-URL `content`, returning JSON
+ * `{"mime": <string>, "bytes_base64": <standard base64>}`. Throws if the
+ * content is not a base64 data URL.
+ */
+export function templateDecodeDataUrl(template_json: string): string;
+
+/**
+ * Read the `description` tag. Throws if absent.
+ */
+export function templateDescription(template_json: string): string;
+
+/**
+ * Extract the document id (the `d` parameter tag).
+ */
+export function templateDocumentId(template_json: string): string;
+
+/**
+ * Build a template from raw file bytes, stored as an RFC 2397 data URL.
+ *
+ * Pass `id = None`/`undefined` or an empty string to mint a UUID.
+ */
+export function templateFromBytes(id: string | null | undefined, title: string, mime: string, bytes: Uint8Array): string;
+
+/**
+ * Read the first value of a custom tag. Throws if the tag is absent.
+ */
+export function templateGetTag(template_json: string, key: string): string;
+
+/**
+ * Whether the template `content` is a base64 data URL (built via
+ * [`template_from_bytes`]).
+ */
+export function templateIsDataUrl(template_json: string): boolean;
+
+/**
+ * Build a new template (UUID + title + body) and return it as JSON.
+ */
+export function templateNew(title: string, body: string): string;
+
+/**
+ * Overwrite the document id and return the updated template JSON.
+ */
+export function templateSetDocumentId(template_json: string, id: string): string;
+
+/**
+ * Set the title and return the updated template JSON.
+ */
+export function templateSetTitle(template_json: string, title: string): string;
+
+/**
+ * Sign a template with `keypair`, returning the signed template JSON.
+ */
+export function templateSign(template_json: string, keypair: Keypair): string;
+
+/**
+ * Extract the title.
+ */
+export function templateTitle(template_json: string): string;
+
+/**
+ * Verify a signed template (event id + signature + shape).
+ */
+export function templateVerify(template_json: string): void;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_keypair_free: (a: number, b: number) => void;
+    readonly badgeUnwrap: (a: number, b: number, c: number, d: number) => void;
+    readonly badgeVerify: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly badgeWrap: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly envelopeAddParticipantSigs: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly envelopeAddParticipantSigsAsOwner: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly envelopeCreateParticipantSig: (a: number, b: number, c: number, d: number) => void;
+    readonly envelopeFromBytes: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number) => void;
+    readonly envelopeId: (a: number, b: number, c: number) => void;
+    readonly envelopeNew: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly envelopeParticipants: (a: number, b: number, c: number) => void;
+    readonly envelopeSign: (a: number, b: number, c: number, d: number) => void;
+    readonly envelopeTimestamp: (a: number, b: number, c: number) => void;
+    readonly envelopeTitle: (a: number, b: number, c: number, d: number) => void;
+    readonly envelopeVerify: (a: number, b: number, c: number) => void;
+    readonly envelopeVerifyAllParticipantSigs: (a: number, b: number, c: number, d: number) => void;
+    readonly envelopeVerifyParticipantSig: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly envelopeViewDocument: (a: number, b: number, c: number, d: number) => void;
+    readonly identityFromEvent: (a: number, b: number, c: number) => void;
+    readonly identityNpub: (a: number, b: number, c: number) => void;
+    readonly identityToEvent: (a: number, b: number, c: number) => void;
+    readonly keypair_fromHex: (a: number, b: number, c: number) => void;
+    readonly keypair_fromMnemonic: (a: number, b: number, c: number) => void;
+    readonly keypair_fromNsec: (a: number, b: number, c: number) => void;
+    readonly keypair_generate: () => number;
+    readonly keypair_mnemonic: (a: number, b: number) => void;
+    readonly keypair_nsec: (a: number, b: number) => void;
+    readonly keypair_pubkey: (a: number, b: number) => void;
+    readonly noteSign: (a: number, b: number, c: number, d: number) => void;
+    readonly templateAddDescription: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly templateAddTag: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly templateContent: (a: number, b: number, c: number) => void;
+    readonly templateDecodeDataUrl: (a: number, b: number, c: number) => void;
+    readonly templateDescription: (a: number, b: number, c: number) => void;
+    readonly templateDocumentId: (a: number, b: number, c: number) => void;
+    readonly templateFromBytes: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
+    readonly templateGetTag: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly templateIsDataUrl: (a: number, b: number, c: number) => void;
+    readonly templateNew: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly templateSetDocumentId: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly templateSetTitle: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly templateSign: (a: number, b: number, c: number, d: number) => void;
+    readonly templateTitle: (a: number, b: number, c: number) => void;
+    readonly templateVerify: (a: number, b: number, c: number) => void;
+    readonly rustsecp256k1_v0_10_0_context_create: (a: number) => number;
+    readonly rustsecp256k1_v0_10_0_context_destroy: (a: number) => void;
+    readonly rustsecp256k1_v0_10_0_default_error_callback_fn: (a: number, b: number) => void;
+    readonly rustsecp256k1_v0_10_0_default_illegal_callback_fn: (a: number, b: number) => void;
+    readonly __wbindgen_export: (a: number) => void;
+    readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+    readonly __wbindgen_export2: (a: number, b: number) => number;
+    readonly __wbindgen_export3: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_export4: (a: number, b: number, c: number) => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;