@isograph/react-disposable-state 0.1.0 → 0.2.0

package/dist/ParentCache.js

@@ -21,6 +21,8 @@ const CacheItem_1 = require("./CacheItem");
  *   be called
  */
 class ParentCache {
+    // TODO pass an onEmpty function, which can e.g. remove this ParentCache
+    // from some parent object.
     constructor(factory) {
         this.__cacheItem = null;
         this.__factory = factory;

package/dist/useCachedPrecommitValue.d.ts

@@ -1,5 +1,5 @@
 import { ParentCache } from './ParentCache';
-import { ItemCleanupPair } from '@isograph/isograph-disposable-types/dist';
+import { ItemCleanupPair } from '@isograph/disposable-types';
 /**
  * usePrecommitValue<T>
  * - Takes a mutable parent cache, a factory function, and an onCommit callback.
@@ -9,7 +9,7 @@ import { ItemCleanupPair } from '@isograph/isograph-disposable-types/dist';
  *   disposed by the time of the commit. If so, this hook checks the parent cache
  *   for another T or creates one, and passes this T to onCommit.
  * - If the T returned during the last render is not the same as the one that
- *   is passed to onCommit, during the commit phase, will schedule another render.
+ *   is passed to onCommit, during the commit phase, it will schedule another render.
  *
  * Invariant: the returned T has not been disposed during the tick of the render.
  * The T passed to the onCommit callback has not been disposed when the onCommit

package/dist/useCachedPrecommitValue.js

@@ -12,7 +12,7 @@ const useHasCommittedRef_1 = require("./useHasCommittedRef");
  *   disposed by the time of the commit. If so, this hook checks the parent cache
  *   for another T or creates one, and passes this T to onCommit.
  * - If the T returned during the last render is not the same as the one that
- *   is passed to onCommit, during the commit phase, will schedule another render.
+ *   is passed to onCommit, during the commit phase, it will schedule another render.
  *
  * Invariant: the returned T has not been disposed during the tick of the render.
  * The T passed to the onCommit callback has not been disposed when the onCommit

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@isograph/react-disposable-state",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Primitives for managing disposable state in React",
+  "homepage": "https://isograph.dev",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "Isograph Labs",
@@ -13,11 +14,14 @@
     "test-watch": "vitest watch",
     "coverage": "vitest run --coverage",
     "note": "WE SHOULD ALSO TEST HERE",
-    "prepack": "yarn run compile"
+    "prepack": "yarn run compile",
+    "tsc": "tsc"
   },
   "dependencies": {
-    "@isograph/disposable-types": "0.1.0",
-    "react": "^18.2.0"
+    "@isograph/disposable-types": "0.2.0"
+  },
+  "peerDependencies": {
+    "react": "18.2.0"
   },
   "devDependencies": {
     "@types/react": "^18.0.31",
@@ -29,5 +33,6 @@
     "type": "git",
     "url": "git+https://github.com/isographlabs/isograph.git",
     "directory": "libs/isograph-react-disposable-state"
-  }
+  },
+  "sideEffects": false
 }

package/src/ParentCache.ts

@@ -28,6 +28,8 @@ export class ParentCache<T> {
   private __cacheItem: CacheItem<T> | null = null;
   private readonly __factory: Factory<T>;
 
+  // TODO pass an onEmpty function, which can e.g. remove this ParentCache
+  // from some parent object.
   constructor(factory: Factory<T>) {
     this.__factory = factory;
   }

package/src/useCachedPrecommitValue.ts

@@ -3,7 +3,7 @@
 import { useEffect, useState } from 'react';
 import { ParentCache } from './ParentCache';
 import { useHasCommittedRef } from './useHasCommittedRef';
-import { ItemCleanupPair } from '@isograph/isograph-disposable-types/dist';
+import { ItemCleanupPair } from '@isograph/disposable-types';
 
 /**
  * usePrecommitValue<T>
@@ -14,7 +14,7 @@ import { ItemCleanupPair } from '@isograph/isograph-disposable-types/dist';
  *   disposed by the time of the commit. If so, this hook checks the parent cache
  *   for another T or creates one, and passes this T to onCommit.
  * - If the T returned during the last render is not the same as the one that
- *   is passed to onCommit, during the commit phase, will schedule another render.
+ *   is passed to onCommit, during the commit phase, it will schedule another render.
  *
  * Invariant: the returned T has not been disposed during the tick of the render.
  * The T passed to the onCommit callback has not been disposed when the onCommit

package/src/useUpdatableDisposableState.ts

@@ -2,7 +2,7 @@ import { ItemCleanupPair } from '@isograph/disposable-types';
 import { useCallback, useEffect, useRef, useState } from 'react';
 import { useHasCommittedRef } from './useHasCommittedRef';
 
-export const UNASSIGNED_STATE = Symbol();
+export const UNASSIGNED_STATE: unique symbol = Symbol();
 export type UnassignedState = typeof UNASSIGNED_STATE;
 
 type UseUpdatableDisposableStateReturnValue<T> = {

package/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.pkg.json",
+  "compilerOptions": {
+    "noEmit": true,
+  },
+}