@2112-lab/central-plant 0.2.12 → 0.3.0

package/dist/index.d.ts

@@ -184,3 +184,122 @@ export * as Numerics from './data/numerics.js';
 // Analysis utilities
 export * as Analysis from './analysis/analysis.js';
 export * as Testing from './analysis/testing.js';
+
+// ─── Cache management ─────────────────────────────────────────────────────────
+
+export interface CacheExpiryConfig {
+  MODELS: number
+  TEXTURES: number
+  JSON: number
+  COMPONENT_DICTIONARY: number
+  SCENE_DATA: number
+  THUMBNAILS: number
+  SKYBOXES: number
+  USER_CONTENT: number
+  TEMPORARY: number
+  DEFAULT: number
+}
+
+export declare const CACHE_EXPIRY: CacheExpiryConfig
+export declare const CACHE_NAME_PREFIX: string
+export declare const GLOBAL_CACHE_NAME: string
+
+export interface CacheStatsItem {
+  url: string
+  sourceKey?: string
+  s3Key?: string
+  size: number
+  sizeMB: string
+  type: string
+  cachedTime: number
+  age: number
+  isLocal?: boolean
+}
+
+export interface CacheStatsResult {
+  count: number
+  totalSize: number
+  totalSizeMB: string
+  items: CacheStatsItem[]
+}
+
+export interface CacheGlobalStats {
+  hits: number
+  misses: number
+  errors: number
+  totalBytesServed: number
+  totalBytesCached: number
+  startTime: number
+  hitRate: string
+  totalMBServed: string
+  totalMBCached: string
+  uptimeMinutes: string
+}
+
+export declare class CacheManager {
+  stats: { hits: number; misses: number; errors: number; totalBytesServed: number; totalBytesCached: number; startTime: number }
+  configure(options: { getUser?: () => Promise<any>; onError?: (error: Error) => void }): void
+  getExpiryForPath(path: string, assetType?: string | null): number
+  resetIdentity(): void
+  getCacheName(): Promise<string>
+  execute(options: { cacheKey: string; sourceKey?: string; expiryMs: number; fetcher: () => Promise<any>; processor: (response: any) => Promise<any>; metadata?: Record<string, string>; logType?: string }): Promise<any>
+  getGlobalStats(): CacheGlobalStats
+  resetStats(): void
+  clearCache(specificKey?: string | null, clearAllUsers?: boolean): Promise<boolean>
+  cleanExpired(): Promise<number>
+  cleanInvalid(): Promise<number>
+  has(cacheKey: string, expiryMs?: number | null): Promise<boolean>
+  get(cacheKey: string, expiryMs?: number | null, processor?: (response: Response) => Promise<any>): Promise<any>
+  delete(cacheKey: string): Promise<boolean>
+  deleteCache(cacheName: string): Promise<boolean>
+  getDetailedStats(allUsers?: boolean): Promise<CacheStatsResult | { caches: any[]; totalCaches: number; grandTotalSizeMB: string }>
+}
+
+export declare const cacheManager: CacheManager
+
+export declare function resetCacheIdentity(): void
+export declare function getGlobalCacheStats(): CacheGlobalStats
+export declare function resetGlobalCacheStats(): void
+export declare function getCurrentCacheName(): Promise<string>
+export declare function cleanExpiredCache(): Promise<number>
+export declare function cleanInvalidCacheEntries(): Promise<number>
+export declare function getCacheStats(allUsers?: boolean): Promise<CacheStatsResult>
+export declare function getUserOnlyCacheStats(allUsers?: boolean): Promise<CacheStatsResult>
+export declare function getGlobalOnlyCacheStats(): Promise<CacheStatsResult>
+export declare function clearS3Cache(specificKey?: string | null, clearAllUsers?: boolean): Promise<boolean>
+export declare function getAllCacheKeys(): Promise<Set<string>>
+export declare function switchCachePartition(isAuthenticated: boolean): Promise<{ oldCacheName: string; newCacheName: string; deletedPartition: string | null; deleted: boolean } | { error: string }>
+
+export declare function getCachedS3Object(s3Key: string, storageOptions?: Record<string, any>, expiryMs?: number | null): Promise<Blob>
+export declare function getCachedS3ObjectURL(s3Key: string, storageOptions?: Record<string, any>, expiryMs?: number | null): Promise<string>
+export declare function preloadS3Objects(s3Keys: string[], storageOptions?: Record<string, any>): Promise<{ success: number; failed: number; errors: Array<{ key: string; error: string }> }>
+export declare function getCachedS3Json(s3Key: string, storageOptions?: Record<string, any>, expiryMs?: number | null): Promise<any>
+export declare function getCachedLocalJson(localPath: string, expiryMs?: number | null): Promise<any>
+export declare function getCachedLocalFile(url: string, expiryMs?: number | null): Promise<Blob>
+export declare function getCachedLocalFileURL(url: string, expiryMs?: number | null): Promise<string>
+export declare function preloadLocalFiles(urls: string[]): Promise<{ success: number; failed: number; errors: Array<{ url: string; error: string }> }>
+
+export declare function cacheJsonData(key: string, data: any, expiryMs?: number): Promise<boolean>
+export declare function getCachedJsonData(key: string, expiryMs?: number): Promise<any>
+export declare function removeCachedJsonData(key: string): Promise<boolean>
+
+export declare function getThumbnailKey(asset: { thumbnailS3Path?: string; s3Path?: string; uuid?: string; id?: string }): string | null
+export declare function isThumbnailCached(asset: { isS3Component?: boolean; source?: string; scope?: string; thumbnailS3Path?: string; s3Path?: string; uuid?: string; id?: string }): Promise<boolean>
+export declare function isCached(s3Key: string, expiryMs?: number | null): Promise<boolean>
+export declare function getCacheExpiryForPath(path: string, assetType?: string | null): number
+export declare function formatCacheExpiry(ms: number): string
+
+export declare class S3MetadataCacheService {
+  getAll(): Promise<any[]>
+  getMetadata(): Promise<{ version: number; components: any[]; timestamp: number }>
+  addComponent(component: { id?: string; uuid?: string; [key: string]: any }): Promise<boolean>
+  removeComponent(identifier: string): Promise<boolean>
+  clear(): Promise<boolean>
+  hasComponent(identifier: string): Promise<boolean>
+  refresh(): Promise<any[]>
+  setAll(components: any[]): Promise<boolean>
+}
+
+export declare const s3MetadataCache: S3MetadataCacheService
+
+export declare function measureS3Transfer(operation: string, asyncFn: () => Promise<any>, fileSize?: number | null): Promise<any>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@2112-lab/central-plant",
-  "version": "0.2.12",
+  "version": "0.3.0",
   "description": "Utility modules for the Central Plant Application",
   "main": "dist/bundle/index.js",
   "module": "dist/esm/src/index.js",
@@ -32,6 +32,7 @@
   "license": "MIT",
   "dependencies": {
     "@2112-lab/pathfinder": "^1.0.38",
+    "aws-amplify": "^5.3.33",
     "stats.js": "^0.17.0",
     "three": "^0.177.0"
   },