@sanity/runtime-cli 17.5.0 → 17.6.0

package/README.md

@@ -45,7 +45,7 @@ All `sanity-run` commands can also be run as `sanity <command>` when `@sanity/cl
 USAGE
   $ sanity-run blueprints add TYPE [--json] [--example <value> | -n <value> | --fn-type
     document-publish|document-create|document-delete|document-update|media-library-asset-create|media-library-asset-dele
-    te|media-library-asset-update|scheduled-function|sync-tag-invalidate... | --language ts|js | --javascript |
+    te|media-library-asset-update|pub-sub|scheduled-function|sync-tag-invalidate... | --language ts|js | --javascript |
     --fn-helpers | --fn-installer skip|npm|pnpm|yarn] [-i | ]
 
 ARGUMENTS
@@ -62,8 +62,8 @@ FLAGS
       --fn-type=<option>...    Document change event(s) that should trigger the function; you can specify multiple
                                events by specifying this flag multiple times
                                <options: document-publish|document-create|document-delete|document-update|media-library-
-                               asset-create|media-library-asset-delete|media-library-asset-update|scheduled-function|syn
-                               c-tag-invalidate>
+                               asset-create|media-library-asset-delete|media-library-asset-update|pub-sub|scheduled-func
+                               tion|sync-tag-invalidate>
       --javascript             Use JavaScript instead of TypeScript
       --json                   Format output as json
       --language=<option>      [default: ts] Language of the new function
@@ -90,7 +90,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/v17.5.0/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -127,7 +127,7 @@ EXAMPLES
   $ sanity-run blueprints config --edit --project-id <projectId> --stack <name-or-id>
 ```
 
-_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -183,7 +183,7 @@ EXAMPLES
   $ sanity-run blueprints deploy --new-stack-name <new-name>
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -221,7 +221,7 @@ EXAMPLES
   $ sanity-run blueprints destroy --stack <name-or-id> --project-id <projectId> --force --no-wait
 ```
 
-_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints doctor`
 
@@ -253,7 +253,7 @@ EXAMPLES
   $ sanity-run blueprints doctor --fix
 ```
 
-_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/blueprints/doctor.ts)_
+_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/doctor.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -291,7 +291,7 @@ EXAMPLES
   $ sanity-run blueprints info --organization-id <orgId> --stack <name-or-id>
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init [DIR]`
 
@@ -355,7 +355,7 @@ EXAMPLES
   $ sanity-run blueprints init old-stack --type <json|js|ts> --project-id <projectId> --stack-id <existingStackId>
 ```
 
-_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -401,7 +401,7 @@ EXAMPLES
   $ sanity-run blueprints logs --before 2026-05-01T00:00:00Z
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints mint-deploy-token`
 
@@ -446,7 +446,7 @@ EXAMPLES
   $ sanity-run blueprints mint-deploy-token --organization-id <orgId>
 ```
 
-_See code: [src/commands/blueprints/mint-deploy-token.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/blueprints/mint-deploy-token.ts)_
+_See code: [src/commands/blueprints/mint-deploy-token.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/mint-deploy-token.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -479,7 +479,7 @@ EXAMPLES
   $ sanity-run blueprints plan --organization-id <orgId> --stack <name-or-id>
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run blueprints promote`
 
@@ -515,7 +515,7 @@ EXAMPLES
   $ sanity-run blueprints promote --new-stack-name <new-name>
 ```
 
-_See code: [src/commands/blueprints/promote.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/blueprints/promote.ts)_
+_See code: [src/commands/blueprints/promote.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/promote.ts)_
 
 ## `sanity-run blueprints stacks`
 
@@ -551,7 +551,7 @@ EXAMPLES
   $ sanity-run blueprints stacks --organization-id <organizationId> --include-projects
 ```
 
-_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions add`
 
@@ -561,7 +561,7 @@ Add a Function to your Blueprint
 USAGE
   $ sanity-run functions add [--json] [--example <value> | -n <value> | --type
     document-publish|document-create|document-delete|document-update|media-library-asset-create|media-library-asset-dele
-    te|media-library-asset-update|scheduled-function|sync-tag-invalidate... | --language ts|js | --javascript |
+    te|media-library-asset-update|pub-sub|scheduled-function|sync-tag-invalidate... | --language ts|js | --javascript |
     --helpers | --installer skip|npm|pnpm|yarn | -i]
 
 FLAGS
@@ -578,8 +578,8 @@ FLAGS
       --type=<option>...    Document change event(s) that should trigger the function; you can specify multiple events
                             by specifying this flag multiple times
                             <options: document-publish|document-create|document-delete|document-update|media-library-ass
-                            et-create|media-library-asset-delete|media-library-asset-update|scheduled-function|sync-tag-
-                            invalidate>
+                            et-create|media-library-asset-delete|media-library-asset-update|pub-sub|scheduled-function|s
+                            ync-tag-invalidate>
 
 DESCRIPTION
   Add a Function to your Blueprint
@@ -603,7 +603,7 @@ EXAMPLES
   $ sanity-run functions add --name my-function --type document-create --type document-update --lang js
 ```
 
