@sanity/runtime-cli 14.8.1 → 14.8.3

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.8.1 linux-x64 node-v24.14.0
+@sanity/runtime-cli/14.8.3 linux-x64 node-v24.14.0
 $ 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.8.1/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/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.8.1/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -179,7 +179,7 @@ EXAMPLES
   $ sanity-run blueprints deploy --fn-installer npm
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.1/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -215,7 +215,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.8.1/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints doctor`
 
@@ -242,7 +242,7 @@ DESCRIPTION
   issues.
 ```
 
-_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.1/src/commands/blueprints/doctor.ts)_
+_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/blueprints/doctor.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -274,7 +274,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.8.1/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init [DIR]`
 
@@ -328,7 +328,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.8.1/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -359,7 +359,7 @@ EXAMPLES
   $ sanity-run blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.1/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -387,7 +387,7 @@ EXAMPLES
   $ sanity-run blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.1/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run blueprints stacks`
 
@@ -419,7 +419,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.8.1/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions add`
 
@@ -472,7 +472,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.8.1/src/commands/functions/add.ts)_
+_See code: [src/commands/functions/add.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/functions/add.ts)_
 
 ## `sanity-run functions dev`
 
@@ -508,7 +508,7 @@ EXAMPLES
   $ sanity-run functions dev --timeout 60
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.1/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -539,7 +539,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.8.1/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env list NAME`
 
@@ -567,7 +567,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.8.1/src/commands/functions/env/list.ts)_
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -597,7 +597,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.8.1/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions logs [NAME]`
 
@@ -639,7 +639,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.1/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test [NAME]`
 
@@ -697,7 +697,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.8.1/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v14.8.3/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

package/dist/actions/blueprints/assets.d.ts

