react-native-nitro-storage 0.7.0 → 0.8.0

package/src/storage-events.ts

@@ -1,4 +1,4 @@
-import { StorageScope } from "./Storage.types";
+import type { StorageScope } from "./Storage.types";
 
 export type StorageChangeOperation =
   | "set"
@@ -10,6 +10,7 @@ export type StorageChangeOperation =
   | "removeBatch"
   | "import"
   | "expire"
+  | "rollback"
   | "external";
 
 export type StorageChangeSource = "memory" | "native" | "web" | "external";

package/src/storage-platform.ts

@@ -0,0 +1,16 @@
+import type { StorageCore } from "./storage-core";
+import type {
+  SecurityCapabilities,
+  StorageCapabilities,
+} from "./storage-runtime";
+import type { AccessControl, StorageScope } from "./Storage.types";
+
+export type PlatformStorage = StorageCore["storage"] & {
+  setAccessControl(level: AccessControl): void;
+  setSecureWritesAsync(enabled: boolean): void;
+  setKeychainAccessGroup(group: string): void;
+  getCapabilities(): StorageCapabilities;
+  getSecurityCapabilities(): SecurityCapabilities;
+};
+
+export type PlatformScope = StorageScope;

package/src/storage-runtime.ts

@@ -56,6 +56,15 @@ export type SecureStorageMetadata = {
 
 const STORAGE_ERROR_TAG_PATTERN = /\[nitro-error:([a-z_]+)\]/;
 
+const STORAGE_ERROR_CODES = new Set<StorageErrorCode>([
+  "keychain_locked",
+  "authentication_required",
+  "key_invalidated",
+  "storage_corruption",
+  "biometric_unavailable",
+  "unsupported",
+]);
+
 export function getStorageErrorCode(
   err: unknown,
 ): StorageErrorCode | undefined {
@@ -63,56 +72,13 @@ export function getStorageErrorCode(
     return undefined;
   }
 
-  const message = err.message;
-  const taggedCode = message.match(STORAGE_ERROR_TAG_PATTERN)?.[1];
-
-  if (
-    taggedCode === "keychain_locked" ||
-    taggedCode === "authentication_required" ||
-    taggedCode === "key_invalidated" ||
-    taggedCode === "storage_corruption" ||
-    taggedCode === "biometric_unavailable" ||
-    taggedCode === "unsupported"
-  ) {
-    return taggedCode;
-  }
-
-  if (message.includes("errSecInteractionNotAllowed")) {
-    return "keychain_locked";
-  }
-
-  if (
-    message.includes("UserNotAuthenticatedException") ||
-    message.includes("KeyStoreException") ||
-    message.includes("android.security.keystore")
-  ) {
-    return "authentication_required";
-  }
+  const taggedCode = err.message.match(STORAGE_ERROR_TAG_PATTERN)?.[1];
 
   if (
-    message.includes("KeyPermanentlyInvalidatedException") ||
-    message.includes("InvalidKeyException")
+    taggedCode !== undefined &&
+    STORAGE_ERROR_CODES.has(taggedCode as StorageErrorCode)
   ) {
-    return "key_invalidated";
-  }
-
-  if (
-    message.includes("AEADBadTagException") ||
-    message.toLowerCase().includes("storage corruption") ||
-    message.toLowerCase().includes("corrupted storage")
-  ) {
-    return "storage_corruption";
-  }
-
-  if (
-    message.toLowerCase().includes("biometric storage unavailable") ||
-    message.toLowerCase().includes("biometric storage is not available")
-  ) {
-    return "biometric_unavailable";
-  }
-
-  if (message.toLowerCase().includes("unsupported")) {
-    return "unsupported";
+    return taggedCode as StorageErrorCode;
   }
 
   return undefined;

package/src/testing.ts

@@ -1,22 +1,27 @@
-import { StorageScope, AccessControl } from "./Storage.types";
 import { assertAccessControlLevel } from "./shared";
 import type { NonMemoryScope } from "./shared";
-import type {
-  SecurityCapabilities,
-  StorageCapabilities,
-} from "./storage-runtime";
 import {
   createStorageCore,
   type StorageCoreAdapter,
   type StorageCoreBackend,
   type StorageCoreInternals,
 } from "./storage-core";
+import type {
+  SecurityCapabilities,
+  StorageCapabilities,
+} from "./storage-runtime";
+import { StorageScope, AccessControl } from "./Storage.types";
 
 export { StorageScope, AccessControl, BiometricLevel } from "./Storage.types";
 export { isKeychainLockedError } from "./shared";
 export { migrateFromMMKV } from "./migration";
 export { getStorageErrorCode } from "./storage-runtime";
 export { createIndexedDBBackend } from "./indexeddb-backend";
+export {
+  describeWebBackendCapabilities,
+  isIndexedDBWebBackend,
+  type WebBackendCapabilities,
+} from "./web-backend-contract";
 export {
   useSetStorage,
   useStorage,
@@ -66,6 +71,7 @@ export type {
   StorageKeyRef,
   TransactionContext,
 } from "./storage-core";
+export type { PlatformScope, PlatformStorage } from "./storage-platform";
 
 const TEST_SECURE_BACKEND = "in-memory-test";
 
@@ -144,7 +150,9 @@ function createInMemoryBackend(): InMemoryBackend {
       biometricStore.clear();
     },
     resetState: () => {
-      stores.forEach((store) => store.clear());
+      stores.forEach((store) => {
+        store.clear();
+      });
       biometricStore.clear();
     },
   };
@@ -159,7 +167,6 @@ function buildTestingModule() {
     backend,
     changeSource: "native",
     applyAccessControlOnSecureRawWrite: true,
-    flushDiskWritesOnImport: false,
     ensureScopeSubscription: (_scope: NonMemoryScope) => {},
     maybeCleanupScopeSubscription: (_scope: NonMemoryScope) => {},
     onWillEmitChanges: () => {},

package/src/web-backend-contract.ts

@@ -0,0 +1,34 @@
+import type { WebStorageBackend } from "./web-storage-backend";
+
+export type WebBackendCapabilities = {
+  buffered: boolean;
+  flushable: boolean;
+  closable: boolean;
+  subscribable: boolean;
+};
+
+export function describeWebBackendCapabilities(
+  backend: WebStorageBackend | undefined,
+): WebBackendCapabilities {
+  if (!backend) {
+    return {
+      buffered: false,
+      flushable: false,
+      closable: false,
+      subscribable: false,
+    };
+  }
+
+  return {
+    buffered: backend.name?.startsWith("indexeddb:") ?? false,
+    flushable: typeof backend.flush === "function",
+    closable: typeof backend.close === "function",
+    subscribable: typeof backend.subscribe === "function",
+  };
+}
+
+export function isIndexedDBWebBackend(
+  backend: WebStorageBackend | undefined,
+): boolean {
+  return backend?.name?.startsWith("indexeddb:") ?? false;
+}

package/src/web-storage-backend.ts

@@ -1,4 +1,4 @@
-import { StorageScope } from "./Storage.types";
+import type { StorageScope } from "./Storage.types";
 
 export type WebStorageChangeEvent = {
   key: string | null;