@sanity/runtime-cli 17.1.0-next.gcfbd613 → 17.2.0-blueprinit.g3a96975

package/dist/cores/blueprinit/adopt.js

@@ -0,0 +1,90 @@
+import { existsSync } from 'node:fs';
+import { join } from 'node:path';
+import { slugify } from '../../actions/blueprinit/manifest.js';
+import { adoptWorkspace } from '../../actions/blueprinit/workspace.js';
+import { listDatasets } from '../../actions/sanity/datasets.js';
+import { groupProjectsByOrganization } from '../../actions/sanity/projects.js';
+import { check } from '../../utils/display/presenters.js';
+import { getLatestNpmVersion } from '../../utils/external/npmjs.js';
+import { isInteractive } from '../../utils/interactive.js';
+import { createStackAndFinish } from './finish.js';
+import { confirmUnlessSkipped, promptForStudioName } from './prompts.js';
+import { findProject } from './selection.js';
+export async function adoptFlow(options) {
+    const { bin, dir, flags, log, studio, token } = options;
+    if (!studio.projectId || !studio.dataset) {
+        return {
+            success: false,
+            error: `Found ${studio.configFile}, but could not read a projectId and dataset from it.`,
+            suggestions: ['Use literal projectId and dataset values in the Studio config.'],
+        };
+    }
+    if (flags.projectId && flags.projectId !== studio.projectId) {
+        return { success: false, error: `The Studio uses project "${studio.projectId}".` };
+    }
+    log(check(`Studio detected (${studio.configFile})`));
+    const grouped = await groupProjectsByOrganization({ token, logger: log });
+    if (!grouped.ok) {
+        return { success: false, error: `Could not list organizations: ${grouped.error}` };
+    }
+    const match = findProject(grouped.organizations, studio.projectId);
+    if (!match) {
+        return {
+            success: false,
+            error: `Project "${studio.projectId}" from ${studio.configFile} was not found in your account.`,
+        };
+    }
+    if (flags.organizationId && flags.organizationId !== match.organization.id) {
+        return {
+            success: false,
+            error: `Project "${studio.projectId}" belongs to organization "${match.organization.id}".`,
+        };
+    }
+    const datasets = await listDatasets({ token, projectId: match.project.id, logger: log });
+    if (!datasets.ok) {
+        return { success: false, error: `Could not list datasets: ${datasets.error}` };
+    }
+    if (!datasets.datasets.some(({ name }) => name === studio.dataset)) {
+        return {
+            success: false,
+            error: `Dataset "${studio.dataset}" was not found in project ${match.project.displayName}.`,
+        };
+    }
+    log(check(`Matches project ${match.project.displayName} (${match.project.id}), dataset ${studio.dataset}`));
+    log('');
+    const confirmed = await confirmUnlessSkipped(flags, isInteractive, 'Adopt this Studio into a Blueprint?');
+    if (!confirmed)
+        return { success: false, error: 'Initialization cancelled.' };
+    const studioName = await promptForStudioName(flags, isInteractive);
+    const stackName = slugify(match.project.displayName) || match.project.id;
+    const marker = (file) => (existsSync(join(dir, file)) ? '~' : '+');
+    log('Changes:');
+    log("  + sanity.blueprint.ts             attach project + dataset; adopt Studio at '.'");
+    log(`  + .sanity/blueprint.config.json   org scope, stack ${stackName}`);
+    log(`  ${marker('.gitignore')} .gitignore`);
+    log(`  ${marker('package.json')} package.json`);
+    log('');
+    const adoption = adoptWorkspace({
+        dir,
+        projectId: match.project.id,
+        displayName: match.project.displayName,
+        datasetName: studio.dataset,
+        stackName,
+        studioName,
+        blueprintsVersion: await getLatestNpmVersion('@sanity/blueprints', log),
+    });
+    return await createStackAndFinish({
+        ...options,
+        organizationId: match.organization.id,
+        projectId: match.project.id,
+        datasetName: studio.dataset,
+        stackName,
+        blueprintFilePath: adoption.blueprintFilePath,
+        files: adoption.files,
+        nextSteps: [
+            `  npx ${bin} blueprints plan`,
+            `  npx ${bin} blueprints deploy`,
+            `  npx ${bin} blueprints info`,
+        ],
+    });
+}

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

@@ -0,0 +1,14 @@
+import type { CoreResult } from '../index.js';
+import type { BlueprinitFlowOptions } from './types.js';
+interface FinishOptions extends BlueprinitFlowOptions {
+    organizationId: string;
+    projectId: string;
+    datasetName: string;
+    stackName: string;
+    blueprintFilePath: string;
+    files: string[];
+    nextSteps: string[];
+}
+export declare function createStackAndFinish(options: FinishOptions): Promise<CoreResult>;
+export declare function alignSteps(steps: Array<[command: string, description?: string]>): string[];
+export {};

