@sanity/runtime-cli 10.5.1 → 10.6.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/10.5.1 linux-x64 node-v22.19.0
+@sanity/runtime-cli/10.6.1 linux-x64 node-v22.19.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.5.1/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/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.5.1/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/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.5.1/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/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.5.1/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/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.5.1/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/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.5.1/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/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.5.1/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/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.5.1/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/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.5.1/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions dev`
 
@@ -307,7 +307,7 @@ EXAMPLES
   $ sanity-run functions dev --port 8974
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v10.5.1/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -329,7 +329,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.5.1/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env list NAME`
 
@@ -349,7 +349,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.5.1/src/commands/functions/env/list.ts)_
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -370,7 +370,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.5.1/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions logs NAME`
 
@@ -404,7 +404,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v10.5.1/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test NAME`
 
@@ -412,21 +412,31 @@ Invoke a local Sanity Function
 
 ```
 USAGE
-  $ sanity-run functions test NAME [-d <value> | -f <value> | --document-id <value>] [-t <value>] [-a <value>]
-    [--dataset <value>] [--project-id <value>] [--with-user-token]
+  $ sanity-run functions test NAME [--data-before <value> | [-d <value> | -f <value> | --document-id <value>] |  | 
+    | --file-before <value> | --file-after <value> | --document-id-before <value> | --document-id-after <value>]
+    [--data-after <value> |  |  |  |  |  |  | ] [-e create|update|delete] [-t <value>] [-a <value>] [--dataset <value>]
+    [--project-id <value>] [--with-user-token]
 
 ARGUMENTS
   NAME  The name of the Sanity Function
 
 FLAGS
-  -a, --api=<value>          Sanity API Version to use
-  -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
-      --dataset=<value>      The Sanity dataset to use
-      --document-id=<value>  Document to fetch and send to function
-      --project-id=<value>   Sanity Project ID to use
-      --with-user-token      Prime access token from CLI config
+  -a, --api=<value>                 Sanity API Version to use
+  -d, --data=<value>                Data to send to the function
+  -e, --event=<option>              Type of event (create, update, delete)
+                                    <options: create|update|delete>
+  -f, --file=<value>                Read data from file and send to the function
+  -t, --timeout=<value>             Execution timeout value in seconds
+      --data-after=<value>          Current document
+      --data-before=<value>         Original document
+      --dataset=<value>             The Sanity dataset to use
+      --document-id=<value>         Document to fetch and send to function
+      --document-id-after=<value>   Current document
+      --document-id-before=<value>  Original document
+      --file-after=<value>          Current document
+      --file-before=<value>         Original document
+      --project-id=<value>          Sanity Project ID to use
+      --with-user-token             Prime access token from CLI config
 
 DESCRIPTION
   Invoke a local Sanity Function
@@ -439,7 +449,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/v10.5.1/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v10.6.1/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

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

@@ -1,2 +1,2 @@
-import type { FunctionResource, InvocationResponse, InvokeContextOptions, InvokePayloadOptions } from '../../utils/types.js';
-export declare function testAction(resource: FunctionResource, options: InvokePayloadOptions, context: InvokeContextOptions): Promise<InvocationResponse>;
+import type { FunctionResource, InvocationResponse, InvokeContextOptions, InvokeExecutionOptions, InvokePayloadOptions } from '../../utils/types.js';
+export declare function testAction(resource: FunctionResource, payload: InvokePayloadOptions, context: InvokeContextOptions, options: InvokeExecutionOptions): Promise<InvocationResponse>;

package/dist/actions/functions/test.js

@@ -1,8 +1,7 @@
 import invoke from '../../utils/invoke-local.js';
-export async function testAction(resource, options, context) {
-    const { payload = null, timeout } = options;
+export async function testAction(resource, payload, context, options) {
     try {
-        const { json, logs } = await invoke(resource, payload, context, { timeout });
+        const { json, logs } = await invoke(resource, payload, context, options);
         return { error: undefined, json, logs };
     }
     catch (error) {

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

@@ -7,12 +7,19 @@ export default class TestCommand extends BlueprintCommand<typeof TestCommand> {
     static examples: string[];
     static flags: {
         data: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'data-before': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'data-after': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        event: 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>;
+        'file-before': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'file-after': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         timeout: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
         api: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         dataset: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'project-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'document-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'document-id-before': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'document-id-after': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'with-user-token': import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;

package/dist/commands/functions/test.js

@@ -18,12 +18,70 @@ export default class TestCommand extends BlueprintCommand {
             exclusive: ['file', 'document-id'],
             required: false,
         }),
+        'data-before': Flags.string({
+            description: 'Original document',
+            exclusive: [
+                'data',
+                'file',
+                'document-id',
+                'file-before',
+                'file-after',
+                'document-id-before',
+                'document-id-after',
+            ],
+            required: false,
+        }),
+        'data-after': Flags.string({
+            description: 'Current document',
+            exclusive: [
+                'data',
+                'file',
+                'document-id',
+                'file-before',
+                'file-after',
+                'document-id-before',
+                'document-id-after',
+            ],
+            required: false,
+        }),
+        event: Flags.string({
+            char: 'e',
+            description: 'Type of event (create, update, delete)',
+            required: false,
+            options: ['create', 'update', 'delete'],
+        }),
         file: Flags.string({
             char: 'f',
             description: 'Read data from file and send to the function',
             exclusive: ['data', 'document-id'],
             required: false,
         }),
+        'file-before': Flags.string({
+            description: 'Original document',
+            exclusive: [
+                'data',
+                'file',
+                'document-id',
+                'data-before',
+                'data-after',
+                'document-id-before',
+                'document-id-after',
+            ],
+            required: false,
+        }),
+        'file-after': Flags.string({
+            description: 'Current document',
+            exclusive: [
+                'data',
+                'file',
+                'document-id',
+                'data-before',
+                'data-after',
+                'document-id-before',
+                'document-id-after',
+            ],
+            required: false,
+        }),
         timeout: Flags.integer({
             char: 't',
             description: 'Execution timeout value in seconds',
@@ -49,12 +107,49 @@ export default class TestCommand extends BlueprintCommand {
             exclusive: ['data', 'file'],
             required: false,
         }),
+        'document-id-before': Flags.string({
+            description: 'Original document',
+            exclusive: [
+                'data',
+                'file',
+                'document-id',
+                'data-before',
+                'data-after',
+                'file-before',
+                'file-after',
+            ],
+            required: false,
+        }),
+        'document-id-after': Flags.string({
+            description: 'Current document',
+            exclusive: [
+                'data',
+                'file',
+                'document-id',
+                'data-before',
+                'data-after',
+                'file-before',
+                'file-after',
+            ],
+            required: false,
+        }),
         'with-user-token': Flags.boolean({
             description: 'Prime access token from CLI config',
             default: false,
         }),
     };
     async run() {
+        if (this.flags.event === 'update') {
+            const hasDataPair = this.flags['data-before'] && this.flags['data-after'];
+            const hasFilePair = this.flags['file-before'] && this.flags['file-before'];
+            const hasDocPair = this.flags['document-id-before'] && this.flags['document-id-after'];
+            if (!(hasDataPair || hasFilePair || hasDocPair)) {
+                this.error('When using --event=update, you must provide one of the following flag pairs:\n' +
+                    '  --data-before and --data-after\n' +
+                    '  --file-before and --file-after\n' +
+                    '  --document-id-before and --document-id-after');
+            }
+        }
         const { success, error } = await functionTestCore({
             bin: this.config.bin,
             log: (msg) => this.log(msg),

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

@@ -7,6 +7,7 @@ export interface FunctionTestOptions extends CoreConfig {
     };
     flags: {
         data?: string;
+        event?: string;
         file?: string;
         timeout?: number;
         api?: string;
@@ -14,6 +15,12 @@ export interface FunctionTestOptions extends CoreConfig {
         'project-id'?: string;
         'document-id'?: string;
         'with-user-token'?: boolean;
+        'data-before'?: string;
+        'data-after'?: string;
+        'file-before'?: string;
+        'file-after'?: string;
+        'document-id-before'?: string;
+        'document-id-after'?: string;
     };
 }
 export declare function functionTestCore(options: FunctionTestOptions): Promise<CoreResult>;

package/dist/cores/functions/test.js

@@ -1,18 +1,36 @@
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { cwd } from 'node:process';
 import ora from 'ora';
 import { testAction } from '../../actions/functions/test.js';
 import config from '../../config.js';
 import buildPayload from '../../utils/build-payload.js';
 import { findFunctionByName } from '../../utils/find-function.js';
 import { fetchDocument } from '../../utils/functions/fetch-document.js';
+import { parseJsonObject } from '../../utils/parse-json-object.js';
+import { isEventType, } from '../../utils/types.js';
 export async function functionTestCore(options) {
     const { blueprint, log, args, flags } = options;
     const { name: fnName } = args;
-    const { data, file, timeout, api, dataset, 'document-id': documentId, 'with-user-token': withUserToken, } = flags;
+    const { data, event, file, timeout, api, dataset, 'document-id': documentId, 'with-user-token': withUserToken, 'data-before': dataBefore, 'data-after': dataAfter, 'file-before': fileBefore, 'file-after': fileAfter, 'document-id-before': documentIdBefore, 'document-id-after': documentIdAfter, } = flags;
     let { 'project-id': projectId } = flags;
     const { parsedBlueprint } = blueprint;
     if (!projectId && blueprint?.projectId) {
         projectId = blueprint.projectId;
     }
+    let eventType;
+    if (!event) {
+        eventType = 'create';
+    }
+    else if (isEventType(event)) {
+        eventType = event;
+    }
+    else {
+        return {
+            success: false,
+            error: 'The event must be one of `create`, `update` or `delete`.',
+        };
+    }
     try {
         const resource = findFunctionByName(parsedBlueprint, fnName); // throws if not found
         const contextOptions = {
@@ -26,21 +44,59 @@ export async function functionTestCore(options) {
         if (withUserToken) {
             contextOptions.clientOptions.token = config.token || undefined;
         }
-        const payload = documentId
-            ? await fetchDocument(documentId, {
+        let before = null;
+        let after = null;
+        if (dataBefore && dataAfter) {
+            before = parseJsonObject(dataBefore);
+            after = parseJsonObject(dataAfter);
+        }
+        else if (fileBefore && fileAfter) {
+            let fileContents = readFileSync(join(cwd(), fileBefore), 'utf8');
+            before = parseJsonObject(fileContents);
+            fileContents = readFileSync(join(cwd(), fileAfter), 'utf8');
+            after = parseJsonObject(fileContents);
+        }
+        else if (documentIdBefore && documentIdAfter) {
+            before = await fetchDocument(documentIdBefore, {
+                projectId,
+                dataset,
+                apiVersion: api,
+                apiHost: config.apiUrl,
+                token: config.token || undefined,
+            });
+            after = await fetchDocument(documentIdAfter, {
                 projectId,
                 dataset,
                 apiVersion: api,
                 apiHost: config.apiUrl,
                 token: config.token || undefined,
-            })
-            : buildPayload({ data, file });
+            });
+        }
+        let payload;
+        if (after) {
+            payload = after;
+        }
+        else {
+            payload = documentId
+                ? await fetchDocument(documentId, {
+                    projectId,
+                    dataset,
+                    apiVersion: api,
+                    apiHost: config.apiUrl,
+                    token: config.token || undefined,
+                })
+                : buildPayload({ data, file });
+        }
         const invokeOptions = {
+            event: eventType,
             payload,
-            timeout: timeout ? timeout : resource.timeout,
+            before,
+            after,
         };
         const spinner = ora('Executing function...').start();
-        const { json, logs, error } = await testAction(resource, invokeOptions, contextOptions);
+        const { json, logs, error } = await testAction(resource, invokeOptions, contextOptions, {
+            timeout: timeout ? timeout : resource.timeout,
+        });
         if (error) {
             spinner.fail('Function execution failed.');
             return {

package/dist/server/app.d.ts

@@ -5,4 +5,4 @@ declare function parseDocumentUrl(url: string): {
     docId: string;
 } | null;
 declare function buildApiUrl(projectId: string, dataset: string, docId: string, apiUrl: string): string;
-export { app, parseDocumentUrl, buildApiUrl };
+export { app, buildApiUrl, parseDocumentUrl };

package/dist/server/app.js

@@ -7,6 +7,7 @@ import config from '../config.js';
 import { findFunctionByName } from '../utils/find-function.js';
 import invoke from '../utils/invoke-local.js';
 import { isRecord } from '../utils/is-record.js';
+import { isEventType } from '../utils/types.js';
 const host = 'localhost';
 const app = (port) => {
     const requestListener = async (req, res) => {
@@ -32,7 +33,7 @@ const app = (port) => {
                     req.on('end', async () => {
                         res.setHeader('Content-Type', 'application/json');
                         try {
-                            const { data, func: functionName } = parseInvokeRequest(Buffer.concat(body));
+                            const { data, func: functionName, metadata } = parseInvokeRequest(Buffer.concat(body));
                             const { context, event } = data;
                             // replace user token if required
                             if (context.clientOptions.token) {
@@ -45,7 +46,13 @@ const app = (port) => {
                             const { parsedBlueprint } = await readLocalBlueprint();
                             const resource = findFunctionByName(parsedBlueprint, functionName);
                             const readBlueprintTime = performance.now() - start;
-                            const response = await invoke(resource, event, context, { forceColor: false });
+                            const payload = {
+                                payload: event,
+                                ...metadata,
+                            };
+                            const response = await invoke(resource, payload, context, {
+                                forceColor: false,
+                            });
                             const timings = { ...response.timings, 'blueprint:read': readBlueprintTime };
                             const timingHeaders = [];
                             for (const [key, value] of Object.entries(timings)) {
@@ -207,7 +214,7 @@ function parseInvokeRequest(body) {
     if (!('data' in json)) {
         throw new Error('Request body is not valid, missing `data` field');
     }
-    const { data, func } = json;
+    const { data, func, metadata } = json;
     if (typeof func !== 'string') {
         throw new Error('Request body is not valid, `func` field is not a string');
     }
@@ -237,6 +244,29 @@ function parseInvokeRequest(body) {
     if (typeof apiVersion !== 'string' && typeof apiVersion !== 'undefined') {
         throw new Error('Request body is not valid, `context.clientOptions.apiVersion` field is not a string');
     }
+    if (!isRecord(metadata)) {
+        throw new Error('Request body is not valid, `metadata` field is not an object');
+    }
+    if (!('event' in metadata)) {
+        throw new Error('Request body is not valid, `metadata.event` field is missing');
+    }
+    const metadataEvent = metadata.event;
+    if (typeof metadataEvent !== 'string' || !isEventType(metadataEvent)) {
+        throw new Error('Request body is not valid, `metadata.event` field is not one of `create`, `update`, or `delete`');
+    }
+    if (!('before' in metadata)) {
+        throw new Error('Request body is not valid, `metadata.before` field is missing');
+    }
+    if (!('after' in metadata)) {
+        throw new Error('Request body is not valid, `metadata.after` field is missing');
+    }
+    const { before, after } = metadata;
+    if (!isRecord(before) && before !== null) {
+        throw new Error('Request body is not valid, `metadata.before` field is not an object');
+    }
+    if (!isRecord(after) && after !== null) {
+        throw new Error('Request body is not valid, `metadata.after` field is not an object');
+    }
     const clientOptions = {
         ...context.clientOptions,
         projectId,
@@ -244,6 +274,10 @@ function parseInvokeRequest(body) {
         // Prefer `undefined` over empty string, triggering the right warnings in the client
         apiVersion: apiVersion || undefined,
     };
-    return { func, data: { context: { ...context, clientOptions }, event } };
+    return {
+        func,
+        data: { context: { ...context, clientOptions }, event },
+        metadata: { event: metadataEvent, before, after },
+    };
 }
-export { app, parseDocumentUrl, buildApiUrl };
+export { app, buildApiUrl, parseDocumentUrl };

package/dist/server/static/api.d.ts

@@ -14,7 +14,11 @@ declare function document({ projectId, dataset, docId }: {
     dataset: any;
     docId: any;
 }): Promise<void>;
-declare function invoke(payloadText?: string): void;
+declare function invoke({ context, event, metadata }: {
+    context: any;
+    event: any;
+    metadata: any;
+}): void;
 declare function projects(): void;
 declare function datasets(selectedProject: any): void;
 export {};

package/dist/server/static/api.js

@@ -1,8 +1,11 @@
 /* eslint-disable n/no-unsupported-features/node-builtins */
 import {Store} from './vendor/vendor.bundle.js'
 
+// list of events to simulate
+const events = ['create', 'update', 'delete'].map((e) => ({name: e}))
+
 // eslint-disable-next-line new-cap
-const store = Store()
+const store = Store({events, selectedEvent: events[0].name})
 
 export default function API() {
   return {
@@ -17,12 +20,13 @@ export default function API() {
   }
 }
 
-function invoke(payloadText = '{}') {
+function invoke({context, event, metadata}) {
   store.inprogress = true
   const start = Date.now()
   const payload = {
-    data: payloadText,
+    data: {context, event},
     func: store.selectedIndex,
+    metadata,
   }
   fetch('/invoke', {
     body: JSON.stringify(payload),

package/dist/server/static/components/api-base.d.ts

@@ -6,7 +6,11 @@ export class ApiBaseElement extends HTMLElement {
             dataset: any;
             docId: any;
         }) => Promise<void>;
-        invoke: (payloadText?: string) => void;
+        invoke: ({ context, event, metadata }: {
+            context: any;
+            event: any;
+            metadata: any;
+        }) => void;
         projects: () => void;
         datasets: (selectedProject: any) => void;
         store: any;

package/dist/server/static/components/filters.js

@@ -20,6 +20,13 @@ class FiltersComponent extends HTMLElement {
               label-prop="name"
               subscribe-to="selectedProject"
             ></select-dropdown>
+            <select-dropdown
+              label="Event"
+              store-key="events"
+              selected-key="selectedEvent"
+              value-prop="name"
+              label-prop="name"
+            ></select-dropdown>
             <fieldset class="mar-t-sm">
                 <label class="slab-text">
                   <span style="display: block; margin-bottom: var(--space-1);">API Version</span>

package/dist/server/static/components/payload-panel.js

@@ -4,40 +4,82 @@ import {basicSetup, EditorView, json} from '../vendor/vendor.bundle.js'
 import {ApiBaseElement} from './api-base.js'
 import {sanityCodeMirrorTheme} from './codemirror-theme.js'
 
-const template = `<div class="gutter-gradient relative h-100 max-h-100 y-scroll border-top border-top-none-l">
-    <div class="bg gutter-gradient sticky top-0 right-0 left-0 z-100">
-      <div class="flex items-center space-between" style="padding: 8px 20px 8px 48px;">
+function template({selectedEvent}) {
+  const singleModeStyle = selectedEvent === 'update' ? ' style="display: none;"' : ''
+  const deltaModeStyle = selectedEvent !== 'update' ? '' : ' style="display: none;"'
+  return `<div id="payloadContainer" class="gutter-gradient relative h-100 max-h-100 y-scroll border-top border-top-none-l"${singleModeStyle}>
+  <div class="bg gutter-gradient sticky top-0 right-0 left-0 z-100">
+    <div class="flex items-center space-between" style="padding: 8px 20px 8px 48px;">
       <h2 class="config-label mar-t-0 mar-b-0">Document</h2>
+    </div>
+    <hr class='hr-border' style='margin-left: 31px; ' />
+  </div>
+  <div id="payload" name="payload" class='max-h-100 min-h-0'></div>
+</div>
+<div id="deltaPayloadContainer" class="gutter-gradient relative h-100 max-h-100 y-scroll border-top border-top-none-l"${deltaModeStyle}>
+  <div class="bg gutter-gradient sticky top-0 right-0 left-0 z-100">
+    <div class="flex items-center space-between" style="padding: 8px 20px 8px 48px;">
+      <h2 class="config-label mar-t-0 mar-b-0">Before Document</h2>
+    </div>
+    <hr class='hr-border' style='margin-left: 31px; ' />
   </div>
+  <div id="beforePayload" name="beforePayload" class='max-h-50 min-h-0'></div>
+  <div class="bg gutter-gradient sticky top-0 right-0 left-0 z-100">
     <hr class='hr-border' style='margin-left: 31px; ' />
+    <div class="flex items-center space-between" style="padding: 8px 20px 8px 48px;">
+      <h2 class="config-label mar-t-0 mar-b-0">After Document</h2>
     </div>
-    <div id="payload" name="payload" class='max-h-100 min-h-0'></div>
+    <hr class='hr-border' style='margin-left: 31px; ' />
+  </div>
+  <div id="afterPayload" name="afterPayload" class='max-h-50 min-h-0'></div>
 </div>
 `
+}
+
 class PayloadPanel extends ApiBaseElement {
   updatePayload = ({document}) => {
     if (!document) return
 
-    const transaction = this.api.store.payload.state.update({
+    this.#updateCodeView(this.api.store.payload, document)
+    this.#updateCodeView(this.api.store.beforePayload, document)
+    this.#updateCodeView(this.api.store.afterPayload, document)
+  }
+  #updateCodeView = (view, document) => {
+    const transaction = view.state.update({
       changes: {
         from: 0,
         insert: JSON.stringify(document, null, 2),
-        to: this.api.store.payload.state.doc.length,
+        to: view.state.doc.length,
       },
     })
-    this.api.store.payload.dispatch(transaction)
+    view.dispatch(transaction)
   }
-  connectedCallback() {
-    this.innerHTML = template
-    this.payload = this.querySelector('#payload')
+  updateSelectedEvent = ({selectedEvent}) => {
+    console.log('updateSelectedEvent', selectedEvent)
+
+    const payloadContainer = this.querySelector('#payloadContainer')
+    const deltaPayloadContainer = this.querySelector('#deltaPayloadContainer')
 
-    this.api.store.payload = new EditorView({
-      doc: '\n\n\n\n',
-      extensions: [basicSetup, json(), sanityCodeMirrorTheme],
-      parent: this.payload,
+    const isUpdateEvent = selectedEvent === 'update'
+    payloadContainer.style.display = isUpdateEvent ? 'none' : 'block'
+    deltaPayloadContainer.style.display = isUpdateEvent ? 'block' : 'none'
+  }
+  connectedCallback() {
+    this.innerHTML = template({
+      selectedEvent: this.api.store.selectedEvent,
     })
 
+    const beforePayloadElem = this.querySelector('#beforePayload')
+    const afterPayloadElem = this.querySelector('#afterPayload')
+
+    this.api.store.beforePayload = attachEditorView(beforePayloadElem)
+    this.api.store.afterPayload = attachEditorView(afterPayloadElem)
+
+    const payloadElem = this.querySelector('#payload')
+    this.api.store.payload = attachEditorView(payloadElem)
+
     this.api.subscribe(this.updatePayload, ['document'])
+    this.api.subscribe(this.updateSelectedEvent, ['selectedEvent'])
   }
   disconnectedCallback() {
     if (this.api) {
@@ -46,4 +88,12 @@ class PayloadPanel extends ApiBaseElement {
   }
 }
 
+function attachEditorView(parent) {
+  return new EditorView({
+    doc: '\n\n\n\n',
+    extensions: [basicSetup, json(), sanityCodeMirrorTheme],
+    parent,
+  })
+}
+
 customElements.define('payload-panel', PayloadPanel)

package/dist/server/static/components/rule-panel.js

@@ -5,7 +5,7 @@ import {basicSetup, EditorState, EditorView, json} from '../vendor/vendor.bundle
 import {ApiBaseElement} from './api-base.js'
 import {sanityCodeMirrorTheme} from './codemirror-theme.js'
 
-const template = `<div style='overflow-y:scroll; min-height: 0;'>
+const template = `<div class="border-left" style='overflow-y:scroll; min-height: 0;'>
   <div>
     <h3 class="config-label" style='display: none; margin-top: 0;'>Filter/Projection</h3>
     <header class='flex space-between'>

package/dist/server/static/components/run-panel.js

@@ -2,7 +2,7 @@
 import {ApiBaseElement} from './api-base.js'
 
 const runTemplate = `<svg data-sanity-icon="play" width="1em" height="1em" viewBox="0 0 25 25" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.5 18.5V6.5L17.5 12.5L7.5 18.5Z" fill="currentColor" stroke="currentColor" stroke-width="1.2" stroke-linejoin="round"></path></svg>
-<span>Run</span>`
+<span title="Type CTRL + Enter to Run">Run</span>`
 
 const template = `<div style="padding: var(--space-3);">
     <button ord="primary" class="sanity-button">
@@ -14,9 +14,29 @@ const template = `<div style="padding: var(--space-3);">
 `
 class RunPanel extends ApiBaseElement {
   invoke = () => {
+    const selectedEvent = this.api.store.selectedEvent
     this.api.store.result = {logs: '', time: 0}
-    const payloadText = this.createPayloadText(this.api.store.payload.state.doc)
-    const event = JSON.parse(payloadText)
+    let event = {}
+    let before = null
+    let after = null
+    if (selectedEvent === 'update') {
+      const beforePayloadText = this.createPayloadText(this.api.store.beforePayload.state.doc)
+      before = JSON.parse(beforePayloadText)
+
+      const afterPayloadText = this.createPayloadText(this.api.store.afterPayload.state.doc)
+      after = JSON.parse(afterPayloadText)
+
+      event = after
+    } else {
+      const payloadText = this.createPayloadText(this.api.store.payload.state.doc)
+      event = JSON.parse(payloadText)
+
+      if (selectedEvent === 'create') {
+        after = event
+      } else if (selectedEvent === 'delete') {
+        before = event
+      }
+    }
     const context = {
       clientOptions: {
         apiVersion: this.apiVersion.value,
@@ -25,7 +45,12 @@ class RunPanel extends ApiBaseElement {
         token: this.api.store.withToken,
       },
     }
-    this.api.invoke({context, event})
+    const metadata = {
+      event: selectedEvent,
+      before,
+      after,
+    }
+    this.api.invoke({context, event, metadata})
   }
   createPayloadText = (doc) => {
     if (doc.text) {

package/dist/server/static/components/select-dropdown.js

@@ -74,10 +74,10 @@ class SelectDropdown extends ApiBaseElement {
     if (this.hasAttribute('trigger-fetch')) {
       // e.g. this.api.projects()
       this.api[this.storeKey]?.()
-    }
-
-    if (this.subscribeTo) {
+    } else if (this.subscribeTo) {
       this.api.subscribe(this.refreshOnChange, [this.subscribeTo])
+    } else {
+      this.renderOptions()
     }
   }
 

package/dist/utils/functions/fetch-document.d.ts

@@ -1,2 +1,2 @@
 import { type ClientConfig } from '@sanity/client';
-export declare function fetchDocument(documentId: string, { projectId, dataset, useCdn, apiVersion, apiHost, token }: ClientConfig): Promise<Record<string, unknown> | undefined>;
+export declare function fetchDocument(documentId: string, { projectId, dataset, useCdn, apiVersion, apiHost, token }: ClientConfig): Promise<Record<string, unknown>>;

package/dist/utils/functions/fetch-document.js

@@ -5,5 +5,8 @@ export async function fetchDocument(documentId, { projectId, dataset, useCdn = t
     const client = createClient({ projectId, dataset, useCdn, apiVersion, apiHost, token });
     const data = await client.fetch(`*[_id == "${documentId}"]`);
     spinner.stop();
-    return data[0] ? data[0] : undefined;
+    if (!data[0]) {
+        throw Error(`Could not fetch document ID ${documentId}`);
+    }
+    return data[0];
 }

package/dist/utils/invoke-local.d.ts

@@ -1,4 +1,4 @@
-import type { FunctionResource, GroqRule, InvocationResponse, InvokeContextOptions, InvokeExecutionOptions } from './types.js';
+import type { FunctionResource, GroqRule, InvocationResponse, InvokeContextOptions, InvokeExecutionOptions, InvokePayloadOptions } from './types.js';
 export declare function sanitizeLogs(logs: string): string;
 export declare const DEFAULT_GROQ_RULE: {
     on: string[];
@@ -6,5 +6,5 @@ export declare const DEFAULT_GROQ_RULE: {
     projection: string;
 };
 export declare function isDefaultGROQRule(rule: GroqRule | undefined): boolean;
-export declare function applyGroqRule(resource: FunctionResource, data: Record<string, unknown> | null): Promise<any>;
-export default function invoke(resource: FunctionResource, data: Record<string, unknown> | null, context: InvokeContextOptions, options: InvokeExecutionOptions): Promise<InvocationResponse>;
+export declare function applyGroqRule(resource: FunctionResource, data: Record<string, unknown> | null, before: Record<string, unknown> | null, after: Record<string, unknown> | null, projectId: string | undefined, dataset: string | undefined): Promise<any>;
+export default function invoke(resource: FunctionResource, payload: InvokePayloadOptions, context: InvokeContextOptions, options: InvokeExecutionOptions): Promise<InvocationResponse>;

package/dist/utils/invoke-local.js

@@ -34,7 +34,7 @@ function getEvent(rule) {
         projection: rule.projection || DEFAULT_GROQ_RULE.projection,
     };
 }
-export async function applyGroqRule(resource, data) {
+export async function applyGroqRule(resource, data, before, after, projectId, dataset) {
     // If there is no rule set return everything
     if (!resource.event)
         return data;
@@ -45,28 +45,30 @@ export async function applyGroqRule(resource, data) {
         const hasProjection = event.projection?.length;
         const projection = hasProjection ? `${event?.projection}` : '';
         const query = `*[${event?.filter}]${projection}`;
-        try {
-            const rule = groq.parse(query);
-            const queryResults = await groq.evaluate(rule, { dataset: [data] });
-            const currentFunctionDocumentSet = await queryResults.get();
-            // TODO can this be multiple documents?
-            return currentFunctionDocumentSet[0] || {};
-        }
-        catch {
-            // parsing/validating the groq rule we do up front as part of functions HTTP API
-            // so this likely would be triggered by evaluating the query, if anything
-            throw Error('⚠️ failed parsing/evaluating GROQ rule! Skipping invoke.');
-        }
+        const rule = groq.parse(query, { mode: 'delta' });
+        const sanity = projectId && dataset ? { projectId, dataset } : undefined;
+        const queryResults = await groq.evaluate(rule, { dataset: [data], before, after, sanity });
+        const currentFunctionDocumentSet = await queryResults.get();
+        return currentFunctionDocumentSet[0];
     }
     // default groq rule so just return the data
     return data;
 }
-export default async function invoke(resource, data, context, options) {
+export default async function invoke(resource, payload, context, options) {
     if (!resource.src) {
         throw new Error(`Function resource "${resource.name}" is missing the 'src' property.`);
     }
+    const { before, after, payload: data = null } = payload;
     const { forceColor = true, timeout = 10 } = options;
-    const filteredData = await applyGroqRule(resource, data);
+    const { projectId, dataset } = context.clientOptions;
+    const filteredData = await applyGroqRule(resource, data, before, after, projectId, dataset);
+    if (typeof filteredData === 'undefined') {
+        return {
+            logs: `⚠️ Filter "${resource.event?.filter}" returned an empty result. Skipping invoke.`,
+            error: undefined,
+            json: undefined,
+        };
+    }
     let cleanupBundle = async () => { };
     let functionPath = '';
     let bundleTimings;

package/dist/utils/types.d.ts

@@ -79,8 +79,12 @@ export interface BuildPayloadOptions {
 /** @internal */
 export interface InvokePayloadOptions {
     payload?: Record<string, unknown>;
-    timeout?: number;
+    event: EventType;
+    before: Record<string, unknown> | null;
+    after: Record<string, unknown> | null;
 }
+export type EventType = 'create' | 'update' | 'delete';
+export declare function isEventType(arg: string): arg is EventType;
 /** @internal */
 export interface InvokeContextOptions {
     clientOptions: {

package/dist/utils/types.js

@@ -1,6 +1,9 @@
 export function isLocalFunctionResource(r) {
     return r.type.startsWith('sanity.function.');
 }
+export function isEventType(arg) {
+    return ['create', 'update', 'delete'].includes(arg);
+}
 /** @internal */
 export var BlueprintParserErrorType;
 (function (BlueprintParserErrorType) {

package/oclif.manifest.json

@@ -712,6 +712,54 @@
           "multiple": false,
           "type": "option"
         },
+        "data-before": {
+          "description": "Original document",
+          "exclusive": [
+            "data",
+            "file",
+            "document-id",
+            "file-before",
+            "file-after",
+            "document-id-before",
+            "document-id-after"
+          ],
+          "name": "data-before",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "data-after": {
+          "description": "Current document",
+          "exclusive": [
+            "data",
+            "file",
+            "document-id",
+            "file-before",
+            "file-after",
+            "document-id-before",
+            "document-id-after"
+          ],
+          "name": "data-after",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "event": {
+          "char": "e",
+          "description": "Type of event (create, update, delete)",
+          "name": "event",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "create",
+            "update",
+            "delete"
+          ],
+          "type": "option"
+        },
         "file": {
           "char": "f",
           "description": "Read data from file and send to the function",
@@ -725,6 +773,40 @@
           "multiple": false,
           "type": "option"
         },
+        "file-before": {
+          "description": "Original document",
+          "exclusive": [
+            "data",
+            "file",
+            "document-id",
+            "data-before",
+            "data-after",
+            "document-id-before",
+            "document-id-after"
+          ],
+          "name": "file-before",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "file-after": {
+          "description": "Current document",
+          "exclusive": [
+            "data",
+            "file",
+            "document-id",
+            "data-before",
+            "data-after",
+            "document-id-before",
+            "document-id-after"
+          ],
+          "name": "file-after",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "timeout": {
           "char": "t",
           "description": "Execution timeout value in seconds",
@@ -779,6 +861,40 @@
           "multiple": false,
           "type": "option"
         },
+        "document-id-before": {
+          "description": "Original document",
+          "exclusive": [
+            "data",
+            "file",
+            "document-id",
+            "data-before",
+            "data-after",
+            "file-before",
+            "file-after"
+          ],
+          "name": "document-id-before",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "document-id-after": {
+          "description": "Current document",
+          "exclusive": [
+            "data",
+            "file",
+            "document-id",
+            "data-before",
+            "data-after",
+            "file-before",
+            "file-after"
+          ],
+          "name": "document-id-after",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "with-user-token": {
           "description": "Prime access token from CLI config",
           "name": "with-user-token",
@@ -907,5 +1023,5 @@
       ]
     }
   },
-  "version": "10.5.1"
+  "version": "10.6.1"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "10.5.1",
+  "version": "10.6.1",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -89,7 +89,7 @@
     "eventsource": "^4.0.0",
     "find-up": "^7.0.0",
     "get-folder-size": "^5.0.0",
-    "groq-js": "^1.17.3",
+    "groq-js": "^1.18.0",
     "inquirer": "^12.9.2",
     "jiti": "^2.5.1",
     "mime-types": "^3.0.1",