accelerator-core/src/worldModeling/models/IModel.ts

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

import {
  EpistemicTypes,
} from '../epistemology/EpistemicTypes';
import {
  IEpistemology,
} from '../epistemology/IEpistemology';
import {
  IFindBaseArgs,
} from '../querying/FindModelArgs';
import {
  INamed,
} from '../../interfaces/INamed';
import {
  IOntology,
} from '../ontology/IOntology';
import {
  ISerializedModel,
} from './ISerializedModel';
import {
  ITag,
} from '../../tags/ITag';
import {
  IWorld,
} from '../world/IWorld';
import {
  ModelType,
} from './ModelType';
import {
  OnticTypes,
} from '../ontology/OnticTypes';
import {
  Tag,
} from '../../tags/Tag';

export interface IModel<
  /**
   * The abstract, conceptual type of the model, determining in the most basic
   * way what the model is, and what it may do.
   */
  Type extends ModelType,

  /**
   * The types to which the model will be able to ontically relate, assuming
   * its type permits any given relation.
   */
  Being extends OnticTypes = any,

  /**
   * The types to which the model will be able to epistemically relate,
   * assuming its type permits any given relation.
   */
  Knowledge extends ModelType = any,
> extends INamed
{
  readonly being: Type extends OnticTypes ?
    IOntology<Type, Being> :
    null;

  /**
   * Note that Thought models are not included in the epistemic types. This is
   * because thought models are intended to be a thin affordance for globally
   * generic thoughts or concepts, and these models cannot "know" anything at
   * all.
   */
  readonly knowledge: Type extends EpistemicTypes ?
    IEpistemology<Type, Knowledge> :
    null;

  readonly tags: readonly ITag[];
  readonly type: Type;
  readonly world: IWorld;
  readonly addTag: (tag: Tag) => void;
  readonly clone: (
    self: IModel<Type, Being, Knowledge>,
  ) => IModel<Type, Being, Knowledge>;

  readonly destroy: (self: IModel<Type, Being, Knowledge>) => void;
  readonly finalize: (self: IModel<Type, Being, Knowledge>) => void;
  readonly find: (
    args: string | IFindBaseArgs<ModelType>,
  ) => IModel<ModelType, Being, Knowledge> | null;

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

  readonly findAllGenerator: (
    args: '*' | IFindBaseArgs<ModelType>,
  ) => IterableIterator<IModel<ModelType, Being, Knowledge>>;

  readonly getTag: (toSearch: Tag) => ITag | null;
  readonly initialize: (self: IModel<Type, Being, Knowledge>) => void;
  readonly removeTag: (toSearch: Tag) => void;

  readonly serialize: (
    self: IModel<Type, Being, Knowledge>,    
    spaces?: number,
  ) => string;

  readonly serializeToObject: (
    self: IModel<Type, Being, Knowledge>,
    spaces?: number,
  ) => ISerializedModel;
}