scrypted/plugins/homekit/src/util.ts

import sdk, { ScryptedInterface } from '@scrypted/sdk';

const { systemManager } = sdk;

/*
 * flattenDeviceTree performs a modified DFS tree traversal of the given
 * device mapping to produce a list of device ids. deviceId is the node
 * of the tree currently being processed, where null is the root of the
 * tree.
 */
function flattenDeviceTree(deviceMap: Map<string, string[]>, deviceId: string): string[] {
    const result: string[] = [];
    if (!deviceMap.has(deviceId)) // no children
        return result;

    const children = deviceMap.get(deviceId);
    result.push(...children);
    children.map(child =>  result.push(...flattenDeviceTree(deviceMap, child)))
    return result;
}

/*
 * reorderDevicesByProvider returns a new ordering of the provided deviceIds
 * where it is guaranteed that DeviceProviders are listed before their children.
 */
export function reorderDevicesByProvider(deviceIds: string[]): string[] {
    const providerDeviceIdMap = new Map<string, string[]>();

    deviceIds.map(deviceId => {
        const device = systemManager.getDeviceById(deviceId);

        // when provider id is equal to device id, this is a root-level device/plugin
        const providerId = device.providerId !== device.id ? device.providerId : null;
        if (providerDeviceIdMap.has(providerId)) {
            providerDeviceIdMap.get(providerId).push(device.id);
        } else {
            providerDeviceIdMap.set(providerId, [device.id]);
        }
    });

    return flattenDeviceTree(providerDeviceIdMap, null);
}