@flowcore/cli 4.9.1 → 4.10.1

package/CHANGELOG.md

@@ -10,6 +10,20 @@
 
 * added description to start that includes week ([58687a7](https://github.com/flowcore-io/flowcore-cli/commit/58687a7bbb66aaa5d6da26af88e555cbb1e72467))
 
+## [4.10.1](https://github.com/flowcore-io/flowcore-cli/compare/v4.10.0...v4.10.1) (2024-11-01)
+
+
+### Bug Fixes
+
+* update plugin core ([c1f2c25](https://github.com/flowcore-io/flowcore-cli/commit/c1f2c258eee8367ce74c0a8a05575ff3442b806d))
+
+## [4.10.0](https://github.com/flowcore-io/flowcore-cli/compare/v4.9.1...v4.10.0) (2024-10-25)
+
+
+### Features
+
+* **apply:** :sparkles: added new diff command to diff supplied resources with applied ones ([2b42f91](https://github.com/flowcore-io/flowcore-cli/commit/2b42f91d011b4707bf34965eba8f81becef788c0))
+
 ## [4.9.1](https://github.com/flowcore-io/flowcore-cli/compare/v4.9.0...v4.9.1) (2024-10-23)
 
 

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @flowcore/cli
 $ flowcore COMMAND
 running command...
 $ flowcore (--version)
-@flowcore/cli/4.9.1 linux-x64 node-v20.18.0
+@flowcore/cli/4.10.1 linux-x64 node-v20.18.0
 $ flowcore --help [COMMAND]
 USAGE
   $ flowcore COMMAND
@@ -43,6 +43,7 @@ USAGE
 * [`flowcore data-core generate flow-type`](#flowcore-data-core-generate-flow-type)
 * [`flowcore data-core init`](#flowcore-data-core-init)
 * [`flowcore delete`](#flowcore-delete)
+* [`flowcore diff`](#flowcore-diff)
 * [`flowcore generate nextjs-entity NAME`](#flowcore-generate-nextjs-entity-name)
 * [`flowcore get adapter [ADAPTER]`](#flowcore-get-adapter-adapter)
 * [`flowcore get scenario [SCENARIO]`](#flowcore-get-scenario-scenario)
@@ -98,7 +99,7 @@ EXAMPLES
   $ flowcore apply -f ./path/to/manifest.yml
 ```
 
-_See code: [src/commands/apply.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.9.1/src/commands/apply.ts)_
+_See code: [src/commands/apply.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.10.1/src/commands/apply.ts)_
 
 ## `flowcore auth delete key API_KEY_NAME`
 
@@ -482,7 +483,28 @@ EXAMPLES
   cat ./path/to/manifest.yml | flowcore delete -f -
 ```
 
-_See code: [src/commands/delete.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.9.1/src/commands/delete.ts)_
+_See code: [src/commands/delete.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.10.1/src/commands/delete.ts)_
+
+## `flowcore diff`
+
+Diff a resource manifests against the Flowcore Platform
+
+```
+USAGE
+  $ flowcore diff -f <value> [--profile <value>]
+
+FLAGS
+  -f, --file=<value>...  (required) file or directory to diff
+      --profile=<value>  Specify the configuration profile to use
+
+DESCRIPTION
+  Diff a resource manifests against the Flowcore Platform
+
+EXAMPLES
+  $ flowcore diff -f ./path/to/manifest.yml
+```
+
+_See code: [src/commands/diff.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.10.1/src/commands/diff.ts)_
 
 ## `flowcore generate nextjs-entity NAME`
 
@@ -627,7 +649,7 @@ EXAMPLES
   $ flowcore info
 ```
 
-_See code: [src/commands/info.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.9.1/src/commands/info.ts)_
+_See code: [src/commands/info.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.10.1/src/commands/info.ts)_
 
 ## `flowcore login`
 
@@ -1268,20 +1290,22 @@ Stream events from a datacore running on the Flowcore Platform and output them t
 
 ```
 USAGE
-  $ flowcore stream STREAM [-e <value>] [-j] [-l] [-m <value>] [-p] [-c] [-s <value>] [--profile <value>]
+  $ flowcore stream STREAM [-e <value>] [-j] [-l] [-m <value>] [-p] [-c] [-s <value>] [-z <value>]
+    [--profile <value>]
 
 ARGUMENTS
   STREAM  stream url to connect to
 
 FLAGS
-  -c, --scan             Scan the full time range
-  -e, --end=<value>      End time to stream to, example: 2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now
-  -j, --json             Output json only
-  -l, --[no-]live        Change to live mode when reaching last time bucket
-  -m, --max=<value>      Maximum number of events to send to the destination
-  -p, --payload          Only send the event payload to the destination
-  -s, --start=<value>    Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now)
-      --profile=<value>  Specify the configuration profile to use
+  -c, --scan              Scan the full time range
+  -e, --end=<value>       End time to stream to, example: 2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now
+  -j, --json              Output json only
+  -l, --[no-]live         Change to live mode when reaching last time bucket
+  -m, --max=<value>       Maximum number of events to send to the destination
+  -p, --payload           Only send the event payload to the destination
+  -s, --start=<value>     Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now)
+  -z, --pageSize=<value>  [default: 10000] Number of events to fetch per page
+      --profile=<value>   Specify the configuration profile to use
 
 DESCRIPTION
   Stream events from a datacore running on the Flowcore Platform and output them to the console
@@ -1300,7 +1324,7 @@ EXAMPLES
   $ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].stream" -s 3m
 ```
 
-_See code: [@flowcore/cli-plugin-core](https://github.com/flowcore/flowcore-cli-plugin-core/blob/v4.6.0/src/commands/stream.ts)_
+_See code: [@flowcore/cli-plugin-core](https://github.com/flowcore/flowcore-cli-plugin-core/blob/v4.9.0/src/commands/stream.ts)_
 
 ## `flowcore stream http STREAM`
 
@@ -1308,8 +1332,8 @@ Stream events from a datacore running on the Flowcore Platform and stream to a h
 
 ```
 USAGE
-  $ flowcore stream http STREAM [-e <value>] [-j] [-l] [-m <value>] [-p] [-c] [-s <value>] [--profile <value>]
-    [-d <value>] [-H <value>] [-t <value>]
+  $ flowcore stream http STREAM [-e <value>] [-j] [-l] [-m <value>] [-p] [-c] [-s <value>] [-z <value>]
+    [--profile <value>] [-d <value>] [-H <value>] [-t <value>]
 
 ARGUMENTS
   STREAM  stream url to connect to
@@ -1325,6 +1349,7 @@ FLAGS
   -p, --payload              Only send the event payload to the destination
   -s, --start=<value>        Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now)
   -t, --timeout=<value>      [default: 5000] Timeout in milliseconds to wait for a response from the destination
+  -z, --pageSize=<value>     [default: 10000] Number of events to fetch per page
       --profile=<value>      Specify the configuration profile to use
 
 DESCRIPTION
@@ -1342,7 +1367,7 @@ EXAMPLES
   $ flowcore stream http "https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].stream" -s 3m -d http://localhost:3000/transform
 ```
 
-_See code: [@flowcore/cli-plugin-core](https://github.com/flowcore/flowcore-cli-plugin-core/blob/v4.6.0/src/commands/stream/http.ts)_
+_See code: [@flowcore/cli-plugin-core](https://github.com/flowcore/flowcore-cli-plugin-core/blob/v4.9.0/src/commands/stream/http.ts)_
 
 ## `flowcore version`
 

package/dist/commands/diff.d.ts

@@ -0,0 +1,10 @@
+import { BaseCommand } from "@flowcore/cli-plugin-config";
+export default class Diff extends BaseCommand<typeof Diff> {
+    static args: {};
+    static description: string;
+    static examples: string[];
+    static flags: {
+        file: import("@oclif/core/interfaces").OptionFlag<string[], import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/diff.js

@@ -0,0 +1,56 @@
+import { BaseCommand } from "@flowcore/cli-plugin-config";
+import { ApiRegistryService, baseResourceDto } from "@flowcore/cli-plugin-core";
+import { Flags } from "@oclif/core";
+import dayjs from "dayjs";
+import isSameOrBefore from "dayjs/plugin/isSameOrBefore.js";
+import utc from "dayjs/plugin/utc.js";
+import * as yaml from "js-yaml";
+import fs from "node:fs";
+import { join } from "node:path";
+dayjs.extend(utc);
+dayjs.extend(isSameOrBefore);
+export default class Diff extends BaseCommand {
+    static args = {};
+    static description = "Diff a resource manifests against the Flowcore Platform";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> -f ./path/to/manifest.yml",
+    ];
+    static flags = {
+        file: Flags.string({
+            char: "f",
+            description: "file or directory to diff",
+            multiple: true,
+            required: true,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(Diff);
+        const apiRegistry = ApiRegistryService.getInstance(this.logger);
+        await this.config.runHook("register-api", {
+            apiRegistry,
+            cliConfiguration: this.cliConfiguration,
+            logger: this.logger,
+        });
+        try {
+            let documents = [];
+            if (fs.statSync(flags.file[0]).isDirectory()) {
+                const files = fs.readdirSync(flags.file[0]);
+                documents = files.flatMap((file) => {
+                    const content = fs.readFileSync(join(flags.file[0], file), "utf8");
+                    return yaml.loadAll(content);
+                });
+            }
+            else {
+                documents = flags.file.flatMap((file) => {
+                    const content = fs.readFileSync(file, "utf8");
+                    return yaml.loadAll(content);
+                });
+            }
+            documents.map((doc) => baseResourceDto.parse(doc));
+            await apiRegistry.showDiff(documents);
+        }
+        catch (error) {
+            this.logger.fatal(`Failed to diff documents with error: ${error}`);
+        }
+    }
+}

package/oclif.manifest.json

@@ -101,6 +101,46 @@
         "delete.js"
       ]
     },
+    "diff": {
+      "aliases": [],
+      "args": {},
+      "description": "Diff a resource manifests against the Flowcore Platform",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> -f ./path/to/manifest.yml"
+      ],
+      "flags": {
+        "profile": {
+          "description": "Specify the configuration profile to use",
+          "name": "profile",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "file": {
+          "char": "f",
+          "description": "file or directory to diff",
+          "name": "file",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "diff",
+      "pluginAlias": "@flowcore/cli",
+      "pluginName": "@flowcore/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "diff.js"
+      ]
+    },
     "info": {
       "aliases": [],
       "args": {},
@@ -133,5 +173,5 @@
       ]
     }
   },
-  "version": "4.9.1"
+  "version": "4.10.1"
 }

package/package.json

@@ -8,7 +8,7 @@
     "@flowcore/cli-plugin-ai": "^1.1.2",
     "@flowcore/cli-plugin-auth-management": "^1.2.2",
     "@flowcore/cli-plugin-config": "^2.4.1",
-    "@flowcore/cli-plugin-core": "^4.6.0",
+    "@flowcore/cli-plugin-core": "^4.9.0",
     "@flowcore/cli-plugin-data-core": "^3.1.1",
     "@flowcore/cli-plugin-generator": "^1.6.0",
     "@flowcore/cli-plugin-scenario": "^4.1.2",
@@ -112,7 +112,7 @@
     "prestart": "npm run build",
     "update-schema": "rover graph introspect https://graph.api.staging.flowcore.io/graphql -o schema.gql"
   },
-  "version": "4.9.1",
+  "version": "4.10.1",
   "bugs": "https://github.com/flowcore-io/flowcore-cli/issues",
   "keywords": [
     "flowcore",