@sanity/pkg-utils 5.0.7 → 5.0.8-canary.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "5.0.7",
+  "version": "5.0.8-canary.1",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -25,7 +25,6 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
       "source": "./src/node/index.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs",
@@ -47,6 +46,23 @@
     "!dist/stats.html",
     "src"
   ],
+  "scripts": {
+    "build": "run-s clean build:pkg check:pkg",
+    "build:pkg": "node -r esbuild-register scripts/build",
+    "check:pkg": "node -r esbuild-register scripts/check",
+    "check:types": "tsc --build",
+    "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 . && eslint . --ext .cjs,.js,.ts,.tsx --fix --quiet",
+    "lint": "eslint . --ext .cjs,.js,.ts,.tsx",
+    "playground:build": "pnpm --filter './playground/**' build",
+    "playground:clean": "pnpm --filter './playground/**' --silent clean",
+    "test": "run-s playground:clean test:clean vitest:run",
+    "test:clean": "rimraf test/env/__tmp__",
+    "vitest:run": "vitest run",
+    "watch": "node -r esbuild-register scripts/watch"
+  },
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"
@@ -62,7 +78,7 @@
   "dependencies": {
     "@babel/core": "^7.24.1",
     "@babel/types": "^7.24.0",
-    "@microsoft/api-extractor": "^7.43.0",
+    "@microsoft/api-extractor": "7.43.0",
     "@microsoft/tsdoc-config": "^0.16.2",
     "@rollup/plugin-alias": "^5.1.0",
     "@rollup/plugin-babel": "^6.0.4",
@@ -102,6 +118,7 @@
   "devDependencies": {
     "@commitlint/cli": "^19.2.1",
     "@commitlint/config-conventional": "^19.1.0",
+    "@sanity/pkg-utils": "workspace:*",
     "@types/babel__core": "^7.20.5",
     "@types/cpx": "^1.5.5",
     "@types/find-config": "^1.0.4",
@@ -130,13 +147,12 @@
     "recast": "^0.23.6",
     "rollup-plugin-visualizer": "^5.12.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.2",
+    "typescript": "5.4.2",
     "vitest": "^1.4.0",
-    "vitest-github-actions-reporter": "^0.11.1",
-    "@sanity/pkg-utils": "5.0.7"
+    "vitest-github-actions-reporter": "^0.11.1"
   },
   "peerDependencies": {
-    "typescript": "^4.7 || ^5"
+    "typescript": "5.4.2"
   },
   "packageManager": "pnpm@8.15.5",
   "engines": {
@@ -145,21 +161,9 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "build": "run-s clean build:pkg check:pkg",
-    "build:pkg": "node -r esbuild-register scripts/build",
-    "check:pkg": "node -r esbuild-register scripts/check",
-    "check:types": "tsc --build",
-    "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 . && eslint . --ext .cjs,.js,.ts,.tsx --fix --quiet",
-    "lint": "eslint . --ext .cjs,.js,.ts,.tsx",
-    "playground:build": "pnpm --filter './playground/**' build",
-    "playground:clean": "pnpm --filter './playground/**' --silent clean",
-    "test": "run-s playground:clean test:clean vitest:run",
-    "test:clean": "rimraf test/env/__tmp__",
-    "vitest:run": "vitest run",
-    "watch": "node -r esbuild-register scripts/watch"
+  "pnpm": {
+    "overrides": {
+      "@sanity/pkg-utils": "workspace:*"
+    }
   }
-}
+}

package/src/node/printExtractMessages.ts

@@ -1,8 +1,8 @@
-import {ExtractorMessage} from '@microsoft/api-extractor'
+import type {ExtractorMessage} from '@microsoft/api-extractor'
 import chalk from 'chalk'
 import path from 'path'
 
