@ledgerhq/revault-sdk 0.25.0 → 0.26.0

package/lib/types-CryvY9pW.d.cts

@@ -1,202 +0,0 @@
-import { VaultRequestResponse, PsdChallenge, ApiChallenge, UserRegistrationResponse, ClaimedRole, WrappingKeyResponse, OnboardingSeedChallenge } from '@ledgerhq/revault-api';
-import { D as Device } from './types-DJfbanPz.cjs';
-import { R as RevaultApiTRPCClient, c as TRPCClientOptions, b as RouterOutputs } from './types-CpGEbAxh.cjs';
-
-type EngineOptions = {
-    /**
-     * revault-api URL
-     */
-    baseUrl: string;
-    /**
-     * 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 EngineBase = {
-    /**
-     * revault-api client
-     */
-    client: RevaultApiTRPCClient;
-    /**
-     * Create a new revault-api client with the given options overriding the base ones
-     */
-    createClient: (opts: Partial<TRPCClientOptions>) => RevaultApiTRPCClient;
-    /**
-     * Engine options used to create the engine. Can be useful to retrieve them at runtime.
-     */
-    __options: EngineOptions;
-};
-type EnhanceWithDevice<T> = T extends WithDevice | WithApiUser ? unknown : {
-    /**
-     * Mark the engine as targeting the given transport id for PSD communication.
-     * See `@ledgerhq/hw-transport` for more information.
-     *
-     * @param string transportId
-     */
-    withTransportId: (transportId: string) => Engine<T & WithDevice>;
-    /**
-     * Mark the engine as using device-api (for dev & test purposes) with the given device index.
-     *
-     * @param number deviceIndex
-     */
-    withDeviceIndex: (deviceIndex: number) => Engine<T & WithDevice>;
-};
-type EnhanceWithApiUser<T> = T extends WithDevice | WithApiUser | WithOnboarding ? unknown : {
-    /**
-     * Mark the engine as targeting API user
-     */
-    withApiUser: () => Engine<T & WithApiUser>;
-};
-type EnhanceWithOnboarding<T> = T extends WithOnboarding | WithWorkspace | WithApiUser ? unknown : {
-    /**
-     * Target the given onboarding id
-     *
-     * @param string Onboarding id
-     */
-    withOnboarding: (onboardingId: string) => Engine<T & WithOnboarding>;
-};
-type EnhanceWithWorkspace<T> = T extends WithWorkspace | WithOnboarding ? unknown : {
-    /**
-     * Target the given workspace
-     *
-     * @param string Workspace name
-     */
-    withWorkspace: (workspaceName: string) => Engine<T & WithWorkspace>;
-};
-type Decorate<T, TCond, TExtend> = T extends TCond ? TExtend : unknown;
-type Engine<T = unknown> = T & EngineBase & EnhanceWithDevice<T> & EnhanceWithApiUser<T> & EnhanceWithOnboarding<T> & EnhanceWithWorkspace<T> & Decorate<T, WithDevice, DecorateWithDevice<T>> & Decorate<T, WithWorkspace, DecorateWithWorkspace<T>> & Decorate<T, WithDevice & WithOnboarding, DecorateWithDeviceAndOnboarding>;
-type WithDevice = {
-    device: Device;
-};
-type DecorateWithDevice<T> = T extends WithWorkspace ? unknown : {
-    getWorkspaces: () => Promise<string[]>;
-    getWorkspacesForSso: () => Promise<RouterOutputs["auth"]["sso"]["findWorkspaces"]["workspaces"]>;
-};
-type WithApiUser = {
-    __isApiUser: true;
-};
-type RegisterOnboardingDeviceParams = {
-    role: "ADMIN" | "SHARED_OWNER";
-    name: string;
-};
-type WithOnboarding = {
-    __onboardingId: string;
-};
-type DecorateWithDeviceAndOnboarding = {
-    /**
-     * Claim the device as part of the onboarding
-     */
-    claimDevice: (p: {
-        role: ClaimedRole;
-        deviceName: string;
-    }) => Promise<void>;
-    /**
-     * Collect fragment of wrapping key
-     */
-    collectWrappingKeyFragment: (wrappingKey: WrappingKeyResponse, params?: OnboardingOperationParams) => Promise<void>;
-    /**
-     * Register device (either Admin or Shared-Owner)
-     */
-    registerDevice: (p: RegisterOnboardingDeviceParams, params?: OnboardingOperationParams) => Promise<void>;
-    /**
-     * Review Shared-Owner with Admin
-     */
-    reviewSharedOwner: (challenge: PsdChallenge, params?: OnboardingOperationParams) => Promise<void>;
-    /**
-     * Collect master seed fragment
-     */
-    collectSeedFragment: (challenge: OnboardingSeedChallenge, params?: OnboardingOperationParams) => Promise<void>;
-};
-type WithWorkspace = {
-    __workspaceName: string;
-};
-type DecorateWithWorkspace<T> = T extends WithPsdAuth | WithApiAuth ? DecorateWithWorkspaceAuthenticated<T> : DecorateWithWorkspaceUnauthenticated<T> & (T extends WithDevice ? DecorateWithDeviceAndWorkspaceUnauthenticated<T> : T extends WithApiUser ? DecorateWithApiUserAndWorkspaceUnauthenticated<T> : unknown);
-type DecorateWithWorkspaceUnauthenticated<T> = {
-    /**
-     * Directly pass a PsdAuth token
-     */
-    withPsdToken: (token: string) => Engine<T & WithPsdAuth>;
-};
-type DecorateWithWorkspaceAuthenticated<T> = T extends WithDevice ? DecorateWithWorkspacePsdAuthenticated : T extends WithApiUser ? DecorateWithWorkspaceApiAuthenticated : unknown;
-type OnboardingOperationParams = {
-    onScreenDisplayed?: () => void | Promise<void>;
-};
-type CorrelationIdOpts = {
-    correlationId?: string;
-};
-type ApproveRequestParams = {
-    onScreenDisplayed?: () => void | Promise<void>;
-    onPsdChallengeSigned?: () => void | Promise<void>;
-} & CorrelationIdOpts;
-type DecorateWithWorkspacePsdAuthenticated = {
-    /**
-     * Approve the given request
-     */
-    approve: (request: VaultRequestResponse, params?: ApproveRequestParams) => Promise<VaultRequestResponse>;
-    /**
-     * Approve the given challenge
-     */
-    approveChallenge: (challenge: PsdChallenge, params?: ApproveRequestParams) => Promise<string>;
-    /**
-     * Reject the given request
-     */
-    reject: (request: VaultRequestResponse) => Promise<VaultRequestResponse>;
-};
-type DecorateWithWorkspaceApiAuthenticated = {
-    /**
-     * Get API challenge for the given request
-     */
-    getChallenge: (request: VaultRequestResponse) => Promise<ApiChallenge["payload"]>;
-    /**
-     * Approve the given request
-     */
-    approve: (request: VaultRequestResponse, signature: string) => Promise<VaultRequestResponse>;
-    /**
-     * Reject the given request
-     */
-    reject: (request: VaultRequestResponse, signature: string) => Promise<VaultRequestResponse>;
-};
-type DecorateWithDeviceAndWorkspaceUnauthenticated<T> = {
-    /**
-     * Login using the workspace & device that the engine are targeting
-     */
-    login: (opts?: {
-        validityDurationSecs?: number;
-        onScreenDisplayed?: () => void | Promise<void>;
-        correlationId?: string;
-    }) => Promise<Engine<T & WithPsdAuth>>;
-    /**
-     * Register the current device
-     */
-    register: (registration: UserRegistrationResponse) => Promise<UserRegistrationResponse>;
-};
-type WithPsdAuth = {
-    __psdToken: string;
-};
-type DecorateWithApiUserAndWorkspaceUnauthenticated<T> = {
-    /**
-     * Login using the workspace that the engine target and the given credentials
-     */
-    login: (credentials: {
-        apiKeyId: string;
-        apiKeySecret: string;
-    }, options?: {
-        correlationId?: string;
-    }) => Promise<Engine<T & WithApiAuth>>;
-};
-type WithApiAuth = {
-    __apiAuth: RouterOutputs["auth"]["authenticate"];
-};
-
-export type { ApproveRequestParams as A, CorrelationIdOpts as C, DecorateWithApiUserAndWorkspaceUnauthenticated as D, Engine as E, OnboardingOperationParams as O, RegisterOnboardingDeviceParams as R, WithOnboarding as W, EngineOptions as a, DecorateWithDevice as b, DecorateWithDeviceAndOnboarding as c, DecorateWithDeviceAndWorkspaceUnauthenticated as d, DecorateWithWorkspace as e, DecorateWithWorkspaceApiAuthenticated as f, DecorateWithWorkspacePsdAuthenticated as g, DecorateWithWorkspaceUnauthenticated as h, EngineBase as i, WithApiAuth as j, WithApiUser as k, WithDevice as l, WithPsdAuth as m, WithWorkspace as n };

package/lib/types-DJfbanPz.d.cts

@@ -1,167 +0,0 @@
-import { PsdAuthChallengeResponse, HsmCertificate, PubKey, PsdPairingData } from '@ledgerhq/revault-api';
-
-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>;
-};
-
-export type { Device as D };

package/lib/types-DJfbanPz.d.ts

@@ -1,167 +0,0 @@
-import { PsdAuthChallengeResponse, HsmCertificate, PubKey, PsdPairingData } from '@ledgerhq/revault-api';
-
-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>;
-};
-
-export type { Device as D };

package/lib/types.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["/home/runner/_work/revault/revault/packages/sdk/lib/types.cjs"],"names":[],"mappings":"AAAA","file":"/home/runner/_work/revault/revault/packages/sdk/lib/types.cjs"}

package/lib/types.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}