xsound 3.2.1 → 3.3.0

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "xsound",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "engines": {
-    "node": ">=14.17.0 <=18.16.x"
+    "node": ">=16.0.0 <=18.16.x"
   },
   "description": "XSound gives Web Developers Powerful Audio Features Easily !",
   "main": "build/xsound.js",
@@ -65,29 +65,29 @@
     "README.md"
   ],
   "devDependencies": {
-    "@types/jest": "^29.5.1",
-    "@typescript-eslint/eslint-plugin": "^5.59.7",
-    "@typescript-eslint/parser": "^5.59.7",
+    "@types/jest": "^29.5.3",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
     "cross-env": "^7.0.3",
     "dotenv-webpack": "^8.0.1",
-    "eslint": "^8.41.0",
+    "eslint": "^8.45.0",
     "eslint-cli": "^1.1.1",
-    "eslint-config-standard": "^17.0.0",
+    "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-n": "^15.6.1",
+    "eslint-plugin-n": "^16.0.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.1.1",
     "husky": "4.3.8",
-    "jest": "^29.5.0",
-    "jest-environment-jsdom": "^29.5.0",
-    "lint-staged": "^13.2.2",
+    "jest": "^29.6.1",
+    "jest-environment-jsdom": "^29.6.1",
+    "lint-staged": "^13.2.3",
     "terser-webpack-plugin": "^5.3.9",
-    "ts-jest": "^29.1.0",
-    "ts-loader": "^9.4.3",
-    "typedoc": "^0.24.7",
+    "ts-jest": "^29.1.1",
+    "ts-loader": "^9.4.4",
+    "typedoc": "^0.24.8",
     "typescript": "^4.7.4",
-    "webpack": "^5.84.1",
-    "webpack-cli": "^5.1.1",
-    "webpack-dev-server": "^4.15.0"
+    "webpack": "^5.88.1",
+    "webpack-cli": "^5.1.4",
+    "webpack-dev-server": "^4.15.1"
   }
 }

package/build/types/SoundModule/Session/Room.d.ts

@@ -1,63 +0,0 @@
-import { Connectable } from '../../interfaces';
-import { SessionSetupParams, SessionConnectionParams } from './';
-export declare type RoomMap = {
-    [id: string]: WebSocket | null;
-};
-/**
- * This class is entity for room feature in session.
- * @constructor
- */
-export declare class Room implements Connectable {
-    private static BUFFER_SIZE;
-    private id;
-    private context;
-    private analyser;
-    private sender;
-    private receiver;
-    private websocket;
-    /**
-     * @param {AudioContext} context This argument is in order to use interfaces of Web Audio API.
-     * @param {SessionSetupParams} params This argument is in order to create instance of `Room`.
-     */
-    constructor(context: AudioContext, params: SessionSetupParams);
-    /**
-     * This method creates instance of `WebSocket` and registers event handlers. Namely, join room.
-     * @param {SessionConnectionParams} params This argument is in order to create instance of `WebSocket`.
-     */
-    join(params: SessionConnectionParams): void;
-    /**
-     * This method sends sound Room ID and data (as `Float32Array`) to server.
-     */
-    send(): void;
-    /**
-     * This method stops sending and receiving data by disconnecting `AudioNode`.
-     * Namely, leave room temporarily.
-     */
-    leave(): void;
-    /**
-     * This method closes connection to WebSocket server and destroys instance of `WebSocket`.
-     * Namely, leave room permanently.
-     */
-    clear(): void;
-    /**
-     * This method connects `AudioNode`s for receiving data.
-     */
-    connect(): void;
-    /**
-     * This method determines whether there is connection to server.
-     * @return {boolean} If connection to server exists, this value is `true`. Otherwise, this value is `false`.
-     */
-    connected(): boolean;
-    /**
-     * This method gets instance of `WebSocket` that corresponds Room ID.
-     * @return {RoomMap}
-     */
-    get(): RoomMap;
-    /** @override */
-    get INPUT(): ScriptProcessorNode;
-    /** @override */
-    get OUTPUT(): ScriptProcessorNode;
-    /** @override */
-    toString(): string;
-}
-//# sourceMappingURL=Room.d.ts.map

