@sanity/runtime-cli 17.3.2 → 17.4.0-blueprinit.g596ac51

package/dist/cores/blueprinit/selection.js

@@ -0,0 +1,90 @@
+import { select } from '@inquirer/prompts';
+export async function chooseOrganization(groups, organizationId, interactive) {
+    if (groups.length === 0) {
+        return failure('No organizations found for this account.');
+    }
+    if (organizationId) {
+        const organization = groups.find((group) => group.organization.id === organizationId);
+        return organization
+            ? { ok: true, value: organization }
+            : failure(`No organization "${organizationId}" found for this account.`);
+    }
+    if (groups.length === 1)
+        return { ok: true, value: groups[0] };
+    if (!interactive) {
+        return failure('Multiple organizations found.', ['Pass --organization-id <id> to choose one.']);
+    }
+    const selectedId = await select({
+        message: 'Choose a Sanity organization:',
+        choices: groups.map(({ organization, projects }) => ({
+            name: organization.name,
+            value: organization.id,
+            description: `${projects?.length ?? 0} projects`,
+        })),
+    });
+    const selected = groups.find(({ organization }) => organization.id === selectedId);
+    return selected ? { ok: true, value: selected } : failure('Organization not found.');
+}
+export async function chooseProject(projects, projectId, organizationName, interactive) {
+    if (projects.length === 0) {
+        return failure(`No projects found in ${organizationName}.`);
+    }
+    if (projectId) {
+        const project = projects.find(({ id }) => id === projectId);
+        return project
+            ? { ok: true, value: project }
+            : failure(`No project "${projectId}" found in ${organizationName}.`);
+    }
+    if (projects.length === 1)
+        return { ok: true, value: projects[0] };
+    if (!interactive) {
+        return failure('Multiple projects found.', ['Pass --project-id <id> to choose one.']);
+    }
+    const selectedId = await select({
+        message: 'Choose a Sanity project:',
+        choices: projects.map((project) => ({ name: project.displayName, value: project.id })),
+    });
+    const selected = projects.find(({ id }) => id === selectedId);
+    return selected ? { ok: true, value: selected } : failure('Project not found.');
+}
+export async function chooseDataset(datasets, datasetName, projectName, interactive) {
+    if (datasets.length === 0) {
+        return failure(`No datasets found in ${projectName}.`);
+    }
+    if (datasetName) {
+        const dataset = datasets.find(({ name }) => name === datasetName);
+        return dataset
+            ? { ok: true, value: dataset }
+            : failure(`No dataset "${datasetName}" found in ${projectName}.`);
+    }
+    if (datasets.length === 1)
+        return { ok: true, value: datasets[0] };
+    if (!interactive) {
+        return failure('Multiple datasets found.', ['Pass --dataset <name> to choose one.']);
+    }
+    const production = datasets.find(({ name }) => name === 'production');
+    const orderedDatasets = production
+        ? [production, ...datasets.filter(({ name }) => name !== 'production')]
+        : datasets;
+    const selectedName = await select({
+        message: 'Choose a Sanity dataset:',
+        choices: orderedDatasets.map((dataset) => ({
+            name: dataset.name,
+            value: dataset.name,
+            description: dataset.aclMode,
+        })),
+    });
+    const selected = datasets.find(({ name }) => name === selectedName);
+    return selected ? { ok: true, value: selected } : failure('Dataset not found.');
+}
+export function findProject(groups, projectId) {
+    for (const { organization, projects = [] } of groups) {
+        const project = projects.find(({ id }) => id === projectId);
+        if (project)
+            return { organization, project };
+    }
+    return undefined;
+}
+function failure(message, suggestions) {
+    return { ok: false, error: { message, suggestions } };
+}

package/dist/cores/blueprinit/types.d.ts

@@ -0,0 +1,16 @@
+import type { Logger } from '../../utils/logger.js';
+export interface BlueprinitFlags {
+    yes?: boolean;
+    organizationId?: string;
+    projectId?: string;
+    datasetName?: string;
+    stackName?: string;
+    studioName?: string;
+}
+export interface BlueprinitFlowOptions {
+    bin: string;
+    dir: string;
+    flags: BlueprinitFlags;
+    log: Logger;
+    token: string;
+}

package/dist/cores/blueprinit/types.js

@@ -0,0 +1 @@
+export {};

package/dist/cores/blueprinit.d.ts

