@sanity/runtime-cli 2.0.2 → 2.1.1

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @sanity/runtime-cli
 $ sanity-run COMMAND
 running command...
 $ sanity-run (--version)
-@sanity/runtime-cli/2.0.2 linux-x64 node-v22.14.0
+@sanity/runtime-cli/2.1.1 linux-x64 node-v22.14.0
 $ sanity-run --help [COMMAND]
 USAGE
   $ sanity-run COMMAND
@@ -38,6 +38,8 @@ USAGE
 * [`sanity-run blueprints plan`](#sanity-run-blueprints-plan)
 * [`sanity-run blueprints stacks`](#sanity-run-blueprints-stacks)
 * [`sanity-run functions dev`](#sanity-run-functions-dev)
+* [`sanity-run functions env add NAME KEY VALUE`](#sanity-run-functions-env-add-name-key-value)
+* [`sanity-run functions env remove NAME KEY`](#sanity-run-functions-env-remove-name-key)
 * [`sanity-run functions invoke NAME`](#sanity-run-functions-invoke-name)
 * [`sanity-run functions logs NAME`](#sanity-run-functions-logs-name)
 * [`sanity-run functions test NAME`](#sanity-run-functions-test-name)
@@ -61,7 +63,7 @@ EXAMPLES
   $ sanity-run blueprints add function
 ```
 
-_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v2.0.2/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -83,7 +85,7 @@ EXAMPLES
   $ sanity-run blueprints config --edit
 ```
 
-_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v2.0.2/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -100,7 +102,7 @@ EXAMPLES
   $ sanity-run blueprints deploy
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v2.0.2/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -122,7 +124,7 @@ EXAMPLES
   $ sanity-run blueprints info --id abc123
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v2.0.2/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init`
 
@@ -139,7 +141,7 @@ EXAMPLES
   $ sanity-run blueprints init
 ```
 
-_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v2.0.2/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -161,7 +163,7 @@ EXAMPLES
   $ sanity-run blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v2.0.2/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -178,7 +180,7 @@ EXAMPLES
   $ sanity-run blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v2.0.2/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run blueprints stacks`
 
@@ -195,7 +197,7 @@ EXAMPLES
   $ sanity-run blueprints stacks
 ```
 
-_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v2.0.2/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions dev`
 
@@ -215,7 +217,50 @@ EXAMPLES
   $ sanity-run functions dev --port 8974
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v2.0.2/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/functions/dev.ts)_
+
+## `sanity-run functions env add NAME KEY VALUE`
+
+Add or set the value of an environment variable for a Sanity function
+
+```
+USAGE
+  $ sanity-run functions env add NAME KEY VALUE
+
+ARGUMENTS
+  NAME   The name of the Sanity Function
+  KEY    The name of the environment variable
+  VALUE  The value of the environment variable
+
+DESCRIPTION
+  Add or set the value of an environment variable for a Sanity function
+
+EXAMPLES
+  $ sanity-run functions env add MyFunction API_URL https://api.example.com/
+```
+
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/functions/env/add.ts)_
+
+## `sanity-run functions env remove NAME KEY`
+
+Remove an environment variable for a Sanity function
+
+```
+USAGE
+  $ sanity-run functions env remove NAME KEY
+
+ARGUMENTS
+  NAME  The name of the Sanity Function
+  KEY   The name of the environment variable
+
+DESCRIPTION
+  Remove an environment variable for a Sanity function
+
+EXAMPLES
+  $ sanity-run functions env remove MyFunction API_URL
+```
+
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions invoke NAME`
 
@@ -241,7 +286,7 @@ EXAMPLES
   $ sanity-run functions invoke <ID> --file 'payload.json'
 ```
 
-_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v2.0.2/src/commands/functions/invoke.ts)_
+_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/functions/invoke.ts)_
 
 ## `sanity-run functions logs NAME`
 
@@ -261,7 +306,7 @@ EXAMPLES
   $ sanity-run functions logs <ID>
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v2.0.2/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test NAME`
 
@@ -290,7 +335,7 @@ EXAMPLES
   $ sanity-run functions test echo-fn --data '{ "id": 1 }' --timeout 60
 ```
 
-_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v2.0.2/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v2.1.1/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

package/dist/actions/functions/env/index.d.ts

@@ -0,0 +1,6 @@
+import * as remove from './remove.js';
+import * as update from './update.js';
+export declare const envActions: {
+    remove: typeof remove;
+    update: typeof update;
+};

package/dist/actions/functions/env/index.js

@@ -0,0 +1,6 @@
+import * as remove from './remove.js';
+import * as update from './update.js';
+export const envActions = {
+    remove,
+    update,
+};

package/dist/actions/functions/env/remove.d.ts

@@ -0,0 +1,5 @@
+import type { AuthParams } from '../../../utils/types.js';
+export declare function remove(id: string, key: string, auth: AuthParams): Promise<{
+    ok: boolean;
+    error: any;
+}>;

package/dist/actions/functions/env/remove.js

@@ -0,0 +1,14 @@
+import config from '../../../config.js';
+import getHeaders from '../../../utils/get-headers.js';
+const { functions } = config.server;
+export async function remove(id, key, auth) {
+    const response = await fetch(`${functions}vX/functions/${id}/envvars/${key}`, {
+        headers: getHeaders(auth),
+        method: 'DELETE',
+    });
+    const json = response.ok ? undefined : await response.json();
+    return {
+        ok: response.ok,
+        error: response.ok ? null : json?.error?.message,
+    };
+}

package/dist/actions/functions/env/update.d.ts

@@ -0,0 +1,5 @@
+import type { AuthParams } from '../../../utils/types.js';
+export declare function update(id: string, key: string, value: string, auth: AuthParams): Promise<{
+    ok: boolean;
+    error: any;
+}>;

package/dist/actions/functions/env/update.js

@@ -0,0 +1,15 @@
+import config from '../../../config.js';
+import getHeaders from '../../../utils/get-headers.js';
+const { functions } = config.server;
+export async function update(id, key, value, auth) {
+    const response = await fetch(`${functions}vX/functions/${id}/envvars/${key}`, {
+        body: JSON.stringify({ value }),
+        headers: getHeaders(auth),
+        method: 'PUT',
+    });
+    const json = response.ok ? undefined : await response.json();
+    return {
+        ok: response.ok,
+        error: response.ok ? null : json?.error?.message,
+    };
+}

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

@@ -4,6 +4,10 @@ import * as logs from './logs.js';
 import * as test from './test.js';
 export declare const functionsActions: {
     dev: typeof dev;
+    env: {
+        remove: typeof import("./env/remove.js");
+        update: typeof import("./env/update.js");
+    };
     invoke: typeof invoke;
     logs: typeof logs;
     test: typeof test;

package/dist/actions/functions/index.js

@@ -1,9 +1,11 @@
 import * as dev from './dev.js';
+import * as env from './env/index.js';
 import * as invoke from './invoke.js';
 import * as logs from './logs.js';
 import * as test from './test.js';
 export const functionsActions = {
     dev,
+    env: env.envActions,
     invoke,
     logs,
     test,

package/dist/actions/functions/logs.js

@@ -6,10 +6,10 @@ export async function logs(id, auth) {
         headers: getHeaders(auth),
         method: 'GET',
     });
-    const logs = await response.json();
+    const json = await response.json();
     return {
         ok: response.ok,
-        error: response.ok ? null : logs?.error?.message,
-        logs: response.ok ? logs : [],
+        error: response.ok ? null : json?.error?.message,
+        logs: response.ok ? json.logs : [],
     };
 }

package/dist/commands/functions/env/add.d.ts

@@ -0,0 +1,11 @@
+import { Command } from '@oclif/core';
+export default class Add extends Command {
+    static args: {
+        name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+        key: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+        value: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/functions/env/add.js

@@ -0,0 +1,40 @@
+import { Args, Command } from '@oclif/core';
+import Spinner from 'yocto-spinner';
+import { readBlueprintOnDisk } from '../../../actions/blueprints/blueprint.js';
+import { update } from '../../../actions/functions/env/update.js';
+import config from '../../../config.js';
+import { red } from '../../../utils/display/colors.js';
+import { findFunctionByName } from '../../../utils/find-function.js';
+export default class Add extends Command {
+    static args = {
+        name: Args.string({ description: 'The name of the Sanity Function', required: true }),
+        key: Args.string({ description: 'The name of the environment variable', required: true }),
+        value: Args.string({ description: 'The value of the environment variable', required: true }),
+    };
+    static description = 'Add or set the value of an environment variable for a Sanity function';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> MyFunction API_URL https://api.example.com/',
+    ];
+    async run() {
+        const { args } = await this.parse(Add);
+        const spinner = Spinner({
+            text: `Updating "${args.key}" environment variable in "${args.name}"`,
+        }).start();
+        const { deployedStack } = await readBlueprintOnDisk({ getStack: true });
+        if (!deployedStack)
+            this.error('Stack not found'); // returns
+        const { projectId } = deployedStack;
+        const { externalId } = findFunctionByName(deployedStack, args.name);
+        const result = await update(externalId, args.key, args.value, {
+            token: config.token,
+            projectId,
+        });
+        if (result.ok) {
+            spinner.success(`Update of ${args.key} succeeded`);
+        }
+        else {
+            spinner.error(`${red('Failed')} to update ${args.key}`);
+            this.log(`Error: ${result.error || 'Unknown error'}`);
+        }
+    }
+}

package/dist/commands/functions/env/remove.d.ts

@@ -0,0 +1,10 @@
+import { Command } from '@oclif/core';
+export default class Remove extends Command {
+    static args: {
+        name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+        key: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/functions/env/remove.js

@@ -0,0 +1,37 @@
+import { Args, Command } from '@oclif/core';
+import Spinner from 'yocto-spinner';
+import { readBlueprintOnDisk } from '../../../actions/blueprints/blueprint.js';
+import { remove } from '../../../actions/functions/env/remove.js';
+import config from '../../../config.js';
+import { red } from '../../../utils/display/colors.js';
+import { findFunctionByName } from '../../../utils/find-function.js';
+export default class Remove extends Command {
+    static args = {
+        name: Args.string({ description: 'The name of the Sanity Function', required: true }),
+        key: Args.string({ description: 'The name of the environment variable', required: true }),
+    };
+    static description = 'Remove an environment variable for a Sanity function';
+    static examples = ['<%= config.bin %> <%= command.id %> MyFunction API_URL'];
+    async run() {
+        const { args } = await this.parse(Remove);
+        const spinner = Spinner({
+            text: `Removing "${args.key}" environment variable in "${args.name}"`,
+        }).start();
+        const { deployedStack } = await readBlueprintOnDisk({ getStack: true });
+        if (!deployedStack)
+            this.error('Stack not found'); // returns
+        const { projectId } = deployedStack;
+        const { externalId } = findFunctionByName(deployedStack, args.name);
+        const result = await remove(externalId, args.key, {
+            token: config.token,
+            projectId,
+        });
+        if (result.ok) {
+            spinner.success(`Removal of ${args.key} succeeded`);
+        }
+        else {
+            spinner.error(`${red('Failed')} to remove ${args.key}`);
+            this.log(`Error: ${result.error || 'Unknown error'}`);
+        }
+    }
+}

package/dist/commands/functions/logs.js

@@ -1,10 +1,20 @@
 import { Args, Command } from '@oclif/core';
 import Spinner from 'yocto-spinner';
 import { readBlueprintOnDisk } from '../../actions/blueprints/blueprint.js';
-import { logs } from '../../actions/functions/logs.js';
+import { logs as logsAction } from '../../actions/functions/logs.js';
 import config from '../../config.js';
-import { bold, red, yellow } from '../../utils/display/colors.js';
+import { formatTitle } from '../../utils/display/blueprints-formatting.js';
+import { blue, bold, green, red, yellow } from '../../utils/display/colors.js';
 import { findFunctionByName } from '../../utils/find-function.js';
+function logLevel(level) {
+    if (level === 'ERROR') {
+        return red(level);
+    }
+    if (level === 'ERROR') {
+        return yellow(level);
+    }
+    return green(level);
+}
 export default class Logs extends Command {
     static args = {
         name: Args.string({ description: 'The name of the Sanity Function', required: true }),
@@ -19,29 +29,23 @@ export default class Logs extends Command {
             this.error('Stack not found'); // returns
         const { name, projectId } = deployedStack;
         const { externalId } = findFunctionByName(deployedStack, args.name);
-        const result = await logs(externalId, { token: config.token, projectId });
-        if (result.ok) {
-            spinner.success(`Found logs ${args.name} for blueprint "${name}"`);
-            for (const logGroup of result.logs) {
-                for (const log of logGroup.events) {
-                    const { message, timestamp } = log;
-                    // INFO log format:   year  month date  hr    min   sec    ms      req uuid
-                    const logPattern = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z\s+[0-9a-f-]+/;
-                    if (logPattern.test(message)) {
-                        const content = message.replace(logPattern, '').trim().replace(/^INFO/, '').trim();
-                        if (content) {
-                            const date = new Date(timestamp);
-                            const time = date.toLocaleTimeString();
-                            const day = date.toLocaleDateString();
-                            this.log(`  ${bold(day)} ${yellow(time)} ${content}`);
-                        }
-                    }
-                }
-            }
-        }
-        else {
+        const { ok, error, logs } = await logsAction(externalId, { token: config.token, projectId });
+        if (!ok) {
             spinner.error(`${red('Failed')} to retrieve logs`);
-            this.log(`Error: ${result.error || 'Unknown error'}`);
+            this.log(`Error: ${error || 'Unknown error'}`);
+            return;
+        }
+        const filteredLogs = logs.filter((entry) => entry.level && entry.message);
+        if (filteredLogs.length === 0) {
+            spinner.info(`No logs found for function ${args.name}`);
+            return;
+        }
+        spinner.success(`${formatTitle('Function', args.name)} Logs`);
+        this.log(`Found ${bold(filteredLogs.length.toString())} log entries for function ${yellow(args.name)}\n`);
+        for (const log of filteredLogs) {
+            const { time, level, message } = log;
+            const date = new Date(time);
+            this.log(`${bold(date.toLocaleDateString())} ${bold(blue(date.toLocaleTimeString()))} ${logLevel(level)} ${message}`);
         }
     }
 }

package/dist/utils/types.d.ts

@@ -84,15 +84,9 @@ export interface AuthParams {
 }
 /** @internal */
 export interface FunctionLog {
-    eventId: string;
-    ingestionTime: string;
-    timestamp: string;
+    time: string;
+    requestId: string;
+    level: string;
     message: string;
 }
-/** @internal */
-export interface FunctionLogGroup {
-    events: Array<FunctionLog>;
-    nextBackwardToken: string;
-    nextForwardToken: string;
-}
 export {};

package/oclif.manifest.json

@@ -402,7 +402,84 @@
         "functions",
         "test.js"
       ]
+    },
+    "functions:env:add": {
+      "aliases": [],
+      "args": {
+        "name": {
+          "description": "The name of the Sanity Function",
+          "name": "name",
+          "required": true
+        },
+        "key": {
+          "description": "The name of the environment variable",
+          "name": "key",
+          "required": true
+        },
+        "value": {
+          "description": "The value of the environment variable",
+          "name": "value",
+          "required": true
+        }
+      },
+      "description": "Add or set the value of an environment variable for a Sanity function",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> MyFunction API_URL https://api.example.com/"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "functions:env:add",
+      "pluginAlias": "@sanity/runtime-cli",
+      "pluginName": "@sanity/runtime-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "functions",
+        "env",
+        "add.js"
+      ]
+    },
+    "functions:env:remove": {
+      "aliases": [],
+      "args": {
+        "name": {
+          "description": "The name of the Sanity Function",
+          "name": "name",
+          "required": true
+        },
+        "key": {
+          "description": "The name of the environment variable",
+          "name": "key",
+          "required": true
+        }
+      },
+      "description": "Remove an environment variable for a Sanity function",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> MyFunction API_URL"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "functions:env:remove",
+      "pluginAlias": "@sanity/runtime-cli",
+      "pluginName": "@sanity/runtime-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "functions",
+        "env",
+        "remove.js"
+      ]
     }
   },
-  "version": "2.0.2"
+  "version": "2.1.1"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "2.0.2",
+  "version": "2.1.1",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",