velocious 1.0.396 → 1.0.398

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 (44) hide show
  1. package/README.md +12 -0
  2. package/build/src/configuration.d.ts +9 -0
  3. package/build/src/configuration.d.ts.map +1 -1
  4. package/build/src/configuration.js +19 -7
  5. package/build/src/database/record/instance-relationships/has-many.d.ts +2 -0
  6. package/build/src/database/record/instance-relationships/has-many.d.ts.map +1 -1
  7. package/build/src/database/record/instance-relationships/has-many.js +13 -1
  8. package/build/src/frontend-models/base.d.ts +22 -5
  9. package/build/src/frontend-models/base.d.ts.map +1 -1
  10. package/build/src/frontend-models/base.js +176 -33
  11. package/build/src/frontend-models/clear-pending-debounced-callback.d.ts +6 -0
  12. package/build/src/frontend-models/clear-pending-debounced-callback.d.ts.map +1 -0
  13. package/build/src/frontend-models/clear-pending-debounced-callback.js +12 -0
  14. package/build/src/frontend-models/event-hook-models.d.ts +12 -0
  15. package/build/src/frontend-models/event-hook-models.d.ts.map +1 -0
  16. package/build/src/frontend-models/event-hook-models.js +37 -0
  17. package/build/src/frontend-models/query.d.ts +63 -0
  18. package/build/src/frontend-models/query.d.ts.map +1 -1
  19. package/build/src/frontend-models/query.js +51 -1
  20. package/build/src/frontend-models/use-created-event.d.ts +17 -0
  21. package/build/src/frontend-models/use-created-event.d.ts.map +1 -0
  22. package/build/src/frontend-models/use-created-event.js +19 -0
  23. package/build/src/frontend-models/use-destroyed-event.d.ts +19 -0
  24. package/build/src/frontend-models/use-destroyed-event.d.ts.map +1 -0
  25. package/build/src/frontend-models/use-destroyed-event.js +103 -0
  26. package/build/src/frontend-models/use-model-class-event.d.ts +27 -0
  27. package/build/src/frontend-models/use-model-class-event.d.ts.map +1 -0
  28. package/build/src/frontend-models/use-model-class-event.js +116 -0
  29. package/build/src/frontend-models/use-updated-event.d.ts +20 -0
  30. package/build/src/frontend-models/use-updated-event.d.ts.map +1 -0
  31. package/build/src/frontend-models/use-updated-event.js +105 -0
  32. package/build/src/frontend-models/websocket-channel.d.ts +54 -12
  33. package/build/src/frontend-models/websocket-channel.d.ts.map +1 -1
  34. package/build/src/frontend-models/websocket-channel.js +116 -6
  35. package/build/src/http-server/client/websocket-session.js +2 -2
  36. package/build/src/http-server/websocket-channel.d.ts +29 -9
  37. package/build/src/http-server/websocket-channel.d.ts.map +1 -1
  38. package/build/src/http-server/websocket-channel.js +23 -5
  39. package/build/src/testing/browser-frontend-model-event-hook-scenarios.d.ts +56 -0
  40. package/build/src/testing/browser-frontend-model-event-hook-scenarios.d.ts.map +1 -0
  41. package/build/src/testing/browser-frontend-model-event-hook-scenarios.js +374 -0
  42. package/build/src/testing/browser-test-app.js +3 -1
  43. package/build/tsconfig.tsbuildinfo +1 -1
  44. package/package.json +10 -1
