@kwiz/fluentui 1.0.170 → 1.0.172
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/dist/controls/loading.d.ts +1 -0
- package/dist/controls/loading.js +6 -3
- package/dist/controls/loading.js.map +1 -1
- package/dist/helpers/hooks.js +1 -1
- package/dist/helpers/hooks.js.map +1 -1
- package/dist/helpers/use-reload-tracker.d.ts +49 -6
- package/dist/helpers/use-reload-tracker.js +64 -28
- package/dist/helpers/use-reload-tracker.js.map +1 -1
- package/package.json +1 -1
package/dist/controls/loading.js
CHANGED
|
@@ -1,12 +1,15 @@
|
|
|
1
|
-
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
-
import {
|
|
1
|
+
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
+
import { Caption1 } from '@fluentui/react-components';
|
|
3
|
+
import { isNotEmptyString, LOGO_ANIM_DARK, LOGO_ANIM_LIGHT } from '@kwiz/common';
|
|
3
4
|
import { useKWIZFluentContext } from '../helpers/context-internal';
|
|
4
5
|
import { Centered } from './centered';
|
|
6
|
+
import { Horizontal } from './horizontal';
|
|
7
|
+
import { Vertical } from './vertical';
|
|
5
8
|
export const Loading = (props) => {
|
|
6
9
|
const ctx = useKWIZFluentContext();
|
|
7
10
|
const src = props.dark === true || ctx.dark
|
|
8
11
|
? LOGO_ANIM_DARK
|
|
9
12
|
: LOGO_ANIM_LIGHT;
|
|
10
|
-
return _jsx(Centered, Object.assign({}, props, { children: _jsx("img", { src: src, alt: "loading", style: { width: '15vw' } }) }));
|
|
13
|
+
return _jsx(Centered, Object.assign({}, props, { children: _jsxs(Vertical, { children: [_jsx("img", { src: src, alt: "loading", style: { width: '15vw' } }), isNotEmptyString(props.label) && _jsx(Horizontal, { hCentered: true, children: _jsx(Caption1, { children: props.label }) })] }) }));
|
|
11
14
|
};
|
|
12
15
|
//# sourceMappingURL=loading.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"loading.js","sourceRoot":"","sources":["../../src/controls/loading.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"loading.js","sourceRoot":"","sources":["../../src/controls/loading.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEjF,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAkB,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAMtC,MAAM,CAAC,MAAM,OAAO,GAA2C,CAAC,KAAK,EAAE,EAAE;IACrE,MAAM,GAAG,GAAG,oBAAoB,EAAE,CAAC;IACnC,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,KAAK,IAAI,IAAI,GAAG,CAAC,IAAI;QACvC,CAAC,CAAC,cAAc;QAChB,CAAC,CAAC,eAAe,CAAC;IAEtB,OAAO,KAAC,QAAQ,oBAAK,KAAK,cACtB,MAAC,QAAQ,eACL,cAAK,GAAG,EAAE,GAAG,EAAE,GAAG,EAAC,SAAS,EAAC,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAI,EACxD,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,KAAC,UAAU,IAAC,SAAS,kBAAC,KAAC,QAAQ,cAAE,KAAK,CAAC,KAAK,GAAY,GAAa,IAChG,IACJ,CAAA;AACf,CAAC,CAAA"}
|
package/dist/helpers/hooks.js
CHANGED
|
@@ -31,7 +31,7 @@ export function useStateEX(initialValue, options) {
|
|
|
31
31
|
let logger = new CommonLogger(`useStateWithTrack${isNullOrEmptyString(name) ? '' : ` ${name}`}`);
|
|
32
32
|
logger.i.setLevel(LoggerLevel.WARN);
|
|
33
33
|
const [value, setValueInState] = useState(initialValue);
|
|
34
|
-
const currentValue = useRef();
|
|
34
|
+
const currentValue = useRef(initialValue); //must set initial value don't rely on useEffect to do it since some dependents might try to access it on first load
|
|
35
35
|
//json clone complex/ref values so we can compare if value changed, in case caller makes chagnes on the value object directly.
|
|
36
36
|
const currentValueForChecks = useRef();
|
|
37
37
|
useEffect(() => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../src/helpers/hooks.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,SAAS,EAAE,aAAa,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACxL,OAAO,EAAoD,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACnH,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,2DAA2D;AAC3D,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AASvC,SAAS,kBAAkB,CAAC,CAAM;IAC9B,IAAI,CAAC;QACD,IAAI,CAAC,YAAY,WAAW;YACxB,OAAO,CAAC,CAAC,SAAS,CAAC;IAC3B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IACf,IAAI,CAAC;QACD,IAAI,IAAI,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;QAC5B,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA,wDAAwD;;YACnG,OAAO,IAAI,CAAC;IACrB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IACf,IAAI,CAAC;QACD,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IACf,OAAO,EAAE,CAAC;AACd,CAAC;AACD,uIAAuI;AACvI,MAAM,UAAU,UAAU,CAAY,YAAuB,EAAE,OAAmC;IAE9F,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;IACxB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;IAEhC,IAAI,MAAM,GAAG,IAAI,YAAY,CAAC,oBAAoB,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IACjG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAEpC,MAAM,CAAC,KAAK,EAAE,eAAe,CAAC,GAAG,QAAQ,CAAY,YAAY,CAAC,CAAC;IAEnE,MAAM,YAAY,GAAG,MAAM,
|
|
1
|
+
{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../src/helpers/hooks.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,SAAS,EAAE,aAAa,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACxL,OAAO,EAAoD,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACnH,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,2DAA2D;AAC3D,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AASvC,SAAS,kBAAkB,CAAC,CAAM;IAC9B,IAAI,CAAC;QACD,IAAI,CAAC,YAAY,WAAW;YACxB,OAAO,CAAC,CAAC,SAAS,CAAC;IAC3B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IACf,IAAI,CAAC;QACD,IAAI,IAAI,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;QAC5B,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA,wDAAwD;;YACnG,OAAO,IAAI,CAAC;IACrB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IACf,IAAI,CAAC;QACD,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IACf,OAAO,EAAE,CAAC;AACd,CAAC;AACD,uIAAuI;AACvI,MAAM,UAAU,UAAU,CAAY,YAAuB,EAAE,OAAmC;IAE9F,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;IACxB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;IAEhC,IAAI,MAAM,GAAG,IAAI,YAAY,CAAC,oBAAoB,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IACjG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAEpC,MAAM,CAAC,KAAK,EAAE,eAAe,CAAC,GAAG,QAAQ,CAAY,YAAY,CAAC,CAAC;IAEnE,MAAM,YAAY,GAAG,MAAM,CAAY,YAAY,CAAC,CAAC,CAAA,oHAAoH;IACzK,8HAA8H;IAC9H,MAAM,qBAAqB,GAAG,MAAM,EAAa,CAAC;IAClD,SAAS,CAAC,GAAG,EAAE;QACX,gBAAgB,CAAC,YAAY,CAAC,CAAC;IACnC,CAAC,EAAE,oBAAoB,CAAC,CAAC;IAEzB,kEAAkE;IAClE,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1C,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC;IAEpC,wFAAwF;IACxF,MAAM,YAAY,GAAG,MAAM,CAA6B,EAAE,CAAC,CAAC;IAC5D,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAEhC,SAAS,CAAC,GAAG,EAAE;QACX,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;QAEzB,OAAO,GAAG,EAAE;YACR,SAAS,CAAC,OAAO,GAAG,KAAK,CAAC;QAC9B,CAAC,CAAC;IACN,CAAC,EAAE,oBAAoB,CAAC,CAAC;IAEzB,SAAS,eAAe;QACpB,IAAI,eAAe,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;YACxC,IAAI,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YAC7C,YAAY,CAAC,OAAO,GAAG,EAAE,CAAC,CAAA,OAAO;YACjC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;QAChD,CAAC;IACL,CAAC;IAAA,CAAC;IACF,SAAS,CAAC,GAAG,EAAE;QACX,eAAe,EAAE,CAAC;IACtB,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAEZ,SAAS,iBAAiB,CAAC,QAAmB;QAC1C,IAAI,KAAK,GAAU,IAAI,CAAC;QACxB,IAAI,MAAe,CAAC;QACpB,IAAI,CAAC;YACD,IAAI,CAAC,YAAY,CAAC,QAAkB,EAAE,qBAAqB,CAAC,OAAiB,CAAC,EAAE,CAAC;gBAC7E,MAAM,GAAG,IAAI,CAAC;YAClB,CAAC;iBACI,CAAC;gBACF,MAAM,GAAG,KAAK,CAAC;YACnB,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,KAAK,GAAG,CAAC,CAAC;YACV,MAAM,GAAG,IAAI,CAAC;QAClB,CAAC;QAED,OAAO,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,mBAAmB,EAAE,GAAG,CAAC,EAAE;YAC5E,IAAI,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC9C,GAAG,CAAC,OAAO,GAAG,kBAAkB,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;gBACjE,GAAG,CAAC,OAAO,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC5C,IAAI,KAAK;oBAAE,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC,CAAC;IACP,CAAC;IAAA,CAAC;IACF,SAAS,gBAAgB,CAAC,QAAmB;QACzC,YAAY,CAAC,OAAO,GAAG,QAAQ,CAAC;QAChC,qBAAqB,CAAC,OAAO,GAAG,gBAAgB,CAAC,QAAQ,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC;YAC9E,CAAC,CAAC,QAAQ;YACV,0CAA0C;YAC1C,oFAAoF;YACpF,qEAAqE;YACrE,sEAAsE;YACtE,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAc,CAAC;IAC3C,CAAC;IAED,MAAM,QAAQ,GAAG,WAAW,CAAC,CAAC,QAAmB,EAAE,EAAE,CAAC,IAAI,OAAO,CAAY,OAAO,CAAC,EAAE;QACnF,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;YACrB,6BAA6B;YAC7B,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YACtC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACtB,CAAC;aACI,CAAC;YACF,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnC,MAAM,SAAS,GAAG,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,gBAAgB;gBACtE,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAA,kGAAkG;gBAC/H,CAAC,CAAC,IAAI,CAAC;YACX,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAC5B,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YAErD,mCAAmC;YACnC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YAE3B,WAAW;YACX,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,SAAS;gBACtC,eAAe,CAAC,QAAQ,CAAC,CAAC;iBAC1B,6EAA6E;gBAC7E,eAAe,EAAE,CAAC;QAC1B,CAAC;IACL,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;IAE1B,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;AAC3C,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,eAAe,CAAI,YAAgB,EAC/C,eAAkC,EAAE,gBAAgB,EAAE,IAAI,EAAE,IAAI,EAAE,iBAAiB,EAAE;AACrF,uFAAuF;AACvF,UAAyB;IACzB,IAAI,KAAK,GAAG,MAAM,CAAI,YAAY,CAAC,CAAC;IACpC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,UAAU,CAAI,YAAY,EAAE,YAAY,CAAC,CAAC;IACpE,sFAAsF;IACtF,SAAS,MAAM,CAAC,QAAW;QACvB,KAAK,CAAC,OAAO,GAAG,QAAQ,CAAC;QACzB,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvB,CAAC;IAAA,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACX,yBAAyB;QACzB,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;YACjC,IAAI,UAAU,CAAC,UAAU,CAAC;gBAAE,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;;gBAChD,UAAwC,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC3E,CAAC;IACL,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,OAAO;QACH,sDAAsD;QACtD,GAAG,EAAE,KAAK;QACV,+BAA+B;QAC/B,KAAK,EAAE,OAAO;QACd,0CAA0C;QAC1C,GAAG,EAAE,MAAM;KACd,CAAC;AACN,CAAC;AAED,MAAM,SAAS,GAAG,UAAU,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC,SAAS;CAC9B,CAAC,CAAC;AAEH,kFAAkF;AAClF,MAAM,UAAU,eAAe;IAC3B,MAAM,QAAQ,GAAG,SAAS,EAAE,CAAC;IAE7B,MAAM,KAAK,GAAmC;QAC1C,SAAS,EAAE,QAAQ,CAAC,SAAS;QAC7B,QAAQ,EAAE,CAAC;QACX,SAAS,EAAE,CAAC,CAAC,EAAE;YACX,IAAI,CAAC,CAAC,GAAG,KAAK,OAAO;gBAAG,CAAC,CAAC,MAAyB,CAAC,KAAK,EAAE,CAAC;QAChE,CAAC;KACJ,CAAC;IAEF,OAAO,KAAK,CAAC;AACjB,CAAC"}
|
|
@@ -1,24 +1,67 @@
|
|
|
1
1
|
import { iLoadingProps } from "../controls/loading";
|
|
2
2
|
import { iPleaseWaitProps } from "../controls/please-wait";
|
|
3
|
-
type queueType = "required" | "optional";
|
|
4
|
-
|
|
3
|
+
type queueType = "required" | "optional" | "idle";
|
|
4
|
+
type isLoadingType = {
|
|
5
|
+
type: queueType;
|
|
6
|
+
label?: string;
|
|
7
|
+
};
|
|
8
|
+
export interface iUseReloadTracker<Scope extends string = "global"> {
|
|
5
9
|
/** marker to set as dependency when you want to re-run the effect when reload was called */
|
|
6
10
|
reloadKey: {
|
|
7
11
|
[key in withGlobal<Scope>]?: number;
|
|
8
12
|
};
|
|
9
|
-
/** call to reload */
|
|
13
|
+
/** call to reload scope+global, or send global to reload all scopes */
|
|
10
14
|
reload: (scope?: Scope) => void;
|
|
11
15
|
/** state: is there pending promises in the queue */
|
|
12
|
-
isLoading:
|
|
16
|
+
isLoading: isLoadingType;
|
|
13
17
|
/** add a loading promise to the queue */
|
|
14
|
-
queue: (promise: Promise<
|
|
18
|
+
queue: <Result>(promise: () => Promise<Result>, info: {
|
|
19
|
+
label: string;
|
|
20
|
+
type?: queueType;
|
|
21
|
+
/** will use promiseOnce if provided, along with the reload key */
|
|
22
|
+
cacheKey?: string;
|
|
23
|
+
/** switch reloadKey scope for cacheKey. Global will update on any reload. You want to set this if you have a dependency on reloadKey.[scope] that is not global */
|
|
24
|
+
cacheScope?: Scope;
|
|
25
|
+
}) => Promise<Result>;
|
|
15
26
|
/** render loading animation, or track isLoading to add animation yourself */
|
|
16
27
|
reloadElement?: JSX.Element;
|
|
17
28
|
}
|
|
18
29
|
type withGlobal<t extends string> = t | "global";
|
|
19
30
|
/** a simple reload marker, can be used as a dependency, and called as a function */
|
|
20
|
-
export declare function useReloadTracker<Scope extends string =
|
|
31
|
+
export declare function useReloadTracker<Scope extends string = "global">(props?: {
|
|
21
32
|
requiredElement?: Partial<iLoadingProps> | JSX.Element;
|
|
22
33
|
optionalElement?: Partial<iPleaseWaitProps> | JSX.Element;
|
|
23
34
|
}): iUseReloadTracker<Scope>;
|
|
24
35
|
export {};
|
|
36
|
+
/** examples
|
|
37
|
+
* =~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~
|
|
38
|
+
* in your main/top control or in your context provider, call:
|
|
39
|
+
* const rt = useReloadTracker();
|
|
40
|
+
* render its content:
|
|
41
|
+
* {rt.reloadElement}
|
|
42
|
+
*
|
|
43
|
+
* load content that never changes, and cached (type:'required' will cover the page content while this is pending):
|
|
44
|
+
* useEffect(() => {
|
|
45
|
+
* queue(() => ASYNC_ACTION(), { label:'Loading XXX', cacheKey: 'ASYNC_ACTION', type: "required" })
|
|
46
|
+
* .then(result => setResult(result));
|
|
47
|
+
* }, [queue]);
|
|
48
|
+
*
|
|
49
|
+
* load content that changes based on other state, and cached:
|
|
50
|
+
* useEffect(() => {
|
|
51
|
+
* queue(() => ASYNC_ACTION(STATE1), { label:'Loading XXX', cacheKey: `ASYNC_ACTION|${STATE1}` })
|
|
52
|
+
* .then(result => setResult(result));
|
|
53
|
+
* }, [queue, STATE1]);
|
|
54
|
+
*
|
|
55
|
+
* load content that changes when you call reload anywhere:
|
|
56
|
+
* useEffect(() => {
|
|
57
|
+
* queue(() => ASYNC_ACTION(), { label:'Loading XXX', cacheKey: 'ASYNC_ACTION' })
|
|
58
|
+
* .then(result => setResult(result));
|
|
59
|
+
* }, [queue, reloadKey.global]);
|
|
60
|
+
*
|
|
61
|
+
* load content that changes when you call reload('scope1') anywhere:
|
|
62
|
+
* useEffect(() => {
|
|
63
|
+
* queue(() => ASYNC_ACTION(), { label:'Loading XXX', cacheKey: 'ASYNC_ACTION', cacheScope: 'scope1' })
|
|
64
|
+
* .then(result => setResult(result));
|
|
65
|
+
* }, [queue, reloadKey.scope1]);
|
|
66
|
+
*
|
|
67
|
+
*/
|
|
@@ -1,48 +1,84 @@
|
|
|
1
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
2
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
3
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
4
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
5
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
6
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
7
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
|
+
});
|
|
9
|
+
};
|
|
1
10
|
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
-
import { debounce, firstIndexOf, firstOrNull, isNullOrEmptyString, isNumber, jsonClone } from "@kwiz/common";
|
|
3
|
-
import { isValidElement, useCallback, useMemo,
|
|
11
|
+
import { CommonLogger, debounce, firstIndexOf, firstOrNull, isNotEmptyString, isNullOrEmptyString, isNumber, jsonClone, jsonStringify, promiseOnce } from "@kwiz/common";
|
|
12
|
+
import { isValidElement, useCallback, useMemo, useRef } from "react";
|
|
4
13
|
import { Loading } from "../controls/loading";
|
|
5
14
|
import { PleaseWait } from "../controls/please-wait";
|
|
6
15
|
import { useStateEX } from "./hooks";
|
|
16
|
+
const logger = new CommonLogger("useReloadTracker");
|
|
7
17
|
/** a simple reload marker, can be used as a dependency, and called as a function */
|
|
8
18
|
export function useReloadTracker(props) {
|
|
9
|
-
const [reloadKey, setReload] =
|
|
10
|
-
const promises = [];
|
|
11
|
-
let counter = 1;
|
|
19
|
+
const [reloadKey, setReload, reloadKeyRef] = useStateEX({ global: 1 });
|
|
20
|
+
const promises = useRef([]);
|
|
21
|
+
let counter = useRef(1);
|
|
12
22
|
const reload = useCallback(debounce((scope) => {
|
|
13
23
|
const rk = jsonClone(reloadKey);
|
|
14
|
-
|
|
15
|
-
|
|
24
|
+
if (scope === "global" || isNullOrEmptyString(scope)) {
|
|
25
|
+
//if global - notify all listeners
|
|
16
26
|
Object.keys(rk).forEach(s => {
|
|
17
27
|
rk[s] = (isNumber(rk[s]) ? rk[s] : 0) + 1;
|
|
18
28
|
});
|
|
19
|
-
|
|
29
|
+
logger.debug('Reload all scopes');
|
|
30
|
+
}
|
|
31
|
+
else {
|
|
32
|
+
//notify only listeners for my scope + global listeners
|
|
20
33
|
rk[scope] = (isNumber(rk[scope]) ? rk[scope] : 0) + 1;
|
|
34
|
+
rk.global++;
|
|
35
|
+
logger.debug(`Reload ${scope}: ${rk[scope]}, and global: ${rk.global}`);
|
|
36
|
+
}
|
|
21
37
|
setReload(rk);
|
|
22
38
|
}, 100), [reloadKey]);
|
|
23
|
-
const [isLoading, setLoading, isLoadingRef] = useStateEX(
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
39
|
+
const [isLoading, setLoading, isLoadingRef] = useStateEX({ type: "idle" }, { skipUpdateIfSame: true });
|
|
40
|
+
//this does not have dependencies, never changes, so unsafe to use state. use stateRef objects.
|
|
41
|
+
const queue = useCallback((promise, info) => __awaiter(this, void 0, void 0, function* () {
|
|
42
|
+
const type = (info === null || info === void 0 ? void 0 : info.type) || "optional";
|
|
43
|
+
if (isLoadingRef.current.type !== "required") //if its required - do not update this back to optional
|
|
44
|
+
setLoading({ type, label: info.label });
|
|
45
|
+
const myId = counter.current++;
|
|
46
|
+
promises.current.push({ id: myId, type, label: info === null || info === void 0 ? void 0 : info.label });
|
|
47
|
+
try {
|
|
48
|
+
return yield (isNotEmptyString(info.cacheKey)
|
|
49
|
+
? (() => {
|
|
50
|
+
const cache_reloadKey = isNotEmptyString(info.cacheScope) ? `${info.cacheScope}:${reloadKeyRef.current[info.cacheScope] || 0}` : `global:${reloadKeyRef.current.global}`;
|
|
51
|
+
const promiseOnceCacheKey = `${cache_reloadKey}|${info.cacheKey}`;
|
|
52
|
+
logger.log(promiseOnceCacheKey);
|
|
53
|
+
return promiseOnce(promiseOnceCacheKey, promise);
|
|
54
|
+
})()
|
|
55
|
+
: promise());
|
|
56
|
+
}
|
|
57
|
+
finally {
|
|
30
58
|
//remove this promise
|
|
31
|
-
const myIndex = firstIndexOf(promises, p => p.id === myId);
|
|
32
|
-
promises.splice(myIndex, 1);
|
|
59
|
+
const myIndex = firstIndexOf(promises.current, p => p.id === myId);
|
|
60
|
+
promises.current.splice(myIndex, 1);
|
|
33
61
|
//if no more promises - set loading to false
|
|
34
|
-
if (promises.length === 0)
|
|
35
|
-
setLoading(
|
|
62
|
+
if (promises.current.length === 0)
|
|
63
|
+
setLoading({ type: "idle" });
|
|
36
64
|
//else, if it is state required and no more required promiese - drop it to optional
|
|
37
|
-
else
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
65
|
+
else {
|
|
66
|
+
//drop the label/type to the next promise in queue, prioritize required ones.
|
|
67
|
+
const nextPromise = firstOrNull(promises.current, p_1 => p_1.type === "required") || promises[0];
|
|
68
|
+
setLoading({ type: nextPromise.type, label: nextPromise.label });
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
}), []);
|
|
72
|
+
const reloadElement = useMemo(() => {
|
|
73
|
+
logger.debug(`reloadElement: ${jsonStringify(isLoading)}`);
|
|
74
|
+
return (isLoading === null || isLoading === void 0 ? void 0 : isLoading.type) === "required"
|
|
75
|
+
? isValidElement(props === null || props === void 0 ? void 0 : props.requiredElement) ? props.requiredElement
|
|
76
|
+
: _jsx(Loading, Object.assign({ fullsize: true, label: isLoading.label }, props === null || props === void 0 ? void 0 : props.requiredElement))
|
|
77
|
+
: (isLoading === null || isLoading === void 0 ? void 0 : isLoading.type) === "optional"
|
|
78
|
+
? isValidElement(props === null || props === void 0 ? void 0 : props.optionalElement) ? props.optionalElement
|
|
79
|
+
: _jsx(PleaseWait, Object.assign({ label: isLoading.label }, props === null || props === void 0 ? void 0 : props.optionalElement))
|
|
80
|
+
: undefined;
|
|
81
|
+
}, [isLoading.type, isLoading.label]);
|
|
46
82
|
return {
|
|
47
83
|
reloadKey, reload, isLoading, queue, reloadElement
|
|
48
84
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use-reload-tracker.js","sourceRoot":"","sources":["../../src/helpers/use-reload-tracker.tsx"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"use-reload-tracker.js","sourceRoot":"","sources":["../../src/helpers/use-reload-tracker.tsx"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACzK,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AACrE,OAAO,EAAiB,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAoB,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,kBAAkB,CAAC,CAAC;AA0BpD,oFAAoF;AACpF,MAAM,UAAU,gBAAgB,CAAkC,KAGjE;IAEG,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,YAAY,CAAC,GAAG,UAAU,CAAmC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;IAEzG,MAAM,QAAQ,GAAG,MAAM,CAAoD,EAAE,CAAC,CAAC;IAC/E,IAAI,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAExB,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,KAAgB,EAAE,EAAE;QACrD,MAAM,EAAE,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QAChC,IAAI,KAAK,KAAK,QAAQ,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,kCAAkC;YAClC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;gBACxB,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACtC,CAAC;aACI,CAAC;YACF,uDAAuD;YACvD,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACtD,EAAE,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,CAAC,KAAK,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;QAC5E,CAAC;QACD,SAAS,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEtB,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,YAAY,CAAC,GAAG,UAAU,CAAgB,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC;IAEtH,+FAA+F;IAC/F,MAAM,KAAK,GAAG,WAAW,CAAoC,CAAO,OAAO,EAAE,IAAI,EAAE,EAAE;QACjF,MAAM,IAAI,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,KAAI,UAAU,CAAC;QACtC,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAC,uDAAuD;YAChG,UAAU,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAE5C,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAC/B,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,EAAE,CAAC,CAAC;QAE9D,IAAI,CAAC;YACD,OAAO,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC;gBACzC,CAAC,CAAC,CAAC,GAAG,EAAE;oBACJ,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,UAAU,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;oBACzK,MAAM,mBAAmB,GAAG,GAAG,eAAe,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClE,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;oBAChC,OAAO,WAAW,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;gBACrD,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,OAAO,EAAE,CACd,CAAC;QACN,CAAC;gBAAS,CAAC;YACP,qBAAqB;YACrB,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC;YACnE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YACpC,4CAA4C;YAC5C,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;gBAAE,UAAU,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;YAEhE,mFAAmF;iBAC9E,CAAC;gBACF,6EAA6E;gBAC7E,MAAM,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACjG,UAAU,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC;YACrE,CAAC;QACL,CAAC;IACL,CAAC,CAAA,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE;QAC/B,MAAM,CAAC,KAAK,CAAC,kBAAkB,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC3D,OAAO,CAAC,SAA2B,aAA3B,SAAS,uBAAT,SAAS,CAAoB,IAAI,MAAK,UAAU;YACpD,CAAC,CAAC,cAAc,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe;gBAC5D,CAAC,CAAC,KAAC,OAAO,kBAAC,QAAQ,QAAC,KAAK,EAAG,SAA2B,CAAC,KAAK,IAAM,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,eAAe,EAAI;YACjG,CAAC,CAAC,CAAC,SAA2B,aAA3B,SAAS,uBAAT,SAAS,CAAoB,IAAI,MAAK,UAAU;gBAC/C,CAAC,CAAC,cAAc,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe;oBAC5D,CAAC,CAAC,KAAC,UAAU,kBAAC,KAAK,EAAG,SAA2B,CAAC,KAAK,IAAM,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,eAAe,EAAI;gBAC3F,CAAC,CAAC,SAAS,CAAC;IACxB,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAEtC,OAAO;QACH,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa;KACrD,CAAC;AACN,CAAC"}
|