feat: Final step to 100% tree-shakeability

Author: Septh

package-lock.json

@@ -34,15 +34,14 @@
       "types": "./dist/win32/consts.d.ts",
       "default": "./dist/win32/consts.js"
     },
-    "./consts/*": {
-      "types": "./dist/win32/consts/*.d.ts",
-      "default": "./dist/win32/consts/*.js"
-    },
     "./rollup-plugin": {
-      "types": "./dist/rollup/plugin.d.ts",
-      "default": "./dist/rollup/plugin.js"
+      "types": "./dist/rollup/index.d.ts",
+      "default": "./dist/rollup/index.js"
     }
   },
+  "imports": {
+    "#consts-base": "./dist/win32/consts"
+  },
   "engines": {
     "node": ">= 18.19.0 || >= 20.6.0"
   },
@@ -67,6 +66,7 @@
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/node": "^22.5.1",
+    "magic-string": "^0.30.11",
     "rimraf": "^6.0.1",
     "rollup": "^4.21.2",
     "rollup-plugin-node-externals": "^7.1.3",

package.json

@@ -1,13 +1,14 @@
 /*
- * This config only bundles the demos. The library itself is published unbundled.
+ * This config only bundles the demos and serves as an example of how to bundle the lib with your code.
+ * The library itself is published unbundled.
  */
 // @ts-check
 import { defineConfig } from 'rollup'
 import { nodeExternals } from 'rollup-plugin-node-externals'
 import { nodeResolve } from '@rollup/plugin-node-resolve'
 import commonjs from '@rollup/plugin-commonjs'
 import typescript from '@rollup/plugin-typescript'
-import { koffi } from './dist/rollup/plugin.js'
+import { libwin32 } from 'libwin32/rollup-plugin'
 
 // Use distinct configs to prevent Rollup from code-splitting the library.
 export default [
@@ -38,10 +39,11 @@ function makeConfig(which) {
             typescript({
                 rootDir: `source/demos`,
                 outDir: `demos/${which}`,
+                target: 'ES2023',
                 declaration: false,
                 declarationMap: false
             }),
-            koffi()
+            libwin32()
         ]
     })
 }

rollup.demos.js

@@ -1,5 +1,5 @@
 import { MessageBox } from 'libwin32'
