Skip to content

Commit 150b419

Browse files
authored
Bump package versions for first published 0.8.x release (#209)
* Bump package versions for 0.8.1 release * Update README files
1 parent 986c5cf commit 150b419

12 files changed

Lines changed: 112 additions & 96 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,14 @@ const { web5, did: myDid } = await Web5.connect();
121121

122122
An object which may specify any of the following properties:
123123

124+
- **`agent`** - _`Web5Agent instance`_ _(optional)_: an instance of a `Web5Agent` implementation. Defaults to creating a local `Web5UserAgent` if not provided.
125+
126+
- **`appData`** - _`AppDataStore instance`_ _(optional)_: an instance of an `AppDataStore` implementation. Defaults to a LevelDB-backed store with an insecure, static unlock passphrase if not provided. To allow the end user to enter a secure passphrase of their choosing, provide an initialized `AppDataVault`.
127+
128+
- **`connectedDid`** - _`string`_ _(optional)_: an existing DID to connect to.
129+
130+
- **`sync`** - _`string`_ _(optional)_: enable or disable synchronization of DWN records between local and remote DWNs. Sync defaults to running every 2 minutes and can be set to any value accepted by [`ms`](https://www.npmjs.com/package/ms). To disable sync set to `'off'`.
131+
124132
- **`techPreview`** - _`object`_ _(optional)_: an object that specifies configuration parameters that are relevant during the Tech Preview period of Web5 JS and may be deprecated in the future with advance notice.
125133

126134
- **`dwnEndpoints`** - _`array`_ _(optional)_: a list of DWeb Node endpoints to define in the DID created and returned by `Web5.connect()`. If this property is omitted, during the Tech Preview two nodes will be included by default (e.g., `['https://dwn.tbddev.org/dwn0', 'https://dwn.tbddev.org/dwn3']`).

package-lock.json

Lines changed: 67 additions & 67 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/agent/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@web5/agent",
3-
"version": "0.1.7",
3+
"version": "0.2.0",
44
"type": "module",
55
"main": "./dist/cjs/index.js",
66
"module": "./dist/esm/index.js",
@@ -68,9 +68,9 @@
6868
},
6969
"dependencies": {
7070
"@tbd54566975/dwn-sdk-js": "0.2.1",
71-
"@web5/common": "0.1.1",
72-
"@web5/crypto": "0.1.6",
73-
"@web5/dids": "0.1.9",
71+
"@web5/common": "0.2.0",
72+
"@web5/crypto": "0.2.0",
73+
"@web5/dids": "0.2.0",
7474
"level": "8.0.0",
7575
"readable-stream": "4.4.2",
7676
"readable-web-to-node-stream": "3.0.2"

packages/api/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,14 @@ const { web5, did: myDid } = await Web5.connect();
121121

122122
An object which may specify any of the following properties:
123123

124+
- **`agent`** - _`Web5Agent instance`_ _(optional)_: an instance of a `Web5Agent` implementation. Defaults to creating a local `Web5UserAgent` if not provided.
125+
126+
- **`appData`** - _`AppDataStore instance`_ _(optional)_: an instance of an `AppDataStore` implementation. Defaults to a LevelDB-backed store with an insecure, static unlock passphrase if not provided. To allow the end user to enter a secure passphrase of their choosing, provide an initialized `AppDataVault`.
127+
128+
- **`connectedDid`** - _`string`_ _(optional)_: an existing DID to connect to.
129+
130+
- **`sync`** - _`string`_ _(optional)_: enable or disable synchronization of DWN records between local and remote DWNs. Sync defaults to running every 2 minutes and can be set to any value accepted by [`ms`](https://www.npmjs.com/package/ms). To disable sync set to `'off'`.
131+
124132
- **`techPreview`** - _`object`_ _(optional)_: an object that specifies configuration parameters that are relevant during the Tech Preview period of Web5 JS and may be deprecated in the future with advance notice.
125133

126134
- **`dwnEndpoints`** - _`array`_ _(optional)_: a list of DWeb Node endpoints to define in the DID created and returned by `Web5.connect()`. If this property is omitted, during the Tech Preview two nodes will be included by default (e.g., `['https://dwn.tbddev.org/dwn0', 'https://dwn.tbddev.org/dwn3']`).

packages/api/package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@web5/api",
3-
"version": "0.8.0",
3+
"version": "0.8.1",
44
"description": "SDK for accessing the features and capabilities of Web5",
55
"type": "module",
66
"main": "./dist/cjs/index.js",
@@ -76,10 +76,10 @@
7676
},
7777
"dependencies": {
7878
"@tbd54566975/dwn-sdk-js": "0.2.1",
79-
"@web5/agent": "0.1.7",
80-
"@web5/crypto": "0.1.6",
81-
"@web5/dids": "0.1.9",
82-
"@web5/user-agent": "0.1.10",
79+
"@web5/agent": "0.2.0",
80+
"@web5/crypto": "0.2.0",
81+
"@web5/dids": "0.2.0",
82+
"@web5/user-agent": "0.2.0",
8383
"level": "8.0.0",
8484
"ms": "2.1.3",
8585
"readable-stream": "4.4.2",

packages/api/src/web5.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export type Web5ConnectOptions = {
3535
connectedDid?: string;
3636

3737
/** Enable synchronization of DWN records between local and remote DWNs.
38-
* Sync defaults to running every 2 minutes and get be set to any value accepted by `ms()`.
38+
* Sync defaults to running every 2 minutes and can be set to any value accepted by `ms()`.
3939
* To disable sync set to 'off'. */
4040
sync?: string;
4141

packages/common/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@web5/common",
3-
"version": "0.1.1",
3+
"version": "0.2.0",
44
"type": "module",
55
"main": "./dist/cjs/index.js",
66
"module": "./dist/esm/index.js",

0 commit comments

Comments
 (0)