@sanity/runtime-cli 17.6.2 → 17.7.0-blueprinit.g71744ef

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

@@ -1,10 +1,10 @@
 import { treeify } from 'array-treeify';
-import { SANITY_ACCESS_ROBOT, SANITY_ACCESS_ROLE, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_DURABLE, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_PUBSUB, SANITY_FUNCTION_SCHEDULED, SANITY_FUNCTION_SYNC_TAG_INVALIDATE, SANITY_PROJECT, SANITY_PROJECT_CORS, SANITY_PROJECT_DATASET, SANITY_PROJECT_WEBHOOK, } from '../../constants.js';
+import { SANITY_ACCESS_ROBOT, SANITY_ACCESS_ROLE, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_DURABLE, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_PUBSUB, SANITY_FUNCTION_SCHEDULED, SANITY_FUNCTION_SYNC_TAG_INVALIDATE, SANITY_PROJECT, SANITY_PROJECT_CORS, SANITY_PROJECT_DATASET, SANITY_PROJECT_WEBHOOK, SANITY_STUDIO, } from '../../constants.js';
 import { styleText } from '../style-text.js';
-import { isCorsOriginResource, isDatasetResource, isRobotResource, isRoleResource, isWebhookResource, } from '../types.js';
+import { isCorsOriginResource, isDatasetResource, isRobotResource, isRoleResource, isStudioResource, isWebhookResource, } from '../types.js';
 import { formatDateTime, formatDuration } from './dates.js';
 import { capitalize, niceId, renderSection } from './presenters.js';
-import { arrayifyCors, arrayifyDataset, arrayifyFunction, arrayifyRobot, arrayifyRole, arrayifyWebhook, } from './resources-formatting.js';
+import { arrayifyCors, arrayifyDataset, arrayifyFunction, arrayifyRobot, arrayifyRole, arrayifyStudio, arrayifyWebhook, } from './resources-formatting.js';
 const functionCategory = {
     label: 'Functions',
     displayNameAttribute: 'displayName',
@@ -58,6 +58,13 @@ const RESOURCE_CATEGORIES = {
             return isWebhookResource(res) ? arrayifyWebhook(res) : [];
         },
     },
