@algorandfoundation/algokit-client-generator 4.0.0-beta.7 → 4.0.0-beta.9

package/client/call-composer-types.js

@@ -25,7 +25,7 @@ function* callComposerType(ctx) {
     yield* writer.jsDoc({
         description: 'Returns the underlying AtomicTransactionComposer instance',
     });
-    yield `composer(): AlgoKitComposer`;
+    yield `composer(): TransactionComposer`;
     yield* writer.jsDoc({
         description: 'Simulates the transaction group and returns the result',
     });

package/client/call-composer-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"call-composer-types.js","sources":["../../src/client/call-composer-types.ts"],"sourcesContent":["import { DecIndentAndCloseBlock, DocumentParts, IncIndent, jsDoc, NewLine } from '../output/writer'\nimport { GeneratorContext } from './generator-context'\n\nimport { BARE_CALL, MethodList } from './helpers/get-call-config-summary'\nimport { getCreateOnCompleteOptions } from './deploy-types'\nimport { ABIMethod } from 'algosdk'\n\nexport function* callComposerType(ctx: GeneratorContext): DocumentParts {\n  const { name, callConfig, app } = ctx\n  yield `export type ${name}Composer<TReturns extends [...any[]] = []> = {`\n  yield IncIndent\n\n  yield* callComposerTypeNoops(ctx)\n  yield* callComposerOperationMethodType(\n    ctx,\n    `Deletes an existing instance of the ${app.name} smart contract`,\n    callConfig.deleteMethods,\n    'delete',\n  )\n  yield* callComposerOperationMethodType(\n    ctx,\n    `Opts the user into an existing instance of the ${app.name} smart contract`,\n    callConfig.optInMethods,\n    'optIn',\n  )\n  yield* callComposerOperationMethodType(\n    ctx,\n    `Makes a close out call to an existing instance of the ${app.name} smart contract`,\n    callConfig.closeOutMethods,\n    'closeOut',\n  )\n\n  yield* callComposerTypeClearState(ctx)\n\n  yield* jsDoc({\n    description: 'Adds a transaction to the composer',\n    params: {\n      txn: 'A transaction to add to the transaction group',\n      signer: 'The optional signer to use when signing this transaction.',\n    },\n  })\n  yield `addTransaction(txn: Transaction, signer?: TransactionSigner): ${name}Composer<TReturns>`\n\n  yield* jsDoc({\n    description: 'Returns the underlying AtomicTransactionComposer instance',\n  })\n  yield `composer(): AlgoKitComposer`\n\n  yield* jsDoc({\n    description: 'Simulates the transaction group and returns the result',\n  })\n  yield `simulate(options?: SimulateOptions): Promise<${name}ComposerResults<TReturns> & { simulateResponse: SimulateResponse }>`\n\n  yield* jsDoc({\n    description: 'Sends the transaction group to the network and returns the results',\n  })\n  yield `send(params?: SendParams): Promise<${name}ComposerResults<TReturns>>`\n\n  yield DecIndentAndCloseBlock\n\n  yield `\n  export type ${name}ComposerResults<TReturns extends [...any[]]> = Expand<SendAtomicTransactionComposerResults & {\n    returns: TReturns\n  }>\n  `\n}\n\nfunction* callComposerTypeClearState({ app, name }: GeneratorContext): DocumentParts {\n  yield* jsDoc({\n    description: `Makes a clear_state call to an existing instance of the ${app.name} smart contract.`,\n    params: {\n      args: `The arguments for the bare call`,\n    },\n    returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n  })\n  yield `clearState(params?: AppClientBareCallParams): ${name}Composer<[...TReturns, undefined]>`\n  yield NewLine\n}\n\nfunction* callComposerTypeNoops({ app, name, callConfig, methodSignatureToUniqueName, sanitizer }: GeneratorContext): DocumentParts {\n  for (const method of app.methods) {\n    const methodSig = new ABIMethod(method).getSignature()\n    const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(methodSig)\n    const methodName = sanitizer.makeSafeMethodIdentifier(methodSignatureToUniqueName[methodSig])\n    // Skip methods which don't support a no_op call config\n    if (!callConfig.callMethods.includes(methodSig)) continue\n\n    yield* jsDoc({\n      description: `Calls the ${new ABIMethod(method).getSignature()} ABI method.`,\n      abiDescription: method.desc,\n      params: {\n        args: `The arguments for the contract call`,\n        params: `Any additional parameters for the call`,\n      },\n      returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n    })\n    yield `${methodName}(params?: CallParams<${name}Args['obj']['${methodSigSafe}'] | ${name}Args['tuple']['${methodSigSafe}']>): ${name}Composer<[...TReturns, ${name}Returns['${methodSigSafe}'] | undefined]>`\n    yield NewLine\n  }\n}\n\nfunction* callComposerOperationMethodType(\n  { app, methodSignatureToUniqueName, name, sanitizer }: GeneratorContext,\n  description: string,\n  methods: MethodList,\n  verb: 'create' | 'update' | 'optIn' | 'closeOut' | 'delete',\n  includeCompilation?: boolean,\n): DocumentParts {\n  if (methods.length) {\n    yield* jsDoc(`Gets available ${verb} methods`)\n    yield `readonly ${verb}: {`\n    yield IncIndent\n    for (const methodSig of methods) {\n      const onComplete = verb === 'create' ? getCreateOnCompleteOptions(methodSig, app) : undefined\n      if (methodSig === BARE_CALL) {\n        yield* jsDoc({\n          description: `${description} using a bare call.`,\n          params: {\n            args: `The arguments for the bare call`,\n          },\n          returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n        })\n        yield `bare(params${onComplete?.isOptional !== false ? '?' : ''}: AppClientBareCallParams ${\n          includeCompilation ? '& AppClientCompilationParams' : ''\n        }): ${name}Composer<[...TReturns, undefined]>`\n      } else {\n        const uniqueName = methodSignatureToUniqueName[methodSig]\n        yield* jsDoc({\n          description: `${description} using the ${methodSig} ABI method.`,\n          params: {\n            args: `The arguments for the smart contract call`,\n            params: `Any additional parameters for the call`,\n          },\n          returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n        })\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(methodSig)\n        yield `${sanitizer.makeSafeMethodIdentifier(uniqueName)}(params${\n          onComplete?.isOptional !== false ? '?' : ''\n        }: CallParams<${name}Args['obj']['${methodSigSafe}'] | ${name}Args['tuple']['${methodSigSafe}']>${includeCompilation ? ' & AppClientCompilationParams' : ''}${\n          onComplete?.type ? ` & ${onComplete.type}` : ''\n        }): ${name}Composer<[...TReturns, ${name}Returns['${methodSigSafe}'] | undefined]>`\n      }\n    }\n    yield DecIndentAndCloseBlock\n    yield NewLine\n  }\n}\n"],"names":["IncIndent","jsDoc","DecIndentAndCloseBlock","NewLine","ABIMethod","getCreateOnCompleteOptions","BARE_CALL"],"mappings":";;;;;;;AAOe,UAAE,gBAAgB,CAAC,GAAqB,EAAA;IACrD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,GAAG,CAAA;IACrC,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,8CAAA,CAAgD,CAAA;AACzE,IAAA,MAAMA,gBAAS,CAAA;AAEf,IAAA,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAA;AACjC,IAAA,OAAO,+BAA+B,CACpC,GAAG,EACH,uCAAuC,GAAG,CAAC,IAAI,CAAA,eAAA,CAAiB,EAChE,UAAU,CAAC,aAAa,EACxB,QAAQ,CACT,CAAA;AACD,IAAA,OAAO,+BAA+B,CACpC,GAAG,EACH,kDAAkD,GAAG,CAAC,IAAI,CAAA,eAAA,CAAiB,EAC3E,UAAU,CAAC,YAAY,EACvB,OAAO,CACR,CAAA;AACD,IAAA,OAAO,+BAA+B,CACpC,GAAG,EACH,yDAAyD,GAAG,CAAC,IAAI,CAAA,eAAA,CAAiB,EAClF,UAAU,CAAC,eAAe,EAC1B,UAAU,CACX,CAAA;AAED,IAAA,OAAO,0BAA0B,CAAC,GAAG,CAAC,CAAA;IAEtC,OAAOC,YAAK,CAAC;AACX,QAAA,WAAW,EAAE,oCAAoC;AACjD,QAAA,MAAM,EAAE;AACN,YAAA,GAAG,EAAE,+CAA+C;AACpD,YAAA,MAAM,EAAE,2DAA2D;AACpE,SAAA;AACF,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,8DAAA,EAAiE,IAAI,CAAA,kBAAA,CAAoB,CAAA;IAE/F,OAAOA,YAAK,CAAC;AACX,QAAA,WAAW,EAAE,2DAA2D;AACzE,KAAA,CAAC,CAAA;AACF,IAAA,MAAM,6BAA6B,CAAA;IAEnC,OAAOA,YAAK,CAAC;AACX,QAAA,WAAW,EAAE,wDAAwD;AACtE,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,6CAAA,EAAgD,IAAI,CAAA,mEAAA,CAAqE,CAAA;IAE/H,OAAOA,YAAK,CAAC;AACX,QAAA,WAAW,EAAE,oEAAoE;AAClF,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,mCAAA,EAAsC,IAAI,CAAA,0BAAA,CAA4B,CAAA;AAE5E,IAAA,MAAMC,6BAAsB,CAAA;IAE5B,MAAM,CAAA;gBACQ,IAAI,CAAA;;;GAGjB,CAAA;AACH,CAAC;AAED,UAAU,0BAA0B,CAAC,EAAE,GAAG,EAAE,IAAI,EAAoB,EAAA;IAClE,OAAOD,YAAK,CAAC;AACX,QAAA,WAAW,EAAE,CAAA,wDAAA,EAA2D,GAAG,CAAC,IAAI,CAAkB,gBAAA,CAAA;AAClG,QAAA,MAAM,EAAE;AACN,YAAA,IAAI,EAAE,CAAiC,+BAAA,CAAA;AACxC,SAAA;AACD,QAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,8CAAA,EAAiD,IAAI,CAAA,kCAAA,CAAoC,CAAA;AAC/F,IAAA,MAAME,cAAO,CAAA;AACf,CAAC;AAED,UAAU,qBAAqB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,2BAA2B,EAAE,SAAS,EAAoB,EAAA;AACjH,IAAA,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE;QAChC,MAAM,SAAS,GAAG,IAAIC,iBAAS,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,CAAA;QACtD,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAA;QACpE,MAAM,UAAU,GAAG,SAAS,CAAC,wBAAwB,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC,CAAA;;QAE7F,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC;YAAE,SAAQ;QAEzD,OAAOH,YAAK,CAAC;YACX,WAAW,EAAE,CAAa,UAAA,EAAA,IAAIG,iBAAS,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,CAAc,YAAA,CAAA;YAC5E,cAAc,EAAE,MAAM,CAAC,IAAI;AAC3B,YAAA,MAAM,EAAE;AACN,gBAAA,IAAI,EAAE,CAAqC,mCAAA,CAAA;AAC3C,gBAAA,MAAM,EAAE,CAAwC,sCAAA,CAAA;AACjD,aAAA;AACD,YAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,SAAA,CAAC,CAAA;AACF,QAAA,MAAM,GAAG,UAAU,CAAA,qBAAA,EAAwB,IAAI,CAAA,aAAA,EAAgB,aAAa,CAAQ,KAAA,EAAA,IAAI,CAAkB,eAAA,EAAA,aAAa,SAAS,IAAI,CAAA,uBAAA,EAA0B,IAAI,CAAY,SAAA,EAAA,aAAa,kBAAkB,CAAA;AAC7M,QAAA,MAAMD,cAAO,CAAA;KACd;AACH,CAAC;AAED,UAAU,+BAA+B,CACvC,EAAE,GAAG,EAAE,2BAA2B,EAAE,IAAI,EAAE,SAAS,EAAoB,EACvE,WAAmB,EACnB,OAAmB,EACnB,IAA2D,EAC3D,kBAA4B,EAAA;AAE5B,IAAA,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,OAAOF,YAAK,CAAC,kBAAkB,IAAI,CAAA,QAAA,CAAU,CAAC,CAAA;QAC9C,MAAM,CAAA,SAAA,EAAY,IAAI,CAAA,GAAA,CAAK,CAAA;AAC3B,QAAA,MAAMD,gBAAS,CAAA;AACf,QAAA,KAAK,MAAM,SAAS,IAAI,OAAO,EAAE;AAC/B,YAAA,MAAM,UAAU,GAAG,IAAI,KAAK,QAAQ,GAAGK,sCAA0B,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,SAAS,CAAA;AAC7F,YAAA,IAAI,SAAS,KAAKC,8BAAS,EAAE;gBAC3B,OAAOL,YAAK,CAAC;oBACX,WAAW,EAAE,CAAG,EAAA,WAAW,CAAqB,mBAAA,CAAA;AAChD,oBAAA,MAAM,EAAE;AACN,wBAAA,IAAI,EAAE,CAAiC,+BAAA,CAAA;AACxC,qBAAA;AACD,oBAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,iBAAA,CAAC,CAAA;gBACF,MAAM,CAAA,WAAA,EAAc,UAAU,EAAE,UAAU,KAAK,KAAK,GAAG,GAAG,GAAG,EAAE,CAAA,0BAAA,EACP,EACxD,CAAA,GAAA,EAAM,IAAI,CAAA,kCAAA,CAAoC,CAAA;aAC/C;iBAAM;AACL,gBAAA,MAAM,UAAU,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAA;gBACzD,OAAOA,YAAK,CAAC;AACX,oBAAA,WAAW,EAAE,CAAA,EAAG,WAAW,CAAA,WAAA,EAAc,SAAS,CAAc,YAAA,CAAA;AAChE,oBAAA,MAAM,EAAE;AACN,wBAAA,IAAI,EAAE,CAA2C,yCAAA,CAAA;AACjD,wBAAA,MAAM,EAAE,CAAwC,sCAAA,CAAA;AACjD,qBAAA;AACD,oBAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,iBAAA,CAAC,CAAA;gBACF,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAA;AACpE,gBAAA,MAAM,CAAG,EAAA,SAAS,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAA,OAAA,EACrD,UAAU,EAAE,UAAU,KAAK,KAAK,GAAG,GAAG,GAAG,EAC3C,CAAA,aAAA,EAAgB,IAAI,CAAA,aAAA,EAAgB,aAAa,CAAA,KAAA,EAAQ,IAAI,CAAA,eAAA,EAAkB,aAAa,CAAM,GAAA,EAAuD,EAAE,CACzJ,EAAA,UAAU,EAAE,IAAI,GAAG,CAAA,GAAA,EAAM,UAAU,CAAC,IAAI,CAAA,CAAE,GAAG,EAC/C,CAAM,GAAA,EAAA,IAAI,CAA0B,uBAAA,EAAA,IAAI,CAAY,SAAA,EAAA,aAAa,kBAAkB,CAAA;aACpF;SACF;AACD,QAAA,MAAMC,6BAAsB,CAAA;AAC5B,QAAA,MAAMC,cAAO,CAAA;KACd;AACH;;;;"}
+{"version":3,"file":"call-composer-types.js","sources":["../../src/client/call-composer-types.ts"],"sourcesContent":["import { DecIndentAndCloseBlock, DocumentParts, IncIndent, jsDoc, NewLine } from '../output/writer'\nimport { GeneratorContext } from './generator-context'\n\nimport { BARE_CALL, MethodList } from './helpers/get-call-config-summary'\nimport { getCreateOnCompleteOptions } from './deploy-types'\nimport { ABIMethod } from 'algosdk'\n\nexport function* callComposerType(ctx: GeneratorContext): DocumentParts {\n  const { name, callConfig, app } = ctx\n  yield `export type ${name}Composer<TReturns extends [...any[]] = []> = {`\n  yield IncIndent\n\n  yield* callComposerTypeNoops(ctx)\n  yield* callComposerOperationMethodType(\n    ctx,\n    `Deletes an existing instance of the ${app.name} smart contract`,\n    callConfig.deleteMethods,\n    'delete',\n  )\n  yield* callComposerOperationMethodType(\n    ctx,\n    `Opts the user into an existing instance of the ${app.name} smart contract`,\n    callConfig.optInMethods,\n    'optIn',\n  )\n  yield* callComposerOperationMethodType(\n    ctx,\n    `Makes a close out call to an existing instance of the ${app.name} smart contract`,\n    callConfig.closeOutMethods,\n    'closeOut',\n  )\n\n  yield* callComposerTypeClearState(ctx)\n\n  yield* jsDoc({\n    description: 'Adds a transaction to the composer',\n    params: {\n      txn: 'A transaction to add to the transaction group',\n      signer: 'The optional signer to use when signing this transaction.',\n    },\n  })\n  yield `addTransaction(txn: Transaction, signer?: TransactionSigner): ${name}Composer<TReturns>`\n\n  yield* jsDoc({\n    description: 'Returns the underlying AtomicTransactionComposer instance',\n  })\n  yield `composer(): TransactionComposer`\n\n  yield* jsDoc({\n    description: 'Simulates the transaction group and returns the result',\n  })\n  yield `simulate(options?: SimulateOptions): Promise<${name}ComposerResults<TReturns> & { simulateResponse: SimulateResponse }>`\n\n  yield* jsDoc({\n    description: 'Sends the transaction group to the network and returns the results',\n  })\n  yield `send(params?: SendParams): Promise<${name}ComposerResults<TReturns>>`\n\n  yield DecIndentAndCloseBlock\n\n  yield `\n  export type ${name}ComposerResults<TReturns extends [...any[]]> = Expand<SendAtomicTransactionComposerResults & {\n    returns: TReturns\n  }>\n  `\n}\n\nfunction* callComposerTypeClearState({ app, name }: GeneratorContext): DocumentParts {\n  yield* jsDoc({\n    description: `Makes a clear_state call to an existing instance of the ${app.name} smart contract.`,\n    params: {\n      args: `The arguments for the bare call`,\n    },\n    returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n  })\n  yield `clearState(params?: AppClientBareCallParams): ${name}Composer<[...TReturns, undefined]>`\n  yield NewLine\n}\n\nfunction* callComposerTypeNoops({ app, name, callConfig, methodSignatureToUniqueName, sanitizer }: GeneratorContext): DocumentParts {\n  for (const method of app.methods) {\n    const methodSig = new ABIMethod(method).getSignature()\n    const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(methodSig)\n    const methodName = sanitizer.makeSafeMethodIdentifier(methodSignatureToUniqueName[methodSig])\n    // Skip methods which don't support a no_op call config\n    if (!callConfig.callMethods.includes(methodSig)) continue\n\n    yield* jsDoc({\n      description: `Calls the ${new ABIMethod(method).getSignature()} ABI method.`,\n      abiDescription: method.desc,\n      params: {\n        args: `The arguments for the contract call`,\n        params: `Any additional parameters for the call`,\n      },\n      returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n    })\n    yield `${methodName}(params?: CallParams<${name}Args['obj']['${methodSigSafe}'] | ${name}Args['tuple']['${methodSigSafe}']>): ${name}Composer<[...TReturns, ${name}Returns['${methodSigSafe}'] | undefined]>`\n    yield NewLine\n  }\n}\n\nfunction* callComposerOperationMethodType(\n  { app, methodSignatureToUniqueName, name, sanitizer }: GeneratorContext,\n  description: string,\n  methods: MethodList,\n  verb: 'create' | 'update' | 'optIn' | 'closeOut' | 'delete',\n  includeCompilation?: boolean,\n): DocumentParts {\n  if (methods.length) {\n    yield* jsDoc(`Gets available ${verb} methods`)\n    yield `readonly ${verb}: {`\n    yield IncIndent\n    for (const methodSig of methods) {\n      const onComplete = verb === 'create' ? getCreateOnCompleteOptions(methodSig, app) : undefined\n      if (methodSig === BARE_CALL) {\n        yield* jsDoc({\n          description: `${description} using a bare call.`,\n          params: {\n            args: `The arguments for the bare call`,\n          },\n          returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n        })\n        yield `bare(params${onComplete?.isOptional !== false ? '?' : ''}: AppClientBareCallParams ${\n          includeCompilation ? '& AppClientCompilationParams' : ''\n        }): ${name}Composer<[...TReturns, undefined]>`\n      } else {\n        const uniqueName = methodSignatureToUniqueName[methodSig]\n        yield* jsDoc({\n          description: `${description} using the ${methodSig} ABI method.`,\n          params: {\n            args: `The arguments for the smart contract call`,\n            params: `Any additional parameters for the call`,\n          },\n          returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n        })\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(methodSig)\n        yield `${sanitizer.makeSafeMethodIdentifier(uniqueName)}(params${\n          onComplete?.isOptional !== false ? '?' : ''\n        }: CallParams<${name}Args['obj']['${methodSigSafe}'] | ${name}Args['tuple']['${methodSigSafe}']>${includeCompilation ? ' & AppClientCompilationParams' : ''}${\n          onComplete?.type ? ` & ${onComplete.type}` : ''\n        }): ${name}Composer<[...TReturns, ${name}Returns['${methodSigSafe}'] | undefined]>`\n      }\n    }\n    yield DecIndentAndCloseBlock\n    yield NewLine\n  }\n}\n"],"names":["IncIndent","jsDoc","DecIndentAndCloseBlock","NewLine","ABIMethod","getCreateOnCompleteOptions","BARE_CALL"],"mappings":";;;;;;;AAOe,UAAE,gBAAgB,CAAC,GAAqB,EAAA;IACrD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,GAAG,CAAA;IACrC,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,8CAAA,CAAgD,CAAA;AACzE,IAAA,MAAMA,gBAAS,CAAA;AAEf,IAAA,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAA;AACjC,IAAA,OAAO,+BAA+B,CACpC,GAAG,EACH,uCAAuC,GAAG,CAAC,IAAI,CAAA,eAAA,CAAiB,EAChE,UAAU,CAAC,aAAa,EACxB,QAAQ,CACT,CAAA;AACD,IAAA,OAAO,+BAA+B,CACpC,GAAG,EACH,kDAAkD,GAAG,CAAC,IAAI,CAAA,eAAA,CAAiB,EAC3E,UAAU,CAAC,YAAY,EACvB,OAAO,CACR,CAAA;AACD,IAAA,OAAO,+BAA+B,CACpC,GAAG,EACH,yDAAyD,GAAG,CAAC,IAAI,CAAA,eAAA,CAAiB,EAClF,UAAU,CAAC,eAAe,EAC1B,UAAU,CACX,CAAA;AAED,IAAA,OAAO,0BAA0B,CAAC,GAAG,CAAC,CAAA;IAEtC,OAAOC,YAAK,CAAC;AACX,QAAA,WAAW,EAAE,oCAAoC;AACjD,QAAA,MAAM,EAAE;AACN,YAAA,GAAG,EAAE,+CAA+C;AACpD,YAAA,MAAM,EAAE,2DAA2D;AACpE,SAAA;AACF,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,8DAAA,EAAiE,IAAI,CAAA,kBAAA,CAAoB,CAAA;IAE/F,OAAOA,YAAK,CAAC;AACX,QAAA,WAAW,EAAE,2DAA2D;AACzE,KAAA,CAAC,CAAA;AACF,IAAA,MAAM,iCAAiC,CAAA;IAEvC,OAAOA,YAAK,CAAC;AACX,QAAA,WAAW,EAAE,wDAAwD;AACtE,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,6CAAA,EAAgD,IAAI,CAAA,mEAAA,CAAqE,CAAA;IAE/H,OAAOA,YAAK,CAAC;AACX,QAAA,WAAW,EAAE,oEAAoE;AAClF,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,mCAAA,EAAsC,IAAI,CAAA,0BAAA,CAA4B,CAAA;AAE5E,IAAA,MAAMC,6BAAsB,CAAA;IAE5B,MAAM,CAAA;gBACQ,IAAI,CAAA;;;GAGjB,CAAA;AACH,CAAC;AAED,UAAU,0BAA0B,CAAC,EAAE,GAAG,EAAE,IAAI,EAAoB,EAAA;IAClE,OAAOD,YAAK,CAAC;AACX,QAAA,WAAW,EAAE,CAAA,wDAAA,EAA2D,GAAG,CAAC,IAAI,CAAkB,gBAAA,CAAA;AAClG,QAAA,MAAM,EAAE;AACN,YAAA,IAAI,EAAE,CAAiC,+BAAA,CAAA;AACxC,SAAA;AACD,QAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,8CAAA,EAAiD,IAAI,CAAA,kCAAA,CAAoC,CAAA;AAC/F,IAAA,MAAME,cAAO,CAAA;AACf,CAAC;AAED,UAAU,qBAAqB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,2BAA2B,EAAE,SAAS,EAAoB,EAAA;AACjH,IAAA,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE;QAChC,MAAM,SAAS,GAAG,IAAIC,iBAAS,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,CAAA;QACtD,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAA;QACpE,MAAM,UAAU,GAAG,SAAS,CAAC,wBAAwB,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC,CAAA;;QAE7F,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC;YAAE,SAAQ;QAEzD,OAAOH,YAAK,CAAC;YACX,WAAW,EAAE,CAAa,UAAA,EAAA,IAAIG,iBAAS,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,CAAc,YAAA,CAAA;YAC5E,cAAc,EAAE,MAAM,CAAC,IAAI;AAC3B,YAAA,MAAM,EAAE;AACN,gBAAA,IAAI,EAAE,CAAqC,mCAAA,CAAA;AAC3C,gBAAA,MAAM,EAAE,CAAwC,sCAAA,CAAA;AACjD,aAAA;AACD,YAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,SAAA,CAAC,CAAA;AACF,QAAA,MAAM,GAAG,UAAU,CAAA,qBAAA,EAAwB,IAAI,CAAA,aAAA,EAAgB,aAAa,CAAQ,KAAA,EAAA,IAAI,CAAkB,eAAA,EAAA,aAAa,SAAS,IAAI,CAAA,uBAAA,EAA0B,IAAI,CAAY,SAAA,EAAA,aAAa,kBAAkB,CAAA;AAC7M,QAAA,MAAMD,cAAO,CAAA;KACd;AACH,CAAC;AAED,UAAU,+BAA+B,CACvC,EAAE,GAAG,EAAE,2BAA2B,EAAE,IAAI,EAAE,SAAS,EAAoB,EACvE,WAAmB,EACnB,OAAmB,EACnB,IAA2D,EAC3D,kBAA4B,EAAA;AAE5B,IAAA,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,OAAOF,YAAK,CAAC,kBAAkB,IAAI,CAAA,QAAA,CAAU,CAAC,CAAA;QAC9C,MAAM,CAAA,SAAA,EAAY,IAAI,CAAA,GAAA,CAAK,CAAA;AAC3B,QAAA,MAAMD,gBAAS,CAAA;AACf,QAAA,KAAK,MAAM,SAAS,IAAI,OAAO,EAAE;AAC/B,YAAA,MAAM,UAAU,GAAG,IAAI,KAAK,QAAQ,GAAGK,sCAA0B,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,SAAS,CAAA;AAC7F,YAAA,IAAI,SAAS,KAAKC,8BAAS,EAAE;gBAC3B,OAAOL,YAAK,CAAC;oBACX,WAAW,EAAE,CAAG,EAAA,WAAW,CAAqB,mBAAA,CAAA;AAChD,oBAAA,MAAM,EAAE;AACN,wBAAA,IAAI,EAAE,CAAiC,+BAAA,CAAA;AACxC,qBAAA;AACD,oBAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,iBAAA,CAAC,CAAA;gBACF,MAAM,CAAA,WAAA,EAAc,UAAU,EAAE,UAAU,KAAK,KAAK,GAAG,GAAG,GAAG,EAAE,CAAA,0BAAA,EACP,EACxD,CAAA,GAAA,EAAM,IAAI,CAAA,kCAAA,CAAoC,CAAA;aAC/C;iBAAM;AACL,gBAAA,MAAM,UAAU,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAA;gBACzD,OAAOA,YAAK,CAAC;AACX,oBAAA,WAAW,EAAE,CAAA,EAAG,WAAW,CAAA,WAAA,EAAc,SAAS,CAAc,YAAA,CAAA;AAChE,oBAAA,MAAM,EAAE;AACN,wBAAA,IAAI,EAAE,CAA2C,yCAAA,CAAA;AACjD,wBAAA,MAAM,EAAE,CAAwC,sCAAA,CAAA;AACjD,qBAAA;AACD,oBAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,iBAAA,CAAC,CAAA;gBACF,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAA;AACpE,gBAAA,MAAM,CAAG,EAAA,SAAS,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAA,OAAA,EACrD,UAAU,EAAE,UAAU,KAAK,KAAK,GAAG,GAAG,GAAG,EAC3C,CAAA,aAAA,EAAgB,IAAI,CAAA,aAAA,EAAgB,aAAa,CAAA,KAAA,EAAQ,IAAI,CAAA,eAAA,EAAkB,aAAa,CAAM,GAAA,EAAuD,EAAE,CACzJ,EAAA,UAAU,EAAE,IAAI,GAAG,CAAA,GAAA,EAAM,UAAU,CAAC,IAAI,CAAA,CAAE,GAAG,EAC/C,CAAM,GAAA,EAAA,IAAI,CAA0B,uBAAA,EAAA,IAAI,CAAY,SAAA,EAAA,aAAa,kBAAkB,CAAA;aACpF;SACF;AACD,QAAA,MAAMC,6BAAsB,CAAA;AAC5B,QAAA,MAAMC,cAAO,CAAA;KACd;AACH;;;;"}

