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

package/dist/utils/functions/child-runtime/invoke.js

@@ -0,0 +1,47 @@
+import process from 'node:process'
+
+export function createInvoker() {
+  /**
+   * Pending nested `context.invoke` calls, keyed by correlation id. Each entry
+   * holds the resolve/reject of the Promise returned to the user's handler; it is
+   * settled when the matching `invoke-response` arrives from the parent.
+   * @type {Map<string, {resolve: (value: unknown) => void, reject: (reason: Error) => void}>}
+   */
+  const pending = new Map()
+  let invokeSeq = 0
+
+  /**
+   * `context.invoke(name, payload)` — ask the parent to execute another blueprint
+   * function and resolve with its return value. Sent over IPC and correlated by id.
+   * @param {string} name
+   * @param {Record<string, unknown>} [payload]
+   * @returns {Promise<unknown>}
+   */
+  function invoke(name, payload = {}) {
+    if (typeof name !== 'string' || name.length === 0) {
+      return Promise.reject(new Error('context.invoke requires a function name'))
+    }
+    const id = String(++invokeSeq)
+    return new Promise((resolve, reject) => {
+      pending.set(id, {resolve, reject})
+      process.send(JSON.stringify({type: 'invoke-request', id, name, payload}))
+    })
+  }
+
+  function handleResponse(msg) {
+    const pendingEntry = pending.get(msg.id)
+    if (!pendingEntry) return
+    pending.delete(msg.id)
+    if (msg.ok) {
+      pendingEntry.resolve(msg.result?.json)
+    } else {
+      const {message, stack, name} = msg.error ?? {}
+      const err = new Error(message ?? 'Nested invoke failed')
+      if (stack) err.stack = stack
+      if (name) err.name = name
+      pendingEntry.reject(err)
+    }
+  }
+
+  return {invoke, handleResponse}
+}

package/dist/utils/functions/child-runtime/resources.d.ts

@@ -0,0 +1,4 @@
+import type {ResourcesApi} from '@sanity/functions'
+import type {GroupedBlueprintResources} from '../../blueprints/group-resources.js'
+
+export function createResourcesApi(resources: GroupedBlueprintResources): ResourcesApi

package/dist/utils/functions/child-runtime/resources.js

@@ -0,0 +1,59 @@
+/**
+ * The returned proxy wraps a function so the API itself is callable.
+ * @param {Record<string, ResourceEntry[]>} resources
+ * @returns {ResourcesApi}
+ */
+export function createResourcesApi(resources) {
+  const findByName = (name) => {
+    for (const group of Object.values(resources)) {
+      const found = group.find((r) => r.name === name)
+      if (found) return found
+    }
+    return undefined
+  }
+  let allCache
+  const all = () => (allCache ??= Object.values(resources).flat())
+
+  return /** @type {ResourcesApi} */ (
+    /** @type {unknown} */ (
+      /*
+       * The Proxy target is `findByName`, so invoking the API as a function —
+       * `context.resources('my-proj')` — bypasses the `get` trap entirely and
+       * calls `findByName` directly for a cross-type lookup by name.
+       */
+      new Proxy(findByName, {
+        get: (_target, prop) => {
+          // context.resources.all() — flat array of every resource across types
+          if (prop === 'all') return all
+          // [...context.resources] / for (const r of context.resources) — iterate all
+          if (prop === Symbol.iterator) {
+            return function* () {
+              yield* all()
+            }
+          }
+
+          /**
+           * Symbol property access (other than iterator above) and `then`
+           * lookups return undefined. The `then` guard prevents the API from
+           * looking like a thenable, so `await context.resources` resolves to
+           * the proxy itself rather than hanging or unwrapping unexpectedly.
+           */
+          if (typeof prop !== 'string' || prop === 'then') {
+            return undefined
+          }
+
+          /**
+           * context.resources.<type>(name) — per-type lookup,
+           * e.g. context.resources.project('my-proj').
+           * Returns a function so the caller supplies the name;
+           * unknown types yield a function that always returns undefined.
+           */
+          return (/** @type {string} */ name) =>
+            Object.hasOwn(resources, prop)
+              ? resources[prop].find((r) => r.name === name)
+              : undefined
+        },
+      })
+    )
+  )
+}

package/dist/utils/studios/prepare-asset.d.ts

@@ -0,0 +1,6 @@
+import type { BlueprintStudioResource } from '@sanity/blueprints';
+import type { AssetPrepResult } from '../types.js';
+export declare function prepareStudioAsset({ blueprintFileDir, resource, }: {
+    blueprintFileDir: string;
+    resource: BlueprintStudioResource;
+}): Promise<AssetPrepResult>;

package/dist/utils/studios/prepare-asset.js

