@sanity/runtime-cli 4.1.0 → 4.3.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/4.1.0 linux-x64 node-v22.14.0
+@sanity/runtime-cli/4.3.0 linux-x64 node-v22.14.0
 $ sanity-run --help [COMMAND]
 USAGE
   $ sanity-run COMMAND
@@ -40,6 +40,7 @@ USAGE
 * [`sanity-run blueprints stacks`](#sanity-run-blueprints-stacks)
 * [`sanity-run functions dev`](#sanity-run-functions-dev)
 * [`sanity-run functions env add NAME KEY VALUE`](#sanity-run-functions-env-add-name-key-value)
+* [`sanity-run functions env list NAME`](#sanity-run-functions-env-list-name)
 * [`sanity-run functions env remove NAME KEY`](#sanity-run-functions-env-remove-name-key)
 * [`sanity-run functions invoke NAME`](#sanity-run-functions-invoke-name)
 * [`sanity-run functions logs NAME`](#sanity-run-functions-logs-name)
@@ -52,19 +53,28 @@ Add a resource to a Blueprint
 
 ```
 USAGE
-  $ sanity-run blueprints add TYPE
+  $ sanity-run blueprints add TYPE [--function-type document-publish -n <value>]
 
 ARGUMENTS
   TYPE  (function) Type of resource to add (e.g. function)
 
+FLAGS
+  -n, --name=<value>            Name of the resource to add
+      --function-type=<option>  Type of function to add (e.g. document-publish)
+                                <options: document-publish>
+
 DESCRIPTION
   Add a resource to a Blueprint
 
 EXAMPLES
   $ sanity-run blueprints add function
+
+  $ sanity-run blueprints add function --name my-function
+
+  $ sanity-run blueprints add function --name my-function --function-type document-publish
 ```
 
-_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v4.1.0/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -72,10 +82,13 @@ View or edit Blueprint configuration
 
 ```
 USAGE
-  $ sanity-run blueprints config [--edit]
+  $ sanity-run blueprints config [-t] [--project-id <value> -e] [--stack-id <value> ]
 
 FLAGS
-  --edit  Edit the configuration
+  -e, --edit                Edit the configuration
+  -t, --test-config         Validate the configuration
+      --project-id=<value>  Update the Project ID in the configuration. Requires --edit flag
+      --stack-id=<value>    Update the Stack ID in the configuration. Requires --edit flag
 
 DESCRIPTION
   View or edit Blueprint configuration
@@ -83,10 +96,14 @@ DESCRIPTION
 EXAMPLES
   $ sanity-run blueprints config
 
+  $ sanity-run blueprints config --test-config
+
   $ sanity-run blueprints config --edit
+
+  $ sanity-run blueprints config --edit --project-id <projectId> --stack-id <stackId>
 ```
 
-_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v4.1.0/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -106,7 +123,7 @@ EXAMPLES
   $ sanity-run blueprints deploy
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v4.1.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -129,7 +146,7 @@ EXAMPLES
   $ sanity-run blueprints destroy --id ST-a1b2c3
 ```
 
-_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v4.1.0/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -151,7 +168,7 @@ EXAMPLES
   $ sanity-run blueprints info --id ST-a1b2c3
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v4.1.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init`
 
@@ -159,16 +176,29 @@ Initialize a new Blueprint
 
 ```
 USAGE
-  $ sanity-run blueprints init
+  $ sanity-run blueprints init [--blueprint-type json|js|ts] [--stack-id <value> --project-id <value>] [-n <value> ]
+
+FLAGS
+  -n, --stack-name=<value>       Name to use for a NEW Stack
+      --blueprint-type=<option>  Blueprint manifest type to use for the Blueprint
+                                 <options: json|js|ts>
+      --project-id=<value>       Sanity Project ID to use for the Blueprint
+      --stack-id=<value>         Existing Stack ID to use for the Blueprint
 
 DESCRIPTION
   Initialize a new Blueprint
 
 EXAMPLES
   $ sanity-run blueprints init
+
+  $ sanity-run blueprints init --blueprint-type <json|js|ts>
+
+  $ sanity-run blueprints init --blueprint-type <json|js|ts> --project-id <projectId> --stack-id <stackId>
+
+  $ sanity-run blueprints init --blueprint-type <json|js|ts> --project-id <projectId> --stack-name <stackName>
 ```
 
-_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v4.1.0/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -190,7 +220,7 @@ EXAMPLES
   $ sanity-run blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v4.1.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -207,7 +237,7 @@ EXAMPLES
   $ sanity-run blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v4.1.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run blueprints stacks`
 
@@ -229,7 +259,7 @@ EXAMPLES
   $ sanity-run blueprints stacks --projectId a1b2c3
 ```
 
-_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v4.1.0/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions dev`
 
@@ -249,7 +279,7 @@ EXAMPLES
   $ sanity-run functions dev --port 8974
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v4.1.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -271,7 +301,27 @@ 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/v4.1.0/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/env/add.ts)_
+
+## `sanity-run functions env list NAME`
+
+List the environment variables for a Sanity function
+
+```
+USAGE
+  $ sanity-run functions env list NAME
+
+ARGUMENTS
+  NAME  The name of the Sanity Function
+
+DESCRIPTION
+  List the environment variables for a Sanity function
+
+EXAMPLES
+  $ sanity-run functions env list MyFunction
+```
+
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -292,7 +342,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/v4.1.0/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions invoke NAME`
 
@@ -318,7 +368,7 @@ EXAMPLES
   $ sanity-run functions invoke <name> --file 'payload.json'
 ```
 
-_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v4.1.0/src/commands/functions/invoke.ts)_
+_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/invoke.ts)_
 
 ## `sanity-run functions logs NAME`
 
@@ -350,7 +400,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v4.1.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test NAME`
 
@@ -383,7 +433,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/v4.1.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

package/dist/actions/functions/env/index.d.ts

@@ -1,2 +1,3 @@
+export * from './list.js';
 export * from './remove.js';
 export * from './update.js';

package/dist/actions/functions/env/index.js

@@ -1,2 +1,3 @@
+export * from './list.js';
 export * from './remove.js';
 export * from './update.js';

package/dist/actions/functions/env/list.d.ts

@@ -0,0 +1,6 @@
+import type { AuthParams } from '../../../utils/types.js';
+export declare function list(id: string, auth: AuthParams): Promise<{
+    ok: boolean;
+    envvars: any;
+    error: any;
+}>;

package/dist/actions/functions/env/list.js

@@ -0,0 +1,15 @@
+import config from '../../../config.js';
+import getHeaders from '../../../utils/get-headers.js';
+const { functions } = config.server;
+export async function list(id, auth) {
+    const response = await fetch(`${functions}vX/functions/${id}/envvars`, {
+        headers: getHeaders(auth),
+        method: 'GET',
+    });
+    const json = await response.json();
+    return {
+        ok: response.ok,
+        envvars: json.envvars,
+        error: response.ok ? null : json?.error?.message,
+    };
+}

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

@@ -5,6 +5,15 @@ export default class Add extends Command {
     static args: {
         type: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
+    static flags: {
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'function-type': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
     run(): Promise<void>;
-    private addFunction;
+    promptForFunctionName(): Promise<string>;
+    promptForFunctionType(): Promise<string>;
+    addFunction({ name, type }: {
+        name?: string;
+        type?: string;
+    }): Promise<void>;
 }

package/dist/commands/blueprints/add.js

@@ -1,11 +1,16 @@
-import { Args, Command } from '@oclif/core';
+import { Args, Command, Flags } from '@oclif/core';
 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, validateFunctionType } from '../../utils/validate/resource.js';
 export default class Add extends Command {
     static description = 'Add a resource to a Blueprint';
-    static examples = ['<%= config.bin %> <%= command.id %> function'];
+    static examples = [
+        '<%= config.bin %> <%= command.id %> function',
+        '<%= config.bin %> <%= command.id %> function --name my-function',
+        '<%= config.bin %> <%= command.id %> function --name my-function --function-type document-publish',
+    ];
     static args = {
         type: Args.string({
             description: 'Type of resource to add (e.g. function)',
@@ -13,19 +18,30 @@ export default class Add extends Command {
             required: true,
         }),
     };
+    static flags = {
+        name: Flags.string({
+            description: 'Name of the resource to add',
+            char: 'n',
+        }),
+        'function-type': Flags.string({
+            description: 'Type of function to add (e.g. document-publish)',
+            options: ['document-publish' /*, 'document-create', 'document-delete'*/],
+            dependsOn: ['name'],
+        }),
+    };
     async run() {
-        const { args } = await this.parse(Add);
+        const { args, flags } = await this.parse(Add);
         const existingBlueprint = findBlueprintFile();
         if (!existingBlueprint) {
             this.error('No blueprint file found. Run `sanity blueprints init` first.');
         }
-        if (args.type === 'function') {
-            await this.addFunction();
-            return;
-        }
-        this.error(`Unsupported resource type: ${args.type}`);
+        if (args.type !== 'function')
+            this.error(`Unsupported resource type: ${args.type}`);
+        const resourceName = flags.name;
+        const functionType = flags['function-type'];
+        await this.addFunction({ name: resourceName, type: functionType });
     }
-    async addFunction() {
+    async promptForFunctionName() {
         const { functionName } = await inquirer.prompt([
             {
                 type: 'input',
@@ -34,6 +50,9 @@ export default class Add extends Command {
                 validate: (input) => input.length > 0 || 'Function name is required',
             },
         ]);
+        return functionName;
+    }
+    async promptForFunctionType() {
         const { functionType } = await inquirer.prompt([
             {
                 type: 'list',
@@ -47,6 +66,17 @@ export default class Add extends Command {
                 default: 'document-publish',
             },
         ]);
+        return functionType;
+    }
+    async addFunction({ name, type }) {
+        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());
+        if (!validateFunctionType(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,

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

@@ -3,7 +3,24 @@ export default class Config extends Command {
     static description: string;
     static examples: string[];
     static flags: {
+        'test-config': import("@oclif/core/interfaces").BooleanFlag<boolean>;
         edit: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        '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>;
     };
     run(): Promise<void>;
+    promptForProjectId({ knownProjectId }: {
+        knownProjectId?: string;
+    }): Promise<string>;
+    promptForStackId({ projectId, knownStackId, }: {
+        projectId: string;
+        knownStackId?: string;
+    }): Promise<string | undefined>;
+    testConfigAndReport({ stackId, projectId }: {
+        stackId: string;
+        projectId: string;
+    }): Promise<{
+        ok: boolean;
+        error: string | null;
+    }>;
 }

package/dist/commands/blueprints/config.js

@@ -1,9 +1,10 @@
 import { Command, Flags } from '@oclif/core';
 import highlight from 'color-json';
 import inquirer from 'inquirer';
+import Spinner from 'yocto-spinner';
 import { readBlueprintOnDisk, writeConfigFile } from '../../actions/blueprints/blueprint.js';
 import { listProjects } from '../../actions/blueprints/projects.js';
-import { listStacks } from '../../actions/blueprints/stacks.js';
+import { getStack, listStacks } from '../../actions/blueprints/stacks.js';
 import config from '../../config.js';
 import { bold, dim, niceId } from '../../utils/display/colors.js';
 const { token } = config;
@@ -11,27 +12,86 @@ export default class Config extends Command {
     static description = 'View or edit Blueprint configuration';
     static examples = [
         '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --test-config',
         '<%= config.bin %> <%= command.id %> --edit',
+        '<%= config.bin %> <%= command.id %> --edit --project-id <projectId> --stack-id <stackId>',
     ];
     static flags = {
+        'test-config': Flags.boolean({
+            char: 't',
+            aliases: ['test', 'validate'],
+            description: 'Validate the configuration',
+            default: false,
+        }),
         edit: Flags.boolean({
+            char: 'e',
             description: 'Edit the configuration',
             default: false,
         }),
+        'project-id': Flags.string({
+            description: 'Update the Project ID in the configuration. Requires --edit flag',
+            aliases: ['project', 'projectId'],
+            dependsOn: ['edit'],
+        }),
+        'stack-id': Flags.string({
+            description: 'Update the Stack ID in the configuration. Requires --edit flag',
+            aliases: ['stack', 'stackId'],
+            dependsOn: ['edit'],
+        }),
     };
     async run() {
         const { flags } = await this.parse(Config);
+        const { edit: editConfig, 'project-id': editProjectId, 'stack-id': editStackId, 'test-config': testConfig, } = flags;
         const blueprint = await readBlueprintOnDisk();
-        const { stackId: configStackId, projectId: configProjectId, configPath, fileInfo } = blueprint;
-        const { extension: blueprintExtension, blueprintFilePath } = fileInfo;
+        const { stackId: configStackId, projectId: configProjectId } = blueprint;
         if (!configStackId && !configProjectId) {
-            this.log('Project and Stack configuration is missing.');
+            this.error('Project and Stack configuration is missing! Use `blueprints init` to create a configuration.');
         }
         this.log(bold('Current configuration:'));
-        this.log(`Sanity Project:  ${niceId(configProjectId)}`);
-        this.log(`Blueprint Stack: ${niceId(configStackId)}`);
-        if (!flags.edit)
+        this.log(`  Sanity Project:  ${niceId(configProjectId)}`);
+        this.log(`  Blueprint Stack: ${niceId(configStackId)}`);
+        if ((editProjectId || editStackId) && !editConfig) {
+            this.log('To update the configuration, use the --edit flag.');
+            return;
+        }
+        if (!editConfig && !testConfig)
+            return;
+        if (testConfig && !editConfig) {
+            if (configStackId && configProjectId) {
+                await this.testConfigAndReport({ stackId: configStackId, projectId: configProjectId });
+            }
+            else {
+                this.log('Unable to test the configuration. Both Project and Stack IDs must be set.');
+            }
+        }
+        if (!editConfig)
             return;
+        const projectId = editProjectId || (await this.promptForProjectId({ knownProjectId: configProjectId }));
+        if (!projectId)
+            this.error('Project ID is required.');
+        const stackId = editStackId || (await this.promptForStackId({ projectId, knownStackId: configStackId }));
+        if (testConfig) {
+            if (projectId && stackId) {
+                const { ok: newConfigOk } = await this.testConfigAndReport({ stackId, projectId });
+                if (!newConfigOk) {
+                    this.error('Updated configuration has not been saved.');
+                }
+            }
+            else {
+                this.error('Unable to test the configuration. Both Project and Stack IDs must be set.');
+            }
+        }
+        try {
+            // update or create .blueprint/config.json
+            writeConfigFile({ projectId, stackId });
+            this.log('Configuration updated successfully.');
+        }
+        catch (error) {
+            this.log('Unable to dynamically update config. Use these values in your blueprint:');
+            this.log(highlight(JSON.stringify({ metadata: { projectId, stackId } }, null, 2)));
+        }
+    }
+    async promptForProjectId({ knownProjectId }) {
         const { ok, projects, error } = await listProjects({ token });
         if (!ok)
             this.error(error ?? 'Unknown error listing projects');
@@ -42,46 +102,55 @@ export default class Config extends Command {
             name: `"${displayName}" ${niceId(projectId)}`,
             value: projectId,
         }));
-        const { projectId } = await inquirer.prompt([
+        const { pickedProjectId } = await inquirer.prompt([
             {
                 type: 'list',
-                name: 'projectId',
+                name: 'pickedProjectId',
                 message: 'Select your Sanity project:',
                 choices: projectChoices,
-                default: configProjectId,
+                default: knownProjectId,
             },
         ]);
+        return pickedProjectId;
+    }
+    async promptForStackId({ projectId, knownStackId, }) {
         const auth = { token, projectId };
         // get stacks for selected project
         const { ok: stacksOk, stacks, error: stacksError } = await listStacks(auth);
         if (!stacksOk)
             this.error(stacksError ?? 'Unknown error listing stacks');
-        let stackId;
         if (stacks.length > 0) {
             const stackChoices = stacks.map((s) => ({
                 name: `"${s.name}" ${niceId(s.id)} ${dim(`(${s.resources.length} res)`)}`,
                 value: s.id,
             }));
             stackChoices.push({ name: 'Unset Stack association', value: 'unset' });
-            const { stackId: selectedStackId } = await inquirer.prompt([
+            const { pickedStackId } = await inquirer.prompt([
                 {
                     type: 'list',
-                    name: 'stackId',
+                    name: 'pickedStackId',
                     message: 'Select a stack:',
                     choices: stackChoices,
-                    default: configStackId,
+                    default: knownStackId,
                 },
             ]);
-            stackId = selectedStackId === 'unset' ? undefined : selectedStackId;
+            return pickedStackId === 'unset' ? undefined : pickedStackId;
         }
-        try {
-            // update or create .blueprint/config.json
-            writeConfigFile({ projectId, stackId });
-            this.log('Configuration updated successfully.');
+        return undefined;
+    }
+    async testConfigAndReport({ stackId, projectId }) {
+        const spinner = Spinner({ text: 'Testing the configuration...' }).start();
+        const { ok, error } = await getStack({
+            stackId,
+            auth: { token, projectId },
+        });
+        if (!ok) {
+            spinner.error(error ?? 'Unknown error testing the configuration');
+            this.log('Use the --edit flag to interactively update the configuration.');
         }
-        catch (error) {
-            this.log('Unable to dynamically update config. Use these values in your blueprint:');
-            this.log(highlight(JSON.stringify({ metadata: { projectId, stackId } }, null, 2)));
+        else {
+            spinner.success('Configuration is valid.');
         }
+        return { ok, error };
     }
 }

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

@@ -1,6 +1,22 @@
 import { Command } from '@oclif/core';
+import type { AuthParams, Stack, StackPayload } from '../../utils/types.js';
 export default class Init extends Command {
     static description: string;
     static examples: string[];
+    static flags: {
+        'blueprint-type': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        '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>;
+        'stack-name': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
     run(): Promise<void>;
+    promptForBlueprintType(): Promise<string>;
+    promptForProjectId(): Promise<string>;
+    promptForStackId({ projectId }: {
+        projectId: string;
+    }): Promise<string>;
+    createEmptyStack({ stackPayload, auth, }: {
+        stackPayload: StackPayload;
+        auth: AuthParams;
+    }): Promise<Stack>;
 }

package/dist/commands/blueprints/init.js

@@ -1,6 +1,6 @@
 import { join } from 'node:path';
 import { cwd } from 'node:process';
-import { Command } from '@oclif/core';
+import { Command, Flags } from '@oclif/core';
 import inquirer from 'inquirer';
 import { findBlueprintFile, writeBlueprintToDisk, writeConfigFile, } from '../../actions/blueprints/blueprint.js';
 import { listProjects } from '../../actions/blueprints/projects.js';
@@ -10,16 +10,77 @@ import { bold, dim, niceId, underline } from '../../utils/display/colors.js';
 const { token } = config;
 export default class Init extends Command {
     static description = 'Initialize a new Blueprint';
-    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --blueprint-type <json|js|ts>',
+        '<%= config.bin %> <%= command.id %> --blueprint-type <json|js|ts> --project-id <projectId> --stack-id <stackId>',
+        '<%= config.bin %> <%= command.id %> --blueprint-type <json|js|ts> --project-id <projectId> --stack-name <stackName>',
+    ];
+    static flags = {
+        'blueprint-type': Flags.string({
+            description: 'Blueprint manifest type to use for the Blueprint',
+            options: ['json', 'js', 'ts'],
+            aliases: ['type'],
+        }),
+        'project-id': Flags.string({
+            description: 'Sanity Project ID to use for the Blueprint',
+            aliases: ['project', 'projectId'],
+        }),
+        'stack-id': Flags.string({
+            description: 'Existing Stack ID to use for the Blueprint',
+            aliases: ['stack', 'stackId'],
+            dependsOn: ['project-id'],
+            exclusive: ['stack-name'],
+        }),
+        'stack-name': Flags.string({
+            char: 'n',
+            description: 'Name to use for a NEW Stack',
+            aliases: ['name'],
+            dependsOn: ['project-id'],
+            exclusive: ['stack-id'],
+        }),
+    };
     async run() {
+        const { flags } = await this.parse(Init);
+        const { 'blueprint-type': flagBlueprintType, 'project-id': flagProjectId, 'stack-id': flagStackId, 'stack-name': flagStackName, } = flags;
         const existingBlueprint = findBlueprintFile();
         if (existingBlueprint) {
             this.error(`A blueprint file already exists: ${existingBlueprint.fileName}`);
         }
-        const { blueprintExtension } = await inquirer.prompt([
+        const blueprintExtension = flagBlueprintType || (await this.promptForBlueprintType());
+        if (!blueprintExtension)
+            this.error('Blueprint type is required.');
+        const projectId = flagProjectId || (await this.promptForProjectId());
+        if (!projectId)
+            this.error('Project ID is required.');
+        let stackId = flagStackId;
+        if (!stackId) {
+            if (flagStackName) {
+                const stack = await this.createEmptyStack({
+                    stackPayload: { name: flagStackName, projectId, document: { resources: [] } },
+                    auth: { token, projectId },
+                });
+                stackId = stack.id;
+            }
+            else {
+                stackId = await this.promptForStackId({ projectId });
+            }
+        }
+        const fileName = `blueprint.${blueprintExtension}`;
+        const filePath = join(cwd(), fileName);
+        writeBlueprintToDisk({ blueprintFilePath: filePath });
+        this.log(`Created new blueprint: ./${fileName}`);
+        writeConfigFile({ blueprintFilePath: filePath, projectId, stackId });
+        this.log(`Created new config file: ./${fileName}.config.json`);
+        if (blueprintExtension === 'ts') {
+            this.log('\nNote: TypeScript support requires "tsx" to be installed. Run: npm install -D tsx');
+        }
+    }
+    async promptForBlueprintType() {
+        const { pickedBlueprintsType } = await inquirer.prompt([
             {
                 type: 'list',
-                name: 'blueprintExtension',
+                name: 'pickedBlueprintsType',
                 message: 'Choose a blueprint type:',
                 choices: [
                     { name: 'JSON (Recommended)', value: 'json' },
@@ -29,6 +90,9 @@ export default class Init extends Command {
                 default: 'json',
             },
         ]);
+        return pickedBlueprintsType;
+    }
+    async promptForProjectId() {
         const { ok: projectsOk, error: projectsErr, projects } = await listProjects({ token });
         if (!projectsOk)
             this.error(projectsErr ?? 'Unknown error listing projects');
@@ -39,14 +103,17 @@ export default class Init extends Command {
             name: `"${displayName}" ${niceId(projectId)}`,
             value: projectId,
         }));
-        const { projectId } = await inquirer.prompt([
+        const { pickedProjectId } = await inquirer.prompt([
             {
                 type: 'list',
-                name: 'projectId',
+                name: 'pickedProjectId',
                 message: 'Select your Sanity project:',
                 choices: projectChoices,
             },
         ]);
+        return pickedProjectId;
+    }
+    async promptForStackId({ projectId }) {
         const { ok: stacksOk, error: stacksErr, stacks } = await listStacks({ token, projectId });
         if (!stacksOk)
             this.error(stacksErr || 'Failed to list Stacks');
@@ -58,16 +125,15 @@ export default class Init extends Command {
                 value: s.id,
             })));
         }
-        let stackId;
-        const { stackId: stackIdChoice } = await inquirer.prompt([
+        const { pickedStackId } = await inquirer.prompt([
             {
                 type: 'list',
-                name: 'stackId',
+                name: 'pickedStackId',
                 message: 'Select your Blueprint Stack:',
                 choices: stackChoices,
             },
         ]);
-        if (stackIdChoice === 'new') {
+        if (pickedStackId === 'new') {
             const { stackName } = await inquirer.prompt([
                 {
                     type: 'input',
@@ -76,25 +142,18 @@ export default class Init extends Command {
                     validate: (input) => input.length > 0 || 'Stack name is required',
                 },
             ]);
-            const { ok: stackOk, error: stackErr, stack, } = await createStack({
+            const stack = await this.createEmptyStack({
                 stackPayload: { name: stackName, projectId, document: { resources: [] } },
                 auth: { token, projectId },
             });
-            if (!stackOk)
-                this.error(stackErr || 'Failed to create Stack');
-            stackId = stack.id;
-        }
-        else {
-            stackId = stackIdChoice;
-        }
-        const fileName = `blueprint.${blueprintExtension}`;
-        const filePath = join(cwd(), fileName);
-        writeBlueprintToDisk({ blueprintFilePath: filePath });
-        this.log(`Created new blueprint: ./${fileName}`);
-        writeConfigFile({ blueprintFilePath: filePath, projectId, stackId });
-        this.log(`Created new config file: ./${fileName}.config.json`);
-        if (blueprintExtension === 'ts') {
-            this.log('\nNote: TypeScript support requires "tsx" to be installed. Run: npm install -D tsx');
+            return stack.id;
         }
+        return pickedStackId;
+    }
+    async createEmptyStack({ stackPayload, auth, }) {
+        const response = await createStack({ stackPayload, auth });
+        if (!response.ok)
+            this.error(response.error || 'Failed to create Stack');
+        return response.stack;
     }
 }

package/dist/commands/functions/env/list.d.ts

@@ -0,0 +1,9 @@
+import { Command } from '@oclif/core';
+export default class List extends Command {
+    static args: {
+        name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/functions/env/list.js

@@ -0,0 +1,30 @@
+import { Args, Command } from '@oclif/core';
+import { readBlueprintOnDisk } from '../../../actions/blueprints/blueprint.js';
+import { list } from '../../../actions/functions/env/list.js';
+import config from '../../../config.js';
+import { findFunctionByName } from '../../../utils/find-function.js';
+export default class List extends Command {
+    static args = {
+        name: Args.string({ description: 'The name of the Sanity Function', required: true }),
+    };
+    static description = 'List the environment variables for a Sanity function';
+    static examples = ['<%= config.bin %> <%= command.id %> MyFunction'];
+    async run() {
+        const { args } = await this.parse(List);
+        const { deployedStack } = await readBlueprintOnDisk({ getStack: true, token: config.token });
+        if (!deployedStack)
+            this.error('Stack not found. Is it deployed?'); // returns
+        const { projectId } = deployedStack;
+        const { externalId } = findFunctionByName(deployedStack, args.name);
+        const result = await list(externalId, {
+            token: config.token,
+            projectId,
+        });
+        if (!result.ok) {
+            this.error(`Error: ${result.error || 'Unknown error'}`);
+        }
+        for (const key of result.envvars) {
+            this.log(key);
+        }
+    }
+}

package/dist/utils/index.d.ts

@@ -1,4 +1,5 @@
 export * as display from './display/index.js';
 export * as findFunction from './find-function.js';
 export * as types from './types.js';
+export * as validate from './validate/index.js';
 export * as vendor from './vendor/index.js';

package/dist/utils/index.js

@@ -1,4 +1,5 @@
 export * as display from './display/index.js';
 export * as findFunction from './find-function.js';
 export * as types from './types.js';
+export * as validate from './validate/index.js';
 export * as vendor from './vendor/index.js';

package/dist/utils/validate/index.d.ts

@@ -0,0 +1 @@
+export * as validate from './resource.js';

package/dist/utils/validate/index.js

@@ -0,0 +1 @@
+export * as validate from './resource.js';

package/dist/utils/validate/resource.d.ts

@@ -0,0 +1,2 @@
+export declare function validateFunctionName(name: string): boolean;
+export declare function validateFunctionType(type: string): boolean;

package/dist/utils/validate/resource.js

@@ -0,0 +1,8 @@
+export function validateFunctionName(name) {
+    // must be 6+ characters, no special characters, no spaces, allow _ and -
+    return /^[a-zA-Z0-9][a-zA-Z0-9_-]{5,}$/.test(name);
+}
+export function validateFunctionType(type) {
+    const functionType = type.replace('sanity.function.', '');
+    return ['document-publish', 'document-create', 'document-delete'].includes(functionType);
+}

package/oclif.manifest.json

@@ -14,9 +14,33 @@
       },
       "description": "Add a resource to a Blueprint",
       "examples": [
-        "<%= config.bin %> <%= command.id %> function"
+        "<%= config.bin %> <%= command.id %> function",
+        "<%= config.bin %> <%= command.id %> function --name my-function",
+        "<%= config.bin %> <%= command.id %> function --name my-function --function-type document-publish"
       ],
-      "flags": {},
+      "flags": {
+        "name": {
+          "char": "n",
+          "description": "Name of the resource to add",
+          "name": "name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "function-type": {
+          "dependsOn": [
+            "name"
+          ],
+          "description": "Type of function to add (e.g. document-publish)",
+          "name": "function-type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "document-publish"
+          ],
+          "type": "option"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
       "id": "blueprints:add",
@@ -39,14 +63,56 @@
       "description": "View or edit Blueprint configuration",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --edit"
+        "<%= config.bin %> <%= command.id %> --test-config",
+        "<%= config.bin %> <%= command.id %> --edit",
+        "<%= config.bin %> <%= command.id %> --edit --project-id <projectId> --stack-id <stackId>"
       ],
       "flags": {
+        "test-config": {
+          "aliases": [
+            "test",
+            "validate"
+          ],
+          "char": "t",
+          "description": "Validate the configuration",
+          "name": "test-config",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "edit": {
+          "char": "e",
           "description": "Edit the configuration",
           "name": "edit",
           "allowNo": false,
           "type": "boolean"
+        },
+        "project-id": {
+          "aliases": [
+            "project",
+            "projectId"
+          ],
+          "dependsOn": [
+            "edit"
+          ],
+          "description": "Update the Project ID in the configuration. Requires --edit flag",
+          "name": "project-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "stack-id": {
+          "aliases": [
+            "stack",
+            "stackId"
+          ],
+          "dependsOn": [
+            "edit"
+          ],
+          "description": "Update the Stack ID in the configuration. Requires --edit flag",
+          "name": "stack-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -175,9 +241,73 @@
       "args": {},
       "description": "Initialize a new Blueprint",
       "examples": [
-        "<%= config.bin %> <%= command.id %>"
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --blueprint-type <json|js|ts>",
+        "<%= config.bin %> <%= command.id %> --blueprint-type <json|js|ts> --project-id <projectId> --stack-id <stackId>",
+        "<%= config.bin %> <%= command.id %> --blueprint-type <json|js|ts> --project-id <projectId> --stack-name <stackName>"
       ],
-      "flags": {},
+      "flags": {
+        "blueprint-type": {
+          "aliases": [
+            "type"
+          ],
+          "description": "Blueprint manifest type to use for the Blueprint",
+          "name": "blueprint-type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "json",
+            "js",
+            "ts"
+          ],
+          "type": "option"
+        },
+        "project-id": {
+          "aliases": [
+            "project",
+            "projectId"
+          ],
+          "description": "Sanity Project ID to use for the Blueprint",
+          "name": "project-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "stack-id": {
+          "aliases": [
+            "stack",
+            "stackId"
+          ],
+          "dependsOn": [
+            "project-id"
+          ],
+          "description": "Existing Stack ID to use for the Blueprint",
+          "exclusive": [
+            "stack-name"
+          ],
+          "name": "stack-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "stack-name": {
+          "aliases": [
+            "name"
+          ],
+          "char": "n",
+          "dependsOn": [
+            "project-id"
+          ],
+          "description": "Name to use for a NEW Stack",
+          "exclusive": [
+            "stack-id"
+          ],
+          "name": "stack-name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
       "id": "blueprints:init",
@@ -571,6 +701,37 @@
         "add.js"
       ]
     },
+    "functions:env:list": {
+      "aliases": [],
+      "args": {
+        "name": {
+          "description": "The name of the Sanity Function",
+          "name": "name",
+          "required": true
+        }
+      },
+      "description": "List the environment variables for a Sanity function",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> MyFunction"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "functions:env:list",
+      "pluginAlias": "@sanity/runtime-cli",
+      "pluginName": "@sanity/runtime-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "functions",
+        "env",
+        "list.js"
+      ]
+    },
     "functions:env:remove": {
       "aliases": [],
       "args": {
@@ -608,5 +769,5 @@
       ]
     }
   },
-  "version": "4.1.0"
+  "version": "4.3.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "4.1.0",
+  "version": "4.3.0",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",