@sanity/runtime-cli 17.1.0-next.gcfbd613 → 17.2.0-blueprinit.g62f8017

package/dist/utils/types.d.ts

@@ -1,4 +1,4 @@
-import { type BlueprintCorsOriginResource, type BlueprintDatasetResource, type BlueprintDocumentFunctionResource, type BlueprintDocumentWebhookResource, type BlueprintMediaLibraryAssetFunctionResource, type BlueprintProjectResource, type BlueprintResource, type BlueprintRobotResource, type BlueprintRoleResource, type BlueprintScheduledFunctionResource, type BlueprintSyncTagInvalidateFunctionResource } from '@sanity/blueprints';
+import { type BlueprintCorsOriginResource, type BlueprintDatasetResource, type BlueprintDocumentFunctionResource, type BlueprintDocumentWebhookResource, type BlueprintMediaLibraryAssetFunctionResource, type BlueprintProjectResource, type BlueprintResource, type BlueprintRobotResource, type BlueprintRoleResource, type BlueprintScheduledFunctionResource, type BlueprintStudioResource, type BlueprintSyncTagInvalidateFunctionResource } from '@sanity/blueprints';
 export type ScopeType = 'organization' | 'project';
 /** Result utility type */
 export type Result<T, E = string> = {
@@ -16,12 +16,8 @@ export interface ActionResponse {
 /** @internal */
 export type FunctionGroqResource = BlueprintDocumentFunctionResource | BlueprintMediaLibraryAssetFunctionResource;
 export type FunctionResource = FunctionGroqResource | BlueprintScheduledFunctionResource | BlueprintSyncTagInvalidateFunctionResource;
-export interface StudioResource extends BlueprintResource {
-    type: 'sanity.studio';
-    src: string;
-}
 /** Resource types that carry a deployable asset (have src: string) */
-export type AssetResource = FunctionResource | StudioResource;
+export type AssetResource = FunctionResource | BlueprintStudioResource;
 /** @internal */
 export interface AuthParams {
     token: string;
@@ -46,7 +42,7 @@ export declare function isProjectResource(r: unknown): r is BlueprintProjectReso
 export declare function isRobotResource(r: unknown): r is BlueprintRobotResource;
 export declare function isRoleResource(r: unknown): r is BlueprintRoleResource;
 export declare function isDatasetResource(r: unknown): r is BlueprintDatasetResource;
-export declare function isStudioResource(r: BlueprintResource): r is StudioResource;
+export declare function isStudioResource(r: BlueprintResource): r is BlueprintStudioResource;
 export declare function isAssetResource(r: BlueprintResource): r is AssetResource;
 export declare function isWebhookResource(r: unknown): r is BlueprintDocumentWebhookResource;
 interface StackBase {
@@ -84,6 +80,7 @@ export interface StackMutation {
         resources?: BlueprintResource[];
     };
     userMessage?: string;
+    preDeploy?: boolean;
 }
 /** @internal */
 export interface BuildPayloadOptions {

package/dist/utils/types.js

@@ -1,5 +1,5 @@
 import { validateCorsOrigin, validateDataset, validateDocumentWebhook, validateProject, validateRobot, validateRole, } from '@sanity/blueprints';
-import { SANITY_FUNCTION_PREFIX } from '../constants.js';
+import { SANITY_FUNCTION_PREFIX, SANITY_STUDIO } from '../constants.js';
 export function isLocalFunctionResource(r) {
     return r.type.startsWith(SANITY_FUNCTION_PREFIX);
 }
@@ -22,9 +22,8 @@ export function isRoleResource(r) {
 export function isDatasetResource(r) {
     return validateDataset(r).length === 0;
 }
-// TODO: update to use blueprints helpers once available
 export function isStudioResource(r) {
-    return r.type === 'sanity.studio';
+    return r.type === SANITY_STUDIO;
 }
 export function isAssetResource(r) {
     return isLocalFunctionResource(r) || isStudioResource(r);

package/oclif.manifest.json

@@ -1,5 +1,111 @@
 {
   "commands": {
+    "blueprinit": {
+      "aliases": [],
+      "args": {},
+      "description": "Scaffolds a Blueprint, Studio, and starter function around an existing Sanity project.\n\nThis hidden command is an experiment; its interface and generated files are not stable.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --yes"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "path": {
+          "aliases": [
+            "blueprint-path"
+          ],
+          "char": "p",
+          "description": "Path to a Blueprint file or directory containing one",
+          "env": "SANITY_BLUEPRINT_PATH",
+          "hidden": true,
+          "name": "path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "trace": {
+          "description": "Trace output",
+          "hidden": true,
+          "name": "trace",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "validate-resources": {
+          "description": "Validate resources",
+          "hidden": true,
+          "name": "validate-resources",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "verbose": {
+          "description": "Verbose output",
+          "hidden": true,
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "yes": {
+          "char": "y",
+          "description": "Skip confirmation prompts",
+          "name": "yes",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "organization-id": {
+          "aliases": [
+            "organization",
+            "organizationId",
+            "org"
+          ],
+          "description": "Organization to use when the account has several",
+          "name": "organization-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "project-id": {
+          "aliases": [
+            "project",
+            "projectId"
+          ],
+          "description": "Project to use when the organization has several",
+          "name": "project-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "blueprinit",
+      "pluginAlias": "@sanity/runtime-cli",
+      "pluginName": "@sanity/runtime-cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Experimental blueprints-first project init",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "blueprinit.js"
+      ]
+    },
     "blueprints:add": {
       "aliases": [],
       "args": {
@@ -30,6 +136,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -258,6 +373,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -390,6 +514,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -535,6 +668,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -668,6 +810,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -742,6 +893,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -864,6 +1024,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -1045,6 +1214,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -1197,6 +1375,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -1322,6 +1509,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -1431,6 +1627,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -1557,6 +1762,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -1677,6 +1891,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -1890,6 +2113,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -2025,6 +2257,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -2169,6 +2410,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -2337,6 +2587,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -2655,7 +2914,8 @@
       },
       "description": "Sets an environment variable in a deployed Sanity Function. If the variable already exists, its value is updated.\n\nEnvironment variables are useful for API keys, configuration values, and other secrets that shouldn't be hardcoded. Changes take effect on the next function invocation.",
       "examples": [
-        "<%= config.bin %> <%= command.id %> MyFunction API_URL https://api.example.com/"
+        "<%= config.bin %> <%= command.id %> MyFunction API_URL https://api.example.com/",
+        "<%= config.bin %> <%= command.id %> --stack <name-or-id> MyFunction API_URL https://api.example.com/"
       ],
       "flags": {
         "json": {
@@ -2664,6 +2924,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -2700,7 +2969,6 @@
         },
         "stack": {
           "description": "Stack name or ID to use instead of the locally configured Stack",
-          "hidden": true,
           "name": "stack",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -2771,7 +3039,8 @@
       },
       "description": "Displays all environment variables (keys only) configured in a deployed Sanity Function.\n\nUse 'functions env add' to set variables or 'functions env remove' to delete them.",
       "examples": [
-        "<%= config.bin %> <%= command.id %> MyFunction"
+        "<%= config.bin %> <%= command.id %> MyFunction",
+        "<%= config.bin %> <%= command.id %> --stack <name-or-id> MyFunction"
       ],
       "flags": {
         "json": {
@@ -2780,6 +3049,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -2816,7 +3094,6 @@
         },
         "stack": {
           "description": "Stack name or ID to use instead of the locally configured Stack",
-          "hidden": true,
           "name": "stack",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -2892,7 +3169,8 @@
       },
       "description": "Deletes an environment variable from a deployed Sanity Function. The change takes effect on the next function invocation.\n\nUse 'functions env list' to see current variables before removing.",
       "examples": [
-        "<%= config.bin %> <%= command.id %> MyFunction API_URL"
+        "<%= config.bin %> <%= command.id %> MyFunction API_URL",
+        "<%= config.bin %> <%= command.id %> --stack <name-or-id> MyFunction API_URL"
       ],
       "flags": {
         "json": {
@@ -2901,6 +3179,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "path": {
           "aliases": [
             "blueprint-path"
@@ -2937,7 +3224,6 @@
         },
         "stack": {
           "description": "Stack name or ID to use instead of the locally configured Stack",
-          "hidden": true,
           "name": "stack",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -2998,5 +3284,5 @@
       ]
     }
   },
-  "version": "17.1.0-next.gcfbd613"
+  "version": "17.2.0-blueprinit.g62f8017"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "17.1.0-next.gcfbd613",
+  "version": "17.2.0-blueprinit.g62f8017",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -26,7 +26,9 @@
   "files": [
     "./bin",
     "./dist",
-    "./oclif.manifest.json"
+    "./oclif.manifest.json",
+    "./SKILL.md",
+    "./skills"
   ],
   "bin": {
     "sanity-run": "bin/run.js"
@@ -40,7 +42,9 @@
     "clean": "shx rm -rf dist oclif.manifest.json",
     "copy:design-tokens": "shx rm -rf ./src/server/static/vendor/design-tokens && shx cp -r ./node_modules/@sanity-labs/design-tokens/dist/css ./src/server/static/vendor/design-tokens",
     "copy:server": "shx cp -r ./src/server/static ./dist/server",
-    "copy:wrapper": "shx cp ./src/utils/functions/child-process-wrapper.js ./dist/utils/functions/child-process-wrapper.js",
+    "copy:wrapper": "npm run copy:wrapper:entry && npm run copy:wrapper:modules",
+    "copy:wrapper:entry": "shx cp ./src/utils/functions/child-process-wrapper.js ./dist/utils/functions/child-process-wrapper.js",
+    "copy:wrapper:modules": "shx rm -rf ./dist/utils/functions/child-runtime && shx cp -r ./src/utils/functions/child-runtime ./dist/utils/functions/child-runtime",
     "lint": "biome ci",
     "lint:write": "biome check --write",
     "lint:fix": "npm run lint:write",
@@ -64,8 +68,10 @@
     "@oclif/core": "^4.11.14",
     "@oclif/plugin-help": "^6.2.53",
     "@sanity-labs/design-tokens": "^0.0.2-alpha.2",
-    "@sanity/blueprints": "^0.22.0",
+    "@sanity/blueprints": "^0.23.0",
     "@sanity/blueprints-parser": "^0.4.0",
+    "@sanity/cli-build": "^5.0.0",
+    "@sanity/cli-core": "^2.5.1",
     "@sanity/client": "^7.23.1",
     "adm-zip": "^0.6.0",
     "array-treeify": "^0.1.5",
@@ -78,6 +84,7 @@
     "ora": "^9.4.1",
     "signal-exit": "^4.1.0",
     "strip-ansi": "^7.2.0",
+    "tar-fs": "^3.1.3",
     "tar-stream": "^3.2.0",
     "vite": "^8.1.4",
     "ws": "^8.21.1",
@@ -97,6 +104,7 @@
     "@types/cardinal": "^2.1.1",
     "@types/mime-types": "^3.0.1",
     "@types/node": "^22",
+    "@types/tar-fs": "^2.0.4",
     "@types/tar-stream": "^3.1.4",
     "@types/ws": "^8.18.1",
     "@vitest/coverage-v8": "4.1.10",

package/skills/blueprinit.md

@@ -0,0 +1,40 @@
+# Blueprinit
+
+Use `blueprinit` to scaffold a Blueprint around an existing Sanity project. The command is
+experimental, hidden from root help, and available from the `blueprinit` npm dist-tag.
+
+## Before running
+
+- Work in the directory that should contain the Blueprint.
+- Confirm the user is signed in with `npx sanity login`.
+- Confirm the account has an organization, project, and dataset.
+- Treat the run as state-changing: it writes local files and creates an empty,
+  organization-scoped Stack.
+
+If the directory already contains a Blueprint, the command exits without changing it. A root
+`sanity.config.*` switches the command to Studio adoption instead of creating a new Studio.
+
+## Unattended run
+
+When the organization and project are known, run:
+
+```sh
+npx @sanity/runtime-cli@blueprinit blueprinit --yes \
+  --organization-id <organization-id> \
+  --project-id <project-id>
+```
+
+Use both IDs when possible. Without them, accounts with several organizations or projects require
+interactive selection. `--yes` skips confirmation and uses `studio` as the generated Studio name.
+
+## After running
+
+Inspect the generated files before installing dependencies or deploying. A fresh workspace includes
+`sanity.blueprint.ts`, an npm-workspace Studio, a `set-slug` function, `.gitignore`, and
+`.sanity/blueprint.config.json`.
+
+The command only creates the empty Stack remotely. Project and dataset attachment, Studio creation,
+and Function creation happen later with `blueprints deploy`.
+
+If Stack creation fails because of quota or a duplicate name, the scaffold can remain without
+`.sanity/blueprint.config.json`. Inspect the workspace before retrying.