@opendatalabs/vana-sdk 0.1.0-alpha.d44f792 → 0.1.0-alpha.d596df3

package/dist/platform/utils.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Platform detection and adapter utilities
+ *
+ * This module provides utilities for detecting the current runtime environment
+ * and creating appropriate platform adapters automatically.
+ */
+import type { VanaPlatformAdapter, PlatformType } from "./interface";
+/**
+ * Detects the current runtime environment
+ *
+ * @returns The detected platform type
+ */
+export declare function detectPlatform(): PlatformType;
+/**
+ * Creates the appropriate platform adapter based on the current environment
+ *
+ * @returns A platform adapter instance for the current environment
+ * @throws {Error} If platform adapters cannot be imported or created
+ */
+export declare function createPlatformAdapter(): Promise<VanaPlatformAdapter>;
+/**
+ * Creates a platform adapter for a specific platform type
+ *
+ * @param platformType - The platform type to create an adapter for
+ * @returns A platform adapter instance for the specified platform
+ * @throws {Error} If platform adapters cannot be imported or created
+ */
+export declare function createPlatformAdapterFor(platformType: PlatformType): Promise<VanaPlatformAdapter>;
+/**
+ * Checks if the current environment supports the given platform adapter
+ *
+ * @param platformType - The platform type to check
+ * @returns True if the platform is supported, false otherwise
+ */
+export declare function isPlatformSupported(platformType: PlatformType): boolean;
+/**
+ * Gets platform-specific capabilities
+ *
+ * @returns Object describing available platform capabilities
+ */
+export declare function getPlatformCapabilities(): {
+    platform: PlatformType;
+    crypto: {
+        webCrypto: false | SubtleCrypto;
+        nodeCrypto: string | false;
+    };
+    fetch: boolean;
+    streams: boolean;
+};

package/dist/platform/utils.js

@@ -0,0 +1,76 @@
+function detectPlatform() {
+  if (typeof process !== "undefined" && process.versions && process.versions.node) {
+    return "node";
+  }
+  if (typeof window !== "undefined" && typeof document !== "undefined") {
+    return "browser";
+  }
+  return "node";
+}
+async function createPlatformAdapter() {
+  const platform = detectPlatform();
+  try {
+    if (platform === "node") {
+      if (typeof window !== "undefined") {
+        throw new Error(
+          "NodePlatformAdapter is not available in browser environments. Use BrowserPlatformAdapter instead."
+        );
+      }
+      const moduleName = "./node";
+      const { NodePlatformAdapter } = await import(moduleName);
+      return new NodePlatformAdapter();
+    } else {
+      const { BrowserPlatformAdapter } = await import("./browser");
+      return new BrowserPlatformAdapter();
+    }
+  } catch (error) {
+    throw new Error(
+      `Failed to create platform adapter for ${platform}: ${error instanceof Error ? error.message : "Unknown error"}`
+    );
+  }
+}
+async function createPlatformAdapterFor(platformType) {
+  try {
+    if (platformType === "node") {
+      if (typeof window !== "undefined") {
+        throw new Error(
+          "NodePlatformAdapter is not available in browser environments. Use BrowserPlatformAdapter instead."
+        );
+      }
+      const moduleName = "./node";
+      const { NodePlatformAdapter } = await import(moduleName);
+      return new NodePlatformAdapter();
+    } else {
+      const { BrowserPlatformAdapter } = await import("./browser");
+      return new BrowserPlatformAdapter();
+    }
+  } catch (error) {
+    throw new Error(
+      `Failed to create platform adapter for ${platformType}: ${error instanceof Error ? error.message : "Unknown error"}`
+    );
+  }
+}
+function isPlatformSupported(platformType) {
+  const currentPlatform = detectPlatform();
+  return currentPlatform === platformType;
+}
+function getPlatformCapabilities() {
+  const platform = detectPlatform();
+  return {
+    platform,
+    crypto: {
+      webCrypto: typeof crypto !== "undefined" && crypto.subtle,
+      nodeCrypto: typeof process !== "undefined" && process.versions && process.versions.node
+    },
+    fetch: typeof fetch !== "undefined" || typeof globalThis.fetch !== "undefined",
+    streams: typeof ReadableStream !== "undefined"
+  };
+}
+export {
+  createPlatformAdapter,
+  createPlatformAdapterFor,
+  detectPlatform,
+  getPlatformCapabilities,
+  isPlatformSupported
+};
+//# sourceMappingURL=utils.js.map

