@algorandfoundation/algokit-utils 1.0.0 → 1.1.1-beta.1

package/types/app.d.ts

@@ -1,5 +1,5 @@
-import { ABIArgument, ABIMethod, ABIMethodParams, ABIType, ABIValue, Address, SourceMap, SuggestedParams, Transaction } from 'algosdk';
-import { SendTransactionFrom, SendTransactionParams, SendTransactionResult, TransactionNote, TransactionToSign } from './transaction';
+import algosdk, { ABIArgument, ABIMethod, ABIMethodParams, ABIType, ABIValue, Address, SourceMap, SuggestedParams, Transaction } from 'algosdk';
+import { SendTransactionFrom, SendTransactionParams, SendTransactionResult, SendTransactionResults, TransactionNote, TransactionToSign } from './transaction';
 /** The name of the TEAL template variable for deploy-time immutability control */
 export declare const UPDATABLE_TEMPLATE_NAME = "TMPL_UPDATABLE";
 /** The name of the TEAL template variable for deploy-time permanence control */
@@ -28,8 +28,15 @@ export interface BoxReference {
     /**
      * Name of box to reference
      */
-    name: Uint8Array | string;
+    name: BoxIdentifier;
 }
+/**
+ * Something that identifies a box name - either a:
+ *  * `Uint8Array`
+ *  * `string` (that will be encoded to a Uint8Array)
+ *  * `SendTransactionFrom` (encoded into the public key address of the corresponding account)
+ */
+export type BoxIdentifier = string | Uint8Array | SendTransactionFrom;
 /**
  * App call args with raw values (minus some processing like encoding strings as binary)
  */
