martin/databag
1
0
Fork 0
mirror of https://github.com/balzack/databag.git synced 2025-04-24 10:35:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Delete app/sdk/API.md

Browse Source
This commit is contained in:
Pierre Balzack 2024-08-20 17:34:54 -07:00 committed by GitHub
parent 1539b49d65
commit 70d9303aac
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 0 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
app/sdk/API.md
View File

@ -1,65 +0,0 @@
The API for the Databag package is provided through a set of typescript interfaces. Each interface groups methods by their functionality and are only allocated as needed. The platform specific implementations of storage and cryptography are defined externally and are also provided to the SDK through interfaces.
## Initialization
<details>
<summary>The SDK must first be allocated</summary><br>
```DatabacgClientSDK(crypto: Crypto | null, log?: Logging)```
</details>
<details>
<summary>Persistent storage can then be provided to the SDK</summary><br>
Mobile apps typically use the SqlStore interface allowing for offline use cases where most of the relational data is stored
```initOfflineStore(sql: SqlStore): Promise<Session | null>```
Browser apps typically use the WebStore interface where minimal session data is stored
```initOnlineStore(web: WebStore): Promise<Session | null>```
</details>
<details>
<summary>Account communcation is provided through the Session interface</summary><br>
login provides a Session through an account login
```login(handle: string, password: string, node: string, secure: boolean, mfaCode: string | null, params: SessionParams): Promise<Session>```
access provides a Session through token access to an account when password is forgotten
```access(node: string, secure: boolean, token: string, params: SessionParams): Promise<Session>```
create provides a Session to a newly created account
```create(handle: string, password: string, node: string, secure: boolean, token: string | null, params: SessionParams): Promise<Session>```
available returns the number of accounts that can be publically created
```available(node: string, secure: boolean): Promise<number>```
username returns whether the username is available for account creation
```username(name: string, token: string, node: string, secure: boolean): Promise<boolean>```
logout releases the Session interface
```logout(session: Session, all: boolean): Promise<void>```
</details>
<details>
<summary>Admin communcation is provided through the Node interface</summary><br>
configure allocates the Node interface for the server
```configure(node: string, secure: boolean, token: string, mfaCode: string | null): Promise<Node>```
</details>
<details>
<summary>Bot communication is provided through the Bot interface</summary><br>
automate allocates the Bot interface for ia specific communication channel
```automate(node: string, secure: boolean, token: string): Promise<Bot>```
</details>