package/client/call-composer-types.mjs

@@ -23,7 +23,7 @@ function* callComposerType(ctx) {
     yield* jsDoc({
         description: 'Returns the underlying AtomicTransactionComposer instance',
     });
-    yield `composer(): AlgoKitComposer`;
+    yield `composer(): TransactionComposer`;
     yield* jsDoc({
         description: 'Simulates the transaction group and returns the result',
     });

package/client/call-composer-types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"call-composer-types.mjs","sources":["../../src/client/call-composer-types.ts"],"sourcesContent":["import { DecIndentAndCloseBlock, DocumentParts, IncIndent, jsDoc, NewLine } from '../output/writer'\nimport { GeneratorContext } from './generator-context'\n\nimport { BARE_CALL, MethodList } from './helpers/get-call-config-summary'\nimport { getCreateOnCompleteOptions } from './deploy-types'\nimport { ABIMethod } from 'algosdk'\n\nexport function* callComposerType(ctx: GeneratorContext): DocumentParts {\n  const { name, callConfig, app } = ctx\n  yield `export type ${name}Composer<TReturns extends [...any[]] = []> = {`\n  yield IncIndent\n\n  yield* callComposerTypeNoops(ctx)\n  yield* callComposerOperationMethodType(\n    ctx,\n    `Deletes an existing instance of the ${app.name} smart contract`,\n    callConfig.deleteMethods,\n    'delete',\n  )\n  yield* callComposerOperationMethodType(\n    ctx,\n    `Opts the user into an existing instance of the ${app.name} smart contract`,\n    callConfig.optInMethods,\n    'optIn',\n  )\n  yield* callComposerOperationMethodType(\n    ctx,\n    `Makes a close out call to an existing instance of the ${app.name} smart contract`,\n    callConfig.closeOutMethods,\n    'closeOut',\n  )\n\n  yield* callComposerTypeClearState(ctx)\n\n  yield* jsDoc({\n    description: 'Adds a transaction to the composer',\n    params: {\n      txn: 'A transaction to add to the transaction group',\n      signer: 'The optional signer to use when signing this transaction.',\n    },\n  })\n  yield `addTransaction(txn: Transaction, signer?: TransactionSigner): ${name}Composer<TReturns>`\n\n  yield* jsDoc({\n    description: 'Returns the underlying AtomicTransactionComposer instance',\n  })\n  yield `composer(): AlgoKitComposer`\n\n  yield* jsDoc({\n    description: 'Simulates the transaction group and returns the result',\n  })\n  yield `simulate(options?: SimulateOptions): Promise<${name}ComposerResults<TReturns> & { simulateResponse: SimulateResponse }>`\n\n  yield* jsDoc({\n    description: 'Sends the transaction group to the network and returns the results',\n  })\n  yield `send(params?: SendParams): Promise<${name}ComposerResults<TReturns>>`\n\n  yield DecIndentAndCloseBlock\n\n  yield `\n  export type ${name}ComposerResults<TReturns extends [...any[]]> = Expand<SendAtomicTransactionComposerResults & {\n    returns: TReturns\n  }>\n  `\n}\n\nfunction* callComposerTypeClearState({ app, name }: GeneratorContext): DocumentParts {\n  yield* jsDoc({\n    description: `Makes a clear_state call to an existing instance of the ${app.name} smart contract.`,\n    params: {\n      args: `The arguments for the bare call`,\n    },\n    returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n  })\n  yield `clearState(params?: AppClientBareCallParams): ${name}Composer<[...TReturns, undefined]>`\n  yield NewLine\n}\n\nfunction* callComposerTypeNoops({ app, name, callConfig, methodSignatureToUniqueName, sanitizer }: GeneratorContext): DocumentParts {\n  for (const method of app.methods) {\n    const methodSig = new ABIMethod(method).getSignature()\n    const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(methodSig)\n    const methodName = sanitizer.makeSafeMethodIdentifier(methodSignatureToUniqueName[methodSig])\n    // Skip methods which don't support a no_op call config\n    if (!callConfig.callMethods.includes(methodSig)) continue\n\n    yield* jsDoc({\n      description: `Calls the ${new ABIMethod(method).getSignature()} ABI method.`,\n      abiDescription: method.desc,\n      params: {\n        args: `The arguments for the contract call`,\n        params: `Any additional parameters for the call`,\n      },\n      returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n    })\n    yield `${methodName}(params?: CallParams<${name}Args['obj']['${methodSigSafe}'] | ${name}Args['tuple']['${methodSigSafe}']>): ${name}Composer<[...TReturns, ${name}Returns['${methodSigSafe}'] | undefined]>`\n    yield NewLine\n  }\n}\n\nfunction* callComposerOperationMethodType(\n  { app, methodSignatureToUniqueName, name, sanitizer }: GeneratorContext,\n  description: string,\n  methods: MethodList,\n  verb: 'create' | 'update' | 'optIn' | 'closeOut' | 'delete',\n  includeCompilation?: boolean,\n): DocumentParts {\n  if (methods.length) {\n    yield* jsDoc(`Gets available ${verb} methods`)\n    yield `readonly ${verb}: {`\n    yield IncIndent\n    for (const methodSig of methods) {\n      const onComplete = verb === 'create' ? getCreateOnCompleteOptions(methodSig, app) : undefined\n      if (methodSig === BARE_CALL) {\n        yield* jsDoc({\n          description: `${description} using a bare call.`,\n          params: {\n            args: `The arguments for the bare call`,\n          },\n          returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n        })\n        yield `bare(params${onComplete?.isOptional !== false ? '?' : ''}: AppClientBareCallParams ${\n          includeCompilation ? '& AppClientCompilationParams' : ''\n        }): ${name}Composer<[...TReturns, undefined]>`\n      } else {\n        const uniqueName = methodSignatureToUniqueName[methodSig]\n        yield* jsDoc({\n          description: `${description} using the ${methodSig} ABI method.`,\n          params: {\n            args: `The arguments for the smart contract call`,\n            params: `Any additional parameters for the call`,\n          },\n          returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n        })\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(methodSig)\n        yield `${sanitizer.makeSafeMethodIdentifier(uniqueName)}(params${\n          onComplete?.isOptional !== false ? '?' : ''\n        }: CallParams<${name}Args['obj']['${methodSigSafe}'] | ${name}Args['tuple']['${methodSigSafe}']>${includeCompilation ? ' & AppClientCompilationParams' : ''}${\n          onComplete?.type ? ` & ${onComplete.type}` : ''\n        }): ${name}Composer<[...TReturns, ${name}Returns['${methodSigSafe}'] | undefined]>`\n      }\n    }\n    yield DecIndentAndCloseBlock\n    yield NewLine\n  }\n}\n"],"names":[],"mappings":";;;;;AAOe,UAAE,gBAAgB,CAAC,GAAqB,EAAA;IACrD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,GAAG,CAAA;IACrC,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,8CAAA,CAAgD,CAAA;AACzE,IAAA,MAAM,SAAS,CAAA;AAEf,IAAA,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAA;AACjC,IAAA,OAAO,+BAA+B,CACpC,GAAG,EACH,uCAAuC,GAAG,CAAC,IAAI,CAAA,eAAA,CAAiB,EAChE,UAAU,CAAC,aAAa,EACxB,QAAQ,CACT,CAAA;AACD,IAAA,OAAO,+BAA+B,CACpC,GAAG,EACH,kDAAkD,GAAG,CAAC,IAAI,CAAA,eAAA,CAAiB,EAC3E,UAAU,CAAC,YAAY,EACvB,OAAO,CACR,CAAA;AACD,IAAA,OAAO,+BAA+B,CACpC,GAAG,EACH,yDAAyD,GAAG,CAAC,IAAI,CAAA,eAAA,CAAiB,EAClF,UAAU,CAAC,eAAe,EAC1B,UAAU,CACX,CAAA;AAED,IAAA,OAAO,0BAA0B,CAAC,GAAG,CAAC,CAAA;IAEtC,OAAO,KAAK,CAAC;AACX,QAAA,WAAW,EAAE,oCAAoC;AACjD,QAAA,MAAM,EAAE;AACN,YAAA,GAAG,EAAE,+CAA+C;AACpD,YAAA,MAAM,EAAE,2DAA2D;AACpE,SAAA;AACF,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,8DAAA,EAAiE,IAAI,CAAA,kBAAA,CAAoB,CAAA;IAE/F,OAAO,KAAK,CAAC;AACX,QAAA,WAAW,EAAE,2DAA2D;AACzE,KAAA,CAAC,CAAA;AACF,IAAA,MAAM,6BAA6B,CAAA;IAEnC,OAAO,KAAK,CAAC;AACX,QAAA,WAAW,EAAE,wDAAwD;AACtE,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,6CAAA,EAAgD,IAAI,CAAA,mEAAA,CAAqE,CAAA;IAE/H,OAAO,KAAK,CAAC;AACX,QAAA,WAAW,EAAE,oEAAoE;AAClF,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,mCAAA,EAAsC,IAAI,CAAA,0BAAA,CAA4B,CAAA;AAE5E,IAAA,MAAM,sBAAsB,CAAA;IAE5B,MAAM,CAAA;gBACQ,IAAI,CAAA;;;GAGjB,CAAA;AACH,CAAC;AAED,UAAU,0BAA0B,CAAC,EAAE,GAAG,EAAE,IAAI,EAAoB,EAAA;IAClE,OAAO,KAAK,CAAC;AACX,QAAA,WAAW,EAAE,CAAA,wDAAA,EAA2D,GAAG,CAAC,IAAI,CAAkB,gBAAA,CAAA;AAClG,QAAA,MAAM,EAAE;AACN,YAAA,IAAI,EAAE,CAAiC,+BAAA,CAAA;AACxC,SAAA;AACD,QAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,8CAAA,EAAiD,IAAI,CAAA,kCAAA,CAAoC,CAAA;AAC/F,IAAA,MAAM,OAAO,CAAA;AACf,CAAC;AAED,UAAU,qBAAqB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,2BAA2B,EAAE,SAAS,EAAoB,EAAA;AACjH,IAAA,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE;QAChC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,CAAA;QACtD,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAA;QACpE,MAAM,UAAU,GAAG,SAAS,CAAC,wBAAwB,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC,CAAA;;QAE7F,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC;YAAE,SAAQ;QAEzD,OAAO,KAAK,CAAC;YACX,WAAW,EAAE,CAAa,UAAA,EAAA,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,CAAc,YAAA,CAAA;YAC5E,cAAc,EAAE,MAAM,CAAC,IAAI;AAC3B,YAAA,MAAM,EAAE;AACN,gBAAA,IAAI,EAAE,CAAqC,mCAAA,CAAA;AAC3C,gBAAA,MAAM,EAAE,CAAwC,sCAAA,CAAA;AACjD,aAAA;AACD,YAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,SAAA,CAAC,CAAA;AACF,QAAA,MAAM,GAAG,UAAU,CAAA,qBAAA,EAAwB,IAAI,CAAA,aAAA,EAAgB,aAAa,CAAQ,KAAA,EAAA,IAAI,CAAkB,eAAA,EAAA,aAAa,SAAS,IAAI,CAAA,uBAAA,EAA0B,IAAI,CAAY,SAAA,EAAA,aAAa,kBAAkB,CAAA;AAC7M,QAAA,MAAM,OAAO,CAAA;KACd;AACH,CAAC;AAED,UAAU,+BAA+B,CACvC,EAAE,GAAG,EAAE,2BAA2B,EAAE,IAAI,EAAE,SAAS,EAAoB,EACvE,WAAmB,EACnB,OAAmB,EACnB,IAA2D,EAC3D,kBAA4B,EAAA;AAE5B,IAAA,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,OAAO,KAAK,CAAC,kBAAkB,IAAI,CAAA,QAAA,CAAU,CAAC,CAAA;QAC9C,MAAM,CAAA,SAAA,EAAY,IAAI,CAAA,GAAA,CAAK,CAAA;AAC3B,QAAA,MAAM,SAAS,CAAA;AACf,QAAA,KAAK,MAAM,SAAS,IAAI,OAAO,EAAE;AAC/B,YAAA,MAAM,UAAU,GAAG,IAAI,KAAK,QAAQ,GAAG,0BAA0B,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,SAAS,CAAA;AAC7F,YAAA,IAAI,SAAS,KAAK,SAAS,EAAE;gBAC3B,OAAO,KAAK,CAAC;oBACX,WAAW,EAAE,CAAG,EAAA,WAAW,CAAqB,mBAAA,CAAA;AAChD,oBAAA,MAAM,EAAE;AACN,wBAAA,IAAI,EAAE,CAAiC,+BAAA,CAAA;AACxC,qBAAA;AACD,oBAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,iBAAA,CAAC,CAAA;gBACF,MAAM,CAAA,WAAA,EAAc,UAAU,EAAE,UAAU,KAAK,KAAK,GAAG,GAAG,GAAG,EAAE,CAAA,0BAAA,EACP,EACxD,CAAA,GAAA,EAAM,IAAI,CAAA,kCAAA,CAAoC,CAAA;aAC/C;iBAAM;AACL,gBAAA,MAAM,UAAU,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAA;gBACzD,OAAO,KAAK,CAAC;AACX,oBAAA,WAAW,EAAE,CAAA,EAAG,WAAW,CAAA,WAAA,EAAc,SAAS,CAAc,YAAA,CAAA;AAChE,oBAAA,MAAM,EAAE;AACN,wBAAA,IAAI,EAAE,CAA2C,yCAAA,CAAA;AACjD,wBAAA,MAAM,EAAE,CAAwC,sCAAA,CAAA;AACjD,qBAAA;AACD,oBAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,iBAAA,CAAC,CAAA;gBACF,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAA;AACpE,gBAAA,MAAM,CAAG,EAAA,SAAS,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAA,OAAA,EACrD,UAAU,EAAE,UAAU,KAAK,KAAK,GAAG,GAAG,GAAG,EAC3C,CAAA,aAAA,EAAgB,IAAI,CAAA,aAAA,EAAgB,aAAa,CAAA,KAAA,EAAQ,IAAI,CAAA,eAAA,EAAkB,aAAa,CAAM,GAAA,EAAuD,EAAE,CACzJ,EAAA,UAAU,EAAE,IAAI,GAAG,CAAA,GAAA,EAAM,UAAU,CAAC,IAAI,CAAA,CAAE,GAAG,EAC/C,CAAM,GAAA,EAAA,IAAI,CAA0B,uBAAA,EAAA,IAAI,CAAY,SAAA,EAAA,aAAa,kBAAkB,CAAA;aACpF;SACF;AACD,QAAA,MAAM,sBAAsB,CAAA;AAC5B,QAAA,MAAM,OAAO,CAAA;KACd;AACH;;;;"}
+{"version":3,"file":"call-composer-types.mjs","sources":["../../src/client/call-composer-types.ts"],"sourcesContent":["import { DecIndentAndCloseBlock, DocumentParts, IncIndent, jsDoc, NewLine } from '../output/writer'\nimport { GeneratorContext } from './generator-context'\n\nimport { BARE_CALL, MethodList } from './helpers/get-call-config-summary'\nimport { getCreateOnCompleteOptions } from './deploy-types'\nimport { ABIMethod } from 'algosdk'\n\nexport function* callComposerType(ctx: GeneratorContext): DocumentParts {\n  const { name, callConfig, app } = ctx\n  yield `export type ${name}Composer<TReturns extends [...any[]] = []> = {`\n  yield IncIndent\n\n  yield* callComposerTypeNoops(ctx)\n  yield* callComposerOperationMethodType(\n    ctx,\n    `Deletes an existing instance of the ${app.name} smart contract`,\n    callConfig.deleteMethods,\n    'delete',\n  )\n  yield* callComposerOperationMethodType(\n    ctx,\n    `Opts the user into an existing instance of the ${app.name} smart contract`,\n    callConfig.optInMethods,\n    'optIn',\n  )\n  yield* callComposerOperationMethodType(\n    ctx,\n    `Makes a close out call to an existing instance of the ${app.name} smart contract`,\n    callConfig.closeOutMethods,\n    'closeOut',\n  )\n\n  yield* callComposerTypeClearState(ctx)\n\n  yield* jsDoc({\n    description: 'Adds a transaction to the composer',\n    params: {\n      txn: 'A transaction to add to the transaction group',\n      signer: 'The optional signer to use when signing this transaction.',\n    },\n  })\n  yield `addTransaction(txn: Transaction, signer?: TransactionSigner): ${name}Composer<TReturns>`\n\n  yield* jsDoc({\n    description: 'Returns the underlying AtomicTransactionComposer instance',\n  })\n  yield `composer(): TransactionComposer`\n\n  yield* jsDoc({\n    description: 'Simulates the transaction group and returns the result',\n  })\n  yield `simulate(options?: SimulateOptions): Promise<${name}ComposerResults<TReturns> & { simulateResponse: SimulateResponse }>`\n\n  yield* jsDoc({\n    description: 'Sends the transaction group to the network and returns the results',\n  })\n  yield `send(params?: SendParams): Promise<${name}ComposerResults<TReturns>>`\n\n  yield DecIndentAndCloseBlock\n\n  yield `\n  export type ${name}ComposerResults<TReturns extends [...any[]]> = Expand<SendAtomicTransactionComposerResults & {\n    returns: TReturns\n  }>\n  `\n}\n\nfunction* callComposerTypeClearState({ app, name }: GeneratorContext): DocumentParts {\n  yield* jsDoc({\n    description: `Makes a clear_state call to an existing instance of the ${app.name} smart contract.`,\n    params: {\n      args: `The arguments for the bare call`,\n    },\n    returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n  })\n  yield `clearState(params?: AppClientBareCallParams): ${name}Composer<[...TReturns, undefined]>`\n  yield NewLine\n}\n\nfunction* callComposerTypeNoops({ app, name, callConfig, methodSignatureToUniqueName, sanitizer }: GeneratorContext): DocumentParts {\n  for (const method of app.methods) {\n    const methodSig = new ABIMethod(method).getSignature()\n    const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(methodSig)\n    const methodName = sanitizer.makeSafeMethodIdentifier(methodSignatureToUniqueName[methodSig])\n    // Skip methods which don't support a no_op call config\n    if (!callConfig.callMethods.includes(methodSig)) continue\n\n    yield* jsDoc({\n      description: `Calls the ${new ABIMethod(method).getSignature()} ABI method.`,\n      abiDescription: method.desc,\n      params: {\n        args: `The arguments for the contract call`,\n        params: `Any additional parameters for the call`,\n      },\n      returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n    })\n    yield `${methodName}(params?: CallParams<${name}Args['obj']['${methodSigSafe}'] | ${name}Args['tuple']['${methodSigSafe}']>): ${name}Composer<[...TReturns, ${name}Returns['${methodSigSafe}'] | undefined]>`\n    yield NewLine\n  }\n}\n\nfunction* callComposerOperationMethodType(\n  { app, methodSignatureToUniqueName, name, sanitizer }: GeneratorContext,\n  description: string,\n  methods: MethodList,\n  verb: 'create' | 'update' | 'optIn' | 'closeOut' | 'delete',\n  includeCompilation?: boolean,\n): DocumentParts {\n  if (methods.length) {\n    yield* jsDoc(`Gets available ${verb} methods`)\n    yield `readonly ${verb}: {`\n    yield IncIndent\n    for (const methodSig of methods) {\n      const onComplete = verb === 'create' ? getCreateOnCompleteOptions(methodSig, app) : undefined\n      if (methodSig === BARE_CALL) {\n        yield* jsDoc({\n          description: `${description} using a bare call.`,\n          params: {\n            args: `The arguments for the bare call`,\n          },\n          returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n        })\n        yield `bare(params${onComplete?.isOptional !== false ? '?' : ''}: AppClientBareCallParams ${\n          includeCompilation ? '& AppClientCompilationParams' : ''\n        }): ${name}Composer<[...TReturns, undefined]>`\n      } else {\n        const uniqueName = methodSignatureToUniqueName[methodSig]\n        yield* jsDoc({\n          description: `${description} using the ${methodSig} ABI method.`,\n          params: {\n            args: `The arguments for the smart contract call`,\n            params: `Any additional parameters for the call`,\n          },\n          returns: `The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions`,\n        })\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(methodSig)\n        yield `${sanitizer.makeSafeMethodIdentifier(uniqueName)}(params${\n          onComplete?.isOptional !== false ? '?' : ''\n        }: CallParams<${name}Args['obj']['${methodSigSafe}'] | ${name}Args['tuple']['${methodSigSafe}']>${includeCompilation ? ' & AppClientCompilationParams' : ''}${\n          onComplete?.type ? ` & ${onComplete.type}` : ''\n        }): ${name}Composer<[...TReturns, ${name}Returns['${methodSigSafe}'] | undefined]>`\n      }\n    }\n    yield DecIndentAndCloseBlock\n    yield NewLine\n  }\n}\n"],"names":[],"mappings":";;;;;AAOe,UAAE,gBAAgB,CAAC,GAAqB,EAAA;IACrD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,GAAG,CAAA;IACrC,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,8CAAA,CAAgD,CAAA;AACzE,IAAA,MAAM,SAAS,CAAA;AAEf,IAAA,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAA;AACjC,IAAA,OAAO,+BAA+B,CACpC,GAAG,EACH,uCAAuC,GAAG,CAAC,IAAI,CAAA,eAAA,CAAiB,EAChE,UAAU,CAAC,aAAa,EACxB,QAAQ,CACT,CAAA;AACD,IAAA,OAAO,+BAA+B,CACpC,GAAG,EACH,kDAAkD,GAAG,CAAC,IAAI,CAAA,eAAA,CAAiB,EAC3E,UAAU,CAAC,YAAY,EACvB,OAAO,CACR,CAAA;AACD,IAAA,OAAO,+BAA+B,CACpC,GAAG,EACH,yDAAyD,GAAG,CAAC,IAAI,CAAA,eAAA,CAAiB,EAClF,UAAU,CAAC,eAAe,EAC1B,UAAU,CACX,CAAA;AAED,IAAA,OAAO,0BAA0B,CAAC,GAAG,CAAC,CAAA;IAEtC,OAAO,KAAK,CAAC;AACX,QAAA,WAAW,EAAE,oCAAoC;AACjD,QAAA,MAAM,EAAE;AACN,YAAA,GAAG,EAAE,+CAA+C;AACpD,YAAA,MAAM,EAAE,2DAA2D;AACpE,SAAA;AACF,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,8DAAA,EAAiE,IAAI,CAAA,kBAAA,CAAoB,CAAA;IAE/F,OAAO,KAAK,CAAC;AACX,QAAA,WAAW,EAAE,2DAA2D;AACzE,KAAA,CAAC,CAAA;AACF,IAAA,MAAM,iCAAiC,CAAA;IAEvC,OAAO,KAAK,CAAC;AACX,QAAA,WAAW,EAAE,wDAAwD;AACtE,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,6CAAA,EAAgD,IAAI,CAAA,mEAAA,CAAqE,CAAA;IAE/H,OAAO,KAAK,CAAC;AACX,QAAA,WAAW,EAAE,oEAAoE;AAClF,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,mCAAA,EAAsC,IAAI,CAAA,0BAAA,CAA4B,CAAA;AAE5E,IAAA,MAAM,sBAAsB,CAAA;IAE5B,MAAM,CAAA;gBACQ,IAAI,CAAA;;;GAGjB,CAAA;AACH,CAAC;AAED,UAAU,0BAA0B,CAAC,EAAE,GAAG,EAAE,IAAI,EAAoB,EAAA;IAClE,OAAO,KAAK,CAAC;AACX,QAAA,WAAW,EAAE,CAAA,wDAAA,EAA2D,GAAG,CAAC,IAAI,CAAkB,gBAAA,CAAA;AAClG,QAAA,MAAM,EAAE;AACN,YAAA,IAAI,EAAE,CAAiC,+BAAA,CAAA;AACxC,SAAA;AACD,QAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,KAAA,CAAC,CAAA;IACF,MAAM,CAAA,8CAAA,EAAiD,IAAI,CAAA,kCAAA,CAAoC,CAAA;AAC/F,IAAA,MAAM,OAAO,CAAA;AACf,CAAC;AAED,UAAU,qBAAqB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,2BAA2B,EAAE,SAAS,EAAoB,EAAA;AACjH,IAAA,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE;QAChC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,CAAA;QACtD,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAA;QACpE,MAAM,UAAU,GAAG,SAAS,CAAC,wBAAwB,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC,CAAA;;QAE7F,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC;YAAE,SAAQ;QAEzD,OAAO,KAAK,CAAC;YACX,WAAW,EAAE,CAAa,UAAA,EAAA,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,CAAc,YAAA,CAAA;YAC5E,cAAc,EAAE,MAAM,CAAC,IAAI;AAC3B,YAAA,MAAM,EAAE;AACN,gBAAA,IAAI,EAAE,CAAqC,mCAAA,CAAA;AAC3C,gBAAA,MAAM,EAAE,CAAwC,sCAAA,CAAA;AACjD,aAAA;AACD,YAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,SAAA,CAAC,CAAA;AACF,QAAA,MAAM,GAAG,UAAU,CAAA,qBAAA,EAAwB,IAAI,CAAA,aAAA,EAAgB,aAAa,CAAQ,KAAA,EAAA,IAAI,CAAkB,eAAA,EAAA,aAAa,SAAS,IAAI,CAAA,uBAAA,EAA0B,IAAI,CAAY,SAAA,EAAA,aAAa,kBAAkB,CAAA;AAC7M,QAAA,MAAM,OAAO,CAAA;KACd;AACH,CAAC;AAED,UAAU,+BAA+B,CACvC,EAAE,GAAG,EAAE,2BAA2B,EAAE,IAAI,EAAE,SAAS,EAAoB,EACvE,WAAmB,EACnB,OAAmB,EACnB,IAA2D,EAC3D,kBAA4B,EAAA;AAE5B,IAAA,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,OAAO,KAAK,CAAC,kBAAkB,IAAI,CAAA,QAAA,CAAU,CAAC,CAAA;QAC9C,MAAM,CAAA,SAAA,EAAY,IAAI,CAAA,GAAA,CAAK,CAAA;AAC3B,QAAA,MAAM,SAAS,CAAA;AACf,QAAA,KAAK,MAAM,SAAS,IAAI,OAAO,EAAE;AAC/B,YAAA,MAAM,UAAU,GAAG,IAAI,KAAK,QAAQ,GAAG,0BAA0B,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,SAAS,CAAA;AAC7F,YAAA,IAAI,SAAS,KAAK,SAAS,EAAE;gBAC3B,OAAO,KAAK,CAAC;oBACX,WAAW,EAAE,CAAG,EAAA,WAAW,CAAqB,mBAAA,CAAA;AAChD,oBAAA,MAAM,EAAE;AACN,wBAAA,IAAI,EAAE,CAAiC,+BAAA,CAAA;AACxC,qBAAA;AACD,oBAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,iBAAA,CAAC,CAAA;gBACF,MAAM,CAAA,WAAA,EAAc,UAAU,EAAE,UAAU,KAAK,KAAK,GAAG,GAAG,GAAG,EAAE,CAAA,0BAAA,EACP,EACxD,CAAA,GAAA,EAAM,IAAI,CAAA,kCAAA,CAAoC,CAAA;aAC/C;iBAAM;AACL,gBAAA,MAAM,UAAU,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAA;gBACzD,OAAO,KAAK,CAAC;AACX,oBAAA,WAAW,EAAE,CAAA,EAAG,WAAW,CAAA,WAAA,EAAc,SAAS,CAAc,YAAA,CAAA;AAChE,oBAAA,MAAM,EAAE;AACN,wBAAA,IAAI,EAAE,CAA2C,yCAAA,CAAA;AACjD,wBAAA,MAAM,EAAE,CAAwC,sCAAA,CAAA;AACjD,qBAAA;AACD,oBAAA,OAAO,EAAE,CAA+H,6HAAA,CAAA;AACzI,iBAAA,CAAC,CAAA;gBACF,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAA;AACpE,gBAAA,MAAM,CAAG,EAAA,SAAS,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAA,OAAA,EACrD,UAAU,EAAE,UAAU,KAAK,KAAK,GAAG,GAAG,GAAG,EAC3C,CAAA,aAAA,EAAgB,IAAI,CAAA,aAAA,EAAgB,aAAa,CAAA,KAAA,EAAQ,IAAI,CAAA,eAAA,EAAkB,aAAa,CAAM,GAAA,EAAuD,EAAE,CACzJ,EAAA,UAAU,EAAE,IAAI,GAAG,CAAA,GAAA,EAAM,UAAU,CAAC,IAAI,CAAA,CAAE,GAAG,EAC/C,CAAM,GAAA,EAAA,IAAI,CAA0B,uBAAA,EAAA,IAAI,CAAY,SAAA,EAAA,aAAa,kBAAkB,CAAA;aACpF;SACF;AACD,QAAA,MAAM,sBAAsB,CAAA;AAC5B,QAAA,MAAM,OAAO,CAAA;KACd;AACH;;;;"}

