@contextual-io/cli 0.3.1 → 0.5.0

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,9 +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();
-            await this.showHelp();
         }
         this.exit(exitCode);
     }

package/dist/commands/config/add.js

@@ -7,7 +7,7 @@ export default class ConfigAdd extends BaseConfigCommand {
     static args = {
         "config-id": Args.string({ description: "id of config", required: true }),
     };
-    static description = "add a new config";
+    static description = "Add a new config.";
     static examples = [
         "<%= config.bin %> <%= command.id %> some-config-id --tenant-id my-tenant",
     ];
@@ -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

@@ -1,7 +1,7 @@
 import { BaseConfigCommand } from "../../base.js";
 export default class ConfigCurrent extends BaseConfigCommand {
     static args = {};
-    static description = "get the current config";
+    static description = "Get the current config.";
     static enableJsonFlag = true;
     static examples = [
         "<%= config.bin %> <%= command.id %>",
@@ -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/delete.js

@@ -5,7 +5,7 @@ export default class ConfigDelete extends BaseConfigCommand {
     static args = {
         "config-id": Args.string({ description: "id of config", required: true }),
     };
-    static description = "delete a config";
+    static description = "Delete a config.";
     static examples = [
         "<%= config.bin %> <%= command.id %> some-config-id",
     ];

package/dist/commands/config/get.js

@@ -6,7 +6,7 @@ export default class ConfigGet extends BaseConfigCommand {
     static args = {
         "config-id": Args.string({ description: "id of config" }),
     };
-    static description = "get a specific config";
+    static description = "Get a specific config.";
     static enableJsonFlag = true;
     static examples = [
         "<%= config.bin %> <%= command.id %>",
@@ -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/index.js

@@ -1,7 +1,7 @@
 import { BaseConfigCommand } from "../../base.js";
 export default class Config extends BaseConfigCommand {
     static args = {};
-    static description = "manage configs";
+    static description = "Manage configs.";
     static examples = [];
     static flags = {};
     static usage = [

package/dist/commands/config/list.js

@@ -3,7 +3,7 @@ import chalk from "chalk";
 import { BaseConfigCommand } from "../../base.js";
 export default class ConfigList extends BaseConfigCommand {
     static args = {};
-    static description = "list all available configs";
+    static description = "List all available configs.";
     static enableJsonFlag = true;
     static examples = [
         "<%= config.bin %> <%= command.id %>",
@@ -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/config/login.js

@@ -2,7 +2,7 @@ import { BaseConfigCommand } from "../../base.js";
 import { codeExchange, getUserProfile } from "../../utils/auth.js";
 export default class ConfigLogin extends BaseConfigCommand {
     static args = {};
-    static description = "login using the current config";
+    static description = "Login using the current config.";
     static examples = [
         "<%= config.bin %> <%= command.id %>",
     ];

package/dist/commands/config/use.js

@@ -5,7 +5,7 @@ export default class ConfigUse extends BaseConfigCommand {
     static args = {
         "config-id": Args.string({ description: "id of config", required: true }),
     };
-    static description = "use a config";
+    static description = "Use a config.";
     static examples = [
         "<%= config.bin %> <%= command.id %> some-config-id",
     ];

package/dist/commands/records/add.js

@@ -11,7 +11,7 @@ export default class RecordsAdd extends BaseCommand {
     static args = {
         "uri": Args.string({ description: "uri of type" }),
     };
-    static description = "create record(s)";
+    static description = "Create record(s).";
     static examples = [
         "<%= config.bin %> <%= command.id %> native-object:my-type",
         "<%= config.bin %> <%= command.id %> --type my-type --input-file records.json",

package/dist/commands/records/delete.js

@@ -6,7 +6,7 @@ export default class RecordsDelete extends BaseCommand {
     static args = {
         "uri": Args.string({ description: "uri of record" }),
     };
-    static description = "delete record(s)";
+    static description = "Delete record(s).";
     static examples = [
         "<%= config.bin %> <%= command.id %> native-object:my-type/instance-1",
         "<%= config.bin %> <%= command.id %> native-object:my-type --id instance-1",
@@ -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

@@ -6,7 +6,7 @@ export default class RecordsGet extends BaseCommand {
     static args = {
         "uri": Args.string({ description: "uri of record" }),
     };
-    static description = "get a record";
+    static description = "Get 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",
@@ -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/index.js

@@ -1,7 +1,7 @@
 import { BaseConfigCommand } from "../../base.js";
 export default class Records extends BaseConfigCommand {
     static args = {};
-    static description = "manage records";
+    static description = "Manage records.";
     static examples = [];
     static flags = {};
     static usage = [

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,10 +9,11 @@ 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" }),
     };
-    static description = "list records";
+    static description = "List records.";
     static examples = [
         "<%= config.bin %> <%= command.id %> native-object:my-type",
         "<%= config.bin %> <%= command.id %> --type my-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/query.js

@@ -10,7 +10,7 @@ export default class RecordsQuery extends BaseCommand {
     static args = {
         "uri": Args.string({ description: "uri of type" }),
     };
-    static description = "query records";
+    static description = "Query records.";
     static examples = [
         "<%= config.bin %> <%= command.id %> native-object:my-type",
         "<%= config.bin %> <%= command.id %> --type my-type --query-file query.json",

package/dist/commands/records/replace.js

@@ -9,7 +9,7 @@ export default class RecordsReplace extends BaseCommand {
     static args = {
         "uri": Args.string({ description: "uri of record" }),
     };
-    static description = "replace a record";
+    static description = "Replace a record.";
     static examples = [
         "<%= config.bin %> <%= command.id %> native-object:my-type/instance-1 --input-file record.json",
         "<%= config.bin %> <%= command.id %> native-object:my-type --id instance-1 --input-file record.json",
@@ -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/add.d.ts

@@ -0,0 +1,11 @@
+import { BaseCommand } from "../../base.js";
+export default class TypesAdd extends BaseCommand<typeof TypesAdd> {
+    static aliases: string[];
+    static args: {};
+    static description: string;
+    static examples: string[];
+    static flags: {
+        "input-file": import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/types/add.js

@@ -0,0 +1,57 @@
+import { Flags } from "@oclif/core";
+import fs, { createReadStream } from "node:fs";
+import path from "node:path";
+import jsonl from "stream-json/jsonl/Parser.js";
+import { BaseCommand } from "../../base.js";
+import { getRegistryApiEndpoint } from "../../utils/endpoints.js";
+import { mapStream, readStreamToEnd } from "../../utils/stream.js";
+export default class TypesAdd extends BaseCommand {
+    static aliases = ["types create", "types import"];
+    static args = {};
+    static description = "Create type(s).";
+    static examples = [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --input-file types.json",
+    ];
+    static flags = {
+        "input-file": Flags.file({
+            char: "i",
+            default: "-",
+            description: "file to read. can read stdin if value is '-'",
+        }),
+    };
+    async run() {
+        const inputFile = this.flags["input-file"] === "-"
+            ? "-"
+            : path.resolve(this.flags["input-file"]);
+        if (inputFile && inputFile !== "-" && !fs.existsSync(inputFile)) {
+            throw new Error("File does not exist");
+        }
+        const stream = inputFile && inputFile !== "-"
+            ? createReadStream(inputFile)
+            : process.stdin;
+        const types = await readStreamToEnd(stream
+            .pipe(jsonl.parser())
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            .pipe(mapStream(async (x) => x.value))
+            .pipe(mapStream(async (x) => JSON.stringify(x))));
+        // eslint-disable-next-line unicorn/consistent-function-scoping
+        const create = (body) => this.fetch(({ silo, tenantId }) => getRegistryApiEndpoint(tenantId, silo) + "/api/v1/types", {
+            body,
+            headers: {
+                "content-type": "application/json",
+            },
+            method: "POST",
+        });
+        for (const type of types) {
+            // eslint-disable-next-line no-await-in-loop
+            const rv = await create(type);
+            if (types.length > 1) {
+                this.log(JSON.stringify(rv));
+            }
+            else {
+                this.logJson(rv);
+            }
+        }
+    }
+}

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

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

package/dist/commands/types/delete.js

@@ -0,0 +1,35 @@
+import { Args, Flags } from "@oclif/core";
+import { BaseCommand } from "../../base.js";
+import { parseUri } from "../../models/uri.js";
+import { getRegistryApiEndpoint } from "../../utils/endpoints.js";
+export default class TypesDelete extends BaseCommand {
+    static args = {
+        "uri": Args.string({ description: "uri of type" }),
+    };
+    static description = "Delete a type.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> native-object:my-type",
+        "<%= config.bin %> <%= command.id %> --type my-type",
+    ];
+    static flags = {
+        type: Flags.string({
+            char: "T",
+            description: "type",
+        }),
+    };
+    async run() {
+        const { uri } = this.args;
+        const { type: flagType } = this.flags;
+        let type = flagType;
+        if (uri) {
+            const { type: uriType } = parseUri(uri);
+            type = uriType;
+        }
+        if (!type) {
+            throw new Error("Type not provided");
+        }
+        await this.fetch(({ silo, tenantId }) => getRegistryApiEndpoint(tenantId, silo) + `/api/v1/types/${type}`, {
+            method: "DELETE",
+        });
+    }
+}

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

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

package/dist/commands/types/get.js

@@ -0,0 +1,33 @@
+import { Args, Flags } from "@oclif/core";
+import { BaseCommand } from "../../base.js";
+import { parseUri } from "../../models/uri.js";
+import { getRegistryApiEndpoint } from "../../utils/endpoints.js";
+export default class TypesGet extends BaseCommand {
+    static args = {
+        "uri": Args.string({ description: "uri of type" }),
+    };
+    static description = "Get a type.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> native-object:my-type",
+        "<%= config.bin %> <%= command.id %> --type my-type",
+    ];
+    static flags = {
+        type: Flags.string({
+            char: "T",
+            description: "type",
+        }),
+    };
+    async run() {
+        const { uri } = this.args;
+        const { type: flagType } = this.flags;
+        let type = flagType;
+        if (uri) {
+            const { type: uriType } = parseUri(uri);
+            type = uriType;
+        }
+        if (!type) {
+            throw new Error("Type not provided");
+        }
+        this.logJson(await this.fetch(({ silo, tenantId }) => getRegistryApiEndpoint(tenantId, silo) + `/api/v1/types/${type}`));
+    }
+}

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

@@ -0,0 +1,9 @@
+import { BaseConfigCommand } from "../../base.js";
+export default class Types extends BaseConfigCommand<typeof Types> {
+    static args: {};
+    static description: string;
+    static examples: never[];
+    static flags: {};
+    static usage: string[];
+    run(): Promise<void>;
+}

package/dist/commands/types/index.js

@@ -0,0 +1,13 @@
+import { BaseConfigCommand } from "../../base.js";
+export default class Types extends BaseConfigCommand {
+    static args = {};
+    static description = "Manage types.";
+    static examples = [];
+    static flags = {};
+    static usage = [
+        "<%= command.id %> <COMMAND>",
+    ];
+    async run() {
+        await this.showHelp();
+    }
+}

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

@@ -0,0 +1,20 @@
+import { BaseCommand } from "../../base.js";
+export default class TypesList extends BaseCommand<typeof TypesList> {
+    static aliases: string[];
+    static args: {};
+    static description: string;
+    static examples: string[];
+    static flags: {
+        "exact-search": import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        export: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        from: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "include-total": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "order-by": import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "page-size": import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "page-token": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        progress: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        search: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        to: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}