@rozenite/storage-plugin 1.7.0 → 1.8.1

package/dist/sdk/index.d.ts

@@ -0,0 +1,197 @@
+import { AgentToolContract } from '@rozenite/agent-shared';
+import { AgentToolDescriptor } from '@rozenite/agent-shared';
+
+declare type AsyncStorage = {
+    kind: 'async';
+    getAllKeys: () => Promise<readonly string[]>;
+    get: (key: string) => Promise<StorageEntry | undefined>;
+    set: (entry: StorageEntry) => Promise<void>;
+    delete: (key: string) => Promise<void>;
+    subscribe?: (callback: (key: string) => void) => StorageSubscription;
+};
+
+export declare const STORAGE_AGENT_ENTRY_TYPES: readonly ["string", "number", "boolean", "buffer"];
+
+export declare const STORAGE_AGENT_PLUGIN_ID = "@rozenite/storage-plugin";
+
+export declare type StorageAdapter = {
+    id: string;
+    name: string;
+    storages: StorageNode[];
+};
+
+export declare type StorageCapabilities = {
+    supportedTypes: StorageEntryType[];
+};
+
+export declare type StorageCreateEntryArgs = StorageWriteEntryArgs;
+
+export declare type StorageCreateEntryResult = {
+    adapterId: string;
+    storageId: string;
+    created: true;
+    key: string;
+};
+
+export declare type StorageEditEntryArgs = StorageWriteEntryArgs;
+
+export declare type StorageEditEntryResult = {
+    adapterId: string;
+    storageId: string;
+    edited: true;
+    key: string;
+};
+
+export declare type StorageEntry = {
+    key: string;
+    type: 'string';
+    value: string;
+} | {
+    key: string;
+    type: 'number';
+    value: number;
+} | {
+    key: string;
+    type: 'boolean';
+    value: boolean;
+} | {
+    key: string;
+    type: 'buffer';
+    value: number[];
+};
+
+export declare type StorageEntryType = StorageEntry['type'];
+
+export declare type StorageEntryValue = StorageEntry['value'];
+
+export declare type StorageListEntriesArgs = StorageSelection & {
+    offset?: number;
+    limit?: number;
+};
+
+export declare type StorageListEntriesResult = {
+    adapterId: string;
+    storageId: string;
+    total: number;
+    offset: number;
+    limit: number;
+    keys: string[];
+};
+
+export declare type StorageListStoragesArgs = undefined;
+
+export declare type StorageListStoragesItem = {
+    adapterId: string;
+    storageId: string;
+    adapterName: string;
+    storageName: string;
+    entryCount: number;
+    supportedTypes: StorageEntryType[];
+};
+
+export declare type StorageListStoragesResult = {
+    storages: StorageListStoragesItem[];
+};
+
+export declare type StorageNode = {
+    id: string;
+    name: string;
+    storage: SyncStorage | AsyncStorage;
+    capabilities: StorageCapabilities;
+    blacklist?: RegExp;
+};
+
+export declare type StorageReadEntryArgs = StorageSelection & {
+    key: string;
+};
+
+export declare type StorageReadEntryResult = {
+    adapterId: string;
+    storageId: string;
+    entry: StorageEntry;
+};
+
+export declare type StorageRemoveEntryArgs = StorageSelection & {
+    key: string;
+};
+
+export declare type StorageRemoveEntryResult = {
+    adapterId: string;
+    storageId: string;
+    removed: boolean;
+    key: string;
+};
+
+declare type StorageSelection = Partial<StorageTarget>;
+
+declare type StorageSubscription = {
+    remove: () => void;
+};
+
+export declare type StorageTarget = {
+    adapterId: string;
+    storageId: string;
+};
+
+export declare const storageToolDefinitions: {
+    readonly listStorages: AgentToolContract<undefined, StorageListStoragesResult>;
+    readonly listEntries: AgentToolContract<StorageListEntriesArgs, StorageListEntriesResult>;
+    readonly readEntry: AgentToolContract<StorageReadEntryArgs, StorageReadEntryResult>;
+    readonly createEntry: AgentToolContract<StorageWriteEntryArgs, StorageCreateEntryResult>;
+    readonly editEntry: AgentToolContract<StorageWriteEntryArgs, StorageEditEntryResult>;
+    readonly removeEntry: AgentToolContract<StorageRemoveEntryArgs, StorageRemoveEntryResult>;
+};
+
+export declare const storageTools: {
+    readonly listStorages: AgentToolDescriptor<undefined, StorageListStoragesResult>;
+    readonly listEntries: AgentToolDescriptor<StorageListEntriesArgs, StorageListEntriesResult>;
+    readonly readEntry: AgentToolDescriptor<StorageReadEntryArgs, StorageReadEntryResult>;
+    readonly createEntry: AgentToolDescriptor<(Partial<StorageTarget> & {
+    key: string;
+    type: "string";
+    value: string;
+    }) | (Partial<StorageTarget> & {
+    key: string;
+    type: "number";
+    value: number;
+    }) | (Partial<StorageTarget> & {
+    key: string;
+    type: "boolean";
+    value: boolean;
+    }) | (Partial<StorageTarget> & {
+    key: string;
+    type: "buffer";
+    value: number[];
+    }), StorageCreateEntryResult>;
+    readonly editEntry: AgentToolDescriptor<(Partial<StorageTarget> & {
+    key: string;
+    type: "string";
+    value: string;
+    }) | (Partial<StorageTarget> & {
+    key: string;
+    type: "number";
+    value: number;
+    }) | (Partial<StorageTarget> & {
+    key: string;
+    type: "boolean";
+    value: boolean;
+    }) | (Partial<StorageTarget> & {
+    key: string;
+    type: "buffer";
+    value: number[];
+    }), StorageEditEntryResult>;
+    readonly removeEntry: AgentToolDescriptor<StorageRemoveEntryArgs, StorageRemoveEntryResult>;
+};
+
+export declare type StorageWriteEntryArgs = StorageSelection & StorageEntry;
+
+declare type SyncStorage = {
+    kind: 'sync';
+    getAllKeys: () => string[];
+    get: (key: string) => StorageEntry | undefined;
+    set: (entry: StorageEntry) => void;
+    delete: (key: string) => void;
+    subscribe?: (callback: (key: string) => void) => StorageSubscription;
+};
+
+export { }

