@sanity/runtime-cli 17.10.0 → 17.11.1-next.gc1820a0

package/dist/utils/display/prompt.js

@@ -5,6 +5,13 @@ import { styleText } from '../style-text.js';
 import { niceId } from './presenters.js';
 // --- Wizard infrastructure ---
 export const BACK = Symbol('back');
+/** Thrown when the user picks "Cancel" in a prompt. Cores translate it to a clean result. */
+export class CancelledError extends Error {
+    constructor(message = 'Cancelled by user.') {
+        super(message);
+        this.name = 'CancelledError';
+    }
+}
 /**
  * Runs a sequence of prompt steps with back-navigation support.
  * Each step can return BACK to go to the previous non-skipped step.
@@ -57,13 +64,53 @@ function withBackChoice(choices, allowBack) {
     ];
 }
 // --- Standalone prompts ---
+/**
+ * Ask where a new Blueprint should go.
+ * Returns the chosen directory, or null to use the current one.
+ * @throws CancelledError when the user cancels.
+ */
+export async function promptForInitLocation(currentDir) {
+    const HERE = 'here';
+    const ELSEWHERE = 'elsewhere';
+    const CANCEL = 'cancel';
+    const choice = await select({
+        message: 'Where should the Blueprint go?',
+        choices: [
+            { name: 'Here', value: HERE, description: currentDir },
+            { name: 'In a new folder', value: ELSEWHERE, description: 'Name a folder to create' },
+            { name: 'Cancel', value: CANCEL, description: 'Stop here and change nothing' },
+        ],
+        default: HERE,
+    });
+    if (choice === CANCEL)
+        throw new CancelledError();
+    if (choice === HERE)
+        return null;
+    const folder = await input({
+        message: 'Folder name:',
+        validate: (val) => val.trim().length > 0 || 'A folder name is required',
+    });
+    return folder.trim();
+}
 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' },
+            {
+                name: 'TypeScript',
+                value: 'ts',
+                description: 'Editor completion and type checks. Adds @sanity/blueprints.',
+            },
+            {
+                name: 'JavaScript',
+                value: 'js',
+                description: 'The same define* helpers, without type checks. Adds @sanity/blueprints.',
+            },
+            {
+                name: 'JSON',
+                value: 'json',
+                description: 'No dependency and no install step. Write each resource by hand.',
+            },
         ],
         default: 'ts',
     });
