@sanity/runtime-cli 17.7.1 → 17.8.0-blueprinit.g0993fa5

package/dist/utils/types.d.ts

@@ -14,7 +14,7 @@ export interface ActionResponse {
     error: string | null;
 }
 /** @internal */
-export type FunctionGroqResource = BlueprintDocumentFunctionResource | BlueprintMediaLibraryAssetFunctionResource;
+export type FunctionGroqResource = BlueprintDocumentFunctionResource | BlueprintMediaLibraryAssetFunctionResource | BlueprintDurableFunctionResource;
 export type FunctionResource = FunctionGroqResource | BlueprintPubSubFunctionResource | BlueprintScheduledFunctionResource | BlueprintSyncTagInvalidateFunctionResource | BlueprintDurableFunctionResource;
 /** Function resources that declare an `event`; PubSub functions are triggered by other functions */
 export type EventFunctionResource = Exclude<FunctionResource, BlueprintPubSubFunctionResource>;
@@ -111,7 +111,7 @@ export interface InvokeNonGroqPayloadOptions {
 export type InvokePayloadOptions = InvokeGroqPayloadOptions | InvokeNonGroqPayloadOptions;
 export type InvokePayloadMetadata = Pick<InvokeGroqPayloadOptions, 'event' | 'before' | 'after'> | Pick<InvokeNonGroqPayloadOptions, 'event'>;
 export type EventType = 'create' | 'update' | 'delete';
-export type NonGroqEventType = 'scheduled' | 'nested';
+export type NonGroqEventType = 'plain' | 'nested' | 'durable';
 export declare function isEventType(arg: string): arg is EventType;
 /** @internal */
 export interface InvokeGroqContextOptions {
@@ -161,6 +161,8 @@ export interface InvokeExecutionOptions {
     depth?: number;
     /** Function names already on the invoke call stack (innermost last), used to detect cycles. @internal */
     callStack?: string[];
+    /** Stream a durable step transition to the caller. @internal */
+    onStepEvent?: (event: DurableStepEvent) => void;
 }
 /**
  * Re-entrant callback that executes a named function from the blueprint on behalf
@@ -178,6 +180,7 @@ export type ParentToChildMessage = {
     type: 'start';
     srcPath: string;
     payload: unknown;
+    isDurable?: boolean;
 } | {
     type: 'invoke-response';
     id: string;
@@ -190,6 +193,9 @@ export type ParentToChildMessage = {
     id: string;
     ok: false;
     error: InvocationError;
+} | {
+    type: 'step-event';
+    event: DurableStepEvent;
 };
 /**
  * IPC messages sent from a function child process back up to the parent.
@@ -202,12 +208,16 @@ export type ChildToParentMessage = {
     id: string;
     name: string;
     payload: Record<string, unknown>;
+    isDurable?: boolean;
 } | {
     type: 'result';
     json?: JsonInvocationResponse;
     logs?: string;
     errorLogs?: string;
     error?: InvocationError;
+} | {
+    type: 'step-event';
+    event: DurableStepEvent;
 };
 /** @internal */
 export interface InvocationResponse {
@@ -290,4 +300,38 @@ export type Warning = {
     code: string;
     suggestions: string[];
 };
+/** @internal */
+export type DurableOperationSteps = 'run';
+/** @internal */
+export type DurableStepPhase = 'start' | 'complete' | 'error';
+/**
+ * Represents a single step in a durable operation
+ */
+export interface DurableStepEvent {
+    name: string;
+    kind: DurableOperationSteps;
+    phase: DurableStepPhase;
+    output?: unknown;
+    error?: InvocationError;
+    durationMs?: number;
+}
+export interface FunctionTestFlags {
+    data?: string;
+    event?: string;
+    file?: string;
+    timeout?: number;
+    api?: string;
+    dataset?: string;
+    'project-id'?: string;
+    'organization-id'?: string;
+    'document-id'?: string;
+    'with-user-token'?: boolean;
+    'data-before'?: string;
+    'data-after'?: string;
+    'file-before'?: string;
+    'file-after'?: string;
+    'document-id-before'?: string;
+    'document-id-after'?: string;
+    'media-library-id'?: string;
+}
 export {};

package/oclif.manifest.json

@@ -1,5 +1,141 @@
 {
   "commands": {
+    "init": {
+      "aliases": [],
+      "args": {
+        "directory": {
+          "description": "Directory to initialize. Interactive runs are asked for one instead.",
+          "name": "directory",
+          "required": false
+        }
+      },
+      "description": "Scaffolds a Blueprint, Studio, and starter function around an existing Sanity project.\n\nPass a directory to scaffold into it. Without one, an interactive run asks where the files go.\n\nThis hidden command is an experiment; its interface and generated files are not stable.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> ./my-workspace",
+        "<%= 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, and the hosted Studio slug",
+          "name": "stack-name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "studio-name": {
+          "description": "Blueprint-local name for the Studio resource and its directory",
+          "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": {
@@ -1556,9 +1692,10 @@
     "blueprints:stacks": {
       "aliases": [],
       "args": {},
-      "description": "Shows all Stacks associated with a project or organization. By default, lists Stacks scoped to the local Blueprint.\n\nUse this to discover existing Stacks you can scope a local Blueprint to (using 'blueprints config --edit'), or to audit what's deployed across your project.\n\nUse --include-projects with --organization-id to also list Stacks from all projects within the organization.",
+      "description": "Shows all Stacks associated with a project or organization. By default, lists Stacks scoped to the local Blueprint.\n\nUse this to discover existing Stacks you can scope a local Blueprint to (using 'blueprints config --edit'), or to audit what's deployed across your project.\n\nWithout a scope, prompts for an organization or project. Use --all to list Stacks across every organization and project you can access, or --include-projects with --organization-id for one organization and its projects.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --all",
         "<%= config.bin %> <%= command.id %> --project-id <projectId>",
         "<%= config.bin %> <%= command.id %> --organization-id <organizationId>",
         "<%= config.bin %> <%= command.id %> --organization-id <organizationId> --include-projects"
@@ -1620,7 +1757,8 @@
           "description": "Sanity project ID used to scope Blueprint and Stack",
           "exclusive": [
             "organization-id",
-            "include-projects"
+            "include-projects",
+            "all"
           ],
           "name": "project-id",
           "hasDynamicHelp": false,
@@ -1635,7 +1773,8 @@
           ],
           "description": "Sanity organization ID used to scope Blueprint and Stack",
           "exclusive": [
-            "project-id"
+            "project-id",
+            "all"
           ],
           "name": "organization-id",
           "hasDynamicHelp": false,
@@ -1650,6 +1789,17 @@
           "name": "include-projects",
           "allowNo": false,
           "type": "boolean"
+        },
+        "all": {
+          "description": "List Stacks from every organization and project you have access to",
+          "exclusive": [
+            "project-id",
+            "organization-id",
+            "include-projects"
+          ],
+          "name": "all",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -1662,7 +1812,7 @@
       "summary": "List remote Stack deployments for your project or organization",
       "enableJsonFlag": true,
       "needs": [
-        "scope"
+        "token"
       ],
       "isESM": true,
       "relativePath": [
@@ -3127,5 +3277,5 @@
       ]
     }
   },
-  "version": "17.7.1"
+  "version": "17.8.0-blueprinit.g0993fa5"
 }

package/package.json

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

package/skills/blueprints-stacks.md

@@ -17,7 +17,9 @@ npx @sanity/cli blueprints stacks --project-id PROJECT_ID --json
 npx @sanity/cli blueprints stacks --organization-id ORGANIZATION_ID --json
 ```
 
-The JSON result contains `stacks`, `scopeType`, and `scopeId`; each entry carries `resourceCount` rather than a full `resources` array. Zero results prints `No stacks found` and emits no JSON. Match both the Stack and its scope; names alone may be ambiguous.
+Always pass a scope flag or `--all` when automating. With no scope to resolve the command prompts for an organization, then for a project if you pick project scope; without a terminal, or with `--json`, it fails with a missing-scope error instead.
+
+The JSON result contains `stacks`, `scopeType`, and `scopeId`; each entry carries `resourceCount` rather than a full `resources` array. Zero results prints `No stacks found`, and under `--json` returns an empty `stacks` array. Match both the Stack and its scope; names alone may be ambiguous.
 
 To also include Stacks scoped to the organization's projects:
 
@@ -25,4 +27,14 @@ To also include Stacks scoped to the organization's projects:
 npx @sanity/cli blueprints stacks --organization-id ORGANIZATION_ID --include-projects --json
 ```
 
-`--include-projects` requires `--organization-id`, cannot be combined with `--project-id`, and only queries the organization's first 50 projects. This command does not change the local Blueprint target; use `blueprints config --edit` for that.
+`--include-projects` requires `--organization-id`, cannot be combined with `--project-id`, and only queries the organization's first 50 projects.
+
+To sweep every organization and project the token can reach:
+
+```sh
+npx @sanity/cli blueprints stacks --all --json
+```
+
+`--all` cannot be combined with the scope flags or `--include-projects`. It is best effort: scopes that return an error are skipped and reported as a count, and only the first 200 projects are queried. Its JSON result contains `stacks` and no top-level `scopeType`/`scopeId`; read each entry's own `scopeType` and `scopeId` instead.
+
+This command does not change the local Blueprint target; use `blueprints config --edit` for that.

package/skills/init.md

@@ -0,0 +1,170 @@
+# 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
+
+Pass the directory as an argument, or run the command from the directory that should contain the
+Blueprint. Without an argument an interactive run asks where the files go; an unattended run keeps
+the current directory.
+
+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 Stack name defaults to `<project>-<dataset>` and is also the hosted Studio slug, so it must be
+available across every Sanity organization. No API reports whether a slug is free, so a taken one
+fails during `blueprints deploy`.
+
+The Studio name is a Blueprint-local resource name and its directory under `studios/`. It defaults
+to `studio`. Every other generated name carries its resource type, so the defaults cannot collide.
+A dataset named `studio`, or `--studio-name production` against a `production` dataset, does
+collide; the command names the repeated value and writes nothing.
+
+When `SANITY_INTERNAL_ENV=staging`, the generated Studio URL and CORS origin use
+`https://<stack-name>.studio.sanity.work`. Other environments use
+`https://<stack-name>.sanity.studio`.
+
+For interactive organization, project, dataset, Stack-name, and confirmation 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.
+
+The generated Studio matches `sanity init`: the same `sanity`, `@sanity/vision`, `react`,
+`react-dom`, `styled-components`, `@types/react`, and `typescript` versions, the same
+`tsconfig.json`, and `visionTool()` beside `structureTool()`. `sanity` and `@sanity/vision` are
+resolved from the registry at scaffold time, so no version is written into this repository.
+The Studio has no `deploy` script, because the Blueprint deploys it.
+
+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.