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

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 {
@@ -126,6 +123,8 @@ export interface InvokeGroqContextOptions {
     functionResourceId: string;
     /** All resources declared by the blueprint, used to populate `context.resources` at invoke time. */
     resources?: BlueprintResource[];
+    /** The directory where the blueprint manifest is located. */
+    blueprintFileDir: string;
 }
 /** @internal */
 export interface InvokeScheduleContextOptions {
@@ -134,6 +133,8 @@ export interface InvokeScheduleContextOptions {
     };
     /** All resources declared by the blueprint, used to populate `context.resources` at invoke time. */
     resources?: BlueprintResource[];
+    /** The directory where the blueprint manifest is located. */
+    blueprintFileDir: string;
 }
 export type InvokeContextOptions = InvokeGroqContextOptions | InvokeScheduleContextOptions;
 export declare function isGroqContextOptions(context: InvokeContextOptions): context is InvokeGroqContextOptions;
@@ -265,7 +266,7 @@ export declare interface FetchConfig {
     apiHost?: string;
     apiVersion?: string;
 }
-export declare const INSTALLER_OPTIONS: readonly ["npm", "pnpm", "yarn"];
+export declare const INSTALLER_OPTIONS: readonly ['npm', 'pnpm', 'yarn'];
 export type InstallerType = 'npm' | 'pnpm' | 'yarn';
 export type AssetPrepResult = {
     success: true;

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);