@ar.io/wayfinder-react 0.0.5-alpha.4 → 0.0.5-alpha.6

package/README.md

@@ -23,10 +23,9 @@ yarn add @ar.io/wayfinder-react @ar.io/wayfinder-core
 ```jsx
 import {
   WayfinderProvider,
-  useWayfinder,
   useWayfinderRequest,
   useWayfinderUrl,
-  useWayfinderData,
+  LocalStorageGatewaysProvider,
 } from '@ar.io/wayfinder-react';
 import { NetworkGatewaysProvider } from '@ar.io/wayfinder-core';
 import { ARIO } from '@ar.io/sdk';
@@ -37,10 +36,13 @@ function App() {
     <WayfinderProvider
       // pass in the wayfinder options
       // https://github.com/ar-io/wayfinder/tree/alpha/packages/core#custom-configuration
-      gatewaysProvider={new NetworkGatewaysProvider({ 
-        ario: ARIO.mainnet() 
-        limit: 3,
-        sortBy: 'operatorStake',
+      gatewaysProvider={new LocalStorageGatewaysProvider({ 
+        ttlSeconds: 3600, // cache the gateways locally for 1 hour to avoid unnecessary network requests
+        gatewaysProvider: new NetworkGatewaysProvider({ 
+          ario: ARIO.mainnet() 
+          limit: 10,
+          sortBy: 'operatorStake',
+        }),
       })}
     >
       <YourApp />

package/dist/cache/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * WayFinder
+ * Copyright (C) 2022-2025 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './local-storage.js';

package/dist/cache/index.js

@@ -0,0 +1,17 @@
+/**
+ * WayFinder
+ * Copyright (C) 2022-2025 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './local-storage.js';

package/dist/cache/local-storage.d.ts

@@ -0,0 +1,32 @@
+/**
+ * WayFinder
+ * Copyright (C) 2022-2025 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { GatewaysProvider } from '@ar.io/wayfinder-core';
+export declare class LocalStorageGatewaysProvider implements GatewaysProvider {
+    private readonly storageKey;
+    private readonly defaultTtlSeconds;
+    private readonly gatewaysProvider;
+    private readonly ttlSeconds;
+    constructor({ ttlSeconds, gatewaysProvider, }: {
+        ttlSeconds?: number;
+        gatewaysProvider: GatewaysProvider;
+    });
+    getGateways(): Promise<URL[]>;
+    private getCachedGateways;
+    private isCacheValid;
+    private cacheGateways;
+    clearCache(): void;
+}

package/dist/cache/local-storage.js

@@ -0,0 +1,69 @@
+export class LocalStorageGatewaysProvider {
+    storageKey = 'wayfinder-gateways-cache';
+    defaultTtlSeconds = 3600; // 1 hour default
+    gatewaysProvider;
+    ttlSeconds;
+    constructor({ ttlSeconds = 300, gatewaysProvider, }) {
+        this.gatewaysProvider = gatewaysProvider;
+        this.ttlSeconds = ttlSeconds;
+        this.gatewaysProvider = gatewaysProvider;
+    }
+    async getGateways() {
+        const cached = this.getCachedGateways();
+        if (cached && this.isCacheValid(cached)) {
+            return cached.gateways;
+        }
+        const gateways = await this.gatewaysProvider.getGateways();
+        this.cacheGateways(gateways);
+        return gateways;
+    }
+    getCachedGateways() {
+        try {
+            if (typeof window === 'undefined' || !window.localStorage) {
+                return null;
+            }
+            const cached = window.localStorage.getItem(this.storageKey);
+            if (!cached) {
+                return null;
+            }
+            return JSON.parse(cached);
+        }
+        catch (error) {
+            console.warn('Failed to retrieve cached gateways:', error);
+            return null;
+        }
+    }
+    isCacheValid(cached) {
+        const now = Date.now();
+        const cacheAge = now - cached.timestamp;
+        const ttlMs = (cached.ttlSeconds || this.defaultTtlSeconds) * 1000;
+        return cacheAge < ttlMs;
+    }
+    cacheGateways(gateways) {
+        try {
+            if (typeof window === 'undefined' || !window.localStorage) {
+                return;
+            }
+            const cached = {
+                gateways,
+                timestamp: Date.now(),
+                ttlSeconds: this.ttlSeconds,
+            };
+            window.localStorage.setItem(this.storageKey, JSON.stringify(cached));
+        }
+        catch (error) {
+            console.warn('Failed to cache gateways:', error);
+        }
+    }
+    clearCache() {
+        try {
+            if (typeof window === 'undefined' || !window.localStorage) {
+                return;
+            }
+            window.localStorage.removeItem(this.storageKey);
+        }
+        catch (error) {
+            console.warn('Failed to clear gateway cache:', error);
+        }
+    }
+}

package/dist/index.d.ts

@@ -16,3 +16,4 @@
  */
 export * from './components/index.js';
 export * from './hooks/index.js';
+export * from './cache/index.js';

package/dist/index.js

@@ -16,3 +16,4 @@
  */
 export * from './components/index.js';
 export * from './hooks/index.js';
+export * from './cache/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/wayfinder-react",
-  "version": "0.0.5-alpha.4",
+  "version": "0.0.5-alpha.6",
   "description": "React components for WayFinder",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -10,7 +10,12 @@
   "publishConfig": {
     "access": "public"
   },
-  "files": ["dist", "package.json", "README.md", "LICENSE"],
+  "files": [
+    "dist",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ],
   "author": {
     "name": "Permanent Data Solutions Inc",
     "email": "info@ar.io",
@@ -30,7 +35,7 @@
     "format:check": "biome format"
   },
   "dependencies": {
-    "@ar.io/wayfinder-core": "0.0.5-alpha.3",
+    "@ar.io/wayfinder-core": "0.0.5-alpha.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },