@flowcore/cli 1.0.1

package/dist/utils/queries/fetch-event-type-range.gql.d.ts

@@ -0,0 +1,21 @@
+export type FetchEventTypeRangeResponse = {
+    datacore: {
+        flowtypes: {
+            aggregator: string;
+            events: {
+                catalog: {
+                    range: {
+                        firstTimeBucket: string;
+                        lastTimeBucket: string;
+                    };
+                };
+                name: string;
+            }[];
+        }[];
+    };
+};
+export type FetchEventTypeRangeQueryInput = {
+    aggregator: string;
+    dataCoreId: string;
+};
+export declare const FETCH_EVENT_TYPE_RANGE_GQL_QUERY: string;

package/dist/utils/queries/fetch-event-type-range.gql.js

@@ -0,0 +1,19 @@
+import { gql } from "graphql-request";
+export const FETCH_EVENT_TYPE_RANGE_GQL_QUERY = gql `
+  query FLOWCORE_CLI_FETCH_EVENT_TYPE_RANGE($dataCoreId: ID!, $aggregator: String!) {
+    datacore(search: {id: $dataCoreId}) {
+      flowtypes(search: {aggregator: $aggregator }) {
+        aggregator
+        events {
+          name
+          catalog {
+            range {
+              firstTimeBucket
+              lastTimeBucket
+            }
+          }
+        }
+      }
+    }
+  }
+`;

package/dist/utils/queries/fetch-events.gql.d.ts

@@ -0,0 +1,28 @@
+export type FetchEventsResponse = {
+    datacore: {
+        fetchEvents: {
+            cursor: string;
+            events: {
+                aggregator: string;
+                dataCore: string;
+                eventId: string;
+                eventType: string;
+                metadata: string;
+                payload: string;
+                timeBucket: string;
+                validTime: string;
+            }[];
+        };
+    };
+};
+export type FetchEventsQueryInput = {
+    afterEventId?: string;
+    aggregator: string;
+    beforeEventId?: string;
+    cursor?: string;
+    dataCoreId: string;
+    eventType: string;
+    pageSize?: number;
+    timeBucket: string;
+};
+export declare const FETCH_EVENTS_GQL_QUERY: string;

package/dist/utils/queries/fetch-events.gql.js

@@ -0,0 +1,28 @@
+import { gql } from "graphql-request";
+export const FETCH_EVENTS_GQL_QUERY = gql `
+  query FLOWCORE_CLI_FETCH_EVENTS($dataCoreId: ID!, $aggregator: String!, $eventType: String!, $timeBucket: String!, $cursor: String, $afterEventId: String, $beforeEventId: String, $pageSize: Int) {
+    datacore(search: {id: $dataCoreId}) {
+      fetchEvents(input: {
+        aggregator: $aggregator,
+        eventTypes: [$eventType],
+        timeBucket: $timeBucket
+        cursor: $cursor
+        afterEventId: $afterEventId
+        beforeEventId: $beforeEventId
+        pageSize: $pageSize
+      }) {
+        events {
+          eventId
+          timeBucket
+          eventType
+          aggregator
+          dataCore
+          metadata
+          payload
+          validTime
+        }
+        cursor
+      }
+    }
+  }
+`;

package/dist/utils/timebucket.util.d.ts

@@ -0,0 +1,5 @@
+import { Dayjs } from "dayjs";
+export declare const TIME_BUCKET_PATTERN = "YYYYMMDDHHmmss";
+export declare const TIME_BUCKET_HOUR_PATTERN = "YYYYMMDDHH";
+export declare const createTimebucket: (date: Dayjs) => string;
+export declare const createTimebucketDayjs: (date: Dayjs) => Dayjs;

package/dist/utils/timebucket.util.js