@@ -0,0 +1,7 @@
+import type { BlueprinitFlags } from './blueprinit/types.js';
+import type { CoreConfig, CoreResult } from './index.js';
+export interface BlueprinitOptions extends CoreConfig {
+    dir?: string;
+    flags?: BlueprinitFlags;
+}
+export declare function blueprinitCore(options: BlueprinitOptions): Promise<CoreResult>;

package/dist/cores/blueprinit.js

@@ -0,0 +1,48 @@
+import { cwd } from 'node:process';
+import { detectStudio } from '../actions/blueprinit/studio.js';
+import { findBlueprintFile } from '../actions/blueprints/blueprint.js';
+import { readConfigFile } from '../actions/blueprints/config.js';
+import { validTokenOrErrorMessage } from '../utils/validated-token.js';
+import { adoptFlow } from './blueprinit/adopt.js';
+import { freshFlow } from './blueprinit/fresh.js';
+export async function blueprinitCore(options) {
+    const { bin, log, flags = {}, dir = cwd() } = options;
+    try {
+        const existingBlueprint = findBlueprintFile(dir);
+        if (existingBlueprint) {
+            const blueprintConfig = readConfigFile(existingBlueprint.blueprintFilePath);
+            if (!blueprintConfig?.stackId) {
+                return {
+                    success: false,
+                    error: `A Blueprint exists here (${existingBlueprint.fileName}), but it is not connected to a Stack.`,
+                    suggestions: [`Finish setup with: npx ${bin} blueprints init`],
+                };
+            }
+            log(`A blueprint already exists here (${existingBlueprint.fileName}).`);
+            log('');
+            log('Use these instead:');
+            log(`  npx ${bin} blueprints config --edit`);
+            log(`  npx ${bin} blueprints doctor`);
+            return {
+                success: true,
+                json: { alreadyInitialized: true, blueprintFile: existingBlueprint.fileName },
+            };
+        }
+        const tokenCheck = await validTokenOrErrorMessage(log);
+        if (!tokenCheck.ok) {
+            return {
+                success: false,
+                error: 'No Sanity session found.',
+                suggestions: ['Sign in first: npx sanity login', 'Then run blueprinit again.'],
+            };
+        }
+        log('Setting up your Sanity workspace.');
+        log('');
+        const flowOptions = { bin, dir, flags, log, token: tokenCheck.value };
+        const studio = detectStudio(dir);
+        return studio ? await adoptFlow({ ...flowOptions, studio }) : await freshFlow(flowOptions);
+    }
+    catch (error) {
+        return { success: false, error: error instanceof Error ? error.message : String(error) };
+    }
+}

package/dist/cores/blueprints/deploy.js

