@sanity/runtime-cli 10.9.2 → 10.10.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/10.9.2 linux-x64 node-v22.19.0
+@sanity/runtime-cli/10.10.0 linux-x64 node-v22.20.0
 $ sanity-run --help [COMMAND]
 USAGE
   $ sanity-run COMMAND
@@ -88,7 +88,7 @@ EXAMPLES
   $ sanity-run blueprints add function --name my-function --fn-type document-create --fn-type document-update --lang js
 ```
 
-_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -119,7 +119,7 @@ EXAMPLES
   $ sanity-run blueprints config --edit --project-id <projectId> --stack-id <stackId>
 ```
 
-_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -141,7 +141,7 @@ EXAMPLES
   $ sanity-run blueprints deploy --no-wait
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -166,7 +166,7 @@ EXAMPLES
   $ sanity-run blueprints destroy --stack-id <stackId> --project-id <projectId> --force --no-wait
 ```
 
-_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -188,7 +188,7 @@ EXAMPLES
   $ sanity-run blueprints info --stack-id <stackId>
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init [DIR]`
 
@@ -226,7 +226,7 @@ EXAMPLES
   $ sanity-run blueprints init --blueprint-type <json|js|ts> --stack-name <stackName>
 ```
 
-_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -248,7 +248,7 @@ EXAMPLES
   $ sanity-run blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -265,7 +265,7 @@ EXAMPLES
   $ sanity-run blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run blueprints stacks`
 
@@ -287,7 +287,7 @@ EXAMPLES
   $ sanity-run blueprints stacks --project-id <projectId>
 ```
 
-_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions dev`
 
@@ -295,10 +295,12 @@ Start the Sanity Function emulator
 
 ```
 USAGE
-  $ sanity-run functions dev [-p <value>]
+  $ sanity-run functions dev [-p <value>] [-t <value>]
 
 FLAGS
-  -p, --port=<value>  Port to start emulator on
+  -p, --port=<value>     Port to start emulator on
+  -t, --timeout=<value>  Maximum execution time for all functions, in seconds. Takes precedence over function-specific
+                         `timeout`
 
 DESCRIPTION
   Start the Sanity Function emulator
@@ -307,7 +309,7 @@ EXAMPLES
   $ sanity-run functions dev --port 8974
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -329,7 +331,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/v10.9.2/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env list NAME`
 
@@ -349,7 +351,7 @@ EXAMPLES
   $ sanity-run functions env list MyFunction
 ```
 
-_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/functions/env/list.ts)_
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -370,7 +372,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/v10.9.2/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions logs NAME`
 
@@ -404,7 +406,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test NAME`
 
@@ -451,7 +453,7 @@ EXAMPLES
   $ sanity-run functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
 ```
 
-_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v10.9.2/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v10.10.0/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

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

@@ -1 +1,2 @@
-export declare function dev(port: number): Promise<void>;
+import type { InvokeExecutionOptions } from '../../utils/types.js';
+export declare function dev(port: number, executionOptions?: Partial<InvokeExecutionOptions>): Promise<void>;

package/dist/actions/functions/dev.js

@@ -1,4 +1,4 @@
 import { app } from '../../server/app.js';
