@arcanejs/react-toolkit 0.6.1 → 0.7.0

package/dist/data.d.mts

@@ -24,6 +24,20 @@ type ProviderProps = DataFileUsage & {
 type DataFileUpdater<T> = (update: (current: T) => T) => void;
 type DataFileContext<T> = {
     data: T;
+    /**
+     * Last timestamp where {@link DataFileContext.data data} was updated
+     * in-memory.
+     *
+     * **Note: This is not the last time the data was saved to disk.**
+     * More specifically:
+     * - If the data has been loaded from disk and not changed,
+     *   then this will be the timestamp that it was loaded from disk.
+     * - If the data has been updated since first loaded into memory,
+     *   then this will be the timestamp of the last update.
+     *
+     * Uses the local timestamp in milliseconds, i.e. `Date.now()`.
+     */
+    lastUpdatedMillis: number;
     updateData: DataFileUpdater<T>;
     /**
      * Can be called to force an attempt to re-save the data to disk
@@ -54,6 +68,8 @@ declare function useDataFileContext<T>(dataFile: DataFileDefinition<T>): DataFil
  */
 declare function useDataFile<T>(dataFile: DataFileDefinition<T>, usage: DataFileUsage): DataFileCore<T>;
 type DataState<T> = {
+    lastUpdatedMillis: number;
+} & ({
     status: 'loading';
     /**
      * The data is not yet loaded, so this will be undefined,
@@ -72,7 +88,7 @@ type DataState<T> = {
 } | {
     status: 'ready';
     data: T;
-};
+});
 type UseDataFileCoreProps<T> = WithPathChange & {
     schema: ZodType<T>;
     defaultValue: T;

package/dist/data.d.ts

@@ -24,6 +24,20 @@ type ProviderProps = DataFileUsage & {
 type DataFileUpdater<T> = (update: (current: T) => T) => void;
 type DataFileContext<T> = {
     data: T;
+    /**
+     * Last timestamp where {@link DataFileContext.data data} was updated
+     * in-memory.
+     *
+     * **Note: This is not the last time the data was saved to disk.**
+     * More specifically:
+     * - If the data has been loaded from disk and not changed,
+     *   then this will be the timestamp that it was loaded from disk.
+     * - If the data has been updated since first loaded into memory,
+     *   then this will be the timestamp of the last update.
+     *
+     * Uses the local timestamp in milliseconds, i.e. `Date.now()`.
+     */
+    lastUpdatedMillis: number;
     updateData: DataFileUpdater<T>;
     /**
      * Can be called to force an attempt to re-save the data to disk
@@ -54,6 +68,8 @@ declare function useDataFileContext<T>(dataFile: DataFileDefinition<T>): DataFil
  */
 declare function useDataFile<T>(dataFile: DataFileDefinition<T>, usage: DataFileUsage): DataFileCore<T>;
 type DataState<T> = {
+    lastUpdatedMillis: number;
+} & ({
     status: 'loading';
     /**
      * The data is not yet loaded, so this will be undefined,
@@ -72,7 +88,7 @@ type DataState<T> = {
 } | {
     status: 'ready';
     data: T;
-};
+});
 type UseDataFileCoreProps<T> = WithPathChange & {
     schema: ZodType<T>;
     defaultValue: T;

package/dist/data.js

@@ -39,6 +39,7 @@ function useDataFileCore({
     path: null,
     data: void 0,
     previousData: void 0,
+    lastUpdatedMillis: Date.now(),
     state: {
       state: "saved"
     }
@@ -53,6 +54,7 @@ function useDataFileCore({
     }
   }, [schema, defaultValue]);
   const [data, setData] = _react.useState.call(void 0, {
+    lastUpdatedMillis: state.current.lastUpdatedMillis,
     status: "loading",
     data: void 0
   });
@@ -61,6 +63,7 @@ function useDataFileCore({
       const data2 = state.current.data;
       if (state.current.state.state === "error") {
         setData({
+          lastUpdatedMillis: state.current.lastUpdatedMillis,
           status: "error",
           error: state.current.state.error,
           data: data2
@@ -69,12 +72,14 @@ function useDataFileCore({
       }
       if (data2 === void 0) {
         setData({
+          lastUpdatedMillis: state.current.lastUpdatedMillis,
           status: "loading",
           data: void 0
         });
         return;
       }
       setData({
+        lastUpdatedMillis: state.current.lastUpdatedMillis,
         status: "ready",
         data: data2
       });
@@ -131,6 +136,7 @@ function useDataFileCore({
       const parsedData = schema.parse(JSON.parse(data2));
       if (state.current.path === path) {
         state.current.data = parsedData;
+        state.current.lastUpdatedMillis = Date.now();
         state.current.state = { state: "saved" };
         updateDataFromState();
       }
@@ -141,6 +147,7 @@ function useDataFileCore({
       if (error.code === "ENOENT") {
         const initialData = onPathChange === "transfer" && state.current.previousData !== void 0 ? state.current.previousData : defaultValue;
         state.current.data = initialData;
+        state.current.lastUpdatedMillis = Date.now();
         state.current.state = { state: "dirty" };
         _optionalChain([log, 'optionalAccess', _ => _.info, 'call', _2 => _2(
           "Creating a new file at %s with initial data %o",
@@ -164,6 +171,7 @@ function useDataFileCore({
         throw new Error("Attempt to update data before it has been loaded");
       }
       state.current.data = update(state.current.data);
+      state.current.lastUpdatedMillis = Date.now();
       state.current.state = { state: "dirty" };
       saveData();
       updateDataFromState();
@@ -182,6 +190,7 @@ function createDataFileDefinition({
 }) {
   const context = _react.createContext.call(void 0, {
     data: defaultValue,
+    lastUpdatedMillis: Date.now(),
     updateData: () => {
       throw new Error("Data file provider not used");
     },
@@ -207,6 +216,7 @@ function createDataFileDefinition({
     const providedContext = _react.useMemo.call(void 0, 
       () => ({
         data: data.status !== "loading" && data.data !== void 0 ? data.data : defaultValue,
+        lastUpdatedMillis: data.lastUpdatedMillis,
         updateData,
         saveData,
         error: data.status === "error" ? data.error : void 0

package/dist/data.mjs

@@ -39,6 +39,7 @@ function useDataFileCore({
     path: null,
     data: void 0,
     previousData: void 0,
+    lastUpdatedMillis: Date.now(),
     state: {
       state: "saved"
     }
@@ -53,6 +54,7 @@ function useDataFileCore({
     }
   }, [schema, defaultValue]);
   const [data, setData] = useState({
+    lastUpdatedMillis: state.current.lastUpdatedMillis,
     status: "loading",
     data: void 0
   });
@@ -61,6 +63,7 @@ function useDataFileCore({
       const data2 = state.current.data;
       if (state.current.state.state === "error") {
         setData({
+          lastUpdatedMillis: state.current.lastUpdatedMillis,
           status: "error",
           error: state.current.state.error,
           data: data2
@@ -69,12 +72,14 @@ function useDataFileCore({
       }
       if (data2 === void 0) {
         setData({
+          lastUpdatedMillis: state.current.lastUpdatedMillis,
           status: "loading",
           data: void 0
         });
         return;
       }
       setData({
+        lastUpdatedMillis: state.current.lastUpdatedMillis,
         status: "ready",
         data: data2
       });
@@ -131,6 +136,7 @@ function useDataFileCore({
       const parsedData = schema.parse(JSON.parse(data2));
       if (state.current.path === path) {
         state.current.data = parsedData;
+        state.current.lastUpdatedMillis = Date.now();
         state.current.state = { state: "saved" };
         updateDataFromState();
       }
@@ -141,6 +147,7 @@ function useDataFileCore({
       if (error.code === "ENOENT") {
         const initialData = onPathChange === "transfer" && state.current.previousData !== void 0 ? state.current.previousData : defaultValue;
         state.current.data = initialData;
+        state.current.lastUpdatedMillis = Date.now();
         state.current.state = { state: "dirty" };
         log?.info(
           "Creating a new file at %s with initial data %o",
@@ -164,6 +171,7 @@ function useDataFileCore({
         throw new Error("Attempt to update data before it has been loaded");
       }
       state.current.data = update(state.current.data);
+      state.current.lastUpdatedMillis = Date.now();
       state.current.state = { state: "dirty" };
       saveData();
       updateDataFromState();
@@ -182,6 +190,7 @@ function createDataFileDefinition({
 }) {
   const context = createContext({
     data: defaultValue,
+    lastUpdatedMillis: Date.now(),
     updateData: () => {
       throw new Error("Data file provider not used");
     },
@@ -207,6 +216,7 @@ function createDataFileDefinition({
     const providedContext = useMemo(
       () => ({
         data: data.status !== "loading" && data.data !== void 0 ? data.data : defaultValue,
+        lastUpdatedMillis: data.lastUpdatedMillis,
         updateData,
         saveData,
         error: data.status === "error" ? data.error : void 0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcanejs/react-toolkit",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "private": false,
   "description": "Build web-accessible control interfaces for your long-running Node.js processes",
   "keywords": [
@@ -56,8 +56,8 @@
     "tsup": "^8.1.0",
     "typescript": "^5.3.3",
     "zod": "^3.23.8",
-    "@arcanejs/eslint-config": "^0.0.0",
-    "@arcanejs/typescript-config": "^0.0.0"
+    "@arcanejs/typescript-config": "^0.0.0",
+    "@arcanejs/eslint-config": "^0.0.0"
   },
   "dependencies": {
     "lodash": "^4.17.21",