+    [SANITY_STUDIO]: {
+        label: 'Studios',
+        displayNameAttribute: 'title',
+        formatDetails(res) {
+            return isStudioResource(res) ? arrayifyStudio(res) : [];
+        },
+    },
 };
 const categoryByLabel = Object.values(RESOURCE_CATEGORIES).reduce((acc, curr) => {
     acc[curr.label] = curr;

package/dist/utils/display/resources-formatting.d.ts

@@ -1,8 +1,9 @@
-import type { BlueprintCorsOriginResource, BlueprintDatasetResource, BlueprintDocumentWebhookResource, BlueprintResource, BlueprintRobotResource, BlueprintRoleResource } from '@sanity/blueprints';
+import type { BlueprintCorsOriginResource, BlueprintDatasetResource, BlueprintDocumentWebhookResource, BlueprintResource, BlueprintRobotResource, BlueprintRoleResource, BlueprintStudioResource } from '@sanity/blueprints';
 import type { TreeInput } from 'array-treeify';
-export declare function arrayifyFunction(fn: BlueprintResource): TreeInput;
 export declare function arrayifyCors(resource: BlueprintCorsOriginResource): TreeInput;
 export declare function arrayifyDataset(resource: BlueprintDatasetResource): TreeInput;
+export declare function arrayifyFunction(fn: BlueprintResource): TreeInput;
 export declare function arrayifyRobot(resource: BlueprintRobotResource): TreeInput;
 export declare function arrayifyRole(resource: BlueprintRoleResource): TreeInput;
+export declare function arrayifyStudio(resource: BlueprintStudioResource): TreeInput;
 export declare function arrayifyWebhook(resource: BlueprintDocumentWebhookResource): TreeInput;

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

@@ -1,11 +1,23 @@
 import { hasEventSource, isLocalFunctionResource, isScheduleEvent, } from '../../utils/types.js';
 import { styleText } from '../style-text.js';
+import { niceId } from './presenters.js';
 function formatLabel(label) {
     return styleText('dim', `${label}:`);
 }
 function formatLabeledValue(label, value) {
     return `${styleText('dim', `${label}:`)} ${value}`;
 }
+export function arrayifyCors(resource) {
+    return [formatLabeledValue('origin', resource.origin)];
+}
+export function arrayifyDataset(resource) {
+    const details = [formatLabeledValue('title', resource.datasetName)];
+    if (resource.aclMode)
+        details.push(formatLabeledValue('visibility', resource.aclMode));
+    if (resource.project)
+        details.push(formatLabeledValue('project', niceId(resource.project)));
+    return details;
+}
 function arrayifyEvent(event) {
     if (!event)
         return undefined;
@@ -55,19 +67,8 @@ export function arrayifyFunction(fn) {
     }
     return details;
 }
-export function arrayifyCors(resource) {
-    return [formatLabeledValue('origin', resource.origin)];
-}
-export function arrayifyDataset(resource) {
-    const details = [formatLabeledValue('title', resource.datasetName)];
-    if (resource.aclMode)
-        details.push(formatLabeledValue('visibility', resource.aclMode));
-    if (resource.project)
-        details.push(formatLabeledValue('project', resource.project));
-    return details;
-}
 export function arrayifyRobot(resource) {
-    const details = [formatLabeledValue('label', resource.label)];
+    const details = [];
     if (resource.memberships.length > 0) {
         details.push(formatLabel('memberships'));
         const memberships = [];
@@ -115,8 +116,16 @@ export function arrayifyRole(resource) {
     }
     return details;
 }
+export function arrayifyStudio(resource) {
+    const details = [formatLabeledValue('appHost', resource.slug)];
+    if (resource.project)
+        details.push(formatLabeledValue('project', niceId(resource.project)));
+    return details;
+}
 export function arrayifyWebhook(resource) {
     const details = [];
+    if (resource.displayName)
+        details.push(formatLabeledValue('displayName', resource.displayName));
     if (resource.description)
         details.push(formatLabeledValue('description', resource.description));
     details.push(formatLabeledValue('url', resource.url));
@@ -131,6 +140,8 @@ export function arrayifyWebhook(resource) {
         details.push(formatLabeledValue('httpMethod', resource.httpMethod));
     if (resource.dataset)
         details.push(formatLabeledValue('dataset', resource.dataset));
+    if (resource.project)
+        details.push(formatLabeledValue('project', niceId(resource.project)));
     // not included: headers, includeDrafts, includeAllVersions, secret, apiVersion
     return details;
 }

package/oclif.manifest.json

@@ -1,5 +1,134 @@
 {
   "commands": {
+    "init": {
+      "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",
+        "<%= config.bin %> <%= command.id %> --project-id <id> --dataset <name> --yes"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json",
+          "name": "json",
+          "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"
+        },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "hidden": true,
+          "name": "llms",
+          "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"
+        },
+        "dataset": {
+          "description": "Dataset to attach",
+          "name": "dataset",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "stack-name": {
+          "description": "Name for the new organization-scoped Stack",
+          "name": "stack-name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "studio-name": {
+          "description": "Name and hosted slug for the Studio resource",
+          "name": "studio-name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "init",
+      "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",
+        "init.js"
+      ]
+    },
     "blueprints:add": {
       "aliases": [],
       "args": {
@@ -3127,5 +3256,5 @@
       ]
     }
   },
-  "version": "17.6.2"
+  "version": "17.7.0-blueprinit.g71744ef"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "17.6.2",
+  "version": "17.7.0-blueprinit.g71744ef",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -65,20 +65,20 @@
     "@architect/hydrate": "~6.0.2",
     "@architect/inventory": "~6.1.0",
     "@inquirer/prompts": "^8.5.2",
-    "@oclif/core": "^4.13.3",
-    "@oclif/plugin-help": "^6.2.56",
+    "@oclif/core": "^4.13.4",
+    "@oclif/plugin-help": "^6.2.58",
     "@sanity-labs/design-tokens": "^0.0.2-alpha.2",
     "@sanity-labs/oclif-plugin-skills-flag": "^0.2.1",
-    "@sanity/blueprints": "^0.23.2",
-    "@sanity/blueprints-parser": "^0.4.0",
-    "@sanity/cli-build": "^5.1.0",
-    "@sanity/cli-core": "^2.8.1",
-    "@sanity/client": "^7.26.2",
+    "@sanity/blueprints": "^0.23.6",
+    "@sanity/blueprints-parser": "^0.5.0",
+    "@sanity/cli-build": "^5.2.0",
+    "@sanity/cli-core": "^3.0.0",
+    "@sanity/client": "^8.0.0",
     "adm-zip": "^0.6.0",
-    "array-treeify": "^0.1.5",
+    "array-treeify": "^0.2.0",
     "cardinal": "^2.1.1",
     "empathic": "^2.0.1",
-    "eventsource": "^4.1.1",
+    "eventsource": "^5.1.0",
     "groq-js": "^2.0.0",
     "jiti": "^2.7.0",
     "mime-types": "^3.0.2",
@@ -92,15 +92,15 @@
     "xdg-basedir": "^5.1.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.5.7",
+    "@biomejs/biome": "2.5.8",
     "@codemirror/lang-json": "^6.0.2",
     "@codemirror/state": "^6.7.1",
     "@enhance/store": "^1.0.2",
     "@lezer/highlight": "^1.2.3",
-    "@oclif/test": "^4.1.21",
+    "@oclif/test": "^4.1.22",
     "@playwright/test": "^1.62.1",
     "@rollup/plugin-node-resolve": "^16.0.3",
-    "@sanity/functions": "^1.6.0",
+    "@sanity/functions": "^1.6.6",
     "@types/adm-zip": "^0.5.8",
     "@types/cardinal": "^2.1.1",
     "@types/mime-types": "^3.0.1",

package/skills/init.md

@@ -0,0 +1,155 @@
+# init
+
+Use `init` 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.
+
+Use it for demos and evaluation, not as a stable project initializer. Its flags, generated files,
+and resource model may change.
+
+## Know what it does
+
+`init` uses an existing Sanity organization, project, and dataset. It writes local Blueprint
+files, then creates an empty organization-scoped Stack. The generated Blueprint attaches the
+project and dataset and declares resources for a later deployment.
+
+It does not create an organization, project, or dataset. It does not deploy the attached resources,
+CORS origin, Studio, or Function. Those changes happen only if `blueprints deploy` is run later.
+
+## Inspect the target directory
+
+Run the command from the directory that should contain the Blueprint.
+
+Before running:
+
+1. Check the working tree and existing files. Do not discard unrelated user changes.
+2. Look for a root `sanity.blueprint.*` file. If one exists, use the existing Blueprint instead of
+   initializing again.
+3. Look for a root `sanity.config.*` file. Its presence selects the Studio adoption flow.
+4. Confirm the user asked to initialize this directory. The command writes files and creates a
+   remote Stack.
+5. Confirm the user is signed in. If needed, have them run:
+
+```sh
+npx sanity login
+```
+
+The account must have at least one organization, one project in the selected organization, and one
+dataset in the selected project.
+
+Interactive runs show the Blueprint resources, hosted Studio URL, local changes, and remote Stack
+action before the confirmation prompt. Project and dataset attachment plus CORS, Studio, and
+Function creation remain pending until a later deployment.
+
+## Choose the flow
+
+- **Existing Blueprint with a configured Stack:** Exit without changes and use
+  `blueprints config --edit` or `blueprints doctor`.
+- **Existing Blueprint without a configured Stack:** Finish setup with `blueprints init`; it can
+  connect the existing manifest without rewriting it.
+- **Root Studio config:** Adopt the Studio in place. Read literal `projectId` and `dataset` strings
+  from `sanity.config.*`, falling back to `sanity.cli.*`. Do not move the Studio.
+- **Fresh workspace:** Create a Blueprint, an npm-workspace Studio, and a starter `set-slug`
+  document function.
+
+Do not rewrite a Studio config merely to make adoption work unless the user asks. Dynamic
+`projectId` or `dataset` values built from environment variables or imports cannot be detected.
+
+For an existing Blueprint, inspect it with:
+
+```sh
+npx @sanity/runtime-cli@blueprinit blueprints doctor
+```
+
+## Run unattended
+
+When the organization and project IDs are known, run this from the target directory:
+
+```sh
+npx @sanity/runtime-cli@blueprinit init --yes \
+  --organization-id <organization-id> \
+  --project-id <project-id> \
+  --dataset <dataset-name>
+```
+
+Replace all placeholders with real values. The project must belong to the organization, and the
+dataset must belong to the project. Do not guess any value.
+
+`--yes` skips confirmation. Without explicit values, an unattended run stops when the account has
+several organizations, projects, or datasets. Ask the user for the missing value or have them run
+the command interactively.
+
+Use `--stack-name <name>` and `--studio-name <name>` when those generated names need to be stable.
+The command normalizes both names to lowercase kebab case. The Studio name is also its hosted slug,
+so it must be available in the target environment. Stack and Studio names must differ because they
+also name Blueprint resources.
+
+When `SANITY_INTERNAL_ENV=staging`, the generated Studio URL and CORS origin use
+`https://<studio-name>.studio.sanity.work`. Other environments use
+`https://<studio-name>.sanity.studio`.
+
+For interactive organization, project, dataset, confirmation, and Studio-name prompts, have the
+user run:
+
+```sh
+npx @sanity/runtime-cli@blueprinit init
+```
+
+When the project has several datasets, the interactive command prompts for one and lists
+`production` first. Report the selected dataset from the command output.
+
+## Review the result
+
+A successful fresh run creates or updates:
+
+```text
+.
+├── .sanity/blueprint.config.json
+├── sanity.blueprint.ts
+├── package.json
+├── functions/
+│   └── set-slug/
+└── studios/
+    └── studio/
+```
+
+The command also creates or updates `.gitignore`. It preserves existing package metadata and adds
+the required npm workspaces and `@sanity/blueprints` dependency.
+
+An adopted Studio stays at the repository root. The command adds the Blueprint, Blueprint config,
+dependency, and `.gitignore` entry, but does not generate the starter Function.
+
+After the command exits:
+
+1. Confirm the output names the expected organization, project, and dataset.
+2. Confirm `.sanity/blueprint.config.json` exists. Its presence means Stack creation completed.
+3. Review `sanity.blueprint.ts`, including the Studio slug and credentialed CORS origin, plus
+   `package.json`, `.gitignore`, and the working-tree diff.
+4. Report the Stack ID and every created or modified path.
+
+Do not deploy as part of initialization unless the user separately asks for deployment. To continue
+after reviewing the scaffold, install dependencies and preview the deployment:
+
+```sh
+npm install
+npx @sanity/runtime-cli@blueprinit blueprints plan
+```
+
+Treat dependency installation and planning as separate follow-up actions when they were not part of
+the user's request.
+
+## Handle failures
+
+- **`No Sanity session found.`** Stop and ask the user to run `npx sanity login`. Authentication
+  fails before files are written.
+- **Multiple organizations or projects found.** Rerun with the matching `--organization-id` and
+  `--project-id`. Selection fails before files are written.
+- **No datasets found.** Ask the user to create or choose a project with a dataset. The command does
+  not create datasets.
+- **Could not read `projectId` and `dataset`.** The detected Studio config does not contain both
+  values as string literals. Pass explicit `--project-id` and `--dataset` values or report the config
+  file and let the user decide whether to change it.
+- **Refusing to overwrite an existing path.** Inspect the reported Studio or Function directory.
+  Do not delete or replace it without the user's direction.
+- **Stack quota or duplicate-name error.** Local scaffold files may already exist while
+  `.sanity/blueprint.config.json` does not. Resolve the Stack error, then run the recovery command
+  printed by `init`, which is `blueprints init`. It connects the existing manifest without rewriting it.