@cmdoss/memwal-sdk 0.9.0 → 1.0.0

package/src/config/defaults.ts

@@ -1,57 +1,57 @@
-/**
- * Default PDW Configuration
- * 
- * Provides sensible defaults for different environments
- */
-
-import type { PDWConfig } from '../types';
-
-export function createDefaultConfig(): PDWConfig {
-  return {
-    // Updated January 12, 2026 - SEAL key_id first argument fix
-    packageId: '0xa5d7d98ea41620c9aaf9f13afa6512455d4d10ca06ccea3f8cd5b2b9568e3a9e',
-    accessRegistryId: '0x0',
-    encryptionConfig: {
-      enabled: true,
-      keyServers: [], // To be configured based on environment
-      policyConfig: {
-        threshold: 2, // 2-of-3 threshold by default
-      },
-    },
-    storageConfig: {
-      cacheEnabled: true,
-      encryptionEnabled: true,
-    },
-    // Walrus Storage Configuration (Testnet defaults)
-    // Publisher: Direct blob uploads (server-side, full control)
-    walrusPublisherUrl: 'https://publisher.walrus-testnet.walrus.space',
-    // Upload Relay: Optimized for browser/mobile (fewer connections, faster)
-    walrusUploadRelayUrl: 'https://upload-relay.testnet.walrus.space',
-    // Aggregator: Blob retrieval
-    walrusAggregatorUrl: 'https://aggregator.walrus-testnet.walrus.space',
-    walrusMaxFileSize: 10 * 1024 * 1024, // 10MB (public service limit)
-    walrusTimeout: 60000, // 60 seconds for upload relay
-  };
-}
-
-export function createTestnetConfig(overrides: Partial<PDWConfig> = {}): PDWConfig {
-  return {
-    ...createDefaultConfig(),
-    accessRegistryId: overrides.accessRegistryId ?? '0x0',
-    encryptionConfig: {
-      enabled: true,
-      keyServers: [
-        // Testnet SEAL key servers
-        '0x0' // Placeholder - will be updated with actual testnet servers
-      ],
-      policyConfig: {
-        threshold: 2,
-      },
-    },
-    // Testnet Walrus endpoints
-    walrusPublisherUrl: 'https://publisher.walrus-testnet.walrus.space',
-    walrusUploadRelayUrl: 'https://upload-relay.testnet.walrus.space',
-    walrusAggregatorUrl: 'https://aggregator.walrus-testnet.walrus.space',
-    ...overrides,
-  };
+/**
+ * Default PDW Configuration
+ * 
+ * Provides sensible defaults for different environments
+ */
+
+import type { PDWConfig } from '../types';
+
+export function createDefaultConfig(): PDWConfig {
+  return {
+    // Updated January 12, 2026 - SEAL key_id first argument fix
+    packageId: '0xa5d7d98ea41620c9aaf9f13afa6512455d4d10ca06ccea3f8cd5b2b9568e3a9e',
+    accessRegistryId: '0x0',
+    encryptionConfig: {
+      enabled: true,
+      keyServers: [], // To be configured based on environment
+      policyConfig: {
+        threshold: 2, // 2-of-3 threshold by default
+      },
+    },
+    storageConfig: {
+      cacheEnabled: true,
+      encryptionEnabled: true,
+    },
+    // Walrus Storage Configuration (Testnet defaults)
+    // Publisher: Direct blob uploads (server-side, full control)
+    walrusPublisherUrl: 'https://publisher.walrus-testnet.walrus.space',
+    // Upload Relay: Optimized for browser/mobile (fewer connections, faster)
+    walrusUploadRelayUrl: 'https://upload-relay.testnet.walrus.space',
+    // Aggregator: Blob retrieval
+    walrusAggregatorUrl: 'https://aggregator.walrus-testnet.walrus.space',
+    walrusMaxFileSize: 10 * 1024 * 1024, // 10MB (public service limit)
+    walrusTimeout: 60000, // 60 seconds for upload relay
+  };
+}
+
+export function createTestnetConfig(overrides: Partial<PDWConfig> = {}): PDWConfig {
+  return {
+    ...createDefaultConfig(),
+    accessRegistryId: overrides.accessRegistryId ?? '0x0',
+    encryptionConfig: {
+      enabled: true,
+      keyServers: [
+        // Testnet SEAL key servers
+        '0x0' // Placeholder - will be updated with actual testnet servers
+      ],
+      policyConfig: {
+        threshold: 2,
+      },
+    },
+    // Testnet Walrus endpoints
+    walrusPublisherUrl: 'https://publisher.walrus-testnet.walrus.space',
+    walrusUploadRelayUrl: 'https://upload-relay.testnet.walrus.space',
+    walrusAggregatorUrl: 'https://aggregator.walrus-testnet.walrus.space',
+    ...overrides,
+  };
 }

package/src/config/index.ts

@@ -1,9 +1,16 @@
-/**
- * Configuration Module
- * 
- * Comprehensive configuration management for the PDW SDK,
- * including environment variable support and validation.
- */
-
-export { ConfigurationHelper, Config } from './ConfigurationHelper';
-export type { SDKConfig, EnvironmentConfig } from './ConfigurationHelper';
+/**
+ * Configuration Module
+ *
+ * Comprehensive configuration management for the PDW SDK,
+ * including environment variable support and validation.
+ */
+
+export { ConfigurationHelper, Config } from './ConfigurationHelper';
+export type { SDKConfig, EnvironmentConfig } from './ConfigurationHelper';
+
+// Model defaults - centralized AI model configuration
+export {
+  MODEL_DEFAULTS,
+  getDefaultEmbeddingModel,
+  getChatModel
+} from './modelDefaults';

package/src/config/modelDefaults.ts

@@ -0,0 +1,103 @@
+/**
+ * Model Defaults - Centralized AI model configuration
+ *
+ * All default AI model settings are defined here for easy customization.
+ * Users can override these via:
+ * 1. Environment variables (AI_CHAT_MODEL, EMBEDDING_MODEL, etc.)
+ * 2. SDK config options when initializing SimplePDWClient
+ *
+ * @module config/modelDefaults
+ */
+
+/**
+ * Default AI model configuration
+ *
+ * @example
+ * ```typescript
+ * import { MODEL_DEFAULTS } from '@cmdoss/memwal-sdk';
+ *
+ * // Use defaults
+ * console.log(MODEL_DEFAULTS.CHAT_MODEL); // 'google/gemini-2.5-flash'
+ *
+ * // Override via env vars
+ * process.env.AI_CHAT_MODEL = 'anthropic/claude-3.5-sonnet';
+ * ```
+ */
+export const MODEL_DEFAULTS = {
+  // =========================================================================
+  // Embedding Models (for vector search)
+  // =========================================================================
+
+  /** Default embedding model for OpenRouter provider */
+  EMBEDDING_OPENROUTER: 'google/gemini-embedding-001',
+
+  /** Default embedding model for Google provider */
+  EMBEDDING_GOOGLE: 'text-embedding-004',
+
+  /** Default embedding model for OpenAI provider */
+  EMBEDDING_OPENAI: 'text-embedding-3-small',
+
+  /** Default embedding model for Cohere provider */
+  EMBEDDING_COHERE: 'embed-english-v3.0',
+
+  // =========================================================================
+  // Chat/Analysis Models (for RAG, knowledge graph extraction)
+  // =========================================================================
+
+  /**
+   * Default chat/analysis model (OpenRouter format)
+   *
+   * Used for:
+   * - RAG responses
+   * - Knowledge graph entity extraction
+   * - Content classification
+   *
+   * Popular alternatives:
+   * - 'google/gemini-2.5-pro' - higher quality
+   * - 'openai/gpt-4o-mini' - fast, cheap
+   * - 'openai/gpt-4o' - highest quality
+   * - 'anthropic/claude-3.5-sonnet' - balanced
+   */
+  CHAT_MODEL: 'google/gemini-2.5-flash',
+
+  // =========================================================================
+  // Embedding Dimensions
+  // =========================================================================
+
+  /**
+   * Default embedding dimensions
+   *
+   * Lower dimensions = faster but less accurate
+   * - 768: Fast, good for most use cases (default)
+   * - 1536: Balanced
+   * - 3072: Highest quality, slowest
+   */
+  EMBEDDING_DIMENSIONS: 768,
+} as const;
+
+/**
+ * Get the default embedding model for a provider
+ */
+export function getDefaultEmbeddingModel(
+  provider: 'google' | 'openai' | 'openrouter' | 'cohere' | string
+): string {
+  switch (provider) {
+    case 'google':
+      return MODEL_DEFAULTS.EMBEDDING_GOOGLE;
+    case 'openai':
+      return MODEL_DEFAULTS.EMBEDDING_OPENAI;
+    case 'openrouter':
+      return MODEL_DEFAULTS.EMBEDDING_OPENROUTER;
+    case 'cohere':
+      return MODEL_DEFAULTS.EMBEDDING_COHERE;
+    default:
+      return MODEL_DEFAULTS.EMBEDDING_GOOGLE;
+  }
+}
+
+/**
+ * Get chat model from config or environment
+ */
+export function getChatModel(configModel?: string): string {
+  return configModel || process.env.AI_CHAT_MODEL || MODEL_DEFAULTS.CHAT_MODEL;
+}

package/src/config/validation.ts

@@ -1,71 +1,71 @@
-/**
- * Configuration Validation
- * 
- * Validates PDW configuration and provides helpful error messages
- */
-
-import type { PDWConfig } from '../types';
-
-export class ConfigurationError extends Error {
-  constructor(message: string) {
-    super(`PDW Configuration Error: ${message}`);
-    this.name = 'ConfigurationError';
-  }
-}
-
-export function validateConfig(config: Partial<PDWConfig>): PDWConfig {
-  const errors: string[] = [];
-
-  // Validate required fields
-  if (!config.packageId || config.packageId === '0x0') {
-    console.warn('PDW SDK: packageId not configured. Please set a valid deployed package ID.');
-  }
-
-  // Validate encryption config
-  if (config.encryptionConfig?.enabled && 
-      (!config.encryptionConfig.keyServers || config.encryptionConfig.keyServers.length === 0)) {
-    console.warn('PDW SDK: Encryption is enabled but no key servers configured. Some features may not work.');
-  }
-
-  // Validate threshold configuration
-  if (config.encryptionConfig?.policyConfig?.threshold) {
-    const threshold = config.encryptionConfig.policyConfig.threshold;
-    if (threshold < 1) {
-      errors.push('Encryption threshold must be at least 1');
-    }
-  }
-
-  // Validate storage config
-  if (config.storageConfig?.provider && !['walrus', 'local'].includes(config.storageConfig.provider)) {
-    errors.push('Storage provider must be either "walrus" or "local"');
-  }
-
-  if (errors.length > 0) {
-    throw new ConfigurationError(errors.join('; '));
-  }
-
-  return config as PDWConfig;
-}
-
-export function mergeConfigs(base: PDWConfig, overrides: Partial<PDWConfig>): PDWConfig {
-  return {
-    ...base,
-    ...overrides,
-    encryptionConfig: {
-      enabled: true,
-      ...base.encryptionConfig,
-      ...overrides.encryptionConfig,
-      policyConfig: {
-        ...base.encryptionConfig?.policyConfig,
-        ...overrides.encryptionConfig?.policyConfig,
-      },
-    },
-    storageConfig: {
-      provider: 'walrus' as const,
-      cacheEnabled: true,
-      encryptionEnabled: true,
-      ...base.storageConfig,
-      ...overrides.storageConfig,
-    },
-  };
+/**
+ * Configuration Validation
+ * 
+ * Validates PDW configuration and provides helpful error messages
+ */
+
+import type { PDWConfig } from '../types';
+
+export class ConfigurationError extends Error {
+  constructor(message: string) {
+    super(`PDW Configuration Error: ${message}`);
+    this.name = 'ConfigurationError';
+  }
+}
+
+export function validateConfig(config: Partial<PDWConfig>): PDWConfig {
+  const errors: string[] = [];
+
+  // Validate required fields
+  if (!config.packageId || config.packageId === '0x0') {
+    console.warn('PDW SDK: packageId not configured. Please set a valid deployed package ID.');
+  }
+
+  // Validate encryption config
+  if (config.encryptionConfig?.enabled && 
+      (!config.encryptionConfig.keyServers || config.encryptionConfig.keyServers.length === 0)) {
+    console.warn('PDW SDK: Encryption is enabled but no key servers configured. Some features may not work.');
+  }
+
+  // Validate threshold configuration
+  if (config.encryptionConfig?.policyConfig?.threshold) {
+    const threshold = config.encryptionConfig.policyConfig.threshold;
+    if (threshold < 1) {
+      errors.push('Encryption threshold must be at least 1');
+    }
+  }
+
+  // Validate storage config
+  if (config.storageConfig?.provider && !['walrus', 'local'].includes(config.storageConfig.provider)) {
+    errors.push('Storage provider must be either "walrus" or "local"');
+  }
+
+  if (errors.length > 0) {
+    throw new ConfigurationError(errors.join('; '));
+  }
+
+  return config as PDWConfig;
+}
+
+export function mergeConfigs(base: PDWConfig, overrides: Partial<PDWConfig>): PDWConfig {
+  return {
+    ...base,
+    ...overrides,
+    encryptionConfig: {
+      enabled: true,
+      ...base.encryptionConfig,
+      ...overrides.encryptionConfig,
+      policyConfig: {
+        ...base.encryptionConfig?.policyConfig,
+        ...overrides.encryptionConfig?.policyConfig,
+      },
+    },
+    storageConfig: {
+      provider: 'walrus' as const,
+      cacheEnabled: true,
+      encryptionEnabled: true,
+      ...base.storageConfig,
+      ...overrides.storageConfig,
+    },
+  };
 }

package/src/core/index.ts

@@ -1,14 +1,14 @@
-/**
- * Core Module - Barrel Export
- *
- * Re-exports all core types, interfaces, and base classes for the PDW SDK.
- *
- * All type definitions are in ./types/index.ts
- * This file only provides re-exports for convenience.
- */
-
-// Re-export core interfaces and base classes
-export * from './interfaces';
-
-// Re-export all types from the types module
-export * from './types';
+/**
+ * Core Module - Barrel Export
+ *
+ * Re-exports all core types, interfaces, and base classes for the PDW SDK.
+ *
+ * All type definitions are in ./types/index.ts
+ * This file only provides re-exports for convenience.
+ */
+
+// Re-export core interfaces and base classes
+export * from './interfaces';
+
+// Re-export all types from the types module
+export * from './types';