@ar.io/sdk 3.10.0-alpha.6 → 3.10.1

package/lib/types/common/wayfinder/routers/priority.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/common/wayfinder/routers/random.d.ts

@@ -1,28 +0,0 @@
-/// <reference types="node" />
-/**
- * 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 { WayfinderRouter } from '../../../types/wayfinder.js';
-import { GatewaysProvider } from '../gateways.js';
-export declare class RandomGatewayRouter implements WayfinderRouter {
-    readonly name = "random";
-    private gatewaysProvider;
-    private blocklist;
-    constructor({ gatewaysProvider, blocklist, }: {
-        gatewaysProvider: GatewaysProvider;
-        blocklist?: string[];
-    });
-    getTargetGateway(): Promise<URL>;
-}

package/lib/types/common/wayfinder/routers/random.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/common/wayfinder/routers/simple-cache.d.ts

@@ -1,29 +0,0 @@
-/// <reference types="node" />
-/**
- * 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 { WayfinderRouter } from '../../../types/wayfinder.js';
-export declare class SimpleCacheRouter implements WayfinderRouter {
-    readonly name: 'simple-cache';
-    private lastUpdatedTimestamp;
-    private ttlSeconds;
-    private targetGateway;
-    private router;
-    constructor({ router, ttlSeconds, }: {
-        router: WayfinderRouter;
-        ttlSeconds?: number;
-    });
-    getTargetGateway(): Promise<URL>;
-}

package/lib/types/common/wayfinder/routers/simple-cache.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,106 +0,0 @@
-/// <reference types="node" />
-import { WayfinderRouter } from '../../types/wayfinder.js';
-type AnyFunction = (...args: [string, ...unknown[]]) => unknown;
-type WayfinderHttpClient<T extends AnyFunction> = T;
-export declare const arnsRegex: RegExp;
-export declare const txIdRegex: RegExp;
-/**
- * Cryptographically secure helper for randomness, does not support seeding
- * @param min - the minimum value
- * @param max - the maximum value
- * @returns a random integer between min and max
- */
-export declare const randomInt: (min: number, max: number) => number;
-/**
- * Core function to resolve a wayfinder url against a target gateway
- * @param originalUrl - the wayfinder url to resolve
- * @param targetGateway - the target gateway to resolve the url against
- * @returns the resolved url that can be used to make a request
- */
-export declare const resolveWayfinderUrl: ({ originalUrl, targetGateway, }: {
-    originalUrl: string | URL;
-    targetGateway: string | URL;
-}) => URL;
-/**
- * Creates a wrapped http client that supports ar:// protocol
- *
- * This function leverages a Proxy to intercept calls to the http client
- * and redirects them to the target gateway using the resolveUrl function url.
- * It also supports the http client methods like get(), post(), put(), delete(), etc.
- *
- * Any URLs provided that are not wayfinder urls will be returned as is.
- *
- * @param httpClient - the http client to wrap (e.g. axios, fetch, got, etc.)
- * @param resolveUrl - the function to construct the redirect url for ar:// requests
- * @returns a wrapped http client that supports ar:// protocol
- */
-export declare const createWayfinderClient: <T extends AnyFunction>({ httpClient, resolveUrl, }: {
-    httpClient: T;
-    resolveUrl: (params: {
-        originalUrl: string | URL;
-    }) => Promise<URL>;
-}) => WayfinderHttpClient<T>;
-/**
- * The main class for the wayfinder
- * @param router - the router to use for requests
- * @param httpClient - the http client to use for requests
- * @param blocklist - the blocklist of gateways to avoid
- */
-export declare class Wayfinder<T extends AnyFunction> {
-    /**
-     * The router to use for requests
-     *
-     * @example
-     * const wayfinder = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
-     * });
-     */
-    readonly router: WayfinderRouter;
-    /**
-     * The http client to use for requests
-     *
-     * @example
-     * const wayfinder = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
-     *   httpClient: axios,
-     * });
-     */
-    readonly httpClient: T;
-    /**
-     * The function that resolves the redirect url for ar:// requests to a target gateway
-     *
-     * @example
-     * const wayfinder = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
-     *   httpClient: axios,
-     * });
-     *
-     * const redirectUrl = await wayfinder.resolveUrl({ originalUrl: 'ar://example' });
-     */
-    readonly resolveUrl: (params: {
-        originalUrl: string;
-    }) => Promise<URL>;
-    /**
-     * A wrapped http client that supports ar:// protocol
-     *
-     * @example
-     * const { request: wayfind } = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
-     *   httpClient: axios,
-     * });;
-     *
-     * TODO: consider a top level function that supports wayfinder routing under the hood
-     * const response = await wayfind('ar://', {
-     *   method: 'POST',
-     *   data: {
-     *     name: 'John Doe',
-     *   },
-     * })
-     */
-    readonly request: WayfinderHttpClient<T>;
-    constructor({ router, httpClient, }: {
-        router: WayfinderRouter;
-        httpClient: T;
-    });
-}
-export {};

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,20 +0,0 @@
-/// <reference types="node" />
-/**
- * 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.
- */
-export interface WayfinderRouter {
-    readonly name: string;
-    getTargetGateway: () => Promise<URL>;
-}

package/lib/types/utils/url.d.ts

@@ -1,19 +0,0 @@
-/**
- * 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.
- */
-export declare const urlWithSearchParams: ({ baseUrl, params, }: {
-    baseUrl: string;
-    params: Record<string, string | number | boolean | null | undefined>;
-}) => string;

package/lib/types/utils/url.test.d.ts

@@ -1 +0,0 @@
-export {};