@narumitw/pi-sync-daemon 0.0.0-stage → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (267) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/LICENSE +21 -0
  3. package/README.md +91 -2
  4. package/dist/cli.d.ts +2 -0
  5. package/dist/cli.js +127 -0
  6. package/dist/client.d.ts +57 -0
  7. package/dist/client.js +534 -0
  8. package/dist/consent.d.ts +24 -0
  9. package/dist/consent.js +205 -0
  10. package/dist/document.d.ts +10 -0
  11. package/dist/document.js +6 -0
  12. package/dist/endpoint.d.ts +8 -0
  13. package/dist/endpoint.js +91 -0
  14. package/dist/engine/backends/backend-factory.d.ts +6 -0
  15. package/dist/engine/backends/backend-factory.js +16 -0
  16. package/dist/engine/backends/backend-identity.d.ts +3 -0
  17. package/dist/engine/backends/backend-identity.js +38 -0
  18. package/dist/engine/backends/backend-types.d.ts +70 -0
  19. package/dist/engine/backends/backend-types.js +1 -0
  20. package/dist/engine/backends/git/git-backend.d.ts +55 -0
  21. package/dist/engine/backends/git/git-backend.js +700 -0
  22. package/dist/engine/backends/git/git-config.d.ts +5 -0
  23. package/dist/engine/backends/git/git-config.js +118 -0
  24. package/dist/engine/backends/git/git-runner.d.ts +25 -0
  25. package/dist/engine/backends/git/git-runner.js +232 -0
  26. package/dist/engine/backends/git/git-storage.d.ts +39 -0
  27. package/dist/engine/backends/git/git-storage.js +226 -0
  28. package/dist/engine/backends/s3/s3-backend.d.ts +32 -0
  29. package/dist/engine/backends/s3/s3-backend.js +436 -0
  30. package/dist/engine/backends/s3/s3-client.d.ts +36 -0
  31. package/dist/engine/backends/s3/s3-client.js +352 -0
  32. package/dist/engine/backends/s3/s3-conditions.d.ts +4 -0
  33. package/dist/engine/backends/s3/s3-conditions.js +66 -0
  34. package/dist/engine/backends/snapshot-pointer.d.ts +6 -0
  35. package/dist/engine/backends/snapshot-pointer.js +22 -0
  36. package/dist/engine/backends/sync-backend.d.ts +71 -0
  37. package/dist/engine/backends/sync-backend.js +23 -0
  38. package/dist/engine/backends/webdav/webdav-backend.d.ts +34 -0
  39. package/dist/engine/backends/webdav/webdav-backend.js +534 -0
  40. package/dist/engine/backends/webdav/webdav-client.d.ts +36 -0
  41. package/dist/engine/backends/webdav/webdav-client.js +326 -0
  42. package/dist/engine/backends/webdav/webdav-config.d.ts +5 -0
  43. package/dist/engine/backends/webdav/webdav-config.js +73 -0
  44. package/dist/engine/commands/command-types.d.ts +31 -0
  45. package/dist/engine/commands/command-types.js +1 -0
  46. package/dist/engine/host.d.ts +70 -0
  47. package/dist/engine/host.js +16 -0
  48. package/dist/engine/paths.d.ts +9 -0
  49. package/dist/engine/paths.js +71 -0
  50. package/dist/engine/settings/config-errors.d.ts +1 -0
  51. package/dist/engine/settings/config-errors.js +4 -0
  52. package/dist/engine/settings/config-file.d.ts +33 -0
  53. package/dist/engine/settings/config-file.js +630 -0
  54. package/dist/engine/settings/config.d.ts +24 -0
  55. package/dist/engine/settings/config.js +200 -0
  56. package/dist/engine/settings/settings-management.d.ts +24 -0
  57. package/dist/engine/settings/settings-management.js +191 -0
  58. package/dist/engine/settings/settings-store.d.ts +8 -0
  59. package/dist/engine/settings/settings-store.js +41 -0
  60. package/dist/engine/settings/settings-types.d.ts +134 -0
  61. package/dist/engine/settings/settings-types.js +1 -0
  62. package/dist/engine/settings/settings-validation.d.ts +15 -0
  63. package/dist/engine/settings/settings-validation.js +356 -0
  64. package/dist/engine/snapshot/session-paths.d.ts +12 -0
  65. package/dist/engine/snapshot/session-paths.js +91 -0
  66. package/dist/engine/snapshot/snapshot-apply.d.ts +22 -0
  67. package/dist/engine/snapshot/snapshot-apply.js +262 -0
  68. package/dist/engine/snapshot/snapshot-case-replacement.d.ts +15 -0
  69. package/dist/engine/snapshot/snapshot-case-replacement.js +82 -0
  70. package/dist/engine/snapshot/snapshot-codec.d.ts +6 -0
  71. package/dist/engine/snapshot/snapshot-codec.js +53 -0
  72. package/dist/engine/snapshot/snapshot-exclude-safety.d.ts +7 -0
  73. package/dist/engine/snapshot/snapshot-exclude-safety.js +47 -0
  74. package/dist/engine/snapshot/snapshot-mutation-queues.d.ts +9 -0
  75. package/dist/engine/snapshot/snapshot-mutation-queues.js +133 -0
  76. package/dist/engine/snapshot/snapshot-paths.d.ts +1 -0
  77. package/dist/engine/snapshot/snapshot-paths.js +11 -0
  78. package/dist/engine/snapshot/snapshot-root-transition.d.ts +25 -0
  79. package/dist/engine/snapshot/snapshot-root-transition.js +122 -0
  80. package/dist/engine/snapshot/snapshot-transaction-directory.d.ts +2 -0
  81. package/dist/engine/snapshot/snapshot-transaction-directory.js +16 -0
  82. package/dist/engine/snapshot/snapshot-transaction-plan.d.ts +12 -0
  83. package/dist/engine/snapshot/snapshot-transaction-plan.js +68 -0
  84. package/dist/engine/snapshot/snapshot-transaction.d.ts +15 -0
  85. package/dist/engine/snapshot/snapshot-transaction.js +787 -0
  86. package/dist/engine/snapshot/snapshot-types.d.ts +48 -0
  87. package/dist/engine/snapshot/snapshot-types.js +1 -0
  88. package/dist/engine/snapshot/snapshot.d.ts +30 -0
  89. package/dist/engine/snapshot/snapshot.js +364 -0
  90. package/dist/engine/state/json-file.d.ts +6 -0
  91. package/dist/engine/state/json-file.js +49 -0
  92. package/dist/engine/state/lock-policy.d.ts +2 -0
  93. package/dist/engine/state/lock-policy.js +2 -0
  94. package/dist/engine/state/lock.d.ts +20 -0
  95. package/dist/engine/state/lock.js +259 -0
  96. package/dist/engine/state/lockfile-fs.d.ts +13 -0
  97. package/dist/engine/state/lockfile-fs.js +13 -0
  98. package/dist/engine/state/merge-baseline-store.d.ts +11 -0
  99. package/dist/engine/state/merge-baseline-store.js +187 -0
  100. package/dist/engine/state/mutation-directory-sync.d.ts +5 -0
  101. package/dist/engine/state/mutation-directory-sync.js +34 -0
  102. package/dist/engine/state/operation-availability.d.ts +49 -0
  103. package/dist/engine/state/operation-availability.js +40 -0
  104. package/dist/engine/state/state-directory.d.ts +14 -0
  105. package/dist/engine/state/state-directory.js +225 -0
  106. package/dist/engine/state/state-types.d.ts +27 -0
  107. package/dist/engine/state/state-types.js +1 -0
  108. package/dist/engine/state/sync-state-store.d.ts +11 -0
  109. package/dist/engine/state/sync-state-store.js +54 -0
  110. package/dist/engine/sync/agent-candidate.d.ts +44 -0
  111. package/dist/engine/sync/agent-candidate.js +207 -0
  112. package/dist/engine/sync/agent-plan.d.ts +8 -0
  113. package/dist/engine/sync/agent-plan.js +84 -0
  114. package/dist/engine/sync/agent-policy.d.ts +9 -0
  115. package/dist/engine/sync/agent-policy.js +10 -0
  116. package/dist/engine/sync/agent-refusal-retry.d.ts +4 -0
  117. package/dist/engine/sync/agent-refusal-retry.js +39 -0
  118. package/dist/engine/sync/agent-request.d.ts +14 -0
  119. package/dist/engine/sync/agent-request.js +13 -0
  120. package/dist/engine/sync/agent-runner.d.ts +6 -0
  121. package/dist/engine/sync/agent-runner.js +183 -0
  122. package/dist/engine/sync/agent-store.d.ts +7 -0
  123. package/dist/engine/sync/agent-store.js +177 -0
  124. package/dist/engine/sync/agent-sync.d.ts +4 -0
  125. package/dist/engine/sync/agent-sync.js +132 -0
  126. package/dist/engine/sync/apply-review.d.ts +8 -0
  127. package/dist/engine/sync/apply-review.js +51 -0
  128. package/dist/engine/sync/conflict-artifact-ownership.d.ts +4 -0
  129. package/dist/engine/sync/conflict-artifact-ownership.js +53 -0
  130. package/dist/engine/sync/conflict-artifacts.d.ts +32 -0
  131. package/dist/engine/sync/conflict-artifacts.js +158 -0
  132. package/dist/engine/sync/conflict-groups.d.ts +9 -0
  133. package/dist/engine/sync/conflict-groups.js +76 -0
  134. package/dist/engine/sync/conflict-preview.d.ts +4 -0
  135. package/dist/engine/sync/conflict-preview.js +53 -0
  136. package/dist/engine/sync/conflict-resolution.d.ts +13 -0
  137. package/dist/engine/sync/conflict-resolution.js +53 -0
  138. package/dist/engine/sync/conflict-retention.d.ts +5 -0
  139. package/dist/engine/sync/conflict-retention.js +61 -0
  140. package/dist/engine/sync/conflict-review.d.ts +4 -0
  141. package/dist/engine/sync/conflict-review.js +73 -0
  142. package/dist/engine/sync/content-conflicts.d.ts +10 -0
  143. package/dist/engine/sync/content-conflicts.js +70 -0
  144. package/dist/engine/sync/continuous-errors.d.ts +14 -0
  145. package/dist/engine/sync/continuous-errors.js +66 -0
  146. package/dist/engine/sync/continuous-lease.d.ts +9 -0
  147. package/dist/engine/sync/continuous-lease.js +206 -0
  148. package/dist/engine/sync/continuous-record.d.ts +31 -0
  149. package/dist/engine/sync/continuous-record.js +199 -0
  150. package/dist/engine/sync/continuous-storage.d.ts +14 -0
  151. package/dist/engine/sync/continuous-storage.js +59 -0
  152. package/dist/engine/sync/continuous-sync.d.ts +15 -0
  153. package/dist/engine/sync/continuous-sync.js +496 -0
  154. package/dist/engine/sync/continuous-watch.d.ts +3 -0
  155. package/dist/engine/sync/continuous-watch.js +65 -0
  156. package/dist/engine/sync/exclude-policy.d.ts +5 -0
  157. package/dist/engine/sync/exclude-policy.js +79 -0
  158. package/dist/engine/sync/field-migration.d.ts +5 -0
  159. package/dist/engine/sync/field-migration.js +20 -0
  160. package/dist/engine/sync/file-merge-planner.d.ts +36 -0
  161. package/dist/engine/sync/file-merge-planner.js +123 -0
  162. package/dist/engine/sync/initialization.d.ts +12 -0
  163. package/dist/engine/sync/initialization.js +75 -0
  164. package/dist/engine/sync/json-document.d.ts +29 -0
  165. package/dist/engine/sync/json-document.js +172 -0
  166. package/dist/engine/sync/local-field-policy.d.ts +2 -0
  167. package/dist/engine/sync/local-field-policy.js +26 -0
  168. package/dist/engine/sync/local-fields.d.ts +9 -0
  169. package/dist/engine/sync/local-fields.js +116 -0
  170. package/dist/engine/sync/merge-apply.d.ts +5 -0
  171. package/dist/engine/sync/merge-apply.js +386 -0
  172. package/dist/engine/sync/merge-journal.d.ts +31 -0
  173. package/dist/engine/sync/merge-journal.js +179 -0
  174. package/dist/engine/sync/merge-transfer-error.d.ts +3 -0
  175. package/dist/engine/sync/merge-transfer-error.js +64 -0
  176. package/dist/engine/sync/merged-sync.d.ts +6 -0
  177. package/dist/engine/sync/merged-sync.js +618 -0
  178. package/dist/engine/sync/mutation-owner.d.ts +2 -0
  179. package/dist/engine/sync/mutation-owner.js +18 -0
  180. package/dist/engine/sync/package-merge.d.ts +3 -0
  181. package/dist/engine/sync/package-merge.js +82 -0
  182. package/dist/engine/sync/partial-progress.d.ts +15 -0
  183. package/dist/engine/sync/partial-progress.js +39 -0
  184. package/dist/engine/sync/remote-snapshot.d.ts +28 -0
  185. package/dist/engine/sync/remote-snapshot.js +62 -0
  186. package/dist/engine/sync/resolver-stream.d.ts +4 -0
  187. package/dist/engine/sync/resolver-stream.js +34 -0
  188. package/dist/engine/sync/session-merge.d.ts +3 -0
  189. package/dist/engine/sync/session-merge.js +178 -0
  190. package/dist/engine/sync/session-push.d.ts +5 -0
  191. package/dist/engine/sync/session-push.js +32 -0
  192. package/dist/engine/sync/settings-conflicts.d.ts +8 -0
  193. package/dist/engine/sync/settings-conflicts.js +56 -0
  194. package/dist/engine/sync/settings-merge.d.ts +13 -0
  195. package/dist/engine/sync/settings-merge.js +93 -0
  196. package/dist/engine/sync/signals.d.ts +2 -0
  197. package/dist/engine/sync/signals.js +8 -0
  198. package/dist/engine/sync/startup-timings.d.ts +11 -0
  199. package/dist/engine/sync/startup-timings.js +44 -0
  200. package/dist/engine/sync/sync-decision.d.ts +35 -0
  201. package/dist/engine/sync/sync-decision.js +66 -0
  202. package/dist/engine/sync/sync-error-guidance.d.ts +2 -0
  203. package/dist/engine/sync/sync-error-guidance.js +55 -0
  204. package/dist/engine/sync/sync-errors.d.ts +9 -0
  205. package/dist/engine/sync/sync-errors.js +18 -0
  206. package/dist/engine/sync/sync-inspection.d.ts +26 -0
  207. package/dist/engine/sync/sync-inspection.js +40 -0
  208. package/dist/engine/sync/sync-loaders.d.ts +7 -0
  209. package/dist/engine/sync/sync-loaders.js +8 -0
  210. package/dist/engine/sync/sync-local.d.ts +5 -0
  211. package/dist/engine/sync/sync-local.js +40 -0
  212. package/dist/engine/sync/sync-mutations.d.ts +30 -0
  213. package/dist/engine/sync/sync-mutations.js +589 -0
  214. package/dist/engine/sync/sync-operations.d.ts +2 -0
  215. package/dist/engine/sync/sync-operations.js +3 -0
  216. package/dist/engine/sync/sync-policy.d.ts +85 -0
  217. package/dist/engine/sync/sync-policy.js +356 -0
  218. package/dist/engine/sync/sync-queries.d.ts +7 -0
  219. package/dist/engine/sync/sync-queries.js +195 -0
  220. package/dist/engine/sync/sync-state.d.ts +31 -0
  221. package/dist/engine/sync/sync-state.js +92 -0
  222. package/dist/engine/sync/text-merge.d.ts +19 -0
  223. package/dist/engine/sync/text-merge.js +124 -0
  224. package/dist/engine/types.d.ts +5 -0
  225. package/dist/engine/types.js +2 -0
  226. package/dist/engine/ui/merge-review.d.ts +2 -0
  227. package/dist/engine/ui/merge-review.js +7 -0
  228. package/dist/engine/ui/merged-sync-summary.d.ts +25 -0
  229. package/dist/engine/ui/merged-sync-summary.js +86 -0
  230. package/dist/engine/ui/sync-format.d.ts +13 -0
  231. package/dist/engine/ui/sync-format.js +150 -0
  232. package/dist/engine/ui/sync-status.d.ts +9 -0
  233. package/dist/engine/ui/sync-status.js +30 -0
  234. package/dist/engine/ui/terminal-text.d.ts +3 -0
  235. package/dist/engine/ui/terminal-text.js +9 -0
  236. package/dist/engine/ui/transfer-changes.d.ts +12 -0
  237. package/dist/engine/ui/transfer-changes.js +24 -0
  238. package/dist/engine/ui/transfer-review.d.ts +3 -0
  239. package/dist/engine/ui/transfer-review.js +19 -0
  240. package/dist/engine-service.d.ts +14 -0
  241. package/dist/engine-service.js +322 -0
  242. package/dist/identity.d.ts +20 -0
  243. package/dist/identity.js +133 -0
  244. package/dist/idle-exit.d.ts +17 -0
  245. package/dist/idle-exit.js +77 -0
  246. package/dist/index.d.ts +8 -0
  247. package/dist/index.js +4 -0
  248. package/dist/lifecycle-log.d.ts +7 -0
  249. package/dist/lifecycle-log.js +53 -0
  250. package/dist/lifecycle.d.ts +2 -0
  251. package/dist/lifecycle.js +21 -0
  252. package/dist/model-signature.d.ts +2 -0
  253. package/dist/model-signature.js +7 -0
  254. package/dist/monitor.d.ts +14 -0
  255. package/dist/monitor.js +272 -0
  256. package/dist/participant-admission.d.ts +5 -0
  257. package/dist/participant-admission.js +30 -0
  258. package/dist/protocol.d.ts +102 -0
  259. package/dist/protocol.js +97 -0
  260. package/dist/resolver-host.d.ts +11 -0
  261. package/dist/resolver-host.js +78 -0
  262. package/dist/server.d.ts +24 -0
  263. package/dist/server.js +808 -0
  264. package/dist/service-host.d.ts +7 -0
  265. package/dist/service-host.js +174 -0
  266. package/docs/architecture.md +162 -0
  267. package/package.json +54 -4
