Firegraph

Warning: This library is experimental. APIs may change without notice between releases.

A typed graph data layer for Firebase Cloud Firestore. Store nodes and edges as triples in a Firestore collection with smart query planning, sharded document IDs, optional schema validation, multi-hop traversal, and nested subgraphs.

Install

npm install firegraph
# or
pnpm add firegraph

Firegraph requires @google-cloud/firestore ^8.0.0 as a peer dependency. npm 7+ and pnpm auto-install peer deps, so this is typically handled for you.

When installing from git (not npm), firegraph builds itself via a prepare script. The consuming project needs tsup and typescript as dev dependencies:

npm install -D tsup typescript

pnpm 10+ blocks dependency build scripts by default. Allow firegraph and esbuild in your package.json:

{
  "pnpm": {
    "onlyBuiltDependencies": ["esbuild", "firegraph"]
  }
}

Quick Start

import { Firestore } from '@google-cloud/firestore';
import { createGraphClient, generateId } from 'firegraph';

const db = new Firestore();
const g = createGraphClient(db, 'graph');

// Create nodes
const tourId = generateId();
await g.putNode('tour', tourId, { name: 'Dolomites Classic', difficulty: 'hard' });

const depId = generateId();
await g.putNode('departure', depId, { date: '2025-07-15', maxCapacity: 30 });

// Create an edge
await g.putEdge('tour', tourId, 'hasDeparture', 'departure', depId, { order: 0 });

// Query edges
const departures = await g.findEdges({ aUid: tourId, axbType: 'hasDeparture' });

Core Concepts

Graph Model

Firegraph stores everything as triples in a Firestore collection (with optional nested subcollections for subgraphs):

(aType, aUid) -[axbType]-> (bType, bUid)

Nodes are self-referencing edges with the special relation is: (tour, Kj7vNq2mP9xR4wL1tY8s3) -[is]-> (tour, Kj7vNq2mP9xR4wL1tY8s3)
Edges are directed relationships between nodes: (tour, Kj7vNq2mP9xR4wL1tY8s3) -[hasDeparture]-> (departure, Xp4nTk8qW2vR7mL9jY5a1)

Every record carries a data payload (arbitrary JSON), plus createdAt and updatedAt server timestamps. Records managed by a schema registry with migrations also carry a v field (schema version number, derived from max(toVersion) of the migrations array) on the record envelope.

Document IDs

UIDs must be generated via generateId() (21-char nanoid). Short sequential strings like tour1 create Firestore write hotspots.

Nodes: The UID itself (e.g., Kj7vNq2mP9xR4wL1tY8s3)
Edges: shard:aUid:axbType:bUid where the shard prefix (0–f) is derived from SHA-256, distributing writes across 16 buckets to avoid Firestore hotspots

API Reference

Creating a Client

import { createGraphClient } from 'firegraph';

const g = createGraphClient(db, 'graph');
// or with options:
const g = createGraphClient(db, 'graph', { registry });

Parameters:

db — A Firestore instance from @google-cloud/firestore
collectionPath — Firestore collection path for all graph data
options.registry — Optional GraphRegistry for schema validation
options.queryMode — Query backend: 'pipeline' (default) or 'standard'

Nodes

const tourId = generateId();

// Create or overwrite a node
await g.putNode('tour', tourId, { name: 'Dolomites Classic' });

// Read a node
const node = await g.getNode(tourId);
// → StoredGraphRecord | null

// Update fields (merge)
await g.updateNode(tourId, { 'data.difficulty': 'extreme' });

// Delete a node
await g.removeNode(tourId);

// Find all nodes of a type
const tours = await g.findNodes({ aType: 'tour' });

Edges

const depId = generateId();

// Create or overwrite an edge
await g.putEdge('tour', tourId, 'hasDeparture', 'departure', depId, { order: 0 });

// Read a specific edge
const edge = await g.getEdge(tourId, 'hasDeparture', depId);
// → StoredGraphRecord | null

// Check existence
const exists = await g.edgeExists(tourId, 'hasDeparture', depId);

// Delete an edge
await g.removeEdge(tourId, 'hasDeparture', depId);

Querying Edges

findEdges accepts any combination of filters. When all three identifiers (aUid, axbType, bUid) are provided, it uses a direct document lookup instead of a query scan.

// Forward: all departures of a tour
await g.findEdges({ aUid: tourId, axbType: 'hasDeparture' });