package/build/types/SoundModule/Session/Room.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Room.d.ts","sourceRoot":"","sources":["../../../../src/SoundModule/Session/Room.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,IAAI,CAAC;AAEjE,oBAAY,OAAO,GAAG;IACpB,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAA;CAC/B,CAAC;AAEF;;;GAGG;AACH,qBAAa,IAAK,YAAW,WAAW;IAEtC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAQ;IAElC,OAAO,CAAC,EAAE,CAAS;IACnB,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,QAAQ,CAAW;IAE3B,OAAO,CAAC,MAAM,CAAsB;IACpC,OAAO,CAAC,QAAQ,CAAsB;IAEtC,OAAO,CAAC,SAAS,CAA0B;IAE3C;;;OAGG;gBACS,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAY7D;;;OAGG;IACI,IAAI,CAAC,MAAM,EAAE,uBAAuB,GAAG,IAAI;IAsElD;;OAEG;IACI,IAAI,IAAI,IAAI;IA+BnB;;;OAGG;IACI,KAAK,IAAI,IAAI;IASpB;;;OAGG;IACI,KAAK,IAAI,IAAI;IAWpB;;OAEG;IACI,OAAO,IAAI,IAAI;IAQtB;;;OAGG;IACI,SAAS,IAAI,OAAO;IAI3B;;;OAGG;IACI,GAAG,IAAI,OAAO;IAIrB,gBAAgB;IAChB,IAAW,KAAK,IAAI,mBAAmB,CAEtC;IAED,gBAAgB;IAChB,IAAW,MAAM,IAAI,mBAAmB,CAEvC;IAED,gBAAgB;IACT,QAAQ,IAAI,MAAM;CAG1B"}

package/build/types/SoundModule/Session/index.d.ts

