Fixes for v0.13.2

MainframeOS · Jan 20, 2020 · cbd3ace · cbd3ace
1 parent a3a199f
commit cbd3ace
Show file tree

Hide file tree

Showing 25 changed files with 176 additions and 197 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## v0.13.2 (2020-01-20)
+
+- Fix providing the `signParams` to `DataListWriter` constructors in `@erebos/doc-sync`.
+- Remove duplicate `@erebos/bzz` types from `@erebos/bzz-feed`.
+
 ## v0.13.1 (2020-01-16)
 
 - Fix type signature of the `write()` method of `TimelineWriter`.

diff --git a/__tests__/doc-sync.ts b/__tests__/doc-sync.ts
@@ -3,6 +3,7 @@ import {
   DocWriter,
   DocSubscriber,
   DocSynchronizer,
+  FeedFactoryParams,
   downloadDoc,
   downloadMeta,
 } from '@erebos/doc-sync'
@@ -12,13 +13,10 @@ import { DataListReader } from '@erebos/feed-list'
 import { pubKeyToAddress } from '@erebos/keccak256'
 import { createKeyPair, sign } from '@erebos/secp256k1'
 
-interface FeedUser {
-  user: string
-}
-
 interface Config {
   bzz: BzzFeed<any, any>
-  feed: FeedUser
+  feed: FeedFactoryParams
+  signParams: any
 }
 
 describe('doc-sync', () => {
@@ -27,11 +25,11 @@ describe('doc-sync', () => {
     const user = pubKeyToAddress(keyPair.getPublic('array'))
     const bzz = new BzzFeed({
       bzz: new BzzNode({ url: 'http://localhost:8500' }),
-      signBytes: (bytes: Array<number>) => {
-        return Promise.resolve(sign(bytes, keyPair))
+      signBytes: (bytes: Array<number>, key) => {
+        return Promise.resolve(sign(bytes, key))
       },
     })
-    return { bzz, feed: { user } }
+    return { bzz, feed: { user }, signParams: keyPair }
   }
 
   describe('DocReader and DocWriter', () => {

diff --git a/docs/doc-sync.md b/docs/doc-sync.md
@@ -96,11 +96,11 @@ interface MetaSnapshot {
 
 ### MetaContent
 
-Uses [FeedParams](bzz-feed.md#feedparams) and [MetaSnapshot](#metasnapshot)
+Uses [Feed](bzz-feed.md#feed) and [MetaSnapshot](#metasnapshot)
 
 ```typescript
 interface MetaContent {
-  dataFeed: FeedParams
+  dataFeed: Feed
   snapshot?: MetaSnapshot | undefined
 }
 ```
@@ -132,35 +132,35 @@ interface MetaPayload extends MetaContent, ProtocolContent {}
 
 ### DocFeeds
 
-Uses [FeedParams](bzz-feed.md#feedparams)
+Uses [Feed](bzz-feed.md#feed)
 
 ```typescript
 interface DocFeeds {
-  data: FeedParams
-  meta: FeedParams
+  data: Feed
+  meta: Feed
 }
 ```
 
 ### DocSerialized
 
-Uses [FeedParams](bzz-feed.md#feedparams)
+Uses [Feed](bzz-feed.md#feed) and [FeedParams](bzz-feed.md#feedparams)
 
 ```typescript
 interface DocSerialized {
   docString: string
   dataFeed: FeedParams
-  metaFeed: FeedParams
+  metaFeed: Feed
 }
 ```
 
 ### LoadDocReaderParams
 
-Uses [FeedParams](bzz-feed.md#feedparams) and [Bzz](#bzz)
+Uses [Feed](bzz-feed.md#feed) and [Bzz](#bzz)
 
 ```typescript
 interface LoadDocReaderParams<B extends Bzz = Bzz> {
   bzz: B
-  feed: FeedParams // params for meta feed
+  feed: Feed // meta feed
 }
 ```
 
@@ -178,13 +178,13 @@ interface FromJSONDocReaderParams<B extends Bzz = Bzz> extends DocSerialized {
 
 ### DocReaderParams
 
-Uses [FeedParams](bzz-feed.md#feedparams), [DataListReader class](feed-list.md#datalistreader-class), [Bzz](#bzz), [Doc](#doc) and [DataPayload](#datapayload)
+Uses [Feed](bzz-feed.md#feed), [DataListReader class](feed-list.md#datalistreader-class), [Bzz](#bzz), [Doc](#doc) and [DataPayload](#datapayload)
 
 ```typescript
 interface DocReaderParams<T, B extends Bzz = Bzz> {
   bzz: B
   doc: Doc<T>
-  feed: FeedParams
+  feed: Feed
   list: DataListReader<DataPayload, B>
   time: number
 }
@@ -237,6 +237,7 @@ Uses [Bzz](#bzz) and [FeedFactoryParams](#feedfactoryparams)
 interface CreateDocWriterParams<B extends Bzz = Bzz> {
   bzz: B
   feed: FeedFactoryParams
+  signParams?: any
   snapshotFrequency?: number
 }
 ```
@@ -263,6 +264,7 @@ Uses [Bzz](#bzz)
 ```typescript
 interface FromJSONDocWriterParams<B extends Bzz = Bzz>
   extends FromJSONDocReaderParams<B> {
+  signParams?: any
   snapshotFrequency?: number
 }
 ```
@@ -276,20 +278,22 @@ Uses [Bzz](#bzz)
 ```typescript
 interface LoadDocWriterParams<B extends Bzz = Bzz>
   extends LoadDocReaderParams<B> {
+  signParams?: any
   snapshotFrequency?: number
 }
 ```
 
 ### DocWriterParams
 
-Uses [FeedParams](bzz-feed.md#feedparams), [DataListWriter class](feed-list.md#datalistwriter-class), [Bzz](#bzz), [Doc](#doc) and [DataPayload](#datapayload)
+Uses [Feed](bzz-feed.md#feed), [DataListWriter class](feed-list.md#datalistwriter-class), [Bzz](#bzz), [Doc](#doc) and [DataPayload](#datapayload)
 
 ```typescript
 interface DocWriterParams<T, B extends Bzz = Bzz> {
   bzz: B
   doc: Doc<T>
-  feed: FeedParams
+  feed: Feed
   list: DataListWriter<DataPayload, B>
+  signParams?: any
   snapshotFrequency?: number
 }
 ```
@@ -298,14 +302,14 @@ interface DocWriterParams<T, B extends Bzz = Bzz> {
 
 Extends [InitDocWriterParams](#initdocwriterparams)
 
-Uses [FeedParams](bzz-feed.md#feedparams) and [Bzz](#bzz)
+Uses [Feed](bzz-feed.md#feed) and [Bzz](#bzz)
 
 ```typescript
 interface InitDocSynchronizerParams<T, B extends Bzz = Bzz>
   extends InitDocWriterParams<T, B> {
   pullInterval: number
   pushInterval?: number
-  sources?: Array<FeedParams>
+  sources?: Array<Feed>
 }
 ```
 
@@ -328,14 +332,14 @@ interface FromJSONDocSynchronizerParams<B extends Bzz = Bzz>
 
 Extends [LoadDocWriterParams](#loaddocwriterparams)
 
-Uses [FeedParams](bzz-feed.md#feedparams) and [Bzz](#bzz)
+Uses [Feed](bzz-feed.md#feed) and [Bzz](#bzz)
 
 ```typescript
 interface LoadDocSynchronizerParams<B extends Bzz = Bzz>
   extends LoadDocWriterParams<B> {
   pullInterval: number
   pushInterval?: number
-  sources?: Array<FeedParams>
+  sources?: Array<Feed>
 }
 ```
 
@@ -399,7 +403,7 @@ Creates a `DocReader` instance loading the remote document
 
 ### .metaFeed
 
-**Returns** [`FeedParams`](bzz-feed.md#feedparams)
+**Returns** [`Feed`](bzz-feed.md#feed)
 
 ### .pull()
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "erebos-project",
-  "version": "0.13.1",
+  "version": "0.13.2",
   "description": "Swarm client and tools",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "license": "MIT",
@@ -25,7 +25,7 @@
     "@babel/plugin-transform-runtime": "^7.8.3",
     "@babel/preset-env": "^7.8.3",
     "@babel/preset-typescript": "^7.8.3",
-    "@types/expect-puppeteer": "^3.3.3",
+    "@types/expect-puppeteer": "^4.4.0",
     "@types/jest": "^24.9.0",
     "@types/jest-environment-puppeteer": "^4.3.1",
     "@types/puppeteer": "^2.0.0",
@@ -41,6 +41,6 @@
     "prettier": "~1.19.1",
     "puppeteer": "^2.0.0",
     "ts-jest": "^24.3.0",
-    "typescript": "~3.7.4"
+    "typescript": "~3.7.5"
   }
 }
diff --git a/packages/bzz-feed/package.json b/packages/bzz-feed/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@erebos/bzz-feed",
-  "version": "0.13.1",
+  "version": "0.13.2",
   "description": "Bzz Feed API",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "cjs/index.js",

diff --git a/packages/bzz-feed/src/index.ts b/packages/bzz-feed/src/index.ts
@@ -2,6 +2,7 @@ import {
   BZZ_MODE_PROTOCOLS,
   Bzz,
   DownloadOptions,
+  FetchOptions,
   HTTPError,
   Response,
   UploadOptions,
@@ -26,7 +27,6 @@ import {
   FeedMetadata,
   FeedParams,
   FeedUpdateParams,
-  FetchOptions,
   PollFeedOptions,
   PollFeedContentHashOptions,
   PollFeedContentOptions,

diff --git a/packages/bzz-feed/src/types.ts b/packages/bzz-feed/src/types.ts
@@ -23,11 +23,6 @@ export interface FeedTopicParams {
   topic?: string
 }
 
-export interface FetchOptions {
-  headers?: Record<string, any>
-  timeout?: number
-}
-
 export interface PollFeedOptions extends PollOptions {
   whenEmpty?: 'accept' | 'ignore' | 'error' // defaults to 'accept'
   trigger?: Observable<void>
@@ -41,31 +36,6 @@ export interface PollFeedContentOptions
   extends DownloadOptions,
     PollFeedContentHashOptions {}
 
-export interface PinOptions extends FetchOptions {
-  download?: boolean
-  raw?: boolean
-}
-
-export interface PinnedFile {
-  address: string
-  counter: number
-  raw: boolean
-  size: number
-}
-
-export interface Tag {
-  uid: number
-  name: string
-  address: string
-  total: number
-  split: number
-  seen: number
-  stored: number
-  sent: number
-  synced: number
-  startedAt: Date
-}
-
 export interface FeedParams {
   user: string
   level?: number

diff --git a/packages/bzz-feed/types/index.d.ts b/packages/bzz-feed/types/index.d.ts
@@ -1,9 +1,9 @@
 /// <reference types="node" />
-import { Bzz, DownloadOptions, Response, UploadOptions } from '@erebos/bzz';
+import { Bzz, DownloadOptions, FetchOptions, Response, UploadOptions } from '@erebos/bzz';
 import { hexInput, hexValue } from '@erebos/hex';
 import { Observable } from 'rxjs';
 import { FeedID } from './feed';
-import { BzzFeedConfig, FeedMetadata, FeedParams, FeedUpdateParams, FetchOptions, PollFeedOptions, PollFeedContentHashOptions, PollFeedContentOptions, SignBytesFunc } from './types';
+import { BzzFeedConfig, FeedMetadata, FeedParams, FeedUpdateParams, PollFeedOptions, PollFeedContentHashOptions, PollFeedContentOptions, SignBytesFunc } from './types';
 export * from './feed';
 export * from './types';
 export declare class BzzFeed<S, R extends Response<S>> {

diff --git a/packages/bzz-feed/types/types.d.ts b/packages/bzz-feed/types/types.d.ts
@@ -18,10 +18,6 @@ export interface FeedTopicParams {
     name?: string;
     topic?: string;
 }
-export interface FetchOptions {
-    headers?: Record<string, any>;
-    timeout?: number;
-}
 export interface PollFeedOptions extends PollOptions {
     whenEmpty?: 'accept' | 'ignore' | 'error';
     trigger?: Observable<void>;
@@ -31,28 +27,6 @@ export interface PollFeedContentHashOptions extends PollFeedOptions {
 }
 export interface PollFeedContentOptions extends DownloadOptions, PollFeedContentHashOptions {
 }
-export interface PinOptions extends FetchOptions {
-    download?: boolean;
-    raw?: boolean;
-}
-export interface PinnedFile {
-    address: string;
-    counter: number;
-    raw: boolean;
-    size: number;
-}
-export interface Tag {
-    uid: number;
-    name: string;
-    address: string;
-    total: number;
-    split: number;
-    seen: number;
-    stored: number;
-    sent: number;
-    synced: number;
-    startedAt: Date;
-}
 export interface FeedParams {
     user: string;
     level?: number;

diff --git a/packages/bzz-fs/package.json b/packages/bzz-fs/package.json
@@ -27,7 +27,7 @@
   },
   "devDependencies": {
     "@types/fs-extra": "^8.0.1",
-    "@types/node": "^13.1.7",
+    "@types/node": "^13.1.8",
     "@types/tar-fs": "^1.16.2"
   }
 }
diff --git a/packages/bzz-node/package.json b/packages/bzz-node/package.json
@@ -27,7 +27,7 @@
     "tar-stream": "^2.1.0"
   },
   "devDependencies": {
-    "@types/node": "^13.1.7",
+    "@types/node": "^13.1.8",
     "@types/node-fetch": "^2.5.4",
     "@types/tar-stream": "^1.6.1"
   }

diff --git a/packages/doc-sync/package.json b/packages/doc-sync/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@erebos/doc-sync",
-  "version": "0.13.1",
-  "description": "Feed-based JSON state",
+  "version": "0.13.2",
+  "description": "Feed-based JSON document synchronization",
   "repository": "[email protected]:MainframeHQ/erebos.git",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -26,8 +26,9 @@
   "dependencies": {
     "@babel/runtime": "^7.8.3",
     "@erebos/bzz": "^0.13.0",
-    "@erebos/bzz-feed": "^0.13.1",
-    "@erebos/feed-list": "^0.13.1",
+    "@erebos/bzz-feed": "^0.13.2",
+    "@erebos/feed-list": "^0.13.2",
+    "@erebos/hex": "^0.13.0",
     "automerge": "^0.12.1",
     "rxjs": "^6.5.4"
   }