@sanity/runtime-cli 17.4.0 → 17.6.0

package/README.md

@@ -45,7 +45,7 @@ All `sanity-run` commands can also be run as `sanity <command>` when `@sanity/cl
 USAGE
   $ sanity-run blueprints add TYPE [--json] [--example <value> | -n <value> | --fn-type
     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 |
+    te|media-library-asset-update|pub-sub|scheduled-function|sync-tag-invalidate... | --language ts|js | --javascript |
     --fn-helpers | --fn-installer skip|npm|pnpm|yarn] [-i | ]
 
 ARGUMENTS
@@ -62,8 +62,8 @@ FLAGS
       --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-delete|document-update|media-library-
-                               asset-create|media-library-asset-delete|media-library-asset-update|scheduled-function|syn
-                               c-tag-invalidate>
+                               asset-create|media-library-asset-delete|media-library-asset-update|pub-sub|scheduled-func
+                               tion|sync-tag-invalidate>
       --javascript             Use JavaScript instead of TypeScript
       --json                   Format output as json
       --language=<option>      [default: ts] Language of the new function
@@ -90,7 +90,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/v17.4.0/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -127,7 +127,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/v17.4.0/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -160,7 +160,9 @@ DESCRIPTION
 
   Use --fn-installer to force which package manager to use when deploying functions.
 
-  Set SANITY_ASSET_TIMEOUT (seconds) to override the 60-second timeout for processing resource assets.
+  Set SANITY_ASSET_TIMEOUT (seconds) to override the 180-second timeout for processing resource assets.
+
+  Set SANITY_ASSET_CONCURRENCY to override how many resource assets are processed at once (default 4).
 
   Exit codes: 0 deployed, 2 deployment failed, 75 deployment accepted but completion could not be confirmed (rerun
   'blueprints info' to check).
@@ -181,7 +183,7 @@ EXAMPLES
   $ sanity-run blueprints deploy --new-stack-name <new-name>
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -189,16 +191,16 @@ Destroy a remote Stack deployment and its resources
 
 ```
 USAGE
-  $ sanity-run blueprints destroy [--json] [--project-id <value> --stack <value> --force] [--organization-id <value>  ]
+  $ sanity-run blueprints destroy [--json] [--project-id <value> --stack <value> -f] [--organization-id <value>  ]
     [--no-wait]
 
 FLAGS
-  --force                    Force Stack destruction (skip confirmation)
-  --json                     Format output as json
-  --no-wait                  Do not wait for Stack destruction to complete
-  --organization-id=<value>  Sanity organization ID used to scope Blueprint and Stack
-  --project-id=<value>       Sanity project ID used to scope Blueprint and Stack
-  --stack=<value>            Stack name or ID to destroy (defaults to the locally configured Stack)
+  -f, --force                    Force Stack destruction (skip confirmation)
+      --json                     Format output as json
+      --no-wait                  Do not wait for Stack destruction to complete
+      --organization-id=<value>  Sanity organization ID used to scope Blueprint and Stack
+      --project-id=<value>       Sanity project ID used to scope Blueprint and Stack
+      --stack=<value>            Stack name or ID to destroy (defaults to the locally configured Stack)
 
 DESCRIPTION
   Destroy a remote Stack deployment and its resources
@@ -219,7 +221,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/v17.4.0/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints doctor`
 
@@ -251,7 +253,7 @@ EXAMPLES
   $ sanity-run blueprints doctor --fix
 ```
 
-_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/blueprints/doctor.ts)_
+_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/doctor.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -259,13 +261,14 @@ Display the status and resources of the remote Stack deployment
 
 ```
 USAGE
-  $ sanity-run blueprints info [--json] [--stack <value>] [--project-id <value> | --organization-id <value>]
+  $ sanity-run blueprints info [--json] [-v] [--stack <value>] [--project-id <value> | --organization-id <value>]
 
 FLAGS
-  --json                     Format output as json
-  --organization-id=<value>  Sanity organization ID used to scope Blueprint and Stack
-  --project-id=<value>       Sanity project ID used to scope Blueprint and Stack
-  --stack=<value>            Stack name or ID
+  -v, --verbose                  Show resource and external IDs
+      --json                     Format output as json
+      --organization-id=<value>  Sanity organization ID used to scope Blueprint and Stack
+      --project-id=<value>       Sanity project ID used to scope Blueprint and Stack
+      --stack=<value>            Stack name or ID
 
 DESCRIPTION
   Display the status and resources of the remote Stack deployment
@@ -288,7 +291,7 @@ EXAMPLES
   $ sanity-run blueprints info --organization-id <orgId> --stack <name-or-id>
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init [DIR]`
 
