@sanity/runtime-cli 10.1.4 → 10.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/10.1.4 linux-x64 node-v22.18.0
+@sanity/runtime-cli/10.2.0 linux-x64 node-v22.18.0
 $ sanity-run --help [COMMAND]
 USAGE
   $ sanity-run COMMAND
@@ -52,8 +52,9 @@ Add a Resource to a Blueprint
 
 ```
 USAGE
-  $ sanity-run blueprints add TYPE [--example <value> | -n <value> | --fn-type document-publish | --fn-language
-    ts|js | --javascript | --fn-helpers | --fn-installer skip|npm|pnpm|yarn] [-i | ]
+  $ sanity-run blueprints add TYPE [--example <value> | -n <value> | --fn-type
+    document-publish|document-create|document-delete|document-update | --fn-language ts|js | --javascript | --fn-helpers
+    | --fn-installer skip|npm|pnpm|yarn] [-i | ]
 
 ARGUMENTS
   TYPE  (function) Type of Resource to add (e.g. function)
@@ -68,7 +69,7 @@ FLAGS
       --fn-language=<option>   [default: ts] Language of the new Function
                                <options: ts|js>
       --fn-type=<option>       Type of new Function
-                               <options: document-publish>
+                               <options: document-publish|document-create|document-delete|document-update>
       --javascript             Use JavaScript instead of TypeScript
 
 DESCRIPTION
@@ -83,10 +84,10 @@ EXAMPLES
 
   $ sanity-run blueprints add function --name my-function --fn-type document-publish
 
-  $ sanity-run blueprints add function --name my-function --fn-type document-publish --lang js
+  $ sanity-run blueprints add function --name my-function --fn-type document-update --lang js
 ```
 
-_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v10.1.4/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -117,7 +118,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.1.4/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -139,7 +140,7 @@ EXAMPLES
   $ sanity-run blueprints deploy --no-wait
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v10.1.4/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -164,7 +165,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.1.4/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -186,7 +187,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.1.4/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init [DIR]`
 
@@ -224,7 +225,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.1.4/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -246,7 +247,7 @@ EXAMPLES
   $ sanity-run blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v10.1.4/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -263,7 +264,7 @@ EXAMPLES
   $ sanity-run blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v10.1.4/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run blueprints stacks`
 
@@ -285,7 +286,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.1.4/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions dev`
 
@@ -305,7 +306,7 @@ EXAMPLES
   $ sanity-run functions dev --port 8974
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v10.1.4/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -327,7 +328,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.1.4/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env list NAME`
 
@@ -347,7 +348,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.1.4/src/commands/functions/env/list.ts)_
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -368,7 +369,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.1.4/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions logs NAME`
 
@@ -402,7 +403,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v10.1.4/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test NAME`
 
@@ -437,7 +438,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.1.4/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v10.2.0/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

package/dist/commands/blueprints/add.js

