aurelia/aurelia

import { Writable } from '@aurelia/kernel';
import { ICustomElementController, IHydratedController, IHydratedParentController } from '@aurelia/runtime-html';
import { Params, RouteNode, NavigationInstruction, IRouteViewModel } from '@aurelia/router-lite';
import { IHookInvocationAggregator } from './hook-invocation-tracker.js';
import { IHookSpec, hookSpecsMap } from './hook-spec.js';

export interface ITestRouteViewModel extends IRouteViewModel {
  readonly $controller: ICustomElementController<this>;
  readonly name: string;

  binding(initiator: IHydratedController, parent: IHydratedParentController): void | Promise<void>;
  bound(initiator: IHydratedController, parent: IHydratedParentController): void | Promise<void>;
  attaching(initiator: IHydratedController, parent: IHydratedParentController): void | Promise<void>;
  attached(initiator: IHydratedController): void | Promise<void>;

  detaching(initiator: IHydratedController, parent: IHydratedParentController): void | Promise<void>;
  unbinding(initiator: IHydratedController, parent: IHydratedParentController): void | Promise<void>;

  canLoad(params: Params, next: RouteNode, current: RouteNode | null): boolean | NavigationInstruction | NavigationInstruction[] | Promise<boolean | NavigationInstruction | NavigationInstruction[]>;
  loading(params: Params, next: RouteNode, current: RouteNode | null): void | Promise<void>;
  canUnload(next: RouteNode | null, current: RouteNode): boolean | Promise<boolean>;
  unloading(next: RouteNode | null, current: RouteNode): void | Promise<void>;
}

export class HookSpecs {
  public static get DEFAULT(): HookSpecs {
    return HookSpecs.create({});
  }

  private constructor(
    public readonly binding: IHookSpec<'binding'>,
    public readonly bound: IHookSpec<'bound'>,
    public readonly attaching: IHookSpec<'attaching'>,
    public readonly attached: IHookSpec<'attached'>,

    public readonly detaching: IHookSpec<'detaching'>,
    public readonly unbinding: IHookSpec<'unbinding'>,

    public readonly $dispose: IHookSpec<'dispose'>,

    public readonly canLoad: IHookSpec<'canLoad'>,
    public readonly loading: IHookSpec<'loading'>,
    public readonly canUnload: IHookSpec<'canUnload'>,
    public readonly unloading: IHookSpec<'unloading'>,
  ) {}

  public static create(
    input: Partial<HookSpecs>,
  ): HookSpecs {
    return new HookSpecs(
      input.binding ?? hookSpecsMap.binding.sync,
      input.bound ?? hookSpecsMap.bound.sync,
      input.attaching ?? hookSpecsMap.attaching.sync,
      input.attached ?? hookSpecsMap.attached.sync,

      input.detaching ?? hookSpecsMap.detaching.sync,
      input.unbinding ?? hookSpecsMap.unbinding.sync,

      hookSpecsMap.dispose,

      input.canLoad ?? hookSpecsMap.canLoad.sync,
      input.loading ?? hookSpecsMap.loading.sync,
      input.canUnload ?? hookSpecsMap.canUnload.sync,
      input.unloading ?? hookSpecsMap.unloading.sync,
    );
  }

  public dispose(): void {
    const $this = this as Partial<Writable<this>>;

    $this.binding = void 0;
    $this.bound = void 0;
    $this.attaching = void 0;
    $this.attached = void 0;

    $this.detaching = void 0;
    $this.unbinding = void 0;

    $this.$dispose = void 0;

    $this.canLoad = void 0;
    $this.loading = void 0;
    $this.canUnload = void 0;
    $this.unloading = void 0;
  }

  public toString(exclude?: string): string {
    const strings: string[] = [];
    for (const k of hookNames) {
      const spec = this[k];
      if (spec.type !== exclude) {
        strings.push(`${spec.name}.${spec.type}`);
      }
    }
    return strings.length > 0 ? `Hooks(${strings.join(',')})` : '';
  }
}

const hookNames = [
  'binding',
  'bound',
  'attaching',
  'attached',

  'detaching',
  'unbinding',

  'canLoad',
  'loading',
  'canUnload',
  'unloading',
] as const;

export abstract class TestRouteViewModelBase implements ITestRouteViewModel {
  public readonly $controller!: ICustomElementController<this>;
  public get name(): string {
    return this.$controller.definition.name;
  }

  public constructor(
    public readonly hia: IHookInvocationAggregator,

    public readonly specs: HookSpecs = HookSpecs.DEFAULT,
  ) {}

  public binding(
    initiator: IHydratedController,
    parent: IHydratedParentController,
  ): void | Promise<void> {
    return this.specs.binding.invoke(
      this,
      () => {
        this.hia.binding.notify(this.name);
        return this.$binding(initiator, parent);
      },
    );
  }

