@sanity/runtime-cli 14.9.0 → 14.10.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/14.9.0 linux-x64 node-v24.14.1
+@sanity/runtime-cli/14.10.1 linux-x64 node-v24.14.1
 $ sanity-run --help [COMMAND]
 USAGE
   $ sanity-run COMMAND
@@ -101,7 +101,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/v14.9.0/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -140,7 +140,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/v14.9.0/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -148,13 +148,14 @@ Deploy the local Blueprint to the remote Stack
 
 ```
 USAGE
-  $ sanity-run blueprints deploy [--json] [--validate-resources] [--stack <value>] [--no-wait]
+  $ sanity-run blueprints deploy [--json] [--validate-resources] [--stack <value>] [-m <value>] [--no-wait]
 
 FLAGS
-  --json                     Format output as json
-  --no-wait                  Do not wait for Stack deployment to complete
-  --stack=<value>            Stack name or ID to use instead of the locally configured Stack
-  --[no-]validate-resources  Validate resources
+  -m, --message=<value>          Message describing the deployment (e.g. reason for change)
+      --json                     Format output as json
+      --no-wait                  Do not wait for Stack deployment to complete
+      --stack=<value>            Stack name or ID to use instead of the locally configured Stack
+      --[no-]validate-resources  Validate resources
 
 DESCRIPTION
   Deploy the local Blueprint to the remote Stack
@@ -174,12 +175,14 @@ DESCRIPTION
 EXAMPLES
   $ sanity-run blueprints deploy
 
+  $ sanity-run blueprints deploy --message "Enable staging dataset"
+
   $ sanity-run blueprints deploy --no-wait
 
   $ sanity-run blueprints deploy --fn-installer npm
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v14.9.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -215,7 +218,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/v14.9.0/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints doctor`
 
@@ -247,7 +250,7 @@ EXAMPLES
   $ sanity-run blueprints doctor --fix
 ```
 
-_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v14.9.0/src/commands/blueprints/doctor.ts)_
+_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/blueprints/doctor.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -279,7 +282,7 @@ EXAMPLES
   $ sanity-run blueprints info --stack <name-or-id>
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v14.9.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init [DIR]`
 
@@ -333,7 +336,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/v14.9.0/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -364,7 +367,7 @@ EXAMPLES
   $ sanity-run blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v14.9.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -392,7 +395,7 @@ EXAMPLES
   $ sanity-run blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v14.9.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run blueprints stacks`
 
@@ -424,7 +427,7 @@ EXAMPLES
   $ sanity-run blueprints stacks --organization-id <organizationId>
 ```
 
-_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v14.9.0/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions add`
 
@@ -477,7 +480,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/v14.9.0/src/commands/functions/add.ts)_
+_See code: [src/commands/functions/add.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/functions/add.ts)_
 
 ## `sanity-run functions dev`
 
@@ -513,7 +516,7 @@ EXAMPLES
   $ sanity-run functions dev --timeout 60
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v14.9.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -544,7 +547,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/v14.9.0/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env list NAME`
 
@@ -572,7 +575,7 @@ EXAMPLES
   $ sanity-run functions env list MyFunction
 ```
 
-_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v14.9.0/src/commands/functions/env/list.ts)_
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -602,7 +605,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/v14.9.0/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions logs [NAME]`
 