// Reverse: all tours that have this departure
await g.findEdges({ axbType: 'hasDeparture', bUid: depId });

// Type-scoped: all hasDeparture edges from any tour
await g.findEdges({ aType: 'tour', axbType: 'hasDeparture' });

// With limit and ordering
await g.findEdges({
  aUid: tourId,
  axbType: 'hasDeparture',
  limit: 5,
  orderBy: { field: 'data.order', direction: 'asc' },
});

Transactions

Full read-write transactions with automatic retry:

await g.runTransaction(async (tx) => {
  const dep = await tx.getNode(depId);
  const count = (dep?.data.registeredRiders as number) || 0;

  if (count < 30) {
    await tx.putEdge('departure', depId, 'hasRider', 'rider', riderId, {});
    await tx.updateNode(depId, { 'data.registeredRiders': count + 1 });
  }
});

The transaction object (tx) has the same read/write methods as the client. Writes are synchronous within the transaction and committed atomically.

Batches

Atomic batch writes (no reads):

const batch = g.batch();
const aliceId = generateId();
const bobId = generateId();
await batch.putNode('rider', aliceId, { name: 'Alice' });
await batch.putNode('rider', bobId, { name: 'Bob' });
await batch.putEdge('rider', aliceId, 'friends', 'rider', bobId, {});
await batch.commit();

Graph Traversal

Multi-hop traversal with budget enforcement, concurrency control, in-memory filtering, and cross-graph hops:

import { createTraversal } from 'firegraph';

// Tour → Departures → Riders (2 hops)
const result = await createTraversal(g, tourId)
  .follow('hasDeparture', { limit: 5, bType: 'departure' })
  .follow('hasRider', {
    limit: 20,
    filter: (edge) => edge.data.status === 'confirmed',
  })
  .run({ maxReads: 200, returnIntermediates: true });

result.nodes;      // StoredGraphRecord[] — edges from the final hop
result.hops;       // HopResult[] — per-hop breakdown
result.totalReads; // number — Firestore reads consumed
result.truncated;  // boolean — true if budget was hit

createTraversal accepts a GraphClient or GraphReader. When passed a GraphClient, cross-graph hops via targetGraph are supported (see Cross-Graph Edges).

Reverse Traversal

Walk edges backwards to find parents:

// Rider → Departures → Tours
const result = await createTraversal(g, riderId)
  .follow('hasRider', { direction: 'reverse' })
  .follow('hasDeparture', { direction: 'reverse' })
  .run();

// result.nodes contains the tour edges

Traversal in Transactions

await g.runTransaction(async (tx) => {
  const result = await createTraversal(tx, tourId)
    .follow('hasDeparture')
    .follow('hasRider')
    .run();
  // Use result to make transactional writes...
});

Hop Options

Option	Type	Default	Description
`direction`	`'forward' \| 'reverse'`	`'forward'`	Edge direction
`aType`	`string`	—	Filter source node type
`bType`	`string`	—	Filter target node type
`limit`	`number`	`10`	Max edges per source node
`orderBy`	`{ field, direction? }`	—	Firestore-level ordering
`filter`	`(edge) => boolean`	—	In-memory post-filter
`targetGraph`	`string`	—	Subgraph to cross into (forward only). See Cross-Graph Edges

Run Options

Option	Type	Default	Description
`maxReads`	`number`	`100`	Total Firestore read budget
`concurrency`	`number`	`5`	Max parallel queries per hop
`returnIntermediates`	`boolean`	`false`	Include edges from all hops

When filter is set, the limit is applied after filtering (in-memory), so Firestore returns all matching edges and the filter + slice happens client-side.

Schema Registry

Optional type validation using Zod (or any object with a .parse() method):

import { createRegistry, createGraphClient } from 'firegraph';
import { z } from 'zod';

const registry = createRegistry([
  {
    aType: 'tour',
    axbType: 'is',
    bType: 'tour',
    dataSchema: z.object({
      name: z.string(),
      difficulty: z.enum(['easy', 'medium', 'hard']),
    }),
  },
  {
    aType: 'tour',
    axbType: 'hasDeparture',
    bType: 'departure',
    // No dataSchema = any data allowed for this edge type
  },
]);

const g = createGraphClient(db, 'graph', { registry });

// This validates against the registry before writing:
const id = generateId();
await g.putNode('tour', id, { name: 'Alps', difficulty: 'hard' }); // OK
await g.putNode('tour', id, { name: 123 }); // throws ValidationError

// Unregistered triples are rejected:
await g.putEdge('tour', id, 'unknownRel', 'x', generateId(), {}); // throws RegistryViolationError

Dynamic Registry

For agent-driven or runtime-extensible schemas, firegraph supports a dynamic registry where node and edge types are defined as graph data itself (meta-nodes). The workflow is: define → reload → write.

import { createGraphClient } from 'firegraph';

const g = createGraphClient(db, 'graph', {
  registryMode: { mode: 'dynamic' },
});

// 1. Define types (stored as meta-nodes in the graph)
await g.defineNodeType('tour', {
  type: 'object',
  required: ['name'],
  properties: { name: { type: 'string' } },
  additionalProperties: false,
});

await g.defineEdgeType(
  'hasDeparture',
  { from: 'tour', to: 'departure' },
  { type: 'object', properties: { order: { type: 'number' } } },
);

// 2. Compile the registry from stored definitions
await g.reloadRegistry();

// 3. Write domain data — validated against the compiled registry
const tourId = generateId();
await g.putNode('tour', tourId, { name: 'Dolomites Classic' }); // OK
await g.putNode('booking', generateId(), { total: 500 }); // throws RegistryViolationError

Key behaviors:

Before reloadRegistry(): Domain writes are rejected. Only meta-type writes (defineNodeType, defineEdgeType) are allowed.
After reloadRegistry(): Domain writes are validated against the compiled registry. Unknown types are always rejected.
Upsert semantics: Calling defineNodeType('tour', ...) twice overwrites the previous definition. After reloading, the latest schema is used.
Separate collection: Meta-nodes can be stored in a different collection via registryMode: { mode: 'dynamic', collection: 'meta' }.
Merged mode: Provide both registry (static) and registryMode (dynamic) to get a merged registry where static entries take priority and dynamic definitions can only add new types — not override existing ones.

Dynamic registry returns a DynamicGraphClient which extends GraphClient with defineNodeType(), defineEdgeType(), and reloadRegistry(). Transactions and batches also validate against the compiled dynamic registry.

Schema Versioning & Auto-Migration

Firegraph supports schema versioning with automatic migration of records on read. The schema version is derived automatically as max(toVersion) from the migrations array -- there is no separate schemaVersion property to set. When a record's stored version (v) is behind the derived version, migration functions run automatically to bring data up to the current version.

import { createRegistry, createGraphClient } from 'firegraph';
import type { MigrationStep } from 'firegraph';

const migrations: MigrationStep[] = [
  { fromVersion: 0, toVersion: 1, up: (d) => ({ ...d, status: d.status ?? 'draft' }) },
  { fromVersion: 1, toVersion: 2, up: async (d) => ({ ...d, active: true }) },
];

const registry = createRegistry([
  {
    aType: 'tour',
    axbType: 'is',
    bType: 'tour',
    jsonSchema: tourSchemaV2,
    migrations,                    // version derived as max(toVersion) = 2
    migrationWriteBack: 'eager',
  },
]);

const g = createGraphClient(db, 'graph', { registry });

// Reading a v0 record automatically migrates it to v2 in memory
const tour = await g.getNode(tourId);
// tour.v === 2, tour.data.status === 'draft', tour.data.active === true

How It Works

Version storage: The v field lives on the record envelope (top-level, alongside aType, data, etc.), not inside data. Records without v are treated as version 0 (legacy data).
Read path: When a record is read and its v is behind the derived version (max(toVersion) from migrations), migrations run sequentially to bring data up to the current version.
Write path: When writing via putNode/putEdge, the record is stamped with v equal to the derived version automatically.
updateNode: Does not stamp v — it is a raw partial update without schema context. The next read re-triggers migration (which is idempotent).

Write-Back

Write-back controls whether migrated data is persisted back to Firestore after a read-triggered migration:

Mode	Behavior
`'off'`	In-memory only; Firestore document unchanged (default)
`'eager'`	Fire-and-forget write after read; inline update in transactions
`'background'`	Same as eager but errors are swallowed with a `console.warn`

Resolution order: entry.migrationWriteBack > client.migrationWriteBack > 'off'

// Global default
const g = createGraphClient(db, 'graph', {
  registry,
  migrationWriteBack: 'background',
});

// Entry-level override (takes priority)
createRegistry([{
  aType: 'tour', axbType: 'is', bType: 'tour',
  migrations,
  migrationWriteBack: 'eager',
}]);

Dynamic Registry Migrations

In dynamic mode, migrations are stored as source code strings:

await g.defineNodeType('tour', tourSchema, 'A tour', {
  migrations: [
    { fromVersion: 0, toVersion: 1, up: '(d) => ({ ...d, status: "draft" })' },
  ],
  migrationWriteBack: 'eager',
});
await g.reloadRegistry();

Stored migration strings must be self-contained — no import, require, or external references. Firestore special types (Timestamp, GeoPoint, VectorValue, DocumentReference) are transparently preserved through the sandbox boundary via tagged serialization. Inside the sandbox, these appear as tagged plain objects (e.g., { __firegraph_ser__: 'Timestamp', seconds: N, nanoseconds: N }) that the migration can read, modify, or create. They are reconstructed into real Firestore types after the migration returns.

For custom sandboxing, pass migrationSandbox to createGraphClient():

const g = createGraphClient(db, 'graph', {
  registryMode: { mode: 'dynamic' },
  migrationSandbox: (source) => {
    const compartment = new Compartment({ /* endowments */ });
    return compartment.evaluate(source);
  },
});

Entity Discovery

Place a migrations.ts file in the entity folder. It must default-export a MigrationStep[] array. Optionally set migrationWriteBack in meta.json. The schema version is derived automatically as max(toVersion) from the migrations array.

entities/nodes/tour/
  schema.json
  migrations.ts       # export default [{ fromVersion: 0, toVersion: 1, up: ... }]
  meta.json           # { "migrationWriteBack": "eager" }

Subgraphs

Create isolated graph namespaces inside a parent node's Firestore document as subcollections. Each subgraph is a full GraphClient scoped to its own collection path.

const agentId = generateId();
await g.putNode('agent', agentId, { name: 'ResearchBot' });

// Create a subgraph under the agent's document
const memories = g.subgraph(agentId, 'memories');

// CRUD works exactly like the parent client
const memId = generateId();
await memories.putNode('memory', memId, { text: 'The sky is blue' });
const mem = await memories.getNode(memId);

// Subgraph data is isolated — parent can't see it
const parentNodes = await g.findNodes({ aType: 'memory', allowCollectionScan: true });
// → [] (empty — memories live in the subcollection)

Nested Subgraphs

Subgraphs can be nested to any depth:

const workspace = g.subgraph(agentId, 'workspace');
const taskId = generateId();
await workspace.putNode('task', taskId, { name: 'Analyze data' });

// Nest further
const subtasks = workspace.subgraph(taskId, 'subtasks');
await subtasks.putNode('subtask', generateId(), { name: 'Parse CSV' });

Scope Constraints (`allowedIn`)

Registry entries support allowedIn patterns that restrict where a type can be used:

const registry = createRegistry([
  { aType: 'agent', axbType: 'is', bType: 'agent', allowedIn: ['root'] },
  { aType: 'memory', axbType: 'is', bType: 'memory', allowedIn: ['**/memories'] },
  { aType: 'task', axbType: 'is', bType: 'task', allowedIn: ['workspace', '**/workspace'] },
]);

const g = createGraphClient(db, 'graph', { registry });

// Agent only at root
await g.putNode('agent', agentId, {}); // OK
await memories.putNode('agent', generateId(), {}); // throws RegistryScopeError

// Memory only in 'memories' subgraphs
await memories.putNode('memory', generateId(), {}); // OK
await g.putNode('memory', generateId(), {}); // throws RegistryScopeError

Pattern syntax:

Pattern	Matches
`root`	Top-level collection only
`memories`	Exact subgraph name
`workspace/tasks`	Exact path
`*/memories`	`*` matches one segment
`**/memories`	`**` matches zero or more segments
`**`	Everything including root

Omitting allowedIn (or passing an empty array) means the type is allowed everywhere.

Transactions & Batches in Subgraphs

const sub = g.subgraph(agentId, 'memories');

// Transaction
await sub.runTransaction(async (tx) => {
  const node = await tx.getNode(memId);
  await tx.putNode('memory', memId, { text: 'updated' });
});

