@sanity/runtime-cli 5.1.0 → 5.2.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @sanity/runtime-cli
 $ sanity-run COMMAND
 running command...
 $ sanity-run (--version)
-@sanity/runtime-cli/5.1.0 linux-x64 node-v22.15.0
+@sanity/runtime-cli/5.2.0 linux-x64 node-v22.15.0
 $ sanity-run --help [COMMAND]
 USAGE
   $ sanity-run COMMAND
@@ -47,7 +47,7 @@ USAGE
 
 ## `sanity-run blueprints add TYPE`
 
-Add a (function) resource to a Blueprint
+Add a Resource to a Blueprint
 
 ```
 USAGE
@@ -57,15 +57,15 @@ ARGUMENTS
   TYPE  (function) Type of resource to add (e.g. function)
 
 FLAGS
-  -n, --name=<value>       Name of the resource to add
-      --fn-type=<option>   Type of new function
+  -n, --name=<value>       Name of the Resource to add
+      --fn-type=<option>   Type of new Function
                            <options: document-publish>
       --javascript         Use JavaScript instead of TypeScript
-      --language=<option>  [default: ts] Language of the new function
+      --language=<option>  [default: ts] Language of the new Function
                            <options: ts|js>
 
 DESCRIPTION
-  Add a (function) resource to a Blueprint
+  Add a Resource to a Blueprint
 
 EXAMPLES
   $ sanity-run blueprints add function
@@ -77,7 +77,7 @@ EXAMPLES
   $ sanity-run blueprints add function --name my-function --fn-type document-publish --lang js
 ```
 
-_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -105,7 +105,7 @@ EXAMPLES
   $ sanity-run blueprints config --edit --project-id <projectId>
 ```
 
-_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -127,7 +127,7 @@ EXAMPLES
   $ sanity-run blueprints deploy --no-wait
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -135,10 +135,11 @@ Destroy a Blueprint deployment (will not delete local files)
 
 ```
 USAGE
-  $ sanity-run blueprints destroy [--force]
+  $ sanity-run blueprints destroy [--force] [--no-wait]
 
 FLAGS
-  --force  Force destroy (skip confirmation)
+  --force    Force destroy (skip confirmation)
+  --no-wait  Do not wait for destruction to complete
 
 DESCRIPTION
   Destroy a Blueprint deployment (will not delete local files)
@@ -147,7 +148,7 @@ EXAMPLES
   $ sanity-run blueprints destroy
 ```
 
-_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -164,7 +165,7 @@ EXAMPLES
   $ sanity-run blueprints info
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init [DIR]`
 
@@ -196,7 +197,7 @@ EXAMPLES
   $ sanity-run blueprints init --blueprint-type <json|js|ts> --project-id <projectId>
 ```
 
-_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -218,7 +219,7 @@ EXAMPLES
   $ sanity-run blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -235,7 +236,7 @@ EXAMPLES
   $ sanity-run blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run functions dev`
 
@@ -255,7 +256,7 @@ EXAMPLES
   $ sanity-run functions dev --port 8974
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -277,7 +278,7 @@ EXAMPLES
   $ sanity-run functions env add MyFunction API_URL https://api.example.com/
 ```
 
-_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env list NAME`
 
@@ -297,7 +298,7 @@ EXAMPLES
   $ sanity-run functions env list MyFunction
 ```
 
-_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/functions/env/list.ts)_
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -318,7 +319,7 @@ EXAMPLES
   $ sanity-run functions env remove MyFunction API_URL
 ```
 
-_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions logs NAME`
 
@@ -350,7 +351,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test NAME`
 
