@audius/sdk 15.1.0 → 15.3.0

package/dist/sdk/types.d.ts

@@ -1,267 +0,0 @@
-import type { PublicClient, WalletClient } from 'viem';
-import { z } from 'zod';
-import type { OAuthTokenStore } from './oauth/tokenStore';
-import { AntiAbuseOracleService } from './services/AntiAbuseOracle/types';
-import type { AntiAbuseOracleSelectorService } from './services/AntiAbuseOracleSelector/types';
-import type { ArchiverService } from './services/Archiver';
-import type { AudiusWalletClient } from './services/AudiusWalletClient';
-import { EmailEncryptionService } from './services/Encryption';
-import type { EntityManagerService } from './services/EntityManager';
-import type { EthereumService } from './services/Ethereum';
-import type { LoggerService } from './services/Logger';
-import type { PaymentRouterClient, SolanaRelayService, SolanaWalletAdapter } from './services/Solana';
-import { ClaimableTokensClient } from './services/Solana/programs/ClaimableTokensClient';
-import { RewardManagerClient } from './services/Solana/programs/RewardManagerClient';
-import type { SolanaClient } from './services/Solana/programs/SolanaClient';
-import type { StorageService } from './services/Storage';
-import type { StorageNodeSelectorService } from './services/StorageNodeSelector';
-export type ServicesContainer = {
-    /**
-     * Service used to choose storage node
-     */
-    storageNodeSelector: StorageNodeSelectorService;
-    /**
-     * Service used to write and update entities on chain
-     */
-    entityManager?: EntityManagerService;
-    /**
-     * Service used to store and retrieve content e.g. tracks and images
-     */
-    storage: StorageService;
-    /**
-     * For interacting with the user or app's wallet for signatures or secrets.
-     */
-    audiusWalletClient: AudiusWalletClient;
-    /**
-     * Service used to log and set a desired log level
-     */
-    logger: LoggerService;
-    /**
-     * Service used to store OAuth access and refresh tokens.
-     * Defaults to `TokenStoreLocalStorage` which persists to localStorage.
-     * Override to use in-memory, cookie-based, or other storage strategies.
-     */
-    tokenStore: OAuthTokenStore;
-    /**
-     * Called with the OAuth URL when `login()` is invoked. Defaults to
-     * `window.open` (popup) or `window.location.href` (fullScreen) on web.
-     * Required on mobile — use `Linking.openURL` or a WebView.
-     */
-    openUrl?: (url: string) => void | Promise<void>;
-    /**
-     * Service used to interact with the Solana relay
-     */
-    solanaRelay: SolanaRelayService;
-    /**
-     * Service used to interact with the Solana wallet
-     */
-    solanaWalletAdapter: SolanaWalletAdapter;
-    /**
-     * Service used to interact with the Solana RPCs
-     */
-    solanaClient: SolanaClient;
-    /**
-     * Claimable Tokens Program client for Solana
-     */
-    claimableTokensClient: ClaimableTokensClient;
-    /**
-     * Payment Router Program client for Solana
-     */
-    paymentRouterClient: PaymentRouterClient;
-    /**
-     * Reward Manager Program client for Solana
-     */
-    rewardManagerClient: RewardManagerClient;
-    /**
-     * Service used to choose a healthy Anti Abuse Oracle
-     */
-    antiAbuseOracleSelector: AntiAbuseOracleSelectorService;
-    /**
-     * Service used to interact with Anti Abuse Oracle
-     */
-    antiAbuseOracle: AntiAbuseOracleService;
-    /**
-     * Service used to handle the encryption and decryption of emails, also used for the encryption needed to share emails between users
-     */
-    emailEncryptionService: EmailEncryptionService;
-    /**
-     * Service used to create and download track archives
-     */
-    archiverService?: ArchiverService;
-    /**
-     * Service for interacting with Audius Ethereum contracts.
-     * Exposes viem contract instances for all protocol contracts,
-     * with optional per-environment address overrides.
-     */
-    ethereum: EthereumService;
-    /**
-     * viem PublicClient for Ethereum reads.
-     */
-    ethPublicClient: PublicClient;
-    /**
-     * viem WalletClient for Ethereum writes.
-     */
-    ethWalletClient: WalletClient;
-};
-export declare const SdkConfigSchema: z.ZodUnion<[z.ZodObject<{
-    /**
-     * Your app name
-     */
-    appName: z.ZodOptional<z.ZodString>;
-    /**
-     * Services injection
-     */
-    services: z.ZodOptional<z.ZodType<Partial<ServicesContainer>, z.ZodTypeDef, Partial<ServicesContainer>>>;
-    /**
-     * API key, required for writes
-     */
-    apiKey: z.ZodString;
-    /**
-     * Default redirect URI used by `oauth.login()`. Can be overridden per-call.
-     */
-    redirectUri: z.ZodOptional<z.ZodString>;
-    /**
-     * Target environment
-     * @internal
-     */
-    environment: z.ZodOptional<z.ZodEnum<["development", "production"]>>;
-    /**
-     * Override API base URL (e.g. http://localhost:1323 for local dev). When set, all API and archive requests use this base.
-     */
-    apiEndpoint: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    apiKey: string;
-    appName?: string | undefined;
-    services?: Partial<ServicesContainer> | undefined;
-    redirectUri?: string | undefined;
-    environment?: "development" | "production" | undefined;
-    apiEndpoint?: string | undefined;
-}, {
-    apiKey: string;
-    appName?: string | undefined;
-    services?: Partial<ServicesContainer> | undefined;
-    redirectUri?: string | undefined;
-    environment?: "development" | "production" | undefined;
-    apiEndpoint?: string | undefined;
-}>, z.ZodObject<{
-    /**
-     * Your app name
-     */
-    appName: z.ZodOptional<z.ZodString>;
-    /**
-     * Services injection
-     */
-    services: z.ZodOptional<z.ZodType<Partial<ServicesContainer>, z.ZodTypeDef, Partial<ServicesContainer>>>;
-    /**
-     * API key
-     */
-    apiKey: z.ZodString;
-    /**
-     * API bearer token, required for writes that use the API
-     */
-    bearerToken: z.ZodString;
-    /**
-     * Default redirect URI used by `oauth.login()`. Can be overridden per-call.
-     */
-    redirectUri: z.ZodOptional<z.ZodString>;
-    /**
-     * Target environment
-     * @internal
-     */
-    environment: z.ZodOptional<z.ZodEnum<["development", "production"]>>;
-    apiEndpoint: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    apiKey: string;
-    bearerToken: string;
-    appName?: string | undefined;
-    services?: Partial<ServicesContainer> | undefined;
-    redirectUri?: string | undefined;
-    environment?: "development" | "production" | undefined;
-    apiEndpoint?: string | undefined;
-}, {
-    apiKey: string;
-    bearerToken: string;
-    appName?: string | undefined;
-    services?: Partial<ServicesContainer> | undefined;
-    redirectUri?: string | undefined;
-    environment?: "development" | "production" | undefined;
-    apiEndpoint?: string | undefined;
-}>, z.ZodObject<{
-    /**
-     * Your app name
-     */
-    appName: z.ZodString;
-    /**
-     * Services injection
-     */
-    services: z.ZodOptional<z.ZodType<Partial<ServicesContainer>, z.ZodTypeDef, Partial<ServicesContainer>>>;
-    /**
-     * Default redirect URI used by `oauth.login()`. Can be overridden per-call.
-     */
-    redirectUri: z.ZodOptional<z.ZodString>;
-    /**
-     * Target environment
-     * @internal
-     */
-    environment: z.ZodOptional<z.ZodEnum<["development", "production"]>>;
-    apiEndpoint: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    appName: string;
-    services?: Partial<ServicesContainer> | undefined;
-    redirectUri?: string | undefined;
-    environment?: "development" | "production" | undefined;
-    apiEndpoint?: string | undefined;
-}, {
-    appName: string;
-    services?: Partial<ServicesContainer> | undefined;
-    redirectUri?: string | undefined;
-    environment?: "development" | "production" | undefined;
-    apiEndpoint?: string | undefined;
-}>, z.ZodObject<{
-    /**
-     * Your app name
-     */
-    appName: z.ZodOptional<z.ZodString>;
-    /**
-     * Services injection
-     */
-    services: z.ZodOptional<z.ZodType<Partial<ServicesContainer>, z.ZodTypeDef, Partial<ServicesContainer>>>;
-    /**
-     * API key
-     */
-    apiKey: z.ZodOptional<z.ZodString>;
-    /**
-     * API secret, required for writes that use Entity Manager
-     */
-    apiSecret: z.ZodString;
-    /**
-     * Default redirect URI used by `oauth.login()`. Can be overridden per-call.
-     */
-    redirectUri: z.ZodOptional<z.ZodString>;
-    /**
-     * Target environment
-     * @internal
-     */
-    environment: z.ZodOptional<z.ZodEnum<["development", "production"]>>;
-    apiEndpoint: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    apiSecret: string;
-    appName?: string | undefined;
-    services?: Partial<ServicesContainer> | undefined;
-    apiKey?: string | undefined;
-    redirectUri?: string | undefined;
-    environment?: "development" | "production" | undefined;
-    apiEndpoint?: string | undefined;
-}, {
-    apiSecret: string;
-    appName?: string | undefined;
-    services?: Partial<ServicesContainer> | undefined;
-    apiKey?: string | undefined;
-    redirectUri?: string | undefined;
-    environment?: "development" | "production" | undefined;
-    apiEndpoint?: string | undefined;
-}>]>;
-/**
- * Config for SDK initialization. Requires at least an app name or API key for read-only access, and API secret or bearer token for write access.
- */
-export type SdkConfig = z.infer<typeof SdkConfigSchema>;