package/dist/cores/blueprinit/finish.js

@@ -0,0 +1,36 @@
+import { writeConfigFile } from '../../actions/blueprints/config.js';
+import { createEmptyStack } from '../../actions/blueprints/stacks.js';
+import { check } from '../../utils/display/presenters.js';
+export async function createStackAndFinish(options) {
+    const stack = await createEmptyStack({
+        token: options.token,
+        scopeType: 'organization',
+        scopeId: options.organizationId,
+        name: options.stackName,
+        logger: options.log,
+    });
+    writeConfigFile(options.blueprintFilePath, {
+        organizationId: options.organizationId,
+        stackId: stack.id,
+    });
+    options.log(check(`Stack ${stack.name} created (org scope)`));
+    options.log('');
+    options.log('Next steps:');
+    for (const step of options.nextSteps)
+        options.log(step);
+    return {
+        success: true,
+        json: {
+            organizationId: options.organizationId,
+            projectId: options.projectId,
+            dataset: options.datasetName,
+            stackId: stack.id,
+            stackName: stack.name,
+            files: [...options.files, '.sanity/blueprint.config.json'],
+        },
+    };
+}
+export function alignSteps(steps) {
+    const width = Math.max(...steps.map(([command]) => command.length));
+    return steps.map(([command, description]) => description ? `  ${command.padEnd(width + 2)}${description}` : `  ${command}`);
+}

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

@@ -0,0 +1,3 @@
+import type { CoreResult } from '../index.js';
+import type { BlueprinitFlowOptions } from './types.js';
+export declare function freshFlow(options: BlueprinitFlowOptions): Promise<CoreResult>;

package/dist/cores/blueprinit/fresh.js

@@ -0,0 +1,88 @@
+import { STARTER_FUNCTION_NAME, slugify } from '../../actions/blueprinit/manifest.js';
+import { scaffoldWorkspace } from '../../actions/blueprinit/workspace.js';
+import { listDatasets } from '../../actions/sanity/datasets.js';
+import { groupProjectsByOrganization } from '../../actions/sanity/projects.js';
+import { check } from '../../utils/display/presenters.js';
+import { getLatestNpmVersion } from '../../utils/external/npmjs.js';
+import { isInteractive } from '../../utils/interactive.js';
+import { alignSteps, createStackAndFinish } from './finish.js';
+import { confirmUnlessSkipped, promptForStudioName } from './prompts.js';
+import { chooseDataset, chooseOrganization, chooseProject } from './selection.js';
+export async function freshFlow(options) {
+    const { bin, dir, flags, log, token } = options;
+    const grouped = await groupProjectsByOrganization({ token, logger: log });
+    if (!grouped.ok) {
+        return { success: false, error: `Could not list organizations: ${grouped.error}` };
+    }
+    const organizationResult = await chooseOrganization(grouped.organizations, flags.organizationId, isInteractive);
+    if (!organizationResult.ok) {
+        return {
+            success: false,
+            error: organizationResult.error.message,
+            suggestions: organizationResult.error.suggestions,
+        };
+    }
+    const { organization, projects = [] } = organizationResult.value;
+    const projectResult = await chooseProject(projects, flags.projectId, organization.name, isInteractive);
+    if (!projectResult.ok) {
+        return {
+            success: false,
+            error: projectResult.error.message,
+            suggestions: projectResult.error.suggestions,
+        };
+    }
+    const project = projectResult.value;
+    const datasets = await listDatasets({ token, projectId: project.id, logger: log });
+    if (!datasets.ok) {
+        return { success: false, error: `Could not list datasets: ${datasets.error}` };
+    }
+    const dataset = chooseDataset(datasets.datasets);
+    if (!dataset)
+        return { success: false, error: `No datasets found in ${project.displayName}.` };
+    log(check(`Org: ${organization.name} (${organization.id})`));
+    log(check(`Project: ${project.displayName} (${project.id}), dataset: ${dataset.name}`));
+    log('');
+    const confirmed = await confirmUnlessSkipped(flags, isInteractive, `Set up this directory as the workspace for "${project.displayName}"?`);
+    if (!confirmed)
+        return { success: false, error: 'Initialization cancelled.' };
+    const stackName = slugify(project.displayName) || project.id;
+    const studioName = await promptForStudioName(flags, isInteractive);
+    log('Files to write:');
+    log('  + sanity.blueprint.ts             project + dataset (attached), studio, function');
+    log(`  + ${`studios/${studioName}/`.padEnd(32)}Studio with a "post" type`);
+    log(`  + ${`functions/${STARTER_FUNCTION_NAME}/`.padEnd(32)}sets a post slug from its title`);
+    log(`  + .sanity/blueprint.config.json   org scope, stack ${stackName}`);
+    log('  + .gitignore');
+    log('  + package.json');
+    log('');
+    const scaffold = scaffoldWorkspace({
+        dir,
+        projectId: project.id,
+        displayName: project.displayName,
+        datasetName: dataset.name,
+        stackName,
+        studioName,
+        blueprintsVersion: await getLatestNpmVersion('@sanity/blueprints', log),
+    });
+    return await createStackAndFinish({
+        ...options,
+        organizationId: organization.id,
+        projectId: project.id,
+        datasetName: dataset.name,
+        stackName,
+        blueprintFilePath: scaffold.blueprintFilePath,
+        files: scaffold.files,
+        nextSteps: [
+            ...alignSteps([
+                ['npm install'],
+                [`npm run dev -w studios/${studioName}`, 'open the Studio and add a post'],
+                [`npx ${bin} blueprints plan`, 'preview the deployment'],
+                [`npx ${bin} blueprints deploy`, 'deploy the resources'],
+            ]),
+            '',
+            'Test the function on that post:',
+            `  npx ${bin} functions test ${STARTER_FUNCTION_NAME} --document-id <id>` +
+                ` --project-id ${project.id} --dataset ${dataset.name} --with-user-token`,
+        ],
+    });
+}

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