@@ -203,7 +250,7 @@ export async function promptForProjectInOrg({ projects, knownProjectId, logger,
  * Prompt the user for a Stack after scope has been determined.
  * Can create a new Stack or select an existing one.
  */
-export async function promptForStack({ scopeType, scopeId, token, logger, allowBack = false, }) {
+export async function promptForStack({ scopeType, scopeId, token, logger, allowBack = false, suggestedName, }) {
     if (!scopeId) {
         throw new Error(`Cannot list Stacks: no ${scopeType} ID provided. ` +
             'Provide --project-id or --organization-id, or select a scope in the wizard.');
@@ -247,16 +294,30 @@ export async function promptForStack({ scopeType, scopeId, token, logger, allowB
         pickedStackId = answer;
     }
     else if (allowBack) {
+        const CANCEL = 'cancel';
         const proceed = await select({
-            message: 'No existing Stacks. Create a new one?',
-            choices: withBackChoice([{ name: 'Yes, create a new Stack', value: 'yes' }], allowBack),
+            message: 'This scope has no Stacks yet:',
+            choices: withBackChoice([
+                {
+                    name: 'Create the first Stack',
+                    value: NEW_STACK_ID,
+                    description: 'A Blueprint needs a Stack before it can deploy',
+                },
+                { name: 'Cancel', value: CANCEL, description: 'Stop here and change nothing' },
+            ], allowBack),
         });
         if (proceed === BACK)
             return BACK;
+        if (proceed === CANCEL)
+            throw new CancelledError();
     }
     if (pickedStackId === NEW_STACK_ID) {
+        // only suggest a free name; the API rejects a duplicate within a scope
+        const isTaken = stacks.some((s) => s.name === suggestedName);
+        logger(styleText('dim', 'The name is a label. Sanity assigns the Stack ID.'));
         const stackName = await input({
-            message: 'Enter a name for your new Stack:',
+            message: 'Name your new Stack:',
+            default: isTaken ? undefined : suggestedName,
             validate: (val) => val.length > 0 || 'Stack name is required',
         });
         const stack = await createEmptyStack({
@@ -277,7 +338,7 @@ export async function promptForStack({ scopeType, scopeId, token, logger, allowB
  * Full wizard: Organization -> Scope -> Project (if project-scoped) -> Stack.
  * Supports back-navigation between steps.
  */
-export async function runScopeAndStackWizard({ token, knownOrganizationId, knownProjectId, logger, }) {
+export async function runScopeAndStackWizard({ token, knownOrganizationId, knownProjectId, logger, suggestedStackName, }) {
     const steps = [
         {
             key: 'organization',
@@ -336,6 +397,7 @@ export async function runScopeAndStackWizard({ token, knownOrganizationId, known
                     token,
                     logger,
                     allowBack: true,
+                    suggestedName: suggestedStackName,
                 });
             },
         },

package/dist/utils/package-manager.d.ts

@@ -0,0 +1,20 @@
+/** Package managers this CLI can name in the commands it prints. */
+export type PackageManager = 'npm' | 'pnpm' | 'yarn' | 'bun';
+/**
+ * Detect the package manager for a project.
+ *
+ * `npm_config_user_agent` is first then lockfile detection.
+ */
+export declare function detectPackageManager(dir?: string): PackageManager | undefined;
+/**
+ * The command that runs this CLI, matched to the detected package manager.
+ * Falls back to `npx`
+ *
+ * Yarn is weird: detected from a lockfile alone also falls bac
+ * lockfile name does not differentiate Yarn 1 vs Yarn 2+
+ */
+export declare function runCommand(bin: string, dir?: string): string;
+/** The command that installs dependencies, matched to the detected package manager. */
+export declare function installCommand(dir?: string): string;
+/** Clear the lockfile lookup cache. Tests use this after they move fixtures. */
+export declare function resetPackageManagerCache(): void;

package/dist/utils/package-manager.js

@@ -0,0 +1,63 @@
+import { basename } from 'node:path';
+import { getBinCommand, getRunningPackageManager } from '@sanity/cli-core/package-manager';
+import * as find from 'empathic/find';
+/**
+ * Lockfile names in priority order
+ */
+const LOCKFILES = {
+    'pnpm-lock.yaml': 'pnpm',
+    'yarn.lock': 'yarn',
+    'bun.lock': 'bun',
+    'bun.lockb': 'bun',
+    'package-lock.json': 'npm',
+};
+const LOCKFILE_NAMES = Object.keys(LOCKFILES);
+/** Minimal user agents, so the lockfile path reuses the same command mapping. */
+const SYNTHETIC_USER_AGENTS = {
+    npm: 'npm/0',
+    pnpm: 'pnpm/0',
+    yarn: 'yarn/0',
+    bun: 'bun/0',
+};
+const lockfileCache = new Map();
+/** Find the package manager a lockfile at or above `dir` implies. */
+function detectFromLockfile(dir) {
+    if (lockfileCache.has(dir))
+        return lockfileCache.get(dir);
+    const found = find.any(LOCKFILE_NAMES, { cwd: dir });
+    const manager = found ? LOCKFILES[basename(found)] : undefined;
+    lockfileCache.set(dir, manager);
+    return manager;
+}
+/**
+ * Detect the package manager for a project.
+ *
+ * `npm_config_user_agent` is first then lockfile detection.
+ */
+export function detectPackageManager(dir = process.cwd()) {
+    return getRunningPackageManager() ?? detectFromLockfile(dir);
+}
+/**
+ * The command that runs this CLI, matched to the detected package manager.
+ * Falls back to `npx`
+ *
+ * Yarn is weird: detected from a lockfile alone also falls bac
+ * lockfile name does not differentiate Yarn 1 vs Yarn 2+
+ */
+export function runCommand(bin, dir) {
+    const running = getRunningPackageManager();
+    if (running)
+        return getBinCommand({ bin });
+    const fromLockfile = detectFromLockfile(dir ?? process.cwd());
+    if (!fromLockfile || fromLockfile === 'yarn')
+        return `npx ${bin}`;
+    return getBinCommand({ bin, userAgent: SYNTHETIC_USER_AGENTS[fromLockfile] });
+}
+/** The command that installs dependencies, matched to the detected package manager. */
+export function installCommand(dir) {
+    return `${detectPackageManager(dir) ?? 'npm'} install`;
+}
+/** Clear the lockfile lookup cache. Tests use this after they move fixtures. */
+export function resetPackageManagerCache() {
+    lockfileCache.clear();
+}

package/dist/utils/types.d.ts

@@ -262,8 +262,17 @@ export interface FunctionLog {
     requestId: string;
     level: string;
     message: string;
+    operationName?: string;
+    attempt?: number;
+    operationId?: string;
+    executionArn?: string;
 }
 /** @internal */
+export type FunctionLogJson = Omit<FunctionLog, 'executionArn' | 'operationId' | 'operationName'> & {
+    durableContext?: 'handler' | 'step';
+    step?: string;
+};
+/** @internal */
 export declare enum BlueprintParserErrorType {
     InvalidProperty = "invalid_property",
     InvalidVersion = "invalid_version",

package/oclif.manifest.json

@@ -3148,5 +3148,5 @@
       ]
     }
   },
-  "version": "17.10.0"
+  "version": "17.11.1-next.gc1820a0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "17.10.0",
+  "version": "17.11.1-next.gc1820a0",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -64,21 +64,20 @@
   "dependencies": {
     "@architect/hydrate": "~6.0.2",
     "@architect/inventory": "~6.1.0",
-    "@inquirer/prompts": "^8.5.2",
-    "@oclif/core": "^4.13.4",
-    "@oclif/plugin-help": "^6.2.58",
-    "@sanity-labs/design-tokens": "^0.0.2-alpha.2",
+    "@inquirer/prompts": "^8.7.0",
+    "@oclif/core": "^4.14.0",
+    "@oclif/plugin-help": "^6.3.0",
     "@sanity-labs/oclif-plugin-skills-flag": "^0.2.1",
-    "@sanity/blueprints": "^0.23.6",
+    "@sanity/blueprints": "^0.24.0",
     "@sanity/blueprints-parser": "^0.5.0",
     "@sanity/cli-build": "^5.2.0",
-    "@sanity/cli-core": "^3.0.0",
-    "@sanity/client": "^8.0.0",
+    "@sanity/cli-core": "^3.5.0",
+    "@sanity/client": "^8.4.0",
     "adm-zip": "^0.6.0",
     "array-treeify": "^0.2.0",
     "cardinal": "^2.1.1",
     "empathic": "^2.0.1",
-    "eventsource": "^5.1.0",
+    "eventsource": "^5.1.1",
     "groq-js": "^2.0.0",
     "jiti": "^2.7.0",
     "mime-types": "^3.0.2",
@@ -86,38 +85,38 @@
     "signal-exit": "^4.1.0",
     "strip-ansi": "^7.2.0",
     "tar-fs": "^3.1.3",
-    "tar-stream": "^3.2.0",
-    "vite": "^8.2.1",
+    "tar-stream": "^3.2.1",
+    "vite": "^8.2.2",
     "ws": "^8.21.3",
     "xdg-basedir": "^5.1.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.5.8",
+    "@biomejs/biome": "2.5.11",
     "@codemirror/lang-json": "^6.0.2",
+    "@codemirror/language": "^6.12.4",
     "@codemirror/state": "^6.7.1",
     "@enhance/store": "^1.0.2",
     "@lezer/highlight": "^1.2.3",
-    "@oclif/test": "^4.1.22",
+    "@oclif/test": "^4.2.0",
     "@playwright/test": "^1.62.1",
     "@rollup/plugin-node-resolve": "^16.0.3",
-    "@sanity/functions": "^1.6.6",
-    "@types/adm-zip": "^0.5.8",
+    "@sanity-labs/design-tokens": "^0.0.2-alpha.2",
+    "@sanity/functions": "^1.7.1",
     "@types/cardinal": "^2.1.1",
     "@types/mime-types": "^3.0.1",
     "@types/node": "^22",
     "@types/tar-fs": "^2.0.4",
-    "@types/tar-stream": "^3.1.4",
     "@types/ws": "^8.18.1",
-    "@vitest/coverage-v8": "4.1.10",
+    "@vitest/coverage-v8": "4.1.11",
     "codemirror": "^6.0.2",
     "mentoss": "^0.13.0",
-    "oclif": "^4.23.30",
-    "pretty-bytes": "^7.1.1",
-    "pretty-ms": "^9.3.0",
-    "rollup": "^4.62.4",
+    "oclif": "^4.24.0",
+    "pretty-bytes": "^7.1.2",
+    "pretty-ms": "^9.3.1",
+    "rollup": "^4.63.1",
     "shx": "^0.4.0",
     "typescript": "^7.0.2",
-    "vitest": "4.1.10"
+    "vitest": "4.1.11"
   },
   "oclif": {
     "bin": "sanity-run",