Client utilities

The Next.js App Router provider, and which entry point each export comes from.

The package has two entry points. The default entry is client-side and carries the provider; the bootstrap helpers live on /server.


// Client entry: the provider and its props type.
import { NextSyncProvider } from "@stratasync/next";

// Server entry: prefetching, serializing and seeding a bootstrap snapshot.
import {
  decodeBootstrapSnapshot,
  deserializeBootstrapSnapshot,
  encodeBootstrapSnapshot,
  isBootstrapSnapshotStale,
  prefetchBootstrap,
  seedStorageFromBootstrap,
  serializeBootstrapSnapshot,
} from

Published with Edda

Client utilities

The Next.js App Router provider, and which entry point each export comes from.

The package has two entry points. The default entry is client-side and carries the provider; the bootstrap helpers live on /server.


// Client entry: the provider and its props type.
import { NextSyncProvider } from "@stratasync/next";

// Server entry: prefetching, serializing and seeding a bootstrap snapshot.
import {
  decodeBootstrapSnapshot,
  deserializeBootstrapSnapshot,
  encodeBootstrapSnapshot,
  isBootstrapSnapshotStale,
  prefetchBootstrap,
  seedStorageFromBootstrap,
  serializeBootstrapSnapshot,
} from

Published with Edda

Prop	Type	Default	Description
`client`	`SyncClient \| (() => SyncClient)`	Required	Sync client instance or lazy factory.
`children`	`ReactNode`	Required	Child components.
`loading`	`ReactNode`	`null`	Shown while the client initializes.
`error`	`(error: Error) => ReactNode`	-	Error renderer. If not provided, the error is thrown for an error boundary.
`onReady`	`() => void`	-	Callback when the client is ready.
`onError`	`(error: Error) => void`	-	Callback when initialization fails.

Option	Type	Default	Description
`storage`	`StorageAdapter`	Required	Storage adapter instance.
`snapshot`	`BootstrapSnapshot \| BootstrapSnapshotPayload \| string`	Required	The bootstrap data to seed.
`dbName`	`string`	`"sync-db"`	Database name.
`clearExisting`	`boolean`	`true`	Clear storage before seeding.
`validateSchemaHash`	`boolean`	`true`	Validate schema hash matches.
`batchSize`	`number`	`500`	Number of rows per write batch.
`closeAfter`	`boolean`	`true`	Close storage after seeding.
`schema`	`SchemaDefinition \| ModelRegistrySnapshot`	-	Schema for hash validation.

Field	Type	Description
`applied`	`boolean`	Whether the seed was applied.
`rowCount`	`number`	Number of rows seeded.
`reason`	`"schema_mismatch" \| undefined`	Reason if not applied.

Client utilities

Client utilities

NextSyncProvider

NextSyncProviderProps

Initialization lifecycle

Lazy client factory

Bootstrap decoding

decodeBootstrapSnapshot

deserializeBootstrapSnapshot

isBootstrapSnapshotStale

seedStorageFromBootstrap

Hooks