@isograph/react-disposable-state 0.4.3 → 0.5.1

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 (69) hide show
  1. package/.turbo/turbo-compile-libs.log +10 -3
  2. package/dist/CacheItem.d.mts +63 -0
  3. package/dist/CacheItem.d.mts.map +1 -0
  4. package/dist/CacheItem.d.ts +33 -29
  5. package/dist/CacheItem.d.ts.map +1 -1
  6. package/dist/CacheItem.js +191 -266
  7. package/dist/CacheItem.mjs +193 -0
  8. package/dist/CacheItem.mjs.map +1 -0
  9. package/dist/ParentCache.d.mts +45 -0
  10. package/dist/ParentCache.d.mts.map +1 -0
  11. package/dist/ParentCache.d.ts +27 -22
  12. package/dist/ParentCache.d.ts.map +1 -1
  13. package/dist/ParentCache.js +69 -85
  14. package/dist/ParentCache.mjs +73 -0
  15. package/dist/ParentCache.mjs.map +1 -0
  16. package/dist/_virtual/rolldown_runtime.js +25 -0
  17. package/dist/index.d.mts +9 -0
  18. package/dist/index.d.ts +9 -9
  19. package/dist/index.js +24 -24
  20. package/dist/index.mjs +11 -0
  21. package/dist/useCachedResponsivePrecommitValue.d.mts +43 -0
  22. package/dist/useCachedResponsivePrecommitValue.d.mts.map +1 -0
  23. package/dist/useCachedResponsivePrecommitValue.d.ts +9 -4
  24. package/dist/useCachedResponsivePrecommitValue.d.ts.map +1 -1
  25. package/dist/useCachedResponsivePrecommitValue.js +55 -90
  26. package/dist/useCachedResponsivePrecommitValue.mjs +57 -0
  27. package/dist/useCachedResponsivePrecommitValue.mjs.map +1 -0
  28. package/dist/useDisposableState.d.mts +13 -0
  29. package/dist/useDisposableState.d.mts.map +1 -0
  30. package/dist/useDisposableState.d.ts +10 -7
  31. package/dist/useDisposableState.d.ts.map +1 -1
  32. package/dist/useDisposableState.js +36 -69
  33. package/dist/useDisposableState.mjs +37 -0
  34. package/dist/useDisposableState.mjs.map +1 -0
  35. package/dist/useHasCommittedRef.d.mts +11 -0
  36. package/dist/useHasCommittedRef.d.mts.map +1 -0
  37. package/dist/useHasCommittedRef.d.ts +7 -2
  38. package/dist/useHasCommittedRef.d.ts.map +1 -1
  39. package/dist/useHasCommittedRef.js +15 -11
  40. package/dist/useHasCommittedRef.mjs +17 -0
  41. package/dist/useHasCommittedRef.mjs.map +1 -0
  42. package/dist/useLazyDisposableState.d.mts +20 -0
  43. package/dist/useLazyDisposableState.d.mts.map +1 -0
  44. package/dist/useLazyDisposableState.d.ts +9 -4
  45. package/dist/useLazyDisposableState.d.ts.map +1 -1
  46. package/dist/useLazyDisposableState.js +32 -39
  47. package/dist/useLazyDisposableState.mjs +34 -0
  48. package/dist/useLazyDisposableState.mjs.map +1 -0
  49. package/dist/useUpdatableDisposableState.d.mts +43 -0
  50. package/dist/useUpdatableDisposableState.d.mts.map +1 -0
  51. package/dist/useUpdatableDisposableState.d.ts +10 -7
  52. package/dist/useUpdatableDisposableState.d.ts.map +1 -1
  53. package/dist/useUpdatableDisposableState.js +73 -89
  54. package/dist/useUpdatableDisposableState.mjs +74 -0
  55. package/dist/useUpdatableDisposableState.mjs.map +1 -0
  56. package/package.json +24 -17
  57. package/src/CacheItem.test.ts +4 -7
  58. package/src/CacheItem.ts +16 -11
  59. package/src/ParentCache.test.ts +5 -5
  60. package/src/ParentCache.ts +5 -4
  61. package/src/useCachedResponsivePrecommitValue.test.tsx +15 -14
  62. package/src/useCachedResponsivePrecommitValue.ts +4 -4
  63. package/src/useDisposableState.ts +21 -16
  64. package/src/useHasCommittedRef.ts +1 -1
  65. package/src/useLazyDisposableState.test.tsx +2 -2
  66. package/src/useLazyDisposableState.ts +1 -1
  67. package/src/useUpdatableDisposableState.test.tsx +19 -5
  68. package/src/useUpdatableDisposableState.ts +1 -1
  69. package/dist/index.d.ts.map +0 -1
@@ -1,5 +1,12 @@
1
- ../.. |  WARN  Unsupported engine: wanted: {"node":"22.9.0"} (current: {"node":"v22.20.0","pnpm":"10.15.0"})
1
+ ../.. |  WARN  Unsupported engine: wanted: {"node":"22.9.0"} (current: {"node":"v22.21.1","pnpm":"10.15.0"})
2
2
 
