Update Docs & Readme

Author: honusz

LogEmitter/index.ts

@@ -12,14 +12,17 @@ export declare interface Logger {
 }
 
 export class Logger extends EventEmitter {
-
   private logStream: fs.WriteStream = null;
   private static _instance: Logger;
   private timeStart: number;
 
-  constructor (_fileName?: string) {
+
+  /**
+   * Logger Utility Class
+   * @param {string} _fileName 
+   */
+  constructor(_fileName?: string) {
     super();
-    
     const fileName = _fileName || 'log.txt';
     this.logStream = fs.createWriteStream(fileName);//, {flags: 'a'});
     const hrTime = process.hrtime();
@@ -32,7 +35,7 @@ export class Logger extends EventEmitter {
     return this._instance || (this._instance = new this());
   }
 
-  private logEntry(...args: any){
+  private logEntry(...args: any) {
     const hrTime = process.hrtime();
     const logTime = Math.floor((hrTime[0] * 1000000 + hrTime[1] / 1000));
     this.logStream.write(`[${logTime - this.timeStart}] ${[args.join(' ')]}\n`);

README.md

@@ -41,20 +41,21 @@ const stageLinqOptions: StageLinqOptions = {
   downloadDbSources: true,
   actingAs: ActingAsDevice.StageLinqJS,
   services: [
-    ServiceList.StateMap,
-    ServiceList.BeatInfo,
-    ServiceList.FileTransfer,
+    Services.StateMap,
+    Services.BeatInfo,
+    Services.FileTransfer,
   ],
 }
 ```
 
 ## Starting StageLinq
 
-StageLinq is started as it was previously:
+The main StageLinq class is now a Static Class:
 ```ts
-const stageLinq = new StageLinq(stageLinqOptions);
+StageLinq.options = stageLinqOptions;
 
-await stageLinq.connect();
+await StageLinq.connect();
+await StageLinq.disconnect();
 ```
 
 
@@ -112,6 +113,8 @@ public getDevices(): ConnectionInfo[] {
 
 
 ## StateMap
+
+
 ```ts
 StateMap.emitter.on('newDevice', (service: StateMapDevice) => {
     console.log(`[STATEMAP] Subscribing to States on ${service.deviceId.string}`);

Sources/DbConnection.ts

@@ -55,33 +55,28 @@ export class DbConnection {
    * @returns {Promise<Track>}
    */
   async getTrackInfo(_trackPath: string): Promise<TrackDBEntry> {
-    let result: TrackDBEntry[];
-
-    //console.dir(_trackPath.split('/'))
     const trackPath = _trackPath.split('/').slice(5, _trackPath.length).join('/')
-    //console.log(trackPath)
-    //if (/streaming:\/\//.test(trackPath)) {
-    //  result = this.querySource('SELECT * FROM Track WHERE uri = (?) LIMIT 1', trackPath);
-    //} else {
-    result = this.querySource('SELECT * FROM Track WHERE path = (?) LIMIT 1', trackPath);
-    //}
+    const result: TrackDBEntry[] = this.querySource('SELECT * FROM Track WHERE path = (?) LIMIT 1', trackPath);
     if (!result) throw new Error(`Could not find track: ${trackPath} in database.`);
+
     result[0].trackData = await this.zInflate(result[0].trackData);
     result[0].overviewWaveFormData = await this.zInflate(result[0].overviewWaveFormData);
     result[0].beatData = await this.zInflate(result[0].beatData);
 
     return result[0];
   }
 
+  /**
+   * 
+   * @param {number} id /ID of track in the database
+   * @returns {Promise<TrackDBEntry>}
+   */
   async getTrackById(id: number): Promise<TrackDBEntry> {
-    let result: TrackDBEntry[];
-
-    result = this.querySource('SELECT * FROM Track WHERE id = (?) LIMIT 1', id);
+    const result: TrackDBEntry[] = this.querySource('SELECT * FROM Track WHERE id = (?) LIMIT 1', id);
     if (!result) throw new Error(`Could not find track id: ${id} in database.`);
     result[0].trackData = await this.zInflate(result[0].trackData);
     result[0].overviewWaveFormData = await this.zInflate(result[0].overviewWaveFormData);
     result[0].beatData = await this.zInflate(result[0].beatData);
-
     return result[0];
   }
 

Sources/Sources.ts

@@ -22,6 +22,11 @@ export declare interface Sources {
 export class Sources extends EventEmitter {
   #sources: Map<string, Source> = new Map();
 
+  /**
+   * Sources EndPoint Class
+   */
+
+
   /** 
    * Check if sources has Source
    * @param {string} sourceName - Name of source in EngineOS, eg: 'DJ STICK (USB 1)'
@@ -141,19 +146,43 @@ export class Source {
   deviceId: DeviceId;
   #databases: Map<string, Database> = new Map();
 
+  /**
+   * Source Type Class
+   * @constructor
+   * @param {string} name 
+   * @param {DeviceId} deviceId 
+   */
+
+
   constructor(name: string, deviceId: DeviceId) {
     this.name = name;
     this.deviceId = deviceId;
   }
-
-  getDatabase(name?: string) {
+  /**
+   * Get a Database by File Name
+   * @param {string }name Filename eg "m.db"
+   * @returns {Database}
+   */
+  getDatabase(name?: string): Database {
     return this.#databases.get(name || "m.db")
   }
 
+  /**
+   * Get an array of all Databases
+   * @returns {Database[]}
+   */
+
   getDatabases(): Database[] {
     return [...this.#databases.values()]
   }
 
+  /**
+   * New Database Constructor
+   * @param {string} filename 
+   * @param {number} size 
+   * @param {string} remotePath 
+   * @returns 
+   */
   newDatabase(filename: string, size: number, remotePath: string): Database {
     const db = new Database(filename, size, remotePath, this)
     this.#databases.set(db.filename, db);
@@ -176,6 +205,7 @@ class Database {
   downloaded: boolean = false;
 
   /**
+   * Database Type Class
    * @constructor
    * @param {string} filename name of the file EG: 'm.db'
    * @param {number} size size of the file
@@ -193,15 +223,25 @@ class Database {
     this.localPath = getTempFilePath(`${source.deviceId.string}/${source.name}/`);
   }
 
+  /**
+   * Get full remote path & filename
+   */
   get remoteDBPath() {
     return `${this.remotePath}/${this.filename}`
   }
 
+  /**
+   * Get full local path & filename
+   */
   get localDBPath() {
     return `${this.localPath}/${this.filename}`
   }
 
-  connection() {
+  /**
+   * Create new Connection to the DB for Querying
+   * @returns {DbConnection}
+   */
+  connection(): DbConnection {
     return new DbConnection(this.localDBPath)
   }
 

StageLinq/index.ts

@@ -28,7 +28,7 @@ export class StageLinq {
   /**
    * Service Constructor Factory Function
    * @param {Service<T>} Service
-   * @param {DeviceId} deviceId 
+   * @param {DeviceId} [deviceId] 
    * @returns {Promise<Service<T>>}
    */
   static async startServiceListener<T extends InstanceType<typeof Service>>(ctor: {

devices/Devices.ts

@@ -76,7 +76,10 @@ export class Devices extends EventEmitter {
     await this.#devices.set(deviceId.string, device);
   }
 
-
+  /**
+   * Get an array of all current Service Instances
+   * @returns {Promise<InstanceType<typeof Service>[]>}
+   */
   async getDeviceServices(): Promise<InstanceType<typeof Service>[]> {
     return [...this.#devices.values()].flatMap(device => device.getServices())
   }
@@ -117,23 +120,44 @@ export class Device {
     this.info = info;
   }
 
+  /**
+   * Get # of decks on this device
+   * @returns {number}
+   */
   deckCount(): number {
     return this.info.unit.decks
   }
 
-
-  service(serviceName: string) {
+  /**
+   * Get a service instance by name
+   * @param {string} serviceName 
+   * @returns {InstanceType<typeof Service>}
+   */
+  service(serviceName: string): InstanceType<typeof Service> {
     return this.#services.get(serviceName)
   }
 
+  /**
+   * Check if Device has Service
+   * @param {string} serviceName 
+   * @returns {boolean}
+   */
   hasService(serviceName: string): boolean {
     return this.#services.has(serviceName)
   }
 
+  /**
+   * Get an Array of names of all current Services on this Device
+   * @returns {string[]}
+   */
   getServiceNames(): string[] {
     return [...this.#services.keys()]
   }
 
+  /**
+   * Get an Array of all current Services on this Device
+   * @returns {InstanceType<typeof Service>[]}
+   */
   getServices(): InstanceType<typeof Service>[] {
     return [...this.#services.values()]
   }

docs/assets/highlight.css

@@ -9,10 +9,10 @@
     --dark-hl-3: #4EC9B0;
     --light-hl-4: #001080;
     --dark-hl-4: #9CDCFE;
-    --light-hl-5: #795E26;
-    --dark-hl-5: #DCDCAA;
-    --light-hl-6: #AF00DB;
-    --dark-hl-6: #C586C0;
+    --light-hl-5: #AF00DB;
+    --dark-hl-5: #C586C0;
+    --light-hl-6: #795E26;
+    --dark-hl-6: #DCDCAA;
     --light-hl-7: #A31515;
     --dark-hl-7: #CE9178;
     --light-hl-8: #000000FF;