@sanity/runtime-cli 1.5.0 → 1.6.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @sanity/runtime-cli
 $ sanity COMMAND
 running command...
 $ sanity (--version)
-@sanity/runtime-cli/1.5.0 linux-x64 node-v22.14.0
+@sanity/runtime-cli/1.6.0 linux-x64 node-v22.14.0
 $ sanity --help [COMMAND]
 USAGE
   $ sanity COMMAND
@@ -65,7 +65,7 @@ EXAMPLES
   $ sanity blueprints deploy
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v1.5.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/blueprints/deploy.ts)_
 
 ## `sanity blueprints info`
 
@@ -87,7 +87,7 @@ EXAMPLES
   $ sanity blueprints info --id abc123
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v1.5.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/blueprints/info.ts)_
 
 ## `sanity blueprints logs`
 
@@ -109,7 +109,7 @@ EXAMPLES
   $ sanity blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.5.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/blueprints/logs.ts)_
 
 ## `sanity blueprints plan`
 
@@ -126,7 +126,7 @@ EXAMPLES
   $ sanity blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v1.5.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/blueprints/plan.ts)_
 
 ## `sanity blueprints stacks`
 
@@ -143,7 +143,7 @@ EXAMPLES
   $ sanity blueprints stacks
 ```
 
-_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v1.5.0/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/blueprints/stacks.ts)_
 
 ## `sanity functions dev`
 
@@ -163,7 +163,7 @@ EXAMPLES
   $ sanity functions dev --port 8974
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v1.5.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/functions/dev.ts)_
 
 ## `sanity functions invoke ID`
 
@@ -189,7 +189,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.5.0/src/commands/functions/invoke.ts)_
+_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/functions/invoke.ts)_
 
 ## `sanity functions logs ID`
 
@@ -209,7 +209,7 @@ EXAMPLES
   $ sanity functions logs <ID>
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.5.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/functions/logs.ts)_
 
 ## `sanity functions test PATH`
 
@@ -238,7 +238,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.5.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/functions/test.ts)_
 
 ## `sanity help [COMMAND]`
 

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

@@ -14,7 +14,7 @@ export declare function readBlueprintOnDisk({ blueprintPath, getStack, }?: {
     stackId?: string;
     deployedStack?: BlueprintStack;
 }>;
-export declare function updateBlueprintMetadata({ blueprintPath, projectId, stackId, }: {
+/** @experimental */ export declare function updateBlueprintMetadata({ blueprintPath, projectId, stackId, }: {
     blueprintPath?: string;
     projectId: string;
     stackId: string;

package/dist/actions/blueprints/blueprint.js

@@ -1,4 +1,5 @@
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
 import { dirname, extname, join } from 'node:path';
 import { cwd } from 'node:process';
 import { BlueprintErrorType } from '../../utils/types.js';
@@ -7,10 +8,10 @@ import blueprintParserValidator from '../../utils/vendor/parser-validator.js';
 import { getStack as getStackById } from './stacks.js';
 const SUPPORTED_FILE_NAMES_IN_PRIORITY_ORDER = [
     'blueprint.json',
-    // 'blueprint.js',
-    // 'blueprint.mjs',
-    // 'blueprint.cjs',
-    // 'blueprint.ts',
+    'blueprint.js',
+    'blueprint.mjs',
+    'blueprint.cjs',
+    'blueprint.ts',
 ];
 function findBlueprintFile(blueprintPath) {
     if (blueprintPath) {
@@ -41,12 +42,12 @@ function readConfigFile(blueprintPath) {
             }
         }
     }
-    const metadataPath = join(cwd(), '.blueprint', 'config.json');
-    if (!existsSync(metadataPath))
+    const configFilePath = join(cwd(), '.blueprint', 'config.json');
+    if (!existsSync(configFilePath))
         return null;
     try {
-        const metadata = JSON.parse(readFileSync(metadataPath, 'utf8'));
-        return metadata || null;
+        const config = JSON.parse(readFileSync(configFilePath, 'utf8'));
+        return config || null;
     }
     catch (err) {
         return null;
@@ -59,25 +60,58 @@ export async function readBlueprintOnDisk({ blueprintPath, getStack, } = {}) {
             throw Error('Could not find Blueprint file! Use the init command.');
         const { path, fileName, extension } = blueprintFile;
         let blueprintString;
-        if (extension === '.json') {
-            blueprintString = readFileSync(path, 'utf8').toString();
-            // } else if (extension === '.js' || extension === '.mjs') {
-            //   const blueprintModule = require(path)
-            //   blueprintJson = blueprintModule.default
+        let blueprintJson;
+        let blueprintModule;
+        switch (extension) {
+            case '.json': {
+                blueprintString = readFileSync(path, 'utf8').toString();
+                blueprintJson = JSON.parse(blueprintString);
+                break;
+            }
+            case '.js':
+            case '.mjs': {
+                const module = await import(path);
+                blueprintModule = module.default;
+                break;
+            }
+            case '.cjs': {
+                const require = createRequire(import.meta.url);
+                blueprintModule = require(path);
+                break;
+            }
+            case '.ts': {
+                console.warn('\x1b[2mSupport for Typescript blueprints is experimental.\x1b[0m');
+                try {
+                    const { tsImport } = await import('tsx/esm/api');
+                    const module = await tsImport(path, dirname(path));
+                    blueprintModule = module.default;
+                }
+                catch (err) {
+                    if (err instanceof Error && err.message.includes('Cannot find module')) {
+                        throw Error(`TypeScript support requires 'tsx' to be installed. Run: npm install -D tsx`);
+                    }
+                    throw err;
+                }
+                break;
+            }
+            default:
+                throw Error(`Unsupported blueprint file extension: ${extension}`);
         }
-        else {
-            throw Error(`Unsupported blueprint file extension: ${extension}`);
+        if (blueprintModule) {
+            if (typeof blueprintModule !== 'function')
+                throw Error(`Blueprint ${fileName} must export a default function`);
+            blueprintJson = blueprintModule();
         }
-        const parsed = blueprintParserValidator(JSON.parse(blueprintString));
-        const { blueprint: parsedBlueprint } = parsed;
-        const errors = parsed.errors || [];
+        const parserResult = blueprintParserValidator(blueprintJson);
+        const { blueprint: parsedBlueprint } = parserResult;
+        const errors = parserResult.errors || [];
         // find project and stack IDs from .blueprint/config.json first,
         // then fallback to metadata in blueprint file,
         // finally fallback to resources array...
         let projectId;
         let stackId;
         const configIds = readConfigFile(blueprintPath);
-        const blueprintMetadata = extension === '.json' ? parsedBlueprint.metadata : null;
+        const blueprintMetadata = parsedBlueprint.metadata;
         // find/create project resource
         if (configIds?.projectId) {
             projectId = configIds.projectId;
@@ -126,6 +160,7 @@ export async function readBlueprintOnDisk({ blueprintPath, getStack, } = {}) {
         throw Error(`Unable to parse Blueprint file: ${err}`);
     }
 }
+/** @experimental */ // no, that's not a real JSDoc pragma
 export async function updateBlueprintMetadata({ blueprintPath, projectId, stackId, }) {
     const blueprintFile = findBlueprintFile(blueprintPath);
     if (!blueprintFile)

package/oclif.manifest.json

@@ -315,5 +315,5 @@
       ]
     }
   },
-  "version": "1.5.0"
+  "version": "1.6.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "A new CLI generated with oclif",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -13,6 +13,9 @@
   "engines": {
     "node": ">=20.11.0"
   },
+  "optionalPeerDependencies": {
+    "tsx": "^4.19.3"
+  },
   "files": [
     "./bin",
     "./dist",
@@ -64,6 +67,7 @@
     "rollup": "^4.36.0",
     "shx": "^0.4.0",
     "ts-node": "^10",
+    "tsx": "^4.19.3",
     "typescript": "^5",
     "vitest": "3.0.8"
   },