@sanity/runtime-cli 12.1.0 → 12.3.0

package/dist/cores/blueprints/doctor.js

@@ -5,6 +5,7 @@ import { getStack } from '../../actions/blueprints/stacks.js';
 import config from '../../config.js';
 import { capitalize, check, filePathRelativeToCwd, indent, niceId, severe, unsure, } from '../../utils/display/presenters.js';
 import { validTokenOrErrorMessage } from '../../utils/validated-token.js';
+import { blueprintConfigCore } from './config.js';
 const diagLookup = {
     online: 'Online',
     tokenPresent: 'Auth token present',
@@ -17,12 +18,13 @@ const diagLookup = {
     userHasAccess: 'User has access to deployed "Stack"',
 };
 export async function blueprintDoctorCore(options) {
-    const { log, token, flags: { verbose: v, path: p }, } = options;
+    const { bin, log, token, flags: { verbose: v, path: p, fix }, } = options;
     const yikes = (s) => {
         log(chalk.bgRedBright.whiteBright.bold(` ${s} `));
     };
     const here = cwd();
     const path = p || here;
+    let tokenOrError;
     if (v)
         log(`Checking ${filePathRelativeToCwd(path)}`);
     // 3 states: null == unknown, true == good, false == bad
@@ -49,7 +51,7 @@ export async function blueprintDoctorCore(options) {
     // TOKEN
     if (token) {
         diagnostics.tokenPresent = true;
-        const tokenOrError = await validTokenOrErrorMessage(token);
+        tokenOrError = await validTokenOrErrorMessage(token);
         if (tokenOrError.ok) {
             diagnostics.tokenValid = true;
         }
@@ -91,7 +93,8 @@ export async function blueprintDoctorCore(options) {
         diagnostics.blueprintValid = false;
     }
     if (blueprint) {
-        const { configPath, scopeType, scopeId, stackId, projectId } = blueprint;
+        const { blueprintConfig, scopeType, scopeId, stackId, projectId } = blueprint;
+        const configPath = blueprintConfig?.configPath;
         // CONFIG file
         if (configPath) {
             if (v)
@@ -169,11 +172,39 @@ export async function blueprintDoctorCore(options) {
                 log(severe(`${key} is ${value}`));
         }
     }
+    const errorMessage = 'One or more checks failed';
     if (allGood) {
         log(chalk.bold.green('All checks passed'));
+        if (fix)
+            log(chalk.bold.yellow('Nothing to fix; --fix flag is ignored'));
         return { success: true, data: { diagnostics } };
     }
-    else {
-        return { success: false, error: 'One or more checks failed', data: { diagnostics } };
+    else if (fix) {
+        if (p) {
+            return { success: false, error: `${errorMessage}. --fix cannot be used with --path` };
+        }
+        if (!tokenOrError) {
+            return { success: false, error: `${errorMessage}. Unable to fix: Missing authentication token` };
+        }
+        if (tokenOrError?.ok === false) {
+            return {
+                success: false,
+                error: `${errorMessage}. Unable to fix: ${tokenOrError.error.message}`,
+            };
+        }
+        if (!blueprint) {
+            return {
+                success: false,
+                error: `${errorMessage}. Unable to fix: Blueprint is missing or invalid`,
+            };
+        }
+        return blueprintConfigCore({
+            bin,
+            log,
+            token: tokenOrError.value,
+            blueprint,
+            flags: { edit: true, verbose: v },
+        });
     }
+    return { success: false, error: errorMessage, data: { diagnostics } };
 }

package/dist/cores/blueprints/info.js

@@ -1,5 +1,5 @@
 import { getStack } from '../../actions/blueprints/stacks.js';
-import { formatResourceTree, formatStackInfo } from '../../utils/display/blueprints-formatting.js';
+import { formatDeployedResourceTree, formatStackInfo, } from '../../utils/display/blueprints-formatting.js';
 import { niceId } from '../../utils/display/presenters.js';
 export async function blueprintInfoCore(options) {
     const { log, auth, stackId, flags, deployedStack } = options;
@@ -20,7 +20,7 @@ export async function blueprintInfoCore(options) {
         }
         log(formatStackInfo(stack, true));
         if (stack.resources)
-            log(formatResourceTree(stack.resources));
+            log(formatDeployedResourceTree(stack.resources));
         return { success: true };
     }
     catch (error) {

package/dist/cores/functions/env/add.js

@@ -1,11 +1,11 @@
 import chalk from 'chalk';
 import ora from 'ora';
 import { update } from '../../../actions/functions/env/update.js';
-import { findFunctionByName } from '../../../utils/find-function.js';
+import { findFunctionInStack } from '../../../utils/find-function.js';
 export async function functionEnvAddCore(options) {
     const args = options.args;
     const spinner = ora(`Updating "${args.key}" environment variable in "${args.name}"`).start();
-    const { externalId } = findFunctionByName(options.deployedStack, args.name);
+    const { externalId } = findFunctionInStack(options.deployedStack, args.name);
     const result = await update(externalId, args.key, args.value, options.auth);
     if (!result.ok) {
         spinner.fail(`${chalk.red('Failed')} to update ${args.key}`);

package/dist/cores/functions/env/list.js

@@ -1,10 +1,10 @@
 import ora from 'ora';
 import { list } from '../../../actions/functions/env/list.js';
-import { findFunctionByName } from '../../../utils/find-function.js';
+import { findFunctionInStack } from '../../../utils/find-function.js';
 export async function functionEnvListCore(options) {
     const args = options.args;
     const spinner = ora(`Listing environment variables for "${args.name}"`).start();
-    const { externalId } = findFunctionByName(options.deployedStack, args.name);
+    const { externalId } = findFunctionInStack(options.deployedStack, args.name);
     const result = await list(externalId, options.auth);
     if (!result.ok) {
         spinner.stop();

package/dist/cores/functions/env/remove.js

@@ -1,11 +1,11 @@
 import chalk from 'chalk';
 import ora from 'ora';
 import { remove } from '../../../actions/functions/env/remove.js';
-import { findFunctionByName } from '../../../utils/find-function.js';
+import { findFunctionInStack } from '../../../utils/find-function.js';
 export async function functionEnvRemoveCore(options) {
     const args = options.args;
     const spinner = ora(`Removing "${args.key}" environment variable in "${args.name}"`).start();
-    const { externalId } = findFunctionByName(options.deployedStack, args.name);
+    const { externalId } = findFunctionInStack(options.deployedStack, args.name);
     const result = await remove(externalId, args.key, options.auth);
     if (!result.ok) {
         spinner.fail(`${chalk.red('Failed')} to remove ${args.key}`);

package/dist/cores/functions/logs.js

@@ -4,12 +4,12 @@ import ora from 'ora';
 import { deleteLogs as deleteLogsAction, logs as getLogsAction, streamLogs as streamLogsAction, } from '../../actions/functions/logs.js';
 import { formatTitle } from '../../utils/display/blueprints-formatting.js';
 import { niceId } from '../../utils/display/presenters.js';
-import { findFunctionByName } from '../../utils/find-function.js';
+import { findFunctionInStack } from '../../utils/find-function.js';
 export async function functionLogsCore(options) {
     const { args, flags, log, auth, deployedStack } = options;
     const { name } = args;
     const { delete: shouldDelete, watch: shouldWatch, force, limit, json, utc } = flags;
-    const { externalId } = findFunctionByName(deployedStack, name); // throws if not found
+    const { externalId } = findFunctionInStack(deployedStack, name); // throws if not found
     if (shouldDelete)
         return deleteLogs({ name, externalId, auth, force, log });
     if (shouldWatch)

package/dist/cores/functions/test.js

@@ -4,11 +4,12 @@ import { cwd } from 'node:process';
 import ora from 'ora';
 import { testAction } from '../../actions/functions/test.js';
 import config from '../../config.js';
+import { SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET } from '../../constants.js';
 import buildPayload from '../../utils/build-payload.js';
-import { findFunctionByName } from '../../utils/find-function.js';
+import { findFunctionInBlueprint } from '../../utils/find-function.js';
 import { fetchAsset, fetchDocument } from '../../utils/functions/fetch-document.js';
 import { parseJsonObject } from '../../utils/parse-json-object.js';
-import { isEventType, } from '../../utils/types.js';
+import { isEventType, isGroqContextOptions, } from '../../utils/types.js';
 export async function functionTestCore(options) {
     const { blueprint, log, args, flags } = options;
     const { name: fnName } = args;
@@ -29,22 +30,25 @@ export async function functionTestCore(options) {
         };
     }
     try {
-        const resource = findFunctionByName(parsedBlueprint, fnName); // throws if not found
-        const docFunction = resource.type === 'sanity.function.document';
-        const contextOptions = {
-            clientOptions: {
-                apiVersion: api,
-                dataset,
-                projectId,
-                organizationId,
-            },
-            eventResourceType: docFunction ? 'dataset' : 'media-library',
-            eventResourceId: (docFunction ? `${projectId}.${dataset}` : mediaLibraryId) || '',
-            functionResourceType: 'project',
-            functionResourceId: (docFunction ? projectId : organizationId) || '',
-        };
+        const resource = findFunctionInBlueprint(parsedBlueprint, fnName); // throws if not found
+        const docFunction = resource.type === SANITY_FUNCTION_DOCUMENT;
+        const mediaFunction = resource.type === SANITY_FUNCTION_MEDIA_LIBRARY_ASSET;
+        const contextOptions = docFunction || mediaFunction
+            ? {
+                clientOptions: {
+                    apiVersion: api,
+                    dataset,
+                    projectId,
+                    organizationId,
+                },
+                eventResourceType: docFunction ? 'dataset' : 'media-library',
+                eventResourceId: (docFunction ? `${projectId}.${dataset}` : mediaLibraryId) || '',
+                functionResourceType: 'project',
+                functionResourceId: projectId || '',
+            }
+            : {};
         // If the user sets the flag to use the real token set it in our options
-        if (withUserToken) {
+        if (withUserToken && isGroqContextOptions(contextOptions)) {
             contextOptions.clientOptions.token = config.token || undefined;
         }
         let before = null;
@@ -115,12 +119,16 @@ export async function functionTestCore(options) {
                 payload = buildPayload({ data, file });
             }
         }
-        const invokeOptions = {
-            event: eventType,
-            payload,
-            before,
-            after,
-        };
+        const invokeOptions = docFunction || mediaFunction
+            ? {
+                event: eventType,
+                payload,
+                before,
+                after,
+            }
+            : {
+                event: 'schedule',
+            };
         const spinner = ora('Executing function...').start();
         const { json, logs, error } = await testAction(resource, invokeOptions, contextOptions, {
             timeout: timeout ? timeout : resource.timeout,

package/dist/server/app.js

@@ -5,7 +5,7 @@ import { WebSocketServer } from 'ws';
 import { readLocalBlueprint } from '../actions/blueprints/blueprint.js';
 import config from '../config.js';
 import { isRecord } from '../utils/is-record.js';
-import { isEventType, } from '../utils/types.js';
+import { isEventType, isGroqContextOptions, } from '../utils/types.js';
 import { handleInvokeRequest } from './handlers/invoke.js';
 const app = (host, port, executionOptions) => {
     const requestListener = async (req, res) => {
@@ -34,11 +34,13 @@ const app = (host, port, executionOptions) => {
                             const { data, func: functionName, metadata } = parseInvokeRequest(Buffer.concat(body));
                             const { context, event } = data;
                             // replace user token if required
-                            if (context.clientOptions.token) {
-                                context.clientOptions.token = config.token || undefined;
-                            }
-                            else {
-                                delete context.clientOptions.token;
+                            if (isGroqContextOptions(context)) {
+                                if (context.clientOptions.token) {
+                                    context.clientOptions.token = config.token || undefined;
+                                }
+                                else {
+                                    delete context.clientOptions.token;
+                                }
                             }
                             const result = await handleInvokeRequest(functionName, event, metadata, context, executionOptions);
                             // Add Server-Timing header
@@ -324,21 +326,30 @@ function parseInvokeRequest(body) {
         throw new Error('Request body is not valid, `metadata.event` field is missing');
     }
     const metadataEvent = metadata.event;
-    if (typeof metadataEvent !== 'string' || !isEventType(metadataEvent)) {
-        throw new Error('Request body is not valid, `metadata.event` field is not one of `create`, `update`, or `delete`');
-    }
-    if (!('before' in metadata)) {
-        throw new Error('Request body is not valid, `metadata.before` field is missing');
-    }
-    if (!('after' in metadata)) {
-        throw new Error('Request body is not valid, `metadata.after` field is missing');
-    }
-    const { before, after } = metadata;
-    if (!isRecord(before) && before !== null) {
-        throw new Error('Request body is not valid, `metadata.before` field is not an object');
+    if (typeof metadataEvent !== 'string' ||
+        (!isEventType(metadataEvent) && metadataEvent !== 'schedule')) {
+        throw new Error('Request body is not valid, `metadata.event` field is not one of `create`, `update`, `delete`, or `schedule`');
     }
-    if (!isRecord(after) && after !== null) {
-        throw new Error('Request body is not valid, `metadata.after` field is not an object');
+    let before = null;
+    let after = null;
+    // Only GROQ-based events (create, update, delete) have before and after fields
+    if (metadataEvent !== 'schedule') {
+        if (!('before' in metadata)) {
+            throw new Error('Request body is not valid, `metadata.before` field is missing');
+        }
+        if (!('after' in metadata)) {
+            throw new Error('Request body is not valid, `metadata.after` field is missing');
+        }
+        const beforeValue = metadata.before;
+        const afterValue = metadata.after;
+        if (!isRecord(beforeValue) && beforeValue !== null) {
+            throw new Error('Request body is not valid, `metadata.before` field is not an object');
+        }
+        if (!isRecord(afterValue) && afterValue !== null) {
+            throw new Error('Request body is not valid, `metadata.after` field is not an object');
+        }
+        before = beforeValue;
+        after = afterValue;
     }
     const clientOptions = {
         ...context.clientOptions,
@@ -361,7 +372,7 @@ function parseInvokeRequest(body) {
             },
             event,
         },
-        metadata: { event: metadataEvent, before, after },
+        metadata: metadataEvent === 'schedule' ? { event: metadataEvent } : { event: metadataEvent, before, after },
     };
 }
 export { app, buildApiUrl, parseDocumentUrl };

package/dist/server/handlers/invoke.d.ts

@@ -1,4 +1,4 @@
-import type { InvocationResponse, InvokeContextOptions, InvokeExecutionOptions, InvokePayloadOptions } from '../../utils/types.js';
-export declare function handleInvokeRequest(functionName: string, event: Record<string, unknown>, metadata: Pick<InvokePayloadOptions, 'event' | 'before' | 'after'>, context: InvokeContextOptions, executionOptions?: Partial<InvokeExecutionOptions>): Promise<InvocationResponse & {
+import type { InvocationResponse, InvokeContextOptions, InvokeExecutionOptions, InvokePayloadMetadata } from '../../utils/types.js';
+export declare function handleInvokeRequest(functionName: string, event: Record<string, unknown>, metadata: InvokePayloadMetadata, context: InvokeContextOptions, executionOptions?: Partial<InvokeExecutionOptions>): Promise<InvocationResponse & {
     timings: Record<string, number>;
 }>;

package/dist/server/handlers/invoke.js

@@ -1,10 +1,10 @@
 import { readLocalBlueprint } from '../../actions/blueprints/blueprint.js';
-import { findFunctionByName } from '../../utils/find-function.js';
+import { findFunctionInBlueprint } from '../../utils/find-function.js';
 import invoke from '../../utils/invoke-local.js';
 export async function handleInvokeRequest(functionName, event, metadata, context, executionOptions) {
     const start = performance.now();
     const { parsedBlueprint } = await readLocalBlueprint();
-    const resource = findFunctionByName(parsedBlueprint, functionName);
+    const resource = findFunctionInBlueprint(parsedBlueprint, functionName);
     const readBlueprintTime = performance.now() - start;
     const payload = {
         payload: event,

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

@@ -7,5 +7,8 @@ export class ApiBaseElement extends HTMLElement {
   constructor() {
     super()
     this.api = api
+    this.SANITY_FUNCTION_DOCUMENT = 'sanity.function.document'
+    this.SANITY_FUNCTION_MEDIA_LIBRARY_ASSET = 'sanity.function.media-library.asset'
+    this.SANITY_FUNCTION_SCHEDULE = 'sanity.function.cron'
   }
 }