Class Client

Hierarchy

Base
- Client

Index

Constructors

Properties

Methods

_invocationConfig addProof addSpace agent createDelegation createSpace currentSpace delegations proofs registerSpace setCurrentSpace spaces uploadDirectory uploadFile

Constructors

constructor

new Client(agentData: AgentData, options?: {
serviceConf: undefined | ServiceConf;
}): Client
Parameters
- agentData: AgentData
- Optional options: {
  serviceConf: undefined | ServiceConf;
  }
  - serviceConf: undefined | ServiceConf
Returns Client
Overrides Base.constructor
- Defined in src/client.js:16

Properties

`Protected` _agent

_agent: Agent

`Protected` _serviceConf

_serviceConf: ServiceConf

capability

capability: {
    space: SpaceClient;
    store: StoreClient;
    upload: UploadClient;
}

Type declaration

space: SpaceClient
store: StoreClient
upload: UploadClient

Methods

`Protected` _invocationConfig

_invocationConfig(abilities: Ability[]): Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:${string}:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:${string}:${string}`;
}>
Protected
Parameters
- abilities: Ability[]
Returns Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:${string}:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:${string}:${string}`;
}>
Inherited from Base._invocationConfig
- Defined in src/base.js:36

addProof

addProof(proof: Delegation<Capabilities>): Promise<void>
Add a proof to the agent. Proofs are delegations with an audience matching the agent DID.
Parameters
- proof: Delegation<Capabilities>
Returns Promise<void>
- Defined in src/client.js:139

addSpace

addSpace(proof: Delegation<Capabilities>): Promise<Space>
Add a space from a received proof.
Parameters
- proof: Delegation<Capabilities>
Returns Promise<Space>
- Defined in src/client.js:116

agent

agent(): Signer<`did:${string}:${string}`, SigAlg>
The current user agent (this device).

Returns Signer<`did:${string}:${string}`, SigAlg>
- Defined in src/client.js:55

createDelegation

createDelegation(audience: Principal<`did:${string}:${string}`>, abilities: TupleToUnion<AbilitiesArray>[], options??: Omit<UCANOptions, "audience"> & {
audienceMeta?: AgentMeta;
}): Promise<Delegation<Capabilities>>
Create a delegation to the passed audience for the given abilities with the current space as the resource.
Parameters
- audience: Principal<`did:${string}:${string}`>
- abilities: TupleToUnion<AbilitiesArray>[]
- Optional options: Omit<UCANOptions, "audience"> & {
  audienceMeta?: AgentMeta;
  } = {}
Returns Promise<Delegation<Capabilities>>
- Defined in src/client.js:165

createSpace

createSpace(name?: string): Promise<Space>
Create a new space with an optional name.
Parameters
- Optional name: string
Returns Promise<Space>
- Defined in src/client.js:88

currentSpace

currentSpace(): undefined | Space
The current space.

Returns undefined | Space
- Defined in src/client.js:62

delegations

delegations(caps?: Capability<Ability, `${string}:${string}`, any>[]): Delegation<Capabilities>[]
Get delegations created by the agent for others.
Parameters
- Optional caps: Capability<Ability, `${string}:${string}`, any>[]
  
  Capabilities to filter by. Empty or undefined caps with return all the delegations.
Returns Delegation<Capabilities>[]
- Defined in src/client.js:149

proofs

proofs(caps?: Capability<Ability, `${string}:${string}`, any>[]): Delegation<Capabilities>[]
Get all the proofs matching the capabilities.

Proofs are delegations with an audience matching the agent DID.
Parameters
- Optional caps: Capability<Ability, `${string}:${string}`, any>[]
  
  Capabilities to filter by. Empty or undefined caps with return all the proofs.
Returns Delegation<Capabilities>[]
- Defined in src/client.js:129

registerSpace

registerSpace(email: string, options?: {
signal: undefined | AbortSignal;
}): Promise<void>
Register the current space with the service.

Invokes voucher/redeem for the free tier, waits on the websocket for the voucher/claim and invokes it.

It also adds a full space delegation to the service in the voucher/claim invocation to allow for recovery.
Parameters
- email: string
- Optional options: {
  signal: undefined | AbortSignal;
  }
  - signal: undefined | AbortSignal
Returns Promise<void>
- Defined in src/client.js:107

setCurrentSpace

setCurrentSpace(did: `did:${string}:${string}`): Promise<void>
Use a specific space.
Parameters
- did: `did:${string}:${string}`
Returns Promise<void>
- Defined in src/client.js:72

spaces

spaces(): Space[]
Spaces available to this agent.

Returns Space[]
- Defined in src/client.js:79

uploadDirectory

uploadDirectory(files: FileLike[], options??: UploadOptions): Promise<AnyLink>
Uploads a directory of files to the service and returns the root data CID for the generated DAG. All files are added to a container directory, with paths in file names preserved.
Parameters
- files: FileLike[]
  
  File data.
- Optional options: UploadOptions = {}
Returns Promise<AnyLink>
- Defined in src/client.js:46

uploadFile

uploadFile(file: BlobLike, options??: UploadOptions): Promise<AnyLink>
Uploads a file to the service and returns the root data CID for the generated DAG.
Parameters
- file: BlobLike
  
  File data.
- Optional options: UploadOptions = {}
Returns Promise<AnyLink>
- Defined in src/client.js:32

Class Client

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

agentData: AgentData

Optional options: { serviceConf: undefined | ServiceConf; }

serviceConf: undefined | ServiceConf

Returns Client

Properties

Protected _agent

Protected _serviceConf

capability

Type declaration

space: SpaceClient

store: StoreClient

upload: UploadClient

Methods

Protected _invocationConfig

Parameters

abilities: Ability[]

Returns Promise<{ audience: Principal<`did:${string}:${string}`>; issuer: Signer<`did:${string}:${string}`, SigAlg>; proofs: Delegation<Capabilities>[]; with: `did:${string}:${string}`; }>

addProof

Parameters

proof: Delegation<Capabilities>

Returns Promise<void>

addSpace

Parameters

proof: Delegation<Capabilities>

Returns Promise<Space>

agent

Returns Signer<`did:${string}:${string}`, SigAlg>

createDelegation

Parameters

audience: Principal<`did:${string}:${string}`>

abilities: TupleToUnion<AbilitiesArray>[]

Optional options: Omit<UCANOptions, "audience"> & { audienceMeta?: AgentMeta; } = {}

Returns Promise<Delegation<Capabilities>>

createSpace

Parameters

Optional name: string

Returns Promise<Space>

currentSpace

Returns undefined | Space

delegations

Parameters

Optional caps: Capability<Ability, `${string}:${string}`, any>[]

Returns Delegation<Capabilities>[]

proofs

Parameters

Optional caps: Capability<Ability, `${string}:${string}`, any>[]

Returns Delegation<Capabilities>[]

registerSpace

Parameters

email: string

Optional options: { signal: undefined | AbortSignal; }

signal: undefined | AbortSignal

Returns Promise<void>

setCurrentSpace

Parameters

did: `did:${string}:${string}`

Returns Promise<void>

spaces

Returns Space[]

uploadDirectory

Parameters

files: FileLike[]

Optional options: UploadOptions = {}

Returns Promise<AnyLink>

uploadFile

Parameters

file: BlobLike

Optional options: UploadOptions = {}

Returns Promise<AnyLink>

Settings

Member Visibility

`Optional` options: {
serviceConf: undefined | ServiceConf;
}

`Protected` _agent

`Protected` _serviceConf

`Protected` _invocationConfig

Returns Promise<{
audience: Principal<`did:${string}:${string}`>;
issuer: Signer<`did:${string}:${string}`, SigAlg>;
proofs: Delegation<Capabilities>[];
with: `did:${string}:${string}`;
}>

`Optional` options: Omit<UCANOptions, "audience"> & {
audienceMeta?: AgentMeta;
} = {}

`Optional` name: string

`Optional` caps: Capability<Ability, `${string}:${string}`, any>[]

`Optional` caps: Capability<Ability, `${string}:${string}`, any>[]

`Optional` options: {
signal: undefined | AbortSignal;
}

`Optional` options: UploadOptions = {}

`Optional` options: UploadOptions = {}