-_See code: [src/commands/functions/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/functions/add.ts)_
+_See code: [src/commands/functions/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/add.ts)_
 
 ## `sanity-run functions dev`
 
@@ -638,7 +638,7 @@ EXAMPLES
   $ sanity-run functions dev --timeout 60
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -671,7 +671,7 @@ EXAMPLES
   $ sanity-run functions env add --stack <name-or-id> MyFunction API_URL https://api.example.com/
 ```
 
-_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env list NAME`
 
@@ -701,7 +701,7 @@ EXAMPLES
   $ sanity-run functions env list --stack <name-or-id> MyFunction
 ```
 
-_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/functions/env/list.ts)_
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -733,7 +733,7 @@ EXAMPLES
   $ sanity-run functions env remove --stack <name-or-id> MyFunction API_URL
 ```
 
-_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions logs [NAME]`
 
@@ -773,7 +773,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v17.5.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test [NAME]`
 
@@ -830,7 +830,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/v17.5.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

package/dist/actions/blueprints/blueprint.js

@@ -5,7 +5,7 @@ import { pathToFileURL } from 'node:url';
 import blueprintParserValidator from '@sanity/blueprints-parser';
 import * as find from 'empathic/find';
 import { createJiti } from 'jiti';
-import { SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_SCHEDULED, } from '../../constants.js';
+import { SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_DURABLE, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_SCHEDULED, } from '../../constants.js';
 import { validateResources } from '../../utils/blueprints/validate-resources.js';
 import { backfillProjectBasedStackId, readConfigFile, } from './config.js';
 import { resolveIds } from './resolve.js';
@@ -122,6 +122,7 @@ export function parseBlueprintContent(rawBlueprint, options) {
             SANITY_FUNCTION_DOCUMENT,
             SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
             SANITY_FUNCTION_SCHEDULED,
+            SANITY_FUNCTION_DURABLE,
         ],
     });
     const parsedBlueprint = parserResult.result === 'valid' ? parserResult.blueprint : undefined;

package/dist/actions/blueprints/resources.js

@@ -2,7 +2,7 @@ import { spawn } from 'node:child_process';
 import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
 import { dirname, join } from 'node:path';
 import { cwd } from 'node:process';
-import { MAP_EVENT_TO_FUNCTION_TYPE, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_SCHEDULED, SANITY_FUNCTION_SYNC_TAG_INVALIDATE, } from '../../constants.js';
+import { MAP_EVENT_TO_FUNCTION_TYPE, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_PUBSUB, SANITY_FUNCTION_SCHEDULED, SANITY_FUNCTION_SYNC_TAG_INVALIDATE, } from '../../constants.js';
 import { styleText } from '../../utils/style-text.js';
 import { writeOrUpdateNodeDependency } from '../node.js';
 import { addResourceToBlueprint } from './blueprint.js';