package/client/imports.js

@@ -17,7 +17,7 @@ function* imports() {
       CloneAppClientParams,
     } from '@algorandfoundation/algokit-utils/types/app-client'
     import { AppFactory, AppFactoryAppClientParams, AppFactoryResolveAppClientByCreatorAndNameParams, AppFactoryDeployParams, AppFactoryParams, CreateSchema } from '@algorandfoundation/algokit-utils/types/app-factory'
-    import AlgoKitComposer, { AppCallMethodCall, AppMethodCallTransactionArgument, SimulateOptions } from '@algorandfoundation/algokit-utils/types/composer'
+    import { TransactionComposer, AppCallMethodCall, AppMethodCallTransactionArgument, SimulateOptions } from '@algorandfoundation/algokit-utils/types/composer'
     import { SendParams, SendSingleTransactionResult, SendAtomicTransactionComposerResults } from '@algorandfoundation/algokit-utils/types/transaction'
     import { modelsv2, OnApplicationComplete, Transaction, TransactionSigner } from 'algosdk'
     import SimulateResponse = modelsv2.SimulateResponse

package/client/imports.js.map

@@ -1 +1 @@
-{"version":3,"file":"imports.js","sources":["../../src/client/imports.ts"],"sourcesContent":["import { DocumentParts } from '../output/writer'\n\nexport function* imports(): DocumentParts {\n  yield `\n    import { AlgorandClientInterface } from '@algorandfoundation/algokit-utils/types/algorand-client-interface'\n    import { ABIReturn, AppReturn, SendAppTransactionResult } from '@algorandfoundation/algokit-utils/types/app'\n    import { Arc56Contract, getArc56ReturnValue, getABIStructFromABITuple } from '@algorandfoundation/algokit-utils/types/app-arc56'\n    import {\n      AppClient,\n      AppClientMethodCallParams,\n      AppClientParams,\n      AppClientBareCallParams,\n      CallOnComplete,\n      AppClientCompilationParams,\n      ResolveAppClientByCreatorAndName,\n      ResolveAppClientByNetwork,\n      CloneAppClientParams,\n    } from '@algorandfoundation/algokit-utils/types/app-client'\n    import { AppFactory, AppFactoryAppClientParams, AppFactoryResolveAppClientByCreatorAndNameParams, AppFactoryDeployParams, AppFactoryParams, CreateSchema } from '@algorandfoundation/algokit-utils/types/app-factory'\n    import AlgoKitComposer, { AppCallMethodCall, AppMethodCallTransactionArgument, SimulateOptions } from '@algorandfoundation/algokit-utils/types/composer'\n    import { SendParams, SendSingleTransactionResult, SendAtomicTransactionComposerResults } from '@algorandfoundation/algokit-utils/types/transaction'\n    import { modelsv2, OnApplicationComplete, Transaction, TransactionSigner } from 'algosdk'\n    import SimulateResponse = modelsv2.SimulateResponse\n  `\n}\n"],"names":[],"mappings":";;AAEM,UAAW,OAAO,GAAA;IACtB,MAAM,CAAA;;;;;;;;;;;;;;;;;;;;GAoBL,CAAA;AACH;;;;"}
+{"version":3,"file":"imports.js","sources":["../../src/client/imports.ts"],"sourcesContent":["import { DocumentParts } from '../output/writer'\n\nexport function* imports(): DocumentParts {\n  yield `\n    import { AlgorandClientInterface } from '@algorandfoundation/algokit-utils/types/algorand-client-interface'\n    import { ABIReturn, AppReturn, SendAppTransactionResult } from '@algorandfoundation/algokit-utils/types/app'\n    import { Arc56Contract, getArc56ReturnValue, getABIStructFromABITuple } from '@algorandfoundation/algokit-utils/types/app-arc56'\n    import {\n      AppClient,\n      AppClientMethodCallParams,\n      AppClientParams,\n      AppClientBareCallParams,\n      CallOnComplete,\n      AppClientCompilationParams,\n      ResolveAppClientByCreatorAndName,\n      ResolveAppClientByNetwork,\n      CloneAppClientParams,\n    } from '@algorandfoundation/algokit-utils/types/app-client'\n    import { AppFactory, AppFactoryAppClientParams, AppFactoryResolveAppClientByCreatorAndNameParams, AppFactoryDeployParams, AppFactoryParams, CreateSchema } from '@algorandfoundation/algokit-utils/types/app-factory'\n    import { TransactionComposer, AppCallMethodCall, AppMethodCallTransactionArgument, SimulateOptions } from '@algorandfoundation/algokit-utils/types/composer'\n    import { SendParams, SendSingleTransactionResult, SendAtomicTransactionComposerResults } from '@algorandfoundation/algokit-utils/types/transaction'\n    import { modelsv2, OnApplicationComplete, Transaction, TransactionSigner } from 'algosdk'\n    import SimulateResponse = modelsv2.SimulateResponse\n  `\n}\n"],"names":[],"mappings":";;AAEM,UAAW,OAAO,GAAA;IACtB,MAAM,CAAA;;;;;;;;;;;;;;;;;;;;GAoBL,CAAA;AACH;;;;"}