@@ -0,0 +1,11 @@
+import { TimeBucket } from "@flowcore/time-bucket";
+export const TIME_BUCKET_PATTERN = "YYYYMMDDHHmmss";
+export const TIME_BUCKET_HOUR_PATTERN = "YYYYMMDDHH";
+export const createTimebucket = (date) => {
+    const timeBucket = TimeBucket.create(TIME_BUCKET_HOUR_PATTERN, TIME_BUCKET_PATTERN);
+    return timeBucket(date).format(TIME_BUCKET_PATTERN);
+};
+export const createTimebucketDayjs = (date) => {
+    const timeBucket = TimeBucket.create(TIME_BUCKET_HOUR_PATTERN, TIME_BUCKET_PATTERN);
+    return timeBucket(date);
+};

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

@@ -0,0 +1,24 @@
+import { CliConfig, CliConfiguration } from "./config.util.js";
+export type UserInfo = {
+    family_name: string;
+    flowcore_user_id: string;
+    given_name: string;
+    name: string;
+    preferred_username: string;
+};
+export declare enum LOGIN_CODES {
+    LOGIN_EXPIRED = 2,
+    LOGIN_FAILED = 0,
+    LOGIN_SUCCESS = 1
+}
+export declare class ValidateLogin {
+    private readonly url;
+    constructor(url: string);
+    isExpired(config: CliConfig, client: CliConfiguration): Promise<boolean>;
+    tryRefreshToken(config: CliConfig, client: CliConfiguration): Promise<CliConfig>;
+    validate(config: CliConfig, client: CliConfiguration): Promise<{
+        status: LOGIN_CODES;
+    } | UserInfo & {
+        status: LOGIN_CODES;
+    }>;
+}

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

@@ -0,0 +1,111 @@
+import { ux } from "@oclif/core";
+import { jwtDecode } from "jwt-decode";
+export var LOGIN_CODES;
+(function (LOGIN_CODES) {
+    LOGIN_CODES[LOGIN_CODES["LOGIN_EXPIRED"] = 2] = "LOGIN_EXPIRED";
+    LOGIN_CODES[LOGIN_CODES["LOGIN_FAILED"] = 0] = "LOGIN_FAILED";
+    LOGIN_CODES[LOGIN_CODES["LOGIN_SUCCESS"] = 1] = "LOGIN_SUCCESS";
+})(LOGIN_CODES || (LOGIN_CODES = {}));
+export class ValidateLogin {
+    url;
+    constructor(url) {
+        this.url = url;
+    }
+    async isExpired(config, client) {
+        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");
+                config = await this.tryRefreshToken(config, client);
+                ux.action.stop("Refreshed token");
+                return true;
+            }
+            catch (error) {
+                ux.error(`Failed to refresh token: ${error}`);
+            }
+        }
+        return false;
+    }
+    async tryRefreshToken(config, client) {
+        if (config.auth?.refreshToken === undefined) {
+            throw new Error("No refresh token");
+        }
+        const response = await fetch(this.url);
+        const json = await response.json();
+        if (json.token_endpoint === undefined) {
+            throw new Error("No token_endpoint in openid configuration");
+        }
+        const body = new URLSearchParams();
+        body.append("grant_type", "refresh_token");
+        body.append("refresh_token", config.auth.refreshToken);
+        body.append("client_id", config.login.clientId);
+        body.append("client_secret", config.login.clientSecret ?? "");
+        const result = await fetch(json.token_endpoint, {
+            body,
+            method: "POST",
+        });
+        if (result.status !== 200) {
+            throw new Error("Failed to refresh token");
+        }
+        const resultJson = await result.json();
+        client.setConfig({
+            auth: {
+                ...config.auth,
+                accessToken: resultJson.access_token,
+                idToken: resultJson.id_token,
+                refreshToken: resultJson.refresh_token,
+            }
+        });
+        return client.getConfig();
+    }
+    async validate(config, client) {
+        const response = await fetch(this.url);
+        const json = await response.json();
+        if (json.userinfo_endpoint === undefined) {
+            throw new Error("No userinfo_endpoint in openid configuration");
+        }
+        if (config.auth === undefined) {
+            return {
+                status: LOGIN_CODES.LOGIN_FAILED,
+            };
+        }
+        if (config.auth.accessToken === undefined) {
+            return {
+                status: LOGIN_CODES.LOGIN_FAILED,
+            };
+        }
+        try {
+            await this.isExpired(config, client);
+        }
+        catch {
+            return {
+                status: LOGIN_CODES.LOGIN_EXPIRED,
+            };
+        }
+        try {
+            const result = await fetch(json.userinfo_endpoint, {
+                headers: {
+                    "Authorization": `Bearer ${config?.auth?.accessToken}`,
+                }
+            });
+            if (result.status !== 200) {
+                return {
+                    status: LOGIN_CODES.LOGIN_FAILED,
+                };
+            }
+            return {
+                ...await result.json(),
+                status: LOGIN_CODES.LOGIN_SUCCESS,
+            };
+        }
+        catch (error) {
+            console.error(error);
+            return {
+                status: LOGIN_CODES.LOGIN_FAILED,
+            };
+        }
+    }
+}

