@flowcore/cli 1.0.1

package/README.md

@@ -0,0 +1,510 @@
+Flowcore CLI
+=================
+
+Flowcore CLI is a command line interface for interacting with the Flowcore Platform.
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Build and Release](https://github.com/flowcore-io/flowcore-cli/actions/workflows/build.yml/badge.svg)](https://github.com/flowcore-io/flowcore-cli/actions/workflows/build.yml)
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @flowcore/cli
+$ flowcore COMMAND
+running command...
+$ flowcore (--version)
+@flowcore/cli/1.0.1 linux-x64 node-v20.10.0
+$ flowcore --help [COMMAND]
+USAGE
+  $ flowcore COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`flowcore autocomplete [SHELL]`](#flowcore-autocomplete-shell)
+* [`flowcore config set`](#flowcore-config-set)
+* [`flowcore config show`](#flowcore-config-show)
+* [`flowcore help [COMMANDS]`](#flowcore-help-commands)
+* [`flowcore login`](#flowcore-login)
+* [`flowcore plugins`](#flowcore-plugins)
+* [`flowcore plugins:install PLUGIN...`](#flowcore-pluginsinstall-plugin)
+* [`flowcore plugins:inspect PLUGIN...`](#flowcore-pluginsinspect-plugin)
+* [`flowcore plugins:install PLUGIN...`](#flowcore-pluginsinstall-plugin-1)
+* [`flowcore plugins:link PLUGIN`](#flowcore-pluginslink-plugin)
+* [`flowcore plugins:uninstall PLUGIN...`](#flowcore-pluginsuninstall-plugin)
+* [`flowcore plugins reset`](#flowcore-plugins-reset)
+* [`flowcore plugins:uninstall PLUGIN...`](#flowcore-pluginsuninstall-plugin-1)
+* [`flowcore plugins:uninstall PLUGIN...`](#flowcore-pluginsuninstall-plugin-2)
+* [`flowcore plugins update`](#flowcore-plugins-update)
+* [`flowcore stream STREAM`](#flowcore-stream-stream)
+* [`flowcore version`](#flowcore-version)
+* [`flowcore whoami`](#flowcore-whoami)
+
+## `flowcore autocomplete [SHELL]`
+
+Display autocomplete installation instructions.
+
+```
+USAGE
+  $ flowcore autocomplete [SHELL] [-r]
+
+ARGUMENTS
+  SHELL  (zsh|bash|powershell) Shell type
+
+FLAGS
+  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
+
+DESCRIPTION
+  Display autocomplete installation instructions.
+
+EXAMPLES
+  $ flowcore autocomplete
+
+  $ flowcore autocomplete bash
+
+  $ flowcore autocomplete zsh
+
+  $ flowcore autocomplete powershell
+
+  $ flowcore autocomplete --refresh-cache
+```
+
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.3/src/commands/autocomplete/index.ts)_
+
+## `flowcore config set`
+
+Configure the cli
+
+```
+USAGE
+  $ flowcore config set [--profile <value>] [-c <value>] [-n <value>] [-l <value>] [-p] [-u <value>]
+
+FLAGS
+  -c, --clientId=<value>      client id to use for the login
+  -l, --loginUrl=<value>      url to discover the openid configuration
+  -n, --clientSecret=<value>  name to print
+  -p, --port                  prompt for port to listen for the callback
+  -u, --url=<value>           url to the flowcore platform api
+      --profile=<value>       Specify the configuration profile to use
+
+DESCRIPTION
+  Configure the cli
+
+EXAMPLES
+  $ flowcore config set -l https://auth.flowcore.io/realms/flowcore/.well-known/openid-configuration -c my-client-id -s my-client-secret
+
+  $ flowcore config set -u https://graph.api.flowcore.io/graphql
+
+  $ flowcore config set -l https://auth.flowcore.io/realms/flowcore/.well-known/openid-configuration -c my-client-id -p
+```
+
+_See code: [src/commands/config/set.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.0.1/src/commands/config/set.ts)_
+
+## `flowcore config show`
+
+Show the configured login url
+
+```
+USAGE
+  $ flowcore config show [--profile <value>]
+
+FLAGS
+  --profile=<value>  Specify the configuration profile to use
+
+DESCRIPTION
+  Show the configured login url
+
+EXAMPLES
+  $ flowcore config show
+```
+
+_See code: [src/commands/config/show.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.0.1/src/commands/config/show.ts)_
+
+## `flowcore help [COMMANDS]`
+
+Display help for flowcore.
+
+```
+USAGE
+  $ flowcore help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for flowcore.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
+
+## `flowcore login`
+
+login to the Flowcore Platform
+
+```
+USAGE
+  $ flowcore login [--profile <value>] [-p <value>]
+
+FLAGS
+  -p, --port=<value>     [default: 3000] port to listen for the callback
+      --profile=<value>  Specify the configuration profile to use
+
+DESCRIPTION
+  login to the Flowcore Platform
+
+EXAMPLES
+  $ flowcore login
+
+  $ flowcore login --port 8080
+```
+
+_See code: [src/commands/login.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.0.1/src/commands/login.ts)_
+
+## `flowcore plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ flowcore plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ flowcore plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/index.ts)_
+
+## `flowcore plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ flowcore plugins add plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences yarn output.
+  -v, --verbose  Show verbose yarn output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ flowcore plugins add
+
+EXAMPLES
+  $ flowcore plugins add myplugin 
+
+  $ flowcore plugins add https://github.com/someuser/someplugin
+
+  $ flowcore plugins add someuser/someplugin
+```
+
+## `flowcore plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ flowcore plugins inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ flowcore plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/inspect.ts)_
+
+## `flowcore plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ flowcore plugins install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences yarn output.
+  -v, --verbose  Show verbose yarn output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ flowcore plugins add
+
+EXAMPLES
+  $ flowcore plugins install myplugin 
+
+  $ flowcore plugins install https://github.com/someuser/someplugin
+
+  $ flowcore plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/install.ts)_
+
+## `flowcore plugins:link PLUGIN`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ flowcore plugins link PLUGIN
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help          Show CLI help.
+  -v, --verbose
+      --[no-]install  Install dependencies after linking the plugin.
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ flowcore plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/link.ts)_
+
+## `flowcore plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ flowcore plugins remove plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ flowcore plugins unlink
+  $ flowcore plugins remove
+
+EXAMPLES
+  $ flowcore plugins remove myplugin
+```
+
+## `flowcore plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ flowcore plugins reset
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/reset.ts)_
+
+## `flowcore plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ flowcore plugins uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ flowcore plugins unlink
+  $ flowcore plugins remove
+
+EXAMPLES
+  $ flowcore plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/uninstall.ts)_
+
+## `flowcore plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ flowcore plugins unlink plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ flowcore plugins unlink
+  $ flowcore plugins remove
+
+EXAMPLES
+  $ flowcore plugins unlink myplugin
+```
+
+## `flowcore plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ flowcore plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/update.ts)_
+
+## `flowcore stream STREAM`
+
+Stream events from a datacore running on the Flowcore Platform
+
+```
+USAGE
+  $ flowcore stream STREAM [--profile <value>] [-d <value>] [-l] [-o http|log] [-s <value>]
+
+ARGUMENTS
+  STREAM  stream url to connect to
+
+FLAGS
+  -d, --destination=<value>  [default: http://localhost:3000/transform] Destination to send events to
+  -l, --live                 Change to live mode when reaching last time bucket
+  -o, --output=<option>      [default: http] Output format
+                             <options: http|log>
+  -s, --start=<value>        Start time bucket to stream from, example: (1y, 1m, 1d, 1h)
+      --profile=<value>      Specify the configuration profile to use
+
+DESCRIPTION
+  Stream events from a datacore running on the Flowcore Platform
+
+EXAMPLES
+  $ flowcore stream https://staging.flowcore.io/flowcore/flowcore-platform/organization.0/event.organization.subscription.updated-requested.0.stream
+```
+
+_See code: [src/commands/stream.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.0.1/src/commands/stream.ts)_
+
+## `flowcore version`
+
+```
+USAGE
+  $ flowcore version [--json] [--verbose]
+
+FLAGS
+  --verbose  Show additional information about the CLI.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+FLAG DESCRIPTIONS
+  --verbose  Show additional information about the CLI.
+
+    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
+```
+
+_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v2.0.9/src/commands/version.ts)_
+
+## `flowcore whoami`
+
+Check what user you are logged in as
+
+```
+USAGE
+  $ flowcore whoami [--profile <value>]
+
+FLAGS
+  --profile=<value>  Specify the configuration profile to use
+
+DESCRIPTION
+  Check what user you are logged in as
+```
+
+_See code: [src/commands/whoami.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.0.1/src/commands/whoami.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
+
+// eslint-disable-next-line node/shebang
+async function main() {
+  const {execute} = await import('@oclif/core')
+  await execute({development: true, dir: import.meta.url})
+}
+
+await main()

package/bin/run.cmd

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

package/bin/run.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+async function main() {
+  const {execute} = await import('@oclif/core')
+  await execute({dir: import.meta.url})
+}
+
+await main()

package/dist/base-command.d.ts

@@ -0,0 +1,17 @@
+import { Command, Interfaces } from '@oclif/core';
+import { CliConfiguration } from "./utils/config.util.js";
+export type Flags<T extends typeof Command> = Interfaces.InferredFlags<typeof BaseCommand['baseFlags'] & T['flags']>;
+export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
+export declare abstract class BaseCommand<T extends typeof Command> extends Command {
+    static baseFlags: {
+        profile: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+    };
+    protected args: Args<T>;
+    protected cliConfiguration: CliConfiguration;
+    protected flags: Flags<T>;
+    protected catch(err: Error & {
+        exitCode?: number;
+    }): Promise<unknown>;
+    protected finally(_: Error | undefined): Promise<unknown>;
+    protected init(): Promise<void>;
+}

package/dist/base-command.js

@@ -0,0 +1,32 @@
+// src/baseCommand.ts
+import { Command, Flags } from '@oclif/core';
+import { CliConfiguration } from "./utils/config.util.js";
+export class BaseCommand extends Command {
+    // define flags that can be inherited by any command that extends BaseCommand
+    static baseFlags = {
+        'profile': Flags.string({
+            description: 'Specify the configuration profile to use',
+        }),
+    };
+    args;
+    cliConfiguration = new CliConfiguration();
+    flags;
+    async catch(err) {
+        return super.catch(err);
+    }
+    async finally(_) {
+        return super.finally(_);
+    }
+    async init() {
+        await super.init();
+        const { args, flags } = await this.parse({
+            args: this.ctor.args,
+            baseFlags: super.ctor.baseFlags,
+            flags: this.ctor.flags,
+            strict: this.ctor.strict,
+        });
+        this.cliConfiguration.init(flags.profile || "default", this.config.configDir);
+        this.flags = flags;
+        this.args = args;
+    }
+}

package/dist/commands/config/set.d.ts

@@ -0,0 +1,13 @@
+import { BaseCommand } from "../../base-command.js";
+export default class Set extends BaseCommand<typeof Set> {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        clientId: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        clientSecret: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        loginUrl: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        port: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        url: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/config/set.js

@@ -0,0 +1,45 @@
+import { Flags } from '@oclif/core';
+import pkg from "enquirer";
+import _ from "lodash";
+import { BaseCommand } from "../../base-command.js";
+const { prompt } = pkg;
+export default class Set extends BaseCommand {
+    static description = 'Configure the cli';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> -l https://auth.flowcore.io/realms/flowcore/.well-known/openid-configuration -c my-client-id -s my-client-secret',
+        '<%= config.bin %> <%= command.id %> -u https://graph.api.flowcore.io/graphql',
+        '<%= config.bin %> <%= command.id %> -l https://auth.flowcore.io/realms/flowcore/.well-known/openid-configuration -c my-client-id -p',
+    ];
+    static flags = {
+        clientId: Flags.string({ char: 'c', description: 'client id to use for the login' }),
+        clientSecret: Flags.string({ char: 'n', description: 'name to print' }),
+        loginUrl: Flags.string({ char: 'l', description: 'url to discover the openid configuration' }),
+        port: Flags.boolean({ char: 'p', description: 'prompt for port to listen for the callback' }),
+        url: Flags.string({ char: 'u', description: 'url to the flowcore platform api' }),
+    };
+    async run() {
+        const { flags } = await this.parse(Set);
+        let callbackPort;
+        if (flags.port) {
+            const port = await prompt([{
+                    choices: ["3000", "4000", "5000", "6000"],
+                    message: "Select a port to listen for the callback",
+                    name: "callbackPort",
+                    type: "select"
+                }]);
+            callbackPort = port.callbackPort;
+        }
+        console.log(flags);
+        this.cliConfiguration.setConfig({
+            ...(flags.url && { api: {
+                    url: flags.url,
+                } }),
+            login: {
+                ...(callbackPort && { callbackPort }),
+                ...(flags.loginUrl && { url: flags.loginUrl }),
+                ..._.omit(flags, ["port", "url", "loginUrl"]),
+            }
+        });
+        this.cliConfiguration.displayConfigTable(this.log.bind(this));
+    }
+}

package/dist/commands/config/show.d.ts

@@ -0,0 +1,6 @@
+import { BaseCommand } from "../../base-command.js";
+export default class LoginShow extends BaseCommand<typeof LoginShow> {
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/config/show.js

@@ -0,0 +1,11 @@
+import { BaseCommand } from "../../base-command.js";
+export default class LoginShow extends BaseCommand {
+    static description = 'Show the configured login url';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+    ];
+    async run() {
+        this.log(`Showing configuration for ${this.cliConfiguration.getSelectedProfile()}`);
+        this.cliConfiguration.displayConfigTable(this.log.bind(this));
+    }
+}

package/dist/commands/login.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="node" resolution-mode="require"/>
+import * as http from "node:http";
+import { BaseClient } from "openid-client";
+import { BaseCommand } from "../base-command.js";
+export default class Login extends BaseCommand<typeof Login> {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        port: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    protected client: BaseClient | undefined;
+    protected server: http.Server | undefined;
+    protected catch(err: Error & {
+        exitCode?: number;
+    }): Promise<unknown>;
+    protected init(): Promise<void>;
+    run(): Promise<void>;
+    private writeToken;
+}