package/client/imports.mjs

@@ -15,7 +15,7 @@ function* imports() {
       CloneAppClientParams,
     } from '@algorandfoundation/algokit-utils/types/app-client'
     import { AppFactory, AppFactoryAppClientParams, AppFactoryResolveAppClientByCreatorAndNameParams, AppFactoryDeployParams, AppFactoryParams, CreateSchema } from '@algorandfoundation/algokit-utils/types/app-factory'
-    import AlgoKitComposer, { AppCallMethodCall, AppMethodCallTransactionArgument, SimulateOptions } from '@algorandfoundation/algokit-utils/types/composer'
+    import { TransactionComposer, AppCallMethodCall, AppMethodCallTransactionArgument, SimulateOptions } from '@algorandfoundation/algokit-utils/types/composer'
     import { SendParams, SendSingleTransactionResult, SendAtomicTransactionComposerResults } from '@algorandfoundation/algokit-utils/types/transaction'
     import { modelsv2, OnApplicationComplete, Transaction, TransactionSigner } from 'algosdk'
     import SimulateResponse = modelsv2.SimulateResponse

package/client/imports.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"imports.mjs","sources":["../../src/client/imports.ts"],"sourcesContent":["import { DocumentParts } from '../output/writer'\n\nexport function* imports(): DocumentParts {\n  yield `\n    import { AlgorandClientInterface } from '@algorandfoundation/algokit-utils/types/algorand-client-interface'\n    import { ABIReturn, AppReturn, SendAppTransactionResult } from '@algorandfoundation/algokit-utils/types/app'\n    import { Arc56Contract, getArc56ReturnValue, getABIStructFromABITuple } from '@algorandfoundation/algokit-utils/types/app-arc56'\n    import {\n      AppClient,\n      AppClientMethodCallParams,\n      AppClientParams,\n      AppClientBareCallParams,\n      CallOnComplete,\n      AppClientCompilationParams,\n      ResolveAppClientByCreatorAndName,\n      ResolveAppClientByNetwork,\n      CloneAppClientParams,\n    } from '@algorandfoundation/algokit-utils/types/app-client'\n    import { AppFactory, AppFactoryAppClientParams, AppFactoryResolveAppClientByCreatorAndNameParams, AppFactoryDeployParams, AppFactoryParams, CreateSchema } from '@algorandfoundation/algokit-utils/types/app-factory'\n    import AlgoKitComposer, { AppCallMethodCall, AppMethodCallTransactionArgument, SimulateOptions } from '@algorandfoundation/algokit-utils/types/composer'\n    import { SendParams, SendSingleTransactionResult, SendAtomicTransactionComposerResults } from '@algorandfoundation/algokit-utils/types/transaction'\n    import { modelsv2, OnApplicationComplete, Transaction, TransactionSigner } from 'algosdk'\n    import SimulateResponse = modelsv2.SimulateResponse\n  `\n}\n"],"names":[],"mappings":"AAEM,UAAW,OAAO,GAAA;IACtB,MAAM,CAAA;;;;;;;;;;;;;;;;;;;;GAoBL,CAAA;AACH;;;;"}
+{"version":3,"file":"imports.mjs","sources":["../../src/client/imports.ts"],"sourcesContent":["import { DocumentParts } from '../output/writer'\n\nexport function* imports(): DocumentParts {\n  yield `\n    import { AlgorandClientInterface } from '@algorandfoundation/algokit-utils/types/algorand-client-interface'\n    import { ABIReturn, AppReturn, SendAppTransactionResult } from '@algorandfoundation/algokit-utils/types/app'\n    import { Arc56Contract, getArc56ReturnValue, getABIStructFromABITuple } from '@algorandfoundation/algokit-utils/types/app-arc56'\n    import {\n      AppClient,\n      AppClientMethodCallParams,\n      AppClientParams,\n      AppClientBareCallParams,\n      CallOnComplete,\n      AppClientCompilationParams,\n      ResolveAppClientByCreatorAndName,\n      ResolveAppClientByNetwork,\n      CloneAppClientParams,\n    } from '@algorandfoundation/algokit-utils/types/app-client'\n    import { AppFactory, AppFactoryAppClientParams, AppFactoryResolveAppClientByCreatorAndNameParams, AppFactoryDeployParams, AppFactoryParams, CreateSchema } from '@algorandfoundation/algokit-utils/types/app-factory'\n    import { TransactionComposer, AppCallMethodCall, AppMethodCallTransactionArgument, SimulateOptions } from '@algorandfoundation/algokit-utils/types/composer'\n    import { SendParams, SendSingleTransactionResult, SendAtomicTransactionComposerResults } from '@algorandfoundation/algokit-utils/types/transaction'\n    import { modelsv2, OnApplicationComplete, Transaction, TransactionSigner } from 'algosdk'\n    import SimulateResponse = modelsv2.SimulateResponse\n  `\n}\n"],"names":[],"mappings":"AAEM,UAAW,OAAO,GAAA;IACtB,MAAM,CAAA;;;;;;;;;;;;;;;;;;;;GAoBL,CAAA;AACH;;;;"}

