@basis-theory-labs/cli 1.0.1

package/README.md

@@ -0,0 +1,55 @@
+Basis Theory CLI
+=================
+
+Basis Theory CLI tool
+
+Make sure to either have a `BT_MANAGEMENT_KEY` env var exported or pass a `management-key` flag to the commands.
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @basis-theory-labs/cli
+$ bt COMMAND
+running command...
+$ bt (--version)
+@basis-theory-labs/cli/1.0.1 linux-x64 node-v18.16.0
+$ bt --help [COMMAND]
+USAGE
+  $ bt COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`bt logs`](#bt-logs)
+
+## `bt logs`
+
+Display live Reactor / Proxy Transform logs output. Requires `reactor:read`, `reactor:update`, `proxy:read` and `proxy:update` Management Application permissions
+
+```
+USAGE
+  $ bt logs --management-key <value> [-p <value>] [--proxy-id <value>] [--reactor-id <value>]
+
+FLAGS
+  -p, --port=<value>        [default: 8220] port to listen for incoming logs
+  --management-key=<value>  (required) management key used for connecting with the reactor / proxy
+  --proxy-id=<value>        proxy id to connect to
+  --reactor-id=<value>      reactor id to connect to
+
+DESCRIPTION
+  Display live Reactor / Proxy Transform logs output. Requires `reactor:read`, `reactor:update`, `proxy:read` and
+  `proxy:update` Management Application permissions
+
+EXAMPLES
+  $ bt logs
+
+  $ bt logs -p 3000
+```
+
+_See code: [dist/commands/logs.ts](https://github.com/Basis-Theory-Labs/basistheory-cli/blob/v1.0.1/dist/commands/logs.ts)_
+<!-- commandsstop -->

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/dist/commands/logs.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+export default class Logs extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        port: import("@oclif/core/lib/interfaces/parser").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'management-key': import("@oclif/core/lib/interfaces/parser").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'proxy-id': import("@oclif/core/lib/interfaces/parser").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'reactor-id': import("@oclif/core/lib/interfaces/parser").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/logs.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const management_1 = require("../logs/management");
+const server_1 = require("../logs/server");
+class Logs extends core_1.Command {
+    async run() {
+        const { flags: { port, 'management-key': managementKey, 'reactor-id': reactorId, 'proxy-id': proxyId, }, } = await this.parse(Logs);
+        const url = await (0, server_1.createLogServer)(this, port);
+        await (0, management_1.connectToResource)({
+            managementKey,
+            proxyId,
+            reactorId,
+            url,
+        });
+    }
+}
+exports.default = Logs;
+Logs.description = 'Display live Reactor / Proxy Transform logs output. Requires `reactor:read`, `reactor:update`, `proxy:read` and `proxy:update` Management Application permissions';
+Logs.examples = [
+    '<%= config.bin %> <%= command.id %>',
+    '<%= config.bin %> <%= command.id %> -p 3000',
+];
+Logs.flags = {
+    port: core_1.Flags.integer({
+        char: 'p',
+        description: 'port to listen for incoming logs',
+        default: 8220,
+    }),
+    'management-key': core_1.Flags.string({
+        env: 'BT_MANAGEMENT_KEY',
+        description: 'management key used for connecting with the reactor / proxy',
+        required: true,
+    }),
+    'proxy-id': core_1.Flags.string({
+        description: 'proxy id to connect to',
+        exactlyOne: ['proxy-id', 'reactor-id'],
+    }),
+    'reactor-id': core_1.Flags.string({
+        description: 'reactor id to connect to',
+        exactlyOne: ['proxy-id', 'reactor-id'],
+    }),
+};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/dist/logs/management.d.ts

@@ -0,0 +1,8 @@
+interface ConnectParams {
+    managementKey: string;
+    reactorId?: string;
+    proxyId?: string;
+    url: string;
+}
+declare const connectToResource: ({ managementKey, reactorId, proxyId, url, }: ConnectParams) => Promise<void>;
+export { connectToResource };

package/dist/logs/management.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.connectToResource = void 0;
+const basis_theory_js_1 = require("@basis-theory/basis-theory-js");
+const core_1 = require("@oclif/core");
+const BT_LOGGING_CONFIGURATION = 'BT_REMOTE_LOGGING';
+const createConfiguration = (url, current = {}) => ({
+    ...current,
+    [BT_LOGGING_CONFIGURATION]: JSON.stringify({
+        destination: url,
+        date: Date.now(),
+    }),
+});
+const connectToReactor = async (bt, reactorId, url) => {
+    core_1.ux.action.start('Connecting to Reactor');
+    const reactor = await bt.reactors.retrieve(reactorId);
+    await bt.reactors.update(reactorId, {
+        name: reactor.name,
+        configuration: createConfiguration(url, reactor.configuration),
+        application: reactor.application,
+    });
+    core_1.ux.action.stop('✅\t');
+};
+const connectToProxy = async (bt, proxyId, url) => {
+    core_1.ux.action.start('Connecting to Proxy');
+    const proxy = await bt.proxies.retrieve(proxyId);
+    await bt.proxies.update(proxyId, {
+        ...proxy,
+        ...(proxy.applicationId
+            ? {
+                application: {
+                    id: proxy.applicationId,
+                },
+            }
+            : {}),
+        configuration: createConfiguration(url, proxy.configuration),
+    });
+    core_1.ux.action.stop('✅\t');
+};
+const connectToResource = async ({ managementKey, reactorId, proxyId, url, }) => {
+    const bt = await new basis_theory_js_1.BasisTheory().init(managementKey);
+    if (typeof reactorId === 'string') {
+        return connectToReactor(bt, reactorId, url);
+    }
+    return connectToProxy(bt, proxyId, url);
+};
+exports.connectToResource = connectToResource;

package/dist/logs/parser.d.ts

@@ -0,0 +1,10 @@
+import pino from 'pino';
+interface LogEvent {
+    args: any[];
+    correlationId: string;
+    reactorId: string;
+    level: 'INFO' | 'WARN' | 'ERROR';
+    time: number;
+}
+declare const parseLogEvent: (logger: pino.Logger) => (event: LogEvent) => Promise<void>;
+export { parseLogEvent };

package/dist/logs/parser.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseLogEvent = void 0;
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const debug = require('debug')('logs:parser');
+const parseLogEvent = (logger) => async (event) => {
+    debug(event);
+    const { deserializeError } = await import('serialize-error');
+    const [arg1, arg2, ...args] = event.args.map((arg) => {
+        // eslint-disable-next-line unicorn/no-null
+        if (arg === null || arg === undefined || typeof arg === 'number') {
+            return String(arg);
+        }
+        if ((arg === null || arg === void 0 ? void 0 : arg.name) && (arg === null || arg === void 0 ? void 0 : arg.stack)) {
+            return deserializeError(arg);
+        }
+        return arg;
+    });
+    switch (event.level) {
+        case 'INFO': {
+            logger.info(arg1, arg2, ...args);
+            break;
+        }
+        case 'WARN': {
+            logger.warn(arg1, arg2, ...args);
+            break;
+        }
+        case 'ERROR': {
+            logger.error(arg1, arg2, ...args);
+            break;
+        }
+        // No default
+    }
+};
+exports.parseLogEvent = parseLogEvent;

package/dist/logs/server.d.ts

@@ -0,0 +1,3 @@
+import type { Command } from '@oclif/core';
+declare const createLogServer: (command: Command, port: number) => Promise<string>;
+export { createLogServer };

package/dist/logs/server.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLogServer = void 0;
+const core_1 = require("@oclif/core");
+const cloudflared_1 = require("cloudflared");
+const fs = require("node:fs");
+const node_http_1 = require("node:http");
+const pino_1 = require("pino");
+const socket_io_1 = require("socket.io");
+const parser_1 = require("./parser");
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const debug = require('debug')('logs:server');
+const runTunnel = async (port) => {
+    if (!fs.existsSync(cloudflared_1.bin)) {
+        await (0, cloudflared_1.install)(cloudflared_1.bin);
+    }
+    debug('starting tunnel');
+    const { url: urlPromise } = (0, cloudflared_1.tunnel)({
+        '--url': `localhost:${port}`,
+    });
+    const url = await urlPromise;
+    debug(`tunnel started at ${url}`);
+    return url;
+};
+const createLogServer = async (command, port) => {
+    core_1.ux.action.start('Starting log server');
+    const logger = (0, pino_1.default)({
+        transport: {
+            target: 'pino-pretty',
+            options: {
+                colorize: true,
+                colorizeObjects: false,
+                ignore: 'pid,hostname',
+            },
+        },
+    });
+    debug('creating http server');
+    const server = (0, node_http_1.createServer)();
+    debug('creating socket server');
+    const io = new socket_io_1.Server(server);
+    io.on('connection', (client) => {
+        debug(`socket client connected: ${client.handshake.address}`);
+        client.on('log', (0, parser_1.parseLogEvent)(logger));
+        client.on('disconnect', (reason) => {
+            debug(`socket client disconnected ${client.handshake.address}: ${reason}`);
+        });
+    });
+    debug(`server listening on port ${port}`);
+    server.listen(port);
+    core_1.ux.action.stop(`✅\tListening at http://localhost:${port}`);
+    core_1.ux.action.start('Starting tunnel');
+    const url = await runTunnel(port);
+    core_1.ux.action.stop(`✅\t\tListening at ${url}`);
+    return url;
+};
+exports.createLogServer = createLogServer;

package/oclif.manifest.json

@@ -0,0 +1,48 @@
+{
+  "version": "1.0.1",
+  "commands": {
+    "logs": {
+      "id": "logs",
+      "description": "Display live Reactor / Proxy Transform logs output. Requires `reactor:read`, `reactor:update`, `proxy:read` and `proxy:update` Management Application permissions",
+      "strict": true,
+      "pluginName": "@basis-theory-labs/cli",
+      "pluginAlias": "@basis-theory-labs/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> -p 3000"
+      ],
+      "flags": {
+        "port": {
+          "name": "port",
+          "type": "option",
+          "char": "p",
+          "description": "port to listen for incoming logs",
+          "multiple": false,
+          "default": 8220
+        },
+        "management-key": {
+          "name": "management-key",
+          "type": "option",
+          "description": "management key used for connecting with the reactor / proxy",
+          "required": true,
+          "multiple": false
+        },
+        "proxy-id": {
+          "name": "proxy-id",
+          "type": "option",
+          "description": "proxy id to connect to",
+          "multiple": false
+        },
+        "reactor-id": {
+          "name": "reactor-id",
+          "type": "option",
+          "description": "reactor id to connect to",
+          "multiple": false
+        }
+      },
+      "args": {}
+    }
+  }
+}

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "@basis-theory-labs/cli",
+  "version": "1.0.1",
+  "description": "Basis Theory CLI tool",
+  "author": "Davi Aquino @djejaquino",
+  "bin": {
+    "bt": "./bin/run"
+  },
+  "homepage": "https://github.com/Basis-Theory-Labs/basistheory-cli",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "repository": "Basis-Theory-Labs/basistheory-cli",
+  "files": [
+    "/bin",
+    "/dist",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@basis-theory/basis-theory-js": "^1.77.0",
+    "@oclif/core": "^2",
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-plugins": "^2.4.7",
+    "cloudflared": "^0.4.0",
+    "debug": "^4.3.4",
+    "pino": "^8.14.1",
+    "pino-pretty": "^10.0.0",
+    "serialize-error": "^11.0.0",
+    "socket.io": "^4.6.2"
+  },
+  "devDependencies": {
+    "@basis-theory/eslint-config": "^1.2.0",
+    "@oclif/test": "^2.3.22",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^10.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^9.0.3",
+    "@semantic-release/npm": "^10.0.4",
+    "@semantic-release/release-notes-generator": "^11.0.3",
+    "@types/chai": "^4",
+    "@types/debug": "^4.1.8",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^16.18.36",
+    "chai": "^4",
+    "eslint": "^7.32.0",
+    "eslint-config-oclif": "^4",
+    "eslint-config-oclif-typescript": "^1.0.3",
+    "mocha": "^9.2.2",
+    "oclif": "^3",
+    "prettier": "^2.8.8",
+    "semantic-release": "^21.0.5",
+    "shx": "^0.3.3",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.5.3",
+    "typescript": "^4.9.5"
+  },
+  "oclif": {
+    "bin": "bt",
+    "dirname": "bt",
+    "commands": "./dist/commands",
+    "plugins": [],
+    "topicSeparator": " ",
+    "topics": {
+      "logs": {
+        "description": "See realtime logs from Reactors and Proxies"
+      }
+    }
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "yarn lint",
+    "prepack": "yarn build && oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md",
+    "release": "semantic-release"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "bugs": "https://github.com/Basis-Theory-Labs/basistheory-cli/issues",
+  "keywords": [
+    "oclif"
+  ],
+  "types": "dist/index.d.ts",
+  "prettier": "@basis-theory/eslint-config/prettier",
+  "publishConfig": {
+    "access": "public"
+  }
+}