@@ -0,0 +1,17 @@
1
+ /** @typedef {typeof import("./base.js").default} FrontendModelClass */
2
+ /** @typedef {import("./use-model-class-event.js").FrontendModelCreateUpdateEventPayload} FrontendModelCreateEventPayload */
3
+ /** @typedef {import("./use-model-class-event.js").UseModelClassEventOptions} UseCreatedEventOptions */
4
+ /** @typedef {(payload: FrontendModelCreateEventPayload) => void} FrontendModelCreateEventCallback */
5
+ /**
6
+ * React hook for frontend-model class create events.
7
+ * @param {FrontendModelClass | null | undefined} modelClass - Frontend model class.
8
+ * @param {FrontendModelCreateEventCallback} callback - Event callback.
9
+ * @param {UseCreatedEventOptions} [options] - Hook options.
10
+ * @returns {void}
11
+ */
12
+ export default function useCreatedEvent(modelClass: FrontendModelClass | null | undefined, callback: FrontendModelCreateEventCallback, options?: UseCreatedEventOptions): void;
13
+ export type FrontendModelClass = typeof import("./base.js").default;
14
+ export type FrontendModelCreateEventPayload = import("./use-model-class-event.js").FrontendModelCreateUpdateEventPayload;
15
+ export type UseCreatedEventOptions = import("./use-model-class-event.js").UseModelClassEventOptions;
16
+ export type FrontendModelCreateEventCallback = (payload: FrontendModelCreateEventPayload) => void;
17
+ //# sourceMappingURL=use-created-event.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-created-event.d.ts","sourceRoot":"","sources":["../../../src/frontend-models/use-created-event.js"],"names":[],"mappings":"AAIA,uEAAuE;AACvE,4HAA4H;AAC5H,uGAAuG;AACvG,qGAAqG;AAErG;;;;;;GAMG;AACH,oDALW,kBAAkB,GAAG,IAAI,GAAG,SAAS,YACrC,gCAAgC,YAChC,sBAAsB,GACpB,IAAI,CAMhB;iCAhBa,cAAc,WAAW,EAAE,OAAO;8CAClC,OAAO,4BAA4B,EAAE,qCAAqC;qCAC1E,OAAO,4BAA4B,EAAE,yBAAyB;+CAC9D,CAAC,OAAO,EAAE,+BAA+B,KAAK,IAAI"}
@@ -0,0 +1,19 @@
1
+ // @ts-check
2
+ import useModelClassEvent from "./use-model-class-event.js";
3
+ /** @typedef {typeof import("./base.js").default} FrontendModelClass */
4
+ /** @typedef {import("./use-model-class-event.js").FrontendModelCreateUpdateEventPayload} FrontendModelCreateEventPayload */
5
+ /** @typedef {import("./use-model-class-event.js").UseModelClassEventOptions} UseCreatedEventOptions */
6
+ /** @typedef {(payload: FrontendModelCreateEventPayload) => void} FrontendModelCreateEventCallback */
7
+ /**
8
+ * React hook for frontend-model class create events.
9
+ * @param {FrontendModelClass | null | undefined} modelClass - Frontend model class.
10
+ * @param {FrontendModelCreateEventCallback} callback - Event callback.
11
+ * @param {UseCreatedEventOptions} [options] - Hook options.
12
+ * @returns {void}
13
+ */
14
+ export default function useCreatedEvent(modelClass, callback, options = {}) {
15
+ useModelClassEvent(modelClass, "create", (payload) => {
16
+ callback(/** @type {FrontendModelCreateEventPayload} */ (payload));
17
+ }, options);
18
+ }
19
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXNlLWNyZWF0ZWQtZXZlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvZnJvbnRlbmQtbW9kZWxzL3VzZS1jcmVhdGVkLWV2ZW50LmpzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLFlBQVk7QUFFWixPQUFPLGtCQUFrQixNQUFNLDRCQUE0QixDQUFBO0FBRTNELHVFQUF1RTtBQUN2RSw0SEFBNEg7QUFDNUgsdUdBQXVHO0FBQ3ZHLHFHQUFxRztBQUVyRzs7Ozs7O0dBTUc7QUFDSCxNQUFNLENBQUMsT0FBTyxVQUFVLGVBQWUsQ0FBQyxVQUFVLEVBQUUsUUFBUSxFQUFFLE9BQU8sR0FBRyxFQUFFO0lBQ3hFLGtCQUFrQixDQUFDLFVBQVUsRUFBRSxRQUFRLEVBQUUsQ0FBQyxPQUFPLEVBQUUsRUFBRTtRQUNuRCxRQUFRLENBQUMsOENBQThDLENBQUMsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFBO0lBQ3BFLENBQUMsRUFBRSxPQUFPLENBQUMsQ0FBQTtBQUNiLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBAdHMtY2hlY2tcblxuaW1wb3J0IHVzZU1vZGVsQ2xhc3NFdmVudCBmcm9tIFwiLi91c2UtbW9kZWwtY2xhc3MtZXZlbnQuanNcIlxuXG4vKiogQHR5cGVkZWYge3R5cGVvZiBpbXBvcnQoXCIuL2Jhc2UuanNcIikuZGVmYXVsdH0gRnJvbnRlbmRNb2RlbENsYXNzICovXG4vKiogQHR5cGVkZWYge2ltcG9ydChcIi4vdXNlLW1vZGVsLWNsYXNzLWV2ZW50LmpzXCIpLkZyb250ZW5kTW9kZWxDcmVhdGVVcGRhdGVFdmVudFBheWxvYWR9IEZyb250ZW5kTW9kZWxDcmVhdGVFdmVudFBheWxvYWQgKi9cbi8qKiBAdHlwZWRlZiB7aW1wb3J0KFwiLi91c2UtbW9kZWwtY2xhc3MtZXZlbnQuanNcIikuVXNlTW9kZWxDbGFzc0V2ZW50T3B0aW9uc30gVXNlQ3JlYXRlZEV2ZW50T3B0aW9ucyAqL1xuLyoqIEB0eXBlZGVmIHsocGF5bG9hZDogRnJvbnRlbmRNb2RlbENyZWF0ZUV2ZW50UGF5bG9hZCkgPT4gdm9pZH0gRnJvbnRlbmRNb2RlbENyZWF0ZUV2ZW50Q2FsbGJhY2sgKi9cblxuLyoqXG4gKiBSZWFjdCBob29rIGZvciBmcm9udGVuZC1tb2RlbCBjbGFzcyBjcmVhdGUgZXZlbnRzLlxuICogQHBhcmFtIHtGcm9udGVuZE1vZGVsQ2xhc3MgfCBudWxsIHwgdW5kZWZpbmVkfSBtb2RlbENsYXNzIC0gRnJvbnRlbmQgbW9kZWwgY2xhc3MuXG4gKiBAcGFyYW0ge0Zyb250ZW5kTW9kZWxDcmVhdGVFdmVudENhbGxiYWNrfSBjYWxsYmFjayAtIEV2ZW50IGNhbGxiYWNrLlxuICogQHBhcmFtIHtVc2VDcmVhdGVkRXZlbnRPcHRpb25zfSBbb3B0aW9uc10gLSBIb29rIG9wdGlvbnMuXG4gKiBAcmV0dXJucyB7dm9pZH1cbiAqL1xuZXhwb3J0IGRlZmF1bHQgZnVuY3Rpb24gdXNlQ3JlYXRlZEV2ZW50KG1vZGVsQ2xhc3MsIGNhbGxiYWNrLCBvcHRpb25zID0ge30pIHtcbiAgdXNlTW9kZWxDbGFzc0V2ZW50KG1vZGVsQ2xhc3MsIFwiY3JlYXRlXCIsIChwYXlsb2FkKSA9PiB7XG4gICAgY2FsbGJhY2soLyoqIEB0eXBlIHtGcm9udGVuZE1vZGVsQ3JlYXRlRXZlbnRQYXlsb2FkfSAqLyAocGF5bG9hZCkpXG4gIH0sIG9wdGlvbnMpXG59XG4iXX0=
@@ -0,0 +1,19 @@
1
+ /**
2
+ * React hook for frontend-model destroy events. Pass a model class for class-level
3
+ * destroy events, or a model / model array for instance-level destroy events.
4
+ * @param {FrontendModelClass | FrontendModelInstance | FrontendModelInstance[] | null | undefined} modelClassOrModels - Model class, model, or models.
5
+ * @param {FrontendModelDestroyEventCallback} callback - Event callback.
6
+ * @param {UseDestroyedEventOptions} [options] - Hook options.
7
+ * @returns {void}
8
+ */
9
+ export default function useDestroyedEvent(modelClassOrModels: FrontendModelClass | FrontendModelInstance | FrontendModelInstance[] | null | undefined, callback: FrontendModelDestroyEventCallback, options?: UseDestroyedEventOptions): void;
10
+ export type FrontendModelClass = typeof import("./base.js").default;
11
+ export type FrontendModelInstance = import("./base.js").default;
12
+ export type FrontendModelClassDestroyEventPayload = import("./use-model-class-event.js").FrontendModelDestroyEventPayload;
13
+ export type FrontendModelInstanceDestroyEventPayload = {
14
+ id: string;
15
+ };
16
+ export type FrontendModelDestroyEventPayload = FrontendModelClassDestroyEventPayload | FrontendModelInstanceDestroyEventPayload;
17
+ export type UseDestroyedEventOptions = import("./use-model-class-event.js").UseModelClassEventOptions;
18
+ export type FrontendModelDestroyEventCallback = (payload: FrontendModelDestroyEventPayload) => void;
19
+ //# sourceMappingURL=use-destroyed-event.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-destroyed-event.d.ts","sourceRoot":"","sources":["../../../src/frontend-models/use-destroyed-event.js"],"names":[],"mappings":"AA6BA;;;;;;;GAOG;AACH,8DALW,kBAAkB,GAAG,qBAAqB,GAAG,qBAAqB,EAAE,GAAG,IAAI,GAAG,SAAS,YACvF,iCAAiC,YACjC,wBAAwB,GACtB,IAAI,CAYhB;iCAtCa,cAAc,WAAW,EAAE,OAAO;oCAClC,OAAO,WAAW,EAAE,OAAO;oDAC3B,OAAO,4BAA4B,EAAE,gCAAgC;uDACrE;IAAC,EAAE,EAAE,MAAM,CAAA;CAAC;+CACZ,qCAAqC,GAAG,wCAAwC;uCAChF,OAAO,4BAA4B,EAAE,yBAAyB;gDAC9D,CAAC,OAAO,EAAE,gCAAgC,KAAK,IAAI"}
@@ -0,0 +1,103 @@
1
+ // @ts-check
2
+ import debounceFunction from "debounce";
3
+ import { useEffect, useMemo, useRef } from "react";
4
+ import clearPendingDebouncedCallback from "./clear-pending-debounced-callback.js";
5
+ import { modelsDependencyKey, modelsFromInput } from "./event-hook-models.js";
6
+ import useModelClassEvent from "./use-model-class-event.js";
7
+ /** @typedef {typeof import("./base.js").default} FrontendModelClass */
8
+ /** @typedef {import("./base.js").default} FrontendModelInstance */
9
+ /** @typedef {import("./use-model-class-event.js").FrontendModelDestroyEventPayload} FrontendModelClassDestroyEventPayload */
10
+ /** @typedef {{id: string}} FrontendModelInstanceDestroyEventPayload */
11
+ /** @typedef {FrontendModelClassDestroyEventPayload | FrontendModelInstanceDestroyEventPayload} FrontendModelDestroyEventPayload */
12
+ /** @typedef {import("./use-model-class-event.js").UseModelClassEventOptions} UseDestroyedEventOptions */
13
+ /** @typedef {(payload: FrontendModelDestroyEventPayload) => void} FrontendModelDestroyEventCallback */
14
+ /**
15
+ * @param {Record<string, import("./query.js").FrontendModelTransportValue | (() => void) | undefined>} restOptions - Unknown options object.
16
+ * @returns {void}
17
+ */
18
+ function assertNoUnknownOptions(restOptions) {
19
+ const unknownOptionNames = Object.keys(restOptions);
20
+ if (unknownOptionNames.length > 0) {
21
+ throw new Error(`Unknown options given to useDestroyedEvent: ${unknownOptionNames.join(", ")}`);
22
+ }
23
+ }
24
+ /**
25
+ * React hook for frontend-model destroy events. Pass a model class for class-level
26
+ * destroy events, or a model / model array for instance-level destroy events.
27
+ * @param {FrontendModelClass | FrontendModelInstance | FrontendModelInstance[] | null | undefined} modelClassOrModels - Model class, model, or models.
28
+ * @param {FrontendModelDestroyEventCallback} callback - Event callback.
29
+ * @param {UseDestroyedEventOptions} [options] - Hook options.
30
+ * @returns {void}
31
+ */
32
+ export default function useDestroyedEvent(modelClassOrModels, callback, options = {}) {
33
+ const { active = true, abilities, debounce = false, onConnected, preload, queryData, select, withCount, ...restOptions } = options;
34
+ assertNoUnknownOptions(restOptions);
35
+ const classModel = typeof modelClassOrModels === "function" ? modelClassOrModels : null;
36
+ const instanceModels = typeof modelClassOrModels === "function" ? null : modelClassOrModels;
37
+ const projectionOptions = { abilities, preload, queryData, select, withCount };
38
+ useModelClassEvent(classModel, "destroy", callback, { active: active && Boolean(classModel), debounce, onConnected, ...projectionOptions });
39
+ useInstanceDestroyedEvent(instanceModels, callback, { active: active && !classModel, debounce, onConnected, ...projectionOptions });
40
+ }
41
+ /**
42
+ * @param {FrontendModelInstance | FrontendModelInstance[] | null | undefined} modelOrModels - Model or models.
43
+ * @param {FrontendModelDestroyEventCallback} callback - Event callback.
44
+ * @param {UseDestroyedEventOptions} options - Hook options.
45
+ * @returns {void}
46
+ */
47
+ function useInstanceDestroyedEvent(modelOrModels, callback, options) {
48
+ const { active = true, abilities, debounce = false, onConnected, preload, queryData, select, withCount } = options;
49
+ const projectionKey = JSON.stringify({ abilities, preload, queryData, select, withCount });
50
+ const projectionOptionsRef = useRef({ abilities, preload, queryData, select, withCount });
51
+ const callbackRef = useRef(callback);
52
+ const activeRef = useRef(active);
53
+ projectionOptionsRef.current = { abilities, preload, queryData, select, withCount };
54
+ callbackRef.current = callback;
55
+ activeRef.current = active;
56
+ const modelsKey = modelsDependencyKey(modelOrModels);
57
+ const eventCallback = useMemo(() => {
58
+ const wrappedCallback = (/** @type {FrontendModelInstanceDestroyEventPayload} */ payload) => {
59
+ if (activeRef.current)
60
+ callbackRef.current(payload);
61
+ };
62
+ if (typeof debounce === "number")
63
+ return debounceFunction(wrappedCallback, debounce);
64
+ if (debounce)
65
+ return debounceFunction(wrappedCallback);
66
+ return wrappedCallback;
67
+ }, [debounce]);
68
+ useEffect(() => {
69
+ if (!active)
70
+ return undefined;
71
+ const models = modelsFromInput(modelOrModels);
72
+ if (models.length < 1)
73
+ return undefined;
74
+ let closed = false;
75
+ /** @type {Array<() => void>} */
76
+ const unsubscribeCallbacks = [];
77
+ const subscriptionCallback = (/** @type {FrontendModelInstanceDestroyEventPayload} */ payload) => {
78
+ if (!closed)
79
+ eventCallback(payload);
80
+ };
81
+ void (async () => {
82
+ for (const model of models) {
83
+ const unsubscribe = await model.onDestroy(subscriptionCallback, projectionOptionsRef.current);
84
+ if (closed) {
85
+ unsubscribe();
86
+ }
87
+ else {
88
+ unsubscribeCallbacks.push(unsubscribe);
89
+ }
90
+ }
91
+ if (!closed && onConnected)
92
+ onConnected();
93
+ })();
94
+ return () => {
95
+ closed = true;
96
+ for (const unsubscribe of unsubscribeCallbacks) {
97
+ unsubscribe();
98
+ }
99
+ clearPendingDebouncedCallback(eventCallback);
100
+ };
101
+ }, [active, eventCallback, modelsKey, onConnected, projectionKey]);
102
+ }
103
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"use-destroyed-event.js","sourceRoot":"","sources":["../../../src/frontend-models/use-destroyed-event.js"],"names":[],"mappings":"AAAA,YAAY;AAEZ,OAAO,gBAAgB,MAAM,UAAU,CAAA;AACvC,OAAO,EAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAC,MAAM,OAAO,CAAA;AAEhD,OAAO,6BAA6B,MAAM,uCAAuC,CAAA;AACjF,OAAO,EAAC,mBAAmB,EAAE,eAAe,EAAC,MAAM,wBAAwB,CAAA;AAC3E,OAAO,kBAAkB,MAAM,4BAA4B,CAAA;AAE3D,uEAAuE;AACvE,mEAAmE;AACnE,6HAA6H;AAC7H,uEAAuE;AACvE,mIAAmI;AACnI,yGAAyG;AACzG,uGAAuG;AAEvG;;;GAGG;AACH,SAAS,sBAAsB,CAAC,WAAW;IACzC,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAEnD,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,+CAA+C,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACjG,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,kBAAkB,EAAE,QAAQ,EAAE,OAAO,GAAG,EAAE;IAClF,MAAM,EAAC,MAAM,GAAG,IAAI,EAAE,SAAS,EAAE,QAAQ,GAAG,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,EAAC,GAAG,OAAO,CAAA;IAChI,sBAAsB,CAAC,WAAW,CAAC,CAAA;IAEnC,MAAM,UAAU,GAAG,OAAO,kBAAkB,KAAK,UAAU,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAA;IACvF,MAAM,cAAc,GAAG,OAAO,kBAAkB,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAA;IAC3F,MAAM,iBAAiB,GAAG,EAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,CAAA;IAE5E,kBAAkB,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAC,MAAM,EAAE,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,iBAAiB,EAAC,CAAC,CAAA;IACzI,yBAAyB,CAAC,cAAc,EAAE,QAAQ,EAAE,EAAC,MAAM,EAAE,MAAM,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,iBAAiB,EAAC,CAAC,CAAA;AACnI,CAAC;AAED;;;;;GAKG;AACH,SAAS,yBAAyB,CAAC,aAAa,EAAE,QAAQ,EAAE,OAAO;IACjE,MAAM,EAAC,MAAM,GAAG,IAAI,EAAE,SAAS,EAAE,QAAQ,GAAG,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,GAAG,OAAO,CAAA;IAChH,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,EAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAA;IACxF,MAAM,oBAAoB,GAAG,MAAM,CAAC,EAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAA;IACvF,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IACpC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;IAChC,oBAAoB,CAAC,OAAO,GAAG,EAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,CAAA;IACjF,WAAW,CAAC,OAAO,GAAG,QAAQ,CAAA;IAC9B,SAAS,CAAC,OAAO,GAAG,MAAM,CAAA;IAE1B,MAAM,SAAS,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAA;IACpD,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE;QACjC,MAAM,eAAe,GAAG,CAAC,uDAAuD,CAAC,OAAO,EAAE,EAAE;YAC1F,IAAI,SAAS,CAAC,OAAO;gBAAE,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACrD,CAAC,CAAA;QAED,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAAE,OAAO,gBAAgB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAA;QACpF,IAAI,QAAQ;YAAE,OAAO,gBAAgB,CAAC,eAAe,CAAC,CAAA;QAEtD,OAAO,eAAe,CAAA;IACxB,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;IAEd,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,MAAM;YAAE,OAAO,SAAS,CAAA;QAE7B,MAAM,MAAM,GAAG,eAAe,CAAC,aAAa,CAAC,CAAA;QAC7C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,SAAS,CAAA;QAEvC,IAAI,MAAM,GAAG,KAAK,CAAA;QAClB,gCAAgC;QAChC,MAAM,oBAAoB,GAAG,EAAE,CAAA;QAC/B,MAAM,oBAAoB,GAAG,CAAC,uDAAuD,CAAC,OAAO,EAAE,EAAE;YAC/F,IAAI,CAAC,MAAM;gBAAE,aAAa,CAAC,OAAO,CAAC,CAAA;QACrC,CAAC,CAAA;QAED,KAAK,CAAC,KAAK,IAAI,EAAE;YACf,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAA;gBAE7F,IAAI,MAAM,EAAE,CAAC;oBACX,WAAW,EAAE,CAAA;gBACf,CAAC;qBAAM,CAAC;oBACN,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBACxC,CAAC;YACH,CAAC;YAED,IAAI,CAAC,MAAM,IAAI,WAAW;gBAAE,WAAW,EAAE,CAAA;QAC3C,CAAC,CAAC,EAAE,CAAA;QAEJ,OAAO,GAAG,EAAE;YACV,MAAM,GAAG,IAAI,CAAA;YAEb,KAAK,MAAM,WAAW,IAAI,oBAAoB,EAAE,CAAC;gBAC/C,WAAW,EAAE,CAAA;YACf,CAAC;YAED,6BAA6B,CAAC,aAAa,CAAC,CAAA;QAC9C,CAAC,CAAA;IACH,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC,CAAA;AACpE,CAAC","sourcesContent":["// @ts-check\n\nimport debounceFunction from \"debounce\"\nimport {useEffect, useMemo, useRef} from \"react\"\n\nimport clearPendingDebouncedCallback from \"./clear-pending-debounced-callback.js\"\nimport {modelsDependencyKey, modelsFromInput} from \"./event-hook-models.js\"\nimport useModelClassEvent from \"./use-model-class-event.js\"\n\n/** @typedef {typeof import(\"./base.js\").default} FrontendModelClass */\n/** @typedef {import(\"./base.js\").default} FrontendModelInstance */\n/** @typedef {import(\"./use-model-class-event.js\").FrontendModelDestroyEventPayload} FrontendModelClassDestroyEventPayload */\n/** @typedef {{id: string}} FrontendModelInstanceDestroyEventPayload */\n/** @typedef {FrontendModelClassDestroyEventPayload | FrontendModelInstanceDestroyEventPayload} FrontendModelDestroyEventPayload */\n/** @typedef {import(\"./use-model-class-event.js\").UseModelClassEventOptions} UseDestroyedEventOptions */\n/** @typedef {(payload: FrontendModelDestroyEventPayload) => void} FrontendModelDestroyEventCallback */\n\n/**\n * @param {Record<string, import(\"./query.js\").FrontendModelTransportValue | (() => void) | undefined>} restOptions - Unknown options object.\n * @returns {void}\n */\nfunction assertNoUnknownOptions(restOptions) {\n  const unknownOptionNames = Object.keys(restOptions)\n\n  if (unknownOptionNames.length > 0) {\n    throw new Error(`Unknown options given to useDestroyedEvent: ${unknownOptionNames.join(\", \")}`)\n  }\n}\n\n/**\n * React hook for frontend-model destroy events. Pass a model class for class-level\n * destroy events, or a model / model array for instance-level destroy events.\n * @param {FrontendModelClass | FrontendModelInstance | FrontendModelInstance[] | null | undefined} modelClassOrModels - Model class, model, or models.\n * @param {FrontendModelDestroyEventCallback} callback - Event callback.\n * @param {UseDestroyedEventOptions} [options] - Hook options.\n * @returns {void}\n */\nexport default function useDestroyedEvent(modelClassOrModels, callback, options = {}) {\n  const {active = true, abilities, debounce = false, onConnected, preload, queryData, select, withCount, ...restOptions} = options\n  assertNoUnknownOptions(restOptions)\n\n  const classModel = typeof modelClassOrModels === \"function\" ? modelClassOrModels : null\n  const instanceModels = typeof modelClassOrModels === \"function\" ? null : modelClassOrModels\n  const projectionOptions = {abilities, preload, queryData, select, withCount}\n\n  useModelClassEvent(classModel, \"destroy\", callback, {active: active && Boolean(classModel), debounce, onConnected, ...projectionOptions})\n  useInstanceDestroyedEvent(instanceModels, callback, {active: active && !classModel, debounce, onConnected, ...projectionOptions})\n}\n\n/**\n * @param {FrontendModelInstance | FrontendModelInstance[] | null | undefined} modelOrModels - Model or models.\n * @param {FrontendModelDestroyEventCallback} callback - Event callback.\n * @param {UseDestroyedEventOptions} options - Hook options.\n * @returns {void}\n */\nfunction useInstanceDestroyedEvent(modelOrModels, callback, options) {\n  const {active = true, abilities, debounce = false, onConnected, preload, queryData, select, withCount} = options\n  const projectionKey = JSON.stringify({abilities, preload, queryData, select, withCount})\n  const projectionOptionsRef = useRef({abilities, preload, queryData, select, withCount})\n  const callbackRef = useRef(callback)\n  const activeRef = useRef(active)\n  projectionOptionsRef.current = {abilities, preload, queryData, select, withCount}\n  callbackRef.current = callback\n  activeRef.current = active\n\n  const modelsKey = modelsDependencyKey(modelOrModels)\n  const eventCallback = useMemo(() => {\n    const wrappedCallback = (/** @type {FrontendModelInstanceDestroyEventPayload} */ payload) => {\n      if (activeRef.current) callbackRef.current(payload)\n    }\n\n    if (typeof debounce === \"number\") return debounceFunction(wrappedCallback, debounce)\n    if (debounce) return debounceFunction(wrappedCallback)\n\n    return wrappedCallback\n  }, [debounce])\n\n  useEffect(() => {\n    if (!active) return undefined\n\n    const models = modelsFromInput(modelOrModels)\n    if (models.length < 1) return undefined\n\n    let closed = false\n    /** @type {Array<() => void>} */\n    const unsubscribeCallbacks = []\n    const subscriptionCallback = (/** @type {FrontendModelInstanceDestroyEventPayload} */ payload) => {\n      if (!closed) eventCallback(payload)\n    }\n\n    void (async () => {\n      for (const model of models) {\n        const unsubscribe = await model.onDestroy(subscriptionCallback, projectionOptionsRef.current)\n\n        if (closed) {\n          unsubscribe()\n        } else {\n          unsubscribeCallbacks.push(unsubscribe)\n        }\n      }\n\n      if (!closed && onConnected) onConnected()\n    })()\n\n    return () => {\n      closed = true\n\n      for (const unsubscribe of unsubscribeCallbacks) {\n        unsubscribe()\n      }\n\n      clearPendingDebouncedCallback(eventCallback)\n    }\n  }, [active, eventCallback, modelsKey, onConnected, projectionKey])\n}\n"]}
@@ -0,0 +1,27 @@
1
+ /**
2
+ * React hook for frontend-model class lifecycle events.
3
+ * @param {FrontendModelClass | null | undefined} modelClass - Frontend model class.
4
+ * @param {FrontendModelClassEventName | FrontendModelClassEventName[]} eventOrEvents - Event name or names.
5
+ * @param {FrontendModelClassEventCallback} callback - Event callback.
6
+ * @param {UseModelClassEventOptions} [options] - Hook options.
7
+ * @returns {void}
8
+ */
9
+ export default function useModelClassEvent(modelClass: FrontendModelClass | null | undefined, eventOrEvents: FrontendModelClassEventName | FrontendModelClassEventName[], callback: FrontendModelClassEventCallback, options?: UseModelClassEventOptions): void;
10
+ export type FrontendModelClass = typeof import("./base.js").default;
11
+ export type FrontendModelInstance = InstanceType<FrontendModelClass>;
12
+ export type FrontendModelClassEventName = "create" | "update" | "destroy";
13
+ export type FrontendModelCreateUpdateEventPayload = {
14
+ id: string;
15
+ model: FrontendModelInstance;
16
+ };
17
+ export type FrontendModelDestroyEventPayload = {
18
+ id: string;
19
+ };
20
+ export type FrontendModelClassEventPayload = FrontendModelCreateUpdateEventPayload | FrontendModelDestroyEventPayload;
21
+ export type FrontendModelClassEventCallback = (payload: FrontendModelClassEventPayload) => void;
22
+ export type UseModelClassEventOptions = {
23
+ active?: boolean;
24
+ debounce?: boolean | number;
25
+ onConnected?: () => void;
26
+ } & import("./query.js").FrontendModelProjectionOptions;
27
+ //# sourceMappingURL=use-model-class-event.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-model-class-event.d.ts","sourceRoot":"","sources":["../../../src/frontend-models/use-model-class-event.js"],"names":[],"mappings":"AA2DA;;;;;;;GAOG;AACH,uDANW,kBAAkB,GAAG,IAAI,GAAG,SAAS,iBACrC,2BAA2B,GAAG,2BAA2B,EAAE,YAC3D,+BAA+B,YAC/B,yBAAyB,GACvB,IAAI,CA6DhB;iCAvHa,cAAc,WAAW,EAAE,OAAO;oCAClC,YAAY,CAAC,kBAAkB,CAAC;0CAChC,QAAQ,GAAG,QAAQ,GAAG,SAAS;oDAC/B;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,qBAAqB,CAAA;CAAC;+CAC1C;IAAC,EAAE,EAAE,MAAM,CAAA;CAAC;6CACZ,qCAAqC,GAAG,gCAAgC;8CACxE,CAAC,OAAO,EAAE,8BAA8B,KAAK,IAAI;wCACjD;IAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,IAAI,CAAA;CAAC,GAAG,OAAO,YAAY,EAAE,8BAA8B"}
@@ -0,0 +1,116 @@
1
+ // @ts-check
2
+ import debounceFunction from "debounce";
3
+ import { useEffect, useMemo, useRef } from "react";
4
+ import clearPendingDebouncedCallback from "./clear-pending-debounced-callback.js";
5
+ /** @typedef {typeof import("./base.js").default} FrontendModelClass */
6
+ /** @typedef {InstanceType<FrontendModelClass>} FrontendModelInstance */
7
+ /** @typedef {"create" | "update" | "destroy"} FrontendModelClassEventName */
8
+ /** @typedef {{id: string, model: FrontendModelInstance}} FrontendModelCreateUpdateEventPayload */
9
+ /** @typedef {{id: string}} FrontendModelDestroyEventPayload */
10
+ /** @typedef {FrontendModelCreateUpdateEventPayload | FrontendModelDestroyEventPayload} FrontendModelClassEventPayload */
11
+ /** @typedef {(payload: FrontendModelClassEventPayload) => void} FrontendModelClassEventCallback */
12
+ /** @typedef {{active?: boolean, debounce?: boolean | number, onConnected?: () => void} & import("./query.js").FrontendModelProjectionOptions} UseModelClassEventOptions */
13
+ /**
14
+ * @param {FrontendModelClassEventName | FrontendModelClassEventName[]} eventOrEvents - Event name or names.
15
+ * @returns {FrontendModelClassEventName[]} - Normalized event names.
16
+ */
17
+ function normalizeEventNames(eventOrEvents) {
18
+ return Array.isArray(eventOrEvents) ? eventOrEvents : [eventOrEvents];
19
+ }
20
+ /**
21
+ * @param {FrontendModelClassEventName[]} eventNames - Event names.
22
+ * @returns {string} - Stable dependency key.
23
+ */
24
+ function eventNamesDependencyKey(eventNames) {
25
+ return eventNames.join("|");
26
+ }
27
+ /**
28
+ * @param {Record<string, import("./query.js").FrontendModelTransportValue | (() => void) | undefined>} restOptions - Unknown options object.
29
+ * @returns {void}
30
+ */
31
+ function assertNoUnknownOptions(restOptions) {
32
+ const unknownOptionNames = Object.keys(restOptions);
33
+ if (unknownOptionNames.length > 0) {
34
+ throw new Error(`Unknown options given to useModelClassEvent: ${unknownOptionNames.join(", ")}`);
35
+ }
36
+ }
37
+ /**
38
+ * @param {FrontendModelClass} modelClass - Frontend model class.
39
+ * @param {FrontendModelClassEventName} eventName - Event name.
40
+ * @param {FrontendModelClassEventCallback} callback - Event callback.
41
+ * @param {import("./query.js").FrontendModelProjectionOptions} options - Event record projection options.
42
+ * @returns {Promise<() => void>} - Unsubscribe callback.
43
+ */
44
+ async function subscribeToModelClassEvent(modelClass, eventName, callback, options) {
45
+ if (eventName === "create")
46
+ return await modelClass.onCreate(callback, options);
47
+ if (eventName === "update")
48
+ return await modelClass.onUpdate(callback, options);
49
+ if (eventName === "destroy")
50
+ return await modelClass.onDestroy(callback, options);
51
+ throw new Error(`Unsupported frontend model class event: ${eventName}`);
52
+ }
53
+ /**
54
+ * React hook for frontend-model class lifecycle events.
55
+ * @param {FrontendModelClass | null | undefined} modelClass - Frontend model class.
56
+ * @param {FrontendModelClassEventName | FrontendModelClassEventName[]} eventOrEvents - Event name or names.
57
+ * @param {FrontendModelClassEventCallback} callback - Event callback.
58
+ * @param {UseModelClassEventOptions} [options] - Hook options.
59
+ * @returns {void}
60
+ */
61
+ export default function useModelClassEvent(modelClass, eventOrEvents, callback, options = {}) {
62
+ const { active = true, abilities, debounce = false, onConnected, preload, queryData, select, withCount, ...restOptions } = options;
63
+ assertNoUnknownOptions(restOptions);
64
+ const projectionKey = JSON.stringify({ abilities, preload, queryData, select, withCount });
65
+ const projectionOptionsRef = useRef({ abilities, preload, queryData, select, withCount });
66
+ const callbackRef = useRef(callback);
67
+ const activeRef = useRef(active);
68
+ projectionOptionsRef.current = { abilities, preload, queryData, select, withCount };
69
+ callbackRef.current = callback;
70
+ activeRef.current = active;
71
+ const eventNames = normalizeEventNames(eventOrEvents);
72
+ const eventsKey = eventNamesDependencyKey(eventNames);
73
+ const eventCallback = useMemo(() => {
74
+ const wrappedCallback = (/** @type {FrontendModelClassEventPayload} */ payload) => {
75
+ if (activeRef.current)
76
+ callbackRef.current(payload);
77
+ };
78
+ if (typeof debounce === "number")
79
+ return debounceFunction(wrappedCallback, debounce);
80
+ if (debounce)
81
+ return debounceFunction(wrappedCallback);
82
+ return wrappedCallback;
83
+ }, [debounce]);
84
+ useEffect(() => {
85
+ if (!active || !modelClass)
86
+ return undefined;
87
+ let closed = false;
88
+ /** @type {Array<() => void>} */
89
+ const unsubscribeCallbacks = [];
90
+ const subscriptionCallback = (/** @type {FrontendModelClassEventPayload} */ payload) => {
91
+ if (!closed)
92
+ eventCallback(payload);
93
+ };
94
+ void (async () => {
95
+ for (const eventName of eventNames) {
96
+ const unsubscribe = await subscribeToModelClassEvent(modelClass, eventName, subscriptionCallback, projectionOptionsRef.current);
97
+ if (closed) {
98
+ unsubscribe();
99
+ }
100
+ else {
101
+ unsubscribeCallbacks.push(unsubscribe);
102
+ }
103
+ }
104
+ if (!closed && onConnected)
105
+ onConnected();
106
+ })();
107
+ return () => {
108
+ closed = true;
109
+ for (const unsubscribe of unsubscribeCallbacks) {
110
+ unsubscribe();
111
+ }
112
+ clearPendingDebouncedCallback(eventCallback);
113
+ };
114
+ }, [active, eventsKey, eventCallback, modelClass, onConnected, projectionKey]);
115
+ }
116
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"use-model-class-event.js","sourceRoot":"","sources":["../../../src/frontend-models/use-model-class-event.js"],"names":[],"mappings":"AAAA,YAAY;AAEZ,OAAO,gBAAgB,MAAM,UAAU,CAAA;AACvC,OAAO,EAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAC,MAAM,OAAO,CAAA;AAEhD,OAAO,6BAA6B,MAAM,uCAAuC,CAAA;AAEjF,uEAAuE;AACvE,wEAAwE;AACxE,6EAA6E;AAC7E,kGAAkG;AAClG,+DAA+D;AAC/D,yHAAyH;AACzH,mGAAmG;AACnG,2KAA2K;AAE3K;;;GAGG;AACH,SAAS,mBAAmB,CAAC,aAAa;IACxC,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAA;AACvE,CAAC;AAED;;;GAGG;AACH,SAAS,uBAAuB,CAAC,UAAU;IACzC,OAAO,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAC7B,CAAC;AAED;;;GAGG;AACH,SAAS,sBAAsB,CAAC,WAAW;IACzC,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAEnD,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,gDAAgD,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAClG,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,0BAA0B,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO;IAChF,IAAI,SAAS,KAAK,QAAQ;QAAE,OAAO,MAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC/E,IAAI,SAAS,KAAK,QAAQ;QAAE,OAAO,MAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC/E,IAAI,SAAS,KAAK,SAAS;QAAE,OAAO,MAAM,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAEjF,MAAM,IAAI,KAAK,CAAC,2CAA2C,SAAS,EAAE,CAAC,CAAA;AACzE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,UAAU,EAAE,aAAa,EAAE,QAAQ,EAAE,OAAO,GAAG,EAAE;IAC1F,MAAM,EAAC,MAAM,GAAG,IAAI,EAAE,SAAS,EAAE,QAAQ,GAAG,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,EAAC,GAAG,OAAO,CAAA;IAChI,sBAAsB,CAAC,WAAW,CAAC,CAAA;IAEnC,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,EAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAA;IACxF,MAAM,oBAAoB,GAAG,MAAM,CAAC,EAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAA;IACvF,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IACpC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;IAChC,oBAAoB,CAAC,OAAO,GAAG,EAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,CAAA;IACjF,WAAW,CAAC,OAAO,GAAG,QAAQ,CAAA;IAC9B,SAAS,CAAC,OAAO,GAAG,MAAM,CAAA;IAE1B,MAAM,UAAU,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAA;IACrD,MAAM,SAAS,GAAG,uBAAuB,CAAC,UAAU,CAAC,CAAA;IACrD,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE;QACjC,MAAM,eAAe,GAAG,CAAC,6CAA6C,CAAC,OAAO,EAAE,EAAE;YAChF,IAAI,SAAS,CAAC,OAAO;gBAAE,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACrD,CAAC,CAAA;QAED,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAAE,OAAO,gBAAgB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAA;QACpF,IAAI,QAAQ;YAAE,OAAO,gBAAgB,CAAC,eAAe,CAAC,CAAA;QAEtD,OAAO,eAAe,CAAA;IACxB,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;IAEd,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU;YAAE,OAAO,SAAS,CAAA;QAE5C,IAAI,MAAM,GAAG,KAAK,CAAA;QAClB,gCAAgC;QAChC,MAAM,oBAAoB,GAAG,EAAE,CAAA;QAC/B,MAAM,oBAAoB,GAAG,CAAC,6CAA6C,CAAC,OAAO,EAAE,EAAE;YACrF,IAAI,CAAC,MAAM;gBAAE,aAAa,CAAC,OAAO,CAAC,CAAA;QACrC,CAAC,CAAA;QAED,KAAK,CAAC,KAAK,IAAI,EAAE;YACf,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;gBACnC,MAAM,WAAW,GAAG,MAAM,0BAA0B,CAAC,UAAU,EAAE,SAAS,EAAE,oBAAoB,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAA;gBAE/H,IAAI,MAAM,EAAE,CAAC;oBACX,WAAW,EAAE,CAAA;gBACf,CAAC;qBAAM,CAAC;oBACN,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBACxC,CAAC;YACH,CAAC;YAED,IAAI,CAAC,MAAM,IAAI,WAAW;gBAAE,WAAW,EAAE,CAAA;QAC3C,CAAC,CAAC,EAAE,CAAA;QAEJ,OAAO,GAAG,EAAE;YACV,MAAM,GAAG,IAAI,CAAA;YAEb,KAAK,MAAM,WAAW,IAAI,oBAAoB,EAAE,CAAC;gBAC/C,WAAW,EAAE,CAAA;YACf,CAAC;YAED,6BAA6B,CAAC,aAAa,CAAC,CAAA;QAC9C,CAAC,CAAA;IACH,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC,CAAA;AAChF,CAAC","sourcesContent":["// @ts-check\n\nimport debounceFunction from \"debounce\"\nimport {useEffect, useMemo, useRef} from \"react\"\n\nimport clearPendingDebouncedCallback from \"./clear-pending-debounced-callback.js\"\n\n/** @typedef {typeof import(\"./base.js\").default} FrontendModelClass */\n/** @typedef {InstanceType<FrontendModelClass>} FrontendModelInstance */\n/** @typedef {\"create\" | \"update\" | \"destroy\"} FrontendModelClassEventName */\n/** @typedef {{id: string, model: FrontendModelInstance}} FrontendModelCreateUpdateEventPayload */\n/** @typedef {{id: string}} FrontendModelDestroyEventPayload */\n/** @typedef {FrontendModelCreateUpdateEventPayload | FrontendModelDestroyEventPayload} FrontendModelClassEventPayload */\n/** @typedef {(payload: FrontendModelClassEventPayload) => void} FrontendModelClassEventCallback */\n/** @typedef {{active?: boolean, debounce?: boolean | number, onConnected?: () => void} & import(\"./query.js\").FrontendModelProjectionOptions} UseModelClassEventOptions */\n\n/**\n * @param {FrontendModelClassEventName | FrontendModelClassEventName[]} eventOrEvents - Event name or names.\n * @returns {FrontendModelClassEventName[]} - Normalized event names.\n */\nfunction normalizeEventNames(eventOrEvents) {\n  return Array.isArray(eventOrEvents) ? eventOrEvents : [eventOrEvents]\n}\n\n/**\n * @param {FrontendModelClassEventName[]} eventNames - Event names.\n * @returns {string} - Stable dependency key.\n */\nfunction eventNamesDependencyKey(eventNames) {\n  return eventNames.join(\"|\")\n}\n\n/**\n * @param {Record<string, import(\"./query.js\").FrontendModelTransportValue | (() => void) | undefined>} restOptions - Unknown options object.\n * @returns {void}\n */\nfunction assertNoUnknownOptions(restOptions) {\n  const unknownOptionNames = Object.keys(restOptions)\n\n  if (unknownOptionNames.length > 0) {\n    throw new Error(`Unknown options given to useModelClassEvent: ${unknownOptionNames.join(\", \")}`)\n  }\n}\n\n/**\n * @param {FrontendModelClass} modelClass - Frontend model class.\n * @param {FrontendModelClassEventName} eventName - Event name.\n * @param {FrontendModelClassEventCallback} callback - Event callback.\n * @param {import(\"./query.js\").FrontendModelProjectionOptions} options - Event record projection options.\n * @returns {Promise<() => void>} - Unsubscribe callback.\n */\nasync function subscribeToModelClassEvent(modelClass, eventName, callback, options) {\n  if (eventName === \"create\") return await modelClass.onCreate(callback, options)\n  if (eventName === \"update\") return await modelClass.onUpdate(callback, options)\n  if (eventName === \"destroy\") return await modelClass.onDestroy(callback, options)\n\n  throw new Error(`Unsupported frontend model class event: ${eventName}`)\n}\n\n/**\n * React hook for frontend-model class lifecycle events.\n * @param {FrontendModelClass | null | undefined} modelClass - Frontend model class.\n * @param {FrontendModelClassEventName | FrontendModelClassEventName[]} eventOrEvents - Event name or names.\n * @param {FrontendModelClassEventCallback} callback - Event callback.\n * @param {UseModelClassEventOptions} [options] - Hook options.\n * @returns {void}\n */\nexport default function useModelClassEvent(modelClass, eventOrEvents, callback, options = {}) {\n  const {active = true, abilities, debounce = false, onConnected, preload, queryData, select, withCount, ...restOptions} = options\n  assertNoUnknownOptions(restOptions)\n\n  const projectionKey = JSON.stringify({abilities, preload, queryData, select, withCount})\n  const projectionOptionsRef = useRef({abilities, preload, queryData, select, withCount})\n  const callbackRef = useRef(callback)\n  const activeRef = useRef(active)\n  projectionOptionsRef.current = {abilities, preload, queryData, select, withCount}\n  callbackRef.current = callback\n  activeRef.current = active\n\n  const eventNames = normalizeEventNames(eventOrEvents)\n  const eventsKey = eventNamesDependencyKey(eventNames)\n  const eventCallback = useMemo(() => {\n    const wrappedCallback = (/** @type {FrontendModelClassEventPayload} */ payload) => {\n      if (activeRef.current) callbackRef.current(payload)\n    }\n\n    if (typeof debounce === \"number\") return debounceFunction(wrappedCallback, debounce)\n    if (debounce) return debounceFunction(wrappedCallback)\n\n    return wrappedCallback\n  }, [debounce])\n\n  useEffect(() => {\n    if (!active || !modelClass) return undefined\n\n    let closed = false\n    /** @type {Array<() => void>} */\n    const unsubscribeCallbacks = []\n    const subscriptionCallback = (/** @type {FrontendModelClassEventPayload} */ payload) => {\n      if (!closed) eventCallback(payload)\n    }\n\n    void (async () => {\n      for (const eventName of eventNames) {\n        const unsubscribe = await subscribeToModelClassEvent(modelClass, eventName, subscriptionCallback, projectionOptionsRef.current)\n\n        if (closed) {\n          unsubscribe()\n        } else {\n          unsubscribeCallbacks.push(unsubscribe)\n        }\n      }\n\n      if (!closed && onConnected) onConnected()\n    })()\n\n    return () => {\n      closed = true\n\n      for (const unsubscribe of unsubscribeCallbacks) {\n        unsubscribe()\n      }\n\n      clearPendingDebouncedCallback(eventCallback)\n    }\n  }, [active, eventsKey, eventCallback, modelClass, onConnected, projectionKey])\n}\n"]}
@@ -0,0 +1,20 @@
1
+ /**
2
+ * React hook for frontend-model update events. Pass a model class for class-level
3
+ * update events, or a model / model array for instance-level update events.
4
+ * @param {FrontendModelClass | FrontendModelInstance | FrontendModelInstance[] | null | undefined} modelClassOrModels - Model class, model, or models.
5
+ * @param {FrontendModelUpdateEventCallback} callback - Event callback.
6
+ * @param {UseUpdatedEventOptions} [options] - Hook options.
7
+ * @returns {void}
8
+ */
9
+ export default function useUpdatedEvent(modelClassOrModels: FrontendModelClass | FrontendModelInstance | FrontendModelInstance[] | null | undefined, callback: FrontendModelUpdateEventCallback, options?: UseUpdatedEventOptions): void;
10
+ export type FrontendModelClass = typeof import("./base.js").default;
11
+ export type FrontendModelInstance = import("./base.js").default;
12
+ export type FrontendModelClassUpdateEventPayload = import("./use-model-class-event.js").FrontendModelCreateUpdateEventPayload;
13
+ export type FrontendModelInstanceUpdateEventPayload = {
14
+ id: string;
15
+ model: FrontendModelInstance;
16
+ };
17
+ export type FrontendModelUpdateEventPayload = FrontendModelClassUpdateEventPayload | FrontendModelInstanceUpdateEventPayload;
18
+ export type UseUpdatedEventOptions = import("./use-model-class-event.js").UseModelClassEventOptions;
19
+ export type FrontendModelUpdateEventCallback = (payload: FrontendModelUpdateEventPayload) => void;
20
+ //# sourceMappingURL=use-updated-event.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-updated-event.d.ts","sourceRoot":"","sources":["../../../src/frontend-models/use-updated-event.js"],"names":[],"mappings":"AA6BA;;;;;;;GAOG;AACH,4DALW,kBAAkB,GAAG,qBAAqB,GAAG,qBAAqB,EAAE,GAAG,IAAI,GAAG,SAAS,YACvF,gCAAgC,YAChC,sBAAsB,GACpB,IAAI,CAchB;iCAxCa,cAAc,WAAW,EAAE,OAAO;oCAClC,OAAO,WAAW,EAAE,OAAO;mDAC3B,OAAO,4BAA4B,EAAE,qCAAqC;sDAC1E;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,qBAAqB,CAAA;CAAC;8CAC1C,oCAAoC,GAAG,uCAAuC;qCAC9E,OAAO,4BAA4B,EAAE,yBAAyB;+CAC9D,CAAC,OAAO,EAAE,+BAA+B,KAAK,IAAI"}
@@ -0,0 +1,105 @@
1
+ // @ts-check
2
+ import debounceFunction from "debounce";
3
+ import { useEffect, useMemo, useRef } from "react";
4
+ import clearPendingDebouncedCallback from "./clear-pending-debounced-callback.js";
5
+ import { modelsDependencyKey, modelsFromInput } from "./event-hook-models.js";
6
+ import useModelClassEvent from "./use-model-class-event.js";
7
+ /** @typedef {typeof import("./base.js").default} FrontendModelClass */
8
+ /** @typedef {import("./base.js").default} FrontendModelInstance */
9
+ /** @typedef {import("./use-model-class-event.js").FrontendModelCreateUpdateEventPayload} FrontendModelClassUpdateEventPayload */
10
+ /** @typedef {{id: string, model: FrontendModelInstance}} FrontendModelInstanceUpdateEventPayload */
11
+ /** @typedef {FrontendModelClassUpdateEventPayload | FrontendModelInstanceUpdateEventPayload} FrontendModelUpdateEventPayload */
12
+ /** @typedef {import("./use-model-class-event.js").UseModelClassEventOptions} UseUpdatedEventOptions */
13
+ /** @typedef {(payload: FrontendModelUpdateEventPayload) => void} FrontendModelUpdateEventCallback */
14
+ /**
15
+ * @param {Record<string, import("./query.js").FrontendModelTransportValue | (() => void) | undefined>} restOptions - Unknown options object.
16
+ * @returns {void}
17
+ */
18
+ function assertNoUnknownOptions(restOptions) {
19
+ const unknownOptionNames = Object.keys(restOptions);
20
+ if (unknownOptionNames.length > 0) {
21
+ throw new Error(`Unknown options given to useUpdatedEvent: ${unknownOptionNames.join(", ")}`);
22
+ }
23
+ }
24
+ /**
25
+ * React hook for frontend-model update events. Pass a model class for class-level
26
+ * update events, or a model / model array for instance-level update events.
27
+ * @param {FrontendModelClass | FrontendModelInstance | FrontendModelInstance[] | null | undefined} modelClassOrModels - Model class, model, or models.
28
+ * @param {FrontendModelUpdateEventCallback} callback - Event callback.
29
+ * @param {UseUpdatedEventOptions} [options] - Hook options.
30
+ * @returns {void}
31
+ */
32
+ export default function useUpdatedEvent(modelClassOrModels, callback, options = {}) {
33
+ const { active = true, abilities, debounce = false, onConnected, preload, queryData, select, withCount, ...restOptions } = options;
34
+ assertNoUnknownOptions(restOptions);
35
+ const classModel = typeof modelClassOrModels === "function" ? modelClassOrModels : null;
36
+ const instanceModels = typeof modelClassOrModels === "function" ? null : modelClassOrModels;
37
+ const projectionOptions = { abilities, preload, queryData, select, withCount };
38
+ useModelClassEvent(classModel, "update", (payload) => {
39
+ callback(/** @type {FrontendModelClassUpdateEventPayload} */ (payload));
40
+ }, { active: active && Boolean(classModel), debounce, onConnected, ...projectionOptions });
41
+ useInstanceUpdatedEvent(instanceModels, callback, { active: active && !classModel, debounce, onConnected, ...projectionOptions });
42
+ }
43
+ /**
44
+ * @param {FrontendModelInstance | FrontendModelInstance[] | null | undefined} modelOrModels - Model or models.
45
+ * @param {FrontendModelUpdateEventCallback} callback - Event callback.
46
+ * @param {UseUpdatedEventOptions} options - Hook options.
47
+ * @returns {void}
48
+ */
49
+ function useInstanceUpdatedEvent(modelOrModels, callback, options) {
50
+ const { active = true, abilities, debounce = false, onConnected, preload, queryData, select, withCount } = options;
51
+ const projectionKey = JSON.stringify({ abilities, preload, queryData, select, withCount });
52
+ const projectionOptionsRef = useRef({ abilities, preload, queryData, select, withCount });
53
+ const callbackRef = useRef(callback);
54
+ const activeRef = useRef(active);
55
+ projectionOptionsRef.current = { abilities, preload, queryData, select, withCount };
56
+ callbackRef.current = callback;
57
+ activeRef.current = active;
58
+ const modelsKey = modelsDependencyKey(modelOrModels);
59
+ const eventCallback = useMemo(() => {
60
+ const wrappedCallback = (/** @type {FrontendModelInstanceUpdateEventPayload} */ payload) => {
61
+ if (activeRef.current)
62
+ callbackRef.current(payload);
63
+ };
64
+ if (typeof debounce === "number")
65
+ return debounceFunction(wrappedCallback, debounce);
66
+ if (debounce)
67
+ return debounceFunction(wrappedCallback);
68
+ return wrappedCallback;
69
+ }, [debounce]);
70
+ useEffect(() => {
71
+ if (!active)
72
+ return undefined;
73
+ const models = modelsFromInput(modelOrModels);
74
+ if (models.length < 1)
75
+ return undefined;
76
+ let closed = false;
77
+ /** @type {Array<() => void>} */
78
+ const unsubscribeCallbacks = [];
79
+ const subscriptionCallback = (/** @type {FrontendModelInstanceUpdateEventPayload} */ payload) => {
80
+ if (!closed)
81
+ eventCallback(payload);
82
+ };
83
+ void (async () => {
84
+ for (const model of models) {
85
+ const unsubscribe = await model.onUpdate(subscriptionCallback, projectionOptionsRef.current);
86
+ if (closed) {
87
+ unsubscribe();
88
+ }
89
+ else {
90
+ unsubscribeCallbacks.push(unsubscribe);
91
+ }
92
+ }
93
+ if (!closed && onConnected)
94
+ onConnected();
95
+ })();
96
+ return () => {
97
+ closed = true;
98
+ for (const unsubscribe of unsubscribeCallbacks) {
99
+ unsubscribe();
100
+ }
101
+ clearPendingDebouncedCallback(eventCallback);
102
+ };
103
+ }, [active, eventCallback, modelsKey, onConnected, projectionKey]);
104
+ }
105
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"use-updated-event.js","sourceRoot":"","sources":["../../../src/frontend-models/use-updated-event.js"],"names":[],"mappings":"AAAA,YAAY;AAEZ,OAAO,gBAAgB,MAAM,UAAU,CAAA;AACvC,OAAO,EAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAC,MAAM,OAAO,CAAA;AAEhD,OAAO,6BAA6B,MAAM,uCAAuC,CAAA;AACjF,OAAO,EAAC,mBAAmB,EAAE,eAAe,EAAC,MAAM,wBAAwB,CAAA;AAC3E,OAAO,kBAAkB,MAAM,4BAA4B,CAAA;AAE3D,uEAAuE;AACvE,mEAAmE;AACnE,iIAAiI;AACjI,oGAAoG;AACpG,gIAAgI;AAChI,uGAAuG;AACvG,qGAAqG;AAErG;;;GAGG;AACH,SAAS,sBAAsB,CAAC,WAAW;IACzC,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAEnD,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,6CAA6C,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC/F,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,kBAAkB,EAAE,QAAQ,EAAE,OAAO,GAAG,EAAE;IAChF,MAAM,EAAC,MAAM,GAAG,IAAI,EAAE,SAAS,EAAE,QAAQ,GAAG,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,EAAC,GAAG,OAAO,CAAA;IAChI,sBAAsB,CAAC,WAAW,CAAC,CAAA;IAEnC,MAAM,UAAU,GAAG,OAAO,kBAAkB,KAAK,UAAU,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAA;IACvF,MAAM,cAAc,GAAG,OAAO,kBAAkB,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAA;IAC3F,MAAM,iBAAiB,GAAG,EAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,CAAA;IAE5E,kBAAkB,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE;QACnD,QAAQ,CAAC,mDAAmD,CAAC,CAAC,OAAO,CAAC,CAAC,CAAA;IACzE,CAAC,EAAE,EAAC,MAAM,EAAE,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,iBAAiB,EAAC,CAAC,CAAA;IACxF,uBAAuB,CAAC,cAAc,EAAE,QAAQ,EAAE,EAAC,MAAM,EAAE,MAAM,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,iBAAiB,EAAC,CAAC,CAAA;AACjI,CAAC;AAED;;;;;GAKG;AACH,SAAS,uBAAuB,CAAC,aAAa,EAAE,QAAQ,EAAE,OAAO;IAC/D,MAAM,EAAC,MAAM,GAAG,IAAI,EAAE,SAAS,EAAE,QAAQ,GAAG,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,GAAG,OAAO,CAAA;IAChH,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,EAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAA;IACxF,MAAM,oBAAoB,GAAG,MAAM,CAAC,EAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAA;IACvF,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IACpC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;IAChC,oBAAoB,CAAC,OAAO,GAAG,EAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAC,CAAA;IACjF,WAAW,CAAC,OAAO,GAAG,QAAQ,CAAA;IAC9B,SAAS,CAAC,OAAO,GAAG,MAAM,CAAA;IAE1B,MAAM,SAAS,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAA;IACpD,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE;QACjC,MAAM,eAAe,GAAG,CAAC,sDAAsD,CAAC,OAAO,EAAE,EAAE;YACzF,IAAI,SAAS,CAAC,OAAO;gBAAE,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACrD,CAAC,CAAA;QAED,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAAE,OAAO,gBAAgB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAA;QACpF,IAAI,QAAQ;YAAE,OAAO,gBAAgB,CAAC,eAAe,CAAC,CAAA;QAEtD,OAAO,eAAe,CAAA;IACxB,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;IAEd,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,MAAM;YAAE,OAAO,SAAS,CAAA;QAE7B,MAAM,MAAM,GAAG,eAAe,CAAC,aAAa,CAAC,CAAA;QAC7C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,SAAS,CAAA;QAEvC,IAAI,MAAM,GAAG,KAAK,CAAA;QAClB,gCAAgC;QAChC,MAAM,oBAAoB,GAAG,EAAE,CAAA;QAC/B,MAAM,oBAAoB,GAAG,CAAC,sDAAsD,CAAC,OAAO,EAAE,EAAE;YAC9F,IAAI,CAAC,MAAM;gBAAE,aAAa,CAAC,OAAO,CAAC,CAAA;QACrC,CAAC,CAAA;QAED,KAAK,CAAC,KAAK,IAAI,EAAE;YACf,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAA;gBAE5F,IAAI,MAAM,EAAE,CAAC;oBACX,WAAW,EAAE,CAAA;gBACf,CAAC;qBAAM,CAAC;oBACN,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBACxC,CAAC;YACH,CAAC;YAED,IAAI,CAAC,MAAM,IAAI,WAAW;gBAAE,WAAW,EAAE,CAAA;QAC3C,CAAC,CAAC,EAAE,CAAA;QAEJ,OAAO,GAAG,EAAE;YACV,MAAM,GAAG,IAAI,CAAA;YAEb,KAAK,MAAM,WAAW,IAAI,oBAAoB,EAAE,CAAC;gBAC/C,WAAW,EAAE,CAAA;YACf,CAAC;YAED,6BAA6B,CAAC,aAAa,CAAC,CAAA;QAC9C,CAAC,CAAA;IACH,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC,CAAA;AACpE,CAAC","sourcesContent":["// @ts-check\n\nimport debounceFunction from \"debounce\"\nimport {useEffect, useMemo, useRef} from \"react\"\n\nimport clearPendingDebouncedCallback from \"./clear-pending-debounced-callback.js\"\nimport {modelsDependencyKey, modelsFromInput} from \"./event-hook-models.js\"\nimport useModelClassEvent from \"./use-model-class-event.js\"\n\n/** @typedef {typeof import(\"./base.js\").default} FrontendModelClass */\n/** @typedef {import(\"./base.js\").default} FrontendModelInstance */\n/** @typedef {import(\"./use-model-class-event.js\").FrontendModelCreateUpdateEventPayload} FrontendModelClassUpdateEventPayload */\n/** @typedef {{id: string, model: FrontendModelInstance}} FrontendModelInstanceUpdateEventPayload */\n/** @typedef {FrontendModelClassUpdateEventPayload | FrontendModelInstanceUpdateEventPayload} FrontendModelUpdateEventPayload */\n/** @typedef {import(\"./use-model-class-event.js\").UseModelClassEventOptions} UseUpdatedEventOptions */\n/** @typedef {(payload: FrontendModelUpdateEventPayload) => void} FrontendModelUpdateEventCallback */\n\n/**\n * @param {Record<string, import(\"./query.js\").FrontendModelTransportValue | (() => void) | undefined>} restOptions - Unknown options object.\n * @returns {void}\n */\nfunction assertNoUnknownOptions(restOptions) {\n  const unknownOptionNames = Object.keys(restOptions)\n\n  if (unknownOptionNames.length > 0) {\n    throw new Error(`Unknown options given to useUpdatedEvent: ${unknownOptionNames.join(\", \")}`)\n  }\n}\n\n/**\n * React hook for frontend-model update events. Pass a model class for class-level\n * update events, or a model / model array for instance-level update events.\n * @param {FrontendModelClass | FrontendModelInstance | FrontendModelInstance[] | null | undefined} modelClassOrModels - Model class, model, or models.\n * @param {FrontendModelUpdateEventCallback} callback - Event callback.\n * @param {UseUpdatedEventOptions} [options] - Hook options.\n * @returns {void}\n */\nexport default function useUpdatedEvent(modelClassOrModels, callback, options = {}) {\n  const {active = true, abilities, debounce = false, onConnected, preload, queryData, select, withCount, ...restOptions} = options\n  assertNoUnknownOptions(restOptions)\n\n  const classModel = typeof modelClassOrModels === \"function\" ? modelClassOrModels : null\n  const instanceModels = typeof modelClassOrModels === \"function\" ? null : modelClassOrModels\n  const projectionOptions = {abilities, preload, queryData, select, withCount}\n\n  useModelClassEvent(classModel, \"update\", (payload) => {\n    callback(/** @type {FrontendModelClassUpdateEventPayload} */ (payload))\n  }, {active: active && Boolean(classModel), debounce, onConnected, ...projectionOptions})\n  useInstanceUpdatedEvent(instanceModels, callback, {active: active && !classModel, debounce, onConnected, ...projectionOptions})\n}\n\n/**\n * @param {FrontendModelInstance | FrontendModelInstance[] | null | undefined} modelOrModels - Model or models.\n * @param {FrontendModelUpdateEventCallback} callback - Event callback.\n * @param {UseUpdatedEventOptions} options - Hook options.\n * @returns {void}\n */\nfunction useInstanceUpdatedEvent(modelOrModels, callback, options) {\n  const {active = true, abilities, debounce = false, onConnected, preload, queryData, select, withCount} = options\n  const projectionKey = JSON.stringify({abilities, preload, queryData, select, withCount})\n  const projectionOptionsRef = useRef({abilities, preload, queryData, select, withCount})\n  const callbackRef = useRef(callback)\n  const activeRef = useRef(active)\n  projectionOptionsRef.current = {abilities, preload, queryData, select, withCount}\n  callbackRef.current = callback\n  activeRef.current = active\n\n  const modelsKey = modelsDependencyKey(modelOrModels)\n  const eventCallback = useMemo(() => {\n    const wrappedCallback = (/** @type {FrontendModelInstanceUpdateEventPayload} */ payload) => {\n      if (activeRef.current) callbackRef.current(payload)\n    }\n\n    if (typeof debounce === \"number\") return debounceFunction(wrappedCallback, debounce)\n    if (debounce) return debounceFunction(wrappedCallback)\n\n    return wrappedCallback\n  }, [debounce])\n\n  useEffect(() => {\n    if (!active) return undefined\n\n    const models = modelsFromInput(modelOrModels)\n    if (models.length < 1) return undefined\n\n    let closed = false\n    /** @type {Array<() => void>} */\n    const unsubscribeCallbacks = []\n    const subscriptionCallback = (/** @type {FrontendModelInstanceUpdateEventPayload} */ payload) => {\n      if (!closed) eventCallback(payload)\n    }\n\n    void (async () => {\n      for (const model of models) {\n        const unsubscribe = await model.onUpdate(subscriptionCallback, projectionOptionsRef.current)\n\n        if (closed) {\n          unsubscribe()\n        } else {\n          unsubscribeCallbacks.push(unsubscribe)\n        }\n      }\n\n      if (!closed && onConnected) onConnected()\n    })()\n\n    return () => {\n      closed = true\n\n      for (const unsubscribe of unsubscribeCallbacks) {\n        unsubscribe()\n      }\n\n      clearPendingDebouncedCallback(eventCallback)\n    }\n  }, [active, eventCallback, modelsKey, onConnected, projectionKey])\n}\n"]}
@@ -1,3 +1,12 @@
1
+ /**
2
+ * @typedef {{action?: string, id?: string | number, record?: import("./query.js").FrontendModelTransportValue, [key: string]: import("./query.js").FrontendModelTransportValue | undefined}} FrontendModelLifecycleBroadcastBody
3
+ */
4
+ /**
5
+ * @typedef {{headers?: () => Record<string, string | string[] | undefined>, remoteAddress?: () => string | undefined}} FrontendModelWebsocketUpgradeRequest
6
+ */
7
+ /**
8
+ * @typedef {{headers: () => Record<string, string | string[] | undefined>, header: (name: string) => string | string[] | undefined, metadata: (key?: string) => Record<string, import("./query.js").FrontendModelTransportValue> | import("./query.js").FrontendModelTransportValue | undefined, path: () => string, httpMethod: () => string, remoteAddress: () => string | undefined, origin: () => string | string[] | undefined}} FrontendModelWebsocketSyntheticRequest
9
+ */
1
10
  /**
2
11
  * Per-session channel subscription for frontend-model lifecycle events.
3
12
  * Replaces the legacy `FrontendModelWebsocketChannel` (Phase 3).
@@ -15,15 +24,37 @@
15
24
  * `matches()` routes by model name.
16
25
  */