-import {BuildContext} from './core'
+import type {BuildContext} from './core'
 
 export function printExtractMessages(ctx: BuildContext, messages: ExtractorMessage[]): void {
   const {cwd, logger} = ctx

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

@@ -1,6 +1,6 @@
 import ts from 'typescript'
 
-import {Logger} from '../../logger'
+import type {Logger} from '../../logger'
 import {printDiagnostic} from './printDiagnostic'
 
 /** @internal */
@@ -20,6 +20,17 @@ export async function buildTypes(options: {
     emitDeclarationOnly: true,
     noEmit: false,
     outDir,
+    // Support the new `module: 'preserve'` option in TypeScript 5.4
+    ...(tsconfig.options.module === ts.ModuleKind.Preserve
+      ? {
+          // 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: ts.ModuleKind.ESNext,
+          moduleResolution: ts.ModuleResolutionKind.Bundler,
+          esModuleInterop: true,
+          resolveJsonModule: true,
+        }
+      : {}),
   }
 
   const program = ts.createProgram(tsconfig.fileNames, compilerOptions)

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

@@ -1,5 +1,6 @@
 import type {IConfigFile, IExtractorMessagesConfig} from '@microsoft/api-extractor'
 import path from 'path'
+import ts from 'typescript'
 
 export function createApiExtractorConfig(options: {
   bundledPackages?: string[]
@@ -9,6 +10,7 @@ export function createApiExtractorConfig(options: {
   messages: IExtractorMessagesConfig
   projectFolder: string
   mainEntryPointFilePath: string
+  tsconfig: ts.ParsedCommandLine
   tsconfigPath: string
 }): IConfigFile {
   const {
@@ -19,6 +21,7 @@ export function createApiExtractorConfig(options: {
     messages,
     projectFolder,
     mainEntryPointFilePath,
+    tsconfig,
     tsconfigPath,
   } = options
 
@@ -28,9 +31,26 @@ export function createApiExtractorConfig(options: {
       reportFileName: '<unscopedPackageName>.api.md',
     },
     bundledPackages,
-    compiler: {
-      tsconfigFilePath: tsconfigPath,
-    },
+    compiler:
+      tsconfig.options.module === ts.ModuleKind.Preserve
+        ? {
+            // When the module is 'preserve' it's necessary to override the tsconfig file as api-extractor doesn't handle it out of the box
+            overrideTsconfig: {
+              extends: tsconfigPath,
+              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 the module is not 'preserve', use the tsconfig file directly
+            tsconfigFilePath: tsconfigPath,
+          },
     docModel: {
       enabled: false,
       apiJsonFilePath: path.resolve(distPath, `${exportPath}.api.json`),

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

@@ -57,6 +57,7 @@ export async function doExtract(
       projectPath: cwd,
       rules: config?.extract?.rules,
       sourceTypesPath: sourceTypesPath,
+      tsconfig: ts.config,
       tmpPath,
       tsconfigPath: path.resolve(cwd, ts.configPath || 'tsconfig.json'),
     })

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

@@ -1,8 +1,8 @@
 import type {File} from '@babel/types'
-import {ExtractorResult} from '@microsoft/api-extractor'
+import type {ExtractorResult} from '@microsoft/api-extractor'
 import {parse, print} from 'recast'
 import typeScriptParser from 'recast/parsers/typescript'
-import {Program} from 'typescript'
+import type {Program} from 'typescript'
 
 /**
  * A workaround to find all module blocks in extract TS files.

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

@@ -8,6 +8,7 @@ import fs from 'fs/promises'
 import {mkdirp} from 'mkdirp'
 import path from 'path'
 import prettier from 'prettier'
+import ts from 'typescript'
 
 import type {BuildFile, PkgConfigOptions} from '../../core'
 import {createApiExtractorConfig} from './createApiExtractorConfig'
@@ -27,6 +28,7 @@ export async function extractTypes(options: {
   rules?: NonNullable<PkgConfigOptions['extract']>['rules']
   sourceTypesPath: string
   tmpPath: string
+  tsconfig: ts.ParsedCommandLine
   tsconfigPath: string
 }): Promise<{extractorResult: ExtractorResult; messages: ExtractorMessage[]}> {
   const {
@@ -40,6 +42,7 @@ export async function extractTypes(options: {
     rules,
     sourceTypesPath,
     tmpPath,
+    tsconfig,
     tsconfigPath,
   } = options
 
@@ -56,6 +59,7 @@ export async function extractTypes(options: {
       messages: getExtractMessagesConfig({rules}),
       projectFolder: projectPath,
       mainEntryPointFilePath: sourceTypesPath,
+      tsconfig,
       tsconfigPath,
     }),
     configObjectFullPath: undefined,