-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathpullWatchers.ts
More file actions
283 lines (250 loc) · 8.45 KB
/
pullWatchers.ts
File metadata and controls
283 lines (250 loc) · 8.45 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
import { type json, normalizeProps } from "~/utils/getBlockProps";
import type { AddPullWatch, PullBlock } from "roamjs-components/types";
import {
STATIC_TOP_LEVEL_ENTRIES,
getPersonalSettingsKey,
FeatureFlagsSchema,
GlobalSettingsSchema,
PersonalSettingsSchema,
DiscourseNodeSchema,
type FeatureFlags,
type GlobalSettings,
type PersonalSettings,
type DiscourseNodeSettings,
} from "./zodSchema";
type PullWatchCallback = Parameters<AddPullWatch>[2];
// Need assertions to bridge type defs between the (roamjs-components) and json type (getBlockProps.ts)
const getNormalizedProps = (data: PullBlock | null): Record<string, json> => {
return normalizeProps((data?.[":block/props"] || {}) as json) as Record<
string,
json
>;
};
const hasPropChanged = (
before: PullBlock | null,
after: PullBlock | null,
key?: string,
): boolean => {
const beforeProps = getNormalizedProps(before);
const afterProps = getNormalizedProps(after);
if (key) {
return JSON.stringify(beforeProps[key]) !== JSON.stringify(afterProps[key]);
}
return JSON.stringify(beforeProps) !== JSON.stringify(afterProps);
};
const createCleanupFn = (watches: Parameters<AddPullWatch>[]): (() => void) => {
return () => {
watches.forEach(([pattern, entityId, callback]) => {
window.roamAlphaAPI.data.removePullWatch(pattern, entityId, callback);
});
};
};
const createSettingsWatchCallback = <T>(
schema: { safeParse: (data: unknown) => { success: boolean; data?: T } },
onSettingsChange: (context: {
newSettings: T;
oldSettings: T | null;
before: PullBlock | null;
after: PullBlock | null;
}) => void,
): PullWatchCallback => {
return (before, after) => {
const beforeProps = getNormalizedProps(before);
const afterProps = getNormalizedProps(after);
const beforeResult = schema.safeParse(beforeProps);
const afterResult = schema.safeParse(afterProps);
if (!afterResult.success) return;
const oldSettings = beforeResult.success
? (beforeResult.data ?? null)
: null;
const newSettings = afterResult.data as T;
onSettingsChange({ newSettings, oldSettings, before, after });
};
};
const addPullWatch = (
watches: Parameters<AddPullWatch>[],
blockUid: string,
callback: PullWatchCallback,
): void => {
const pattern = "[:block/props]";
const entityId = `[:block/uid "${blockUid}"]`;
window.roamAlphaAPI.data.addPullWatch(pattern, entityId, callback);
watches.push([pattern, entityId, callback]);
};
export const featureFlagHandlers: Partial<
Record<
keyof FeatureFlags,
(newValue: boolean, oldValue: boolean, allFlags: FeatureFlags) => void
>
> = {
// Add handlers as needed:
// "Enable Left Sidebar": (newValue) => { ... },
// "Suggestive Mode Enabled": (newValue) => { ... },
// "Reified Relation Triples": (newValue) => { ... },
};
type GlobalSettingsHandlers = {
[K in keyof GlobalSettings]?: (
newValue: GlobalSettings[K],
oldValue: GlobalSettings[K],
allSettings: GlobalSettings,
) => void;
};
export const globalSettingsHandlers: GlobalSettingsHandlers = {
// Add handlers as needed:
// "Trigger": (newValue) => { ... },
// "Canvas Page Format": (newValue) => { ... },
// "Left Sidebar": (newValue) => { ... },
// "Export": (newValue) => { ... },
// "Suggestive Mode": (newValue) => { ... },
};
type PersonalSettingsHandlers = {
[K in keyof PersonalSettings]?: (
newValue: PersonalSettings[K],
oldValue: PersonalSettings[K],
allSettings: PersonalSettings,
) => void;
};
export const personalSettingsHandlers: PersonalSettingsHandlers = {
// "Left Sidebar" stub for testing with stubSetLeftSidebarPersonalSections() in accessors.ts
/* eslint-disable @typescript-eslint/naming-convention */
"Left sidebar": (newValue, oldValue) => {
const oldSections = Object.keys(oldValue || {});
const newSections = Object.keys(newValue || {});
if (newSections.length === 0 && oldSections.length === 0) return;
console.group("👤 [PullWatch] Personal Settings Changed: Left Sidebar");
console.log("Old value:", JSON.stringify(oldValue, null, 2));
console.log("New value:", JSON.stringify(newValue, null, 2));
const addedSections = newSections.filter((s) => !oldSections.includes(s));
const removedSections = oldSections.filter((s) => !newSections.includes(s));
if (addedSections.length > 0) {
console.log(" → Sections added:", addedSections);
}
if (removedSections.length > 0) {
console.log(" → Sections removed:", removedSections);
}
console.groupEnd();
},
/* eslint-enable @typescript-eslint/naming-convention */
};
export const discourseNodeHandlers: Array<
(
nodeType: string,
newSettings: DiscourseNodeSettings,
oldSettings: DiscourseNodeSettings | null,
) => void
> = [
// Add handlers as needed:
// (nodeType, newSettings, oldSettings) => { ... },
];
export const setupPullWatchOnSettingsPage = (
blockUids: Record<string, string>,
): (() => void) => {
const watches: Parameters<AddPullWatch>[] = [];
const featureFlagsBlockUid =
blockUids[STATIC_TOP_LEVEL_ENTRIES.featureFlags.key];
const globalSettingsBlockUid = blockUids[STATIC_TOP_LEVEL_ENTRIES.global.key];
const personalSettingsKey = getPersonalSettingsKey();
const personalSettingsBlockUid = blockUids[personalSettingsKey];
if (featureFlagsBlockUid && Object.keys(featureFlagHandlers).length > 0) {
addPullWatch(
watches,
featureFlagsBlockUid,
createSettingsWatchCallback(
FeatureFlagsSchema,
({ newSettings, oldSettings, before, after }) => {
for (const [key, handler] of Object.entries(featureFlagHandlers)) {
const typedKey = key as keyof FeatureFlags;
if (hasPropChanged(before, after, key) && handler) {
handler(
newSettings[typedKey],
oldSettings?.[typedKey] ?? false,
newSettings,
);
}
}
},
),
);
}
if (
globalSettingsBlockUid &&
Object.keys(globalSettingsHandlers).length > 0
) {
addPullWatch(
watches,
globalSettingsBlockUid,
createSettingsWatchCallback(
GlobalSettingsSchema,
({ newSettings, oldSettings, before, after }) => {
for (const [key, handler] of Object.entries(globalSettingsHandlers)) {
const typedKey = key as keyof GlobalSettings;
if (hasPropChanged(before, after, key) && handler) {
// Object.entries loses key-handler correlation, but data is Zod-validated
(
handler as (
newValue: unknown,
oldValue: unknown,
allSettings: GlobalSettings,
) => void
)(newSettings[typedKey], oldSettings?.[typedKey], newSettings);
}
}
},
),
);
}
if (
personalSettingsBlockUid &&
Object.keys(personalSettingsHandlers).length > 0
) {
addPullWatch(
watches,
personalSettingsBlockUid,
createSettingsWatchCallback(
PersonalSettingsSchema,
({ newSettings, oldSettings, before, after }) => {
for (const [key, handler] of Object.entries(
personalSettingsHandlers,
)) {
const typedKey = key as keyof PersonalSettings;
if (hasPropChanged(before, after, key) && handler) {
// Object.entries loses key-handler correlation, but data is Zod-validated
(
handler as (
newValue: unknown,
oldValue: unknown,
allSettings: PersonalSettings,
) => void
)(newSettings[typedKey], oldSettings?.[typedKey], newSettings);
}
}
},
),
);
}
return createCleanupFn(watches);
};
export const setupPullWatchDiscourseNodes = (
nodePageUids: Record<string, string>,
): (() => void) => {
const watches: Parameters<AddPullWatch>[] = [];
if (discourseNodeHandlers.length === 0) {
return () => {};
}
Object.entries(nodePageUids).forEach(([nodeType, pageUid]) => {
addPullWatch(
watches,
pageUid,
createSettingsWatchCallback(
DiscourseNodeSchema,
({ newSettings, oldSettings }) => {
for (const handler of discourseNodeHandlers) {
handler(nodeType, newSettings, oldSettings);
}
},
),
);
});
return createCleanupFn(watches);
};
export { getNormalizedProps, hasPropChanged };