Use package entry point terminology

Author: pastelsky

.changeset/clean-cats-import.md

@@ -2,4 +2,4 @@
 'package-build-stats': minor
 ---
 
-Add public import-point discovery and allow package stats to target one validated import point.
+Add package entry-point discovery and allow package stats to target one validated entry point.

CONTRIBUTING.md

@@ -32,10 +32,10 @@ To build a package and get stats about exports that are exposed out of the packa
 curl 'localhost:3000/exports?p=<package-name>'
 ```
 
-To list public package import points –
+To list package entry points –
 
 ```bash
-curl 'localhost:3000/import-points?p=<package-name>'
+curl 'localhost:3000/entry-points?p=<package-name>'
 ```
 
 To build a package and get stats about size of various exports that are exposed out of the package –

README.md

@@ -26,21 +26,21 @@ const results = await getPackageStats('moment')
 const results = await getPackageStats('moment@2.24.0')
 ```
 
-##### Discovering and building public import points
+##### Discovering and building package entry points
 
 ```js
-import { getPackageImportPoints, getPackageStats } from 'package-build-stats'
+import { getPackageEntryPoints, getPackageStats } from 'package-build-stats'
 
-const importPoints = await getPackageImportPoints('react-dom@19.2.0')
+const entryPoints = await getPackageEntryPoints('react-dom@19.2.0')
 // ['react-dom', 'react-dom/client', 'react-dom/profiling', ...]
 
 const results = await getPackageStats('react-dom@19.2.0', {
-  importPoint: 'react-dom/client',
+  entryPoint: 'react-dom/client',
 })
 ```
 
-`importPoint` only accepts an exact value returned by
-`getPackageImportPoints()` for that package version. This keeps generated build
+`entryPoint` only accepts an exact value returned by
+`getPackageEntryPoints()` for that package version. This keeps generated build
 entries limited to discovered package imports while respecting `exports`
 encapsulation when it is present.
 
@@ -77,7 +77,7 @@ const results = await getBuiltPackageStats('moment', options)
 | limitConcurrency   | `true` or `false`               | `false`      | When using `yarn` as the client, use the network mutex to limit concurrency                                                                                     |
 | networkConcurrency | `number`                        | `false`      | When using `yarn` or `bun` as client, limit simultaneous installs to this number.                                                                               |
 | customImports      | `Array<string>`                 | `null`       | By default, the default export is used for calculating sizes. Setting this option allows calculation of package stats based on more granular top-level exports. |
-| importPoint        | `string`                        | package root | Public package import to bundle. Must exactly match a value returned by `getPackageImportPoints()`.                                                             |
+| entryPoint         | `string`                        | package root | Package entry point to bundle. Must exactly match a value returned by `getPackageEntryPoints()`.                                                                |
 | minifier           | `terser` or `esbuild`           | `terser`     | ESbuild is faster, albeit with marginally larger file sizes                                                                                                     |
 | installTimeout     | number (ms)                     | 30000        | Timeout for package install                                                                                                                                     |
 

index.js

@@ -9,7 +9,7 @@ import {
   getPackageStats,
   getPackageExportSizes,
   getAllPackageExports,
-  getPackageImportPoints,
+  getPackageEntryPoints,
 } from './build/index.js'
 
 const PORT = Number(process.env.PORT ?? 3000)