@@ -383,7 +384,7 @@ EXAMPLES
   $ sanity-run functions test <name> --data '{ "id": 1 }' --timeout 60
 ```
 
-_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v5.1.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v5.2.0/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

package/dist/actions/blueprints/blueprint.d.ts

@@ -13,11 +13,9 @@ export declare function findBlueprintFile(blueprintPath?: string): {
     extension: BlueprintFileExtension;
 } | null;
 /**
- * Reads the blueprint file from disk and parses it. Greedily looks for project and stack config
- * @param blueprintPath - The path of the blueprint file or directory- will search up the directory tree!
- * @returns Known information about the Blueprint, config, and Stack
+ * Result of the blueprint read operation
  */
-export declare function readLocalBlueprint(blueprintPath?: string): Promise<{
+export interface ReadBlueprintResult {
     fileInfo: {
         blueprintFilePath: string;
         fileName: string;
@@ -29,7 +27,13 @@ export declare function readLocalBlueprint(blueprintPath?: string): Promise<{
     configPath?: string;
     projectId?: string;
     stackId?: string;
-}>;
+}
+/**
+ * Reads the blueprint file from disk and parses it. Greedily looks for project and stack config
+ * @param blueprintPath - The path of the blueprint file or directory- will search up the directory tree!
+ * @returns Known information about the Blueprint, config, and Stack
+ */
+export declare function readLocalBlueprint(blueprintPath?: string): Promise<ReadBlueprintResult>;
 export declare function writeBlueprintToDisk({ blueprintFilePath, content, }: {
     blueprintFilePath: string;
     content?: LocalBlueprint;

package/dist/actions/blueprints/index.d.ts

@@ -32,7 +32,7 @@ type BlueprintResult = BlueprintSuccess | BlueprintFailure;
  * Get the local Blueprint and deployed Stack
  * @param blueprintPath - The path of the Blueprint file or directory- will search up the directory tree if not provided
  * @param token - The Sanity API token
- * @returns The local Blueprint and deployed Stack
+ * @returns The local Blueprint, issues, and maybe a deployed Stack
  */
 export declare function getBlueprintAndStack({ token, blueprintPath, }: {
     token: string;

package/dist/actions/blueprints/index.js

@@ -11,7 +11,7 @@ import { getStack } from './stacks.js';
  * Get the local Blueprint and deployed Stack
  * @param blueprintPath - The path of the Blueprint file or directory- will search up the directory tree if not provided
  * @param token - The Sanity API token
- * @returns The local Blueprint and deployed Stack
+ * @returns The local Blueprint, issues, and maybe a deployed Stack
  */
 export async function getBlueprintAndStack({ token, blueprintPath, }) {
     if (!token)

package/dist/baseCommands.d.ts

@@ -4,6 +4,11 @@ import { readLocalBlueprint } from './actions/blueprints/blueprint.js';
 import type { AuthParams, Stack } from './utils/types.js';
 export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof BlueprintCommand)['baseFlags'] & T['flags']>;
 export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
+/**
+ * @description Guarantees flags, args, sanityToken, and blueprint.
+ * Blueprint parser errors are logged and the command exits with an error
+ * @extends Command
+ */
 export declare abstract class BlueprintCommand<T extends typeof Command> extends Command {
     protected sanityToken: string;
     protected blueprint: Awaited<ReturnType<typeof readLocalBlueprint>>;
@@ -15,6 +20,11 @@ export declare abstract class BlueprintCommand<T extends typeof Command> extends
     }): Promise<unknown>;
     protected finally(_: Error | undefined): Promise<unknown>;
 }
+/**
+ * @description Guarantees flags, args, sanityToken, blueprint, projectId, stackId, auth, and deployedStack.
+ * If a project or stack is missing, the command exits with an error
+ * @extends BlueprintCommand
+ */
 export declare abstract class DeployedBlueprintCommand<T extends typeof Command> extends BlueprintCommand<T> {
     protected auth: AuthParams;
     protected deployedStack: Stack;

package/dist/baseCommands.js

@@ -2,8 +2,14 @@
 import { Command } from '@oclif/core';
 import { readLocalBlueprint } from './actions/blueprints/blueprint.js';
 import { getStack } from './actions/blueprints/stacks.js';
+import { niceId } from './utils/display/colors.js';
 import { presentBlueprintParserErrors } from './utils/display/errors.js';
 import { validTokenOrErrorMessage } from './utils/validated-token.js';
+/**
+ * @description Guarantees flags, args, sanityToken, and blueprint.
+ * Blueprint parser errors are logged and the command exits with an error
+ * @extends Command
+ */
 export class BlueprintCommand extends Command {
     sanityToken;
     blueprint;
@@ -27,7 +33,7 @@ export class BlueprintCommand extends Command {
         const blueprint = await readLocalBlueprint();
         if (blueprint.errors.length > 0) {
             this.log(presentBlueprintParserErrors(blueprint.errors));
-            this.error('Blueprint parse errors.');
+            this.error('Unable to parse Blueprint file.');
         }
         this.blueprint = blueprint;
     }
@@ -41,6 +47,11 @@ export class BlueprintCommand extends Command {
         return super.finally(_);
     }
 }
+/**
+ * @description Guarantees flags, args, sanityToken, blueprint, projectId, stackId, auth, and deployedStack.
+ * If a project or stack is missing, the command exits with an error
+ * @extends BlueprintCommand
+ */
 export class DeployedBlueprintCommand extends BlueprintCommand {
     auth;
     deployedStack;
@@ -49,21 +60,22 @@ export class DeployedBlueprintCommand extends BlueprintCommand {
     async init() {
         await super.init();
         const { projectId, stackId } = this.blueprint;
-        if (!projectId)
-            this.error('Missing Project ID for Blueprint');
-        if (!stackId)
-            this.error('Missing Stack ID for Blueprint');
+        if (!(projectId && stackId)) {
+            this.log(`Run \`${this.config.bin} blueprints config --edit --test\` to update your config`);
+            if (!projectId)
+                this.error('Missing Project configuration for Blueprint');
+            if (!stackId)
+                this.error('Missing deployment configuration for Blueprint');
+        }
         this.projectId = projectId;
         this.stackId = stackId;
         this.auth = { token: this.sanityToken, projectId };
         const stackResponse = await getStack({ stackId, auth: this.auth });
         if (!stackResponse.ok) {
-            this.error(stackResponse.error ?? 'Could not retrieve deployment info');
-        }
-        const { stack: deployedStack } = stackResponse;
-        if (!deployedStack) {
-            this.error('Unable to find deployed Stack. Run `sanity-run blueprints init`');
+            this.log(`Could not retrieve deployment info for ${niceId(stackId)}. Was it destroyed?`);
+            this.log(`Run \`${this.config.bin} blueprints config --edit --test\` to update your config`);
+            this.error('Missing deployment');
         }
