Bump package versions for first published 0.8.x release (#209)

* Bump package versions for 0.8.1 release * Update README files
TBD54566975 · Sep 6, 2023 · 150b419 · 150b419
1 parent 986c5cf
commit 150b419
Show file tree

Hide file tree

Showing 12 changed files with 112 additions and 96 deletions.
diff --git a/README.md b/README.md
@@ -121,6 +121,14 @@ const { web5, did: myDid } = await Web5.connect();
 
 An object which may specify any of the following properties:
 
+- **`agent`** - _`Web5Agent instance`_ _(optional)_: an instance of a `Web5Agent` implementation. Defaults to creating a local `Web5UserAgent` if not provided.
+
+- **`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`.
+
+- **`connectedDid`** - _`string`_ _(optional)_: an existing DID to connect to.
+
+- **`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'`.
+
 - **`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.
 
   - **`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']`).

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/agent/package.json b/packages/agent/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@web5/agent",
-  "version": "0.1.7",
+  "version": "0.2.0",
   "type": "module",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -68,9 +68,9 @@
   },
   "dependencies": {
     "@tbd54566975/dwn-sdk-js": "0.2.1",
-    "@web5/common": "0.1.1",
-    "@web5/crypto": "0.1.6",
-    "@web5/dids": "0.1.9",
+    "@web5/common": "0.2.0",
+    "@web5/crypto": "0.2.0",
+    "@web5/dids": "0.2.0",
     "level": "8.0.0",
     "readable-stream": "4.4.2",
     "readable-web-to-node-stream": "3.0.2"

diff --git a/packages/api/README.md b/packages/api/README.md
@@ -121,6 +121,14 @@ const { web5, did: myDid } = await Web5.connect();
 
 An object which may specify any of the following properties:
 
+- **`agent`** - _`Web5Agent instance`_ _(optional)_: an instance of a `Web5Agent` implementation. Defaults to creating a local `Web5UserAgent` if not provided.
+
+- **`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`.
+
+- **`connectedDid`** - _`string`_ _(optional)_: an existing DID to connect to.
+
+- **`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'`.
+
 - **`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.
 
   - **`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']`).

diff --git a/packages/api/package.json b/packages/api/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@web5/api",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "SDK for accessing the features and capabilities of Web5",
   "type": "module",
   "main": "./dist/cjs/index.js",
@@ -76,10 +76,10 @@
   },
   "dependencies": {
     "@tbd54566975/dwn-sdk-js": "0.2.1",
-    "@web5/agent": "0.1.7",
-    "@web5/crypto": "0.1.6",
-    "@web5/dids": "0.1.9",
-    "@web5/user-agent": "0.1.10",
+    "@web5/agent": "0.2.0",
+    "@web5/crypto": "0.2.0",
+    "@web5/dids": "0.2.0",
+    "@web5/user-agent": "0.2.0",
     "level": "8.0.0",
     "ms": "2.1.3",
     "readable-stream": "4.4.2",

diff --git a/packages/api/src/web5.ts b/packages/api/src/web5.ts
@@ -35,7 +35,7 @@ export type Web5ConnectOptions = {
   connectedDid?: string;
 
   /** Enable synchronization of DWN records between local and remote DWNs.
-   * Sync defaults to running every 2 minutes and get be set to any value accepted by `ms()`.
+   * Sync defaults to running every 2 minutes and can be set to any value accepted by `ms()`.
    * To disable sync set to 'off'. */
   sync?: string;
 

diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@web5/common",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "type": "module",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",