package/package.json

@@ -6,7 +6,7 @@
     "**"
   ],
   "name": "@algorandfoundation/algokit-client-generator",
-  "version": "4.0.0-beta.7",
+  "version": "4.0.0-beta.9",
   "description": "Generates a TypeScript client for interacting with, and deploying ARC-0032 smart contracts on the Algorand Blockchain.",
   "module": "index.mjs",
   "private": false,
@@ -26,7 +26,7 @@
     "rollup": "^4.22.5"
   },
   "dependencies": {
-    "@algorandfoundation/algokit-utils": "^7.0.0-beta.20",
+    "@algorandfoundation/algokit-utils": "^7.0.0-beta.23",
     "algosdk": "^2.7.0",
     "chalk": "^4.1.2",
     "change-case": "^5.4.4",

package/schema/arc56.schema.json.js

@@ -27,6 +27,9 @@ var definitions = {
 							type: "string"
 						}
 					},
+					required: [
+						"type"
+					],
 					type: "object"
 				},
 				type: "array"
@@ -40,6 +43,10 @@ var definitions = {
 				type: "string"
 			}
 		},
+		required: [
+			"name",
+			"args"
+		],
 		type: "object"
 	},
 	Method: {
@@ -114,6 +121,10 @@ var definitions = {
 									type: "string"
 								}
 							},
