chore(e2e-test-utils): avoid circular reference, policy config example, export return type of vincent dev env

Author: awisniew207

packages/libs/e2e-test-utils/src/index.ts

@@ -13,3 +13,4 @@ export {
 } from './lib';
 
 export type { PkpInfo } from './lib/mint-new-pkp';
+export type { VincentDevEnvironment } from './lib/setup-vincent-development-environment';

packages/libs/e2e-test-utils/src/lib/index.ts

@@ -18,4 +18,7 @@ export { ensureUnexpiredCapacityToken } from './ensure-capacity-credit';
 export { getEnv } from './env';
 export { getChainHelpers } from './chain';
 export { createRandomVincentWallets } from './create-random-vincent-wallets';
-export { setupVincentDevelopmentEnvironment } from './setup-vincent-development-environment';
+export {
+  setupVincentDevelopmentEnvironment,
+  type VincentDevEnvironment,
+} from './setup-vincent-development-environment';

packages/libs/e2e-test-utils/src/lib/setup-vincent-development-environment.ts

@@ -1,16 +1,17 @@
-import {
-  delegator,
-  delegatee,
-  appManager,
-  funder,
-  getChainHelpers,
-  ensureUnexpiredCapacityToken,
-  type PkpInfo,
-} from '../index';
-import { type PermissionData } from '@lit-protocol/vincent-contracts-sdk';
-import { type Wallet } from 'ethers';
+import type { Wallet } from 'ethers';
 
-export interface SetupResult {
+import type { PermissionData } from '@lit-protocol/vincent-contracts-sdk';
+
+import type { PkpInfo } from './mint-new-pkp';
+
+import * as appManager from './appManager';
+import { getChainHelpers } from './chain';
+import * as delegatee from './delegatee';
+import * as delegator from './delegator';
+import { ensureUnexpiredCapacityToken } from './ensure-capacity-credit';
+import * as funder from './funder';
+
+export interface VincentDevEnvironment {
   agentPkpInfo: PkpInfo;
   wallets: {
     appDelegatee: Wallet;
@@ -35,19 +36,29 @@ export interface SetupResult {
  * @returns the setup result including agent PKP info, wallets, app ID, and app version
  * @example
  * ```typescript
+ * // Example with no policies
  * const permissionData = {
- *   // EVM Transaction Signer Ability has no policies
- *   // If yours does, you would add the policies to this object
  *   [bundledVincentAbility.ipfsCid]: {},
  * };
+ *
+ * // Example with policies
+ * const permissionDataWithPolicies = {
+ *   [bundledVincentAbility.ipfsCid]: {
+ *     [spendingLimitPolicy.ipfsCid]: {
+ *       limit: '1000000',
+ *       period: '86400',
+ *     },
+ *   },
+ * };
+ *
  * const result = await setupVincentDevelopmentEnvironment({ permissionData });
  * ```
  */
 export const setupVincentDevelopmentEnvironment = async ({
   permissionData,
 }: {
   permissionData: PermissionData;
-}): Promise<SetupResult> => {
+}): Promise<VincentDevEnvironment> => {
   // Check and fund all required accounts
   await funder.checkFunderBalance();
   await delegatee.ensureAppDelegateeFunded();