v0.12

CHANGELOG.md

@@ -1,3 +1,24 @@
+## v0.12.0 (2019-12-17)
+
+### Breaking change
+
+The `Timeline` class has been split between the [`TimelineReader`](https://erebos.js.org/docs/timeline-api#timelinereader-class) and [`TimelineWriter`](https://erebos.js.org/docs/timeline-api#timelinewriter-class) classes. `TimelineWriter` extends `TimelineReader` and therefore can be used as a dropped-in replacement for `Timeline`.
+
+### Additional features
+
+- Support for [raw Swarm feeds](https://erebos.js.org/docs/api-bzz#raw-feeds-methods) has been added thanks to [Attila Gazso's pull request](https://github.com/MainframeHQ/erebos/pull/122).
+- `@erebos/api-bzz-browser` can now be used in a Web Worker thanks to [Adam Uhlíř's pull request](https://github.com/MainframeHQ/erebos/pull/128).
+- The [`uploadData()`](https://erebos.js.org/docs/api-bzz#uploaddata) and [`downloadData()`](https://erebos.js.org/docs/api-bzz#downloaddata) methods have been added to the [Bzz APIs](https://erebos.js.org/docs/api-bzz).
+- The [`Hex.from()`](https://erebos.js.org/docs/hex#hexfrom) static method has been added as a replacement for `createHex()`.
+
+### Other change
+
+HTTP error messages from Swarm are now parsed when possible thanks to [Adam Uhlíř's pull request](https://github.com/MainframeHQ/erebos/pull/129).
+
+### New package
+
+The `@erebos/feed-list` package has been added, implementing [lists data structures](https://erebos.js.org/docs/feed-list) on top of raw Swarm feeds.
+
 ## v0.11.0 (2019-11-28)
 
 This release adds support for [Readable streams](https://nodejs.org/api/stream.html#stream_class_stream_readable) in `@erebos/api-bzz-base`, thanks to [Adam Uhlíř's pull request](https://github.com/MainframeHQ/erebos/pull/116).

README.md

@@ -39,11 +39,13 @@ npm install -g @erebos/cli
 | [`@erebos/swarm-node`](/packages/swarm-node) | [![npm version](https://img.shields.io/npm/v/@erebos/swarm-node.svg)](https://www.npmjs.com/package/@erebos/swarm-node)| ⚛️ ⚙️ | Electron and Node Erebos library for Swarm
 | **CLI**
 | [`@erebos/cli`](/packages/cli) | [![npm version](https://img.shields.io/npm/v/@erebos/cli.svg)](https://www.npmjs.com/package/@erebos/cli) |
-| **Individual APIs**
+| **Individual Swarm APIs**
 | [`@erebos/api-bzz-browser`](/packages/api-bzz-browser) | [![npm version](https://img.shields.io/npm/v/@erebos/api-bzz-browser.svg)](https://www.npmjs.com/package/@erebos/api-bzz-browser) | 🌐 | Browser-only Swarm (BZZ) APIs
 | [`@erebos/api-bzz-node`](/packages/api-bzz-node) | [![npm version](https://img.shields.io/npm/v/@erebos/api-bzz-node.svg)](https://www.npmjs.com/package/@erebos/api-bzz-node) | ⚛️ ⚙️ | Electron and Node Swarm (BZZ) APIs
 | [`@erebos/api-bzz-react-native`](/packages/api-bzz-react-native) | [![npm version](https://img.shields.io/npm/v/@erebos/api-bzz-react-native.svg)](https://www.npmjs.com/package/@erebos/api-bzz-react-native) | 📱 | Experimental React Native Swarm (BZZ) APIs
 | [`@erebos/api-pss`](/packages/api-pss) | [![npm version](https://img.shields.io/npm/v/@erebos/api-pss.svg)](https://www.npmjs.com/package/@erebos/api-pss) | ⚛️ ⚙️ 📱 🌐 | Postal Services over Swarm (PSS) APIs
+| **Higher-level APIs**
+| [`@erebos/feed-list`](/packages/feed-list) | [![npm version](https://img.shields.io/npm/v/@erebos/feed-list.svg)](https://www.npmjs.com/package/@erebos/feed-list) | ⚛️ ⚙️ 📱 🌐 | List APIs using raw Swarm feeds
 | [`@erebos/timeline`](/packages/timeline) | [![npm version](https://img.shields.io/npm/v/@erebos/timeline.svg)](https://www.npmjs.com/package/@erebos/timeline) | ⚛️ ⚙️ 📱 🌐 | Feed-based Timeline APIs
 | **Ethereum and Swarm utilities**
 | [`@erebos/hex`](/packages/hex) | [![npm version](https://img.shields.io/npm/v/@erebos/hex.svg)](https://www.npmjs.com/package/@erebos/hex) | ⚛️ ⚙️ 📱 🌐 | Hexadecimal values encoding and decoding

__tests__/api-bzz-base.ts

@@ -149,6 +149,7 @@ describe('api-bzz-base', () => {
       expect(setTimeout).toHaveBeenCalledTimes(2)
 
       // Rejects with timeout error
+      // eslint-disable-next-line @typescript-eslint/no-empty-function
       fetch.mockResponseOnce(() => new Promise(() => {})) // Never resolves
       const req = bzzTimeout.fetchTimeout('test', {})
       expect(setTimeout).toHaveBeenCalledTimes(3)

__tests__/rpc-handler.ts

@@ -76,6 +76,7 @@ describe('rpc-handler', () => {
     )
     expect(() =>
       normalizeMethods({
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
         ok: () => {},
         objectFails: {
           nohandler: true,

docs/api-bzz.md

@@ -565,6 +565,17 @@ The `downloadStream()` method returns a NodeJs's compatible [`Readable` instance
 
 **Returns** `Promise<Readable>`
 
+### .downloadData()
+
+Downloads and parses JSON data.
+
+**Arguments**
+
+1.  `hashOrDomain: string`: ENS name or Swarm hash
+1.  [`options?: DownloadOptions = {}`](#downloadoptions)
+
+**Returns** `Promise<any>`
+
 ### .downloadObservable()
 
 Returns a [RxJS `Observable`](https://rxjs.dev/api/index/class/Observable) emitting the [`FileEntry`](#fileentry) objects as they are downloaded.
@@ -596,6 +607,17 @@ Uploads a single file and returns the hash. If the `contentType` option is provi
 
 **Returns** `Promise<string>`
 
+### .uploadData()
+
+Stringifies and uploads JSON data.
+
+**Arguments**
+
+1.  `data: any`
+1.  [`options: UploadOptions = {}`](#uploadoptions)
+
+**Returns** `Promise<string>`
+
 ### .uploadDirectory()
 
 Uploads multiple files and returns the hash of the manifest containing these files.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "erebos-project",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Swarm client and tools",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "license": "MIT",

packages/api-bzz-base/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erebos/api-bzz-base",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Base Bzz API",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "cjs/index.js",
@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.7.6",
-    "@erebos/hex": "^0.11.0",
+    "@erebos/hex": "^0.12.0",
     "@erebos/keccak256": "^0.11.0",
     "readable-stream": "^3.1.1",
     "rxjs": "^6.5.3",

packages/api-bzz-browser/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erebos/api-bzz-browser",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Bzz API for browser",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "cjs/index.js",
@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.7.6",
-    "@erebos/api-bzz-base": "^0.11.0",
+    "@erebos/api-bzz-base": "^0.12.0",
     "readable-stream": "^3.4.0"
   },
   "devDependencies": {

packages/api-bzz-node/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erebos/api-bzz-node",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Bzz API for node",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "lib/index.js",
@@ -21,7 +21,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.7.6",
-    "@erebos/api-bzz-base": "^0.11.0",
+    "@erebos/api-bzz-base": "^0.12.0",
     "form-data": "^3.0.0",
     "fs-extra": "^8.0.1",
     "node-fetch": "^2.6.0",
@@ -30,7 +30,7 @@
   },
   "devDependencies": {
     "@types/fs-extra": "^8.0.1",
-    "@types/node": "^12.12.17",
+    "@types/node": "^12.12.18",
     "@types/node-fetch": "^2.5.4",
     "@types/tar-fs": "^1.16.1",
     "@types/tar-stream": "^1.6.1"

packages/api-bzz-react-native/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erebos/api-bzz-react-native",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Bzz API for react-native",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "cjs/index.js",
@@ -24,7 +24,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.7.6",
-    "@erebos/api-bzz-base": "^0.11.0",
+    "@erebos/api-bzz-base": "^0.12.0",
     "universal-url": "^2.0.0"
   }
 }

packages/api-pss/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erebos/api-pss",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "PSS API",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "cjs/index.js",
@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.7.6",
-    "@erebos/hex": "^0.11.0",
+    "@erebos/hex": "^0.12.0",
     "@erebos/rpc-stream": "^0.11.0",
     "rxjs": "^6.5.3"
   }

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erebos/cli",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Command-line interface for Swarm",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "lib/index.js",
@@ -51,16 +51,16 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.7.6",
-    "@erebos/api-bzz-node": "^0.11.0",
-    "@erebos/api-pss": "^0.11.0",
-    "@erebos/hex": "^0.11.0",
+    "@erebos/api-bzz-node": "^0.12.0",
+    "@erebos/api-pss": "^0.12.0",
+    "@erebos/hex": "^0.12.0",
     "@erebos/keccak256": "^0.11.0",
     "@erebos/secp256k1": "^0.10.0",
-    "@erebos/swarm-node": "^0.11.0",
-    "@erebos/timeline": "^0.11.0",
+    "@erebos/swarm-node": "^0.12.0",
+    "@erebos/timeline": "^0.12.0",
     "@oclif/command": "^1.5.19",
     "@oclif/config": "^1.13.3",
-    "@oclif/plugin-help": "^2.2.2",
+    "@oclif/plugin-help": "^2.2.3",
     "fs-extra": "^8.0.1",
     "ora": "^4.0.3",
     "update-notifier": "^4.0.0"

packages/feed-list/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erebos/feed-list",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Feed-based list data structure",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "cjs/index.js",
@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.7.6",
-    "@erebos/api-bzz-base": "^0.11.0",
-    "@erebos/hex": "^0.11.0"
+    "@erebos/api-bzz-base": "^0.12.0",
+    "@erebos/hex": "^0.12.0"
   }
 }

packages/hex/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erebos/hex",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Hex conversion utilities",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "cjs/index.js",

packages/rpc-base/package.json

@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.7.6",
-    "nanoid": "^2.1.7"
+    "nanoid": "^2.1.8"
   },
   "devDependencies": {
     "@types/nanoid": "^2.1.0"

packages/swarm-browser/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erebos/swarm-browser",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Swarm client for browser",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "cjs/index.js",
@@ -30,9 +30,9 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.7.6",
-    "@erebos/api-bzz-base": "^0.11.0",
-    "@erebos/api-bzz-browser": "^0.11.0",
-    "@erebos/api-pss": "^0.11.0",
+    "@erebos/api-bzz-base": "^0.12.0",
+    "@erebos/api-bzz-browser": "^0.12.0",
+    "@erebos/api-pss": "^0.12.0",
     "@erebos/client-base": "^0.11.0",
     "@erebos/rpc-browser": "^0.11.0",
     "@erebos/rpc-stream": "^0.11.0",
@@ -41,7 +41,7 @@
   "devDependencies": {
     "babel-loader": "^8.0.5",
     "terser-webpack-plugin": "^2.3.0",
-    "webpack": "^4.40.2",
+    "webpack": "^4.41.3",
     "webpack-cli": "^3.3.8"
   }
 }

packages/swarm-node/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erebos/swarm-node",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Swarm client for node",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "lib/index.js",
@@ -21,9 +21,9 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.7.6",
-    "@erebos/api-bzz-base": "^0.11.0",
-    "@erebos/api-bzz-node": "^0.11.0",
-    "@erebos/api-pss": "^0.11.0",
+    "@erebos/api-bzz-base": "^0.12.0",
+    "@erebos/api-bzz-node": "^0.12.0",
+    "@erebos/api-pss": "^0.12.0",
     "@erebos/client-base": "^0.11.0",
     "@erebos/rpc-ipc": "^0.11.0",
     "@erebos/rpc-node": "^0.11.0",

packages/swarm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erebos/swarm",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Swarm client",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "index.js",
@@ -12,7 +12,7 @@
     "browser.js"
   ],
   "dependencies": {
-    "@erebos/swarm-browser": "^0.11.0",
-    "@erebos/swarm-node": "^0.11.0"
+    "@erebos/swarm-browser": "^0.12.0",
+    "@erebos/swarm-node": "^0.12.0"
   }
 }

packages/timeline/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erebos/timeline",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Linked-list data structure for Swarm feeds",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "cjs/index.js",
@@ -30,15 +30,15 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.7.6",
-    "@erebos/api-bzz-base": "^0.11.0",
+    "@erebos/api-bzz-base": "^0.12.0",
     "rxjs": "^6.5.3",
     "semver": "^6.3.0"
   },
   "devDependencies": {
     "@types/semver": "^6.0.2",
     "babel-loader": "^8.0.5",
     "terser-webpack-plugin": "^2.3.0",
-    "webpack": "^4.40.2",
+    "webpack": "^4.41.3",
     "webpack-cli": "^3.3.8"
   }
 }

packages/timeline/src/index.ts

@@ -9,7 +9,7 @@ import {
 } from '@erebos/api-bzz-base'
 import { Observable, Observer } from 'rxjs'
 import { flatMap } from 'rxjs/operators'
-import semver from 'semver'
+import { satisfies as semverSatisfies, valid as semverValid } from 'semver'
 
 export const PROTOCOL = 'timeline'
 export const VERSION = '1.0.0'
@@ -87,8 +87,8 @@ export function validateChapter<T extends MaybeChapter>(chapter: T): T {
     throw new Error('Unsupported protocol')
   }
   if (
-    semver.valid(chapter.version) === null ||
-    !semver.satisfies(chapter.version, VERSION_RANGE)
+    semverValid(chapter.version) === null ||
+    !semverSatisfies(chapter.version, VERSION_RANGE)
   ) {
     throw new Error('Unsupported protocol version')
   }