velocious 1.0.395 → 1.0.397
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.
- package/README.md +33 -0
- package/build/src/background-jobs/job-runner.d.ts.map +1 -1
- package/build/src/background-jobs/job-runner.js +7 -2
- package/build/src/background-jobs/json-socket.d.ts +4 -0
- package/build/src/background-jobs/json-socket.d.ts.map +1 -1
- package/build/src/background-jobs/json-socket.js +5 -1
- package/build/src/background-jobs/main.d.ts +13 -0
- package/build/src/background-jobs/main.d.ts.map +1 -1
- package/build/src/background-jobs/main.js +47 -5
- package/build/src/background-jobs/store.d.ts +5 -1
- package/build/src/background-jobs/store.d.ts.map +1 -1
- package/build/src/background-jobs/store.js +10 -4
- package/build/src/background-jobs/types.d.ts +3 -1
- package/build/src/background-jobs/types.d.ts.map +1 -1
- package/build/src/background-jobs/types.js +2 -2
- package/build/src/background-jobs/worker.d.ts +16 -9
- package/build/src/background-jobs/worker.d.ts.map +1 -1
- package/build/src/background-jobs/worker.js +53 -15
- package/build/src/configuration-types.d.ts +24 -0
- package/build/src/configuration-types.d.ts.map +1 -1
- package/build/src/configuration-types.js +9 -1
- package/build/src/configuration.d.ts.map +1 -1
- package/build/src/configuration.js +7 -2
- package/build/src/database/pool/async-tracked-multi-connection.d.ts +28 -0
- package/build/src/database/pool/async-tracked-multi-connection.d.ts.map +1 -1
- package/build/src/database/pool/async-tracked-multi-connection.js +129 -10
- package/build/src/database/record/instance-relationships/has-many.d.ts +2 -0
- package/build/src/database/record/instance-relationships/has-many.d.ts.map +1 -1
- package/build/src/database/record/instance-relationships/has-many.js +13 -1
- package/build/src/frontend-models/clear-pending-debounced-callback.d.ts +6 -0
- package/build/src/frontend-models/clear-pending-debounced-callback.d.ts.map +1 -0
- package/build/src/frontend-models/clear-pending-debounced-callback.js +12 -0
- package/build/src/frontend-models/event-hook-models.d.ts +12 -0
- package/build/src/frontend-models/event-hook-models.d.ts.map +1 -0
- package/build/src/frontend-models/event-hook-models.js +37 -0
- package/build/src/frontend-models/use-created-event.d.ts +17 -0
- package/build/src/frontend-models/use-created-event.d.ts.map +1 -0
- package/build/src/frontend-models/use-created-event.js +19 -0
- package/build/src/frontend-models/use-destroyed-event.d.ts +19 -0
- package/build/src/frontend-models/use-destroyed-event.d.ts.map +1 -0
- package/build/src/frontend-models/use-destroyed-event.js +99 -0
- package/build/src/frontend-models/use-model-class-event.d.ts +27 -0
- package/build/src/frontend-models/use-model-class-event.d.ts.map +1 -0
- package/build/src/frontend-models/use-model-class-event.js +112 -0
- package/build/src/frontend-models/use-updated-event.d.ts +20 -0
- package/build/src/frontend-models/use-updated-event.d.ts.map +1 -0
- package/build/src/frontend-models/use-updated-event.js +101 -0
- package/build/src/testing/browser-frontend-model-event-hook-scenarios.d.ts +35 -0
- package/build/src/testing/browser-frontend-model-event-hook-scenarios.d.ts.map +1 -0
- package/build/src/testing/browser-frontend-model-event-hook-scenarios.js +259 -0
- package/build/src/testing/browser-test-app.js +3 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +10 -1
|
@@ -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,CAWhB;iCArCa,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,99 @@
|
|
|
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, unknown>} 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, debounce = false, onConnected, ...restOptions } = options;
|
|
34
|
+
assertNoUnknownOptions(restOptions);
|
|
35
|
+
const classModel = typeof modelClassOrModels === "function" ? modelClassOrModels : null;
|
|
36
|
+
const instanceModels = typeof modelClassOrModels === "function" ? null : modelClassOrModels;
|
|
37
|
+
useModelClassEvent(classModel, "destroy", callback, { active: active && Boolean(classModel), debounce, onConnected });
|
|
38
|
+
useInstanceDestroyedEvent(instanceModels, callback, { active: active && !classModel, debounce, onConnected });
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* @param {FrontendModelInstance | FrontendModelInstance[] | null | undefined} modelOrModels - Model or models.
|
|
42
|
+
* @param {FrontendModelDestroyEventCallback} callback - Event callback.
|
|
43
|
+
* @param {UseDestroyedEventOptions} options - Hook options.
|
|
44
|
+
* @returns {void}
|
|
45
|
+
*/
|
|
46
|
+
function useInstanceDestroyedEvent(modelOrModels, callback, options) {
|
|
47
|
+
const { active = true, debounce = false, onConnected } = options;
|
|
48
|
+
const callbackRef = useRef(callback);
|
|
49
|
+
const activeRef = useRef(active);
|
|
50
|
+
callbackRef.current = callback;
|
|
51
|
+
activeRef.current = active;
|
|
52
|
+
const modelsKey = modelsDependencyKey(modelOrModels);
|
|
53
|
+
const eventCallback = useMemo(() => {
|
|
54
|
+
const wrappedCallback = (/** @type {FrontendModelInstanceDestroyEventPayload} */ payload) => {
|
|
55
|
+
if (activeRef.current)
|
|
56
|
+
callbackRef.current(payload);
|
|
57
|
+
};
|
|
58
|
+
if (typeof debounce === "number")
|
|
59
|
+
return debounceFunction(wrappedCallback, debounce);
|
|
60
|
+
if (debounce)
|
|
61
|
+
return debounceFunction(wrappedCallback);
|
|
62
|
+
return wrappedCallback;
|
|
63
|
+
}, [debounce]);
|
|
64
|
+
useEffect(() => {
|
|
65
|
+
if (!active)
|
|
66
|
+
return undefined;
|
|
67
|
+
const models = modelsFromInput(modelOrModels);
|
|
68
|
+
if (models.length < 1)
|
|
69
|
+
return undefined;
|
|
70
|
+
let closed = false;
|
|
71
|
+
/** @type {Array<() => void>} */
|
|
72
|
+
const unsubscribeCallbacks = [];
|
|
73
|
+
const subscriptionCallback = (/** @type {FrontendModelInstanceDestroyEventPayload} */ payload) => {
|
|
74
|
+
if (!closed)
|
|
75
|
+
eventCallback(payload);
|
|
76
|
+
};
|
|
77
|
+
void (async () => {
|
|
78
|
+
for (const model of models) {
|
|
79
|
+
const unsubscribe = await model.onDestroy(subscriptionCallback);
|
|
80
|
+
if (closed) {
|
|
81
|
+
unsubscribe();
|
|
82
|
+
}
|
|
83
|
+
else {
|
|
84
|
+
unsubscribeCallbacks.push(unsubscribe);
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
if (!closed && onConnected)
|
|
88
|
+
onConnected();
|
|
89
|
+
})();
|
|
90
|
+
return () => {
|
|
91
|
+
closed = true;
|
|
92
|
+
for (const unsubscribe of unsubscribeCallbacks) {
|
|
93
|
+
unsubscribe();
|
|
94
|
+
}
|
|
95
|
+
clearPendingDebouncedCallback(eventCallback);
|
|
96
|
+
};
|
|
97
|
+
}, [active, eventCallback, modelsKey, onConnected]);
|
|
98
|
+
}
|
|
99
|
+
//# 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,QAAQ,GAAG,KAAK,EAAE,WAAW,EAAE,GAAG,WAAW,EAAC,GAAG,OAAO,CAAA;IAC9E,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;IAE3F,kBAAkB,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAC,MAAM,EAAE,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAC,CAAC,CAAA;IACnH,yBAAyB,CAAC,cAAc,EAAE,QAAQ,EAAE,EAAC,MAAM,EAAE,MAAM,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAC,CAAC,CAAA;AAC7G,CAAC;AAED;;;;;GAKG;AACH,SAAS,yBAAyB,CAAC,aAAa,EAAE,QAAQ,EAAE,OAAO;IACjE,MAAM,EAAC,MAAM,GAAG,IAAI,EAAE,QAAQ,GAAG,KAAK,EAAE,WAAW,EAAC,GAAG,OAAO,CAAA;IAC9D,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IACpC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;IAChC,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,CAAC,CAAA;gBAE/D,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,CAAC,CAAC,CAAA;AACrD,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, unknown>} 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, debounce = false, onConnected, ...restOptions} = options\n  assertNoUnknownOptions(restOptions)\n\n  const classModel = typeof modelClassOrModels === \"function\" ? modelClassOrModels : null\n  const instanceModels = typeof modelClassOrModels === \"function\" ? null : modelClassOrModels\n\n  useModelClassEvent(classModel, \"destroy\", callback, {active: active && Boolean(classModel), debounce, onConnected})\n  useInstanceDestroyedEvent(instanceModels, callback, {active: active && !classModel, debounce, onConnected})\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, debounce = false, onConnected} = options\n  const callbackRef = useRef(callback)\n  const activeRef = useRef(active)\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)\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])\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
|
+
};
|
|
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":"AA0DA;;;;;;;GAOG;AACH,uDANW,kBAAkB,GAAG,IAAI,GAAG,SAAS,iBACrC,2BAA2B,GAAG,2BAA2B,EAAE,YAC3D,+BAA+B,YAC/B,yBAAyB,GACvB,IAAI,CA0DhB;iCAnHa,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"}
|
|
@@ -0,0 +1,112 @@
|
|
|
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}} 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, unknown>} 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
|
+
* @returns {Promise<() => void>} - Unsubscribe callback.
|
|
42
|
+
*/
|
|
43
|
+
async function subscribeToModelClassEvent(modelClass, eventName, callback) {
|
|
44
|
+
if (eventName === "create")
|
|
45
|
+
return await modelClass.onCreate(callback);
|
|
46
|
+
if (eventName === "update")
|
|
47
|
+
return await modelClass.onUpdate(callback);
|
|
48
|
+
if (eventName === "destroy")
|
|
49
|
+
return await modelClass.onDestroy(callback);
|
|
50
|
+
throw new Error(`Unsupported frontend model class event: ${eventName}`);
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* React hook for frontend-model class lifecycle events.
|
|
54
|
+
* @param {FrontendModelClass | null | undefined} modelClass - Frontend model class.
|
|
55
|
+
* @param {FrontendModelClassEventName | FrontendModelClassEventName[]} eventOrEvents - Event name or names.
|
|
56
|
+
* @param {FrontendModelClassEventCallback} callback - Event callback.
|
|
57
|
+
* @param {UseModelClassEventOptions} [options] - Hook options.
|
|
58
|
+
* @returns {void}
|
|
59
|
+
*/
|
|
60
|
+
export default function useModelClassEvent(modelClass, eventOrEvents, callback, options = {}) {
|
|
61
|
+
const { active = true, debounce = false, onConnected, ...restOptions } = options;
|
|
62
|
+
assertNoUnknownOptions(restOptions);
|
|
63
|
+
const callbackRef = useRef(callback);
|
|
64
|
+
const activeRef = useRef(active);
|
|
65
|
+
callbackRef.current = callback;
|
|
66
|
+
activeRef.current = active;
|
|
67
|
+
const eventNames = normalizeEventNames(eventOrEvents);
|
|
68
|
+
const eventsKey = eventNamesDependencyKey(eventNames);
|
|
69
|
+
const eventCallback = useMemo(() => {
|
|
70
|
+
const wrappedCallback = (/** @type {FrontendModelClassEventPayload} */ payload) => {
|
|
71
|
+
if (activeRef.current)
|
|
72
|
+
callbackRef.current(payload);
|
|
73
|
+
};
|
|
74
|
+
if (typeof debounce === "number")
|
|
75
|
+
return debounceFunction(wrappedCallback, debounce);
|
|
76
|
+
if (debounce)
|
|
77
|
+
return debounceFunction(wrappedCallback);
|
|
78
|
+
return wrappedCallback;
|
|
79
|
+
}, [debounce]);
|
|
80
|
+
useEffect(() => {
|
|
81
|
+
if (!active || !modelClass)
|
|
82
|
+
return undefined;
|
|
83
|
+
let closed = false;
|
|
84
|
+
/** @type {Array<() => void>} */
|
|
85
|
+
const unsubscribeCallbacks = [];
|
|
86
|
+
const subscriptionCallback = (/** @type {FrontendModelClassEventPayload} */ payload) => {
|
|
87
|
+
if (!closed)
|
|
88
|
+
eventCallback(payload);
|
|
89
|
+
};
|
|
90
|
+
void (async () => {
|
|
91
|
+
for (const eventName of eventNames) {
|
|
92
|
+
const unsubscribe = await subscribeToModelClassEvent(modelClass, eventName, subscriptionCallback);
|
|
93
|
+
if (closed) {
|
|
94
|
+
unsubscribe();
|
|
95
|
+
}
|
|
96
|
+
else {
|
|
97
|
+
unsubscribeCallbacks.push(unsubscribe);
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
if (!closed && onConnected)
|
|
101
|
+
onConnected();
|
|
102
|
+
})();
|
|
103
|
+
return () => {
|
|
104
|
+
closed = true;
|
|
105
|
+
for (const unsubscribe of unsubscribeCallbacks) {
|
|
106
|
+
unsubscribe();
|
|
107
|
+
}
|
|
108
|
+
clearPendingDebouncedCallback(eventCallback);
|
|
109
|
+
};
|
|
110
|
+
}, [active, eventsKey, eventCallback, modelClass, onConnected]);
|
|
111
|
+
}
|
|
112
|
+
//# 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,qHAAqH;AAErH;;;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;;;;;GAKG;AACH,KAAK,UAAU,0BAA0B,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ;IACvE,IAAI,SAAS,KAAK,QAAQ;QAAE,OAAO,MAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACtE,IAAI,SAAS,KAAK,QAAQ;QAAE,OAAO,MAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACtE,IAAI,SAAS,KAAK,SAAS;QAAE,OAAO,MAAM,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;IAExE,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,QAAQ,GAAG,KAAK,EAAE,WAAW,EAAE,GAAG,WAAW,EAAC,GAAG,OAAO,CAAA;IAC9E,sBAAsB,CAAC,WAAW,CAAC,CAAA;IAEnC,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IACpC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;IAChC,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,CAAC,CAAA;gBAEjG,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,CAAC,CAAC,CAAA;AACjE,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}} 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, unknown>} 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 * @returns {Promise<() => void>} - Unsubscribe callback.\n */\nasync function subscribeToModelClassEvent(modelClass, eventName, callback) {\n  if (eventName === \"create\") return await modelClass.onCreate(callback)\n  if (eventName === \"update\") return await modelClass.onUpdate(callback)\n  if (eventName === \"destroy\") return await modelClass.onDestroy(callback)\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, debounce = false, onConnected, ...restOptions} = options\n  assertNoUnknownOptions(restOptions)\n\n  const callbackRef = useRef(callback)\n  const activeRef = useRef(active)\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)\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])\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,CAahB;iCAvCa,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,101 @@
|
|
|
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, unknown>} 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, debounce = false, onConnected, ...restOptions } = options;
|
|
34
|
+
assertNoUnknownOptions(restOptions);
|
|
35
|
+
const classModel = typeof modelClassOrModels === "function" ? modelClassOrModels : null;
|
|
36
|
+
const instanceModels = typeof modelClassOrModels === "function" ? null : modelClassOrModels;
|
|
37
|
+
useModelClassEvent(classModel, "update", (payload) => {
|
|
38
|
+
callback(/** @type {FrontendModelClassUpdateEventPayload} */ (payload));
|
|
39
|
+
}, { active: active && Boolean(classModel), debounce, onConnected });
|
|
40
|
+
useInstanceUpdatedEvent(instanceModels, callback, { active: active && !classModel, debounce, onConnected });
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* @param {FrontendModelInstance | FrontendModelInstance[] | null | undefined} modelOrModels - Model or models.
|
|
44
|
+
* @param {FrontendModelUpdateEventCallback} callback - Event callback.
|
|
45
|
+
* @param {UseUpdatedEventOptions} options - Hook options.
|
|
46
|
+
* @returns {void}
|
|
47
|
+
*/
|
|
48
|
+
function useInstanceUpdatedEvent(modelOrModels, callback, options) {
|
|
49
|
+
const { active = true, debounce = false, onConnected } = options;
|
|
50
|
+
const callbackRef = useRef(callback);
|
|
51
|
+
const activeRef = useRef(active);
|
|
52
|
+
callbackRef.current = callback;
|
|
53
|
+
activeRef.current = active;
|
|
54
|
+
const modelsKey = modelsDependencyKey(modelOrModels);
|
|
55
|
+
const eventCallback = useMemo(() => {
|
|
56
|
+
const wrappedCallback = (/** @type {FrontendModelInstanceUpdateEventPayload} */ payload) => {
|
|
57
|
+
if (activeRef.current)
|
|
58
|
+
callbackRef.current(payload);
|
|
59
|
+
};
|
|
60
|
+
if (typeof debounce === "number")
|
|
61
|
+
return debounceFunction(wrappedCallback, debounce);
|
|
62
|
+
if (debounce)
|
|
63
|
+
return debounceFunction(wrappedCallback);
|
|
64
|
+
return wrappedCallback;
|
|
65
|
+
}, [debounce]);
|
|
66
|
+
useEffect(() => {
|
|
67
|
+
if (!active)
|
|
68
|
+
return undefined;
|
|
69
|
+
const models = modelsFromInput(modelOrModels);
|
|
70
|
+
if (models.length < 1)
|
|
71
|
+
return undefined;
|
|
72
|
+
let closed = false;
|
|
73
|
+
/** @type {Array<() => void>} */
|
|
74
|
+
const unsubscribeCallbacks = [];
|
|
75
|
+
const subscriptionCallback = (/** @type {FrontendModelInstanceUpdateEventPayload} */ payload) => {
|
|
76
|
+
if (!closed)
|
|
77
|
+
eventCallback(payload);
|
|
78
|
+
};
|
|
79
|
+
void (async () => {
|
|
80
|
+
for (const model of models) {
|
|
81
|
+
const unsubscribe = await model.onUpdate(subscriptionCallback);
|
|
82
|
+
if (closed) {
|
|
83
|
+
unsubscribe();
|
|
84
|
+
}
|
|
85
|
+
else {
|
|
86
|
+
unsubscribeCallbacks.push(unsubscribe);
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
if (!closed && onConnected)
|
|
90
|
+
onConnected();
|
|
91
|
+
})();
|
|
92
|
+
return () => {
|
|
93
|
+
closed = true;
|
|
94
|
+
for (const unsubscribe of unsubscribeCallbacks) {
|
|
95
|
+
unsubscribe();
|
|
96
|
+
}
|
|
97
|
+
clearPendingDebouncedCallback(eventCallback);
|
|
98
|
+
};
|
|
99
|
+
}, [active, eventCallback, modelsKey, onConnected]);
|
|
100
|
+
}
|
|
101
|
+
//# 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,QAAQ,GAAG,KAAK,EAAE,WAAW,EAAE,GAAG,WAAW,EAAC,GAAG,OAAO,CAAA;IAC9E,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;IAE3F,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,EAAC,CAAC,CAAA;IAClE,uBAAuB,CAAC,cAAc,EAAE,QAAQ,EAAE,EAAC,MAAM,EAAE,MAAM,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAC,CAAC,CAAA;AAC3G,CAAC;AAED;;;;;GAKG;AACH,SAAS,uBAAuB,CAAC,aAAa,EAAE,QAAQ,EAAE,OAAO;IAC/D,MAAM,EAAC,MAAM,GAAG,IAAI,EAAE,QAAQ,GAAG,KAAK,EAAE,WAAW,EAAC,GAAG,OAAO,CAAA;IAC9D,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IACpC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;IAChC,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,CAAC,CAAA;gBAE9D,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,CAAC,CAAC,CAAA;AACrD,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, unknown>} 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, debounce = false, onConnected, ...restOptions} = options\n  assertNoUnknownOptions(restOptions)\n\n  const classModel = typeof modelClassOrModels === \"function\" ? modelClassOrModels : null\n  const instanceModels = typeof modelClassOrModels === \"function\" ? null : modelClassOrModels\n\n  useModelClassEvent(classModel, \"update\", (payload) => {\n    callback(/** @type {FrontendModelClassUpdateEventPayload} */ (payload))\n  }, {active: active && Boolean(classModel), debounce, onConnected})\n  useInstanceUpdatedEvent(instanceModels, callback, {active: active && !classModel, debounce, onConnected})\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, debounce = false, onConnected} = options\n  const callbackRef = useRef(callback)\n  const activeRef = useRef(active)\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)\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])\n}\n"]}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @param {keyof typeof scenarios} scenarioName - Scenario name.
|
|
3
|
+
* @returns {Promise<Record<string, number>>} - Scenario result.
|
|
4
|
+
*/
|
|
5
|
+
export default function runFrontendModelEventHookScenario(scenarioName: keyof typeof scenarios): Promise<Record<string, number>>;
|
|
6
|
+
export type FakeSubscriptions = {
|
|
7
|
+
/**
|
|
8
|
+
* - Create callbacks.
|
|
9
|
+
*/
|
|
10
|
+
create: Set<(payload: unknown) => void>;
|
|
11
|
+
/**
|
|
12
|
+
* - Destroy callbacks.
|
|
13
|
+
*/
|
|
14
|
+
destroy: Set<(payload: unknown) => void>;
|
|
15
|
+
/**
|
|
16
|
+
* - Update callbacks.
|
|
17
|
+
*/
|
|
18
|
+
update: Set<(payload: unknown) => void>;
|
|
19
|
+
};
|
|
20
|
+
declare namespace scenarios {
|
|
21
|
+
export { classLifecycleScenario as classLifecycle };
|
|
22
|
+
export { debounceUnmountScenario as debounceUnmount };
|
|
23
|
+
export { instanceLifecycleScenario as instanceLifecycle };
|
|
24
|
+
export { resubscribeInstanceScenario as resubscribeInstance };
|
|
25
|
+
}
|
|
26
|
+
/** @returns {Promise<Record<string, number>>} - Scenario result. */
|
|
27
|
+
declare function classLifecycleScenario(): Promise<Record<string, number>>;
|
|
28
|
+
/** @returns {Promise<Record<string, number>>} - Scenario result. */
|
|
29
|
+
declare function debounceUnmountScenario(): Promise<Record<string, number>>;
|
|
30
|
+
/** @returns {Promise<Record<string, number>>} - Scenario result. */
|
|
31
|
+
declare function instanceLifecycleScenario(): Promise<Record<string, number>>;
|
|
32
|
+
/** @returns {Promise<Record<string, number>>} - Scenario result. */
|
|
33
|
+
declare function resubscribeInstanceScenario(): Promise<Record<string, number>>;
|
|
34
|
+
export {};
|
|
35
|
+
//# sourceMappingURL=browser-frontend-model-event-hook-scenarios.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"browser-frontend-model-event-hook-scenarios.d.ts","sourceRoot":"","sources":["../../../src/testing/browser-frontend-model-event-hook-scenarios.js"],"names":[],"mappings":"AAiTA;;;GAGG;AACH,wEAHW,MAAM,OAAO,SAAS,GACpB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAQ3C;;;;;YA/Sa,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;;;;aAC/B,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;;;;YAC/B,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;;;;;;;;AAqH7C,oEAAoE;AACpE,2CADc,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAyC5C;AA6CD,oEAAoE;AACpE,4CADc,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CA2B5C;AAtED,oEAAoE;AACpE,8CADc,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAyC5C;AA+BD,oEAAoE;AACpE,gDADc,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAkD5C"}
|