@ar.io/sdk 3.12.0-beta.2 → 3.12.0-beta.3

package/lib/cjs/common/wayfinder/index.js

@@ -35,6 +35,7 @@ __exportStar(require("./routing/strategies/random.js"), exports);
 __exportStar(require("./routing/strategies/static.js"), exports);
 __exportStar(require("./routing/strategies/ping.js"), exports);
 __exportStar(require("./routing/strategies/round-robin.js"), exports);
+__exportStar(require("./routing/strategies/preferred-with-fallback.js"), exports);
 // gateways providers
 __exportStar(require("./gateways/network.js"), exports);
 __exportStar(require("./gateways/simple-cache.js"), exports);

package/lib/cjs/common/wayfinder/routing/strategies/preferred-with-fallback.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PreferredWithFallbackRoutingStrategy = void 0;
+const logger_js_1 = require("../../../logger.js");
+const ping_js_1 = require("./ping.js");
+class PreferredWithFallbackRoutingStrategy {
+    name = 'preferred-with-fallback';
+    preferredGateway;
+    fallbackStrategy;
+    logger;
+    constructor({ preferredGateway, fallbackStrategy = new ping_js_1.FastestPingRoutingStrategy(), logger = logger_js_1.Logger.default, }) {
+        try {
+            this.preferredGateway = new URL(preferredGateway);
+        }
+        catch (error) {
+            throw new Error(`Invalid URL provided for preferred gateway: ${preferredGateway}`);
+        }
+        this.fallbackStrategy = fallbackStrategy;
+        this.logger = logger;
+    }
+    async selectGateway({ gateways = [] }) {
+        this.logger.debug('Attempting to connect to preferred gateway', {
+            preferredGateway: this.preferredGateway.toString(),
+        });
+        try {
+            // Check if the preferred gateway is responsive
+            const response = await fetch(this.preferredGateway.toString(), {
+                method: 'HEAD',
+                signal: AbortSignal.timeout(1000),
+            });
+            if (response.ok) {
+                this.logger.debug('Successfully connected to preferred gateway', {
+                    preferredGateway: this.preferredGateway.toString(),
+                });
+                return this.preferredGateway;
+            }
+            throw new Error(`Preferred gateway responded with status: ${response.status}`);
+        }
+        catch (error) {
+            this.logger.warn('Failed to connect to preferred gateway, falling back to alternative strategy', {
+                preferredGateway: this.preferredGateway.toString(),
+                error: error instanceof Error ? error.message : String(error),
+                fallbackStrategy: this.fallbackStrategy.constructor.name,
+            });
+            // Fall back to the provided routing strategy
+            return this.fallbackStrategy.selectGateway({ gateways });
+        }
+    }
+}
+exports.PreferredWithFallbackRoutingStrategy = PreferredWithFallbackRoutingStrategy;

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.12.0-beta.2';
+exports.version = '3.12.0-beta.3';

package/lib/esm/common/wayfinder/index.js

@@ -19,6 +19,7 @@ export * from './routing/strategies/random.js';
 export * from './routing/strategies/static.js';
 export * from './routing/strategies/ping.js';
 export * from './routing/strategies/round-robin.js';
+export * from './routing/strategies/preferred-with-fallback.js';
 // gateways providers
 export * from './gateways/network.js';
 export * from './gateways/simple-cache.js';

package/lib/esm/common/wayfinder/routing/strategies/preferred-with-fallback.js

@@ -0,0 +1,46 @@
+import { Logger } from '../../../logger.js';
+import { FastestPingRoutingStrategy } from './ping.js';
+export class PreferredWithFallbackRoutingStrategy {
+    name = 'preferred-with-fallback';
+    preferredGateway;
+    fallbackStrategy;
+    logger;
+    constructor({ preferredGateway, fallbackStrategy = new FastestPingRoutingStrategy(), logger = Logger.default, }) {
+        try {
+            this.preferredGateway = new URL(preferredGateway);
+        }
+        catch (error) {
+            throw new Error(`Invalid URL provided for preferred gateway: ${preferredGateway}`);
+        }
+        this.fallbackStrategy = fallbackStrategy;
+        this.logger = logger;
+    }
+    async selectGateway({ gateways = [] }) {
+        this.logger.debug('Attempting to connect to preferred gateway', {
+            preferredGateway: this.preferredGateway.toString(),
+        });
+        try {
+            // Check if the preferred gateway is responsive
+            const response = await fetch(this.preferredGateway.toString(), {
+                method: 'HEAD',
+                signal: AbortSignal.timeout(1000),
+            });
+            if (response.ok) {
+                this.logger.debug('Successfully connected to preferred gateway', {
+                    preferredGateway: this.preferredGateway.toString(),
+                });
+                return this.preferredGateway;
+            }
+            throw new Error(`Preferred gateway responded with status: ${response.status}`);
+        }
+        catch (error) {
+            this.logger.warn('Failed to connect to preferred gateway, falling back to alternative strategy', {
+                preferredGateway: this.preferredGateway.toString(),
+                error: error instanceof Error ? error.message : String(error),
+                fallbackStrategy: this.fallbackStrategy.constructor.name,
+            });
+            // Fall back to the provided routing strategy
+            return this.fallbackStrategy.selectGateway({ gateways });
+        }
+    }
+}

package/lib/esm/version.js

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '3.12.0-beta.2';
+export const version = '3.12.0-beta.3';

package/lib/types/common/wayfinder/index.d.ts

@@ -18,6 +18,7 @@ export * from './routing/strategies/random.js';
 export * from './routing/strategies/static.js';
 export * from './routing/strategies/ping.js';
 export * from './routing/strategies/round-robin.js';
+export * from './routing/strategies/preferred-with-fallback.js';
 export * from './gateways/network.js';
 export * from './gateways/simple-cache.js';
 export * from './gateways/static.js';

package/lib/types/common/wayfinder/routing/strategies/preferred-with-fallback.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright (C) 2022-2024 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 { RoutingStrategy } from '../../../../types/wayfinder.js';
+import { Logger } from '../../../logger.js';
+export declare class PreferredWithFallbackRoutingStrategy implements RoutingStrategy {
+    readonly name = "preferred-with-fallback";
+    private preferredGateway;
+    private fallbackStrategy;
+    private logger;
+    constructor({ preferredGateway, fallbackStrategy, logger, }: {
+        preferredGateway: string;
+        fallbackStrategy?: RoutingStrategy;
+        logger?: Logger;
+    });
+    selectGateway({ gateways }: {
+        gateways: URL[];
+    }): Promise<URL>;
+}

package/lib/types/version.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "3.12.0-beta.1";
+export declare const version = "3.12.0-beta.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.12.0-beta.2",
+  "version": "3.12.0-beta.3",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"