@kubohiroya/turbowarp-asset-cache 0.1.0

package/dist/types/verified-remote-cache.d.ts

@@ -0,0 +1,106 @@
+import { type VerifiedRemoteStoryCacheDeleteResult, type VerifiedRemoteStoryCacheInfo, type VerifiedRemoteStoryCachePruneResult } from './verified-cache-catalog.js';
+export type { VerifiedRemoteStoryCacheDeleteResult, VerifiedRemoteStoryCacheInfo, VerifiedRemoteStoryCachePruneResult } from './verified-cache-catalog.js';
+export interface VerifiedRemoteBinaryInput {
+    readonly url: unknown;
+    readonly integrity: unknown;
+    readonly size: unknown;
+    readonly contentType: unknown;
+}
+export interface NormalizedVerifiedRemoteBinaryInput {
+    readonly url: string;
+    readonly integrity: string;
+    readonly size: number;
+    readonly contentType: string;
+}
+export interface VerifiedRemoteBinaryLoadResult {
+    readonly bytes: ArrayBuffer | Uint8Array;
+    readonly contentType: unknown;
+    readonly transferOwnership?: boolean;
+}
+export interface VerifiedRemoteBinaryResolveOptions {
+    readonly load: (input: NormalizedVerifiedRemoteBinaryInput, context: Readonly<{
+        signal?: AbortSignal;
+    }>) => Promise<VerifiedRemoteBinaryLoadResult>;
+    readonly signal?: AbortSignal;
+}
+export interface VerifiedRemoteCacheWarning {
+    readonly operation: 'read' | 'write' | 'cleanup';
+    readonly code: string;
+}
+export interface VerifiedRemoteCacheIdentityInput {
+    readonly id: unknown;
+    readonly label: unknown;
+    readonly databaseName?: unknown;
+}
+export interface VerifiedRemoteCacheIdentity {
+    readonly id: string;
+    readonly label: string;
+    readonly databaseName: string;
+}
+export interface VerifiedRemoteBinaryResult {
+    readonly bytes: Uint8Array;
+    readonly contentType: string;
+    readonly integrity: string;
+    readonly source: 'indexeddb' | 'network';
+    readonly cacheRead: 'hit' | 'miss' | 'invalid' | 'failed';
+    readonly cacheWrite: 'not-needed' | 'stored' | 'skipped' | 'failed';
+    readonly cacheWarnings: ReadonlyArray<VerifiedRemoteCacheWarning>;
+}
+export interface VerifiedRemoteCacheStats {
+    readonly databaseName: string;
+    readonly cacheIdentity: VerifiedRemoteCacheIdentity | null;
+    readonly entries: number;
+    readonly bytes: number;
+    readonly oldestAccessedAt: number | null;
+    readonly newestAccessedAt: number | null;
+    readonly highWaterBytes: number;
+    readonly lowWaterBytes: number;
+    readonly lastCleanupAt: number | null;
+    readonly lastCleanupRemovedEntries: number;
+    readonly lastCleanupRemovedBytes: number;
+    readonly warnings: ReadonlyArray<VerifiedRemoteCacheWarning>;
+}
+export interface VerifiedRemoteCachePruneResult {
+    readonly databaseName: string;
+    readonly cacheIdentity: VerifiedRemoteCacheIdentity | null;
+    readonly removedEntries: number;
+    readonly removedBytes: number;
+    readonly remainingEntries: number;
+    readonly remainingBytes: number;
+    readonly highWaterBytes: number;
+    readonly lowWaterBytes: number;
+    readonly warnings: ReadonlyArray<VerifiedRemoteCacheWarning>;
+}
+export interface VerifiedRemoteBinaryCacheOptions {
+    readonly indexedDB?: IDBFactory;
+    readonly subtleCrypto?: SubtleCrypto;
+    readonly estimateStorage?: () => Promise<Readonly<{
+        quota?: number;
+        usage?: number;
+    }>>;
+    readonly now?: () => number;
+    readonly maxCacheBytes?: number;
+    readonly quotaFraction?: number;
+    readonly lowWaterRatio?: number;
+    readonly ttlMs?: number;
+    readonly touchIntervalMs?: number;
+    readonly cleanupBatchSize?: number;
+    readonly leaseTtlMs?: number;
+    readonly cacheIdentity?: VerifiedRemoteCacheIdentityInput;
+}
+export interface VerifiedRemoteBinaryCache {
+    resolve(input: VerifiedRemoteBinaryInput, options: VerifiedRemoteBinaryResolveOptions): Promise<VerifiedRemoteBinaryResult>;
+    getStats(): Promise<VerifiedRemoteCacheStats>;
+    prune(): Promise<VerifiedRemoteCachePruneResult>;
+    clear(): Promise<VerifiedRemoteCachePruneResult>;
+    listStoryCaches(): Promise<ReadonlyArray<VerifiedRemoteStoryCacheInfo>>;
+    pruneStoryCaches(): Promise<VerifiedRemoteStoryCachePruneResult>;
+    deleteStoryCache(databaseName: unknown): Promise<VerifiedRemoteStoryCacheDeleteResult>;
+    renewStoryCacheLease(): Promise<void>;
+    releaseStoryCacheLease(): Promise<void>;
+}
+export declare function createVerifiedRemoteCacheDatabaseName(input: {
+    readonly id: unknown;
+    readonly label: unknown;
+}): string;
+export declare function createVerifiedRemoteBinaryCache(options?: VerifiedRemoteBinaryCacheOptions): VerifiedRemoteBinaryCache;

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@kubohiroya/turbowarp-asset-cache",
+  "version": "0.1.0",
+  "description": "A browser-local image, audio, and runtime-text asset cache for TurboWarp projects.",
+  "author": "Hiroya Kubo <hiroya@cuc.ac.jp>",
+  "type": "module",
+  "license": "MPL-2.0",
+  "homepage": "https://kubohiroya.github.io/turbowarp-asset-cache/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kubohiroya/turbowarp-asset-cache.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kubohiroya/turbowarp-asset-cache/issues"
+  },
+  "exports": {
+    "./composition": {
+      "types": "./dist/types/composition.d.ts",
+      "import": "./dist/composition.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "unpkg": "./dist/asset-cache.js",
+  "jsdelivr": "./dist/asset-cache.js",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "packageManager": "pnpm@11.11.0",
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "scripts": {
+    "dev": "vite build --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src tests scripts vite.config.ts vite.composition.config.ts vite-indent-plugin.ts",
+    "format": "eslint src tests scripts vite.config.ts vite.composition.config.ts vite-indent-plugin.ts --fix",
+    "build": "pnpm build:extension && pnpm build:composition && pnpm build:types",
+    "build:extension": "vite build",
+    "build:composition": "vite build --config vite.composition.config.ts",
+    "build:types": "tsc --project tsconfig.build.json",
+    "types:composition:check": "tsc --project tsconfig.composition-consumer.json",
+    "test": "vitest run",
+    "test:browser:opfs": "node scripts/check-opfs-browser.ts",
+    "docs": "node scripts/generate-readme.ts",
+    "docs:check": "pnpm run docs && git diff --exit-code -- docs/block-reference.md",
+    "docs:site:check": "node scripts/check-site.ts",
+    "repo:check": "node scripts/check-repo.ts",
+    "check:dist": "pnpm run build && git diff --exit-code -- dist",
+    "archive:check": "node scripts/check-github-archive.ts",
+    "pack:check": "npm pack --dry-run --ignore-scripts",
+    "release:check": "npm publish --dry-run --access public",
+    "check": "pnpm run typecheck && pnpm run lint && pnpm run test && pnpm run build && pnpm run test:browser:opfs && pnpm run types:composition:check && pnpm run docs:check && pnpm run docs:site:check && pnpm run check:dist && pnpm run archive:check && pnpm run repo:check && pnpm run pack:check",
+    "prepack": "pnpm run build"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.5",
+    "@kubohiroya/turbowarp-named-data": "0.1.0",
+    "@kubohiroya/turbowarp-extension-manifest": "0.2.0",
+    "@kubohiroya/vite-plugin-turbowarp-extension": "0.4.0",
+    "@types/node": "^22.20.1",
+    "@xmldom/xmldom": "0.9.11",
+    "eslint": "^9.39.5",
+    "fake-indexeddb": "6.2.5",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.70.0",
+    "vite": "^8.2.2",
+    "vitest": "^4.1.10"
+  },
+  "peerDependencies": {
+    "@kubohiroya/turbowarp-named-data": "^0.1.0"
+  },
+  "keywords": [
+    "turbowarp",
+    "scratch",
+    "extension",
+    "assets",
+    "indexeddb"
+  ]
+}