@sanity/runtime-cli 14.11.0 → 14.12.1

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @sanity/runtime-cli
 $ sanity-run COMMAND
 running command...
 $ sanity-run (--version)
-@sanity/runtime-cli/14.11.0 linux-x64 node-v24.14.1
+@sanity/runtime-cli/14.12.1 linux-x64 node-v24.14.1
 $ sanity-run --help [COMMAND]
 USAGE
   $ sanity-run COMMAND
@@ -55,9 +55,9 @@ Add a function resource to a Blueprint
 ```
 USAGE
   $ sanity-run blueprints add TYPE [--json] [--validate-resources] [--example <value> | -n <value> | --fn-type
-    document-publish|document-create|document-update|document-delete|media-library-asset-create|media-library-asset-upda
-    te|media-library-asset-delete|scheduled-function... | --language ts|js | --javascript | --fn-helpers |
-    --fn-installer skip|npm|pnpm|yarn] [-i | ]
+    document-publish|document-create|document-delete|document-update|media-library-asset-create|media-library-asset-dele
+    te|media-library-asset-update|scheduled-function|sync-tag-invalidate... | --language ts|js | --javascript |
+    --fn-helpers | --fn-installer skip|npm|pnpm|yarn] [-i | ]
 
 ARGUMENTS
   TYPE  (function) Type of resource to add (only "function" is supported)
@@ -72,9 +72,9 @@ FLAGS
                                  <options: skip|npm|pnpm|yarn>
       --fn-type=<option>...      Document change event(s) that should trigger the function; you can specify multiple
                                  events by specifying this flag multiple times
-                                 <options:
-                                 document-publish|document-create|document-update|document-delete|media-library-asset-cr
-                                 eate|media-library-asset-update|media-library-asset-delete|scheduled-function>
+                                 <options: document-publish|document-create|document-delete|document-update|media-librar
+                                 y-asset-create|media-library-asset-delete|media-library-asset-update|scheduled-function
+                                 |sync-tag-invalidate>
       --javascript               Use JavaScript instead of TypeScript
       --json                     Format output as json
       --language=<option>        [default: ts] Language of the new function
@@ -101,7 +101,7 @@ EXAMPLES
   $ sanity-run blueprints add function --name my-function --fn-type document-create --fn-type document-update --lang js
 ```
 
-_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -109,8 +109,8 @@ View or edit the local Blueprint configuration
 
 ```
 USAGE
-  $ sanity-run blueprints config [--json] [--validate-resources] [--project-id <value> -e] [--organization-id <value> ]
-    [--stack <value> ]
+  $ sanity-run blueprints config [--json] [--validate-resources] [--stack <value> -e] [--project-id <value> ]
+    [--organization-id <value> ]
 
 FLAGS
   -e, --edit                     Modify the configuration interactively, or directly when combined with ID flags.
@@ -140,7 +140,7 @@ EXAMPLES
   $ sanity-run blueprints config --edit --project-id <projectId> --stack <name-or-id>
 ```
 
-_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -182,7 +182,7 @@ EXAMPLES
   $ sanity-run blueprints deploy --fn-installer npm
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -218,7 +218,7 @@ EXAMPLES
   $ sanity-run blueprints destroy --stack <name-or-id> --project-id <projectId> --force --no-wait
 ```
 
-_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints doctor`
 
@@ -250,7 +250,7 @@ EXAMPLES
   $ sanity-run blueprints doctor --fix
 ```
 
-_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/blueprints/doctor.ts)_
+_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/blueprints/doctor.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -258,11 +258,12 @@ Display the status and resources of the remote Stack deployment
 
 ```
 USAGE
-  $ sanity-run blueprints info [--json] [--validate-resources] [--stack <value>]
+  $ sanity-run blueprints info [--json] [--validate-resources] [--stack <value>] [--project-id <value>]
 
 FLAGS
   --json                     Format output as json
-  --stack=<value>            Stack name or ID to use instead of the locally configured Stack
+  --project-id=<value>       Sanity project ID used to scope Blueprint and Stack
+  --stack=<value>            Stack name or ID
   --[no-]validate-resources  Validate resources
 
 DESCRIPTION
@@ -280,9 +281,11 @@ EXAMPLES
   $ sanity-run blueprints info
 
   $ sanity-run blueprints info --stack <name-or-id>
+
+  $ sanity-run blueprints info --project-id <id> --stack <name-or-id>
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init [DIR]`
 
@@ -290,7 +293,7 @@ Initialize a Blueprint and create a remote Stack
 
 ```
 USAGE
-  $ sanity-run blueprints init [DIR] [--json] [--validate-resources] [--verbose] [--dir <value>] [--example <value> |
+  $ sanity-run blueprints init [DIR] [--json] [--validate-resources] [--dir <value>] [--example <value> |
     --blueprint-type json|js|ts | --stack-id <value> | --stack-name <value>] [--project-id <value>] [--organization-id
     <value>]
 
@@ -308,7 +311,6 @@ FLAGS
   --stack-id=<value>         Existing Stack ID used to scope local Blueprint
   --stack-name=<value>       Name to use for a new Stack provisioned during initialization
   --[no-]validate-resources  Validate resources
-  --verbose                  Verbose output
 
 DESCRIPTION
   Initialize a Blueprint and create a remote Stack
@@ -336,7 +338,7 @@ EXAMPLES
   $ sanity-run blueprints init --blueprint-type <json|js|ts> --stack-name <stackName>
 ```
 
-_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -367,7 +369,7 @@ EXAMPLES
   $ sanity-run blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -395,7 +397,7 @@ EXAMPLES
   $ sanity-run blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run blueprints stacks`
 
@@ -427,7 +429,7 @@ EXAMPLES
   $ sanity-run blueprints stacks --organization-id <organizationId>
 ```
 
-_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions add`
 
@@ -436,9 +438,9 @@ Add a Function to your Blueprint
 ```
 USAGE
   $ sanity-run functions add [--json] [--validate-resources] [--example <value> | -n <value> |  | --language ts|js
-    | --javascript |  | ] [--type document-publish|document-create|document-update|document-delete|media-library-asset-c
-    reate|media-library-asset-update|media-library-asset-delete|scheduled-function... ] [--helpers] [--installer
-    skip|npm|pnpm|yarn] [-i | ]
+    | --javascript |  | ] [--type document-publish|document-create|document-delete|document-update|media-library-asset-c
+    reate|media-library-asset-delete|media-library-asset-update|scheduled-function|sync-tag-invalidate... ] [--helpers]
+    [--installer skip|npm|pnpm|yarn] [-i | ]
 
 FLAGS
   -i, --install                  Shortcut for --fn-installer npm
@@ -453,9 +455,9 @@ FLAGS
                                  <options: ts|js>
       --type=<option>...         Document change event(s) that should trigger the function; you can specify multiple
                                  events by specifying this flag multiple times
-                                 <options:
-                                 document-publish|document-create|document-update|document-delete|media-library-asset-cr
-                                 eate|media-library-asset-update|media-library-asset-delete|scheduled-function>
+                                 <options: document-publish|document-create|document-delete|document-update|media-librar
+                                 y-asset-create|media-library-asset-delete|media-library-asset-update|scheduled-function
+                                 |sync-tag-invalidate>
       --[no-]validate-resources  Validate resources
 
 DESCRIPTION
@@ -463,8 +465,8 @@ DESCRIPTION
 
   Scaffolds a new Function in the functions/ folder and templates a resource for your Blueprint manifest.
 
-  Functions are serverless handlers triggered by document events (create, update, delete, publish) or media library
-  events.
+  Functions are serverless handlers triggered by document, live content or media-library events (create, update, delete,
+  publish).
 
   After adding, use 'functions dev' to test locally, then 'blueprints deploy' to publish.
 
@@ -480,7 +482,7 @@ EXAMPLES
   $ sanity-run functions add --name my-function --type document-create --type document-update --lang js
 ```
 
-_See code: [src/commands/functions/add.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/functions/add.ts)_
+_See code: [src/commands/functions/add.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/functions/add.ts)_
 
 ## `sanity-run functions dev`
 
@@ -516,7 +518,7 @@ EXAMPLES
   $ sanity-run functions dev --timeout 60
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -547,7 +549,7 @@ EXAMPLES
   $ sanity-run functions env add MyFunction API_URL https://api.example.com/
 ```
 
-_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env list NAME`
 
@@ -575,7 +577,7 @@ EXAMPLES
   $ sanity-run functions env list MyFunction
 ```
 
-_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/functions/env/list.ts)_
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -605,7 +607,7 @@ EXAMPLES
   $ sanity-run functions env remove MyFunction API_URL
 ```
 
-_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions logs [NAME]`
 
@@ -647,7 +649,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test [NAME]`
 
@@ -655,11 +657,11 @@ Invoke a local Sanity Function
 
 ```
 USAGE
-  $ sanity-run functions test [NAME] [--json] [--validate-resources] [--data-before <value> | [-d <value> | -f
-    <value> | --document-id <value>] |  |  | --file-before <value> | --file-after <value> | --document-id-before <value>
-    | --document-id-after <value>] [--data-after <value> |  |  |  |  |  |  | ] [-e create|update|delete] [-t <value>]
-    [-a <value>] [--organization-id <value>] [--with-user-token] [--media-library-id <value> | --project-id <value> |
-    --dataset <value>]
+  $ sanity-run functions test [NAME] [--json] [--validate-resources] [--organization-id <value>] [--data-before
+    <value> | [-d <value> | -f <value> | --document-id <value>] |  |  | --file-before <value> | --file-after <value> |
+    --document-id-before <value> | --document-id-after <value>] [--data-after <value> |  |  |  |  |  |  | ] [-e
+    create|update|delete] [-t <value>] [-a <value>] [--with-user-token] [--media-library-id <value> | --project-id
+    <value> | --dataset <value>]
 
 ARGUMENTS
   [NAME]  The name of the Sanity Function
@@ -705,7 +707,7 @@ EXAMPLES
   $ sanity-run functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
 ```
 
-_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v14.11.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v14.12.1/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

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

@@ -3,6 +3,7 @@ import { type Blueprint } from '@sanity/blueprints-parser';
 import type { Logger } from '../../utils/logger.js';
 import type { BlueprintParserError, ScopeType } from '../../utils/types.js';
 import { type LocatedBlueprintsConfig } from './config.js';
+import { type ConfigSource } from './resolve.js';
 declare const SUPPORTED_FILE_EXTENSIONS: readonly [".json", ".js", ".mjs", ".ts"];
 type BlueprintFileExtension = (typeof SUPPORTED_FILE_EXTENSIONS)[number];
 export declare const JSON_BLUEPRINT_CONTENT: {
@@ -23,18 +24,26 @@ type FileInfo = {
 };
 /**
  * Finds the blueprint file in the given path or current working directory
- * @param blueprintPath - The path of the blueprint file or directory
  * @returns The path, file name, and extension of the blueprint file
  */
 export declare function findBlueprintFile(blueprintPath?: string): FileInfo | null;
+/** @see resolve.ts for the canonical definition */
+export type { ConfigSource } from './resolve.js';
+/** Result of loading a blueprint file from disk. */
+export interface LoadedBlueprintFile {
+    rawBlueprint: Record<string, unknown>;
+    module?: BlueprintModule;
+}
 /**
- * Source of the config value.
- * - config: from the config file - .sanity.blueprint.config.json most common
- * - env: from the environment - usually CLI var like `SANITY_ORGANIZATION_ID`
- * - module: from the blueprint module - undocumented escape hatch
- * - inferred: legacy `ST-<projectId>` stacks from launch
+ * Normalized result from the parser's {@link BlueprintOutput}
+ * to match the shape returned by {@link readLocalBlueprint}
  */
-export type ConfigSource = 'config' | 'env' | 'module' | 'inferred';
+export interface ParsedBlueprintContent {
+    /** The validated blueprint, or the raw data as fallback when parsing fails */
+    parsedBlueprint: Blueprint | Record<string, unknown>;
+    errors: BlueprintParserError[];
+    resources: BlueprintResource[];
+}
 /** Result of the blueprint read operation */
 export interface ReadBlueprintResult {
     fileInfo: FileInfo;
@@ -46,8 +55,6 @@ export interface ReadBlueprintResult {
     errors: BlueprintParserError[];
     /** Validated resources escaped from parser types */
     resources: BlueprintResource[];
-    /** @deprecated - use blueprintConfig.configPath instead */
-    configPath?: string;
     scopeType?: ScopeType;
     scopeId?: string;
     organizationId?: string;
@@ -60,13 +67,40 @@ export interface ReadBlueprintResult {
     };
 }
 /**
- * Reads the blueprint file from disk and parses it.
- * Overrides config file values with shell environment variables.
- * Can infer stackId from projectId if no stackId is provided and legacy ST-<projectId> stacks from launch are used.
+ * Load a blueprint file from disk: read JSON or import+execute a JS/TS module.
+ * Returns the raw blueprint data and the module reference (if dynamic).
+ */
+export declare function loadBlueprintFile(fileInfo: FileInfo): Promise<LoadedBlueprintFile>;
+/**
+ * Run the blueprint parser/validator on raw blueprint data.
+ * Optionally validates function resources.
+ */
+export declare function parseBlueprintContent(rawBlueprint: Record<string, unknown>, options: {
+    validateResources: boolean;
+}): ParsedBlueprintContent;
+/** Result of finding, loading, and parsing a blueprint file. */
+export interface LocalBlueprint extends ParsedBlueprintContent {
+    fileInfo: FileInfo;
+    rawBlueprint: Record<string, unknown>;
+    module?: BlueprintModule;
+}
+/**
+ * Find, load, and parse a local blueprint file in one step.
+ * Does not read the config file or resolve IDs -- callers that need
+ * scope/stack information should use `readConfigFile` + `resolveIds` separately.
  *
- * @param logger The logger instance
- * @param validate Validation options
- * @param blueprintPath - The path of the blueprint file or directory- will search up the directory tree!
+ * @param blueprintPath Path to a blueprint file or directory containing one
+ * @param options.validateResources Whether to validate function resources
+ */
+export declare function loadAndParseBlueprint(blueprintPath?: string, options?: {
+    validateResources: boolean;
+}): Promise<LocalBlueprint>;
+/**
+ * Reads the blueprint file from disk and parses it.
+ * Resolves IDs from environment > blueprint module > config file.
+ * Can infer stackId from projectId for legacy ST-<projectId> stacks.
+ * @see {@link loadBlueprintFile} {@link readConfigFile} {@link resolveIds} {@link parseBlueprintContent}
+ * @todo deprecate in favor of decomposed functions
  * @returns Known information about the Blueprint, config, and Stack
  */
 export declare function readLocalBlueprint(logger: Logger, validate: {
@@ -80,4 +114,3 @@ export declare function addResourceToBlueprint<T extends BlueprintResource>({ bl
     blueprintFilePath?: string;
     resource: T;
 }): T | undefined;
-export {};