Prometheus Entity Management API
    Preparing search index...

    Module @prometheus-ags/entity-graph-svelte

    @prometheus-ags/entity-graph-svelte

    Svelte 5 runes bindings for the Prometheus entity graph.

    Wraps @prometheus-ags/entity-graph-core with reactive stores that update automatically when the underlying entity graph changes — no polling, no prop- drilling, full cross-view reactivity.

    pnpm add @prometheus-ags/entity-graph-svelte @prometheus-ags/entity-graph-core

    @prometheus-ags/entity-graph-core is a required peer: install it explicitly so the application owns the one compatible graph instance. The Svelte binding must not install a private core copy. See the binding singleton contract.

    // src/routes/+layout.svelte or App.svelte
    import { initEntityGraph } from "@prometheus-ags/entity-graph-svelte";

    initEntityGraph({ defaultStaleTime: 30_000, globalListeners: true });

    import {
      registerEntityTransport,
      makeRestTransport,
    } from "@prometheus-ags/entity-graph-core";

    registerEntityTransport(
      "Invoice",
      makeRestTransport({ baseUrl: "/api/invoices" })
    );

    createEntityStore returns a plain object whose properties are tracked by Svelte 5 when accessed inside {#if} / {#each} / {@html} / $derived expressions. Wrap it in $state() so mutations to store.entity etc. are reactive.

    

{#if store.isLoading}
  
    Loading…
    
{:else if store.error}
  
    Error: {store.error}
    
{:else if store.entity}
  
    {store.entity.title}
    
  
{/if}

    

{#if list.isLoading}
  
    Loading…
    
{:else}
  {#each list.items as invoice (invoice.id)}
    
  {/each}
  {#if list.hasNextPage}
    
  {/if}
{/if}

    createEntityStore<TRaw, TEntity>(type, opts): EntityStore<TEntity>

    Option Type Required Description
    id string | null | undefined yes Entity primary key
    fetch (id: string) => Promise<TRaw> yes Transport fetcher
    normalize (raw: TRaw) => TEntity yes Row normalizer
    enabled boolean no Skip fetch when false (default: true)
    staleTime number no Override global stale time (ms)
    idField string no Field containing the entity id (default: "id")

    Returns EntityStore<TEntity>:

    Property Type Description
    entity TEntity | null Merged canonical + patch view
    isLoading boolean Fetch in flight
    error string | null Last fetch error
    isReady boolean Entity loaded and not fetching
    refetch() () => void Force refresh
    destroy() () => void Cleanup — call from onDestroy

    createEntityList<TRaw, TEntity>(type, opts): EntityList<TEntity>

    Option Type Required Description
    queryKey unknown[] yes Stable cache key array
    fetch (params: ListFetchParams) => Promise<ListResponse<TRaw>> yes List fetcher
    normalize (raw: TRaw) => { id: string; data: TEntity } yes Row normalizer
    enabled boolean no Skip fetch when false
    staleTime number no Override global stale time (ms)
    mode "replace" | "append" no Pagination strategy

    Returns EntityList<TEntity>:

    Property Type Description
    items TEntity[] Resolved entity rows
    isLoading boolean Full-page fetch in flight
    isLoadingMore boolean Load-more in flight
    error string | null Last list error
    hasNextPage boolean More pages available
    total number | null Server-reported total
    refetch() () => void Reset and re-fetch page 1
    loadMore() () => void Fetch next page (append)
    destroy() () => void Cleanup

    initEntityGraph(opts?)

    Bootstrap the graph engine. Must be called once before any store is created.

    Option Type Default Description
    globalListeners boolean true Attach focus/reconnect SWR listeners
    defaultStaleTime number 30_000 Global stale time (ms)
    maxRetries number 3 Retry count on transient errors
    (all EngineOptions) — — Forwarded to configureEngine

    The entity graph is a single normalized store. When any adapter writes to entities["Invoice"]["inv-1"], every createEntityStore and createEntityList that references that id re-renders automatically — no cache invalidation needed.

    Svelte component
      └── createEntityStore / createEntityList  (this package)
            └── graphStore.subscribe()          (entity-graph-core)
                  ├── fetchEntity / fetchList   (core engine)
                  └── graph mutations           (core graph.ts)

    Components never touch the graph store directly. All I/O is owned by core.

    CreateEntityListOptions
    CreateEntityStoreOptions
    EntityList
    EntityQueryOptions
    EntityStore
    InitEntityGraphOptions
    ListFetchParams
    ListQueryOptions
    ListState
    EntityId
    EntityType
    createEntityList
    createEntityStore
    initEntityGraph

    Settings
    Member Visibility

    On This Page
    @prometheus-ags/entity-graph-svelte
    Interfaces
    Type Aliases
    Functions