package/dist/sdk/utils/EventEmitterTarget.d.ts

@@ -1,6 +0,0 @@
-import type { EventMap } from 'typed-emitter';
-import type TypedEventEmitter from 'typed-emitter';
-export type EventEmitterTarget<T extends EventMap> = {
-    addEventListener: TypedEventEmitter<T>['addListener'];
-    removeEventListener: TypedEventEmitter<T>['removeListener'];
-};

package/dist/sdk/utils/apiKey.d.ts

@@ -1 +0,0 @@
-export declare const isApiKeyValid: (apiKey: string) => boolean;

package/dist/sdk/utils/cid.d.ts

@@ -1,2 +0,0 @@
-import { CID } from 'multiformats/cid';
-export declare const generateMetadataCidV1: (metadata: {}) => Promise<CID>;

package/dist/sdk/utils/crypto.d.ts

@@ -1,26 +0,0 @@
-export declare class CryptoUtils {
-    /**
-     * Encrypts data using AES with the last 32 bytes of the secret
-     * @param secret The secret key for encryption
-     * @param payload The data to encrypt
-     */
-    static encrypt(secret: Uint8Array, payload: Uint8Array): Promise<Uint8Array>;
-    /**
-     * Encrypts a string using AES with the last 32 bytes of the secret
-     * @param secret The secret key for encryption
-     * @param payload The string to encrypt
-     */
-    static encryptString(secret: Uint8Array, payload: string): Promise<Uint8Array>;
-    /**
-     * Decrypts data using AES with the last 32 bytes of the secret
-     * @param secret The secret key for decryption
-     * @param payload The data to decrypt
-     */
-    static decrypt(secret: Uint8Array, payload: Uint8Array): Promise<Uint8Array>;
-    /**
-     * Decrypts data and converts it to a string using AES with the last 32 bytes of the secret
-     * @param secret The secret key for decryption
-     * @param payload The data to decrypt
-     */
-    static decryptString(secret: Uint8Array, payload: Uint8Array): Promise<string>;
-}

