@flowcore/cli 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -7,6 +7,13 @@
 
 
 
+## [1.1.0](https://github.com/flowcore-io/flowcore-cli/compare/v1.0.2...v1.1.0) (2024-01-09)
+
+
+### Features
+
+* added json output ([c97b83e](https://github.com/flowcore-io/flowcore-cli/commit/c97b83e5f3f5d6172ce76e70d6331bee497b44db))
+
 ## [1.0.2](https://github.com/flowcore-io/flowcore-cli/compare/v1.0.1...v1.0.2) (2024-01-09)
 
 

package/README.md

@@ -17,7 +17,7 @@ $ npm install -g @flowcore/cli
 $ flowcore COMMAND
 running command...
 $ flowcore (--version)
-@flowcore/cli/1.0.2 linux-x64 node-v20.10.0
+@flowcore/cli/1.1.0 linux-x64 node-v20.10.0
 $ flowcore --help [COMMAND]
 USAGE
   $ flowcore COMMAND
@@ -103,7 +103,7 @@ EXAMPLES
   $ 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.2/src/commands/config/set.ts)_
+_See code: [src/commands/config/set.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.1.0/src/commands/config/set.ts)_
 
 ## `flowcore config show`
 
@@ -123,7 +123,7 @@ EXAMPLES
   $ flowcore config show
 ```
 
-_See code: [src/commands/config/show.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.0.2/src/commands/config/show.ts)_
+_See code: [src/commands/config/show.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.1.0/src/commands/config/show.ts)_
 
 ## `flowcore help [COMMANDS]`
 
@@ -166,7 +166,7 @@ EXAMPLES
   $ flowcore login --port 8080
 ```
 
-_See code: [src/commands/login.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.0.2/src/commands/login.ts)_
+_See code: [src/commands/login.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.1.0/src/commands/login.ts)_
 
 ## `flowcore plugins`
 
@@ -449,14 +449,15 @@ Stream events from a datacore running on the Flowcore Platform
 
 ```
 USAGE
-  $ flowcore stream STREAM [--profile <value>] [-d <value>] [-l] [-o http|log] [-s <value>]
+  $ flowcore stream STREAM [--profile <value>] [-d <value>] [-j] [-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
+  -j, --json                 Output json only
+  -l, --[no-]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)
@@ -469,7 +470,7 @@ 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.2/src/commands/stream.ts)_
+_See code: [src/commands/stream.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.1.0/src/commands/stream.ts)_
 
 ## `flowcore version`
 
@@ -506,5 +507,5 @@ 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.2/src/commands/whoami.ts)_
+_See code: [src/commands/whoami.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.1.0/src/commands/whoami.ts)_
 <!-- commandsstop -->

package/dist/commands/stream.d.ts

@@ -7,6 +7,7 @@ export default class Stream extends BaseCommand<typeof Stream> {
     static examples: string[];
     static flags: {
         destination: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        json: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         live: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         output: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         start: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;

package/dist/commands/stream.js

@@ -23,14 +23,15 @@ export default class Stream extends BaseCommand {
     ];
     static flags = {
         destination: Flags.string({ char: 'd', default: "http://localhost:3000/transform", description: 'Destination to send events to' }),
-        live: Flags.boolean({ char: 'l', default: true, description: 'Change to live mode when reaching last time bucket' }),
+        json: Flags.boolean({ char: 'j', description: 'Output json only' }),
+        live: Flags.boolean({ allowNo: true, char: 'l', default: true, description: 'Change to live mode when reaching last time bucket' }),
         output: Flags.string({ char: 'o', default: 'http', description: 'Output format', options: ['http', 'log'] }),
         start: Flags.string({ char: 's', description: 'Start time bucket to stream from, example: (1y, 1m, 1d, 1h)' }),
     };
     async run() {
         const config = this.cliConfiguration.getConfig();
         const loginValidator = new ValidateLogin(config.login.url);
-        const validateLogin = await loginValidator.validate(config, this.cliConfiguration);
+        const validateLogin = await loginValidator.validate(config, this.cliConfiguration, !this.flags.json);
         const { api, auth } = config;
         if (validateLogin.status !== LOGIN_CODES.LOGIN_SUCCESS || !auth) {
             ux.error(`Not logged in, please run ${ux.colorize("yellow", "flowcore login")} first`);
@@ -39,7 +40,7 @@ export default class Stream extends BaseCommand {
             ux.error("No api url configured");
         }
         const graphqlClient = new QueryGraphQL(api.url, auth.accessToken, async () => {
-            if (!await loginValidator.isExpired(config, this.cliConfiguration)) {
+            if (!await loginValidator.isExpired(config, this.cliConfiguration, !this.flags.json)) {
                 return false;
             }
             return config.auth.accessToken;
@@ -65,23 +66,23 @@ export default class Stream extends BaseCommand {
         let firstTimeBucket = eventRangeRequest.datacore.flowtypes.find(ft => ft.aggregator === aggregator)?.events.find(e => e.name === eventType)?.catalog.range.firstTimeBucket;
         if (!firstTimeBucket && !flags.start) {
             firstTimeBucket = createTimebucket(dayjs());
-            ux.warn(`First time bucket not found, setting to current time (${ux.colorize("yellowBright", firstTimeBucket)})`);
+            !this.flags.json && this.warn(`First time bucket not found, setting to current time (${ux.colorize("yellowBright", firstTimeBucket)})`);
         }
         if (flags.start) {
             firstTimeBucket = this.setTimeBucket(dayjs(), flags.start);
-            ux.log(ux.colorize("green", `Setting first time bucket to ${ux.colorize("yellow", flags.start)} ago (${ux.colorize("yellowBright", firstTimeBucket)})`));
+            !this.flags.json && this.log(ux.colorize("green", `Setting first time bucket to ${ux.colorize("yellow", flags.start)} ago (${ux.colorize("yellowBright", firstTimeBucket)})`));
         }
         if (!firstTimeBucket) {
             firstTimeBucket = this.setTimeBucket(dayjs(), "1d");
-            ux.log(ux.colorize("green", `Setting first time bucket to ${ux.colorize("yellow", "1d")} ago (${ux.colorize("yellowBright", firstTimeBucket)})`));
+            !this.flags.json && this.log(ux.colorize("green", `Setting first time bucket to ${ux.colorize("yellow", "1d")} ago (${ux.colorize("yellowBright", firstTimeBucket)})`));
         }
         let lastTimeBucket = eventRangeRequest.datacore.flowtypes.find(ft => ft.aggregator === aggregator)?.events.find(e => e.name === eventType)?.catalog.range.lastTimeBucket;
         if (!lastTimeBucket) {
             lastTimeBucket = createTimebucket(dayjs());
-            this.warn(`Last time bucket not found, setting to current time (${ux.colorize("yellowBright", lastTimeBucket)})`);
+            !this.flags.json && this.warn(`Last time bucket not found, setting to current time (${ux.colorize("yellowBright", lastTimeBucket)})`);
         }
         const observer = new Subject();
-        this.log(ux.colorize("blackBright", `Starting to stream events for ${dataCoreId} - ${aggregator} - ${eventType}, press ${ux.colorize("whiteBright", "ctrl+c")} to stop`));
+        !this.flags.json && this.log(ux.colorize("blackBright", `Starting to stream events for ${dataCoreId} - ${aggregator} - ${eventType}, press ${ux.colorize("whiteBright", "ctrl+c")} to stop`));
         // eslint-disable-next-line no-void
         void this.streanEvents(dataCoreId, aggregator, eventType, firstTimeBucket, lastTimeBucket, graphqlClient, observer, flags.live);
         await this.processEvents(observer, flags.destination, flags.output);
@@ -89,13 +90,14 @@ export default class Stream extends BaseCommand {
     async processEvents(observer, destination, output) {
         let done = false;
         let events = [];
+        const warn = this.flags.json ? () => { } : this.warn.bind(this);
         observer.subscribe({
             complete() {
-                ux.warn("Stream completed");
+                warn("Stream completed");
                 done = true;
             },
             error(error) {
-                ux.warn(`Stream error occurred with error ${error}`);
+                warn(`Stream error occurred with error ${error}`);
                 done = true;
             },
             next(value) {
@@ -109,10 +111,13 @@ export default class Stream extends BaseCommand {
             while (!processingQueue.isEmpty()) {
                 const event = processingQueue.dequeue();
                 if (output === "log") {
-                    ux.log(JSON.stringify(event));
+                    this.flags.json ? this.log(JSON.stringify({
+                        event,
+                        type: "input",
+                    }, null, 2)) : this.log(JSON.stringify(event));
                     continue;
                 }
-                this.debug(`Sending event to ${destination}: ${event.eventId}`);
+                this.log(`Sending event to ${destination}: ${event.eventId}`);
                 try {
                     // eslint-disable-next-line no-await-in-loop
                     const result = await fetch(destination, {
@@ -123,15 +128,19 @@ export default class Stream extends BaseCommand {
                         method: "POST",
                     });
                     if (!result.ok) {
-                        this.warn(`Error sending event to ${destination}: ${result.statusText}`);
+                        !this.flags.json && this.warn(`Error sending event to ${destination}: ${result.statusText}`);
                     }
                     if (result.body) {
-                        // eslint-disable-next-line no-await-in-loop
-                        ux.debug(`Response from ${destination}: ${await result.json()}`);
+                        this.flags.json ? this.log(JSON.stringify({
+                            // eslint-disable-next-line no-await-in-loop
+                            event: (await result.json()),
+                            type: "output",
+                            // eslint-disable-next-line no-await-in-loop
+                        }, null, 2)) : this.log(`Response from ${destination}: ${JSON.stringify(await result.json())}`);
                     }
                 }
                 catch (error) {
-                    this.warn(`Error sending event to ${destination}: ${error}`);
+                    !this.flags.json && this.warn(`Error sending event to ${destination}: ${error}`);
                 }
             }
             if (events.length === 0) {
@@ -159,7 +168,7 @@ export default class Stream extends BaseCommand {
                 return createTimebucket(date.subtract(Number.parseInt(parts[1], 10), "hour"));
             }
             default: {
-                this.error("Invalid start time bucket");
+                ux.error("Invalid start time bucket");
             }
         }
     }
@@ -171,11 +180,15 @@ export default class Stream extends BaseCommand {
         // eslint-disable-next-line no-constant-condition
         while (true) {
             const timeBucket = createTimebucket(startTimeBucket);
-            ux.action.start(`Fetching events for ${startTimeBucket}`);
+            if (!this.flags.json) {
+                ux.action.start(`Fetching events for ${startTimeBucket}`);
+            }
             let cursor = null;
             let found = false;
             do {
-                ux.action.status = `(${timeBucket}), cursor: ${cursor}`;
+                if (!this.flags.json) {
+                    ux.action.status = `(${timeBucket}), cursor: ${cursor}`;
+                }
                 // eslint-disable-next-line no-await-in-loop
                 await graphqlClient.validateToken();
                 try {
@@ -199,7 +212,7 @@ export default class Stream extends BaseCommand {
                     if (error instanceof Error && error.message.includes("Token is expired")) {
                         continue;
                     }
-                    ux.warn(`Error fetching events: ${error}`);
+                    this.warn(`Error fetching events: ${error}`);
                 }
             } while (cursor);
             if (dayjs(timeBucket, TIME_BUCKET_HOUR_PATTERN).isBefore(currentTime, "hour")) {
@@ -208,11 +221,13 @@ export default class Stream extends BaseCommand {
             if (timeBucket === lastTimeBucket) {
                 if (!live) {
                     observer.complete();
-                    ux.action.stop("Fetched all events, stopping");
+                    if (!this.flags.json) {
+                        ux.action.stop("Fetched all events, stopping");
+                    }
                     return;
                 }
                 if (!liveMode) {
-                    ux.warn("Reached last time bucket, switching to live mode");
+                    !this.flags.json && this.warn("Reached last time bucket, switching to live mode");
                     startTimeBucket = createTimebucketDayjs(currentTime);
                     liveMode = true;
                 }

package/dist/utils/validate-login.util.d.ts

@@ -14,9 +14,9 @@ export declare enum LOGIN_CODES {
 export declare class ValidateLogin {
     private readonly url;
     constructor(url: string);
-    isExpired(config: CliConfig, client: CliConfiguration): Promise<boolean>;
+    isExpired(config: CliConfig, client: CliConfiguration, displayProgress?: boolean): Promise<boolean>;
     tryRefreshToken(config: CliConfig, client: CliConfiguration): Promise<CliConfig>;
-    validate(config: CliConfig, client: CliConfiguration): Promise<{
+    validate(config: CliConfig, client: CliConfiguration, displayProgress?: boolean): Promise<{
         status: LOGIN_CODES;
     } | UserInfo & {
         status: LOGIN_CODES;

package/dist/utils/validate-login.util.js

@@ -11,16 +11,20 @@ export class ValidateLogin {
     constructor(url) {
         this.url = url;
     }
-    async isExpired(config, client) {
+    async isExpired(config, client, displayProgress = true) {
         const decoded = jwtDecode(config.auth?.accessToken ?? "");
         if (decoded.exp === undefined) {
             throw new Error("Invalid id token");
         }
         if (decoded.exp * 1000 < Date.now() - 5000) {
             try {
-                ux.action.start("Refreshing token");
+                if (displayProgress) {
+                    ux.action.start("Refreshing token");
+                }
                 config = await this.tryRefreshToken(config, client);
-                ux.action.stop("Refreshed token");
+                if (displayProgress) {
+                    ux.action.stop("Refreshed token");
+                }
                 return true;
             }
             catch (error) {
@@ -61,7 +65,7 @@ export class ValidateLogin {
         });
         return client.getConfig();
     }
-    async validate(config, client) {
+    async validate(config, client, displayProgress = true) {
         const response = await fetch(this.url);
         const json = await response.json();
         if (json.userinfo_endpoint === undefined) {
@@ -78,7 +82,7 @@ export class ValidateLogin {
             };
         }
         try {
-            await this.isExpired(config, client);
+            await this.isExpired(config, client, displayProgress);
         }
         catch {
             return {

package/oclif.manifest.json

@@ -71,11 +71,18 @@
           "multiple": false,
           "type": "option"
         },
+        "json": {
+          "char": "j",
+          "description": "Output json only",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "live": {
           "char": "l",
           "description": "Change to live mode when reaching last time bucket",
           "name": "live",
-          "allowNo": false,
+          "allowNo": true,
           "type": "boolean"
         },
         "output": {
@@ -249,5 +256,5 @@
       ]
     }
   },
-  "version": "1.0.2"
+  "version": "1.1.0"
 }

package/package.json

@@ -86,7 +86,7 @@
     "prestart": "npm run build",
     "update-schema": "rover graph introspect https://graph.api.staging.flowcore.io/graphql -o schema.gql"
   },
-  "version": "1.0.2",
+  "version": "1.1.0",
   "bugs": "https://github.com/flowcore-io/flowcore-cli/issues",
   "keywords": [
     "flowcore",