API Features

export abstract class BaseModule {
    /**
     * Module package Info
     *
     * @api-version 1
     * @user
     */
    readonly packageInfo: IModulePackageInfo;

    /**
     * A constructor to instantiate {@link BaseModule}.
     *
     * @api-version 1
     * @system
     */
    constructor(packageInfo: IModulePackageInfo) {
        this.packageInfo = packageInfo;
        logger.debug(`BaseModule (${packageInfo.packageName}) is instantiated.`);
    }

    /**
     * This method is called to retrieve an appropriate {@link ModuleScreen} component about the {@link Message} by system.
     * The method could be called by only system.
     *
     * @param componentId A component id to retrieve a component.
     * @return An object that is consists of a class which is inherited the {@link ModuleScreen} and CSS file's relative path array that are should be loaded at HTML.
     *
     * @api-version 1
     * @system
     */
    getModuleScreen(componentId: string): typeof ModuleScreen | null {
        return null;
    }

    /**
     * This method is called to retrieve an appropriate {@link ModuleService} component about the {@link Message} by system.
     * The method could be called by only system.
     *
     * @param componentId A component id to retrieve a component.
     * @return A class which is inherited the {@link ModuleService}.
     *
     * @api-version 1
     * @system
     */
    getModuleService(componentId: string): typeof ModuleService | null {
        return null;
    }

    /**
     * This method is called only when the module package is first installed.
     * If there is any jobs which are need to do after install the module package, then this method should be overridden and implement code in the method.
     * The method could be called by only system.
     *
     * @api-version 1
     * @system
     */
    onModulePackageInstalled(): void {
        // empty
    }

    /**
     * This method is called when the module package is updated.
     * If there is any jobs which are need to do after update the module package, then this method should be overridden and implement code in the method.
     * The method could be called by only system.
     *
     * @param oldVersion A module package version before it was updated.
     * @param newVersion A module package version after it has been updated.
     *
     * @api-version 1
     * @system
     */
    onModulePackageUpdated(oldVersion: string, newVersion: string): void {
        // empty
    }

    /**
     * Call this when system is need to render a screen component that is included in the module.
     * It is needed to avoid 'Minified React error #321' problem.
     * The method could be called by only system.
     *
     * @return The ReactDOM class that is imported in the module package.
     *
     * @api-version 1
     * @system
     * @hidden
     */
    readonly getReactDom = () => {
        return ReactDOM;
    };
}

export interface ButtonInterface {
    /**
     * Sets the text to be displayed.
     *
     * @api-version 1
     * @user
     */
    setText(text: string): void;
    /**
     * Set the enabled state.
     *
     * @api-version 1
     * @user
     */
    setEnabled(enabled: boolean): void;
    /**
     * Set the hidden state.
     *
     * @api-version 1
     * @user
     */
    setHidden(hidden: boolean): void;
    /**
     * Set the {@link OnClickListener} to be invoked when this button is pressed.
     *
     * @api-version 1
     * @user
     */
    setOnClickListener(listener: OnClickListener): void;
}

export type AUTHORITY_STATE = typeof AUTHORITY_STATE[keyof typeof AUTHORITY_STATE];

export const BYTE_SIZE = {
    FIVEBITES: 5, // 5 bits
    SIXBITS: 6,   // 6 bits
    SEVENBITS: 7, // 7 bits
    EIGHTBITS: 8, // 8 bits
} as const;