+							required: [
+								"source",
+								"data"
+							],
 							type: "object"
 						},
 						desc: {
@@ -133,6 +144,9 @@ var definitions = {
 							type: "string"
 						}
 					},
+					required: [
+						"type"
+					],
 					type: "object"
 				},
 				type: "array"
@@ -200,6 +214,11 @@ var definitions = {
 								type: "number"
 							}
 						},
+						required: [
+							"key",
+							"readBytes",
+							"writeBytes"
+						],
 						type: "object"
 					},
 					innerTransactionCount: {
@@ -225,9 +244,18 @@ var definitions = {
 						type: "string"
 					}
 				},
+				required: [
+					"type"
+				],
 				type: "object"
 			}
 		},
+		required: [
+			"name",
+			"args",
+			"returns",
+			"actions"
+		],
 		type: "object"
 	},
 	ProgramSourceInfo: {
@@ -248,6 +276,10 @@ var definitions = {
 				type: "array"
 			}
 		},
+		required: [
+			"pcOffsetMethod",
+			"sourceInfo"
+		],
 		type: "object"
 	},
 	SourceInfo: {
@@ -272,6 +304,9 @@ var definitions = {
 				type: "number"
 			}
 		},
+		required: [
+			"pc"
+		],
 		type: "object"
 	},
 	StorageKey: {
@@ -294,6 +329,11 @@ var definitions = {
 				type: "string"
 			}
 		},
