@ledgerhq/revault-sdk 0.25.0 → 0.26.0

package/lib/index-BE7oUpCb.d.cts

@@ -0,0 +1,237 @@
+import { t as Logger } from "./logger-Cme0iL1f.cjs";
+import { HsmCertificate, PsdAuthChallengeResponse, PsdPairingData, PubKey } from "@ledgerhq/revault-api";
+import Transport from "@ledgerhq/hw-transport";
+import { Observable } from "rxjs";
+
+//#region src/device/types.d.ts
+type Device = {
+  /**
+   * Authenticate (resolve challenge for login)
+   */
+  authenticate: (opts: {
+    challenge: PsdAuthChallengeResponse;
+    workspaceName: string;
+  }) => Promise<string>;
+  /**
+   * Finalize pairing
+   */
+  finalizePairingHandshake: (opts: {
+    handshake: string;
+    partitionId: string;
+    handshakeAttestation: HsmCertificate;
+  }) => Promise<string>;
+  /**
+   * Generate seed fragment from Shared-Owner device
+   */
+  generateSeedFragment: () => Promise<string>;
+  /**
+   * Generate Wrapping Key fragment from Wrapping-Key Owner device
+   */
+  generateWrappingKeyFragment: () => Promise<string>;
+  /**
+   * Get device attestation
+   */
+  getAttestation: () => Promise<{
+    attestation: {
+      codeHash: string;
+      attestationPub: string;
+      certificate: string;
+    };
+    buffer: Buffer;
+  }>;
+  /**
+   * Get device confidentiality key
+   */
+  getConfidentialityKey: () => Promise<{
+    confidentialityKeyCurve25519: string;
+    confidentialityKeySignature: string;
+  }>;
+  /**
+   * Get device confidentiality public key
+   */
+  getConfidentialityPubKey: () => Promise<{
+    pubKey: string;
+    signature: string;
+  }>;
+  /**
+   * Get device user id (the 16 chars user identifier displayed on Vault app)
+   */
+  getDeviceUserId: () => Promise<string>;
+  /**
+   * Get device U2F public key
+   */
+  getU2FPubKey: () => Promise<{
+    pubKey: string;
+    signature: string;
+  }>;
+  /**
+   * Get device validation public key
+   */
+  getValidationPubKey: () => Promise<{
+    pubKey: string;
+    signature: string;
+  }>;
+  /**
+   * Check is device has partition pairing
+   */
+  hasPairing: () => Promise<boolean>;
+  /**
+   * Initialize pairing handshake
+   */
+  initPairingHandshake: () => Promise<{
+    pubKey: string;
+    signature: string;
+  }>;
+  /**
+   * Open session
+   */
+  openSession: (opts: {
+    secureChannel: {
+      pubKey: PubKey;
+      certificate: HsmCertificate;
+    };
+  }) => Promise<void>;
+  /**
+   * Register device
+   */
+  register: (opts: {
+    challenge: string;
+    u2fRegisterData: string;
+    name: string;
+    role: "ADMIN" | "SHARED_OWNER" | "OPERATOR";
+  }) => Promise<{
+    u2fRegister: Buffer;
+    keyHandle: Buffer;
+    rfu: number;
+    pubKey: string;
+  }>;
+  /**
+   * Register data
+   */
+  registerData: (opts: {
+    challenge: string;
+  }) => Promise<string>;
+  /**
+   * Inject partition pairing
+   */
+  setPairing: (opts: {
+    pairing: PsdPairingData;
+  }) => Promise<void>;
+  /**
+   * Start KK pattern (related to noise channel)
+   */
+  startKKPatternAsResponder: (opts: {
+    handshake: string;
+    handshakeAttestation: HsmCertificate;
+    partitionId: string;
+  }) => Promise<{
+    handshake: string;
+    signature: string;
+  }>;
+  /**
+   * Start K pattern (related to noise channel)
+   */
+  startKPatternAsResponder: (opts: {
+    handshake: string;
+    handshakeAttestation: HsmCertificate;
+    partitionId: string;
+  }) => Promise<void>;
+  /**
+   * Approve with device
+   */
+  validateVaultOperation: (opts: {
+    actions: string[];
+  }) => Promise<string>;
+  /**
+   * Send arbitrary APDU
+   * apduCommand in HEX string format
+   */
+  sendAPDU: (apduCommand: string) => Promise<string>;
+  /**
+   * Get app version
+   *
+   */
+  getVersion: () => Promise<string>;
+  /**
+   * Poll device until it's plugged-on
+   *
+   */
+  poll: (opts?: {
+    retryOnError?: (err: Error) => boolean;
+  }) => Promise<{
+    isAppOpened: boolean;
+  }>;
+  /**
+   * Returned when app is opened
+   * appName in string format
+   */
+  pollApp: (name: string) => Promise<string>;
+};
+//#endregion
+//#region src/device/api-device.d.ts
+type Options = {
+  /**
+   * device-api URL
+   */
+  deviceApiUrl: string;
+  /**
+   * salt used by device-api
+   */
+  salt: string;
+  /**
+   * seed generation function used for device-api device spawn
+   */
+  genSeed: (p: {
+    salt: string;
+    index: number;
+  }) => string | Promise<string>;
+};
+type ApiDevice = {
+  /**
+   * bind a device to the given device index
+   */
+  with: (index: number) => Device;
+};
+declare function createApiDevice(options: Options, logger: Logger): ApiDevice;
+//#endregion
+//#region src/device/device-access.d.ts
+type Discovery = Observable<{
+  type: "add" | "remove";
+  id: string;
+  name: string;
+}>;
+type TransportModule = {
+  id: string;
+  open: (id: string) => Promise<Transport> | null | undefined;
+  close?: (transport: Transport, id: string) => Promise<void> | null | undefined;
+  disconnect: (id: string) => Promise<void> | null | undefined;
+  discovery?: Discovery;
+};
+declare const registerTransportModule: (module: TransportModule) => void;
+//#endregion
+//#region ../../node_modules/.pnpm/@ledgerhq+errors@6.32.0/node_modules/@ledgerhq/errors/lib-es/index.d.ts
+/**
+ * Error thrown when a device returned a non success status.
+ * the error.statusCode is one of the `StatusCodes` exported by this library.
+ */
+declare class TransportStatusError extends Error {
+  statusCode: number;
+  statusText: string;
+  /**
+   * @param statusCode The error status code coming from a Transport implementation
+   * @param options containing:
+   *  - canBeMappedToChildError: enable the mapping of TransportStatusError to an error extending/inheriting from it
+   *  . Ex: LockedDeviceError. Default to true.
+   */
+  constructor(statusCode: number, {
+    canBeMappedToChildError
+  }?: {
+    canBeMappedToChildError?: boolean;
+  });
+}
+//#endregion
+//#region src/device/utils.d.ts
+declare const isTransportStatusError: (error: unknown) => error is TransportStatusError;
+declare const isDeviceCancelError: (error: Error) => boolean;
+//#endregion
+export { createApiDevice as a, ApiDevice as i, isTransportStatusError as n, Device as o, registerTransportModule as r, isDeviceCancelError as t };

