@contextual-io/cli 0.4.0 → 0.5.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @contextual-io/cli
 $ ctxl COMMAND
 running command...
 $ ctxl (--version)
-@contextual-io/cli/0.4.0 linux-x64 node-v25.2.1
+@contextual-io/cli/0.5.0 linux-x64 node-v25.2.1
 $ ctxl --help [COMMAND]
 USAGE
   $ ctxl COMMAND
@@ -46,8 +46,10 @@ USAGE
 * [`ctxl records get [URI]`](#ctxl-records-get-uri)
 * [`ctxl records import [URI]`](#ctxl-records-import-uri)
 * [`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 replace [URI]`](#ctxl-records-replace-uri)
+* [`ctxl records search [URI]`](#ctxl-records-search-uri)
 * [`ctxl types <COMMAND>`](#ctxl-types-command)
 * [`ctxl types add`](#ctxl-types-add)
 * [`ctxl types create`](#ctxl-types-create)
@@ -56,6 +58,7 @@ USAGE
 * [`ctxl types import`](#ctxl-types-import)
 * [`ctxl types list`](#ctxl-types-list)
 * [`ctxl types replace [URI]`](#ctxl-types-replace-uri)
+* [`ctxl types search`](#ctxl-types-search)
 
 ## `ctxl autocomplete [SHELL]`
 
@@ -106,14 +109,12 @@ Add a new config.
 
 ```
 USAGE
-  $ ctxl config add CONFIG-ID [-s prod|qa|dev] [-t <value>]
+  $ ctxl config add CONFIG-ID [-t <value>]
 
 ARGUMENTS
   CONFIG-ID  id of config
 
 FLAGS
-  -s, --silo=<option>      [default: prod] silo
-                           <options: prod|qa|dev>
   -t, --tenant-id=<value>  tenant id (if different from config id)
 
 DESCRIPTION
@@ -333,14 +334,14 @@ Delete record(s).
 
 ```
 USAGE
-  $ ctxl records delete [URI] [-C <value>] [-i <value>...] [-T <value>]
+  $ ctxl records delete [URI] [-C <value>] [-I <value>...] [-T <value>]
 
 ARGUMENTS
   [URI]  uri of record
 
 FLAGS
+  -I, --id=<value>...  id(s)
   -T, --type=<value>   type
-  -i, --id=<value>...  id(s)
 
 GLOBAL FLAGS
   -C, --config-id=<value>  Specify config id to use for call.
@@ -366,14 +367,14 @@ Get a record.
 
 ```
 USAGE
-  $ ctxl records get [URI] [-C <value>] [-i <value>...] [-T <value>]
+  $ ctxl records get [URI] [-C <value>] [-I <value>...] [-T <value>]
 
 ARGUMENTS
   [URI]  uri of record
 
 FLAGS
+  -I, --id=<value>...  id(s)
   -T, --type=<value>   type
-  -i, --id=<value>...  id(s)
 
 GLOBAL FLAGS
   -C, --config-id=<value>  Specify config id to use for call.
@@ -455,6 +456,9 @@ GLOBAL FLAGS
 DESCRIPTION
   List records.
 
+ALIASES
+  $ ctxl records search
+
 EXAMPLES
   $ ctxl records list native-object:my-type
 
@@ -465,6 +469,41 @@ EXAMPLES
   $ ctxl records list --type my-type -s field1=value1 -s field2=value2 --include-total
 ```
 
+## `ctxl records patch [URI]`
+
+Patch a record.
+
+```
+USAGE
+  $ ctxl records patch [URI] [-C <value>] [-a <value>...] [-I <value>] [-i <value>...] [-d <value>...] [-r
+    <value>...] [-s <value>...] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of record
+
+FLAGS
+  -I, --id=<value>            id
+  -T, --type=<value>          type
+  -a, --add=<value>...        add field
+  -d, --remove=<value>...     remove field
+  -i, --increment=<value>...  increment field
+  -r, --replace=<value>...    replace field
+  -s, --set=<value>...        set field
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Patch a record.
+
+EXAMPLES
+  $ ctxl records patch native-object:my-type/instance-1 --set field1=value1
+
+  $ ctxl records patch native-object:my-type --id instance-1 --remove field2
+
+  $ ctxl records patch --type my-type --id instance-1 --increment field3=2
+```
+
 ## `ctxl records query [URI]`
 
 Query records.
@@ -509,14 +548,14 @@ Replace a record.
 
 ```
 USAGE
-  $ ctxl records replace [URI] [-C <value>] [-i <value>] [-i <value>] [-T <value>]
+  $ ctxl records replace [URI] [-C <value>] [-I <value>] [-i <value>] [-T <value>]
 
 ARGUMENTS
   [URI]  uri of record
 
 FLAGS
+  -I, --id=<value>          id
   -T, --type=<value>        type
-  -i, --id=<value>          id
   -i, --input-file=<value>  [default: -] file to read. can read stdin if value is '-'
 
 GLOBAL FLAGS
@@ -533,6 +572,50 @@ EXAMPLES
   $ ctxl records replace --type my-type --id instance-1 --input-file record.json
 ```
 
+## `ctxl records search [URI]`
+
+List records.
+
+```
+USAGE
+  $ ctxl records search [URI] [-C <value>] [-S <value>...] [-e] [-f <value>...] [--include-total] [-o <value>...]
+    [--page-size <value>] [--page-token <value>] [-p] [-s <value>...] [-t <value>...] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of type
+
+FLAGS
+  -S, --exact-search=<value>...  search fields exactly
+  -T, --type=<value>             type
+  -e, --export                   export data as JSONL
+  -f, --from=<value>...          search from
+  -o, --order-by=<value>...      order fields
+  -p, --progress                 show progress during export
+  -s, --search=<value>...        search fields
+  -t, --to=<value>...            search to
+      --include-total            include total count
+      --page-size=<value>        number of records per page
+      --page-token=<value>       page token to fetch
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  List records.
+
+ALIASES
+  $ ctxl records search
+
+EXAMPLES
+  $ ctxl records search native-object:my-type
+
+  $ ctxl records search --type my-type
+
+  $ ctxl records search --type my-type --order-by field1:desc
+
+  $ ctxl records search --type my-type -s field1=value1 -s field2=value2 --include-total
+```
+
 ## `ctxl types <COMMAND>`
 
 Manage types.
@@ -705,6 +788,9 @@ GLOBAL FLAGS
 DESCRIPTION
   List types.
 
+ALIASES
+  $ ctxl types search
+
 EXAMPLES
   $ ctxl types list
 
@@ -739,4 +825,42 @@ EXAMPLES
 
   $ ctxl types replace --type my-type  --input-file record.json
 ```
+
+## `ctxl types search`
+
+List types.
+
+```
+USAGE
+  $ ctxl types search [-C <value>] [-S <value>...] [-e] [-f <value>...] [--include-total] [-o <value>...]
+    [--page-size <value>] [--page-token <value>] [-p] [-s <value>...] [-t <value>...]
+
+FLAGS
+  -S, --exact-search=<value>...  search fields exactly
+  -e, --export                   export data as JSONL
+  -f, --from=<value>...          search from
+  -o, --order-by=<value>...      order fields
+  -p, --progress                 show progress during export
+  -s, --search=<value>...        search fields
+  -t, --to=<value>...            search to
+      --include-total            include total count
+      --page-size=<value>        number of types per page
+      --page-token=<value>       page token to fetch
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  List types.
+
+ALIASES
+  $ ctxl types search
+
+EXAMPLES
+  $ ctxl types search
+
+  $ ctxl types search --order-by field1:desc
+
+  $ ctxl types search -s field1=value1 -s field2=value2 --include-total
+```
 <!-- commandsstop -->

package/dist/base.d.ts

@@ -7,7 +7,11 @@ export type Args<T extends typeof Command> = Interfaces.InferredArgs<T["args"]>;
 declare class CommandConfig {
     private readonly configDir;
     constructor(configDir: string);
-    clean(configId: UrlSafeId, { silo, tenantId }: Config): CleanConfig;
+    cleanJson(configId: UrlSafeId, { silo, tenantId }: Config): CleanConfig;
+    cleanTable(configId: UrlSafeId, config: Config): {
+        tenantId: string;
+        configId: string;
+    };
     get(configId?: UrlSafeId): Promise<{
         config: Config;
         lookup: string;

package/dist/base.js

@@ -13,12 +13,25 @@ class CommandConfig {
     constructor(configDir) {
         this.configDir = configDir;
     }
-    clean(configId, { silo, tenantId }) {
-        return {
+    cleanJson(configId, { silo, tenantId }) {
+        const rv = {
             configId,
-            silo,
             tenantId,
         };
+        if (silo === "prod") {
+            return rv;
+        }
+        return {
+            ...rv,
+            silo,
+        };
+    }
+    cleanTable(configId, config) {
+        const { silo, ...rv } = this.cleanJson(configId, config);
+        if (silo) {
+            rv.tenantId = `[${silo}] ${rv.tenantId}`;
+        }
+        return rv;
     }
     async get(configId) {
         const userConfig = this.read();
@@ -112,11 +125,11 @@ export class BaseConfigCommand extends Command {
                 const flattened = z.flattenError(err);
                 message = flattened.formErrors.join("\n");
             }
+            if (!/See more help with/.test(message)) {
+                message += "\nSee more help with --help";
+            }
             this.logToStderr(chalkStderr.red(chalkStderr.bold("    Error: ") + message));
             this.logToStderr();
-            if (!(err instanceof HttpError)) {
-                await this.showHelp();
-            }
         }
         this.exit(exitCode);
     }

package/dist/commands/config/add.js

@@ -16,6 +16,7 @@ export default class ConfigAdd extends BaseConfigCommand {
             char: "s",
             default: "prod",
             description: "silo",
+            hidden: true,
             options: [...Silo.options.values()],
         }),
         "tenant-id": Flags.string({ char: "t", description: "tenant id (if different from config id)" }),

package/dist/commands/config/current.js

@@ -10,6 +10,6 @@ export default class ConfigCurrent extends BaseConfigCommand {
     async run() {
         const { config, lookup } = await this.userConfig.get();
         this.log(lookup);
-        return this.userConfig.clean(lookup, config);
+        return this.userConfig.cleanJson(lookup, config);
     }
 }

package/dist/commands/config/get.js

@@ -16,10 +16,9 @@ export default class ConfigGet extends BaseConfigCommand {
     async run() {
         const configId = UrlSafeId.optional().parse(this.args["config-id"]);
         const { config, lookup } = await this.userConfig.get(configId);
-        const rv = this.userConfig.clean(lookup, config);
         this.log(makeTable({
-            data: [rv],
+            data: [this.userConfig.cleanTable(lookup, config)],
         }));
-        return rv;
+        return this.userConfig.cleanJson(lookup, config);
     }
 }

package/dist/commands/config/list.js

@@ -16,17 +16,17 @@ export default class ConfigList extends BaseConfigCommand {
                 return config;
             return {
                 configId: chalk.bold(chalk.yellow(config.configId)),
-                silo: chalk.bold(chalk.yellow(config.silo)),
                 tenantId: chalk.bold(chalk.yellow(config.tenantId)),
             };
         };
-        const configs = Object.entries(userConfig.configs)
-            .map(([configId, config]) => this.userConfig.clean(configId, config));
         this.log(makeTable({
-            data: configs.map(c => colorize(c)),
+            data: Object.entries(userConfig.configs)
+                .map(([configId, config]) => this.userConfig.cleanTable(configId, config))
+                .map(c => colorize(c)),
         }));
         return {
-            configs,
+            configs: Object.entries(userConfig.configs)
+                .map(([configId, config]) => this.userConfig.cleanJson(configId, config)),
             current: userConfig.current,
         };
     }

package/dist/commands/records/delete.js

@@ -16,7 +16,7 @@ export default class RecordsDelete extends BaseCommand {
     ];
     static flags = {
         id: Flags.string({
-            char: "i",
+            char: "I",
             description: "id(s)",
             multiple: true,
         }),

package/dist/commands/records/get.js

@@ -16,7 +16,7 @@ export default class RecordsGet extends BaseCommand {
     ];
     static flags = {
         id: Flags.string({
-            char: "i",
+            char: "I",
             description: "id(s)",
             multiple: true,
         }),

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

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

package/dist/commands/records/list.js

@@ -9,6 +9,7 @@ const flagArrayToParam = (cmd, values) => values
     .map(([k, v]) => ({ [`${cmd}.${k}`]: v }))
     .reduce((a, b) => ({ ...a, ...b }), {});
 export default class RecordsList extends BaseCommand {
+    static aliases = ["records search"];
     static args = {
         "uri": Args.string({ description: "uri of type" }),
     };

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

@@ -0,0 +1,25 @@
+import { BaseCommand } from "../../base.js";
+type Patch = {
+    path: string;
+};
+type PatchWithValue = Patch & {
+    value: unknown;
+};
+export default class RecordsPatch extends BaseCommand<typeof RecordsPatch> {
+    static args: {
+        uri: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        add: import("@oclif/core/interfaces").OptionFlag<PatchWithValue[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        id: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        increment: import("@oclif/core/interfaces").OptionFlag<PatchWithValue[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        remove: import("@oclif/core/interfaces").OptionFlag<Patch[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        replace: import("@oclif/core/interfaces").OptionFlag<PatchWithValue[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        set: import("@oclif/core/interfaces").OptionFlag<PatchWithValue[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        type: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}
+export {};

package/dist/commands/records/patch.js

@@ -0,0 +1,106 @@
+import { Args, Flags } from "@oclif/core";
+import { BaseCommand } from "../../base.js";
+import { parseUri } from "../../models/uri.js";
+import { getNativeObjectApiEndpoint } from "../../utils/endpoints.js";
+const toPath = (input) => "/" + input.replaceAll(".", "/");
+const patchFlag = Flags.custom({
+    async parse(input) {
+        return {
+            path: toPath(input),
+        };
+    },
+});
+const patchWithValueFlag = Flags.custom({
+    async parse(input) {
+        if (!/=/.test(input)) {
+            throw new Error("No value provided for patch");
+        }
+        const [key, value] = input.split("=");
+        return {
+            path: toPath(key),
+            value,
+        };
+    },
+});
+export default class RecordsPatch extends BaseCommand {
+    static args = {
+        "uri": Args.string({ description: "uri of record" }),
+    };
+    static description = "Patch a record.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> native-object:my-type/instance-1 --set field1=value1",
+        "<%= config.bin %> <%= command.id %> native-object:my-type --id instance-1 --remove field2",
+        "<%= config.bin %> <%= command.id %> --type my-type --id instance-1 --increment field3=2",
+    ];
+    static flags = {
+        add: patchWithValueFlag({
+            char: "a",
+            description: "add field",
+            multiple: true,
+        }),
+        id: Flags.string({
+            char: "I",
+            description: "id",
+        }),
+        increment: patchWithValueFlag({
+            char: "i",
+            description: "increment field",
+            multiple: true,
+        }),
+        remove: patchFlag({
+            char: "d",
+            description: "remove field",
+            multiple: true,
+        }),
+        replace: patchWithValueFlag({
+            char: "r",
+            description: "replace field",
+            multiple: true,
+        }),
+        set: patchWithValueFlag({
+            char: "s",
+            description: "set field",
+            multiple: true,
+        }),
+        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 patches = [
+            ...(this.flags.add ?? []).map(x => ({ op: "add", ...x })),
+            ...(this.flags.set ?? []).map(x => ({ op: "set", ...x })),
+            ...(this.flags.replace ?? []).map(x => ({ op: "replace", ...x })),
+            ...(this.flags.remove ?? []).map(x => ({ op: "remove", ...x })),
+            ...(this.flags.increment ?? []).map(({ value, ...x }) => ({ op: "increment", ...x, value: Number(`${value}`) })),
+        ];
+        if (patches.length === 0) {
+            throw new Error("No patches provided");
+        }
+        this.logJson(await this.fetch(({ silo, tenantId }) => getNativeObjectApiEndpoint(tenantId, silo) + `/api/v1/${type}/${lookup}`, {
+            body: JSON.stringify(patches),
+            headers: {
+                "content-type": "application/json",
+            },
+            method: "PATCH",
+        }));
+    }
+}

package/dist/commands/records/replace.js

@@ -17,7 +17,7 @@ export default class RecordsReplace extends BaseCommand {
     ];
     static flags = {
         id: Flags.string({
-            char: "i",
+            char: "I",
             description: "id",
         }),
         "input-file": Flags.file({

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

@@ -1,5 +1,6 @@
 import { BaseCommand } from "../../base.js";
 export default class TypesList extends BaseCommand<typeof TypesList> {
+    static aliases: string[];
     static args: {};
     static description: string;
     static examples: string[];

package/dist/commands/types/list.js

@@ -8,6 +8,7 @@ const flagArrayToParam = (cmd, values) => values
     .map(([k, v]) => ({ [`${cmd}.${k}`]: v }))
     .reduce((a, b) => ({ ...a, ...b }), {});
 export default class TypesList extends BaseCommand {
+    static aliases = ["types search"];
     static args = {};
     static description = "List types.";
     static examples = [

package/dist/models/user-config.d.ts

@@ -23,11 +23,11 @@ export declare const Config: z.ZodObject<{
 }, z.core.$strip>;
 export type Config = z.infer<typeof Config>;
 export declare const CleanConfig: z.ZodObject<{
-    silo: z.ZodEnum<{
+    silo: z.ZodOptional<z.ZodEnum<{
         prod: "prod";
         qa: "qa";
         dev: "dev";
-    }>;
+    }>>;
     tenantId: z.ZodString;
     configId: z.ZodString;
 }, z.core.$strip>;

package/dist/models/user-config.js

@@ -15,6 +15,8 @@ export const Config = z.object({
 export const CleanConfig = Config.pick({
     silo: true,
     tenantId: true,
+}).partial({
+    silo: true,
 }).extend({
     configId: z.string(),
 });

package/oclif.manifest.json

@@ -17,6 +17,7 @@
         "silo": {
           "char": "s",
           "description": "silo",
+          "hidden": true,
           "name": "silo",
           "default": "prod",
           "hasDynamicHelp": false,
@@ -351,7 +352,7 @@
           "type": "option"
         },
         "id": {
-          "char": "i",
+          "char": "I",
           "description": "id(s)",
           "name": "id",
           "hasDynamicHelp": false,
@@ -410,7 +411,7 @@
           "type": "option"
         },
         "id": {
-          "char": "i",
+          "char": "I",
           "description": "id(s)",
           "name": "id",
           "hasDynamicHelp": false,
@@ -468,7 +469,9 @@
       ]
     },
     "records:list": {
-      "aliases": [],
+      "aliases": [
+        "records:search"
+      ],
       "args": {
         "uri": {
           "description": "uri of type",
@@ -591,6 +594,103 @@
         "list.js"
       ]
     },
+    "records:patch": {
+      "aliases": [],
+      "args": {
+        "uri": {
+          "description": "uri of record",
+          "name": "uri"
+        }
+      },
+      "description": "Patch a record.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> native-object:my-type/instance-1 --set field1=value1",
+        "<%= config.bin %> <%= command.id %> native-object:my-type --id instance-1 --remove field2",
+        "<%= config.bin %> <%= command.id %> --type my-type --id instance-1 --increment field3=2"
+      ],
+      "flags": {
+        "config-id": {
+          "char": "C",
+          "helpGroup": "GLOBAL",
+          "name": "config-id",
+          "summary": "Specify config id to use for call.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "add": {
+          "char": "a",
+          "description": "add field",
+          "name": "add",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "id": {
+          "char": "I",
+          "description": "id",
+          "name": "id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "increment": {
+          "char": "i",
+          "description": "increment field",
+          "name": "increment",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "remove": {
+          "char": "d",
+          "description": "remove field",
+          "name": "remove",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "replace": {
+          "char": "r",
+          "description": "replace field",
+          "name": "replace",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "set": {
+          "char": "s",
+          "description": "set field",
+          "name": "set",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "type": {
+          "char": "T",
+          "description": "type",
+          "name": "type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "records:patch",
+      "pluginAlias": "@contextual-io/cli",
+      "pluginName": "@contextual-io/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "records",
+        "patch.js"
+      ]
+    },
     "records:query": {
       "aliases": [],
       "args": {
@@ -717,7 +817,7 @@
           "type": "option"
         },
         "id": {
-          "char": "i",
+          "char": "I",
           "description": "id",
           "name": "id",
           "hasDynamicHelp": false,
@@ -927,7 +1027,9 @@
       ]
     },
     "types:list": {
-      "aliases": [],
+      "aliases": [
+        "types:search"
+      ],
       "args": {},
       "description": "List types.",
       "examples": [
@@ -1094,5 +1196,5 @@
       ]
     }
   },
-  "version": "0.4.0"
+  "version": "0.5.0"
 }

package/package.json

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