@did-btcr2/api 0.2.1 → 0.3.0

package/dist/types/types.d.ts

@@ -0,0 +1,128 @@
+import type { HttpExecutor, NetworkName, RestConfig, RpcConfig } from '@did-btcr2/bitcoin';
+import type { KeyManager } from '@did-btcr2/kms';
+import type { Btcr2DidDocument } from '@did-btcr2/method';
+import type { DidResolutionResult } from '@web5/dids';
+import type { CasConfig } from './cas.js';
+/**
+ * Pluggable logger interface. All methods are optional-call; the default
+ * implementation is a silent no-op.
+ * @public
+ */
+export type Logger = {
+    debug(message: string, ...args: unknown[]): void;
+    info(message: string, ...args: unknown[]): void;
+    warn(message: string, ...args: unknown[]): void;
+    error(message: string, ...args: unknown[]): void;
+};
+/**
+ * The two supported DID identifier types.
+ *
+ * Note: the upstream `DidCreateOptions.idType` is typed as `string` rather
+ * than a union. This local alias provides compile-time safety at the API
+ * facade level. Upstream runtime validation in `Identifier.encode()` still
+ * catches invalid values.
+ * @public
+ */
+export type IdType = 'KEY' | 'EXTERNAL';
+/**
+ * A branded string representing a DID identifier (e.g. `did:btcr2:k1q...`).
+ * Use branded types to prevent accidentally passing a txid where a DID is
+ * expected, or vice versa, at compile time.
+ *
+ * @example
+ * ```ts
+ * const did = api.generateDid().did as DidString;
+ * api.resolveDid(did); // OK
+ * api.btc.getTransaction(did); // Type error — DidString is not TxId
+ * ```
+ * @public
+ */
+export type DidString = string & {
+    readonly __brand: 'DidString';
+};
+/**
+ * A branded string representing a Bitcoin transaction ID (64-char hex).
+ * @public
+ */
+export type TxId = string & {
+    readonly __brand: 'TxId';
+};
+/**
+ * Result of a DID resolution attempt. Wraps the standard
+ * {@link DidResolutionResult} with a discriminated `ok` flag for ergonomic
+ * pattern matching without exception handling.
+ *
+ * @example
+ * ```ts
+ * const result = await api.tryResolveDid(did);
+ * if (result.ok) {
+ *   console.log(result.document);
+ * } else {
+ *   console.log(result.error, result.errorMessage);
+ * }
+ * ```
+ * @public
+ */
+export type ResolutionResult = {
+    ok: true;
+    document: Btcr2DidDocument;
+    metadata: DidResolutionResult['didDocumentMetadata'];
+    raw: DidResolutionResult;
+} | {
+    ok: false;
+    error: string;
+    errorMessage?: string;
+    raw: DidResolutionResult;
+};
+/**
+ * Bitcoin API configuration options.
+ * The `network` field is required and determines default REST/RPC endpoints.
+ * Optional `rest` and `rpc` fields override individual endpoints on top of
+ * the network defaults.
+ *
+ * @example
+ * ```ts
+ * // Use regtest defaults (localhost Polar + Esplora)
+ * { network: 'regtest' }
+ *
+ * // Use testnet4 with a custom REST endpoint
+ * { network: 'testnet4', rest: { host: 'https://my-mempool.example/api' } }
+ *
+ * // Use regtest with custom RPC credentials, default REST
+ * { network: 'regtest', rpc: { host: 'http://mynode:18443', username: 'u', password: 'p' } }
+ * ```
+ * @public
+ */
+export type BitcoinApiConfig = {
+    /** Bitcoin network name (e.g., 'regtest', 'testnet4', 'bitcoin'). */
+    network: NetworkName;
+    /** Override REST client settings on top of network defaults. */
+    rest?: Partial<RestConfig>;
+    /** Override RPC client settings on top of network defaults. */
+    rpc?: RpcConfig;
+    /**
+     * Optional HTTP executor for sans-I/O usage. Defaults to global `fetch`.
+     * Inject a custom executor to intercept requests in tests or route through
+     * a proxy without monkey-patching globals.
+     */
+    executor?: HttpExecutor;
+    /**
+     * Optional request timeout in milliseconds for REST calls.
+     * When set, wraps the HTTP executor with an `AbortSignal.timeout()`.
+     * Has no effect when a custom `executor` is provided (the custom
+     * executor is responsible for its own timeouts).
+     */
+    timeoutMs?: number;
+};
+/**
+ * Top-level API configuration options.
+ * @public
+ */
+export type ApiConfig = {
+    btc?: BitcoinApiConfig;
+    cas?: CasConfig;
+    kms?: KeyManager;
+    /** Optional logger. Defaults to a silent no-op logger. */
+    logger?: Logger;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC3F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAE1C;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IACjD,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAChD,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAChD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;CAClD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,MAAM,GAAG,KAAK,GAAG,UAAU,CAAC;AAExC;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAA;CAAE,CAAC;AAEnE;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAE,QAAQ,EAAE,gBAAgB,CAAC;IAAC,QAAQ,EAAE,mBAAmB,CAAC,qBAAqB,CAAC,CAAC;IAAC,GAAG,EAAE,mBAAmB,CAAA;CAAE,GACzH;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAElF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,qEAAqE;IACrE,OAAO,EAAE,WAAW,CAAC;IACrB,gEAAgE;IAChE,IAAI,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3B,+DAA+D;IAC/D,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,GAAG,CAAC,EAAE,gBAAgB,CAAC;IACvB,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-btcr2/api",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "type": "module",
   "description": "SDK for accessing the did:btcr2 method functionality.",
   "main": "./dist/cjs/index.js",
@@ -84,11 +84,12 @@
     "multiformats": "^13.3.1",
     "nostr-tools": "^2.15.0",
     "tiny-secp256k1": "^2.2.3",
-    "@did-btcr2/cryptosuite": "5.1.0",
-    "@did-btcr2/keypair": "0.9.1",
-    "@did-btcr2/common": "4.0.1",
-    "@did-btcr2/method": "0.22.0",
-    "@did-btcr2/bitcoin": "0.3.4"
+    "@did-btcr2/bitcoin": "0.5.0",
+    "@did-btcr2/common": "8.0.0",
+    "@did-btcr2/cryptosuite": "6.0.2",
+    "@did-btcr2/keypair": "0.11.0",
+    "@did-btcr2/method": "0.25.0",
+    "@did-btcr2/kms": "0.4.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.22.0",