@@ -1,107 +0,0 @@
-import { Connectable } from '../../interfaces';
-import { BufferSize } from '../../types';
-import { Analyser } from '../Analyser';
-import { Room, RoomMap } from './Room';
-export declare type NumberOfSessionChannels = 1 | 2;
-export type { Room, RoomMap };
-/**
- * @property {string} roomId This property is string that identifies messaging room.
- * @property {BufferSize} bufferSize This property is buffer size for `ScriptProcessorNode`.
- * @property {NumberOfSessionChannels} numberOfInputs This property is the number of inputs for `ScriptProcessorNode`.
- * @property {NumberOfSessionChannels} numberOfOutputs This property the number of outputs for `ScriptProcessorNode`.
- * @property {Analyser} analyser This property is instance of `Analyser`.
- */
-export declare type SessionSetupParams = {
-    roomId: string;
-    bufferSize: BufferSize;
-    numberOfInputs: NumberOfSessionChannels;
-    numberOfOutputs: NumberOfSessionChannels;
-    analyser: Analyser;
-};
-/**
- * @property {string} roomId This property is string that identifies messaging room.
- * @property {boolean} tls This property is in order to select protocol (either `wss` or `ws`).
- * @property {string} host This property is server's hostname.
- * @property {number} port This property is port number for connection.
- * @property {string} path This property is script path that is executed in server side.
- * @property {function} openCallback This property is invoked as `onopen` event handler in instance of `WebSocket`.
- * @property {function} closeCallback This property is invoked as `onclose` event handler in instance of `WebSocket`.
- * @property {function} errorCallback This property is invoked as `onerror` event handler in instance of `WebSocket`.
- */
-export declare type SessionConnectionParams = {
-    roomId: string;
-    tls: boolean;
-    host: string;
-    port: number;
-    path: string;
-    openCallback?(event: Event): void;
-    closeCallback?(event: Event): void;
-    errorCallback?(event: Event): void;
-};
-/**
- * This private class manages sound session rooms.
- * @constructor
- */
-export declare class Session implements Connectable {
-    private context;
-    private input;
-    private output;
-    private rooms;
-    /**
-     * @param {AudioContext} context This argument is in order to use Web Audio API.
-     */
-    constructor(context: AudioContext);
-    /**
-     * This method creates instance of `Room`.
-     * @param {SessionSetupParams} params This argument is in order to create instance of `Room`.
-     * @return {Session} Return value is for method chain.
-     */
-    setup(params: SessionSetupParams): Session;
-    /**
-     * This method creates instance of `WebSocket`.
-     * @param {SessionConnectionParams} params This argument is in order to create instance of `WebSocket`.
-     * @return {Session} Return value is for method chain.
-     */
-    ready(params: SessionConnectionParams): Session;
-    /**
-     * This method sends sound data to server.
-     * @param {string} roomId This argument is string that identifies messaging room.
-     * @return {Session} Return value is for method chain.
-     */
-    start(roomId: string): Session;
-    /**
-     * This method stops sending and receiving data.
-     * @param {string} roomId This argument is string that identifies messaging room.
-     * @return {Session} Return value is for method chain.
-     */
-    stop(roomId: string): Session;
-    /**
-     * This method closes connection to WebSocket server and destroys instance of `WebSocket`.
-     * @param {string} roomId This argument is string that identifies messaging room.
-     * @return {Session} Return value is for method chain.
-     */
-    clear(roomId: string): Session;
-    /**
-     * This method connects `AudioNode`s.
-     * @param {string} roomId This argument is string that identifies messaging room.
-     * @return {Session} Return value is for method chain.
-     */
-    connect(roomId: string): Session;
-    /**
-     * This method determines whether there is connection to server.
-     * @param {string} roomId This argument is string that identifies messaging room.
-     * @return {boolean}
-     */
-    connected(roomId: string): boolean;
-    /**
-     * This method gets instance of `Room` that is designated Room ID.
-     * @param {string} roomId This argument is string that identifies room.
-     * @return {Room}
-     */
-    get(roomId: string): Room | null;
-    /** @override */
-    get INPUT(): GainNode;
-    /** @override */
-    get OUTPUT(): GainNode;
-}
-//# sourceMappingURL=index.d.ts.map

package/build/types/SoundModule/Session/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/SoundModule/Session/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAEvC,oBAAY,uBAAuB,GAAG,CAAC,GAAG,CAAC,CAAC;AAE5C,YAAY,EACV,IAAI,EACJ,OAAO,EACR,CAAC;AAEF;;;;;;GAMG;AACH,oBAAY,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,UAAU,CAAC;IACvB,cAAc,EAAE,uBAAuB,CAAC;IACxC,eAAe,EAAE,uBAAuB,CAAC;IACzC,QAAQ,EAAE,QAAQ,CAAA;CACnB,CAAC;AAEF;;;;;;;;;GASG;AACH,oBAAY,uBAAuB,GAAG;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,OAAO,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAClC,aAAa,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACnC,aAAa,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;CACnC,CAAC;AAEF;;;GAGG;AACH,qBAAa,OAAQ,YAAW,WAAW;IACzC,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,KAAK,CAAW;IACxB,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,KAAK,CAAc;IAE3B;;OAEG;gBACS,OAAO,EAAE,YAAY;IAOjC;;;;OAIG;IACI,KAAK,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO;IAKjD;;;;OAIG;IACI,KAAK,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO;IAYtD;;;;OAIG;IACI,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAcrC;;;;OAIG;IACI,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAYpC;;;;OAIG;IACI,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAYrC;;;;OAIG;IACI,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAavC;;;;OAIG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAUzC;;;;OAIG;IACI,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAIvC,gBAAgB;IAChB,IAAW,KAAK,IAAI,QAAQ,CAE3B;IAED,gBAAgB;IAChB,IAAW,MAAM,IAAI,QAAQ,CAE5B;CACF"}