@onekeyfe/react-native-cloud-kit-module 3.0.179 → 3.0.180

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +12 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -50,6 +50,18 @@ as a persisted backup.
50
50
  See [src/CloudKitModule.nitro.ts](src/CloudKitModule.nitro.ts) for the exported
51
51
  parameter and result types.
52
52
 
53
+ ## Record payload boundaries
54
+
55
+ `SaveRecordParams` carries `recordType`, `recordID`, `data` and `meta`, all
56
+ strings. Serialize application data before calling the module and decode it in
57
+ the consumer after reading. `fetchRecord` can return `null`, and
58
+ `queryRecords` wraps its results in `{ records: RecordResult[] }`.
59
+
60
+ The exported `RecordResult` contains `createdAt` and `modifiedAt` numbers in
61
+ addition to the string payload. `AccountInfoResult.containerUserId` is optional;
62
+ do not require it before inspecting `status` and `statusName`. Availability,
63
+ a successful write and later retrieval are distinct checks in a backup flow.
64
+
53
65
  ## License
54
66
 
55
67
  MIT.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onekeyfe/react-native-cloud-kit-module",
3
- "version": "3.0.179",
3
+ "version": "3.0.180",
4
4
  "description": "CloudKit account and private record access for OneKey on iOS",
5
5
  "main": "./lib/module/index.js",
6
6
  "types": "./lib/typescript/src/index.d.ts",