Class BasePodStore

A PodStore implementation using a PodManager to create pods and a AccountLoginStorage to store the data. Needs to be initialized before it can be used.

Adds the initial WebID as the owner of the pod. By default, this owner is not exposed through a link header. This can be changed by setting the constructor visible parameter to true.

Hierarchy (view full)

Initializer
- BasePodStore

Implements

PodStore

Index

Constructors

constructor

Methods

canHandle create findByBaseUrl findPods get getOwners handle handleSafe removeOwner updateOwner

Constructors

constructor

new BasePodStore(storage, manager, visible?): BasePodStore
Parameters
- storage: AccountLoginStorage<Record<string, never>>
- manager: PodManager
- visible: boolean = false
Returns BasePodStore
Overrides Initializer.constructor
- Defined in src/identity/interaction/pod/util/BasePodStore.ts:48

Methods

canHandle

canHandle(input): Promise<void>
Checks whether the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.
Parameters
- input: void
  Input that could potentially be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from Initializer.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:18

create

create(accountId, settings, overwrite): Promise<string>
Creates a new pod and updates the account accordingly.
Parameters
- accountId: string
  Identifier of the account that is creating the account.
- settings: PodSettings
  Settings to create a pod with.
- overwrite: boolean
  If the pod is allowed to overwrite existing data.
Returns Promise<string>
The ID of the new pod resource.
Implementation of PodStore.create
- Defined in src/identity/interaction/pod/util/BasePodStore.ts:72

findByBaseUrl

findByBaseUrl(baseUrl): Promise<undefined | {
accountId: string;
id: string;
}>
Find the ID of the account that created the given pod.
Parameters
- baseUrl: string
  The pod base URL.
Returns Promise<undefined | {
accountId: string;
id: string;
}>
Implementation of PodStore.findByBaseUrl
- Defined in src/identity/interaction/pod/util/BasePodStore.ts:98

findPods

findPods(accountId): Promise<{
baseUrl: string;
id: string;
}[]>
Find all the pod resources created by the given account ID.
Parameters
- accountId: string
  Account ID to find pod resources for.
Returns Promise<{
baseUrl: string;
id: string;
}[]>
Implementation of PodStore.findPods
- Defined in src/identity/interaction/pod/util/BasePodStore.ts:106

get

get(id): Promise<undefined | {
accountId: string;
baseUrl: string;
}>
Returns the baseURl and account that created the pod for the given pod ID.
Parameters
- id: string
  ID of the pod.
Returns Promise<undefined | {
accountId: string;
baseUrl: string;
}>
Implementation of PodStore.get
- Defined in src/identity/interaction/pod/util/BasePodStore.ts:90

getOwners

getOwners(id): Promise<undefined | {
visible: boolean;
webId: string;
}[]>
Find all owners for the given pod ID.
Parameters
- id: string
  ID of the pod.
Returns Promise<undefined | {
visible: boolean;
webId: string;
}[]>
Implementation of PodStore.getOwners
- Defined in src/identity/interaction/pod/util/BasePodStore.ts:111

handle

handle(): Promise<void>
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Returns Promise<void>
A promise resolving when handling is finished.
Overrides Initializer.handle
- Defined in src/identity/interaction/pod/util/BasePodStore.ts:56

handleSafe

handleSafe(input): Promise<void>
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.
Parameters
- input: void
  Input data that will be handled if it can be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from Initializer.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:41

removeOwner

removeOwner(id, webId): Promise<void>
Remove an owner from a pod. This should not remove the last owner as a pod always needs to have at least one owner. https://solidproject.org/TR/2022/protocol-20221231#server-storage-track-owner
Parameters
- id: string
  ID of the pod.
- webId: string
  WebID of the owner.
Returns Promise<void>
Implementation of PodStore.removeOwner
- Defined in src/identity/interaction/pod/util/BasePodStore.ts:131

updateOwner

updateOwner(id, webId, visible): Promise<void>
Add or update an owner of a pod. In case there already is an owner with this WebID, it will be updated, otherwise a new owner will be added.
Parameters
- id: string
  ID of the pod.
- webId: string
  WebID of the owner.
- visible: boolean
  Whether the owner wants to be exposed or not.
Returns Promise<void>
Implementation of PodStore.updateOwner
- Defined in src/identity/interaction/pod/util/BasePodStore.ts:120

Class BasePodStore

Hierarchy (view full)

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BasePodStore

Methods

canHandle

Parameters

Returns Promise<void>

create

Parameters

Returns Promise<string>

findByBaseUrl

Parameters

Returns Promise<undefined | { accountId: string; id: string; }>

findPods

Parameters

Returns Promise<{ baseUrl: string; id: string; }[]>

get

Parameters

Returns Promise<undefined | { accountId: string; baseUrl: string; }>

getOwners

Parameters

Returns Promise<undefined | { visible: boolean; webId: string; }[]>

handle

Returns Promise<void>

handleSafe

Parameters

Returns Promise<void>

removeOwner

Parameters

Returns Promise<void>

updateOwner

Parameters

Returns Promise<void>

Settings

On This Page

Returns Promise<undefined | {
accountId: string;
id: string;
}>

Returns Promise<{
baseUrl: string;
id: string;
}[]>

Returns Promise<undefined | {
accountId: string;
baseUrl: string;
}>

Returns Promise<undefined | {
visible: boolean;
webId: string;
}[]>