@openhps/core/src/service/Service.ts

Open Hybrid Positioning System - Core component

import { AsyncEventEmitter } from '../_internal/AsyncEventEmitter';
import { v4 as uuidv4 } from 'uuid';
import { SerializableMember, SerializableObject } from '../data/decorators';

/**
 * Service is accessible by each {@link Node} inside the {@link Model}
 */
@SerializableObject()
export abstract class Service extends AsyncEventEmitter {
    /**
     * Service name
     */
    @SerializableMember()
    uid: string;
    private _ready = false;
    /**
     * Model shape
     */
    model: any;
    /**
     * Dependencies that need to be resolved before the service is ready
     */
    dependencies?: (new (...args: any[]) => Service)[] = [];

    constructor(options: ServiceOptions = {}) {
        super();

        this.uid = options.uid ?? this.constructor.name;

        this.prependOnceListener('ready', () => {
            this._ready = true;
        });
    }

    /**
     * Add a dependency to the service
     * @param dependency Service dependency
     * @returns {this} Service instance
     */
    addDependency(dependency: new (...args: any[]) => Service): this {
        this.dependencies.push(dependency);
        return this;
    }

    protected generateUUID(): string {
        return uuidv4();
    }

    setUID(uid: string): this {
        this.uid = uid;
        return this;
    }

    isReady(): boolean {
        return this._ready;
    }

    emit(name: string | symbol, ...args: any[]): boolean;
    /**
     * Service ready
     * @param {string} name ready
     */
    emit(name: 'ready'): boolean;
    /**
     * Destroy the service
     * @param {string} name destroy
     */
    emit(name: 'destroy'): boolean;
    emit(name: string | symbol, ...args: any[]): boolean {
        return super.emit(name, ...args);
    }

    once(name: string | symbol, listener: (...args: any[]) => void): this;
    /**
     * Event called when service is destroyed
     * @param {string} name destroy
     * @param {Function} listener Event callback
     */
    once(name: 'destroy', listener: () => void | Promise<void>): this;
    /**
     * Event called when service is build
     * @param {string} name build
     * @param {Function} listener Event callback
     */
    once(name: 'build', listener: () => void | Promise<void>): this;
    /**
     * Event called when service is ready
     * @param {string} name ready
     * @param {Function} listener Event callback
     */
    once(name: 'ready', listener: () => void | Promise<void>): this;
    once(name: string | symbol, listener: (...args: any[]) => void): this {
        if (name === 'ready' && this.isReady()) {
            listener();
            return this;
        }
        return super.once(name, listener);
    }

    logger(level: 'debug', message: string, data?: any): void;
    logger(level: 'info', message: string, data?: any): void;
    logger(level: 'warn', message: string, data?: any): void;
    logger(level: 'error', message: string, error?: Error): void;
    /**
     * @deprecated
     * @param {string} level Logging level
     * @param {any} log Logging data or message
     */
    logger(level: string, log: any): void;
    /**
     * Graph logger
     * @param {string} level Logging level
     * @param {string} message Message
     * @param {any} data Data to include in log
     */
    logger(level: string, message: string, data?: any): void {
        if (this.model) {
            this.model.logger(level, message, data);
        }
    }
}

export interface ServiceOptions {
    uid?: string;
}