@sanity/runtime-cli 3.2.0 → 4.1.0

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

@@ -1,12 +1,12 @@
 import { treeify } from 'array-treeify';
-import { blue, bold, boldnblue, green, red, yellow } from './colors.js';
+import { blue, bold, boldnblue, green, niceId, red, yellow } from './colors.js';
 import { formatDate, formatDuration } from './dates.js';
 export function formatTitle(title, name) {
     return `${boldnblue(title)} ${bold(`"${name}"`)}`;
 }
 export function formatResourceTree(resources) {
     if (!resources || resources.length === 0) {
-        return '  No resources in this stack';
+        return '  Zero resources in this stack';
     }
     const output = [];
     output.push(`${blue('Stack Resources')} [${resources.length}]`);
@@ -18,7 +18,7 @@ export function formatResourceTree(resources) {
         functionsOutput.push(`${bold('Functions')} [${functionResources.length}]`);
         const functionResourcesOutput = functionResources.map((fn) => {
             const name = green(fn.displayName || fn.name);
-            const externalId = fn.externalId ? `Fn<${yellow(fn.externalId)}>` : '';
+            const externalId = fn.externalId ? `Fn${niceId(fn.externalId)}` : '';
             return `"${name}" ${externalId}`;
         });
         functionsOutput.push(functionResourcesOutput);
@@ -38,17 +38,20 @@ export function formatResourceTree(resources) {
 export function formatStackInfo(stack, isCurrentStack = false) {
     const output = [];
     const isStack = 'id' in stack;
+    const infoOutput = [];
     if (isStack) {
         const stackName = isCurrentStack ? boldnblue(stack.name) : bold(stack.name);
-        output.push(`"${stackName}" <${yellow(stack.id)}>${isCurrentStack ? ' (current)' : ''}`);
+        output.push(`"${stackName}" ${niceId(stack.id)}${isCurrentStack ? ' (current)' : ''}`);
     }
     else {
         output.push('Local Blueprint');
     }
-    const infoOutput = [];
     if (stack.resources) {
         infoOutput.push(`${stack.resources.length} resource${stack.resources.length === 1 ? '' : 's'}`);
     }
+    else {
+        infoOutput.push('No resources');
+    }
     if (isStack) {
         if (stack.createdAt)
             infoOutput.push(`Created: ${formatDate(stack.createdAt)}`);
@@ -58,7 +61,7 @@ export function formatStackInfo(stack, isCurrentStack = false) {
             const operation = stack.recentOperation;
             const operationOutput = [];
             if (operation.id)
-                operationOutput.push(`Recent Operation <${yellow(operation.id)}>:`);
+                operationOutput.push(`Recent Operation ${niceId(operation.id)}:`);
             if (operation.status) {
                 const operationColor = operation.status === 'COMPLETED' ? green : red;
                 const status = operation.status || 'UNKNOWN';

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

@@ -1,4 +1,5 @@
 export declare function bold(str: string): string;
+export declare function underline(str: string): string;
 export declare function dim(str: string): string;
 export declare function blue(str: string): string;
 export declare function green(str: string): string;

package/dist/utils/display/colors.js

@@ -2,6 +2,9 @@ import chalk from 'chalk';
 export function bold(str) {
     return chalk.bold(str);
 }
+export function underline(str) {
+    return chalk.underline(str);
+}
 export function dim(str) {
     return chalk.dim(str);
 }

package/dist/utils/invoke-local.d.ts

@@ -1,2 +1,3 @@
 import type { InvocationResponse, InvokeContextOptions } from './types.js';
+export declare function sanitizeLogs(logs: string): string;
 export default function invoke(srcPath: string, data: null | object, context: InvokeContextOptions, timeout?: number): Promise<InvocationResponse>;

package/dist/utils/invoke-local.js

@@ -5,6 +5,9 @@ import config from '../config.js';
 function getChildProcessWrapperPath() {
     return new URL('./child-process-wrapper.js', import.meta.url).pathname;
 }
+export function sanitizeLogs(logs) {
+    return logs.replace(/[a-zA-Z0-9]{75}/g, '*'.repeat(10));
+}
 export default async function invoke(srcPath, data, context, timeout = 5) {
     return new Promise((resolve, reject) => {
         let child;
@@ -18,7 +21,7 @@ export default async function invoke(srcPath, data, context, timeout = 5) {
             child.on('message', (data) => {
                 const { json, logs } = JSON.parse(data.toString());
                 shutdown();
-                resolve({ json, logs, error: '' });
+                resolve({ json, logs: sanitizeLogs(logs), error: '' });
             });
             child.on('error', (error) => {
                 reject(new Error(`encountered error ${error.message}`));
@@ -40,9 +43,12 @@ export default async function invoke(srcPath, data, context, timeout = 5) {
             const payload = {
                 ...data,
                 context: {
-                    apiHost: config.apiUrl,
-                    token: config.token,
                     ...context,
+                    clientOptions: {
+                        ...context.clientOptions,
+                        apiHost: config.apiUrl,
+                        token: config.token,
+                    },
                 },
             };
             child.send(JSON.stringify({ srcPath, payload }, null, 2));

package/dist/utils/types.d.ts

@@ -5,10 +5,41 @@ export interface AuthParams {
 }
 /** @internal */
 export interface LocalBlueprint {
+    /** @link https://github.com/sanity-io/blueprints-rfc/blob/main/readme.md#versioning */
     blueprintVersion?: string;
+    /** @link https://github.com/sanity-io/blueprints-rfc/blob/main/readme.md#values */
     values?: Record<string, unknown>;
+    /** @link https://github.com/sanity-io/blueprints-rfc/blob/main/readme.md#outputs */
     outputs?: Array<Record<string, unknown>>;
+    /** @link https://github.com/sanity-io/blueprints-rfc/blob/main/readme.md#resources */
     resources?: Array<LocalResource>;
+    /** @link https://github.com/sanity-io/blueprints-rfc/blob/main/readme.md#parameters */
+    parameters?: Array<{
+        name: string;
+        type: 'arg' | 'argument' | 'env-var' | 'envVar' | 'config' | 'stdin';
+    } & ({
+        type: 'arg' | 'argument';
+        argument: string;
+        'env-var'?: never;
+        setting?: never;
+    } | {
+        type: 'env-var' | 'envVar';
+        'env-var': string;
+        argument?: never;
+        setting?: never;
+    } | {
+        type: 'config';
+        setting: string;
+        'env-var'?: never;
+        argument?: never;
+    } | {
+        type: 'stdin';
+        'env-var'?: never;
+        argument?: never;
+        setting?: never;
+    })>;
+    /** @link https://github.com/sanity-io/blueprints-rfc/blob/main/readme.md#arbitrary-userland-data */
+    metadata?: Record<string, unknown>;
 }
 /** @internal */
 export interface LocalResource {
@@ -73,9 +104,11 @@ export interface InvokePayloadOptions {
 }
 /** @internal */
 export interface InvokeContextOptions {
-    apiVersion?: string;
-    dataset?: string;
-    projectId?: string;
+    clientOptions: {
+        apiVersion?: string;
+        dataset?: string;
+        projectId?: string;
+    };
 }
 /** @internal */
 export interface InvocationResponse {
@@ -89,6 +122,7 @@ export interface BlueprintLog {
     message: string;
     stackId: string;
     level: string;
+    metadata?: Record<string, unknown>;
 }
 /** @internal */
 export interface FunctionLog {

package/oclif.manifest.json

@@ -72,7 +72,14 @@
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
-      "flags": {},
+      "flags": {
+        "no-wait": {
+          "description": "Do not wait for deployment to complete",
+          "name": "no-wait",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
       "id": "blueprints:deploy",
@@ -132,10 +139,10 @@
     "blueprints:info": {
       "aliases": [],
       "args": {},
-      "description": "Show information about a Blueprint",
+      "description": "Show information about a deployed Blueprint Stack",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --id abc123"
+        "<%= config.bin %> <%= command.id %> --id ST-a1b2c3"
       ],
       "flags": {
         "id": {
@@ -250,9 +257,19 @@
       "args": {},
       "description": "List all Blueprint stacks",
       "examples": [
-        "<%= config.bin %> <%= command.id %>"
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --projectId a1b2c3"
       ],
-      "flags": {},
+      "flags": {
+        "projectId": {
+          "description": "Project ID to show stacks for",
+          "name": "projectId",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
       "id": "blueprints:stacks",
@@ -591,5 +608,5 @@
       ]
     }
   },
-  "version": "3.2.0"
+  "version": "4.1.0"
 }

package/package.json

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