package/dist/sdk/index.js

@@ -0,0 +1,113 @@
+import { defineAgentToolContract as e, defineAgentToolDescriptors as i } from "@rozenite/agent-shared";
+const t = {
+  adapterId: {
+    type: "string",
+    description: "Storage adapter ID. Required when multiple adapters are configured."
+  },
+  storageId: {
+    type: "string",
+    description: "Storage node ID within the adapter. Required when multiple storages are configured."
+  }
+}, n = "@rozenite/storage-plugin", r = [
+  "string",
+  "number",
+  "boolean",
+  "buffer"
+], s = {
+  listStorages: e({
+    name: "list-storages",
+    description: "List all storage adapters and their storage nodes currently available on the device, including supported entry types and entry counts.",
+    inputSchema: { type: "object", properties: {} }
+  }),
+  listEntries: e({
+    name: "list-entries",
+    description: "List keys in a storage. This call intentionally does not return entry values to keep responses token-efficient.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        ...t,
+        offset: {
+          type: "number",
+          description: "Pagination offset. Defaults to 0."
+        },
+        limit: {
+          type: "number",
+          description: "Pagination size. Defaults to 100."
+        }
+      }
+    }
+  }),
+  readEntry: e({
+    name: "read-entry",
+    description: "Read a single storage entry value by key.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        ...t,
+        key: { type: "string", description: "Entry key." }
+      },
+      required: ["key"]
+    }
+  }),
+  createEntry: e({
+    name: "create-entry",
+    description: "Create a new storage entry. Fails if the key already exists.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        ...t,
+        key: { type: "string", description: "Entry key." },
+        type: {
+          type: "string",
+          enum: [...r],
+          description: "Entry value type. Must be one of the supported types for the target storage (see list-storages)."
+        },
+        value: {
+          description: "Entry value matching the provided type."
+        }
+      },
+      required: ["key", "type", "value"]
+    }
+  }),
+  editEntry: e({
+    name: "edit-entry",
+    description: "Edit an existing storage entry. Fails if the key does not exist.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        ...t,
+        key: { type: "string", description: "Entry key." },
+        type: {
+          type: "string",
+          enum: [...r],
+          description: "Entry value type. Must be one of the supported types for the target storage (see list-storages)."
+        },
+        value: {
+          description: "Entry value matching the provided type."
+        }
+      },
+      required: ["key", "type", "value"]
+    }
+  }),
+  removeEntry: e({
+    name: "remove-entry",
+    description: "Remove a storage entry by key.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        ...t,
+        key: { type: "string", description: "Entry key." }
+      },
+      required: ["key"]
+    }
+  })
+}, a = i(
+  n,
+  s
+);
+export {
+  r as STORAGE_AGENT_ENTRY_TYPES,
+  n as STORAGE_AGENT_PLUGIN_ID,
+  s as storageToolDefinitions,
+  a as storageTools
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rozenite/storage-plugin",
-  "version": "1.7.0",
+  "version": "1.8.1",
   "description": "Generic Storage Inspector for Rozenite.",
   "type": "module",
   "main": "./dist/react-native/index.cjs",
@@ -15,8 +15,9 @@
     "url": "https://github.com/callstackincubator/rozenite.git"
   },
   "dependencies": {
-    "@rozenite/agent-bridge": "1.7.0",
-    "@rozenite/plugin-bridge": "1.7.0"
+    "@rozenite/agent-shared": "1.8.1",
+    "@rozenite/agent-bridge": "1.8.1",
+    "@rozenite/plugin-bridge": "1.8.1"
   },
   "devDependencies": {
     "@tanstack/react-table": "^8.21.3",
@@ -37,8 +38,8 @@
     "tailwindcss-animate": "^1.0.7",
     "typescript": "~5.9.3",
     "vite": "^7.3.1",
-    "@rozenite/vite-plugin": "1.7.0",
-    "rozenite": "1.7.0"
+    "@rozenite/vite-plugin": "1.8.1",
+    "rozenite": "1.8.1"
   },
   "peerDependencies": {
     "@react-native-async-storage/async-storage": "*",
@@ -65,6 +66,12 @@
       "import": "./dist/react-native/index.js",
       "require": "./dist/react-native/index.cjs"
     },