@@ -644,7 +647,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v14.9.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test [NAME]`
 
@@ -702,7 +705,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/v14.9.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v14.10.1/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

package/dist/actions/blueprints/logs-streaming.d.ts

@@ -8,6 +8,7 @@ export interface LogStreamingConfig {
     verbose?: boolean;
     log: Logger;
     onActivity?: () => void;
+    onLogEntry?: (log: BlueprintLog) => void;
 }
 export interface StreamLogsOptions {
     stackId: string;

package/dist/actions/blueprints/logs-streaming.js

@@ -80,6 +80,7 @@ export async function setupLogStreaming(config) {
             return;
         newestTimestamp = new Date(logEntry.timestamp).getTime();
         config.onActivity?.();
+        config.onLogEntry?.(logEntry);
         log(formatLogEntry(logEntry, verbose, previousLog));
         previousLog = logEntry;
     };

package/dist/commands/blueprints/deploy.d.ts

@@ -5,6 +5,7 @@ export default class DeployCommand extends DeployedStackCommand<typeof DeployCom
     static examples: string[];
     static flags: {
         stack: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        message: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'fn-installer': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'no-wait': import("@oclif/core/interfaces").BooleanFlag<boolean>;
         'new-stack-name': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;

package/dist/commands/blueprints/deploy.js

@@ -16,11 +16,16 @@ Use --fn-installer to force which package manager to use when deploying function
 Set SANITY_ASSET_TIMEOUT (seconds) to override the 60-second timeout for processing resource assets.`;
     static 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',
     ];
     static flags = {
         stack: unhide(stackFlag),
+        message: Flags.string({
+            description: 'Message describing the deployment (e.g. reason for change)',
+            char: 'm',
+        }),
         'fn-installer': Flags.string({
             description: 'Which package manager to use when installing Function dependencies',
             aliases: ['function-installer', 'installer'],

package/dist/constants.js

@@ -30,6 +30,7 @@ export const FUNCTION_TYPES = [
 export const PROJECT_SCOPED_FUNCTION_TYPES = new Set([
     SANITY_FUNCTION_DOCUMENT,
     SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
+    SANITY_FUNCTION_SYNC_TAG_INVALIDATE,
 ]);
 export const ORGANIZATION_SCOPED_FUNCTION_TYPES = new Set([
     SANITY_FUNCTION_SCHEDULED,

package/dist/cores/blueprints/deploy.d.ts

@@ -12,6 +12,7 @@ export interface BlueprintDeployOptions extends CoreConfig {
         'fn-installer'?: string;
         'no-wait'?: boolean;
         'new-stack-name'?: string;
+        message?: string;
         verbose?: boolean;
     };
 }

package/dist/cores/blueprints/deploy.js

@@ -2,6 +2,7 @@ import { setTimeout as sleep } from 'node:timers/promises';
 import { stashAsset } from '../../actions/blueprints/assets.js';
 import { setupLogStreaming } from '../../actions/blueprints/logs-streaming.js';
 import { getStack, updateStack } from '../../actions/blueprints/stacks.js';
+import { createLogHintCollector } from '../../utils/blueprints/log-hints.js';
 import { niceId } from '../../utils/display/presenters.js';
 import { styleText } from '../../utils/style-text.js';
 import { isAssetResource } from '../../utils/types.js';
@@ -54,6 +55,7 @@ export async function blueprintDeployCore(options) {
                 scopeId,
                 name: stackName,
                 document: { resources },
+                userMessage: flags.message,
             },
             auth,
             logger: log,
@@ -80,6 +82,7 @@ export async function blueprintDeployCore(options) {
             };
         }
         log(styleText('dim', 'Stack deployment progress:'));
+        const logHints = createLogHintCollector(bin);
         let logStreamCleanup = null;
         try {
             let lastLogAt = Date.now();
@@ -93,6 +96,7 @@ export async function blueprintDeployCore(options) {
                 onActivity: () => {
                     lastLogAt = Date.now();
                 },
+                onLogEntry: (logEntry) => logHints.inspect(logEntry),
             });
             while (true) {
                 const { ok, stack: currentStack } = await getStack({ stackId: stack.id, auth, logger: log });
@@ -121,6 +125,7 @@ export async function blueprintDeployCore(options) {
                         success: false,
                         error: 'Stack deployment failed',
                         suggestions: [
+                            ...logHints.getSuggestions(),
                             `Run \`npx ${bin} blueprints logs\` to review deployment logs.`,
                             `Run \`npx ${bin} blueprints plan\` to identify issues with your Blueprint.`,
                         ],

package/dist/cores/blueprints/destroy.js

@@ -2,6 +2,7 @@ import { setTimeout as sleep } from 'node:timers/promises';
 import { confirm } from '@inquirer/prompts';
 import { setupLogStreaming } from '../../actions/blueprints/logs-streaming.js';
 import { destroyStack, getStack, resolveStackIdByNameOrId } from '../../actions/blueprints/stacks.js';
+import { createLogHintCollector } from '../../utils/blueprints/log-hints.js';
 import { niceId } from '../../utils/display/presenters.js';
 import { styleText } from '../../utils/style-text.js';
 export async function blueprintDestroyCore(options) {
@@ -103,6 +104,7 @@ export async function blueprintDestroyCore(options) {
             return { success: true, json: { stackId: stack.id, stackName: stack.name } };
         }
         log(styleText('dim', 'Stack destruction progress:'));
+        const logHints = createLogHintCollector(bin);
         let logStreamCleanup = null;
         try {
             let lastLogAt = Date.now();
@@ -115,6 +117,7 @@ export async function blueprintDestroyCore(options) {
                 onActivity: () => {
                     lastLogAt = Date.now();
                 },
+                onLogEntry: (logEntry) => logHints.inspect(logEntry),
             });
             while (true) {
                 const { ok, stack: currentStack } = await getStack({ stackId: stack.id, auth, logger: log });
@@ -134,6 +137,7 @@ export async function blueprintDestroyCore(options) {
                         success: false,
                         error: 'Stack destruction failed',
                         suggestions: [
+                            ...logHints.getSuggestions(),
                             `Run \`npx ${bin} blueprints logs\` to review destruction logs.`,
                             `Run \`npx ${bin} blueprints info\` to view current Stack status.`,
                         ],

package/dist/cores/blueprints/doctor.js

@@ -163,6 +163,8 @@ export async function blueprintDoctorCore(options) {
                             ? `  ${styleText('dim', new Date(time).toLocaleString('sv-SE'))}`
                             : '';
                         stackRows.push(['Operation', `${op.status}${timestamp}`]);
+                        if (op.userMessage)
+                            stackRows.push(['  Message', `"${op.userMessage}"`]);
                     }
                     if (stack.resources) {
                         stackRows.push(['Resources', `${stack.resources.length}`]);

package/dist/utils/blueprints/log-hints.d.ts

@@ -0,0 +1,25 @@
+import type { BlueprintLog } from '../types.js';
+/**
+ * A pattern that matches a log message and produces oclif suggestions
+ * The regex is tested against `BlueprintLog.message`
+ * capture groups are forwarded to the factory so suggestions can include dynamic values
+ */
+type LogHintPattern = [RegExp, (match: RegExpMatchArray, bin: string) => string[]];
+/**
+ * Patterns matched against ERROR/FATAL log entries during streaming operations
+ * like deploy and destroy. Each entry is a [regex, suggestionFactory] tuple.
+ *
+ * Add new patterns here -- no other code changes required.
+ */
+export declare const LOG_HINT_PATTERNS: LogHintPattern[];
+/**
+ * Creates a collector to create suggestions
+ * Use getSuggestions() after all logs are inspected
+ */
+export declare function createLogHintCollector(bin: string): {
+    /** Check a log entry against hint patterns; only ERROR/FATAL levels are inspected. */
+    inspect(log: BlueprintLog): void;
+    /** Return unique collected suggestions. */
+    getSuggestions(): string[];
+};
+export {};

package/dist/utils/blueprints/log-hints.js

@@ -0,0 +1,46 @@
+/**
+ * Patterns matched against ERROR/FATAL log entries during streaming operations
+ * like deploy and destroy. Each entry is a [regex, suggestionFactory] tuple.
+ *
+ * Add new patterns here -- no other code changes required.
+ */
+export const LOG_HINT_PATTERNS = [
+    [
+        // tester
+        /\[TEST\] '(.+)' TEST/,
+        (match) => [`TEST SUGGESTION for '${match[1]}'.`],
+    ],
+    [
+        // Function requires organization scope
+        /\[Functions\] Failed.+: (.+must be attached to an organization scoped stack)/,
+        (_match, bin) => [
+            `Run \`npx ${bin} blueprints promote\` to move from project to organization scope.`,
+        ],
+    ],
+];
+/**
+ * Creates a collector to create suggestions
+ * Use getSuggestions() after all logs are inspected
+ */
+export function createLogHintCollector(bin) {
+    const collected = [];
+    return {
+        /** Check a log entry against hint patterns; only ERROR/FATAL levels are inspected. */
+        inspect(log) {
+            const level = log.level.toUpperCase();
+            if (level !== 'ERROR' && level !== 'FATAL')
+                return;
+            for (const [pattern, factory] of LOG_HINT_PATTERNS) {
+                const match = log.message.match(pattern);
+                if (match) {
+                    collected.push(...factory(match, bin));
+                    break; // first matching pattern wins per entry
+                }
+            }
+        },
+        /** Return unique collected suggestions. */
+        getSuggestions() {
+            return [...new Set(collected)];
+        },
+    };
+}

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

@@ -197,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/types.d.ts

@@ -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

@@ -317,6 +317,7 @@
       "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",
@@ -2238,5 +2247,5 @@
       ]
     }
   },
-  "version": "14.9.0"
+  "version": "14.10.1"
 }

package/package.json

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