@algorandfoundation/algokit-utils 2.3.3-beta.3 → 2.3.3-beta.5

package/types/types/app-spec.d.ts

@@ -0,0 +1,154 @@
+import { ABIContractParams, ABIMethodParams } from 'algosdk';
+/** An ARC-0032 Application Specification see https://github.com/algorandfoundation/ARCs/pull/150 */
+export interface AppSpec {
+    /** Method call hints */
+    hints: HintSpec;
+    /** The TEAL source */
+    source: AppSources;
+    /** The ABI-0004 contract definition see https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0004.md */
+    contract: ABIContractParams;
+    /** The values that make up the local and global state */
+    schema: SchemaSpec;
+    /** The rolled-up schema allocation values for local and global state */
+    state: StateSchemaSpec;
+    /** The config of all BARE calls (i.e. non ABI calls with no args) */
+    bare_call_config: CallConfig;
+}
+/** A lookup of encoded method call spec to hint */
+export type HintSpec = Record<string, Hint>;
+/** The TEAL source of a contract */
+export interface AppSources {
+    /** The TEAL source of the approval program */
+    approval: string;
+    /** The TEAL source of the clear program */
+    clear: string;
+}
+/** The various call configs:
+ *  * `NEVER`: Will not be called
+ *  * `CALL`: Can be called during a non-create call i.e. app id != 0
+ *  * `CREATE`: Can be called during a create call i.e. app id = 0
+ *  * `ALL`: Can be during a create OR non-create call
+ **/
+export type CallConfigValue = 'NEVER' | 'CALL' | 'CREATE' | 'ALL';
+/** Call configuration for a method */
+export interface CallConfig {
+    /** NoOp call config */
+    no_op?: CallConfigValue;
+    /** Opt-in call config */
+    opt_in?: CallConfigValue;
+    /** Close out call config */
+    close_out?: CallConfigValue;
+    /** Update call config */
+    update_application?: CallConfigValue;
+    /** Delete call config */
+    delete_application?: CallConfigValue;
+}
+/** Hint information for a given method call to allow client generation */
+export interface Hint {
+    /** Any user-defined struct/tuple types used in the method call, keyed by parameter name or `output` for return type */
+    structs?: Record<string, Struct>;
+    read_only?: boolean;
+    default_arguments?: Record<string, DefaultArgument>;
+    call_config: CallConfig;
+}
+/** The name of a field */
+export type FieldName = string;
+/** The string name of an ABI type */
+export type ABIType = string;
+/** The elements of the struct/tuple: `FieldName`, `ABIType` */
+export type StructElement = [FieldName, ABIType];
+/** A user-defined struct/tuple type */
+export interface Struct {
+    /** The name of the type */
+    name: string;
+    /** The elements (in order) that make up the struct/tuple */
+    elements: StructElement[];
+}
+/**
+ * Defines a strategy for obtaining a default value for a given ABI arg.
+ */
+export type DefaultArgument = {
+    /**
+     * The default value should be fetched by invoking an ABI method
+     */
+    source: 'abi-method';
+    data: ABIMethodParams;
+} | {
+    /**
+     * The default value should be fetched from global state
+     */
+    source: 'global-state';
+    /**
+     * The key of the state variable
+     */
+    data: string;
+} | {
+    /**
+     * The default value should be fetched from the local state of the sender user
+     */
+    source: 'local-state';
+    /**
+     * The key of the state variable
+     */
+    data: string;
+} | {
+    /**
+     * The default value is a constant.
+     */
+    source: 'constant';
+    /**
+     * The static default value to use.
+     */
+    data: string | number;
+};
+/** AVM data type */
+export type AVMType = 'uint64' | 'bytes';
+/** Declared schema value specification */
+export interface DeclaredSchemaValueSpec {
+    /** The type of value */
+    type: AVMType;
+    /** The name of the key */
+    key: string;
+    /** A description of the variable */
+    descr?: string;
+    /** Whether or not the value is set statically (at create time only) or dynamically */
+    static?: boolean;
+}
+/** Reserved schema value specification */
+export interface ReservedSchemaValueSpec {
+    /** The type of value */
+    type: AVMType;
+    /** The description of the reserved storage space */
+    descr: string;
+    /** The maximum number of slots to reserve */
+    max_keys: number;
+}
+/** The schema for global and local storage */
+export interface SchemaSpec {
+    /** The local storage schema */
+    local: Schema;
+    /** The global storage schema */
+    global: Schema;
+}
+/** The storage schema definition */
+export interface Schema {
+    /** Declared storage schema */
+    declared: Record<string, DeclaredSchemaValueSpec>;
+    /** Reserved storage schema */
+    reserved: Record<string, ReservedSchemaValueSpec>;
+}
+/** The rolled-up schema allocation specification for local and global state */
+export interface StateSchemaSpec {
+    /** Global storage spec */
+    global: StateSchema;
+    /** Local storage spec */
+    local: StateSchema;
+}
+/** Schema spec summary for global or local storage */
+export type StateSchema = {
+    /** Number of uint slots */
+    num_uints: number;
+    /** Number of byte slots */
+    num_byte_slices: number;
+};
+//# sourceMappingURL=app-spec.d.ts.map