+    "./sdk": {
+      "development": "./sdk.ts",
+      "types": "./dist/sdk/index.d.ts",
+      "import": "./dist/sdk/index.js",
+      "require": "./dist/sdk/index.cjs"
+    },
     "./package.json": "./package.json"
   },
   "publishConfig": {
@@ -74,6 +81,7 @@
     "build": "rozenite build",
     "dev": "rozenite dev",
     "typecheck": "tsc -p tsconfig.json --noEmit",
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "test": "vitest --run --passWithNoTests"
   }
 }

package/react-native.ts

@@ -30,28 +30,17 @@ const isWeb =
 const isDev = process.env.NODE_ENV !== 'production';
 const isServer = typeof window === 'undefined';
 
-if (isDev && !isWeb && !isServer) {
-  createAsyncStorageAdapter =
-    require('./src/react-native/adapters').createAsyncStorageAdapter;
-  createExpoAsyncStorageAdapter =
-    require('./src/react-native/adapters').createExpoAsyncStorageAdapter;
-  createExpoSecureStorageAdapter =
-    require('./src/react-native/adapters').createExpoSecureStorageAdapter;
-  createMMKVStorageAdapter =
-    require('./src/react-native/adapters').createMMKVStorageAdapter;
-  useRozeniteStoragePlugin =
-    require('./src/react-native/useRozeniteStoragePlugin').useRozeniteStoragePlugin;
-} else {
-  const createNoopStorageAdapter = (
-    options: { adapterId?: string; adapterName?: string } | undefined,
-    defaultId: string,
-    defaultName: string
-  ) => ({
-    id: options?.adapterId ?? defaultId,
-    name: options?.adapterName ?? defaultName,
-    storages: [],
-  });
+const createNoopStorageAdapter = (
+  options: { adapterId?: string; adapterName?: string } | undefined,
+  defaultId: string,
+  defaultName: string
+) => ({
+  id: options?.adapterId ?? defaultId,
+  name: options?.adapterName ?? defaultName,
+  storages: [],
+});
 
+if (!isDev || isServer) {
   createAsyncStorageAdapter = ((
     options: { adapterId?: string; adapterName?: string }
   ) =>
@@ -74,4 +63,27 @@ if (isDev && !isWeb && !isServer) {
     options: { adapterId?: string; adapterName?: string }
   ) => createNoopStorageAdapter(options, 'mmkv', 'MMKV')) as typeof createMMKVStorageAdapter;
   useRozeniteStoragePlugin = () => null;
+} else if (isWeb) {
+  const asyncStorageModule = require('./src/react-native/adapters/async-storage');
+  const secureStorageModule = require('./src/react-native/adapters/secure-storage');
+
+  createAsyncStorageAdapter = asyncStorageModule.createAsyncStorageAdapter;
+  createExpoAsyncStorageAdapter = asyncStorageModule.createExpoAsyncStorageAdapter;
+  createExpoSecureStorageAdapter = secureStorageModule.createExpoSecureStorageAdapter;
+  createMMKVStorageAdapter = ((
+    options: { adapterId?: string; adapterName?: string }
+  ) => createNoopStorageAdapter(options, 'mmkv', 'MMKV')) as typeof createMMKVStorageAdapter;
+  useRozeniteStoragePlugin =
+    require('./src/react-native/useRozeniteStoragePlugin').useRozeniteStoragePlugin;
+} else {
+  createAsyncStorageAdapter =
+    require('./src/react-native/adapters').createAsyncStorageAdapter;
+  createExpoAsyncStorageAdapter =
+    require('./src/react-native/adapters').createExpoAsyncStorageAdapter;
+  createExpoSecureStorageAdapter =
+    require('./src/react-native/adapters').createExpoSecureStorageAdapter;
+  createMMKVStorageAdapter =
+    require('./src/react-native/adapters').createMMKVStorageAdapter;
+  useRozeniteStoragePlugin =
+    require('./src/react-native/useRozeniteStoragePlugin').useRozeniteStoragePlugin;
 }

package/sdk.ts

@@ -0,0 +1,44 @@
+import { defineAgentToolDescriptors } from '@rozenite/agent-shared';
+import {
+  STORAGE_AGENT_ENTRY_TYPES,
+  STORAGE_AGENT_PLUGIN_ID,
+  storageToolDefinitions,
+} from './src/shared/agent-tools.js';
+
+export {
+  STORAGE_AGENT_ENTRY_TYPES,
+  STORAGE_AGENT_PLUGIN_ID,
+  storageToolDefinitions,
+};
+
+export const storageTools = defineAgentToolDescriptors(
+  STORAGE_AGENT_PLUGIN_ID,
+  storageToolDefinitions,
+);
+
+export type {
+  StorageCreateEntryArgs,
+  StorageCreateEntryResult,
+  StorageEditEntryArgs,
+  StorageEditEntryResult,
+  StorageListEntriesArgs,
+  StorageListEntriesResult,
+  StorageListStoragesArgs,
+  StorageListStoragesItem,
+  StorageListStoragesResult,
+  StorageReadEntryArgs,
+  StorageReadEntryResult,
+  StorageRemoveEntryArgs,
+  StorageRemoveEntryResult,
+  StorageWriteEntryArgs,
+} from './src/shared/agent-tools.js';
+
+export type {
+  StorageAdapter,
+  StorageCapabilities,
+  StorageEntry,
+  StorageEntryType,
+  StorageEntryValue,
+  StorageNode,
+  StorageTarget,
+} from './src/shared/types.js';

package/src/react-native/useStorageAgentTools.ts

@@ -1,131 +1,12 @@
 import { useCallback } from 'react';
-import { useRozenitePluginAgentTool, type AgentTool } from '@rozenite/agent-bridge';
+import { useRozenitePluginAgentTool } from '@rozenite/agent-bridge';
+import {
+  STORAGE_AGENT_PLUGIN_ID,
+  storageToolDefinitions,
+} from '../shared/agent-tools';
 import type { StorageEntry, StorageEntryType, StorageEntryValue } from '../shared/types';
 import type { StorageView } from './storage-view';
 
-type StorageInput = { adapterId?: string; storageId?: string };
-type KeyInput = StorageInput & { key: string };
-type SetInput = StorageInput & {
-  key: string;
-  type: StorageEntryType;
-  value: unknown;
-};
-type ListEntriesInput = StorageInput & {
-  offset?: number;
-  limit?: number;
-};
-
-const toolPrefix = '@rozenite/storage-plugin';
-const sharedStorageProperties = {
-  adapterId: {
-    type: 'string',
-    description:
-      'Storage adapter ID. Required when multiple adapters are configured.',
-  },
-  storageId: {
-    type: 'string',
-    description:
-      'Storage node ID within the adapter. Required when multiple storages are configured.',
-  },
-} as const;
-
-const listStoragesTool: AgentTool = {
-  name: 'list-storages',
-  description:
-    'List all storage adapters and their storage nodes currently available on the device, including supported entry types and entry counts.',
-  inputSchema: { type: 'object', properties: {} },
-};
-
-const listEntriesTool: AgentTool = {
-  name: 'list-entries',
-  description:
-    'List keys in a storage. This call intentionally does not return entry values to keep responses token-efficient.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      ...sharedStorageProperties,
-      offset: {
-        type: 'number',
-        description: 'Pagination offset. Defaults to 0.',
-      },
-      limit: {
-        type: 'number',
-        description: 'Pagination size. Defaults to 100.',
-      },
-    },
-  },
-};
-
-const readEntryTool: AgentTool = {
-  name: 'read-entry',
-  description: 'Read a single storage entry value by key.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      ...sharedStorageProperties,
-      key: { type: 'string', description: 'Entry key.' },
-    },
-    required: ['key'],
-  },
-};
-
-const createEntryTool: AgentTool = {
-  name: 'create-entry',
-  description: 'Create a new storage entry. Fails if the key already exists.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      ...sharedStorageProperties,
-      key: { type: 'string', description: 'Entry key.' },
-      type: {
-        type: 'string',
-        enum: ['string', 'number', 'boolean', 'buffer'],
-        description:
-          'Entry value type. Must be one of the supported types for the target storage (see list-storages).',
-      },
-      value: {
-        description: 'Entry value matching the provided type.',
-      },
-    },
-    required: ['key', 'type', 'value'],
-  },
-};
-
-const editEntryTool: AgentTool = {
-  name: 'edit-entry',
-  description: 'Edit an existing storage entry. Fails if the key does not exist.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      ...sharedStorageProperties,
-      key: { type: 'string', description: 'Entry key.' },
-      type: {
-        type: 'string',
-        enum: ['string', 'number', 'boolean', 'buffer'],
-        description:
-          'Entry value type. Must be one of the supported types for the target storage (see list-storages).',
-      },
-      value: {
-        description: 'Entry value matching the provided type.',
-      },
-    },
-    required: ['key', 'type', 'value'],
-  },
-};
-
-const removeEntryTool: AgentTool = {
-  name: 'remove-entry',
-  description: 'Remove a storage entry by key.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      ...sharedStorageProperties,
-      key: { type: 'string', description: 'Entry key.' },
-    },
-    required: ['key'],
-  },
-};
-
 const parseValueForType = (
   type: StorageEntryType,
   value: unknown
@@ -202,8 +83,8 @@ export const useStorageAgentTools = (views: StorageView[]) => {
   );
 
   useRozenitePluginAgentTool({
-    pluginId: toolPrefix,
-    tool: listStoragesTool,
+    pluginId: STORAGE_AGENT_PLUGIN_ID,
+    tool: storageToolDefinitions.listStorages,
     handler: async () => ({
       storages: await Promise.all(
         views.map(async (view) => ({
@@ -218,9 +99,9 @@ export const useStorageAgentTools = (views: StorageView[]) => {
     }),
   });
 
-  useRozenitePluginAgentTool<ListEntriesInput>({
-    pluginId: toolPrefix,
-    tool: listEntriesTool,
+  useRozenitePluginAgentTool({
+    pluginId: STORAGE_AGENT_PLUGIN_ID,
+    tool: storageToolDefinitions.listEntries,
     handler: async ({ adapterId, storageId, offset = 0, limit = 100 }) => {
       const view = resolveStorage(adapterId, storageId);
       const allKeys = await view.getAllKeys();
@@ -239,12 +120,9 @@ export const useStorageAgentTools = (views: StorageView[]) => {
     },
   });
 
-  useRozenitePluginAgentTool<
-    KeyInput,
-    { adapterId: string; storageId: string; entry: StorageEntry }
-  >({
-    pluginId: toolPrefix,
-    tool: readEntryTool,
+  useRozenitePluginAgentTool({
+    pluginId: STORAGE_AGENT_PLUGIN_ID,
+    tool: storageToolDefinitions.readEntry,
     handler: async ({ adapterId, storageId, key }) => {
       const view = resolveStorage(adapterId, storageId);
       const entry = await view.get(key);
@@ -263,9 +141,9 @@ export const useStorageAgentTools = (views: StorageView[]) => {
     },
   });
 
-  useRozenitePluginAgentTool<SetInput>({
-    pluginId: toolPrefix,
-    tool: createEntryTool,
+  useRozenitePluginAgentTool({
+    pluginId: STORAGE_AGENT_PLUGIN_ID,
+    tool: storageToolDefinitions.createEntry,
     handler: async ({ adapterId, storageId, key, type, value }) => {
       const view = resolveStorage(adapterId, storageId);
       const existing = await view.get(key);
@@ -282,15 +160,15 @@ export const useStorageAgentTools = (views: StorageView[]) => {
       return {
         adapterId: view.target.adapterId,
         storageId: view.target.storageId,
-        created: true,
+        created: true as const,
         key,
       };
     },
   });
 
-  useRozenitePluginAgentTool<SetInput>({
-    pluginId: toolPrefix,
-    tool: editEntryTool,
+  useRozenitePluginAgentTool({
+    pluginId: STORAGE_AGENT_PLUGIN_ID,
+    tool: storageToolDefinitions.editEntry,
     handler: async ({ adapterId, storageId, key, type, value }) => {
       const view = resolveStorage(adapterId, storageId);
       const existing = await view.get(key);
@@ -307,15 +185,15 @@ export const useStorageAgentTools = (views: StorageView[]) => {
       return {
         adapterId: view.target.adapterId,
         storageId: view.target.storageId,
-        edited: true,
+        edited: true as const,
         key,
       };
     },
   });
 
-  useRozenitePluginAgentTool<KeyInput>({
-    pluginId: toolPrefix,
-    tool: removeEntryTool,
+  useRozenitePluginAgentTool({
+    pluginId: STORAGE_AGENT_PLUGIN_ID,
+    tool: storageToolDefinitions.removeEntry,
     handler: async ({ adapterId, storageId, key }) => {
       const view = resolveStorage(adapterId, storageId);
       const existed = !!(await view.get(key));