@@ -318,12 +321,12 @@ DESCRIPTION
 
   A Blueprint is your local infrastructure-as-code configuration that defines Sanity resources (datasets, functions,
   etc.). A Stack is the remote deployment target where your Blueprint is applied.
-  [NOTE: Currently, accounts are limited to three (3) Stacks per project scope.]
 
   This is typically the first command you run in a new project. It creates a local Blueprint manifest file
   (sanity.blueprint.ts, .js, or .json) and provisions a new remote Stack.
-  Additionally, a Blueprint configuration file is created in .sanity/ containing the scope and Stack IDs. This is
-  .gitignored by default.
+  Additionally, a Blueprint configuration file is created in .sanity/ containing the scope and Stack IDs. A .gitignore
+  covering node_modules, .env, and Function build output is created or updated; the .sanity/ config itself is not
+  ignored.
 
   After initialization, use 'blueprints plan' to preview changes, then 'blueprints deploy' to apply them.
 
@@ -352,7 +355,7 @@ EXAMPLES
   $ sanity-run blueprints init old-stack --type <json|js|ts> --project-id <projectId> --stack-id <existingStackId>
 ```
 
-_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -360,8 +363,8 @@ Display logs for the current Blueprint's Stack deployment
 
 ```
 USAGE
-  $ sanity-run blueprints logs [--json] [--stack <value>] [--project-id <value> | --organization-id <value>] [-l
-    <value> | -w] [--since <value> | ] [--before <value> | ]
+  $ sanity-run blueprints logs [--stack <value>] [--project-id <value> | --organization-id <value>] [-l <value> | [-w
+    | --json]] [--since <value> | ] [--before <value> | ]
 
 FLAGS
   -l, --limit=<value>            Maximum number of log entries to retrieve (1-500)
@@ -398,7 +401,7 @@ EXAMPLES
   $ sanity-run blueprints logs --before 2026-05-01T00:00:00Z
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints mint-deploy-token`
 
@@ -443,7 +446,7 @@ EXAMPLES
   $ sanity-run blueprints mint-deploy-token --organization-id <orgId>
 ```
 