package/types/types/app-spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-spec.d.ts","sourceRoot":"","sources":["../../../src/types/app-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE5D,oGAAoG;AACpG,MAAM,WAAW,OAAO;IACtB,wBAAwB;IACxB,KAAK,EAAE,QAAQ,CAAA;IACf,sBAAsB;IACtB,MAAM,EAAE,UAAU,CAAA;IAClB,iHAAiH;IACjH,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,yDAAyD;IACzD,MAAM,EAAE,UAAU,CAAA;IAClB,wEAAwE;IACxE,KAAK,EAAE,eAAe,CAAA;IACtB,qEAAqE;IACrE,gBAAgB,EAAE,UAAU,CAAA;CAC7B;AAED,mDAAmD;AACnD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;AAE3C,oCAAoC;AACpC,MAAM,WAAW,UAAU;IACzB,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAA;IAChB,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;;IAKI;AACJ,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAA;AAEjE,sCAAsC;AACtC,MAAM,WAAW,UAAU;IACzB,uBAAuB;IACvB,KAAK,CAAC,EAAE,eAAe,CAAA;IACvB,yBAAyB;IACzB,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB,4BAA4B;IAC5B,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,yBAAyB;IACzB,kBAAkB,CAAC,EAAE,eAAe,CAAA;IACpC,yBAAyB;IACzB,kBAAkB,CAAC,EAAE,eAAe,CAAA;CACrC;AAED,0EAA0E;AAC1E,MAAM,WAAW,IAAI;IACnB,uHAAuH;IACvH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACnD,WAAW,EAAE,UAAU,CAAA;CACxB;AAED,0BAA0B;AAC1B,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAE9B,qCAAqC;AACrC,MAAM,MAAM,OAAO,GAAG,MAAM,CAAA;AAE5B,+DAA+D;AAC/D,MAAM,MAAM,aAAa,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;AAEhD,uCAAuC;AACvC,MAAM,WAAW,MAAM;IACrB,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,4DAA4D;IAC5D,QAAQ,EAAE,aAAa,EAAE,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB;IACE;;OAEG;IACH,MAAM,EAAE,YAAY,CAAA;IACpB,IAAI,EAAE,eAAe,CAAA;CACtB,GACD;IACE;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE;;OAEG;IACH,MAAM,EAAE,aAAa,CAAA;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAEL,oBAAoB;AACpB,MAAM,MAAM,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;AAExC,0CAA0C;AAC1C,MAAM,WAAW,uBAAuB;IACtC,wBAAwB;IACxB,IAAI,EAAE,OAAO,CAAA;IACb,0BAA0B;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sFAAsF;IACtF,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,0CAA0C;AAC1C,MAAM,WAAW,uBAAuB;IACtC,wBAAwB;IACxB,IAAI,EAAE,OAAO,CAAA;IACb,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAA;IACb,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,8CAA8C;AAC9C,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAA;CACf;AAED,oCAAoC;AACpC,MAAM,WAAW,MAAM;IACrB,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;IACjD,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;CAClD;AAED,+EAA+E;AAC/E,MAAM,WAAW,eAAe;IAC9B,0BAA0B;IAC1B,MAAM,EAAE,WAAW,CAAA;IACnB,yBAAyB;IACzB,KAAK,EAAE,WAAW,CAAA;CACnB;AAED,sDAAsD;AACtD,MAAM,MAAM,WAAW,GAAG;IACxB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,2BAA2B;IAC3B,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA"}

