Setup Jest - unit tests

.github/workflows/build.yml

@@ -6,7 +6,7 @@ on:
       - master
 
 jobs:
-  build:
+  build-and-test:
     runs-on: ubuntu-latest
 
     steps:
@@ -23,3 +23,6 @@ jobs:
 
     - name: Build and Lint
       run: npm run build
+
+    - name: Test
+      run: npm test

.gitignore

@@ -31,3 +31,5 @@ dist/**/dts/**/*.d.ts
 
 # service worker
 .rollup.cache
+
+coverage

dist/index.d.ts

@@ -18,6 +18,7 @@ import FilterManagerInterface$1 from '@/audioEditor/interfaces/FilterManagerInte
 import AudioEditorInterface$1 from '@/audioEditor/interfaces/AudioEditorInterface';
 import { ConfigService as ConfigService$1 } from '@/services/interfaces/ConfigService';
 import VoiceRecorderInterface$1 from '@/voiceRecorder/interfaces/VoiceRecorderInterface';
+import AbstractAudioElement$1 from '@/filters/interfaces/AbstractAudioElement';
 
 declare const audioEditorContainer: Container;
 
@@ -1157,4 +1158,59 @@ declare class SoundStudioFactory {
     static getConfigServiceInstance(): ConfigService$1 | undefined;
 }
 
-export { AbstractAudioElement, AbstractAudioFilter, AbstractAudioFilterWorklet, AbstractAudioRenderer, AudioEditor, type AudioFilterEntrypointInterface, type AudioFilterNodes, BufferPlayer, type ConfigService, Constants, EventEmitter, type EventEmitterCallback, EventType, type FilterSettingValue, type FilterSettings, type FilterState, GenericConfigService, type GenericSettingValueAdditionalData, type RecorderSettings, type SaveBufferOptions, type SelectFormValue, SoundStudioFactory, utilFunctions as UtilFunctions, VoiceRecorder, audioEditorContainer };
+interface LimiterSettings extends FilterSettings {
+    preGain: number;
+    postGain: number;
+    attackTime: number;
+    releaseTime: number;
+    threshold: number;
+    lookAheadTime: number;
+}
+
+declare class LimiterFilter extends AbstractAudioFilterWorklet<void> {
+    private preGain;
+    private postGain;
+    private attackTime;
+    private releaseTime;
+    private threshold;
+    private lookAheadTime;
+    constructor();
+    receiveEvent(message: MessageEvent<void>): void;
+    get workletPath(): string;
+    get workletName(): string;
+    get order(): number;
+    get id(): string;
+    getAddingTime(): number;
+    getSettings(): LimiterSettings;
+    setSetting(settingId: string, value: FilterSettingValue): Promise<void>;
+}
+
+declare class FilterManager extends AbstractAudioElement$1 implements FilterManagerInterface {
+    /** A list of filters */
+    private filters;
+    /** The entrypoint filter */
+    private _entryPointFilter;
+    /** The current connected nodes */
+    private _currentNodes;
+    constructor(filters: AbstractAudioFilter$1[], entryPointFilter: (AbstractAudioFilter$1 & AudioFilterEntrypointInterface$1) | null);
+    private setup;
+    addFilters(...filters: AbstractAudioFilter$1[]): void;
+    getFiltersState(): FilterState$1;
+    getFiltersSettings(): Map<string, FilterSettings$1>;
+    toggleFilter(filterId: string): void;
+    changeFilterSettings(filterId: string, settings: FilterSettings$1): Promise<void>;
+    resetFilterSettings(filterId: string): Promise<void>;
+    resetAllFiltersState(): void;
+    connectNodes(context: BaseAudioContext, buffer: AudioBuffer, keepCurrentInputOutput: boolean, isCompatibilityMode: boolean): Promise<void>;
+    disconnectOldNodes(keepCurrentOutput: boolean): void;
+    initializeWorklets(context: BaseAudioContext): Promise<void>;
+    getAddingTime(): number;
+    setupTotalSamples(durationAudio: number, currentContext: AudioContext | null): void;
+    resetFilterBuffers(): Promise<void>;
+    get entrypointFilter(): (AbstractAudioFilter$1 & AudioFilterEntrypointInterface$1) | null;
+    get currentNodes(): AudioFilterNodes$1 | null;
+    get order(): number;
+    get id(): string;
+}
+
+export { AbstractAudioElement, AbstractAudioFilter, AbstractAudioFilterWorklet, AbstractAudioRenderer, AudioEditor, type AudioFilterEntrypointInterface, type AudioFilterNodes, BufferPlayer, type ConfigService, Constants, EventEmitter, type EventEmitterCallback, EventType, FilterManager, type FilterSettingValue, type FilterSettings, type FilterState, GenericConfigService, type GenericSettingValueAdditionalData, LimiterFilter, type RecorderSettings, type SaveBufferOptions, type SelectFormValue, SoundStudioFactory, utilFunctions as UtilFunctions, VoiceRecorder, audioEditorContainer };

jest.config.ts

@@ -0,0 +1,23 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type { Config } from "jest";
+
+const config: Config = {
+    clearMocks: true,
+    collectCoverage: false,
+    coverageDirectory: undefined,
+    coverageProvider: "v8",
+    moduleDirectories: [
+        "node_modules",
+        "lib"
+    ],
+    moduleNameMapper: {
+        "@/(.*)": "<rootDir>/lib/$1"
+    },
+    preset: "ts-jest"
+};
+
+export default config;

lib/index.ts

@@ -22,6 +22,8 @@ import { EventEmitterCallback } from "./model/EventEmitterCallback";
 import { ConfigService } from "./services/interfaces/ConfigService";
 import SaveBufferOptions from "./model/SaveBufferOptions";
 import SoundStudioFactory from "./utils/SoundStudioFactory";
+import LimiterFilter from "./filters/LimiterFilter";
+import FilterManager from "./audioEditor/FilterManager";
 
 export {
     audioEditorContainer,
@@ -48,5 +50,7 @@ export {
     AbstractAudioRenderer,
     type AudioFilterEntrypointInterface,
     utilFunctions as UtilFunctions,
-    SoundStudioFactory
+    SoundStudioFactory,
+    FilterManager,
+    LimiterFilter
 };

lib/utils/Functions.ts

@@ -139,12 +139,12 @@ const utilFunctions = {
     },
     forceDownload(blob: Blob, filename: string) {
         const link = window.document.createElement("a");
-        const url = (window.URL || window.webkitURL).createObjectURL(blob);
+        const url = URL.createObjectURL(blob);
         window.document.body.appendChild(link);
         link.href = url;
         link.download = filename || "output.wav";
         link.click();
-        window.URL.revokeObjectURL(url);
+        URL.revokeObjectURL(url);
     }
 };