-import { MB_ } from 'libwin32/consts/MB'
+import { MB_ } from 'libwin32/consts'
 
 const result = MessageBox(
     null,

source/demos/messagebox.ts

@@ -6,18 +6,7 @@ import {
     MessageBox,
     type HINSTANCE, type WPARAM, type LPARAM, type HWND, type MSG
 } from 'libwin32'
-
-// Also import some helpfull constants.
-// Note that import { CS_, CW_, IDC_, IDI_, MB_, SW_, WM_, WS_ } from 'libwin32/consts' would also work,
-// but at the cost of tree-shakeability due to the way TypeScript exports enums.
-import { CS_ } from 'libwin32/consts/CS'
-import { CW_ } from 'libwin32/consts/CW'
-import { IDC_ } from 'libwin32/consts/IDC'
-import { IDI_ } from 'libwin32/consts/IDI'
-import { MB_ } from 'libwin32/consts/MB'
-import { SW_ } from 'libwin32/consts/SW'
-import { WM_ } from 'libwin32/consts/WM'
-import { WS_, WS_EX_ } from 'libwin32/consts/WS'
+import { CS_, CW_, IDC_, IDI_, MB_, SW_, WM_, WS_, WS_EX_ } from 'libwin32/consts'
 
 const windowClass = "NodeApp"
 const windowName  = "Window Demo!"

source/demos/window.ts

@@ -0,0 +1,46 @@
+import { fileURLToPath } from 'node:url'
+import MagicString from 'magic-string'
+import type { Plugin } from 'rollup'
+
+/**
+ * A plugin that rewrites TypeScript's `enum`s into a tree-shakeable
+ * form --the same as esbuid.
+ */
+export function enums(): Plugin {
+
+    const constsBase = fileURLToPath(import.meta.resolve('#consts-base'))
+
+    // https://regex101.com/r/1nyPC3/3
+    const enumRx = /\b(?<intro>(?:export\s+)?var\s+(?<name>[^;\s]+);?\s*\(function\s*\(\k<name>\)\s*{).*(?<outro>}\)\(\k<name>\s*\|\|\s*\(\k<name>\s*=\s{}\)\);?)/gsmd
+
+    return {
+        name: 'libwin32-tree-skakeable-enums',
+
+        transform(code, id) {
+            if (!id.startsWith(constsBase))
+                return
+
+            let ms: MagicString | undefined
+            let match: RegExpMatchArray | null
+            enumRx.lastIndex = 0
+            while (match = enumRx.exec(code)) {
+                const varName = match.groups!.name
+                const indices = match.indices!.groups
+
+                ms ??= new MagicString(code)
+                ms.update(indices!.intro[0], indices!.intro[1], `export var ${varName}= /*@__PURE__*/(${varName} => {`)
+                ms.update(indices!.outro[0], indices!.outro[1], `${ms.getIndentString()}return ${varName};\n})(${varName} || {});`)
+            }
+
+            if (ms) {
+                ms.replace(/\/\/#\s*sourceMappingURL=(?:.*).map\s*$/, '')
+                return {
+                    code: ms.toString(),
+                    map: ms.generateMap()
+                }
+            }
+
+            return null
+        }
+    }
+}

source/rollup/enums.ts

@@ -0,0 +1,7 @@
+import { koffi } from './koffi.js'
+import { enums } from './enums.js'
+
+export const libwin32 = () => [
+    koffi(),
+    enums(),
+]

source/rollup/index.ts

@@ -4,29 +4,33 @@ import { fileURLToPath } from 'node:url'
 import path from 'node:path'
 import type { Plugin } from 'rollup'
 
+/**
+ * A plugin that simplifies bundling Koffi with user apps.
+ */
 export function koffi(): Plugin {
 
-    // The path to Koffi's .node file.
+    // The path to the orginal `koffi.node` binary.
     const koffiSource = fileURLToPath(new URL(
         `./build/koffi/${platform}_${arch}/koffi.node`,
-        import.meta.resolve('koffi')  // Unflagged in Node v20.6.0, v18.19.0
+        import.meta.resolve('koffi')
     ))
 
-    // The path we'll copy it to.
-    const koffiDest = `koffi-${platform}-${arch}.node`
+    // The name under which we'll copy it to.
+    const koffi_win32_x64 = `koffi-${platform}-${arch}.node`
 
+    // Won't do if this is still false at writeBundle() time.
     let copy = false
 
     return {
-        name: 'koffi-cream',
+        name: 'libwin32-koffi-cream',
 
         async buildStart() {
             copy = false
 
             // Make sure Koffi's installed and accessible.
             const err = await fs.access(koffiSource, fs.constants.R_OK).catch((err: NodeJS.ErrnoException) => err)
             if (err instanceof Error)
-                this.error({ message: `Cannot access "${koffiSource}": ${err.code}.`, stack: undefined })
+                this.error({ message: `Cannot access "${koffiSource}": ${err.code}. Did you install koffi as a dependency?`, stack: undefined })
         },
 
         buildEnd(error) {
@@ -36,35 +40,37 @@ export function koffi(): Plugin {
         async writeBundle(options) {
             if (copy) {
 
-                // Create all necessary directories.
+                // Create all the necessary directories.
                 const outDir = path.join(
                     options.dir ?? path.dirname(options.file!),
                     'node_modules', 'koffi'
                 )
                 await fs.mkdir(outDir, { recursive: true }).catch(() => {})
 
-                // Copy Koffi's native code.
-                const destFile = path.join(outDir, koffiDest)
-                let err = await fs.copyFile(koffiSource, destFile).catch((err: NodeJS.ErrnoException) => err)
-                if (err instanceof Error)
-                    this.error({ message: `Cannot write "${destFile}": ${err.code}.`, stack: undefined })
+                // Copy Koffi's binary.
+                const outFile = path.join(outDir, koffi_win32_x64)
+                let err = await fs.copyFile(koffiSource, outFile).catch((err: NodeJS.ErrnoException) => err)
+                if (err)
+                    this.error({ message: `Cannot write "${outFile}": ${err.code}.`, stack: undefined })
 
                 // Write index.cjs
-                err = await fs.writeFile(path.join(outDir, 'index.cjs'), [
-                    `module.exports = require('./${koffiDest}');`
-                ].join('\n')).catch((err: NodeJS.ErrnoException) => err)
-                if (err instanceof Error)
+                err = await fs.writeFile(
+                    path.join(outDir, 'index.cjs'),
+                    `module.exports = require('./${koffi_win32_x64}');`
+                ).catch((err: NodeJS.ErrnoException) => err)
+                if (err)
                     this.error({ message: `Cannot write index.cjs: ${err.code}.`, stack: undefined })
 
                 // Write package.json
                 err = await fs.writeFile(path.join(outDir, 'package.json'), JSON.stringify({
                     name: 'koffi',
+                    description: `koffi binary for ${platform} ${arch} systems`,
                     type: 'commonjs',
                     main: './index.cjs'
                 }, undefined, 2)).catch((err: NodeJS.ErrnoException) => err)
-                if (err instanceof Error)
+                if (err)
                     this.error({ message: `Cannot write package.json: ${err.code}.`, stack: undefined })
             }
-        },
+        }
     }
 }

source/rollup/plugin.ts renamed to source/rollup/koffi.ts

@@ -1,4 +1,6 @@
-/** Flags for GetAncestor() */
+/**
+ * Flags for GetAncestor()
+ */
 export enum GA_ {
     PARENT    = 1,
     ROOT      = 2,

source/win32/consts/GA.ts

@@ -1,4 +1,6 @@
-/** Special HWND values. */
+/**
+ * Special HWND values.
+ */
 export enum HWND_ {
     // PostMessage() and SendMessage()
     BROADCAST = 0xffff,

source/win32/consts/HWND.ts

@@ -17,7 +17,7 @@
 
     // Output
     "outDir": "dist",
-    "target": "ES2023",
+    "target": "ESNext",
     "removeComments": false,
     "preserveConstEnums": true,
     "sourceMap": true,