  public bound(
    initiator: IHydratedController,
    parent: IHydratedParentController,
  ): void | Promise<void> {
    return this.specs.bound.invoke(
      this,
      () => {
        this.hia.bound.notify(this.name);
        return this.$bound(initiator, parent);
      },
    );
  }

  public attaching(
    initiator: IHydratedController,
    parent: IHydratedParentController,
  ): void | Promise<void> {
    return this.specs.attaching.invoke(
      this,
      () => {
        this.hia.attaching.notify(this.name);
        return this.$attaching(initiator, parent);
      },
    );
  }

  public attached(
    initiator: IHydratedController,
  ): void | Promise<void> {
    return this.specs.attached.invoke(
      this,
      () => {
        this.hia.attached.notify(this.name);
        return this.$attached(initiator);
      },
    );
  }

  public detaching(
    initiator: IHydratedController,
    parent: IHydratedParentController,
  ): void | Promise<void> {
    return this.specs.detaching.invoke(
      this,
      () => {
        this.hia.detaching.notify(this.name);
        return this.$detaching(initiator, parent);
      },
    );
  }

  public unbinding(
    initiator: IHydratedController,
    parent: IHydratedParentController,
  ): void | Promise<void> {
    return this.specs.unbinding.invoke(
      this,
      () => {
        this.hia.unbinding.notify(this.name);
        return this.$unbinding(initiator, parent);
      },
    );
  }

  public dispose(): void {
    this.specs.$dispose.invoke(
      this,
      () => {
        this.hia.$$dispose.notify(this.name);
        this.$dispose();
      },
    );
  }

  public canLoad(
    params: Params,
    next: RouteNode,
    current: RouteNode | null,
  ): boolean | NavigationInstruction | NavigationInstruction[] | Promise<boolean | NavigationInstruction | NavigationInstruction[]> {
    return this.specs.canLoad.invoke(
      this,
      () => {
        this.hia.canLoad.notify(this.name);
        return this.$canLoad(params, next, current);
      },
    );
  }

  public loading(
    params: Params,
    next: RouteNode,
    current: RouteNode | null,
  ): void | Promise<void> {
    return this.specs.loading.invoke(
      this,
      () => {
        this.hia.loading.notify(this.name);
        return this.$loading(params, next, current);
      },
    );
  }

  public canUnload(
    next: RouteNode | null,
    current: RouteNode,
  ): boolean | Promise<boolean> {
    return this.specs.canUnload.invoke(
      this,
      () => {
        this.hia.canUnload.notify(this.name);
        return this.$canUnload(next, current);
      },
    );
  }

  public unloading(
    next: RouteNode | null,
    current: RouteNode,
  ): void | Promise<void> {
    return this.specs.unloading.invoke(
      this,
      () => {
        this.hia.unloading.notify(this.name);
        return this.$unloading(next, current);
      },
    );
  }

  protected $binding(
    _initiator: IHydratedController,
    _parent: IHydratedParentController,
  ): void | Promise<void> {
    // do nothing
  }

  protected $bound(
    _initiator: IHydratedController,
    _parent: IHydratedParentController,
  ): void | Promise<void> {
    // do nothing
  }

  protected $attaching(
    _initiator: IHydratedController,
    _parent: IHydratedParentController,
  ): void | Promise<void> {
    // do nothing
  }

  protected $attached(
    _initiator: IHydratedController,
  ): void | Promise<void> {
    // do nothing
  }

  protected $detaching(
    _initiator: IHydratedController,
    _parent: IHydratedParentController,
  ): void | Promise<void> {
    // do nothing
  }

  protected $unbinding(
    _initiator: IHydratedController,
    _parent: IHydratedParentController,
  ): void | Promise<void> {
    // do nothing
  }

  protected $canLoad(
    _params: Params,
    _next: RouteNode,
    _current: RouteNode | null,
  ): boolean | NavigationInstruction | NavigationInstruction[] | Promise<boolean | NavigationInstruction | NavigationInstruction[]> {
    return true;
  }

  protected $loading(
    _params: Params,
    _next: RouteNode,
    _current: RouteNode | null,
  ): void | Promise<void> {
    // do nothing
  }

  protected $canUnload(
    _next: RouteNode | null,
    _current: RouteNode,
  ): boolean | Promise<boolean> {
    return true;
  }

  protected $unloading(
    _next: RouteNode | null,
    _current: RouteNode,
  ): void | Promise<void> {
    // do nothing
  }

  protected $dispose(): void {
    const $this = this as Partial<Writable<this>>;

    $this.hia = void 0;
    $this.specs = void 0;
  }
}