package/dist/platform/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/platform/utils.ts"],"sourcesContent":["/**\n * Platform detection and adapter utilities\n *\n * This module provides utilities for detecting the current runtime environment\n * and creating appropriate platform adapters automatically.\n */\n\nimport type { VanaPlatformAdapter, PlatformType } from \"./interface\";\n\n/**\n * Detects the current runtime environment\n *\n * @returns The detected platform type\n */\nexport function detectPlatform(): PlatformType {\n  // Check for Node.js environment\n  if (\n    typeof process !== \"undefined\" &&\n    process.versions &&\n    process.versions.node\n  ) {\n    return \"node\";\n  }\n\n  // Check for browser environment\n  if (typeof window !== \"undefined\" && typeof document !== \"undefined\") {\n    return \"browser\";\n  }\n\n  // Default to Node.js if we can't determine (e.g., SSR environments)\n  return \"node\";\n}\n\n/**\n * Creates the appropriate platform adapter based on the current environment\n *\n * @returns A platform adapter instance for the current environment\n * @throws {Error} If platform adapters cannot be imported or created\n */\nexport async function createPlatformAdapter(): Promise<VanaPlatformAdapter> {\n  const platform = detectPlatform();\n\n  try {\n    if (platform === \"node\") {\n      // Check if we're in a browser environment\n      if (typeof window !== \"undefined\") {\n        throw new Error(\n          \"NodePlatformAdapter is not available in browser environments. Use BrowserPlatformAdapter instead.\",\n        );\n      }\n\n      // Use string concatenation to avoid static analysis\n      const moduleName = \"./node\";\n      const { NodePlatformAdapter } = await import(moduleName);\n      return new NodePlatformAdapter();\n    } else {\n      const { BrowserPlatformAdapter } = await import(\"./browser\");\n      return new BrowserPlatformAdapter();\n    }\n  } catch (error) {\n    throw new Error(\n      `Failed to create platform adapter for ${platform}: ${error instanceof Error ? error.message : \"Unknown error\"}`,\n    );\n  }\n}\n\n/**\n * Creates a platform adapter for a specific platform type\n *\n * @param platformType - The platform type to create an adapter for\n * @returns A platform adapter instance for the specified platform\n * @throws {Error} If platform adapters cannot be imported or created\n */\nexport async function createPlatformAdapterFor(\n  platformType: PlatformType,\n): Promise<VanaPlatformAdapter> {\n  try {\n    if (platformType === \"node\") {\n      // Check if we're in a browser environment\n      if (typeof window !== \"undefined\") {\n        throw new Error(\n          \"NodePlatformAdapter is not available in browser environments. Use BrowserPlatformAdapter instead.\",\n        );\n      }\n\n      // Use string concatenation to avoid static analysis\n      const moduleName = \"./node\";\n      const { NodePlatformAdapter } = await import(moduleName);\n      return new NodePlatformAdapter();\n    } else {\n      const { BrowserPlatformAdapter } = await import(\"./browser\");\n      return new BrowserPlatformAdapter();\n    }\n  } catch (error) {\n    throw new Error(\n      `Failed to create platform adapter for ${platformType}: ${error instanceof Error ? error.message : \"Unknown error\"}`,\n    );\n  }\n}\n\n/**\n * Checks if the current environment supports the given platform adapter\n *\n * @param platformType - The platform type to check\n * @returns True if the platform is supported, false otherwise\n */\nexport function isPlatformSupported(platformType: PlatformType): boolean {\n  const currentPlatform = detectPlatform();\n  return currentPlatform === platformType;\n}\n\n/**\n * Gets platform-specific capabilities\n *\n * @returns Object describing available platform capabilities\n */\nexport function getPlatformCapabilities() {\n  const platform = detectPlatform();\n\n  return {\n    platform,\n    crypto: {\n      webCrypto: typeof crypto !== \"undefined\" && crypto.subtle,\n      nodeCrypto:\n        typeof process !== \"undefined\" &&\n        process.versions &&\n        process.versions.node,\n    },\n    fetch:\n      typeof fetch !== \"undefined\" || typeof globalThis.fetch !== \"undefined\",\n    streams: typeof ReadableStream !== \"undefined\",\n  };\n}\n"],"mappings":"AAcO,SAAS,iBAA+B;AAE7C,MACE,OAAO,YAAY,eACnB,QAAQ,YACR,QAAQ,SAAS,MACjB;AACA,WAAO;AAAA,EACT;AAGA,MAAI,OAAO,WAAW,eAAe,OAAO,aAAa,aAAa;AACpE,WAAO;AAAA,EACT;AAGA,SAAO;AACT;AAQA,eAAsB,wBAAsD;AAC1E,QAAM,WAAW,eAAe;AAEhC,MAAI;AACF,QAAI,aAAa,QAAQ;AAEvB,UAAI,OAAO,WAAW,aAAa;AACjC,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAGA,YAAM,aAAa;AACnB,YAAM,EAAE,oBAAoB,IAAI,MAAM,OAAO;AAC7C,aAAO,IAAI,oBAAoB;AAAA,IACjC,OAAO;AACL,YAAM,EAAE,uBAAuB,IAAI,MAAM,OAAO,WAAW;AAC3D,aAAO,IAAI,uBAAuB;AAAA,IACpC;AAAA,EACF,SAAS,OAAO;AACd,UAAM,IAAI;AAAA,MACR,yCAAyC,QAAQ,KAAK,iBAAiB,QAAQ,MAAM,UAAU,eAAe;AAAA,IAChH;AAAA,EACF;AACF;AASA,eAAsB,yBACpB,cAC8B;AAC9B,MAAI;AACF,QAAI,iBAAiB,QAAQ;AAE3B,UAAI,OAAO,WAAW,aAAa;AACjC,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAGA,YAAM,aAAa;AACnB,YAAM,EAAE,oBAAoB,IAAI,MAAM,OAAO;AAC7C,aAAO,IAAI,oBAAoB;AAAA,IACjC,OAAO;AACL,YAAM,EAAE,uBAAuB,IAAI,MAAM,OAAO,WAAW;AAC3D,aAAO,IAAI,uBAAuB;AAAA,IACpC;AAAA,EACF,SAAS,OAAO;AACd,UAAM,IAAI;AAAA,MACR,yCAAyC,YAAY,KAAK,iBAAiB,QAAQ,MAAM,UAAU,eAAe;AAAA,IACpH;AAAA,EACF;AACF;AAQO,SAAS,oBAAoB,cAAqC;AACvE,QAAM,kBAAkB,eAAe;AACvC,SAAO,oBAAoB;AAC7B;AAOO,SAAS,0BAA0B;AACxC,QAAM,WAAW,eAAe;AAEhC,SAAO;AAAA,IACL;AAAA,IACA,QAAQ;AAAA,MACN,WAAW,OAAO,WAAW,eAAe,OAAO;AAAA,MACnD,YACE,OAAO,YAAY,eACnB,QAAQ,YACR,QAAQ,SAAS;AAAA,IACrB;AAAA,IACA,OACE,OAAO,UAAU,eAAe,OAAO,WAAW,UAAU;AAAA,IAC9D,SAAS,OAAO,mBAAmB;AAAA,EACrC;AACF;","names":[]}

package/dist/platform/utils.test.d.ts

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

package/dist/platform.browser.d.ts

@@ -1,293 +1,9 @@
 /**
- * Platform Adapter interface for environment-specific implementations
+ * Browser-specific platform adapters entry point
  *
- * This interface abstracts all environment-specific dependencies to ensure
- * the SDK works seamlessly across Node.js and browser/SSR environments.
- *
- * **Implementation Context:**
- * - Node.js: Uses native crypto modules and full OpenPGP support
- * - Browser: Uses Web Crypto API and browser-compatible libraries
- * - SSR: Automatically selects appropriate implementation based on runtime
- *
- * **Usage Notes:**
- * Platform adapters are automatically selected by the SDK. Direct usage is only
- * needed for custom implementations or testing.
- */
-/**
- * Platform type identifier
- */
-type PlatformType = "node" | "browser";
-/**
- * Encryption operations that require different implementations per platform
- */
-interface VanaCryptoAdapter {
-    /**
-     * Encrypt data with a public key using asymmetric cryptography
-     *
-     * **Usage Context:**
-     * - Used internally for file encryption before storage
-     * - Public key format: Armored PGP public key string
-     * - Returns base64-encoded encrypted data
-     *
-     * @param data The data to encrypt
-     * @param publicKey The public key for encryption
-     * @returns Promise resolving to encrypted data
-     */
-    encryptWithPublicKey(data: string, publicKey: string): Promise<string>;
-    /**
-     * Decrypt data with a private key using asymmetric cryptography
-     *
-     * @param encryptedData The encrypted data
-     * @param privateKey The private key for decryption
-     * @returns Promise resolving to decrypted data
-     */
-    decryptWithPrivateKey(encryptedData: string, privateKey: string): Promise<string>;
-    /**
-     * Generate a new key pair for asymmetric cryptography
-     *
-     * @returns Promise resolving to public and private key pair
-     */
-    generateKeyPair(): Promise<{
-        publicKey: string;
-        privateKey: string;
-    }>;
-    /**
-     * Encrypt data with a wallet's public key using ECDH cryptography
-     * Uses platform-appropriate ECDH implementation (eccrypto vs eccrypto-js)
-     *
-     * **Usage Context:**
-     * - Used for sharing encryption keys with permission recipients
-     * - Public key format: Compressed or uncompressed secp256k1 hex string
-     * - Compatible with Ethereum wallet public keys
-     *
-     * @param data The data to encrypt (string)
-     * @param publicKey The wallet's public key (secp256k1)
-     * @returns Promise resolving to encrypted data as hex string
-     */
-    encryptWithWalletPublicKey(data: string, publicKey: string): Promise<string>;
-    /**
-     * Decrypt data with a wallet's private key using ECDH cryptography
-     * Uses platform-appropriate ECDH implementation (eccrypto vs eccrypto-js)
-     *
-     * @param encryptedData The encrypted data as hex string
-     * @param privateKey The wallet's private key (secp256k1)
-     * @returns Promise resolving to decrypted data as string
-     */
-    decryptWithWalletPrivateKey(encryptedData: string, privateKey: string): Promise<string>;
-    /**
-     * Encrypt data with a password using PGP password-based encryption
-     * Uses platform-appropriate OpenPGP implementation with consistent format
-     *
-     * @param data The data to encrypt as Uint8Array
-     * @param password The password for encryption (typically wallet signature)
-     * @returns Promise resolving to encrypted data as Uint8Array
-     */
-    encryptWithPassword(data: Uint8Array, password: string): Promise<Uint8Array>;
-    /**
-     * Decrypt data with a password using PGP password-based decryption
-     * Uses platform-appropriate OpenPGP implementation with consistent format
-     *
-     * @param encryptedData The encrypted data as Uint8Array
-     * @param password The password for decryption (typically wallet signature)
-     * @returns Promise resolving to decrypted data as Uint8Array
-     */
-    decryptWithPassword(encryptedData: Uint8Array, password: string): Promise<Uint8Array>;
-}
-/**
- * PGP operations that require different configurations per platform
- */
-interface VanaPGPAdapter {
-    /**
-     * Encrypt data using PGP with proper platform configuration
-     *
-     * @param data The data to encrypt
-     * @param publicKey The PGP public key
-     * @returns Promise resolving to encrypted data
-     */
-    encrypt(data: string, publicKey: string): Promise<string>;
-    /**
-     * Decrypt data using PGP with proper platform configuration
-     *
-     * @param encryptedData The encrypted data
-     * @param privateKey The PGP private key
-     * @returns Promise resolving to decrypted data
-     */
-    decrypt(encryptedData: string, privateKey: string): Promise<string>;
-    /**
-     * Generate a new PGP key pair with platform-appropriate configuration
-     *
-     * @param options - Key generation options
-     * @param options.name - The name for the PGP key
-     * @param options.email - The email for the PGP key
-     * @param options.passphrase - Optional passphrase to protect the private key
-     * @returns Promise resolving to public and private key pair
-     */
-    generateKeyPair(options?: {
-        name?: string;
-        email?: string;
-        passphrase?: string;
-    }): Promise<{
-        publicKey: string;
-        privateKey: string;
-    }>;
-}
-/**
- * HTTP operations that need consistent API across platforms
- */
-interface VanaHttpAdapter {
-    /**
-     * Perform HTTP request with platform-appropriate fetch implementation
-     *
-     * @param url The URL to request
-     * @param options Request options
-     * @returns Promise resolving to response
-     */
-    fetch(url: string, options?: RequestInit): Promise<Response>;
-}
-/**
- * Simple cache operations that work across platforms
- */
-interface VanaCacheAdapter {
-    /**
-     * Get a value from the cache
-     *
-     * @param key The cache key
-     * @returns The cached value or null if not found/expired
-     */
-    get(key: string): string | null;
-    /**
-     * Set a value in the cache
-     *
-     * @param key The cache key
-     * @param value The value to cache
-     */
-    set(key: string, value: string): void;
-    /**
-     * Delete a value from the cache
-     *
-     * @param key The cache key
-     */
-    delete(key: string): void;
-    /**
-     * Clear all values from the cache
-     */
-    clear(): void;
-}
-/**
- * Main platform adapter interface that combines all platform-specific functionality
- *
- * **Implementation Guidelines:**
- * 1. All methods must maintain consistent behavior across platforms
- * 2. Error types and messages should be unified
- * 3. Data formats (encoding, serialization) must be identical
- * 4. Performance characteristics can vary but API must be consistent
- *
- * **Custom Implementation Example:**
- * ```typescript
- * class CustomPlatformAdapter implements VanaPlatformAdapter {
- *   crypto = new CustomCryptoAdapter();
- *   pgp = new CustomPGPAdapter();
- *   http = new CustomHttpAdapter();
- *   platform = 'browser' as const;
- * }
- * ```
- */
-interface VanaPlatformAdapter {
-    /**
-     * Crypto operations adapter
-     */
-    crypto: VanaCryptoAdapter;
-    /**
-     * PGP operations adapter
-     */
-    pgp: VanaPGPAdapter;
-    /**
-     * HTTP operations adapter
-     */
-    http: VanaHttpAdapter;
-    /**
-     * Cache operations adapter
-     */
-    cache: VanaCacheAdapter;
-    /**
-     * Platform identifier for debugging/telemetry
-     */
-    readonly platform: PlatformType;
-}
-
-/**
- * Browser implementation of the Vana Platform Adapter
- *
- * This implementation uses browser-compatible libraries and configurations
- * to provide crypto, PGP, and HTTP functionality without Node.js dependencies.
- */
-
-/**
- * Complete browser platform adapter implementation
- */
-declare class BrowserPlatformAdapter implements VanaPlatformAdapter {
-    crypto: VanaCryptoAdapter;
-    pgp: VanaPGPAdapter;
-    http: VanaHttpAdapter;
-    cache: VanaCacheAdapter;
-    platform: "browser";
-    constructor();
-}
-
-/**
- * Browser-only exports for platform adapters
- *
- * This file provides browser-only exports that completely avoid Node.js imports
- * when bundling for browser environments. This is used by the browser entry point.
- */
-
-/**
- * Creates a BrowserPlatformAdapter instance
- *
- * @returns A BrowserPlatformAdapter instance
- */
-declare function createBrowserPlatformAdapter(): VanaPlatformAdapter;
-/**
- * Browser-only platform adapter factory
- * This version does not include Node.js imports at all
- *
- * @returns A BrowserPlatformAdapter instance
- */
-declare function createPlatformAdapterSafe(): VanaPlatformAdapter;
-
-/**
- * Platform detection and adapter utilities
- *
- * This module provides utilities for detecting the current runtime environment
- * and creating appropriate platform adapters automatically.
- */
-
-/**
- * Detects the current runtime environment
- *
- * @returns The detected platform type
- */
-declare function detectPlatform(): PlatformType;
-/**
- * Checks if the current environment supports the given platform adapter
- *
- * @param platformType - The platform type to check
- * @returns True if the platform is supported, false otherwise
- */
-declare function isPlatformSupported(platformType: PlatformType): boolean;
-/**
- * Gets platform-specific capabilities
- *
- * @returns Object describing available platform capabilities
+ * This module provides browser-safe platform utilities without Node.js dependencies.
  */
-declare function getPlatformCapabilities(): {
-    platform: PlatformType;
-    crypto: {
-        webCrypto: false | SubtleCrypto;
-        nodeCrypto: string | false;
-    };
-    fetch: boolean;
-    streams: boolean;
-};
-
-export { BrowserPlatformAdapter, type VanaPlatformAdapter, createBrowserPlatformAdapter, createPlatformAdapterSafe, detectPlatform, getPlatformCapabilities, isPlatformSupported };
+export { BrowserPlatformAdapter } from "./platform/browser";
+export type { VanaPlatformAdapter } from "./platform/interface";
+export { createBrowserPlatformAdapter, createPlatformAdapterSafe, } from "./platform/browser-only";
+export { detectPlatform, isPlatformSupported, getPlatformCapabilities, } from "./platform/utils";