@glimmer/interfaces/lib/components.d.ts

Common interfaces shared among all @glimmer/\* projects

import type { Dict } from './core.js';
import type { InternalComponentManager } from './managers.js';
import type { Reference } from './references.js';
import type { ScopeSlot } from './runtime.js';
import type { CompilableProgram } from './template.js';
import type { ProgramSymbolTable } from './tier1/symbol-table.js';

export type ComponentDefinitionState = object;
export type ComponentInstanceState = unknown;

declare const CapabilityBrand: unique symbol;
export type CapabilityMask = number & {
  [CapabilityBrand]: never;
};

export interface ComponentDefinition<
  D extends ComponentDefinitionState = ComponentDefinitionState,
  I = ComponentInstanceState,
  M extends InternalComponentManager<I, D> = InternalComponentManager<I, D>,
> {
  resolvedName: string | null;
  handle: number;
  state: D;
  manager: M;
  capabilities: CapabilityMask;
  compilable: CompilableProgram | null;
  debugName?: string | undefined;
}

export interface ComponentInstance<
  D extends ComponentDefinitionState = ComponentDefinitionState,
  I = ComponentInstanceState,
  M extends InternalComponentManager<I, D> = InternalComponentManager<I, D>,
> {
  definition: ComponentDefinition<D, I>;
  manager: M;
  capabilities: CapabilityMask;
  state: I;
  handle: number;
  table: ProgramSymbolTable;
  lookup: Record<string, ScopeSlot> | null;
}

export interface PreparedArguments {
  positional: ReadonlyArray<Reference>;
  named: Dict<Reference>;
}