@sanity/cli 5.9.0-next.8 → 6.0.0-alpha.11

package/dist/actions/build/buildStudio.js

@@ -0,0 +1,202 @@
+import { rm } from 'node:fs/promises';
+import path from 'node:path';
+import { styleText } from 'node:util';
+import { getCliTelemetry, getTimer } from '@sanity/cli-core';
+import { confirm, logSymbols, select, spinner } from '@sanity/cli-core/ux';
+import semver from 'semver';
+import { StudioBuildTrace } from '../../telemetry/build.telemetry.js';
+import { getAppId } from '../../util/appId.js';
+import { compareDependencyVersions } from '../../util/compareDependencyVersions.js';
+import { formatModuleSizes, sortModulesBySize } from '../../util/moduleFormatUtils.js';
+import { getPackageManagerChoice } from '../../util/packageManager/packageManagerChoice.js';
+import { upgradePackages } from '../../util/packageManager/upgradePackages.js';
+import { warnAboutMissingAppId } from '../../util/warnAboutMissingAppId.js';
+import { buildDebug } from './buildDebug.js';
+import { buildStaticFiles } from './buildStaticFiles.js';
+import { buildVendorDependencies } from './buildVendorDependencies.js';
+import { checkRequiredDependencies } from './checkRequiredDependencies.js';
+import { checkStudioDependencyVersions } from './checkStudioDependencyVersions.js';
+import { determineBasePath } from './determineBasePath.js';
+import { getAutoUpdatesImportMap } from './getAutoUpdatesImportMap.js';
+import { getStudioEnvVars } from './getStudioEnvVars.js';
+import { shouldAutoUpdate } from './shouldAutoUpdate.js';
+/**
+ * Build the Sanity Studio.
+ *
+ * @internal
+ */ export async function buildStudio(options) {
+    const timer = getTimer();
+    const { cliConfig, exit, flags, outDir, output, workDir } = options;
+    const unattendedMode = Boolean(flags.yes);
+    const defaultOutputDir = path.resolve(path.join(workDir, 'dist'));
+    const outputDir = path.resolve(outDir || defaultOutputDir);
+    await checkStudioDependencyVersions(workDir, output);
+    // If the check resulted in a dependency install, the CLI command will be re-run,
+    // thus we want to exit early
+    const { installedSanityVersion } = await checkRequiredDependencies({
+        cliConfig,
+        output,
+        workDir
+    });
+    const autoUpdatesEnabled = shouldAutoUpdate({
+        cliConfig,
+        flags,
+        output
+    });
+    let autoUpdatesImports = {};
+    if (autoUpdatesEnabled) {
+        // Get the clean version without build metadata: https://semver.org/#spec-item-10
+        const cleanSanityVersion = semver.parse(installedSanityVersion)?.version;
+        if (!cleanSanityVersion) {
+            throw new Error(`Failed to parse installed Sanity version: ${installedSanityVersion}`);
+        }
+        output.log(`${logSymbols.info} Building with auto-updates enabled`);
+        const projectId = cliConfig?.api?.projectId;
+        const appId = getAppId(cliConfig);
+        // Warn if auto updates enabled but no appId configured
+        if (!appId) {
+            warnAboutMissingAppId({
+                appType: 'studio',
+                output,
+                projectId
+            });
+        }
+        const sanityDependencies = [
+            {
+                name: 'sanity',
+                version: cleanSanityVersion
+            },
+            {
+                name: '@sanity/vision',
+                version: cleanSanityVersion
+            }
+        ];
+        autoUpdatesImports = getAutoUpdatesImportMap(sanityDependencies, {
+            appId
+        });
+        // Check the versions
+        const result = await compareDependencyVersions(sanityDependencies, workDir);
+        // If it is in unattended mode, we don't want to prompt
+        if (result?.length && !unattendedMode) {
+            const choice = await select({
+                choices: [
+                    {
+                        name: `Upgrade and proceed with build`,
+                        value: 'upgrade-and-proceed'
+                    },
+                    {
+                        name: `Upgrade only. You will need to run the build command again`,
+                        value: 'upgrade'
+                    },
+                    {
+                        name: 'Cancel',
+                        value: 'cancel'
+                    }
+                ],
+                default: 'upgrade-and-proceed',
+                message: styleText('yellow', `The following local package versions are different from the versions currently served at runtime.\n` + `When using auto updates, we recommend that you test locally with the same versions before deploying. \n\n` + `${result.map((mod)=>` - ${mod.pkg} (local version: ${mod.installed}, runtime version: ${mod.remote})`).join('\n')} \n\n` + `Do you want to upgrade local versions before deploying?`)
+            });
+            if (choice === 'cancel') {
+                return exit(1);
+            }
+            if (choice === 'upgrade' || choice === 'upgrade-and-proceed') {
+                await upgradePackages({
+                    packageManager: (await getPackageManagerChoice(workDir, {
+                        interactive: false
+                    })).chosen,
+                    packages: result.map((res)=>[
+                            res.pkg,
+                            res.remote
+                        ])
+                }, {
+                    output,
+                    workDir
+                });
+                if (choice !== 'upgrade-and-proceed') {
+                    return exit(1);
+                }
+            }
+        }
+    }
+    const envVarKeys = getStudioEnvVars();
+    if (envVarKeys.length > 0) {
+        output.log('\nIncluding the following environment variables as part of the JavaScript bundle:');
+        for (const key of envVarKeys){
+            output.log(`- ${key}`);
+        }
+        output.log('');
+    }
+    let shouldClean = true;
+    if (outputDir !== defaultOutputDir && !unattendedMode) {
+        shouldClean = await confirm({
+            default: true,
+            message: `Do you want to delete the existing directory (${outputDir}) first?`
+        });
+    }
+    // Determine base path for built studio
+    const basePath = determineBasePath(cliConfig, 'studio');
+    let spin;
+    if (shouldClean) {
+        timer.start('cleanOutputFolder');
+        spin = spinner('Clean output folder').start();
+        await rm(outputDir, {
+            force: true,
+            recursive: true
+        });
+        const cleanDuration = timer.end('cleanOutputFolder');
+        spin.text = `Clean output folder (${cleanDuration.toFixed(0)}ms)`;
+        spin.succeed();
+    }
+    spin = spinner(`Build Sanity Studio`).start();
+    const trace = getCliTelemetry().trace(StudioBuildTrace);
+    trace.start();
+    let importMap;
+    if (autoUpdatesEnabled) {
+        importMap = {
+            imports: {
+                ...await buildVendorDependencies({
+                    basePath,
+                    cwd: workDir,
+                    outputDir
+                }),
+                ...autoUpdatesImports
+            }
+        };
+    }
+    try {
+        timer.start('bundleStudio');
+        const bundle = await buildStaticFiles({
+            basePath,
+            cwd: workDir,
+            importMap,
+            minify: Boolean(flags.minify),
+            outputDir,
+            reactCompiler: cliConfig && 'reactCompiler' in cliConfig ? cliConfig.reactCompiler : undefined,
+            sourceMap: Boolean(flags['source-maps']),
+            vite: cliConfig && 'vite' in cliConfig ? cliConfig.vite : undefined
+        });
+        trace.log({
+            outputSize: bundle.chunks.flatMap((chunk)=>chunk.modules.flatMap((mod)=>mod.renderedLength)).reduce((sum, n)=>sum + n, 0)
+        });
+        const buildDuration = timer.end('bundleStudio');
+        spin.text = `Build Sanity Studio (${buildDuration.toFixed(0)}ms)`;
+        spin.succeed();
+        trace.complete();
+        if (flags.stats) {
+            output.log('\nLargest module files:');
+            output.log(formatModuleSizes(sortModulesBySize(bundle.chunks).slice(0, 15)));
+        }
+    } catch (error) {
+        spin.fail();
+        trace.error(error);
+        const message = error instanceof Error ? error.message : String(error);
+        buildDebug(`Failed to build Sanity Studio`, {
+            error
+        });
+        output.error(`Failed to build Sanity Studio: ${message}`, {
+            exit: 1
+        });
+    }
+}
+
+//# sourceMappingURL=buildStudio.js.map