-export async function dev(port) {
-    app(Number(port));
+export async function dev(port, executionOptions) {
+    app(Number(port), executionOptions);
 }

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

@@ -4,6 +4,7 @@ export default class DevCommand extends Command {
     static examples: string[];
     static flags: {
         port: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        timeout: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
 }

package/dist/commands/functions/dev.js

@@ -5,6 +5,11 @@ export default class DevCommand extends Command {
     static examples = ['<%= config.bin %> <%= command.id %> --port 8974'];
     static flags = {
         port: Flags.integer({ char: 'p', description: 'Port to start emulator on', required: false }),
+        timeout: Flags.integer({
+            char: 't',
+            description: 'Maximum execution time for all functions, in seconds. Takes precedence over function-specific `timeout`',
+            required: false,
+        }),
     };
     async run() {
         const { flags } = await this.parse(DevCommand);

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

@@ -2,6 +2,7 @@ import type { CoreConfig, CoreResult } from '../index.js';
 export interface FunctionDevOptions extends CoreConfig {
     flags: {
         port?: number;
+        timeout?: number;
     };
 }
 export declare function functionDevCore(options: FunctionDevOptions): Promise<CoreResult>;

package/dist/cores/functions/dev.js

@@ -1,9 +1,13 @@
 import { dev } from '../../actions/functions/dev.js';
 export async function functionDevCore(options) {
     const { log, flags } = options;
-    const { port = 8080 } = flags;
+    const { port = 8080, timeout } = flags;
+    // Construct execution options only if timeout is provided
+    const executionOptions = timeout
+        ? { timeout }
+        : undefined;
     try {
-        await dev(Number(port));
+        await dev(Number(port), executionOptions);
         log(`Server is running on http://localhost:${port}\n`);
         return {
             success: true,

package/dist/server/app.d.ts

@@ -1,4 +1,5 @@
-declare const app: (port: number) => void;
+import { type InvokeExecutionOptions } from '../utils/types.js';
+declare const app: (port: number, executionOptions?: Partial<InvokeExecutionOptions>) => void;
 declare function parseDocumentUrl(url: string): {
     projectId: string;
     dataset: string;

package/dist/server/app.js

@@ -5,10 +5,10 @@ import { WebSocketServer } from 'ws';
 import { readLocalBlueprint } from '../actions/blueprints/blueprint.js';
 import config from '../config.js';
 import { isRecord } from '../utils/is-record.js';
-import { isEventType } from '../utils/types.js';
+import { isEventType, } from '../utils/types.js';
 import { handleInvokeRequest } from './handlers/invoke.js';
 const host = 'localhost';
-const app = (port) => {
+const app = (port, executionOptions) => {
     const requestListener = async (req, res) => {
         res.setHeader('Content-Type', 'application/json');
         switch (true) {
@@ -41,7 +41,7 @@ const app = (port) => {
                             else {
                                 delete context.clientOptions.token;
                             }
-                            const result = await handleInvokeRequest(functionName, event, metadata, context);
+                            const result = await handleInvokeRequest(functionName, event, metadata, context, executionOptions);
                             // Add Server-Timing header
                             const timingHeaders = [];
                             for (const [key, value] of Object.entries(result.timings)) {

package/dist/server/handlers/invoke.d.ts

@@ -1,4 +1,4 @@
-import type { InvocationResponse, InvokeContextOptions, InvokePayloadOptions } from '../../utils/types.js';
-export declare function handleInvokeRequest(functionName: string, event: Record<string, unknown>, metadata: Pick<InvokePayloadOptions, 'event' | 'before' | 'after'>, context: InvokeContextOptions): Promise<InvocationResponse & {
+import type { InvocationResponse, InvokeContextOptions, InvokeExecutionOptions, InvokePayloadOptions } from '../../utils/types.js';
+export declare function handleInvokeRequest(functionName: string, event: Record<string, unknown>, metadata: Pick<InvokePayloadOptions, 'event' | 'before' | 'after'>, context: InvokeContextOptions, executionOptions?: Partial<InvokeExecutionOptions>): Promise<InvocationResponse & {
     timings: Record<string, number>;
 }>;

package/dist/server/handlers/invoke.js

@@ -1,7 +1,7 @@
 import { readLocalBlueprint } from '../../actions/blueprints/blueprint.js';
 import { findFunctionByName } from '../../utils/find-function.js';
 import invoke from '../../utils/invoke-local.js';
-export async function handleInvokeRequest(functionName, event, metadata, context) {
+export async function handleInvokeRequest(functionName, event, metadata, context, executionOptions) {
     const start = performance.now();
     const { parsedBlueprint } = await readLocalBlueprint();
     const resource = findFunctionByName(parsedBlueprint, functionName);
@@ -11,8 +11,8 @@ export async function handleInvokeRequest(functionName, event, metadata, context
         ...metadata,
     };
     const response = await invoke(resource, payload, context, {
-        forceColor: false,
-        timeout: resource.timeout,
+        forceColor: executionOptions?.forceColor ?? false,
+        timeout: executionOptions?.timeout ?? resource.timeout,
     });
     const timings = { ...response.timings, 'blueprint:read': readBlueprintTime };
     return { ...response, timings };

package/oclif.manifest.json

@@ -638,6 +638,15 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "timeout": {
+          "char": "t",
+          "description": "Maximum execution time for all functions, in seconds. Takes precedence over function-specific `timeout`",
+          "name": "timeout",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -1132,5 +1141,5 @@
       ]
     }
   },
-  "version": "10.9.2"
+  "version": "10.10.0"
 }

package/package.json

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