@lit-protocol/vincent-app-sdk 0.0.6-mma → 0.0.8-mma

package/dist/src/abilityClient/typeGuards.js

@@ -0,0 +1,67 @@
+"use strict";
+// src/lib/abilityClient/typeGuards.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAbilityResponseSuccess = isAbilityResponseSuccess;
+exports.isAbilityResponseFailure = isAbilityResponseFailure;
+exports.isAbilityResponseRuntimeFailure = isAbilityResponseRuntimeFailure;
+exports.isAbilityResponseSchemaValidationFailure = isAbilityResponseSchemaValidationFailure;
+exports.isAbilityResponse = isAbilityResponse;
+exports.isRemoteVincentAbilityExecutionResult = isRemoteVincentAbilityExecutionResult;
+/** Type guard function that returns true only if the passed value is a successful ability response
+ * @category API
+ * */
+function isAbilityResponseSuccess(value) {
+    return (typeof value === 'object' &&
+        value !== null &&
+        'success' in value &&
+        value.success === true);
+}
+/** Type guard function that returns true only if the passed value is a failure ability response
+ *  @category API */
+function isAbilityResponseFailure(value) {
+    return (typeof value === 'object' &&
+        value !== null &&
+        'success' in value &&
+        value.success === false);
+}
+/** Type guard function that returns true only if the passed value is a failure ability response that was a runtime error
+ * This could be caused by code `throw()`ing an error from inside ability or policy code, or by errors encountered in the
+ * Vincent SDK wrapping code that handles the execution of the ability/policies.
+ *
+ * This could also be the result of a schema validation error -- use {@link isAbilityResponseSchemaValidationFailure} to check
+ * to see if have a data validation error.
+ *
+ *  @category API*/
+function isAbilityResponseRuntimeFailure(value) {
+    if (!isAbilityResponseFailure(value))
+        return false;
+    return 'runtimeError' in value && typeof value.runtimeError === 'string';
+}
+/** Type guard function that returns true only if the passed value is a failure ability response that was caused by
+ * a schema parsing failure.  All data inputs and outputs to / from Vincent Abilities and Policies is validated using ZOD schemas.
+ *
+ * If this returns true, you can parse the `schemaValidationError` property in the response - it is a ZodError object.
+ * @category API */
+function isAbilityResponseSchemaValidationFailure(value) {
+    if (!isAbilityResponseFailure(value))
+        return false;
+    return ('schemaValidationError' in value && typeof value.schemaValidationError === 'object');
+}
+/** @hidden */
+function isAbilityResponse(value) {
+    return (typeof value === 'object' &&
+        value !== null &&
+        'success' in value &&
+        typeof value.success === 'boolean');
+}
+/** @hidden */
+function isRemoteVincentAbilityExecutionResult(value) {
+    return (typeof value === 'object' &&
+        value !== null &&
+        'abilityExecutionResult' in value &&
+        'abilityContext' in value &&
+        isAbilityResponse(value.abilityExecutionResult) &&
+        typeof value.abilityContext === 'object' &&
+        value.abilityContext !== null);
+}
+//# sourceMappingURL=typeGuards.js.map

package/dist/src/abilityClient/typeGuards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeGuards.js","sourceRoot":"","sources":["../../../src/abilityClient/typeGuards.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AActC,4DAWC;AAID,4DAWC;AAUD,0EAMC;AAOD,4FAOC;AAGD,8CASC;AAGD,sFAYC;AAtFD;;KAEK;AACL,SAAgB,wBAAwB,CACtC,KAAc;IAId,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,SAAS,IAAI,KAAK;QACjB,KAAa,CAAC,OAAO,KAAK,IAAI,CAChC,CAAC;AACJ,CAAC;AAED;oBACoB;AACpB,SAAgB,wBAAwB,CACtC,KAAc;IAId,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,SAAS,IAAI,KAAK;QACjB,KAAa,CAAC,OAAO,KAAK,KAAK,CACjC,CAAC;AACJ,CAAC;AAED;;;;;;;mBAOmB;AACnB,SAAgB,+BAA+B,CAC7C,KAAc;IAEd,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAEnD,OAAO,cAAc,IAAI,KAAK,IAAI,OAAQ,KAAa,CAAC,YAAY,KAAK,QAAQ,CAAC;AACpF,CAAC;AAED;;;;mBAImB;AACnB,SAAgB,wCAAwC,CACtD,KAAc;IAEd,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnD,OAAO,CACL,uBAAuB,IAAI,KAAK,IAAI,OAAQ,KAAa,CAAC,qBAAqB,KAAK,QAAQ,CAC7F,CAAC;AACJ,CAAC;AAED,cAAc;AACd,SAAgB,iBAAiB,CAC/B,KAAc;IAEd,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,SAAS,IAAI,KAAK;QAClB,OAAQ,KAAa,CAAC,OAAO,KAAK,SAAS,CAC5C,CAAC;AACJ,CAAC;AAED,cAAc;AACd,SAAgB,qCAAqC,CACnD,KAAc;IAEd,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,wBAAwB,IAAI,KAAK;QACjC,gBAAgB,IAAI,KAAK;QACzB,iBAAiB,CAAE,KAAa,CAAC,sBAAsB,CAAC;QACxD,OAAQ,KAAa,CAAC,cAAc,KAAK,QAAQ;QAChD,KAAa,CAAC,cAAc,KAAK,IAAI,CACvC,CAAC;AACJ,CAAC"}

package/dist/src/abilityClient/types.d.ts