@@ -1,11 +1,11 @@
-import type { Resource } from '@sanity/blueprints-parser';
+import type { BlueprintResource } from '@sanity/blueprints';
 import AdmZip from 'adm-zip';
 import type { Logger } from '../../utils/logger.js';
 import type { AuthParams, InstallerType } from '../../utils/types.js';
 export declare const ASSET_CHECK_URL: string;
 export declare const ASSET_STASH_URL: string;
 export declare function stashAsset({ resource, auth, logger, installer, }: {
-    resource: Resource;
+    resource: BlueprintResource;
     auth: AuthParams;
     logger: Logger;
     installer?: InstallerType;

package/dist/actions/blueprints/assets.js

@@ -66,7 +66,7 @@ export async function stashAsset({ resource, auth, logger, installer, }) {
         return { success: false, error: err instanceof Error ? err.message : `${err}` };
     }
 }
-async function prepareStudioAsset({ resource }) {
+async function prepareStudioAsset({ resource, }) {
     if (!('src' in resource) || typeof resource.src !== 'string') {
         return {
             success: false,

package/dist/actions/blueprints/resources.js

@@ -15,6 +15,12 @@ export const handler = documentEventHandler(async ({ context, event }) => {
   const time = new Date().toLocaleTimeString()
   console.log(\`👋 Your Sanity Function was called at \${time}\`)
 })`;
+const DEFAULT_SCHEDULED_HELPER_FUNCTION_TEMPLATE = /*ts*/ `import { scheduledEventHandler } from '@sanity/functions'
+
+export const handler = scheduledEventHandler(async ({ context }) => {
+  const time = new Date().toLocaleTimeString()
+  console.log(\`Your scheduled Sanity Function was called at \${time}\`)
+})`;
 /**
  * Creates a new function resource file and adds it to the blueprint
  */
@@ -39,9 +45,24 @@ export async function createFunctionResource(options, logger) {
     mkdirSync(functionDir, { recursive: true });
     if (!['ts', 'js'].includes(lang))
         throw Error(`Unsupported language: ${lang}`);
+    // type looks like 'document-publish', 'media-library-asset-delete' or 'scheduled-function'
+    // and we are guaranteed to have the same leading words (typeName below) for all provided type strings (via guards in the call site for this method).
+    // TODO: this substring convention is brittle - consider mapping EVENT_* constants to typeName values explicitly instead of relying on string splitting.
+    const typeName = type[0].substring(0, type[0].lastIndexOf('-'));
     // Create index.<lang> with default template
     const indexPath = join(functionDir, `index.${lang}`);
-    writeFileSync(indexPath, addHelpers ? DEFAULT_HELPER_FUNCTION_TEMPLATE : DEFAULT_FUNCTION_TEMPLATE);
+    let template = DEFAULT_FUNCTION_TEMPLATE;
+    if (addHelpers) {
+        switch (typeName) {
+            case 'scheduled':
+                template = DEFAULT_SCHEDULED_HELPER_FUNCTION_TEMPLATE;
+                break;
+            default:
+                template = DEFAULT_HELPER_FUNCTION_TEMPLATE;
+                break;
+        }
+    }
+    writeFileSync(indexPath, template);
     if (addHelpers && blueprintFilePath) {
         try {
             await writeOrUpdateNodeDependency(blueprintFilePath, '@sanity/functions', logger);
@@ -56,9 +77,6 @@ export async function createFunctionResource(options, logger) {
             throw new Error(`Failed to install dependencies using \`${installCommand}\``);
         }
     }
-    // type looks like 'document-publish', 'media-library-asset-delete' or 'scheduled-function'
-    // and we are guaranteed to have the same leading words (typeName below) for all provided type strings (via guards in the call site for this method).
-    const typeName = type[0].substring(0, type[0].lastIndexOf('-'));
     const eventsOn = type.map((t) => t.substring(t.lastIndexOf('-') + 1));
     // Create resource definition
     let resourceJson;
@@ -84,7 +102,17 @@ export async function createFunctionResource(options, logger) {
                 },
             };
             break;
-        // TODO: add scheduled and sync tag invalidate funx
+        case 'scheduled':
+            resourceJson = {
+                name,
+                src: `functions/${name}`,
+                type: 'sanity.function.cron',
+                event: {
+                    expression: '0 0 * * *',
+                },
+            };
+            break;
+        // TODO: add sync tag invalidate funx
     }
     if (!resourceJson) {
         throw new Error('Could not create function resource based on selections');

package/dist/cores/blueprints/deploy.js

@@ -35,8 +35,11 @@ export async function blueprintDeployCore(options) {
             log('Processing assets...');
             for (const resource of preDeployResources) {
                 const preDeployResult = await preDeploy(resource, { auth, installer, log });
-                if (preDeployResult.success === false) {
+                if (!preDeployResult.success)
                     return preDeployResult;
+                const idx = validResources.indexOf(resource);
+                if (idx !== -1) {
+                    validResources[idx] = preDeployResult.resource;
                 }
             }
         }
@@ -152,9 +155,9 @@ async function preDeploy(resource, options) {
         clearTimeout(assetTimeoutTimer);
     }
     if (result.success && result.assetId) {
-        resource.src = result.assetId;
-        fnSpinner.succeed(`${resource.name} ${niceId(result.assetId)}`);
-        log(`   Source: ${resource.src}`);
+        const updatedResource = { ...resource, src: result.assetId };
+        fnSpinner.succeed(`${updatedResource.name} ${niceId(result.assetId)}`);
+        log(`   Source: ${updatedResource.src}`);
         if (result.hash) {
             if (result.hash.length > 24) {
                 log.verbose(`   Hash: ${result.hash.slice(0, 8)}...${result.hash.slice(-12)}`);
@@ -165,11 +168,9 @@ async function preDeploy(resource, options) {
         }
         if (result.exists)
             log.verbose('   Asset unchanged');
+        return { success: true, resource: updatedResource };
     }
-    else {
-        const errorMsg = `Failed uploading ${resource.name} asset, deploy has stopped`;
-        fnSpinner.fail(errorMsg);
-        return { success: false, error: result.error || 'Failed to process asset' };
-    }
-    return { success: true };
+    const errorMsg = `Failed uploading ${resource.name} asset, deploy has stopped`;
+    fnSpinner.fail(errorMsg);
+    return { success: false, error: result.error || 'Failed to process asset' };
 }

package/dist/utils/display/blueprints-formatting.d.ts

@@ -1,9 +1,10 @@
-import type { Blueprint, Resource } from '@sanity/blueprints-parser';
+import type { BlueprintResource } from '@sanity/blueprints';
+import type { Blueprint } from '@sanity/blueprints-parser';
 import type { DeploymentPlan } from '../../actions/blueprints/stacks.js';
 import { type BlueprintResourceRecord, type Stack, type StackSummary } from '../types.js';
 export declare function formatTitle(title: string, name: string): string;
 export declare function formatDeployedResourceTree(resources: BlueprintResourceRecord[] | undefined, verbose?: boolean): string;
-export declare function formatResourceTree(resources: Resource[] | undefined, verbose?: boolean): string;
+export declare function formatResourceTree(resources: BlueprintResource[] | undefined, verbose?: boolean): string;
 export declare function formatStackInfo(stack: Stack | StackSummary | Blueprint, isCurrentStack?: boolean): string;
 export declare function formatStacksListing(stacks: StackSummary[], currentStackId?: string): string;
 export declare function hasActionableChanges(deploymentPlan: DeploymentPlan): boolean;

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

@@ -62,10 +62,11 @@ const categoryByLabel = Object.values(RESOURCE_CATEGORIES).reduce((acc, curr) =>
 }, {});
 function resourceName(res, displayNameAttribute) {
     const nameParts = [styleText(['bold', 'green'], res.name)];
+    const resAsAny = res;
     const displayName = displayNameAttribute &&
         displayNameAttribute in res &&
-        typeof res[displayNameAttribute] === 'string' &&
-        res[displayNameAttribute];
+        typeof resAsAny[displayNameAttribute] === 'string' &&
+        resAsAny[displayNameAttribute];
     if (displayName && displayName !== res.name)
         nameParts.push(styleText('green', `"${displayName}"`));
     return nameParts.join(' ');

package/dist/utils/display/resources-formatting.d.ts

@@ -1,7 +1,6 @@
-import type { BlueprintCorsOriginResource, BlueprintDatasetResource, BlueprintDocumentWebhookResource, BlueprintRobotResource, BlueprintRoleResource } from '@sanity/blueprints';
-import type { Resource } from '@sanity/blueprints-parser';
+import type { BlueprintCorsOriginResource, BlueprintDatasetResource, BlueprintDocumentWebhookResource, BlueprintResource, BlueprintRobotResource, BlueprintRoleResource } from '@sanity/blueprints';
 import type { TreeInput } from 'array-treeify';
-export declare function arrayifyFunction(fn: Resource): TreeInput;
+export declare function arrayifyFunction(fn: BlueprintResource): TreeInput;
 export declare function arrayifyCors(resource: BlueprintCorsOriginResource): TreeInput;
 export declare function arrayifyRobot(resource: BlueprintRobotResource): TreeInput;
 export declare function arrayifyRole(resource: BlueprintRoleResource): TreeInput;

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

@@ -33,11 +33,11 @@ function arrayifyEvent(event) {
 }
 export function arrayifyFunction(fn) {
     const details = [formatLabeledValue('type', fn.type)];
-    if (fn.memory)
+    if ('memory' in fn && fn.memory)
         details.push(formatLabeledValue('memory', fn.memory));
-    if (fn.timeout)
+    if ('timeout' in fn && fn.timeout)
         details.push(formatLabeledValue('timeout', fn.timeout));
-    if (fn.event) {
+    if ('event' in fn && fn.event) {
         const eventDetails = arrayifyEvent(fn.event);
         if (eventDetails) {
             details.push(formatLabel('event'));

package/dist/utils/find-function.d.ts

@@ -1,8 +1,8 @@
-import type { Blueprint } from '@sanity/blueprints-parser';
-import type { DeployedResource, FunctionResource, Stack } from './types.js';
+import type { Blueprint } from '@sanity/blueprints';
+import { type DeployedResource, type FunctionResource, type Stack } from './types.js';
 export declare function getFunctionNames(resources: Array<{
     type?: string;
     name?: string;
 }> | undefined): string[];
-export declare function findFunctionInBlueprint(blueprint: Blueprint, name: string): FunctionResource;
+export declare function findFunctionInBlueprint(blueprint: Pick<Blueprint, 'resources'>, name: string): FunctionResource;
 export declare function findFunctionInStack(stack: Stack, name: string): DeployedResource;

package/dist/utils/find-function.js

@@ -1,4 +1,5 @@
 import { SANITY_FUNCTION_PREFIX } from '../constants.js';
+import { isLocalFunctionResource, } from './types.js';
 export function getFunctionNames(resources) {
     return (resources
         ?.filter((r) => r?.type?.startsWith(SANITY_FUNCTION_PREFIX))
@@ -6,13 +7,13 @@ export function getFunctionNames(resources) {
         .filter((name) => typeof name === 'string') ?? []);
 }
 export function findFunctionInBlueprint(blueprint, name) {
-    const func = blueprint?.resources?.find((r) => r?.type?.startsWith(SANITY_FUNCTION_PREFIX) && r.name === name);
+    const func = blueprint?.resources?.filter(isLocalFunctionResource).find((r) => r.name === name);
     if (!func)
         throw Error(`Unable to find function ${name}`);
     return func;
 }
 export function findFunctionInStack(stack, name) {
-    const func = stack?.resources?.find((r) => r?.type?.startsWith(SANITY_FUNCTION_PREFIX) && r.name === name);
+    const func = stack?.resources?.filter(isLocalFunctionResource).find((r) => r.name === name);
     if (!func)
         throw Error(`Unable to find function: "${name}"`);
     if (!isDeployedResource(func))

package/dist/utils/validate/index.d.ts

@@ -1,4 +1,4 @@
-import type { Resource } from '@sanity/blueprints-parser';
+import { type BlueprintResource } from '@sanity/blueprints';
 import type { BlueprintParserError } from '../types.js';
 export * as validate from './resource.js';
-export declare function validateResources(resources: Resource[]): BlueprintParserError[];
+export declare function validateResources(resources: BlueprintResource[]): BlueprintParserError[];

package/oclif.manifest.json

@@ -2235,5 +2235,5 @@
       ]
     }
   },
-  "version": "14.8.1"
+  "version": "14.8.3"
 }

package/package.json

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