-        this.deployedStack = deployedStack;
+        this.deployedStack = stackResponse.stack;
     }
 }

package/dist/commands/blueprints/add.d.ts

@@ -12,12 +12,4 @@ export default class AddCommand extends Command {
         javascript: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
-    promptForFunctionName(): Promise<string>;
-    promptForFunctionType(): Promise<string>;
-    promptForFunctionLang(): Promise<string>;
-    addFunction({ name, type, lang, }: {
-        name?: string;
-        type?: string;
-        lang?: string;
-    }): Promise<void>;
 }

package/dist/commands/blueprints/add.js

@@ -1,13 +1,7 @@
-import { cwd } from 'node:process';
 import { Args, Command, Flags } from '@oclif/core';
-import chalk from 'chalk';
-import highlight from 'color-json';
-import inquirer from 'inquirer';
-import { findBlueprintFile } from '../../actions/blueprints/blueprint.js';
-import { createFunctionResource } from '../../actions/blueprints/resources.js';
-import { validateFunctionName } from '../../utils/validate/resource.js';
+import { blueprintAddCore } from '../../cores/blueprints/index.js';
 export default class AddCommand extends Command {
-    static description = 'Add a (function) resource to a Blueprint';
+    static description = 'Add a Resource to a Blueprint';
     static examples = [
         '<%= config.bin %> <%= command.id %> function',
         '<%= config.bin %> <%= command.id %> function --name my-function',
@@ -23,18 +17,18 @@ export default class AddCommand extends Command {
     };
     static flags = {
         name: Flags.string({
-            description: 'Name of the resource to add',
+            description: 'Name of the Resource to add',
             char: 'n',
         }),
         'fn-type': Flags.string({
-            description: 'Type of new function',
+            description: 'Type of new Function',
             options: ['document-publish' /*, 'document-create', 'document-delete'*/],
             aliases: ['function-type'],
             // default: 'document-publish', // prompting informs user of default
             dependsOn: ['name'],
         }),
         language: Flags.string({
-            description: 'Language of the new function',
+            description: 'Language of the new Function',
             aliases: ['function-language', 'lang'],
             options: ['ts', 'js'],
             default: 'ts',
@@ -46,88 +40,13 @@ export default class AddCommand extends Command {
     };
     async run() {
         const { args, flags } = await this.parse(AddCommand);
-        if (args.type !== 'function')
-            this.error(`Unsupported Resource type: ${args.type}`);
-        const existingBlueprint = findBlueprintFile();
-        if (!existingBlueprint) {
-            this.error('No Blueprint file found. Run `sanity-run blueprints init` first.');
-        }
-        const { name: resourceName, 'fn-type': functionType, javascript } = flags;
-        let { language: functionLang } = flags;
-        if (javascript)
-            functionLang = 'js';
-        await this.addFunction({ name: resourceName, type: functionType, lang: functionLang });
-    }
-    async promptForFunctionName() {
-        const { functionName } = await inquirer.prompt([
-            {
-                type: 'input',
-                name: 'functionName',
-                message: 'Enter function name:',
-                validate: (input) => input.length > 0 || 'Function name is required',
-            },
-        ]);
-        return functionName;
-    }
-    async promptForFunctionType() {
-        const { functionType } = await inquirer.prompt([
-            {
-                type: 'list',
-                name: 'functionType',
-                message: 'Choose function type:',
-                choices: [
-                    { name: 'Document Publish', value: 'document-publish' },
-                    { name: 'Document Create', value: 'document-create', disabled: true },
-                    { name: 'Document Delete', value: 'document-delete', disabled: true },
-                ],
-                default: 'document-publish',
-            },
-        ]);
-        return functionType;
-    }
-    async 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',
-            },
-        ]);
-        return functionLang;
-    }
-    async addFunction({ name, type, lang, }) {
-        const functionName = name || (await this.promptForFunctionName());
-        if (!validateFunctionName(functionName)) {
-            this.error('Invalid function name. Must be 6+ characters, no special characters, no spaces');
-        }
-        const functionType = type || (await this.promptForFunctionType());
-        const functionLang = lang || (await this.promptForFunctionLang());
-        if (!['document-publish', 'document-create', 'document-delete'].includes(functionType)) {
-            this.error('Invalid function type. Must be one of: document-publish, document-create, document-delete');
-        }
-        const { filePath, resourceAdded, resource } = createFunctionResource({
-            name: functionName,
-            type: functionType,
-            lang: functionLang,
-            displayName: functionName,
+        const { success, error } = await blueprintAddCore({
+            bin: this.config.bin,
+            log: (msg) => this.log(msg),
+            args,
+            flags,
         });
-        this.log(`\nCreated function: ${filePath.replace(cwd(), '')}`);
-        if (functionLang === 'ts') {
-            this.log(chalk.dim('To avoid committing build artifacts, it is helpful to .gitignore "functions/**/.build/**"'));
-        }
-        if (!resourceAdded) {
-            // print the resource JSON for manual addition
-            this.log('\nAdd this Function resource to your blueprint:');
-            this.log(highlight(JSON.stringify(resource, null, 2)));
-        }
-        else {
-            // added to blueprint.json
-            this.log('Function resource added to blueprint');
-        }
+        if (!success)
+            this.error(error);
     }
 }

package/dist/commands/blueprints/config.d.ts

@@ -1,5 +1,5 @@
-import { Command } from '@oclif/core';
-export default class ConfigCommand extends Command {
+import { BlueprintCommand } from '../../baseCommands.js';
+export default class ConfigCommand extends BlueprintCommand<typeof ConfigCommand> {
     static description: string;
     static examples: string[];
     static flags: {
@@ -8,27 +8,5 @@ export default class ConfigCommand extends Command {
         'project-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'stack-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    sanityToken: string | undefined;
-    projectId: string | undefined;
-    stackId: string | undefined;
     run(): Promise<void>;
-    promptForProjectId({ knownProjectId }: {
-        knownProjectId?: string;
-    }): Promise<string>;
-    promptForStackId({ projectId, knownStackId, }: {
-        projectId: string;
-        knownStackId?: string;
-    }): Promise<string | undefined>;
-    testConfigAndReport({ stackId, projectId, reinit, }: {
-        stackId: string;
-        projectId: string;
-        reinit?: boolean;
-    }): Promise<{
-        ok: boolean;
-        error: string | null;
-    }>;
-    startReinitializeStack({ projectId, stackId }: {
-        projectId: string;
-        stackId: string;
-    }): Promise<void>;
 }