@sanity/runtime-cli 1.3.0 → 1.4.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @sanity/runtime-cli
 $ sanity COMMAND
 running command...
 $ sanity (--version)
-@sanity/runtime-cli/1.3.0 linux-x64 node-v22.14.0
+@sanity/runtime-cli/1.4.0 linux-x64 node-v22.14.0
 $ sanity --help [COMMAND]
 USAGE
   $ sanity COMMAND
@@ -64,7 +64,7 @@ EXAMPLES
   $ sanity blueprints deploy
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v1.3.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v1.4.0/src/commands/blueprints/deploy.ts)_
 
 ## `sanity blueprints info`
 
@@ -81,7 +81,7 @@ EXAMPLES
   $ sanity blueprints info
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v1.3.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v1.4.0/src/commands/blueprints/info.ts)_
 
 ## `sanity blueprints logs`
 
@@ -89,11 +89,10 @@ Display logs for a Blueprint stack
 
 ```
 USAGE
-  $ sanity blueprints logs [-s <value>] [-w]
+  $ sanity blueprints logs [-w]
 
 FLAGS
-  -s, --stack-id=<value>  Stack ID to fetch logs for (optional if running in a blueprint directory)
-  -w, --watch             Watch for new logs (streaming mode)
+  -w, --watch  Watch for new logs (streaming mode)
 
 DESCRIPTION
   Display logs for a Blueprint stack
@@ -101,12 +100,10 @@ DESCRIPTION
 EXAMPLES
   $ sanity blueprints logs
 
-  $ sanity blueprints logs --stack-id <stack-id>
-
   $ sanity blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.3.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.4.0/src/commands/blueprints/logs.ts)_
 
 ## `sanity blueprints plan`
 
@@ -123,7 +120,7 @@ EXAMPLES
   $ sanity blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v1.3.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v1.4.0/src/commands/blueprints/plan.ts)_
 
 ## `sanity functions dev`
 
@@ -143,7 +140,7 @@ EXAMPLES
   $ sanity functions dev --port 8974
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v1.3.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v1.4.0/src/commands/functions/dev.ts)_
 
 ## `sanity functions invoke ID`
 
@@ -169,7 +166,7 @@ EXAMPLES
   $ sanity functions invoke <ID> --file 'payload.json'
 ```
 
-_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v1.3.0/src/commands/functions/invoke.ts)_
+_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v1.4.0/src/commands/functions/invoke.ts)_
 
 ## `sanity functions logs ID`
 
@@ -189,7 +186,7 @@ EXAMPLES
   $ sanity functions logs <ID>
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.3.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.4.0/src/commands/functions/logs.ts)_
 
 ## `sanity functions test PATH`
 