package/types/types/app.d.ts

@@ -0,0 +1,308 @@
+import algosdk, { ABIArgument, ABIMethod, ABIMethodParams, ABIType, ABIValue, Address, OnApplicationComplete, 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 */
+export declare const DELETABLE_TEMPLATE_NAME = "TMPL_DELETABLE";
+/** The app create/update ARC-2 transaction note prefix */
+export declare const APP_DEPLOY_NOTE_DAPP = "ALGOKIT_DEPLOYER";
+/** The maximum number of bytes in a single app code page */
+export declare const APP_PAGE_MAX_SIZE = 2048;
+/** First 4 bytes of SHA-512/256 hash of "return" for retrieving ABI return values */
+export declare const ABI_RETURN_PREFIX: Uint8Array;
+/** Information about an Algorand app */
+export interface AppReference {
+    /** The id of the app */
+    appId: number | bigint;
+    /** The Algorand address of the account associated with the app */
+    appAddress: string;
+}
+/**
+ * A grouping of the app ID and name of the box in an Uint8Array
+ */
+export interface BoxReference {
+    /**
+     * A unique application id
+     */
+    appId: number | bigint;
+    /**
+     * Name of box to reference
+     */
+    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;
+/** Common app call arguments for ABI and non-ABI (raw) calls */
+export interface CoreAppCallArgs {
+    /** The optional lease for the transaction */
+    lease?: string | Uint8Array;
+    /** Any box references to load */
+    boxes?: (algosdk.BoxReference | BoxReference | BoxIdentifier)[];
+    /** The address of any accounts to load in */
+    accounts?: (string | Address)[];
+    /** IDs of any apps to load into the foreignApps array */
+    apps?: number[];
+    /** IDs of any assets to load into the foreignAssets array */
+    assets?: number[];
+}
+/**
+ * App call args with non-ABI (raw) values (minus some processing like encoding strings as binary)
+ */
+export interface RawAppCallArgs extends CoreAppCallArgs {
+    /** Any application arguments to pass through */
+    appArgs?: (Uint8Array | string)[];
+    /** Property to aid intellisense */
+    method?: undefined;
+}
+/** 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> | SendTransactionResult | undefined;
+/**
+ * App call args for an ABI call
+ */
+export type ABIAppCallArgs = CoreAppCallArgs & {
+    /** The ABI method to call */
+    method: ABIMethodParams | ABIMethod;
+    /** The ABI method args to pass in */
+    methodArgs: ABIAppCallArg[];
+};
+/** Arguments to pass to an app call either:
+ *   * The raw app call values to pass through into the transaction (after processing); or
+ *   * An ABI method definition (method and args)
+ **/
+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 transaction */
+    from: SendTransactionFrom;
+    /** The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */
+    approvalProgram: Uint8Array | string;
+    /** The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */
+    clearStateProgram: Uint8Array | string;
+    /** Optional transaction parameters */
+    transactionParams?: SuggestedParams;
+    /** The (optional) transaction note */
+    note?: TransactionNote;
+    /** The arguments passed in to the app call */
+    args?: AppCallArgs;
+}
+/** Parameters that are passed in when creating an app. */
+export interface CreateAppParams extends CreateOrUpdateAppParams {
+    /** The storage schema to request for the created app */
+    schema: AppStorageSchema;
+    /** Override the on-completion action for the create call; defaults to NoOp */
+    onCompleteAction?: Exclude<AppCallType, 'clear_state'> | Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC>;
+}
+/** Parameters that are passed in when updating an app. */
+export interface UpdateAppParams extends CreateOrUpdateAppParams {
+    /** The id of the app to update */
+    appId: number | bigint;
+}
+/** The type of call / [on-completion action](https://developer.algorand.org/docs/get-details/dapps/smart-contracts/apps/#the-lifecycle-of-a-smart-contract) for a smart contract call.
+ *
+ * Equivalent of `algosdk.OnApplicationComplete`, but as a more convenient string enum.
+ *
+ * * `no_op`: Normal smart contract call, no special on-complete action
+ * * `opt_in`: Opt-in to smart contract local storage
+ * * `close_out`: Close-out local storage storage
+ * * `clear_state`: Clear local storage state
+ * * `update_application`: Update the smart contract
+ * * `delete_application`: Delete the smart contract
+ */
+export type AppCallType = 'no_op' | 'opt_in' | 'close_out' | 'clear_state' | 'update_application' | 'delete_application';
+/** Parameters representing a call to an app. */
+export interface AppCallParams extends SendTransactionParams {
+    /** The id of the app to call */
+    appId: number | bigint;
+    /** The type of call, everything except create (see `createApp`) and update (see `updateApp`) */
+    callType: Exclude<AppCallType, 'update_application'> | Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplicationOC>;
+    /** The account to make the call from */
+    from: SendTransactionFrom;
+    /** Optional transaction parameters */
+    transactionParams?: SuggestedParams;
+    /** The (optional) transaction note */
+    note?: TransactionNote;
+    /** The arguments passed in to the app call */
+    args?: AppCallArgs;
+}
+/** Parameters representing the storage schema of an app. */
+export interface AppStorageSchema {
+    /** Restricts number of ints in per-user local state */
+    localInts: number;
+    /** Restricts number of byte slices in per-user local state */
+    localByteSlices: number;
+    /** Restricts number of ints in global state */
+    globalInts: number;
+    /** Restricts number of byte slices in global state */
+    globalByteSlices: number;
+    /** Any extra pages that are needed for the smart contract; if left blank then the right number of pages will be calculated based on the teal code size */
+    extraPages?: number;
+}
+/** Information about a compiled teal program */
+export interface CompiledTeal {
+    /** Original TEAL code */
+    teal: string;
+    /** The compiled code */
+    compiled: string;
+    /** The has returned by the compiler */
+    compiledHash: string;
+    /** The base64 encoded code as a byte array */
+    compiledBase64ToBytes: Uint8Array;
+    /** Source map from the compilation */
+    sourceMap: SourceMap;
+}
+export interface AppCallTransactionResultOfType<T> extends SendTransactionResults, SendTransactionResult {
+    /** If an ABI method was called the processed return value */
+    return?: T;
+}
+/** Result from calling an app */
+export interface AppCallTransactionResult extends AppCallTransactionResultOfType<ABIReturn> {
+}
+/** The return value of an ABI method call */
+export type ABIReturn = {
+    rawReturnValue: Uint8Array;
+    returnValue: ABIValue;
+    decodeError: undefined;
+} | {
+    rawReturnValue: undefined;
+    returnValue: undefined;
+    decodeError: Error;
+};
+/**
+ * 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 */
+    name: string;
+    /** The version of app that is / will be deployed */
+    version: string;
+    /** Whether or not the app is deletable / permanent / unspecified */
+    deletable?: boolean;
+    /** Whether or not the app is updatable / immutable / unspecified */
+    updatable?: boolean;
+}
+/** The metadata that can be collected about a deployed app */
+export interface AppMetadata extends AppReference, AppDeployMetadata {
+    /** The round the app was created */
+    createdRound: number;
+    /** The last round that the app was updated */
+    updatedRound: number;
+    /** The metadata when the app was created */
+    createdMetadata: AppDeployMetadata;
+    /** Whether or not the app is deleted */
+    deleted: boolean;
+}
+/** A lookup of name -> Algorand app for a creator */
+export interface AppLookup {
+    creator: Readonly<string>;
+    apps: Readonly<{
+        [name: string]: AppMetadata;
+    }>;
+}
+/** Dictionary of deploy-time parameters to replace in a teal template.
+ *
+ * Note: Looks for `TMPL_{parameter}` for template replacements i.e. you can leave out the `TMPL_`.
+ *
+ */
+export interface TealTemplateParams {
+    [key: string]: string | bigint | number | Uint8Array;
+}
+/** What action to perform when deploying an app and an update is detected in the TEAL code */
+export declare enum OnUpdate {
+    /** Fail the deployment */
+    Fail = 0,
+    /** Update the app */
+    UpdateApp = 1,
+    /** Delete the app and create a new one in its place */
+    ReplaceApp = 2,
+    /** Create a new app */
+    AppendApp = 3
+}
+/** What action to perform when deploying an app and a breaking schema change is detected */
+export declare enum OnSchemaBreak {
+    /** Fail the deployment */
+    Fail = 0,
+    /** Delete the app and create a new one in its place */
+    ReplaceApp = 1,
+    /** Create a new app */
+    AppendApp = 2
+}
+/** The parameters to deploy an app */
+export interface AppDeploymentParams extends Omit<CreateAppParams, 'onCompleteAction' | 'args' | 'note' | 'skipSending' | 'skipWaiting' | 'atc'> {
+    /** The deployment metadata */
+    metadata: AppDeployMetadata;
+    /** Any deploy-time parameters to replace in the TEAL code */
+    deployTimeParams?: TealTemplateParams;
+    /** What action to perform if a schema break is detected */
+    onSchemaBreak?: 'replace' | 'fail' | 'append' | OnSchemaBreak;
+    /** What action to perform if a TEAL update is detected */
+    onUpdate?: 'update' | 'replace' | 'fail' | 'append' | OnUpdate;
+    /** Optional cached value of the existing apps for the given creator */
+    existingDeployments?: AppLookup;
+    /** Any args to pass to any create transaction that is issued as part of deployment */
+    createArgs?: AppCallArgs;
+    /** Override the on-completion action for the create call; defaults to NoOp */
+    createOnCompleteAction?: Exclude<AppCallType, 'clear_state'> | Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC>;
+    /** Any args to pass to any update transaction that is issued as part of deployment */
+    updateArgs?: AppCallArgs;
+    /** Any args to pass to any delete transaction that is issued as part of deployment */
+    deleteArgs?: AppCallArgs;
+}
+/** The result of compiling the approval and clear TEAL for an app */
+export interface AppCompilationResult {
+    /** The compilation result of approval */
+    compiledApproval: CompiledTeal;
+    /** The compilation result of clear */
+    compiledClear: CompiledTeal;
+}
+/** Object holding app state values */
+export interface AppState {
+    [key: string]: {
+        value: number | bigint;
+        keyRaw: Uint8Array;
+        keyBase64: string;
+    } | {
+        value: string;
+        valueRaw: Uint8Array;
+        valueBase64: string;
+        keyRaw: Uint8Array;
+        keyBase64: string;
+    };
+}
+/** The name of a box storage box */
+export interface BoxName {
+    /** Name in UTF-8 */
+    name: string;
+    /** Name in binary bytes */
+    nameRaw: Uint8Array;
+    /** Name in Base64 */
+    nameBase64: string;
+}
+/**
+ * Parameters to get and decode a box value as an ABI type.
+ */
+export interface BoxValueRequestParams {
+    /** The ID of the app return box names for */
+    appId: number | bigint;
+    /** 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;
+}
+/**
+ * Parameters to get and decode a box value as an ABI type.
+ */
+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 BoxName` */
+    boxNames: (string | Uint8Array | BoxName)[];
+    /** The ABI type to decode the value using */
+    type: ABIType;
+}
+export {};
+//# sourceMappingURL=app.d.ts.map

package/types/types/app.d.ts.map

@@ -0,0 +1 @@
+{"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,qBAAqB,EACrB,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,GAAG,MAAM,CAAA;IACtB,kEAAkE;IAClE,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB;;OAEG;IACH,IAAI,EAAE,aAAa,CAAA;CACpB;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,mBAAmB,CAAA;AAErE,gEAAgE;AAChE,MAAM,WAAW,eAAe;IAC9B,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;IAC3B,iCAAiC;IACjC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,YAAY,GAAG,YAAY,GAAG,aAAa,CAAC,EAAE,CAAA;IAC/D,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE,CAAA;IAC/B,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,gDAAgD;IAChD,OAAO,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,CAAC,EAAE,CAAA;IACjC,mCAAmC;IACnC,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,wMAAwM;AACxM,MAAM,MAAM,aAAa,GACrB,WAAW,GACX,iBAAiB,GACjB,WAAW,GACX,OAAO,CAAC,qBAAqB,CAAC,GAC9B,qBAAqB,GACrB,SAAS,CAAA;AAEb;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG;IAC7C,6BAA6B;IAC7B,MAAM,EAAE,eAAe,GAAG,SAAS,CAAA;IACnC,qCAAqC;IACrC,UAAU,EAAE,aAAa,EAAE,CAAA;CAC5B,CAAA;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;IACxB,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,OAAO,CAAC,WAAW,EAAE,aAAa,CAAC,GAAG,OAAO,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAA;CAC5H;AAED,0DAA0D;AAC1D,MAAM,WAAW,eAAgB,SAAQ,uBAAuB;IAC9D,kCAAkC;IAClC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,QAAQ,GAAG,WAAW,GAAG,aAAa,GAAG,oBAAoB,GAAG,oBAAoB,CAAA;AAExH,gDAAgD;AAChD,MAAM,WAAW,aAAc,SAAQ,qBAAqB;IAC1D,gCAAgC;IAChC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,gGAAgG;IAChG,QAAQ,EAAE,OAAO,CAAC,WAAW,EAAE,oBAAoB,CAAC,GAAG,OAAO,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,mBAAmB,CAAC,CAAA;IAChI,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,MAAM,WAAW,8BAA8B,CAAC,CAAC,CAAE,SAAQ,sBAAsB,EAAE,qBAAqB;IACtG,6DAA6D;IAC7D,MAAM,CAAC,EAAE,CAAC,CAAA;CACX;AAED,iCAAiC;AAEjC,MAAM,WAAW,wBAAyB,SAAQ,8BAA8B,CAAC,SAAS,CAAC;CAAG;AAE9F,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;IACV,uBAAuB;IACvB,SAAS,IAAA;CACV;AAED,4FAA4F;AAC5F,oBAAY,aAAa;IACvB,0BAA0B;IAC1B,IAAI,IAAA;IACJ,uDAAuD;IACvD,UAAU,IAAA;IACV,uBAAuB;IACvB,SAAS,IAAA;CACV;AAED,sCAAsC;AACtC,MAAM,WAAW,mBACf,SAAQ,IAAI,CAAC,eAAe,EAAE,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,aAAa,GAAG,KAAK,CAAC;IAC3G,8BAA8B;IAC9B,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,6DAA6D;IAC7D,gBAAgB,CAAC,EAAE,kBAAkB,CAAA;IACrC,2DAA2D;IAC3D,aAAa,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,aAAa,CAAA;IAC7D,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAC9D,uEAAuE;IACvE,mBAAmB,CAAC,EAAE,SAAS,CAAA;IAC/B,sFAAsF;IACtF,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,8EAA8E;IAC9E,sBAAsB,CAAC,EAAE,OAAO,CAAC,WAAW,EAAE,aAAa,CAAC,GAAG,OAAO,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAA;IACjI,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,GAAG,MAAM,CAAA;IACtB,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/types/config.d.ts

@@ -0,0 +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
+     * @param newConfig Partial or complete config to replace
+     */
+    configure(newConfig: Partial<Config>): void;
+}
+//# sourceMappingURL=config.d.ts.map

package/types/types/config.d.ts.map

@@ -0,0 +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,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"}