@sanity/pkg-utils 6.13.4 → 7.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "6.13.4",
+  "version": "7.0.0",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -70,7 +70,7 @@
     "@babel/core": "^7.26.0",
     "@babel/preset-typescript": "^7.26.0",
     "@babel/types": "^7.26.3",
-    "@microsoft/api-extractor": "7.48.1",
+    "@microsoft/api-extractor": "7.49.0",
     "@microsoft/tsdoc-config": "0.17.1",
     "@optimize-lodash/rollup-plugin": "5.0.0",
     "@rollup/plugin-alias": "^5.1.1",
@@ -144,7 +144,7 @@
     "ts-node": "^10.9.2",
     "typescript": "5.7.3",
     "vitest": "^2.1.8",
-    "@sanity/pkg-utils": "6.13.4"
+    "@sanity/pkg-utils": "7.0.0"
   },
   "peerDependencies": {
     "babel-plugin-react-compiler": "*",

package/src/node/build.ts

@@ -46,8 +46,7 @@ export async function build(options: {
 
   const config = await loadConfig({cwd})
 
-  const legacyExports = config?.legacyExports ?? false
-  const pkg = await loadPkgWithReporting({cwd, logger, strict, legacyExports})
+  const pkg = await loadPkgWithReporting({cwd, logger, strict})
 
   const tsconfig = tsconfigOption || config?.tsconfig || 'tsconfig.json'
 

package/src/node/check.ts

@@ -19,8 +19,7 @@ export async function check(options: {
   const logger = createLogger()
 
   const config = await loadConfig({cwd})
-  const legacyExports = config?.legacyExports ?? false
-  const pkg = await loadPkgWithReporting({cwd, logger, strict, legacyExports})
+  const pkg = await loadPkgWithReporting({cwd, logger, strict})
   const tsconfig = tsconfigOption || config?.tsconfig || 'tsconfig.json'
   const ctx = await resolveBuildContext({config, cwd, logger, pkg, strict, tsconfig})
 

package/src/node/core/config/types.ts

@@ -221,7 +221,7 @@ export interface PkgConfigOptions {
       /**
        * @deprecated as it's no longer needed since TypeScript 5.5 https://github.com/microsoft/TypeScript/issues/42873
        */
-      'ae-forgotten-export'?: PkgRuleLevel
+      'ae-forgotten-export'?: never
       'ae-incompatible-release-tags'?: PkgRuleLevel
       'ae-internal-missing-underscore'?: PkgRuleLevel
       'ae-missing-release-tag'?: PkgRuleLevel
@@ -255,10 +255,9 @@ export interface PkgConfigOptions {
    */
   jsxImportSource?: string
   /**
-   * Build package with support for legacy exports (writes root `<export>.js` files)
-   * @deprecated - will be removed in the next major version
+   * @deprecated no longer supported
    */
-  legacyExports?: boolean
+  legacyExports?: never
   minify?: boolean
   /** @alpha */
   rollup?: {

package/src/node/core/pkg/loadPkgWithReporting.ts

@@ -11,23 +11,15 @@ export async function loadPkgWithReporting(options: {
   cwd: string
   logger: Logger
   strict: boolean
-  legacyExports: boolean
 }): Promise<PackageJSON> {
-  const {cwd, logger, strict, legacyExports} = options
+  const {cwd, logger, strict} = options
 
   try {
     const pkg = await loadPkg({cwd})
     let shouldError = false
 
     if (strict) {
-      if (legacyExports && pkg.type === 'commonjs') {
-        shouldError = true
-        logger.error(
-          `the \`type\` field in \`./package.json\` shouldn't be "commonjs" when \`legacyExports\` is set to true)`,
-        )
-      }
-
-      if (!legacyExports && !pkg.type) {
+      if (!pkg.type) {
         shouldError = true
         logger.error(
           `the \`type\` field in \`./package.json\` must be either "module" or "commonjs")`,

package/src/node/core/pkg/parseExports.ts

@@ -3,7 +3,7 @@ import {resolve as resolvePath} from 'node:path'
 
 import type {Logger} from '../../logger'
 import type {InferredStrictOptions} from '../../strict'
-import {defaultEnding, fileEnding, legacyEnding} from '../../tasks/dts/getTargetPaths'
+import {defaultEnding, fileEnding} from '../../tasks/dts/getTargetPaths'
 import type {PkgExport} from '../config'
 import {isRecord} from '../isRecord'
 import {pkgExtMap} from './pkgExt'
@@ -16,10 +16,9 @@ export function parseExports(options: {
   pkg: PackageJSON
   strict: boolean
   strictOptions: InferredStrictOptions
-  legacyExports: boolean
   logger: Logger
 }): (PkgExport & {_path: string})[] {
-  const {cwd, pkg, strict, strictOptions, legacyExports, logger} = options
+  const {cwd, pkg, strict, strictOptions, logger} = options
   const type = pkg.type || 'commonjs'
   const errors: string[] = []
 
@@ -72,20 +71,12 @@ export function parseExports(options: {
           browserConditions.push(
             `      "import": ${JSON.stringify(pkg.browser?.[pkg.main].replace(fileEnding, extMap.esm))}`,
           )
-        } else if (legacyExports) {
-          const browserImport = pkg.main.replace(fileEnding, `.browser${extMap.esm}`)
-
-          browserConditions.push(`      "import": ${JSON.stringify(browserImport)}`)
         }
 
         if (pkg.browser?.[pkg.main]) {
           browserConditions.push(
             `      "require": ${JSON.stringify(pkg.browser[pkg.main].replace(fileEnding, extMap.commonjs))}`,
           )
-        } else if (legacyExports) {
-          const browserRequire = pkg.main.replace(fileEnding, `.browser${extMap.commonjs}`)
-
-          browserConditions.push(`      "require": ${JSON.stringify(browserRequire)}`)
         }
 
         if (browserConditions.length) {
@@ -106,11 +97,8 @@ export function parseExports(options: {
           `    "source": ${JSON.stringify(pkg.source)},`,
           // If browser conditions are detected then add them to the suggestion
           ...(maybeBrowserCondition.length > 0 ? maybeBrowserCondition : []),
-          // If legacy exports are enabled we suggest the full list of exports, if not we can use the terse version
-          (legacyExports || type === 'commonjs') &&
-            `    "import": ${JSON.stringify(importExport)},`,
-          (legacyExports || type === 'module') &&
-            `    "require": ${JSON.stringify(requireExport)},`,
+          type === 'commonjs' && `    "import": ${JSON.stringify(importExport)},`,
+          type === 'module' && `    "require": ${JSON.stringify(requireExport)},`,
           `    "default": ${JSON.stringify(defaultExport)}`,
           `  },`,
           `  "./package.json": "./package.json"`,
@@ -142,8 +130,6 @@ export function parseExports(options: {
 
   const _exports: (PkgExport & {_path: string})[] = []
 
-  // @TODO validate typesVersions when legacyExports is true
-
   if (strict && strictOptions.noPackageJsonTypings !== 'off' && 'typings' in pkg) {
     report(strictOptions.noPackageJsonTypings, 'package.json: `typings` should be `types`')
   }
@@ -202,18 +188,6 @@ export function parseExports(options: {
         if (fallback) {
           exp.default = fallback
         }
-
-        if (legacyExports) {
-          if (fallback) {
-            errors.push(
-              `package.json - \`exports["${exp._path}"].default\` should be set to "${fallback}" when "legacyExports" is true`,
-            )
-          } else {
-            errors.push(
-              `package.json - \`exports["${exp._path}"].default\` should be specified when "legacyExports" is true`,
-            )
-          }
-        }
       }
 
       // Infer the `require` condition based on the `type` and other conditions
@@ -233,23 +207,10 @@ export function parseExports(options: {
           )
         }
 
-        if (legacyExports) {
-          const indexLegacyExport = (exportEntry.import || exportEntry.require || '').replace(
-            /(\.esm)?\.[mc]?js$/,
-            legacyEnding,
+        if (exportEntry.import && pkg.module && exportEntry.import !== pkg.module) {
+          errors.push(
+            'package.json: mismatch between "module" and "exports.import" These must be equal.',
           )
-
-          if (indexLegacyExport !== pkg.module) {
-            errors.push(
-              `package.json: "module" should be "${indexLegacyExport}" when "legacyExports" is true`,
-            )
-          }
-        } else {
-          if (exportEntry.import && pkg.module && exportEntry.import !== pkg.module) {
-            errors.push(
-              'package.json: mismatch between "module" and "exports.import" These must be equal.',
-            )
-          }
         }
       }
 

package/src/node/core/pkg/pkgExt.ts

@@ -1,10 +1,9 @@
-import {cjsEnding, defaultEnding, legacyEnding, mjsEnding} from '../../tasks/dts/getTargetPaths'
+import {cjsEnding, defaultEnding, mjsEnding} from '../../tasks/dts/getTargetPaths'
 
 /** @internal */
 export interface PkgExtMap {
   commonjs: {commonjs: string; esm: string}
   module: {commonjs: string; esm: string}
-  legacy: string
 }
 
 /** @internal */
@@ -20,6 +19,4 @@ export const pkgExtMap = {
     commonjs: cjsEnding,
     esm: defaultEnding,
   },
-  // package.config.legacyExports: true
-  legacy: legacyEnding,
 } satisfies PkgExtMap

package/src/node/core/pkg/validateExports.ts

@@ -12,7 +12,6 @@ export function validateExports(
 
   const errors: string[] = []
 
-  // @TODO validate that no exports declare the legacy exports
   for (const exp of _exports) {
     if (exp.require && !exp.require.endsWith(ext.commonjs)) {
       errors.push(

package/src/node/resolveBuildContext.ts

@@ -96,7 +96,6 @@ export async function resolveBuildContext(options: {
     cwd,
     pkg,
     strict,
-    legacyExports: config?.legacyExports ?? false,
     strictOptions,
     logger,
   }).reduce<PkgExports>((acc, x) => {

package/src/node/resolveBuildTasks.ts

@@ -1,13 +1,12 @@
-import fs from 'node:fs'
 import path from 'node:path'
 
 import type {BuildContext, PkgExport, PkgFormat, PkgRuntime} from './core'
-import type {BuildTask, DtsTask, RollupLegacyTask, RollupTask, RollupTaskEntry} from './tasks'
-import {fileEnding, getTargetPaths, legacyEnding} from './tasks/dts/getTargetPaths'
+import type {BuildTask, DtsTask, RollupTask, RollupTaskEntry} from './tasks'
+import {getTargetPaths} from './tasks/dts/getTargetPaths'
 
 /** @internal */
 export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
-  const {config, cwd, pkg, target} = ctx
+  const {config, pkg, target} = ctx
 
   const bundles = config?.bundles || []
 
@@ -23,7 +22,6 @@ export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
   }
 
   const rollupTasks: Record<string, RollupTask> = {}
-  const rollupLegacyTasks: Record<string, RollupLegacyTask> = {}
 
   function addRollupTaskEntry(format: PkgFormat, runtime: PkgRuntime, entry: RollupTaskEntry) {
     const buildId = `${format}:${runtime}`
@@ -42,24 +40,6 @@ export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
     }
   }
 
-  function addRollupLegacyTaskEntry(runtime: PkgRuntime, entry: RollupTaskEntry) {
-    const buildId = `esm:${runtime}`
-
-    if (rollupLegacyTasks[buildId]) {
-      rollupLegacyTasks[buildId].entries.push(entry)
-    } else {
-      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],
-      }
-    }
-  }
-
   // Parse `dts` tasks
   for (const exp of exports) {
     const importId = path.join(pkg.name, exp._path)
@@ -168,25 +148,6 @@ export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
       })
     }
 
-    // Create rollup bundles that legacy export files will re-export
-    if (config?.legacyExports) {
-      for (const exp of exports) {
-        const runtime = exp.browser?.import ? 'browser' : ctx.runtime
-        const output = exp.browser?.import || exp.import
-
-        if (!output) continue
-
-        // Change the suffix to what the legacy exports will use
-        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)
 
@@ -207,26 +168,7 @@ export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
       }
     }
 
-    tasks.push(...Object.values(rollupTasks), ...Object.values(rollupLegacyTasks))
-
-    // Write legacy exports files
-    if (config?.legacyExports) {
-      for (const exp of exports) {
-        if (exp._exported && exp._path !== '.') {
-          const output = (exp.browser?.import || exp.import || '').replace(fileEnding, legacyEnding)
-          const relativeTargetPath = output.replace(/\.[^/.]+$/, '')
-
-          if (relativeTargetPath) {
-            fs.writeFileSync(
-              path.resolve(cwd, `${exp._path}.js`),
-              ['// AUTO-GENERATED – DO NOT EDIT', `export * from '${relativeTargetPath}'`, ''].join(
-                '\n',
-              ),
-            )
-          }
-        }
-      }
-    }
+    tasks.push(...Object.values(rollupTasks))
   }
 
   return tasks

package/src/node/resolveWatchTasks.ts

@@ -1,4 +1,3 @@
-import fs from 'node:fs'
 import path from 'node:path'
 
 import type {BuildContext, PkgExport, PkgFormat, PkgRuntime} from './core'
@@ -7,7 +6,7 @@ import {getTargetPaths} from './tasks/dts/getTargetPaths'
 
 /** @internal */
 export function resolveWatchTasks(ctx: BuildContext): WatchTask[] {
-  const {config, cwd, pkg, target} = ctx
+  const {pkg, target} = ctx
   const tasks: WatchTask[] = []
 
   const exports = Object.entries(ctx.exports || {}).map(
@@ -128,26 +127,5 @@ export function resolveWatchTasks(ctx: BuildContext): WatchTask[] {
 
   tasks.push(...Object.values(rollupTasks))
 
-  // Write legacy exports files
-  if (config?.legacyExports) {
-    for (const exp of exports) {
-      if (exp._exported && exp._path !== '.') {
-        const relativeTargetPath = (exp.browser?.import || exp.import || '').replace(
-          /\.[^/.]+$/,
-          '',
-        )
-
-        if (relativeTargetPath) {
-          fs.writeFileSync(
-            path.resolve(cwd, `${exp._path}.js`),
-            [`// AUTO-GENERATED – DO NOT EDIT`, `export * from '${relativeTargetPath}'`, ``].join(
-              '\n',
-            ),
-          )
-        }
-      }
-    }
-  }
-
   return tasks
 }

package/src/node/tasks/dts/createApiExtractorConfig.ts

@@ -26,34 +26,6 @@ export function createApiExtractorConfig(options: {
     tsconfigPath,
   } = options
 
-  // When the module is 'preserve' it's necessary to override the tsconfig file as api-extractor doesn't handle it out of the box
-  const workaroundModulePreserve = tsconfig.options.module === ts.ModuleKind.Preserve
-  // If `paths` are used for self-referencing imports (e.g. the module is named `sanity`, and the `sanity/structure` export is also importing from `sanity/router`),
-  const workaroundPaths = !!tsconfig.options.paths
-
-  const overrideTsconfig = {
-    extends: tsconfigPath,
-    compilerOptions: {},
-  }
-
-  if (workaroundModulePreserve) {
-    Object.assign(overrideTsconfig.compilerOptions, {
-      // Set the equivalent options to `module: 'Preserve'`
-      // https://github.com/microsoft/TypeScript/pull/56785/files?file-filters%5B%5D=.js&file-filters%5B%5D=.json&file-filters%5B%5D=.symbols&file-filters%5B%5D=.ts&file-filters%5B%5D=.types&show-viewed-files=true#diff-31d3c12bafea26bc9e8c8a77920c41af0c593206442add70c45a06c063767445
-      module: 'ESNext',
-      moduleResolution: 'Bundler',
-      esModuleInterop: true,
-      resolveJsonModule: true,
-    })
-  }
-
-  if (workaroundPaths) {
-    Object.assign(overrideTsconfig.compilerOptions, {
-      // An empty object replaces whatever is in the original tsconfig file
-      paths: {},
-    })
-  }
-
   return {
     apiReport: {
       enabled: false,
@@ -61,10 +33,18 @@ export function createApiExtractorConfig(options: {
     },
     bundledPackages,
 
-    compiler:
-      workaroundModulePreserve || workaroundPaths
-        ? {overrideTsconfig}
-        : {tsconfigFilePath: tsconfigPath},
+    // If `paths` are used for self-referencing imports (e.g. the module is named `sanity`, and the `sanity/structure` export is also importing from `sanity/router`),
+    compiler: tsconfig.options.paths
+      ? {
+          overrideTsconfig: {
+            extends: tsconfigPath,
+            compilerOptions: {
+              // An empty object replaces whatever is in the original tsconfig file
+              paths: {},
+            },
+          },
+        }
+      : {tsconfigFilePath: tsconfigPath},
 
     docModel: {
       enabled: false,

package/src/node/tasks/dts/getExtractMessagesConfig.ts

@@ -38,7 +38,11 @@ export function getExtractMessagesConfig(options: {
       },
 
       'ae-forgotten-export': {
-        logLevel: ruleToLogLevel('ae-forgotten-export', 'none' as ExtractorLogLevel),
+        /**
+         * This is hardcoded to `none` as it's no longer needed since TypeScript 5.5 https://github.com/microsoft/TypeScript/issues/42873
+         * It's hardcoded to `none` since supported by API Extractor when using `module: 'Preserve'` doesn't support it well since `@microsoft/api-extractor` v7.49.0, which upgraded from TS 5.4 to 5.7 internally
+         */
+        logLevel: 'none' as ExtractorLogLevel,
         addToApiReportFile: false,
       },
 

package/src/node/tasks/dts/getTargetPaths.ts

@@ -7,8 +7,6 @@ export const dtsEnding = '.d.ts' as const
 /** @internal */
 export const defaultEnding = '.js' as const
 /** @internal */
-export const legacyEnding = `.esm${defaultEnding}` as const
-/** @internal */
 export const mjsEnding = '.mjs' as const
 /** @internal */
 export const cjsEnding = '.cjs' as const

package/src/node/tasks/index.ts

@@ -1,5 +1,5 @@
 import {dtsTask, dtsWatchTask} from './dts'
-import {rollupLegacyTask, rollupTask, rollupWatchTask} from './rollup'
+import {rollupTask, rollupWatchTask} from './rollup'
 import type {BuildTaskHandlers, WatchTaskHandlers} from './types'
 
 export * from './dts'
@@ -10,7 +10,6 @@ export * from './types'
 export const buildTaskHandlers: BuildTaskHandlers = {
   'build:dts': dtsTask,
   'build:js': rollupTask,
-  'build:legacy': rollupLegacyTask,
 }
 
 /** @internal */

package/src/node/tasks/rollup/index.ts

@@ -1,3 +1,2 @@
-export * from './rollupLegacyTask'
 export * from './rollupTask'
 export * from './rollupWatchTask'

package/src/node/tasks/rollup/resolveRollupConfig.ts

@@ -14,7 +14,7 @@ import esbuild from 'rollup-plugin-esbuild'
 
 import {pkgExtMap as extMap} from '../../../node/core/pkg/pkgExt'
 import {type BuildContext, type PackageJSON, resolveConfigProperty} from '../../core'
-import type {RollupLegacyTask, RollupTask, RollupWatchTask} from '../types'
+import type {RollupTask, RollupWatchTask} from '../types'
 
 export interface RollupConfig {
   inputOptions: InputOptions
@@ -24,12 +24,11 @@ export interface RollupConfig {
 /** @internal */
 export function resolveRollupConfig(
   ctx: BuildContext,
-  buildTask: RollupTask | RollupLegacyTask | RollupWatchTask,
+  buildTask: RollupTask | RollupWatchTask,
 ): RollupConfig {
   const {format, runtime, target} = buildTask
   const {config, cwd, exports: _exports, external, distPath, logger, pkg, ts} = ctx
-  const isLegacyExports = buildTask.type === 'build:legacy'
-  const outputExt = isLegacyExports ? extMap.legacy : extMap[pkg.type || 'commonjs'][format]
+  const outputExt = extMap[pkg.type || 'commonjs'][format]
   const minify = config?.minify ?? false
   const outDir = path.relative(cwd, distPath)
 
@@ -180,13 +179,9 @@ export function resolveRollupConfig(
     : resolveConfigProperty(config?.rollup?.plugins, defaultPlugins)
 
   const hashChunkFileNames = config?.rollup?.hashChunkFileNames ?? false
-  const chunksFolder = isLegacyExports
-    ? '_legacy'
-    : hashChunkFileNames
-      ? '_chunks'
-      : '_chunks-[format]'
+  const chunksFolder = hashChunkFileNames ? '_chunks' : '_chunks-[format]'
   const chunkFileNames = `${chunksFolder}/${hashChunkFileNames ? '[name]-[hash]' : '[name]'}${outputExt}`
-  const entryFileNames = isLegacyExports ? '[name].js' : `[name]${outputExt}`
+  const entryFileNames = `[name]${outputExt}`
 
   return {
     inputOptions: {

package/src/node/tasks/types.ts

@@ -21,16 +21,6 @@ export interface RollupTask {
   target: string[]
 }
 
-/** @internal */
-export interface RollupLegacyTask {
-  type: 'build:legacy'
-  buildId: string
-  entries: RollupTaskEntry[]
-  runtime: PkgRuntime
-  format: 'esm'
-  target: string[]
-}
-
 /** @internal */
 export interface RollupWatchTask {
   type: 'watch:js'
@@ -42,7 +32,7 @@ export interface RollupWatchTask {
 }
 
 /** @internal */
-export type BuildTask = DtsTask | RollupTask | RollupLegacyTask
+export type BuildTask = DtsTask | RollupTask
 
 /** @internal */
 export type WatchTask = DtsWatchTask | RollupWatchTask
@@ -59,7 +49,6 @@ export type TaskHandler<Task, Result = void> = {
 export interface BuildTaskHandlers {
   'build:dts': TaskHandler<DtsTask, DtsResult>
   'build:js': TaskHandler<RollupTask>
-  'build:legacy': TaskHandler<RollupLegacyTask>
 }
 
 /** @internal */

package/src/node/watch.ts

@@ -32,8 +32,7 @@ export async function watch(options: {
       }
 
       const config = await loadConfig({cwd})
-      const legacyExports = config?.legacyExports ?? false
-      const pkg = await loadPkgWithReporting({cwd, logger, strict, legacyExports})
+      const pkg = await loadPkgWithReporting({cwd, logger, strict})
       const tsconfig = tsconfigOption || config?.tsconfig || 'tsconfig.json'
 
       return resolveBuildContext({config, cwd, logger, pkg, strict, tsconfig})