@onekeyfe/react-native-cloud-kit-module 3.0.157-alpha.275 → 3.0.157-alpha.276

package/README.md

@@ -0,0 +1,55 @@
+# @onekeyfe/react-native-cloud-kit-module
+
+CloudKit account and private-record access for OneKey React Native applications.
+The iOS implementation uses the application's default CloudKit container and
+its private database. The caller owns record schema, serialization and deciding
+which application data may be stored in iCloud.
+
+## Installation
+
+```sh
+yarn add @onekeyfe/react-native-cloud-kit-module react-native-nitro-modules
+```
+
+Install the application's iOS pods and rebuild the native application. Configure
+the application's iCloud/CloudKit entitlements and container before using the
+module; package installation does not provision them.
+
+## Usage
+
+```ts
+import { CloudKit } from '@onekeyfe/react-native-cloud-kit-module';
+
+if (await CloudKit.isAvailable()) {
+  const account = await CloudKit.getAccountInfo();
+  const record = await CloudKit.fetchRecord({
+    recordType: 'Backup',
+    recordID: 'example-record',
+  });
+}
+```
+
+## API
+
+| Method | Purpose |
+| --- | --- |
+| `isAvailable()` | Check iCloud account availability. |
+| `getAccountInfo()` | Return account status and optional container user ID. |
+| `saveRecord({ recordType, recordID, data, meta })` | Store string data and metadata. |
+| `fetchRecord({ recordType, recordID })` | Read a record or return `null`. |
+| `recordExists({ recordType, recordID })` | Check for a record. |
+| `deleteRecord({ recordType, recordID })` | Remove a record. |
+| `queryRecords({ recordType })` | Return records matching a type. |
+
+Records include IDs, type, string data/metadata and creation/modification times.
+Handle promise failures in the application, including unavailable accounts and
+CloudKit errors. Android exposes placeholder methods and reports unavailable;
+it does not provide CloudKit storage. Do not treat a placeholder write result
+as a persisted backup.
+
+See [src/CloudKitModule.nitro.ts](src/CloudKitModule.nitro.ts) for the exported
+parameter and result types.
+
+## License
+
+MIT.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@onekeyfe/react-native-cloud-kit-module",
-  "version": "3.0.157-alpha.275",
-  "description": "react-native-cloud-kit-module",
+  "version": "3.0.157-alpha.276",
+  "description": "CloudKit account and private record access for OneKey on iOS",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
   "exports": {
@@ -50,14 +50,15 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/OneKeyHQ/app-modules.git"
+    "url": "git+https://github.com/OneKeyHQ/app-modules.git",
+    "directory": "native-modules/react-native-cloud-kit-module"
   },
   "author": "react-native-cloud-kit-module <huanming@onekey.so> (https://github.com/OneKeyHQ/app-modules)",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/OneKeyHQ/app-modules/issues"
   },
-  "homepage": "https://github.com/OneKeyHQ/app-modules#readme",
+  "homepage": "https://github.com/OneKeyHQ/app-modules/tree/main/native-modules/react-native-cloud-kit-module#readme",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },