@sanity/runtime-cli 7.1.0 → 7.2.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @sanity/runtime-cli
 $ sanity-run COMMAND
 running command...
 $ sanity-run (--version)
-@sanity/runtime-cli/7.1.0 linux-x64 node-v22.15.0
+@sanity/runtime-cli/7.2.0 linux-x64 node-v22.15.0
 $ sanity-run --help [COMMAND]
 USAGE
   $ sanity-run COMMAND
@@ -84,7 +84,7 @@ EXAMPLES
   $ sanity-run blueprints add function --name my-function --fn-type document-publish --lang js
 ```
 
-_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v7.1.0/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -112,7 +112,7 @@ EXAMPLES
   $ sanity-run blueprints config --edit --project-id <projectId>
 ```
 
-_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v7.1.0/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -134,7 +134,7 @@ EXAMPLES
   $ sanity-run blueprints deploy --no-wait
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v7.1.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -155,7 +155,7 @@ EXAMPLES
   $ sanity-run blueprints destroy
 ```
 
-_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v7.1.0/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -172,7 +172,7 @@ EXAMPLES
   $ sanity-run blueprints info
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v7.1.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init [DIR]`
 
@@ -204,7 +204,7 @@ EXAMPLES
   $ sanity-run blueprints init --blueprint-type <json|js|ts> --project-id <projectId>
 ```
 
-_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v7.1.0/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -226,7 +226,7 @@ EXAMPLES
   $ sanity-run blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v7.1.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -243,7 +243,7 @@ EXAMPLES
   $ sanity-run blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v7.1.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run functions dev`
 
@@ -263,7 +263,7 @@ EXAMPLES
   $ sanity-run functions dev --port 8974
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v7.1.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -285,7 +285,7 @@ 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/v7.1.0/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env list NAME`
 
@@ -305,7 +305,7 @@ EXAMPLES
   $ sanity-run functions env list MyFunction
 ```
 
-_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v7.1.0/src/commands/functions/env/list.ts)_
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -326,7 +326,7 @@ 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/v7.1.0/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions logs NAME`
 
@@ -334,7 +334,7 @@ Retrieve or delete logs for a Sanity Function
 
 ```
 USAGE
-  $ sanity-run functions logs NAME [-u] [-f [-d | -l <value> | -j]]
+  $ sanity-run functions logs NAME [-u] [-f [-d | -l <value> | -j]] [-w]
 
 ARGUMENTS
   NAME  The name of the Sanity Function
@@ -345,6 +345,7 @@ FLAGS
   -j, --json           Return logs in JSON format
   -l, --limit=<value>  [default: 50] Total number of log entries to retrieve
   -u, --utc            Show dates in UTC time zone
+  -w, --watch          Watch for new logs (streaming mode)
 
 DESCRIPTION
   Retrieve or delete logs for a Sanity Function
@@ -359,7 +360,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v7.1.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test NAME`
 
@@ -392,7 +393,7 @@ EXAMPLES
   $ sanity-run functions test <name> --data '{ "id": 1 }' --timeout 60
 ```
 
-_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v7.1.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v7.2.0/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

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

@@ -1,4 +1,4 @@
-import type { AuthParams } from '../../utils/types.js';
+import type { AuthParams, FunctionLog } from '../../utils/types.js';
 /** @internal */
 export interface LoggingOptions {
     limit: number;
@@ -13,3 +13,4 @@ export declare function deleteLogs(id: string, auth: AuthParams): Promise<{
     ok: boolean;
     error: any;
 }>;
+export declare function streamLogs(id: string, auth: AuthParams, onLog: (log: FunctionLog) => void, onOpen: () => void, onError: (error: string) => void): () => void;

package/dist/actions/functions/logs.js

@@ -1,3 +1,4 @@
+import { EventSource } from 'eventsource';
 import config from '../../config.js';
 import getHeaders from '../../utils/get-headers.js';
 const { apiUrl } = config;
@@ -26,3 +27,57 @@ export async function deleteLogs(id, auth) {
         error: response.ok ? null : json?.error?.message,
     };
 }
+// Create streaming logs connection
+export function streamLogs(id, auth, onLog, onOpen, onError) {
+    const url = new URL(`${apiUrl}vX/functions/${id}/logs/stream`);
+    const headers = getHeaders(auth);
+    const eventSource = new EventSource(url.toString(), {
+        fetch: (input, init) => fetch(input, {
+            ...init,
+            headers: {
+                ...init?.headers,
+                ...headers,
+            },
+        }),
+    });
+    eventSource.onopen = onOpen;
+    eventSource.onmessage = (event) => {
+        try {
+            const log = JSON.parse(event.data);
+            onLog(log);
+        }
+        catch (err) {
+            onError(`Failed to parse log data: ${err instanceof Error ? err.message : String(err)}`);
+        }
+    };
+    eventSource.addEventListener('logs', (event) => {
+        try {
+            const logData = JSON.parse(event.data);
+            // usually an array
+            if (Array.isArray(logData)) {
+                for (const log of logData)
+                    onLog(log);
+            }
+            else {
+                onLog(logData);
+            }
+        }
+        catch (err) {
+            console.error('Error parsing logs event:', err);
+        }
+    });
+    eventSource.onerror = (err) => {
+        onError('Connection to log stream failed or was closed');
+        if (eventSource.readyState === eventSource.CLOSED) {
+            console.log('Connection is CLOSED');
+        }
+        else if (eventSource.readyState === eventSource.CONNECTING) {
+            console.log('Connection is attempting to reconnect...');
+            return; // Don't close if trying to reconnect
+        }
+        eventSource.close();
+    };
+    return () => {
+        eventSource.close();
+    };
+}

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

@@ -11,6 +11,7 @@ export default class LogsCommand extends DeployedBlueprintCommand<typeof LogsCom
         utc: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         delete: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        watch: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
 }

package/dist/commands/functions/logs.js

@@ -41,6 +41,11 @@ export default class LogsCommand extends DeployedBlueprintCommand {
             description: 'Skip confirmation for deleting logs',
             required: false,
         }),
+        watch: Flags.boolean({
+            char: 'w',
+            description: 'Watch for new logs (streaming mode)',
+            aliases: ['follow'],
+        }),
     };
     async run() {
         const { success, error } = await functionLogsCore({

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

@@ -9,6 +9,7 @@ export interface FunctionLogsOptions extends DeployedBlueprintConfig {
         utc?: boolean;
         delete?: boolean;
         force?: boolean;
+        watch?: boolean;
     };
 }
 export declare function functionLogsCore(options: FunctionLogsOptions): Promise<CoreResult>;

package/dist/cores/functions/logs.js

@@ -1,16 +1,19 @@
 import chalk from 'chalk';
 import inquirer from 'inquirer';
 import ora from 'ora';
-import { deleteLogs as deleteLogsAction, logs as getLogsAction, } from '../../actions/functions/logs.js';
+import { deleteLogs as deleteLogsAction, logs as getLogsAction, streamLogs as streamLogsAction, } from '../../actions/functions/logs.js';
 import { formatTitle } from '../../utils/display/blueprints-formatting.js';
+import { niceId } from '../../utils/display/presenters.js';
 import { findFunctionByName } from '../../utils/find-function.js';
 export async function functionLogsCore(options) {
     const { args, flags, log, auth, deployedStack } = options;
     const { name } = args;
-    const { delete: shouldDelete, force, limit, json, utc } = flags;
+    const { delete: shouldDelete, watch: shouldWatch, force, limit, json, utc } = flags;
     const { externalId } = findFunctionByName(deployedStack, name); // throws if not found
     if (shouldDelete)
         return deleteLogs({ name, externalId, auth, force, log });
+    if (shouldWatch)
+        return streamLogs({ name, externalId, auth, json, utc, log });
     return getLogs({ name, externalId, auth, limit, json, utc, log });
 }
 async function deleteLogs({ name, externalId, auth, force, log, }) {
@@ -33,6 +36,34 @@ async function deleteLogs({ name, externalId, auth, force, log, }) {
     spinner.succeed('Logs deleted');
     return { success: true };
 }
+async function streamLogs({ name, externalId, auth, json, utc, log, }) {
+    const spinner = ora(`Setting up streaming logs session for function ${niceId(name)}`).start();
+    try {
+        spinner.stop();
+        log(`Streaming log session for function ${niceId(name)}`);
+        log(`Watching for new logs... ${chalk.bold('ctrl+c')} to stop`);
+        const onOpen = () => {
+            // TODO delete line 97 and uncomment 101 when Fns service is updated
+            // log(`Watching for new logs... ${chalk.bold('ctrl+c')} to stop`)
+        };
+        const renderLog = (logEntry) => {
+            const { time, level, message } = logEntry;
+            log(formatLog(time, level, message, true));
+        };
+        streamLogsAction(externalId, auth, renderLog, onOpen, (error) => log(`${chalk.red('Error:')} ${error}`));
+        // Return a special key for streaming mode
+        return {
+            success: true,
+            streaming: new Promise(() => { }),
+        };
+    }
+    catch (err) {
+        spinner.fail('Failed to retrieve logs');
+        const errorMessage = err instanceof Error ? err.message : String(err);
+        log(`Error: ${errorMessage}`);
+        return { success: false, error: errorMessage };
+    }
+}
 async function getLogs({ name, externalId, auth, limit, json, utc, log, }) {
     const spinner = ora(`Finding logs for function "${name}"`).start();
     const { ok, error, logs, total } = await getLogsAction(externalId, { limit }, auth);
@@ -53,11 +84,7 @@ async function getLogs({ name, externalId, auth, limit, json, utc, log, }) {
         }
         log('\n');
         for (const { time, level, message } of filteredLogs) {
-            const date = new Date(time);
-            const [dateString, timeString] = utc
-                ? date.toISOString().slice(0, 19).split('T')
-                : [date.toLocaleDateString(), date.toLocaleTimeString()];
-            log([chalk.bold(dateString), chalk.bold.blue(timeString), logLevel(level), message].join(' '));
+            log(formatLog(time, level, message, utc));
         }
     }
     else {
@@ -65,6 +92,13 @@ async function getLogs({ name, externalId, auth, limit, json, utc, log, }) {
     }
     return { success: true };
 }
+function formatLog(time, level, message, utc) {
+    const date = new Date(time);
+    const [dateString, timeString] = utc
+        ? date.toISOString().slice(0, 19).split('T')
+        : [date.toLocaleDateString(), date.toLocaleTimeString()];
+    return [chalk.bold(dateString), chalk.bold.blue(timeString), logLevel(level), message].join(' ');
+}
 function logLevel(level) {
     if (level === 'ERROR')
         return chalk.red(level);

package/oclif.manifest.json

@@ -618,6 +618,16 @@
           "required": false,
           "allowNo": false,
           "type": "boolean"
+        },
+        "watch": {
+          "aliases": [
+            "follow"
+          ],
+          "char": "w",
+          "description": "Watch for new logs (streaming mode)",
+          "name": "watch",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -829,5 +839,5 @@
       ]
     }
   },
-  "version": "7.1.0"
+  "version": "7.2.0"
 }

package/package.json

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