@ardrive/turbo-sdk 1.0.0-alpha.8 → 1.0.0-beta.1

package/lib/cjs/utils/errors.d.ts

@@ -1,22 +0,0 @@
-/**
- * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-export declare class UnauthenticatedRequestError extends Error {
-    constructor();
-}
-export declare class FailedRequestError extends Error {
-    constructor(status: number, message: string);
-}

package/lib/esm/common/factory.d.ts

@@ -1,21 +0,0 @@
-/**
- * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-import { TurboPublicConfiguration } from '../types/turbo.js';
-import { TurboUnauthenticatedClient } from './turbo.js';
-export declare class TurboBaseFactory {
-    static unauthenticated({ paymentServiceConfig, uploadServiceConfig, }?: TurboPublicConfiguration): TurboUnauthenticatedClient;
-}

package/lib/esm/common/http.d.ts

@@ -1,44 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/**
- * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-import { AxiosInstance } from 'axios';
-import { RetryConfig } from 'retry-axios';
-import { Readable } from 'stream';
-import { ReadableStream } from 'stream/web';
-import { TurboHTTPServiceInterface, TurboSignedRequestHeaders } from '../types/turbo.js';
-export declare class TurboHTTPService implements TurboHTTPServiceInterface {
-    protected axios: AxiosInstance;
-    constructor({ url, retryConfig, }: {
-        url: string;
-        retryConfig?: RetryConfig;
-    });
-    get<T>({ endpoint, signal, allowedStatuses, headers, }: {
-        endpoint: string;
-        signal?: AbortSignal;
-        allowedStatuses?: number[];
-        headers?: Partial<TurboSignedRequestHeaders> & Record<string, string>;
-    }): Promise<T>;
-    post<T>({ endpoint, signal, allowedStatuses, headers, data, }: {
-        endpoint: string;
-        signal?: AbortSignal;
-        allowedStatuses?: number[];
-        headers?: Partial<TurboSignedRequestHeaders> & Record<string, string>;
-        data: Readable | Buffer | ReadableStream;
-    }): Promise<T>;
-}

package/lib/esm/common/turbo.d.ts

@@ -1,73 +0,0 @@
-/**
- * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-import { Currency, TurboAbortSignal, TurboAuthenticatedClientInterface, TurboAuthenticatedPaymentServiceInterface, TurboAuthenticatedUploadServiceInterface, TurboBalanceResponse, TurboCountriesResponse, TurboCurrenciesResponse, TurboFiatToArResponse, TurboFileFactory, TurboPriceResponse, TurboPrivateClientConfiguration, TurboPublicClientConfiguration, TurboRatesResponse, TurboSignedDataItemFactory, TurboUnauthenticatedClientInterface, TurboUnauthenticatedPaymentServiceInterface, TurboUnauthenticatedUploadServiceInterface, TurboUploadDataItemResponse } from '../types/index.js';
-export declare class TurboUnauthenticatedClient implements TurboUnauthenticatedClientInterface {
-    protected readonly paymentService: TurboUnauthenticatedPaymentServiceInterface;
-    protected readonly uploadService: TurboUnauthenticatedUploadServiceInterface;
-    constructor({ uploadService, paymentService, }: TurboPublicClientConfiguration);
-    /**
-     * Returns the supported fiat currency conversion rate for 1AR based on current market prices.
-     */
-    getFiatToAR({ currency, }: {
-        currency: Currency;
-    }): Promise<TurboFiatToArResponse>;
-    /**
-     * Returns the latest conversion rates to purchase 1GiB of data for all supported currencies, including all adjustments and fees.
-     *
-     * Note: this does not take into account varying adjustments and promotions for different sizes of data. If you want to calculate the total
-     * cost in 'winc' for a given number of bytes, use getUploadCosts.
-     */
-    getFiatRates(): Promise<TurboRatesResponse>;
-    /**
-     * Returns a comprehensive list of supported countries that can purchase credits through the Turbo Payment Service.
-     */
-    getSupportedCountries(): Promise<TurboCountriesResponse>;
-    /**
-     * Returns a list of all supported fiat currencies.
-     */
-    getSupportedCurrencies(): Promise<TurboCurrenciesResponse>;
-    /**
-     * Determines the price in 'winc' to upload one data item of a specific size in bytes, including all Turbo cost adjustments and fees.
-     */
-    getUploadCosts({ bytes, }: {
-        bytes: number[];
-    }): Promise<TurboPriceResponse[]>;
-    /**
-     * Determines the amount of 'winc' that would be returned for a given currency and amount, including all Turbo cost adjustments and fees.
-     */
-    getWincForFiat({ amount, currency, }: {
-        amount: number;
-        currency: Currency;
-    }): Promise<Omit<TurboPriceResponse, 'adjustments'>>;
-    /**
-     * Uploads a signed data item to the Turbo Upload Service.
-     */
-    uploadSignedDataItem({ dataItemStreamFactory, signal, }: TurboSignedDataItemFactory & TurboAbortSignal): Promise<TurboUploadDataItemResponse>;
-}
-export declare class TurboAuthenticatedClient extends TurboUnauthenticatedClient implements TurboAuthenticatedClientInterface {
-    protected readonly paymentService: TurboAuthenticatedPaymentServiceInterface;
-    protected readonly uploadService: TurboAuthenticatedUploadServiceInterface;
-    constructor({ paymentService, uploadService, }: TurboPrivateClientConfiguration);
-    /**
-     * Returns the current balance of the user's wallet in 'winc'.
-     */
-    getBalance(): Promise<TurboBalanceResponse>;
-    /**
-     * Signs and uploads raw data to the Turbo Upload Service.
-     */
-    uploadFile({ fileStreamFactory, signal, }: TurboFileFactory & TurboAbortSignal): Promise<TurboUploadDataItemResponse>;
-}