3
- > @isograph/react-disposable-state@0.4.3 compile-libs /home/runner/work/isograph/isograph/libs/isograph-react-disposable-state
4
- > rimraf dist && tsc -p tsconfig.pkg.json
3
+ > @isograph/react-disposable-state@0.5.1 compile-libs /home/runner/work/isograph/isograph/libs/isograph-react-disposable-state
4
+ > tsdown
5
5
 
6
+ ℹ tsdown v0.15.10 powered by rolldown v1.0.0-beta.44
7
+ ℹ Using tsdown config: /home/runner/work/isograph/isograph/tsdown.config.ts
8
+ (node:2983) [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of file:///home/runner/work/isograph/isograph/tsdown.config.ts is not specified and it doesn't parse as CommonJS.
9
+ Reparsing as ES module because module syntax was detected. This incurs a performance overhead.
10
+ To eliminate this warning, add "type": "module" to /home/runner/work/isograph/isograph/package.json.
11
+ (Use `node --trace-warnings ...` to show where the warning was created)
12
+ ℹ Build start
@@ -0,0 +1,63 @@
1
+ import { CleanupFn, Factory, ItemCleanupPair } from "@isograph/disposable-types";
2
+
3
+ //#region src/CacheItem.d.ts
4
+ type NotInParentCacheAndDisposed = {
5
+ kind: 'NotInParentCacheAndDisposed';
6
+ };
7
+ type NotInParentCacheAndNotDisposed<T> = {
8
+ kind: 'NotInParentCacheAndNotDisposed';
9
+ value: T;
10
+ disposeValue: () => void;
11
+ permanentRetainCount: number;
12
+ };
13
+ type InParentCacheAndNotDisposed<T> = {
14
+ kind: 'InParentCacheAndNotDisposed';
15
+ value: T;
16
+ disposeValue: () => void;
17
+ removeFromParentCache: () => void;
18
+ temporaryRetainCount: number;
19
+ permanentRetainCount: number;
20
+ };
21
+ type CacheItemState<T> = InParentCacheAndNotDisposed<T> | NotInParentCacheAndNotDisposed<T> | NotInParentCacheAndDisposed;
22
+ type CacheItemOptions = {
23
+ temporaryRetainTime: number;
24
+ };
25
+ /**
26
+ * CacheItem:
27
+ *
28
+ * Terminology:
29
+ * - TRC = Temporary Retain Count
30
+ * - PRC = Permanent Retain Count
31
+ *
32
+ * A CacheItem<T> can be in three states:
33
+ * In parent cache? | Item disposed? | TRC | PRC | Name
34
+ * -----------------+----------------+-----+-----+-------------------------------
35
+ * In parent cache | Not disposed | >0 | >=0 | InParentCacheAndNotDisposed
36
+ * Removed | Not disposed | 0 | >0 | NotInParentCacheAndNotDisposed
37
+ * Removed | Disposed | 0 | 0 | NotInParentCacheAndNotDisposed
38
+ *
39
+ * A cache item can only move down rows. As in, if its in the parent cache,
40
+ * it can be removed. It can never be replaced in the parent cache. (If a
41
+ * parent cache becomes full again, it will contain a new CacheItem.) The
42
+ * contained item can be disposed, but never un-disposed.
43
+ *
44
+ * So, the valid transitions are:
45
+ * - InParentCacheAndNotDisposed => NotInParentCacheAndNotDisposed
46
+ * - InParentCacheAndNotDisposed => NotInParentCacheAndDisposed
47
+ * - NotInParentCacheAndNotDisposed => NotInParentCacheAndDisposed
48
+ */
49
+ declare class CacheItem<T> {
50
+ private __state;
51
+ private __options;
52
+ constructor(factory: Factory<T>, removeFromParentCache: CleanupFn, options: CacheItemOptions | void);
53
+ getValue(): T;
54
+ permanentRetainIfNotDisposed(disposeOfTemporaryRetain: CleanupFn): ItemCleanupPair<T> | null;
55
+ temporaryRetain(): CleanupFn;
56
+ permanentRetain(): CleanupFn;
57
+ private __maybeExitInParentCacheAndNotDisposedState;
58
+ private __maybeExitNotInParentCacheAndNotDisposedState;
59
+ }
60
+ declare function createTemporarilyRetainedCacheItem<T>(factory: Factory<T>, removeFromParentCache: CleanupFn, options: CacheItemOptions | void): [CacheItem<T>, CleanupFn];
61
+ //#endregion
62
+ export { CacheItem, CacheItemOptions, CacheItemState, InParentCacheAndNotDisposed, NotInParentCacheAndDisposed, NotInParentCacheAndNotDisposed, createTemporarilyRetainedCacheItem };
63
+ //# sourceMappingURL=CacheItem.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CacheItem.d.mts","names":[],"sources":["../src/CacheItem.ts"],"sourcesContent":[],"mappings":";;;KAQY,2BAAA;;AAAZ,CAAA;AAGY,KAAA,8BAA8B,CAAA,CAAA,CAAA,GAAA;EAQ9B,IAAA,EAAA,gCAA2B;EAa3B,KAAA,EAnBH,CAmBG;EACoB,YAAA,EAAA,GAAA,GAAA,IAAA;EAA5B,oBAAA,EAAA,MAAA;CAC+B;AAA/B,KAfQ,2BAeR,CAAA,CAAA,CAAA,GAAA;EACA,IAAA,EAAA,6BAAA;EAA2B,KAAA,EAdtB,CAcsB;EAEnB,YAAA,EAAA,GAAA,GAAgB,IAAA;EA+Bf,qBAAS,EAAA,GAAA,GAAA,IAAA;EAUD,oBAAA,EAAA,MAAA;EAAR,oBAAA,EAAA,MAAA;CACc;AACd,KAhDD,cAgDC,CAAA,CAAA,CAAA,GA/CT,2BA+CS,CA/CmB,CA+CnB,CAAA,GA9CT,8BA8CS,CA9CsB,CA8CtB,CAAA,GA7CT,2BA6CS;AAgBC,KA3DF,gBAAA,GA2DE;EAkBgB,mBAAA,EAAA,MAAA;CACT;;;;;AAyPrB;;;;;;;;;;;;;;;;;;;;cAxSa;;;uBAUA,QAAQ,2BACM,oBACd;cAgBC;yDAkBgB,YACzB,gBAAgB;qBA+EA;qBAqEA;;;;iBAqGL,+CACL,QAAQ,2BACM,oBACd,2BACP,UAAU,IAAI"}
@@ -1,24 +1,26 @@
1
- import { CleanupFn, Factory, ItemCleanupPair } from '@isograph/disposable-types';
2
- export type NotInParentCacheAndDisposed = {
3
- kind: 'NotInParentCacheAndDisposed';
1
+ import { CleanupFn, Factory, ItemCleanupPair } from "@isograph/disposable-types";
2
+
3
+ //#region src/CacheItem.d.ts
4
+ type NotInParentCacheAndDisposed = {
5
+ kind: 'NotInParentCacheAndDisposed';
4
6
  };
5
- export type NotInParentCacheAndNotDisposed<T> = {
6
- kind: 'NotInParentCacheAndNotDisposed';
7
- value: T;
8
- disposeValue: () => void;
9
- permanentRetainCount: number;
7
+ type NotInParentCacheAndNotDisposed<T> = {
8
+ kind: 'NotInParentCacheAndNotDisposed';
9
+ value: T;
10
+ disposeValue: () => void;
11
+ permanentRetainCount: number;
10
12
  };
11
- export type InParentCacheAndNotDisposed<T> = {
12
- kind: 'InParentCacheAndNotDisposed';
13
- value: T;
14
- disposeValue: () => void;
15
- removeFromParentCache: () => void;
16
- temporaryRetainCount: number;
17
- permanentRetainCount: number;
13
+ type InParentCacheAndNotDisposed<T> = {
14
+ kind: 'InParentCacheAndNotDisposed';
15
+ value: T;
16
+ disposeValue: () => void;
17
+ removeFromParentCache: () => void;
18
+ temporaryRetainCount: number;
19
+ permanentRetainCount: number;
18
20
  };
19
- export type CacheItemState<T> = InParentCacheAndNotDisposed<T> | NotInParentCacheAndNotDisposed<T> | NotInParentCacheAndDisposed;
20
- export type CacheItemOptions = {
21
- temporaryRetainTime: number;
21
+ type CacheItemState<T> = InParentCacheAndNotDisposed<T> | NotInParentCacheAndNotDisposed<T> | NotInParentCacheAndDisposed;
22
+ type CacheItemOptions = {
23
+ temporaryRetainTime: number;
22
24
  };
23
25
  /**
24
26
  * CacheItem:
@@ -44,16 +46,18 @@ export type CacheItemOptions = {
44
46
  * - InParentCacheAndNotDisposed => NotInParentCacheAndDisposed
45
47
  * - NotInParentCacheAndNotDisposed => NotInParentCacheAndDisposed
46
48
  */
47
- export declare class CacheItem<T> {
48
- private __state;
49
- private __options;
50
- constructor(factory: Factory<T>, removeFromParentCache: CleanupFn, options: CacheItemOptions | void);
51
- getValue(): T;
52
- permanentRetainIfNotDisposed(disposeOfTemporaryRetain: CleanupFn): ItemCleanupPair<T> | null;
53
- temporaryRetain(): CleanupFn;
54
- permanentRetain(): CleanupFn;
55
- private __maybeExitInParentCacheAndNotDisposedState;
56
- private __maybeExitNotInParentCacheAndNotDisposedState;
49
+ declare class CacheItem<T> {
50
+ private __state;
51
+ private __options;
52
+ constructor(factory: Factory<T>, removeFromParentCache: CleanupFn, options: CacheItemOptions | void);
53
+ getValue(): T;
54
+ permanentRetainIfNotDisposed(disposeOfTemporaryRetain: CleanupFn): ItemCleanupPair<T> | null;
55
+ temporaryRetain(): CleanupFn;
56
+ permanentRetain(): CleanupFn;
57
+ private __maybeExitInParentCacheAndNotDisposedState;
58
+ private __maybeExitNotInParentCacheAndNotDisposedState;
57
59
  }
58
- export declare function createTemporarilyRetainedCacheItem<T>(factory: Factory<T>, removeFromParentCache: CleanupFn, options: CacheItemOptions | void): [CacheItem<T>, CleanupFn];
60
+ declare function createTemporarilyRetainedCacheItem<T>(factory: Factory<T>, removeFromParentCache: CleanupFn, options: CacheItemOptions | void): [CacheItem<T>, CleanupFn];
61
+ //#endregion
62
+ export { CacheItem, CacheItemOptions, CacheItemState, InParentCacheAndNotDisposed, NotInParentCacheAndDisposed, NotInParentCacheAndNotDisposed, createTemporarilyRetainedCacheItem };
59
63
  //# sourceMappingURL=CacheItem.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"CacheItem.d.ts","sourceRoot":"","sources":["../src/CacheItem.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,OAAO,EACP,eAAe,EAChB,MAAM,4BAA4B,CAAC;AAIpC,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,6BAA6B,CAAC;CACrC,CAAC;AACF,MAAM,MAAM,8BAA8B,CAAC,CAAC,IAAI;IAC9C,IAAI,EAAE,gCAAgC,CAAC;IACvC,KAAK,EAAE,CAAC,CAAC;IACT,YAAY,EAAE,MAAM,IAAI,CAAC;IAGzB,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AACF,MAAM,MAAM,2BAA2B,CAAC,CAAC,IAAI;IAC3C,IAAI,EAAE,6BAA6B,CAAC;IACpC,KAAK,EAAE,CAAC,CAAC;IACT,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB,qBAAqB,EAAE,MAAM,IAAI,CAAC;IAGlC,oBAAoB,EAAE,MAAM,CAAC;IAG7B,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,IACxB,2BAA2B,CAAC,CAAC,CAAC,GAC9B,8BAA8B,CAAC,CAAC,CAAC,GACjC,2BAA2B,CAAC;AAEhC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAKF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,SAAS,CAAC,CAAC;IACtB,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,SAAS,CAA0B;gBAQzC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,qBAAqB,EAAE,SAAS,EAChC,OAAO,EAAE,gBAAgB,GAAG,IAAI;IAgBlC,QAAQ,IAAI,CAAC;IAiBb,4BAA4B,CAC1B,wBAAwB,EAAE,SAAS,GAClC,eAAe,CAAC,CAAC,CAAC,GAAG,IAAI;IA8E5B,eAAe,IAAI,SAAS;IAkE5B,eAAe,IAAI,SAAS;IAoE5B,OAAO,CAAC,2CAA2C;IAoBnD,OAAO,CAAC,8CAA8C;CAUvD;AAED,wBAAgB,kCAAkC,CAAC,CAAC,EAClD,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,qBAAqB,EAAE,SAAS,EAChC,OAAO,EAAE,gBAAgB,GAAG,IAAI,GAC/B,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAI3B"}
1
+ {"version":3,"file":"CacheItem.d.ts","names":[],"sources":["../src/CacheItem.ts"],"sourcesContent":[],"mappings":";;;KAQY,2BAAA;;AAAZ,CAAA;AAGY,KAAA,8BAA8B,CAAA,CAAA,CAAA,GAAA;EAQ9B,IAAA,EAAA,gCAA2B;EAa3B,KAAA,EAnBH,CAmBG;EACoB,YAAA,EAAA,GAAA,GAAA,IAAA;EAA5B,oBAAA,EAAA,MAAA;CAC+B;AAA/B,KAfQ,2BAeR,CAAA,CAAA,CAAA,GAAA;EACA,IAAA,EAAA,6BAAA;EAA2B,KAAA,EAdtB,CAcsB;EAEnB,YAAA,EAAA,GAAA,GAAgB,IAAA;EA+Bf,qBAAS,EAAA,GAAA,GAAA,IAAA;EAUD,oBAAA,EAAA,MAAA;EAAR,oBAAA,EAAA,MAAA;CACc;AACd,KAhDD,cAgDC,CAAA,CAAA,CAAA,GA/CT,2BA+CS,CA/CmB,CA+CnB,CAAA,GA9CT,8BA8CS,CA9CsB,CA8CtB,CAAA,GA7CT,2BA6CS;AAgBC,KA3DF,gBAAA,GA2DE;EAkBgB,mBAAA,EAAA,MAAA;CACT;;;;;AAyPrB;;;;;;;;;;;;;;;;;;;;cAxSa;;;uBAUA,QAAQ,2BACM,oBACd;cAgBC;yDAkBgB,YACzB,gBAAgB;qBA+EA;qBAqEA;;;;iBAqGL,+CACL,QAAQ,2BACM,oBACd,2BACP,UAAU,IAAI"}
package/dist/CacheItem.js CHANGED
@@ -1,269 +1,194 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CacheItem = void 0;
4
- exports.createTemporarilyRetainedCacheItem = createTemporarilyRetainedCacheItem;
5
- const DEFAULT_TEMPORARY_RETAIN_TIME = 5000;
6
- // TODO don't export this class, only export type (interface) instead
7
- // TODO convert cacheitem impl to a getter and setter and free functions
1
+
2
+ //#region src/CacheItem.ts
3
+ const DEFAULT_TEMPORARY_RETAIN_TIME = 5e3;
8
4
  /**
9
- * CacheItem:
10
- *
11
- * Terminology:
12
- * - TRC = Temporary Retain Count
13
- * - PRC = Permanent Retain Count
14
- *
15
- * A CacheItem<T> can be in three states:
16
- * In parent cache? | Item disposed? | TRC | PRC | Name
17
- * -----------------+----------------+-----+-----+-------------------------------
18
- * In parent cache | Not disposed | >0 | >=0 | InParentCacheAndNotDisposed
19
- * Removed | Not disposed | 0 | >0 | NotInParentCacheAndNotDisposed
20
- * Removed | Disposed | 0 | 0 | NotInParentCacheAndNotDisposed
21
- *
22
- * A cache item can only move down rows. As in, if its in the parent cache,
23
- * it can be removed. It can never be replaced in the parent cache. (If a
24
- * parent cache becomes full again, it will contain a new CacheItem.) The
25
- * contained item can be disposed, but never un-disposed.
26
- *
27
- * So, the valid transitions are:
28
- * - InParentCacheAndNotDisposed => NotInParentCacheAndNotDisposed
29
- * - InParentCacheAndNotDisposed => NotInParentCacheAndDisposed
30
- * - NotInParentCacheAndNotDisposed => NotInParentCacheAndDisposed
31
- */
32
- class CacheItem {
33
- // Private. Do not call this constructor directly. Use
34
- // createTemporarilyRetainedCacheItem instead. This is because this
35
- // constructor creates a CacheItem in an invalid state. It must be
36
- // temporarily retained to enter a valid state, and JavaScript doesn't
37
- // let you return a tuple from a constructor.
38
- constructor(factory, removeFromParentCache, options) {
39
- this.__options = options !== null && options !== void 0 ? options : null;
40
- const [value, disposeValue] = factory();
41
- this.__state = {
42
- kind: 'InParentCacheAndNotDisposed',
43
- value,
44
- disposeValue,
45
- removeFromParentCache,
46
- // NOTE: we are creating the CacheItem in an invalid state. This is okay, because
47
- // we are immediately calling .temporaryRetain.
48
- temporaryRetainCount: 0,
49
- permanentRetainCount: 0,
50
- };
51
- }
52
- getValue() {
53
- switch (this.__state.kind) {
54
- case 'InParentCacheAndNotDisposed': {
55
- return this.__state.value;
56
- }
57
- case 'NotInParentCacheAndNotDisposed': {
58
- return this.__state.value;
59
- }
60
- default: {
61
- throw new Error('Attempted to access disposed value from CacheItem. ' +
62
- 'This indicates a bug in react-disposable-state.');
63
- }
64
- }
65
- }
66
- permanentRetainIfNotDisposed(disposeOfTemporaryRetain) {
67
- switch (this.__state.kind) {
68
- case 'InParentCacheAndNotDisposed': {
69
- let cleared = false;
70
- this.__state.permanentRetainCount++;
71
- disposeOfTemporaryRetain();
72
- return [
73
- this.__state.value,
74
- () => {
75
- if (cleared) {
76
- throw new Error('A permanent retain should only be cleared once. ' +
77
- 'This indicates a bug in react-disposable-state.');
78
- }
79
- cleared = true;
80
- switch (this.__state.kind) {
81
- case 'InParentCacheAndNotDisposed': {
82
- this.__state.permanentRetainCount--;
83
- this.__maybeExitInParentCacheAndNotDisposedState(this.__state);
84
- return;
85
- }
86
- case 'NotInParentCacheAndNotDisposed': {
87
- this.__state.permanentRetainCount--;
88
- this.__maybeExitNotInParentCacheAndNotDisposedState(this.__state);
89
- return;
90
- }
91
- default: {
92
- throw new Error('CacheItem was in a disposed state, but there existed a permanent retain. ' +
93
- 'This indicates a bug in react-disposable-state.');
94
- }
95
- }
96
- },
97
- ];
98
- }
99
- case 'NotInParentCacheAndNotDisposed': {
100
- let cleared = false;
101
- this.__state.permanentRetainCount++;
102
- disposeOfTemporaryRetain();
103
- return [
104
- this.__state.value,
105
- () => {
106
- if (cleared) {
107
- throw new Error('A permanent retain should only be cleared once. ' +
108
- 'This indicates a bug in react-disposable-state.');
109
- }
110
- cleared = true;
111
- switch (this.__state.kind) {
112
- case 'NotInParentCacheAndNotDisposed': {
113
- this.__state.permanentRetainCount--;
114
- this.__maybeExitNotInParentCacheAndNotDisposedState(this.__state);
115
- return;
116
- }
117
- default: {
118
- throw new Error('CacheItem was in an unexpected state. ' +
119
- 'This indicates a bug in react-disposable-state.');
120
- }
121
- }
122
- },
123
- ];
124
- }
125
- default: {
126
- // The CacheItem is disposed, so disposeOfTemporaryRetain is a no-op
127
- return null;
128
- }
129
- }
130
- }
131
- temporaryRetain() {
132
- var _a, _b;
133
- switch (this.__state.kind) {
134
- case 'InParentCacheAndNotDisposed': {
135
- let status = 'Uncleared';
136
- this.__state.temporaryRetainCount++;
137
- const clearTemporaryRetainByCallack = () => {
138
- if (status === 'ClearedByCallback') {
139
- throw new Error('A temporary retain should only be cleared once. ' +
140
- 'This indicates a bug in react-disposable-state.');
141
- }
142
- else if (status === 'Uncleared') {
143
- switch (this.__state.kind) {
144
- case 'InParentCacheAndNotDisposed': {
145
- this.__state.temporaryRetainCount--;
146
- this.__maybeExitInParentCacheAndNotDisposedState(this.__state);
147
- clearTimeout(timeoutId);
148
- return;
149
- }
150
- default: {
151
- throw new Error('A temporary retain was cleared, for which the CacheItem is in an invalid state. ' +
152
- 'This indicates a bug in react-disposable-state.');
153
- }
154
- }
155
- }
156
- };
157
- const clearTemporaryRetainByTimeout = () => {
158
- status = 'ClearedByTimeout';
159
- switch (this.__state.kind) {
160
- case 'InParentCacheAndNotDisposed': {
161
- this.__state.temporaryRetainCount--;
162
- this.__maybeExitInParentCacheAndNotDisposedState(this.__state);
163
- return;
164
- }
165
- default: {
166
- throw new Error('A temporary retain was cleared, for which the CacheItem is in an invalid state. ' +
167
- 'This indicates a bug in react-disposable-state.');
168
- }
169
- }
170
- };
171
- const timeoutId = setTimeout(clearTemporaryRetainByTimeout, (_b = (_a = this.__options) === null || _a === void 0 ? void 0 : _a.temporaryRetainTime) !== null && _b !== void 0 ? _b : DEFAULT_TEMPORARY_RETAIN_TIME);
172
- return clearTemporaryRetainByCallack;
173
- }
174
- default: {
175
- throw new Error('temporaryRetain was called, for which the CacheItem is in an invalid state. ' +
176
- 'This indicates a bug in react-disposable-state.');
177
- }
178
- }
179
- }
180
- permanentRetain() {
181
- switch (this.__state.kind) {
182
- case 'InParentCacheAndNotDisposed': {
183
- let cleared = false;
184
- this.__state.permanentRetainCount++;
185
- return () => {
186
- if (cleared) {
187
- throw new Error('A permanent retain should only be cleared once. ' +
188
- 'This indicates a bug in react-disposable-state.');
189
- }
190
- cleared = true;
191
- switch (this.__state.kind) {
192
- case 'InParentCacheAndNotDisposed': {
193
- this.__state.permanentRetainCount--;
194
- this.__maybeExitInParentCacheAndNotDisposedState(this.__state);
195
- return;
196
- }
197
- case 'NotInParentCacheAndNotDisposed': {
198
- this.__state.permanentRetainCount--;
199
- this.__maybeExitNotInParentCacheAndNotDisposedState(this.__state);
200
- return;
201
- }
202
- default: {
203
- throw new Error('CacheItem was in a disposed state, but there existed a permanent retain. ' +
204
- 'This indicates a bug in react-disposable-state.');
205
- }
206
- }
207
- };
208
- }
209
- case 'NotInParentCacheAndNotDisposed': {
210
- let cleared = false;
211
- this.__state.permanentRetainCount++;
212
- return () => {
213
- if (cleared) {
214
- throw new Error('A permanent retain should only be cleared once. ' +
215
- 'This indicates a bug in react-disposable-state.');
216
- }
217
- cleared = true;
218
- switch (this.__state.kind) {
219
- case 'NotInParentCacheAndNotDisposed': {
220
- this.__state.permanentRetainCount--;
221
- this.__maybeExitNotInParentCacheAndNotDisposedState(this.__state);
222
- return;
223
- }
224
- default: {
225
- throw new Error('CacheItem was in an unexpected state. ' +
226
- 'This indicates a bug in react-disposable-state.');
227
- }
228
- }
229
- };
230
- }
231
- default: {
232
- throw new Error('permanentRetain was called, but the CacheItem is in an invalid state. ' +
233
- 'This indicates a bug in react-disposable-state.');
234
- }
235
- }
236
- }
237
- __maybeExitInParentCacheAndNotDisposedState(state) {
238
- if (state.temporaryRetainCount === 0 && state.permanentRetainCount === 0) {
239
- state.removeFromParentCache();
240
- state.disposeValue();
241
- this.__state = {
242
- kind: 'NotInParentCacheAndDisposed',
243
- };
244
- }
245
- else if (state.temporaryRetainCount === 0) {
246
- state.removeFromParentCache();
247
- this.__state = {
248
- kind: 'NotInParentCacheAndNotDisposed',
249
- value: state.value,
250
- disposeValue: state.disposeValue,
251
- permanentRetainCount: state.permanentRetainCount,
252
- };
253
- }
254
- }
255
- __maybeExitNotInParentCacheAndNotDisposedState(state) {
256
- if (state.permanentRetainCount === 0) {
257
- state.disposeValue();
258
- this.__state = {
259
- kind: 'NotInParentCacheAndDisposed',
260
- };
261
- }
262
- }
263
- }
264
- exports.CacheItem = CacheItem;
5
+ * CacheItem:
6
+ *
7
+ * Terminology:
8
+ * - TRC = Temporary Retain Count
9
+ * - PRC = Permanent Retain Count
10
+ *
11
+ * A CacheItem<T> can be in three states:
12
+ * In parent cache? | Item disposed? | TRC | PRC | Name
13
+ * -----------------+----------------+-----+-----+-------------------------------
14
+ * In parent cache | Not disposed | >0 | >=0 | InParentCacheAndNotDisposed
15
+ * Removed | Not disposed | 0 | >0 | NotInParentCacheAndNotDisposed
16
+ * Removed | Disposed | 0 | 0 | NotInParentCacheAndNotDisposed
17
+ *
18
+ * A cache item can only move down rows. As in, if its in the parent cache,
19
+ * it can be removed. It can never be replaced in the parent cache. (If a
20
+ * parent cache becomes full again, it will contain a new CacheItem.) The
21
+ * contained item can be disposed, but never un-disposed.
22
+ *
23
+ * So, the valid transitions are:
24
+ * - InParentCacheAndNotDisposed => NotInParentCacheAndNotDisposed
25
+ * - InParentCacheAndNotDisposed => NotInParentCacheAndDisposed
26
+ * - NotInParentCacheAndNotDisposed => NotInParentCacheAndDisposed
27
+ */
28
+ var CacheItem = class {
29
+ constructor(factory, removeFromParentCache, options) {
30
+ this.__options = options ?? null;
31
+ const [value, disposeValue] = factory();
32
+ this.__state = {
33
+ kind: "InParentCacheAndNotDisposed",
34
+ value,
35
+ disposeValue,
36
+ removeFromParentCache,
37
+ temporaryRetainCount: 0,
38
+ permanentRetainCount: 0
39
+ };
40
+ }
41
+ getValue() {
42
+ switch (this.__state.kind) {
43
+ case "InParentCacheAndNotDisposed": return this.__state.value;
44
+ case "NotInParentCacheAndNotDisposed": return this.__state.value;
45
+ case "NotInParentCacheAndDisposed": throw new Error("Attempted to access disposed value from CacheItem. This indicates a bug in react-disposable-state.");
46
+ }
47
+ }
48
+ permanentRetainIfNotDisposed(disposeOfTemporaryRetain) {
49
+ switch (this.__state.kind) {
50
+ case "InParentCacheAndNotDisposed": {
51
+ let cleared = false;
52
+ this.__state.permanentRetainCount++;
53
+ disposeOfTemporaryRetain();
54
+ return [this.__state.value, () => {
55
+ if (cleared) throw new Error("A permanent retain should only be cleared once. This indicates a bug in react-disposable-state.");
56
+ cleared = true;
57
+ switch (this.__state.kind) {
58
+ case "InParentCacheAndNotDisposed":
59
+ this.__state.permanentRetainCount--;
60
+ this.__maybeExitInParentCacheAndNotDisposedState(this.__state);
61
+ return;
62
+ case "NotInParentCacheAndNotDisposed":
63
+ this.__state.permanentRetainCount--;
64
+ this.__maybeExitNotInParentCacheAndNotDisposedState(this.__state);
65
+ return;
66
+ case "NotInParentCacheAndDisposed": throw new Error("CacheItem was in a disposed state, but there existed a permanent retain. This indicates a bug in react-disposable-state.");
67
+ }
68
+ }];
69
+ }
70
+ case "NotInParentCacheAndNotDisposed": {
71
+ let cleared = false;
72
+ this.__state.permanentRetainCount++;
73
+ disposeOfTemporaryRetain();
74
+ return [this.__state.value, () => {
75
+ if (cleared) throw new Error("A permanent retain should only be cleared once. This indicates a bug in react-disposable-state.");
76
+ cleared = true;
77
+ switch (this.__state.kind) {
78
+ case "NotInParentCacheAndNotDisposed":
79
+ this.__state.permanentRetainCount--;
80
+ this.__maybeExitNotInParentCacheAndNotDisposedState(this.__state);
81
+ return;
82
+ case "InParentCacheAndNotDisposed":
83
+ case "NotInParentCacheAndDisposed": throw new Error("CacheItem was in an unexpected state. This indicates a bug in react-disposable-state.");
84
+ }
85
+ }];
86
+ }
87
+ case "NotInParentCacheAndDisposed": return null;
88
+ }
89
+ }
90
+ temporaryRetain() {
91
+ switch (this.__state.kind) {
92
+ case "InParentCacheAndNotDisposed": {
93
+ let status = "Uncleared";
94
+ this.__state.temporaryRetainCount++;
95
+ const clearTemporaryRetainByCallack = () => {
96
+ if (status === "ClearedByCallback") throw new Error("A temporary retain should only be cleared once. This indicates a bug in react-disposable-state.");
97
+ else if (status === "Uncleared") switch (this.__state.kind) {
98
+ case "InParentCacheAndNotDisposed":
99
+ this.__state.temporaryRetainCount--;
100
+ this.__maybeExitInParentCacheAndNotDisposedState(this.__state);
101
+ clearTimeout(timeoutId);
102
+ return;
103
+ case "NotInParentCacheAndDisposed":
104
+ case "NotInParentCacheAndNotDisposed": throw new Error("A temporary retain was cleared, for which the CacheItem is in an invalid state. This indicates a bug in react-disposable-state.");
105
+ }
106
+ };
107
+ const clearTemporaryRetainByTimeout = () => {
108
+ status = "ClearedByTimeout";
109
+ switch (this.__state.kind) {
110
+ case "InParentCacheAndNotDisposed":
111
+ this.__state.temporaryRetainCount--;
112
+ this.__maybeExitInParentCacheAndNotDisposedState(this.__state);
113
+ return;
114
+ case "NotInParentCacheAndDisposed":
115
+ case "NotInParentCacheAndNotDisposed": throw new Error("A temporary retain was cleared, for which the CacheItem is in an invalid state. This indicates a bug in react-disposable-state.");
116
+ }
117
+ };
118
+ const timeoutId = setTimeout(clearTemporaryRetainByTimeout, this.__options?.temporaryRetainTime ?? DEFAULT_TEMPORARY_RETAIN_TIME);
119
+ return clearTemporaryRetainByCallack;
120
+ }
121
+ case "NotInParentCacheAndDisposed":
122
+ case "NotInParentCacheAndNotDisposed": throw new Error("temporaryRetain was called, for which the CacheItem is in an invalid state. This indicates a bug in react-disposable-state.");
123
+ }
124
+ }
125
+ permanentRetain() {
126
+ switch (this.__state.kind) {
127
+ case "InParentCacheAndNotDisposed": {
128
+ let cleared = false;
129
+ this.__state.permanentRetainCount++;
130
+ return () => {
131
+ if (cleared) throw new Error("A permanent retain should only be cleared once. This indicates a bug in react-disposable-state.");
132
+ cleared = true;
133
+ switch (this.__state.kind) {
134
+ case "InParentCacheAndNotDisposed":
135
+ this.__state.permanentRetainCount--;
136
+ this.__maybeExitInParentCacheAndNotDisposedState(this.__state);
137
+ return;
138
+ case "NotInParentCacheAndNotDisposed":
139
+ this.__state.permanentRetainCount--;
140
+ this.__maybeExitNotInParentCacheAndNotDisposedState(this.__state);
141
+ return;
142
+ case "NotInParentCacheAndDisposed": throw new Error("CacheItem was in a disposed state, but there existed a permanent retain. This indicates a bug in react-disposable-state.");
143
+ }
144
+ };
145
+ }
146
+ case "NotInParentCacheAndNotDisposed": {
147
+ let cleared = false;
148
+ this.__state.permanentRetainCount++;
149
+ return () => {
150
+ if (cleared) throw new Error("A permanent retain should only be cleared once. This indicates a bug in react-disposable-state.");
151
+ cleared = true;
152
+ switch (this.__state.kind) {
153
+ case "NotInParentCacheAndNotDisposed":
154
+ this.__state.permanentRetainCount--;
155
+ this.__maybeExitNotInParentCacheAndNotDisposedState(this.__state);
156
+ return;
157
+ case "InParentCacheAndNotDisposed":
158
+ case "NotInParentCacheAndDisposed": throw new Error("CacheItem was in an unexpected state. This indicates a bug in react-disposable-state.");
159
+ }
160
+ };
161
+ }
162
+ case "NotInParentCacheAndDisposed": throw new Error("permanentRetain was called, but the CacheItem is in an invalid state. This indicates a bug in react-disposable-state.");
163
+ }
164
+ }
165
+ __maybeExitInParentCacheAndNotDisposedState(state) {
166
+ if (state.temporaryRetainCount === 0 && state.permanentRetainCount === 0) {
167
+ state.removeFromParentCache();
168
+ state.disposeValue();
169
+ this.__state = { kind: "NotInParentCacheAndDisposed" };
170
+ } else if (state.temporaryRetainCount === 0) {
171
+ state.removeFromParentCache();
172
+ this.__state = {
173
+ kind: "NotInParentCacheAndNotDisposed",
174
+ value: state.value,
175
+ disposeValue: state.disposeValue,
176
+ permanentRetainCount: state.permanentRetainCount
177
+ };
178
+ }
179
+ }
180
+ __maybeExitNotInParentCacheAndNotDisposedState(state) {
181
+ if (state.permanentRetainCount === 0) {
182
+ state.disposeValue();
183
+ this.__state = { kind: "NotInParentCacheAndDisposed" };
184
+ }
185
+ }
186
+ };
265
187
  function createTemporarilyRetainedCacheItem(factory, removeFromParentCache, options) {
266
- const cacheItem = new CacheItem(factory, removeFromParentCache, options);
267
- const disposeTemporaryRetain = cacheItem.temporaryRetain();
268
- return [cacheItem, disposeTemporaryRetain];
188
+ const cacheItem = new CacheItem(factory, removeFromParentCache, options);
189
+ return [cacheItem, cacheItem.temporaryRetain()];
269
190
  }
191
+
192
+ //#endregion
193
+ exports.CacheItem = CacheItem;
194
+ exports.createTemporarilyRetainedCacheItem = createTemporarilyRetainedCacheItem;