ropegeo-common 1.16.0 → 1.16.2

package/README.md

@@ -326,7 +326,7 @@ Legend entries for page minimaps are keyed objects (`legend` on `PageMiniMap`);
 
 | Name | Description | Import |
 | --- | --- | --- |
-| `RopeGeoDataLoader` | Single-request loader: `onlinePath` / `onlinePathParams`, optional `offlineData` (object or filesystem path + `readOfflineFile`), optional `timeoutAfterSeconds` and `isOnline`. Children receive `data`, `errors`, `timeoutCountdown` (numeric only while an online fetch is in flight, otherwise `null`), and `reload`. Reconnect refetch uses `dirtyWhileOffline` driven by a semantic key (no `refreshOnReconnect` prop). Also exports `Method`, `Service`, `SERVICE_BASE_URL`. | `import { RopeGeoDataLoader, Method, Service } from 'ropegeo-common/components'` |
+| `RopeGeoDataLoader` | Single-request loader: `onlinePath` / `onlinePathParams`, optional `offlineData` (`undefined` → fetch online; `null` → `data` null / loading-style, no fetch; `T` → use as `data`, no fetch), optional `timeoutAfterSeconds` and `isOnline`. Children receive `data`, `errors`, `timeoutCountdown` (numeric only while an online fetch is in flight, otherwise `null`), and `reload`. Reconnect refetch uses `dirtyWhileOffline` driven by a semantic key (no `refreshOnReconnect` prop). Also exports `Method`, `Service`, `SERVICE_BASE_URL`. | `import { RopeGeoDataLoader, Method, Service } from 'ropegeo-common/components'` |
 | `RopeGeoPagedDataLoader` | Cursor-paginated list: same networking props as above; children get `loadNextPage`, `loadingNextPage`, `morePages`, plus `data`, `errors`, `timeoutCountdown`, `reload`. | `import { RopeGeoPagedDataLoader } from 'ropegeo-common/components'` |
 | `RopeGeoProgressDataLoader` | Page-based “progress” fetch: batches additional pages until `total` is satisfied; children get `received`, `total`, `data`, `errors`, `timeoutCountdown`, `reload`. | `import { RopeGeoProgressDataLoader } from 'ropegeo-common/components'` |
 

package/dist/components/RopeGeoDataLoader.d.ts

