@sanity/runtime-cli 11.2.1 → 12.0.0

package/dist/cores/functions/add.js

@@ -1,9 +1,9 @@
 import { existsSync } from 'node:fs';
 import { dirname, join } from 'node:path';
 import { cwd } from 'node:process';
+import { checkbox, confirm, input, select } from '@inquirer/prompts';
 import { highlight } from 'cardinal';
 import chalk from 'chalk';
-import inquirer from 'inquirer';
 import { createFunctionResource } from '../../actions/blueprints/resources.js';
 import { verifyExampleExists, writeExample } from '../../actions/sanity/examples.js';
 import { check, indent, warn } from '../../utils/display/presenters.js';
@@ -198,86 +198,74 @@ export async function functionAddCore(options) {
     }
 }
 async function promptForFunctionName() {
-    const { functionName } = await inquirer.prompt([
-        {
-            type: 'input',
-            name: 'functionName',
-            message: 'Enter function name:',
-            validate: (input) => validateFunctionName(input) ||
-                'Invalid function name. Must be 6+ characters, no special characters, no spaces',
-        },
-    ]);
+    const functionName = await input({
+        message: 'Enter function name:',
+        validate: (input) => validateFunctionName(input) ||
+            'Invalid function name. Must be 6+ characters, no special characters, no spaces',
+    });
     return functionName;
 }
 async function promptForFunctionType() {
-    const { functionType } = await inquirer.prompt([
-        {
-            type: 'checkbox',
-            name: 'functionType',
-            message: 'Choose events to trigger your function:',
-            choices: [
-                { name: 'Document Create', value: 'document-create' },
-                { name: 'Document Update', value: 'document-update' },
-                { name: 'Document Delete', value: 'document-delete' },
-                { name: 'Media Library Asset Create', value: 'media-library-asset-create' },
-                { name: 'Media Library Asset Update', value: 'media-library-asset-update' },
-                { name: 'Media Library Asset Delete', value: 'media-library-asset-delete' },
-            ],
-            default: ['document-create', 'document-update'],
-            validate(choices) {
-                if (choices.length === 0) {
-                    return 'You must choose at least one function type / document change event';
-                }
-                if (choices.some((c) => String(c.value).startsWith('media-library')) &&
-                    choices.some((c) => String(c.value).startsWith('document'))) {
-                    return 'You cannot mix both Document and Media Library Asset events together in one Function';
-                }
-                return true;
-            },
+    function hasAtLeastOne(arr) {
+        // TypeScript believes me when I make a funciton to "guard" the type
+        return arr.length > 0;
+    }
+    const functionTypes = await checkbox({
+        message: 'Choose events to trigger your function:',
+        choices: [
+            { name: 'Document Create', value: 'document-create', checked: true },
+            { name: 'Document Update', value: 'document-update', checked: true },
+            { name: 'Document Delete', value: 'document-delete' },
+            { name: 'Media Library Asset Create', value: 'media-library-asset-create' },
+            { name: 'Media Library Asset Update', value: 'media-library-asset-update' },
+            { name: 'Media Library Asset Delete', value: 'media-library-asset-delete' },
+        ],
+        validate(choices) {
+            if (choices.length === 0) {
+                return 'You must choose at least one function type / document change event';
+            }
+            if (choices.some((c) => String(c.value).startsWith('media-library')) &&
+                choices.some((c) => String(c.value).startsWith('document'))) {
+                return 'You cannot mix both Document and Media Library Asset events together in one Function';
+            }
+            return true;
         },
-    ]);
-    return functionType;
+    });
+    // checking functionTypes.length > 0 doesn't narrow the type
+    // validate should prevent this from happening, but just in case
+    if (!hasAtLeastOne(functionTypes)) {
+        throw new Error('You must choose at least one function type / document change event');
+    }
+    return functionTypes;
 }
 async function promptForFunctionLang() {
-    const { functionLang } = await inquirer.prompt([
-        {
-            type: 'list',
-            name: 'functionLang',
-            message: 'Choose function language:',
-            choices: [
-                { name: 'TypeScript', value: 'ts' },
-                { name: 'JavaScript', value: 'js' },
-            ],
-            default: 'ts',
-        },
-    ]);
+    const functionLang = await select({
+        message: 'Choose function language:',
+        choices: [
+            { name: 'TypeScript', value: 'ts' },
+            { name: 'JavaScript', value: 'js' },
+        ],
+        default: 'ts',
+    });
     return functionLang;
 }
 async function promptForAddHelpers() {
-    const { addHelpers } = await inquirer.prompt([
-        {
-            type: 'confirm',
-            name: 'addHelpers',
-            message: 'Add @sanity/functions helpers to the new Function?',
-            default: true,
-        },
-    ]);
+    const addHelpers = await confirm({
+        message: 'Add @sanity/functions helpers to the new Function?',
+        default: true,
+    });
     return addHelpers;
 }
 async function promptForInstallCommand() {
-    const { command } = await inquirer.prompt([
-        {
-            type: 'list',
-            name: 'command',
-            message: 'How to install the @sanity/functions helpers:',
-            choices: [
-                { name: 'npm', value: 'npm' },
-                { name: 'pnpm', value: 'pnpm' },
-                { name: 'yarn', value: 'yarn' },
-                { name: 'Skip install', value: null },
-            ],
-            default: 'npm',
-        },
-    ]);
+    const command = await select({
+        message: 'How to install the @sanity/functions helpers:',
+        choices: [
+            { name: 'npm', value: 'npm' },
+            { name: 'pnpm', value: 'pnpm' },
+            { name: 'yarn', value: 'yarn' },
+            { name: 'Skip install', value: null },
+        ],
+        default: 'npm',
+    });
     return command;
 }

package/dist/cores/functions/logs.js

@@ -1,5 +1,5 @@
+import { confirm } from '@inquirer/prompts';
 import chalk from 'chalk';
-import inquirer from 'inquirer';
 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';
@@ -18,9 +18,7 @@ export async function functionLogsCore(options) {
 }
 async function deleteLogs({ name, externalId, auth, force, }) {
     if (!force) {
-        const { certain } = await inquirer.prompt({
-            type: 'confirm',
-            name: 'certain',
+        const certain = await confirm({
             message: `Are you sure you want to delete ${chalk.bold('all')} logs for function ${chalk.yellow(name)}?`,
             default: false,
         });

package/dist/cores/index.js

@@ -46,14 +46,14 @@ export async function initDeployedBlueprintConfig(config) {
         if (!scopeType || !scopeId)
             return { ok: false, error: 'Missing scope configuration for Blueprint' };
         if (!stackId)
-            return { ok: false, error: 'Missing deployment configuration for Blueprint' };
+            return { ok: false, error: 'Missing Stack deployment configuration for Blueprint' };
     }
     const auth = { token: config.token, scopeType, scopeId };
     const stackResponse = await getStack({ stackId, auth });
     if (!stackResponse.ok) {
-        config.log(`Could not retrieve deployment info for ${niceId(stackId)}.`);
+        config.log(`Could not retrieve Stack deployment info for ${niceId(stackId)}.`);
         config.log(`Run \`${config.bin} blueprints doctor\` for diagnostics.`);
-        return { ok: false, error: 'Missing deployment' };
+        return { ok: false, error: 'Missing Stack deployment' };
     }
     return {
         ok: true,

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

@@ -84,11 +84,16 @@ export function formatResourceTree(resources) {
     return `${treeify(output)}\n`;
 }
 export function formatStackInfo(stack, isCurrentStack = false) {
-    const isStack = 'id' in stack;
+    const isStack = 'id' in stack; // type narrowing
+    const isProjectBasedStack = isStack && stack.id === `ST-${stack.scopeId}`;
     const output = [];
     if (isStack) {
-        const stackName = isCurrentStack ? chalk.bold.blue(stack.name) : chalk.bold(stack.name);
-        output.push(`"${stackName}" ${niceId(stack.id)}${isCurrentStack ? ' (current)' : ''}`);
+        let stackName = chalk.bold(`"${stack.name}"`);
+        if (isCurrentStack)
+            stackName = `${chalk.blue(stackName)} (current)`;
+        if (isProjectBasedStack)
+            stackName += ' (project-based)';
+        output.push(`${stackName} ${niceId(stack.id)}`);
     }
     else {
         output.push('Local Blueprint');

package/dist/utils/display/errors.js

@@ -8,7 +8,7 @@ export function presentBlueprintIssues(issues) {
                     report.push(presentBlueprintParserErrors(issue.errors));
                 break;
             case 'NO_STACK_ID':
-                report.push('Existing deployment not found.');
+                report.push('Existing Stack deployment not found.');
                 break;
             case 'NO_SCOPE_TYPE':
                 report.push('Scope type not found.');
@@ -17,7 +17,7 @@ export function presentBlueprintIssues(issues) {
                 report.push('Scope ID not found.');
                 break;
             case 'NO_STACK':
-                report.push('Existing deployment not found.');
+                report.push('Existing Stack deployment not found.');
                 break;
             default:
                 report.push(issue.message);

package/dist/utils/display/presenters.d.ts

@@ -1,7 +1,9 @@
 export declare function check(str: string): string;
 export declare function info(str: string): string;
 export declare function warn(str: string): string;
+export declare function unsure(str: string): string;
 export declare function severe(str: string): string;
 export declare function niceId(id: string | undefined): string;
 export declare function indent(str: string, spaces?: number): string;
 export declare function capitalize(str: string): string;
+export declare function filePathRelativeToCwd(filePath: string): string;

package/dist/utils/display/presenters.js

@@ -1,3 +1,4 @@
+import { cwd } from 'node:process';
 import chalk from 'chalk';
 export function check(str) {
     return `${chalk.bold(chalk.green('✔︎'))} ${str}`;
@@ -8,6 +9,9 @@ export function info(str) {
 export function warn(str) {
     return `${chalk.bold.yellow('▶︎')} ${str}`;
 }
+export function unsure(str) {
+    return `${chalk.bold.cyan('?')} ${str}`;
+}
 export function severe(str) {
     return `${chalk.bold.red('✘')} ${str}`;
 }
@@ -26,3 +30,6 @@ export function indent(str, spaces = 2) {
 export function capitalize(str) {
     return str.charAt(0).toUpperCase() + str.slice(1);
 }
+export function filePathRelativeToCwd(filePath) {
+    return filePath.replace(cwd(), '.');
+}

package/dist/utils/display/prompt.d.ts

@@ -1,3 +1,4 @@
+export declare function promptForBlueprintType(): Promise<string>;
 /**
  * Prompt the user for a Project after selecting an Organization.
  * @param token - The Sanity API token
@@ -12,7 +13,18 @@ export declare function promptForProject({ token, knownOrganizationId, knownProj
     projectId: string;
     displayName: string;
 }>;
-export declare function promptForStackId({ projectId, token, }: {
+/**
+ * Prompt the user for a Stack ID after selecting a Project.
+ * Can be used to create a new Stack or select an existing one.
+ * @param projectId - The ID of the Project
+ * @param token - The Sanity API token
+ * @returns The selected Stack ID
+ * @throws {Error} If the user does not have any Stacks or if the API call fails
+ */
+export declare function promptForStack({ projectId, token, }: {
     projectId: string;
     token: string;
-}): Promise<string>;
+}): Promise<{
+    stackId: string;
+    name: string;
+}>;

package/dist/utils/display/prompt.js

@@ -1,8 +1,19 @@
+import { confirm, input, Separator, select } from '@inquirer/prompts';
 import chalk from 'chalk';
-import inquirer from 'inquirer';
 import { createEmptyStack, listStacks } from '../../actions/blueprints/stacks.js';
 import { groupProjectsByOrganization } from '../../actions/sanity/projects.js';
 import { niceId } from './presenters.js';
+export async function promptForBlueprintType() {
+    return await select({
+        message: 'Choose a Blueprint file type:',
+        choices: [
+            { name: 'TypeScript', value: 'ts' },
+            { name: 'JavaScript', value: 'js' },
+            { name: 'JSON', value: 'json' },
+        ],
+        default: 'ts',
+    });
+}
 /**
  * Prompt the user for a Project after selecting an Organization.
  * @param token - The Sanity API token
@@ -24,15 +35,11 @@ export async function promptForProject({ token, knownOrganizationId, knownProjec
             value: { organization, projects },
             disabled: !projects || projects.length === 0 ? '(0 Projects)' : false,
         }));
-        const { pickedOrganization } = await inquirer.prompt([
-            {
-                type: 'list',
-                name: 'pickedOrganization',
-                message: 'Which Organization would you like to use?',
-                choices: orgChoices,
-                default: knownOrganizationId,
-            },
-        ]);
+        const pickedOrganization = await select({
+            message: 'Which Organization would you like to use?',
+            choices: orgChoices,
+            default: knownOrganizationId,
+        });
         projects = pickedOrganization.projects;
     }
     else {
@@ -42,56 +49,68 @@ export async function promptForProject({ token, knownOrganizationId, knownProjec
         name: `"${displayName}" ${niceId(projectId)}`,
         value: { projectId, displayName },
     }));
-    const { pickedProject } = await inquirer.prompt([
-        {
-            type: 'list',
-            name: 'pickedProject',
+    let pickedProject;
+    if (projectChoices.length === 1) {
+        const onlyProject = projectChoices[0];
+        const confirmed = await confirm({
+            message: `Found 1 project. Use ${onlyProject.name}?`,
+            default: true,
+        });
+        if (confirmed)
+            pickedProject = onlyProject.value;
+        else
+            throw new Error('No project selected');
+    }
+    else {
+        pickedProject = await select({
             message: 'Choose a Sanity Project:',
             choices: projectChoices,
             default: knownProjectId,
-        },
-    ]);
+        });
+    }
     return pickedProject;
 }
-export async function promptForStackId({ projectId, token, }) {
+/**
+ * Prompt the user for a Stack ID after selecting a Project.
+ * Can be used to create a new Stack or select an existing one.
+ * @param projectId - The ID of the Project
+ * @param token - The Sanity API token
+ * @returns The selected Stack ID
+ * @throws {Error} If the user does not have any Stacks or if the API call fails
+ */
+export async function promptForStack({ projectId, token, }) {
     const { ok: stacksOk, error: stacksErr, stacks, } = await listStacks({ token, scopeType: 'project', scopeId: projectId });
     if (!stacksOk) {
         throw new Error(stacksErr || 'Failed to list Stacks');
     }
-    const stackChoices = [
-        { name: chalk.bold('✨ Create a new Stack'), value: 'new' },
-    ];
+    const newStackValue = { id: 'new', name: 'new' };
+    const stackChoices = [];
+    stackChoices.push(new Separator(chalk.underline('Create a new Stack:')));
+    stackChoices.push({ name: chalk.bold('New Stack ✨'), value: newStackValue });
     if (stacks.length > 0) {
-        stackChoices.push(new inquirer.Separator(chalk.underline('Use an existing Stack:')));
+        stackChoices.push(new Separator(chalk.underline('Use an existing Stack:')));
         stackChoices.push(...stacks.map((s) => ({
             name: `"${s.name}" ${niceId(s.id)} ${chalk.dim(`(${s.resources.length} res)`)}`,
-            value: s.id,
+            value: { id: s.id, name: s.name },
         })));
     }
-    const { pickedStackId } = await inquirer.prompt([
-        {
-            type: 'list',
-            name: 'pickedStackId',
-            message: 'Select an existing deployment or create a new one:',
-            choices: stackChoices,
-        },
-    ]);
-    if (pickedStackId === 'new') {
-        const { stackName } = await inquirer.prompt([
-            {
-                type: 'input',
-                name: 'stackName',
-                message: 'Enter a name for your Stack:',
-                validate: (input) => input.length > 0 || 'Stack name is required',
-            },
-        ]);
+    const pickedStackId = await select({
+        message: 'Select an existing deployment or create a new one:',
+        choices: stackChoices,
+        default: newStackValue,
+    });
+    if (pickedStackId.id === 'new') {
+        const stackName = await input({
+            message: 'Enter a name for your Stack:',
+            validate: (input) => input.length > 0 || 'Stack name is required',
+        });
         const stack = await createEmptyStack({
             token,
             scopeType: 'project',
             scopeId: projectId,
             name: stackName,
         });
-        return stack.id;
+        return { stackId: stack.id, name: stackName };
     }
-    return pickedStackId;
+    return { stackId: pickedStackId.id, name: pickedStackId.name };
 }

package/dist/utils/types.d.ts

@@ -99,7 +99,6 @@ export interface StackMutation {
     scopeType: ScopeType;
     scopeId: string;
     document: Blueprint;
-    useProjectBasedId?: boolean;
 }
 /** @internal */
 export interface BuildPayloadOptions {

package/oclif.manifest.json

@@ -165,7 +165,6 @@
       "description": "View or edit Blueprint configuration",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --test-config",
         "<%= config.bin %> <%= command.id %> --edit",
         "<%= config.bin %> <%= command.id %> --edit --project-id <projectId>",
         "<%= config.bin %> <%= command.id %> --edit --project-id <projectId> --stack-id <stackId>"
@@ -178,21 +177,9 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "test-config": {
-          "aliases": [
-            "test",
-            "validate"
-          ],
-          "char": "t",
-          "deprecated": true,
-          "description": "Validate the configuration",
-          "name": "test-config",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "edit": {
           "char": "e",
-          "description": "Edit the configuration",
+          "description": "Modify the configuration interactively, or directly when combined with ID flags.",
           "name": "edit",
           "allowNo": false,
           "type": "boolean"
@@ -205,7 +192,7 @@
           "dependsOn": [
             "edit"
           ],
-          "description": "Update the Project ID in the configuration. Requires --edit flag",
+          "description": "Directly set the Project ID in the configuration. Requires --edit flag",
           "name": "project-id",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -220,7 +207,7 @@
           "dependsOn": [
             "edit"
           ],
-          "description": "Update the Organization ID in the configuration. Requires --edit flag",
+          "description": "Directly set the Organization ID in the configuration. Requires --edit flag",
           "name": "organization-id",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -234,7 +221,7 @@
           "dependsOn": [
             "edit"
           ],
-          "description": "Update the Stack ID in the configuration. Requires --edit flag",
+          "description": "Directly set the Stack ID in the configuration. Requires --edit flag",
           "name": "stack-id",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -274,7 +261,7 @@
           "type": "boolean"
         },
         "no-wait": {
-          "description": "Do not wait for deployment to complete",
+          "description": "Do not wait for Stack deployment to complete",
           "name": "no-wait",
           "allowNo": false,
           "type": "boolean"
@@ -299,7 +286,7 @@
     "blueprints:destroy": {
       "aliases": [],
       "args": {},
-      "description": "Destroy a Blueprint deployment (will not delete local files)",
+      "description": "Destroy a Blueprint Stack deployment and its resources (will not delete local files)",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --stack-id <stackId> --project-id <projectId> --force --no-wait"
@@ -316,7 +303,7 @@
           "aliases": [
             "f"
           ],
-          "description": "Force destroy (skip confirmation)",
+          "description": "Force Stack destruction (skip confirmation)",
           "name": "force",
           "allowNo": false,
           "type": "boolean"
@@ -364,7 +351,7 @@
           "type": "option"
         },
         "no-wait": {
-          "description": "Do not wait for destruction to complete",
+          "description": "Do not wait for Stack destruction to complete",
           "name": "no-wait",
           "allowNo": false,
           "type": "boolean"
@@ -425,7 +412,7 @@
     "blueprints:info": {
       "aliases": [],
       "args": {},
-      "description": "Show information about a Blueprint deployment",
+      "description": "Show information about a Blueprint Stack deployment",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --stack-id <stackId>"
@@ -439,7 +426,7 @@
           "type": "boolean"
         },
         "id": {
-          "description": "Stack ID to show info for (defaults to current stack)",
+          "description": "Stack ID to show info for (defaults to current Stack)",
           "name": "id",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -568,6 +555,12 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "verbose": {
+          "description": "Verbose output",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -589,7 +582,7 @@
     "blueprints:logs": {
       "aliases": [],
       "args": {},
-      "description": "Display logs for a Blueprint deployment",
+      "description": "Display logs for a Blueprint Stack deployment",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --watch"
@@ -607,7 +600,7 @@
             "follow"
           ],
           "char": "w",
-          "description": "Watch for new logs (streaming mode)",
+          "description": "Watch for new Stack logs (streaming mode)",
           "name": "watch",
           "allowNo": false,
           "type": "boolean"
@@ -1417,5 +1410,5 @@
       ]
     }
   },
-  "version": "11.2.1"
+  "version": "12.0.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "11.2.1",
+  "version": "12.0.0",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -69,7 +69,7 @@
     "postpack": "shx rm -f oclif.manifest.json",
     "test": "vitest run && npm run lint",
     "test:depmgmt": "vitest run --config ./test-depmgmt/vitest.config.ts",
-    "test:integration": "cd test/integration && npm install && npm run typecheck",
+    "test:api": "cd test/api-types && npm install && npm run typecheck",
     "test:watch": "vitest",
     "typecheck": "tsc --project tsconfig.typecheck.json",
     "watch": "tsc --watch"
@@ -77,6 +77,7 @@
   "dependencies": {
     "@architect/hydrate": "^5.0.1",
     "@architect/inventory": "^5.0.0",
+    "@inquirer/prompts": "^8.0.1",
     "@oclif/core": "^4.8.0",
     "@oclif/plugin-help": "^6.2.36",
     "@sanity/blueprints-parser": "^0.3.0",
@@ -137,7 +138,7 @@
     "topicSeparator": " ",
     "topics": {
       "blueprints": {
-        "description": "Blueprint deployment and management commands"
+        "description": "Blueprint Stack deployment and management commands"
       },
       "functions": {
         "description": "Sanity Function development and management commands"