@contextual-io/cli 0.1.1 → 0.1.2

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @contextual-io/cli
 $ ctxl COMMAND
 running command...
 $ ctxl (--version)
-@contextual-io/cli/0.1.1 linux-x64 node-v25.2.1
+@contextual-io/cli/0.1.2 linux-x64 node-v25.2.1
 $ ctxl --help [COMMAND]
 USAGE
   $ ctxl COMMAND
@@ -29,7 +29,17 @@ USAGE
 <!-- usagestop -->
 # Commands
 <!-- commands -->
+* [`ctxl base`](#ctxl-base)
+* [`ctxl config add CONFIG-ID`](#ctxl-config-add-config-id)
+* [`ctxl config current`](#ctxl-config-current)
+* [`ctxl config delete CONFIG-ID`](#ctxl-config-delete-config-id)
+* [`ctxl config get [CONFIG-ID]`](#ctxl-config-get-config-id)
+* [`ctxl config list`](#ctxl-config-list)
+* [`ctxl config login`](#ctxl-config-login)
+* [`ctxl config use CONFIG-ID`](#ctxl-config-use-config-id)
+* [`ctxl create [URI]`](#ctxl-create-uri)
 * [`ctxl help [COMMAND]`](#ctxl-help-command)
+* [`ctxl import [URI]`](#ctxl-import-uri)
 * [`ctxl plugins`](#ctxl-plugins)
 * [`ctxl plugins add PLUGIN`](#ctxl-plugins-add-plugin)
 * [`ctxl plugins:inspect PLUGIN...`](#ctxl-pluginsinspect-plugin)
@@ -40,6 +50,202 @@ USAGE
 * [`ctxl plugins uninstall [PLUGIN]`](#ctxl-plugins-uninstall-plugin)
 * [`ctxl plugins unlink [PLUGIN]`](#ctxl-plugins-unlink-plugin)
 * [`ctxl plugins update`](#ctxl-plugins-update)
+* [`ctxl records add [URI]`](#ctxl-records-add-uri)
+* [`ctxl records delete [URI]`](#ctxl-records-delete-uri)
+* [`ctxl records get [URI]`](#ctxl-records-get-uri)
+* [`ctxl records list [URI]`](#ctxl-records-list-uri)
+* [`ctxl records query [URI]`](#ctxl-records-query-uri)
+* [`ctxl records replace [URI]`](#ctxl-records-replace-uri)
+
+## `ctxl base`
+
+```
+USAGE
+  $ ctxl base [-C <value>]
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+```
+
+_See code: [src/commands/base.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/base.ts)_
+
+## `ctxl config add CONFIG-ID`
+
+add a new config
+
+```
+USAGE
+  $ ctxl config add CONFIG-ID [-s prod|qa|dev] [-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
+  add a new config
+
+EXAMPLES
+  $ ctxl config add some-config-id --tenant-id my-tenant
+```
+
+_See code: [src/commands/config/add.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/config/add.ts)_
+
+## `ctxl config current`
+
+get the current config
+
+```
+USAGE
+  $ ctxl config current [--json]
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  get the current config
+
+EXAMPLES
+  $ ctxl config current
+```
+
+_See code: [src/commands/config/current.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/config/current.ts)_
+
+## `ctxl config delete CONFIG-ID`
+
+delete a config
+
+```
+USAGE
+  $ ctxl config delete CONFIG-ID
+
+ARGUMENTS
+  CONFIG-ID  id of config
+
+DESCRIPTION
+  delete a config
+
+EXAMPLES
+  $ ctxl config delete some-config-id
+```
+
+_See code: [src/commands/config/delete.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/config/delete.ts)_
+
+## `ctxl config get [CONFIG-ID]`
+
+get a specific config
+
+```
+USAGE
+  $ ctxl config get [CONFIG-ID] [--json]
+
+ARGUMENTS
+  [CONFIG-ID]  id of config
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  get a specific config
+
+EXAMPLES
+  $ ctxl config get
+
+  $ ctxl config get some-config-id
+```
+
+_See code: [src/commands/config/get.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/config/get.ts)_
+
+## `ctxl config list`
+
+list all available configs
+
+```
+USAGE
+  $ ctxl config list [--json]
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  list all available configs
+
+EXAMPLES
+  $ ctxl config list
+```
+
+_See code: [src/commands/config/list.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/config/list.ts)_
+
+## `ctxl config login`
+
+login using the current config
+
+```
+USAGE
+  $ ctxl config login
+
+DESCRIPTION
+  login using the current config
+
+EXAMPLES
+  $ ctxl config login
+```
+
+_See code: [src/commands/config/login.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/config/login.ts)_
+
+## `ctxl config use CONFIG-ID`
+
+use a config
+
+```
+USAGE
+  $ ctxl config use CONFIG-ID
+
+ARGUMENTS
+  CONFIG-ID  id of config
+
+DESCRIPTION
+  use a config
+
+EXAMPLES
+  $ ctxl config use some-config-id
+```
+
+_See code: [src/commands/config/use.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/config/use.ts)_
+
+## `ctxl create [URI]`
+
+create record(s)
+
+```
+USAGE
+  $ ctxl create [URI] [-C <value>] [-i <value>] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of type
+
+FLAGS
+  -T, --type=<value>        type
+  -i, --input-file=<value>  [default: -] file to read. can read stdin if value is '-'
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  create record(s)
+
+ALIASES
+  $ ctxl create
+  $ ctxl import
+
+EXAMPLES
+  $ ctxl create native-object:my-type
+
+  $ ctxl create --type my-type --input-file records.json
+```
 
 ## `ctxl help [COMMAND]`
 
@@ -61,6 +267,37 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
 
+## `ctxl import [URI]`
+
+create record(s)
+
+```
+USAGE
+  $ ctxl import [URI] [-C <value>] [-i <value>] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of type
+
+FLAGS
+  -T, --type=<value>        type
+  -i, --input-file=<value>  [default: -] file to read. can read stdin if value is '-'
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  create record(s)
+
+ALIASES
+  $ ctxl create
+  $ ctxl import
+
+EXAMPLES
+  $ ctxl import native-object:my-type
+
+  $ ctxl import --type my-type --input-file records.json
+```
+
 ## `ctxl plugins`
 
 List installed plugins.
@@ -350,4 +587,222 @@ DESCRIPTION
 ```
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/update.ts)_
+
+## `ctxl records add [URI]`
+
+create record(s)
+
+```
+USAGE
+  $ ctxl records add [URI] [-C <value>] [-i <value>] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of type
+
+FLAGS
+  -T, --type=<value>        type
+  -i, --input-file=<value>  [default: -] file to read. can read stdin if value is '-'
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  create record(s)
+
+ALIASES
+  $ ctxl create
+  $ ctxl import
+
+EXAMPLES
+  $ ctxl records add native-object:my-type
+
+  $ ctxl records add --type my-type --input-file records.json
+```
+
+_See code: [src/commands/records/add.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/records/add.ts)_
+
+## `ctxl records delete [URI]`
+
+delete record(s)
+
+```
+USAGE
+  $ ctxl records delete [URI] [-C <value>] [-i <value>...] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of record
+
+FLAGS
+  -T, --type=<value>   type
+  -i, --id=<value>...  id(s)
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  delete record(s)
+
+EXAMPLES
+  $ ctxl records delete native-object:my-type/instance-1
+
+  $ ctxl records delete native-object:my-type --id instance-1
+
+  $ ctxl records delete native-object:my-type --id instance-1 --id instance-2
+
+  $ ctxl records delete --type my-type --id instance-1
+
+  $ ctxl records delete --type my-type --id instance-1 --id instance-2
+```
+
+_See code: [src/commands/records/delete.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/records/delete.ts)_
+
+## `ctxl records get [URI]`
+
+get a record
+
+```
+USAGE
+  $ ctxl records get [URI] [-C <value>] [-i <value>...] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of record
+
+FLAGS
+  -T, --type=<value>   type
+  -i, --id=<value>...  id(s)
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  get a record
+
+EXAMPLES
+  $ ctxl records get native-object:my-type/instance-1
+
+  $ ctxl records get native-object:my-type --id instance-1
+
+  $ ctxl records get native-object:my-type --id instance-1 --id instance-2
+
+  $ ctxl records get --type my-type --id instance-1
+
+  $ ctxl records get --type my-type --id instance-1 --id instance-2
+```
+
+_See code: [src/commands/records/get.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/records/get.ts)_
+
+## `ctxl records list [URI]`
+
+list records
+
+```
+USAGE
+  $ ctxl records list [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
+
+EXAMPLES
+  $ ctxl records list native-object:my-type
+
+  $ ctxl records list --type my-type
+
+  $ ctxl records list --type my-type --order-by field1:desc
+
+  $ ctxl records list --type my-type -s field1=value1 -s field2=value2 --include-total
+```
+
+_See code: [src/commands/records/list.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/records/list.ts)_
+
+## `ctxl records query [URI]`
+
+query records
+
+```
+USAGE
+  $ ctxl records query [URI] [-C <value>] [-e] [--include-total] [-o <value>...] [--page-size <value>]
+    [--page-token <value>] [-p] [-q <value>] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of type
+
+FLAGS
+  -T, --type=<value>         type
+  -e, --export               export data as JSONL
+  -o, --order-by=<value>...  order fields
+  -p, --progress             show progress during export
+  -q, --query-file=<value>   [default: -] file to read. can read stdin if value is '-'
+      --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
+  query records
+
+EXAMPLES
+  $ ctxl records query native-object:my-type
+
+  $ ctxl records query --type my-type --query-file query.json
+
+  $ ctxl records query --type my-type --order-by field1:desc --query-file query.json
+
+  $ ctxl records query --type my-type --include-total --query-file query.json
+```
+
+_See code: [src/commands/records/query.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/records/query.ts)_
+
+## `ctxl records replace [URI]`
+
+replace a record
+
+```
+USAGE
+  $ ctxl records replace [URI] [-C <value>] [-i <value>] [-i <value>] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of record
+
+FLAGS
+  -T, --type=<value>        type
+  -i, --id=<value>          id
+  -i, --input-file=<value>  [default: -] file to read. can read stdin if value is '-'
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  replace a record
+
+EXAMPLES
+  $ ctxl records replace native-object:my-type/instance-1 --input-file record.json
+
+  $ ctxl records replace native-object:my-type --id instance-1 --input-file record.json
+
+  $ ctxl records replace --type my-type --id instance-1 --input-file record.json
+```
+
+_See code: [src/commands/records/replace.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.1.2/src/commands/records/replace.ts)_
 <!-- commandsstop -->

package/dist/commands/base.d.ts

@@ -0,0 +1,41 @@
+import { Command, Interfaces } from "@oclif/core";
+import fetch from "cross-fetch";
+import { UrlSafeId } from "../models/url-safe-id.js";
+import { CleanConfig, Config, UserConfig } from "../models/user-config.js";
+export type Flags<T extends typeof Command> = Interfaces.InferredFlags<T["flags"] & typeof BaseConfigCommand["baseFlags"]>;
+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;
+    get(configId?: UrlSafeId): Promise<{
+        config: Config;
+        lookup: string;
+    }>;
+    read(): UserConfig;
+    remove(configId: UrlSafeId): void;
+    upsert(configId: UrlSafeId, config: Config): Config;
+    use(configId: UrlSafeId): Promise<Config>;
+    private writeUserConfig;
+}
+export declare abstract class BaseConfigCommand<T extends typeof Command> extends Command {
+    static baseFlags: {};
+    protected args: Args<T>;
+    protected flags: Flags<T>;
+    protected userConfig: CommandConfig;
+    protected catch(err: Error & {
+        exitCode?: number;
+    }): Promise<unknown>;
+    protected finally(_: Error | undefined): Promise<unknown>;
+    init(): Promise<void>;
+}
+export declare abstract class BaseCommand<T extends typeof Command> extends BaseConfigCommand<T> {
+    static baseFlags: {
+        "config-id": Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+    };
+    protected currentConfig(): Promise<Config & {
+        bearerToken: string;
+    }>;
+    protected fetch(getUrl: (config: Config) => string, init?: Parameters<typeof fetch>[1]): Promise<any>;
+}
+export {};

package/dist/commands/base.js

@@ -0,0 +1,164 @@
+import { Command, Flags } from "@oclif/core";
+import fetch from "cross-fetch";
+import fs from "node:fs";
+import path from "node:path";
+import { HttpError } from "../models/errors.js";
+import { UserConfig } from "../models/user-config.js";
+import { rehydrateToken } from "../utils/auth.js";
+class CommandConfig {
+    configDir;
+    constructor(configDir) {
+        this.configDir = configDir;
+    }
+    clean(configId, { silo, tenantId }) {
+        return {
+            configId,
+            silo,
+            tenantId,
+        };
+    }
+    async get(configId) {
+        const userConfig = this.read();
+        const lookup = configId ?? userConfig.current;
+        let config = lookup ? userConfig.configs[lookup] : undefined;
+        if (!lookup) {
+            throw new Error("No config id found");
+        }
+        if (!config) {
+            throw new Error(`No config with id '${lookup}' found`);
+        }
+        if (config.refreshToken && config.expiresAt) {
+            const expired = new Date();
+            expired.setUTCMinutes(expired.getUTCMinutes() + 5);
+            if (config.expiresAt <= expired.toISOString()) {
+                const auth = await rehydrateToken(config.auth, config.refreshToken);
+                config = this.upsert(lookup, {
+                    ...config,
+                    ...auth,
+                    refreshToken: auth.refreshToken ?? config.refreshToken,
+                });
+            }
+        }
+        return { config, lookup };
+    }
+    read() {
+        const { configDir } = this;
+        this.writeUserConfig({ configs: {} }, false);
+        const configPath = path.join(configDir, "config.json");
+        return UserConfig.parse(JSON.parse(fs.readFileSync(configPath, "utf8")));
+    }
+    remove(configId) {
+        const userConfig = this.read();
+        if (!userConfig.configs[configId]) {
+            throw new Error(`No config with id '${configId}' found`);
+        }
+        delete userConfig.configs[configId];
+        if (userConfig.current === configId)
+            userConfig.current = undefined;
+        this.writeUserConfig(userConfig);
+    }
+    upsert(configId, config) {
+        const userConfig = this.read();
+        userConfig.configs[configId] = config;
+        userConfig.current ??= configId;
+        this.writeUserConfig(userConfig);
+        return config;
+    }
+    async use(configId) {
+        const userConfig = this.read();
+        const { config } = await this.get(configId);
+        userConfig.current = configId;
+        this.writeUserConfig(userConfig);
+        return config;
+    }
+    writeUserConfig(userConfig, overwrite = true) {
+        const { configDir } = this;
+        if (!fs.existsSync(configDir)) {
+            fs.mkdirSync(configDir);
+        }
+        const configPath = path.join(configDir, "config.json");
+        if (overwrite || !fs.existsSync(configPath)) {
+            fs.writeFileSync(configPath, JSON.stringify(userConfig, null, 2), "utf8");
+        }
+        return userConfig;
+    }
+}
+export class BaseConfigCommand extends Command {
+    // define flags that can be inherited by any command that extends BaseCommand
+    static baseFlags = {
+    /* "log-level": Flags.option({
+      default: "info",
+      helpGroup: "GLOBAL",
+      options: ["debug", "warn", "error", "info", "trace"] as const,
+      summary: "Specify level for logging.",
+    })(), */
+    };
+    args;
+    flags;
+    userConfig;
+    async catch(err) {
+        // add any custom logic to handle errors from the command
+        // or simply return the parent class error handling
+        return super.catch(err);
+    }
+    async finally(_) {
+        // called after run and catch regardless of whether or not the command errored
+        return super.finally(_);
+    }
+    async init() {
+        await super.init();
+        const { args, flags } = await this.parse({
+            args: this.ctor.args,
+            baseFlags: super.ctor.baseFlags,
+            enableJsonFlag: this.ctor.enableJsonFlag,
+            flags: this.ctor.flags,
+            strict: this.ctor.strict,
+        });
+        this.flags = flags;
+        this.args = args;
+        this.userConfig = new CommandConfig(this.config.configDir);
+    }
+}
+export class BaseCommand extends BaseConfigCommand {
+    // define flags that can be inherited by any command that extends BaseCommand
+    static baseFlags = {
+        "config-id": Flags.string({
+            char: "C",
+            helpGroup: "GLOBAL",
+            summary: "Specify config id to use for call.",
+        }),
+    };
+    async currentConfig() {
+        const { config, lookup } = await this.userConfig.get(this.flags["config-id"]);
+        const { bearerToken } = config;
+        if (!bearerToken) {
+            throw new Error(`Config '${lookup}' not logged in`);
+        }
+        return {
+            ...config,
+            bearerToken,
+        };
+    }
+    async fetch(getUrl, init) {
+        const config = await this.currentConfig();
+        const url = getUrl(config);
+        const rsp = await fetch(url, {
+            ...init,
+            headers: {
+                ...init?.headers,
+                authorization: `Bearer ${config.bearerToken}`,
+                "x-org-id": config.tenantId,
+            },
+        });
+        const rspContentType = rsp.headers.get("content-type");
+        if (!rsp.ok) {
+            const body = rspContentType?.startsWith("application/json")
+                ? await rsp.json()
+                : await rsp.text();
+            throw new HttpError(`${init?.method ?? "GET"} ${url}`, body, rsp.status);
+        }
+        if (rspContentType?.startsWith("application/json"))
+            return rsp.json();
+        return rsp.text();
+    }
+}

package/dist/commands/config/add.d.ts

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