inventoresed/packages/shared/src/inheritance.ts

Z-Wave driver written entirely in JavaScript/TypeScript

import type { Constructor, UnionToIntersection } from "./types";

/** Decorator to support multi-inheritance using mixins */
export function Mixin(baseCtors: Constructor[]) {
	return function (derivedCtor: Constructor): void {
		for (const baseCtor of baseCtors) {
			applyMixin(derivedCtor, baseCtor);
		}
	};
}

export function applyMixin(
	target: Constructor,
	mixin: Constructor,
	includeConstructor: boolean = false,
): void {
	// Figure out the inheritance chain of the mixin
	const inheritanceChain: Constructor[] = [mixin];
	while (true) {
		const current = inheritanceChain[0];
		const base = Object.getPrototypeOf(current);
		if (base?.prototype) {
			inheritanceChain.unshift(base);
		} else {
			break;
		}
	}
	for (const ctor of inheritanceChain) {
		for (const prop of Object.getOwnPropertyNames(ctor.prototype)) {
			// Do not override the constructor
			if (includeConstructor || prop !== "constructor") {
				Object.defineProperty(
					target.prototype,
					prop,
					Object.getOwnPropertyDescriptor(ctor.prototype, prop) ??
						Object.create(null),
				);
			}
		}
	}
}

type Constructors<T extends any[]> = { [K in keyof T]: Constructor<T[K]> };

/**
 * Merges the given base classes into one, so extending from all of them at once is possible.
 * The first one will be included with proper inheritance, the remaining ones are mixed in.
 */
export function AllOf<T extends any[]>(
	...BaseClasses: Constructors<T>
): Constructor<UnionToIntersection<T[number]>> {
	const [First, ...Others] = BaseClasses;
	const ret = class AllOf extends First {};
	for (const base of Others) {
		applyMixin(ret, base);
	}
	return ret as any;
}

/** Tests if base is in the super chain of `constructor` */
export function staticExtends<T extends new (...args: any[]) => any>(
	constructor: unknown,
	base: T,
): constructor is T {
	while (constructor) {
		if (constructor === base) return true;
		constructor = Object.getPrototypeOf(constructor) as unknown;
	}
	return false;
}