package/dist/sdk/utils/deepPartial.d.ts

@@ -1,3 +0,0 @@
-export type DeepPartial<T> = T extends any[] ? T : T extends Set<any> ? T : T extends object ? {
-    [P in keyof T]?: DeepPartial<T[P]>;
-} : T;

package/dist/sdk/utils/errors.d.ts

@@ -1,8 +0,0 @@
-export declare class MissingOtpUserAuthError extends Error {
-    constructor(message: string);
-}
-export declare class AntiAbuseOracleAttestationError extends Error {
-    code: number;
-    name: string;
-    constructor(code: number, message: string);
-}

package/dist/sdk/utils/fetch.d.ts

@@ -1,16 +0,0 @@
-declare const fetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
-export declare const Headers: {
-    new (init?: HeadersInit | undefined): Headers;
-    prototype: Headers;
-};
-export declare const Request: {
-    new (input: RequestInfo | URL, init?: RequestInit | undefined): Request;
-    prototype: Request;
-};
-export declare const Response: {
-    new (body?: BodyInit | null | undefined, init?: ResponseInit | undefined): Response;
-    prototype: Response;
-    error(): Response;
-    redirect(url: string | URL, status?: number | undefined): Response;
-};
-export default fetch;

package/dist/sdk/utils/getPathFromUrl.d.ts