17
26
  export default class FrontendModelWebsocketChannel extends VelociousWebsocketChannel {
27
+ /** @type {import("../authorization/ability.js").default | null} */
28
+ _ability: import("../authorization/ability.js").default | null;
18
29
  /** @returns {Promise<boolean>} Whether the frontend-model subscription is authorized. */
19
30
  canSubscribe(): Promise<boolean>;
20
31
  /**
21
- * @param {Record<string, any>} broadcastParams - Params from `broadcastToChannel`.
32
+ * @param {FrontendModelLifecycleBroadcastBody} body - Broadcast body.
33
+ * @param {{eventId?: string}} [meta] - Optional event metadata.
34
+ * @returns {Promise<void>} Resolves after delivery.
35
+ */
36
+ deliverBroadcast(body: FrontendModelLifecycleBroadcastBody, meta?: {
37
+ eventId?: string;
38
+ }): Promise<void>;
39
+ /**
40
+ * @param {Record<string, import("./query.js").FrontendModelTransportValue>} broadcastParams - Params from `broadcastToChannel`.
22
41
  * @returns {boolean} Whether the broadcast matches this subscriber's model.
23
42
  */
24
- matches(broadcastParams: Record<string, any>): boolean;
43
+ matches(broadcastParams: Record<string, import("./query.js").FrontendModelTransportValue>): boolean;
25
44
  /** @returns {string | null} - Requested frontend-model name or null. */
26
45
  _modelName(): string | null;
46
+ /** @returns {boolean} - Whether this subscription requested per-event record projection. */
47
+ _hasProjectionParams(): boolean;
48
+ /**
49
+ * @param {typeof import("../frontend-model-controller.js").default} FrontendModelController - Server-side frontend-model controller class.
50
+ * @returns {import("../frontend-model-controller.js").default} - Synthetic controller used for resource serialization.
51
+ */
52
+ _frontendModelController(FrontendModelController: typeof import("../frontend-model-controller.js").default): import("../frontend-model-controller.js").default;
53
+ /**
54
+ * @param {string | number} id - Event record id.
55
+ * @returns {Promise<Record<string, import("./query.js").FrontendModelTransportValue> | null>} - Serialized projected record.
56
+ */
57
+ _projectedRecordForEventId(id: string | number): Promise<Record<string, import("./query.js").FrontendModelTransportValue> | null>;
27
58
  /**
28
59
  * Minimal Request-like stub used only for ability resolution. Avoids
29
60
  * importing `WebsocketRequest` here because its `node:querystring`
@@ -34,17 +65,28 @@ export default class FrontendModelWebsocketChannel extends VelociousWebsocketCha
34
65
  * map uses `"Cookie"` or `"cookie"`. Session metadata stays separate
35
66
  * from headers and is exposed through `metadata(...)` for ability
36
67
  * resolvers that need websocket-delivered session data.
37
- * @returns {{headers: () => Record<string, any>, header: (name: string) => any, metadata: (key?: string) => any, path: () => string, httpMethod: () => string, remoteAddress: () => string | undefined, origin: () => any}} Request-like object for ability resolution.
68
+ * @returns {FrontendModelWebsocketSyntheticRequest} Request-like object for ability resolution.
38
69
  */
39
- _syntheticRequest(): {
40
- headers: () => Record<string, any>;
41
- header: (name: string) => any;
42
- metadata: (key?: string) => any;
43
- path: () => string;
44
- httpMethod: () => string;
45
- remoteAddress: () => string | undefined;
46
- origin: () => any;
47
- };
70
+ _syntheticRequest(): FrontendModelWebsocketSyntheticRequest;
48
71
  }
