Class PolykeyClient

Hierarchy

  • CreateDestroyStartStop
    • PolykeyClient

Constructors

constructor

Properties

[initLock] fs logger nodePath rpcClientClient session

Accessors

[destroyed] [eventHandled] [eventHandlers] [eventTarget] [handleEventError] [running] [statusP] [status]

Methods

addEventListener destroy dispatchEvent removeEventListener start stop createPolykeyClient

Constructors

constructor

Properties

Readonly [initLock]

[initLock]: RWLockWriter

Protected fs

fs: FileSystem

Protected logger

logger: Logger

Readonly nodePath

nodePath: string

Readonly rpcClientClient

rpcClientClient: RPCClient<{
    agentLockAll: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult>;
    agentStatus: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult<StatusResultMessage>>;
    agentStop: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult>;
    agentUnlock: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult>;
    gestaltsActionsGetByIdentity: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult<{
        actionsList: ("claim" | "notify" | "scan")[];
    }>>;
    gestaltsActionsGetByNode: UnaryCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult<ActionsListMessage>>;
    gestaltsActionsSetByIdentity: UnaryCaller<ClientRPCRequestParams<SetIdentityActionMessage>, ClientRPCResponseResult>;
    gestaltsActionsSetByNode: UnaryCaller<ClientRPCRequestParams<SetNodeActionMessage>, ClientRPCResponseResult>;
    gestaltsActionsUnsetByIdentity: UnaryCaller<ClientRPCRequestParams<SetIdentityActionMessage>, ClientRPCResponseResult>;
    gestaltsActionsUnsetByNode: UnaryCaller<ClientRPCRequestParams<SetNodeActionMessage>, ClientRPCResponseResult>;
    gestaltsDiscoveryByIdentity: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult>;
    gestaltsDiscoveryByNode: UnaryCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult>;
    gestaltsGestaltGetByIdentity: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult<GestaltMessage>>;
    gestaltsGestaltGetByNode: UnaryCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult<GestaltMessage>>;
    gestaltsGestaltList: ServerCaller<ClientRPCRequestParams, ClientRPCResponseResult<GestaltMessage>>;
    gestaltsGestaltTrustByIdentity: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult>;
    gestaltsGestaltTrustByNode: UnaryCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult>;
    identitiesAuthenticate: ServerCaller<ClientRPCRequestParams<{
        providerId: string;
    }>, ClientRPCResponseResult<AuthProcessMessage>>;
    identitiesAuthenticatedGet: ServerCaller<ClientRPCRequestParams<{
        providerId?: string;
    }>, ClientRPCResponseResult<IdentityMessage>>;
    identitiesClaim: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult<client.types.ClaimIdMessage>>;
    identitiesInfoConnectedGet: ServerCaller<ClientRPCRequestParams<ProviderSearchMessage>, ClientRPCResponseResult<IdentityInfoMessage>>;
    identitiesInfoGet: ServerCaller<ClientRPCRequestParams<ProviderSearchMessage>, ClientRPCResponseResult<IdentityInfoMessage>>;
    identitiesInvite: UnaryCaller<ClientRPCRequestParams<ClaimNodeMessage>, ClientRPCResponseResult>;
    identitiesProvidersList: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult<{
        providerIds: string[];
    }>>;
    identitiesTokenDelete: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult>;
    identitiesTokenGet: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult<Partial<TokenMessage>>>;
    identitiesTokenPut: UnaryCaller<ClientRPCRequestParams<IdentityMessage & TokenMessage>, ClientRPCResponseResult>;
    keysCertsChainGet: ServerCaller<ClientRPCRequestParams, ClientRPCResponseResult<CertMessage>>;
    keysCertsGet: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult<CertMessage>>;
    keysDecrypt: UnaryCaller<ClientRPCRequestParams<DataMessage>, ClientRPCResponseResult<DataMessage>>;
    keysEncrypt: UnaryCaller<ClientRPCRequestParams<DecryptMessage>, ClientRPCResponseResult<DataMessage>>;
    keysKeyPair: UnaryCaller<ClientRPCRequestParams<PasswordMessage>, ClientRPCResponseResult<KeyPairMessage>>;
    keysKeyPairRenew: UnaryCaller<ClientRPCRequestParams<PasswordMessage>, ClientRPCResponseResult>;
    keysKeyPairReset: UnaryCaller<ClientRPCRequestParams<PasswordMessage>, ClientRPCResponseResult>;
    keysPasswordChange: UnaryCaller<ClientRPCRequestParams<PasswordMessage>, ClientRPCResponseResult>;
    keysPublicKey: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult<PublicKeyMessage>>;
    keysSign: UnaryCaller<ClientRPCRequestParams<DataMessage>, ClientRPCResponseResult<SignatureMessage>>;
    keysVerify: UnaryCaller<ClientRPCRequestParams<VerifySignatureMessage>, ClientRPCResponseResult<SuccessMessage>>;
    nodesAdd: UnaryCaller<ClientRPCRequestParams<NodesAddMessage>, ClientRPCResponseResult>;
    nodesClaim: UnaryCaller<ClientRPCRequestParams<ClaimNodeMessage>, ClientRPCResponseResult<SuccessMessage>>;
    nodesFind: UnaryCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult<client.types.AddressMessage>>;
    nodesGetAll: ServerCaller<ClientRPCRequestParams, ClientRPCResponseResult<NodesGetMessage>>;
    nodesListConnections: ServerCaller<ClientRPCRequestParams, ClientRPCResponseResult<NodeConnectionMessage>>;
    nodesPing: UnaryCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult<SuccessMessage>>;
    notificationsClear: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult>;
    notificationsRead: ServerCaller<ClientRPCRequestParams<NotificationReadMessage>, ClientRPCResponseResult<NotificationMessage>>;
    notificationsSend: UnaryCaller<ClientRPCRequestParams<NotificationSendMessage>, ClientRPCResponseResult>;
    vaultsClone: UnaryCaller<ClientRPCRequestParams<CloneMessage>, ClientRPCResponseResult<SuccessMessage>>;
    vaultsCreate: UnaryCaller<ClientRPCRequestParams<VaultNameMessage>, ClientRPCResponseResult<VaultIdMessage>>;
    vaultsDelete: UnaryCaller<ClientRPCRequestParams<VaultIdentifierMessage>, ClientRPCResponseResult<SuccessMessage>>;
    vaultsList: ServerCaller<ClientRPCRequestParams, ClientRPCResponseResult<VaultListMessage>>;
    vaultsLog: ServerCaller<ClientRPCRequestParams<VaultsLogMessage>, ClientRPCResponseResult<LogEntryMessage>>;
    vaultsPermissionGet: ServerCaller<ClientRPCRequestParams<VaultIdentifierMessage>, ClientRPCResponseResult<VaultPermissionMessage>>;
    vaultsPermissionSet: UnaryCaller<ClientRPCRequestParams<PermissionSetMessage>, ClientRPCResponseResult<SuccessMessage>>;
    vaultsPermissionUnset: UnaryCaller<ClientRPCRequestParams<PermissionSetMessage>, ClientRPCResponseResult<SuccessMessage>>;
    vaultsPull: UnaryCaller<ClientRPCRequestParams<VaultsPullMessage>, ClientRPCResponseResult<SuccessMessage>>;
    vaultsRename: UnaryCaller<ClientRPCRequestParams<VaultsRenameMessage>, ClientRPCResponseResult<VaultIdMessage>>;
    vaultsScan: ServerCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult<client.types.VaultsScanMessage>>;
    vaultsSecretsDelete: UnaryCaller<ClientRPCRequestParams<SecretIdentifierMessage>, ClientRPCResponseResult<SuccessMessage>>;
    vaultsSecretsEdit: UnaryCaller<ClientRPCRequestParams<SecretContentMessage>, ClientRPCResponseResult<SuccessMessage>>;
    vaultsSecretsGet: UnaryCaller<ClientRPCRequestParams<SecretIdentifierMessage>, ClientRPCResponseResult<ContentMessage>>;
    vaultsSecretsList: ServerCaller<ClientRPCRequestParams<VaultIdentifierMessage>, ClientRPCResponseResult<SecretNameMessage>>;
    vaultsSecretsMkdir: UnaryCaller<ClientRPCRequestParams<SecretMkdirMessage>, ClientRPCResponseResult<SuccessMessage>>;
    vaultsSecretsNew: UnaryCaller<ClientRPCRequestParams<SecretContentMessage>, ClientRPCResponseResult<SuccessMessage>>;
    vaultsSecretsNewDir: UnaryCaller<ClientRPCRequestParams<SecretDirMessage>, ClientRPCResponseResult<SuccessMessage>>;
    vaultsSecretsRename: UnaryCaller<ClientRPCRequestParams<SecretRenameMessage>, ClientRPCResponseResult<SuccessMessage>>;
    vaultsSecretsStat: UnaryCaller<ClientRPCRequestParams<SecretIdentifierMessage>, ClientRPCResponseResult<SecretStatMessage>>;
    vaultsVersion: UnaryCaller<ClientRPCRequestParams<VaultsVersionMessage>, ClientRPCResponseResult<VaultsLatestVersionMessage>>;
}>