// Batch
const batch = sub.batch();
await batch.putNode('memory', generateId(), { text: 'first' });
await batch.putNode('memory', generateId(), { text: 'second' });
await batch.commit();

Cascade Delete

removeNodeCascade recursively deletes subcollections by default:

// Deletes the agent node, all its edges, and all subgraph data
await g.removeNodeCascade(agentId);

// To preserve subgraph data:
await g.removeNodeCascade(agentId, { deleteSubcollections: false });

Firestore Path Layout

graph/                          ← root collection
  {agentId}                     ← agent node document
  {agentId}/memories/           ← subgraph subcollection
    {memId}                     ← memory node document
    {shard:aUid:rel:bUid}       ← edge document
  {agentId}/workspace/          ← another subgraph
    {taskId}                    ← task node document
    {taskId}/subtasks/          ← nested subgraph
      {subtaskId}               ← subtask node document

Cross-Graph Edges

Edges that connect nodes across different subgraphs. The key rule: edges live with the target node. A cross-graph edge is stored in the same collection as its target (bUid), while the source (aUid) may be a parent node in an ancestor graph.

import { createGraphClient, createRegistry, createTraversal, generateId } from 'firegraph';

// Registry declares that 'assignedTo' edges live in the 'workflow' subgraph
const registry = createRegistry([
  { aType: 'task', axbType: 'is', bType: 'task', jsonSchema: taskSchema },
  { aType: 'agent', axbType: 'is', bType: 'agent', jsonSchema: agentSchema },
  { aType: 'task', axbType: 'assignedTo', bType: 'agent', targetGraph: 'workflow' },
]);

const g = createGraphClient(db, 'graph', { registry });

// Create a task in the root graph
const taskId = generateId();
await g.putNode('task', taskId, { title: 'Build API' });

// Create agents in a workflow subgraph under the task
const workflow = g.subgraph(taskId, 'workflow');
const agentId = generateId();
await workflow.putNode('agent', agentId, { name: 'Backend Dev' });

// Create the cross-graph edge in the workflow subgraph
// The edge lives alongside the target (agent), source (task) is an ancestor
await workflow.putEdge('task', taskId, 'assignedTo', 'agent', agentId, { role: 'lead' });

// Forward traversal: task → agents (automatically crosses into workflow subgraph)
const result = await createTraversal(g, taskId, registry)
  .follow('assignedTo')
  .run();
// result.nodes contains the agent edges from the workflow subgraph

How It Works

Writing: You explicitly call putEdge on the subgraph client where the target node lives. The caller decides where the edge goes.
Reverse traversal is free: Since the edge lives with the target, querying from the agent's perspective (findEdges({ bUid: agentId }) on the workflow client) finds it locally.
Forward traversal uses targetGraph: When traversing from the task, the engine sees targetGraph: 'workflow' on the registry entry and queries g.subgraph(taskId, 'workflow') automatically.
Path-scanning resolution: To determine if an edge's aUid is an ancestor node, firegraph parses the Firestore collection path. The path graph/taskId/workflow reveals that taskId is a document in the graph collection.

Registry `targetGraph`

The targetGraph field on a RegistryEntry tells forward traversal which subgraph to query under each source node:

createRegistry([
  // When traversing forward from a task along 'assignedTo',
  // look in the 'workflow' subgraph under each task
  { aType: 'task', axbType: 'assignedTo', bType: 'agent', targetGraph: 'workflow' },
]);

targetGraph must be a single segment (no /). It can also be set in entity discovery via edge.json:

{ "from": "task", "to": "agent", "targetGraph": "workflow" }

Explicit Hop Override

You can override the registry's targetGraph on a per-hop basis:

// Use 'team' subgraph instead of registry's default
const result = await createTraversal(g, taskId)
  .follow('assignedTo', { targetGraph: 'team' })
  .run();

Resolution priority: explicit hop targetGraph > registry targetGraph > no cross-graph.

`findEdgesGlobal` — Collection Group Queries

For cross-cutting reads across all subgraphs, use findEdgesGlobal:

// Find all 'assignedTo' edges across all 'workflow' subgraphs in the database
const allAssignments = await g.findEdgesGlobal(
  { axbType: 'assignedTo', allowCollectionScan: true },
  'workflow',  // collection name to query across
);

This uses Firestore collection group queries and requires collection group indexes. The collection name defaults to the last segment of the client's collection path if omitted.

Multi-Hop Limitation

