@streamr/cli-tools 5.0.0 → 6.0.0-alpha.2

package/src/resend.ts

@@ -1,10 +1,23 @@
-import { StreamrClient, StreamrClientOptions } from 'streamr-client'
+import { StreamrClient, ResendOptions } from 'streamr-client'
 
-export const resend = async (streamId: string, resendOpts: any, streamrOptions: StreamrClientOptions & { subscribe?: boolean }) => {
-    const options = { ...streamrOptions }
-    const client = new StreamrClient(options)
+export const assertBothOrNoneDefined = (
+    option1: string,
+    option2: string,
+    errorMessage: string,
+    commandOptions: Record<string, unknown>
+): void | never => { 
+    if ((option1 in commandOptions && !(option2 in commandOptions)) || (option2 in commandOptions && !(option1 in commandOptions))) {
+        console.error(`option ${errorMessage}`)
+        process.exit(1)
+    }
+}
 
-    let sub
+export const resend = async (
+    streamId: string,
+    resendOpts: ResendOptions,
+    client: StreamrClient,
+    subscribe: boolean
+): Promise<void> => {
     try {
         const subscribeOpts = {
             stream: streamId,
@@ -13,31 +26,13 @@ export const resend = async (streamId: string, resendOpts: any, streamrOptions:
         const handler = (message: any) => {
             console.info(JSON.stringify(message))
         }
-
-        if (options.subscribe) {
-            sub = await client.subscribe(subscribeOpts, handler)
+        if (subscribe) {
+            await client.subscribe(subscribeOpts, handler)
         } else {
-            sub = await client.resend(subscribeOpts, handler)
+            await client.resend(subscribeOpts, handler)
         }
     } catch (err) {
         console.error(err.message ? err.message : err)
         process.exit(1)
     }
-
-    sub.on('error', (err: any) => {
-        console.error(err)
-        process.exit(1)
-    })
-
-    sub.on('resent', () => {
-        if (!options.subscribe) {
-            process.exit(0)
-        }
-    })
-
-    sub.on('no_resend', () => {
-        if (!options.subscribe) {
-            process.exit(0)
-        }
-    })
-}
+}

package/tsconfig.json

@@ -1,14 +1,15 @@
 {
-  "compilerOptions": {
-    "target": "esnext",
-    "module": "commonjs",
-    "strict": true,
-    "noImplicitAny": true,
-    "outDir": "dist",
-    "rootDirs": ["src", "bin"],
-    "resolveJsonModule": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
-  }
+    "extends": "@streamr/dev-config/ts/tsconfig.node.json",
+    "compilerOptions": {
+        "composite": true,
+        "outDir": "dist"
+    },
+    "include": [
+        "package.json",
+        "src/**/*",
+        "bin/**/*"
+    ],
+    "references": [
+        { "path": "../client/tsconfig.node.json" }
+    ]
 }

package/bin/common.ts

@@ -1,91 +0,0 @@
-import * as commander from 'commander'
-import { StreamrClientOptions } from 'streamr-client'
-
-export interface EnvironmentOptions {
-    dev?: boolean
-    stg?: boolean
-    wsUrl?: string
-    httpUrl?: string 
-}
-
-export interface AuthenticationOptions {
-    privateKey?: string
-    apiKey?: string
-}
-
-export function envOptions(program: commander.Command) {
-    return program
-        .option('--dev', 'use pre-defined development environment')
-        .option('--stg', 'use pre-defined staging environment')
-        .option('--ws-url <url>', 'alternative websocket url to use')
-        .option('--http-url <url>', 'alternative http url to use')
-}
-
-export function authOptions(program: commander.Command) {
-    return program
-        .option('--private-key <key>', 'use an Ethereum private key to authenticate')
-        .option('--api-key <key>', 'use an API key to authenticate (deprecated)')
-}
-
-export function exitWithHelpIfArgsNotBetween(program: commander.Command, min: number, max: number) {
-    if (program.args.length < min || program.args.length > max) {
-        program.help()
-    }
-}
-
-export function formStreamrOptionsWithEnv({ dev, stg, wsUrl, httpUrl, privateKey, apiKey }: EnvironmentOptions & AuthenticationOptions) {
-    const options: StreamrClientOptions = {}
-
-    if (dev && stg) {
-        console.error('flags --dev and --stg cannot be enabled at the same time')
-        process.exit(1)
-    }
-
-    if (dev) {
-        options.url = 'ws://localhost/api/v1/ws'
-        options.restUrl = 'http://localhost/api/v1'
-        options.storageNode = {
-            // "broker-node-storage-1" on Docker environment
-            address: '0xde1112f631486CfC759A50196853011528bC5FA0',
-            url: 'http://10.200.10.1:8891'
-        }
-    } else if (stg) {
-        options.url = 'wss://staging.streamr.com/api/v1/ws'
-        options.restUrl = 'https://staging.streamr.com/api/v1/'
-    }
-
-    if (wsUrl) {
-        options.url = wsUrl
-    }
-    if (httpUrl) {
-        options.restUrl = httpUrl
-    }
-
-    if (privateKey && apiKey) {
-        console.error('flags --privateKey and --apiKey cannot be used at the same time')
-        process.exit(1)
-    }
-
-    if (privateKey) {
-        options.auth = {
-            privateKey
-        }
-    } else if (apiKey) {
-        options.auth = {
-            apiKey
-        }
-    }
-
-    return options
-}
-
-export function createFnParseInt(name: string) {
-    return (str: string) => {
-        const n = parseInt(str, 10)
-        if (isNaN(n)) {
-            console.error(`${name} must be an integer (was "${str}")`)
-            process.exit(1)
-        }
-        return n
-    }
-}

package/bin/streamr-stream-list.ts

@@ -1,29 +0,0 @@
-#!/usr/bin/env node
-import { Command, Option } from 'commander';
-import { list } from '../src/list'
-import { envOptions, authOptions, exitWithHelpIfArgsNotBetween, formStreamrOptionsWithEnv } from './common'
-import pkg from '../package.json'
-
-const program = new Command();
-program
-    .description('fetch a list of streams that are accessible by the authenticated user')
-    .option('-s, --search [term]', 'search for term in name or description')
-    .addOption(new Option('-o, --operation [permission]', 'filter by permission').choices(['stream_get','stream_subscribe','stream_publish','stream_delete','stream_share']).default('stream_get'))
-    .option('--public-access', 'include publicly available streams')
-    .option('--no-granted-access', 'exclude streams that user has directly granted permissions to')
-authOptions(program)
-envOptions(program)
-    .version(pkg.version)
-    .action((options: any) => {
-        const query: any = {
-            operation: options.operation,
-            noConfig: true,
-            publicAccess: options.publicAccess,
-            search: options.search,
-            grantedAccess: options.grantedAccess
-        }    
-        list(query, formStreamrOptionsWithEnv(options))
-    })
-    .parse(process.argv)
-
-exitWithHelpIfArgsNotBetween(program, 0, 0)

package/dist/bin/common.js

@@ -1,76 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createFnParseInt = exports.formStreamrOptionsWithEnv = exports.exitWithHelpIfArgsNotBetween = exports.authOptions = exports.envOptions = void 0;
-function envOptions(program) {
-    return program
-        .option('--dev', 'use pre-defined development environment')
-        .option('--stg', 'use pre-defined staging environment')
-        .option('--ws-url <url>', 'alternative websocket url to use')
-        .option('--http-url <url>', 'alternative http url to use');
-}
-exports.envOptions = envOptions;
-function authOptions(program) {
-    return program
-        .option('--private-key <key>', 'use an Ethereum private key to authenticate')
-        .option('--api-key <key>', 'use an API key to authenticate (deprecated)');
-}
-exports.authOptions = authOptions;
-function exitWithHelpIfArgsNotBetween(program, min, max) {
-    if (program.args.length < min || program.args.length > max) {
-        program.help();
-    }
-}
-exports.exitWithHelpIfArgsNotBetween = exitWithHelpIfArgsNotBetween;
-function formStreamrOptionsWithEnv({ dev, stg, wsUrl, httpUrl, privateKey, apiKey }) {
-    const options = {};
-    if (dev && stg) {
-        console.error('flags --dev and --stg cannot be enabled at the same time');
-        process.exit(1);
-    }
-    if (dev) {
-        options.url = 'ws://localhost/api/v1/ws';
-        options.restUrl = 'http://localhost/api/v1';
-        options.storageNode = {
-            // "broker-node-storage-1" on Docker environment
-            address: '0xde1112f631486CfC759A50196853011528bC5FA0',
-            url: 'http://10.200.10.1:8891'
-        };
-    }
-    else if (stg) {
-        options.url = 'wss://staging.streamr.com/api/v1/ws';
-        options.restUrl = 'https://staging.streamr.com/api/v1/';
-    }
-    if (wsUrl) {
-        options.url = wsUrl;
-    }
-    if (httpUrl) {
-        options.restUrl = httpUrl;
-    }
-    if (privateKey && apiKey) {
-        console.error('flags --privateKey and --apiKey cannot be used at the same time');
-        process.exit(1);
-    }
-    if (privateKey) {
-        options.auth = {
-            privateKey
-        };
-    }
-    else if (apiKey) {
-        options.auth = {
-            apiKey
-        };
-    }
-    return options;
-}
-exports.formStreamrOptionsWithEnv = formStreamrOptionsWithEnv;
-function createFnParseInt(name) {
-    return (str) => {
-        const n = parseInt(str, 10);
-        if (isNaN(n)) {
-            console.error(`${name} must be an integer (was "${str}")`);
-            process.exit(1);
-        }
-        return n;
-    };
-}
-exports.createFnParseInt = createFnParseInt;

package/dist/src/create.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.create = void 0;
-const streamr_client_1 = require("streamr-client");
-const create = (body, streamrOptions) => {
-    const options = { ...streamrOptions };
-    const client = new streamr_client_1.StreamrClient(options);
-    client.createStream(body).then((stream) => {
-        // @ts-expect-error
-        console.info(JSON.stringify(stream.toObject(), null, 2));
-        process.exit(0);
-    }).catch((err) => {
-        console.error(err.message ? err.message : err);
-        process.exit(1);
-    });
-};
-exports.create = create;

package/dist/src/generate.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = void 0;
-// From: https://stackoverflow.com/questions/10726909/random-alpha-numeric-string-in-javascript
-function randomString(length, chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ') {
-    let result = '';
-    for (let i = length; i > 0; --i) {
-        result += chars[Math.floor(Math.random() * chars.length)];
-    }
-    return result;
-}
-function genArray(size, elementFn) {
-    const arr = [];
-    for (let i = 0; i < size; ++i) {
-        arr.push(elementFn());
-    }
-    return arr;
-}
-const generate = (rate) => {
-    setInterval(() => {
-        console.info(JSON.stringify({
-            someText: randomString(64),
-            aNumber: Math.random() * 10000,
-            bNumber: Math.random(),
-            yesOrNo: Math.random() > 0.5,
-            arrayOfStrings: genArray(Math.floor(Math.random() * 20), () => randomString(8)),
-            arrayOfIntegers: genArray(Math.floor(Math.random() * 10), () => Math.floor(Math.random() * 100))
-        }));
-    }, rate);
-};
-exports.generate = generate;

package/dist/src/list.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.list = void 0;
-const streamr_client_1 = require("streamr-client");
-const easy_table_1 = __importDefault(require("easy-table"));
-const list = (query, streamrOptions) => {
-    const options = { ...streamrOptions };
-    const client = new streamr_client_1.StreamrClient(options);
-    client.listStreams(query).then((streams) => {
-        if (streams.length > 0) {
-            // @ts-expect-error
-            console.info(easy_table_1.default.print(streams.map(({ id, name, lastUpdated }) => ({
-                lastUpdated,
-                id,
-                name
-            }))));
-        }
-        process.exit(0);
-    }, (err) => {
-        console.error(err.message ? err.message : err);
-        process.exit(1);
-    });
-};
-exports.list = list;

package/dist/src/publish.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.publishStream = void 0;
-const stream_1 = require("stream");
-const streamr_client_1 = require("streamr-client");
-const publishStream = (stream, partitionKey, streamrOptions) => {
-    const options = { ...streamrOptions };
-    const client = new streamr_client_1.StreamrClient(options);
-    const writable = new stream_1.Writable({
-        objectMode: true,
-        write: (data, _, done) => {
-            let json = null;
-            // ignore newlines, etc
-            if (!data || String(data).trim() === '') {
-                done();
-                return;
-            }
-            try {
-                json = JSON.parse(data);
-            }
-            catch (e) {
-                console.error(data.toString());
-                done(e);
-                return;
-            }
-            // @ts-expect-error
-            client.publish(stream, json, Date.now(), json[partitionKey]).then(() => done(), (err) => done(err));
-        }
-    });
-    client.on('error', (err) => writable.emit('error', err));
-    // disconnect client when upstream pipe ends and data flushed
-    writable.once('finish', () => client.ensureDisconnected());
-    return writable;
-};
-exports.publishStream = publishStream;

package/dist/src/show.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.show = void 0;
-const streamr_client_1 = require("streamr-client");
-const show = (streamId, includePermissions, streamrOptions) => {
-    const options = { ...streamrOptions };
-    const client = new streamr_client_1.StreamrClient(options);
-    client.getStream(streamId).then(async (stream) => {
-        // @ts-expect-error
-        const obj = stream.toObject();
-        if (includePermissions) {
-            obj.permissions = await stream.getPermissions();
-        }
-        console.info(JSON.stringify(obj, null, 2));
-        process.exit(0);
-    }).catch((err) => {
-        console.error(err.message ? err.message : err);
-        process.exit(1);
-    });
-};
-exports.show = show;

package/dist/src/subscribe.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.subscribe = void 0;
-const streamr_client_1 = require("streamr-client");
-const subscribe = (stream, partition, streamrOptions) => {
-    const options = { ...streamrOptions };
-    new streamr_client_1.StreamrClient(options).subscribe({
-        stream,
-        partition,
-    }, (message, streamMessage) => console.info(JSON.stringify(message)));
-};
-exports.subscribe = subscribe;

package/src/create.ts

@@ -1,15 +0,0 @@
-import { StreamProperties, StreamrClient } from 'streamr-client'
-
-export const create = (body: any, streamrOptions: StreamProperties) => {
-    const options = { ...streamrOptions }
-
-    const client = new StreamrClient(options)
-    client.createStream(body).then((stream) => {
-        // @ts-expect-error
-        console.info(JSON.stringify(stream.toObject(), null, 2))
-        process.exit(0)
-    }).catch((err) => {
-        console.error(err.message ? err.message : err)
-        process.exit(1)
-    })
-}

package/src/generate.ts

@@ -1,30 +0,0 @@
-// From: https://stackoverflow.com/questions/10726909/random-alpha-numeric-string-in-javascript
-function randomString(length: number, chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ') {
-    let result = ''
-    for (let i = length; i > 0; --i) {
-        result += chars[Math.floor(Math.random() * chars.length)]
-    }
-    return result
-}
-
-function genArray(size: number, elementFn: () => any) {
-    const arr = []
-    for (let i=0; i < size; ++i) {
-        arr.push(elementFn())
-    }
-    return arr
-}
-
-export const generate = (rate: number) => {
-    setInterval(() => {
-        console.info(JSON.stringify({
-            someText: randomString(64),
-            aNumber: Math.random() * 10000,
-            bNumber: Math.random(),
-            yesOrNo: Math.random() > 0.5,
-            arrayOfStrings: genArray(Math.floor(Math.random() * 20), () => randomString(8)),
-            arrayOfIntegers: genArray(Math.floor(Math.random() * 10), () => Math.floor(Math.random() * 100))
-
-        }))
-    }, rate)
-}

package/src/list.ts

@@ -1,21 +0,0 @@
-import { StreamListQuery, StreamrClient, StreamrClientOptions } from 'streamr-client'
-import EasyTable from 'easy-table'
-
-export const list = (query: StreamListQuery, streamrOptions: StreamrClientOptions) => {
-    const options = { ...streamrOptions }
-    const client = new StreamrClient(options)
-    client.listStreams(query).then((streams) => {
-        if (streams.length > 0) {
-            // @ts-expect-error
-            console.info(EasyTable.print(streams.map(({id, name, lastUpdated}) => ({
-                lastUpdated,
-                id,
-                name
-            }))))
-        }
-        process.exit(0)
-    }, (err) => {
-        console.error(err.message ? err.message : err)
-        process.exit(1)
-    })
-}

package/src/publish.ts

@@ -1,38 +0,0 @@
-import { Writable } from 'stream'
-import { StreamrClient, StreamrClientOptions } from 'streamr-client'
-
-export const publishStream = (stream: string, partitionKey: string|undefined, streamrOptions: StreamrClientOptions) => {
-    const options = { ...streamrOptions }
-
-    const client = new StreamrClient(options)
-    const writable = new Writable({
-        objectMode: true,
-        write: (data: any, _: any, done: any) => {
-            let json = null
-            // ignore newlines, etc
-            if (!data || String(data).trim() === '') {
-                done()
-                return
-            }
-
-            try {
-                json = JSON.parse(data)
-            } catch (e) {
-                console.error(data.toString())
-                done(e)
-                return
-            }
-
-            // @ts-expect-error
-            client.publish(stream, json, Date.now(), json[partitionKey]).then(
-                () => done(),
-                (err) => done(err)
-            )
-        }
-    })
-
-    client.on('error', (err) => writable.emit('error', err))
-    // disconnect client when upstream pipe ends and data flushed
-    writable.once('finish', () => client.ensureDisconnected())
-    return writable
-}

package/src/show.ts

@@ -1,18 +0,0 @@
-import { StreamrClient, StreamrClientOptions } from 'streamr-client'
-
-export const show = (streamId: string, includePermissions: boolean|undefined, streamrOptions: StreamrClientOptions) => {
-    const options = { ...streamrOptions }
-    const client = new StreamrClient(options)
-    client.getStream(streamId).then(async (stream) => {
-        // @ts-expect-error
-        const obj = stream.toObject()
-        if (includePermissions) {
-            obj.permissions = await stream.getPermissions()
-        }
-        console.info(JSON.stringify(obj, null, 2))
-        process.exit(0)
-    }).catch((err) => {
-        console.error(err.message ? err.message : err)
-        process.exit(1)
-    })
-}

package/src/subscribe.ts

@@ -1,9 +0,0 @@
-import { StreamrClient, StreamrClientOptions } from 'streamr-client'
-
-export const subscribe = (stream: string, partition: number, streamrOptions: StreamrClientOptions) => {
-    const options = { ...streamrOptions }
-    new StreamrClient(options).subscribe({
-        stream,
-        partition,
-    }, (message, streamMessage) => console.info(JSON.stringify(message)))
-}