@sanity/runtime-cli 1.0.2

package/README.md

@@ -0,0 +1,548 @@
+@sanity/runtime-cli
+=================
+
+A new CLI generated with oclif
+
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/@sanity/runtime-cli.svg)](https://npmjs.org/package/@sanity/runtime-cli)
+[![Downloads/week](https://img.shields.io/npm/dw/@sanity/runtime-cli.svg)](https://npmjs.org/package/@sanity/runtime-cli)
+
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @sanity/runtime-cli
+$ sanity COMMAND
+running command...
+$ sanity (--version)
+@sanity/runtime-cli/1.0.2 linux-x64 node-v22.13.1
+$ sanity --help [COMMAND]
+USAGE
+  $ sanity COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`sanity functions dev`](#sanity-functions-dev)
+* [`sanity functions invoke ID`](#sanity-functions-invoke-id)
+* [`sanity functions logs ID`](#sanity-functions-logs-id)
+* [`sanity functions test PATH`](#sanity-functions-test-path)
+* [`sanity help [COMMAND]`](#sanity-help-command)
+* [`sanity plugins`](#sanity-plugins)
+* [`sanity plugins add PLUGIN`](#sanity-plugins-add-plugin)
+* [`sanity plugins:inspect PLUGIN...`](#sanity-pluginsinspect-plugin)
+* [`sanity plugins install PLUGIN`](#sanity-plugins-install-plugin)
+* [`sanity plugins link PATH`](#sanity-plugins-link-path)
+* [`sanity plugins remove [PLUGIN]`](#sanity-plugins-remove-plugin)
+* [`sanity plugins reset`](#sanity-plugins-reset)
+* [`sanity plugins uninstall [PLUGIN]`](#sanity-plugins-uninstall-plugin)
+* [`sanity plugins unlink [PLUGIN]`](#sanity-plugins-unlink-plugin)
+* [`sanity plugins update`](#sanity-plugins-update)
+
+## `sanity functions dev`
+
+Start the Sanity Function emulator
+
+```
+USAGE
+  $ sanity functions dev [-p <value>]
+
+FLAGS
+  -p, --port=<value>  Port to start emulator on
+
+DESCRIPTION
+  Start the Sanity Function emulator
+
+EXAMPLES
+  $ sanity functions dev --port 8974
+```
+
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v1.0.2/src/commands/functions/dev.ts)_
+
+## `sanity functions invoke ID`
+
+Invoke a remote Sanity Function
+
+```
+USAGE
+  $ sanity functions invoke ID [-d <value>] [-f <value>]
+
+ARGUMENTS
+  ID  The ID of the function to invoke
+
+FLAGS
+  -d, --data=<value>  Data to send to the function
+  -f, --file=<value>  Read data from file and send to the function
+
+DESCRIPTION
+  Invoke a remote Sanity Function
+
+EXAMPLES
+  $ sanity functions invoke <ID> --data '{ "id": 1 }'
+
+  $ sanity functions invoke <ID> --file 'payload.json'
+```
+
+_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v1.0.2/src/commands/functions/invoke.ts)_
+
+## `sanity functions logs ID`
+
+Retrieve logs for a Sanity Function
+
+```
+USAGE
+  $ sanity functions logs ID
+
+ARGUMENTS
+  ID  The ID of the function to retrieve logs for
+
+DESCRIPTION
+  Retrieve logs for a Sanity Function
+
+EXAMPLES
+  $ sanity functions logs <ID>
+```
+
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.0.2/src/commands/functions/logs.ts)_
+
+## `sanity functions test PATH`
+
+Invoke a local Sanity Function
+
+```
+USAGE
+  $ sanity functions test PATH [-d <value>] [-f <value>] [-t <value>]
+
+ARGUMENTS
+  PATH  The path to the function source code
+
+FLAGS
+  -d, --data=<value>     Data to send to the function
+  -f, --file=<value>     Read data from file and send to the function
+  -t, --timeout=<value>  Execution timeout value in seconds
+
+DESCRIPTION
+  Invoke a local Sanity Function
+
+EXAMPLES
+  $ sanity functions test ./test.ts --data '{ "id": 1 }'
+
+  $ sanity functions test ./test.js --file 'payload.json'
+
+  $ sanity functions test ./test.ts --data '{ "id": 1 }' --timeout 60
+```
+
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v1.0.2/src/commands/functions/test.ts)_
+
+## `sanity help [COMMAND]`
+
+Display help for sanity.
+
+```
+USAGE
+  $ sanity help [COMMAND...] [-n]
+
+ARGUMENTS
+  COMMAND...  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for sanity.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.25/src/commands/help.ts)_
+
+## `sanity plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ sanity plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ sanity plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.31/src/commands/plugins/index.ts)_
+
+## `sanity plugins add PLUGIN`
+
+Installs a plugin into sanity.
+
+```
+USAGE
+  $ sanity plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into sanity.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the SANITY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the SANITY_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ sanity plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ sanity plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ sanity plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ sanity plugins add someuser/someplugin
+```
+
+## `sanity plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ sanity plugins inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN...  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ sanity plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.31/src/commands/plugins/inspect.ts)_
+
+## `sanity plugins install PLUGIN`
+
+Installs a plugin into sanity.
+
+```
+USAGE
+  $ sanity plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into sanity.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the SANITY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the SANITY_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ sanity plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ sanity plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ sanity plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ sanity plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.31/src/commands/plugins/install.ts)_
+
+## `sanity plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ sanity plugins link PATH [-h] [--install] [-v]
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help          Show CLI help.
+  -v, --verbose
+      --[no-]install  Install dependencies after linking the plugin.
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ sanity plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.31/src/commands/plugins/link.ts)_
+
+## `sanity plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ sanity plugins remove [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ sanity plugins unlink
+  $ sanity plugins remove
+
+EXAMPLES
+  $ sanity plugins remove myplugin
+```
+
+## `sanity plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ sanity plugins reset [--hard] [--reinstall]
+
+FLAGS
+  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
+  --reinstall  Reinstall all plugins after uninstalling.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.31/src/commands/plugins/reset.ts)_
+
+## `sanity plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ sanity plugins uninstall [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ sanity plugins unlink
+  $ sanity plugins remove
+
+EXAMPLES
+  $ sanity plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.31/src/commands/plugins/uninstall.ts)_
+
+## `sanity plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ sanity plugins unlink [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ sanity plugins unlink
+  $ sanity plugins remove
+
+EXAMPLES
+  $ sanity plugins unlink myplugin
+```
+
+## `sanity plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ sanity plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.31/src/commands/plugins/update.ts)_
+<!-- commandsstop -->
+* [`sanity functions dev`](#sanity-functions-dev)
+* [`sanity functions invoke`](#sanity-functions-invoke)
+* [`sanity functions logs`](#sanity-functions-logs)
+* [`sanity functions test`](#sanity-functions-test)
+
+## `sanity functions dev`
+
+Start the Sanity Function emulator
+
+```
+USAGE
+  $ sanity functions dev [-p <value>]
+
+FLAGS
+  -p, --port=<value>  Port to start emulator on
+
+DESCRIPTION
+  Start the Sanity Function emulator
+
+EXAMPLES
+  $ sanity functions dev --port 8974
+```
+
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli-demos/blob/v0.0.0/src/commands/functions/dev.ts)_
+
+## `sanity functions invoke`
+
+Invoke a remote Sanity Function
+
+```
+USAGE
+  $ sanity functions invoke ID [-d <value>] [-f <value>]
+
+ARGUMENTS
+  ID  The ID of the function to invoke
+
+FLAGS
+  -d, --data=<value>  Data to send to the function
+  -f, --file=<value>  Read data from file and send to the function
+
+DESCRIPTION
+  Invoke a remote Sanity Function
+
+EXAMPLES
+  $ sanity functions invoke <ID> --data '{ "id": 1 }'
+
+  $ sanity functions invoke <ID> --file 'payload.json'
+```
+
+_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli-demos/blob/v0.0.0/src/commands/functions/invoke.ts)_
+
+## `sanity functions logs`
+
+Retrieve logs for a Sanity Function
+
+```
+USAGE
+  $ sanity functions logs ID
+
+ARGUMENTS
+  ID  The ID of the function to retrieve logs for
+
+DESCRIPTION
+  Retrieve logs for a Sanity Function
+
+EXAMPLES
+  $ sanity functions logs <ID>
+```
+
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli-demos/blob/v0.0.0/src/commands/functions/logs.ts)_
+
+## `sanity functions test`
+
+Invoke a local Sanity Function
+
+```
+USAGE
+  $ sanity functions test PATH [-d <value>] [-f <value>]
+
+ARGUMENTS
+  PATH  The path to the function source code
+
+FLAGS
+  -d, --data=<value>  Data to send to the function
+  -f, --file=<value>  Read data from file and send to the function
+
+DESCRIPTION
+  Invoke a local Sanity Function
+
+EXAMPLES
+  $ sanity functions test ./test.ts --data '{ "id": 1 }'
+
+  $ sanity functions test ./test.js --file 'payload.json'
+```
+
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli-demos/blob/v0.0.0/src/commands/functions/test.ts)_

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

package/dist/actions/functions/dev.d.ts

@@ -0,0 +1 @@
+export declare function dev(port: number): Promise<void>;

package/dist/actions/functions/dev.js

@@ -0,0 +1,5 @@
+import { serve } from '@hono/node-server';
+import app from '../../server/app.js';
+export async function dev(port) {
+    serve({ fetch: app.fetch, port: Number(port) });
+}

package/dist/actions/functions/invoke.d.ts

@@ -0,0 +1,2 @@
+import type { PayloadOptions } from '../../utils/types.js';
+export declare function invoke(id: string, options: PayloadOptions): Promise<object>;

package/dist/actions/functions/invoke.js

@@ -0,0 +1,17 @@
+import config from '../../config.js';
+import buildPayload from '../../utils/build-payload.js';
+const { url } = config.server;
+export async function invoke(id, options) {
+    const payload = buildPayload(options);
+    // eslint-disable-next-line n/no-unsupported-features/node-builtins
+    const response = await fetch(`${url}/api/vX/functions/${id}/invoke`, {
+        body: JSON.stringify({ data: payload }),
+        headers: {
+            Accept: 'application/json',
+            'Content-Type': 'application/json',
+        },
+        method: 'POST',
+    });
+    const json = await response.json();
+    return json;
+}

package/dist/actions/functions/logs.d.ts

@@ -0,0 +1 @@
+export declare function logs(id: string): Promise<object>;

package/dist/actions/functions/logs.js

@@ -0,0 +1,14 @@
+import config from '../../config.js';
+const { url } = config.server;
+export async function logs(id) {
+    // eslint-disable-next-line n/no-unsupported-features/node-builtins
+    const response = await fetch(`${url}/api/vX/functions/${id}/logs`, {
+        headers: {
+            Accept: 'application/json',
+            'Content-Type': 'application/json',
+        },
+        method: 'GET',
+    });
+    const json = await response.json();
+    return json;
+}

package/dist/actions/functions/test.d.ts

@@ -0,0 +1,2 @@
+import type { InvocationResponse, PayloadOptions } from '../../utils/types.js';
+export declare function testAction(srcPath: string, options: PayloadOptions): Promise<InvocationResponse>;

package/dist/actions/functions/test.js

@@ -0,0 +1,13 @@
+import buildPayload from '../../utils/build-payload.js';
+import invoke from '../../utils/invoke-local.js';
+export async function testAction(srcPath, options) {
+    const payload = buildPayload(options);
+    const { timeout } = options;
+    try {
+        const { json, logs } = await invoke(srcPath, payload, timeout);
+        return { error: undefined, json, logs };
+    }
+    catch (error) {
+        return { error, json: undefined, logs: undefined };
+    }
+}

package/dist/commands/functions/dev.d.ts

@@ -0,0 +1,9 @@
+import { Command } from '@oclif/core';
+export default class Dev extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        port: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/functions/dev.js

@@ -0,0 +1,15 @@
+import { Command, Flags } from '@oclif/core';
+import { dev } from '../../actions/functions/dev.js';
+export default class Dev extends Command {
+    static description = 'Start the Sanity Function emulator';
+    static examples = ['<%= config.bin %> <%= command.id %> --port 8974'];
+    static flags = {
+        port: Flags.string({ char: 'p', description: 'Port to start emulator on', required: false }),
+    };
+    async run() {
+        const { flags } = await this.parse(Dev);
+        const { port = 8080 } = flags;
+        dev(Number(port));
+        this.log(`Server is running on port ${port}\n`);
+    }
+}

package/dist/commands/functions/invoke.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '@oclif/core';
+export default class Invoke extends Command {
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        data: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}