@@ -36,6 +36,12 @@ export const handler = syncTagInvalidateEventHandler(async ({ context, event, do
     console.error('Error invoking Sanity invalidation done endpoint!', e)
   }
 })`;
+const DEFAULT_PUBSUB_HELPER_FUNCTION_TEMPLATE = /*ts*/ `import { pubSubEventHandler } from '@sanity/functions'
+
+export const handler = pubSubEventHandler(async ({ context, event }) => {
+  const time = new Date().toLocaleTimeString()
+  console.log(\`Your pubsub Sanity Function was called at \${time}\`)
+})`;
 /**
  * Creates a new function resource file and adds it to the blueprint
  */
@@ -68,6 +74,9 @@ export async function createFunctionResource(options, logger) {
     let template = DEFAULT_FUNCTION_TEMPLATE;
     if (addHelpers) {
         switch (functionType) {
+            case SANITY_FUNCTION_PUBSUB:
+                template = DEFAULT_PUBSUB_HELPER_FUNCTION_TEMPLATE;
+                break;
             case SANITY_FUNCTION_SCHEDULED:
                 template = DEFAULT_SCHEDULED_HELPER_FUNCTION_TEMPLATE;
                 break;
@@ -119,6 +128,13 @@ export async function createFunctionResource(options, logger) {
                 },
             };
             break;
+        case SANITY_FUNCTION_PUBSUB:
+            resourceJson = {
+                name,
+                src: `functions/${name}`,
+                type: SANITY_FUNCTION_PUBSUB,
+            };
+            break;
         case SANITY_FUNCTION_SCHEDULED:
             resourceJson = {
                 name,

package/dist/constants.d.ts

@@ -3,8 +3,10 @@ export declare const SANITY_ACCESS_ROBOT = "sanity.access.robot";
 export declare const SANITY_FUNCTION_PREFIX = "sanity.function.";
 export declare const SANITY_FUNCTION_DOCUMENT = "sanity.function.document";
 export declare const SANITY_FUNCTION_MEDIA_LIBRARY_ASSET = "sanity.function.media-library.asset";
+export declare const SANITY_FUNCTION_PUBSUB = "sanity.function.pubsub";
 export declare const SANITY_FUNCTION_SCHEDULED = "sanity.function.cron";
 export declare const SANITY_FUNCTION_SYNC_TAG_INVALIDATE = "sanity.function.sync-tag-invalidate";
+export declare const SANITY_FUNCTION_DURABLE = "sanity.function.durable";
 export declare const SANITY_PROJECT = "sanity.project";
 export declare const SANITY_PROJECT_CORS = "sanity.project.cors";
 export declare const SANITY_PROJECT_DATASET = "sanity.project.dataset";
@@ -17,6 +19,7 @@ export declare const EVENT_DOCUMENT_DELETE = "document-delete";
 export declare const EVENT_MEDIA_LIBRARY_ASSET_CREATE = "media-library-asset-create";
 export declare const EVENT_MEDIA_LIBRARY_ASSET_UPDATE = "media-library-asset-update";
 export declare const EVENT_MEDIA_LIBRARY_ASSET_DELETE = "media-library-asset-delete";
+export declare const EVENT_PUBSUB = "pub-sub";
 export declare const EVENT_SCHEDULED = "scheduled-function";
 export declare const EVENT_SYNC_TAG_INVALIDATE = "sync-tag-invalidate";
 export declare const MAP_EVENT_TO_FUNCTION_TYPE: {
@@ -27,6 +30,7 @@ export declare const MAP_EVENT_TO_FUNCTION_TYPE: {
     readonly "media-library-asset-create": "sanity.function.media-library.asset";
     readonly "media-library-asset-delete": "sanity.function.media-library.asset";
     readonly "media-library-asset-update": "sanity.function.media-library.asset";
+    readonly "pub-sub": "sanity.function.pubsub";
     readonly "scheduled-function": "sanity.function.cron";
     readonly "sync-tag-invalidate": "sanity.function.sync-tag-invalidate";
 };
@@ -42,6 +46,7 @@ export declare const LABEL_DOCUMENT_DELETE = "Document Delete";
 export declare const LABEL_MEDIA_LIBRARY_ASSET_CREATE = "Media Library Asset Create";
 export declare const LABEL_MEDIA_LIBRARY_ASSET_UPDATE = "Media Library Asset Update";
 export declare const LABEL_MEDIA_LIBRARY_ASSET_DELETE = "Media Library Asset Delete";
+export declare const LABEL_PUBSUB = "PubSub";
 export declare const LABEL_SCHEDULED = "Scheduled";
 export declare const LABEL_SYNC_TAG_INVALIDATE = "Sync Tag Invalidate";
 export declare const CI_SETUP_DOCS_URL = "https://www.sanity.io/docs/blueprints/deploy-blueprints-from-ci";

package/dist/constants.js

@@ -3,8 +3,10 @@ export const SANITY_ACCESS_ROBOT = 'sanity.access.robot';
 export const SANITY_FUNCTION_PREFIX = 'sanity.function.';
 export const SANITY_FUNCTION_DOCUMENT = 'sanity.function.document';
 export const SANITY_FUNCTION_MEDIA_LIBRARY_ASSET = 'sanity.function.media-library.asset';
+export const SANITY_FUNCTION_PUBSUB = 'sanity.function.pubsub';
 export const SANITY_FUNCTION_SCHEDULED = 'sanity.function.cron';
 export const SANITY_FUNCTION_SYNC_TAG_INVALIDATE = 'sanity.function.sync-tag-invalidate';
+export const SANITY_FUNCTION_DURABLE = 'sanity.function.durable';
 export const SANITY_PROJECT = 'sanity.project';
 export const SANITY_PROJECT_CORS = 'sanity.project.cors';
 export const SANITY_PROJECT_DATASET = 'sanity.project.dataset';
@@ -17,6 +19,7 @@ export const EVENT_DOCUMENT_DELETE = 'document-delete';
 export const EVENT_MEDIA_LIBRARY_ASSET_CREATE = 'media-library-asset-create';
 export const EVENT_MEDIA_LIBRARY_ASSET_UPDATE = 'media-library-asset-update';
 export const EVENT_MEDIA_LIBRARY_ASSET_DELETE = 'media-library-asset-delete';
+export const EVENT_PUBSUB = 'pub-sub';
 export const EVENT_SCHEDULED = 'scheduled-function';
 export const EVENT_SYNC_TAG_INVALIDATE = 'sync-tag-invalidate';
 export const MAP_EVENT_TO_FUNCTION_TYPE = {
@@ -27,6 +30,7 @@ export const MAP_EVENT_TO_FUNCTION_TYPE = {
     [EVENT_MEDIA_LIBRARY_ASSET_CREATE]: SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
     [EVENT_MEDIA_LIBRARY_ASSET_DELETE]: SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
     [EVENT_MEDIA_LIBRARY_ASSET_UPDATE]: SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
+    [EVENT_PUBSUB]: SANITY_FUNCTION_PUBSUB,
     [EVENT_SCHEDULED]: SANITY_FUNCTION_SCHEDULED,
     [EVENT_SYNC_TAG_INVALIDATE]: SANITY_FUNCTION_SYNC_TAG_INVALIDATE,
 };
@@ -35,6 +39,7 @@ export const PROJECT_SCOPED_FUNCTION_TYPES = new Set([
     SANITY_FUNCTION_DOCUMENT,
     SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
     SANITY_FUNCTION_SYNC_TAG_INVALIDATE,
+    SANITY_FUNCTION_DURABLE,
 ]);
 export const ORGANIZATION_SCOPED_FUNCTION_TYPES = new Set([
     SANITY_FUNCTION_SCHEDULED,
@@ -47,6 +52,7 @@ export const LABEL_DOCUMENT_DELETE = 'Document Delete';
 export const LABEL_MEDIA_LIBRARY_ASSET_CREATE = 'Media Library Asset Create';
 export const LABEL_MEDIA_LIBRARY_ASSET_UPDATE = 'Media Library Asset Update';
 export const LABEL_MEDIA_LIBRARY_ASSET_DELETE = 'Media Library Asset Delete';
+export const LABEL_PUBSUB = 'PubSub';
 export const LABEL_SCHEDULED = 'Scheduled';
 export const LABEL_SYNC_TAG_INVALIDATE = 'Sync Tag Invalidate';
 export const CI_SETUP_DOCS_URL = 'https://www.sanity.io/docs/blueprints/deploy-blueprints-from-ci';

package/dist/cores/blueprints/deploy.js

@@ -3,6 +3,7 @@ import { preDeploy } from '../../actions/blueprints/pre-deploy.js';
 import { getStack, updateStack } from '../../actions/blueprints/stacks.js';
 import { waitForOperation } from '../../actions/blueprints/wait-for-operation.js';
 import { checkUserPermission } from '../../actions/sanity/access.js';
+import { extractDurableConfig } from '../../utils/blueprints/extract-durable-config.js';
 import { createHintCollector } from '../../utils/blueprints/hints.js';
 import { check, niceId, severe } from '../../utils/display/presenters.js';
 import { CODE_OPERATION_UNCONFIRMED, EXIT_OPERATION_UNCONFIRMED } from '../../utils/exit-codes.js';
@@ -34,6 +35,7 @@ export async function blueprintDeployCore(options) {
             };
         }
         const resources = [...blueprint.resources];
+        await extractDurableConfig(resources, blueprintFileDir);
         const preDeployResult = await preDeploy({
             scopeType,
             scopeId,

package/dist/cores/blueprints/plan.js

@@ -1,5 +1,6 @@
 import { dirname } from 'node:path';
 import { planStack, resolveStackIdByNameOrId } from '../../actions/blueprints/stacks.js';
+import { extractDurableConfig } from '../../utils/blueprints/extract-durable-config.js';
 import { createHintCollector } from '../../utils/blueprints/hints.js';
 import { formatDeploymentPlan, formatResourceTree, hasActionableChanges, } from '../../utils/display/blueprints-formatting.js';
 import { styleText } from '../../utils/style-text.js';
@@ -9,6 +10,7 @@ export async function blueprintPlanCore(options) {
     const { verbose: _verbose = false } = flags;
     const { scopeType, scopeId, stackId: blueprintStackId, parsedBlueprint, resources, fileInfo, } = blueprint;
     log(`${styleText(['bold', 'blueBright'], 'Local Blueprint')} ${styleText('dim', `(${fileInfo.fileName})`)}`);
+    await extractDurableConfig(resources, dirname(fileInfo.blueprintFilePath));
     log(formatResourceTree(resources));
     if (!token || !scopeType || !scopeId) {
         log(styleText('dim', 'Unable to retrieve live Stack deployment for comparison'));

package/dist/cores/functions/add.js

@@ -5,7 +5,7 @@ import { checkbox, confirm, input, select } from '@inquirer/prompts';
 import { highlight } from 'cardinal';
 import { createFunctionResource } from '../../actions/blueprints/resources.js';
 import { verifyExampleExists, writeExample } from '../../actions/sanity/examples.js';
-import { EVENT_DOCUMENT_CREATE, EVENT_DOCUMENT_DELETE, EVENT_DOCUMENT_UPDATE, EVENT_MEDIA_LIBRARY_ASSET_CREATE, EVENT_MEDIA_LIBRARY_ASSET_DELETE, EVENT_MEDIA_LIBRARY_ASSET_UPDATE, EVENT_SCHEDULED, EVENT_SYNC_TAG_INVALIDATE, FUNCTION_TYPES, LABEL_DOCUMENT_CREATE, LABEL_DOCUMENT_DELETE, LABEL_DOCUMENT_UPDATE, LABEL_MEDIA_LIBRARY_ASSET_CREATE, LABEL_MEDIA_LIBRARY_ASSET_DELETE, LABEL_MEDIA_LIBRARY_ASSET_UPDATE, LABEL_SCHEDULED, LABEL_SYNC_TAG_INVALIDATE, MAP_EVENT_TO_FUNCTION_TYPE, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_SCHEDULED, SANITY_FUNCTION_SYNC_TAG_INVALIDATE, } from '../../constants.js';
+import { EVENT_DOCUMENT_CREATE, EVENT_DOCUMENT_DELETE, EVENT_DOCUMENT_UPDATE, EVENT_MEDIA_LIBRARY_ASSET_CREATE, EVENT_MEDIA_LIBRARY_ASSET_DELETE, EVENT_MEDIA_LIBRARY_ASSET_UPDATE, EVENT_PUBSUB, EVENT_SCHEDULED, EVENT_SYNC_TAG_INVALIDATE, FUNCTION_TYPES, LABEL_DOCUMENT_CREATE, LABEL_DOCUMENT_DELETE, LABEL_DOCUMENT_UPDATE, LABEL_MEDIA_LIBRARY_ASSET_CREATE, LABEL_MEDIA_LIBRARY_ASSET_DELETE, LABEL_MEDIA_LIBRARY_ASSET_UPDATE, LABEL_PUBSUB, LABEL_SCHEDULED, LABEL_SYNC_TAG_INVALIDATE, MAP_EVENT_TO_FUNCTION_TYPE, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_PUBSUB, SANITY_FUNCTION_SCHEDULED, SANITY_FUNCTION_SYNC_TAG_INVALIDATE, } from '../../constants.js';
 import { check, indent, warn } from '../../utils/display/presenters.js';
 import { validateFunctionName } from '../../utils/functions/validate-name.js';
 import { styleText } from '../../utils/style-text.js';
@@ -21,6 +21,9 @@ export const generateFunctionBlueprintResourceTemplate = (fnName, eventNames) =>
         case SANITY_FUNCTION_MEDIA_LIBRARY_ASSET:
             definer = `defineMediaLibraryAssetFunction({name: '${fnName}', event: {on: [${eventOns.join(', ')}], resource: {type: 'media-library', id: 'my-media-library-id'}}}), // ← add this line`;
             break;
+        case SANITY_FUNCTION_PUBSUB:
+            definer = `definePubSubFunction({name: '${fnName}'}), // ← add this line`;
+            break;
         case SANITY_FUNCTION_SCHEDULED:
             definer = `defineScheduledFunction({name: '${fnName}', event: {expression: '0 0 * * *'}}), // ← add this line`;
             break;
@@ -158,7 +161,7 @@ export async function functionAddCore(options) {
         }
         const eventSources = new Set(fnTypes.map((t) => t.substring(0, t.lastIndexOf('-'))));
         if (eventSources.size > 1) {
-            throw new Error('Invalid function type. Cannot mix document-*, media-library-asset-*, sync-tag-* and/or scheduled-* types.');
+            throw new Error('Invalid function type. Cannot mix document-*, media-library-asset-*, pub-sub, sync-tag-* and/or scheduled-* types.');
         }
         let addHelpers;
         let installCommand;
@@ -242,6 +245,7 @@ async function promptForFunctionType() {
             { name: LABEL_MEDIA_LIBRARY_ASSET_CREATE, value: EVENT_MEDIA_LIBRARY_ASSET_CREATE },
             { name: LABEL_MEDIA_LIBRARY_ASSET_UPDATE, value: EVENT_MEDIA_LIBRARY_ASSET_UPDATE },
             { name: LABEL_MEDIA_LIBRARY_ASSET_DELETE, value: EVENT_MEDIA_LIBRARY_ASSET_DELETE },
+            { name: LABEL_PUBSUB, value: EVENT_PUBSUB },
             { name: LABEL_SCHEDULED, value: EVENT_SCHEDULED },
             { name: LABEL_SYNC_TAG_INVALIDATE, value: EVENT_SYNC_TAG_INVALIDATE },
         ],
@@ -249,11 +253,10 @@ async function promptForFunctionType() {
             if (choices.length === 0) {
                 return 'You must choose at least one function type / document change event';
             }
-            const hasMedia = choices.some((c) => String(c.value).startsWith('media-library'));
-            const hasDocument = choices.some((c) => String(c.value).startsWith('document'));
-            const hasSchedule = choices.some((c) => String(c.value).startsWith('scheduled'));
-            if ((hasMedia && hasDocument) || (hasMedia && hasSchedule) || (hasDocument && hasSchedule)) {
-                return 'You cannot mix Document, Media Library Asset, and Scheduled events together in one Function';
+            // same grouping as the check in functionAddCore, so the prompt cannot drift from it
+            const eventSources = new Set(choices.map((c) => String(c.value).substring(0, String(c.value).lastIndexOf('-'))));
+            if (eventSources.size > 1) {
+                return 'You cannot mix Document, Media Library Asset, PubSub, Scheduled, and Sync Tag Invalidate events together in one Function';
             }
             return true;
         },

package/dist/server/static/components/api-base.js

@@ -9,6 +9,7 @@ export class ApiBaseElement extends HTMLElement {
     this.api = api
     this.SANITY_FUNCTION_DOCUMENT = 'sanity.function.document'
     this.SANITY_FUNCTION_MEDIA_LIBRARY_ASSET = 'sanity.function.media-library.asset'
+    this.SANITY_FUNCTION_PUBSUB = 'sanity.function.pubsub'
     this.SANITY_FUNCTION_SCHEDULED = 'sanity.function.cron'
     this.SANITY_FUNCTION_SYNC_TAG_INVALIDATE = 'sanity.function.sync-tag-invalidate'
   }

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

@@ -79,6 +79,7 @@ class FiltersComponent extends ApiBaseElement {
     const mediaFunction = this.api.store.selectedFunctionType?.startsWith(
       this.SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
     )
+    const pubsubFunction = this.api.store.selectedFunctionType === this.SANITY_FUNCTION_PUBSUB
     const scheduleFunction = this.api.store.selectedFunctionType === this.SANITY_FUNCTION_SCHEDULED
     const stiFunction =
       this.api.store.selectedFunctionType === this.SANITY_FUNCTION_SYNC_TAG_INVALIDATE
@@ -89,15 +90,16 @@ class FiltersComponent extends ApiBaseElement {
       mediaFunction,
       scheduleFunction,
       stiFunction,
+      pubsubFunction,
     )
   }
 
-  buildFilters = (docFunction, mediaFunction, scheduleFunction, stiFunction) => {
+  buildFilters = (docFunction, mediaFunction, scheduleFunction, stiFunction, pubsubFunction) => {
     return `
     <legend class="config-label">Client Options</legend>
     <div id="dynamic-dropdowns" class="flex gap-2">
       ${
-        docFunction || scheduleFunction || stiFunction
+        docFunction || scheduleFunction || stiFunction || pubsubFunction
           ? `<select-dropdown
         label="Project"
         store-key="projects"

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

@@ -164,6 +164,9 @@ class PayloadPanel extends ApiBaseElement {
     const payloadTitle = this.shadowRoot.querySelector('#payloadTitle')
     let title = 'Document'
     switch (selectedFunctionType) {
+      case this.SANITY_FUNCTION_PUBSUB:
+        title = 'PubSub Payload'
+        break
       case this.SANITY_FUNCTION_SYNC_TAG_INVALIDATE:
         title = 'Sync Tag Payload'
         break

package/dist/utils/blueprints/extract-durable-config.d.ts

@@ -0,0 +1,8 @@
+import { type BlueprintResource } from '@sanity/blueprints';
+/**
+ * Extracts the blueprint config from the function source code and mutates it to the resource object.
+ * This is used for durable functions that may not have a config defined in the blueprint.
+ * @param resources
+ * @param blueprintFileDir
+ */
+export declare const extractDurableConfig: (resources: BlueprintResource[], blueprintFileDir: string) => Promise<void>;

package/dist/utils/blueprints/extract-durable-config.js

@@ -0,0 +1,60 @@
+import { resolve } from 'node:path';
+import { pathToFileURL } from 'node:url';
+import { validateDurableFunction, } from '@sanity/blueprints';
+import { SANITY_FUNCTION_DURABLE } from '../../constants.js';
+import { findFunctionEntryPoint } from '../functions/find-entry-point.js';
+import { transpileFunction } from '../functions/transpile/function.js';
+import { isLocalFunctionResource } from '../types.js';
+const DURABLE_CONFIG_KEYS = ['event', 'concurrency', 'debounce', 'debounceKey'];
+/**
+ * Extracts the blueprint config from the function source code and mutates it to the resource object.
+ * This is used for durable functions that may not have a config defined in the blueprint.
+ * @param resources
+ * @param blueprintFileDir
+ */
+export const extractDurableConfig = async (resources, blueprintFileDir) => {
+    for (const resource of resources) {
+        if (!isLocalFunctionResource(resource))
+            continue;
+        // skip if not a durable function
+        if (resource.type !== SANITY_FUNCTION_DURABLE)
+            continue;
+        // Check if source needs to be transpiled before attempting to get config
+        const resourceSrc = resolve(blueprintFileDir, resource.src);
+        const entryPoint = await findFunctionEntryPoint(resourceSrc, resource.name);
+        let importPath = entryPoint;
+        let cleanup = async () => { };
+        // need to transpile and grab the config from the built output if the entry point is a TypeScript file
+        if (entryPoint.endsWith('.ts')) {
+            const built = await transpileFunction({ resource, functionPath: resourceSrc, entryPoint });
+            importPath = await findFunctionEntryPoint(built.outputDir, resource.name);
+            cleanup = built.cleanup;
+        }
+        let config = {};
+        try {
+            const mod = await import(pathToFileURL(importPath).href);
+            config = (mod.handler || mod.default)?.config;
+        }
+        finally {
+            await cleanup();
+        }
+        // Update values not included in the blueprint.
+        if (resource.event === undefined && config?.event !== undefined) {
+            resource.event = config.event;
+        }
+        if (resource.concurrency === undefined && config?.concurrency !== undefined) {
+            resource.concurrency = config.concurrency;
+        }
+        if (resource.debounce === undefined && config?.debounce !== undefined) {
+            resource.debounce = config.debounce;
+        }
+        if (resource.debounceKey === undefined && config?.debounceKey !== undefined) {
+            resource.debounceKey = config.debounceKey;
+        }
+        // Validate the resource after merging the config values
+        const errors = validateDurableFunction(resource);
+        if (errors.length > 0) {
+            throw new Error(`Invalid durable resource "${resource.name}": ${errors.map((error) => error.message).join('; ')}`);
+        }
+    }
+};

package/dist/utils/blueprints/validate-resources.js

@@ -1,5 +1,5 @@
-import { validateCorsOrigin, validateDataset, validateDocumentFunction, validateDocumentWebhook, validateMediaLibraryAssetFunction, validateProject, validateRole, validateScheduledFunction, } from '@sanity/blueprints';
-import { SANITY_ACCESS_ROLE, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_SCHEDULED, SANITY_PROJECT, SANITY_PROJECT_CORS, SANITY_PROJECT_DATASET, SANITY_PROJECT_WEBHOOK, } from '../../constants.js';
+import { validateCorsOrigin, validateDataset, validateDocumentFunction, validateDocumentWebhook, validateDurableFunction, validateMediaLibraryAssetFunction, validateProject, validateRole, validateScheduledFunction, } from '@sanity/blueprints';
+import { SANITY_ACCESS_ROLE, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_DURABLE, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_SCHEDULED, SANITY_PROJECT, SANITY_PROJECT_CORS, SANITY_PROJECT_DATASET, SANITY_PROJECT_WEBHOOK, } from '../../constants.js';
 const RESOURCE_VALIDATORS = {
     [SANITY_ACCESS_ROLE]: {
         validate: validateRole,
@@ -25,6 +25,9 @@ const RESOURCE_VALIDATORS = {
     [SANITY_PROJECT_WEBHOOK]: {
         validate: validateDocumentWebhook,
     },
+    [SANITY_FUNCTION_DURABLE]: {
+        validate: validateDurableFunction,
+    },
 };
 export function validateResources(resources) {
     const errors = [];

package/dist/utils/display/blueprints-formatting.js

@@ -1,5 +1,5 @@
 import { treeify } from 'array-treeify';
-import { SANITY_ACCESS_ROBOT, SANITY_ACCESS_ROLE, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_SCHEDULED, SANITY_FUNCTION_SYNC_TAG_INVALIDATE, SANITY_PROJECT, SANITY_PROJECT_CORS, SANITY_PROJECT_DATASET, SANITY_PROJECT_WEBHOOK, } from '../../constants.js';
+import { SANITY_ACCESS_ROBOT, SANITY_ACCESS_ROLE, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_DURABLE, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_PUBSUB, SANITY_FUNCTION_SCHEDULED, SANITY_FUNCTION_SYNC_TAG_INVALIDATE, SANITY_PROJECT, SANITY_PROJECT_CORS, SANITY_PROJECT_DATASET, SANITY_PROJECT_WEBHOOK, } from '../../constants.js';
 import { styleText } from '../style-text.js';
 import { isCorsOriginResource, isDatasetResource, isRobotResource, isRoleResource, isWebhookResource, } from '../types.js';
 import { formatDateTime, formatDuration } from './dates.js';
@@ -27,8 +27,10 @@ const RESOURCE_CATEGORIES = {
     },
     [SANITY_FUNCTION_DOCUMENT]: functionCategory,
     [SANITY_FUNCTION_MEDIA_LIBRARY_ASSET]: functionCategory,
+    [SANITY_FUNCTION_PUBSUB]: functionCategory,
     [SANITY_FUNCTION_SCHEDULED]: functionCategory,
     [SANITY_FUNCTION_SYNC_TAG_INVALIDATE]: functionCategory,
+    [SANITY_FUNCTION_DURABLE]: functionCategory,
     [SANITY_PROJECT]: {
         label: 'Projects',
         displayNameAttribute: 'displayName',
@@ -215,11 +217,13 @@ export function formatStacksListing(stacks, currentStackId) {
 const IGNORED_PARAMS = {
     [SANITY_FUNCTION_DOCUMENT]: new Set(['src']),
     [SANITY_FUNCTION_MEDIA_LIBRARY_ASSET]: new Set(['src']),
+    [SANITY_FUNCTION_PUBSUB]: new Set(['src']),
     [SANITY_FUNCTION_SCHEDULED]: new Set(['src']),
 };
 const ASSET_RESOURCE_TYPES = new Set([
     SANITY_FUNCTION_DOCUMENT,
     SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
+    SANITY_FUNCTION_PUBSUB,
     SANITY_FUNCTION_SCHEDULED,
 ]);
 function stringifyUnknown(val) {

package/dist/utils/display/resources-formatting.js

@@ -1,4 +1,4 @@
-import { isLocalFunctionResource, isScheduleEvent } from '../../utils/types.js';
+import { hasEventSource, isLocalFunctionResource, isScheduleEvent, } from '../../utils/types.js';
 import { styleText } from '../style-text.js';
 function formatLabel(label) {
     return styleText('dim', `${label}:`);
@@ -46,7 +46,7 @@ export function arrayifyFunction(fn) {
         details.push(formatLabeledValue('memory', fn.memory));
     if (fn.timeout)
         details.push(formatLabeledValue('timeout', fn.timeout));
-    if (fn.event) {
+    if (hasEventSource(fn) && fn.event) {
         const eventDetails = arrayifyEvent(fn.event);
         if (eventDetails) {
             details.push(formatLabel('event'));

package/dist/utils/types.d.ts

@@ -1,4 +1,4 @@
-import { type BlueprintCorsOriginResource, type BlueprintDatasetResource, type BlueprintDocumentFunctionResource, type BlueprintDocumentWebhookResource, type BlueprintMediaLibraryAssetFunctionResource, type BlueprintProjectResource, type BlueprintResource, type BlueprintRobotResource, type BlueprintRoleResource, type BlueprintScheduledFunctionResource, type BlueprintStudioResource, type BlueprintSyncTagInvalidateFunctionResource } from '@sanity/blueprints';
+import { type BlueprintCorsOriginResource, type BlueprintDatasetResource, type BlueprintDocumentFunctionResource, type BlueprintDocumentWebhookResource, type BlueprintDurableFunctionResource, type BlueprintMediaLibraryAssetFunctionResource, type BlueprintProjectResource, type BlueprintPubSubFunctionResource, type BlueprintResource, type BlueprintRobotResource, type BlueprintRoleResource, type BlueprintScheduledFunctionResource, type BlueprintStudioResource, type BlueprintSyncTagInvalidateFunctionResource } from '@sanity/blueprints';
 export type ScopeType = 'organization' | 'project';
 /** Result utility type */
 export type Result<T, E = string> = {
@@ -15,7 +15,11 @@ export interface ActionResponse {
 }
 /** @internal */
 export type FunctionGroqResource = BlueprintDocumentFunctionResource | BlueprintMediaLibraryAssetFunctionResource;
-export type FunctionResource = FunctionGroqResource | BlueprintScheduledFunctionResource | BlueprintSyncTagInvalidateFunctionResource;
+export type FunctionResource = FunctionGroqResource | BlueprintPubSubFunctionResource | BlueprintScheduledFunctionResource | BlueprintSyncTagInvalidateFunctionResource | BlueprintDurableFunctionResource;
+/** Function resources that declare an `event`; PubSub functions are triggered by other functions */
+export type EventFunctionResource = Exclude<FunctionResource, BlueprintPubSubFunctionResource>;
+/** The `event` of any function resource that declares one */
+export type FunctionResourceEvent = EventFunctionResource['event'];
 /** Resource types that carry a deployable asset (have src: string) */
 export type AssetResource = FunctionResource | BlueprintStudioResource;
 /** @internal */
@@ -36,6 +40,7 @@ export interface DeployedResource extends BlueprintResourceRecord {
     externalId: string;
 }
 export declare function isLocalFunctionResource(r: BlueprintResource): r is FunctionResource;
+export declare function hasEventSource(r: FunctionResource): r is EventFunctionResource;
 export declare function isScheduleEvent(e: unknown): e is BlueprintScheduledFunctionResource['event'];
 export declare function isCorsOriginResource(r: unknown): r is BlueprintCorsOriginResource;
 export declare function isProjectResource(r: unknown): r is BlueprintProjectResource;
@@ -43,6 +48,7 @@ export declare function isRobotResource(r: unknown): r is BlueprintRobotResource
 export declare function isRoleResource(r: unknown): r is BlueprintRoleResource;
 export declare function isDatasetResource(r: unknown): r is BlueprintDatasetResource;
 export declare function isStudioResource(r: BlueprintResource): r is BlueprintStudioResource;
+export declare function isDurableFunctionResource(r: unknown): r is BlueprintDurableFunctionResource;
 export declare function isAssetResource(r: BlueprintResource): r is AssetResource;
 export declare function isWebhookResource(r: unknown): r is BlueprintDocumentWebhookResource;
 interface StackBase {

package/dist/utils/types.js

@@ -1,8 +1,11 @@
-import { validateCorsOrigin, validateDataset, validateDocumentWebhook, validateProject, validateRobot, validateRole, } from '@sanity/blueprints';
-import { SANITY_FUNCTION_PREFIX, SANITY_STUDIO } from '../constants.js';
+import { validateCorsOrigin, validateDataset, validateDocumentWebhook, validateDurableFunction, validateProject, validateRobot, validateRole, } from '@sanity/blueprints';
+import { SANITY_FUNCTION_PREFIX, SANITY_FUNCTION_PUBSUB, SANITY_STUDIO } from '../constants.js';
 export function isLocalFunctionResource(r) {
     return r.type.startsWith(SANITY_FUNCTION_PREFIX);
 }
+export function hasEventSource(r) {
+    return r.type !== SANITY_FUNCTION_PUBSUB;
+}
 // type narrowing with predicate functions
 export function isScheduleEvent(e) {
     return e !== null && typeof e === 'object' && ('hour' in e || 'expression' in e);
@@ -25,6 +28,9 @@ export function isDatasetResource(r) {
 export function isStudioResource(r) {
     return r.type === SANITY_STUDIO;
 }
+export function isDurableFunctionResource(r) {
+    return validateDurableFunction(r).length === 0;
+}
 export function isAssetResource(r) {
     return isLocalFunctionResource(r) || isStudioResource(r);
 }

package/oclif.manifest.json

@@ -148,6 +148,7 @@
             "media-library-asset-create",
             "media-library-asset-delete",
             "media-library-asset-update",
+            "pub-sub",
             "scheduled-function",
             "sync-tag-invalidate"
           ],
@@ -1805,6 +1806,7 @@
             "media-library-asset-create",
             "media-library-asset-delete",
             "media-library-asset-update",
+            "pub-sub",
             "scheduled-function",
             "sync-tag-invalidate"
           ],
@@ -3125,5 +3127,5 @@
       ]
     }
   },
-  "version": "17.5.0"
+  "version": "17.6.0"
 }

package/package.json

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