Type declaration

Readonly session

session: Session

Accessors

[destroyed]

  • get [destroyed](): boolean

  • Returns boolean

[eventHandled]

  • get [eventHandled](): ReadonlyWeakSet<Event>

  • Returns ReadonlyWeakSet<Event>

[eventHandlers]

  • get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>

  • Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

  • get [eventTarget](): EventTarget

  • Returns EventTarget

[handleEventError]

  • get [handleEventError](): ((evt) => void)

  • Returns ((evt) => void)

      • (evt): void

      • Parameters

        • evt: EventError

        Returns void

[running]

  • get [running](): boolean

  • Returns boolean

[statusP]

  • get [statusP](): Promise<Status>

  • Returns Promise<Status>

[status]

  • get [status](): Status

  • Returns Status

Methods

addEventListener

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

destroy

  • Returns Promise<void>

dispatchEvent

  • Parameters

    • event: Event

    Returns boolean

removeEventListener

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

start

  • Returns Promise<void>

stop

  • Returns Promise<void>

Static createPolykeyClient

  • Parameters

    • __namedParameters: {
          fresh?: boolean;
          fs?: FileSystem;
          logger?: Logger;
          nodePath?: string;
          parserBufferByteLimit?: number;
          streamFactory: StreamFactory;
          streamKeepAliveTimeoutTime?: number;
      }
      • Optional fresh?: boolean
      • Optional fs?: FileSystem
      • Optional logger?: Logger
      • Optional nodePath?: string
      • Optional parserBufferByteLimit?: number
      • streamFactory: StreamFactory
      • Optional streamKeepAliveTimeoutTime?: number

    Returns Promise<PolykeyClient>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc