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

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

import {
  addTag,
} from '../../tags/addTag';
import {
  FindModelArgs,
  IFindBaseArgs,
} from '../querying/FindModelArgs';
import {
  getTag,
} from '../../tags/getTag';
import {
  IModel,
} from '../models/IModel';
import {
  IRelation,
} from './IRelation';
import {
  IRelationConstructorArgs,
} from './IRelationConstructorArgs';
import {
  ITag,
} from '../../tags/ITag';
import {
  IWorld,
} from '../world/IWorld';
import {
  ModelType,
} from '../models/ModelType';
import {
  OnticTypes,
} from '../ontology/OnticTypes';
import {
  removeTag,
} from '../../tags/removeTag';

export abstract class RelationBase<
  Type extends ModelType,
> implements IRelation<Type>
{
  protected readonly __modelType: ModelType;
  public get modelType() {
    return this.__modelType;
  }

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

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

  constructor(world: IWorld, args: IRelationConstructorArgs<Type>) {
    this.__world = world;
    this.__modelType = args.modelType;

    if (Array.isArray(args.tags)) {
      args.tags.forEach(this.addTag);
    }

    if (typeof this.initialize === 'function') {
      this.initialize(this);
    }
  }

  public readonly addTag = (tag: ITag) => (
    void (this.__tags = addTag(tag, this.tags))
  );

  public readonly initialize?: (self: IRelation<Type>) => void; 

  public readonly find = (
    args: string | IFindBaseArgs<ModelType>,
  ): IModel<ModelType, OnticTypes, ModelType> | null => this.findAllGenerator(
    typeof args === 'string' ?
      { name: args } :
      args,
  ).next().value || null;
  
  public readonly findAll = (
    args: '*' | IFindBaseArgs<ModelType>,
  ): readonly IModel<ModelType, OnticTypes, ModelType>[] =>
  {
    const ret = [];
    for (const model of this.findAllGenerator(args)) {
      ret.push(model);
    }

    return ret;
  };

  public readonly finalize?: (self: IRelation<Type>) => void; 

  public readonly getTag = (tag: ITag) => getTag(this.tags, tag);

  public readonly removeTag = (tag: ITag) => (
    void (this.__tags = removeTag(this.tags, tag))
  );

  public readonly serialize = (
    self: IRelation<Type>,
    spaces?: number,
  ): string => JSON.stringify(this.serializeToObject(self), null, spaces);

  public abstract readonly findAllGenerator: (
    args: '*' | FindModelArgs<ModelType, OnticTypes, ModelType>,
  ) => IterableIterator<IModel<ModelType, OnticTypes, ModelType>>;

  public abstract readonly clone: (self: IRelation<Type>) => any;
  public abstract readonly destroy: (self: IRelation<Type>) => void;
  public abstract readonly serializeToObject: (
    self: IRelation<Type>,
  ) => Readonly<Record<string, any>>;
}