Function createEntity

core/entity.ts:84–169

({
  data,
  client,
}: CreateEntityInput<D, V>)

}

export function createEntity<D, V>({
  data,
  client,
}: CreateEntityInput<D, V>): Entity<D, V> {
  const { store } = client;
  const { definition, db } = store;

  const { config } = definition;
  const dataWithDefaults = fillDataDefaults(data, store);

  assertDataMatchDefinition(dataWithDefaults, definition);

  const initialKey = data[config.idField!];

  const observableData = makeAutoObservable<D & object>(
    dataWithDefaults as D & object,
    config.customObservableAnnotations,
    {
      name: `${definition.config.name}-${initialKey}`,
    }
  );

  const cleanupObject = createCleanupObject();

  const viewLinker: EntityViewLinker<D> = {
    db,
    updateSelf(data) {
      return entity.update(data) as EntityUpdatedEvent<D, unknown>;
    },
    cleanup: cleanupObject,
  };

  const view = config.getView?.(observableData, viewLinker) ?? ({} as V);

  // Note: we dont want to add view as {...data, ...connections}. Connections might have getters so it would simply unwrap them.
  const observableDataAndView = extendObservable(
    observableData,
    view as V & object
  );

  const entityMethods: EntityMethods<D, V> = {
    definition,
    db: db,
    store: store,
    client,
    cleanup: cleanupObject,
    remove() {
      client.remove(entityMethods.getId());
    },
    isRemoved() {
      return !store.findById(entityMethods.getId());
    },
    getId() {
      return `${entity[config.idField!]}`;
    },
    getIdPropName() {
      return config.idField as string;
    },