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