@sanity/pkg-utils 5.1.2 → 5.1.3-canary.0

package/dist/index.js

@@ -208,6 +208,25 @@ async function loadPkgWithReporting(options2) {
 function formatPath(segments) {
   return segments.map((s, idx) => idx === 0 ? s : typeof s == "number" ? `[${s}]` : s.startsWith(".") ? `["${s}"]` : `.${s}`).join("");
 }
+const fileEnding = /\.[mc]?js$/, dtsEnding = ".d.ts", legacyEnding = ".esm.js", mtsEnding = ".d.mts", ctsEnding = ".d.cts";
+function getTargetPaths(_type, expOrBundle) {
+  const type = _type === "module" ? "module" : "commonjs", set = /* @__PURE__ */ new Set();
+  return expOrBundle?.import && set.add(expOrBundle.import.replace(fileEnding, type === "module" ? dtsEnding : mtsEnding)), expOrBundle?.require && set.add(expOrBundle.require.replace(fileEnding, type === "commonjs" ? dtsEnding : ctsEnding)), isPkgExport(expOrBundle) && (expOrBundle.browser?.source || (expOrBundle.browser?.import && set.add(
+    expOrBundle.browser.import.replace(fileEnding, type === "module" ? dtsEnding : mtsEnding)
+  ), expOrBundle.browser?.require && set.add(
+    expOrBundle.browser.require.replace(
+      fileEnding,
+      type === "commonjs" ? dtsEnding : ctsEnding
+    )
+  )), expOrBundle.node?.source || (expOrBundle.node?.import && set.add(
+    expOrBundle.node.import.replace(fileEnding, type === "module" ? dtsEnding : mtsEnding)
+  ), expOrBundle.node?.require && set.add(
+    expOrBundle.node.require.replace(fileEnding, type === "commonjs" ? dtsEnding : ctsEnding)
+  ))), Array.from(set);
+}
+function isPkgExport(exp) {
+  return exp?.browser || exp?.node || exp?.default;
+}
 function validateExports(_exports, options2) {
   const { extMap, pkg } = options2, ext = extMap[pkg.type || "commonjs"], errors = [];
   for (const exp of _exports)
@@ -219,7 +238,7 @@ function validateExports(_exports, options2) {
   return errors;
 }
 function parseExports(options2) {
-  const { extMap, pkg, strict } = options2, rootExport = {
+  const { extMap, pkg, strict, legacyExports } = options2, rootExport = {
     _exported: !0,
     _path: ".",
     source: pkg.source || "",
@@ -232,24 +251,31 @@ function parseExports(options2) {
     import: pkg.module,
     default: pkg.module || pkg.main || ""
   }, extraExports = [], errors = [];
-  if (strict && !pkg.types && pkg.source?.endsWith(".ts") && pkg.exports && errors.push(
-    "package.json: `types` must be declared for the npm listing to show as a TypeScript module."
-  ), strict && "typings" in pkg && errors.push("package.json: `typings` should be `types`"), pkg.exports) {
-    strict && !pkg.exports["./package.json"] && errors.push('package.json: `exports["./package.json"] must be declared.');
+  if (strict && "typings" in pkg && errors.push("package.json: `typings` should be `types`"), pkg.exports) {
+    strict && !pkg.types && pkg.source?.endsWith(".ts") && errors.push(
+      "package.json: `types` must be declared for the npm listing to show as a TypeScript module."
+    ), strict && !pkg.exports["./package.json"] && errors.push('package.json: `exports["./package.json"] must be declared.');
     for (const [exportPath, exportEntry] of Object.entries(pkg.exports))
       if (exportPath.endsWith(".json"))
         exportPath === "./package.json" && exportEntry !== "./package.json" && errors.push('package.json: `exports["./package.json"] must be "./package.json".');
       else if (!(isRecord(exportEntry) && "svelte" in exportEntry))
         if (isRecord(exportEntry))
-          if (exportPath === ".")
-            exportEntry.require && rootExport.require && exportEntry.require !== rootExport.require && errors.push(
+          if (exportPath === ".") {
+            if (exportEntry.require && rootExport.require && exportEntry.require !== rootExport.require && errors.push(
               'package.json: mismatch between "main" and "exports.require". These must be equal.'
-            ), exportEntry.import && rootExport.import && exportEntry.import !== rootExport.import && errors.push(
-              'package.json: mismatch between "module" and "exports.import" These must be equal.'
-            ), exportEntry.source && rootExport.source && exportEntry.source !== rootExport.source && errors.push(
+            ), legacyExports) {
+              const indexLegacyExport = (exportEntry.browser?.import || exportEntry.import || exportEntry.browser?.require || exportEntry.require || "").replace(fileEnding, legacyEnding);
+              indexLegacyExport !== rootExport.import && errors.push(
+                `package.json: "module" should be "${indexLegacyExport}" when "legacyExports" is true`
+              );
+            } else
+              exportEntry.import && rootExport.import && exportEntry.import !== rootExport.import && errors.push(
+                'package.json: mismatch between "module" and "exports.import" These must be equal.'
+              );
+            exportEntry.source && rootExport.source && exportEntry.source !== rootExport.source && errors.push(
               'package.json: mismatch between "source" and "exports.source". These must be equal.'
             ), Object.assign(rootExport, exportEntry);
-          else {
+          } else {
             const extraExport = {
               _exported: !0,
               _path: exportPath,
@@ -267,7 +293,7 @@ function parseExports(options2) {
 - `));
   return _exports;
 }
-const DEFAULT_PKG_EXT_MAP = {
+const pkgExtMap = {
   // pkg.type: "commonjs"
   commonjs: {
     commonjs: ".js",
@@ -277,14 +303,12 @@ const DEFAULT_PKG_EXT_MAP = {
   module: {
     commonjs: ".cjs",
     esm: ".js"
-  }
+  },
+  // package.config.legacyExports: true
+  legacy: legacyEnding
 };
-function getPkgExtMap(options2) {
-  const { legacyExports } = options2, ret = { ...DEFAULT_PKG_EXT_MAP };
-  return legacyExports && (ret.commonjs = {
-    commonjs: ".js",
-    esm: ".esm.js"
-  }), ret;
+function getPkgExtMap() {
+  return pkgExtMap;
 }
 const promptsTypes = {
   string: "text"
@@ -444,7 +468,12 @@ async function resolveBuildContext(options2) {
     "*": webTarget.concat(nodeTarget),
     browser: webTarget,
     node: nodeTarget
-  }, parsedExports = parseExports({ extMap, pkg, strict }).reduce((acc, x) => {
+  }, parsedExports = parseExports({
+    extMap,
+    pkg,
+    strict,
+    legacyExports: config2?.legacyExports ?? !1
+  }).reduce((acc, x) => {
     const { _path: exportPath, ...exportEntry } = x;
     return { ...acc, [exportPath]: exportEntry };
   }, {}), exports = resolveConfigProperty(config2?.exports, parsedExports), parsedExternal = [
@@ -490,32 +519,13 @@ async function resolveBuildContext(options2) {
     }
   };
 }
-const fileEnding = /\.[mc]?js$/, dtsEnding = ".d.ts", mtsEnding = ".d.mts", ctsEnding = ".d.cts";
-function getTargetPaths(_type, expOrBundle) {
-  const type = _type === "module" ? "module" : "commonjs", set = /* @__PURE__ */ new Set();
-  return expOrBundle?.import && set.add(expOrBundle.import.replace(fileEnding, type === "module" ? dtsEnding : mtsEnding)), expOrBundle?.require && set.add(expOrBundle.require.replace(fileEnding, type === "commonjs" ? dtsEnding : ctsEnding)), isPkgExport(expOrBundle) && (expOrBundle.browser?.source || (expOrBundle.browser?.import && set.add(
-    expOrBundle.browser.import.replace(fileEnding, type === "module" ? dtsEnding : mtsEnding)
-  ), expOrBundle.browser?.require && set.add(
-    expOrBundle.browser.require.replace(
-      fileEnding,
-      type === "commonjs" ? dtsEnding : ctsEnding
-    )
-  )), expOrBundle.node?.source || (expOrBundle.node?.import && set.add(
-    expOrBundle.node.import.replace(fileEnding, type === "module" ? dtsEnding : mtsEnding)
-  ), expOrBundle.node?.require && set.add(
-    expOrBundle.node.require.replace(fileEnding, type === "commonjs" ? dtsEnding : ctsEnding)
-  ))), Array.from(set);
-}
-function isPkgExport(exp) {
-  return exp?.browser || exp?.node || exp?.default;
-}
 function resolveBuildTasks(ctx) {
   const { config: config2, cwd, pkg, target } = ctx, bundles = config2?.bundles || [], tasks = [], exports = Object.entries(ctx.exports || {}).map(
     ([_path, exp]) => ({ _path, ...exp })
   ), dtsTask2 = {
     type: "build:dts",
     entries: []
-  }, rollupTasks = {};
+  }, rollupTasks = {}, rollupLegacyTasks = {};
   function addRollupTaskEntry(format2, runtime, entry) {
     const buildId = `${format2}:${runtime}`;
     rollupTasks[buildId] ? rollupTasks[buildId].entries.push(entry) : rollupTasks[buildId] = {
@@ -527,6 +537,18 @@ function resolveBuildTasks(ctx) {
       target: target[runtime]
     };
   }
+  function addRollupLegacyTaskEntry(runtime, entry) {
+    const buildId = `esm:${runtime}`;
+    rollupLegacyTasks[buildId] ? rollupLegacyTasks[buildId].entries.push(entry) : rollupLegacyTasks[buildId] = {
+      type: "build:legacy",
+      buildId,
+      entries: [entry],
+      runtime,
+      format: "esm",
+      // @TODO set a different target here that is compatible with legacy bundlers and testing tools like brownfield jest
+      target: target[runtime]
+    };
+  }
   for (const exp of exports) {
     const importId = path$1.join(pkg.name, exp._path);
     exp.source?.endsWith(".ts") && dtsTask2.entries.push({
@@ -589,6 +611,18 @@ function resolveBuildTasks(ctx) {
         output
       });
     }
+    if (config2?.legacyExports)
+      for (const exp of exports) {
+        const runtime = exp.browser?.import || exp.browser?.require ? "browser" : ctx.runtime, output = exp.browser?.import || exp.import || exp.browser?.require || exp.require;
+        if (!output)
+          continue;
+        const legacyOutput = output.replace(fileEnding, legacyEnding);
+        addRollupLegacyTaskEntry(runtime, {
+          path: exp._path,
+          source: exp.browser?.source || exp.source,
+          output: legacyOutput
+        });
+      }
     for (const bundle of bundles) {
       const idx = bundles.indexOf(bundle);
       bundle.require && addRollupTaskEntry("commonjs", bundle.runtime || ctx.runtime, {
@@ -601,13 +635,10 @@ function resolveBuildTasks(ctx) {
         output: bundle.import
       });
     }
-    if (tasks.push(...Object.values(rollupTasks)), config2?.legacyExports) {
+    if (tasks.push(...Object.values(rollupTasks), ...Object.values(rollupLegacyTasks)), config2?.legacyExports) {
       for (const exp of exports)
         if (exp._exported && exp._path !== ".") {
-          const relativeTargetPath = (exp.browser?.import || exp.import || "").replace(
-            /\.[^/.]+$/,
-            ""
-          );
+          const relativeTargetPath = (exp.browser?.import || exp.import || exp.browser?.require || exp.require || "").replace(fileEnding, legacyEnding).replace(/\.[^/.]+$/, "");
           relativeTargetPath && fs$1.writeFileSync(
             path$1.resolve(cwd, `${exp._path}.js`),
             ["// AUTO-GENERATED \u2013 DO NOT EDIT", `export * from '${relativeTargetPath}'`, ""].join(
@@ -698,7 +729,7 @@ async function buildTypes(options2) {
     } : {}
   }, program = ts.createProgram(tsconfig.fileNames, compilerOptions), emitResult = program.emit(), allDiagnostics = ts.getPreEmitDiagnostics(program).concat(emitResult.diagnostics);
   for (const diagnostic of allDiagnostics)
-    printDiagnostic({ cwd, logger, diagnostic });
+    diagnostic.code !== 2307 && printDiagnostic({ cwd, logger, diagnostic });
   if (emitResult.emitSkipped && allDiagnostics.filter((diag) => diag.category === ts.DiagnosticCategory.Error).length && strict)
     throw new Error("failed to compile TypeScript definitions");
 }
@@ -20370,7 +20401,7 @@ function createConsoleSpy(options2) {
   };
 }
 function resolveRollupConfig(ctx, buildTask) {
-  const { format: format2, runtime, target } = buildTask, { config: config2, cwd, exports: _exports, extMap, external, distPath, logger, pkg, ts: ts2 } = ctx, outputExt = extMap[pkg.type || "commonjs"][format2], minify = config2?.minify ?? !1, outDir = path$1.relative(cwd, distPath), pathAliases = Object.fromEntries(
+  const { format: format2, runtime, target } = buildTask, { config: config2, cwd, exports: _exports, external, distPath, logger, pkg, ts: ts2 } = ctx, isLegacyExports = buildTask.type === "build:legacy", outputExt = isLegacyExports ? pkgExtMap.legacy : pkgExtMap[pkg.type || "commonjs"][format2], minify = config2?.minify ?? !1, outDir = path$1.relative(cwd, distPath), pathAliases = Object.fromEntries(
     Object.entries(ts2.config?.options.paths || {}).map(([key, val]) => [key, path$1.resolve(cwd, ts2.config?.options.baseUrl || ".", val[0])])
   ), entries = buildTask.entries.map((entry) => ({
     ...entry,
@@ -20435,6 +20466,11 @@ function resolveRollupConfig(ctx, buildTask) {
       }
     })
   ].filter(Boolean), userPlugins = config2?.rollup?.plugins, plugins = Array.isArray(userPlugins) ? defaultPlugins.concat(userPlugins) : resolveConfigProperty(config2?.rollup?.plugins, defaultPlugins);
+  if (config2?.rollup?.hashChunkFileNames === !1 && config2.legacyExports)
+    throw new TypeError(
+      "when `legacyExports: true` you can't set `rollup.hashChunkFileNames: false` \u2013 this would cause chunks to overwrite each other. Please remove the `hashChunkFileNames` option or set it to `true"
+    );
+  const hashChunkFileNames = config2?.rollup?.hashChunkFileNames ?? !1, chunkFileNames = `${isLegacyExports ? "_legacy" : hashChunkFileNames ? "_chunks" : "_chunks-[format]"}/${hashChunkFileNames ? "[name]-[hash]" : "[name]"}${outputExt}`, entryFileNames = isLegacyExports ? "[name].js" : `[name]${outputExt}`;
   return {
     inputOptions: {
       context: cwd,
@@ -20469,16 +20505,10 @@ function resolveRollupConfig(ctx, buildTask) {
       experimentalLogSideEffects: config2?.rollup?.experimentalLogSideEffects
     },
     outputOptions: {
-      chunkFileNames: () => {
-        const parts = outputExt.split("."), prefix = config2?.rollup?.hashChunkFileNames ? "[name]-[hash]" : "[name]", folder = config2?.rollup?.hashChunkFileNames ? "_chunks" : "_chunks-[format]";
-        return parts.length === 3 ? `${folder}/${prefix}.${parts[2]}` : `${folder}/${prefix}${outputExt}`;
-      },
+      chunkFileNames,
       compact: minify,
       dir: outDir,
-      entryFileNames: () => {
-        const parts = outputExt.split(".");
-        return parts.length === 3 ? `[name].${parts[2]}` : `[name]${outputExt}`;
-      },
+      entryFileNames,
       esModule: !0,
       format: format2,
       interop: "compat",
@@ -20488,6 +20518,70 @@ function resolveRollupConfig(ctx, buildTask) {
     }
   };
 }
+const rollupLegacyTask = {
+  name: (ctx, task) => {
+    const entries = task.entries.filter((e) => !e.path.includes("__$$bundle_")), targetLines = task.target.length ? ["  target:", ...task.target.map((t) => `    - ${chalk.yellow(t)}`)] : [], entriesLines = entries.length ? [
+      "  entries:",
+      ...entries.map(
+        (e) => [
+          "    - ",
+          `${chalk.cyan(path$1.join(ctx.pkg.name, e.path))}: `,
+          `${chalk.yellow(e.source)} ${chalk.gray("\u2192")} ${chalk.yellow(e.output)}`
+        ].join("")
+      )
+    ] : [];
+    return [
+      "Build legacy exports...",
+      `  format: ${chalk.yellow(task.format)}`,
+      ...targetLines,
+      ...entriesLines
+    ].join(`
+`);
+  },
+  exec: (ctx, task) => new Observable((observer) => {
+    execPromise$1(ctx, task).then((result) => {
+      observer.next(result), observer.complete();
+    }).catch((err) => observer.error(err));
+  }),
+  complete: () => {
+  },
+  error: (_ctx, _task, err) => {
+    console.error(err);
+  }
+};
+async function execPromise$1(ctx, task) {
+  const { distPath, files, logger } = ctx, outDir = path$1.relative(ctx.cwd, distPath), consoleSpy = createConsoleSpy({
+    onRestored: (messages) => {
+      for (const msg of messages) {
+        const text = String(msg.args[0]);
+        msg.code !== "CIRCULAR_DEPENDENCY" && (text.startsWith("Dynamic import can only") || text.startsWith("Sourcemap is likely to be incorrect") || (msg.type === "log" && logger.info(...msg.args), msg.type === "warn" && logger.warn(...msg.args), msg.type === "error" && logger.error(...msg.args)));
+      }
+    }
+  });
+  try {
+    const { inputOptions, outputOptions } = resolveRollupConfig(ctx, task), bundle = await rollup({
+      ...inputOptions,
+      onwarn(warning) {
+        consoleSpy.messages.push({
+          type: "warn",
+          code: warning.code,
+          args: [warning.message]
+        });
+      }
+    }), { output } = await bundle.generate(outputOptions);
+    for (const chunkOrAsset of output)
+      chunkOrAsset.type === "asset" ? files.push({
+        type: "asset",
+        path: path$1.resolve(outDir, chunkOrAsset.fileName)
+      }) : files.push({
+        type: "chunk",
+        path: path$1.resolve(outDir, chunkOrAsset.fileName)
+      });
+    await bundle.write(outputOptions), await bundle.close(), consoleSpy.restore();
+  } catch (err) {
+    throw consoleSpy.restore(), err;
+  }
+}
 const rollupTask = {
   name: (ctx, task) => {
     const bundleEntries = task.entries.filter((e) => e.path.includes("__$$bundle_")), entries = task.entries.filter((e) => !e.path.includes("__$$bundle_")), targetLines = task.target.length ? ["  target:", ...task.target.map((t) => `    - ${chalk.yellow(t)}`)] : [], bundlesLines = bundleEntries.length ? [
@@ -20600,13 +20694,14 @@ const rollupWatchTask = {
   }
 }, buildTaskHandlers = {
   "build:dts": dtsTask,
-  "build:js": rollupTask
+  "build:js": rollupTask,
+  "build:legacy": rollupLegacyTask
 }, watchTaskHandlers = {
   "watch:dts": dtsWatchTask,
   "watch:js": rollupWatchTask
 };
 async function build(options2) {
-  const { cwd, emitDeclarationOnly, strict = !1, tsconfig: tsconfigOption } = options2, logger = createLogger(), pkg = await loadPkgWithReporting({ cwd, logger, strict }), config2 = await loadConfig({ cwd }), extMap = getPkgExtMap({ legacyExports: config2?.legacyExports ?? !1 }), tsconfig = tsconfigOption || config2?.tsconfig || "tsconfig.json", ctx = await resolveBuildContext({
+  const { cwd, emitDeclarationOnly, strict = !1, tsconfig: tsconfigOption } = options2, logger = createLogger(), pkg = await loadPkgWithReporting({ cwd, logger, strict }), config2 = await loadConfig({ cwd }), extMap = getPkgExtMap(), tsconfig = tsconfigOption || config2?.tsconfig || "tsconfig.json", ctx = await resolveBuildContext({
     config: config2,
     cwd,
     emitDeclarationOnly,
@@ -20666,7 +20761,7 @@ function printPackageTree(ctx) {
   ), logger.log(treeify.asTree(tree, !0, !0));
 }
 async function check(options2) {
-  const { cwd, strict = !1, tsconfig: tsconfigOption } = options2, logger = createLogger(), pkg = await loadPkgWithReporting({ cwd, logger, strict }), config2 = await loadConfig({ cwd }), extMap = getPkgExtMap({ legacyExports: config2?.legacyExports ?? !1 }), tsconfig = tsconfigOption || config2?.tsconfig || "tsconfig.json", ctx = await resolveBuildContext({ config: config2, cwd, extMap, logger, pkg, strict, tsconfig });
+  const { cwd, strict = !1, tsconfig: tsconfigOption } = options2, logger = createLogger(), pkg = await loadPkgWithReporting({ cwd, logger, strict }), config2 = await loadConfig({ cwd }), extMap = getPkgExtMap(), tsconfig = tsconfigOption || config2?.tsconfig || "tsconfig.json", ctx = await resolveBuildContext({ config: config2, cwd, extMap, logger, pkg, strict, tsconfig });
   if (printPackageTree(ctx), strict) {
     const missingFiles = [];
     for (const [, exp] of Object.entries(ctx.exports || {}))
@@ -21358,7 +21453,7 @@ async function watch(options2) {
     switchMap(async (configFiles) => {
       if (!configFiles.map((f) => path$1.relative(cwd, f)).find((f) => f === "package.json"))
         throw new Error("missing package.json");
-      const pkg = await loadPkgWithReporting({ cwd, logger, strict }), config2 = await loadConfig({ cwd }), extMap = getPkgExtMap({ legacyExports: config2?.legacyExports ?? !1 }), tsconfig = tsconfigOption || config2?.tsconfig || "tsconfig.json";
+      const pkg = await loadPkgWithReporting({ cwd, logger, strict }), config2 = await loadConfig({ cwd }), extMap = getPkgExtMap(), tsconfig = tsconfigOption || config2?.tsconfig || "tsconfig.json";
       return resolveBuildContext({ config: config2, cwd, extMap, logger, pkg, strict, tsconfig });
     })
   ).subscribe(async (ctx) => {
@@ -21381,7 +21476,6 @@ async function watch(options2) {
 }
 export {
   DEFAULT_BROWSERSLIST_QUERY,
-  DEFAULT_PKG_EXT_MAP,
   build,
   buildTaskHandlers,
   check,
@@ -21400,8 +21494,10 @@ export {
   loadPkgWithReporting,
   loadTSConfig,
   parseExports,
+  pkgExtMap,
   resolveBuildTasks,
   resolveConfigProperty,
+  rollupLegacyTask,
   rollupTask,
   rollupWatchTask,
   watch,