package/dist/actions/build/buildStudio.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/build/buildStudio.ts"],"sourcesContent":["import {rm} from 'node:fs/promises'\nimport path from 'node:path'\nimport {styleText} from 'node:util'\n\nimport {getCliTelemetry, getTimer} from '@sanity/cli-core'\nimport {confirm, logSymbols, select, spinner, type SpinnerInstance} from '@sanity/cli-core/ux'\nimport semver from 'semver'\n\nimport {StudioBuildTrace} from '../../telemetry/build.telemetry.js'\nimport {getAppId} from '../../util/appId.js'\nimport {compareDependencyVersions} from '../../util/compareDependencyVersions.js'\nimport {formatModuleSizes, sortModulesBySize} from '../../util/moduleFormatUtils.js'\nimport {getPackageManagerChoice} from '../../util/packageManager/packageManagerChoice.js'\nimport {upgradePackages} from '../../util/packageManager/upgradePackages.js'\nimport {warnAboutMissingAppId} from '../../util/warnAboutMissingAppId.js'\nimport {buildDebug} from './buildDebug.js'\nimport {buildStaticFiles} from './buildStaticFiles.js'\nimport {buildVendorDependencies} from './buildVendorDependencies.js'\nimport {checkRequiredDependencies} from './checkRequiredDependencies.js'\nimport {checkStudioDependencyVersions} from './checkStudioDependencyVersions.js'\nimport {determineBasePath} from './determineBasePath.js'\nimport {getAutoUpdatesImportMap} from './getAutoUpdatesImportMap.js'\nimport {getStudioEnvVars} from './getStudioEnvVars.js'\nimport {shouldAutoUpdate} from './shouldAutoUpdate.js'\nimport {type BuildOptions} from './types.js'\n\n/**\n * Build the Sanity Studio.\n *\n * @internal\n */\nexport async function buildStudio(options: BuildOptions): Promise<void> {\n  const timer = getTimer()\n  const {cliConfig, exit, flags, outDir, output, workDir} = options\n\n  const unattendedMode = Boolean(flags.yes)\n  const defaultOutputDir = path.resolve(path.join(workDir, 'dist'))\n  const outputDir = path.resolve(outDir || defaultOutputDir)\n\n  await checkStudioDependencyVersions(workDir, output)\n\n  // If the check resulted in a dependency install, the CLI command will be re-run,\n  // thus we want to exit early\n  const {installedSanityVersion} = await checkRequiredDependencies({\n    cliConfig,\n    output,\n    workDir,\n  })\n\n  const autoUpdatesEnabled = shouldAutoUpdate({cliConfig, flags, output})\n\n  let autoUpdatesImports = {}\n\n  if (autoUpdatesEnabled) {\n    // Get the clean version without build metadata: https://semver.org/#spec-item-10\n    const cleanSanityVersion = semver.parse(installedSanityVersion)?.version\n    if (!cleanSanityVersion) {\n      throw new Error(`Failed to parse installed Sanity version: ${installedSanityVersion}`)\n    }\n\n    output.log(`${logSymbols.info} Building with auto-updates enabled`)\n\n    const projectId = cliConfig?.api?.projectId\n    const appId = getAppId(cliConfig)\n\n    // Warn if auto updates enabled but no appId configured\n    if (!appId) {\n      warnAboutMissingAppId({appType: 'studio', output, projectId})\n    }\n\n    const sanityDependencies = [\n      {name: 'sanity', version: cleanSanityVersion},\n      {name: '@sanity/vision', version: cleanSanityVersion},\n    ]\n    autoUpdatesImports = getAutoUpdatesImportMap(sanityDependencies, {appId})\n\n    // Check the versions\n    const result = await compareDependencyVersions(sanityDependencies, workDir)\n\n    // If it is in unattended mode, we don't want to prompt\n    if (result?.length && !unattendedMode) {\n      const choice = await select({\n        choices: [\n          {\n            name: `Upgrade and proceed with build`,\n            value: 'upgrade-and-proceed',\n          },\n          {\n            name: `Upgrade only. You will need to run the build command again`,\n            value: 'upgrade',\n          },\n          {name: 'Cancel', value: 'cancel'},\n        ],\n        default: 'upgrade-and-proceed',\n        message: styleText(\n          'yellow',\n          `The following local package versions are different from the versions currently served at runtime.\\n` +\n            `When using auto updates, we recommend that you test locally with the same versions before deploying. \\n\\n` +\n            `${result.map((mod) => ` - ${mod.pkg} (local version: ${mod.installed}, runtime version: ${mod.remote})`).join('\\n')} \\n\\n` +\n            `Do you want to upgrade local versions before deploying?`,\n        ),\n      })\n\n      if (choice === 'cancel') {\n        return exit(1)\n      }\n\n      if (choice === 'upgrade' || choice === 'upgrade-and-proceed') {\n        await upgradePackages(\n          {\n            packageManager: (await getPackageManagerChoice(workDir, {interactive: false})).chosen,\n            packages: result.map((res) => [res.pkg, res.remote]),\n          },\n          {output, workDir},\n        )\n\n        if (choice !== 'upgrade-and-proceed') {\n          return exit(1)\n        }\n      }\n    }\n  }\n\n  const envVarKeys = getStudioEnvVars()\n  if (envVarKeys.length > 0) {\n    output.log('\\nIncluding the following environment variables as part of the JavaScript bundle:')\n    for (const key of envVarKeys) {\n      output.log(`- ${key}`)\n    }\n    output.log('')\n  }\n\n  let shouldClean = true\n  if (outputDir !== defaultOutputDir && !unattendedMode) {\n    shouldClean = await confirm({\n      default: true,\n      message: `Do you want to delete the existing directory (${outputDir}) first?`,\n    })\n  }\n\n  // Determine base path for built studio\n  const basePath = determineBasePath(cliConfig, 'studio')\n\n  let spin: SpinnerInstance\n  if (shouldClean) {\n    timer.start('cleanOutputFolder')\n    spin = spinner('Clean output folder').start()\n    await rm(outputDir, {force: true, recursive: true})\n    const cleanDuration = timer.end('cleanOutputFolder')\n    spin.text = `Clean output folder (${cleanDuration.toFixed(0)}ms)`\n    spin.succeed()\n  }\n\n  spin = spinner(`Build Sanity Studio`).start()\n\n  const trace = getCliTelemetry().trace(StudioBuildTrace)\n  trace.start()\n\n  let importMap\n\n  if (autoUpdatesEnabled) {\n    importMap = {\n      imports: {\n        ...(await buildVendorDependencies({basePath, cwd: workDir, outputDir})),\n        ...autoUpdatesImports,\n      },\n    }\n  }\n\n  try {\n    timer.start('bundleStudio')\n\n    const bundle = await buildStaticFiles({\n      basePath,\n      cwd: workDir,\n      importMap,\n      minify: Boolean(flags.minify),\n      outputDir,\n      reactCompiler:\n        cliConfig && 'reactCompiler' in cliConfig ? cliConfig.reactCompiler : undefined,\n      sourceMap: Boolean(flags['source-maps']),\n      vite: cliConfig && 'vite' in cliConfig ? cliConfig.vite : undefined,\n    })\n\n    trace.log({\n      outputSize: bundle.chunks\n        .flatMap((chunk) => chunk.modules.flatMap((mod) => mod.renderedLength))\n        .reduce((sum, n) => sum + n, 0),\n    })\n    const buildDuration = timer.end('bundleStudio')\n\n    spin.text = `Build Sanity Studio (${buildDuration.toFixed(0)}ms)`\n    spin.succeed()\n\n    trace.complete()\n    if (flags.stats) {\n      output.log('\\nLargest module files:')\n      output.log(formatModuleSizes(sortModulesBySize(bundle.chunks).slice(0, 15)))\n    }\n  } catch (error) {\n    spin.fail()\n    trace.error(error)\n    const message = error instanceof Error ? error.message : String(error)\n    buildDebug(`Failed to build Sanity Studio`, {error})\n    output.error(`Failed to build Sanity Studio: ${message}`, {exit: 1})\n  }\n}\n"],"names":["rm","path","styleText","getCliTelemetry","getTimer","confirm","logSymbols","select","spinner","semver","StudioBuildTrace","getAppId","compareDependencyVersions","formatModuleSizes","sortModulesBySize","getPackageManagerChoice","upgradePackages","warnAboutMissingAppId","buildDebug","buildStaticFiles","buildVendorDependencies","checkRequiredDependencies","checkStudioDependencyVersions","determineBasePath","getAutoUpdatesImportMap","getStudioEnvVars","shouldAutoUpdate","buildStudio","options","timer","cliConfig","exit","flags","outDir","output","workDir","unattendedMode","Boolean","yes","defaultOutputDir","resolve","join","outputDir","installedSanityVersion","autoUpdatesEnabled","autoUpdatesImports","cleanSanityVersion","parse","version","Error","log","info","projectId","api","appId","appType","sanityDependencies","name","result","length","choice","choices","value","default","message","map","mod","pkg","installed","remote","packageManager","interactive","chosen","packages","res","envVarKeys","key","shouldClean","basePath","spin","start","force","recursive","cleanDuration","end","text","toFixed","succeed","trace","importMap","imports","cwd","bundle","minify","reactCompiler","undefined","sourceMap","vite","outputSize","chunks","flatMap","chunk","modules","renderedLength","reduce","sum","n","buildDuration","complete","stats","slice","error","fail","String"],"mappings":"AAAA,SAAQA,EAAE,QAAO,mBAAkB;AACnC,OAAOC,UAAU,YAAW;AAC5B,SAAQC,SAAS,QAAO,YAAW;AAEnC,SAAQC,eAAe,EAAEC,QAAQ,QAAO,mBAAkB;AAC1D,SAAQC,OAAO,EAAEC,UAAU,EAAEC,MAAM,EAAEC,OAAO,QAA6B,sBAAqB;AAC9F,OAAOC,YAAY,SAAQ;AAE3B,SAAQC,gBAAgB,QAAO,qCAAoC;AACnE,SAAQC,QAAQ,QAAO,sBAAqB;AAC5C,SAAQC,yBAAyB,QAAO,0CAAyC;AACjF,SAAQC,iBAAiB,EAAEC,iBAAiB,QAAO,kCAAiC;AACpF,SAAQC,uBAAuB,QAAO,oDAAmD;AACzF,SAAQC,eAAe,QAAO,+CAA8C;AAC5E,SAAQC,qBAAqB,QAAO,sCAAqC;AACzE,SAAQC,UAAU,QAAO,kBAAiB;AAC1C,SAAQC,gBAAgB,QAAO,wBAAuB;AACtD,SAAQC,uBAAuB,QAAO,+BAA8B;AACpE,SAAQC,yBAAyB,QAAO,iCAAgC;AACxE,SAAQC,6BAA6B,QAAO,qCAAoC;AAChF,SAAQC,iBAAiB,QAAO,yBAAwB;AACxD,SAAQC,uBAAuB,QAAO,+BAA8B;AACpE,SAAQC,gBAAgB,QAAO,wBAAuB;AACtD,SAAQC,gBAAgB,QAAO,wBAAuB;AAGtD;;;;CAIC,GACD,OAAO,eAAeC,YAAYC,OAAqB;IACrD,MAAMC,QAAQzB;IACd,MAAM,EAAC0B,SAAS,EAAEC,IAAI,EAAEC,KAAK,EAAEC,MAAM,EAAEC,MAAM,EAAEC,OAAO,EAAC,GAAGP;IAE1D,MAAMQ,iBAAiBC,QAAQL,MAAMM,GAAG;IACxC,MAAMC,mBAAmBtC,KAAKuC,OAAO,CAACvC,KAAKwC,IAAI,CAACN,SAAS;IACzD,MAAMO,YAAYzC,KAAKuC,OAAO,CAACP,UAAUM;IAEzC,MAAMjB,8BAA8Ba,SAASD;IAE7C,iFAAiF;IACjF,6BAA6B;IAC7B,MAAM,EAACS,sBAAsB,EAAC,GAAG,MAAMtB,0BAA0B;QAC/DS;QACAI;QACAC;IACF;IAEA,MAAMS,qBAAqBlB,iBAAiB;QAACI;QAAWE;QAAOE;IAAM;IAErE,IAAIW,qBAAqB,CAAC;IAE1B,IAAID,oBAAoB;QACtB,iFAAiF;QACjF,MAAME,qBAAqBrC,OAAOsC,KAAK,CAACJ,yBAAyBK;QACjE,IAAI,CAACF,oBAAoB;YACvB,MAAM,IAAIG,MAAM,CAAC,0CAA0C,EAAEN,wBAAwB;QACvF;QAEAT,OAAOgB,GAAG,CAAC,GAAG5C,WAAW6C,IAAI,CAAC,mCAAmC,CAAC;QAElE,MAAMC,YAAYtB,WAAWuB,KAAKD;QAClC,MAAME,QAAQ3C,SAASmB;QAEvB,uDAAuD;QACvD,IAAI,CAACwB,OAAO;YACVrC,sBAAsB;gBAACsC,SAAS;gBAAUrB;gBAAQkB;YAAS;QAC7D;QAEA,MAAMI,qBAAqB;YACzB;gBAACC,MAAM;gBAAUT,SAASF;YAAkB;YAC5C;gBAACW,MAAM;gBAAkBT,SAASF;YAAkB;SACrD;QACDD,qBAAqBrB,wBAAwBgC,oBAAoB;YAACF;QAAK;QAEvE,qBAAqB;QACrB,MAAMI,SAAS,MAAM9C,0BAA0B4C,oBAAoBrB;QAEnE,uDAAuD;QACvD,IAAIuB,QAAQC,UAAU,CAACvB,gBAAgB;YACrC,MAAMwB,SAAS,MAAMrD,OAAO;gBAC1BsD,SAAS;oBACP;wBACEJ,MAAM,CAAC,8BAA8B,CAAC;wBACtCK,OAAO;oBACT;oBACA;wBACEL,MAAM,CAAC,0DAA0D,CAAC;wBAClEK,OAAO;oBACT;oBACA;wBAACL,MAAM;wBAAUK,OAAO;oBAAQ;iBACjC;gBACDC,SAAS;gBACTC,SAAS9D,UACP,UACA,CAAC,mGAAmG,CAAC,GACnG,CAAC,yGAAyG,CAAC,GAC3G,GAAGwD,OAAOO,GAAG,CAAC,CAACC,MAAQ,CAAC,GAAG,EAAEA,IAAIC,GAAG,CAAC,iBAAiB,EAAED,IAAIE,SAAS,CAAC,mBAAmB,EAAEF,IAAIG,MAAM,CAAC,CAAC,CAAC,EAAE5B,IAAI,CAAC,MAAM,KAAK,CAAC,GAC3H,CAAC,uDAAuD,CAAC;YAE/D;YAEA,IAAImB,WAAW,UAAU;gBACvB,OAAO7B,KAAK;YACd;YAEA,IAAI6B,WAAW,aAAaA,WAAW,uBAAuB;gBAC5D,MAAM5C,gBACJ;oBACEsD,gBAAgB,AAAC,CAAA,MAAMvD,wBAAwBoB,SAAS;wBAACoC,aAAa;oBAAK,EAAC,EAAGC,MAAM;oBACrFC,UAAUf,OAAOO,GAAG,CAAC,CAACS,MAAQ;4BAACA,IAAIP,GAAG;4BAAEO,IAAIL,MAAM;yBAAC;gBACrD,GACA;oBAACnC;oBAAQC;gBAAO;gBAGlB,IAAIyB,WAAW,uBAAuB;oBACpC,OAAO7B,KAAK;gBACd;YACF;QACF;IACF;IAEA,MAAM4C,aAAalD;IACnB,IAAIkD,WAAWhB,MAAM,GAAG,GAAG;QACzBzB,OAAOgB,GAAG,CAAC;QACX,KAAK,MAAM0B,OAAOD,WAAY;YAC5BzC,OAAOgB,GAAG,CAAC,CAAC,EAAE,EAAE0B,KAAK;QACvB;QACA1C,OAAOgB,GAAG,CAAC;IACb;IAEA,IAAI2B,cAAc;IAClB,IAAInC,cAAcH,oBAAoB,CAACH,gBAAgB;QACrDyC,cAAc,MAAMxE,QAAQ;YAC1B0D,SAAS;YACTC,SAAS,CAAC,8CAA8C,EAAEtB,UAAU,QAAQ,CAAC;QAC/E;IACF;IAEA,uCAAuC;IACvC,MAAMoC,WAAWvD,kBAAkBO,WAAW;IAE9C,IAAIiD;IACJ,IAAIF,aAAa;QACfhD,MAAMmD,KAAK,CAAC;QACZD,OAAOvE,QAAQ,uBAAuBwE,KAAK;QAC3C,MAAMhF,GAAG0C,WAAW;YAACuC,OAAO;YAAMC,WAAW;QAAI;QACjD,MAAMC,gBAAgBtD,MAAMuD,GAAG,CAAC;QAChCL,KAAKM,IAAI,GAAG,CAAC,qBAAqB,EAAEF,cAAcG,OAAO,CAAC,GAAG,GAAG,CAAC;QACjEP,KAAKQ,OAAO;IACd;IAEAR,OAAOvE,QAAQ,CAAC,mBAAmB,CAAC,EAAEwE,KAAK;IAE3C,MAAMQ,QAAQrF,kBAAkBqF,KAAK,CAAC9E;IACtC8E,MAAMR,KAAK;IAEX,IAAIS;IAEJ,IAAI7C,oBAAoB;QACtB6C,YAAY;YACVC,SAAS;gBACP,GAAI,MAAMtE,wBAAwB;oBAAC0D;oBAAUa,KAAKxD;oBAASO;gBAAS,EAAE;gBACtE,GAAGG,kBAAkB;YACvB;QACF;IACF;IAEA,IAAI;QACFhB,MAAMmD,KAAK,CAAC;QAEZ,MAAMY,SAAS,MAAMzE,iBAAiB;YACpC2D;YACAa,KAAKxD;YACLsD;YACAI,QAAQxD,QAAQL,MAAM6D,MAAM;YAC5BnD;YACAoD,eACEhE,aAAa,mBAAmBA,YAAYA,UAAUgE,aAAa,GAAGC;YACxEC,WAAW3D,QAAQL,KAAK,CAAC,cAAc;YACvCiE,MAAMnE,aAAa,UAAUA,YAAYA,UAAUmE,IAAI,GAAGF;QAC5D;QAEAP,MAAMtC,GAAG,CAAC;YACRgD,YAAYN,OAAOO,MAAM,CACtBC,OAAO,CAAC,CAACC,QAAUA,MAAMC,OAAO,CAACF,OAAO,CAAC,CAAClC,MAAQA,IAAIqC,cAAc,GACpEC,MAAM,CAAC,CAACC,KAAKC,IAAMD,MAAMC,GAAG;QACjC;QACA,MAAMC,gBAAgB9E,MAAMuD,GAAG,CAAC;QAEhCL,KAAKM,IAAI,GAAG,CAAC,qBAAqB,EAAEsB,cAAcrB,OAAO,CAAC,GAAG,GAAG,CAAC;QACjEP,KAAKQ,OAAO;QAEZC,MAAMoB,QAAQ;QACd,IAAI5E,MAAM6E,KAAK,EAAE;YACf3E,OAAOgB,GAAG,CAAC;YACXhB,OAAOgB,GAAG,CAACrC,kBAAkBC,kBAAkB8E,OAAOO,MAAM,EAAEW,KAAK,CAAC,GAAG;QACzE;IACF,EAAE,OAAOC,OAAO;QACdhC,KAAKiC,IAAI;QACTxB,MAAMuB,KAAK,CAACA;QACZ,MAAM/C,UAAU+C,iBAAiB9D,QAAQ8D,MAAM/C,OAAO,GAAGiD,OAAOF;QAChE7F,WAAW,CAAC,6BAA6B,CAAC,EAAE;YAAC6F;QAAK;QAClD7E,OAAO6E,KAAK,CAAC,CAAC,+BAA+B,EAAE/C,SAAS,EAAE;YAACjC,MAAM;QAAC;IACpE;AACF"}

package/dist/actions/build/buildVendorDependencies.js

@@ -0,0 +1,179 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import resolveFrom from 'resolve-from';
+import semver from 'semver';
+import { build } from 'vite';
+import { createExternalFromImportMap } from './createExternalFromImportMap.js';
+// Directory where vendor packages will be stored
+const VENDOR_DIR = 'vendor';
+// Define the vendor packages and their corresponding versions and entry points
+const VENDOR_IMPORTS = {
+    react: {
+        '^18.0.0': {
+            '.': './cjs/react.production.min.js',
+            './jsx-dev-runtime': './cjs/react-jsx-dev-runtime.production.min.js',
+            './jsx-runtime': './cjs/react-jsx-runtime.production.min.js',
+            './package.json': './package.json'
+        },
+        '^19.0.0': {
+            '.': './cjs/react.production.js',
+            './compiler-runtime': './cjs/react-compiler-runtime.production.js',
+            './jsx-dev-runtime': './cjs/react-jsx-dev-runtime.production.js',
+            './jsx-runtime': './cjs/react-jsx-runtime.production.js',
+            './package.json': './package.json'
+        }
+    },
+    'react-dom': {
+        '^18.0.0': {
+            '.': './cjs/react-dom.production.min.js',
+            './client': './cjs/react-dom.production.min.js',
+            './package.json': './package.json',
+            './server': './cjs/react-dom-server-legacy.browser.production.min.js',
+            './server.browser': './cjs/react-dom-server-legacy.browser.production.min.js'
+        },
+        '^19.0.0': {
+            '.': './cjs/react-dom.production.js',
+            './client': './cjs/react-dom-client.production.js',
+            './package.json': './package.json',
+            './server': './cjs/react-dom-server-legacy.browser.production.js',
+            './server.browser': './cjs/react-dom-server-legacy.browser.production.js',
+            './static': './cjs/react-dom-server.browser.production.js',
+            './static.browser': './cjs/react-dom-server.browser.production.js'
+        }
+    },
+    'styled-components': {
+        '^6.1.0': {
+            '.': './dist/styled-components.esm.js',
+            './package.json': './package.json'
+        }
+    }
+};
+/**
+ * Builds the ESM browser compatible versions of the vendor packages
+ * specified in VENDOR_IMPORTS. Returns the `imports` object of an import map.
+ */ export async function buildVendorDependencies({ basePath, cwd, outputDir }) {
+    // normalize the CWD to a relative dir for better error messages
+    const dir = path.relative(process.cwd(), path.resolve(cwd));
+    const entry = {};
+    const imports = {};
+    // Iterate over each package and its version ranges in VENDOR_IMPORTS
+    for (const [packageName, ranges] of Object.entries(VENDOR_IMPORTS)){
+        const packageJsonPath = resolveFrom.silent(cwd, path.join(packageName, 'package.json'));
+        if (!packageJsonPath) {
+            throw new Error(`Could not find package.json for package '${packageName}' from directory '${dir}'. Is it installed?`);
+        }
+        let packageJson;
+        try {
+            // Read and parse the package.json file
+            packageJson = JSON.parse(await fs.promises.readFile(packageJsonPath, 'utf8'));
+        } catch (e) {
+            const message = `Could not read package.json for package '${packageName}' from directory '${dir}'`;
+            if (typeof e?.message === 'string') {
+                // Re-assign the error message so the stack trace is more visible
+                e.message = `${message}: ${e.message}`;
+                throw e;
+            }
+            throw new Error(message, {
+                cause: e
+            });
+        }
+        // Coerce the version to a semver-compatible version
+        const version = semver.coerce(packageJson.version)?.version;
+        if (!version) {
+            throw new Error(`Could not parse version '${packageJson.version}' from '${packageName}'`);
+        }
+        // Sort version ranges in descending order
+        const sortedRanges = Object.keys(ranges).toSorted((range1, range2)=>{
+            const min1 = semver.minVersion(range1);
+            const min2 = semver.minVersion(range2);
+            if (!min1) throw new Error(`Could not parse range '${range1}'`);
+            if (!min2) throw new Error(`Could not parse range '${range2}'`);
+            // sort them in reverse so we can rely on array `.find` below
+            return semver.rcompare(min1.version, min2.version);
+        });
+        // Find the first version range that satisfies the package version
+        const matchedRange = sortedRanges.find((range)=>semver.satisfies(version, range));
+        if (!matchedRange) {
+            const min = semver.minVersion(sortedRanges.at(-1));
+            if (!min) {
+                throw new Error(`Could not find a minimum version for package '${packageName}'`);
+            }
+            if (semver.gt(min.version, version)) {
+                throw new Error(`Package '${packageName}' requires at least ${min.version}.`);
+            }
+            throw new Error(`Version '${version}' of package '${packageName}' is not supported yet.`);
+        }
+        const subpaths = ranges[matchedRange];
+        // Iterate over each subpath and its corresponding entry point
+        for (const [subpath, relativeEntryPoint] of Object.entries(subpaths)){
+            const packagePath = path.dirname(packageJsonPath);
+            const entryPoint = resolveFrom.silent(packagePath, relativeEntryPoint);
+            if (!entryPoint) {
+                throw new Error(`Failed to resolve entry point '${path.join(packageName, relativeEntryPoint)}'. `);
+            }
+            const specifier = path.posix.join(packageName, subpath);
+            const chunkName = path.posix.join(packageName, path.relative(packageName, specifier) || 'index');
+            entry[chunkName] = entryPoint;
+            imports[specifier] = path.posix.join('/', basePath, VENDOR_DIR, `${chunkName}.mjs`);
+        }
+    }
+    // Use Vite to build the packages into the output directory
+    let buildResult = await build({
+        appType: 'custom',
+        build: {
+            commonjsOptions: {
+                strictRequires: 'auto'
+            },
+            emptyOutDir: false,
+            lib: {
+                entry,
+                formats: [
+                    'es'
+                ]
+            },
+            minify: true,
+            outDir: path.join(outputDir, VENDOR_DIR),
+            rollupOptions: {
+                external: createExternalFromImportMap({
+                    imports
+                }),
+                output: {
+                    chunkFileNames: '[name]-[hash].mjs',
+                    entryFileNames: '[name]-[hash].mjs',
+                    exports: 'named',
+                    format: 'es'
+                },
+                treeshake: {
+                    preset: 'recommended'
+                }
+            }
+        },
+        // Define a custom cache directory so that sanity's vite cache
+        // does not conflict with any potential local vite projects
+        cacheDir: 'node_modules/.sanity/vite-vendor',
+        configFile: false,
+        define: {
+            'process.env.NODE_ENV': JSON.stringify('production')
+        },
+        logLevel: 'silent',
+        mode: 'production',
+        root: cwd
+    });
+    buildResult = Array.isArray(buildResult) ? buildResult : [
+        buildResult
+    ];
+    // Create a map of the original import specifiers to their hashed filenames
+    const hashedImports = {};
+    const output = buildResult.flatMap((i)=>i.output);
+    for (const chunk of output){
+        if (chunk.type === 'asset') continue;
+        for (const [specifier, originalPath] of Object.entries(imports)){
+            if (originalPath.endsWith(`${chunk.name}.mjs`)) {
+                hashedImports[specifier] = path.posix.join('/', basePath, VENDOR_DIR, chunk.fileName);
+            }
+        }
+    }
+    return hashedImports;
+}
+
+//# sourceMappingURL=buildVendorDependencies.js.map

package/dist/actions/build/buildVendorDependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/build/buildVendorDependencies.ts"],"sourcesContent":["import fs from 'node:fs'\nimport path from 'node:path'\n\nimport resolveFrom from 'resolve-from'\nimport semver from 'semver'\nimport {build} from 'vite'\n\nimport {createExternalFromImportMap} from './createExternalFromImportMap.js'\n\n// Directory where vendor packages will be stored\nconst VENDOR_DIR = 'vendor'\n\n/**\n * A type representing the imports of vendor packages, defining specific entry\n * points for various versions and subpaths of the packages.\n *\n * The `VendorImports` object is used to build ESM browser-compatible versions\n * of the specified packages. This approach ensures that the appropriate version\n * and entry points are used for each package, enabling compatibility and proper\n * functionality in the browser environment.\n *\n * ## Rationale\n *\n * The rationale for this structure is to handle different versions of the\n * packages carefully, especially major versions. Major version bumps often\n * introduce breaking changes, so the module scheme for the package needs to be\n * checked when there is a major version update. However, minor and patch\n * versions are generally backward compatible, so they are handled more\n * leniently. By assuming that new minor versions are compatible, we avoid\n * unnecessary warnings and streamline the update process.\n *\n * If a new minor version introduces an additional subpath export within the\n * package of this version range, the corresponding package can add a more\n * specific version range that includes the new subpath. This design allows for\n * flexibility and ease of maintenance, ensuring that the latest features and\n * fixes are incorporated without extensive manual intervention.\n *\n * An additional subpath export within the package of this version range that\n * could cause the build to break if that new export is used, can be treated as\n * a bug fix. It might make more sense to our users that this new subpath isn't\n * supported yet until we address it as a bug fix. This approach helps maintain\n * stability and prevents unexpected issues during the build process.\n *\n * ## Structure\n * The `VendorImports` type is a nested object where:\n * - The keys at the first level represent the package names.\n * - The keys at the second level represent the version ranges (e.g., `^19.0.0`).\n * - The keys at the third level represent the subpaths within the package (e.g., `.` for the main entry point).\n * - The values at the third level are the relative paths to the corresponding entry points within the package.\n *\n * This structure allows for precise specification of the entry points for\n * different versions and subpaths, ensuring that the correct files are used\n * during the build process.\n */\ntype VendorImports = {\n  [packageName: string]: {\n    [versionRange: string]: {\n      [subpath: string]: string\n    }\n  }\n}\n\n// Define the vendor packages and their corresponding versions and entry points\nconst VENDOR_IMPORTS: VendorImports = {\n  react: {\n    '^18.0.0': {\n      '.': './cjs/react.production.min.js',\n      './jsx-dev-runtime': './cjs/react-jsx-dev-runtime.production.min.js',\n      './jsx-runtime': './cjs/react-jsx-runtime.production.min.js',\n      './package.json': './package.json',\n    },\n    '^19.0.0': {\n      '.': './cjs/react.production.js',\n      './compiler-runtime': './cjs/react-compiler-runtime.production.js',\n      './jsx-dev-runtime': './cjs/react-jsx-dev-runtime.production.js',\n      './jsx-runtime': './cjs/react-jsx-runtime.production.js',\n      './package.json': './package.json',\n    },\n  },\n  'react-dom': {\n    '^18.0.0': {\n      '.': './cjs/react-dom.production.min.js',\n      './client': './cjs/react-dom.production.min.js',\n      './package.json': './package.json',\n      './server': './cjs/react-dom-server-legacy.browser.production.min.js',\n      './server.browser': './cjs/react-dom-server-legacy.browser.production.min.js',\n    },\n    '^19.0.0': {\n      '.': './cjs/react-dom.production.js',\n      './client': './cjs/react-dom-client.production.js',\n      './package.json': './package.json',\n      './server': './cjs/react-dom-server-legacy.browser.production.js',\n      './server.browser': './cjs/react-dom-server-legacy.browser.production.js',\n      './static': './cjs/react-dom-server.browser.production.js',\n      './static.browser': './cjs/react-dom-server.browser.production.js',\n    },\n  },\n  'styled-components': {\n    '^6.1.0': {\n      '.': './dist/styled-components.esm.js',\n      './package.json': './package.json',\n    },\n  },\n}\n\ninterface VendorBuildOptions {\n  basePath: string\n  cwd: string\n  outputDir: string\n}\n\n/**\n * Builds the ESM browser compatible versions of the vendor packages\n * specified in VENDOR_IMPORTS. Returns the `imports` object of an import map.\n */\nexport async function buildVendorDependencies({\n  basePath,\n  cwd,\n  outputDir,\n}: VendorBuildOptions): Promise<Record<string, string>> {\n  // normalize the CWD to a relative dir for better error messages\n  const dir = path.relative(process.cwd(), path.resolve(cwd))\n  const entry: Record<string, string> = {}\n  const imports: Record<string, string> = {}\n\n  // Iterate over each package and its version ranges in VENDOR_IMPORTS\n  for (const [packageName, ranges] of Object.entries(VENDOR_IMPORTS)) {\n    const packageJsonPath = resolveFrom.silent(cwd, path.join(packageName, 'package.json'))\n    if (!packageJsonPath) {\n      throw new Error(\n        `Could not find package.json for package '${packageName}' from directory '${dir}'. Is it installed?`,\n      )\n    }\n\n    let packageJson\n\n    try {\n      // Read and parse the package.json file\n      packageJson = JSON.parse(await fs.promises.readFile(packageJsonPath, 'utf8'))\n    } catch (e) {\n      const message = `Could not read package.json for package '${packageName}' from directory '${dir}'`\n      if (typeof e?.message === 'string') {\n        // Re-assign the error message so the stack trace is more visible\n        e.message = `${message}: ${e.message}`\n        throw e\n      }\n\n      throw new Error(message, {cause: e})\n    }\n\n    // Coerce the version to a semver-compatible version\n    const version = semver.coerce(packageJson.version)?.version\n    if (!version) {\n      throw new Error(`Could not parse version '${packageJson.version}' from '${packageName}'`)\n    }\n\n    // Sort version ranges in descending order\n    const sortedRanges = Object.keys(ranges).toSorted((range1, range2) => {\n      const min1 = semver.minVersion(range1)\n      const min2 = semver.minVersion(range2)\n\n      if (!min1) throw new Error(`Could not parse range '${range1}'`)\n      if (!min2) throw new Error(`Could not parse range '${range2}'`)\n\n      // sort them in reverse so we can rely on array `.find` below\n      return semver.rcompare(min1.version, min2.version)\n    })\n\n    // Find the first version range that satisfies the package version\n    const matchedRange = sortedRanges.find((range) => semver.satisfies(version, range))\n\n    if (!matchedRange) {\n      const min = semver.minVersion(sortedRanges.at(-1)!)\n      if (!min) {\n        throw new Error(`Could not find a minimum version for package '${packageName}'`)\n      }\n\n      if (semver.gt(min.version, version)) {\n        throw new Error(`Package '${packageName}' requires at least ${min.version}.`)\n      }\n\n      throw new Error(`Version '${version}' of package '${packageName}' is not supported yet.`)\n    }\n\n    const subpaths = ranges[matchedRange]\n\n    // Iterate over each subpath and its corresponding entry point\n    for (const [subpath, relativeEntryPoint] of Object.entries(subpaths)) {\n      const packagePath = path.dirname(packageJsonPath)\n      const entryPoint = resolveFrom.silent(packagePath, relativeEntryPoint)\n\n      if (!entryPoint) {\n        throw new Error(\n          `Failed to resolve entry point '${path.join(packageName, relativeEntryPoint)}'. `,\n        )\n      }\n\n      const specifier = path.posix.join(packageName, subpath)\n      const chunkName = path.posix.join(\n        packageName,\n        path.relative(packageName, specifier) || 'index',\n      )\n\n      entry[chunkName] = entryPoint\n      imports[specifier] = path.posix.join('/', basePath, VENDOR_DIR, `${chunkName}.mjs`)\n    }\n  }\n\n  // removes the `RollupWatcher` type\n  type BuildResult = Exclude<Awaited<ReturnType<typeof build>>, {close: unknown}>\n\n  // Use Vite to build the packages into the output directory\n  let buildResult = (await build({\n    appType: 'custom',\n    build: {\n      commonjsOptions: {strictRequires: 'auto'},\n      emptyOutDir: false, // Rely on CLI to do this\n      lib: {entry, formats: ['es']},\n      minify: true,\n      outDir: path.join(outputDir, VENDOR_DIR),\n      rollupOptions: {\n        external: createExternalFromImportMap({imports}),\n        output: {\n          chunkFileNames: '[name]-[hash].mjs',\n          entryFileNames: '[name]-[hash].mjs',\n          exports: 'named',\n          format: 'es',\n        },\n        treeshake: {preset: 'recommended'},\n      },\n    },\n    // Define a custom cache directory so that sanity's vite cache\n    // does not conflict with any potential local vite projects\n    cacheDir: 'node_modules/.sanity/vite-vendor',\n    configFile: false,\n    define: {'process.env.NODE_ENV': JSON.stringify('production')},\n    logLevel: 'silent',\n    mode: 'production',\n    root: cwd,\n  })) as BuildResult\n\n  buildResult = Array.isArray(buildResult) ? buildResult : [buildResult]\n\n  // Create a map of the original import specifiers to their hashed filenames\n  const hashedImports: Record<string, string> = {}\n  const output = buildResult.flatMap((i) => i.output)\n\n  for (const chunk of output) {\n    if (chunk.type === 'asset') continue\n\n    for (const [specifier, originalPath] of Object.entries(imports)) {\n      if (originalPath.endsWith(`${chunk.name}.mjs`)) {\n        hashedImports[specifier] = path.posix.join('/', basePath, VENDOR_DIR, chunk.fileName)\n      }\n    }\n  }\n\n  return hashedImports\n}\n"],"names":["fs","path","resolveFrom","semver","build","createExternalFromImportMap","VENDOR_DIR","VENDOR_IMPORTS","react","buildVendorDependencies","basePath","cwd","outputDir","dir","relative","process","resolve","entry","imports","packageName","ranges","Object","entries","packageJsonPath","silent","join","Error","packageJson","JSON","parse","promises","readFile","e","message","cause","version","coerce","sortedRanges","keys","toSorted","range1","range2","min1","minVersion","min2","rcompare","matchedRange","find","range","satisfies","min","at","gt","subpaths","subpath","relativeEntryPoint","packagePath","dirname","entryPoint","specifier","posix","chunkName","buildResult","appType","commonjsOptions","strictRequires","emptyOutDir","lib","formats","minify","outDir","rollupOptions","external","output","chunkFileNames","entryFileNames","exports","format","treeshake","preset","cacheDir","configFile","define","stringify","logLevel","mode","root","Array","isArray","hashedImports","flatMap","i","chunk","type","originalPath","endsWith","name","fileName"],"mappings":"AAAA,OAAOA,QAAQ,UAAS;AACxB,OAAOC,UAAU,YAAW;AAE5B,OAAOC,iBAAiB,eAAc;AACtC,OAAOC,YAAY,SAAQ;AAC3B,SAAQC,KAAK,QAAO,OAAM;AAE1B,SAAQC,2BAA2B,QAAO,mCAAkC;AAE5E,iDAAiD;AACjD,MAAMC,aAAa;AAoDnB,+EAA+E;AAC/E,MAAMC,iBAAgC;IACpCC,OAAO;QACL,WAAW;YACT,KAAK;YACL,qBAAqB;YACrB,iBAAiB;YACjB,kBAAkB;QACpB;QACA,WAAW;YACT,KAAK;YACL,sBAAsB;YACtB,qBAAqB;YACrB,iBAAiB;YACjB,kBAAkB;QACpB;IACF;IACA,aAAa;QACX,WAAW;YACT,KAAK;YACL,YAAY;YACZ,kBAAkB;YAClB,YAAY;YACZ,oBAAoB;QACtB;QACA,WAAW;YACT,KAAK;YACL,YAAY;YACZ,kBAAkB;YAClB,YAAY;YACZ,oBAAoB;YACpB,YAAY;YACZ,oBAAoB;QACtB;IACF;IACA,qBAAqB;QACnB,UAAU;YACR,KAAK;YACL,kBAAkB;QACpB;IACF;AACF;AAQA;;;CAGC,GACD,OAAO,eAAeC,wBAAwB,EAC5CC,QAAQ,EACRC,GAAG,EACHC,SAAS,EACU;IACnB,gEAAgE;IAChE,MAAMC,MAAMZ,KAAKa,QAAQ,CAACC,QAAQJ,GAAG,IAAIV,KAAKe,OAAO,CAACL;IACtD,MAAMM,QAAgC,CAAC;IACvC,MAAMC,UAAkC,CAAC;IAEzC,qEAAqE;IACrE,KAAK,MAAM,CAACC,aAAaC,OAAO,IAAIC,OAAOC,OAAO,CAACf,gBAAiB;QAClE,MAAMgB,kBAAkBrB,YAAYsB,MAAM,CAACb,KAAKV,KAAKwB,IAAI,CAACN,aAAa;QACvE,IAAI,CAACI,iBAAiB;YACpB,MAAM,IAAIG,MACR,CAAC,yCAAyC,EAAEP,YAAY,kBAAkB,EAAEN,IAAI,mBAAmB,CAAC;QAExG;QAEA,IAAIc;QAEJ,IAAI;YACF,uCAAuC;YACvCA,cAAcC,KAAKC,KAAK,CAAC,MAAM7B,GAAG8B,QAAQ,CAACC,QAAQ,CAACR,iBAAiB;QACvE,EAAE,OAAOS,GAAG;YACV,MAAMC,UAAU,CAAC,yCAAyC,EAAEd,YAAY,kBAAkB,EAAEN,IAAI,CAAC,CAAC;YAClG,IAAI,OAAOmB,GAAGC,YAAY,UAAU;gBAClC,iEAAiE;gBACjED,EAAEC,OAAO,GAAG,GAAGA,QAAQ,EAAE,EAAED,EAAEC,OAAO,EAAE;gBACtC,MAAMD;YACR;YAEA,MAAM,IAAIN,MAAMO,SAAS;gBAACC,OAAOF;YAAC;QACpC;QAEA,oDAAoD;QACpD,MAAMG,UAAUhC,OAAOiC,MAAM,CAACT,YAAYQ,OAAO,GAAGA;QACpD,IAAI,CAACA,SAAS;YACZ,MAAM,IAAIT,MAAM,CAAC,yBAAyB,EAAEC,YAAYQ,OAAO,CAAC,QAAQ,EAAEhB,YAAY,CAAC,CAAC;QAC1F;QAEA,0CAA0C;QAC1C,MAAMkB,eAAehB,OAAOiB,IAAI,CAAClB,QAAQmB,QAAQ,CAAC,CAACC,QAAQC;YACzD,MAAMC,OAAOvC,OAAOwC,UAAU,CAACH;YAC/B,MAAMI,OAAOzC,OAAOwC,UAAU,CAACF;YAE/B,IAAI,CAACC,MAAM,MAAM,IAAIhB,MAAM,CAAC,uBAAuB,EAAEc,OAAO,CAAC,CAAC;YAC9D,IAAI,CAACI,MAAM,MAAM,IAAIlB,MAAM,CAAC,uBAAuB,EAAEe,OAAO,CAAC,CAAC;YAE9D,6DAA6D;YAC7D,OAAOtC,OAAO0C,QAAQ,CAACH,KAAKP,OAAO,EAAES,KAAKT,OAAO;QACnD;QAEA,kEAAkE;QAClE,MAAMW,eAAeT,aAAaU,IAAI,CAAC,CAACC,QAAU7C,OAAO8C,SAAS,CAACd,SAASa;QAE5E,IAAI,CAACF,cAAc;YACjB,MAAMI,MAAM/C,OAAOwC,UAAU,CAACN,aAAac,EAAE,CAAC,CAAC;YAC/C,IAAI,CAACD,KAAK;gBACR,MAAM,IAAIxB,MAAM,CAAC,8CAA8C,EAAEP,YAAY,CAAC,CAAC;YACjF;YAEA,IAAIhB,OAAOiD,EAAE,CAACF,IAAIf,OAAO,EAAEA,UAAU;gBACnC,MAAM,IAAIT,MAAM,CAAC,SAAS,EAAEP,YAAY,oBAAoB,EAAE+B,IAAIf,OAAO,CAAC,CAAC,CAAC;YAC9E;YAEA,MAAM,IAAIT,MAAM,CAAC,SAAS,EAAES,QAAQ,cAAc,EAAEhB,YAAY,uBAAuB,CAAC;QAC1F;QAEA,MAAMkC,WAAWjC,MAAM,CAAC0B,aAAa;QAErC,8DAA8D;QAC9D,KAAK,MAAM,CAACQ,SAASC,mBAAmB,IAAIlC,OAAOC,OAAO,CAAC+B,UAAW;YACpE,MAAMG,cAAcvD,KAAKwD,OAAO,CAAClC;YACjC,MAAMmC,aAAaxD,YAAYsB,MAAM,CAACgC,aAAaD;YAEnD,IAAI,CAACG,YAAY;gBACf,MAAM,IAAIhC,MACR,CAAC,+BAA+B,EAAEzB,KAAKwB,IAAI,CAACN,aAAaoC,oBAAoB,GAAG,CAAC;YAErF;YAEA,MAAMI,YAAY1D,KAAK2D,KAAK,CAACnC,IAAI,CAACN,aAAamC;YAC/C,MAAMO,YAAY5D,KAAK2D,KAAK,CAACnC,IAAI,CAC/BN,aACAlB,KAAKa,QAAQ,CAACK,aAAawC,cAAc;YAG3C1C,KAAK,CAAC4C,UAAU,GAAGH;YACnBxC,OAAO,CAACyC,UAAU,GAAG1D,KAAK2D,KAAK,CAACnC,IAAI,CAAC,KAAKf,UAAUJ,YAAY,GAAGuD,UAAU,IAAI,CAAC;QACpF;IACF;IAKA,2DAA2D;IAC3D,IAAIC,cAAe,MAAM1D,MAAM;QAC7B2D,SAAS;QACT3D,OAAO;YACL4D,iBAAiB;gBAACC,gBAAgB;YAAM;YACxCC,aAAa;YACbC,KAAK;gBAAClD;gBAAOmD,SAAS;oBAAC;iBAAK;YAAA;YAC5BC,QAAQ;YACRC,QAAQrE,KAAKwB,IAAI,CAACb,WAAWN;YAC7BiE,eAAe;gBACbC,UAAUnE,4BAA4B;oBAACa;gBAAO;gBAC9CuD,QAAQ;oBACNC,gBAAgB;oBAChBC,gBAAgB;oBAChBC,SAAS;oBACTC,QAAQ;gBACV;gBACAC,WAAW;oBAACC,QAAQ;gBAAa;YACnC;QACF;QACA,8DAA8D;QAC9D,2DAA2D;QAC3DC,UAAU;QACVC,YAAY;QACZC,QAAQ;YAAC,wBAAwBtD,KAAKuD,SAAS,CAAC;QAAa;QAC7DC,UAAU;QACVC,MAAM;QACNC,MAAM3E;IACR;IAEAmD,cAAcyB,MAAMC,OAAO,CAAC1B,eAAeA,cAAc;QAACA;KAAY;IAEtE,2EAA2E;IAC3E,MAAM2B,gBAAwC,CAAC;IAC/C,MAAMhB,SAASX,YAAY4B,OAAO,CAAC,CAACC,IAAMA,EAAElB,MAAM;IAElD,KAAK,MAAMmB,SAASnB,OAAQ;QAC1B,IAAImB,MAAMC,IAAI,KAAK,SAAS;QAE5B,KAAK,MAAM,CAAClC,WAAWmC,aAAa,IAAIzE,OAAOC,OAAO,CAACJ,SAAU;YAC/D,IAAI4E,aAAaC,QAAQ,CAAC,GAAGH,MAAMI,IAAI,CAAC,IAAI,CAAC,GAAG;gBAC9CP,aAAa,CAAC9B,UAAU,GAAG1D,KAAK2D,KAAK,CAACnC,IAAI,CAAC,KAAKf,UAAUJ,YAAYsF,MAAMK,QAAQ;YACtF;QACF;IACF;IAEA,OAAOR;AACT"}

package/dist/actions/build/checkRequiredDependencies.js

@@ -0,0 +1,122 @@
+import path from 'node:path';
+import { oneline } from 'oneline';
+import semver from 'semver';
+import { determineIsApp } from '../../util/determineIsApp.js';
+import { readModuleVersion } from '../../util/readModuleVersion.js';
+import { readPackageManifest } from '../../util/readPackageManifest.js';
+const defaultStudioManifestProps = {
+    name: 'studio',
+    version: '1.0.0'
+};
+const styledComponentsVersionRange = '^6.1.15';
+/**
+ * Checks that the studio has declared and installed the required dependencies
+ * needed by the Sanity modules. While we generally use regular, explicit
+ * dependencies in modules, there are certain dependencies that are better
+ * served being peer dependencies, such as react and styled-components.
+ *
+ * If these dependencies are not installed/declared, we report an error
+ * and instruct the user to install them manually.
+ *
+ * Additionally, returns the version of the 'sanity' dependency from the package.json.
+ */ export async function checkRequiredDependencies(options) {
+    const { cliConfig, output, workDir: studioPath } = options;
+    // currently there's no check needed for core apps,
+    // but this should be removed once they are more mature
+    const isApp = determineIsApp(cliConfig);
+    if (isApp) {
+        return {
+            installedSanityVersion: ''
+        };
+    }
+    const [studioPackageManifest, installedStyledComponentsVersion, installedSanityVersion] = await Promise.all([
+        readPackageManifest(path.join(studioPath, 'package.json'), defaultStudioManifestProps),
+        readModuleVersion(studioPath, 'styled-components'),
+        readModuleVersion(studioPath, 'sanity')
+    ]);
+    const wantedStyledComponentsVersionRange = styledComponentsVersionRange;
+    // Retrieve the version of the 'sanity' dependency
+    if (!installedSanityVersion) {
+        output.error('Failed to read the installed sanity version.', {
+            exit: 1
+        });
+        return {
+            installedSanityVersion: ''
+        };
+    }
+    // The studio _must_ now declare `styled-components` as a dependency. If it's not there,
+    // we'll want to automatically _add it_ to the manifest and tell the user to reinstall
+    // dependencies before running whatever command was being run
+    const declaredStyledComponentsVersion = studioPackageManifest.dependencies['styled-components'] || studioPackageManifest.devDependencies['styled-components'];
+    if (!declaredStyledComponentsVersion) {
+        output.error(oneline`
+      Declared dependency \`styled-components\` is not installed - run
+      \`npm install\`, \`yarn install\` or \`pnpm install\` to install it before re-running this command.
+    `, {
+            exit: 1
+        });
+        return {
+            installedSanityVersion
+        };
+    }
+    // Theoretically the version specified in package.json could be incorrect, eg `foo`
+    let minDeclaredStyledComponentsVersion = null;
+    try {
+        minDeclaredStyledComponentsVersion = semver.minVersion(declaredStyledComponentsVersion);
+    } catch  {
+    // Intentional fall-through (variable will be left as null, throwing below)
+    }
+    if (!minDeclaredStyledComponentsVersion) {
+        output.error(oneline`
+      Declared dependency \`styled-components\` has an invalid version range:
+      \`${declaredStyledComponentsVersion}\`.
+    `, {
+            exit: 1
+        });
+        return {
+            installedSanityVersion
+        };
+    }
+    // The declared version should be semver-compatible with the version specified as a
+    // peer dependency in `sanity`. If not, we should tell the user to change it.
+    //
+    // Exception: Ranges are hard to compare. `>=5.0.0 && <=5.3.2 || ^6`... Comparing this
+    // to anything is going to be challenging, so only compare "simple" ranges/versions
+    // (^x.x.x / ~x.x.x / x.x.x)
+    if (isComparableRange(declaredStyledComponentsVersion) && !semver.satisfies(minDeclaredStyledComponentsVersion, wantedStyledComponentsVersionRange)) {
+        output.warn(oneline`
+      Declared version of styled-components (${declaredStyledComponentsVersion})
+      is not compatible with the version required by sanity (${wantedStyledComponentsVersionRange}).
+      This might cause problems!
+    `);
+    }
+    // Ensure the studio has _installed_ a version of `styled-components`
+    if (!installedStyledComponentsVersion) {
+        output.error(oneline`
+      Declared dependency \`styled-components\` is not installed - run
+      \`npm install\`, \`yarn install\` or \`pnpm install\` to install it before re-running this command.
+    `, {
+            exit: 1
+        });
+        return {
+            installedSanityVersion
+        };
+    }
+    // The studio should have an _installed_ version of `styled-components`, and it should
+    // be semver compatible with the version specified in `sanity` peer dependencies.
+    if (!semver.satisfies(installedStyledComponentsVersion, wantedStyledComponentsVersionRange)) {
+        output.warn(oneline`
+      Installed version of styled-components (${installedStyledComponentsVersion})
+      is not compatible with the version required by sanity (${wantedStyledComponentsVersionRange}).
+      This might cause problems!
+    `);
+    }
+    return {
+        installedSanityVersion
+    };
+}
+function isComparableRange(range) {
+    return /^[\^~]?\d+(\.\d+)?(\.\d+)?$/.test(range);
+}
+
+//# sourceMappingURL=checkRequiredDependencies.js.map

package/dist/actions/build/checkRequiredDependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/build/checkRequiredDependencies.ts"],"sourcesContent":["import path from 'node:path'\n\nimport {type CliConfig, type Output} from '@sanity/cli-core'\nimport {oneline} from 'oneline'\nimport semver, {type SemVer} from 'semver'\n\nimport {determineIsApp} from '../../util/determineIsApp.js'\nimport {readModuleVersion} from '../../util/readModuleVersion.js'\nimport {type PartialPackageManifest, readPackageManifest} from '../../util/readPackageManifest.js'\n\nconst defaultStudioManifestProps: PartialPackageManifest = {\n  name: 'studio',\n  version: '1.0.0',\n}\n\ninterface CheckResult {\n  installedSanityVersion: string\n}\n\ninterface CheckRequiredDependenciesOptions {\n  cliConfig: CliConfig\n  output: Output\n  workDir: string\n}\n\nconst styledComponentsVersionRange = '^6.1.15'\n\n/**\n * Checks that the studio has declared and installed the required dependencies\n * needed by the Sanity modules. While we generally use regular, explicit\n * dependencies in modules, there are certain dependencies that are better\n * served being peer dependencies, such as react and styled-components.\n *\n * If these dependencies are not installed/declared, we report an error\n * and instruct the user to install them manually.\n *\n * Additionally, returns the version of the 'sanity' dependency from the package.json.\n */\nexport async function checkRequiredDependencies(\n  options: CheckRequiredDependenciesOptions,\n): Promise<CheckResult> {\n  const {cliConfig, output, workDir: studioPath} = options\n  // currently there's no check needed for core apps,\n  // but this should be removed once they are more mature\n  const isApp = determineIsApp(cliConfig)\n  if (isApp) {\n    return {installedSanityVersion: ''}\n  }\n\n  const [studioPackageManifest, installedStyledComponentsVersion, installedSanityVersion] =\n    await Promise.all([\n      readPackageManifest(path.join(studioPath, 'package.json'), defaultStudioManifestProps),\n      readModuleVersion(studioPath, 'styled-components'),\n      readModuleVersion(studioPath, 'sanity'),\n    ])\n\n  const wantedStyledComponentsVersionRange = styledComponentsVersionRange\n\n  // Retrieve the version of the 'sanity' dependency\n  if (!installedSanityVersion) {\n    output.error('Failed to read the installed sanity version.', {exit: 1})\n    return {installedSanityVersion: ''}\n  }\n\n  // The studio _must_ now declare `styled-components` as a dependency. If it's not there,\n  // we'll want to automatically _add it_ to the manifest and tell the user to reinstall\n  // dependencies before running whatever command was being run\n  const declaredStyledComponentsVersion =\n    studioPackageManifest.dependencies['styled-components'] ||\n    studioPackageManifest.devDependencies['styled-components']\n\n  if (!declaredStyledComponentsVersion) {\n    output.error(\n      oneline`\n      Declared dependency \\`styled-components\\` is not installed - run\n      \\`npm install\\`, \\`yarn install\\` or \\`pnpm install\\` to install it before re-running this command.\n    `,\n      {exit: 1},\n    )\n    return {installedSanityVersion}\n  }\n\n  // Theoretically the version specified in package.json could be incorrect, eg `foo`\n  let minDeclaredStyledComponentsVersion: SemVer | null = null\n  try {\n    minDeclaredStyledComponentsVersion = semver.minVersion(declaredStyledComponentsVersion)\n  } catch {\n    // Intentional fall-through (variable will be left as null, throwing below)\n  }\n\n  if (!minDeclaredStyledComponentsVersion) {\n    output.error(\n      oneline`\n      Declared dependency \\`styled-components\\` has an invalid version range:\n      \\`${declaredStyledComponentsVersion}\\`.\n    `,\n      {exit: 1},\n    )\n    return {installedSanityVersion}\n  }\n\n  // The declared version should be semver-compatible with the version specified as a\n  // peer dependency in `sanity`. If not, we should tell the user to change it.\n  //\n  // Exception: Ranges are hard to compare. `>=5.0.0 && <=5.3.2 || ^6`... Comparing this\n  // to anything is going to be challenging, so only compare \"simple\" ranges/versions\n  // (^x.x.x / ~x.x.x / x.x.x)\n  if (\n    isComparableRange(declaredStyledComponentsVersion) &&\n    !semver.satisfies(minDeclaredStyledComponentsVersion, wantedStyledComponentsVersionRange)\n  ) {\n    output.warn(oneline`\n      Declared version of styled-components (${declaredStyledComponentsVersion})\n      is not compatible with the version required by sanity (${wantedStyledComponentsVersionRange}).\n      This might cause problems!\n    `)\n  }\n\n  // Ensure the studio has _installed_ a version of `styled-components`\n  if (!installedStyledComponentsVersion) {\n    output.error(\n      oneline`\n      Declared dependency \\`styled-components\\` is not installed - run\n      \\`npm install\\`, \\`yarn install\\` or \\`pnpm install\\` to install it before re-running this command.\n    `,\n      {exit: 1},\n    )\n    return {installedSanityVersion}\n  }\n\n  // The studio should have an _installed_ version of `styled-components`, and it should\n  // be semver compatible with the version specified in `sanity` peer dependencies.\n  if (!semver.satisfies(installedStyledComponentsVersion, wantedStyledComponentsVersionRange)) {\n    output.warn(oneline`\n      Installed version of styled-components (${installedStyledComponentsVersion})\n      is not compatible with the version required by sanity (${wantedStyledComponentsVersionRange}).\n      This might cause problems!\n    `)\n  }\n\n  return {installedSanityVersion}\n}\n\nfunction isComparableRange(range: string): boolean {\n  return /^[\\^~]?\\d+(\\.\\d+)?(\\.\\d+)?$/.test(range)\n}\n"],"names":["path","oneline","semver","determineIsApp","readModuleVersion","readPackageManifest","defaultStudioManifestProps","name","version","styledComponentsVersionRange","checkRequiredDependencies","options","cliConfig","output","workDir","studioPath","isApp","installedSanityVersion","studioPackageManifest","installedStyledComponentsVersion","Promise","all","join","wantedStyledComponentsVersionRange","error","exit","declaredStyledComponentsVersion","dependencies","devDependencies","minDeclaredStyledComponentsVersion","minVersion","isComparableRange","satisfies","warn","range","test"],"mappings":"AAAA,OAAOA,UAAU,YAAW;AAG5B,SAAQC,OAAO,QAAO,UAAS;AAC/B,OAAOC,YAA2B,SAAQ;AAE1C,SAAQC,cAAc,QAAO,+BAA8B;AAC3D,SAAQC,iBAAiB,QAAO,kCAAiC;AACjE,SAAqCC,mBAAmB,QAAO,oCAAmC;AAElG,MAAMC,6BAAqD;IACzDC,MAAM;IACNC,SAAS;AACX;AAYA,MAAMC,+BAA+B;AAErC;;;;;;;;;;CAUC,GACD,OAAO,eAAeC,0BACpBC,OAAyC;IAEzC,MAAM,EAACC,SAAS,EAAEC,MAAM,EAAEC,SAASC,UAAU,EAAC,GAAGJ;IACjD,mDAAmD;IACnD,uDAAuD;IACvD,MAAMK,QAAQb,eAAeS;IAC7B,IAAII,OAAO;QACT,OAAO;YAACC,wBAAwB;QAAE;IACpC;IAEA,MAAM,CAACC,uBAAuBC,kCAAkCF,uBAAuB,GACrF,MAAMG,QAAQC,GAAG,CAAC;QAChBhB,oBAAoBL,KAAKsB,IAAI,CAACP,YAAY,iBAAiBT;QAC3DF,kBAAkBW,YAAY;QAC9BX,kBAAkBW,YAAY;KAC/B;IAEH,MAAMQ,qCAAqCd;IAE3C,kDAAkD;IAClD,IAAI,CAACQ,wBAAwB;QAC3BJ,OAAOW,KAAK,CAAC,gDAAgD;YAACC,MAAM;QAAC;QACrE,OAAO;YAACR,wBAAwB;QAAE;IACpC;IAEA,wFAAwF;IACxF,sFAAsF;IACtF,6DAA6D;IAC7D,MAAMS,kCACJR,sBAAsBS,YAAY,CAAC,oBAAoB,IACvDT,sBAAsBU,eAAe,CAAC,oBAAoB;IAE5D,IAAI,CAACF,iCAAiC;QACpCb,OAAOW,KAAK,CACVvB,OAAO,CAAC;;;IAGV,CAAC,EACC;YAACwB,MAAM;QAAC;QAEV,OAAO;YAACR;QAAsB;IAChC;IAEA,mFAAmF;IACnF,IAAIY,qCAAoD;IACxD,IAAI;QACFA,qCAAqC3B,OAAO4B,UAAU,CAACJ;IACzD,EAAE,OAAM;IACN,2EAA2E;IAC7E;IAEA,IAAI,CAACG,oCAAoC;QACvChB,OAAOW,KAAK,CACVvB,OAAO,CAAC;;QAEN,EAAEyB,gCAAgC;IACtC,CAAC,EACC;YAACD,MAAM;QAAC;QAEV,OAAO;YAACR;QAAsB;IAChC;IAEA,mFAAmF;IACnF,6EAA6E;IAC7E,EAAE;IACF,sFAAsF;IACtF,mFAAmF;IACnF,4BAA4B;IAC5B,IACEc,kBAAkBL,oCAClB,CAACxB,OAAO8B,SAAS,CAACH,oCAAoCN,qCACtD;QACAV,OAAOoB,IAAI,CAAChC,OAAO,CAAC;6CACqB,EAAEyB,gCAAgC;6DAClB,EAAEH,mCAAmC;;IAE9F,CAAC;IACH;IAEA,qEAAqE;IACrE,IAAI,CAACJ,kCAAkC;QACrCN,OAAOW,KAAK,CACVvB,OAAO,CAAC;;;IAGV,CAAC,EACC;YAACwB,MAAM;QAAC;QAEV,OAAO;YAACR;QAAsB;IAChC;IAEA,sFAAsF;IACtF,iFAAiF;IACjF,IAAI,CAACf,OAAO8B,SAAS,CAACb,kCAAkCI,qCAAqC;QAC3FV,OAAOoB,IAAI,CAAChC,OAAO,CAAC;8CACsB,EAAEkB,iCAAiC;6DACpB,EAAEI,mCAAmC;;IAE9F,CAAC;IACH;IAEA,OAAO;QAACN;IAAsB;AAChC;AAEA,SAASc,kBAAkBG,KAAa;IACtC,OAAO,8BAA8BC,IAAI,CAACD;AAC5C"}