@@ -1,4 +0,0 @@
-/**
- * Extracts the path of a URL with query parameters. Platform agnostic.
- */
-export declare const getPathFromUrl: (url: string) => string;

package/dist/sdk/utils/hashId.d.ts

@@ -1,8 +0,0 @@
-/**
- * Decodes a string id into an int. Returns null if an invalid ID.
- */
-export declare const decodeHashId: (id: string) => number | null;
-/**
- * Encodes an int to a string based hashid
- */
-export declare const encodeHashId: (id: number | null) => string | null;

package/dist/sdk/utils/hashId.test.d.ts

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

package/dist/sdk/utils/localStorage.d.ts

@@ -1,6 +0,0 @@
-import type { LocalStorage } from '@audius/hedgehog';
-/**
- * Fallback for localStorage that works in node and the browser
- * @returns localStorage
- */
-export declare const getPlatformLocalStorage: () => Promise<LocalStorage>;

package/dist/sdk/utils/location.d.ts

@@ -1,16 +0,0 @@
-import { LoggerService } from '../services';
-type Location = {
-    city: string;
-    region: string;
-    country: string;
-};
-/**
- * Helper to get location. Intended for client-side use only from unique
- * requesters.
- * @param logger
- * @returns { city, region, country}
- */
-export declare const getLocation: ({ logger }?: {
-    logger?: LoggerService | undefined;
-}) => Promise<Location | null>;
-export {};

package/dist/sdk/utils/mergeConfigs.d.ts

@@ -1,7 +0,0 @@
-/**
- * Gets the config with any undefined properties replaced by the defaults
- * @param config the config
- * @param defaults the defaults
- * @returns the merged config with defaults
- */
-export declare const mergeConfigWithDefaults: <T, K>(config: T, defaults: K) => {} & K & T;

package/dist/sdk/utils/mergeConfigs.test.d.ts

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

package/dist/sdk/utils/oauthScope.d.ts

@@ -1 +0,0 @@
-export declare const isOAuthScopeValid: (scope: string[]) => boolean;

package/dist/sdk/utils/object.d.ts

@@ -1,4 +0,0 @@
-/**
- * Return properties from a list for which the object is missing values
- */
-export declare const objectMissingValues: (object: Record<string, any>, properties: string[]) => string[];

package/dist/sdk/utils/parseMint.d.ts

@@ -1,10 +0,0 @@
-import { PublicKey } from '@solana/web3.js';
-import { TokenName } from '../services';
-/**
- * Helper function to get both the token and mint address from one or the other.
- * @param mintOrToken either the name of the token ('USDC') or its mint address
- * @param mints a mapping of tokens to mint addresses
- * @returns the mint address and token name
- * @throws if the token isn't in the mint map
- */
-export declare const parseMint: (mintOrToken: PublicKey | TokenName, mints: Partial<Record<TokenName, PublicKey>>) => PublicKey;

package/dist/sdk/utils/parseParams.d.ts

@@ -1,13 +0,0 @@
-import type { ZodError, z } from 'zod';
-export declare class ParseRequestError extends Error {
-    method: string;
-    innerError: ZodError;
-    name: "ParseRequestError";
-    constructor(method: string, innerError: ZodError);
-}
-/**
- * @param name Name of the method for which the parameters are being parsed
- * @param schema Zod schema that defines the shape of the request parameters
- * @returns The parsed data or throws an error
- */
-export declare const parseParams: <T extends z.ZodType<any, z.ZodTypeDef, any>>(name: string, schema: T) => <J>(params: J) => Promise<z.TypeOf<T>>;

package/dist/sdk/utils/preparePaymentSplits.d.ts

@@ -1,19 +0,0 @@
-import { ExtendedPaymentSplit } from '../api/generated/default';
-import { LoggerService } from '../services';
-import { ClaimableTokensClient } from '../services/Solana/programs/ClaimableTokensClient';
-/**
- * 1. Converts amounts to bigints
- * 2. Spreads the extraAmount to each split
- * 3. Creates user banks for recipients as necessary
- * 4. Returns a simplified splits structure, a list of account/amount pairs
- */
-export declare const prepareSplits: ({ splits, extraAmount, claimableTokensClient, logger }: {
-    splits: ExtendedPaymentSplit[];
-    extraAmount: bigint;
-    includeNetworkCut?: boolean | undefined;
-    claimableTokensClient: ClaimableTokensClient;
-    logger: LoggerService;
-}) => Promise<{
-    wallet: string;
-    amount: bigint;
-}[]>;