@@ -0,0 +1,139 @@
+import { createWriteStream } from 'node:fs';
+import { mkdtemp, rm, stat } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import path, { basename, dirname, join } from 'node:path';
+import { pipeline } from 'node:stream/promises';
+import { createGzip } from 'node:zlib';
+import { buildStudio, compareDependencyVersions } from '@sanity/cli-build/_internal/build';
+import { pack } from 'tar-fs';
+export async function prepareStudioAsset({ blueprintFileDir, resource, }) {
+    // validate resource has an externalId
+    if (!('externalId' in resource) ||
+        typeof resource.externalId !== 'string' ||
+        !resource.externalId) {
+        return {
+            success: false,
+            async cleanup() {
+                // no op
+            },
+            error: `Unable to determine appId for sanity.studio resource '${resource.name}'`,
+        };
+    }
+    let cleanup = async () => {
+        // no op
+    };
+    const studioPath = path.resolve(blueprintFileDir, resource.src);
+    try {
+        const studioPathStat = await stat(studioPath);
+        if (!studioPathStat.isDirectory()) {
+            return {
+                success: false,
+                cleanup,
+                error: `Property 'src' on resource with type '${resource.type}' must be a directory`,
+            };
+        }
+    }
+    catch (error) {
+        const msg = error instanceof Error ? error.message : String(error);
+        return {
+            success: false,
+            cleanup,
+            error: `Unable to read given 'src' on resource with type '${resource.type}': ${msg}`,
+        };
+    }
+    try {
+        const outDir = await mkdtemp(join(tmpdir(), `studio-build-`));
+        const outFile = `${outDir}.tar.gz`;
+        cleanup = async () => {
+            await rm(outDir, { force: true, recursive: true });
+            await rm(outFile, { force: true });
+        };
+        const appId = resource.externalId;
+        try {
+            await buildStudio({
+                appId,
+                autoUpdatesEnabled: resource.autoUpdates.enabled,
+                checkAppId() { },
+                async compareDependencyVersions(packages) {
+                    return compareDependencyVersions(packages, studioPath, { appId });
+                },
+                determineBasePath() {
+                    return resource.basePath ?? '/';
+                },
+                isApp: false,
+                isWorkbenchApp: false,
+                minify: resource.minify ?? true,
+                outDir,
+                output: createSilentOutput(),
+                reactCompiler: resource.reactCompiler || false,
+                schemaExtraction: undefined,
+                sourceMap: resource.sourceMap ?? false,
+                stats: false,
+                unattendedMode: true,
+                // TODO pass in vite config from the studio resource
+                vite: undefined,
+                workDir: studioPath,
+                eventListener: {
+                    onBuildFail({ message }) {
+                        throw new Error(message);
+                    },
+                    onInvalidStyledComponentsVersionRange({ message }) {
+                        throw new Error(message);
+                    },
+                    onNoDeclaredStyledComponentsVersion({ message }) {
+                        throw new Error(message);
+                    },
+                    onNoInstalledSanityVersion({ message }) {
+                        throw new Error(message);
+                    },
+                    onNoInstalledStyledComponentsVersion({ message }) {
+                        throw new Error(message);
+                    },
+                    onPreReleaseInNonInteractiveAutoUpdate({ message }) {
+                        throw new Error(message);
+                    },
+                },
+            });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            return {
+                success: false,
+                cleanup,
+                error: message,
+            };
+        }
+        // tar/gzip/write the built output
+        await pipeline(pack(dirname(outDir), { entries: [basename(outDir)] }), createGzip(), createWriteStream(outFile));
+        return {
+            success: true,
+            cleanup,
+            // studio must be pre built (e.g. with `npm run build`) and tarred/gzipped
+            outputPath: outFile,
+        };
+    }
+    catch (error) {
+        return {
+            success: false,
+            cleanup,
+            error: error instanceof Error ? error.message : String(error),
+        };
+    }
+}
+function createSilentOutput() {
+    return {
+        error(input, options) {
+            if (typeof options?.exit === 'number') {
+                if (input instanceof Error) {
+                    throw input;
+                }
+                throw new Error(input);
+            }
+            return undefined;
+        },
+        log() { },
+        warn(input) {
+            return input;
+        },
+    };
+}

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,102 @@
 {
   "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"
+        },
+        "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": {
@@ -2655,7 +2752,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": {
@@ -2700,7 +2798,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 +2868,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": {
@@ -2816,7 +2914,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 +2989,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": {
@@ -2937,7 +3035,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 +3095,5 @@
       ]
     }
   },
-  "version": "17.1.0-next.gcfbd613"
+  "version": "17.2.0-blueprinit.gd1553d6"
 }

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.gd1553d6",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -40,7 +40,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 +66,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 +82,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 +102,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",