-_See code: [src/commands/blueprints/mint-deploy-token.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/blueprints/mint-deploy-token.ts)_
+_See code: [src/commands/blueprints/mint-deploy-token.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/mint-deploy-token.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -476,7 +479,7 @@ EXAMPLES
   $ sanity-run blueprints plan --organization-id <orgId> --stack <name-or-id>
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run blueprints promote`
 
@@ -512,7 +515,7 @@ EXAMPLES
   $ sanity-run blueprints promote --new-stack-name <new-name>
 ```
 
-_See code: [src/commands/blueprints/promote.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/blueprints/promote.ts)_
+_See code: [src/commands/blueprints/promote.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/promote.ts)_
 
 ## `sanity-run blueprints stacks`
 
@@ -548,7 +551,7 @@ EXAMPLES
   $ sanity-run blueprints stacks --organization-id <organizationId> --include-projects
 ```
 
-_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions add`
 
@@ -556,13 +559,13 @@ Add a Function to your Blueprint
 
 ```
 USAGE
-  $ sanity-run functions add [--json] [--example <value> | -n <value> |  | --language ts|js | --javascript |  | ]
-    [--type document-publish|document-create|document-delete|document-update|media-library-asset-create|media-library-as
-    set-delete|media-library-asset-update|scheduled-function|sync-tag-invalidate... ] [--helpers] [--installer
-    skip|npm|pnpm|yarn] [-i | ]
+  $ sanity-run functions add [--json] [--example <value> | -n <value> | --type
+    document-publish|document-create|document-delete|document-update|media-library-asset-create|media-library-asset-dele
+    te|media-library-asset-update|pub-sub|scheduled-function|sync-tag-invalidate... | --language ts|js | --javascript |
+    --helpers | --installer skip|npm|pnpm|yarn | -i]
 
 FLAGS
-  -i, --install             Shortcut for --fn-installer npm
+  -i, --install             Shortcut for --installer npm
   -n, --name=<value>        Name of the Function to add
       --example=<value>     Example to use for the Function
       --[no-]helpers        Add helpers to the new Function
@@ -575,8 +578,8 @@ FLAGS
       --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-delete|document-update|media-library-ass
-                            et-create|media-library-asset-delete|media-library-asset-update|scheduled-function|sync-tag-
-                            invalidate>
+                            et-create|media-library-asset-delete|media-library-asset-update|pub-sub|scheduled-function|s
+                            ync-tag-invalidate>
 
 DESCRIPTION
   Add a Function to your Blueprint
@@ -600,7 +603,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/v17.4.0/src/commands/functions/add.ts)_
+_See code: [src/commands/functions/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/add.ts)_
 
 ## `sanity-run functions dev`
 
@@ -624,18 +627,18 @@ DESCRIPTION
 
   Open the emulator in your browser to interactively test your functions with the payload editor.
 
-  Optionally, set the host and port with the --host and --port flags. Function timeout can be configured with the
-  --timeout flag.
+  Optionally, set the host and port with the --host and --port flags. Port 8974 is reserved for the emulator's
+  live-reload WebSocket server. Function timeout can be configured with the --timeout flag.
 
   To invoke a function with the CLI, use 'functions test'.
 
 EXAMPLES
-  $ sanity-run functions dev --host 127.0.0.1 --port 8974
+  $ sanity-run functions dev --host 127.0.0.1 --port 3333
 
   $ sanity-run functions dev --timeout 60
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -668,7 +671,7 @@ EXAMPLES
   $ sanity-run functions env add --stack <name-or-id> MyFunction API_URL https://api.example.com/
 ```
 
-_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env list NAME`
 
@@ -698,7 +701,7 @@ EXAMPLES
   $ sanity-run functions env list --stack <name-or-id> MyFunction
 ```
 
-_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/functions/env/list.ts)_
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -730,7 +733,7 @@ EXAMPLES
   $ sanity-run functions env remove --stack <name-or-id> MyFunction API_URL
 ```
 
-_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions logs [NAME]`
 
@@ -738,7 +741,7 @@ Retrieve or delete logs for a Sanity Function
 
 ```
 USAGE
-  $ sanity-run functions logs [NAME] [--stack <value>] [-u] [-f [-d | -l <value> | --json]] [-w]
+  $ sanity-run functions logs [NAME] [--stack <value>] [-u] [-f [-d | -l <value> | --json]] [-w | ]
 
 ARGUMENTS
   [NAME]  The name of the Sanity Function
@@ -770,7 +773,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v17.4.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test [NAME]`
 
@@ -827,7 +830,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/v17.4.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v17.6.0/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 
@@ -847,5 +850,5 @@ DESCRIPTION
   Display help for sanity-run.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.55/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.56/src/commands/help.ts)_
 <!-- commandsstop -->

package/SKILL.md

