@syncular/client-plugin-encryption 0.0.1-98 → 0.0.2-126
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.
- package/README.md +36 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# @syncular/client-plugin-encryption
|
|
2
|
+
|
|
3
|
+
End-to-end encryption plugin for the Syncular client. Supports field-level encryption with key sharing between devices.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @syncular/client-plugin-encryption
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import {
|
|
15
|
+
createFieldEncryptionPlugin,
|
|
16
|
+
createStaticFieldEncryptionKeys,
|
|
17
|
+
} from '@syncular/client-plugin-encryption';
|
|
18
|
+
|
|
19
|
+
const encryption = createFieldEncryptionPlugin({
|
|
20
|
+
rules: [{ scope: 'user', table: 'notes', fields: ['body'] }],
|
|
21
|
+
keys: createStaticFieldEncryptionKeys({
|
|
22
|
+
keys: { default: 'base64url:...' },
|
|
23
|
+
}),
|
|
24
|
+
});
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Documentation
|
|
28
|
+
|
|
29
|
+
- Encryption guide: https://syncular.dev/docs/build/encryption
|
|
30
|
+
|
|
31
|
+
## Links
|
|
32
|
+
|
|
33
|
+
- GitHub: https://github.com/syncular/syncular
|
|
34
|
+
- Issues: https://github.com/syncular/syncular/issues
|
|
35
|
+
|
|
36
|
+
> Status: Alpha. APIs and storage layouts may change between releases.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@syncular/client-plugin-encryption",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2-126",
|
|
4
4
|
"description": "End-to-end encryption plugin for the Syncular client",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Benjamin Kniffler",
|
|
@@ -48,8 +48,8 @@
|
|
|
48
48
|
"@noble/curves": "^2.0.1",
|
|
49
49
|
"@noble/hashes": "^2.0.1",
|
|
50
50
|
"@scure/bip39": "^2.0.1",
|
|
51
|
-
"@syncular/client": "0.0.
|
|
52
|
-
"@syncular/core": "0.0.
|
|
51
|
+
"@syncular/client": "0.0.2-126",
|
|
52
|
+
"@syncular/core": "0.0.2-126"
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
55
|
"@syncular/config": "0.0.0",
|