@chipmobilesdk/rn-camera 0.1.1 → 0.2.1

package/src/storage/artifactStore.ts

@@ -1,108 +1,141 @@
-/**
- * ArtifactStore port + default cache-directory adapter (FR-026..FR-029).
- *
- * Package-owned artifacts live in a dedicated `rn-camera` subdirectory of the
- * platform cache directory (research R6). That dedicated prefix is what makes
- * ownership checkable rather than advisory: `owns()` is a path-prefix test, so
- * the package can refuse to delete anything it did not create (FR-028).
- */
-
-export interface ArtifactStore {
-	/** Absolute path of the package-owned temporary directory. */
-	temporaryDirectory(): string;
-	/** True only for paths the package created (FR-028). */
-	owns(uri: string): boolean;
-	/** Deletes an artifact. Resolves even if already gone (FR-027). */
-	remove(uri: string): Promise<void>;
-	/** Deletes owned artifacts older than `olderThanMs`; returns the count. */
-	sweep(olderThanMs: number): Promise<number>;
-}
-
-/** Minimal filesystem surface the adapter needs. Injectable for tests. */
-export interface FileSystemBridge {
-	cacheDirectory(): string;
-	exists(path: string): Promise<boolean>;
-	unlink(path: string): Promise<void>;
-	list(directory: string): Promise<readonly string[]>;
-	createdAt(path: string): Promise<number>;
-	ensureDirectory(directory: string): Promise<void>;
-}
-
-export interface StoreOptions {
-	readonly fs?: FileSystemBridge;
-	/** Directory name under the cache directory. Defaults to `rn-camera`. */
-	readonly directoryName?: string;
-}
-
-/** Normalizes separators so prefix comparison works on both platforms. */
-function normalize(path: string): string {
-	return path.replace(/\\/g, '/').replace(/^file:\/\//, '');
-}
-
-export function createArtifactStore(
-	fs: FileSystemBridge,
-	directoryName = 'rn-camera',
-): ArtifactStore {
-	const root = `${fs.cacheDirectory().replace(/\/$/, '')}/${directoryName}`;
-	const normalizedRoot = normalize(root);
-	// Artifacts created by this process are never swept, no matter their age.
-	const createdThisProcess = new Set<string>();
-
-	return {
-		temporaryDirectory() {
-			return root;
-		},
-
-		owns(uri) {
-			return normalize(uri).startsWith(`${normalizedRoot}/`);
-		},
-
-		async remove(uri) {
-			if (!this.owns(uri)) {
-				return;
-			}
-			const path = normalize(uri);
-			// Idempotent: a missing artifact is a successful cleanup (FR-027).
-			if (await fs.exists(path)) {
-				await fs.unlink(path);
-			}
-			createdThisProcess.delete(path);
-		},
-
-		async sweep(olderThanMs) {
-			await fs.ensureDirectory(root);
-			const entries = await fs.list(root);
-			const cutoff = Date.now() - olderThanMs;
-			let removed = 0;
-
-			for (const entry of entries) {
-				const path = normalize(entry);
-				if (createdThisProcess.has(path)) {
-					continue;
-				}
-				const created = await fs.createdAt(path);
-				if (created < cutoff) {
-					await fs.unlink(path);
-					removed += 1;
-				}
-			}
-			return removed;
-		},
-	};
-}
-
-/**
- * Default adapter. The concrete filesystem bridge is supplied by the native
- * layer at runtime; it is a parameter rather than a hard import so the package
- * takes no filesystem dependency of its own.
- */
-export function createCacheArtifactStore(options: StoreOptions = {}): ArtifactStore {
-	const fs = options.fs;
-	if (!fs) {
-		throw new Error(
-			'createCacheArtifactStore requires a FileSystemBridge. Pass `fs`, or use ' +
-				'createTestCamera() in tests.',
-		);
-	}
-	return createArtifactStore(fs, options.directoryName);
-}
+/**
+ * ArtifactStore port + default cache-directory adapter (FR-026..FR-029).
+ *
+ * Package-owned artifacts live in a dedicated `rn-camera` subdirectory of the
+ * platform cache directory (research R6). That dedicated prefix is what makes
+ * ownership checkable rather than advisory: `owns()` is a path-prefix test, so
+ * the package can refuse to delete anything it did not create (FR-028).
+ */
+
+export interface ArtifactStore {
+	/** Absolute path of the package-owned temporary directory. */
+	temporaryDirectory(): string;
+	/** True only for paths the package created (FR-028). */
+	owns(uri: string): boolean;
+	/** Deletes an artifact. Resolves even if already gone (FR-027). */
+	remove(uri: string): Promise<void>;
+	/** Deletes owned artifacts older than `olderThanMs`; returns the count. */
+	sweep(olderThanMs: number): Promise<number>;
+	/**
+	 * Brings a fresh capture under the store and returns its managed URI: a file
+	 * already inside the store is recorded as created by this process, a file
+	 * anywhere else is moved in. Without this, a capture the engine wrote to its
+	 * own temporary directory is never owned, so `cleanup()` refuses it and the
+	 * sweep never sees it. Optional so app-written stores keep compiling.
+	 */
+	adopt?(uri: string): Promise<string>;
+}
+
+/** Minimal filesystem surface the adapter needs. Injectable for tests. */
+export interface FileSystemBridge {
+	cacheDirectory(): string;
+	exists(path: string): Promise<boolean>;
+	unlink(path: string): Promise<void>;
+	list(directory: string): Promise<readonly string[]>;
+	createdAt(path: string): Promise<number>;
+	ensureDirectory(directory: string): Promise<void>;
+	/**
+	 * Moves a file. Needed by `adopt()` to pull a capture out of the engine's own
+	 * temporary directory; a bridge without it can only adopt files already
+	 * inside the store.
+	 */
+	move?(from: string, to: string): Promise<void>;
+}
+
+export interface StoreOptions {
+	readonly fs?: FileSystemBridge;
+	/** Directory name under the cache directory. Defaults to `rn-camera`. */
+	readonly directoryName?: string;
+}
+
+/** Normalizes separators so prefix comparison works on both platforms. */
+function normalize(path: string): string {
+	return path.replace(/\\/g, '/').replace(/^file:\/\//, '');
+}
+
+export function createArtifactStore(
+	fs: FileSystemBridge,
+	directoryName = 'rn-camera',
+): ArtifactStore {
+	const root = `${fs.cacheDirectory().replace(/\/$/, '')}/${directoryName}`;
+	const normalizedRoot = normalize(root);
+	// Artifacts created by this process are never swept, no matter their age.
+	const createdThisProcess = new Set<string>();
+
+	function owns(uri: string): boolean {
+		return normalize(uri).startsWith(`${normalizedRoot}/`);
+	}
+
+	return {
+		temporaryDirectory() {
+			return root;
+		},
+
+		owns,
+
+		async remove(uri) {
+			if (!owns(uri)) {
+				return;
+			}
+			const path = normalize(uri);
+			// Idempotent: a missing artifact is a successful cleanup (FR-027).
+			if (await fs.exists(path)) {
+				await fs.unlink(path);
+			}
+			createdThisProcess.delete(path);
+		},
+
+		async sweep(olderThanMs) {
+			await fs.ensureDirectory(root);
+			const entries = await fs.list(root);
+			const cutoff = Date.now() - olderThanMs;
+			let removed = 0;
+
+			for (const entry of entries) {
+				const path = normalize(entry);
+				if (createdThisProcess.has(path)) {
+					continue;
+				}
+				const created = await fs.createdAt(path);
+				if (created < cutoff) {
+					await fs.unlink(path);
+					removed += 1;
+				}
+			}
+			return removed;
+		},
+
+		async adopt(uri) {
+			const path = normalize(uri);
+			if (owns(uri)) {
+				createdThisProcess.add(path);
+				return uri;
+			}
+			if (!fs.move) {
+				throw new Error('This FileSystemBridge has no move(), so it cannot adopt a capture');
+			}
+			await fs.ensureDirectory(root);
+			const name = path.slice(path.lastIndexOf('/') + 1) || `capture-${Date.now()}.jpg`;
+			const target = `${root}/${name}`;
+			await fs.move(path, target);
+			createdThisProcess.add(normalize(target));
+			return uri.startsWith('file://') ? `file://${normalize(target)}` : target;
+		},
+	};
+}
+
+/**
+ * Default adapter. The concrete filesystem bridge is supplied by the native
+ * layer at runtime; it is a parameter rather than a hard import so the package
+ * takes no filesystem dependency of its own.
+ */
+export function createCacheArtifactStore(options: StoreOptions = {}): ArtifactStore {
+	const fs = options.fs;
+	if (!fs) {
+		throw new Error(
+			'createCacheArtifactStore requires a FileSystemBridge. Pass `fs`, or use ' +
+				'createTestCamera() in tests.',
+		);
+	}
+	return createArtifactStore(fs, options.directoryName);
+}