@@ -0,0 +1,59 @@
+---
+name: sanity-runtime-cli
+description: Use the Sanity `blueprints` and `functions` commands to manage Sanity Blueprints and develop, test, and operate Sanity Functions. Use when an agent needs to inspect or run `blueprints` & `functions` commands, work with Blueprint manifests and remote Stacks, or work with Sanity Function resources.
+---
+
+# Sanity Runtime CLI
+
+Typically, the `@sanity/runtime-cli` (`sanity-run`) CLI is not used directly by end-users. The main `@sanity/cli` (`sanity`) loads and uses this CLI internally.  
+All `sanity-run` commands can also be run as `sanity <command>` when `@sanity/cli` is available.  
+The preferred way to run Sanity commands is with `npx @sanity/cli <command>`.
+
+If Sanity authentication has been configured, `sanity-run` may be preferred in environments like CI/CD pipelines for its smaller install size.
+
+## Read command guidance first
+
+Before running an unfamiliar command, print its agent-oriented guidance:
+
+```sh
+sanity-run blueprints deploy --skill
+sanity-run functions test --skill
+sanity-run functions env add --skill
+```
+
+`--skill` prints the matching Markdown file and exits without executing the command. `--llms` and `--skills` are aliases.
+
+Use `--help` or [README.md](./README.md) for exhaustive arguments and flags. Use `--skill` for command workflows, automation advice, safety checks, and output-handling guidance.
+
+## Find command skill files
+
+Command guidance is stored in [skills/](./skills/). Derive filenames from oclif command IDs by replacing colons with hyphens:
+
+- `blueprints:deploy` → `skills/blueprints-deploy.md`
+- `functions:test` → `skills/functions-test.md`
+- `functions:env:add` → `skills/functions-env-add.md`
+
+Read the file matching the command before invoking it. Follow its guidance for destructive operations, credentials, environment variables, and long-running commands.
+
+## Resolve the target
+
+Most `blueprints` commands and every `functions` command that touches remote state need a scope (project or organization), a Stack, and a token. Each is resolved independently, in this order:
+
+1. Command flags, such as `--project-id`, `--organization-id`, and `--stack`.
+2. Environment variables: `SANITY_PROJECT_ID`, `SANITY_ORGANIZATION_ID`, `SANITY_BLUEPRINT_STACK_ID`.
+3. Values exported by the Blueprint manifest.
+4. `.sanity/blueprint.config.json`.
+
+When both a project ID and an organization ID resolve, project scope wins. Prefer explicit flags in CI and when correcting a misconfigured target; a value inherited from a lower-priority source is easy to miss.
+
+`SANITY_AUTH_TOKEN` supplies the token, otherwise it is read from the `@sanity/cli` login config. `SANITY_BLUEPRINT_PATH` points at a Blueprint file or its directory when it is not discoverable from the working directory.
+
+## Choose a command family
+
+- Use `blueprints` commands to manage local Blueprint manifests and remote Stack deployments.
+- Use `functions` commands to scaffold, build, emulate, test, and operate Sanity Functions.
+
+## Read Sanity documentation
+
+- [Sanity Blueprints](https://www.sanity.io/docs/blueprints)
+- [Sanity Functions](https://www.sanity.io/docs/functions)

package/dist/actions/blueprints/blueprint.js

@@ -5,7 +5,7 @@ import { pathToFileURL } from 'node:url';
 import blueprintParserValidator from '@sanity/blueprints-parser';
 import * as find from 'empathic/find';
 import { createJiti } from 'jiti';
-import { SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_SCHEDULED, } from '../../constants.js';
+import { SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_DURABLE, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_SCHEDULED, } from '../../constants.js';
 import { validateResources } from '../../utils/blueprints/validate-resources.js';
 import { backfillProjectBasedStackId, readConfigFile, } from './config.js';
 import { resolveIds } from './resolve.js';
@@ -122,6 +122,7 @@ export function parseBlueprintContent(rawBlueprint, options) {
             SANITY_FUNCTION_DOCUMENT,
             SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
             SANITY_FUNCTION_SCHEDULED,
+            SANITY_FUNCTION_DURABLE,
         ],
     });
     const parsedBlueprint = parserResult.result === 'valid' ? parserResult.blueprint : undefined;

package/dist/actions/blueprints/pre-deploy.d.ts

@@ -1,6 +1,7 @@
 import type { BlueprintResource } from '@sanity/blueprints';
 import type { Logger } from '../../utils/logger.js';
 import { type AuthParams, type InstallerType, type ScopeType } from '../../utils/types.js';