@@ -31,15 +31,12 @@ export type RopeGeoDataLoaderProps<T = unknown> = {
      */
     isOnline?: boolean;
     /**
-     * Inline offline payload or filesystem path. When an object, it is used as `data` immediately
-     * (no network, no file read). When a string, `readOfflineFile` is invoked; on failure the error
-     * `Could not read file at {path}` is set and the loader falls back to {@link onlinePath} when online.
+     * Offline / local-first behavior without reading files inside the loader:
+     * - **`undefined`**: omit or leave unset — fetch from {@link onlinePath} as usual.
+     * - **`null`**: do not fetch; children receive `data: null` and `errors: null` (loading-style).
+     * - **`T`**: use as `data` immediately; no network.
      */
-    offlineData?: T | string;
-    /**
-     * Required when `offlineData` is a string. Reads file contents as UTF-8 text for JSON parsing.
-     */
-    readOfflineFile?: (path: string) => Promise<string>;
+    offlineData?: T | null;
     children: (args: {
         data: T | null;
         errors: Error | null;
@@ -52,5 +49,5 @@ export type RopeGeoDataLoaderProps<T = unknown> = {
         reload: () => void;
     }) => ReactNode;
 };
-export declare function RopeGeoDataLoader<T = unknown>({ service, method, onlinePath, onlinePathParams, queryParams, body, timeoutAfterSeconds, isOnline, offlineData, readOfflineFile, children, }: RopeGeoDataLoaderProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function RopeGeoDataLoader<T = unknown>({ service, method, onlinePath, onlinePathParams, queryParams, body, timeoutAfterSeconds, isOnline, offlineData, children, }: RopeGeoDataLoaderProps<T>): import("react/jsx-runtime").JSX.Element;
 //# sourceMappingURL=RopeGeoDataLoader.d.ts.map

package/dist/components/RopeGeoDataLoader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RopeGeoDataLoader.d.ts","sourceRoot":"","sources":["../../src/components/RopeGeoDataLoader.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAavC,eAAO,MAAM,OAAO;;CAEV,CAAC;AACX,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,OAAO,OAAO,CAAC,CAAC;AAE7D,eAAO,MAAM,MAAM;;;;;CAKT,CAAC;AACX,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,OAAO,MAAM,CAAC,CAAC;AAE1D,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAEpD,CAAC;AAqEF,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,OAAO,IAAI;IAChD,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,0FAA0F;IAC1F,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC;IACpE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC;IACzB;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IACpD,QAAQ,EAAE,CAAC,IAAI,EAAE;QACf,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;QACf,MAAM,EAAE,KAAK,GAAG,IAAI,CAAC;QACrB;;;WAGG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAChC,iFAAiF;QACjF,MAAM,EAAE,MAAM,IAAI,CAAC;KACpB,KAAK,SAAS,CAAC;CACjB,CAAC;AAEF,wBAAgB,iBAAiB,CAAC,CAAC,GAAG,OAAO,EAAE,EAC7C,OAAO,EACP,MAAM,EACN,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,IAAI,EACJ,mBAAmB,EACnB,QAAQ,EACR,WAAW,EACX,eAAe,EACf,QAAQ,GACT,EAAE,sBAAsB,CAAC,CAAC,CAAC,2CA+X3B"}
+{"version":3,"file":"RopeGeoDataLoader.d.ts","sourceRoot":"","sources":["../../src/components/RopeGeoDataLoader.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAavC,eAAO,MAAM,OAAO;;CAEV,CAAC;AACX,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,OAAO,OAAO,CAAC,CAAC;AAE7D,eAAO,MAAM,MAAM;;;;;CAKT,CAAC;AACX,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,OAAO,MAAM,CAAC,CAAC;AAE1D,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAEpD,CAAC;AAqEF,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,OAAO,IAAI;IAChD,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,0FAA0F;IAC1F,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC;IACpE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,CAAC,IAAI,EAAE;QACf,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;QACf,MAAM,EAAE,KAAK,GAAG,IAAI,CAAC;QACrB;;;WAGG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAChC,iFAAiF;QACjF,MAAM,EAAE,MAAM,IAAI,CAAC;KACpB,KAAK,SAAS,CAAC;CACjB,CAAC;AAEF,wBAAgB,iBAAiB,CAAC,CAAC,GAAG,OAAO,EAAE,EAC7C,OAAO,EACP,MAAM,EACN,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,IAAI,EACJ,mBAAmB,EACnB,QAAQ,EACR,WAAW,EACX,QAAQ,GACT,EAAE,sBAAsB,CAAC,CAAC,CAAC,2CAgU3B"}

package/dist/components/RopeGeoDataLoader.js

@@ -57,18 +57,16 @@ function dataLoaderReconnectSemanticKey(service, method, onlinePath, pathParamsK
 function offlineDataKeyPart(offlineData) {
     if (offlineData === undefined)
         return "";
-    if (typeof offlineData === "string")
-        return `|file:${offlineData}`;
+    if (offlineData === null)
+        return "|offline:null";
     return `|obj:${JSON.stringify(offlineData)}`;
 }
-function RopeGeoDataLoader({ service, method, onlinePath, onlinePathParams, queryParams, body, timeoutAfterSeconds, isOnline, offlineData, readOfflineFile, children, }) {
+function RopeGeoDataLoader({ service, method, onlinePath, onlinePathParams, queryParams, body, timeoutAfterSeconds, isOnline, offlineData, children, }) {
     const [data, setData] = (0, react_1.useState)(null);
     const [errors, setErrors] = (0, react_1.useState)(null);
     const [timeoutCountdown, setTimeoutCountdown] = (0, react_1.useState)(null);
     const [reloadTick, setReloadTick] = (0, react_1.useState)(0);
     const pendingReloadRef = (0, react_1.useRef)(false);
-    /** `null` = not using file path, `'pending'`, `'ok'`, `'failed'` */
-    const [offlineFileStatus, setOfflineFileStatus] = (0, react_1.useState)(null);
     const errorsRef = (0, react_1.useRef)(errors);
     const hasCommittedRef = (0, react_1.useRef)(false);
     errorsRef.current = errors;
@@ -108,61 +106,25 @@ function RopeGeoDataLoader({ service, method, onlinePath, onlinePathParams, quer
         setReloadTick((n) => n + 1);
     }, [isOnline]);
     const lastRequestKeyRef = (0, react_1.useRef)("");
-    /** Inline object offlineData — immediate, no network. */
+    /** Sync `data` from {@link offlineData} when it is `null` or `T`; `undefined` defers to the network effect. */
     (0, react_1.useEffect)(() => {
-        if (offlineData == null || typeof offlineData !== "object") {
+        if (offlineData === undefined) {
+            return;
+        }
+        if (offlineData === null) {
+            setData(null);
+            setErrors(null);
+            hasCommittedRef.current = false;
+            dirtyWhileOfflineRef.current = false;
+            semanticSnapshotRef.current = null;
             return;
         }
-        setOfflineFileStatus(null);
         setData(offlineData);
         setErrors(null);
         hasCommittedRef.current = true;
         dirtyWhileOfflineRef.current = false;
         semanticSnapshotRef.current = null;
     }, [offlineData]);
-    /** String path: read file, then maybe fall back to online. */
-    (0, react_1.useEffect)(() => {
-        if (typeof offlineData !== "string") {
-            setOfflineFileStatus(null);
-            return;
-        }
-        let cancelled = false;
-        setOfflineFileStatus("pending");
-        setData(null);
-        setErrors(null);
-        hasCommittedRef.current = false;
-        if (readOfflineFile == null) {
-            setErrors(new Error("readOfflineFile is required when offlineData is a filesystem path"));
-            setOfflineFileStatus("failed");
-            return;
-        }
-        void (async () => {
-            try {
-                const text = await readOfflineFile(offlineData);
-                const raw = JSON.parse(text);
-                const parsed = models_1.Result.fromResponseBody(raw);
-                if (!cancelled) {
-                    setData(parsed.result);
-                    setErrors(null);
-                    hasCommittedRef.current = true;
-                    setOfflineFileStatus("ok");
-                    dirtyWhileOfflineRef.current = false;
-                    semanticSnapshotRef.current = null;
-                }
-            }
-            catch {
-                if (!cancelled) {
-                    setErrors(new Error(`Could not read file at ${offlineData}`));
-                    setData(null);
-                    hasCommittedRef.current = false;
-                    setOfflineFileStatus("failed");
-                }
-            }
-        })();
-        return () => {
-            cancelled = true;
-        };
-    }, [offlineData, readOfflineFile]);
     (0, react_1.useEffect)(() => {
         const online = isOnline !== false;
         const prevOnline = prevIsOnlineRef.current;
@@ -178,19 +140,8 @@ function RopeGeoDataLoader({ service, method, onlinePath, onlinePathParams, quer
                 dirtyWhileOfflineRef.current = true;
             }
         }
-        /** Inline object: dedicated effect owns `data`; never hit the network here. */
-        if (offlineData != null && typeof offlineData === "object") {
-            prevIsOnlineRef.current = online;
-            return;
-        }
-        /** File path: wait for read outcome; `ok` keeps local data; only `failed` falls through to online fetch. */
-        if (typeof offlineData === "string" && offlineFileStatus === "ok") {
-            prevIsOnlineRef.current = online;
-            return;
-        }
-        if (typeof offlineData === "string" &&
-            offlineFileStatus !== "failed" &&
-            offlineFileStatus !== "ok") {
+        /** `offlineData` is `null` or `T`: own `data`; never hit the network here. */
+        if (offlineData !== undefined) {
             prevIsOnlineRef.current = online;
             return;
         }
@@ -366,7 +317,6 @@ function RopeGeoDataLoader({ service, method, onlinePath, onlinePathParams, quer
         requestKey,
         reloadTick,
         offlineData,
-        offlineFileStatus,
         reconnectSemanticKey,
         queryParams,
     ]);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ropegeo-common",
-    "version": "1.16.0",
+    "version": "1.16.2",
     "description": "Shared domain models and helpers for RopeGeo and WebScraper",
     "license": "ISC",
     "repository": {