package/lib/index-DOn7RPPt.d.cts

@@ -0,0 +1,23 @@
+import { t as Logger } from "./logger-Cme0iL1f.cjs";
+import { a as TRPCContext } from "./trpc-C_dUOB1u.cjs";
+import { d as Engine, p as EngineOptions } from "./types-Ngwgtu_U.cjs";
+import { CursorPaginated, Paginated } from "@ledgerhq/revault-api";
+
+//#region src/utils.d.ts
+/**
+ * Utility function that collect results on all pages until there is no more next page
+ */
+declare function fetchAll<TData, TQuery extends {
+  page?: number;
+}>(queryFn: (query: TQuery, trpcContext?: TRPCContext) => Promise<Paginated<TData>>, query: TQuery, trpcContext?: TRPCContext): Promise<TData[]>;
+/**
+ * Utility function that collect results on all cursors until cursor is null
+ */
+declare function fetchAllCursor<TData, TQuery extends {
+  cursor?: number | string;
+}>(queryFn: (query: TQuery) => Promise<CursorPaginated<TData>>, query: TQuery): Promise<TData[]>;
+//#endregion
+//#region src/engine/index.d.ts
+declare function createEngine(options: EngineOptions, logger: Logger): Engine;
+//#endregion
+export { fetchAll as n, fetchAllCursor as r, createEngine as t };

package/lib/index-U0iFMp3g.d.ts

