@syncable/core/src/library/change/change.ts

Syncable.

import {Dict, Nominal} from 'tslang';

import {ISyncableObject, SyncableRef} from '../syncable';
import {NumericTimestamp} from '../types';

export type ChangePacketId = Nominal<string, 'change-packet-id'>;

export interface SyncableCreationRef<
  T extends ISyncableObject = ISyncableObject
> {
  type: T['syncable']['_type'];
  create: {
    id: T['syncable']['_id'];
  };
}

export type GeneralSyncableRef =
  | SyncableRef
  | SyncableCreationRef
  | SyncableRef[];

export interface IChange {
  type: string;
  refs: object;
  options: object | undefined;
}

export interface GeneralChange extends IChange {
  refs: Dict<GeneralSyncableRef>;
}

export interface ChangePacket extends GeneralChange {
  id: ChangePacketId;
  createdAt: NumericTimestamp;
}