@sanity/runtime-cli 14.8.6 → 14.10.0

package/dist/cores/functions/test.js

@@ -142,9 +142,15 @@ export async function functionTestCore(options) {
         });
         if (error) {
             spinner.fail('Function execution failed.');
+            const errorMessage = error.stack || error.message || error.name;
+            const isTimeout = error.message?.includes('Timeout');
             return {
                 success: false,
-                error: error.stack || error.message || error.name,
+                error: errorMessage,
+                ref: isTimeout ? 'https://www.sanity.io/docs/help/functions-timeout' : undefined,
+                suggestions: isTimeout
+                    ? ['Increase the timeout in your Blueprint function configuration.']
+                    : undefined,
             };
         }
         spinner.succeed('Function execution succeeded.');

package/dist/cores/index.d.ts

@@ -35,6 +35,12 @@ export type CoreResult = {
     success: false;
     /** The error message, if the operation failed. */
     error: string;
+    /** Actionable suggestions displayed to the user via oclif's PrettyPrintableError. */
+    suggestions?: string[];
+    /** A URL for more information about the error. */
+    ref?: string;
+    /** A machine-readable error code. */
+    code?: string;
     streaming?: never;
     json?: never;
 } | {

package/dist/cores/index.js

@@ -42,7 +42,6 @@ export async function initDeployedBlueprintConfig(config) {
     }
     const { scopeType, scopeId, stackId: blueprintStackId } = config.blueprint;
     if (!scopeType || !scopeId) {
-        config.log(`Incomplete configuration. Run \`${config.bin} blueprints doctor\` for diagnostics.`);
         return { ok: false, error: 'Missing scope configuration for Blueprint' };
     }
     const auth = { token: config.token, scopeType, scopeId };
@@ -51,14 +50,12 @@ export async function initDeployedBlueprintConfig(config) {
         stackId = await resolveStackIdByNameOrId(config.stackOverride, auth, config.log);
     }
     if (!stackId) {
-        config.log(`Incomplete configuration. Run \`${config.bin} blueprints doctor\` for diagnostics.`);
         return { ok: false, error: 'Missing Stack deployment configuration for Blueprint' };
     }
     const spinner = config.log.ora('Loading Stack deployment...').start();
     const stackResponse = await getStack({ stackId, auth, logger: config.log });
     if (!stackResponse.ok) {
         spinner.fail('Could not load Stack deployment');
-        config.log(`Run \`${config.bin} blueprints doctor\` for diagnostics.`);
         return { ok: false, error: 'Missing Stack deployment' };
     }
     spinner.stop().clear();

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_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_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 { styleText } from '../style-text.js';
 import { isCorsOriginResource, isDatasetResource, isRobotResource, isRoleResource, isWebhookResource, } from '../types.js';
 import { formatDate, formatDuration } from './dates.js';
@@ -28,6 +28,7 @@ const RESOURCE_CATEGORIES = {
     [SANITY_FUNCTION_DOCUMENT]: functionCategory,
     [SANITY_FUNCTION_MEDIA_LIBRARY_ASSET]: functionCategory,
     [SANITY_FUNCTION_SCHEDULED]: functionCategory,
+    [SANITY_FUNCTION_SYNC_TAG_INVALIDATE]: functionCategory,
     [SANITY_PROJECT]: {
         label: 'Projects',
         displayNameAttribute: 'displayName',
@@ -196,6 +197,8 @@ export function formatStackInfo(stack, isCurrentStack = false) {
             parts.push(styleText('yellow', `(${formatDuration(op.createdAt, op.completedAt)})`));
         }
         rows.push(['Operation', parts.join('  ')]);
+        if (op.userMessage)
+            rows.push(['  Message', `"${op.userMessage}"`]);
     }
     return renderSection(title, rows);
 }

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

@@ -19,15 +19,20 @@ function arrayifyEvent(event) {
         }
     }
     else {
-        if (event.on) {
+        if ('on' in event && event.on) {
             details.push(formatLabeledValue('on', event.on.map((o) => `"${o}"`).join(', ')));
         }
-        if (event.filter) {
+        if ('filter' in event && event.filter) {
             details.push(formatLabeledValue('filter', event.filter));
         }
-        if (event.projection) {
+        if ('projection' in event && event.projection) {
             details.push(formatLabeledValue('projection', event.projection));
         }
+        // TODO: expose event.resource details once we are ready
+        // https://linear.app/sanity/issue/RUN-1246/cli-should-show-eventresource-details-in-blueprints-infoplans
+        // if (event.resource) {
+        //   details.push(formatLabeledValue('resource', JSON.stringify(event.resource)))
+        // }
     }
     return details;
 }

package/dist/utils/invoke-local.js

@@ -150,7 +150,7 @@ export default async function invoke(resource, payload, context, options) {
             });
             timer = setTimeout(() => {
                 shutdown();
-                reject(new Error(`Timeout: The process exceeded your current timeout limit of ${timeout} seconds. Learn to adjust your Blueprint's timeout settings here: https://www.sanity.io/docs/help/functions-timeout`));
+                reject(new Error(`Timeout: Function exceeded the ${timeout}-second time limit.`));
             }, timeout * 1000);
             const payload = {
                 data: { ...filteredData },

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 } from '@sanity/blueprints';
+import { type BlueprintCorsOriginResource, type BlueprintDatasetResource, type BlueprintDocumentFunctionResource, type BlueprintDocumentWebhookResource, type BlueprintMediaLibraryAssetFunctionResource, type BlueprintProjectResource, type BlueprintResource, type BlueprintRobotResource, type BlueprintRoleResource, type BlueprintScheduledFunctionResource, type BlueprintSyncTagInvalidateFunctionResource } from '@sanity/blueprints';
 export type ScopeType = 'organization' | 'project';
 /** Result utility type */
 export type Result<T, E = string> = {
@@ -15,7 +15,7 @@ export interface ActionResponse {
 }
 /** @internal */
 export type FunctionGroqResource = BlueprintDocumentFunctionResource | BlueprintMediaLibraryAssetFunctionResource;
-export type FunctionResource = FunctionGroqResource | BlueprintScheduledFunctionResource;
+export type FunctionResource = FunctionGroqResource | BlueprintScheduledFunctionResource | BlueprintSyncTagInvalidateFunctionResource;
 export interface StudioResource extends BlueprintResource {
     type: 'sanity.studio';
     src: string;
@@ -72,6 +72,8 @@ export interface StackOperation {
     status: string;
     createdAt?: string;
     completedAt?: string;
+    userMessage?: string;
+    systemMessage?: string;
 }
 /** @internal */
 export interface StackMutation {
@@ -81,6 +83,7 @@ export interface StackMutation {
     document: {
         resources?: BlueprintResource[];
     };
+    userMessage?: string;
 }
 /** @internal */
 export interface BuildPayloadOptions {

package/oclif.manifest.json

@@ -314,9 +314,10 @@
     "blueprints:deploy": {
       "aliases": [],
       "args": {},
-      "description": "Pushes your local Blueprint configuration to the remote Stack; provisioning, updating, or destroying resources as needed. This is the primary command for applying infrastructure changes.\n\nBefore deploying, run 'blueprints plan' to preview changes. After deployment, use 'blueprints info' to verify Stack status or 'blueprints logs' to monitor activity.\n\nUse --no-wait to queue the deployment and return immediately without waiting for completion.\n\nUse --fn-installer to force which package manager to use when deploying functions.\n\nSet SANITY_ASSET_TIMEOUT (seconds) to override the 60-second timeout for processing resource assets.",
+      "description": "Applies your local Blueprint to the remote Stack, creating, updating, or removing resources as needed. This is the primary command for applying infrastructure changes.\n\nBefore deploying, run 'blueprints plan' to preview changes. After deployment, use 'blueprints info' to verify Stack status or 'blueprints logs' to monitor activity.\n\nUse --no-wait to queue the deployment and return immediately without waiting for completion.\n\nUse --fn-installer to force which package manager to use when deploying functions.\n\nSet SANITY_ASSET_TIMEOUT (seconds) to override the 60-second timeout for processing resource assets.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --message \"Enable staging dataset\"",
         "<%= config.bin %> <%= command.id %> --no-wait",
         "<%= config.bin %> <%= command.id %> --fn-installer npm"
       ],
@@ -368,6 +369,14 @@
           "multiple": false,
           "type": "option"
         },
+        "message": {
+          "char": "m",
+          "description": "Message describing the deployment (e.g. reason for change)",
+          "name": "message",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "fn-installer": {
           "aliases": [
             "function-installer",
@@ -536,7 +545,7 @@
       "pluginName": "@sanity/runtime-cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Destroy the remote Stack deployment and its resources (will not delete local files)",
+      "summary": "Destroy a remote Stack deployment and its resources",
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -550,7 +559,10 @@
       "aliases": [],
       "args": {},
       "description": "Analyzes your local Blueprint and remote Stack configuration for common issues, such as missing authentication, invalid project references, or misconfigured resources.\n\nRun this command when encountering errors with other Blueprint commands. Use --fix to interactively resolve detected issues.",
-      "examples": [],
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --fix"
+      ],
       "flags": {
         "json": {
           "description": "Format output as json",
@@ -681,7 +693,7 @@
       "pluginName": "@sanity/runtime-cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Show information about the local Blueprint's remote Stack deployment",
+      "summary": "Display the status and resources of the remote Stack deployment",
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -841,7 +853,7 @@
       "pluginName": "@sanity/runtime-cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Initialize a local Blueprint and optionally provision a remote Stack deployment",
+      "summary": "Initialize a Blueprint and create a remote Stack",
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -998,7 +1010,7 @@
       "pluginName": "@sanity/runtime-cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Enumerate resources to be deployed to the remote Stack - will not modify any resources",
+      "summary": "Preview changes that will be applied to the remote Stack",
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -1011,7 +1023,7 @@
     "blueprints:promote": {
       "aliases": [],
       "args": {},
-      "description": "EXPERIMENTAL! Promotes a Stack, changing its scope from project to organization. This is a one-way trip.",
+      "description": "Promotes a deployed Stack to organization scope, enabling management of org-level resources. Promotion cannot be reversed.\n\nYour local Blueprint configuration will be updated to reflect the new scope.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --stack <name-or-id>"
@@ -1081,7 +1093,7 @@
       "pluginName": "@sanity/runtime-cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Promote a Stack deployment to a broader scope",
+      "summary": "Promote a Stack from project scope to organization scope",
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -1177,7 +1189,7 @@
       "pluginName": "@sanity/runtime-cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "List all remote Stack deployments (defaults to the current Blueprint's project scope)",
+      "summary": "List remote Stack deployments for your project or organization",
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -2235,5 +2247,5 @@
       ]
     }
   },
-  "version": "14.8.6"
+  "version": "14.10.0"
 }

package/package.json

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