package/lib/esm/node/signer.d.ts

@@ -1,36 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-/**
- * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-import { ArweaveSigner } from 'arbundles';
-import { Readable } from 'node:stream';
-import { JWKInterface } from '../types/arweave.js';
-import { TurboWalletSigner } from '../types/turbo.js';
-export declare class TurboNodeArweaveSigner implements TurboWalletSigner {
-    protected privateKey: JWKInterface;
-    protected signer: ArweaveSigner;
-    constructor({ privateKey }: {
-        privateKey: JWKInterface;
-    });
-    signDataItem({ fileStreamFactory, }: {
-        fileStreamFactory: () => Readable;
-    }): Promise<Readable>;
-    generateSignedRequestHeaders(): Promise<{
-        'x-public-key': string;
-        'x-nonce': string;
-        'x-signature': string;
-    }>;
-}

package/lib/esm/types/index.d.ts

@@ -1,18 +0,0 @@
-/**
- * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-export * from './arweave.js';
-export * from './turbo.js';

package/lib/esm/types/index.js

@@ -1,18 +0,0 @@
-/**
- * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-export * from './arweave.js';
-export * from './turbo.js';

package/lib/esm/types/turbo.d.ts

@@ -1,149 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/**
- * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-import { Readable } from 'node:stream';
-import { ReadableStream } from 'node:stream/web';
-import { RetryConfig } from 'retry-axios';
-import winston from 'winston';
-import { JWKInterface } from './arweave.js';
-export type Base64String = string;
-export type PublicArweaveAddress = Base64String;
-export type TransactionId = Base64String;
-export type UserAddress = string | PublicArweaveAddress;
-export type Currency = 'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'nzd' | 'jpy';
-export type Country = 'United States' | 'United Kingdom' | 'Canada';
-export type CurrencyLimit = {
-    minimumPaymentAmount: number;
-    maximumPaymentAmount: number;
-    suggestedPaymentAmount: number[];
-    zeroDecimalCurrency: boolean;
-};
-export type TurboPriceResponse = {
-    winc: string;
-    adjustments: any;
-};
-export type TurboBalanceResponse = Omit<TurboPriceResponse, 'adjustments'>;
-export type TurboFiatToArResponse = {
-    currency: Currency;
-    rate: number;
-};
-export type TurboRatesResponse = TurboPriceResponse & Record<'fiat', Record<Currency, number>>;
-export type TurboCountriesResponse = Country[];
-export type TurboCurrenciesResponse = {
-    supportedCurrencies: Currency[];
-    limits: Record<Currency, CurrencyLimit>;
-};
-export type TurboUploadDataItemResponse = {
-    dataCaches: string[];
-    fastFinalityIndexes: string[];
-    id: TransactionId;
-    owner: PublicArweaveAddress;
-};
-export type TurboWallet = JWKInterface;
-export type TurboSignedRequestHeaders = {
-    'x-public-key': string;
-    'x-nonce': string;
-    'x-signature': string;
-};
-type TurboAuthConfiguration = {
-    signer: TurboWalletSigner;
-};
-type TurboServiceConfiguration = {
-    url?: string;
-    retryConfig?: RetryConfig;
-    logger?: winston.Logger;
-};
-export type TurboUnauthenticatedUploadServiceInterfaceConfiguration = TurboServiceConfiguration;
-export type TurboAuthenticatedUploadServiceConfiguration = TurboUnauthenticatedUploadServiceInterfaceConfiguration & TurboAuthConfiguration;
-export type TurboUnauthenticatedPaymentServiceInterfaceConfiguration = TurboServiceConfiguration;
-export type TurboAuthenticatedPaymentServiceInterfaceConfiguration = TurboServiceConfiguration & TurboAuthConfiguration;
-export type TurboPublicConfiguration = {
-    paymentServiceConfig?: TurboUnauthenticatedPaymentServiceInterfaceConfiguration;
-    uploadServiceConfig?: TurboUnauthenticatedUploadServiceInterfaceConfiguration;
-};
-export type TurboPrivateConfiguration = TurboPublicConfiguration & {
-    privateKey: TurboWallet;
-};
-export type TurboPublicClientConfiguration = {
-    paymentService: TurboUnauthenticatedPaymentServiceInterface;
-    uploadService: TurboUnauthenticatedUploadServiceInterface;
-};
-export type TurboPrivateClientConfiguration = {
-    paymentService: TurboAuthenticatedPaymentServiceInterface;
-    uploadService: TurboAuthenticatedUploadServiceInterface;
-};
-export type FileStreamFactory = (() => Readable) | (() => ReadableStream) | (() => Buffer);
-export type SignedDataStreamFactory = FileStreamFactory;
-export type TurboFileFactory = {
-    fileStreamFactory: FileStreamFactory;
-};
-export type TurboSignedDataItemFactory = {
-    dataItemStreamFactory: SignedDataStreamFactory;
-};
-export type TurboAbortSignal = {
-    signal?: AbortSignal;
-};
-export interface TurboHTTPServiceInterface {
-    get<T>({ endpoint, signal, headers, allowedStatuses, }: {
-        endpoint: string;
-        signal?: AbortSignal;
-        headers?: Partial<TurboSignedRequestHeaders> & Record<string, string>;
-        allowedStatuses?: number[];
-    }): Promise<T>;
-    post<T>({ endpoint, signal, headers, allowedStatuses, data, }: {
-        endpoint: string;
-        signal: AbortSignal;
-        headers?: Partial<TurboSignedRequestHeaders> & Record<string, string>;
-        allowedStatuses?: number[];
-        data: Readable | ReadableStream | Buffer;
-    }): Promise<T>;
-}
-export interface TurboWalletSigner {
-    signDataItem({ fileStreamFactory, }: TurboFileFactory): Promise<Readable> | Promise<Buffer>;
-    generateSignedRequestHeaders(): Promise<TurboSignedRequestHeaders>;
-}
-export interface TurboUnauthenticatedPaymentServiceInterface {
-    getSupportedCurrencies(): Promise<TurboCurrenciesResponse>;
-    getSupportedCountries(): Promise<TurboCountriesResponse>;
-    getFiatToAR({ currency, }: {
-        currency: Currency;
-    }): Promise<TurboFiatToArResponse>;
-    getFiatRates(): Promise<TurboRatesResponse>;
-    getWincForFiat({ amount, currency, }: {
-        amount: number;
-        currency: Currency;
-    }): Promise<Omit<TurboPriceResponse, 'adjustments'>>;
-    getUploadCosts({ bytes }: {
-        bytes: number[];
-    }): Promise<TurboPriceResponse[]>;
-}
-export interface TurboAuthenticatedPaymentServiceInterface extends TurboUnauthenticatedPaymentServiceInterface {
-    getBalance: () => Promise<TurboBalanceResponse>;
-}
-export interface TurboUnauthenticatedUploadServiceInterface {
-    uploadSignedDataItem({ dataItemStreamFactory, signal, }: TurboSignedDataItemFactory & TurboAbortSignal): Promise<TurboUploadDataItemResponse>;
-}
-export interface TurboAuthenticatedUploadServiceInterface extends TurboUnauthenticatedUploadServiceInterface {
-    uploadFile({ fileStreamFactory, }: TurboFileFactory & TurboAbortSignal): Promise<TurboUploadDataItemResponse>;
-}
-export interface TurboUnauthenticatedClientInterface extends TurboUnauthenticatedPaymentServiceInterface, TurboUnauthenticatedUploadServiceInterface {
-}
-export interface TurboAuthenticatedClientInterface extends TurboAuthenticatedPaymentServiceInterface, TurboAuthenticatedUploadServiceInterface {
-}
-export {};

package/lib/esm/utils/base64.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import { JWKInterface } from '../types/index.js';
-import { Base64String, PublicArweaveAddress } from '../types/index.js';
-export declare const base64URLRegex: RegExp;
-export declare function jwkToPublicArweaveAddress(jwk: JWKInterface): PublicArweaveAddress;
-export declare function ownerToAddress(owner: Base64String): PublicArweaveAddress;
-export declare function fromB64Url(input: Base64String): Buffer;
-export declare function toB64Url(buffer: Buffer): Base64String;
-export declare function sha256B64Url(input: Buffer): Base64String;

package/lib/esm/utils/readableStream.d.ts

@@ -1,22 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/**
- * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-import { ReadableStream } from 'node:stream/web';
-export declare function readableStreamToBuffer({ stream, }: {
-    stream: ReadableStream;
-}): Promise<Buffer>;

package/lib/esm/web/factory.d.ts

@@ -1,22 +0,0 @@
-/**
- * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-import { TurboBaseFactory } from '../common/factory.js';
-import { TurboAuthenticatedClient } from '../common/index.js';
-import { TurboPrivateConfiguration } from '../types/index.js';
-export declare class TurboFactory extends TurboBaseFactory {
-    static authenticated({ privateKey, paymentServiceConfig, uploadServiceConfig, }: TurboPrivateConfiguration): TurboAuthenticatedClient;
-}

package/lib/esm/web/index.d.ts

@@ -1,20 +0,0 @@
-/**
- * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-export * from './factory.js';
-export * from './signer.js';
-export * from '../common/index.js';
-export * from '../types/index.js';

package/lib/esm/web/signer.d.ts

@@ -1,37 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/**
- * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-import { ArweaveSigner } from 'arbundles';
-import { ReadableStream } from 'node:stream/web';
-import { JWKInterface } from '../types/arweave.js';
-import { TurboWalletSigner } from '../types/turbo.js';
-export declare class TurboWebArweaveSigner implements TurboWalletSigner {
-    protected privateKey: JWKInterface;
-    protected signer: ArweaveSigner;
-    constructor({ privateKey }: {
-        privateKey: JWKInterface;
-    });
-    signDataItem({ fileStreamFactory, }: {
-        fileStreamFactory: () => ReadableStream;
-    }): Promise<Buffer>;
-    generateSignedRequestHeaders(): Promise<{
-        'x-public-key': string;
-        'x-nonce': string;
-        'x-signature': string;
-    }>;
-}