@@ -218,7 +215,7 @@ EXAMPLES
   $ sanity functions test ./test.ts --data '{ "id": 1 }' --timeout 60
 ```
 
-_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v1.3.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v1.4.0/src/commands/functions/test.ts)_
 
 ## `sanity help [COMMAND]`
 

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

@@ -1,4 +1,5 @@
 import type { BlueprintLog } from '../../utils/types.js';
+export declare const logsUrl: string;
 export declare function getLogs(stackId: string, projectId: string, token: string): Promise<{
     logs: BlueprintLog[];
     ok: boolean;

package/dist/actions/blueprints/logs.js

@@ -1,8 +1,9 @@
 import { EventSource } from 'eventsource';
 import config from '../../config.js';
 const { blueprints } = config.server;
+export const logsUrl = `${blueprints}vX/blueprints/logs`;
 export async function getLogs(stackId, projectId, token) {
-    const response = await fetch(`${blueprints}/vX/blueprints/logs?stackId=${stackId}`, {
+    const response = await fetch(`${logsUrl}?stackId=${stackId}`, {
         headers: {
             Accept: 'application/json',
             'Content-Type': 'application/json',
@@ -20,7 +21,7 @@ export async function getLogs(stackId, projectId, token) {
     };
 }
 export function streamLogs(stackId, projectId, token, onLog, onOpen, onError) {
-    const url = new URL(`${blueprints}/vX/blueprints/logs/stream`);
+    const url = new URL(`${logsUrl}/stream`);
     url.searchParams.append('stackId', stackId);
     const headers = {
         Authorization: `Bearer ${token}`,

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

@@ -1,4 +1,5 @@
 import type { BlueprintOperation } from '../../utils/types.js';
+export declare const stacksUrl: string;
 export declare function getOperation({ stackId, operationId, projectId, }: {
     stackId: string;
     operationId: string;

package/dist/actions/blueprints/operations.js

@@ -1,5 +1,6 @@
 import config from '../../config.js';
 const { blueprints } = config.server;
+export const stacksUrl = `${blueprints}vX/blueprints/stacks`;
 function getHeaders(projectId) {
     return {
         Authorization: `Bearer ${config.token}`,
@@ -9,7 +10,7 @@ function getHeaders(projectId) {
     };
 }
 export async function getOperation({ stackId, operationId, projectId, }) {
-    const path = `${blueprints}/vX/blueprints/stacks/${stackId}/operations/${operationId}`;
+    const path = `${stacksUrl}/${stackId}/operations/${operationId}`;
     const response = await fetch(path, {
         method: 'GET',
         headers: getHeaders(projectId),
@@ -30,7 +31,7 @@ export async function getOperation({ stackId, operationId, projectId, }) {
     };
 }
 export async function listOperations({ stackId, projectId, }) {
-    const path = `${blueprints}/vX/blueprints/stacks/${stackId}/operations`;
+    const path = `${stacksUrl}/${stackId}/operations`;
     const response = await fetch(path, {
         method: 'GET',
         headers: getHeaders(projectId),

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

@@ -1,7 +1,16 @@
-import type { Blueprint } from '../../utils/types.js';
-export default function readBlueprintOnDisk(): {
-    document: Blueprint;
-    path: string;
-    fileName: string;
-    extension: string;
-};
+import type { Blueprint, BlueprintError, BlueprintResource, BlueprintStack } from '../../utils/types.js';
+export default function readBlueprintOnDisk({ blueprintPath, getStack, }?: {
+    blueprintPath?: string;
+    getStack?: boolean;
+}): Promise<{
+    fileInfo: {
+        path: string;
+        fileName: string;
+        extension: string;
+    };
+    parsedBlueprint: Blueprint;
+    errors: BlueprintError[];
+    projectResource?: BlueprintResource;
+    stackResource?: BlueprintResource;
+    deployedStack?: BlueprintStack;
+}>;

package/dist/actions/blueprints/read-blueprint.js

@@ -1,6 +1,10 @@
 import { existsSync, readFileSync } from 'node:fs';
 import { extname, join } from 'node:path';
 import { cwd } from 'node:process';
+import { getStackByName } from '../../actions/blueprints/stacks.js';
+import { BlueprintErrorType } from '../../utils/types.js';
+// @ts-ignore - this is currently untyped
+import blueprintParserValidator from '../../utils/vendor/parser-validator.js';
 const SUPPORTED_FILE_NAMES_IN_PRIORITY_ORDER = [
     'blueprint.json',
     // 'blueprint.js',
@@ -8,7 +12,13 @@ const SUPPORTED_FILE_NAMES_IN_PRIORITY_ORDER = [
     // 'blueprint.cjs',
     // 'blueprint.ts',
 ];
-function findBlueprintFile() {
+function findBlueprintFile(blueprintPath) {
+    if (blueprintPath) {
+        if (existsSync(blueprintPath)) {
+            return { path: blueprintPath, fileName: blueprintPath, extension: extname(blueprintPath) };
+        }
+        throw Error(`Blueprint file not found: ${blueprintPath}`);
+    }
     for (const fileName of SUPPORTED_FILE_NAMES_IN_PRIORITY_ORDER) {
         const filePath = join(cwd(), fileName);
         if (existsSync(filePath)) {
@@ -17,17 +27,15 @@ function findBlueprintFile() {
     }
     return null;
 }
-export default function readBlueprintOnDisk() {
+export default async function readBlueprintOnDisk({ blueprintPath, getStack, } = {}) {
     try {
-        const blueprintPath = findBlueprintFile();
-        if (!blueprintPath)
+        const blueprintFile = findBlueprintFile(blueprintPath);
+        if (!blueprintFile)
             throw Error('Could not find Blueprint file');
-        const { path, fileName, extension } = blueprintPath;
-        let readBlueprint;
-        let blueprintJson;
+        const { path, fileName, extension } = blueprintFile;
+        let blueprintString;
         if (extension === '.json') {
-            readBlueprint = readFileSync(path, 'utf8').toString();
-            blueprintJson = JSON.parse(readBlueprint);
+            blueprintString = readFileSync(path, 'utf8').toString();
             // } else if (extension === '.js' || extension === '.mjs') {
             //   const blueprintModule = require(path)
             //   blueprintJson = blueprintModule.default
@@ -35,7 +43,45 @@ export default function readBlueprintOnDisk() {
         else {
             throw Error(`Unsupported blueprint file extension: ${extension}`);
         }
-        return { document: blueprintJson, path, fileName, extension };
+        const parsed = blueprintParserValidator(JSON.parse(blueprintString));
+        const { blueprint: parsedBlueprint } = parsed;
+        const errors = parsed.errors || [];
+        const projectResource = parsedBlueprint.resources.find((r) => r.type === 'sanity.project');
+        const stackResource = parsedBlueprint.resources.find((r) => r.type === 'sanity.blueprints.stack');
+        if (!projectResource) {
+            errors.push({
+                message: 'Blueprint is missing a project resource',
+                type: BlueprintErrorType.MissingProject,
+            });
+        }
+        if (!stackResource) {
+            errors.push({
+                message: 'Blueprint is missing a stack resource',
+                type: BlueprintErrorType.MissingStack,
+            });
+        }
+        let deployedStack;
+        if (getStack && projectResource && stackResource) {
+            const { stack } = await getStackByName({
+                name: stackResource.name,
+                projectId: projectResource.id,
+            });
+            if (!stack) {
+                errors.push({
+                    message: 'Stack not found',
+                    type: BlueprintErrorType.InvalidStack,
+                });
+            }
+            deployedStack = stack;
+        }
+        return {
+            fileInfo: { path, fileName, extension },
+            errors,
+            projectResource,
+            stackResource,
+            deployedStack,
+            parsedBlueprint,
+        };
     }
     catch (err) {
         throw Error(`Unable to parse Blueprint file: ${err}`);

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

@@ -1,12 +1,13 @@
 import type { BlueprintJob } from '../../utils/types.js';
-declare function listStacks({ projectId }: {
+export declare const stacksUrl: string;
+export declare function listStacks({ projectId }: {
     projectId: string;
 }): Promise<{
     ok: boolean;
     error: any;
     stacks: any;
 }>;
-declare function getStackByName({ name, projectId }: {
+export declare function getStackByName({ name, projectId }: {
     name: string;
     projectId: string;
 }): Promise<{
@@ -22,7 +23,7 @@ declare function getStackByName({ name, projectId }: {
     stackId: any;
     availableStacks?: undefined;
 }>;
-declare function getStack({ stackId, projectId }: {
+export declare function getStack({ stackId, projectId }: {
     stackId: string;
     projectId: string;
 }): Promise<{
@@ -30,7 +31,7 @@ declare function getStack({ stackId, projectId }: {
     error: any;
     stack: any;
 }>;
-declare function createStack({ blueprint, projectId }: {
+export declare function createStack({ blueprint, projectId, }: {
     blueprint: BlueprintJob;
     projectId: string;
 }): Promise<{
@@ -38,7 +39,7 @@ declare function createStack({ blueprint, projectId }: {
     error: any;
     stack: any;
 }>;
-declare function updateStack({ stackId, blueprint, projectId, }: {
+export declare function updateStack({ stackId, blueprint, projectId, }: {
     stackId: string;
     blueprint: BlueprintJob;
     projectId: string;
@@ -47,4 +48,3 @@ declare function updateStack({ stackId, blueprint, projectId, }: {
     error: any;
     stack: any;
 }>;
-export { listStacks, getStack, createStack, updateStack, getStackByName };

package/dist/actions/blueprints/stacks.js

@@ -1,5 +1,6 @@
 import config from '../../config.js';
 const { blueprints } = config.server;
+export const stacksUrl = `${blueprints}vX/blueprints/stacks`;
 function getHeaders(projectId) {
     return {
         Authorization: `Bearer ${config.token}`,
@@ -8,9 +9,8 @@ function getHeaders(projectId) {
         'X-Sanity-Scope-Id': projectId,
     };
 }
-async function listStacks({ projectId }) {
-    const path = `${blueprints}/vX/blueprints/stacks`;
-    const response = await fetch(path, {
+export async function listStacks({ projectId }) {
+    const response = await fetch(stacksUrl, {
         method: 'GET',
         headers: getHeaders(projectId),
     });
@@ -21,7 +21,7 @@ async function listStacks({ projectId }) {
         stacks,
     };
 }
-async function getStackByName({ name, projectId }) {
+export async function getStackByName({ name, projectId }) {
     const { ok, stacks, error } = await listStacks({ projectId });
     if (!ok || !stacks) {
         return {
@@ -49,9 +49,8 @@ async function getStackByName({ name, projectId }) {
         stackId: foundStack.id,
     };
 }
-async function getStack({ stackId, projectId }) {
-    const path = `${blueprints}/vX/blueprints/stacks/${stackId}`;
-    const response = await fetch(path, {
+export async function getStack({ stackId, projectId }) {
+    const response = await fetch(`${stacksUrl}/${stackId}`, {
         method: 'GET',
         headers: getHeaders(projectId),
     });
@@ -62,9 +61,8 @@ async function getStack({ stackId, projectId }) {
         stack,
     };
 }
-async function createStack({ blueprint, projectId }) {
-    const path = `${blueprints}/vX/blueprints/stacks`;
-    const response = await fetch(path, {
+export async function createStack({ blueprint, projectId, }) {
+    const response = await fetch(stacksUrl, {
         method: 'POST',
         headers: getHeaders(projectId),
         body: JSON.stringify(blueprint),
@@ -76,9 +74,8 @@ async function createStack({ blueprint, projectId }) {
         stack,
     };
 }
-async function updateStack({ stackId, blueprint, projectId, }) {
-    const path = `${blueprints}/vX/blueprints/stacks/${stackId}`;
-    const response = await fetch(path, {
+export async function updateStack({ stackId, blueprint, projectId, }) {
+    const response = await fetch(`${stacksUrl}/${stackId}`, {
         method: 'PUT',
         headers: getHeaders(projectId),
         body: JSON.stringify(blueprint),
@@ -90,4 +87,3 @@ async function updateStack({ stackId, blueprint, projectId, }) {
         stack,
     };
 }
-export { listStacks, getStack, createStack, updateStack, getStackByName };

package/dist/actions/blueprints/stash-asset.d.ts

@@ -1,4 +1,5 @@
 import type { BlueprintResource } from '../../utils/types.js';
+export declare const stashUrl: string;
 export declare function stashAsset({ resource, projectId, }: {
     resource: BlueprintResource;
     projectId: string;

package/dist/actions/blueprints/stash-asset.js

@@ -4,6 +4,7 @@ import { cwd } from 'node:process';
 import JSZip from 'jszip';
 import config from '../../config.js';
 const { blueprints } = config.server;
+export const stashUrl = `${blueprints}vX/blueprints/assets/stash`;
 function getHeaders(projectId) {
     return {
         Authorization: `Bearer ${config.token}`,
@@ -14,15 +15,12 @@ function getHeaders(projectId) {
 }
 export async function stashAsset({ resource, projectId, }) {
     try {
-        // Read the function source
         const source = await fs.readFileSync(path.join(cwd(), resource.src), 'utf8');
-        // Create zip with function source
         const zip = new JSZip();
         zip.file('index.js', source);
         const zipBuffer = await zip.generateAsync({ type: 'nodebuffer' });
         const base64Zip = zipBuffer.toString('base64');
-        // Stash the asset
-        const assetResponse = await fetch(`${blueprints}/vX/blueprints/assets/stash`, {
+        const assetResponse = await fetch(stashUrl, {
             method: 'POST',
             headers: getHeaders(projectId),
             body: JSON.stringify({
@@ -31,7 +29,6 @@ export async function stashAsset({ resource, projectId, }) {
             }),
         });
         const assetJson = await assetResponse.json();
-        // console.debug('ASSET RESPONSE:', assetJson)
         if (assetResponse.ok) {
             return { success: true, assetId: assetJson.id };
         }

package/dist/actions/functions/invoke.d.ts

@@ -1,2 +1,6 @@
-import type { PayloadOptions } from '../../utils/types.js';
-export declare function invoke(id: string, options: PayloadOptions): Promise<object>;
+import type { AuthParams, PayloadOptions } from '../../utils/types.js';
+export declare function invoke(id: string, options: PayloadOptions, auth: AuthParams): Promise<{
+    ok: boolean;
+    error: any;
+    json: any;
+}>;

package/dist/actions/functions/invoke.js

@@ -1,20 +1,18 @@
 import config from '../../config.js';
 import buildPayload from '../../utils/build-payload.js';
+import getHeaders from '../../utils/get-headers.js';
 const { functions } = config.server;
-function getHeaders() {
-    return {
-        Authorization: `Bearer ${config.token}`,
-        'Content-Type': 'application/json',
-        Accept: 'application/json',
-    };
-}
-export async function invoke(id, options) {
+export async function invoke(id, options, auth) {
     const payload = buildPayload(options);
-    const response = await fetch(`${functions}/vX/functions/${id}/invoke`, {
+    const response = await fetch(`${functions}vX/functions/${id}/invoke`, {
         body: JSON.stringify({ data: payload }),
-        headers: getHeaders(),
+        headers: getHeaders(auth),
         method: 'POST',
     });
     const json = await response.json();
-    return json;
+    return {
+        ok: response.ok,
+        error: response.ok ? null : json?.error?.message,
+        json: response.ok ? json : undefined,
+    };
 }

package/dist/actions/functions/logs.d.ts

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

package/dist/actions/functions/logs.js

@@ -1,15 +1,15 @@
 import config from '../../config.js';
+import getHeaders from '../../utils/get-headers.js';
 const { functions } = config.server;
-export async function logs(id, token) {
-    // eslint-disable-next-line n/no-unsupported-features/node-builtins
-    const response = await fetch(`${functions}/vX/functions/${id}/logs`, {
-        headers: {
-            Accept: 'application/json',
-            'Content-Type': 'application/json',
-            Authorization: `Bearer ${token}`,
-        },
+export async function logs(id, auth) {
+    const response = await fetch(`${functions}vX/functions/${id}/logs`, {
+        headers: getHeaders(auth),
         method: 'GET',
     });
-    const json = await response.json();
-    return json;
+    const logs = await response.json();
+    return {
+        ok: response.ok,
+        error: response.ok ? null : logs?.error?.message,
+        logs: response.ok ? logs : [],
+    };
 }

package/dist/commands/blueprints/deploy.js

@@ -1,6 +1,6 @@
 import { Command } from '@oclif/core';
 import readBlueprintOnDisk from '../../actions/blueprints/read-blueprint.js';
-import { createStack, getStackByName, updateStack } from '../../actions/blueprints/stacks.js';
+import { createStack, updateStack } from '../../actions/blueprints/stacks.js';
 import { stashAsset } from '../../actions/blueprints/stash-asset.js';
 import { green, red, yellow } from '../../utils/display/colors.js';
 import Spinner from '../../utils/spinner.js';
@@ -8,10 +8,21 @@ export default class Deploy extends Command {
     static description = 'Deploy a Blueprint';
     static examples = ['<%= config.bin %> <%= command.id %>'];
     async run() {
-        const { document } = readBlueprintOnDisk();
-        const { displayName, name, projectId, resources } = document;
+        const { errors, projectResource, stackResource, parsedBlueprint: { resources }, deployedStack, } = await readBlueprintOnDisk({ getStack: true });
+        if (errors.length > 0) {
+            // printErrors(errors) // TODO: error printer in formatting
+            this.log('Blueprint parse errors:');
+            console.dir(errors, { depth: null });
+            return;
+        }
+        if (!projectResource)
+            this.error('Blueprint must contain a project resource'); // returns
+        if (!stackResource)
+            this.error('Blueprint must contain a stack resource'); // returns
+        const { id: projectId } = projectResource;
+        const { name } = stackResource;
         const s = new Spinner();
-        const functionResources = resources.filter((r) => r.kind === 'function');
+        const functionResources = resources.filter((r) => r.type === 'function');
         // First stash all function assets
         if (functionResources.length > 0) {
             for (const resource of functionResources) {
@@ -31,33 +42,23 @@ export default class Deploy extends Command {
                 }
             }
         }
-        s.start('Looking for existing stack...');
-        const { ok, error, stackId: existingStackId, } = await getStackByName({
-            name,
-            projectId,
-        });
-        if (!ok) {
-            s.stop(`${red('Failed')} to list stacks`);
-            this.log(`Error: ${error || 'Unknown error'}`);
-            return;
-        }
         const blueprint = {
             name,
             projectId,
             document: { resources },
         };
         this.debug('BLUEPRINT DOCUMENT:', blueprint);
-        const { ok: deployOk, stack, error: deployError, } = existingStackId
-            ? await updateStack({ stackId: existingStackId, blueprint, projectId })
+        const { ok: deployOk, stack, error: deployError, } = deployedStack
+            ? await updateStack({ stackId: deployedStack.id, blueprint, projectId })
             : await createStack({ blueprint, projectId });
         this.debug('STACK RESPONSE:', stack);
         if (deployOk) {
-            s.stop(`${green('Success!')} Stack ${existingStackId ? 'updated' : 'created'} <${yellow(stack.id)}>`);
+            s.stop(`${green('Success!')} Stack ${deployedStack ? 'updated' : 'created'} <${yellow(stack.id)}>`);
             this.log('\nUse `sanity blueprints info` to check deployment status');
         }
         else {
             this.debug('STACK ERROR RESPONSE:', stack);
-            s.stop(`${red('Failed')} to ${existingStackId ? 'update' : 'create'} stack`);
+            s.stop(`${red('Failed')} to ${deployedStack ? 'update' : 'create'} stack`);
             this.log(`Error: ${deployError || 'Unknown error'}`);
         }
     }