@sanity/pkg-utils 1.7.2 → 1.8.0

package/dist/{index.d.ts → types/src/node/index.d.ts}

@@ -68,15 +68,21 @@ export declare function defineConfig(configOptions: PkgConfigOptions): PkgConfig
 export declare interface _DtsResult {
   type: 'dts'
   messages: ExtractorMessage[]
+  results: {
+    sourcePath: string
+    filePath: string
+  }[]
 }
 
 /** @internal */
 export declare interface _DtsTask {
   type: 'build:dts'
-  exportPath: string
-  importId: string
-  sourcePath: string
-  targetPath: string
+  entries: {
+    exportPath: string
+    importId: string
+    sourcePath: string
+    targetPath: string
+  }[]
 }
 
 /** @internal */
@@ -85,10 +91,12 @@ export declare const _dtsTask: _TaskHandler<_DtsTask, _DtsResult>
 /** @internal */
 export declare interface _DtsWatchTask {
   type: 'watch:dts'
-  exportPath: string
-  importId: string
-  sourcePath: string
-  targetPath: string
+  entries: {
+    exportPath: string
+    importId: string
+    sourcePath: string
+    targetPath: string
+  }[]
 }
 
 /** @internal */
@@ -114,7 +122,7 @@ export declare function _loadTSConfig(options: {
 
 /** @internal */
 export declare interface _PackageJSON {
-  type?: 'module'
+  type: 'commonjs' | 'module'
   version: string
   private?: boolean
   name: string
@@ -128,6 +136,12 @@ export declare interface _PackageJSON {
       source: string
       types?: string
       browser?: {
+        source: string
+        require?: string
+        import?: string
+      }
+      node?: {
+        source: string
         require?: string
         import?: string
       }
@@ -138,7 +152,7 @@ export declare interface _PackageJSON {
   >
   main?: string
   browser?: Record<string, string>
-  source: string
+  source?: string
   module?: string
   types?: string
   browserslist?: string[]

package/package.json

@@ -1,6 +1,7 @@
 {
+  "type": "module",
   "name": "@sanity/pkg-utils",
-  "version": "1.7.2",
+  "version": "1.8.0",
   "author": "Sanity.io <hello@sanity.io>",
   "license": "MIT",
   "description": "Simple utilities for modern npm packages.",
@@ -16,10 +17,10 @@
   "source": "./src/node/index.ts",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/types/src/node/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/types/src/node/index.d.ts",
       "source": "./src/node/index.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs",
@@ -27,8 +28,8 @@
     }
   },
   "bin": {
-    "pkg": "./bin/pkg-utils",
-    "pkg-utils": "./bin/pkg-utils"
+    "pkg": "./bin/pkg-utils.cjs",
+    "pkg-utils": "./bin/pkg-utils.cjs"
   },
   "files": [
     "bin",
@@ -36,19 +37,20 @@
     "dist"
   ],
   "scripts": {
-    "build": "node -r esbuild-register scripts/build && node -r esbuild-register scripts/check",
-    "check:package": "node -r esbuild-register scripts/check",
+    "build": "node --experimental-loader ./scripts/_experimental-loader.js --no-warnings -r esbuild-register scripts/build",
+    "check:package": "node --experimental-loader ./scripts/_experimental-loader.js --no-warnings -r esbuild-register scripts/check",
     "clean": "rimraf dist test/env/__tmp__",
     "commit": "cz",
     "extract": "sanity-tsdoc etl --outDir etc/api/@sanity/pkg-utils --tsconfig tsconfig.dist.json",
     "format": "prettier --write --cache --ignore-unknown .",
     "lint": "eslint . --ext .cjs,.js,.ts",
+    "postbuild": "pnpm run check:package",
     "prebuild": "pnpm run clean",
     "prepublishOnly": "pnpm run build",
     "release": "semantic-release",
     "test": "vitest run",
     "type-check": "tsc --build",
-    "watch": "node -r esbuild-register scripts/watch"
+    "watch": "node --experimental-loader ./scripts/_experimental-loader.js --no-warnings -r esbuild-register scripts/watch"
   },
   "dependencies": {
     "@babel/core": "^7.19.0",
@@ -66,6 +68,7 @@
     "cac": "^6.7.12",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
+    "cpx": "^1.5.0",
     "esbuild": "^0.15.5",
     "esbuild-register": "^3.3.3",
     "find-config": "^1.0.0",
@@ -75,7 +78,6 @@
     "pkg-up": "^3.1.0",
     "prettier": "^2.7.1",
     "pretty-bytes": "^5.6.0",
-    "rimraf": "^3.0.2",
     "rollup": "^2.78.1",
     "rollup-plugin-esbuild": "^4.9.3",
     "rollup-plugin-terser": "^7.0.2",
@@ -88,9 +90,9 @@
     "@commitlint/cli": "^17.0.3",
     "@commitlint/config-conventional": "^17.0.3",
     "@sanity/semantic-release-preset": "^2.0.0",
+    "@types/babel__core": "^7.1.19",
     "@types/cpx": "^1.5.2",
     "@types/find-config": "^1.0.1",
-    "@types/globby": "^9.1.0",
     "@types/mkdirp": "^1.0.2",
     "@types/node": "^18.7.13",
     "@types/prettier": "^2.7.0",
@@ -100,7 +102,6 @@
     "@typescript-eslint/eslint-plugin": "^5.35.1",
     "@typescript-eslint/parser": "^5.35.1",
     "commitizen": "^4.2.5",
-    "cpx": "^1.5.0",
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.23.0",
     "eslint-config-prettier": "^8.5.0",
@@ -108,6 +109,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "husky": "^8.0.1",
     "lint-staged": "^12.5.0",
+    "rimraf": "^3.0.2",
     "semantic-release": "^19.0.5",
     "ts-node": "^10.9.1",
     "typescript": "^4.7.4",

package/src/node/_core/pkg/_loadPkg.ts

@@ -1,46 +1,7 @@
 import fs from 'fs/promises'
 import pkgUp from 'pkg-up'
-import {z} from 'zod'
 import {_PackageJSON} from './_types'
-
-const pkgSchema = z.object({
-  type: z.optional(z.enum(['module'])),
-  name: z.string(),
-  version: z.string(),
-  bin: z.optional(z.record(z.string())),
-  dependencies: z.optional(z.record(z.string())),
-  devDependencies: z.optional(z.record(z.string())),
-  peerDependencies: z.optional(z.record(z.string())),
-  source: z.string(),
-  main: z.optional(z.string()),
-  browser: z.optional(z.record(z.string())),
-  module: z.optional(z.string()),
-  types: z.optional(z.string()),
-  exports: z.optional(
-    z.record(
-      z.object({
-        types: z.optional(z.string()),
-        source: z.string(),
-        browser: z.optional(
-          z.object({
-            require: z.optional(z.string()),
-            import: z.optional(z.string()),
-          })
-        ),
-        node: z.optional(
-          z.object({
-            require: z.optional(z.string()),
-            import: z.optional(z.string()),
-          })
-        ),
-        require: z.optional(z.string()),
-        import: z.optional(z.string()),
-        default: z.string(),
-      })
-    )
-  ),
-  browserslist: z.optional(z.array(z.string())),
-})
+import {_validatePkg} from './_validatePkg'
 
 /** @internal */
 export async function _loadPkg(options: {cwd: string}): Promise<_PackageJSON> {
@@ -52,5 +13,5 @@ export async function _loadPkg(options: {cwd: string}): Promise<_PackageJSON> {
 
   const buf = await fs.readFile(pkgPath)
 
-  return pkgSchema.parse(JSON.parse(buf.toString()))
+  return _validatePkg(JSON.parse(buf.toString()))
 }

package/src/node/_core/pkg/_loadPkgWithReporting.ts

@@ -15,7 +15,7 @@ export async function _loadPkgWithReporting(options: {cwd: string}): Promise<_Pa
         if (issue.code === 'invalid_type') {
           console.log(
             `${chalk.red('invalid type')} in ./package.json at ${chalk.magenta(
-              `\`${issue.path.join('')}\``
+              `\`${issue.path.join('.')}\``
             )} (expected ${issue.expected}, received ${issue.received})`
           )
         }

package/src/node/_core/pkg/_parseExports.ts

@@ -1,6 +1,7 @@
 import {_isRecord} from '../_isRecord'
 import {PkgExport} from '../config'
 import {_PackageJSON} from './_types'
+import {_validateExports} from './_validateExports'
 
 /** @internal */
 export function _parseExports(options: {pkg: _PackageJSON}): (PkgExport & {_path: string})[] {
@@ -10,14 +11,14 @@ export function _parseExports(options: {pkg: _PackageJSON}): (PkgExport & {_path
     _exported: true,
     _path: '.',
     types: pkg.types,
-    source: pkg.source || 'index.js',
+    source: pkg.source || '',
     browser: pkg.browser && {
       require: pkg.main && pkg.browser[pkg.main],
       import: pkg.module && pkg.browser[pkg.module],
     },
     import: pkg.module,
     require: pkg.main,
-    default: pkg.module || pkg.main || './index.js',
+    default: pkg.module || pkg.main || '',
   }
 
   const extraExports: (PkgExport & {_path: string})[] = []
@@ -26,6 +27,26 @@ export function _parseExports(options: {pkg: _PackageJSON}): (PkgExport & {_path
     for (const [exportPath, exportEntry] of Object.entries(pkg.exports)) {
       if (_isRecord(exportEntry)) {
         if (exportPath === '.') {
+          if (
+            exportEntry.require &&
+            rootExport.require &&
+            exportEntry.require !== rootExport.require
+          ) {
+            throw new Error('mismatch between "main" and "require"')
+          }
+
+          if (exportEntry.import && rootExport.import && exportEntry.import !== rootExport.import) {
+            throw new Error('mismatch between "module" and "import"')
+          }
+
+          if (exportEntry.types && rootExport.types && exportEntry.types !== rootExport.types) {
+            throw new Error('mismatch between "types" and "types"')
+          }
+
+          if (exportEntry.source && rootExport.source && exportEntry.source !== rootExport.source) {
+            throw new Error('mismatch between "source" and "source"')
+          }
+
           Object.assign(rootExport, exportEntry)
         } else {
           const extraExport: PkgExport & {_path: string} = {
@@ -42,5 +63,7 @@ export function _parseExports(options: {pkg: _PackageJSON}): (PkgExport & {_path
     }
   }
 
-  return [rootExport, ...extraExports]
+  const _exports = [rootExport, ...extraExports]
+
+  return _validateExports(_exports, {pkg})
 }

package/src/node/_core/pkg/_types.ts

@@ -1,6 +1,6 @@
 /** @internal */
 export interface _PackageJSON {
-  type?: 'module'
+  type: 'commonjs' | 'module'
   version: string
   private?: boolean
   name: string
@@ -14,6 +14,12 @@ export interface _PackageJSON {
       source: string
       types?: string
       browser?: {
+        source: string
+        require?: string
+        import?: string
+      }
+      node?: {
+        source: string
         require?: string
         import?: string
       }
@@ -24,7 +30,7 @@ export interface _PackageJSON {
   >
   main?: string
   browser?: Record<string, string>
-  source: string
+  source?: string
   module?: string
   types?: string
   browserslist?: string[]

package/src/node/_core/pkg/_validateExports.ts

@@ -0,0 +1,29 @@
+import {PkgExport} from '../config'
+import {_PackageJSON} from './_types'
+
+export function _validateExports(
+  _exports: (PkgExport & {_path: string})[],
+  options: {pkg: _PackageJSON}
+): (PkgExport & {_path: string})[] {
+  const {pkg} = options
+
+  for (const exp of _exports) {
+    if (pkg.type === 'commonjs') {
+      if (exp.require && !exp.require.endsWith('.js')) {
+        throw new Error(
+          `package.json with \`"type": "commonjs"\` - \`exports["${exp._path}"].require\` must end with ".js"`
+        )
+      }
+    }
+
+    if (pkg.type === 'module') {
+      if (exp.require && !exp.require.endsWith('.cjs')) {
+        throw new Error(
+          `package.json with \`"type": "module"\` - \`exports["${exp._path}"].require\` must end with ".cjs"`
+        )
+      }
+    }
+  }
+
+  return _exports
+}

package/src/node/_core/pkg/_validatePkg.ts

@@ -0,0 +1,50 @@
+import {z} from 'zod'
+import {_PackageJSON} from './_types'
+
+const pkgSchema = z.object({
+  type: z.optional(z.enum(['commonjs', 'module'])),
+  name: z.string(),
+  version: z.string(),
+  license: z.string(),
+  bin: z.optional(z.record(z.string())),
+  dependencies: z.optional(z.record(z.string())),
+  devDependencies: z.optional(z.record(z.string())),
+  peerDependencies: z.optional(z.record(z.string())),
+  source: z.optional(z.string()),
+  main: z.optional(z.string()),
+  browser: z.optional(z.record(z.string())),
+  module: z.optional(z.string()),
+  types: z.optional(z.string()),
+  exports: z.optional(
+    z.record(
+      z.object({
+        types: z.optional(z.string()),
+        source: z.string(),
+        browser: z.optional(
+          z.object({
+            source: z.string(),
+            require: z.optional(z.string()),
+            import: z.optional(z.string()),
+          })
+        ),
+        node: z.optional(
+          z.object({
+            source: z.string(),
+            require: z.optional(z.string()),
+            import: z.optional(z.string()),
+          })
+        ),
+        require: z.optional(z.string()),
+        import: z.optional(z.string()),
+        default: z.string(),
+      })
+    )
+  ),
+  browserslist: z.optional(z.array(z.string())),
+})
+
+export function _validatePkg(input: unknown): _PackageJSON {
+  const pkg = pkgSchema.parse(input)
+
+  return {...pkg, type: pkg.type || 'commonjs'}
+}

package/src/node/_resolveBuildTasks.ts

@@ -13,13 +13,19 @@ export function _resolveBuildTasks(ctx: _BuildContext): _BuildTask[] {
     ([_path, exp]) => ({_path, ...exp} as PkgExport & {_path: string})
   )
 
-  const dtsTasks: Record<string, _DtsTask> = {}
+  const dtsTask: _DtsTask = {
+    type: 'build:dts',
+    entries: [],
+  }
+
   const rollupTasks: Record<string, _RollupTask> = {}
 
   function _addRollupTaskEntry(format: PkgFormat, runtime: PkgRuntime, entry: _RollupTaskEntry) {
     const buildId = `${format}:${runtime}`
 
-    if (!rollupTasks[buildId]) {
+    if (rollupTasks[buildId]) {
+      rollupTasks[buildId].entries.push(entry)
+    } else {
       rollupTasks[buildId] = {
         type: 'build:js',
         buildId,
@@ -28,8 +34,6 @@ export function _resolveBuildTasks(ctx: _BuildContext): _BuildTask[] {
         format,
         target: target[runtime],
       }
-    } else {
-      rollupTasks[buildId].entries.push(entry)
     }
   }
 
@@ -38,15 +42,12 @@ export function _resolveBuildTasks(ctx: _BuildContext): _BuildTask[] {
     const importId = path.join(pkg.name, exp._path)
 
     if (exp.types) {
-      if (!dtsTasks[importId]) {
-        dtsTasks[importId] = {
-          type: 'build:dts',
-          importId,
-          exportPath: exp._path,
-          sourcePath: exp.source,
-          targetPath: exp.types,
-        }
-      }
+      dtsTask.entries.push({
+        importId,
+        exportPath: exp._path,
+        sourcePath: exp.source,
+        targetPath: exp.types,
+      })
     }
   }
 
@@ -102,7 +103,10 @@ export function _resolveBuildTasks(ctx: _BuildContext): _BuildTask[] {
     })
   }
 
-  tasks.push(...Object.values(dtsTasks))
+  if (dtsTask.entries.length) {
+    tasks.push(dtsTask)
+  }
+
   tasks.push(...Object.values(rollupTasks))
 
   // Parse rollup:esm:browser tasks

package/src/node/_resolveWatchTasks.ts

@@ -12,13 +12,19 @@ export function _resolveWatchTasks(ctx: _BuildContext): _WatchTask[] {
     ([_path, exp]) => ({_path, ...exp} as PkgExport & {_path: string})
   )
 
-  const dtsTasks: Record<string, _DtsWatchTask> = {}
+  const dtsTask: _DtsWatchTask = {
+    type: 'watch:dts',
+    entries: [],
+  }
+
   const rollupTasks: Record<string, _RollupWatchTask> = {}
 
   function _addRollupTaskEntry(format: PkgFormat, runtime: PkgRuntime, entry: _RollupTaskEntry) {
     const buildId = `${format}:${runtime}`
 
-    if (!rollupTasks[buildId]) {
+    if (rollupTasks[buildId]) {
+      rollupTasks[buildId].entries.push(entry)
+    } else {
       rollupTasks[buildId] = {
         type: 'watch:js',
         buildId,
@@ -27,8 +33,6 @@ export function _resolveWatchTasks(ctx: _BuildContext): _WatchTask[] {
         format,
         target: target[runtime],
       }
-    } else {
-      rollupTasks[buildId].entries.push(entry)
     }
   }
 
@@ -37,15 +41,12 @@ export function _resolveWatchTasks(ctx: _BuildContext): _WatchTask[] {
     const importId = path.join(pkg.name, exp._path)
 
     if (exp.types) {
-      if (!dtsTasks[importId]) {
-        dtsTasks[importId] = {
-          type: 'watch:dts',
-          importId,
-          exportPath: exp._path,
-          sourcePath: exp.source,
-          targetPath: exp.types,
-        }
-      }
+      dtsTask.entries.push({
+        importId,
+        exportPath: exp._path,
+        sourcePath: exp.source,
+        targetPath: exp.types,
+      })
     }
   }
 
@@ -101,7 +102,10 @@ export function _resolveWatchTasks(ctx: _BuildContext): _WatchTask[] {
     })
   }
 
-  tasks.push(...Object.values(dtsTasks))
+  if (dtsTask.entries.length) {
+    tasks.push(dtsTask)
+  }
+
   tasks.push(...Object.values(rollupTasks))
 
   // Parse rollup:esm:browser tasks
@@ -115,7 +119,7 @@ export function _resolveWatchTasks(ctx: _BuildContext): _WatchTask[] {
           [
             `// AUTO-GENERATED – DO NOT EDIT`,
             ``,
-            `export {default} from '${relativeTargetPath}'`,
+            // `export {default} from '${relativeTargetPath}'`,
             `export * from '${relativeTargetPath}'`,
             ``,
           ].join('\n')

package/src/node/_tasks/dts/_buildTypes.ts

@@ -1,6 +1,5 @@
 /* eslint-disable no-console */
 
-import path from 'path'
 import ts from 'typescript'
 
 export const formatHost: ts.FormatDiagnosticsHost = {
@@ -13,10 +12,9 @@ export const formatHost: ts.FormatDiagnosticsHost = {
 export async function _buildTypes(options: {
   cwd: string
   outDir: string
-  sourcePath: string
   tsconfig: ts.ParsedCommandLine
-}): Promise<{path: string}> {
-  const {cwd, outDir, sourcePath, tsconfig} = options
+}): Promise<void> {
+  const {outDir, tsconfig} = options
 
   const compilerOptions: ts.CompilerOptions = {
     ...tsconfig.options,
@@ -27,23 +25,8 @@ export async function _buildTypes(options: {
     outDir,
   }
 
-  const rootDir =
-    path.relative(
-      cwd,
-      compilerOptions.rootDir
-        ? path.resolve(cwd, compilerOptions.rootDir)
-        : path.dirname(path.resolve(cwd, sourcePath))
-    ) || '.'
-
   const program = ts.createProgram(tsconfig.fileNames, compilerOptions)
 
-  const sourceFiles = program.getSourceFiles()
-  const sourceFile = sourceFiles.find((f) => f.fileName === path.resolve(cwd, sourcePath))
-
-  if (!sourceFile) {
-    throw new Error(`source file not found: ${sourcePath}`)
-  }
-
   const emitResult = program.emit()
 
   const allDiagnostics = ts.getPreEmitDiagnostics(program).concat(emitResult.diagnostics)
@@ -68,10 +51,4 @@ export async function _buildTypes(options: {
       throw new Error('failed to compile')
     }
   }
-
-  const typesPath = path
-    .resolve(outDir, path.relative(rootDir, path.resolve(cwd, sourcePath)))
-    .replace(/\.[jt]sx?$/, '.d.ts')
-
-  return {path: typesPath}
 }