@lit-protocol/vincent-ability-sdk 0.0.8-mma → 2.0.0

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 (4) hide show
  1. package/CHANGELOG.md +51 -0
  2. package/dist/CHANGELOG.md +51 -0
  3. package/dist/package.json +1 -1
  4. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,3 +1,54 @@
1
+ # 2.0.0 (2025-08-05)
2
+
3
+ ### 🚀 Features
4
+
5
+ - Add descriptions on abilities and their api interface params ([0b8ff1e3](https://github.com/LIT-Protocol/Vincent/commit/0b8ff1e3))
6
+
7
+ ### 🩹 Fixes
8
+
9
+ - Making api version property in bundled things to ease its discovery and usage when validating its compatibility ([aa81d087](https://github.com/LIT-Protocol/Vincent/commit/aa81d087))
10
+ - ### Implement supported Vincent Ability API range ([14f0ece1](https://github.com/LIT-Protocol/Vincent/commit/14f0ece1))
11
+
12
+ Added basic Ability API handling to ensure abilities & policies are only used by compatible abilities and policies, and with the correct version of the vincentAbilityClient / app-sdk
13
+
14
+ - Added a new jsParam when VincentAbilityClient calls an ability, `vincentAbilityApiVersion`
15
+ - LIT action wrappers for abilities + policies compare `vincentAbilityApiVersion` to match the major semver range the handler was built with from the ability-sdk
16
+ - vincentAbilityHandler() is responsible for passing along the value when it evaluates supported policies
17
+
18
+ ### ⚠️ Breaking Changes
19
+
20
+ - Add support for vincent-contract-sdk using CBOR2 encoded policy parameters ([819fcd11](https://github.com/LIT-Protocol/Vincent/commit/819fcd11))
21
+ - ### `error` is now `runtimeError` and can only be set by `throw ...` ([04f1ca20](https://github.com/LIT-Protocol/Vincent/commit/04f1ca20))
22
+
23
+ - Previously, if you had not defined a `deny` or `fail` schema, you could call `deny()` or `fail()` with a string
24
+ - That string would end up in the ability/policy response as the `error` property instead of `result`
25
+ - This was problematic because there was no consistent way to identify _un-handled_ error vs. _explicitly returned fail/deny results_
26
+ - If you don't define a deny or fail schema, you can no longer call those methods with a string.
27
+ - `error` is now `runtimeError`, and is _only_ set if a lifecycle method `throw`s an Error - in that case it will be the `message` property of the error
28
+ - If you want to be able to return simple errors in your _result_, you can define a simple deny or fail schema like `z.object({ error: z.string() }`
29
+
30
+ - ### Add support for explicit `schemaValidationError` ([337a4bde](https://github.com/LIT-Protocol/Vincent/commit/337a4bde))
31
+
32
+ - Previously, a failure to validate either input or results of lifecycle method would result in `result: { zodError }` being returned
33
+ - Now, `result` will be `undefined` and there will be an explicit `schemaValidationError` in the result of the ability / policy
34
+
35
+ ```typescript
36
+ export interface SchemaValidationError {
37
+ zodError: ZodError<unknown>; // The result of `zod.safeParse().error`
38
+ phase: string; // Policies: `precheck`|`evaluate`|`commit` - Abilities: `precheck` | `execute`
39
+ stage: string; // `input` | `output`
40
+ }
41
+ ```
42
+
43
+ ### 🧱 Updated Dependencies
44
+
45
+ - Updated contracts-sdk to 2.0.0
46
+
47
+ ### ❤️ Thank You
48
+
49
+ - Daryl Collins
50
+ - FedericoAmura @FedericoAmura
51
+
1
52
  ## 1.0.2 (2025-07-08)
2
53
 
3
54
  ### 🩹 Fixes
package/dist/CHANGELOG.md CHANGED
@@ -1,3 +1,54 @@
1
+ # 2.0.0 (2025-08-05)
2
+
3
+ ### 🚀 Features
4
+
5
+ - Add descriptions on abilities and their api interface params ([0b8ff1e3](https://github.com/LIT-Protocol/Vincent/commit/0b8ff1e3))
6
+
7
+ ### 🩹 Fixes
8
+
9
+ - Making api version property in bundled things to ease its discovery and usage when validating its compatibility ([aa81d087](https://github.com/LIT-Protocol/Vincent/commit/aa81d087))
10
+ - ### Implement supported Vincent Ability API range ([14f0ece1](https://github.com/LIT-Protocol/Vincent/commit/14f0ece1))
11
+
12
+ Added basic Ability API handling to ensure abilities & policies are only used by compatible abilities and policies, and with the correct version of the vincentAbilityClient / app-sdk
13
+
14
+ - Added a new jsParam when VincentAbilityClient calls an ability, `vincentAbilityApiVersion`
15
+ - LIT action wrappers for abilities + policies compare `vincentAbilityApiVersion` to match the major semver range the handler was built with from the ability-sdk
16
+ - vincentAbilityHandler() is responsible for passing along the value when it evaluates supported policies
17
+
18
+ ### ⚠️ Breaking Changes
19
+
20
+ - Add support for vincent-contract-sdk using CBOR2 encoded policy parameters ([819fcd11](https://github.com/LIT-Protocol/Vincent/commit/819fcd11))
21
+ - ### `error` is now `runtimeError` and can only be set by `throw ...` ([04f1ca20](https://github.com/LIT-Protocol/Vincent/commit/04f1ca20))
22
+
23
+ - Previously, if you had not defined a `deny` or `fail` schema, you could call `deny()` or `fail()` with a string
24
+ - That string would end up in the ability/policy response as the `error` property instead of `result`
25
+ - This was problematic because there was no consistent way to identify _un-handled_ error vs. _explicitly returned fail/deny results_
26
+ - If you don't define a deny or fail schema, you can no longer call those methods with a string.
27
+ - `error` is now `runtimeError`, and is _only_ set if a lifecycle method `throw`s an Error - in that case it will be the `message` property of the error
28
+ - If you want to be able to return simple errors in your _result_, you can define a simple deny or fail schema like `z.object({ error: z.string() }`
29
+
30
+ - ### Add support for explicit `schemaValidationError` ([337a4bde](https://github.com/LIT-Protocol/Vincent/commit/337a4bde))
31
+
32
+ - Previously, a failure to validate either input or results of lifecycle method would result in `result: { zodError }` being returned
33
+ - Now, `result` will be `undefined` and there will be an explicit `schemaValidationError` in the result of the ability / policy
34
+
35
+ ```typescript
36
+ export interface SchemaValidationError {
37
+ zodError: ZodError<unknown>; // The result of `zod.safeParse().error`
38
+ phase: string; // Policies: `precheck`|`evaluate`|`commit` - Abilities: `precheck` | `execute`
39
+ stage: string; // `input` | `output`
40
+ }
41
+ ```
42
+
43
+ ### 🧱 Updated Dependencies
44
+
45
+ - Updated contracts-sdk to 2.0.0
46
+
47
+ ### ❤️ Thank You
48
+
49
+ - Daryl Collins
50
+ - FedericoAmura @FedericoAmura
51
+
1
52
  ## 1.0.2 (2025-07-08)
2
53
 
3
54
  ### 🩹 Fixes
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lit-protocol/vincent-ability-sdk",
3
- "version": "1.0.2",
3
+ "version": "2.0.0",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lit-protocol/vincent-ability-sdk",
3
- "version": "0.0.8-mma",
3
+ "version": "2.0.0",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -9,7 +9,7 @@
9
9
  "semver": "^7.7.2",
10
10
  "tslib": "^2.8.1",
11
11
  "zod": "^3.25.64",
12
- "@lit-protocol/vincent-contracts-sdk": "0.0.8-mma"
12
+ "@lit-protocol/vincent-contracts-sdk": "1.0.1"
13
13
  },
14
14
  "main": "./dist/src/index.js",
15
15
  "types": "./dist/src/index.d.ts",