@opendatalabs/vana-sdk 0.1.0-alpha.d7fc764 → 0.1.0-alpha.dc68f39

package/dist/types/data.d.ts

@@ -1,5 +1,4 @@
-import { Address, Hash } from 'viem';
-
+import type { Address, Hash } from "viem";
 /**
  * Represents a registered data file in the Vana network with complete blockchain metadata.
  *
@@ -12,7 +11,7 @@ import { Address, Hash } from 'viem';
  *
  * @category Data Management
  */
-interface UserFile {
+export interface UserFile {
     /** Unique identifier assigned by the Data Registry contract. */
     id: number;
     /** Storage URL where the encrypted file content is hosted. */
@@ -48,7 +47,7 @@ interface UserFile {
  * organization, validation, and display purposes.
  * @category Data Management
  */
-interface FileMetadata {
+export interface FileMetadata {
     /** Original filename as provided by the user or application. */
     name?: string;
     /** Total file size in bytes for storage tracking. */
@@ -113,7 +112,7 @@ interface FileMetadata {
  * ```
  * @category Data Management
  */
-interface UploadParams {
+export interface UploadParams {
     /** Raw file data as string, Blob, or Buffer. */
     content: string | Blob | Buffer;
     /** Optional filename for the uploaded file. */
@@ -137,7 +136,7 @@ interface UploadParams {
  * When encrypt is true, any permissions must include public keys for encryption.
  * @category Data Management
  */
-interface EncryptedUploadParams extends Omit<UploadParams, "permissions" | "encrypt"> {
+export interface EncryptedUploadParams extends Omit<UploadParams, "permissions" | "encrypt"> {
     /** File permissions with required public keys for encrypted data sharing. */
     permissions?: FilePermissionParams[];
     /** Encryption is enabled. */
@@ -150,7 +149,7 @@ interface EncryptedUploadParams extends Omit<UploadParams, "permissions" | "encr
  * This interface is used when uploading unencrypted data.
  * @category Data Management
  */
-interface UnencryptedUploadParams extends Omit<UploadParams, "encrypt"> {
+export interface UnencryptedUploadParams extends Omit<UploadParams, "encrypt"> {
     /** Encryption is disabled. */
     encrypt: false;
 }
@@ -177,7 +176,7 @@ interface UnencryptedUploadParams extends Omit<UploadParams, "encrypt"> {
  * ```
  * @category Data Management
  */
-interface FilePermissionParams {
+export interface FilePermissionParams {
     /** The account address that will be able to decrypt this file. */
     account: Address;
     /** The public key to encrypt the file's encryption key with. */
@@ -192,7 +191,7 @@ interface FilePermissionParams {
  *
  * @category Data Management
  */
-interface PermissionParams {
+export interface PermissionParams {
     /** The address of the application to grant permission to. */
     grantee: Address;
     /** The operation type (e.g., "llm_inference", "data_analysis", "compute_task"). */
@@ -223,7 +222,7 @@ interface PermissionParams {
  * @deprecated Removed in v2.0.0. Use FilePermissionParams for uploads.
  * @category Data Management
  */
-interface LegacyPermissionParams {
+export interface LegacyPermissionParams {
     grantee: Address;
     operation: string;
     parameters: Record<string, unknown>;
@@ -238,7 +237,7 @@ interface LegacyPermissionParams {
  * Returned by the `vana.data.upload()` method after successful upload and blockchain registration.
  * @category Data Management
  */
-interface UploadResult {
+export interface UploadResult {
     /** The file ID assigned by the DataRegistry contract. */
     fileId: number;
     /** The storage URL where the file is hosted. */
@@ -279,7 +278,7 @@ interface UploadResult {
  * ```
  * @category Data Management
  */
-interface UploadFileParams {
+export interface UploadFileParams {
     /** Raw file data in bytes, buffer, or string format. */
     content: Uint8Array | Buffer | string;
     /** Descriptive metadata for file organization and tracking. */
@@ -300,7 +299,7 @@ interface UploadFileParams {
  * and encryption details when applicable.
  * @category Data Management
  */
-interface UploadFileResult {
+export interface UploadFileResult {
     /** Public URL where the uploaded file can be accessed. */
     url: string;
     /** Actual file size in bytes after upload processing. */
@@ -315,7 +314,7 @@ interface UploadFileResult {
  *
  * @category Data Management
  */
-interface UploadEncryptedFileResult extends UploadFileResult {
+export interface UploadEncryptedFileResult extends UploadFileResult {
     /** The new file ID assigned by the DataRegistry */
     fileId: number;
     /** Transaction hash of the file registration */
@@ -326,7 +325,7 @@ interface UploadEncryptedFileResult extends UploadFileResult {
  *
  * @category Data Management
  */
-interface EncryptionInfo {
+export interface EncryptionInfo {
     /** Encryption algorithm used */
     algorithm: string;
     /** Key derivation function */
@@ -343,7 +342,7 @@ interface EncryptionInfo {
  *
  * @category Data Management
  */
-interface GetUserFilesParams {
+export interface GetUserFilesParams {
     /** Owner address to filter by */
     owner?: Address;
     /** Starting block number for filtering */
@@ -360,7 +359,7 @@ interface GetUserFilesParams {
  *
  * @category Data Management
  */
-interface GetFileParams {
+export interface GetFileParams {
     /** File ID to retrieve */
     fileId: number;
     /** Whether to include metadata */
@@ -371,7 +370,7 @@ interface GetFileParams {
  *
  * @category Data Management
  */
-interface DownloadFileParams {
+export interface DownloadFileParams {
     /** File URL or ID to download */
     file: string | number;
     /** Storage provider to use */
@@ -384,7 +383,7 @@ interface DownloadFileParams {
  *
  * @category Data Management
  */
-interface DownloadFileResult {
+export interface DownloadFileResult {
     /** File content */
     content: Uint8Array;
     /** File metadata */
@@ -397,7 +396,7 @@ interface DownloadFileResult {
  *
  * @category Data Management
  */
-interface DeleteFileParams {
+export interface DeleteFileParams {
     /** File ID to delete */
     fileId: number;
     /** Whether to also delete from storage */
@@ -410,7 +409,7 @@ interface DeleteFileParams {
  *
  * @category Data Management
  */
-interface DeleteFileResult {
+export interface DeleteFileResult {
     /** Whether the file was successfully deleted from the registry */
     registryDeleted: boolean;
     /** Whether the file was successfully deleted from storage */
@@ -418,12 +417,83 @@ interface DeleteFileResult {
     /** Transaction hash of the deletion */
     transactionHash?: Hash;
 }
+/**
+ * Options for encrypting a file
+ *
+ * @category Data Management
+ */
+export interface EncryptFileOptions {
+    /** Encryption seed for key derivation. Defaults to DEFAULT_ENCRYPTION_SEED */
+    seed?: string;
+    /** MIME type for the encrypted blob if input is not already a Blob */
+    mimeType?: string;
+}
+/**
+ * Result of encrypting a file
+ *
+ * @category Data Management
+ */
+export interface EncryptFileResult {
+    /** The encrypted data as a Blob */
+    encryptedData: Blob;
+    /** The encryption key used (derived from wallet) */
+    encryptionKey: string;
+}
+/**
+ * Options for decrypting a file
+ *
+ * @category Data Management
+ */
+export interface DecryptFileOptions {
+    /** Encryption seed for key derivation. Defaults to DEFAULT_ENCRYPTION_SEED */
+    seed?: string;
+}
+/**
+ * Parameters for uploading a file with permissions
+ *
+ * @category Data Management
+ */
+export interface UploadFileWithPermissionsParams {
+    /** The file data to encrypt and upload */
+    data: Blob;
+    /** Array of permissions to grant, each with account address and public key */
+    permissions: Array<{
+        account: Address;
+        publicKey: string;
+    }>;
+    /** Optional filename for the upload */
+    filename?: string;
+    /** Optional storage provider to use */
+    providerName?: string;
+}
+/**
+ * Parameters for adding permission to a file
+ *
+ * @category Data Management
+ */
+export interface AddFilePermissionParams {
+    /** The file ID to grant permission for */
+    fileId: number;
+    /** The account to grant permission to */
+    account: Address;
+    /** The public key of the account for encryption */
+    publicKey: string;
+}
+/**
+ * Options for decrypting a file with permission
+ *
+ * @category Data Management
+ */
+export interface DecryptFileWithPermissionOptions {
+    /** Optional account address to verify permission against */
+    account?: Address;
+}
 /**
  * File access permissions
  *
  * @category Data Management
  */
-interface FileAccessPermissions {
+export interface FileAccessPermissions {
     /** Whether the file can be read */
     read: boolean;
     /** Whether the file can be written */
@@ -438,7 +508,7 @@ interface FileAccessPermissions {
  *
  * @category Data Management
  */
-interface FileSharingConfig {
+export interface FileSharingConfig {
     /** Addresses that can access the file */
     allowedAddresses?: Address[];
     /** Expiration time for shared access */
@@ -451,7 +521,7 @@ interface FileSharingConfig {
  *
  * @category Data Management
  */
-interface BatchUploadParams {
+export interface BatchUploadParams {
     /** Array of files to upload */
     files: UploadFileParams[];
     /** Storage provider to use for all files */
@@ -466,7 +536,7 @@ interface BatchUploadParams {
  *
  * @category Data Management
  */
-interface BatchUploadResult {
+export interface BatchUploadResult {
     /** Results for each uploaded file */
     results: UploadEncryptedFileResult[];
     /** Overall success status */
@@ -482,7 +552,7 @@ interface BatchUploadResult {
  *
  * @category Data Management
  */
-interface SchemaMetadata {
+export interface SchemaMetadata {
     /** Schema ID */
     id: number;
     /** Schema name */
@@ -496,7 +566,7 @@ interface SchemaMetadata {
  * Complete schema with all definition fields populated.
  * This is what schemas.get() returns - a schema with the definition fetched.
  */
-interface CompleteSchema extends SchemaMetadata {
+export interface CompleteSchema extends SchemaMetadata {
     /** Version of the schema */
     version: string;
     /** Optional description of the schema */
@@ -544,7 +614,7 @@ interface CompleteSchema extends SchemaMetadata {
  * };
  * ```
  */
-interface Schema extends SchemaMetadata {
+export interface Schema extends SchemaMetadata {
     /** Version of the schema (present when definition is fetched) */
     version?: string;
     /** Optional description of the schema */
@@ -559,7 +629,7 @@ interface Schema extends SchemaMetadata {
  *
  * @category Data Management
  */
-interface Refiner {
+export interface Refiner {
     /** Refiner ID */
     id: number;
     /** DLP ID this refiner belongs to */
@@ -578,7 +648,7 @@ interface Refiner {
  *
  * @category Data Management
  */
-interface AddSchemaParams {
+export interface AddSchemaParams {
     /** Schema name */
     name: string;
     /** Schema dialect */
@@ -591,7 +661,7 @@ interface AddSchemaParams {
  *
  * @category Data Management
  */
-interface AddSchemaResult {
+export interface AddSchemaResult {
     /** The new schema ID assigned by the contract */
     schemaId: number;
     /** Transaction hash of the schema registration */
@@ -615,7 +685,7 @@ interface AddSchemaResult {
  * };
  * ```
  */
-interface AddRefinerParams {
+export interface AddRefinerParams {
     /** DLP ID this refiner belongs to */
     dlpId: number;
     /** Refiner name */
@@ -630,7 +700,7 @@ interface AddRefinerParams {
  *
  * @category Data Management
  */
-interface AddRefinerResult {
+export interface AddRefinerResult {
     /** The new refiner ID assigned by the contract */
     refinerId: number;
     /** Transaction hash of the refiner registration */
@@ -641,7 +711,7 @@ interface AddRefinerResult {
  *
  * @category Data Management
  */
-interface UpdateSchemaIdParams {
+export interface UpdateSchemaIdParams {
     /** Refiner ID to update */
     refinerId: number;
     /** New schema ID to associate with the refiner */
@@ -652,7 +722,7 @@ interface UpdateSchemaIdParams {
  *
  * @category Data Management
  */
-interface UpdateSchemaIdResult {
+export interface UpdateSchemaIdResult {
     /** Transaction hash of the update */
     transactionHash: Hash;
 }
@@ -661,7 +731,7 @@ interface UpdateSchemaIdResult {
  *
  * @category Data Management
  */
-interface TrustedServer {
+export interface TrustedServer {
     /** Unique identifier for the trusted server relationship */
     id: string;
     /** Server address (EVM address) */
@@ -680,7 +750,7 @@ interface TrustedServer {
  *
  * @category Data Management
  */
-interface GetUserTrustedServersParams {
+export interface GetUserTrustedServersParams {
     /** User address to query trusted servers for */
     user: Address;
     /** Optional subgraph URL to override default */
@@ -690,5 +760,3 @@ interface GetUserTrustedServersParams {
     /** Number of results to skip */
     offset?: number;
 }
-
-export type { AddRefinerParams, AddRefinerResult, AddSchemaParams, AddSchemaResult, BatchUploadParams, BatchUploadResult, CompleteSchema, DeleteFileParams, DeleteFileResult, DownloadFileParams, DownloadFileResult, EncryptedUploadParams, EncryptionInfo, FileAccessPermissions, FileMetadata, FilePermissionParams, FileSharingConfig, GetFileParams, GetUserFilesParams, GetUserTrustedServersParams, LegacyPermissionParams, PermissionParams, Refiner, Schema, SchemaMetadata, TrustedServer, UnencryptedUploadParams, UpdateSchemaIdParams, UpdateSchemaIdResult, UploadEncryptedFileResult, UploadFileParams, UploadFileResult, UploadParams, UploadResult, UserFile };

package/dist/types/external-apis.d.ts

@@ -7,9 +7,9 @@
  * Documentation: https://replicate.com/docs/reference/http
  */
 /** Status values for Replicate predictions */
-type ReplicateStatus = "starting" | "processing" | "succeeded" | "failed" | "canceled";
+export type ReplicateStatus = "starting" | "processing" | "succeeded" | "failed" | "canceled";
 /** Base Replicate API prediction response */
-interface ReplicateAPIResponse {
+export interface ReplicateAPIResponse {
     /** Unique identifier for the prediction */
     id: string;
     /** Model version identifier */
@@ -53,7 +53,7 @@ interface ReplicateAPIResponse {
  * Storage Provider API Types
  */
 /** Pinata IPFS upload response */
-interface PinataUploadResponse {
+export interface PinataUploadResponse {
     /** IPFS hash of the uploaded content */
     IpfsHash: string;
     /** Size of the pinned content in bytes */
@@ -64,7 +64,7 @@ interface PinataUploadResponse {
     isDuplicate?: boolean;
 }
 /** Pinata pin information */
-interface PinataPin {
+export interface PinataPin {
     /** IPFS hash */
     ipfs_pin_hash: string;
     /** Pin size in bytes */
@@ -82,7 +82,7 @@ interface PinataPin {
     };
 }
 /** Pinata list response */
-interface PinataListResponse {
+export interface PinataListResponse {
     /** Total count of pins */
     count: number;
     /** Array of pin information */
@@ -93,7 +93,7 @@ interface PinataListResponse {
  * Used for internal API routes in the demo application
  */
 /** Standard API response wrapper */
-interface APIResponse<T = unknown> {
+export interface APIResponse<T = unknown> {
     /** Whether the request was successful */
     success: boolean;
     /** Response data (if successful) */
@@ -120,7 +120,7 @@ interface APIResponse<T = unknown> {
  * }
  * ```
  */
-declare function isReplicateAPIResponse(value: unknown): value is ReplicateAPIResponse;
+export declare function isReplicateAPIResponse(value: unknown): value is ReplicateAPIResponse;
 /**
  * Validates whether a value is a valid APIResponse.
  *
@@ -140,7 +140,7 @@ declare function isReplicateAPIResponse(value: unknown): value is ReplicateAPIRe
  * }
  * ```
  */
-declare function isAPIResponse<T>(value: unknown): value is APIResponse<T>;
+export declare function isAPIResponse<T>(value: unknown): value is APIResponse<T>;
 /**
  * Utility Functions for Safe JSON Parsing
  */
@@ -162,7 +162,7 @@ declare function isAPIResponse<T>(value: unknown): value is APIResponse<T>;
  * }
  * ```
  */
-declare function safeParseJSON<T>(jsonString: string, typeGuard: (value: unknown) => value is T): T | null;
+export declare function safeParseJSON<T>(jsonString: string, typeGuard: (value: unknown) => value is T): T | null;
 /**
  * Parses Replicate API response output with type safety.
  *
@@ -181,6 +181,4 @@ declare function safeParseJSON<T>(jsonString: string, typeGuard: (value: unknown
  * }
  * ```
  */
-declare function parseReplicateOutput<T>(response: ReplicateAPIResponse, typeGuard: (value: unknown) => value is T): T | null;
-
-export { type APIResponse, type PinataListResponse, type PinataPin, type PinataUploadResponse, type ReplicateAPIResponse, type ReplicateStatus, isAPIResponse, isReplicateAPIResponse, parseReplicateOutput, safeParseJSON };
+export declare function parseReplicateOutput<T>(response: ReplicateAPIResponse, typeGuard: (value: unknown) => value is T): T | null;