@@ -39,7 +46,7 @@ export interface RawAppCallArgs {
     /** Any application arguments to pass through */
     appArgs?: (Uint8Array | string)[];
     /** Any box references to load */
-    boxes?: BoxReference[];
+    boxes?: (algosdk.BoxReference | BoxReference | BoxIdentifier)[];
     /** IDs of any apps to load into the foreignApps array */
     apps?: number[];
     /** IDs of any assets to load into the foreignAssets array */
@@ -47,22 +54,20 @@ export interface RawAppCallArgs {
     /** The optional lease for the transaction */
     lease?: string | Uint8Array;
 }
-export type ABIAppCallArg = ABIArgument | TransactionToSign | Transaction;
+/** An argument for an ABI method, either a primitive value, or a transaction with or without signer, or the unawaited async return value of an algokit method that returns a `SendTransactionResult` */
+export type ABIAppCallArg = ABIArgument | TransactionToSign | Transaction | Promise<SendTransactionResult>;
 /**
  * App call args for an ABI call
  */
 export interface ABIAppCallArgs {
-    /** The ABI method to call, either:
-     *  * `method_name` e.g. `hello`; or
-     *  * `method_signature` e.g. `hello(string)string`
-     **/
+    /** The ABI method to call */
     method: ABIMethodParams | ABIMethod;
     /** The ABI args to pass in */
     args: ABIAppCallArg[];
     /** The optional lease for the transaction */
     lease?: string | Uint8Array;
     /** Any box references to load either as the box name (if for the current app) or the reference with app id */
-    boxes?: (BoxReference | Uint8Array | string)[];
+    boxes?: (algosdk.BoxReference | BoxReference | BoxIdentifier)[];
 }
 /** Arguments to pass to an app call either:
  *   * The raw app call values to pass through into the transaction (after processing); or
@@ -71,7 +76,7 @@ export interface ABIAppCallArgs {
 export type AppCallArgs = RawAppCallArgs | ABIAppCallArgs;
 /** Base interface for common data passed to an app create or update. */
 interface CreateOrUpdateAppParams extends SendTransactionParams {
-    /** The account (with private key loaded) that will send the µALGOs */
+    /** The account (with private key loaded) that will send the transaction */
     from: SendTransactionFrom;
     /** The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */
     approvalProgram: Uint8Array | string;
@@ -94,10 +99,11 @@ export interface UpdateAppParams extends CreateOrUpdateAppParams {
     /** The id of the app to update */
     appId: number;
 }
+/** Parameters representing a call to an app. */
 export interface AppCallParams extends SendTransactionParams {
     /** The id of the app to call */
     appId: number;
-    /** The type of call, everything except create (@see createApp ) and update (@see updateApp ) */
+    /** The type of call, everything except create (`createApp`) and update (`updateApp`) */
     callType: 'optin' | 'closeout' | 'clearstate' | 'delete' | 'normal';
     /** The account to make the call from */
     from: SendTransactionFrom;
@@ -135,7 +141,7 @@ export interface CompiledTeal {
     sourceMap: SourceMap;
 }
 /** Result from calling an app */
-export interface AppCallTransactionResult extends SendTransactionResult {
+export interface AppCallTransactionResult extends SendTransactionResults, SendTransactionResult {
     /** If an ABI method was called the processed return value */
     return?: ABIReturn;
 }
@@ -150,7 +156,7 @@ export type ABIReturn = {
     decodeError: Error;
 };
 /**
- * The payload of the metadata to add to the transaction note when deploying an app, noting it will be prefixed with @see {APP_DEPLOY_NOTE_PREFIX}.
+ * The payload of the metadata to add to the transaction note when deploying an app, noting it will be prefixed with `APP_DEPLOY_NOTE_PREFIX`.
  */
 export interface AppDeployMetadata {
     /** The unique name identifier of the app within the creator account */
@@ -205,7 +211,7 @@ export declare enum OnSchemaBreak {
     ReplaceApp = 1
 }
 /** The parameters to deploy an app */
-export interface AppDeploymentParams extends Omit<CreateAppParams, 'args' | 'note' | 'skipSending' | 'skipWaiting'> {
+export interface AppDeploymentParams extends Omit<CreateAppParams, 'args' | 'note' | 'skipSending' | 'skipWaiting' | 'atc'> {
     /** The deployment metadata */
     metadata: AppDeployMetadata;
     /** Any deploy-time parameters to replace in the TEAL code */
@@ -259,7 +265,7 @@ export interface BoxName {
 export interface BoxValueRequestParams {
     /** The ID of the app return box names for */
     appId: number;
-    /** The name of the box to return either as a string, binary array or @see BoxName */
+    /** The name of the box to return either as a string, binary array or `BoxName` */
     boxName: string | Uint8Array | BoxName;
     /** The ABI type to decode the value using */
     type: ABIType;
@@ -270,7 +276,7 @@ export interface BoxValueRequestParams {
 export interface BoxValuesRequestParams {
     /** The ID of the app return box names for */
     appId: number;
-    /** The names of the boxes to return either as a string, binary array or @see BoxName */
+    /** The names of the boxes to return either as a string, binary array or BoxName` */
     boxNames: (string | Uint8Array | BoxName)[];
     /** The ABI type to decode the value using */
     type: ABIType;

package/types/app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/types/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACtI,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAErI,kFAAkF;AAClF,eAAO,MAAM,uBAAuB,mBAAmB,CAAA;AAEvD,gFAAgF;AAChF,eAAO,MAAM,uBAAuB,mBAAmB,CAAA;AAEvD,0DAA0D;AAC1D,eAAO,MAAM,oBAAoB,qBAAqB,CAAA;AAEtD,4DAA4D;AAC5D,eAAO,MAAM,iBAAiB,OAAO,CAAA;AAErC,qFAAqF;AACrF,eAAO,MAAM,iBAAiB,YAAqC,CAAA;AAEnE,wCAAwC;AACxC,MAAM,WAAW,YAAY;IAC3B,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,kEAAkE;IAClE,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE,CAAA;IAC/B,gDAAgD;IAChD,OAAO,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,CAAC,EAAE,CAAA;IACjC,iCAAiC;IACjC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAA;IACtB,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;CAC5B;AAED,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,iBAAiB,GAAG,WAAW,CAAA;AAEzE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;QAGI;IACJ,MAAM,EAAE,eAAe,GAAG,SAAS,CAAA;IACnC,8BAA8B;IAC9B,IAAI,EAAE,aAAa,EAAE,CAAA;IACrB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;IAC3B,8GAA8G;IAC9G,KAAK,CAAC,EAAE,CAAC,YAAY,GAAG,UAAU,GAAG,MAAM,CAAC,EAAE,CAAA;CAC/C;AAED;;;IAGI;AACJ,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,cAAc,CAAA;AAEzD,wEAAwE;AACxE,UAAU,uBAAwB,SAAQ,qBAAqB;IAC7D,sEAAsE;IACtE,IAAI,EAAE,mBAAmB,CAAA;IACzB,+GAA+G;IAC/G,eAAe,EAAE,UAAU,GAAG,MAAM,CAAA;IACpC,kHAAkH;IAClH,iBAAiB,EAAE,UAAU,GAAG,MAAM,CAAA;IACtC,sCAAsC;IACtC,iBAAiB,CAAC,EAAE,eAAe,CAAA;IACnC,sCAAsC;IACtC,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAED,0DAA0D;AAC1D,MAAM,WAAW,eAAgB,SAAQ,uBAAuB;IAC9D,wDAAwD;IACxD,MAAM,EAAE,gBAAgB,CAAA;CACzB;AAED,0DAA0D;AAC1D,MAAM,WAAW,eAAgB,SAAQ,uBAAuB;IAC9D,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,aAAc,SAAQ,qBAAqB;IAC1D,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,gGAAgG;IAChG,QAAQ,EAAE,OAAO,GAAG,UAAU,GAAG,YAAY,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACnE,wCAAwC;IACxC,IAAI,EAAE,mBAAmB,CAAA;IACzB,sCAAsC;IACtC,iBAAiB,CAAC,EAAE,eAAe,CAAA;IACnC,sCAAsC;IACtC,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAED,4DAA4D;AAC5D,MAAM,WAAW,gBAAgB;IAC/B,uDAAuD;IACvD,SAAS,EAAE,MAAM,CAAA;IACjB,8DAA8D;IAC9D,eAAe,EAAE,MAAM,CAAA;IACvB,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAA;IAClB,sDAAsD;IACtD,gBAAgB,EAAE,MAAM,CAAA;IACxB,0JAA0J;IAC1J,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,gDAAgD;AAChD,MAAM,WAAW,YAAY;IAC3B,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAA;IACpB,8CAA8C;IAC9C,qBAAqB,EAAE,UAAU,CAAA;IACjC,sCAAsC;IACtC,SAAS,EAAE,SAAS,CAAA;CACrB;AAED,iCAAiC;AACjC,MAAM,WAAW,wBAAyB,SAAQ,qBAAqB;IACrE,6DAA6D;IAC7D,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,6CAA6C;AAC7C,MAAM,MAAM,SAAS,GACjB;IACE,cAAc,EAAE,UAAU,CAAA;IAC1B,WAAW,EAAE,QAAQ,CAAA;IACrB,WAAW,EAAE,SAAS,CAAA;CACvB,GACD;IAAE,cAAc,EAAE,SAAS,CAAC;IAAC,WAAW,EAAE,SAAS,CAAC;IAAC,WAAW,EAAE,KAAK,CAAA;CAAE,CAAA;AAE7E;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAA;IACZ,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAA;IACf,oEAAoE;IACpE,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,oEAAoE;IACpE,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,8DAA8D;AAC9D,MAAM,WAAW,WAAY,SAAQ,YAAY,EAAE,iBAAiB;IAClE,oCAAoC;IACpC,YAAY,EAAE,MAAM,CAAA;IACpB,8CAA8C;IAC9C,YAAY,EAAE,MAAM,CAAA;IACpB,4CAA4C;IAC5C,eAAe,EAAE,iBAAiB,CAAA;IAClC,wCAAwC;IACxC,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,qDAAqD;AACrD,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACzB,IAAI,EAAE,QAAQ,CAAC;QACb,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAA;KAC5B,CAAC,CAAA;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAA;CACrD;AAED,8FAA8F;AAC9F,oBAAY,QAAQ;IAClB,0BAA0B;IAC1B,IAAI,IAAA;IACJ,qBAAqB;IACrB,SAAS,IAAA;IACT,uDAAuD;IACvD,UAAU,IAAA;CACX;AAED,4FAA4F;AAC5F,oBAAY,aAAa;IACvB,0BAA0B;IAC1B,IAAI,IAAA;IACJ,uDAAuD;IACvD,UAAU,IAAA;CACX;AAED,sCAAsC;AACtC,MAAM,WAAW,mBAAoB,SAAQ,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,aAAa,CAAC;IACjH,8BAA8B;IAC9B,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,6DAA6D;IAC7D,gBAAgB,CAAC,EAAE,kBAAkB,CAAA;IACrC,2DAA2D;IAC3D,aAAa,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,aAAa,CAAA;IAClD,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,CAAA;IACnD,uEAAuE;IACvE,mBAAmB,CAAC,EAAE,SAAS,CAAA;IAC/B,sFAAsF;IACtF,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,sFAAsF;IACtF,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,sFAAsF;IACtF,UAAU,CAAC,EAAE,WAAW,CAAA;CACzB;AAED,qEAAqE;AACrE,MAAM,WAAW,oBAAoB;IACnC,yCAAyC;IACzC,gBAAgB,EAAE,YAAY,CAAA;IAC9B,sCAAsC;IACtC,aAAa,EAAE,YAAY,CAAA;CAC5B;AAED,sCAAsC;AACtC,MAAM,WAAW,QAAQ;IACvB,CAAC,GAAG,EAAE,MAAM,GACR;QACE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;QACtB,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,MAAM,CAAA;KAClB,GACD;QACE,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,UAAU,CAAA;QACpB,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;CACN;AAED,oCAAoC;AACpC,MAAM,WAAW,OAAO;IACtB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,2BAA2B;IAC3B,OAAO,EAAE,UAAU,CAAA;IACnB,qBAAqB;IACrB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAA;IACb,qFAAqF;IACrF,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAA;IACtC,6CAA6C;IAC7C,IAAI,EAAE,OAAO,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAA;IACb,wFAAwF;IACxF,QAAQ,EAAE,CAAC,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,EAAE,CAAA;IAC3C,6CAA6C;IAC7C,IAAI,EAAE,OAAO,CAAA;CACd"}
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/types/app.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EACd,WAAW,EACX,SAAS,EACT,eAAe,EACf,OAAO,EACP,QAAQ,EACR,OAAO,EACP,SAAS,EACT,eAAe,EACf,WAAW,EACZ,MAAM,SAAS,CAAA;AAChB,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EAClB,MAAM,eAAe,CAAA;AAEtB,kFAAkF;AAClF,eAAO,MAAM,uBAAuB,mBAAmB,CAAA;AAEvD,gFAAgF;AAChF,eAAO,MAAM,uBAAuB,mBAAmB,CAAA;AAEvD,0DAA0D;AAC1D,eAAO,MAAM,oBAAoB,qBAAqB,CAAA;AAEtD,4DAA4D;AAC5D,eAAO,MAAM,iBAAiB,OAAO,CAAA;AAErC,qFAAqF;AACrF,eAAO,MAAM,iBAAiB,YAAqC,CAAA;AAEnE,wCAAwC;AACxC,MAAM,WAAW,YAAY;IAC3B,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,kEAAkE;IAClE,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,EAAE,aAAa,CAAA;CACpB;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,mBAAmB,CAAA;AAErE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE,CAAA;IAC/B,gDAAgD;IAChD,OAAO,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,CAAC,EAAE,CAAA;IACjC,iCAAiC;IACjC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,YAAY,GAAG,YAAY,GAAG,aAAa,CAAC,EAAE,CAAA;IAC/D,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;CAC5B;AAED,wMAAwM;AACxM,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,iBAAiB,GAAG,WAAW,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;AAE1G;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,MAAM,EAAE,eAAe,GAAG,SAAS,CAAA;IACnC,8BAA8B;IAC9B,IAAI,EAAE,aAAa,EAAE,CAAA;IACrB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;IAC3B,8GAA8G;IAC9G,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,YAAY,GAAG,YAAY,GAAG,aAAa,CAAC,EAAE,CAAA;CAChE;AAED;;;IAGI;AACJ,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,cAAc,CAAA;AAEzD,wEAAwE;AACxE,UAAU,uBAAwB,SAAQ,qBAAqB;IAC7D,2EAA2E;IAC3E,IAAI,EAAE,mBAAmB,CAAA;IACzB,+GAA+G;IAC/G,eAAe,EAAE,UAAU,GAAG,MAAM,CAAA;IACpC,kHAAkH;IAClH,iBAAiB,EAAE,UAAU,GAAG,MAAM,CAAA;IACtC,sCAAsC;IACtC,iBAAiB,CAAC,EAAE,eAAe,CAAA;IACnC,sCAAsC;IACtC,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAED,0DAA0D;AAC1D,MAAM,WAAW,eAAgB,SAAQ,uBAAuB;IAC9D,wDAAwD;IACxD,MAAM,EAAE,gBAAgB,CAAA;CACzB;AAED,0DAA0D;AAC1D,MAAM,WAAW,eAAgB,SAAQ,uBAAuB;IAC9D,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAA;CACd;AAED,gDAAgD;AAChD,MAAM,WAAW,aAAc,SAAQ,qBAAqB;IAC1D,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,wFAAwF;IACxF,QAAQ,EAAE,OAAO,GAAG,UAAU,GAAG,YAAY,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACnE,wCAAwC;IACxC,IAAI,EAAE,mBAAmB,CAAA;IACzB,sCAAsC;IACtC,iBAAiB,CAAC,EAAE,eAAe,CAAA;IACnC,sCAAsC;IACtC,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAED,4DAA4D;AAC5D,MAAM,WAAW,gBAAgB;IAC/B,uDAAuD;IACvD,SAAS,EAAE,MAAM,CAAA;IACjB,8DAA8D;IAC9D,eAAe,EAAE,MAAM,CAAA;IACvB,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAA;IAClB,sDAAsD;IACtD,gBAAgB,EAAE,MAAM,CAAA;IACxB,0JAA0J;IAC1J,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,gDAAgD;AAChD,MAAM,WAAW,YAAY;IAC3B,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAA;IACpB,8CAA8C;IAC9C,qBAAqB,EAAE,UAAU,CAAA;IACjC,sCAAsC;IACtC,SAAS,EAAE,SAAS,CAAA;CACrB;AAED,iCAAiC;AACjC,MAAM,WAAW,wBAAyB,SAAQ,sBAAsB,EAAE,qBAAqB;IAC7F,6DAA6D;IAC7D,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,6CAA6C;AAC7C,MAAM,MAAM,SAAS,GACjB;IACE,cAAc,EAAE,UAAU,CAAA;IAC1B,WAAW,EAAE,QAAQ,CAAA;IACrB,WAAW,EAAE,SAAS,CAAA;CACvB,GACD;IAAE,cAAc,EAAE,SAAS,CAAC;IAAC,WAAW,EAAE,SAAS,CAAC;IAAC,WAAW,EAAE,KAAK,CAAA;CAAE,CAAA;AAE7E;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAA;IACZ,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAA;IACf,oEAAoE;IACpE,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,oEAAoE;IACpE,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,8DAA8D;AAC9D,MAAM,WAAW,WAAY,SAAQ,YAAY,EAAE,iBAAiB;IAClE,oCAAoC;IACpC,YAAY,EAAE,MAAM,CAAA;IACpB,8CAA8C;IAC9C,YAAY,EAAE,MAAM,CAAA;IACpB,4CAA4C;IAC5C,eAAe,EAAE,iBAAiB,CAAA;IAClC,wCAAwC;IACxC,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,qDAAqD;AACrD,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACzB,IAAI,EAAE,QAAQ,CAAC;QACb,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAA;KAC5B,CAAC,CAAA;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAA;CACrD;AAED,8FAA8F;AAC9F,oBAAY,QAAQ;IAClB,0BAA0B;IAC1B,IAAI,IAAA;IACJ,qBAAqB;IACrB,SAAS,IAAA;IACT,uDAAuD;IACvD,UAAU,IAAA;CACX;AAED,4FAA4F;AAC5F,oBAAY,aAAa;IACvB,0BAA0B;IAC1B,IAAI,IAAA;IACJ,uDAAuD;IACvD,UAAU,IAAA;CACX;AAED,sCAAsC;AACtC,MAAM,WAAW,mBAAoB,SAAQ,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,aAAa,GAAG,KAAK,CAAC;IACzH,8BAA8B;IAC9B,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,6DAA6D;IAC7D,gBAAgB,CAAC,EAAE,kBAAkB,CAAA;IACrC,2DAA2D;IAC3D,aAAa,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,aAAa,CAAA;IAClD,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,CAAA;IACnD,uEAAuE;IACvE,mBAAmB,CAAC,EAAE,SAAS,CAAA;IAC/B,sFAAsF;IACtF,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,sFAAsF;IACtF,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,sFAAsF;IACtF,UAAU,CAAC,EAAE,WAAW,CAAA;CACzB;AAED,qEAAqE;AACrE,MAAM,WAAW,oBAAoB;IACnC,yCAAyC;IACzC,gBAAgB,EAAE,YAAY,CAAA;IAC9B,sCAAsC;IACtC,aAAa,EAAE,YAAY,CAAA;CAC5B;AAED,sCAAsC;AACtC,MAAM,WAAW,QAAQ;IACvB,CAAC,GAAG,EAAE,MAAM,GACR;QACE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;QACtB,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,MAAM,CAAA;KAClB,GACD;QACE,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,UAAU,CAAA;QACpB,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;CACN;AAED,oCAAoC;AACpC,MAAM,WAAW,OAAO;IACtB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,2BAA2B;IAC3B,OAAO,EAAE,UAAU,CAAA;IACnB,qBAAqB;IACrB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAA;IACb,kFAAkF;IAClF,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAA;IACtC,6CAA6C;IAC7C,IAAI,EAAE,OAAO,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAA;IACb,oFAAoF;IACpF,QAAQ,EAAE,CAAC,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,EAAE,CAAA;IAC3C,6CAA6C;IAC7C,IAAI,EAAE,OAAO,CAAA;CACd"}

package/types/app.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/types/app.ts"],"names":[],"mappings":";;;AAGA,kFAAkF;AACrE,QAAA,uBAAuB,GAAG,gBAAgB,CAAA;AAEvD,gFAAgF;AACnE,QAAA,uBAAuB,GAAG,gBAAgB,CAAA;AAEvD,0DAA0D;AAC7C,QAAA,oBAAoB,GAAG,kBAAkB,CAAA;AAEtD,4DAA4D;AAC/C,QAAA,iBAAiB,GAAG,IAAI,CAAA;AAErC,qFAAqF;AACxE,QAAA,iBAAiB,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;AAoMnE,8FAA8F;AAC9F,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,0BAA0B;IAC1B,uCAAI,CAAA;IACJ,qBAAqB;IACrB,iDAAS,CAAA;IACT,uDAAuD;IACvD,mDAAU,CAAA;AACZ,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AAED,4FAA4F;AAC5F,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,0BAA0B;IAC1B,iDAAI,CAAA;IACJ,uDAAuD;IACvD,6DAAU,CAAA;AACZ,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB"}
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/types/app.ts"],"names":[],"mappings":";;;AAoBA,kFAAkF;AACrE,QAAA,uBAAuB,GAAG,gBAAgB,CAAA;AAEvD,gFAAgF;AACnE,QAAA,uBAAuB,GAAG,gBAAgB,CAAA;AAEvD,0DAA0D;AAC7C,QAAA,oBAAoB,GAAG,kBAAkB,CAAA;AAEtD,4DAA4D;AAC/C,QAAA,iBAAiB,GAAG,IAAI,CAAA;AAErC,qFAAqF;AACxE,QAAA,iBAAiB,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;AA2MnE,8FAA8F;AAC9F,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,0BAA0B;IAC1B,uCAAI,CAAA;IACJ,qBAAqB;IACrB,iDAAS,CAAA;IACT,uDAAuD;IACvD,mDAAU,CAAA;AACZ,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AAED,4FAA4F;AAC5F,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,0BAA0B;IAC1B,iDAAI,CAAA;IACJ,uDAAuD;IACvD,6DAAU,CAAA;AACZ,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB"}

package/types/config.d.ts

@@ -1,15 +1,32 @@
 import { Logger } from './logging';
 /** The AlgoKit configuration type */
 export interface Config {
+    /** Logger */
     logger: Logger;
+    /** Whether or not debug mode is enabled */
+    debug: boolean;
 }
 /** Updatable AlgoKit config */
 export declare class UpdatableConfig implements Readonly<Config> {
     private config;
     get logger(): Logger;
+    get debug(): boolean;
+    /**
+     * Returns the current logger, or the null logger if true is passed in to `returnNullLogger`
+     * @param returnNullLogger Whether or not to return the null logger
+     * @returns The requested logger
+     */
     getLogger(returnNullLogger?: boolean): Logger;
+    /**
+     * Temporarily run with debug set to true.
+     * @param lambda A lambda expression with code to run with debug config set to true
+     */
+    withDebug(lambda: () => unknown): void;
     constructor();
-    /** Update the AlgoKit configuration with your own configuration settings */
-    configure(newConfig: Config): void;
+    /**
+     * Update the AlgoKit configuration with your own configuration settings
+     * @param newConfig Partial or complete config to replace
+     */
+    configure(newConfig: Partial<Config>): void;
 }
 //# sourceMappingURL=config.d.ts.map

package/types/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/types/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,MAAM,EAAc,MAAM,WAAW,CAAA;AAE7D,qCAAqC;AACrC,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,+BAA+B;AAC/B,qBAAa,eAAgB,YAAW,QAAQ,CAAC,MAAM,CAAC;IACtD,OAAO,CAAC,MAAM,CAAQ;IAEtB,IAAI,MAAM,WAET;IAED,SAAS,CAAC,gBAAgB,CAAC,EAAE,OAAO;;IAcpC,4EAA4E;IAC5E,SAAS,CAAC,SAAS,EAAE,MAAM;CAG5B"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/types/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,MAAM,EAAc,MAAM,WAAW,CAAA;AAE7D,qCAAqC;AACrC,MAAM,WAAW,MAAM;IACrB,aAAa;IACb,MAAM,EAAE,MAAM,CAAA;IACd,2CAA2C;IAC3C,KAAK,EAAE,OAAO,CAAA;CACf;AAED,+BAA+B;AAC/B,qBAAa,eAAgB,YAAW,QAAQ,CAAC,MAAM,CAAC;IACtD,OAAO,CAAC,MAAM,CAAQ;IAEtB,IAAI,MAAM,WAET;IAED,IAAI,KAAK,YAER;IAED;;;;OAIG;IACH,SAAS,CAAC,gBAAgB,CAAC,EAAE,OAAO;IAQpC;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,OAAO;;IAiB/B;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC;CAGrC"}

package/types/config.js

@@ -7,20 +7,46 @@ class UpdatableConfig {
     get logger() {
         return this.config.logger;
     }
+    get debug() {
+        return this.config.debug;
+    }
+    /**
+     * Returns the current logger, or the null logger if true is passed in to `returnNullLogger`
+     * @param returnNullLogger Whether or not to return the null logger
+     * @returns The requested logger
+     */
     getLogger(returnNullLogger) {
         if (returnNullLogger) {
             return logging_1.nullLogger;
         }
         return this.logger;
     }
+    /**
+     * Temporarily run with debug set to true.
+     * @param lambda A lambda expression with code to run with debug config set to true
+     */
+    withDebug(lambda) {
+        const original = this.config.debug;
+        try {
+            this.config.debug = true;
+            lambda();
+        }
+        finally {
+            this.config.debug = original;
+        }
+    }
     constructor() {
         this.config = {
             logger: logging_1.consoleLogger,
+            debug: false,
         };
     }
-    /** Update the AlgoKit configuration with your own configuration settings */
+    /**
+     * Update the AlgoKit configuration with your own configuration settings
+     * @param newConfig Partial or complete config to replace
+     */
     configure(newConfig) {
-        this.config = newConfig;
+        this.config = { ...this.config, ...newConfig };
     }
 }
 exports.UpdatableConfig = UpdatableConfig;

package/types/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/types/config.ts"],"names":[],"mappings":";;;AAAA,uCAA6D;AAO7D,+BAA+B;AAC/B,MAAa,eAAe;IAG1B,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAA;IAC3B,CAAC;IAED,SAAS,CAAC,gBAA0B;QAClC,IAAI,gBAAgB,EAAE;YACpB,OAAO,oBAAU,CAAA;SAClB;QAED,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED;QACE,IAAI,CAAC,MAAM,GAAG;YACZ,MAAM,EAAE,uBAAa;SACtB,CAAA;IACH,CAAC;IAED,4EAA4E;IAC5E,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;IACzB,CAAC;CACF;AAzBD,0CAyBC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/types/config.ts"],"names":[],"mappings":";;;AAAA,uCAA6D;AAU7D,+BAA+B;AAC/B,MAAa,eAAe;IAG1B,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAA;IAC3B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAA;IAC1B,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,gBAA0B;QAClC,IAAI,gBAAgB,EAAE;YACpB,OAAO,oBAAU,CAAA;SAClB;QAED,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,MAAqB;QAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAA;QAClC,IAAI;YACF,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAA;YACxB,MAAM,EAAE,CAAA;SACT;gBAAS;YACR,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,QAAQ,CAAA;SAC7B;IACH,CAAC;IAED;QACE,IAAI,CAAC,MAAM,GAAG;YACZ,MAAM,EAAE,uBAAa;YACrB,KAAK,EAAE,KAAK;SACb,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAA0B;QAClC,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,EAAE,CAAA;IAChD,CAAC;CACF;AApDD,0CAoDC"}