@arcanejs/react-toolkit 0.14.0 → 0.15.0

package/dist/data.d.mts

@@ -45,6 +45,10 @@ type DataFileContext<T> = {
      */
     lastUpdatedMillis: number;
     updateData: DataFileUpdater<T>;
+    /**
+     * Can be called to reset the data to the default value, and save that to disk.
+     */
+    resetData: () => void;
     /**
      * Can be called to force an attempt to re-save the data to disk
      */
@@ -99,7 +103,8 @@ type DataFileOperation = 'load' | 'save' | 'usage';
 declare class ArcaneDataFileError extends Error {
     readonly operation: DataFileOperation;
     readonly path: string | null;
-    constructor(message: string, operation: DataFileOperation, path: string | null, cause?: unknown);
+    readonly contents: string | null;
+    constructor(message: string, operation: DataFileOperation, path: string | null, contents: string | null, cause?: unknown);
 }
 type ErrorListener = (error: ArcaneDataFileError) => void;
 type UseDataFileCoreProps<T> = WithPathChange & {
@@ -111,6 +116,7 @@ type UseDataFileCoreProps<T> = WithPathChange & {
 type DataFileCore<T> = {
     data: DataState<T>;
     updateData: DataFileUpdater<T>;
+    resetData: () => void;
     saveData: () => void;
 };
 /**

package/dist/data.d.ts

@@ -45,6 +45,10 @@ type DataFileContext<T> = {
      */
     lastUpdatedMillis: number;
     updateData: DataFileUpdater<T>;
+    /**
+     * Can be called to reset the data to the default value, and save that to disk.
+     */
+    resetData: () => void;
     /**
      * Can be called to force an attempt to re-save the data to disk
      */
@@ -99,7 +103,8 @@ type DataFileOperation = 'load' | 'save' | 'usage';
 declare class ArcaneDataFileError extends Error {
     readonly operation: DataFileOperation;
     readonly path: string | null;
-    constructor(message: string, operation: DataFileOperation, path: string | null, cause?: unknown);
+    readonly contents: string | null;
+    constructor(message: string, operation: DataFileOperation, path: string | null, contents: string | null, cause?: unknown);
 }
 type ErrorListener = (error: ArcaneDataFileError) => void;
 type UseDataFileCoreProps<T> = WithPathChange & {
@@ -111,6 +116,7 @@ type UseDataFileCoreProps<T> = WithPathChange & {
 type DataFileCore<T> = {
     data: DataState<T>;
     updateData: DataFileUpdater<T>;
+    resetData: () => void;
     saveData: () => void;
 };
 /**

package/dist/data.js

@@ -4,6 +4,7 @@ var _chunkRT2VSMJLjs = require('./chunk-RT2VSMJL.js');
 
 // src/data.tsx
 var _fs = require('fs');
+var _crypto = require('crypto');
 
 
 
@@ -28,13 +29,27 @@ function useDataFile(dataFile, usage) {
   return dataFile.useDataFile(usage);
 }
 var ArcaneDataFileError = class extends Error {
-  constructor(message, operation, path, cause) {
+  constructor(message, operation, path, contents, cause) {
     super(message, { cause });
     this.operation = operation;
     this.path = path;
+    this.contents = contents;
     this.name = `ArcaneDataFileError(${operation})`;
   }
 };
+function stripUtf8Bom(data) {
+  return data.charCodeAt(0) === 65279 ? data.slice(1) : data;
+}
+async function writeFileAtomically(path, data) {
+  const tempPath = `${path}.${process.pid}.${_crypto.randomUUID.call(void 0, )}.tmp`;
+  try {
+    await _fs.promises.writeFile(tempPath, data, "utf8");
+    await _fs.promises.rename(tempPath, path);
+  } catch (error) {
+    await _fs.promises.rm(tempPath, { force: true }).catch(() => void 0);
+    throw error;
+  }
+}
 function useDataFileCore({
   schema,
   defaultValue,
@@ -45,6 +60,7 @@ function useDataFileCore({
   const log = _chunkRT2VSMJLjs.useLogger.call(void 0, );
   const state = _react.useRef.call(void 0, {
     initialized: false,
+    saveChain: Promise.resolve(),
     path: null,
     data: void 0,
     previousData: void 0,
@@ -60,6 +76,7 @@ function useDataFileCore({
       const error = new ArcaneDataFileError(
         "Cannot change schema or defaultValue after initialization",
         "usage",
+        null,
         null
       );
       _optionalChain([onError, 'optionalCall', _ => _(error)]);
@@ -110,11 +127,15 @@ function useDataFileCore({
         if (!currentPath || currentData === void 0) {
           return;
         }
-        try {
-          const json = JSON.stringify(currentData, null, 2);
+        const json = JSON.stringify(currentData, null, 2);
+        const queuedSave = state.current.saveChain.catch(() => void 0).then(async () => {
           await _fs.promises.mkdir(_path.dirname.call(void 0, currentPath), { recursive: true });
-          await _fs.promises.writeFile(currentPath, json, "utf8");
-          if (state.current.path === currentPath && state.current.data === currentData) {
+          await writeFileAtomically(currentPath, json);
+        });
+        try {
+          state.current.saveChain = queuedSave;
+          await queuedSave;
+          if (state.current.path === currentPath && state.current.saveChain === queuedSave) {
             state.current.state = { state: "saved" };
           }
         } catch (cause) {
@@ -122,10 +143,11 @@ function useDataFileCore({
             `Error saving data file to path: ${currentPath}`,
             "save",
             currentPath,
+            null,
             cause
           );
           _optionalChain([onError, 'optionalCall', _2 => _2(error)]);
-          if (state.current.path === currentPath && state.current.data === currentData) {
+          if (state.current.path === currentPath && state.current.saveChain === queuedSave) {
             state.current.state = { state: "error", error };
             updateDataFromState();
           }
@@ -152,8 +174,10 @@ function useDataFileCore({
         state: "saved"
       }
     };
+    let contents = null;
     _fs.promises.readFile(path, "utf8").then((data2) => {
-      const parsedData = schema.parse(JSON.parse(data2));
+      contents = data2;
+      const parsedData = schema.parse(JSON.parse(stripUtf8Bom(data2)));
       if (state.current.path === path) {
         state.current.data = parsedData;
         state.current.lastUpdatedMillis = Date.now();
@@ -182,6 +206,7 @@ function useDataFileCore({
         `Error loading data file at path: ${path}`,
         "load",
         path,
+        contents,
         err
       );
       _optionalChain([onError, 'optionalCall', _5 => _5(error)]);
@@ -190,25 +215,36 @@ function useDataFileCore({
       updateDataFromState();
     });
   }, [path, onPathChange]);
-  const updateData = _react.useMemo.call(void 0, 
-    () => (update) => {
+  const setDataTo = _react.useMemo.call(void 0, 
+    () => (data2) => {
       if (state.current.path !== path) {
         return;
       }
-      if (state.current.data === void 0) {
-        throw new Error("Attempt to update data before it has been loaded");
-      }
-      state.current.data = update(state.current.data);
+      state.current.data = data2;
       state.current.lastUpdatedMillis = Date.now();
       state.current.state = { state: "dirty" };
       saveData();
       updateDataFromState();
     },
-    [path]
+    [saveData, path]
+  );
+  const updateData = _react.useMemo.call(void 0, 
+    () => (update) => {
+      if (state.current.data === void 0) {
+        throw new Error("Attempt to update data before it has been loaded");
+      }
+      setDataTo(update(state.current.data));
+    },
+    [setDataTo]
+  );
+  const resetData = _react.useMemo.call(void 0, 
+    () => () => setDataTo(defaultValue),
+    [setDataTo, defaultValue]
   );
   return {
     data,
     updateData,
+    resetData,
     saveData
   };
 }
@@ -223,6 +259,9 @@ function createDataFileDefinition({
     updateData: () => {
       throw new Error("Data file provider not used");
     },
+    resetData: () => {
+      throw new Error("Data file provider not used");
+    },
     saveData: () => {
       throw new Error("Data file provider not used");
     },
@@ -245,7 +284,7 @@ function createDataFileDefinition({
     onError,
     children
   }) => {
-    const { data, updateData, saveData } = useDataFile2({
+    const { data, updateData, resetData, saveData } = useDataFile2({
       path,
       onPathChange,
       onError
@@ -256,6 +295,7 @@ function createDataFileDefinition({
         status: data.status,
         lastUpdatedMillis: data.lastUpdatedMillis,
         updateData,
+        resetData,
         saveData,
         error: data.status === "error" ? data.error : void 0
       }),

package/dist/data.mjs

@@ -4,6 +4,7 @@ import {
 
 // src/data.tsx
 import { promises as fs } from "fs";
+import { randomUUID } from "crypto";
 import {
   useMemo,
   useContext,
@@ -28,13 +29,27 @@ function useDataFile(dataFile, usage) {
   return dataFile.useDataFile(usage);
 }
 var ArcaneDataFileError = class extends Error {
-  constructor(message, operation, path, cause) {
+  constructor(message, operation, path, contents, cause) {
     super(message, { cause });
     this.operation = operation;
     this.path = path;
+    this.contents = contents;
     this.name = `ArcaneDataFileError(${operation})`;
   }
 };
+function stripUtf8Bom(data) {
+  return data.charCodeAt(0) === 65279 ? data.slice(1) : data;
+}
+async function writeFileAtomically(path, data) {
+  const tempPath = `${path}.${process.pid}.${randomUUID()}.tmp`;
+  try {
+    await fs.writeFile(tempPath, data, "utf8");
+    await fs.rename(tempPath, path);
+  } catch (error) {
+    await fs.rm(tempPath, { force: true }).catch(() => void 0);
+    throw error;
+  }
+}
 function useDataFileCore({
   schema,
   defaultValue,
@@ -45,6 +60,7 @@ function useDataFileCore({
   const log = useLogger();
   const state = useRef({
     initialized: false,
+    saveChain: Promise.resolve(),
     path: null,
     data: void 0,
     previousData: void 0,
@@ -60,6 +76,7 @@ function useDataFileCore({
       const error = new ArcaneDataFileError(
         "Cannot change schema or defaultValue after initialization",
         "usage",
+        null,
         null
       );
       onError?.(error);
@@ -110,11 +127,15 @@ function useDataFileCore({
         if (!currentPath || currentData === void 0) {
           return;
         }
-        try {
-          const json = JSON.stringify(currentData, null, 2);
+        const json = JSON.stringify(currentData, null, 2);
+        const queuedSave = state.current.saveChain.catch(() => void 0).then(async () => {
           await fs.mkdir(dirname(currentPath), { recursive: true });
-          await fs.writeFile(currentPath, json, "utf8");
-          if (state.current.path === currentPath && state.current.data === currentData) {
+          await writeFileAtomically(currentPath, json);
+        });
+        try {
+          state.current.saveChain = queuedSave;
+          await queuedSave;
+          if (state.current.path === currentPath && state.current.saveChain === queuedSave) {
             state.current.state = { state: "saved" };
           }
         } catch (cause) {
@@ -122,10 +143,11 @@ function useDataFileCore({
             `Error saving data file to path: ${currentPath}`,
             "save",
             currentPath,
+            null,
             cause
           );
           onError?.(error);
-          if (state.current.path === currentPath && state.current.data === currentData) {
+          if (state.current.path === currentPath && state.current.saveChain === queuedSave) {
             state.current.state = { state: "error", error };
             updateDataFromState();
           }
@@ -152,8 +174,10 @@ function useDataFileCore({
         state: "saved"
       }
     };
+    let contents = null;
     fs.readFile(path, "utf8").then((data2) => {
-      const parsedData = schema.parse(JSON.parse(data2));
+      contents = data2;
+      const parsedData = schema.parse(JSON.parse(stripUtf8Bom(data2)));
       if (state.current.path === path) {
         state.current.data = parsedData;
         state.current.lastUpdatedMillis = Date.now();
@@ -182,6 +206,7 @@ function useDataFileCore({
         `Error loading data file at path: ${path}`,
         "load",
         path,
+        contents,
         err
       );
       onError?.(error);
@@ -190,25 +215,36 @@ function useDataFileCore({
       updateDataFromState();
     });
   }, [path, onPathChange]);
-  const updateData = useMemo(
-    () => (update) => {
+  const setDataTo = useMemo(
+    () => (data2) => {
       if (state.current.path !== path) {
         return;
       }
-      if (state.current.data === void 0) {
-        throw new Error("Attempt to update data before it has been loaded");
-      }
-      state.current.data = update(state.current.data);
+      state.current.data = data2;
       state.current.lastUpdatedMillis = Date.now();
       state.current.state = { state: "dirty" };
       saveData();
       updateDataFromState();
     },
-    [path]
+    [saveData, path]
+  );
+  const updateData = useMemo(
+    () => (update) => {
+      if (state.current.data === void 0) {
+        throw new Error("Attempt to update data before it has been loaded");
+      }
+      setDataTo(update(state.current.data));
+    },
+    [setDataTo]
+  );
+  const resetData = useMemo(
+    () => () => setDataTo(defaultValue),
+    [setDataTo, defaultValue]
   );
   return {
     data,
     updateData,
+    resetData,
     saveData
   };
 }
@@ -223,6 +259,9 @@ function createDataFileDefinition({
     updateData: () => {
       throw new Error("Data file provider not used");
     },
+    resetData: () => {
+      throw new Error("Data file provider not used");
+    },
     saveData: () => {
       throw new Error("Data file provider not used");
     },
@@ -245,7 +284,7 @@ function createDataFileDefinition({
     onError,
     children
   }) => {
-    const { data, updateData, saveData } = useDataFile2({
+    const { data, updateData, resetData, saveData } = useDataFile2({
       path,
       onPathChange,
       onError
@@ -256,6 +295,7 @@ function createDataFileDefinition({
         status: data.status,
         lastUpdatedMillis: data.lastUpdatedMillis,
         updateData,
+        resetData,
         saveData,
         error: data.status === "error" ? data.error : void 0
       }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcanejs/react-toolkit",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "private": false,
   "description": "Build web-accessible control interfaces for your long-running Node.js processes",
   "keywords": [