@contextual-io/cli 0.5.0 → 0.6.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @contextual-io/cli
 $ ctxl COMMAND
 running command...
 $ ctxl (--version)
-@contextual-io/cli/0.5.0 linux-x64 node-v25.2.1
+@contextual-io/cli/0.6.0 linux-x64 node-v25.2.1
 $ ctxl --help [COMMAND]
 USAGE
   $ ctxl COMMAND
@@ -48,8 +48,11 @@ USAGE
 * [`ctxl records list [URI]`](#ctxl-records-list-uri)
 * [`ctxl records patch [URI]`](#ctxl-records-patch-uri)
 * [`ctxl records query [URI]`](#ctxl-records-query-uri)
+* [`ctxl records remove [URI]`](#ctxl-records-remove-uri)
 * [`ctxl records replace [URI]`](#ctxl-records-replace-uri)
+* [`ctxl records rm [URI]`](#ctxl-records-rm-uri)
 * [`ctxl records search [URI]`](#ctxl-records-search-uri)
+* [`ctxl records stats [URI]`](#ctxl-records-stats-uri)
 * [`ctxl types <COMMAND>`](#ctxl-types-command)
 * [`ctxl types add`](#ctxl-types-add)
 * [`ctxl types create`](#ctxl-types-create)
@@ -57,7 +60,9 @@ USAGE
 * [`ctxl types get [URI]`](#ctxl-types-get-uri)
 * [`ctxl types import`](#ctxl-types-import)
 * [`ctxl types list`](#ctxl-types-list)
+* [`ctxl types remove [URI]`](#ctxl-types-remove-uri)
 * [`ctxl types replace [URI]`](#ctxl-types-replace-uri)
+* [`ctxl types rm [URI]`](#ctxl-types-rm-uri)
 * [`ctxl types search`](#ctxl-types-search)
 
 ## `ctxl autocomplete [SHELL]`
@@ -349,6 +354,10 @@ GLOBAL FLAGS
 DESCRIPTION
   Delete record(s).
 
+ALIASES
+  $ ctxl records rm
+  $ ctxl records remove
+
 EXAMPLES
   $ ctxl records delete native-object:my-type/instance-1
 
@@ -542,6 +551,43 @@ EXAMPLES
   $ ctxl records query --type my-type --include-total --query-file query.json
 ```
 
+## `ctxl records remove [URI]`
+
+Delete record(s).
+
+```
+USAGE
+  $ ctxl records remove [URI] [-C <value>] [-I <value>...] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of record
+
+FLAGS
+  -I, --id=<value>...  id(s)
+  -T, --type=<value>   type
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Delete record(s).
+
+ALIASES
+  $ ctxl records rm
+  $ ctxl records remove
+
+EXAMPLES
+  $ ctxl records remove native-object:my-type/instance-1
+
+  $ ctxl records remove native-object:my-type --id instance-1
+
+  $ ctxl records remove native-object:my-type --id instance-1 --id instance-2
+
+  $ ctxl records remove --type my-type --id instance-1
+
+  $ ctxl records remove --type my-type --id instance-1 --id instance-2
+```
+
 ## `ctxl records replace [URI]`
 
 Replace a record.
@@ -572,6 +618,43 @@ EXAMPLES
   $ ctxl records replace --type my-type --id instance-1 --input-file record.json
 ```
 
+## `ctxl records rm [URI]`
+
+Delete record(s).
+
+```
+USAGE
+  $ ctxl records rm [URI] [-C <value>] [-I <value>...] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of record
+
+FLAGS
+  -I, --id=<value>...  id(s)
+  -T, --type=<value>   type
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Delete record(s).
+
+ALIASES
+  $ ctxl records rm
+  $ ctxl records remove
+
+EXAMPLES
+  $ ctxl records rm native-object:my-type/instance-1
+
+  $ ctxl records rm native-object:my-type --id instance-1
+
+  $ ctxl records rm native-object:my-type --id instance-1 --id instance-2
+
+  $ ctxl records rm --type my-type --id instance-1
+
+  $ ctxl records rm --type my-type --id instance-1 --id instance-2
+```
+
 ## `ctxl records search [URI]`
 
 List records.
@@ -616,6 +699,35 @@ EXAMPLES
   $ ctxl records search --type my-type -s field1=value1 -s field2=value2 --include-total
 ```
 
+## `ctxl records stats [URI]`
+
+Get the stats of a record.
+
+```
+USAGE
+  $ ctxl records stats [URI] [-C <value>] [-I <value>] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of record
+
+FLAGS
+  -I, --id=<value>    id
+  -T, --type=<value>  type
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Get the stats of a record.
+
+EXAMPLES
+  $ ctxl records stats native-object:my-type/instance-1
+
+  $ ctxl records stats native-object:my-type --id instance-1
+
+  $ ctxl records stats --type my-type --id instance-1
+```
+
 ## `ctxl types <COMMAND>`
 
 Manage types.
@@ -702,6 +814,10 @@ GLOBAL FLAGS
 DESCRIPTION
   Delete a type.
 
+ALIASES
+  $ ctxl types rm
+  $ ctxl types remove
+
 EXAMPLES
   $ ctxl types delete native-object:my-type
 
@@ -799,6 +915,36 @@ EXAMPLES
   $ ctxl types list -s field1=value1 -s field2=value2 --include-total
 ```
 
+## `ctxl types remove [URI]`
+
+Delete a type.
+
+```
+USAGE
+  $ ctxl types remove [URI] [-C <value>] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of type
+
+FLAGS
+  -T, --type=<value>  type
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Delete a type.
+
+ALIASES
+  $ ctxl types rm
+  $ ctxl types remove
+
+EXAMPLES
+  $ ctxl types remove native-object:my-type
+
+  $ ctxl types remove --type my-type
+```
+
 ## `ctxl types replace [URI]`
 
 Replace a type.
@@ -826,6 +972,36 @@ EXAMPLES
   $ ctxl types replace --type my-type  --input-file record.json
 ```
 
+## `ctxl types rm [URI]`
+
+Delete a type.
+
+```
+USAGE
+  $ ctxl types rm [URI] [-C <value>] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of type
+
+FLAGS
+  -T, --type=<value>  type
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Delete a type.
+
+ALIASES
+  $ ctxl types rm
+  $ ctxl types remove
+
+EXAMPLES
+  $ ctxl types rm native-object:my-type
+
+  $ ctxl types rm --type my-type
+```
+
 ## `ctxl types search`
 
 List types.

package/dist/commands/records/delete.d.ts

@@ -1,5 +1,6 @@
 import { BaseCommand } from "../../base.js";
 export default class RecordsDelete extends BaseCommand<typeof RecordsDelete> {
+    static aliases: string[];
     static args: {
         uri: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
     };

package/dist/commands/records/delete.js

@@ -3,6 +3,7 @@ import { BaseCommand } from "../../base.js";
 import { parseUri } from "../../models/uri.js";
 import { getNativeObjectApiEndpoint } from "../../utils/endpoints.js";
 export default class RecordsDelete extends BaseCommand {
+    static aliases = ["records rm", "records remove"];
     static args = {
         "uri": Args.string({ description: "uri of record" }),
     };

package/dist/commands/records/stats.d.ts

@@ -0,0 +1,13 @@
+import { BaseCommand } from "../../base.js";
+export default class RecordsStats extends BaseCommand<typeof RecordsStats> {
+    static args: {
+        uri: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        id: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        type: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/records/stats.js

@@ -0,0 +1,73 @@
+import { Args, Flags } from "@oclif/core";
+import { BaseCommand } from "../../base.js";
+import { parseUri } from "../../models/uri.js";
+import { getNativeObjectApiEndpoint } from "../../utils/endpoints.js";
+const bytesToString = (bytes) => {
+    if (bytes < 1000)
+        return `${bytes} B`;
+    bytes /= 1000;
+    if (bytes < 1000)
+        return `${bytes.toFixed(2)} kB`;
+    bytes /= 1000;
+    if (bytes < 1000)
+        return `${bytes.toFixed(2)} MB`;
+    bytes /= 1000;
+    return `${bytes.toFixed(2)} GB`;
+};
+export default class RecordsStats extends BaseCommand {
+    static args = {
+        "uri": Args.string({ description: "uri of record" }),
+    };
+    static description = "Get the stats of a record.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> native-object:my-type/instance-1",
+        "<%= config.bin %> <%= command.id %> native-object:my-type --id instance-1",
+        "<%= config.bin %> <%= command.id %> --type my-type --id instance-1",
+    ];
+    static flags = {
+        id: Flags.string({
+            char: "I",
+            description: "id",
+        }),
+        type: Flags.string({
+            char: "T",
+            description: "type",
+        }),
+    };
+    async run() {
+        const { uri } = this.args;
+        const { id: flagId, type: flagType } = this.flags;
+        let type = flagType;
+        let lookup = flagId;
+        if (uri) {
+            const { id, type: uriType } = parseUri(uri);
+            type = uriType;
+            if (id) {
+                lookup = id;
+            }
+        }
+        if (!type) {
+            throw new Error("Type not provided");
+        }
+        if (!lookup) {
+            throw new Error("Id not provided");
+        }
+        const record = await this.fetch(({ silo, tenantId }) => getNativeObjectApiEndpoint(tenantId, silo) + `/api/v1/${type}/${lookup}`);
+        const totalBytes = Buffer.byteLength(JSON.stringify(record));
+        const { _metaData, ...data } = record;
+        const bytesWithoutMetaData = Buffer.byteLength(JSON.stringify(data));
+        const rv = { total: bytesToString(totalBytes), withoutMetaData: bytesToString(bytesWithoutMetaData) };
+        if (type === "flow") {
+            const nodes = data.node_red_data.flows;
+            const largestFiveNodes = nodes
+                .map(n => [n, Buffer.byteLength(JSON.stringify(n))])
+                .sort(([, sizeA], [, sizeB]) => sizeA - sizeB)
+                .slice(-5)
+                .map(([{ id, name }, size]) => ({ id, name, size: bytesToString(size) }));
+            this.logJson({ ...rv, largestFiveNodes });
+        }
+        else {
+            this.logJson(rv);
+        }
+    }
+}

package/dist/commands/types/delete.d.ts

@@ -1,5 +1,6 @@
 import { BaseCommand } from "../../base.js";
 export default class TypesDelete extends BaseCommand<typeof TypesDelete> {
+    static aliases: string[];
     static args: {
         uri: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
     };

package/dist/commands/types/delete.js

@@ -3,6 +3,7 @@ import { BaseCommand } from "../../base.js";
 import { parseUri } from "../../models/uri.js";
 import { getRegistryApiEndpoint } from "../../utils/endpoints.js";
 export default class TypesDelete extends BaseCommand {
+    static aliases = ["types rm", "types remove"];
     static args = {
         "uri": Args.string({ description: "uri of type" }),
     };

package/oclif.manifest.json

@@ -326,7 +326,10 @@
       ]
     },
     "records:delete": {
-      "aliases": [],
+      "aliases": [
+        "records:rm",
+        "records:remove"
+      ],
       "args": {
         "uri": {
           "description": "uri of record",
@@ -858,6 +861,63 @@
         "replace.js"
       ]
     },
+    "records:stats": {
+      "aliases": [],
+      "args": {
+        "uri": {
+          "description": "uri of record",
+          "name": "uri"
+        }
+      },
+      "description": "Get the stats of a record.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> native-object:my-type/instance-1",
+        "<%= config.bin %> <%= command.id %> native-object:my-type --id instance-1",
+        "<%= config.bin %> <%= command.id %> --type my-type --id instance-1"
+      ],
+      "flags": {
+        "config-id": {
+          "char": "C",
+          "helpGroup": "GLOBAL",
+          "name": "config-id",
+          "summary": "Specify config id to use for call.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "id": {
+          "char": "I",
+          "description": "id",
+          "name": "id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "type": {
+          "char": "T",
+          "description": "type",
+          "name": "type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "records:stats",
+      "pluginAlias": "@contextual-io/cli",
+      "pluginName": "@contextual-io/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "records",
+        "stats.js"
+      ]
+    },
     "types:add": {
       "aliases": [
         "types:create",
@@ -906,7 +966,10 @@
       ]
     },
     "types:delete": {
-      "aliases": [],
+      "aliases": [
+        "types:rm",
+        "types:remove"
+      ],
       "args": {
         "uri": {
           "description": "uri of type",
@@ -1196,5 +1259,5 @@
       ]
     }
   },
-  "version": "0.5.0"
+  "version": "0.6.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contextual-io/cli",
   "description": "Contextual CLI",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "author": "Nasser Oloumi",
   "bin": {
     "ctxl": "./bin/run.js"