# beta754/vef architecture

> Architecture diagram of the GitHub repository beta754/vef, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/beta754/vef
- Repository: https://github.com/beta754/vef

## Overview

efmdb is a small TypeScript entity-framework library with MongoDB-oriented query types and abstract entity-store contracts. A typical consumer defines server or versioned entities, then implements a store for lookup, search, and mutation; the library also supplies cursors, patches, ownership types, and utility helpers. The README describes Mongo support, but the sampled stores are abstract contracts, not a MongoDB adapter. Some utility implementations were not sampled, so their internal behavior and connections are omitted.

Main entry points: [`src/ServerEntityStore.ts`](https://github.com/beta754/vef/blob/master/src/ServerEntityStore.ts) (Server entity store), [`src/VersionedEntityStore.ts`](https://github.com/beta754/vef/blob/master/src/VersionedEntityStore.ts) (Versioned entity store), [`src/utils/GlobalInjector.ts`](https://github.com/beta754/vef/blob/master/src/utils/GlobalInjector.ts) (Global injector), [`src/utils/Record.ts`](https://github.com/beta754/vef/blob/master/src/utils/Record.ts) (Record helpers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_models["Entity models"]
  node_server_entity["Server entity<br/>[ServerEntity.ts]"]
  node_owner["Entity owner<br/>[EntityOwner.ts]"]
  node_versioned_entity["Versioned entity<br/>[VersionedEntity.ts]"]
  node_patch["Entity patch<br/>[EntityPatch.ts]"]
  node_cursor["Search cursor<br/>[Cursor.ts]"]
end

subgraph group_stores["Store contracts"]
  node_server_store["Server entity store"]
  node_versioned_store["Versioned entity store"]
end

subgraph group_utilities["Utilities"]
  node_record["Record helpers<br/>[Record.ts]"]
  node_registry["Smart registry<br/>[SmartRegistry.ts]"]
  node_injector["Global injector<br/>[GlobalInjector.ts]"]
  node_async["Async helpers<br/>[Async.ts]"]
  node_mutate["Mutation helpers<br/>[Mutate.ts]"]
  node_mem2["Memoization helper<br/>[mem2.ts]"]
end

node_consumer(("Library consumer"))
node_mem["mem package"]

node_consumer -.->|"implements"| node_server_store
node_consumer -.->|"implements"| node_versioned_store
node_owner -->|"implements"| node_server_entity
node_server_store -->|"stores"| node_server_entity
node_server_store -->|"returns"| node_cursor
node_server_store -->|"accepts"| node_patch
node_server_store -->|"uses types"| node_record
node_versioned_store -->|"stores"| node_versioned_entity
node_versioned_store -->|"returns"| node_cursor
node_versioned_store -->|"accepts"| node_patch
node_versioned_store -->|"uses types"| node_record
node_registry -->|"uses helpers"| node_record
node_injector -->|"creates"| node_registry
node_injector -->|"types service"| node_owner
node_injector -->|"types service"| node_server_store
node_mem2 -->|"wraps"| node_mem

click node_server_entity "https://github.com/beta754/vef/blob/master/src/ServerEntity.ts"
click node_owner "https://github.com/beta754/vef/blob/master/src/EntityOwner.ts"
click node_versioned_entity "https://github.com/beta754/vef/blob/master/src/VersionedEntity.ts"
click node_patch "https://github.com/beta754/vef/blob/master/src/EntityPatch.ts"
click node_cursor "https://github.com/beta754/vef/blob/master/src/Cursor.ts"
click node_server_store "https://github.com/beta754/vef/blob/master/src/ServerEntityStore.ts"
click node_versioned_store "https://github.com/beta754/vef/blob/master/src/VersionedEntityStore.ts"
click node_record "https://github.com/beta754/vef/blob/master/src/utils/Record.ts"
click node_registry "https://github.com/beta754/vef/blob/master/src/utils/SmartRegistry.ts"
click node_injector "https://github.com/beta754/vef/blob/master/src/utils/GlobalInjector.ts"
click node_async "https://github.com/beta754/vef/blob/master/src/utils/Async.ts"
click node_mutate "https://github.com/beta754/vef/blob/master/src/utils/Mutate.ts"
click node_mem2 "https://github.com/beta754/vef/blob/master/src/utils/mem2.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_server_entity,node_owner,node_versioned_entity,node_patch,node_cursor toneBlue
class node_server_store,node_versioned_store toneAmber
class node_record,node_registry,node_injector,node_async,node_mutate,node_mem2 toneMint
class node_consumer,node_mem toneIndigo
```

## Components

### Entity models

- [Server entity](https://github.com/beta754/vef/blob/master/src/ServerEntity.ts): `src/ServerEntity.ts`
- [Entity owner](https://github.com/beta754/vef/blob/master/src/EntityOwner.ts): `src/EntityOwner.ts`
- [Versioned entity](https://github.com/beta754/vef/blob/master/src/VersionedEntity.ts): `src/VersionedEntity.ts`
- [Entity patch](https://github.com/beta754/vef/blob/master/src/EntityPatch.ts): `src/EntityPatch.ts`
- [Search cursor](https://github.com/beta754/vef/blob/master/src/Cursor.ts): `src/Cursor.ts`

### Store contracts

- [Server entity store](https://github.com/beta754/vef/blob/master/src/ServerEntityStore.ts): `src/ServerEntityStore.ts`
- [Versioned entity store](https://github.com/beta754/vef/blob/master/src/VersionedEntityStore.ts): `src/VersionedEntityStore.ts`

### Utilities

- [Record helpers](https://github.com/beta754/vef/blob/master/src/utils/Record.ts): `src/utils/Record.ts`
- [Smart registry](https://github.com/beta754/vef/blob/master/src/utils/SmartRegistry.ts): `src/utils/SmartRegistry.ts`
- [Global injector](https://github.com/beta754/vef/blob/master/src/utils/GlobalInjector.ts): `src/utils/GlobalInjector.ts`
- [Async helpers](https://github.com/beta754/vef/blob/master/src/utils/Async.ts): `src/utils/Async.ts`
- [Mutation helpers](https://github.com/beta754/vef/blob/master/src/utils/Mutate.ts): `src/utils/Mutate.ts`
- [Memoization helper](https://github.com/beta754/vef/blob/master/src/utils/mem2.ts): `src/utils/mem2.ts`

### Other components

- **Library consumer**
- **mem package**

## Connections

- Library consumer → Server entity store: implements (evidence: `README.md`)
- Library consumer → Versioned entity store: implements (evidence: `README.md`)
- Entity owner → Server entity: implements (evidence: `src/EntityOwner.ts`)
- Server entity store → Server entity: stores (evidence: `src/ServerEntityStore.ts`)
- Server entity store → Search cursor: returns (evidence: `src/ServerEntityStore.ts`)
- Server entity store → Entity patch: accepts (evidence: `src/ServerEntityStore.ts`)
- Server entity store → Record helpers: uses types (evidence: `src/ServerEntityStore.ts`)
- Versioned entity store → Versioned entity: stores (evidence: `src/VersionedEntityStore.ts`)
- Versioned entity store → Search cursor: returns (evidence: `src/VersionedEntityStore.ts`)
- Versioned entity store → Entity patch: accepts (evidence: `src/VersionedEntityStore.ts`)
- Versioned entity store → Record helpers: uses types (evidence: `src/VersionedEntityStore.ts`)
- Smart registry → Record helpers: uses helpers (evidence: `src/utils/SmartRegistry.ts`)
- Global injector → Smart registry: creates (evidence: `src/utils/GlobalInjector.ts`)
- Global injector → Entity owner: types service (evidence: `src/utils/GlobalInjector.ts`)
- Global injector → Server entity store: types service (evidence: `src/utils/GlobalInjector.ts`)
- Memoization helper → mem package: wraps (evidence: `src/utils/mem2.ts`)
