@sanity/runtime-cli 17.13.1-next.g2772647 → 17.13.1-next.g4fa31d1

package/dist/utils/{applications → bundles}/prepare-asset.js

@@ -7,15 +7,16 @@ import { createGzip } from 'node:zlib';
 import { buildApp, buildStudio, compareDependencyVersions, } from '@sanity/cli-build/_internal/build';
 import { getLocalPackageVersion } from '@sanity/cli-core';
 import { pack } from 'tar-fs';
-export const APP_BUILD_SPECS = {
-    'sanity.studio': { build: buildStudioBundle },
-    'sanity.application': { build: buildApplicationBundle },
+export const BUNDLE_SPECS = {
+    'sanity.studio': { requiresAppId: true, build: buildStudioBundle },
+    'sanity.application': { requiresAppId: true, build: buildApplicationBundle },
+    'sanity.installation.config': { requiresAppId: false, build: buildInstallationConfigBundle },
 };
-export async function prepareApplicationAsset({ blueprintFileDir, resource, }) {
+export async function prepareBundleAsset({ blueprintFileDir, resource, }) {
     // The lookup can't prove it yields the spec matching this R, so it's asserted once here.
-    const spec = APP_BUILD_SPECS[resource.type];
+    const spec = BUNDLE_SPECS[resource.type];
     const appId = getAppId(resource);
-    if (!appId) {
+    if (spec.requiresAppId && !appId) {
         return {
             success: false,
             async cleanup() { },
@@ -25,6 +26,15 @@ export async function prepareApplicationAsset({ blueprintFileDir, resource, }) {
     let cleanup = async () => { };
     const assetPath = String(resource.root);
     const workDir = path.resolve(blueprintFileDir, assetPath);
+    // Defence in depth alongside blueprints-node's own check: an absolute path or one
+    // that climbs above the blueprint dir would bundle files outside the project.
+    if (path.isAbsolute(assetPath) || path.relative(blueprintFileDir, workDir).startsWith('..')) {
+        return {
+            success: false,
+            cleanup,
+            error: `Property 'root' on resource with type '${resource.type}' must be under the blueprint directory`,
+        };
+    }
     try {
         const workDirStat = await stat(workDir);
         if (!workDirStat.isDirectory()) {
@@ -44,7 +54,7 @@ export async function prepareApplicationAsset({ blueprintFileDir, resource, }) {
         };
     }
     try {
-        const outDir = await mkdtemp(join(tmpdir(), `app-build-`));
+        const outDir = await mkdtemp(join(tmpdir(), `bundle-`));
         const outFile = `${outDir}.tar.gz`;
         cleanup = async () => {
             await rm(outDir, { force: true, recursive: true });
@@ -132,24 +142,45 @@ async function buildApplicationBundle({ resource, appId, workDir, outDir, output
     if (extraWindow) {
         throw new Error(`Application resource '${resource.name}' declares more than one window view; at most one is allowed`);
     }
-    let mismatchedPackages;
     await buildApp({
+        ...sharedBuildAppOptions({ appId, workDir, outDir, output, eventListener }),
         appId,
         appTitle: resource.title,
+        entry: window?.src,
+        workbenchAppId: appId,
+        exposes: {
+            views: views.map(toWorkbenchView),
+            webWorkers: resource.webWorkers,
+        },
+    });
+    // a workbench app never auto-updates, so no dependency mismatches are compared
+    return {};
+}
+async function buildInstallationConfigBundle({ resource, workDir, outDir, output, eventListener, }) {
+    await buildApp({
+        ...sharedBuildAppOptions({ appId: undefined, workDir, outDir, output, eventListener }),
+        appId: undefined,
+        appTitle: undefined,
+        entry: undefined,
+        workbenchAppId: undefined,
+        exposes: { config: { appType: resource.appType, fields: resource.fields } },
+    });
+    return {};
+}
+// Options a workbench build (application or installation config) always sets the
+// same way; each caller adds only what differs (identity, entry, exposes).
+function sharedBuildAppOptions({ appId, workDir, outDir, output, eventListener, }) {
+    return {
         autoUpdatesEnabled: false,
         checkAppId() { },
         async compareDependencyVersions(packages) {
-            const result = await compareDependencyVersions(packages, workDir, { appId });
-            mismatchedPackages = result.mismatched.map((m) => m.pkg);
-            return result;
+            return compareDependencyVersions(packages, workDir, { appId });
         },
         determineBasePath() {
             return '/';
         },
-        entry: window?.src,
         isWorkbenchApp: true,
         isBlueprints: true,
-        workbenchAppId: appId,
         minify: true,
         outDir,
         output,
@@ -161,12 +192,7 @@ async function buildApplicationBundle({ resource, appId, workDir, outDir, output
         vite: undefined,
         workDir,
         eventListener,
-        exposes: {
-            views: views.map(toWorkbenchView),
-            webWorkers: resource.webWorkers,
-        },
-    });
-    return { mismatchedPackages };
+    };
 }
 // blueprints-node emits `type` (window views as `app`); workbench-cli discriminates on `surface`.
 function toWorkbenchView(view) {

package/dist/utils/{applications → bundles}/types.d.ts

@@ -43,4 +43,19 @@ export interface BlueprintApplicationResource extends BlueprintResource<Blueprin
     views?: ApplicationView[];
     webWorkers?: WebWorker[];
 }
+type InstallationConfigField = {
+    name: string;
+    title: string;
+    src: string;
+    public?: boolean;
+};
+export interface BlueprintInstallationConfigResource extends BlueprintResource {
+    type: 'sanity.installation.config';
+    appType: 'media-library';
+    /** Build directory, relative to the blueprint file; contains package.json. Field `src` resolves against it. */
+    root: string;
+    fields: InstallationConfigField[];
+    /** Stamped by the CLI before pre-deploy; the authored shape from blueprints-node has none. */
+    version?: string;
+}
 export {};

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

@@ -1,6 +1,6 @@
 import { formatDateTime, formatElapsed } from '@sanity/cli-core/dates';
 import { treeify } from 'array-treeify';
-import { SANITY_ACCESS_ROBOT, SANITY_ACCESS_ROLE, SANITY_APPLICATION, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_DURABLE, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_PUBSUB, SANITY_FUNCTION_SCHEDULED, SANITY_FUNCTION_SYNC_TAG_INVALIDATE, SANITY_PROJECT, SANITY_PROJECT_CORS, SANITY_PROJECT_DATASET, SANITY_PROJECT_WEBHOOK, SANITY_STUDIO, } from '../../constants.js';
+import { SANITY_ACCESS_ROBOT, SANITY_ACCESS_ROLE, SANITY_APPLICATION, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_DURABLE, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_PUBSUB, SANITY_FUNCTION_SCHEDULED, SANITY_FUNCTION_SYNC_TAG_INVALIDATE, SANITY_INSTALLATION_CONFIG, SANITY_PROJECT, SANITY_PROJECT_CORS, SANITY_PROJECT_DATASET, SANITY_PROJECT_WEBHOOK, SANITY_STUDIO, } from '../../constants.js';
 import { styleText } from '../style-text.js';
 import { isCorsOriginResource, isDatasetResource, isRobotResource, isRoleResource, isStudioResource, isWebhookResource, } from '../types.js';
 import { capitalize, niceId, renderSection } from './presenters.js';
@@ -69,6 +69,10 @@ const RESOURCE_CATEGORIES = {
         label: 'Applications',
         displayNameAttribute: 'title',
     },
+    [SANITY_INSTALLATION_CONFIG]: {
+        label: 'Installation configs',
+        displayNameAttribute: 'name',
+    },
 };
 const categoryByLabel = Object.values(RESOURCE_CATEGORIES).reduce((acc, curr) => {
     acc[curr.label] = curr;

package/dist/utils/request-id.d.ts

@@ -0,0 +1,4 @@
+export declare const REQUEST_ID_HEADER = "x-request-id";
+/** Stack PUT/POST/DELETE success bodies also carry `requestId`; error bodies do not. */
+export declare function getRequestId(response?: Response, body?: unknown): string | undefined;
+export declare function withRequestId(message: string, requestId?: string): string;

package/dist/utils/request-id.js

@@ -0,0 +1,19 @@
+export const REQUEST_ID_HEADER = 'x-request-id';
+/** Stack PUT/POST/DELETE success bodies also carry `requestId`; error bodies do not. */
+export function getRequestId(response, body) {
+    const fromHeader = response?.headers.get(REQUEST_ID_HEADER);
+    if (fromHeader)
+        return fromHeader;
+    if (body && typeof body === 'object' && 'requestId' in body) {
+        const fromBody = body.requestId;
+        if (typeof fromBody === 'string' && fromBody)
+            return fromBody;
+    }
+    return undefined;
+}
+export function withRequestId(message, requestId) {
+    if (!requestId)
+        return message;
+    const suffix = `(request ID ${requestId})`;
+    return message.endsWith('.') ? `${message.slice(0, -1)} ${suffix}.` : `${message} ${suffix}`;
+}