72
+ export type FrontendModelLifecycleBroadcastBody = {
73
+ action?: string;
74
+ id?: string | number;
75
+ record?: import("./query.js").FrontendModelTransportValue;
76
+ [key: string]: import("./query.js").FrontendModelTransportValue | undefined;
77
+ };
78
+ export type FrontendModelWebsocketUpgradeRequest = {
79
+ headers?: () => Record<string, string | string[] | undefined>;
80
+ remoteAddress?: () => string | undefined;
81
+ };
82
+ export type FrontendModelWebsocketSyntheticRequest = {
83
+ headers: () => Record<string, string | string[] | undefined>;
84
+ header: (name: string) => string | string[] | undefined;
85
+ metadata: (key?: string) => Record<string, import("./query.js").FrontendModelTransportValue> | import("./query.js").FrontendModelTransportValue | undefined;
86
+ path: () => string;
87
+ httpMethod: () => string;
88
+ remoteAddress: () => string | undefined;
89
+ origin: () => string | string[] | undefined;
90
+ };
49
91
  import VelociousWebsocketChannel from "../http-server/websocket-channel.js";
50
92
  //# sourceMappingURL=websocket-channel.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"websocket-channel.d.ts","sourceRoot":"","sources":["../../../src/frontend-models/websocket-channel.js"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;GAeG;AACH;IACE,yFAAyF;IACzF,gBADc,OAAO,CAAC,OAAO,CAAC,CAgC7B;IAED;;;OAGG;IACH,yBAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,CAInB;IAED,wEAAwE;IACxE,cADc,MAAM,GAAG,IAAI,CAK1B;IAED;;;;;;;;;;;OAWG;IACH,qBAFa;QAAC,OAAO,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAAC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG,CAAC;QAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,GAAG,CAAC;QAAC,IAAI,EAAE,MAAM,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,MAAM,GAAG,SAAS,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,CAAA;KAAC,CAuB1N;CACF;sCAvGqC,qCAAqC"}
