@simplysm/capacitor-plugin-usb-storage 13.0.0-beta.21 → 13.0.0-beta.23

package/README.md

@@ -41,6 +41,10 @@ npx cap sync
 
 The main entry point of the plugin. All methods are static and operate asynchronously.
 
+```typescript
+import { UsbStorage } from "@simplysm/capacitor-plugin-usb-storage";
+```
+
 | Method | Return Type | Description |
 |--------|-----------|------|
 | `getDevices()` | `Promise<IUsbDeviceInfo[]>` | Retrieve list of connected USB devices |
@@ -49,8 +53,29 @@ The main entry point of the plugin. All methods are static and operate asynchron
 | `readdir(filter, dirPath)` | `Promise<IUsbFileInfo[]>` | Read list of files/folders in directory |
 | `read(filter, filePath)` | `Promise<Bytes \| undefined>` | Read file contents as binary |
 
+### IUsbStoragePlugin (Raw Plugin Interface)
+
+The low-level Capacitor plugin interface. Most users should use the `UsbStorage` static class instead.
+This interface is useful for advanced scenarios such as creating custom plugin implementations.
+
+```typescript
+import type { IUsbStoragePlugin } from "@simplysm/capacitor-plugin-usb-storage";
+```
+
+| Method | Return Type | Description |
+|--------|-----------|------|
+| `getDevices()` | `Promise<{ devices: IUsbDeviceInfo[] }>` | Get connected USB devices (raw) |
+| `requestPermission(options)` | `Promise<{ granted: boolean }>` | Request USB permission (raw) |
+| `hasPermission(options)` | `Promise<{ granted: boolean }>` | Check USB permission (raw) |
+| `readdir(options)` | `Promise<{ files: IUsbFileInfo[] }>` | List directory contents (raw) |
+| `read(options)` | `Promise<{ data: string \| null }>` | Read file as Base64 string (raw) |
+
 ### Interfaces
 
+```typescript
+import type { IUsbDeviceInfo, IUsbDeviceFilter, IUsbFileInfo } from "@simplysm/capacitor-plugin-usb-storage";
+```
+
 #### IUsbDeviceInfo
 
 Represents USB device information.
@@ -187,6 +212,13 @@ In web environments, the `UsbStorageWeb` class is automatically used, providing
 
 `UsbStorageWeb` provides methods for adding virtual devices and files for development and testing purposes.
 
+> **Note**: `UsbStorageWeb` is not re-exported from the main package entry point.
+> Import it via a deep path as shown below.
+
+```typescript
+import { UsbStorageWeb } from "@simplysm/capacitor-plugin-usb-storage/dist/web/UsbStorageWeb";
+```
+
 | Method | Description |
 |--------|------|
 | `addVirtualDevice(device)` | Register a virtual USB device |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simplysm/capacitor-plugin-usb-storage",
-  "version": "13.0.0-beta.21",
+  "version": "13.0.0-beta.23",
   "description": "심플리즘 패키지 - Capacitor USB Storage Plugin",
   "author": "김석래",
   "repository": {
@@ -22,7 +22,7 @@
     }
   },
   "dependencies": {
-    "@simplysm/core-common": "13.0.0-beta.21"
+    "@simplysm/core-common": "13.0.0-beta.23"
   },
   "peerDependencies": {
     "@capacitor/core": "^7.4.4"