Type winamp-eqf

Author: captbaritone

.github/workflows/ci.yml

@@ -55,6 +55,7 @@ jobs:
           # Set CI environment variable for optimized builds
           export CI=true
           pnpm --filter ani-cursor build
+          pnpm --filter winamp-eqf build
           pnpm --filter webamp build
         env:
           NODE_ENV: production
@@ -88,6 +89,7 @@ jobs:
           # Set CI environment variable for optimized builds
           export CI=true
           pnpm --filter ani-cursor build
+          pnpm --filter winamp-eqf build
           pnpm --filter webamp build-library
         env:
           NODE_ENV: production

docs/typescript-checking.md

@@ -6,7 +6,7 @@ This document describes the TypeScript checking convention established for the W
 
 Each TypeScript-enabled package in the monorepo now has a consistent `type-check` script that performs type checking without emitting files.
 
-**Progress: 4 out of 5 packages now passing! 🎉**
+**Progress: 5 out of 6 packages now passing! 🎉**
 
 ### Package Status
 
@@ -16,6 +16,7 @@ Each TypeScript-enabled package in the monorepo now has a consistent `type-check
 - **ani-cursor**: Clean TypeScript compilation
 - **skin-database**: Clean TypeScript compilation (fixed JSZip types, Jest types, and Buffer compatibility issues)
 - **webamp-docs**: Clean TypeScript compilation
+- **winamp-eqf**: Clean TypeScript compilation (ES module with full type definitions)
 
 #### ❌ Failing Packages (Need fixes)
 
@@ -44,7 +45,7 @@ The root package.json contains a centralized script that runs type checking for
 ```json
 {
   "scripts": {
-    "type-check": "pnpm --filter webamp type-check && pnpm --filter ani-cursor type-check && pnpm --filter skin-database type-check && pnpm --filter webamp-docs type-check"
+    "type-check": "pnpm --filter webamp type-check && pnpm --filter ani-cursor type-check && pnpm --filter skin-database type-check && pnpm --filter webamp-docs type-check && pnpm --filter winamp-eqf type-check"
   }
 }
 ```

package.json

@@ -11,7 +11,7 @@
   "scripts": {
     "test": "jest",
     "lint": "eslint . --ext ts,tsx,js,jsx --rulesdir=packages/webamp-modern/tools/eslint-rules",
-    "type-check": "pnpm --filter webamp type-check && pnpm --filter ani-cursor type-check && pnpm --filter skin-database type-check && pnpm --filter webamp-docs type-check",
+    "type-check": "pnpm --filter webamp type-check && pnpm --filter ani-cursor type-check && pnpm --filter skin-database type-check && pnpm --filter webamp-docs type-check && pnpm --filter winamp-eqf type-check",
     "deploy": "sh deploy.sh",
     "format": "prettier --write '**/*.{js,ts,tsx}'"
   },

packages/webamp/config/jest.unit.js

@@ -10,10 +10,12 @@ module.exports = {
     "\\.css$": "<rootDir>/js/__mocks__/styleMock.js",
     "\\.wsz$": "<rootDir>/js/__mocks__/fileMock.js",
     "\\.mp3$": "<rootDir>/js/__mocks__/fileMock.js",
+    "^winamp-eqf$": "<rootDir>/../winamp-eqf/built/index.js",
   },
   transform: {
     "^.+\\.(t|j)sx?$": ["@swc/jest"],
   },
+  extensionsToTreatAsEsm: [".ts", ".tsx"],
   testPathIgnorePatterns: ["/node_modules/"],
   testEnvironment: "jsdom",
 };

packages/webamp/js/selectors.ts

@@ -45,13 +45,20 @@ import { SerializedStateV1 } from "./serializedStates/v1Types";
 export const getSliders = (state: AppState) => state.equalizer.sliders;
 
 export const getEqfData = createSelector(getSliders, (sliders) => {
-  const preset: { [key: string]: number | string } = {
+  const preset = {
     name: "Entry1",
     preamp: Utils.denormalizeEqBand(sliders.preamp),
+    hz60: Utils.denormalizeEqBand(sliders[60]),
+    hz170: Utils.denormalizeEqBand(sliders[170]),
+    hz310: Utils.denormalizeEqBand(sliders[310]),
+    hz600: Utils.denormalizeEqBand(sliders[600]),
+    hz1000: Utils.denormalizeEqBand(sliders[1000]),
+    hz3000: Utils.denormalizeEqBand(sliders[3000]),
+    hz6000: Utils.denormalizeEqBand(sliders[6000]),
+    hz12000: Utils.denormalizeEqBand(sliders[12000]),
+    hz14000: Utils.denormalizeEqBand(sliders[14000]),
+    hz16000: Utils.denormalizeEqBand(sliders[16000]),
   };
-  BANDS.forEach((band) => {
-    preset[`hz${band}`] = Utils.denormalizeEqBand(sliders[band]);
-  });
   const eqfData = {
     presets: [preset],
     type: "Winamp EQ library file v1.1",

packages/webamp/js/winamp-eqf.d.ts

@@ -155,6 +155,6 @@
     "reselect": "^3.0.1",
     "strtok3": "^10.3.1",
     "tinyqueue": "^1.2.3",
-    "winamp-eqf": "^1.0.0"
+    "winamp-eqf": "workspace:*"
   }
 }

packages/webamp/package.json

@@ -1,6 +1,10 @@
-const fs = require("fs");
-const path = require("path");
-const { parser } = require("winamp-eqf");
+import fs from "fs";
+import path from "path";
+import { parser } from "winamp-eqf";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 const presetsPath = path.join(__dirname, "../presets/winamp.q1");
 const content = fs.readFileSync(presetsPath);

packages/webamp/scripts/parsePresetFiles.js

@@ -0,0 +1,23 @@
+# Build output
+built/
+
+# Node modules
+node_modules/
+
+# npm/pnpm
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+package-lock.json
+
+# TypeScript
+*.tsbuildinfo
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db

packages/winamp-eqf/.gitignore

@@ -1,23 +1,31 @@
 # Winamp Equalizer Preset Parser
 
-Winamp allows you to save your equalizser settings to `.eqf` file. This package allows you to parse these files.
+Winamp allows you to save your equalizer settings to `.eqf` file. This package allows you to parse these files.
 
 ## Installation
 
-    npm install --save winamp-eqf
+```bash
+npm install --save winamp-eqf
+```
+
+## Usage
 
-## Ussage
+```typescript
+import { parser, creator, EqfData, CreateEqfData } from 'winamp-eqf';
 
-    import {parser, creator} from 'winamp-eqf';
+// ... Get your .eqf or .q1 file as an ArrayBuffer
+const eqf: EqfData = parser(eqfArrayBuffer);
 
-    // ... Get your .eqf or .q1 file as an ArrayBuffer
-    const eqf = parser(eqfArrayBuffer);
+const eqfArrayBuffer: ArrayBuffer = creator(eqf);
+```
 
-    const eqfArrayBuffer = creator(eqf);
+This package is an ES module and requires Node.js 14+ or a modern bundler that supports ES modules.
 
 ## API
 
-### `parser(ArrayBuffer)`
+This package is written in TypeScript and provides full type definitions.
+
+### `parser(ArrayBuffer): EqfData`
 
 #### Return value
 
@@ -44,7 +52,7 @@ Winamp allows you to save your equalizser settings to `.eqf` file. This package
 }
 ```
 
-### `creator(eqfObject)`
+### `creator(eqfObject: CreateEqfData): ArrayBuffer`
 
 #### Return Value: `ArrayBuffer`