@@ -4,21 +4,21 @@ 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 { createHintCollector } from '../../utils/blueprints/hints.js';
-import { niceId } from '../../utils/display/presenters.js';
+import { check, niceId, severe } from '../../utils/display/presenters.js';
 import { CODE_OPERATION_UNCONFIRMED, EXIT_OPERATION_UNCONFIRMED } from '../../utils/exit-codes.js';
 import { styleText } from '../../utils/style-text.js';
 import { getWarnings } from '../../utils/warnings.js';
 export async function blueprintDeployCore(options) {
-    const { bin = 'sanity', log, auth, stackId, scopeType, scopeId, deployedStack, blueprint, flags, } = options;
+    const { bin = 'sanity', log: logger, auth, stackId, scopeType, scopeId, deployedStack, blueprint, flags, } = options;
     const { verbose } = flags;
     const noWait = flags['no-wait'] || false;
     const stackName = flags['new-stack-name'] ?? deployedStack.name;
     const installer = flags['fn-installer'] || undefined;
     const blueprintFileDir = dirname(blueprint.fileInfo.blueprintFilePath);
     const workspaceWarnings = getWarnings({ dir: blueprintFileDir });
-    log(`Deploying "${stackName}" ${niceId(deployedStack.id)}...`);
+    logger(`Deploying "${stackName}" ${niceId(deployedStack.id)}...`);
     try {
-        const { ok: checkOk, stack: currentStack } = await getStack({ stackId, auth, logger: log });
+        const { ok: checkOk, stack: currentStack } = await getStack({ stackId, auth, logger });
         if (!checkOk) {
             return { success: false, error: 'Failed to check current Stack status' };
         }
@@ -37,20 +37,20 @@ export async function blueprintDeployCore(options) {
         const preDeployResult = await preDeploy({
             scopeType,
             scopeId,
-            resources,
+            resources, // mutated by preDeploy
             stackId,
             stackName,
             auth,
             blueprintFileDir,
             installer,
-            log,
+            logger,
             bin,
             verbose,
+            onAssetEvent: createAssetEventHandler(logger),
         });
-        if (!preDeployResult?.success) {
+        if (!preDeployResult?.success)
             return preDeployResult;
-        }
-        const spinner = log.ora('Deploying...').start();
+        const deploySpinner = logger.ora('Deploying...').start();
         const { ok: deployOk, stack, error: deployError, } = await updateStack({
             stackId,
             stackMutation: {
@@ -61,10 +61,10 @@ export async function blueprintDeployCore(options) {
                 userMessage: flags.message,
             },
             auth,
-            logger: log,
+            logger,
         });
         if (!deployOk) {
-            spinner.fail(`${styleText('red', 'Failed')} to update Stack deployment`);
+            deploySpinner.fail(`${styleText('red', 'Failed')} to update Stack deployment`);
             const hints = createHintCollector(bin);
             if (deployError) {
                 hints.inspectMessage(deployError);
@@ -79,18 +79,18 @@ export async function blueprintDeployCore(options) {
                 ],
             };
         }
-        spinner.stop().clear();
+        deploySpinner.stop().clear();
         const legacyPermissionsNoticePromise = CHECK_LEGACY_DEPLOY_PERMISSION
             ? checkLegacyDeployPermission({
                 auth,
                 scopeType,
                 scopeId,
-                log,
+                log: logger,
             })
             : Promise.resolve(null);
         if (noWait) {
-            log(styleText(['bold', 'green'], 'Stack deployment started!'));
-            log(`Use \`npx ${bin} blueprints info\` to check status`);
+            logger(styleText(['bold', 'green'], 'Stack deployment started!'));
+            logger(`Use \`npx ${bin} blueprints info\` to check status`);
             const legacyWarning = await legacyPermissionsNoticePromise;
             const warnings = [...(legacyWarning ? [legacyWarning] : []), ...workspaceWarnings];
             return {
@@ -100,19 +100,19 @@ export async function blueprintDeployCore(options) {
                 warnings: warnings.length ? warnings : undefined,
             };
         }
-        log(styleText('dim', 'Stack deployment progress:'));
-        log('');
+        logger(styleText('dim', 'Stack deployment progress:'));
+        logger('');
         const outcome = await waitForOperation({
             stackId,
             operationId: stack.operationId,
             auth,
-            log,
+            log: logger,
             bin,
             verbose,
             progressNoun: 'deployment',
         });
         if (outcome.type === 'completed') {
-            log(styleText(['bold', 'green'], 'Stack deployment completed!'));
+            logger(styleText(['bold', 'green'], 'Stack deployment completed!'));
             const legacyWarning = await legacyPermissionsNoticePromise;
             const warnings = [...(legacyWarning ? [legacyWarning] : []), ...workspaceWarnings];
             return {
@@ -151,6 +151,56 @@ export async function blueprintDeployCore(options) {
         return { success: false, error: errorMessage };
     }
 }
+function createAssetEventHandler(logger) {
+    let spinner;
+    const results = [];
+    return (event) => {
+        switch (event.type) {
+            case 'progress': {
+                const { completed, total, slow } = event.progress;
+                const text = [
+                    `Processing assets (${completed}/${total})`,
+                    slow ? ', this can take a moment' : '',
+                ].join('');
+                if (spinner)
+                    spinner.text = text;
+                else
+                    spinner = logger.ora(text).start();
+                return;
+            }
+            case 'result': {
+                results.push(event.result);
+                return;
+            }
+            case 'complete': {
+                spinner?.stop();
+                spinner = undefined;
+                break;
+            }
+        }
+        // done. print report
+        for (const result of results) {
+            const { resource } = result;
+            if (!result.success) {
+                const summary = result.failureKind === 'upload'
+                    ? `Failed uploading ${resource.name} asset`
+                    : `Failed processing ${resource.name} asset`;
+                logger(` ${severe(summary)}`);
+                logger.error(`   ${result.error}`);
+                continue;
+            }
+            logger(` ${check(`${resource.name} ${niceId(resource.src)}`)}`);
+            logger(`   Source: ${resource.src}`);
+            if (result.hash) {
+                const hash = result.hash;
+                const h = hash.length > 24 ? `${hash.slice(0, 8)}...${hash.slice(-12)}` : hash;
+                logger.verbose(`   Hash: ${h}`);
+            }
+            if (result.exists)
+                logger.verbose('   Asset unchanged');
+        }
+    };
+}
 const CHECK_LEGACY_DEPLOY_PERMISSION = false;
 const BLUEPRINTS_PERMISSION_ENFORCEMENT_DATE = 'July 1, 2026';
 async function checkLegacyDeployPermission({ auth, scopeType, scopeId, log, }) {

package/dist/cores/functions/add.js

@@ -224,7 +224,7 @@ async function promptForFunctionName() {
     const functionName = await input({
         message: 'Enter function name:',
         validate: (input) => validateFunctionName(input) ||
-            'Invalid function name. Must be 6+ characters, no special characters, no spaces',
+            'Invalid function name. Must be 3+ characters, no special characters, no spaces',
     });
     return functionName;
 }

package/dist/cores/functions/list.d.ts

@@ -0,0 +1,10 @@
+import type { AuthParams } from '../../utils/types.js';
+import type { CoreConfig, CoreResult } from '../index.js';
+export interface FunctionListOptions extends Pick<CoreConfig, 'log'> {
+    auth: AuthParams;
+    flags: {
+        json?: boolean;
+        verbose?: boolean;
+    };
+}
+export declare function functionListCore(options: FunctionListOptions): Promise<CoreResult>;

package/dist/cores/functions/list.js

@@ -0,0 +1,34 @@
+import { listFunctions } from '../../actions/functions/list.js';
+import { formatFunctionsList } from '../../utils/display/functions-formatting.js';
+import { capitalize, niceId } from '../../utils/display/presenters.js';
+import { styleText } from '../../utils/style-text.js';
+export async function functionListCore(options) {
+    const { auth, flags, log } = options;
+    const { scopeId, scopeType } = auth;
+    const spinner = flags.json ? undefined : log.ora('Fetching functions...').start();
+    const result = await listFunctions(auth, log);
+    if (!result.ok) {
+        spinner?.fail('Failed to list functions');
+        const suggestions = /access|permission|forbidden/i.test(result.error)
+            ? [
+                `Verify you have access to ${scopeType} "${scopeId}".`,
+                'Try a different scope with --project-id or --organization-id.',
+            ]
+            : undefined;
+        return { success: false, error: result.error, suggestions };
+    }
+    spinner?.stop().clear();
+    if (!flags.json) {
+        if (result.functions.length === 0) {
+            log(`No functions found for ${scopeType} ${niceId(scopeId)}`);
+        }
+        else {
+            log(`${styleText('bold', capitalize(scopeType))} ${niceId(scopeId)} ${styleText('bold', 'Functions')} [${result.functions.length}]:`);
+            log(formatFunctionsList(result.functions, { verbose: flags.verbose }));
+        }
+    }
+    return {
+        success: true,
+        json: { functions: result.functions, scopeType, scopeId },
+    };
+}

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

@@ -72,15 +72,15 @@ function resourceName(res, displayNameAttribute) {
         nameParts.push(styleText('green', `"${displayName}"`));
     return nameParts.join(' ');
 }
-function deployedResourceName(res, displayNameAttribute, _verbose = false) {
+function deployedResourceName(res, displayNameAttribute, verbose = false) {
     const nameParts = [styleText(['bold', 'green'], res.name)];
     const displayName = displayNameAttribute &&
         typeof res.parameters[displayNameAttribute] === 'string' &&
         res.parameters[displayNameAttribute];
     if (displayName && displayName !== res.name)
         nameParts.push(styleText('green', `"${displayName}"`));
-    // if (verbose)
-    nameParts.push(idList(res));
+    if (verbose)
+        nameParts.push(idList(res));
     return nameParts.join(' ');
 }
 function idList(res) {

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

@@ -0,0 +1,7 @@
+import type { DeployedFunction } from '../../actions/functions/list.js';
+export declare function formatFunctionsList(functions: DeployedFunction[], options?: {
+    verbose?: boolean;
+}): string;
+export declare function formatFunction(fn: DeployedFunction, options?: {
+    verbose?: boolean;
+}): string;

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

@@ -0,0 +1,95 @@
+import { SANITY_FUNCTION_PREFIX } from '../../constants.js';
+import { styleText } from '../style-text.js';
+import { formatDateTime } from './dates.js';
+import { niceId, renderSection } from './presenters.js';
+export function formatFunctionsList(functions, options = {}) {
+    if (!options.verbose)
+        return formatCompactList(functions);
+    return functions.map((fn) => formatFunction(fn, options)).join('\n');
+}
+export function formatFunction(fn, options = {}) {
+    if (!options.verbose)
+        return formatCompactList([fn]);
+    const rows = [];
+    if (fn.type)
+        rows.push(['Type', shortType(fn.type)]);
+    if (fn.updatedAt) {
+        const updatedAt = formatDateTime(fn.updatedAt);
+        if (updatedAt)
+            rows.push(['Updated', updatedAt]);
+    }
+    if (typeof fn.memory === 'number')
+        rows.push(['Memory', `${fn.memory} MB`]);
+    if (typeof fn.timeout === 'number')
+        rows.push(['Timeout', `${fn.timeout}s`]);
+    const rule = formatEventRule(fn.eventRule);
+    if (rule)
+        rows.push(['Rule', rule]);
+    return renderSection(formatTitle(fn), rows);
+}
+function formatCompactList(functions) {
+    const titles = functions.map(plainTitle);
+    const ids = functions.map((fn) => `<${fn.id}>`);
+    const types = functions.map((fn) => (fn.type ? shortType(fn.type) : '-'));
+    const updated = functions.map((fn) => (fn.updatedAt ? formatDateTime(fn.updatedAt) || '-' : '-'));
+    const titlePad = Math.max(...titles.map((title) => title.length));
+    const idPad = Math.max(...ids.map((id) => id.length));
+    const typePad = Math.max(...types.map((type) => type.length));
+    return functions
+        .map((fn, index) => {
+        const title = formatIdentity(fn) + ' '.repeat(titlePad - titles[index].length);
+        const id = niceId(fn.id) + ' '.repeat(idPad - ids[index].length);
+        const type = styleText('dim', types[index].padEnd(typePad));
+        const timestamp = styleText('dim', updated[index]);
+        return `  ${title}  ${id}  ${type}  ${timestamp}`;
+    })
+        .join('\n');
+}
+function formatTitle(fn) {
+    return `${formatIdentity(fn)} ${niceId(fn.id)}`;
+}
+function formatIdentity(fn) {
+    const parts = [];
+    if (fn.name)
+        parts.push(styleText('bold', fn.name));
+    if (fn.displayName && fn.displayName !== fn.name) {
+        parts.push(styleText('green', `"${fn.displayName}"`));
+    }
+    if (parts.length === 0)
+        parts.push(styleText('bold', 'Unnamed'));
+    return parts.join(' ');
+}
+function plainTitle(fn) {
+    const parts = [];
+    if (fn.name)
+        parts.push(fn.name);
+    if (fn.displayName && fn.displayName !== fn.name)
+        parts.push(`"${fn.displayName}"`);
+    return parts.length > 0 ? parts.join(' ') : 'Unnamed';
+}
+function shortType(type) {
+    return type.startsWith(SANITY_FUNCTION_PREFIX) ? type.slice(SANITY_FUNCTION_PREFIX.length) : type;
+}
+function formatEventRule(rule) {
+    if (rule === null || rule === undefined)
+        return undefined;
+    if (typeof rule !== 'object')
+        return String(rule);
+    if (Array.isArray(rule))
+        return rule.map(formatRuleValue).join(', ');
+    const entries = Object.entries(rule);
+    if (entries.length === 0)
+        return undefined;
+    return entries.map(([key, value]) => `${key}: ${formatRuleValue(value)}`).join(' · ');
+}
+function formatRuleValue(value) {
+    if (typeof value === 'string')
+        return value;
+    if (value === null || value === undefined)
+        return String(value);
+    if (Array.isArray(value))
+        return value.map(formatRuleValue).join(', ');
+    if (typeof value === 'object')
+        return JSON.stringify(value);
+    return String(value);
+}

package/dist/utils/style-text.js

@@ -1,3 +1,4 @@
+// TODO: move to ./display
 import { env } from 'node:process';
 import { styleText as nodeStyleText } from 'node:util';
 import { isInteractive } from './interactive.js';