react-native-storage-inspector 1.0.2 → 1.0.4

package/README.md

@@ -49,12 +49,11 @@ The component fills its container. The consumer is responsible for header, back
 
 ### Props
 
-| Prop              | Type                | Description                                                                                                                   |
-| ----------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
-| `mmkvInstances`   | `MMKV[]`            | **Required for MMKV.** Pass your MMKV instances to inspect.                                                                   |
-| `secureStoreKeys` | `string[]`          | **Required for Secure Store.** Keys to list (no list API).                                                                    |
-| `keychainKeys`    | `string[]`          | Optional. Only for internet credentials (no list API). Generic passwords auto-discovered via `getAllGenericPasswordServices`. |
-| `customAdapters`  | `IStorageAdapter[]` | Optional. Custom adapters for other storages.                                                                                 |
+| Prop              | Type                | Description                                                                                       |
+| ----------------- | ------------------- | ------------------------------------------------------------------------------------------------- |
+| `mmkvInstances`   | `MMKV[]`            | **Required for MMKV.** Pass your MMKV instances to inspect.                                       |
+| `secureStoreKeys` | `string[]`          | Optional. Known keys for Secure Store (no list API). Merged with keys persisted by the inspector. |
+| `customAdapters`  | `IStorageAdapter[]` | Optional. Custom adapters for other storages.                                                     |
 
 ## Expo
 