1
+ {"version":3,"file":"websocket-channel.d.ts","sourceRoot":"","sources":["../../../src/frontend-models/websocket-channel.js"],"names":[],"mappings":"AAMA;;GAEG;AACH;;GAEG;AACH;;GAEG;AAEH;;;;;;;;;;;;;;;GAeG;AACH;IACE,mEAAmE;IACnE,UADW,OAAO,6BAA6B,EAAE,OAAO,GAAG,IAAI,CAChD;IAEf,yFAAyF;IACzF,gBADc,OAAO,CAAC,OAAO,CAAC,CAiC7B;IAED;;;;OAIG;IACH,uBAJW,mCAAmC,SACnC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAC,GAChB,OAAO,CAAC,IAAI,CAAC,CA4BzB;IAED;;;OAGG;IACH,yBAHW,MAAM,CAAC,MAAM,EAAE,OAAO,YAAY,EAAE,2BAA2B,CAAC,GAC9D,OAAO,CAInB;IAED,wEAAwE;IACxE,cADc,MAAM,GAAG,IAAI,CAK1B;IAED,4FAA4F;IAC5F,wBADc,OAAO,CAOpB;IAED;;;OAGG;IACH,kDAHW,cAAc,iCAAiC,EAAE,OAAO,GACtD,OAAO,iCAAiC,EAAE,OAAO,CAwB7D;IAED;;;OAGG;IACH,+BAHW,MAAM,GAAG,MAAM,GACb,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,YAAY,EAAE,2BAA2B,CAAC,GAAG,IAAI,CAAC,CA4C5F;IAED;;;;;;;;;;;OAWG;IACH,qBAFa,sCAAsC,CAuBlD;CACF;kDAvOY;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,YAAY,EAAE,2BAA2B,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,YAAY,EAAE,2BAA2B,GAAG,SAAS,CAAA;CAAC;mDAG/K;IAAC,OAAO,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,MAAM,GAAG,SAAS,CAAA;CAAC;qDAGzG;IAAC,OAAO,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IAAC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;IAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,YAAY,EAAE,2BAA2B,CAAC,GAAG,OAAO,YAAY,EAAE,2BAA2B,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,MAAM,GAAG,SAAS,CAAC;IAAC,MAAM,EAAE,MAAM,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;CAAC;sCAX/X,qCAAqC"}