package/dist/sdk/utils/prettify.d.ts

@@ -1,3 +0,0 @@
-export type Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};

package/dist/sdk/utils/promiseAny.d.ts

@@ -1,6 +0,0 @@
-/**
- * Polyfill for Promise.any
- * Adapted from Sergio Tskhovrebov's implementation:
- * https://dev.to/sinxwal/looking-for-promise-any-let-s-quickly-implement-a-polyfill-for-it-1kga
- */
-export declare const promiseAny: <T>(iterable: Iterable<T | PromiseLike<T>>) => Promise<T>;

package/dist/sdk/utils/reactionsMap.d.ts

@@ -1,11 +0,0 @@
-export declare const reactionsMap: {
-    readonly '\uD83D\uDE0D': 1;
-    readonly '\uD83D\uDD25': 2;
-    readonly '\uD83E\uDD73': 3;
-    readonly '\uD83E\uDD2F': 4;
-};
-type ReactionTypes = keyof typeof reactionsMap;
-/** use overloads to be able to use same function with the two different types */
-export declare function getReaction(reaction: number): ReactionTypes | undefined;
-export declare function getReaction(reaction: ReactionTypes): number | undefined;
-export {};

package/dist/sdk/utils/rendezvous.d.ts

@@ -1,12 +0,0 @@
-/**
- * TypeScript equivalent of https://github.com/tysonmote/rendezvous/blob/be0258dbbd3d/rendezvous.go
- */
-export declare class RendezvousHash {
-    private readonly nodes;
-    constructor(...nodes: string[]);
-    add(...nodes: string[]): void;
-    getNodes(): string[];
-    get(key: string): string;
-    getN(n: number, key: string): string[];
-    rendezvous256(key: string): string[];
-}

package/dist/sdk/utils/retry.d.ts

@@ -1,4 +0,0 @@
-/**
- * Calls fn and then retries once after 500ms, again after 1500ms, and again after 4000ms
- */
-export declare const retry3: <ReturnType_1>(fn: () => ReturnType_1, onRetry?: (_err: any) => void) => Promise<ReturnType_1>;

package/dist/sdk/utils/signatureSchemas.d.ts

@@ -1,54 +0,0 @@
-export declare const getNonce: () => Promise<`0x${string}`>;
-export declare const generators: {
-    getManageEntityData: (chainId: number, contractAddress: string, userId: number, entityType: string, entityId: number, action: string, metadata: string, nonce: string) => {
-        types: {
-            readonly EIP712Domain: readonly [{
-                readonly name: "name";
-                readonly type: "string";
-            }, {
-                readonly name: "version";
-                readonly type: "string";
-            }, {
-                readonly name: "chainId";
-                readonly type: "uint256";
-            }, {
-                readonly name: "verifyingContract";
-                readonly type: "address";
-            }];
-            readonly ManageEntity: readonly [{
-                readonly name: "userId";
-                readonly type: "uint";
-            }, {
-                readonly name: "entityType";
-                readonly type: "string";
-            }, {
-                readonly name: "entityId";
-                readonly type: "uint";
-            }, {
-                readonly name: "action";
-                readonly type: "string";
-            }, {
-                readonly name: "metadata";
-                readonly type: "string";
-            }, {
-                readonly name: "nonce";
-                readonly type: "bytes32";
-            }];
-        };
-        domain: {
-            name: string;
-            version: string;
-            chainId: bigint;
-            verifyingContract: string;
-        };
-        primaryType: "ManageEntity";
-        message: {
-            userId: number;
-            entityType: string;
-            entityId: number;
-            action: string;
-            metadata: string;
-            nonce: string;
-        };
-    };
-};

package/dist/sdk/utils/uuid.d.ts

@@ -1 +0,0 @@
-export declare const uuid: () => string;

package/dist/sdk/utils/wait.d.ts

@@ -1 +0,0 @@
-export declare const wait: (milliseconds: number) => Promise<void>;