+import { type ProcessAssetsProgress, type ProcessedAsset } from './process-assets.js';
 type PreDeployResult = {
     success: false;
     error: string;
@@ -10,11 +11,14 @@ type PreDeployResult = {
 } | {
     success: true;
 };
-type PreDeployResourceOptions = {
-    auth: AuthParams;
-    blueprintFileDir: string;
-    installer: InstallerType;
-    log: Logger;
+export type PreDeployAssetEvent = {
+    type: 'progress';
+    progress: ProcessAssetsProgress;
+} | {
+    type: 'complete';
+} | {
+    type: 'result';
+    result: ProcessedAsset;
 };
 type PreDeployOptions = {
     scopeType: ScopeType;
@@ -24,6 +28,11 @@ type PreDeployOptions = {
     stackName: string;
     bin: string;
     verbose: boolean | undefined;
-} & PreDeployResourceOptions;
+    auth: AuthParams;
+    blueprintFileDir: string;
+    installer: InstallerType;
+    logger: Logger;
+    onAssetEvent?: (event: PreDeployAssetEvent) => void;
+};
 export declare function preDeploy(options: PreDeployOptions): Promise<PreDeployResult>;
 export {};

package/dist/actions/blueprints/pre-deploy.js

@@ -1,18 +1,13 @@
 import { env } from 'node:process';
 import { resolveDeployedResources } from '../../utils/blueprints/resolve-deployed-resources.js';
-import { niceId } from '../../utils/display/presenters.js';
 import { CODE_OPERATION_UNCONFIRMED, EXIT_OPERATION_UNCONFIRMED } from '../../utils/exit-codes.js';
 import { styleText } from '../../utils/style-text.js';
 import { isAssetResource, } from '../../utils/types.js';
-import { stashAsset } from './assets.js';
+import { processAssets } from './process-assets.js';
 import { updateStack } from './stacks.js';
 import { waitForOperation } from './wait-for-operation.js';
-const DEFAULT_ASSET_TIMEOUT = 180;
-const assetTimeoutS = Number(process.env.SANITY_ASSET_TIMEOUT) || DEFAULT_ASSET_TIMEOUT;
-const assetTimeoutMs = assetTimeoutS * 1000;
-const warnTimeoutMs = assetTimeoutMs / 3;
 export async function preDeploy(options) {
-    const { resources, stackId, auth, blueprintFileDir, installer, log } = options;
+    const { resources, stackId, auth, blueprintFileDir, installer, logger } = options;
     const hasAssetResources = resources.some(isAssetResource);
     if (hasAssetResources) {
         let assetResources;
@@ -26,34 +21,45 @@ export async function preDeploy(options) {
                 resources,
                 stackId,
                 auth,
-                logger: log,
+                logger,
             });
             assetResources = resolvedResources.filter(isAssetResource);
         }
         else {
             assetResources = resources.filter(isAssetResource);
         }
-        log('Processing assets...');
-        for (const resource of assetResources) {
-            const preDeployResult = await preDeployResource(resource, {
+        let processedAssets;
+        try {
+            processedAssets = await processAssets({
+                assetResources,
                 auth,
                 blueprintFileDir,
                 installer,
-                log,
+                logger,
+                onProgress: (progress) => options.onAssetEvent?.({ type: 'progress', progress }),
+                onResult: (result) => options.onAssetEvent?.({ type: 'result', result }),
             });
-            if (!preDeployResult.success)
-                return preDeployResult;
-            const idx = resources.findIndex((r) => r.name === resource.name);
+        }
+        finally {
+            options.onAssetEvent?.({ type: 'complete' });
+        }
+        const failure = processedAssets.find((result) => !result.success);
+        if (failure)
+            return { success: false, error: failure.error };
+        // update resources with processed assets
+        for (const asset of processedAssets) {
+            const idx = resources.findIndex((r) => r.name === asset.resource.name);
+            // ! I think this error message is wrong. we somehow have an extra asset
             if (idx === -1)
                 throw new Error('Unable to update resource asset');
-            resources[idx] = preDeployResult.resource;
+            resources[idx] = asset.resource;
         }
     }
     return { success: true };
 }
 async function preDeployStack(options) {
-    const { scopeType, scopeId, stackId, stackName, resources, auth, log, bin, verbose } = options;
-    const spinner = log.ora('Starting pre-deploy...').start();
+    const { scopeType, scopeId, stackId, stackName, resources, auth, logger, bin, verbose } = options;
+    const spinner = logger.ora('Starting pre-deploy...').start();
     const stackMutation = {
         scopeType,
         scopeId,
@@ -61,7 +67,7 @@ async function preDeployStack(options) {
         preDeploy: true,
         document: { resources },
     };
-    const { ok: deployOk, stack, error: deployError, } = await updateStack({ stackId, stackMutation, auth, logger: log });
+    const { ok: deployOk, stack, error: deployError, } = await updateStack({ stackId, stackMutation, auth, logger });
     if (!deployOk) {
         spinner.fail(`${styleText('red', 'Failed')} to complete Stack pre-deployment`);
         return {
@@ -74,19 +80,19 @@ async function preDeployStack(options) {
         };
     }
     spinner.stop().clear();
-    log(styleText('dim', 'Stack deployment progress:'));
-    log('');
+    logger(styleText('dim', 'Stack deployment progress:'));
+    logger('');
     const outcome = await waitForOperation({
         stackId,
         operationId: stack.operationId,
         auth,
-        log,
+        log: logger,
         bin,
         verbose,
         progressNoun: 'pre-deployment',
     });
     if (outcome.type === 'completed') {
-        log(styleText(['bold', 'green'], 'Stack pre-deployment completed!'));
+        logger(styleText(['bold', 'green'], 'Stack pre-deployment completed!'));
     }
     else if (outcome.type === 'unconfirmed') {
         return {
@@ -115,50 +121,3 @@ async function preDeployStack(options) {
     }
     return { success: true };
 }
-async function preDeployResource(resource, options) {
-    const { auth, blueprintFileDir, installer, log } = options;
-    const fnSpinner = log.ora({ text: `Processing ${resource.name}...`, prefixText: ' ' }).start();
-    const warnTimer = setTimeout(() => {
-        fnSpinner.text = `Still processing ${resource.name}, this can take a moment...`;
-    }, warnTimeoutMs);
-    let assetTimeoutTimer;
-    let result;
-    try {
-        result = await Promise.race([
-            stashAsset({ resource, blueprintFileDir, auth, logger: log, installer }),
-            new Promise((_, reject) => {
-                assetTimeoutTimer = setTimeout(() => {
-                    reject(new Error(`Processing ${resource.name} timed out after ${assetTimeoutS}s`));
-                }, assetTimeoutMs);
-            }),
-        ]);
-    }
-    catch (err) {
-        const msg = err instanceof Error ? err.message : String(err);
-        fnSpinner.fail(msg);
-        return { success: false, error: msg };
-    }
-    finally {
-        clearTimeout(warnTimer);
-        clearTimeout(assetTimeoutTimer);
-    }
-    if (result.success && result.assetId) {
-        const updatedResource = { ...resource, src: result.assetId };
-        fnSpinner.succeed(`${updatedResource.name} ${niceId(result.assetId)}`);
-        log(`   Source: ${updatedResource.src}`);
-        if (result.hash) {
-            if (result.hash.length > 24) {
-                log.verbose(`   Hash: ${result.hash.slice(0, 8)}...${result.hash.slice(-12)}`);
-            }
-            else {
-                log.verbose(`   Hash: ${result.hash}`);
-            }
-        }
-        if (result.exists)
-            log.verbose('   Asset unchanged');
-        return { success: true, resource: updatedResource };
-    }
-    const errorMsg = `Failed uploading ${resource.name} asset, deploy has stopped`;
-    fnSpinner.fail(errorMsg);
-    return { success: false, error: result.error || 'Failed to process asset' };
-}

package/dist/actions/blueprints/process-assets.d.ts

@@ -0,0 +1,29 @@
+import type { Logger } from '../../utils/logger.js';
+import type { AssetResource, AuthParams, InstallerType } from '../../utils/types.js';
+type ProcessAssetsOptions = {
+    assetResources: AssetResource[];
+    auth: AuthParams;
+    blueprintFileDir: string;
+    installer: InstallerType;
+    logger: Logger;
+    onProgress?: (progress: ProcessAssetsProgress) => void;
+    onResult?: (result: ProcessedAsset) => void;
+};
+export type ProcessAssetsProgress = {
+    completed: number;
+    total: number;
+    slow: boolean;
+};
+export type ProcessedAsset = {
+    success: false;
+    resource: AssetResource;
+    error: string;
+    failureKind: 'processing' | 'upload';
+} | {
+    success: true;
+    resource: AssetResource;
+    hash?: string;
+    exists?: boolean;
+};
+export declare function processAssets(options: ProcessAssetsOptions): Promise<ProcessedAsset[]>;
+export {};