@@ -0,0 +1,50 @@
+import type { z } from 'zod';
+import type { BaseAbilityContext } from '@lit-protocol/vincent-ability-sdk';
+import type { AbilityExecuteResponse } from './execute/types';
+import type { AbilityPrecheckResponse } from './precheck/types';
+export { type BaseAbilityContext };
+/**
+ * The Vincent Ability Client is used to interact with Vincent abilities.
+ *
+ * - Precheck ability parameters and policies
+ * - Execute abilities remotely
+ *
+ * @typeParam AbilityParamsSchema {@removeTypeParameterCompletely}
+ * @typeParam PoliciesByPackageName {@removeTypeParameterCompletely}
+ * @typeParam ExecuteSuccessSchema {@removeTypeParameterCompletely}
+ * @typeParam ExecuteFailSchema {@removeTypeParameterCompletely}
+ * @typeParam PrecheckSuccessSchema {@removeTypeParameterCompletely}
+ * @typeParam PrecheckFailSchema {@removeTypeParameterCompletely}
+ *
+ * @category Interfaces
+ */
+export interface VincentAbilityClient<AbilityParamsSchema extends z.ZodType, PoliciesByPackageName extends Record<string, any>, ExecuteSuccessSchema extends z.ZodType = z.ZodUndefined, ExecuteFailSchema extends z.ZodType = z.ZodUndefined, PrecheckSuccessSchema extends z.ZodType = z.ZodUndefined, PrecheckFailSchema extends z.ZodType = z.ZodUndefined> {
+    /**
+     * Performs a precheck of the ability parameters and policies.
+     *
+     * This method validates the ability parameters and checks if the policies allow the ability to be executed.
+     *
+     * @param rawAbilityParams - The parameters to be passed to the ability
+     * @param context - The context for the ability execution, including the delegator PKP Ethereum address
+     * @returns A promise that resolves to a AbilityResponse containing the precheck result
+     */
+    precheck(rawAbilityParams: z.infer<AbilityParamsSchema>, context: AbilityClientContext & {
+        rpcUrl?: string;
+    }): Promise<AbilityPrecheckResponse<PrecheckSuccessSchema, PrecheckFailSchema, PoliciesByPackageName>>;
+    /**
+     * Executes the ability with the given parameters.
+     *
+     * This method validates the ability parameters, executes the ability remotely, and returns the result.
+     *
+     * @param rawAbilityParams - The parameters to be passed to the ability
+     * @param context - The context for the ability execution, including the delegator PKP Ethereum address
+     * @returns A promise that resolves to a AbilityResponse containing the execution result
+     *
+     */
+    execute(rawAbilityParams: z.infer<AbilityParamsSchema>, context: AbilityClientContext): Promise<AbilityExecuteResponse<ExecuteSuccessSchema, ExecuteFailSchema, PoliciesByPackageName>>;
+}
+/** @category Interfaces */
+export interface AbilityClientContext {
+    delegatorPkpEthAddress: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/src/abilityClient/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/abilityClient/types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAE5E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAEhE,OAAO,EAAE,KAAK,kBAAkB,EAAE,CAAC;AAEnC;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,oBAAoB,CACnC,mBAAmB,SAAS,CAAC,CAAC,OAAO,EACrC,qBAAqB,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjD,oBAAoB,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,YAAY,EACvD,iBAAiB,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,YAAY,EACpD,qBAAqB,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,YAAY,EACxD,kBAAkB,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,YAAY;IAErD;;;;;;;;OAQG;IACH,QAAQ,CACN,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAC9C,OAAO,EAAE,oBAAoB,GAAG;QAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GACA,OAAO,CACR,uBAAuB,CAAC,qBAAqB,EAAE,kBAAkB,EAAE,qBAAqB,CAAC,CAC1F,CAAC;IAEF;;;;;;;;;OASG;IACH,OAAO,CACL,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAC9C,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CACR,sBAAsB,CAAC,oBAAoB,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,CACvF,CAAC;CACH;AAED,2BAA2B;AAC3B,MAAM,WAAW,oBAAoB;IACnC,sBAAsB,EAAE,MAAM,CAAC;CAChC"}

package/dist/src/{toolClient → abilityClient}/types.js

@@ -1,4 +1,4 @@
 "use strict";
-// src/lib/toolClient/types.ts
+// src/lib/abilityClient/types.ts
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=types.js.map

package/dist/src/abilityClient/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/abilityClient/types.ts"],"names":[],"mappings":";AAAA,iCAAiC"}

package/dist/src/abilityClient/vincentAbilityClient.d.ts

@@ -0,0 +1,76 @@
+import { ethers } from 'ethers';
+import { z } from 'zod';
+import type { BundledVincentAbility, VincentAbility } from '@lit-protocol/vincent-ability-sdk';
+import type { AbilityPolicyMap } from '@lit-protocol/vincent-ability-sdk/internal';
+import type { VincentAbilityClient } from './types';
+/** A VincentAbilityClient provides a type-safe interface for executing abilities, for both `precheck()`
+ * and `execute()` functionality.
+ *
+ * ```typescript
+ * import { disconnectVincentAbilityClients, getVincentAbilityClient, isAbilityResponseFailure } from '@lit-protocol/vincent-app-sdk/abilityClient';
+ * import { bundledVincentAbility as uniswapBundledAbility } from '@lit-protocol/vincent-ability-uniswap-swap';
+ * import { delegateeEthersSigner } = from './ethersSigner';
+ * import { ETH_RPC_URL, BASE_RPC_URL } from './rpcConfigs';
+ *
+ * const uniswapAbilityClient = getVincentAbilityClient({
+ *     bundledVincentAbility: uniswapBundledAbility,
+ *     ethersSigner: delegateeEthersSigner,
+ *   });
+ *
+ * // First, call `precheck()` to get a best-estimate result indicating that the ability execution in the LIT action runtime will not fail
+ * const precheckResult = await uniswapSwapAbilityClient.precheck({
+ *     ethRpcUrl: ETH_RPC_URL,
+ *     rpcUrlForUniswap: BASE_RPC_URL,
+ *     chainIdForUniswap: 8453, // Base
+ *     tokenInAddress: '0x4200000000000000000000000000000000000006', // WETH
+ *     tokenInDecimals: 18,
+ *     tokenInAmount: 0.0000077,
+ *     tokenOutAddress: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913', // USDC on Base
+ *     tokenOutDecimals: 8,
+ *   },
+ *   {
+ *     delegatorPkpEthAddress: '0x123456789123456789123456789...',
+ *   });
+ *
+ * const uniswapSwapExecutionResult = await uniswapSwapAbilityClient.execute({
+ *   ethRpcUrl: ETH_RPC_URL,
+ *   rpcUrlForUniswap: BASE_RPC_URL,
+ *   chainIdForUniswap: 8453,
+ *   tokenInAddress: '0x4200000000000000000000000000000000000006', // WETH
+ *   tokenInDecimals: 18,
+ *   tokenInAmount: 0.0000077,
+ *   tokenOutAddress: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913', // USDC on Base
+ *   tokenOutDecimals: 8,
+ * },
+ * {
+ *   delegatorPkpEthAddress: '0x123456789123456789123456789...',
+ * });
+ *
+ * if(isAbilityResponseFailure(uniswapSwapExecutionResult)) {
+ *   ...handle failure
+ * } else {
+ *  ...handle result
+ * }
+ * ```
+ *
+ * @typeParam IpfsCid {@removeTypeParameterCompletely}
+ * @typeParam AbilityParamsSchema {@removeTypeParameterCompletely}
+ * @typeParam PkgNames {@removeTypeParameterCompletely}
+ * @typeParam PolicyMap {@removeTypeParameterCompletely}
+ * @typeParam PoliciesByPackageName {@removeTypeParameterCompletely}
+ * @typeParam ExecuteSuccessSchema {@removeTypeParameterCompletely}
+ * @typeParam ExecuteFailSchema {@removeTypeParameterCompletely}
+ * @typeParam PrecheckSuccessSchema {@removeTypeParameterCompletely}
+ * @typeParam PrecheckFailSchema {@removeTypeParameterCompletely}
+ *
+ * @param params
+ * @param params.ethersSigner  - An ethers signer that has been configured with your delegatee key
+ * @param params.bundledVincentAbility  - The bundled vincent ability that you want to interact with
+ *
+ * @category API
+ * */
+export declare function getVincentAbilityClient<const IpfsCid extends string, AbilityParamsSchema extends z.ZodType, PkgNames extends string, PolicyMap extends AbilityPolicyMap<any, PkgNames>, PoliciesByPackageName extends PolicyMap['policyByPackageName'], ExecuteSuccessSchema extends z.ZodType = z.ZodUndefined, ExecuteFailSchema extends z.ZodType = z.ZodUndefined, PrecheckSuccessSchema extends z.ZodType = z.ZodUndefined, PrecheckFailSchema extends z.ZodType = z.ZodUndefined>(params: {
+    bundledVincentAbility: BundledVincentAbility<VincentAbility<AbilityParamsSchema, PkgNames, PolicyMap, PoliciesByPackageName, ExecuteSuccessSchema, ExecuteFailSchema, PrecheckSuccessSchema, PrecheckFailSchema, any, any>, IpfsCid>;
+    ethersSigner: ethers.Signer;
+}): VincentAbilityClient<AbilityParamsSchema, PoliciesByPackageName, ExecuteSuccessSchema, ExecuteFailSchema, PrecheckSuccessSchema, PrecheckFailSchema>;
+//# sourceMappingURL=vincentAbilityClient.d.ts.map

package/dist/src/abilityClient/vincentAbilityClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vincentAbilityClient.d.ts","sourceRoot":"","sources":["../../../src/abilityClient/vincentAbilityClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AAC/F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAcnF,OAAO,KAAK,EAAwB,oBAAoB,EAAE,MAAM,SAAS,CAAC;AA2B1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAiEK;AACL,wBAAgB,uBAAuB,CACrC,KAAK,CAAC,OAAO,SAAS,MAAM,EAC5B,mBAAmB,SAAS,CAAC,CAAC,OAAO,EACrC,QAAQ,SAAS,MAAM,EACvB,SAAS,SAAS,gBAAgB,CAAC,GAAG,EAAE,QAAQ,CAAC,EACjD,qBAAqB,SAAS,SAAS,CAAC,qBAAqB,CAAC,EAC9D,oBAAoB,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,YAAY,EACvD,iBAAiB,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,YAAY,EACpD,qBAAqB,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,YAAY,EACxD,kBAAkB,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,YAAY,EACrD,MAAM,EAAE;IACR,qBAAqB,EAAE,qBAAqB,CAC1C,cAAc,CACZ,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACT,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,GAAG,EACH,GAAG,CACJ,EACD,OAAO,CACR,CAAC;IACF,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC;CAC7B,GAAG,oBAAoB,CACtB,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,CACnB,CAmWA"}

package/dist/src/{toolClient/vincentToolClient.js → abilityClient/vincentAbilityClient.js}

@@ -1,13 +1,13 @@
 "use strict";
-// src/toolClient/vincentToolClient.ts
+// src/abilityClient/vincentAbilityClient.ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVincentToolClient = getVincentToolClient;
+exports.getVincentAbilityClient = getVincentAbilityClient;
 const ethers_1 = require("ethers");
 const zod_1 = require("zod");
 const constants_1 = require("@lit-protocol/constants");
-const internal_1 = require("@lit-protocol/vincent-tool-sdk/internal");
+const internal_1 = require("@lit-protocol/vincent-ability-sdk/internal");
 const getLitNodeClient_1 = require("../internal/LitNodeClient/getLitNodeClient");
-const generateVincentToolSessionSigs_1 = require("./execute/generateVincentToolSessionSigs");
+const generateVincentAbilitySessionSigs_1 = require("./execute/generateVincentAbilitySessionSigs");
 const resultCreators_1 = require("./execute/resultCreators");
 const resultCreators_2 = require("./precheck/resultCreators");
 const runPolicyPrechecks_1 = require("./precheck/runPolicyPrechecks");
@@ -16,22 +16,22 @@ const YELLOWSTONE_RPC_URL = 'https://yellowstone-rpc.litprotocol.com/';
 const bigintReplacer = (key, value) => {
     return typeof value === 'bigint' ? value.toString() : value;
 };
-/** A VincentToolClient provides a type-safe interface for executing tools, for both `precheck()`
+/** A VincentAbilityClient provides a type-safe interface for executing abilities, for both `precheck()`
  * and `execute()` functionality.
  *
  * ```typescript
- * import { disconnectVincentToolClients, getVincentToolClient, isToolResponseFailure } from '@lit-protocol/vincent-app-sdk/toolClient';
- * import { bundledVincentTool as uniswapBundledTool } from '@lit-protocol/vincent-tool-uniswap-swap';
+ * import { disconnectVincentAbilityClients, getVincentAbilityClient, isAbilityResponseFailure } from '@lit-protocol/vincent-app-sdk/abilityClient';
+ * import { bundledVincentAbility as uniswapBundledAbility } from '@lit-protocol/vincent-ability-uniswap-swap';
  * import { delegateeEthersSigner } = from './ethersSigner';
  * import { ETH_RPC_URL, BASE_RPC_URL } from './rpcConfigs';
  *
- * const uniswapToolClient = getVincentToolClient({
- *     bundledVincentTool: uniswapBundledTool,
+ * const uniswapAbilityClient = getVincentAbilityClient({
+ *     bundledVincentAbility: uniswapBundledAbility,
  *     ethersSigner: delegateeEthersSigner,
  *   });
  *
- * // First, call `precheck()` to get a best-estimate result indicating that the tool execution in the LIT action runtime will not fail
- * const precheckResult = await uniswapSwapToolClient.precheck({
+ * // First, call `precheck()` to get a best-estimate result indicating that the ability execution in the LIT action runtime will not fail
+ * const precheckResult = await uniswapSwapAbilityClient.precheck({
  *     ethRpcUrl: ETH_RPC_URL,
  *     rpcUrlForUniswap: BASE_RPC_URL,
  *     chainIdForUniswap: 8453, // Base
@@ -45,7 +45,7 @@ const bigintReplacer = (key, value) => {
  *     delegatorPkpEthAddress: '0x123456789123456789123456789...',
  *   });
  *
- * const uniswapSwapExecutionResult = await uniswapSwapToolClient.execute({
+ * const uniswapSwapExecutionResult = await uniswapSwapAbilityClient.execute({
  *   ethRpcUrl: ETH_RPC_URL,
  *   rpcUrlForUniswap: BASE_RPC_URL,
  *   chainIdForUniswap: 8453,
@@ -59,7 +59,7 @@ const bigintReplacer = (key, value) => {
  *   delegatorPkpEthAddress: '0x123456789123456789123456789...',
  * });
  *
- * if(isToolResponseFailure(uniswapSwapExecutionResult)) {
+ * if(isAbilityResponseFailure(uniswapSwapExecutionResult)) {
  *   ...handle failure
  * } else {
  *  ...handle result
@@ -67,7 +67,7 @@ const bigintReplacer = (key, value) => {
  * ```
  *
  * @typeParam IpfsCid {@removeTypeParameterCompletely}
- * @typeParam ToolParamsSchema {@removeTypeParameterCompletely}
+ * @typeParam AbilityParamsSchema {@removeTypeParameterCompletely}
  * @typeParam PkgNames {@removeTypeParameterCompletely}
  * @typeParam PolicyMap {@removeTypeParameterCompletely}
  * @typeParam PoliciesByPackageName {@removeTypeParameterCompletely}
@@ -78,21 +78,21 @@ const bigintReplacer = (key, value) => {
  *
  * @param params
  * @param params.ethersSigner  - An ethers signer that has been configured with your delegatee key
- * @param params.bundledVincentTool  - The bundled vincent tool that you want to interact with
+ * @param params.bundledVincentAbility  - The bundled vincent ability that you want to interact with
  *
  * @category API
  * */
-function getVincentToolClient(params) {
+function getVincentAbilityClient(params) {
     var _a, _b;
-    const { bundledVincentTool, ethersSigner } = params;
-    const { ipfsCid, vincentTool, vincentToolApiVersion } = bundledVincentTool;
-    (0, internal_1.assertSupportedToolVersion)(vincentToolApiVersion);
+    const { bundledVincentAbility, ethersSigner } = params;
+    const { ipfsCid, vincentAbility, vincentAbilityApiVersion } = bundledVincentAbility;
+    (0, internal_1.assertSupportedAbilityVersion)(vincentAbilityApiVersion);
     const network = constants_1.LIT_NETWORK.Datil;
-    const executeSuccessSchema = ((_a = vincentTool.__schemaTypes.executeSuccessSchema) !== null && _a !== void 0 ? _a : zod_1.z.undefined());
-    const executeFailSchema = ((_b = vincentTool.__schemaTypes.executeFailSchema) !== null && _b !== void 0 ? _b : zod_1.z.undefined());
+    const executeSuccessSchema = ((_a = vincentAbility.__schemaTypes.executeSuccessSchema) !== null && _a !== void 0 ? _a : zod_1.z.undefined());
+    const executeFailSchema = ((_b = vincentAbility.__schemaTypes.executeFailSchema) !== null && _b !== void 0 ? _b : zod_1.z.undefined());
     return {
-        async precheck(rawToolParams, { rpcUrl, delegatorPkpEthAddress, }) {
-            console.log('precheck', { rawToolParams, delegatorPkpEthAddress, rpcUrl });
+        async precheck(rawAbilityParams, { rpcUrl, delegatorPkpEthAddress, }) {
+            console.log('precheck', { rawAbilityParams, delegatorPkpEthAddress, rpcUrl });
             const delegateePkpEthAddress = ethers_1.ethers.utils.getAddress(await ethersSigner.getAddress());
             // This will be populated further during execution; if an error is encountered, it'll include as much data as we can give the caller.
             const baseContext = {
@@ -100,13 +100,13 @@ function getVincentToolClient(params) {
                     delegateeAddress: delegateePkpEthAddress,
                     // delegatorPkpInfo: null,
                 },
-                toolIpfsCid: ipfsCid,
+                abilityIpfsCid: ipfsCid,
                 // appId: undefined,
                 // appVersion: undefined,
             };
-            const parsedParams = (0, internal_1.validateOrFail)(rawToolParams, vincentTool.toolParamsSchema, 'precheck', 'input');
-            if ((0, typeGuards_1.isToolResponseFailure)(parsedParams)) {
-                return (0, resultCreators_2.createToolPrecheckResponseFailureNoResult)({
+            const parsedParams = (0, internal_1.validateOrFail)(rawAbilityParams, vincentAbility.abilityParamsSchema, 'precheck', 'input');
+            if ((0, typeGuards_1.isAbilityResponseFailure)(parsedParams)) {
+                return (0, resultCreators_2.createAbilityPrecheckResponseFailureNoResult)({
                     ...parsedParams,
                     context: baseContext,
                 });
@@ -122,42 +122,42 @@ function getVincentToolClient(params) {
                 delegationRpcUrl: rpcUrl !== null && rpcUrl !== void 0 ? rpcUrl : YELLOWSTONE_RPC_URL,
                 appDelegateeAddress: delegateePkpEthAddress,
                 agentWalletPkpEthAddress: delegatorPkpEthAddress,
-                toolIpfsCid: ipfsCid,
+                abilityIpfsCid: ipfsCid,
             });
             baseContext.appId = appId.toNumber();
             baseContext.appVersion = appVersion.toNumber();
             console.log('Fetched policies and app info', { decodedPolicies, appId, appVersion });
-            const baseToolContext = await (0, runPolicyPrechecks_1.runToolPolicyPrechecks)({
-                bundledVincentTool,
-                toolParams: parsedParams,
+            const baseAbilityContext = await (0, runPolicyPrechecks_1.runAbilityPolicyPrechecks)({
+                bundledVincentAbility,
+                abilityParams: parsedParams,
                 decodedPolicies,
                 context: {
                     ...baseContext,
                     rpcUrl,
                 },
             });
-            if (!vincentTool.precheck) {
-                console.log('No tool precheck defined - returning baseContext policy evaluation results', {
-                    rawToolParams,
+            if (!vincentAbility.precheck) {
+                console.log('No ability precheck defined - returning baseContext policy evaluation results', {
+                    rawAbilityParams,
                     delegatorPkpEthAddress,
                     rpcUrl,
                 });
-                if (!baseToolContext.policiesContext.allow) {
-                    return (0, resultCreators_2.createToolPrecheckResponseFailureNoResult)({
-                        context: baseToolContext,
+                if (!baseAbilityContext.policiesContext.allow) {
+                    return (0, resultCreators_2.createAbilityPrecheckResponseFailureNoResult)({
+                        context: baseAbilityContext,
                     });
                 }
-                return (0, resultCreators_2.createToolPrecheckResponseSuccessNoResult)({
-                    context: baseToolContext,
+                return (0, resultCreators_2.createAbilityPrecheckResponseSuccessNoResult)({
+                    context: baseAbilityContext,
                 });
             }
-            console.log('Executing tool precheck');
-            const precheckResult = await vincentTool.precheck({ toolParams: parsedParams }, baseToolContext);
-            if ((0, typeGuards_1.isToolResponseSchemaValidationFailure)(precheckResult) ||
-                (0, typeGuards_1.isToolResponseRuntimeFailure)(precheckResult)) {
-                console.log('Detected runtime or schema validation error in toolPrecheckResult - returning as-is:', JSON.stringify({
-                    isToolResponseRuntimeFailure: (0, typeGuards_1.isToolResponseRuntimeFailure)(precheckResult),
-                    isToolResponseSchemaValidationFailure: (0, typeGuards_1.isToolResponseSchemaValidationFailure)(precheckResult),
+            console.log('Executing ability precheck');
+            const precheckResult = await vincentAbility.precheck({ abilityParams: parsedParams }, baseAbilityContext);
+            if ((0, typeGuards_1.isAbilityResponseSchemaValidationFailure)(precheckResult) ||
+                (0, typeGuards_1.isAbilityResponseRuntimeFailure)(precheckResult)) {
+                console.log('Detected runtime or schema validation error in abilityPrecheckResult - returning as-is:', JSON.stringify({
+                    isAbilityResponseRuntimeFailure: (0, typeGuards_1.isAbilityResponseRuntimeFailure)(precheckResult),
+                    isAbilityResponseSchemaValidationFailure: (0, typeGuards_1.isAbilityResponseSchemaValidationFailure)(precheckResult),
                     precheckResult,
                 }, bigintReplacer));
                 // Runtime errors and schema validation errors will not have results; return them as-is.
@@ -166,26 +166,26 @@ function getVincentToolClient(params) {
             console.log('precheckResult()', JSON.stringify(precheckResult, bigintReplacer));
             return {
                 ...precheckResult,
-                context: baseToolContext,
+                context: baseAbilityContext,
             };
         },
-        async execute(rawToolParams, context) {
-            const parsedParams = (0, internal_1.validateOrFail)(rawToolParams, vincentTool.toolParamsSchema, 'execute', 'input');
-            if ((0, typeGuards_1.isToolResponseFailure)(parsedParams)) {
+        async execute(rawAbilityParams, context) {
+            const parsedParams = (0, internal_1.validateOrFail)(rawAbilityParams, vincentAbility.abilityParamsSchema, 'execute', 'input');
+            if ((0, typeGuards_1.isAbilityResponseFailure)(parsedParams)) {
                 return {
                     ...parsedParams,
                     context,
                 };
             }
             const litNodeClient = await (0, getLitNodeClient_1.getLitNodeClientInstance)({ network });
-            const sessionSigs = await (0, generateVincentToolSessionSigs_1.generateVincentToolSessionSigs)({ ethersSigner, litNodeClient });
+            const sessionSigs = await (0, generateVincentAbilitySessionSigs_1.generateVincentAbilitySessionSigs)({ ethersSigner, litNodeClient });
             const result = await litNodeClient.executeJs({
                 ipfsId: ipfsCid,
                 sessionSigs,
                 jsParams: {
-                    toolParams: parsedParams,
+                    abilityParams: parsedParams,
                     context,
-                    vincentToolApiVersion,
+                    vincentAbilityApiVersion,
                 },
             });
             const { success, response } = result;
@@ -194,8 +194,8 @@ function getVincentToolClient(params) {
                 success,
             });
             if (success !== true) {
-                return (0, resultCreators_1.createToolExecuteResponseFailureNoResult)({
-                    runtimeError: `Remote tool failed with unknown error: ${JSON.stringify(response, bigintReplacer, 2)}`,
+                return (0, resultCreators_1.createAbilityExecuteResponseFailureNoResult)({
+                    runtimeError: `Remote ability failed with unknown error: ${JSON.stringify(response, bigintReplacer, 2)}`,
                 });
             }
             let parsedResult = response;
@@ -206,80 +206,80 @@ function getVincentToolClient(params) {
                     // eslint-disable-next-line @typescript-eslint/no-unused-vars
                 }
                 catch (e) {
-                    return (0, resultCreators_1.createToolExecuteResponseFailureNoResult)({
-                        runtimeError: `Remote tool failed with unknown error: ${JSON.stringify(response, bigintReplacer)}`,
+                    return (0, resultCreators_1.createAbilityExecuteResponseFailureNoResult)({
+                        runtimeError: `Remote ability failed with unknown error: ${JSON.stringify(response, bigintReplacer)}`,
                     });
                 }
             }
-            if (!(0, typeGuards_1.isRemoteVincentToolExecutionResult)(parsedResult)) {
-                console.log('Result from `executeJs` was valid JSON, but not a vincentToolExecutionResult', { parsedResult, success });
-                return (0, resultCreators_1.createToolExecuteResponseFailureNoResult)({
-                    runtimeError: `Remote tool failed with unknown error: ${JSON.stringify(parsedResult, bigintReplacer)}`,
+            if (!(0, typeGuards_1.isRemoteVincentAbilityExecutionResult)(parsedResult)) {
+                console.log('Result from `executeJs` was valid JSON, but not a vincentAbilityExecutionResult', { parsedResult, success });
+                return (0, resultCreators_1.createAbilityExecuteResponseFailureNoResult)({
+                    runtimeError: `Remote ability failed with unknown error: ${JSON.stringify(parsedResult, bigintReplacer)}`,
                 });
             }
-            const remoteVincentToolResult = parsedResult;
-            console.log('Parsed executeJs vincentToolExecutionResult:', JSON.stringify(parsedResult, bigintReplacer));
-            const { toolContext, toolExecutionResult } = remoteVincentToolResult;
-            if ((0, typeGuards_1.isToolResponseSchemaValidationFailure)(toolExecutionResult) ||
-                (0, typeGuards_1.isToolResponseRuntimeFailure)(toolExecutionResult)) {
-                console.log('Detected runtime or schema validation error in toolExecutionResult - returning as-is:', JSON.stringify({
-                    isToolResponseRuntimeFailure: (0, typeGuards_1.isToolResponseRuntimeFailure)(toolExecutionResult),
-                    isToolResponseSchemaValidationFailure: (0, typeGuards_1.isToolResponseSchemaValidationFailure)(toolExecutionResult),
-                    toolExecutionResult,
+            const remoteVincentAbilityResult = parsedResult;
+            console.log('Parsed executeJs vincentAbilityExecutionResult:', JSON.stringify(parsedResult, bigintReplacer));
+            const { abilityContext, abilityExecutionResult } = remoteVincentAbilityResult;
+            if ((0, typeGuards_1.isAbilityResponseSchemaValidationFailure)(abilityExecutionResult) ||
+                (0, typeGuards_1.isAbilityResponseRuntimeFailure)(abilityExecutionResult)) {
+                console.log('Detected runtime or schema validation error in abilityExecutionResult - returning as-is:', JSON.stringify({
+                    isAbilityResponseRuntimeFailure: (0, typeGuards_1.isAbilityResponseRuntimeFailure)(abilityExecutionResult),
+                    isAbilityResponseSchemaValidationFailure: (0, typeGuards_1.isAbilityResponseSchemaValidationFailure)(abilityExecutionResult),
+                    abilityExecutionResult,
                 }, bigintReplacer));
                 // Runtime errors and schema validation errors will not have results; return them as-is.
-                return (0, resultCreators_1.createToolExecuteResponseFailureNoResult)({
-                    ...(toolExecutionResult.runtimeError
-                        ? { runtimeError: toolExecutionResult.runtimeError }
+                return (0, resultCreators_1.createAbilityExecuteResponseFailureNoResult)({
+                    ...(abilityExecutionResult.runtimeError
+                        ? { runtimeError: abilityExecutionResult.runtimeError }
                         : {}),
-                    ...(toolExecutionResult.schemaValidationError
-                        ? { schemaValidationError: toolExecutionResult.schemaValidationError }
+                    ...(abilityExecutionResult.schemaValidationError
+                        ? { schemaValidationError: abilityExecutionResult.schemaValidationError }
                         : {}),
-                    context: remoteVincentToolResult.toolContext,
+                    context: remoteVincentAbilityResult.abilityContext,
                 });
             }
             // Policy eval happens before `execute()` is ever called
-            // As a result, when policies return a `deny` result, there will be no tool result
+            // As a result, when policies return a `deny` result, there will be no ability result
             // so we need to skip trying to run result through the success/fail schema logic
-            if (!toolContext.policiesContext.allow) {
-                return (0, resultCreators_1.createToolExecuteResponseFailureNoResult)({
-                    context: toolContext,
+            if (!abilityContext.policiesContext.allow) {
+                return (0, resultCreators_1.createAbilityExecuteResponseFailureNoResult)({
+                    context: abilityContext,
                 });
             }
-            const resultSchemaDetails = (0, internal_1.getSchemaForToolResult)({
-                value: toolExecutionResult,
+            const resultSchemaDetails = (0, internal_1.getSchemaForAbilityResult)({
+                value: abilityExecutionResult,
                 successResultSchema: executeSuccessSchema,
                 failureResultSchema: executeFailSchema,
             });
             const { schemaToUse, parsedType } = resultSchemaDetails;
-            console.log(`Parsing tool result using the ${parsedType} Zod schema`);
+            console.log(`Parsing ability result using the ${parsedType} Zod schema`);
             // Parse returned result using appropriate execute zod schema
-            const executeResult = (0, internal_1.validateOrFail)(toolExecutionResult.result, schemaToUse, 'execute', 'output');
+            const executeResult = (0, internal_1.validateOrFail)(abilityExecutionResult.result, schemaToUse, 'execute', 'output');
             console.log('Zod parse result:', executeResult);
-            if ((0, typeGuards_1.isToolResponseFailure)(executeResult)) {
+            if ((0, typeGuards_1.isAbilityResponseFailure)(executeResult)) {
                 // Parsing the result threw a zodError
                 return executeResult;
             }
-            console.log('Raw toolExecutionResult was:', toolExecutionResult);
+            console.log('Raw abilityExecutionResult was:', abilityExecutionResult);
             // We parsed the result -- it may be a success or a failure; return appropriately.
-            if ((0, typeGuards_1.isToolResponseFailure)(toolExecutionResult)) {
-                return (0, resultCreators_1.createToolExecuteResponseFailure)({
-                    ...(toolExecutionResult.runtimeError
-                        ? { runtimeError: toolExecutionResult.runtimeError }
+            if ((0, typeGuards_1.isAbilityResponseFailure)(abilityExecutionResult)) {
+                return (0, resultCreators_1.createAbilityExecuteResponseFailure)({
+                    ...(abilityExecutionResult.runtimeError
+                        ? { runtimeError: abilityExecutionResult.runtimeError }
                         : {}),
-                    ...(toolExecutionResult.schemaValidationError
-                        ? { schemaValidationError: toolExecutionResult.schemaValidationError }
+                    ...(abilityExecutionResult.schemaValidationError
+                        ? { schemaValidationError: abilityExecutionResult.schemaValidationError }
                         : {}),
                     result: executeResult,
-                    context: remoteVincentToolResult.toolContext,
+                    context: remoteVincentAbilityResult.abilityContext,
                 });
             }
             const res = executeResult;
-            return (0, resultCreators_1.createToolExecuteResponseSuccess)({
+            return (0, resultCreators_1.createAbilityExecuteResponseSuccess)({
                 result: res,
-                context: remoteVincentToolResult.toolContext,
+                context: remoteVincentAbilityResult.abilityContext,
             });
         },
     };
 }
-//# sourceMappingURL=vincentToolClient.js.map
+//# sourceMappingURL=vincentAbilityClient.js.map

package/dist/src/abilityClient/vincentAbilityClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vincentAbilityClient.js","sourceRoot":"","sources":["../../../src/abilityClient/vincentAbilityClient.ts"],"names":[],"mappings":";AAAA,4CAA4C;;AAiH5C,0DAqYC;AApfD,mCAAgC;AAChC,6BAAwB;AAKxB,uDAAsD;AACtD,yEAOoD;AAMpD,iFAAsF;AACtF,mGAAgG;AAChG,6DAIkC;AAClC,8DAGmC;AACnC,sEAA0E;AAC1E,6CAKsB;AAEtB,MAAM,mBAAmB,GAAG,0CAA0C,CAAC;AAEvE,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAE,KAAU,EAAE,EAAE;IAC9C,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;AAC9D,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAiEK;AACL,SAAgB,uBAAuB,CAUrC,MAiBD;;IAQC,MAAM,EAAE,qBAAqB,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;IACvD,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAE,GAAG,qBAAqB,CAAC;IAEpF,IAAA,wCAA6B,EAAC,wBAAwB,CAAC,CAAC;IAExD,MAAM,OAAO,GAAG,uBAAW,CAAC,KAAK,CAAC;IAElC,MAAM,oBAAoB,GAAG,CAAC,MAAA,cAAc,CAAC,aAAa,CAAC,oBAAoB,mCAC7E,OAAC,CAAC,SAAS,EAAE,CAAyB,CAAC;IACzC,MAAM,iBAAiB,GAAG,CAAC,MAAA,cAAc,CAAC,aAAa,CAAC,iBAAiB,mCACvE,OAAC,CAAC,SAAS,EAAE,CAAsB,CAAC;IAEtC,OAAO;QACL,KAAK,CAAC,QAAQ,CACZ,gBAA8C,EAC9C,EACE,MAAM,EACN,sBAAsB,GAGvB;YAID,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,EAAE,CAAC,CAAC;YAC9E,MAAM,sBAAsB,GAAG,eAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,YAAY,CAAC,UAAU,EAAE,CAAC,CAAC;YAExF,qIAAqI;YACrI,MAAM,WAAW,GAAG;gBAClB,UAAU,EAAE;oBACV,gBAAgB,EAAE,sBAAsB;oBACxC,0BAA0B;iBAC3B;gBACD,cAAc,EAAE,OAAO;gBACvB,oBAAoB;gBACpB,yBAAyB;aACnB,CAAC;YAET,MAAM,YAAY,GAAG,IAAA,yBAAc,EACjC,gBAAgB,EAChB,cAAc,CAAC,mBAAmB,EAClC,UAAU,EACV,OAAO,CACR,CAAC;YAEF,IAAI,IAAA,qCAAwB,EAAC,YAAY,CAAC,EAAE,CAAC;gBAC3C,OAAO,IAAA,6DAA4C,EAAC;oBAClD,GAAG,YAAY;oBACf,OAAO,EAAE,WAAW;iBACrB,CAIA,CAAC;YACJ,CAAC;YAED,MAAM,WAAW,GAAG,MAAM,IAAA,qBAAU,EAAC;gBACnC,sBAAsB,EAAE,0CAA+B;gBACvD,iBAAiB,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,mBAAmB;gBAChD,aAAa,EAAE,sBAAsB;aACtC,CAAC,CAAC;YACH,WAAW,CAAC,UAAU,CAAC,gBAAgB,GAAG,WAAW,CAAC;YAEtD,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;YAExC,MAAM,EAAE,eAAe,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM,IAAA,mCAAwB,EAAC;gBAC5E,gBAAgB,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,mBAAmB;gBAC/C,mBAAmB,EAAE,sBAAsB;gBAC3C,wBAAwB,EAAE,sBAAsB;gBAChD,cAAc,EAAE,OAAO;aACxB,CAAC,CAAC;YACH,WAAW,CAAC,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YACrC,WAAW,CAAC,UAAU,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;YAE/C,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;YAErF,MAAM,kBAAkB,GAAG,MAAM,IAAA,8CAAyB,EAAC;gBACzD,qBAAqB;gBACrB,aAAa,EAAE,YAA4C;gBAC3D,eAAe;gBACf,OAAO,EAAE;oBACP,GAAG,WAAW;oBACd,MAAM;iBACP;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;gBAC7B,OAAO,CAAC,GAAG,CACT,+EAA+E,EAC/E;oBACE,gBAAgB;oBAChB,sBAAsB;oBACtB,MAAM;iBACP,CACF,CAAC;gBACF,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;oBAC9C,OAAO,IAAA,6DAA4C,EAAC;wBAClD,OAAO,EAAE,kBAAkB;qBAC5B,CAIA,CAAC;gBACJ,CAAC;gBAED,OAAO,IAAA,6DAA4C,EAAC;oBAClD,OAAO,EAAE,kBAAkB;iBAC5B,CAIA,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;YAE1C,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,QAAQ,CAClD,EAAE,aAAa,EAAE,YAAY,EAAE,EAC/B,kBAAkB,CACnB,CAAC;YAEF,IACE,IAAA,qDAAwC,EAAC,cAAc,CAAC;gBACxD,IAAA,4CAA+B,EAAC,cAAc,CAAC,EAC/C,CAAC;gBACD,OAAO,CAAC,GAAG,CACT,yFAAyF,EACzF,IAAI,CAAC,SAAS,CACZ;oBACE,+BAA+B,EAAE,IAAA,4CAA+B,EAAC,cAAc,CAAC;oBAChF,wCAAwC,EACtC,IAAA,qDAAwC,EAAC,cAAc,CAAC;oBAC1D,cAAc;iBACf,EACD,cAAc,CACf,CACF,CAAC;gBACF,wFAAwF;gBACxF,OAAO,cAIN,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC;YAChF,OAAO;gBACL,GAAG,cAAc;gBACjB,OAAO,EAAE,kBAAkB;aAK5B,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,OAAO,CACX,gBAA8C,EAC9C,OAA6B;YAI7B,MAAM,YAAY,GAAG,IAAA,yBAAc,EACjC,gBAAgB,EAChB,cAAc,CAAC,mBAAmB,EAClC,SAAS,EACT,OAAO,CACR,CAAC;YAEF,IAAI,IAAA,qCAAwB,EAAC,YAAY,CAAC,EAAE,CAAC;gBAC3C,OAAO;oBACL,GAAG,YAAY;oBACf,OAAO;iBACkF,CAAC;YAC9F,CAAC;YAED,MAAM,aAAa,GAAG,MAAM,IAAA,2CAAwB,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YAClE,MAAM,WAAW,GAAG,MAAM,IAAA,qEAAiC,EAAC,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC;YAE7F,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC;gBAC3C,MAAM,EAAE,OAAO;gBACf,WAAW;gBACX,QAAQ,EAAE;oBACR,aAAa,EAAE,YAAY;oBAC3B,OAAO;oBACP,wBAAwB;iBACzB;aACF,CAAC,CAAC;YAEH,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;YACrC,OAAO,CAAC,GAAG,CAAC,4DAA4D,EAAE;gBACxE,QAAQ;gBACR,OAAO;aACR,CAAC,CAAC;YAEH,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;gBACrB,OAAO,IAAA,4DAA2C,EAAC;oBACjD,YAAY,EAAE,6CAA6C,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,EAAE,CAAC,CAAC,EAAE;iBACzG,CAIA,CAAC;YACJ,CAAC;YAED,IAAI,YAAY,GAAG,QAAQ,CAAC;YAE5B,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACjC,kGAAkG;gBAClG,IAAI,CAAC;oBACH,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBACpC,6DAA6D;gBAC/D,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,OAAO,IAAA,4DAA2C,EAAC;wBACjD,YAAY,EAAE,6CAA6C,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE;qBACtG,CAIA,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,IAAI,CAAC,IAAA,kDAAqC,EAAC,YAAY,CAAC,EAAE,CAAC;gBACzD,OAAO,CAAC,GAAG,CACT,iFAAiF,EACjF,EAAE,YAAY,EAAE,OAAO,EAAE,CAC1B,CAAC;gBAEF,OAAO,IAAA,4DAA2C,EAAC;oBACjD,YAAY,EAAE,6CAA6C,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,cAAc,CAAC,EAAE;iBAC1G,CAIA,CAAC;YACJ,CAAC;YAED,MAAM,0BAA0B,GAI5B,YAAY,CAAC;YAEjB,OAAO,CAAC,GAAG,CACT,iDAAiD,EACjD,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,cAAc,CAAC,CAC7C,CAAC;YAEF,MAAM,EAAE,cAAc,EAAE,sBAAsB,EAAE,GAAG,0BAA0B,CAAC;YAE9E,IACE,IAAA,qDAAwC,EAAC,sBAAsB,CAAC;gBAChE,IAAA,4CAA+B,EAAC,sBAAsB,CAAC,EACvD,CAAC;gBACD,OAAO,CAAC,GAAG,CACT,0FAA0F,EAC1F,IAAI,CAAC,SAAS,CACZ;oBACE,+BAA+B,EAC7B,IAAA,4CAA+B,EAAC,sBAAsB,CAAC;oBACzD,wCAAwC,EACtC,IAAA,qDAAwC,EAAC,sBAAsB,CAAC;oBAClE,sBAAsB;iBACvB,EACD,cAAc,CACf,CACF,CAAC;gBACF,wFAAwF;gBACxF,OAAO,IAAA,4DAA2C,EAAC;oBACjD,GAAG,CAAC,sBAAsB,CAAC,YAAY;wBACrC,CAAC,CAAC,EAAE,YAAY,EAAE,sBAAsB,CAAC,YAAY,EAAE;wBACvD,CAAC,CAAC,EAAE,CAAC;oBACP,GAAG,CAAC,sBAAsB,CAAC,qBAAqB;wBAC9C,CAAC,CAAC,EAAE,qBAAqB,EAAE,sBAAsB,CAAC,qBAAqB,EAAE;wBACzE,CAAC,CAAC,EAAE,CAAC;oBACP,OAAO,EAAE,0BAA0B,CAAC,cAAc;iBACnD,CAIA,CAAC;YACJ,CAAC;YAED,wDAAwD;YACxD,qFAAqF;YACrF,gFAAgF;YAChF,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;gBAC1C,OAAO,IAAA,4DAA2C,EAAC;oBACjD,OAAO,EAAE,cAAc;iBACxB,CAIA,CAAC;YACJ,CAAC;YAED,MAAM,mBAAmB,GAAG,IAAA,oCAAyB,EAAC;gBACpD,KAAK,EAAE,sBAAsB;gBAC7B,mBAAmB,EAAE,oBAAoB;gBACzC,mBAAmB,EAAE,iBAAiB;aACvC,CAAC,CAAC;YAEH,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,mBAAmB,CAAC;YAExD,OAAO,CAAC,GAAG,CAAC,oCAAoC,UAAU,aAAa,CAAC,CAAC;YAEzE,6DAA6D;YAC7D,MAAM,aAAa,GAAG,IAAA,yBAAc,EAClC,sBAAsB,CAAC,MAAM,EAC7B,WAAW,EACX,SAAS,EACT,QAAQ,CACT,CAAC;YAEF,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;YAEhD,IAAI,IAAA,qCAAwB,EAAC,aAAa,CAAC,EAAE,CAAC;gBAC5C,sCAAsC;gBACtC,OAAO,aAIN,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,iCAAiC,EAAE,sBAAsB,CAAC,CAAC;YAEvE,kFAAkF;YAClF,IAAI,IAAA,qCAAwB,EAAC,sBAAsB,CAAC,EAAE,CAAC;gBACrD,OAAO,IAAA,oDAAmC,EAAC;oBACzC,GAAG,CAAC,sBAAsB,CAAC,YAAY;wBACrC,CAAC,CAAC,EAAE,YAAY,EAAE,sBAAsB,CAAC,YAAY,EAAE;wBACvD,CAAC,CAAC,EAAE,CAAC;oBACP,GAAG,CAAC,sBAAsB,CAAC,qBAAqB;wBAC9C,CAAC,CAAC,EAAE,qBAAqB,EAAE,sBAAsB,CAAC,qBAAqB,EAAE;wBACzE,CAAC,CAAC,EAAE,CAAC;oBACP,MAAM,EAAE,aAAa;oBACrB,OAAO,EAAE,0BAA0B,CAAC,cAAc;iBACnD,CAIA,CAAC;YACJ,CAAC;YAED,MAAM,GAAG,GAA6C,aAAa,CAAC;YAEpE,OAAO,IAAA,oDAAmC,EAAC;gBACzC,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,0BAA0B,CAAC,cAAc;aACnD,CAA2F,CAAC;QAC/F,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/src/expressMiddleware/express.js

@@ -105,7 +105,16 @@ function getAuthenticateUserExpressHandler({ allowedAudience, requiredAppId, use
             return;
         }
         try {
-            const decodedJWT = (0, jwt_1.verify)({ jwt: rawJWT, expectedAudience: allowedAudience, requiredAppId });
+            const decodedJWT = requiredAppId != null
+                ? await (0, jwt_1.verifyVincentAppUserJWT)({
+                    jwt: rawJWT,
+                    expectedAudience: allowedAudience,
+                    requiredAppId,
+                })
+                : await (0, jwt_1.verifyVincentPlatformJWT)({
+                    jwt: rawJWT,
+                    expectedAudience: allowedAudience,
+                });
             if (!decodedJWT) {
                 res.status(401).json({ error: 'Invalid token' });
                 return;

package/dist/src/expressMiddleware/express.js.map

@@ -1 +1 @@
-{"version":3,"file":"express.js","sourceRoot":"","sources":["../../../src/expressMiddleware/express.ts"],"names":[],"mappings":";;AA8EA,kEASC;AAnFD,gCAAgC;AAChC,6CAAoD;AAEpD,SAAS,0BAA0B,CACjC,GAAY,EACZ,OAAgB;IAEhB,qCAAqC;IACrC,IAAI,CAAC,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;IAChG,CAAC;IAED,6BAA6B;IAC7B,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAA4B,CAAC;IAErD,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEpC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,IAAA,uBAAe,EAAC,UAAU,CAAC,EAAE,CAAC;QAC/D,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;IACvF,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,SAAgB,2BAA2B,CAA+B,MAIzE;IACC,OAAO;QACL,UAAU,EAAE,iCAAiC,CAAC,MAAM,CAAC;QACrD,OAAO,EAAE,2BAA2B,CAAC,MAAM,CAAC,OAAO,CAAC;KACrD,CAAC;AACJ,CAAC;AAED,SAAS,2BAA2B,CAA+B,OAAgB;IACjF,OAAO,UAAU,OAA6C;QAC5D,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;YACzD,IAAI,CAAC;gBACH,0BAA0B,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBACzC,OAAO,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YACjC,CAAC;YAAC,WAAM,CAAC;gBACP,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC,CAAC;YACvD,CAAC;QACH,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED,qCAAqC;AACrC,SAAS,iCAAiC,CAA+B,EACvE,eAAe,EACf,aAAa,EACb,OAAO,GAKR;IACC,OAAO,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;QAC/D,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC,CAAC;YACrD,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,0DAA0D,EAAE,CAAC,CAAC;YAC5F,OAAO;QACT,CAAC;QAED,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;QAC/B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,kCAAkC,MAAM,GAAG,EAAE,CAAC,CAAC;YAC7E,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,IAAA,YAAM,EAAC,EAAE,GAAG,EAAE,MAAM,EAAE,gBAAgB,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC,CAAC;YAC7F,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;gBACjD,OAAO;YACT,CAAC;YAEA,GAAiD,CAAC,OAAO,CAAC,GAAG;gBAC5D,UAAU;gBACV,MAAM;aACW,CAAC;YAEpB,IAAI,EAAE,CAAC;QACT,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,kBAAmB,CAAW,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AACD,wCAAwC"}
+{"version":3,"file":"express.js","sourceRoot":"","sources":["../../../src/expressMiddleware/express.ts"],"names":[],"mappings":";;AA8EA,kEASC;AAnFD,gCAA2E;AAC3E,6CAAoD;AAEpD,SAAS,0BAA0B,CACjC,GAAY,EACZ,OAAgB;IAEhB,qCAAqC;IACrC,IAAI,CAAC,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;IAChG,CAAC;IAED,6BAA6B;IAC7B,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAA4B,CAAC;IAErD,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEpC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,IAAA,uBAAe,EAAC,UAAU,CAAC,EAAE,CAAC;QAC/D,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;IACvF,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,SAAgB,2BAA2B,CAA+B,MAIzE;IACC,OAAO;QACL,UAAU,EAAE,iCAAiC,CAAC,MAAM,CAAC;QACrD,OAAO,EAAE,2BAA2B,CAAC,MAAM,CAAC,OAAO,CAAC;KACrD,CAAC;AACJ,CAAC;AAED,SAAS,2BAA2B,CAA+B,OAAgB;IACjF,OAAO,UAAU,OAA6C;QAC5D,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;YACzD,IAAI,CAAC;gBACH,0BAA0B,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBACzC,OAAO,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YACjC,CAAC;YAAC,WAAM,CAAC;gBACP,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC,CAAC;YACvD,CAAC;QACH,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED,qCAAqC;AACrC,SAAS,iCAAiC,CAA+B,EACvE,eAAe,EACf,aAAa,EACb,OAAO,GAKR;IACC,OAAO,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;QAC/D,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC,CAAC;YACrD,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,0DAA0D,EAAE,CAAC,CAAC;YAC5F,OAAO;QACT,CAAC;QAED,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;QAC/B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,kCAAkC,MAAM,GAAG,EAAE,CAAC,CAAC;YAC7E,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,MAAM,UAAU,GACd,aAAa,IAAI,IAAI;gBACnB,CAAC,CAAC,MAAM,IAAA,6BAAuB,EAAC;oBAC5B,GAAG,EAAE,MAAM;oBACX,gBAAgB,EAAE,eAAe;oBACjC,aAAa;iBACd,CAAC;gBACJ,CAAC,CAAC,MAAM,IAAA,8BAAwB,EAAC;oBAC7B,GAAG,EAAE,MAAM;oBACX,gBAAgB,EAAE,eAAe;iBAClC,CAAC,CAAC;YAET,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;gBACjD,OAAO;YACT,CAAC;YAEA,GAAiD,CAAC,OAAO,CAAC,GAAG;gBAC5D,UAAU;gBACV,MAAM;aACW,CAAC;YAEpB,IAAI,EAAE,CAAC;QACT,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,kBAAmB,CAAW,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AACD,wCAAwC"}