accelerator-core/src/worldModeling/relations/AdjacencyRelation.ts

[](https://travis-ci.org/furkleindustries/accelerator-core)

import {
  BaseAdjacencies,
} from '../ontology/BaseAdjacencies';
import {
  ContainmentTypes,
} from './ContainmentTypes';
import {
  findAllGenerate,
} from '../querying/findAllGenerate';
import {
  FindAdjacencyArgs,
  IFindBaseArgs,
} from '../querying/FindModelArgs';
import {
  IAdjacencyRelation,
} from './IAdjacencyRelation';
import {
  IModel,
} from '../models/IModel';
import {
  ISerializedAdjacencyRelation,
} from './ISerializedAdjacencyRelation';
import {
  ITag,
} from '../../tags/ITag';
import {
  IWorld,
} from '../world/IWorld';
import {
  ModelType,
} from '../models/ModelType';
import {
  OnticTypes,
} from '../ontology/OnticTypes';
import {
  RelationBase,
} from './RelationBase';

type Adjacencies<T extends BaseAdjacencies = BaseAdjacencies> = T;

export class AdjacencyRelation<
  Type extends OnticTypes,
  Being extends OnticTypes,
  T extends IAdjacencyRelation<Type, Being, any>
> extends RelationBase<Type>
  implements IAdjacencyRelation<Type, Being, any>
{
  protected readonly __modelType: Type;
  public get modelType() {
    return this.__modelType;
  }

  protected readonly __neighbors: Readonly<
    Map<Adjacencies, readonly IModel<Type, Being, ModelType>[]>
  > = Object.freeze(new Map());

  public get neighbors() {
    return this.__neighbors;
  }

  protected __tags: readonly ITag[] = Object.freeze([]);
  public get tags() {
    return this.__tags;
  }

  protected readonly __world: IWorld;
  public get world() {
    return this.__world;
  }

  public readonly addNeighbor = <T extends BaseAdjacencies = BaseAdjacencies>(
    adjacency: T,
    model: IModel<Type, Being, ModelType>,
  ): void => {
    if (this.neighbors.has(adjacency)) {
      const arr = this.neighbors.get(adjacency);
      if (!arr!.find((val) => val.name === model.name)) {
        this.neighbors.set(adjacency, Object.freeze(arr!.concat([ model ])));
      }
    } else {
      const models = Object.freeze([ model ]);
      this.neighbors.set(adjacency, models);
    }
  };

  public readonly clone = (self: T): T => {
    const copy: T = Object.assign(
      Object.create(Object.getPrototypeOf(self)),
      self,
    );

    this.neighbors.forEach((value, key) => value.forEach((model) => (
      copy.addNeighbor(key, model)
    )));

    return copy;
  };

  public readonly destroy = (self: T) => {
    if (typeof self.finalize === 'function') {
      self.finalize(self);
    }

    for (const key of self.neighbors.keys()) {
      self.neighbors.get(key)!.forEach((neighbor) => (
        self.removeNeighbor(key, neighbor))
      );
    }

    self.tags.forEach(self.removeTag);

    ((self: any) => {
      delete self.__modelType;
      delete self.modelType;
      delete self.__tags;
      delete self.tags;
      delete self.__world;
      delete self.world;
    })(self)
  };

  readonly find: (
    args: string |
      IFindBaseArgs<ContainmentTypes> &
        FindAdjacencyArgs<ContainmentTypes, Being, ModelType>,
  ) => IModel<ContainmentTypes, Being, ModelType> | null;

  readonly findAll: (
    args: '*' |
      IFindBaseArgs<ContainmentTypes> &
        FindAdjacencyArgs<ContainmentTypes, Being, ModelType>,
  ) => readonly IModel<ContainmentTypes, Being, ModelType>[];

  readonly findAllGenerator = ((self: T) => function *(
    args: '*' |
      IFindBaseArgs<ContainmentTypes> &
        FindAdjacencyArgs<ContainmentTypes, Being, ModelType>,
  ): IterableIterator<IModel<ContainmentTypes, Being, ModelType>> {
    for (const neighborGroup of self.neighbors.values()) {
      yield* findAllGenerate<ContainmentTypes, Being, ModelType>(
        neighborGroup,
        args as '*',
      );
    }
  })(this);

  public readonly removeNeighbor = <T extends BaseAdjacencies = BaseAdjacencies>(
    adjacency: T,
    model: IModel<Type, Being, ModelType>,
  ): void => {
    if (this.neighbors.has(adjacency)) {
      const arr = this.neighbors.get(adjacency);
      if (!arr!.find((val) => val.name === model.name)) {
        this.neighbors.set(adjacency, Object.freeze(arr!.concat([ model ])));
      }
    }
    
    throw new Error('Adjacency not in AdjacencyRelation.');
  };

  public readonly serializeToObject = (
    self: T,
  ): ISerializedAdjacencyRelation => {
    const neighbors: Record<string, string[]> = {};
    for (const key of self.neighbors.keys()) {
      const value = self.neighbors.get(key);
      if (!value) {
        continue;
      }

      const names = value.map(({ name }) => name);

      if (typeof key === 'string') {
        /* Plain direction enum value. */
        neighbors[key] = names;
      } else if (typeof key === 'object') {
        /* Complex directional mapping. */
        key
      }
    }

    return {
      neighbors,
      modelType: self.modelType,
      tags: [ ...self.tags ],
    };
  };
}