// (C) Copyright 2015 Moodle Pty Ltd. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. import { Component } from '@angular/core'; import { AsyncComponent } from '@classes/async-component'; import { CoreUtils } from '@services/utils/utils'; import { CoreLogger } from './logger'; /** * Registry to keep track of component instances. */ export class CoreComponentsRegistry { private static instances: WeakMap = new WeakMap(); protected static logger = CoreLogger.getInstance('CoreComponentsRegistry'); /** * Register a component instance. * * @param element Root element. * @param instance Component instance. */ static register(element: Element, instance: unknown): void { this.instances.set(element, instance); } /** * Resolve a component instance. * * @param element Root element. * @param componentClass Component class. * @returns Component instance. */ static resolve(element?: Element | null, componentClass?: ComponentConstructor): T | null { const instance = (element && this.instances.get(element) as T) ?? null; return instance && (!componentClass || instance instanceof componentClass) ? instance : null; } /** * Get a component instances and fail if it cannot be resolved. * * @param element Root element. * @param componentClass Component class. * @returns Component instance. */ static require(element: Element, componentClass?: ComponentConstructor): T { const instance = this.resolve(element, componentClass); if (!instance) { throw new Error('Couldn\'t resolve component instance'); } return instance; } /** * Get a component instances and wait to be ready. * * @param element Root element. * @param componentClass Component class. * @return Promise resolved when done. */ static async waitComponentReady( element: Element | null, componentClass?: ComponentConstructor, ): Promise { const instance = this.resolve(element, componentClass); if (!instance) { this.logger.error('No instance registered for element ' + componentClass, element); return; } await instance.ready(); } /** * Waits all elements matching to be ready. * * @param element Element where to search. * @param selector Selector to search on parent. * @param componentClass Component class. * @return Promise resolved when done. */ static async waitComponentsReady( element: Element, selector: string, componentClass?: ComponentConstructor, ): Promise { let elements: Element[] = []; if (element.matches(selector)) { // Element to wait is myself. elements = [element]; } else { elements = Array.from(element.querySelectorAll(selector)); } if (!elements.length) { return; } await Promise.all(elements.map(element => CoreComponentsRegistry.waitComponentReady(element, componentClass))); // Wait for next tick to ensure components are completely rendered. await CoreUtils.nextTick(); } } /** * Component constructor. */ // eslint-disable-next-line @typescript-eslint/no-explicit-any export type ComponentConstructor = { new(...args: any[]): T };