@@ -0,0 +1,4 @@
+import type { BlueprinitFlags } from './types.js';
+export declare const DEFAULT_STUDIO_NAME = "studio";
+export declare function confirmUnlessSkipped(flags: BlueprinitFlags, interactive: boolean, message: string): Promise<boolean>;
+export declare function promptForStudioName(flags: BlueprinitFlags, interactive: boolean): Promise<string>;

package/dist/cores/blueprinit/prompts.js

@@ -0,0 +1,14 @@
+import { confirm, input } from '@inquirer/prompts';
+import { slugify } from '../../actions/blueprinit/manifest.js';
+export const DEFAULT_STUDIO_NAME = 'studio';
+export async function confirmUnlessSkipped(flags, interactive, message) {
+    if (flags.yes || !interactive)
+        return true;
+    return await confirm({ message, default: true });
+}
+export async function promptForStudioName(flags, interactive) {
+    if (flags.yes || !interactive)
+        return DEFAULT_STUDIO_NAME;
+    const answer = await input({ message: 'Name your studio?', default: DEFAULT_STUDIO_NAME });
+    return slugify(answer) || DEFAULT_STUDIO_NAME;
+}

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

@@ -0,0 +1,15 @@
+import type { Dataset } from '../../actions/sanity/datasets.js';
+import type { GroupedProjects, Project } from '../../actions/sanity/projects.js';
+import type { Result } from '../../utils/types.js';
+interface SelectionError {
+    message: string;
+    suggestions?: string[];
+}
+export declare function chooseOrganization(groups: GroupedProjects[], organizationId: string | undefined, interactive: boolean): Promise<Result<GroupedProjects, SelectionError>>;
+export declare function chooseProject(projects: Project[], projectId: string | undefined, organizationName: string, interactive: boolean): Promise<Result<Project, SelectionError>>;
+export declare function chooseDataset(datasets: Dataset[]): Dataset | undefined;
+export declare function findProject(groups: GroupedProjects[], projectId: string): {
+    organization: GroupedProjects['organization'];
+    project: Project;
+} | undefined;
+export {};

package/dist/cores/blueprinit/selection.js

@@ -0,0 +1,63 @@
+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 function chooseDataset(datasets) {
+    return datasets.find(({ name }) => name === 'production') ?? datasets[0];
+}
+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,13 @@
+import type { Logger } from '../../utils/logger.js';
+export interface BlueprinitFlags {
+    yes?: boolean;
+    organizationId?: string;
+    projectId?: 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,39 @@
+import { cwd } from 'node:process';
+import { detectStudio } from '../actions/blueprinit/studio.js';
+import { findBlueprintFile } from '../actions/blueprints/blueprint.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) {
+            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

@@ -1,5 +1,5 @@
 import { dirname } from 'node:path';
-import { stashAsset } from '../../actions/blueprints/assets.js';
+import { preDeploy } from '../../actions/blueprints/pre-deploy.js';
 import { getStack, updateStack } from '../../actions/blueprints/stacks.js';
 import { waitForOperation } from '../../actions/blueprints/wait-for-operation.js';
 import { checkUserPermission } from '../../actions/sanity/access.js';
@@ -7,12 +7,7 @@ import { createHintCollector } from '../../utils/blueprints/hints.js';
 import { niceId } 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 { isAssetResource } from '../../utils/types.js';
 import { getWarnings } from '../../utils/warnings.js';
-const DEFAULT_ASSET_TIMEOUT = 60;
-const assetTimeoutS = Number(process.env.SANITY_ASSET_TIMEOUT) || DEFAULT_ASSET_TIMEOUT;
-const assetTimeoutMs = assetTimeoutS * 1000;
-const warnTimeoutMs = assetTimeoutMs / 2;
 export async function blueprintDeployCore(options) {
     const { bin = 'sanity', log, auth, stackId, scopeType, scopeId, deployedStack, blueprint, flags, } = options;
     const { verbose } = flags;
@@ -39,17 +34,21 @@ export async function blueprintDeployCore(options) {
             };
         }
         const resources = [...blueprint.resources];
-        const assetResources = resources.filter(isAssetResource);
-        if (assetResources.length > 0) {
-            log('Processing assets...');
-            for (const resource of assetResources) {
-                const preDeployResult = await preDeploy(resource, { auth, blueprintFileDir, installer, log });
-                if (!preDeployResult.success)
-                    return preDeployResult;
-                const idx = resources.indexOf(resource);
-                if (idx !== -1)
-                    resources[idx] = preDeployResult.resource;
-            }
+        const preDeployResult = await preDeploy({
+            scopeType,
+            scopeId,
+            resources,
+            stackId,
+            stackName,
+            auth,
+            blueprintFileDir,
+            installer,
+            log,
+            bin,
+            verbose,
+        });
+        if (!preDeployResult?.success) {
+            return preDeployResult;
         }
         const spinner = log.ora('Deploying...').start();
         const { ok: deployOk, stack, error: deployError, } = await updateStack({
@@ -152,53 +151,6 @@ export async function blueprintDeployCore(options) {
         return { success: false, error: errorMessage };
     }
 }
-async function preDeploy(resource, options) {
-    const { auth, blueprintFileDir, installer, log } = options;
-    const fnSpinner = log.ora({ text: `Processing ${resource.name}...`, prefixText: ' ' }).start();
-    const warnTimer = setTimeout(() => {
-        fnSpinner.text = `Still processing ${resource.name}, this can take a moment...`;
-    }, warnTimeoutMs);
-    let assetTimeoutTimer;
-    let result;
-    try {
-        result = await Promise.race([
-            stashAsset({ resource, blueprintFileDir, auth, logger: log, installer }),
-            new Promise((_, reject) => {
-                assetTimeoutTimer = setTimeout(() => {
-                    reject(new Error(`Processing ${resource.name} timed out after ${assetTimeoutS}s`));
-                }, assetTimeoutMs);
-            }),
-        ]);
-    }
-    catch (err) {
-        const msg = err instanceof Error ? err.message : String(err);
-        fnSpinner.fail(msg);
-        return { success: false, error: msg };
-    }
-    finally {
-        clearTimeout(warnTimer);
-        clearTimeout(assetTimeoutTimer);
-    }
-    if (result.success && result.assetId) {
-        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)}`);
-            }
-            else {
-                log.verbose(`   Hash: ${result.hash}`);
-            }
-        }
-        if (result.exists)
-            log.verbose('   Asset unchanged');
-        return { success: true, resource: updatedResource };
-    }
-    const errorMsg = `Failed uploading ${resource.name} asset, deploy has stopped`;
-    fnSpinner.fail(errorMsg);
-    return { success: false, error: result.error || 'Failed to process asset' };
-}
 const CHECK_LEGACY_DEPLOY_PERMISSION = false;
 const BLUEPRINTS_PERMISSION_ENFORCEMENT_DATE = 'July 1, 2026';
 async function checkLegacyDeployPermission({ auth, scopeType, scopeId, log, }) {

package/dist/utils/command-skills.d.ts

@@ -0,0 +1,2 @@
+export declare function commandSkillFilename(commandId: string): string;
+export declare function readCommandSkill(commandId: string, skillsDirectory?: string): Promise<string | undefined>;

package/dist/utils/command-skills.js

@@ -0,0 +1,17 @@
+import { readFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+const SKILLS_DIRECTORY = fileURLToPath(new URL('../../skills/', import.meta.url));
+export function commandSkillFilename(commandId) {
+    return `${commandId.replaceAll(':', '-')}.md`;
+}
+export async function readCommandSkill(commandId, skillsDirectory = SKILLS_DIRECTORY) {
+    try {
+        return await readFile(join(skillsDirectory, commandSkillFilename(commandId)), 'utf8');
+    }
+    catch (error) {
+        if (error.code === 'ENOENT')
+            return;
+        throw error;
+    }
+}