@@ -92,6 +91,7 @@ interface IStorageAdapter {
 ## Development
 
 ```bash
+npm run commit       # Guided commit (Commitizen) – prompts for type, scope, message
 npm run format       # Format all files with Prettier
 npm run format:check # Check formatting (fails if any file is unformatted)
 npm run lint         # Same as format:check
@@ -99,14 +99,9 @@ npm test             # Run tests
 npm run build        # Build src/ to dist/
 ```
 
-- **Formatting:** No auto-format. Run `npm run format` to fix. **Pre-commit** runs `format:check`; **pre-push** runs `format:check`, `test`, and `build`.
-- **Commits:** Use [Conventional Commits](https://www.conventionalcommits.org/) (enforced by `commit-msg` hook).
-- **Before publish:** `prepublishOnly` runs `format:check`, `test`, and `build`.
-
-### Publishing
-
-1. Run `npm version patch` (or `minor`/`major`).
-2. Run `npm publish` (prepublishOnly will run checks and build).
+- **Commits:** Use `npm run commit` for guided [Conventional Commits](https://www.conventionalcommits.org/), or write messages by hand; **Commitlint** (via `commit-msg` hook) enforces the format.
+- **Formatting:** Run `npm run format` to fix. **Pre-commit** runs `format:check`.
+- **Releases:** Version and npm publish are automated by **semantic-release** on push to `main`. See [docs/RELEASES.md](docs/RELEASES.md) for Commitizen, Commitlint, and semantic-release in detail.
 
 See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for full guidelines. [Code of Conduct](docs/CODE_OF_CONDUCT.md).
 

package/dist/index.d.mts

@@ -16,99 +16,22 @@ interface IStorageAdapter {
     isAvailable(): boolean;
 }
 
-/**
- * AsyncStorage-compatible module interface.
- * Pass your AsyncStorage instance to avoid Metro "unknown module" errors in Expo:
- * @example
- * import AsyncStorage from '@react-native-async-storage/async-storage';
- * createAsyncStorageAdapter(AsyncStorage)
- */
-type AsyncStorageModule = {
-    getAllKeys(): Promise<string[]>;
-    getItem(key: string): Promise<string | null>;
-    setItem(key: string, value: string): Promise<void>;
-    removeItem(key: string): Promise<void>;
-};
-/**
- * Creates an AsyncStorage adapter. Pass the AsyncStorage instance for reliable
- * bundling in Expo/Metro (avoids "unknown module" errors):
- *
- * @example
- * import AsyncStorage from '@react-native-async-storage/async-storage';
- * createAsyncStorageAdapter(AsyncStorage)
- */
-declare function createAsyncStorageAdapter(instance?: AsyncStorageModule | null): IStorageAdapter;
-
-/**
- * Keychain-compatible module. Pass your keychain instance to avoid Metro
- * "unknown module" errors in Expo.
- */
-type KeychainModule = {
-    getAllGenericPasswordServices?(options?: object): Promise<string[]>;
-    getGenericPassword?(options?: {
-        service?: string;
-    }): Promise<{
-        password: string;
-    } | false>;
-    setGenericPassword?(username: string, password: string, options?: {
-        service?: string;
-    }): Promise<{
-        storage: string;
-    } | false>;
-    resetGenericPassword?(options?: {
-        service?: string;
-    }): Promise<void>;
-    setInternetCredentials(server: string, username: string, password: string): Promise<{
-        storage: string;
-    } | false>;
-    getInternetCredentials(server: string): Promise<{
-        username: string;
-        password: string;
-    } | null>;
-    resetInternetCredentials(server: string): Promise<void>;
-};
-/**
- * Keychain adapter. Pass the keychain instance for reliable bundling in Expo:
- * @example import * as Keychain from 'react-native-keychain';
- * createKeychainAdapter([], Keychain)
- */
-declare function createKeychainAdapter(knownKeys?: string[], instance?: KeychainModule | null): IStorageAdapter;
-
-/**
- * expo-secure-store compatible module. Pass the module to avoid Metro
- * "unknown module" errors in Expo.
- */
-type SecureStoreModule = {
-    getItemAsync(key: string): Promise<string | null>;
-    setItemAsync(key: string, value: string): Promise<void>;
-    deleteItemAsync(key: string): Promise<void>;
+/** Raw MMKV instance from createMMKV() (react-native-mmkv). */
+type MMKVInstance = {
+    getAllKeys(): string[];
+    getString(key: string): string | undefined;
+    set(key: string, value: string | number | boolean): void;
+    remove(key: string): void | boolean;
 };
-/**
- * expo-secure-store has no API to list all keys. Pass knownKeys to inspect
- * those entries. Pass the module for reliable bundling in Expo:
- * @example import * as SecureStore from 'expo-secure-store';
- * createSecureStoreAdapter([], SecureStore)
- */
-declare function createSecureStoreAdapter(knownKeys?: string[], instance?: SecureStoreModule | null): IStorageAdapter;
+declare function createMMKVAdapter(instance: MMKVInstance, name?: string): IStorageAdapter;
 
 interface StorageInspectorProps {
-    mmkvInstances?: Array<{
-        getAllKeys(): string[];
-        getString(k: string): string | undefined;
-        set(k: string, v: string | number | boolean): void;
-        delete(k: string): void;
-    }>;
-    /** Pass AsyncStorage to avoid Metro "unknown module" in Expo. */
-    asyncStorageInstance?: AsyncStorageModule | null;
-    keychainKeys?: string[];
-    /** Pass Keychain module to avoid Metro "unknown module" in Expo. */
-    keychainInstance?: KeychainModule | null;
+    /** Raw MMKV instances from createMMKV() (react-native-mmkv). */
+    mmkvInstances?: MMKVInstance[];
     secureStoreKeys?: string[];
-    /** Pass SecureStore module to avoid Metro "unknown module" in Expo. */
-    secureStoreInstance?: SecureStoreModule | null;
     customAdapters?: IStorageAdapter[];
 }
-declare function StorageInspector({ mmkvInstances, asyncStorageInstance, keychainKeys: keychainKeysProp, keychainInstance, secureStoreKeys: secureStoreKeysProp, secureStoreInstance, customAdapters, }: StorageInspectorProps): React.JSX.Element;
+declare function StorageInspector(props: StorageInspectorProps): React.JSX.Element;
 
 /**
  * Centralized user-facing text for the storage inspector.
@@ -116,19 +39,18 @@ declare function StorageInspector({ mmkvInstances, asyncStorageInstance, keychai
  */
 declare const strings: {
     readonly noAdapterAvailable: "No storage adapter available. Install at least one of: react-native-mmkv, @react-native-async-storage/async-storage, react-native-keychain, expo-secure-store";
-    readonly keychainHint: "No generic password items yet. Add a key using + above, or pass keychainKeys for internet credentials.";
+    readonly keychainHint: "No generic password items yet. Add a key using + above.";
     readonly secureStoreHint: "Secure Store has no list API. Pass secureStoreKeys prop with known keys, or add a key using + above.";
     readonly loading: "Loading…";
     readonly noItems: "No items";
     readonly valueLabel: "Value";
-    readonly emptyValue: "(empty)";
     readonly charCount: (n: number) => string;
     readonly deleteItemTitle: (key: string) => string;
     readonly deleteItemMessage: (key: string) => string;
     readonly clearAllTitle: (name: string) => string;
     readonly clearAllMessage: (count: number, name: string) => string;
     readonly storageNotAvailable: "This storage is not available.";
-    readonly keychainHintShort: "No items yet. Add a key below, or pass keychainKeys for internet credentials.";
+    readonly keychainHintShort: "No items yet. Add a key below.";
     readonly edit: "Edit";
     readonly delete: "Delete";
     readonly addItem: "Add item";
@@ -163,16 +85,61 @@ declare const theme: {
         readonly textSecondary: "#666666";
         readonly textMuted: "#999999";
         readonly inverted: "#ffffff";
+        readonly overlayBackdrop: "rgba(0,0,0,0.5)";
     };
 };
 type Theme = typeof theme;
 
-type MMKVInstance = {
-    getAllKeys(): string[];
-    getString(key: string): string | undefined;
-    set(key: string, value: string | number | boolean): void;
-    delete(key: string): void;
+/**
+ * AsyncStorage-compatible module interface.
+ */
+type AsyncStorageModule = {
+    getAllKeys(): Promise<string[]>;
+    getItem(key: string): Promise<string | null>;
+    setItem(key: string, value: string): Promise<void>;
+    removeItem(key: string): Promise<void>;
 };
-declare function createMMKVAdapter(instance: MMKVInstance, name?: string): IStorageAdapter;
+/**
+ * Creates an AsyncStorage adapter.
+ */
+declare function createAsyncStorageAdapter(): IStorageAdapter;
+
+/**
+ * Keychain-compatible module (generic password only).
+ */
+type KeychainModule = {
+    getAllGenericPasswordServices?(options?: object): Promise<string[]>;
+    getGenericPassword?(options?: {
+        service?: string;
+    }): Promise<{
+        password: string;
+    } | false>;
+    setGenericPassword?(username: string, password: string, options?: {
+        service?: string;
+    }): Promise<{
+        storage: string;
+    } | false>;
+    resetGenericPassword?(options?: {
+        service?: string;
+    }): Promise<void>;
+};
+/**
+ * Creates a Keychain adapter.
+ */
+declare function createKeychainAdapter(): IStorageAdapter;
+
+/**
+ * expo-secure-store compatible module. Pass the module to avoid Metro
+ * "unknown module" errors in Expo.
+ */
+type SecureStoreModule = {
+    getItemAsync(key: string): Promise<string | null>;
+    setItemAsync(key: string, value: string): Promise<void>;
+    deleteItemAsync(key: string): Promise<void>;
+};
+/**
+ * Creates a Secure Store adapter. Since expo-secure-store has no API to list all keys, we persist the list of keys in Secure Store.
+ */
+declare function createSecureStoreAdapter(knownKeys?: string[]): IStorageAdapter;
 
-export { type AsyncStorageModule, type IStorageAdapter, type KeychainModule, type SecureStoreModule, StorageInspector, type StorageInspectorProps, type StorageItem, type Theme, createAsyncStorageAdapter, createKeychainAdapter, createMMKVAdapter, createSecureStoreAdapter, strings, theme };
+export { type AsyncStorageModule, type IStorageAdapter, type KeychainModule, type MMKVInstance, type SecureStoreModule, StorageInspector, type StorageInspectorProps, type StorageItem, type Theme, createAsyncStorageAdapter, createKeychainAdapter, createMMKVAdapter, createSecureStoreAdapter, strings, theme };

package/dist/index.d.ts

@@ -16,99 +16,22 @@ interface IStorageAdapter {
     isAvailable(): boolean;
 }
 
-/**
- * AsyncStorage-compatible module interface.
- * Pass your AsyncStorage instance to avoid Metro "unknown module" errors in Expo:
- * @example
- * import AsyncStorage from '@react-native-async-storage/async-storage';
- * createAsyncStorageAdapter(AsyncStorage)
- */
-type AsyncStorageModule = {
-    getAllKeys(): Promise<string[]>;
-    getItem(key: string): Promise<string | null>;
-    setItem(key: string, value: string): Promise<void>;
-    removeItem(key: string): Promise<void>;
-};
-/**
- * Creates an AsyncStorage adapter. Pass the AsyncStorage instance for reliable
- * bundling in Expo/Metro (avoids "unknown module" errors):
- *
- * @example
- * import AsyncStorage from '@react-native-async-storage/async-storage';
- * createAsyncStorageAdapter(AsyncStorage)
- */
-declare function createAsyncStorageAdapter(instance?: AsyncStorageModule | null): IStorageAdapter;
-
-/**
- * Keychain-compatible module. Pass your keychain instance to avoid Metro
- * "unknown module" errors in Expo.
- */
-type KeychainModule = {
-    getAllGenericPasswordServices?(options?: object): Promise<string[]>;
-    getGenericPassword?(options?: {
-        service?: string;
-    }): Promise<{
-        password: string;
-    } | false>;
-    setGenericPassword?(username: string, password: string, options?: {
-        service?: string;
-    }): Promise<{
-        storage: string;
-    } | false>;
-    resetGenericPassword?(options?: {
-        service?: string;
-    }): Promise<void>;
-    setInternetCredentials(server: string, username: string, password: string): Promise<{
-        storage: string;
-    } | false>;
-    getInternetCredentials(server: string): Promise<{
-        username: string;
-        password: string;
-    } | null>;
-    resetInternetCredentials(server: string): Promise<void>;
-};
-/**
- * Keychain adapter. Pass the keychain instance for reliable bundling in Expo:
- * @example import * as Keychain from 'react-native-keychain';
- * createKeychainAdapter([], Keychain)
- */
-declare function createKeychainAdapter(knownKeys?: string[], instance?: KeychainModule | null): IStorageAdapter;
-
-/**
- * expo-secure-store compatible module. Pass the module to avoid Metro
- * "unknown module" errors in Expo.
- */
-type SecureStoreModule = {
-    getItemAsync(key: string): Promise<string | null>;
-    setItemAsync(key: string, value: string): Promise<void>;
-    deleteItemAsync(key: string): Promise<void>;
+/** Raw MMKV instance from createMMKV() (react-native-mmkv). */
+type MMKVInstance = {
+    getAllKeys(): string[];
+    getString(key: string): string | undefined;
+    set(key: string, value: string | number | boolean): void;
+    remove(key: string): void | boolean;
 };
-/**
- * expo-secure-store has no API to list all keys. Pass knownKeys to inspect
- * those entries. Pass the module for reliable bundling in Expo:
- * @example import * as SecureStore from 'expo-secure-store';
- * createSecureStoreAdapter([], SecureStore)
- */
-declare function createSecureStoreAdapter(knownKeys?: string[], instance?: SecureStoreModule | null): IStorageAdapter;
+declare function createMMKVAdapter(instance: MMKVInstance, name?: string): IStorageAdapter;
 
 interface StorageInspectorProps {
-    mmkvInstances?: Array<{
-        getAllKeys(): string[];
-        getString(k: string): string | undefined;
-        set(k: string, v: string | number | boolean): void;
-        delete(k: string): void;
-    }>;
-    /** Pass AsyncStorage to avoid Metro "unknown module" in Expo. */
-    asyncStorageInstance?: AsyncStorageModule | null;
-    keychainKeys?: string[];
-    /** Pass Keychain module to avoid Metro "unknown module" in Expo. */
-    keychainInstance?: KeychainModule | null;
+    /** Raw MMKV instances from createMMKV() (react-native-mmkv). */
+    mmkvInstances?: MMKVInstance[];
     secureStoreKeys?: string[];
-    /** Pass SecureStore module to avoid Metro "unknown module" in Expo. */
-    secureStoreInstance?: SecureStoreModule | null;
     customAdapters?: IStorageAdapter[];
 }
-declare function StorageInspector({ mmkvInstances, asyncStorageInstance, keychainKeys: keychainKeysProp, keychainInstance, secureStoreKeys: secureStoreKeysProp, secureStoreInstance, customAdapters, }: StorageInspectorProps): React.JSX.Element;
+declare function StorageInspector(props: StorageInspectorProps): React.JSX.Element;
 
 /**
  * Centralized user-facing text for the storage inspector.
@@ -116,19 +39,18 @@ declare function StorageInspector({ mmkvInstances, asyncStorageInstance, keychai
  */
 declare const strings: {
     readonly noAdapterAvailable: "No storage adapter available. Install at least one of: react-native-mmkv, @react-native-async-storage/async-storage, react-native-keychain, expo-secure-store";
-    readonly keychainHint: "No generic password items yet. Add a key using + above, or pass keychainKeys for internet credentials.";
+    readonly keychainHint: "No generic password items yet. Add a key using + above.";
     readonly secureStoreHint: "Secure Store has no list API. Pass secureStoreKeys prop with known keys, or add a key using + above.";
     readonly loading: "Loading…";
     readonly noItems: "No items";
     readonly valueLabel: "Value";
-    readonly emptyValue: "(empty)";
     readonly charCount: (n: number) => string;
     readonly deleteItemTitle: (key: string) => string;
     readonly deleteItemMessage: (key: string) => string;
     readonly clearAllTitle: (name: string) => string;
     readonly clearAllMessage: (count: number, name: string) => string;
     readonly storageNotAvailable: "This storage is not available.";
-    readonly keychainHintShort: "No items yet. Add a key below, or pass keychainKeys for internet credentials.";
+    readonly keychainHintShort: "No items yet. Add a key below.";
     readonly edit: "Edit";
     readonly delete: "Delete";
     readonly addItem: "Add item";
@@ -163,16 +85,61 @@ declare const theme: {
         readonly textSecondary: "#666666";
         readonly textMuted: "#999999";
         readonly inverted: "#ffffff";
+        readonly overlayBackdrop: "rgba(0,0,0,0.5)";
     };
 };
 type Theme = typeof theme;
 
-type MMKVInstance = {
-    getAllKeys(): string[];
-    getString(key: string): string | undefined;
-    set(key: string, value: string | number | boolean): void;
-    delete(key: string): void;
+/**
+ * AsyncStorage-compatible module interface.
+ */
+type AsyncStorageModule = {
+    getAllKeys(): Promise<string[]>;
+    getItem(key: string): Promise<string | null>;
+    setItem(key: string, value: string): Promise<void>;
+    removeItem(key: string): Promise<void>;
 };
-declare function createMMKVAdapter(instance: MMKVInstance, name?: string): IStorageAdapter;
+/**
+ * Creates an AsyncStorage adapter.
+ */
+declare function createAsyncStorageAdapter(): IStorageAdapter;
+
+/**
+ * Keychain-compatible module (generic password only).
+ */
+type KeychainModule = {
+    getAllGenericPasswordServices?(options?: object): Promise<string[]>;
+    getGenericPassword?(options?: {
+        service?: string;
+    }): Promise<{
+        password: string;
+    } | false>;
+    setGenericPassword?(username: string, password: string, options?: {
+        service?: string;
+    }): Promise<{
+        storage: string;
+    } | false>;
+    resetGenericPassword?(options?: {
+        service?: string;
+    }): Promise<void>;
+};
+/**
+ * Creates a Keychain adapter.
+ */
+declare function createKeychainAdapter(): IStorageAdapter;
+
+/**
+ * expo-secure-store compatible module. Pass the module to avoid Metro
+ * "unknown module" errors in Expo.
+ */
+type SecureStoreModule = {
+    getItemAsync(key: string): Promise<string | null>;
+    setItemAsync(key: string, value: string): Promise<void>;
+    deleteItemAsync(key: string): Promise<void>;
+};
+/**
+ * Creates a Secure Store adapter. Since expo-secure-store has no API to list all keys, we persist the list of keys in Secure Store.
+ */
+declare function createSecureStoreAdapter(knownKeys?: string[]): IStorageAdapter;
 
-export { type AsyncStorageModule, type IStorageAdapter, type KeychainModule, type SecureStoreModule, StorageInspector, type StorageInspectorProps, type StorageItem, type Theme, createAsyncStorageAdapter, createKeychainAdapter, createMMKVAdapter, createSecureStoreAdapter, strings, theme };
+export { type AsyncStorageModule, type IStorageAdapter, type KeychainModule, type MMKVInstance, type SecureStoreModule, StorageInspector, type StorageInspectorProps, type StorageItem, type Theme, createAsyncStorageAdapter, createKeychainAdapter, createMMKVAdapter, createSecureStoreAdapter, strings, theme };