package/oclif.manifest.json

@@ -0,0 +1,253 @@
+{
+  "commands": {
+    "login": {
+      "aliases": [],
+      "args": {},
+      "description": "login to the Flowcore Platform",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --port 8080"
+      ],
+      "flags": {
+        "profile": {
+          "description": "Specify the configuration profile to use",
+          "name": "profile",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "port": {
+          "char": "p",
+          "description": "port to listen for the callback",
+          "name": "port",
+          "default": 3000,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "login",
+      "pluginAlias": "@flowcore/cli",
+      "pluginName": "@flowcore/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "login.js"
+      ]
+    },
+    "stream": {
+      "aliases": [],
+      "args": {
+        "STREAM": {
+          "description": "stream url to connect to",
+          "name": "STREAM",
+          "required": true
+        }
+      },
+      "description": "Stream events from a datacore running on the Flowcore Platform",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> https://staging.flowcore.io/flowcore/flowcore-platform/organization.0/event.organization.subscription.updated-requested.0.stream"
+      ],
+      "flags": {
+        "profile": {
+          "description": "Specify the configuration profile to use",
+          "name": "profile",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "destination": {
+          "char": "d",
+          "description": "Destination to send events to",
+          "name": "destination",
+          "default": "http://localhost:3000/transform",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "live": {
+          "char": "l",
+          "description": "Change to live mode when reaching last time bucket",
+          "name": "live",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "output": {
+          "char": "o",
+          "description": "Output format",
+          "name": "output",
+          "default": "http",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "http",
+            "log"
+          ],
+          "type": "option"
+        },
+        "start": {
+          "char": "s",
+          "description": "Start time bucket to stream from, example: (1y, 1m, 1d, 1h)",
+          "name": "start",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "stream",
+      "pluginAlias": "@flowcore/cli",
+      "pluginName": "@flowcore/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "stream.js"
+      ]
+    },
+    "whoami": {
+      "aliases": [],
+      "args": {},
+      "description": "Check what user you are logged in as",
+      "flags": {
+        "profile": {
+          "description": "Specify the configuration profile to use",
+          "name": "profile",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "whoami",
+      "pluginAlias": "@flowcore/cli",
+      "pluginName": "@flowcore/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "whoami.js"
+      ]
+    },
+    "config:set": {
+      "aliases": [],
+      "args": {},
+      "description": "Configure the cli",
+      "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"
+      ],
+      "flags": {
+        "profile": {
+          "description": "Specify the configuration profile to use",
+          "name": "profile",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "clientId": {
+          "char": "c",
+          "description": "client id to use for the login",
+          "name": "clientId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "clientSecret": {
+          "char": "n",
+          "description": "name to print",
+          "name": "clientSecret",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "loginUrl": {
+          "char": "l",
+          "description": "url to discover the openid configuration",
+          "name": "loginUrl",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "port": {
+          "char": "p",
+          "description": "prompt for port to listen for the callback",
+          "name": "port",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "url": {
+          "char": "u",
+          "description": "url to the flowcore platform api",
+          "name": "url",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "config:set",
+      "pluginAlias": "@flowcore/cli",
+      "pluginName": "@flowcore/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "config",
+        "set.js"
+      ]
+    },
+    "config:show": {
+      "aliases": [],
+      "args": {},
+      "description": "Show the configured login url",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "profile": {
+          "description": "Specify the configuration profile to use",
+          "name": "profile",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "config:show",
+      "pluginAlias": "@flowcore/cli",
+      "pluginName": "@flowcore/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "config",
+        "show.js"
+      ]
+    }
+  },
+  "version": "1.0.1"
+}

package/package.json

@@ -0,0 +1,102 @@
+{
+  "author": "Flowcore",
+  "bin": {
+    "flowcore": "./bin/run.js"
+  },
+  "dependencies": {
+    "@datastructures-js/queue": "^4.2.3",
+    "@flowcore/time-bucket": "^1.1.0",
+    "@oclif/core": "^3",
+    "@oclif/plugin-autocomplete": "^3.0.2",
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-not-found": "^3.0.4",
+    "@oclif/plugin-plugins": "^4",
+    "@oclif/plugin-version": "^2.0.8",
+    "axios": "^1.6.2",
+    "cross-fetch": "^4.0.0",
+    "dayjs": "^1.11.10",
+    "enquirer": "^2.4.1",
+    "express": "^4.18.2",
+    "graphql": "^16.8.1",
+    "graphql-request": "^6.1.0",
+    "jwt-decode": "^4.0.0",
+    "lodash": "^4.17.21",
+    "merge": "^2.1.1",
+    "open": "^9.1.0",
+    "openid-client": "^5.6.1",
+    "rxjs": "^7.8.1",
+    "session": "^0.1.0"
+  },
+  "description": "Flowcore CLI for interacting with the Flowcore platform",
+  "devDependencies": {
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^3",
+    "@types/chai": "^4",
+    "@types/express": "^4.17.21",
+    "@types/lodash": "^4.14.202",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
+    "chai": "^4",
+    "eslint": "^8",
+    "eslint-config-oclif": "^5",
+    "eslint-config-oclif-typescript": "^3",
+    "eslint-config-prettier": "^9.0.0",
+    "mocha": "^10",
+    "oclif": "^4.0.4",
+    "shx": "^0.3.4",
+    "ts-node": "^10.9.1",
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "/bin",
+    "/dist",
+    "/oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/flowcore-io/flowcore-cli",
+  "license": "MIT",
+  "main": "",
+  "name": "@flowcore/cli",
+  "oclif": {
+    "bin": "flowcore",
+    "dirname": "flowcore",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-version",
+      "@oclif/plugin-plugins",
+      "@oclif/plugin-autocomplete",
+      "@oclif/plugin-not-found"
+    ],
+    "topicSeparator": " "
+  },
+  "repository": "flowcore-io/flowcore-cli",
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint . --ext .ts",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "npm run build && oclif manifest && oclif readme",
+    "prepare": "npm run build",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md",
+    "start": "./bin/run.js",
+    "prestart": "npm run build",
+    "update-schema": "rover graph introspect https://graph.api.staging.flowcore.io/graphql -o schema.gql"
+  },
+  "version": "1.0.1",
+  "bugs": "https://github.com/flowcore-io/flowcore-cli/issues",
+  "keywords": [
+    "flowcore",
+    "cli",
+    "flowcore-cli",
+    "streaming",
+    "events",
+    "data"
+  ],
+  "types": "dist/index.d.ts",
+  "exports": "./lib/index.js",
+  "type": "module"
+}