+		required: [
+			"key",
+			"keyType",
+			"valueType"
+		],
 		type: "object"
 	},
 	StorageMap: {
@@ -316,6 +356,10 @@ var definitions = {
 				type: "string"
 			}
 		},
+		required: [
+			"keyType",
+			"valueType"
+		],
 		type: "object"
 	},
 	StructField: {
@@ -340,13 +384,17 @@ var definitions = {
 				description: "The type of the struct field's value"
 			}
 		},
+		required: [
+			"name",
+			"type"
+		],
 		type: "object"
 	}
 };
 var description = "Describes the entire contract. This interface is an extension of the interface described in ARC-4";
 var properties = {
 	arcs: {
-		description: "The ARCs used and/or supported by this contract. All contracts implicity support ARC4 and ARC56",
+		description: "The ARCs used and/or supported by this contract. All contracts implicitly support ARC4 and ARC56",
 		items: {
 			type: "number"
 		},
@@ -383,6 +431,10 @@ var properties = {
 				type: "array"
 			}
 		},
+		required: [
+			"create",
+			"call"
+		],
 		type: "object"
 	},
 	byteCode: {
@@ -397,6 +449,10 @@ var properties = {
 				type: "string"
 			}
 		},
+		required: [
+			"approval",
+			"clear"
+		],
 		type: "object"
 	},
 	compilerInfo: {
@@ -429,6 +485,10 @@ var properties = {
 				type: "object"
 			}
 		},
+		required: [
+			"compiler",
+			"compilerVersion"
+		],
 		type: "object"
 	},
 	desc: {
@@ -461,9 +521,12 @@ var properties = {
 					type: "number"
 				}
 			},
+			required: [
+				"appID"
+			],
 			type: "object"
 		},
-		description: "Optional object listing the contract instances across different networks.\nThe key is the base64 genesis hash of the network, and the value contains\ninformation about the deployed contract in the network indicated by the\nkey. A key containing the human-readable name of the network MAY be\nincluded, but the corresponding genesis hash key MUST also be define",
+		description: "Optional object listing the contract instances across different networks.\nThe key is the base64 genesis hash of the network, and the value contains\ninformation about the deployed contract in the network indicated by the\nkey. A key containing the human-readable name of the network MAY be\nincluded, but the corresponding genesis hash key MUST also be defined",
 		type: "object"
 	},
 	scratchVariables: {
@@ -476,6 +539,10 @@ var properties = {
 					type: "string"
 				}
 			},
+			required: [
+				"slot",
+				"type"
+			],
 			type: "object"
 		},
 		description: "The scratch variables used during runtime",
