@streamr/cli-tools 4.1.0 → 6.0.0-alpha.0

package/bin/common.js

@@ -1,79 +0,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')
-}
-
-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)')
-}
-
-function exitWitHelpIfArgsNotBetween(program, min, max) {
-    if (program.args.length < min || program.args.length > max) {
-        program.help()
-    }
-}
-
-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'
-    } 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
-}
-
-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
-    }
-}
-
-module.exports = {
-    envOptions,
-    authOptions,
-    exitWitHelpIfArgsNotBetween,
-    formStreamrOptionsWithEnv,
-    createFnParseInt
-}

package/bin/streamr-create.js

@@ -1,40 +0,0 @@
-#!/usr/bin/env node
-const program = require('commander')
-const create = require('../src/create')
-const {
-    envOptions,
-    authOptions,
-    exitWitHelpIfArgsNotBetween,
-    formStreamrOptionsWithEnv,
-    createFnParseInt
-} = require('./common')
-
-program
-    .usage('<name>')
-    .description('create a new stream')
-    .option('-d, --description <description>', 'define a description')
-    .option('-c, --config <config>', 'define a configuration as JSON', (s) => JSON.parse(s))
-    .option('-p, --partitions <count>', 'define a partition count',
-        createFnParseInt('--partitions'))
-authOptions(program)
-envOptions(program)
-    .version(require('../package.json').version)
-    .parse(process.argv)
-
-exitWitHelpIfArgsNotBetween(program, 1, 1)
-
-const body = {
-    name: program.args[0]
-}
-if ("description" in program) {
-    body.description = program.description
-}
-if ("config" in program) {
-    body.config = program.config
-}
-if ("partitions" in program) {
-    body.partitions = program.partitions
-}
-
-const options = formStreamrOptionsWithEnv(program)
-create(body, options)

package/bin/streamr-generate.js

@@ -1,14 +0,0 @@
-#!/usr/bin/env node
-const program = require('commander')
-const generate = require('../src/generate')
-const { exitWitHelpIfArgsNotBetween, createFnParseInt } = require('./common')
-
-program
-    .description('generate and print semi-random JSON data to stdout')
-    .option('-r, --rate <n>', 'rate in milliseconds', createFnParseInt('--rate'), 500)
-    .version(require('../package.json').version)
-    .parse(process.argv)
-
-exitWitHelpIfArgsNotBetween(program, 0, 0)
-
-generate(program.rate)

package/bin/streamr-list.js

