@sanity/pkg-utils 5.1.0 → 5.1.1

package/dist/index.js

@@ -142,10 +142,6 @@ async function loadPkg(options2) {
   const buf = await fs.readFile(pkgPath), raw = JSON.parse(buf.toString());
   return validatePkg(raw), raw;
 }
-function assertFirst(a, arr) {
-  const aIdx = arr.indexOf(a);
-  return aIdx === -1 ? !0 : aIdx === 0;
-}
 function assertLast(a, arr) {
   const aIdx = arr.indexOf(a);
   return aIdx === -1 ? !0 : aIdx === arr.length - 1;
@@ -165,7 +161,9 @@ async function loadPkgWithReporting(options2) {
         if (typeof exp == "string" || "svelte" in exp)
           continue;
         const keys = Object.keys(exp);
-        assertFirst("types", keys) || (shouldError = !0, logger.error(`exports["${expPath}"]: the \`types\` property should be the first property`)), exp.module && (shouldError = !0, logger.error(
+        exp.types && (shouldError = !0, logger.error(
+          `exports["${expPath}"]: the \`types\` condition shouldn't be used as dts files are generated in such a way that both CJS and ESM is supported`
+        )), exp.module && (shouldError = !0, logger.error(
           `exports["${expPath}"]: the \`module\` condition shouldn't be used as it's not well supported in all bundlers.`
         )), exp.node ? (exp.import && exp.node.import && !assertOrder("node", "import", keys) && (shouldError = !0, logger.error(
           `exports["${expPath}"]: the \`node\` property should come before the \`import\` property`
@@ -222,7 +220,6 @@ function parseExports(options2) {
   const { extMap, pkg, strict } = options2, rootExport = {
     _exported: !0,
     _path: ".",
-    types: pkg.types,
     source: pkg.source || "",
     browser: pkg.browser && {
       source: pkg.source || "",
@@ -233,7 +230,9 @@ function parseExports(options2) {
     import: pkg.module,
     default: pkg.module || pkg.main || ""
   }, extraExports = [], errors = [];
-  if (pkg.exports) {
+  if (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 && "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.');
     for (const [exportPath, exportEntry] of Object.entries(pkg.exports))
       if (exportPath.endsWith(".json"))
@@ -245,8 +244,6 @@ function parseExports(options2) {
               '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.types && rootExport.types && exportEntry.types !== rootExport.types && errors.push(
-              'package.json: mismatch between "types" and "exports.types". 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);
@@ -491,6 +488,25 @@ 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 })
@@ -511,13 +527,33 @@ function resolveBuildTasks(ctx) {
   }
   for (const exp of exports) {
     const importId = path$1.join(pkg.name, exp._path);
-    exp.types && dtsTask2.entries.push({
+    exp.source?.endsWith(".ts") && dtsTask2.entries.push({
       importId,
       exportPath: exp._path,
       sourcePath: exp.source,
-      targetPath: exp.types
+      targetPaths: getTargetPaths(pkg.type, exp)
+    }), exp.browser?.source?.endsWith(".ts") && dtsTask2.entries.push({
+      importId,
+      exportPath: exp._path,
+      sourcePath: exp.browser.source,
+      targetPaths: getTargetPaths(pkg.type, exp.browser)
+    }), exp.node?.source?.endsWith(".ts") && dtsTask2.entries.push({
+      importId,
+      exportPath: exp._path,
+      sourcePath: exp.node.source,
+      targetPaths: getTargetPaths(pkg.type, exp.node)
     });
   }
+  for (const bundle of bundles)
+    if (bundle.source?.endsWith(".ts")) {
+      const exportPath = (bundle.import || bundle.require).replace(/\.[mc]?js$/, ""), importId = path$1.join(pkg.name, exportPath);
+      dtsTask2.entries.push({
+        importId,
+        exportPath,
+        sourcePath: bundle.source,
+        targetPaths: getTargetPaths(pkg.type, bundle)
+      });
+    }
   if (dtsTask2.entries.length && tasks.push(dtsTask2), !ctx.emitDeclarationOnly) {
     for (const exp of exports) {
       const output = exp.require;
@@ -20180,7 +20216,7 @@ async function extractTypes(options2) {
     distPath,
     exportPath,
     files,
-    filePath,
+    filePaths,
     projectPath,
     rules,
     sourceTypesPath,
@@ -20189,7 +20225,7 @@ async function extractTypes(options2) {
     tsconfigPath
   } = options2, tsdocConfigFile = await createTSDocConfig({
     customTags: customTags || []
-  }), extractorConfig = ExtractorConfig.prepare({
+  }), filePath = filePaths[0].replace(/\.d\.[mc]ts$/, ".d.ts"), shouldCleanUpDts = !filePaths.includes(filePath), extractorConfig = ExtractorConfig.prepare({
     configObject: createApiExtractorConfig({
       bundledPackages,
       distPath,
@@ -20220,17 +20256,18 @@ async function extractTypes(options2) {
     tsOutDir: tmpPath
   }), code = [typesBuf.toString(), ...moduleBlocks].join(`
 
-`);
-  return await fs.writeFile(
-    typesPath,
-    await prettier.format(code, {
-      ...prettierConfig,
-      filepath: typesPath
-    })
-  ), files.push({
-    type: "types",
-    path: typesPath
-  }), { extractorResult, messages };
+`), prettyCode = await prettier.format(code, {
+    ...prettierConfig,
+    filepath: typesPath
+  });
+  for (const expFilePath of filePaths) {
+    const expTypesPath = path$1.resolve(distPath, expFilePath);
+    await fs.writeFile(expTypesPath, prettyCode), files.push({
+      type: "types",
+      path: expTypesPath
+    });
+  }
+  return shouldCleanUpDts && await fs.unlink(typesPath), { extractorResult, messages };
 }
 async function doExtract(ctx, task) {
   const { config: config2, cwd, files, logger, strict, ts: ts2 } = ctx;
@@ -20246,14 +20283,14 @@ async function doExtract(ctx, task) {
     const exportPath = entry.exportPath === "." ? "./index" : entry.exportPath, sourceTypesPath = path$1.resolve(
       tmpPath,
       path$1.relative(rootDir, path$1.resolve(cwd, entry.sourcePath)).replace(/\.ts$/, ".d.ts")
-    ), targetPath = path$1.resolve(cwd, entry.targetPath), filePath = path$1.relative(outDir, targetPath), result = await extractTypes({
+    ), targetPaths = entry.targetPaths.map((targetPath) => path$1.resolve(cwd, targetPath)), filePaths = targetPaths.map((targetPath) => path$1.relative(outDir, targetPath)), result = await extractTypes({
       bundledPackages: config2?.extract?.bundledPackages || [],
       customTags: config2?.extract?.customTags,
       cwd,
       distPath: outDir,
       exportPath,
       files,
-      filePath,
+      filePaths,
       projectPath: cwd,
       rules: config2?.extract?.rules,
       sourceTypesPath,
@@ -20265,7 +20302,7 @@ async function doExtract(ctx, task) {
     const errors = result.messages.filter((msg) => msg.logLevel === "error");
     if (errors.length > 0)
       throw await rimraf(tmpPath), new DtsError(`encountered ${errors.length} errors when extracting types`, errors);
-    results.push({ sourcePath: path$1.resolve(cwd, entry.sourcePath), filePath: targetPath });
+    results.push({ sourcePath: path$1.resolve(cwd, entry.sourcePath), filePaths: targetPaths });
   }
   return await rimraf(tmpPath), { type: "dts", messages, results };
 }
@@ -20273,12 +20310,11 @@ const dtsTask = {
   name: (_ctx, task) => [
     "Build type definitions...",
     "  entries:",
-    ...task.entries.map(
-      (entry) => [
-        `    - ${chalk.cyan(entry.importId)}: `,
-        `${chalk.yellow(entry.sourcePath)} ${chalk.gray("\u2192")} ${chalk.yellow(entry.targetPath)}`
-      ].join("")
-    )
+    ...task.entries.map((entry) => entry.targetPaths.map((targetPath) => [
+      `    - ${chalk.cyan(entry.importId)}: `,
+      `${chalk.yellow(entry.sourcePath)} ${chalk.gray("\u2192")} ${chalk.yellow(targetPath)}`
+    ].join("")).join(`
+`))
   ].join(`
 `),
   exec: (ctx, task) => new Observable((observer) => {
@@ -20298,9 +20334,10 @@ const dtsTask = {
 }, dtsWatchTask = {
   name: (_ctx, task) => [
     "build type definitions",
-    ...task.entries.map(
-      (entry) => `       ${chalk.blue(entry.importId)}: ${entry.sourcePath} -> ${entry.targetPath}`
-    )
+    ...task.entries.map((entry) => entry.targetPaths.map((targetPath) => [
+      `    - ${chalk.cyan(entry.importId)}: `,
+      `${chalk.yellow(entry.sourcePath)} ${chalk.gray("\u2192")} ${chalk.yellow(targetPath)}`
+    ].join("")))
   ].join(`
 `),
   exec: (ctx, task) => new Observable((observer) => {
@@ -20615,7 +20652,6 @@ function printPackageTree(ctx) {
   tree.exports = Object.fromEntries(
     Object.entries(exports).filter(([, entry]) => entry._exported).map(([exportPath, entry]) => {
       const exp = {
-        types: void 0,
         source: fileInfo(entry.source),
         browser: void 0,
         require: void 0,
@@ -20623,7 +20659,7 @@ function printPackageTree(ctx) {
         import: void 0,
         default: fileInfo(entry.default)
       };
-      return entry.types ? exp.types = fileInfo(entry.types) : delete exp.types, entry.browser ? (exp.browser = { source: fileInfo(entry.browser.source) }, entry.browser.import && (exp.browser.import = fileInfo(entry.browser.import)), entry.browser.require && (exp.browser.require = fileInfo(entry.browser.require))) : delete exp.browser, entry.require ? exp.require = fileInfo(entry.require) : delete exp.require, entry.node ? (exp.node = {}, entry.node.source && (exp.node.source = fileInfo(entry.node.source)), entry.node.import && (exp.node.import = fileInfo(entry.node.import)), entry.node.require && (exp.node.require = fileInfo(entry.node.require))) : delete exp.node, entry.import ? exp.import = fileInfo(entry.import) : delete exp.import, [chalk.cyan(path$1.join(pkg.name, exportPath)), exp];
+      return entry.browser ? (exp.browser = { source: fileInfo(entry.browser.source) }, entry.browser.import && (exp.browser.import = fileInfo(entry.browser.import)), entry.browser.require && (exp.browser.require = fileInfo(entry.browser.require))) : delete exp.browser, entry.require ? exp.require = fileInfo(entry.require) : delete exp.require, entry.node ? (exp.node = {}, entry.node.source && (exp.node.source = fileInfo(entry.node.source)), entry.node.import && (exp.node.import = fileInfo(entry.node.import)), entry.node.require && (exp.node.require = fileInfo(entry.node.require))) : delete exp.node, entry.import ? exp.import = fileInfo(entry.import) : delete exp.import, [chalk.cyan(path$1.join(pkg.name, exportPath)), exp];
     })
   ), logger.log(treeify.asTree(tree, !0, !0));
 }
@@ -20632,8 +20668,8 @@ async function check(options2) {
   if (printPackageTree(ctx), strict) {
     const missingFiles = [];
     for (const [, exp] of Object.entries(ctx.exports || {}))
-      exp.source && !fileExists(path$1.resolve(cwd, exp.source)) && missingFiles.push(exp.source), exp.require && !fileExists(path$1.resolve(cwd, exp.require)) && missingFiles.push(exp.require), exp.import && !fileExists(path$1.resolve(cwd, exp.import)) && missingFiles.push(exp.import), exp.types && !fileExists(path$1.resolve(cwd, exp.types)) && missingFiles.push(exp.types);
-    missingFiles.length && (logger.error("missing files"), process.exit(1));
+      exp.source && !fileExists(path$1.resolve(cwd, exp.source)) && missingFiles.push(exp.source), exp.require && !fileExists(path$1.resolve(cwd, exp.require)) && missingFiles.push(exp.require), exp.import && !fileExists(path$1.resolve(cwd, exp.import)) && missingFiles.push(exp.import);
+    ctx.pkg.types && !fileExists(path$1.resolve(cwd, ctx.pkg.types)) && missingFiles.push(ctx.pkg.types), missingFiles.length && (logger.error(`missing files: ${missingFiles.join(", ")}`), process.exit(1));
     const exportPaths = {
       require: [],
       import: []
@@ -20899,9 +20935,7 @@ const RE_NAME = /^(?:@(?:[a-z0-9-*~][a-z0-9-*._~]*)\/)?[a-z0-9-~][a-z0-9-._~]*$/
       }, pkgJson.bugs = {
         url: `https://${repo.source}/${repo.owner}/${repo.name}/issues`
       }, pkgJson.homepage = `https://${repo.source}/${repo.owner}/${repo.name}#readme`), features.typescript) {
-        pkgJson.types = "./dist/index.d.ts";
-        const mainExport = pkgJson.exports?.["."];
-        isRecord(mainExport) && (mainExport.types = "./dist/index.d.ts"), pkgJson.scripts = {
+        pkgJson.types = "./dist/index.d.ts", pkgJson.scripts = {
           ...pkgJson.scripts,
           "ts:check": "tsc --build"
         };
@@ -21213,11 +21247,21 @@ function resolveWatchTasks(ctx) {
   }
   for (const exp of exports) {
     const importId = path$1.join(pkg.name, exp._path);
-    exp.types && dtsTask2.entries.push({
+    exp.source?.endsWith(".ts") && dtsTask2.entries.push({
       importId,
       exportPath: exp._path,
       sourcePath: exp.source,
-      targetPath: exp.types
+      targetPaths: getTargetPaths(pkg.type, exp)
+    }), exp.browser?.source?.endsWith(".ts") && dtsTask2.entries.push({
+      importId,
+      exportPath: exp._path,
+      sourcePath: exp.browser.source,
+      targetPaths: getTargetPaths(pkg.type, exp.browser)
+    }), exp.node?.source?.endsWith(".ts") && dtsTask2.entries.push({
+      importId,
+      exportPath: exp._path,
+      sourcePath: exp.node.source,
+      targetPaths: getTargetPaths(pkg.type, exp.node)
     });
   }
   for (const exp of exports) {