@@ -493,6 +560,10 @@ var properties = {
 				type: "string"
 			}
 		},
+		required: [
+			"approval",
+			"clear"
+		],
 		type: "object"
 	},
 	sourceInfo: {
@@ -507,6 +578,10 @@ var properties = {
 				description: "Clear program information"
 			}
 		},
+		required: [
+			"approval",
+			"clear"
+		],
 		type: "object"
 	},
 	state: {
@@ -533,6 +608,11 @@ var properties = {
 						type: "object"
 					}
 				},
+				required: [
+					"box",
+					"global",
+					"local"
+				],
 				type: "object"
 			},
 			maps: {
@@ -557,6 +637,11 @@ var properties = {
 						type: "object"
 					}
 				},
+				required: [
+					"box",
+					"global",
+					"local"
+				],
 				type: "object"
 			},
 			schema: {
@@ -571,6 +656,10 @@ var properties = {
 								type: "number"
 							}
 						},
+						required: [
+							"bytes",
+							"ints"
+						],
 						type: "object"
 					},
 					local: {
@@ -582,12 +671,25 @@ var properties = {
 								type: "number"
 							}
 						},
+						required: [
+							"bytes",
+							"ints"
+						],
 						type: "object"
 					}
 				},
+				required: [
+					"global",
+					"local"
+				],
 				type: "object"
 			}
 		},
+		required: [
+			"keys",
+			"maps",
+			"schema"
+		],
 		type: "object"
 	},
 	structs: {
@@ -597,7 +699,7 @@ var properties = {
 			},
 			type: "array"
 		},
-		description: "Named structs use by the application. Each struct field appears in the same order as ABI encoding.",
+		description: "Named structs used by the application. Each struct field appears in the same order as ABI encoding.",
 		type: "object"
 	},
 	templateVariables: {
@@ -608,22 +710,34 @@ var properties = {
 					type: "string"
 				},
 				value: {
-					description: "If given, the the base64 encoded value used for the given app/program",
+					description: "If given, the base64 encoded value used for the given app/program",
 					type: "string"
 				}
 			},
+			required: [
+				"type"
+			],
 			type: "object"
 		},
-		description: "A mapping of template variable names as they appear in the teal (not including TMPL_ prefix) to their respecive types and values (if applicable)",
+		description: "A mapping of template variable names as they appear in the TEAL (not including TMPL_ prefix) to their respecive types and values (if applicable)",
 		type: "object"
 	}
 };
+var required = [
+	"arcs",
+	"name",
+	"structs",
+	"methods",
+	"state",
+	"bareActions"
+];
 var type = "object";
 var arc56Schema = {
 	$schema: $schema,
 	definitions: definitions,
 	description: description,
 	properties: properties,
+	required: required,
 	type: type
 };
 
@@ -632,5 +746,6 @@ exports.default = arc56Schema;
 exports.definitions = definitions;
 exports.description = description;
 exports.properties = properties;
+exports.required = required;
 exports.type = type;
 //# sourceMappingURL=arc56.schema.json.js.map

package/schema/arc56.schema.json.js.map

@@ -1 +1 @@
-{"version":3,"file":"arc56.schema.json.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"arc56.schema.json.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/schema/arc56.schema.json.mjs

@@ -23,6 +23,9 @@ var definitions = {
 							type: "string"
 						}
 					},
+					required: [
+						"type"
+					],
 					type: "object"
 				},
 				type: "array"
@@ -36,6 +39,10 @@ var definitions = {
 				type: "string"
 			}
 		},
+		required: [
+			"name",
+			"args"
+		],
 		type: "object"
 	},
 	Method: {
@@ -110,6 +117,10 @@ var definitions = {
 									type: "string"
 								}
 							},
+							required: [
+								"source",
+								"data"
+							],
 							type: "object"
 						},
 						desc: {
@@ -129,6 +140,9 @@ var definitions = {
 							type: "string"
 						}
 					},
+					required: [
+						"type"
+					],
 					type: "object"
 				},
 				type: "array"
@@ -196,6 +210,11 @@ var definitions = {
 								type: "number"
 							}
 						},
+						required: [
+							"key",
+							"readBytes",
+							"writeBytes"
+						],
 						type: "object"
 					},
 					innerTransactionCount: {
@@ -221,9 +240,18 @@ var definitions = {
 						type: "string"
 					}
 				},
+				required: [
+					"type"
+				],
 				type: "object"
 			}
 		},
+		required: [
+			"name",
+			"args",
+			"returns",
+			"actions"
+		],
 		type: "object"
 	},
 	ProgramSourceInfo: {
@@ -244,6 +272,10 @@ var definitions = {
 				type: "array"
 			}
 		},
+		required: [
+			"pcOffsetMethod",
+			"sourceInfo"
+		],
 		type: "object"
 	},
 	SourceInfo: {
@@ -268,6 +300,9 @@ var definitions = {
 				type: "number"
 			}
 		},
+		required: [
+			"pc"
+		],
 		type: "object"
 	},
 	StorageKey: {
@@ -290,6 +325,11 @@ var definitions = {
 				type: "string"
 			}
 		},
+		required: [
+			"key",
+			"keyType",
+			"valueType"
+		],
 		type: "object"
 	},
 	StorageMap: {
@@ -312,6 +352,10 @@ var definitions = {
 				type: "string"
 			}
 		},
+		required: [
+			"keyType",
+			"valueType"
+		],
 		type: "object"
 	},
 	StructField: {
@@ -336,13 +380,17 @@ var definitions = {
 				description: "The type of the struct field's value"
 			}
 		},
+		required: [
+			"name",
+			"type"
+		],
 		type: "object"
 	}
 };
 var description = "Describes the entire contract. This interface is an extension of the interface described in ARC-4";
 var properties = {
 	arcs: {
-		description: "The ARCs used and/or supported by this contract. All contracts implicity support ARC4 and ARC56",
+		description: "The ARCs used and/or supported by this contract. All contracts implicitly support ARC4 and ARC56",
 		items: {
 			type: "number"
 		},
@@ -379,6 +427,10 @@ var properties = {
 				type: "array"
 			}
 		},
+		required: [
+			"create",
+			"call"
+		],
 		type: "object"
 	},
 	byteCode: {
@@ -393,6 +445,10 @@ var properties = {
 				type: "string"
 			}
 		},
+		required: [
+			"approval",
+			"clear"
+		],
 		type: "object"
 	},
 	compilerInfo: {
@@ -425,6 +481,10 @@ var properties = {
 				type: "object"
 			}
 		},
+		required: [
+			"compiler",
+			"compilerVersion"
+		],
 		type: "object"
 	},
 	desc: {
@@ -457,9 +517,12 @@ var properties = {
 					type: "number"
 				}
 			},
+			required: [
+				"appID"
+			],
 			type: "object"
 		},
-		description: "Optional object listing the contract instances across different networks.\nThe key is the base64 genesis hash of the network, and the value contains\ninformation about the deployed contract in the network indicated by the\nkey. A key containing the human-readable name of the network MAY be\nincluded, but the corresponding genesis hash key MUST also be define",
+		description: "Optional object listing the contract instances across different networks.\nThe key is the base64 genesis hash of the network, and the value contains\ninformation about the deployed contract in the network indicated by the\nkey. A key containing the human-readable name of the network MAY be\nincluded, but the corresponding genesis hash key MUST also be defined",
 		type: "object"
 	},
 	scratchVariables: {
@@ -472,6 +535,10 @@ var properties = {
 					type: "string"
 				}
 			},
+			required: [
+				"slot",
+				"type"
+			],
 			type: "object"
 		},
 		description: "The scratch variables used during runtime",
@@ -489,6 +556,10 @@ var properties = {
 				type: "string"
 			}
 		},
+		required: [
+			"approval",
+			"clear"
+		],
 		type: "object"
 	},
 	sourceInfo: {
@@ -503,6 +574,10 @@ var properties = {
 				description: "Clear program information"
 			}
 		},
+		required: [
+			"approval",
+			"clear"
+		],
 		type: "object"
 	},
 	state: {
@@ -529,6 +604,11 @@ var properties = {
 						type: "object"
 					}
 				},
+				required: [
+					"box",
+					"global",
+					"local"
+				],
 				type: "object"
 			},
 			maps: {
@@ -553,6 +633,11 @@ var properties = {
 						type: "object"
 					}
 				},
+				required: [
+					"box",
+					"global",
+					"local"
+				],
 				type: "object"
 			},
 			schema: {
@@ -567,6 +652,10 @@ var properties = {
 								type: "number"
 							}
 						},
+						required: [
+							"bytes",
+							"ints"
+						],
 						type: "object"
 					},
 					local: {
@@ -578,12 +667,25 @@ var properties = {
 								type: "number"
 							}
 						},
+						required: [
+							"bytes",
+							"ints"
+						],
 						type: "object"
 					}
 				},
+				required: [
+					"global",
+					"local"
+				],
 				type: "object"
 			}
 		},
+		required: [
+			"keys",
+			"maps",
+			"schema"
+		],
 		type: "object"
 	},
 	structs: {
@@ -593,7 +695,7 @@ var properties = {
 			},
 			type: "array"
 		},
-		description: "Named structs use by the application. Each struct field appears in the same order as ABI encoding.",
+		description: "Named structs used by the application. Each struct field appears in the same order as ABI encoding.",
 		type: "object"
 	},
 	templateVariables: {
@@ -604,24 +706,36 @@ var properties = {
 					type: "string"
 				},
 				value: {
-					description: "If given, the the base64 encoded value used for the given app/program",
+					description: "If given, the base64 encoded value used for the given app/program",
 					type: "string"
 				}
 			},
+			required: [
+				"type"
+			],
 			type: "object"
 		},
-		description: "A mapping of template variable names as they appear in the teal (not including TMPL_ prefix) to their respecive types and values (if applicable)",
+		description: "A mapping of template variable names as they appear in the TEAL (not including TMPL_ prefix) to their respecive types and values (if applicable)",
 		type: "object"
 	}
 };
+var required = [
+	"arcs",
+	"name",
+	"structs",
+	"methods",
+	"state",
+	"bareActions"
+];
 var type = "object";
 var arc56Schema = {
 	$schema: $schema,
 	definitions: definitions,
 	description: description,
 	properties: properties,
+	required: required,
 	type: type
 };
 
-export { $schema, arc56Schema as default, definitions, description, properties, type };
+export { $schema, arc56Schema as default, definitions, description, properties, required, type };
 //# sourceMappingURL=arc56.schema.json.mjs.map

package/schema/arc56.schema.json.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"arc56.schema.json.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"arc56.schema.json.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}