@@ -8,7 +8,7 @@ export default class AddCommand extends BlueprintCommand {
         '<%= config.bin %> <%= command.id %> function --helpers',
         '<%= config.bin %> <%= command.id %> function --name my-function',
         '<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-publish',
-        '<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-publish --lang js',
+        '<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-update --lang js',
     ];
     static args = {
         type: Args.string({
@@ -29,7 +29,7 @@ export default class AddCommand extends BlueprintCommand {
         }),
         'fn-type': Flags.string({
             description: 'Type of new Function',
-            options: ['document-publish' /*, 'document-create', 'document-delete'*/],
+            options: ['document-publish', 'document-create', 'document-delete', 'document-update'],
             aliases: ['function-type'],
             dependsOn: ['name'],
         }),

package/dist/cores/blueprints/add.js

@@ -8,11 +8,11 @@ import { createFunctionResource } from '../../actions/blueprints/resources.js';
 import { verifyExampleExists, writeExample } from '../../actions/sanity/examples.js';
 import { check, indent, warn } from '../../utils/display/presenters.js';
 import { validateFunctionName } from '../../utils/validate/resource.js';
-const FUNCTION_BLUEPRINT_RESOURCE_TEMPLATE = `
+const generateFunctionBlueprintResourceTemplate = (fnName, eventName) => `
   export default defineBlueprint({
     resources: [
       // ...
-      defineDocumentFunction({name: '{{fnName}}'}), // ← add this line
+      defineDocumentFunction({name: '${fnName}', event: {on: ['${eventName}']}}), // ← add this line
     ],
   })
 `;
@@ -116,8 +116,8 @@ export async function blueprintAddCore(options) {
         }
         const fnType = flagFnType || (await promptForFunctionType());
         const fnLang = flagFnLang || (await promptForFunctionLang());
-        if (!['document-publish', 'document-create', 'document-delete'].includes(fnType)) {
-            throw new Error('Invalid function type. Must be one of: document-publish, document-create, document-delete');
+        if (!['document-publish', 'document-create', 'document-delete', 'document-update'].includes(fnType)) {
+            throw new Error('Invalid function type. Must be one of: document-publish, document-create, document-delete, document-update');
         }
         let addHelpers;
         let installCommand;
@@ -163,7 +163,7 @@ export async function blueprintAddCore(options) {
                 case '.ts':
                 case '.js':
                 case '.mjs': {
-                    log(highlight(FUNCTION_BLUEPRINT_RESOURCE_TEMPLATE.replace('{{fnName}}', fnName)));
+                    log(highlight(generateFunctionBlueprintResourceTemplate(fnName, fnType.split('-')[1])));
                     break;
                 }
                 default:
@@ -205,8 +205,9 @@ async function promptForFunctionType() {
             message: 'Choose function type:',
             choices: [
                 { name: 'Document Publish', value: 'document-publish' },
-                { name: 'Document Create', value: 'document-create', disabled: '(Coming soon)' },
-                { name: 'Document Delete', value: 'document-delete', disabled: '(Coming soon)' },
+                { name: 'Document Create', value: 'document-create' },
+                { name: 'Document Delete', value: 'document-delete' },
+                { name: 'Document Update', value: 'document-update' },
             ],
             default: 'document-publish',
         },

package/dist/utils/types.d.ts

@@ -15,6 +15,8 @@ export interface AuthParams {
 export interface GroqRule {
     on: Array<string>;
     filter?: string;
+    includeDrafts?: boolean;
+    includeAllVersions?: boolean;
     projection?: string;
 }
 /** @internal */

package/dist/utils/validate/resource.js

@@ -3,6 +3,7 @@ export function validateFunctionName(name) {
     // must be 6+ characters, no special characters, no spaces, allow _ and -
     return /^[a-zA-Z0-9][a-zA-Z0-9_-]{5,}$/.test(name);
 }
+const validFunctionEventNames = ['publish', 'create', 'update', 'delete'];
 export function validateFunctionResource(resource) {
     const { name: fnName } = resource;
     const msgPrefix = `Function "${fnName}":`;
@@ -25,9 +26,9 @@ export function validateFunctionResource(resource) {
             type: BlueprintParserErrorType.MissingRequiredProperty,
         });
     }
-    else if (resource.event.on[0] !== 'publish') {
+    else if (!resource.event.on.every((evt) => validFunctionEventNames.includes(evt))) {
         errors.push({
-            message: `${msgPrefix} First event.on value must be "publish"`,
+            message: `${msgPrefix} event.on values must be one of ${validFunctionEventNames.map((e) => `"${e}"`).join(', ')}`,
             type: BlueprintParserErrorType.InvalidValue,
         });
     }
@@ -43,6 +44,19 @@ export function validateFunctionResource(resource) {
             type: BlueprintParserErrorType.InvalidType,
         });
     }
+    if (resource.event?.includeDrafts && typeof resource.event.includeDrafts !== 'boolean') {
+        errors.push({
+            message: `${msgPrefix} event.includeDrafts must be a boolean`,
+            type: BlueprintParserErrorType.InvalidType,
+        });
+    }
+    if (resource.event?.includeAllVersions &&
+        typeof resource.event.includeAllVersions !== 'boolean') {
+        errors.push({
+            message: `${msgPrefix} event.includeAllVersions must be a boolean`,
+            type: BlueprintParserErrorType.InvalidType,
+        });
+    }
     if (resource.memory !== undefined) {
         if (!Number.isInteger(resource.memory)) {
             errors.push({

package/oclif.manifest.json

@@ -18,7 +18,7 @@
         "<%= config.bin %> <%= command.id %> function --helpers",
         "<%= config.bin %> <%= command.id %> function --name my-function",
         "<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-publish",
-        "<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-publish --lang js"
+        "<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-update --lang js"
       ],
       "flags": {
         "example": {
@@ -59,7 +59,10 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "options": [
-            "document-publish"
+            "document-publish",
+            "document-create",
+            "document-delete",
+            "document-update"
           ],
           "type": "option"
         },
@@ -901,5 +904,5 @@
       ]
     }
   },
-  "version": "10.1.4"
+  "version": "10.2.0"
 }

package/package.json

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