Each hop resolves its reader from the root client. If hop 1 crosses into a subgraph, hop 2 does not stay in that subgraph — it reverts to the root. To chain hops within a subgraph, create a separate traversal from the subgraph client:

// This traversal finds agents in the workflow subgraph
const agents = await createTraversal(g, taskId, registry)
  .follow('assignedTo')
  .run();

// To continue traversing within the workflow subgraph,
// create a new traversal from the subgraph client
const workflow = g.subgraph(taskId, 'workflow');
for (const agent of agents.nodes) {
  const mentees = await createTraversal(workflow, agent.bUid)
    .follow('mentors')
    .run();
}

Firestore Path Layout

graph/                              <- root collection
  {taskId}                          <- task node
  {taskId}/workflow/                <- workflow subgraph
    {agentId}                       <- agent node
    {shard:taskId:assignedTo:agentId} <- cross-graph edge

ID Generation

import { generateId } from 'firegraph';

const id = generateId(); // 21-char URL-safe nanoid

Error Handling

All errors extend FiregraphError with a code property:

Error Class	Code	When
`FiregraphError`	varies	Base class
`NodeNotFoundError`	`NODE_NOT_FOUND`	Node lookup fails (not thrown by `getNode` — it returns `null`)
`EdgeNotFoundError`	`EDGE_NOT_FOUND`	Edge lookup fails
`ValidationError`	`VALIDATION_ERROR`	Schema validation fails (registry + Zod)
`RegistryViolationError`	`REGISTRY_VIOLATION`	Triple not registered
`RegistryScopeError`	`REGISTRY_SCOPE`	Type not allowed at this subgraph scope
`MigrationError`	`MIGRATION_ERROR`	Migration function fails or chain is incomplete
`DynamicRegistryError`	`DYNAMIC_REGISTRY_ERROR`	Dynamic registry misconfiguration or misuse
`InvalidQueryError`	`INVALID_QUERY`	`findEdges` called with no filters
`QuerySafetyError`	`QUERY_SAFETY`	Query would cause a full collection scan
`TraversalError`	`TRAVERSAL_ERROR`	`run()` called with zero hops

import { FiregraphError, ValidationError } from 'firegraph';

try {
  await g.putNode('tour', generateId(), { name: 123 });
} catch (err) {
  if (err instanceof ValidationError) {
    console.error(err.code);    // 'VALIDATION_ERROR'
    console.error(err.details); // Zod error details
  }
}

Types

All types are exported for use in your own code:

import type {
  // Data models
  GraphRecord,
  StoredGraphRecord,

  // Query
  FindEdgesParams,
  FindNodesParams,
  QueryPlan,
  QueryFilter,
  QueryOptions,

  // Client interfaces
  GraphReader,
  GraphWriter,
  GraphClient,
  GraphTransaction,
  GraphBatch,
  GraphClientOptions,

  // Registry
  RegistryEntry,       // includes targetGraph, allowedIn
  GraphRegistry,       // includes lookupByAxbType
  EdgeTopology,        // includes targetGraph

  // Dynamic Registry
  DynamicGraphClient,
  DynamicRegistryConfig,
  NodeTypeData,
  EdgeTypeData,

  // Migration
  MigrationFn,
  MigrationStep,
  StoredMigrationStep,
  MigrationExecutor,
  MigrationWriteBack,

  // Traversal
  HopDefinition,       // includes targetGraph
  TraversalOptions,
  HopResult,
  TraversalResult,
  TraversalBuilder,

  // Entity Discovery
  DiscoveredEntity,
  DiscoveryResult,
} from 'firegraph';

How It Works

Storage Layout

All data lives in one Firestore collection. Each document has these fields:

Field	Type	Description
`aType`	string	Source node type
`aUid`	string	Source node ID
`axbType`	string	Relationship type (`is` for nodes)
`bType`	string	Target node type
`bUid`	string	Target node ID
`data`	object	User payload
`v`	number?	Schema version (derived from `max(toVersion)` of migrations; set when entry has migrations)
`createdAt`	Timestamp	Server-set on create
`updatedAt`	Timestamp	Server-set on create/update

Query Planning

When you call findEdges, the query planner decides the strategy:

Direct get — If aUid, axbType, and bUid are all provided, the edge document ID can be computed directly. This is a single-document read (fastest).
Filtered query — Otherwise, a Firestore query is built from whichever fields are provided, with optional limit and orderBy applied server-side.

