@algorandfoundation/algokit-utils 8.2.2 → 9.0.0-beta.1

package/types/config.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"config.mjs","sources":["../../src/types/config.ts"],"sourcesContent":["import { AsyncEventEmitter } from './async-event-emitter'\nimport { Logger, consoleLogger, nullLogger } from './logging'\n\n/** The AlgoKit configuration type */\nexport interface Config {\n  /** Logger */\n  logger: Logger\n  /** Whether or not debug mode is enabled */\n  debug: boolean\n  /** The path to the project root directory */\n  projectRoot: string | null\n  /** Indicates whether to trace all operations */\n  traceAll: boolean\n  /** The size of the trace buffer in megabytes */\n  traceBufferSizeMb: number\n  /** The maximum depth to search for a specific file */\n  maxSearchDepth: number\n  /**\n   * Whether to enable populateAppCallResources in sendParams by default.\n   * Default value is false.\n   */\n  populateAppCallResources: boolean\n\n  events: AsyncEventEmitter\n}\n\n/** Updatable AlgoKit config */\nexport class UpdatableConfig implements Readonly<Config> {\n  private config: Config\n\n  get populateAppCallResources() {\n    return this.config.populateAppCallResources\n  }\n\n  get logger() {\n    return this.config.logger\n  }\n\n  get debug() {\n    return this.config.debug\n  }\n\n  get projectRoot() {\n    return this.config.projectRoot\n  }\n\n  get traceAll() {\n    return this.config.traceAll\n  }\n\n  get traceBufferSizeMb() {\n    return this.config.traceBufferSizeMb\n  }\n\n  get maxSearchDepth() {\n    return this.config.maxSearchDepth\n  }\n\n  get events() {\n    return this.config.events\n  }\n\n  /**\n   * Returns the current logger, or the null logger if true is passed in to `returnNullLogger`\n   * @param returnNullLogger Whether or not to return the null logger\n   * @returns The requested logger\n   */\n  getLogger(returnNullLogger?: boolean) {\n    if (returnNullLogger) {\n      return nullLogger\n    }\n\n    return this.logger\n  }\n\n  /**\n   * Temporarily run with debug set to true.\n   * @param lambda A lambda expression with code to run with debug config set to true\n   */\n  withDebug(lambda: () => unknown) {\n    const original = this.config.debug\n    try {\n      this.config.debug = true\n      lambda()\n    } finally {\n      this.config.debug = original\n    }\n  }\n\n  constructor() {\n    this.config = {\n      logger: consoleLogger,\n      debug: false,\n      projectRoot: null,\n      traceAll: false,\n      traceBufferSizeMb: 256,\n      maxSearchDepth: 10,\n      populateAppCallResources: false,\n      events: new AsyncEventEmitter(),\n    }\n  }\n\n  /**\n   * Update the AlgoKit configuration with your own configuration settings\n   * @param newConfig Partial or complete config to replace\n   */\n  configure(newConfig: Partial<Config>) {\n    this.config = { ...this.config, ...newConfig }\n  }\n}\n"],"names":[],"mappings":";;;AA0BA;MACa,eAAe,CAAA;AAG1B,IAAA,IAAI,wBAAwB,GAAA;AAC1B,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB;;AAG7C,IAAA,IAAI,MAAM,GAAA;AACR,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM;;AAG3B,IAAA,IAAI,KAAK,GAAA;AACP,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK;;AAG1B,IAAA,IAAI,WAAW,GAAA;AACb,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW;;AAGhC,IAAA,IAAI,QAAQ,GAAA;AACV,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ;;AAG7B,IAAA,IAAI,iBAAiB,GAAA;AACnB,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB;;AAGtC,IAAA,IAAI,cAAc,GAAA;AAChB,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc;;AAGnC,IAAA,IAAI,MAAM,GAAA;AACR,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM;;AAG3B;;;;AAIG;AACH,IAAA,SAAS,CAAC,gBAA0B,EAAA;QAClC,IAAI,gBAAgB,EAAE;AACpB,YAAA,OAAO,UAAU;;QAGnB,OAAO,IAAI,CAAC,MAAM;;AAGpB;;;AAGG;AACH,IAAA,SAAS,CAAC,MAAqB,EAAA;AAC7B,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK;AAClC,QAAA,IAAI;AACF,YAAA,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI;AACxB,YAAA,MAAM,EAAE;;gBACA;AACR,YAAA,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,QAAQ;;;AAIhC,IAAA,WAAA,GAAA;QACE,IAAI,CAAC,MAAM,GAAG;AACZ,YAAA,MAAM,EAAE,aAAa;AACrB,YAAA,KAAK,EAAE,KAAK;AACZ,YAAA,WAAW,EAAE,IAAI;AACjB,YAAA,QAAQ,EAAE,KAAK;AACf,YAAA,iBAAiB,EAAE,GAAG;AACtB,YAAA,cAAc,EAAE,EAAE;AAClB,YAAA,wBAAwB,EAAE,KAAK;YAC/B,MAAM,EAAE,IAAI,iBAAiB,EAAE;SAChC;;AAGH;;;AAGG;AACH,IAAA,SAAS,CAAC,SAA0B,EAAA;AAClC,QAAA,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,EAAE;;AAEjD;;;;"}
+{"version":3,"file":"config.mjs","sources":["../../src/types/config.ts"],"sourcesContent":["import { AsyncEventEmitter } from './async-event-emitter'\nimport { Logger, consoleLogger, nullLogger } from './logging'\n\n/** The AlgoKit configuration type */\nexport interface Config {\n  /** Logger */\n  logger: Logger\n  /** Whether or not debug mode is enabled */\n  debug: boolean\n  /** The path to the project root directory */\n  projectRoot: string | null\n  /** Indicates whether to trace all operations */\n  traceAll: boolean\n  /** The size of the trace buffer in megabytes */\n  traceBufferSizeMb: number\n  /** The maximum depth to search for a specific file */\n  maxSearchDepth: number\n  /**\n   * Whether to enable populateAppCallResources in sendParams by default.\n   * Default value is false.\n   */\n  populateAppCallResources: boolean\n\n  events: AsyncEventEmitter\n}\n\n/** Updatable AlgoKit config */\nexport class UpdatableConfig implements Readonly<Config> {\n  private config: Config\n\n  get populateAppCallResources() {\n    return this.config.populateAppCallResources\n  }\n\n  get logger() {\n    return this.config.logger\n  }\n\n  get debug() {\n    return this.config.debug\n  }\n\n  get projectRoot() {\n    return this.config.projectRoot\n  }\n\n  get traceAll() {\n    return this.config.traceAll\n  }\n\n  get traceBufferSizeMb() {\n    return this.config.traceBufferSizeMb\n  }\n\n  get maxSearchDepth() {\n    return this.config.maxSearchDepth\n  }\n\n  get events() {\n    return this.config.events\n  }\n\n  /**\n   * Returns the current logger, or the null logger if true is passed in to `returnNullLogger`\n   * @param returnNullLogger Whether or not to return the null logger\n   * @returns The requested logger\n   */\n  getLogger(returnNullLogger?: boolean) {\n    if (returnNullLogger) {\n      return nullLogger\n    }\n\n    return this.logger\n  }\n\n  /**\n   * Temporarily run with debug set to true.\n   * @param lambda A lambda expression with code to run with debug config set to true\n   */\n  withDebug(lambda: () => unknown) {\n    const original = this.config.debug\n    try {\n      this.config.debug = true\n      lambda()\n    } finally {\n      this.config.debug = original\n    }\n  }\n\n  constructor() {\n    this.config = {\n      logger: consoleLogger,\n      debug: false,\n      projectRoot: null,\n      traceAll: false,\n      traceBufferSizeMb: 256,\n      maxSearchDepth: 10,\n      populateAppCallResources: true,\n      events: new AsyncEventEmitter(),\n    }\n  }\n\n  /**\n   * Update the AlgoKit configuration with your own configuration settings\n   * @param newConfig Partial or complete config to replace\n   */\n  configure(newConfig: Partial<Config>) {\n    this.config = { ...this.config, ...newConfig }\n  }\n}\n"],"names":[],"mappings":";;;AA0BA;MACa,eAAe,CAAA;AAG1B,IAAA,IAAI,wBAAwB,GAAA;AAC1B,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB;;AAG7C,IAAA,IAAI,MAAM,GAAA;AACR,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM;;AAG3B,IAAA,IAAI,KAAK,GAAA;AACP,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK;;AAG1B,IAAA,IAAI,WAAW,GAAA;AACb,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW;;AAGhC,IAAA,IAAI,QAAQ,GAAA;AACV,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ;;AAG7B,IAAA,IAAI,iBAAiB,GAAA;AACnB,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB;;AAGtC,IAAA,IAAI,cAAc,GAAA;AAChB,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc;;AAGnC,IAAA,IAAI,MAAM,GAAA;AACR,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM;;AAG3B;;;;AAIG;AACH,IAAA,SAAS,CAAC,gBAA0B,EAAA;QAClC,IAAI,gBAAgB,EAAE;AACpB,YAAA,OAAO,UAAU;;QAGnB,OAAO,IAAI,CAAC,MAAM;;AAGpB;;;AAGG;AACH,IAAA,SAAS,CAAC,MAAqB,EAAA;AAC7B,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK;AAClC,QAAA,IAAI;AACF,YAAA,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI;AACxB,YAAA,MAAM,EAAE;;gBACA;AACR,YAAA,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,QAAQ;;;AAIhC,IAAA,WAAA,GAAA;QACE,IAAI,CAAC,MAAM,GAAG;AACZ,YAAA,MAAM,EAAE,aAAa;AACrB,YAAA,KAAK,EAAE,KAAK;AACZ,YAAA,WAAW,EAAE,IAAI;AACjB,YAAA,QAAQ,EAAE,KAAK;AACf,YAAA,iBAAiB,EAAE,GAAG;AACtB,YAAA,cAAc,EAAE,EAAE;AAClB,YAAA,wBAAwB,EAAE,IAAI;YAC9B,MAAM,EAAE,IAAI,iBAAiB,EAAE;SAChC;;AAGH;;;AAGG;AACH,IAAA,SAAS,CAAC,SAA0B,EAAA;AAClC,QAAA,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,EAAE;;AAEjD;;;;"}

package/types/algorand-client-interface.d.ts

@@ -1,52 +0,0 @@
-import algosdk from 'algosdk';
-import { AlgorandClientTransactionCreator } from './algorand-client-transaction-creator';
-import { AlgorandClientTransactionSender } from './algorand-client-transaction-sender';
-import { AppDeployer } from './app-deployer';
-import { AppManager } from './app-manager';
-import { TransactionComposer } from './composer';
-import { NetworkDetails } from './network-client';
-import Algodv2 = algosdk.Algodv2;
-import Indexer = algosdk.Indexer;
-import type { AlgorandClient } from './algorand-client';
-import { InterfaceOf } from './interface-of';
-/**
- * @deprecated Use `AlgorandClient` with `import type` instead since this
- * interface does not implement the full interface for the AlgorandClient
- * and will get removed in the next major release
- *
- * @see https://github.com/algorandfoundation/algokit-utils-ts/pull/365
- */
-interface OldAlgorandClientInterface {
-    app: AppManager;
-    appDeployer: AppDeployer;
-    send: AlgorandClientTransactionSender;
-    createTransaction: AlgorandClientTransactionCreator;
-    newGroup(): TransactionComposer;
-    client: {
-        algod: Algodv2;
-        indexer?: Indexer;
-        network(): Promise<NetworkDetails>;
-        isLocalNet(): Promise<boolean>;
-        isTestNet(): Promise<boolean>;
-        isMainNet(): Promise<boolean>;
-    };
-}
-/**
- * @deprecated Use `AlgorandClient` with `import type` instead since this interface
- * will get removed in the next major release
- *
- * This type is a solution to the problem raised in the PR below.
- * In summary, we needed to update the interface without making a breaking
- * change so this was the best option. This interface has some optional properties,
- * such as `account`, but unless you are using a custom implementation of AlgorandClient
- * (you probably aren't) you can be sure these will always be defined.
- *
- * @example
- * ```ts
- * algorand.account!.getInformation(addr);
- * ```
- *
- * @see https://github.com/algorandfoundation/algokit-utils-ts/pull/365
- */
-export type AlgorandClientInterface = OldAlgorandClientInterface & Partial<InterfaceOf<AlgorandClient>>;
-export {};

package/types/algorand-client-interface.js

@@ -1,3 +0,0 @@
-'use strict';
-
-//# sourceMappingURL=algorand-client-interface.js.map

package/types/algorand-client-interface.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"algorand-client-interface.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/types/algorand-client-interface.mjs

@@ -1,2 +0,0 @@
-
-//# sourceMappingURL=algorand-client-interface.mjs.map

package/types/algorand-client-interface.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"algorand-client-interface.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/types/interface-of.d.ts

@@ -1,3 +0,0 @@
-export type InterfaceOf<ClassType> = {
-    [Member in keyof ClassType]: ClassType[Member];
-};

package/types/interface-of.js

@@ -1,3 +0,0 @@
-'use strict';
-
-//# sourceMappingURL=interface-of.js.map

package/types/interface-of.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"interface-of.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/types/interface-of.mjs

@@ -1,2 +0,0 @@
-
-//# sourceMappingURL=interface-of.mjs.map

package/types/interface-of.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"interface-of.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}