@3sixty/vault-models 0.0.0-stage → 0.20.0-next.1

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 (32) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +24 -2
  3. package/dist/es/factories/vaultConnectorFactory.js +9 -0
  4. package/dist/es/factories/vaultConnectorFactory.js.map +1 -0
  5. package/dist/es/index.js +8 -0
  6. package/dist/es/index.js.map +1 -0
  7. package/dist/es/models/IVaultConnector.js +2 -0
  8. package/dist/es/models/IVaultConnector.js.map +1 -0
  9. package/dist/es/models/vaultEncryptionType.js +13 -0
  10. package/dist/es/models/vaultEncryptionType.js.map +1 -0
  11. package/dist/es/models/vaultKeyType.js +17 -0
  12. package/dist/es/models/vaultKeyType.js.map +1 -0
  13. package/dist/es/utils/vaultConnectorHelper.js +57 -0
  14. package/dist/es/utils/vaultConnectorHelper.js.map +1 -0
  15. package/dist/types/factories/vaultConnectorFactory.d.ts +6 -0
  16. package/dist/types/index.d.ts +5 -0
  17. package/dist/types/models/IVaultConnector.d.ts +129 -0
  18. package/dist/types/models/vaultEncryptionType.d.ts +13 -0
  19. package/dist/types/models/vaultKeyType.d.ts +17 -0
  20. package/dist/types/utils/vaultConnectorHelper.d.ts +37 -0
  21. package/docs/changelog.md +9 -0
  22. package/docs/examples.md +141 -0
  23. package/docs/reference/classes/VaultConnectorHelper.md +127 -0
  24. package/docs/reference/index.md +20 -0
  25. package/docs/reference/interfaces/IVaultConnector.md +449 -0
  26. package/docs/reference/type-aliases/VaultEncryptionType.md +5 -0
  27. package/docs/reference/type-aliases/VaultKeyType.md +5 -0
  28. package/docs/reference/variables/VaultConnectorFactory.md +5 -0
  29. package/docs/reference/variables/VaultEncryptionType.md +13 -0
  30. package/docs/reference/variables/VaultKeyType.md +19 -0
  31. package/locales/en.json +7 -0
  32. package/package.json +54 -5
package/docs/reference/type-aliases/VaultEncryptionType.md ADDED
@@ -0,0 +1,5 @@
1
+ # Type Alias: VaultEncryptionType
2
+
3
+ > **VaultEncryptionType** = *typeof* [`VaultEncryptionType`](../variables/VaultEncryptionType.md)\[keyof *typeof* [`VaultEncryptionType`](../variables/VaultEncryptionType.md)\]
4
+
5
+ Vault encryption types.
package/docs/reference/type-aliases/VaultKeyType.md ADDED
@@ -0,0 +1,5 @@
1
+ # Type Alias: VaultKeyType
2
+
3
+ > **VaultKeyType** = *typeof* [`VaultKeyType`](../variables/VaultKeyType.md)\[keyof *typeof* [`VaultKeyType`](../variables/VaultKeyType.md)\]
4
+
5
+ Vault key types.
package/docs/reference/variables/VaultConnectorFactory.md ADDED
@@ -0,0 +1,5 @@
1
+ # Variable: VaultConnectorFactory
2
+
3
+ > `const` **VaultConnectorFactory**: `Factory`\<[`IVaultConnector`](../interfaces/IVaultConnector.md)\>
4
+
5
+ Factory for creating vault connectors.
package/docs/reference/variables/VaultEncryptionType.md ADDED
@@ -0,0 +1,13 @@
1
+ # Variable: VaultEncryptionType
2
+
3
+ > `const` **VaultEncryptionType**: `object`
4
+
5
+ The names of the vault encryption types.
6
+
7
+ ## Type Declaration
8
+
9
+ ### ChaCha20Poly1305 {#chacha20poly1305}
10
+
11
+ > `readonly` **ChaCha20Poly1305**: `0` = `0`
12
+
13
+ The ChaCha20Poly1305. (symmetric)
package/docs/reference/variables/VaultKeyType.md ADDED
@@ -0,0 +1,19 @@
1
+ # Variable: VaultKeyType
2
+
3
+ > `const` **VaultKeyType**: `object`
4
+
5
+ The names of the vault key types.
6
+
7
+ ## Type Declaration
8
+
9
+ ### Ed25519 {#ed25519}
10
+
11
+ > `readonly` **Ed25519**: `0` = `0`
12
+
13
+ Ed25519. (asymmetric)
14
+
15
+ ### ChaCha20Poly1305 {#chacha20poly1305}
16
+
17
+ > `readonly` **ChaCha20Poly1305**: `2` = `2`
18
+
19
+ The ChaCha20Poly1305. (symmetric)
package/locales/en.json ADDED
@@ -0,0 +1,7 @@
1
+ {
2
+ "error": {
3
+ "vaultConnectorHelper": {
4
+ "invalidSignature": "The JSON Web token signature could not be verified"
5
+ }
6
+ }
7
+ }
package/package.json CHANGED
@@ -1,6 +1,55 @@
1
1
  {
2
- "name": "@3sixty/vault-models",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
2
+ "name": "@3sixty/vault-models",
3
+ "version": "0.20.0-next.1",
4
+ "description": "Shared models and factory utilities for consistent vault connector integration",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "git+https://github.com/3sixtyglobal/vault.git",
8
+ "directory": "packages/vault-models"
9
+ },
10
+ "author": "martyn.janes@iota.org",
11
+ "license": "Apache-2.0",
12
+ "type": "module",
13
+ "engines": {
14
+ "node": ">=24.0.0"
15
+ },
16
+ "dependencies": {
17
+ "@3sixty/core": "next",
18
+ "@3sixty/nameof": "next",
19
+ "@3sixty/web": "next"
20
+ },
21
+ "main": "./dist/es/index.js",
22
+ "types": "./dist/types/index.d.ts",
23
+ "exports": {
24
+ ".": {
25
+ "types": "./dist/types/index.d.ts",
26
+ "import": "./dist/es/index.js",
27
+ "default": "./dist/es/index.js"
28
+ },
29
+ "./locales/*.json": "./locales/*.json"
30
+ },
31
+ "files": [
32
+ "dist/es",
33
+ "dist/types",
34
+ "locales",
35
+ "docs"
36
+ ],
37
+ "keywords": [
38
+ "twin",
39
+ "trade",
40
+ "iota",
41
+ "framework",
42
+ "blockchain",
43
+ "vault",
44
+ "encryption",
45
+ "security",
46
+ "keys",
47
+ "models",
48
+ "types",
49
+ "schemas"
50
+ ],
51
+ "bugs": {
52
+ "url": "git+https://github.com/3sixtyglobal/vault/issues"
53
+ },
54
+ "homepage": "https://3sixty.global"
55
+ }