Traversal Execution

Start with sourceUids = [startUid]
For each hop in sequence:
- Resolve targetGraph: check hop override, then registry, then none
- If cross-graph (forward + targetGraph + GraphClient reader): create a subgraph reader via reader.subgraph(sourceUid, targetGraph) for each source
- Fan out: query edges for each source UID (parallel, bounded by semaphore)
- Each findEdges call counts as 1 read against the budget
- Apply in-memory filter if specified, then apply limit
- Collect edges, extract next source UIDs (deduplicated)
- If budget exceeded, mark truncated and stop
Return final hop edges as nodes, all hop data in hops

Query Modes

Firegraph supports two query backends. The mode is set when creating a client:

// Pipeline mode (default) — requires Enterprise Firestore
const g = createGraphClient(db, 'graph');

// Standard mode (opt-in) — for emulator or small datasets
const g = createGraphClient(db, 'graph', { queryMode: 'standard' });

Pipeline Mode (Default)

Uses the Firestore Pipeline API (db.pipeline()). This is the recommended mode for production.

Enables queries on data.* fields without composite indexes
Requires Firestore Enterprise edition
Pipeline API is currently in Preview

Standard Mode

Uses standard Firestore queries (.where().get()). Use only if you understand the limitations:

Firestore Edition	With `data.*` Filters	Risk
Enterprise	Full collection scan (no index needed)	High billing on large collections
Standard	Fails without composite index	Query errors for unindexed fields

Standard mode is appropriate for:

Emulator — the emulator doesn't support pipelines, so firegraph auto-falls back to standard mode when FIRESTORE_EMULATOR_HOST is set
Small datasets where full scans are acceptable
Projects that manage their own composite indexes

Emulator Auto-Fallback

When FIRESTORE_EMULATOR_HOST is detected, firegraph automatically uses standard mode regardless of the queryMode setting. No configuration needed.

Transactions

Transactions always use standard Firestore queries, even when the client is in pipeline mode. This is because Pipeline queries are not transactionally bound — they see committed state, not the transaction's isolated view.

Config File

Set the query mode in firegraph.config.ts:

export default defineConfig({
  entities: './entities',
  queryMode: 'pipeline', // or 'standard'
});

Or via CLI flag: npx firegraph editor --query-mode pipeline

Development

pnpm build          # Build ESM + CJS + types
pnpm typecheck      # Type check
pnpm test:unit      # Unit tests (no emulator needed)
pnpm test:emulator  # Full test suite against Firestore emulator

Requires Node.js 18+.

License

MIT

Name		Name	Last commit message	Last commit date
Latest commit History 69 Commits
.claude		.claude
bin		bin
docs		docs
editor		editor
examples		examples
src		src
tests		tests
.env.example		.env.example
.gitignore		.gitignore
CLAUDE.md		CLAUDE.md
LICENSE		LICENSE
README.md		README.md
firestore.indexes.json		firestore.indexes.json
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
tsconfig.json		tsconfig.json
tsup.config.ts		tsup.config.ts
vitest.config.ts		vitest.config.ts

Folders and files

Latest commit

History

Repository files navigation

Firegraph

Install

Quick Start

Core Concepts

Graph Model

Document IDs

API Reference

Creating a Client

Nodes

Edges

Querying Edges

Transactions

Batches

Graph Traversal

Reverse Traversal

Traversal in Transactions

Hop Options

Run Options

Schema Registry

Dynamic Registry

Schema Versioning & Auto-Migration

How It Works

Write-Back

Dynamic Registry Migrations

Entity Discovery

Subgraphs

Nested Subgraphs

Scope Constraints (allowedIn)

Transactions & Batches in Subgraphs

Cascade Delete

Firestore Path Layout

Cross-Graph Edges

How It Works

Registry targetGraph

Explicit Hop Override

findEdgesGlobal — Collection Group Queries

Multi-Hop Limitation

Firestore Path Layout

ID Generation

Error Handling

Types

How It Works

Storage Layout

Query Planning

Traversal Execution

Query Modes

Pipeline Mode (Default)

Standard Mode

Emulator Auto-Fallback

Transactions

Config File

Development

License

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Scope Constraints (`allowedIn`)

Registry `targetGraph`

`findEdgesGlobal` — Collection Group Queries

Packages