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