@@ -0,0 +1,200 @@
1
+ import { createHash } from "node:crypto";
2
+ import { backendIdentityCoordinates } from "../backends/backend-identity.js";
3
+ import { normalizeGitBranch, normalizeGitDirectory, normalizeGitRemote } from "../backends/git/git-config.js";
4
+ import { normalizeWebDavPath, normalizeWebDavUrl } from "../backends/webdav/webdav-config.js";
5
+ import { normalizeSyncExclude } from "../sync/exclude-policy.js";
6
+ import { normalizeLocalFields } from "../sync/local-field-policy.js";
7
+ import { normalizeSyncInclude, syncSessionsSelected } from "../sync/sync-policy.js";
8
+ import { localConfigPath, readActiveLocalConfigDocumentForRepair } from "./config-file.js";
9
+ import { requireSettings } from "./settings-store.js";
10
+ import { DEFAULT_ON_SWITCH, isCloudflareR2Endpoint, normalizeS3Bucket, normalizeS3Endpoint, normalizeStoragePath, optionalString, ownObject, requiredString, validateConfigName, validateSettingsDocument, } from "./settings-validation.js";
11
+ export async function loadConfig(setupName) {
12
+ return configFromSettings(await requireSettings(), setupName);
13
+ }
14
+ /** A background freshness read must never trigger legacy-file publication. */
15
+ export async function loadConfigForCheck() {
16
+ const document = await readActiveLocalConfigDocumentForRepair();
17
+ if (!document)
18
+ throw new Error(`Missing pi-sync settings: ${localConfigPath()}`);
19
+ validateSettingsDocument(document.parsed);
20
+ return configFromSettings(document.parsed);
21
+ }
22
+ export function configFromSettings(settings, setupName) {
23
+ const selectedName = setupName ?? settings.activeSyncSetup;
24
+ if (!selectedName)
25
+ throw new Error("No sync setups are configured.");
26
+ validateConfigName(selectedName, "sync setup");
27
+ const setup = ownObject(settings.syncSetups, selectedName);
28
+ if (!setup)
29
+ throw new Error(`Invalid pi-sync settings: sync setup “${selectedName}” was not found.`);
30
+ const connectionName = setup.storage.connection;
31
+ const connection = ownObject(settings.storageConnections, connectionName);
32
+ if (!connection) {
33
+ throw new Error(`Invalid pi-sync settings: sync setup “${selectedName}” references missing storage connection “${connectionName}”.`);
34
+ }
35
+ return {
36
+ ...resolveSyncConfig(selectedName, setup, connectionName, connection, settings.onSwitch, settings.skipSecretScan ?? false, settings.showStatus ?? true),
37
+ debug: settings.debug ?? false,
38
+ };
39
+ }
40
+ /** A validated setup-facing projection used by manager and settings UI. */
41
+ export async function loadPartialConfig(setupName) {
42
+ const config = await loadConfig(setupName);
43
+ return {
44
+ setupName: config.setupName,
45
+ ...storageReviewFromConfig(config),
46
+ include: [...config.include],
47
+ ...(config.exclude === undefined ? {} : { exclude: [...config.exclude] }),
48
+ automatic: config.automatic,
49
+ automaticTransfer: config.automaticTransfer ?? false,
50
+ agentMode: config.agentMode ?? false,
51
+ continuous: config.continuous ?? false,
52
+ onSwitch: config.onSwitch,
53
+ showStatus: config.showStatus,
54
+ };
55
+ }
56
+ export function syncSetupStorageReview(setupName, setup, connectionName, connection) {
57
+ return storageReviewFromConfig(resolveSyncConfig(setupName, setup, connectionName, connection, DEFAULT_ON_SWITCH, false, true));
58
+ }
59
+ export function syncSetupReviewIdentity(setupName, setup, connectionName, connection) {
60
+ return syncConfigReviewIdentity(resolveSyncConfig(setupName, setup, connectionName, connection, DEFAULT_ON_SWITCH, false, true));
61
+ }
62
+ export function syncConfigReviewIdentity(config) {
63
+ return JSON.stringify([
64
+ config.setupName,
65
+ config.connectionName,
66
+ backendIdentityCoordinates(config),
67
+ config.include,
68
+ config.automatic,
69
+ config.automaticTransfer ?? false,
70
+ config.agentMode ?? false,
71
+ config.localFields,
72
+ config.mergeSettings ?? false,
73
+ config.mergeContent ?? false,
74
+ config.partialSync ?? false,
75
+ // Preserve existing Off identities and cached candidates across the upgrade.
76
+ ...(config.continuous ? ["continuous"] : []),
77
+ ...(config.exclude === undefined
78
+ ? []
79
+ : ["exclude", normalizeSyncExclude(config.exclude).map((rule) => rule.toLowerCase())]),
80
+ ]);
81
+ }
82
+ export function syncConfigReviewFingerprint(config) {
83
+ return createHash("sha256").update(syncConfigReviewIdentity(config)).digest("hex");
84
+ }
85
+ /** Internal freshness token, including credentials; never display or persist it. */
86
+ export function syncCheckConfigFingerprint(config) {
87
+ return createHash("sha256")
88
+ .update(JSON.stringify({ ...config, showStatus: undefined, debug: undefined }))
89
+ .digest("hex");
90
+ }
91
+ function storageReviewFromConfig(config) {
92
+ return {
93
+ connectionName: config.connectionName,
94
+ storageKind: config.backend.type,
95
+ storagePath: config.storagePath,
96
+ ...(config.backend.type === "s3"
97
+ ? { bucket: config.backend.destination.bucket }
98
+ : config.backend.type === "git"
99
+ ? { branch: config.backend.destination.branch }
100
+ : {}),
101
+ };
102
+ }
103
+ function resolveSyncConfig(setupName, setup, connectionName, connection, onSwitch, skipSecretScan, showStatus) {
104
+ const storagePath = normalizeStoragePath(setup.storage.path);
105
+ const namespace = storagePath === "./" ? "root" : storagePath.slice(storagePath.lastIndexOf("/") + 1);
106
+ const include = normalizeSyncInclude(setup.sync.include);
107
+ const common = {
108
+ setupName,
109
+ connectionName,
110
+ storagePath,
111
+ snapshotIdentity: namespace,
112
+ include,
113
+ ...(setup.sync.exclude === undefined ? {} : { exclude: normalizeSyncExclude(setup.sync.exclude) }),
114
+ automatic: setup.sync.automatic,
115
+ automaticTransfer: setup.sync.automaticTransfer ?? false,
116
+ agentMode: setup.sync.agentMode ?? false,
117
+ continuous: setup.sync.continuous ?? false,
118
+ localFields: setup.sync.localFields === undefined ? undefined : normalizeLocalFields(setup.sync.localFields),
119
+ mergeSettings: setup.sync.mergeSettings ?? false,
120
+ mergeContent: setup.sync.mergeContent ?? false,
121
+ partialSync: setup.sync.partialSync ?? false,
122
+ onSwitch,
123
+ skipSecretScan,
124
+ showStatus,
125
+ };
126
+ if (connection.type === "git") {
127
+ return {
128
+ ...common,
129
+ backend: {
130
+ type: "git",
131
+ profile: { kind: "git", remote: normalizeGitRemote(connection.remote) },
132
+ destination: {
133
+ branch: normalizeGitBranch(setup.storage.branch),
134
+ directory: normalizeGitDirectory(storagePath),
135
+ namespace,
136
+ },
137
+ },
138
+ };
139
+ }
140
+ if (connection.type === "webdav") {
141
+ return {
142
+ ...common,
143
+ backend: {
144
+ type: "webdav",
145
+ profile: {
146
+ kind: "webdav",
147
+ url: normalizeWebDavUrl(connection.url),
148
+ username: connection.credentials.username,
149
+ password: connection.credentials.password,
150
+ },
151
+ destination: { path: normalizeWebDavPath(storagePath), namespace },
152
+ },
153
+ };
154
+ }
155
+ return {
156
+ ...common,
157
+ backend: {
158
+ type: "s3",
159
+ profile: {
160
+ kind: isCloudflareR2Endpoint(connection.endpoint) ? "r2" : "s3-compatible",
161
+ endpoint: normalizeS3Endpoint(connection.endpoint),
162
+ region: requiredString(connection.region, "S3 region"),
163
+ accessKeyId: connection.credentials.accessKeyId,
164
+ secretAccessKey: connection.credentials.secretAccessKey,
165
+ sessionToken: optionalString(connection.credentials.sessionToken, "S3 session token"),
166
+ },
167
+ destination: {
168
+ bucket: normalizeS3Bucket(setup.storage.bucket),
169
+ prefix: storagePath,
170
+ namespace,
171
+ },
172
+ },
173
+ };
174
+ }
175
+ export function sessionTokenWarnings(config) {
176
+ if (!isCloudflareR2Endpoint(config.endpoint) || !config.sessionToken)
177
+ return [];
178
+ return [
179
+ "session token: configured for Cloudflare R2; if R2 rejects X-Amz-Security-Token, pi-sync retries once without it. R2 static access keys usually do not need a session token.",
180
+ ];
181
+ }
182
+ export function syncSessionsWarnings(config) {
183
+ if (!syncSessionsSelected(config))
184
+ return [];
185
+ return [
186
+ "sessions: included; Pi session JSONL can contain prompts, tool output, file paths, images, and secrets. Sync sessions only to storage you trust.",
187
+ ];
188
+ }
189
+ export function isEnabled(value, defaultValue) {
190
+ if (value === undefined)
191
+ return defaultValue;
192
+ if (typeof value === "boolean")
193
+ return value;
194
+ return !["0", "false", "no", "off"].includes(value.trim().toLowerCase());
195
+ }
196
+ export function isExplicitlyEnabled(value) {
197
+ if (typeof value === "boolean")
198
+ return value;
199
+ return ["1", "true", "yes", "on"].includes(value?.trim().toLowerCase() ?? "");
200
+ }
@@ -0,0 +1,24 @@
1
+ import { type SyncSetupStorageReview } from "./config.js";
2
+ import type { PiSyncSettingsV3, StorageConnectionSettings, SyncSetupSettings } from "./settings-types.js";
3
+ export declare class SyncSetupReviewChangedError extends Error {
4
+ constructor(message: string);
5
+ }
6
+ export declare function saveNewV3Settings(input: {
7
+ setupName: string;
8
+ connectionName: string;
9
+ connection: StorageConnectionSettings;
10
+ setup: SyncSetupSettings;
11
+ }, signal?: AbortSignal): Promise<PiSyncSettingsV3>;
12
+ export declare function addStorageConnection(name: string, connection: StorageConnectionSettings, signal?: AbortSignal): Promise<void>;
13
+ export declare function updateStorageConnection(name: string, update: (connection: StorageConnectionSettings) => StorageConnectionSettings, expectedSetups?: readonly string[], signal?: AbortSignal): Promise<void>;
14
+ export declare function addSyncSetup(name: string, setup: SyncSetupSettings, signal?: AbortSignal, expectedConnection?: StorageConnectionSettings): Promise<void>;
15
+ export declare function updateSyncSetup(name: string, update: (setup: SyncSetupSettings) => SyncSetupSettings, options?: {
16
+ expectedStorage?: SyncSetupStorageReview;
17
+ expectedInclude?: readonly string[];
18
+ expectedConnection?: StorageConnectionSettings;
19
+ expectedConfigFingerprint?: string;
20
+ upgradeExclude?: boolean;
21
+ signal?: AbortSignal;
22
+ }): Promise<void>;
23
+ export declare function removeSyncSetup(name: string, signal?: AbortSignal): Promise<void>;
24
+ export declare function removeStorageConnection(name: string, signal?: AbortSignal): Promise<void>;
@@ -0,0 +1,191 @@
1
+ import { isDeepStrictEqual } from "node:util";
2
+ import { normalizeSyncInclude } from "../sync/sync-policy.js";
3
+ import { configFromSettings, syncCheckConfigFingerprint, syncSetupStorageReview, } from "./config.js";
4
+ import { localConfigPath } from "./config-file.js";
5
+ import { updateLocalConfig } from "./settings-store.js";
6
+ import { effectiveSyncSetupRemoteIdentity, validateConfigName } from "./settings-validation.js";
7
+ export class SyncSetupReviewChangedError extends Error {
8
+ constructor(message) {
9
+ super(message);
10
+ this.name = "SyncSetupReviewChangedError";
11
+ }
12
+ }
13
+ export async function saveNewV3Settings(input, signal) {
14
+ validateConfigName(input.setupName, "sync setup");
15
+ validateConfigName(input.connectionName, "storage connection");
16
+ const settings = {
17
+ version: 3,
18
+ activeSyncSetup: input.setupName,
19
+ onSwitch: "ask-before-pull",
20
+ skipSecretScan: false,
21
+ storageConnections: { [input.connectionName]: structuredClone(input.connection) },
22
+ syncSetups: {
23
+ [input.setupName]: {
24
+ ...structuredClone(input.setup),
25
+ storage: { ...input.setup.storage, connection: input.connectionName },
26
+ },
27
+ },
28
+ };
29
+ return updateLocalConfig((current) => {
30
+ if (Object.keys(current.storageConnections).length || Object.keys(current.syncSetups).length) {
31
+ throw new Error(`Settings already exist: ${localConfigPath()}`);
32
+ }
33
+ return { ...current, ...settings };
34
+ }, signal);
35
+ }
36
+ export async function addStorageConnection(name, connection, signal) {
37
+ validateConfigName(name, "storage connection");
38
+ await updateSettings((settings) => {
39
+ if (Object.hasOwn(settings.storageConnections, name)) {
40
+ throw new Error(`Storage connection already exists: ${name}`);
41
+ }
42
+ return {
43
+ ...settings,
44
+ storageConnections: {
45
+ ...settings.storageConnections,
46
+ [name]: structuredClone(connection),
47
+ },
48
+ };
49
+ }, signal);
50
+ }
51
+ export async function updateStorageConnection(name, update, expectedSetups, signal) {
52
+ validateConfigName(name, "storage connection");
53
+ await updateSettings((settings) => {
54
+ const connection = settings.storageConnections[name];
55
+ if (!connection)
56
+ throw new Error(`Storage connection not found: ${name}`);
57
+ const currentSetups = referencingSetupNames(settings.syncSetups, name);
58
+ if (expectedSetups && !sameNames(currentSetups, expectedSetups)) {
59
+ throw new Error(`Storage connection “${name}” usage changed while it was open; reopen it and review the affected sync setups.`);
60
+ }
61
+ const nextConnection = update(structuredClone(connection));
62
+ const nextConnections = { ...settings.storageConnections, [name]: nextConnection };
63
+ assertUniqueLocations(settings.syncSetups, nextConnections);
64
+ return { ...settings, storageConnections: nextConnections };
65
+ }, signal);
66
+ }
67
+ export async function addSyncSetup(name, setup, signal, expectedConnection) {
68
+ validateConfigName(name, "sync setup");
69
+ await updateSettings((settings) => {
70
+ if (Object.hasOwn(settings.syncSetups, name))
71
+ throw new Error(`Sync setup already exists: ${name}`);
72
+ if (!Object.hasOwn(settings.storageConnections, setup.storage.connection)) {
73
+ throw new Error(`Storage connection not found: ${setup.storage.connection}`);
74
+ }
75
+ if (expectedConnection &&
76
+ !isDeepStrictEqual(settings.storageConnections[setup.storage.connection], expectedConnection)) {
77
+ throw new SyncSetupReviewChangedError("Storage connection changed while the setup review was open; reopen it.");
78
+ }
79
+ const nextSetups = { ...settings.syncSetups, [name]: structuredClone(setup) };
80
+ assertUniqueLocations(nextSetups, settings.storageConnections);
81
+ return {
82
+ ...settings,
83
+ syncSetups: nextSetups,
84
+ ...(settings.activeSyncSetup ? {} : { activeSyncSetup: name }),
85
+ };
86
+ }, signal);
87
+ }
88
+ export async function updateSyncSetup(name, update, options = {}) {
89
+ validateConfigName(name, "sync setup");
90
+ await updateSettings((settings) => {
91
+ const setup = settings.syncSetups[name];
92
+ if (!setup)
93
+ throw new Error(`Sync setup not found: ${name}`);
94
+ if (options.expectedConfigFingerprint !== undefined &&
95
+ syncCheckConfigFingerprint(configFromSettings(settings, name)) !== options.expectedConfigFingerprint) {
96
+ throw new SyncSetupReviewChangedError(`Sync setup “${name}” changed while it was open; reopen it and review the current configuration.`);
97
+ }
98
+ if (options.expectedInclude && !sameNames(normalizeSyncInclude(setup.sync.include), options.expectedInclude)) {
99
+ throw new SyncSetupReviewChangedError(`Sync setup “${name}” included content changed while it was open; reopen it and review the current selection.`);
100
+ }
101
+ if (options.expectedStorage) {
102
+ const connectionName = setup.storage.connection;
103
+ const connection = settings.storageConnections[connectionName];
104
+ if (!connection ||
105
+ !sameStorageReview(syncSetupStorageReview(name, setup, connectionName, connection), options.expectedStorage)) {
106
+ throw new SyncSetupReviewChangedError(`Sync setup “${name}” storage changed while it was open; reopen it and review the current storage location.`);
107
+ }
108
+ }
109
+ if (options.expectedConnection &&
110
+ !isDeepStrictEqual(settings.storageConnections[setup.storage.connection], options.expectedConnection)) {
111
+ throw new SyncSetupReviewChangedError("Storage connection changed while the setup review was open; reopen it.");
112
+ }
113
+ const nextSetup = update(structuredClone(setup));
114
+ if (!Object.hasOwn(settings.storageConnections, nextSetup.storage.connection)) {
115
+ throw new Error(`Storage connection not found: ${nextSetup.storage.connection}`);
116
+ }
117
+ const nextSetups = { ...settings.syncSetups, [name]: nextSetup };
118
+ assertUniqueLocations(nextSetups, settings.storageConnections);
119
+ return { ...settings, ...(options.upgradeExclude ? { version: 6 } : {}), syncSetups: nextSetups };
120
+ }, options.signal);
121
+ }
122
+ export async function removeSyncSetup(name, signal) {
123
+ validateConfigName(name, "sync setup");
124
+ await updateSettings((settings) => {
125
+ if (!Object.hasOwn(settings.syncSetups, name))
126
+ throw new Error(`Sync setup not found: ${name}`);
127
+ const isCurrent = settings.activeSyncSetup === name;
128
+ if (isCurrent && Object.keys(settings.syncSetups).length > 1) {
129
+ throw new Error("Switch to another sync setup before removing the current setup.");
130
+ }
131
+ const syncSetups = { ...settings.syncSetups };
132
+ delete syncSetups[name];
133
+ const next = { ...settings, syncSetups };
134
+ if (isCurrent)
135
+ delete next.activeSyncSetup;
136
+ return next;
137
+ }, signal);
138
+ }
139
+ export async function removeStorageConnection(name, signal) {
140
+ validateConfigName(name, "storage connection");
141
+ await updateSettings((settings) => {
142
+ const referenced = referencingSetupNames(settings.syncSetups, name)[0];
143
+ if (referenced) {
144
+ throw new Error(`Storage connection “${name}” is used by sync setup “${referenced}”.`);
145
+ }
146
+ if (!Object.hasOwn(settings.storageConnections, name)) {
147
+ throw new Error(`Storage connection not found: ${name}`);
148
+ }
149
+ const storageConnections = { ...settings.storageConnections };
150
+ delete storageConnections[name];
151
+ return { ...settings, storageConnections };
152
+ }, signal);
153
+ }
154
+ async function updateSettings(update, signal) {
155
+ return updateLocalConfig((settings) => {
156
+ if (settings.version !== 3 && settings.version !== 4 && settings.version !== 5 && settings.version !== 6) {
157
+ throw new Error("Storage connections and sync setups require version 3, 4, 5 or 6 pi-sync settings.");
158
+ }
159
+ return update(settings);
160
+ }, signal);
161
+ }
162
+ function referencingSetupNames(setups, connection) {
163
+ return Object.entries(setups)
164
+ .filter(([, setup]) => setup.storage.connection === connection)
165
+ .map(([name]) => name)
166
+ .sort((left, right) => left.localeCompare(right));
167
+ }
168
+ function assertUniqueLocations(setups, connections) {
169
+ const identities = new Map();
170
+ for (const [name, setup] of Object.entries(setups)) {
171
+ const connection = connections[setup.storage.connection];
172
+ if (!connection)
173
+ throw new Error(`Storage connection not found: ${setup.storage.connection}`);
174
+ const identity = effectiveSyncSetupRemoteIdentity(setup, connection);
175
+ const previous = identities.get(identity);
176
+ if (previous) {
177
+ throw new Error(`Sync setup “${name}” duplicates the storage location of “${previous}”.`);
178
+ }
179
+ identities.set(identity, name);
180
+ }
181
+ }
182
+ function sameNames(left, right) {
183
+ return left.length === right.length && left.every((name, index) => name === right[index]);
184
+ }
185
+ function sameStorageReview(left, right) {
186
+ return (left.connectionName === right.connectionName &&
187
+ left.storageKind === right.storageKind &&
188
+ left.storagePath === right.storagePath &&
189
+ left.bucket === right.bucket &&
190
+ left.branch === right.branch);
191
+ }
@@ -0,0 +1,8 @@
1
+ import type { OnSwitchAction, PiSyncSettingsV3 } from "./settings-types.js";
2
+ export declare function requireSettings(): Promise<PiSyncSettingsV3>;
3
+ export declare function configuredSyncSetupNames(): Promise<string[]>;
4
+ export declare function loadOnSwitch(): Promise<OnSwitchAction>;
5
+ export declare function localConfigTemplate(): PiSyncSettingsV3;
6
+ export declare function readLocalConfigDocument(): Promise<import("./config-file.js").LocalConfigDocument | undefined>;
7
+ export declare function readLocalConfigObject(): Promise<PiSyncSettingsV3 | undefined>;
8
+ export declare function updateLocalConfig(update: (current: PiSyncSettingsV3) => PiSyncSettingsV3, signal?: AbortSignal): Promise<PiSyncSettingsV3>;
@@ -0,0 +1,41 @@
1
+ import { localConfigPath, readMigratingLocalConfigDocument, updateLocalConfigDocument } from "./config-file.js";
2
+ import { DEFAULT_ON_SWITCH, validateSettingsDocument } from "./settings-validation.js";
3
+ export async function requireSettings() {
4
+ const settings = await readLocalConfigObject();
5
+ if (!settings) {
6
+ throw new Error(`Missing pi-sync settings. Open /sync and choose Set up sync, or create ${localConfigPath()}.`);
7
+ }
8
+ return settings;
9
+ }
10
+ export async function configuredSyncSetupNames() {
11
+ const settings = await readLocalConfigObject();
12
+ return settings ? Object.keys(settings.syncSetups).sort((left, right) => left.localeCompare(right)) : [];
13
+ }
14
+ export async function loadOnSwitch() {
15
+ return (await requireSettings()).onSwitch;
16
+ }
17
+ export function localConfigTemplate() {
18
+ return {
19
+ version: 3,
20
+ onSwitch: DEFAULT_ON_SWITCH,
21
+ skipSecretScan: false,
22
+ showStatus: true,
23
+ debug: false,
24
+ storageConnections: {},
25
+ syncSetups: {},
26
+ };
27
+ }
28
+ export async function readLocalConfigDocument() {
29
+ const document = await readMigratingLocalConfigDocument((settings) => {
30
+ validateSettingsDocument(settings);
31
+ });
32
+ if (document)
33
+ validateSettingsDocument(document.parsed);
34
+ return document;
35
+ }
36
+ export async function readLocalConfigObject() {
37
+ return (await readLocalConfigDocument())?.parsed;
38
+ }
39
+ export function updateLocalConfig(update, signal) {
40
+ return updateLocalConfigDocument(localConfigTemplate(), update, validateSettingsDocument, signal);
41
+ }
@@ -0,0 +1,134 @@
1
+ import type { ResolvedS3Backend, ResolvedSyncBackend } from "../backends/backend-types.js";
2
+ export type StorageConnectionType = "s3" | "git" | "webdav";
3
+ export type OnSwitchAction = "ask-before-pull" | "pull-after-switch" | "switch-only";
4
+ export interface S3CredentialsSettings {
5
+ accessKeyId: string;
6
+ secretAccessKey: string;
7
+ sessionToken?: string;
8
+ [key: string]: unknown;
9
+ }
10
+ export interface WebDavCredentialsSettings {
11
+ username: string;
12
+ password: string;
13
+ [key: string]: unknown;
14
+ }
15
+ export interface S3StorageConnectionSettings {
16
+ type: "s3";
17
+ endpoint: string;
18
+ region: string;
19
+ credentials: S3CredentialsSettings;
20
+ remote?: never;
21
+ url?: never;
22
+ [key: string]: unknown;
23
+ }
24
+ export interface GitStorageConnectionSettings {
25
+ type: "git";
26
+ remote: string;
27
+ endpoint?: never;
28
+ region?: never;
29
+ credentials?: never;
30
+ url?: never;
31
+ [key: string]: unknown;
32
+ }
33
+ export interface WebDavStorageConnectionSettings {
34
+ type: "webdav";
35
+ url: string;
36
+ credentials: WebDavCredentialsSettings;
37
+ endpoint?: never;
38
+ region?: never;
39
+ remote?: never;
40
+ [key: string]: unknown;
41
+ }
42
+ export type StorageConnectionSettings = S3StorageConnectionSettings | GitStorageConnectionSettings | WebDavStorageConnectionSettings;
43
+ export interface CommonSyncSetupStorageSettings {
44
+ connection: string;
45
+ path: string;
46
+ [key: string]: unknown;
47
+ }
48
+ export interface S3SyncSetupStorageSettings extends CommonSyncSetupStorageSettings {
49
+ bucket: string;
50
+ branch?: never;
51
+ }
52
+ export interface GitSyncSetupStorageSettings extends CommonSyncSetupStorageSettings {
53
+ branch: string;
54
+ bucket?: never;
55
+ }
56
+ export interface WebDavSyncSetupStorageSettings extends CommonSyncSetupStorageSettings {
57
+ bucket?: never;
58
+ branch?: never;
59
+ }
60
+ export type SyncSetupStorageSettings = S3SyncSetupStorageSettings | GitSyncSetupStorageSettings | WebDavSyncSetupStorageSettings;
61
+ export interface SyncPolicySettings {
62
+ include: string[];
63
+ exclude?: string[];
64
+ automatic: boolean;
65
+ /** Explicit opt-in, separate from the legacy observe/shutdown policy. */
66
+ automaticTransfer?: boolean;
67
+ /** Autonomous merged-sync authorization. */
68
+ agentMode?: boolean;
69
+ /** Separate explicit authorization for recurring background work. */
70
+ continuous?: boolean;
71
+ /** Version 4: settings.json root fields never uploaded. */
72
+ localFields?: string[];
73
+ mergeSettings?: boolean;
74
+ mergeContent?: boolean;
75
+ partialSync?: boolean;
76
+ [key: string]: unknown;
77
+ }
78
+ export interface SyncSetupSettings {
79
+ storage: SyncSetupStorageSettings;
80
+ sync: SyncPolicySettings;
81
+ [key: string]: unknown;
82
+ }
83
+ export interface PiSyncSettingsV3 {
84
+ version: 3 | 4 | 5 | 6;
85
+ activeSyncSetup?: string;
86
+ onSwitch: OnSwitchAction;
87
+ skipSecretScan?: boolean;
88
+ showStatus?: boolean;
89
+ debug?: boolean;
90
+ storageConnections: Record<string, StorageConnectionSettings>;
91
+ syncSetups: Record<string, SyncSetupSettings>;
92
+ [key: string]: unknown;
93
+ }
94
+ export interface SyncConfig<Backend extends ResolvedSyncBackend = ResolvedS3Backend> {
95
+ setupName: string;
96
+ connectionName: string;
97
+ storagePath: string;
98
+ /** Snapshot/wire identity retained behind the settings normalization boundary. */
99
+ snapshotIdentity: string;
100
+ include: string[];
101
+ exclude?: string[];
102
+ automatic: boolean;
103
+ automaticTransfer?: boolean;
104
+ agentMode?: boolean;
105
+ continuous?: boolean;
106
+ localFields?: string[];
107
+ mergeSettings?: boolean;
108
+ mergeContent?: boolean;
109
+ partialSync?: boolean;
110
+ onSwitch: OnSwitchAction;
111
+ skipSecretScan: boolean;
112
+ showStatus: boolean;
113
+ debug?: boolean;
114
+ backend: Backend;
115
+ }
116
+ export type AnySyncConfig = SyncConfig<ResolvedSyncBackend>;
117
+ export type CommonSyncConfig = Omit<AnySyncConfig, "backend">;
118
+ /** UI projection over a fully validated v3 setup; it is never persisted directly. */
119
+ export interface PartialConfig {
120
+ setupName: string;
121
+ connectionName: string;
122
+ storageKind: StorageConnectionType;
123
+ storagePath: string;
124
+ include: string[];
125
+ exclude?: string[];
126
+ automatic: boolean;
127
+ automaticTransfer?: boolean;
128
+ agentMode?: boolean;
129
+ continuous?: boolean;
130
+ onSwitch: OnSwitchAction;
131
+ showStatus: boolean;
132
+ bucket?: string;
133
+ branch?: string;
134
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,15 @@
1
+ import type { OnSwitchAction, PiSyncSettingsV3, StorageConnectionSettings, SyncSetupSettings } from "./settings-types.js";
2
+ export declare const DEFAULT_ON_SWITCH: OnSwitchAction;
3
+ export declare function normalizeOnSwitch(value: unknown): OnSwitchAction;
4
+ export declare function validateSettingsDocument(value: Record<string, unknown>): PiSyncSettingsV3;
5
+ export declare function validateUniqueRemoteSyncSetups(setups: Record<string, unknown>, connections: Record<string, unknown>): void;
6
+ export declare function effectiveSyncSetupRemoteIdentity(setup: SyncSetupSettings, connection: StorageConnectionSettings): string;
7
+ export declare function ownObject<T extends object>(value: Record<string, unknown>, key: string): T | undefined;
8
+ export declare function validateConfigName(value: string, field: string): void;
9
+ export declare function requiredString(value: unknown, field: string): string;
10
+ export declare function optionalString(value: unknown, field: string): string | undefined;
11
+ export declare function normalizeStoragePath(value: string): string;
12
+ export declare function normalizeS3Endpoint(value: string): string;
13
+ export declare function normalizeS3Bucket(value: string | undefined): string;
14
+ export declare function isCloudflareR2Endpoint(endpoint: string | undefined): boolean;
15
+ export declare function ownRecord(value: unknown): Record<string, unknown> | undefined;