Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

protocol.ts

174 lines4.5 KB

1import type { LoadSubsetOptions } from '@tanstack/db'
2import type {
3 CommittedTxAnchor,
4 PersistedCollectionMode,
5 PersistedIndexSpec,
6 PersistedKeySetEvidence,
7 PersistedTx,
8 ReconciledCommittedTx,
9 SQLitePullSinceResult,
10} from '@tanstack/db-sqlite-persistence-core'
11​
12export const ELECTRON_PERSISTENCE_PROTOCOL_VERSION = 4 as const
13export const DEFAULT_ELECTRON_PERSISTENCE_CHANNEL = `tanstack-db:sqlite-persistence`
14​
15export type ElectronPersistedRow = Record<string, unknown>
16export type ElectronPersistedKey = string | number
17​
18export type ElectronPersistenceResolution = {
19 mode: PersistedCollectionMode
20 schemaVersion?: number
22​
23export type ElectronPersistenceMethod =
24 | `loadSubset`
25 | `loadResumeSnapshot`
26 | `loadCollectionMetadata`
27 | `scanRows`
28 | `applyCommittedTx`
29 | `reconcileCommittedTx`
30 | `ensureIndex`
31 | `markIndexRemoved`
32 | `pullSince`
33 | `getStreamPosition`
34 | `reserveLeadershipTerm`
35​
36export type ElectronPersistencePayloadMap = {
37 loadSubset: {
38 options: LoadSubsetOptions
39 ctx?: { requiredIndexSignatures?: ReadonlyArray<string> }
40 }
41 loadResumeSnapshot: {
42 ctx?: {
43 requiredIndexSignatures?: ReadonlyArray<string>
44 includeRows?: boolean
45 }
46 }
47 loadCollectionMetadata: {}
48 scanRows: {
49 options?: {
50 metadataOnly?: boolean
51 }
52 }
53 applyCommittedTx: {
54 tx: PersistedTx<ElectronPersistedRow, ElectronPersistedKey>
55 }
56 reconcileCommittedTx: {
57 tx: PersistedTx<ElectronPersistedRow, ElectronPersistedKey>
58 anchor: CommittedTxAnchor
59 }
60 ensureIndex: {
61 signature: string
62 spec: PersistedIndexSpec
63 }
64 markIndexRemoved: {
65 signature: string
66 }
67 pullSince: {
68 fromRowVersion: number
69 }
70 getStreamPosition: {}
71 reserveLeadershipTerm: { observedTerm: number }
73​
74export type ElectronPersistenceResultMap = {
75 loadSubset: Array<{ key: ElectronPersistedKey; value: ElectronPersistedRow }>
76 loadResumeSnapshot: {
77 rows: Array<{
78 key: ElectronPersistedKey
79 value: ElectronPersistedRow
80 metadata?: unknown
81 }>
82 keySet?: PersistedKeySetEvidence
83 collectionMetadata: Array<{ key: string; value: unknown }>
84 latestTerm: number
85 latestSeq: number
86 latestRowVersion: number
87 resetEpoch: number
88 }
89 loadCollectionMetadata: Array<{ key: string; value: unknown }>
90 scanRows: Array<{
91 key: ElectronPersistedKey
92 value: ElectronPersistedRow
93 metadata?: unknown
94 }>
95 applyCommittedTx: null
96 reconcileCommittedTx: ReconciledCommittedTx
97 ensureIndex: null
98 markIndexRemoved: null
99 pullSince: SQLitePullSinceResult<ElectronPersistedKey>
100 getStreamPosition: {
101 latestTerm: number
102 latestSeq: number
103 latestRowVersion: number
104 }
105 reserveLeadershipTerm: {
106 latestTerm: number
107 latestSeq: number
108 latestRowVersion: number
109 }
111​
112export type ElectronSerializedError = {
113 name: string
114 message: string
115 stack?: string
116 code?: string | number
117 path?: string | ReadonlyArray<string | number>
119​
120export type ElectronPersistenceRequestByMethod = {
121 [Method in ElectronPersistenceMethod]: {
122 v: number
123 requestId: string
124 collectionId: string
125 resolution?: ElectronPersistenceResolution
126 method: Method
127 payload: ElectronPersistencePayloadMap[Method]
128 }
130​
131export type ElectronPersistenceRequest<
132 TMethod extends ElectronPersistenceMethod = ElectronPersistenceMethod,
133> = ElectronPersistenceRequestByMethod[TMethod]
134​
135export type ElectronPersistenceRequestEnvelope =
136 ElectronPersistenceRequestByMethod[ElectronPersistenceMethod]
137​
138type ElectronPersistenceSuccessResponseByMethod = {
139 [Method in ElectronPersistenceMethod]: {
140 v: number
141 requestId: string
142 method: Method
143 ok: true
144 result: ElectronPersistenceResultMap[Method]
145 }
147​
148type ElectronPersistenceErrorResponseByMethod = {
149 [Method in ElectronPersistenceMethod]: {
150 v: number
151 requestId: string
152 method: Method
153 ok: false
154 error: ElectronSerializedError
155 }
157​
158export type ElectronPersistenceResponse<
159 TMethod extends ElectronPersistenceMethod = ElectronPersistenceMethod,
160> =
161 | ElectronPersistenceSuccessResponseByMethod[TMethod]
162 | ElectronPersistenceErrorResponseByMethod[TMethod]
163​
164export type ElectronPersistenceResponseEnvelope =
165 ElectronPersistenceResponse<ElectronPersistenceMethod>
166​
167export type ElectronPersistenceRequestHandler = (
168 request: ElectronPersistenceRequestEnvelope,
169) => Promise<ElectronPersistenceResponseEnvelope>
170​
171export type ElectronPersistenceInvoke = (
172 channel: string,
173 request: ElectronPersistenceRequestEnvelope,
174) => Promise<ElectronPersistenceResponseEnvelope>