@@ -1,35 +0,0 @@
-#!/usr/bin/env node
-const program = require('commander')
-const list = require('../src/list')
-const { envOptions, authOptions, exitWitHelpIfArgsNotBetween, formStreamrOptionsWithEnv } = require('./common')
-
-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')
-    .option('-o, --operation [permission]', 'filter by permission', /^(stream_get|stream_subscribe|stream_publish|stream_delete|stream_share)$/i, '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(require('../package.json').version)
-    .parse(process.argv)
-
-exitWitHelpIfArgsNotBetween(program, 0, 0)
-
-const query = {
-    operation: program.operation,
-    noConfig: true
-}
-if ("publicAccess" in program) {
-    query.publicAccess = program.publicAccess
-}
-if ("search" in program) {
-    query.search = program.search
-}
-if ("grantedAccess" in program) {
-    query.grantedAccess = program.grantedAccess
-}
-
-const options = formStreamrOptionsWithEnv(program);
-list(query, options)
-

package/bin/streamr-publish.js

@@ -1,28 +0,0 @@
-#!/usr/bin/env node
-const es = require('event-stream')
-const program = require('commander')
-const publishStream = require('../src/publish')
-const { envOptions, authOptions, exitWitHelpIfArgsNotBetween, formStreamrOptionsWithEnv } = require('./common')
-
-program
-    .usage('<streamId>')
-    .description('publish to a stream by reading JSON messages from stdin line-by-line')
-    .option('-k, --partition-key <string>', 'field name in each message to use for assigning the message to a stream partition')
-authOptions(program)
-envOptions(program)
-    .version(require('../package.json').version)
-    .parse(process.argv)
-
-exitWitHelpIfArgsNotBetween(program, 1, 1)
-
-const options = formStreamrOptionsWithEnv(program)
-const ps = publishStream(program.args[0], program.partitionKey, options)
-process.stdin
-    .pipe(es.split())
-    .pipe(ps)
-    .on('error', (err) => {
-        console.error(err)
-        process.exit(1)
-        // process.stdin.pipe(ps) recover pipe to continue execution
-    })
-

package/bin/streamr-resend.js

@@ -1,101 +0,0 @@
-#!/usr/bin/env node
-const program = require('commander')
-const resend = require('../src/resend')
-const { envOptions, authOptions, exitWitHelpIfArgsNotBetween, formStreamrOptionsWithEnv } = require('./common')
-
-function handlePublisherIdAndMsgChainId(cmd, resendOptions) {
-    if ('publisherId' in cmd && !('msgChainId' in cmd)) {
-        console.error('option --publisher-id must be accompanied by option --msg-chain-id')
-        process.exit(1)
-    }
-    if ('msgChainId' in cmd && !('publisherId' in cmd)) {
-        console.error('option --msg-chain-id must be accompanied by option --publisher-id')
-        process.exit(1)
-    }
-    if ('publisherId' in cmd) {
-        resendOptions.publisherId = cmd.publisherId
-    }
-    if ('msgChainId' in cmd) {
-        resendOptions.msgChainId = cmd.msgChainId
-    }
-}
-
-program
-    .usage('<command> [<args>]')
-    .description('request resend of stream and print JSON messages to stdout line-by-line')
-
-program
-    .command('last <n> <streamId>')
-    .description('request last N messages')
-    .option('-d, --disable-ordering', 'disable ordering of messages by OrderingUtil', false)
-    .option('-s, --subscribe', 'subscribe in addition to resend', false)
-    .action((n, streamId, cmd) => {
-        if (isNaN(n)) {
-            console.error('argument n is not a number')
-            process.exit(1)
-        }
-        const resendOptions = {
-            last: parseInt(n)
-        }
-        const options = formStreamrOptionsWithEnv(cmd.parent)
-        options.orderMessages = !cmd.disableOrdering
-        options.subscribe = cmd.subscribe
-        resend(streamId, resendOptions, options)
-    })
-
-program
-    .command('from <from> <streamId>')
-    .description('request messages starting from given date-time (format: "YYYY-MM-DDTHH:mm:ss.sssZ")')
-    .option('--publisher-id <string>', 'filter results by publisher')
-    .option('--msg-chain-id <string>', 'filter results by message chain')
-    .option('-d, --disable-ordering', 'disable ordering of messages by OrderingUtil', false)
-    .option('-s, --subscribe', 'subscribe in addition to resend', false)
-    .action((from, streamId, cmd) => {
-        const resendOptions = {
-            from: {
-                timestamp: Date.parse(from),
-                sequenceNumber: 0
-            }
-        }
-        handlePublisherIdAndMsgChainId(cmd, resendOptions)
-        const options = formStreamrOptionsWithEnv(cmd.parent)
-        options.orderMessages = !cmd.disableOrdering
-        options.subscribe = cmd.subscribe
-        resend(streamId, resendOptions, options)
-    })
-
-program
-    .command('range <from> <to> <streamId>')
-    .description('request messages between two given date-times (format: "YYYY-MM-DDTHH:mm:ss.sssZ")')
-    .option('--publisher-id <string>', 'filter results by publisher')
-    .option('--msg-chain-id <string>', 'filter results by message chain')
-    .option('-d, --disable-ordering', 'disable ordering of messages by OrderingUtil', false)
-    .action((from, to, streamId, cmd) => {
-        const resendOptions = {
-            from: {
-                timestamp: Date.parse(from),
-                sequenceNumber: 0
-            },
-            to: {
-                timestamp: Date.parse(to),
-                sequenceNumber: 0
-            },
-        }
-        handlePublisherIdAndMsgChainId(cmd, resendOptions)
-        const options = formStreamrOptionsWithEnv(cmd.parent)
-        options.orderMessages = !cmd.disableOrdering
-        resend(streamId, resendOptions, options)
-    })
-
-program
-    .on('command:*', (invalidCommand) => {
-        console.error(`invalid command: ${invalidCommand}`)
-        process.exit(1)
-    })
-
-authOptions(program)
-envOptions(program)
-    .version(require('../package.json').version)
-    .parse(process.argv)
-
-exitWitHelpIfArgsNotBetween(program, 1, Number.MAX_VALUE)

package/bin/streamr-show.js

@@ -1,19 +0,0 @@
-#!/usr/bin/env node
-const program = require('commander')
-const show = require('../src/show')
-const { envOptions, authOptions, exitWitHelpIfArgsNotBetween, formStreamrOptionsWithEnv } = require('./common')
-
-program
-    .usage('<streamId>')
-    .description('show detailed information about a stream')
-    .option('--include-permissions', 'include list of permissions (requires SHARE permission)')
-authOptions(program)
-envOptions(program)
-    .version(require('../package.json').version)
-    .parse(process.argv)
-
-exitWitHelpIfArgsNotBetween(program, 1, 1)
-
-const options = formStreamrOptionsWithEnv(program);
-show(program.args[0], program.includePermissions, options)
-

package/bin/streamr-subscribe.js

@@ -1,20 +0,0 @@
-#!/usr/bin/env node
-const program = require('commander')
-const subscribe = require('../src/subscribe')
-const { envOptions, authOptions, exitWitHelpIfArgsNotBetween, formStreamrOptionsWithEnv, createFnParseInt } = require('./common')
-
-program
-    .usage('<streamId>')
-    .description('subscribe to a stream, prints JSON messages to stdout line-by-line')
-    .option('-p, --partition [partition]', 'partition', createFnParseInt('--partition'), 0)
-    .option('-d, --disable-ordering', 'disable ordering of messages by OrderingUtil', false)
-authOptions(program)
-envOptions(program)
-    .version(require('../package.json').version)
-    .parse(process.argv)
-
-exitWitHelpIfArgsNotBetween(program, 1, 1)
-
-const options = formStreamrOptionsWithEnv(program)
-options.orderMessages = !program.disableOrdering
-subscribe(program.args[0], program.partition, options)

package/src/resend.js

@@ -1,43 +0,0 @@
-const StreamrClient = require('streamr-client')
-
-module.exports = async function resend(streamId, resendOpts, streamrOptions) {
-    const options = { ...streamrOptions }
-    const client = new StreamrClient(options)
-
-    let sub
-    try {
-        const subscribeOpts = {
-            stream: streamId,
-            resend: resendOpts
-        }
-        const handler = (message) => {
-            console.info(JSON.stringify(message))
-        }
-
-        if (options.subscribe) {
-            sub = await client.subscribe(subscribeOpts, handler)
-        } else {
-            sub = await client.resend(subscribeOpts, handler)
-        }
-    } catch (err) {
-        console.error(err.message ? err.message : err)
-        process.exit(1)
-    }
-
-    sub.on('error', (err) => {
-        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/src/subscribe.js

@@ -1,9 +0,0 @@
-const StreamrClient = require('streamr-client')
-
-module.exports = function subscribe(stream, partition, streamrOptions) {
-    const options = { ...streamrOptions }
-    new StreamrClient(options).subscribe({
-        stream,
-        partition,
-    }, (message, streamMessage) => console.info(JSON.stringify(message)))
-}