@@ -144,8 +144,8 @@ const application = await server({ port: PORT }, [
   packageRoute('/exports', (packageString, query) =>
     getAllPackageExports(packageString, { debug: !!query.debug }),
   ),
-  packageRoute('/import-points', (packageString, query) =>
-    getPackageImportPoints(packageString, { debug: !!query.debug }),
+  packageRoute('/entry-points', (packageString, query) =>
+    getPackageEntryPoints(packageString, { debug: !!query.debug }),
   ),
   get('/__debug/memory', async () => json(getMemorySnapshot())),
   get('/__debug/heapdump', async () => {

src/common.types.ts

@@ -3,7 +3,7 @@ export type PackageManager = (typeof packageManagers)[number]
 
 type AllOptions = {
   customImports?: Array<string>
-  importPoint?: string
+  entryPoint?: string
   splitCustomImports?: boolean
   debug?: boolean
   minify?: boolean
@@ -21,7 +21,7 @@ type AllOptions = {
 export type BuildPackageOptions = Pick<
   AllOptions,
   | 'customImports'
-  | 'importPoint'
+  | 'entryPoint'
   | 'splitCustomImports'
   | 'debug'
   | 'minify'
@@ -32,7 +32,7 @@ export type BuildPackageOptions = Pick<
 
 export type CreateEntryPointOptions = Pick<
   AllOptions,
-  'esm' | 'customImports' | 'importPoint' | 'entryFilename'
+  'esm' | 'customImports' | 'entryPoint' | 'entryFilename'
 >
 export type InstallPackageOptions = Pick<
   AllOptions,
@@ -53,7 +53,7 @@ export type GetPackageStatsOptions = Pick<
   | 'networkConcurrency'
   | 'debug'
   | 'customImports'
-  | 'importPoint'
+  | 'entryPoint'
   | 'installTimeout'
   | 'minify'
   | 'signal'

src/errors/CustomError.ts

@@ -42,14 +42,14 @@ export class EntryPointError extends CustomError {
   }
 }
 
-export class InvalidImportPointError extends CustomError<{
-  importPoint: string
+export class InvalidPackageEntryPointError extends CustomError<{
+  entryPoint: string
 }> {
-  constructor(importPoint: string) {
+  constructor(entryPoint: string) {
     super(
-      'InvalidImportPointError',
-      `Import point ${JSON.stringify(importPoint)} is not exported by this package`,
-      { importPoint },
+      'InvalidPackageEntryPointError',
+      `Package entry point ${JSON.stringify(entryPoint)} is not importable`,
+      { entryPoint },
     )
   }
 }

src/getPackageImportPoints.ts src/getPackageEntryPoints.tssrc/getPackageImportPoints.ts renamed to src/getPackageEntryPoints.ts

@@ -2,9 +2,9 @@ import path from 'node:path'
 import type { InstallPackageOptions } from './common.types.js'
 import InstallationUtils from './utils/installation.utils.js'
 import { parsePackageString, throwIfAborted } from './utils/common.utils.js'
-import { getImportPointsFromPackage } from './utils/importPoints.utils.js'
+import { getEntryPointsFromPackage } from './utils/packageEntryPoints.utils.js'
 
-export default async function getPackageImportPoints(
+export default async function getPackageEntryPoints(
   packageString: string,
   options: InstallPackageOptions = {},
 ) {
@@ -24,7 +24,7 @@ export default async function getPackageImportPoints(
     throwIfAborted(options.signal)
 
     const packagePath = path.join(installPath, 'node_modules', packageName)
-    return await getImportPointsFromPackage(
+    return await getEntryPointsFromPackage(
       packageName,
       packagePath,
       options.signal,

src/getPackageStats.ts

@@ -14,12 +14,12 @@ import {
 import InstallationUtils from './utils/installation.utils.js'
 import BuildUtils from './utils/build.utils.js'
 import {
-  InvalidImportPointError,
+  InvalidPackageEntryPointError,
   UnexpectedBuildError,
 } from './errors/CustomError.js'
 import type { GetPackageStatsOptions } from './common.types.js'
 import Telemetry from './utils/telemetry.utils.js'
-import { getImportPointsFromPackage } from './utils/importPoints.utils.js'
+import { getEntryPointsFromPackage } from './utils/packageEntryPoints.utils.js'
 
 function getPackageJSONDetails(packageName: string, installPath: string) {
   const startTime = performance.now()
@@ -90,15 +90,15 @@ export default async function getPackageStats(
     timings.install = performance.now() - installStart
     console.log(`[PERF] installPackage: ${timings.install.toFixed(2)}ms`)
 
-    if (options.importPoint) {
+    if (options.entryPoint) {
       const packagePath = path.join(installPath, 'node_modules', packageName)
-      const importPoints = await getImportPointsFromPackage(
+      const entryPoints = await getEntryPointsFromPackage(
         packageName,
         packagePath,
         options.signal,
       )
-      if (!importPoints.includes(options.importPoint)) {
-        throw new InvalidImportPointError(options.importPoint)
+      if (!entryPoints.includes(options.entryPoint)) {
+        throw new InvalidPackageEntryPointError(options.entryPoint)
       }
     }
 
@@ -119,7 +119,7 @@ export default async function getPackageStats(
           debug: options.debug,
           minify: options.minify !== false,
           customImports: options.customImports,
-          importPoint: options.importPoint,
+          entryPoint: options.entryPoint,
           includeDependencySizes: true,
           signal: options.signal,
         },

src/index.ts

@@ -1,5 +1,5 @@
 export { default as getPackageStats } from './getPackageStats.js'
-export { default as getPackageImportPoints } from './getPackageImportPoints.js'
+export { default as getPackageEntryPoints } from './getPackageEntryPoints.js'
 export * from './errors/CustomError.js'
 export * from './getPackageExportSizes.js'
 export { emitter as eventQueue } from './utils/telemetry.utils.js'

src/utils/build.utils.ts

@@ -122,7 +122,7 @@ const BuildUtils = {
     )
 
     let importStatement: string
-    const moduleSpecifier = JSON.stringify(options.importPoint ?? packageName)
+    const moduleSpecifier = JSON.stringify(options.entryPoint ?? packageName)
 
     if (options.esm) {
       if (options.customImports) {
@@ -274,7 +274,7 @@ const BuildUtils = {
       entry['main'] = BuildUtils.createEntryPoint(packageName, installPath, {
         esm: true,
         customImports: options.customImports,
-        importPoint: options.importPoint,
+        entryPoint: options.entryPoint,
       })
     }