@@ -0,0 +1,23 @@
+import { t as Logger } from "./logger-DWLViq7U.js";
+import { a as TRPCContext } from "./trpc-CWGPr8Ox.js";
+import { d as Engine, p as EngineOptions } from "./types-BXkDuD6i.js";
+import { CursorPaginated, Paginated } from "@ledgerhq/revault-api";
+
+//#region src/utils.d.ts
+/**
+ * Utility function that collect results on all pages until there is no more next page
+ */
+declare function fetchAll<TData, TQuery extends {
+  page?: number;
+}>(queryFn: (query: TQuery, trpcContext?: TRPCContext) => Promise<Paginated<TData>>, query: TQuery, trpcContext?: TRPCContext): Promise<TData[]>;
+/**
+ * Utility function that collect results on all cursors until cursor is null
+ */
+declare function fetchAllCursor<TData, TQuery extends {
+  cursor?: number | string;
+}>(queryFn: (query: TQuery) => Promise<CursorPaginated<TData>>, query: TQuery): Promise<TData[]>;
+//#endregion
+//#region src/engine/index.d.ts
+declare function createEngine(options: EngineOptions, logger: Logger): Engine;
+//#endregion
+export { fetchAll as n, fetchAllCursor as r, createEngine as t };

package/lib/index.cjs

@@ -1 +0,0 @@
-"use strict";//# sourceMappingURL=index.cjs.map

package/lib/index.d.cts

@@ -1,5 +1,10 @@
-export { L as Logger } from './logger-C-TPbnjv.cjs';
-export { R as RevaultApiTRPCClient, a as RouterInputs, b as RouterOutputs, T as TRPCContext } from './types-CpGEbAxh.cjs';
-export * from '@ledgerhq/revault-api';
-import '@trpc/client';
-import '@trpc/server';
+import { t as Logger } from "./logger-Cme0iL1f.cjs";
+import { a as TRPCContext, n as RouterInputs, r as RouterOutputs, t as RevaultApiTRPCClient } from "./trpc-C_dUOB1u.cjs";
+export * from "@ledgerhq/revault-api";
+
+//#region src/index.d.ts
+declare namespace index_d_exports {
+  export { Logger, RevaultApiTRPCClient, RouterInputs, RouterOutputs, TRPCContext };
+}
+//#endregion
+export { type Logger, type RevaultApiTRPCClient, RouterInputs, RouterOutputs, TRPCContext };

package/lib/index.d.ts

@@ -1,5 +1,10 @@
-export { L as Logger } from './logger-C-TPbnjv.js';
-export { R as RevaultApiTRPCClient, a as RouterInputs, b as RouterOutputs, T as TRPCContext } from './types-CpGEbAxh.js';
-export * from '@ledgerhq/revault-api';
-import '@trpc/client';
-import '@trpc/server';
+import { t as Logger } from "./logger-DWLViq7U.js";
+import { a as TRPCContext, n as RouterInputs, r as RouterOutputs, t as RevaultApiTRPCClient } from "./trpc-CWGPr8Ox.js";
+export * from "@ledgerhq/revault-api";
+
+//#region src/index.d.ts
+declare namespace index_d_exports {
+  export { Logger, RevaultApiTRPCClient, RouterInputs, RouterOutputs, TRPCContext };
+}
+//#endregion
+export { type Logger, type RevaultApiTRPCClient, RouterInputs, RouterOutputs, TRPCContext };

package/lib/index.js

@@ -1 +1 @@
-//# sourceMappingURL=index.js.map
+export {};

package/lib/logger-Cme0iL1f.d.cts

@@ -0,0 +1,10 @@
+//#region src/logger.d.ts
+type Logger = {
+  info: (msg: string) => void;
+  warning: (msg: string) => void;
+  error: (msg: string) => void;
+  debug: (msg: string) => void;
+  output: (msg: string) => void;
+};
+//#endregion
+export { Logger as t };

package/lib/logger-DWLViq7U.d.ts

@@ -0,0 +1,10 @@
+//#region src/logger.d.ts
+type Logger = {
+  info: (msg: string) => void;
+  warning: (msg: string) => void;
+  error: (msg: string) => void;
+  debug: (msg: string) => void;
+  output: (msg: string) => void;
+};
+//#endregion
+export { Logger as t };