@algorandfoundation/algokit-client-generator 3.0.6 → 3.1.0-beta.1

package/src/client/call-composer.js

@@ -0,0 +1,135 @@
+'use strict';
+
+var writer = require('../output/writer.js');
+var getCallConfigSummary = require('./helpers/get-call-config-summary.js');
+var deployTypes = require('./deploy-types.js');
+var algosdk = require('algosdk');
+
+function* composeMethod(ctx) {
+    const { name, callConfig } = ctx;
+    yield `public newGroup(): ${name}Composer {`;
+    yield writer.IncIndent;
+    yield `const client = this`;
+    yield `const composer = client.appClient.newGroup()`;
+    yield `const resultMappers: Array<undefined | ((x: ABIReturn | undefined) => any)> = []`;
+    yield `return {`;
+    yield writer.IncIndent;
+    yield* callComposerNoops(ctx);
+    // This is async and unless we bring back promiseChain (which is possible) it's not a nice
+    //  experience to expose update method(s)
+    //yield* callComposerOperationMethods(ctx, callConfig.updateMethods, 'update', true)
+    yield* callComposerOperationMethods(ctx, callConfig.deleteMethods, 'delete');
+    yield* callComposerOperationMethods(ctx, callConfig.optInMethods, 'optIn');
+    yield* callComposerOperationMethods(ctx, callConfig.closeOutMethods, 'closeOut');
+    yield* callComposerClearState(ctx);
+    yield `addTransaction(txn: Transaction, signer?: TransactionSigner) {`;
+    yield writer.IncIndent;
+    yield 'composer.addTransaction(txn, signer)';
+    yield 'return this';
+    yield writer.DecIndent;
+    yield '},';
+    yield `composer() {`;
+    yield writer.IncIndent;
+    yield 'return composer';
+    yield writer.DecIndent;
+    yield '},';
+    yield `async simulate(options?: SimulateOptions) {`;
+    yield writer.IncIndent;
+    yield `const result = await composer.simulate(options)`;
+    yield `return {`;
+    yield writer.IncIndent;
+    yield `...result,`;
+    yield `returns: result.returns?.map((val, i) => resultMappers[i] !== undefined ? resultMappers[i]!(val) : val.returnValue)`;
+    yield writer.DecIndentAndCloseBlock;
+    yield writer.DecIndent;
+    yield '},';
+    yield `async execute(params?: ExecuteParams) {`;
+    yield writer.IncIndent;
+    yield `const result = await composer.execute(params)`;
+    yield `return {`;
+    yield writer.IncIndent;
+    yield `...result,`;
+    yield `returns: result.returns?.map((val, i) => resultMappers[i] !== undefined ? resultMappers[i]!(val) : val.returnValue)`;
+    yield writer.DecIndentAndCloseBlock;
+    yield writer.DecIndentAndCloseBlock;
+    yield writer.DecIndent;
+    yield `} as unknown as ${name}Composer`;
+    yield writer.DecIndentAndCloseBlock;
+}
+function* callComposerNoops({ app, callConfig, methodSignatureToUniqueName, sanitizer }) {
+    if (callConfig.callMethods.includes(getCallConfigSummary.BARE_CALL)) {
+        yield* writer.jsDoc(`Add a bare method call to the ${app.name} contract`);
+        yield `bare(params: AppClientBareCallParams & ${deployTypes.getCallOnCompleteOptions(getCallConfigSummary.BARE_CALL, app).type}) {`;
+        yield writer.IncIndent;
+        yield `composer.addAppCall(client.params.bare(params))`;
+        yield `return this`;
+        yield writer.DecIndent;
+        yield '},';
+    }
+    for (const methodSignature of callConfig.callMethods.filter((m) => m !== getCallConfigSummary.BARE_CALL).map((m) => m)) {
+        const methodName = sanitizer.makeSafeMethodIdentifier(methodSignatureToUniqueName[methodSignature]);
+        const methodSignatureSafe = sanitizer.makeSafeStringTypeLiteral(methodSignature);
+        const methodNameAccessor = sanitizer.getSafeMemberAccessor(methodName);
+        // Skip methods which don't support a no_op call config
+        if (!callConfig.callMethods.includes(methodSignature))
+            continue;
+        yield* writer.jsDoc(`Add a ${methodSignature} method call against the ${app.name} contract`);
+        yield `${methodName}(params: CallParams<'${methodSignatureSafe}'> & ${deployTypes.getCallOnCompleteOptions(methodSignature, app).type}) {`;
+        yield writer.IncIndent;
+        yield `composer.addAppCallMethodCall(client.params${methodNameAccessor}(params))`;
+        const outputTypeName = app.methods.find((m) => new algosdk.ABIMethod(m).getSignature() === methodSignature)?.returns.type;
+        yield `resultMappers.push(${outputTypeName && outputTypeName !== 'void' ? `(v) => client.decodeReturnValue('${methodSignatureSafe}', v)` : 'undefined'})`;
+        yield `return this`;
+        yield writer.DecIndent;
+        yield '},';
+    }
+}
+function* callComposerClearState({ app }) {
+    yield* writer.jsDoc(`Add a clear state call to the ${app.name} contract`);
+    yield `clearState(params: AppClientBareCallParams) {`;
+    yield writer.IncIndent;
+    yield `composer.addAppCall(client.params.clearState(params))`;
+    yield `return this`;
+    yield writer.DecIndent;
+    yield '},';
+}
+function* callComposerOperationMethods({ app, methodSignatureToUniqueName, sanitizer }, methods, verb, includeCompilation) {
+    const callType = verb === 'update' ? 'Update' : verb === 'delete' ? 'Delete' : 'Call';
+    if (methods.length) {
+        yield `get ${verb}() {`;
+        yield writer.IncIndent;
+        yield `const $this = this`;
+        yield `return {`;
+        yield writer.IncIndent;
+        for (const methodSig of methods) {
+            if (methodSig === getCallConfigSummary.BARE_CALL) {
+                yield `bare(params?: AppClientBareCallParams ${''}) {`;
+                yield writer.IncIndent;
+                yield `composer.addApp${callType}(client.params.${verb}.bare(params))`;
+                yield `return $this`;
+                yield writer.DecIndent;
+                yield '},';
+            }
+            else {
+                const uniqueName = methodSignatureToUniqueName[methodSig];
+                const methodName = sanitizer.makeSafeMethodIdentifier(uniqueName);
+                const methodNameAccessor = sanitizer.getSafeMemberAccessor(methodName);
+                const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(methodSig);
+                yield `${methodName}(params: CallParams<'${methodSigSafe}'>${''}) {`;
+                yield writer.IncIndent;
+                yield `composer.addApp${callType}MethodCall(client.params.${verb}${methodNameAccessor}(params))`;
+                const outputTypeName = app.methods.find((m) => new algosdk.ABIMethod(m).getSignature() === methodSig)?.returns.type;
+                yield `resultMappers.push(${outputTypeName && outputTypeName !== 'void' ? `(v) => client.decodeReturnValue('${methodSigSafe}', v)` : 'undefined'})`;
+                yield `return $this`;
+                yield writer.DecIndent;
+                yield '},';
+            }
+        }
+        yield writer.DecIndentAndCloseBlock;
+        yield writer.DecIndent;
+        yield '},';
+    }
+}
+
+exports.composeMethod = composeMethod;
+//# sourceMappingURL=call-composer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"call-composer.js","sources":["../../../src/client/call-composer.ts"],"sourcesContent":["import { DecIndent, DecIndentAndCloseBlock, DocumentParts, IncIndent, jsDoc } from '../output/writer'\nimport { GeneratorContext } from './generator-context'\nimport { BARE_CALL, MethodList } from './helpers/get-call-config-summary'\nimport { getCallOnCompleteOptions } from './deploy-types'\nimport { ABIMethod, ABIMethodParams } from 'algosdk'\n\nexport function* composeMethod(ctx: GeneratorContext): DocumentParts {\n  const { name, callConfig } = ctx\n  yield `public newGroup(): ${name}Composer {`\n  yield IncIndent\n\n  yield `const client = this`\n  yield `const composer = client.appClient.newGroup()`\n  yield `const resultMappers: Array<undefined | ((x: ABIReturn | undefined) => any)> = []`\n  yield `return {`\n  yield IncIndent\n\n  yield* callComposerNoops(ctx)\n  // This is async and unless we bring back promiseChain (which is possible) it's not a nice\n  //  experience to expose update method(s)\n  //yield* callComposerOperationMethods(ctx, callConfig.updateMethods, 'update', true)\n  yield* callComposerOperationMethods(ctx, callConfig.deleteMethods, 'delete')\n  yield* callComposerOperationMethods(ctx, callConfig.optInMethods, 'optIn')\n  yield* callComposerOperationMethods(ctx, callConfig.closeOutMethods, 'closeOut')\n  yield* callComposerClearState(ctx)\n\n  yield `addTransaction(txn: Transaction, signer?: TransactionSigner) {`\n  yield IncIndent\n  yield 'composer.addTransaction(txn, signer)'\n  yield 'return this'\n  yield DecIndent\n  yield '},'\n\n  yield `composer() {`\n  yield IncIndent\n  yield 'return composer'\n  yield DecIndent\n  yield '},'\n\n  yield `async simulate(options?: SimulateOptions) {`\n  yield IncIndent\n  yield `const result = await composer.simulate(options)`\n  yield `return {`\n  yield IncIndent\n  yield `...result,`\n  yield `returns: result.returns?.map((val, i) => resultMappers[i] !== undefined ? resultMappers[i]!(val) : val.returnValue)`\n  yield DecIndentAndCloseBlock\n  yield DecIndent\n  yield '},'\n\n  yield `async execute(params?: ExecuteParams) {`\n  yield IncIndent\n  yield `const result = await composer.execute(params)`\n  yield `return {`\n  yield IncIndent\n  yield `...result,`\n  yield `returns: result.returns?.map((val, i) => resultMappers[i] !== undefined ? resultMappers[i]!(val) : val.returnValue)`\n  yield DecIndentAndCloseBlock\n  yield DecIndentAndCloseBlock\n  yield DecIndent\n  yield `} as unknown as ${name}Composer`\n\n  yield DecIndentAndCloseBlock\n}\n\nfunction* callComposerNoops({ app, callConfig, methodSignatureToUniqueName, sanitizer }: GeneratorContext): DocumentParts {\n  if (callConfig.callMethods.includes(BARE_CALL)) {\n    yield* jsDoc(`Add a bare method call to the ${app.name} contract`)\n    yield `bare(params: AppClientBareCallParams & ${getCallOnCompleteOptions(BARE_CALL, app).type}) {`\n    yield IncIndent\n    yield `composer.addAppCall(client.params.bare(params))`\n    yield `return this`\n    yield DecIndent\n    yield '},'\n  }\n\n  for (const methodSignature of callConfig.callMethods.filter((m) => m !== BARE_CALL).map((m) => m as string)) {\n    const methodName = sanitizer.makeSafeMethodIdentifier(methodSignatureToUniqueName[methodSignature])\n    const methodSignatureSafe = sanitizer.makeSafeStringTypeLiteral(methodSignature)\n    const methodNameAccessor = sanitizer.getSafeMemberAccessor(methodName)\n    // Skip methods which don't support a no_op call config\n    if (!callConfig.callMethods.includes(methodSignature)) continue\n    yield* jsDoc(`Add a ${methodSignature} method call against the ${app.name} contract`)\n    yield `${methodName}(params: CallParams<'${methodSignatureSafe}'> & ${getCallOnCompleteOptions(methodSignature, app).type}) {`\n    yield IncIndent\n    yield `composer.addAppCallMethodCall(client.params${methodNameAccessor}(params))`\n    const outputTypeName = app.methods.find((m: ABIMethodParams) => new ABIMethod(m).getSignature() === methodSignature)?.returns.type\n    yield `resultMappers.push(${outputTypeName && outputTypeName !== 'void' ? `(v) => client.decodeReturnValue('${methodSignatureSafe}', v)` : 'undefined'})`\n    yield `return this`\n    yield DecIndent\n    yield '},'\n  }\n}\n\nfunction* callComposerClearState({ app }: GeneratorContext): DocumentParts {\n  yield* jsDoc(`Add a clear state call to the ${app.name} contract`)\n  yield `clearState(params: AppClientBareCallParams) {`\n  yield IncIndent\n  yield `composer.addAppCall(client.params.clearState(params))`\n  yield `return this`\n  yield DecIndent\n  yield '},'\n}\n\nfunction* callComposerOperationMethods(\n  { app, methodSignatureToUniqueName, sanitizer }: GeneratorContext,\n  methods: MethodList,\n  verb: 'update' | 'optIn' | 'closeOut' | 'delete',\n  includeCompilation?: boolean,\n): DocumentParts {\n  const callType = verb === 'update' ? 'Update' : verb === 'delete' ? 'Delete' : 'Call'\n  if (methods.length) {\n    yield `get ${verb}() {`\n    yield IncIndent\n    yield `const $this = this`\n    yield `return {`\n    yield IncIndent\n    for (const methodSig of methods) {\n      if (methodSig === BARE_CALL) {\n        yield `bare(params?: AppClientBareCallParams ${includeCompilation ? '& AppClientCompilationParams ' : ''}) {`\n        yield IncIndent\n        yield `composer.addApp${callType}(client.params.${verb}.bare(params))`\n        yield `return $this`\n        yield DecIndent\n        yield '},'\n      } else {\n        const uniqueName = methodSignatureToUniqueName[methodSig]\n        const methodName = sanitizer.makeSafeMethodIdentifier(uniqueName)\n        const methodNameAccessor = sanitizer.getSafeMemberAccessor(methodName)\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(methodSig)\n        yield `${methodName}(params: CallParams<'${methodSigSafe}'>${includeCompilation ? ' & AppClientCompilationParams' : ''}) {`\n        yield IncIndent\n        yield `composer.addApp${callType}MethodCall(client.params.${verb}${methodNameAccessor}(params))`\n        const outputTypeName = app.methods.find((m: ABIMethodParams) => new ABIMethod(m).getSignature() === methodSig)?.returns.type\n        yield `resultMappers.push(${outputTypeName && outputTypeName !== 'void' ? `(v) => client.decodeReturnValue('${methodSigSafe}', v)` : 'undefined'})`\n        yield `return $this`\n        yield DecIndent\n        yield '},'\n      }\n    }\n    yield DecIndentAndCloseBlock\n    yield DecIndent\n    yield '},'\n  }\n}\n"],"names":["IncIndent","DecIndent","DecIndentAndCloseBlock","BARE_CALL","jsDoc","getCallOnCompleteOptions","ABIMethod"],"mappings":";;;;;;;AAMe,UAAE,aAAa,CAAC,GAAqB,EAAA;AAClD,IAAA,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,GAAG,CAAA;IAChC,MAAM,CAAA,mBAAA,EAAsB,IAAI,CAAA,UAAA,CAAY,CAAA;AAC5C,IAAA,MAAMA,gBAAS,CAAA;AAEf,IAAA,MAAM,qBAAqB,CAAA;AAC3B,IAAA,MAAM,8CAA8C,CAAA;AACpD,IAAA,MAAM,kFAAkF,CAAA;AACxF,IAAA,MAAM,UAAU,CAAA;AAChB,IAAA,MAAMA,gBAAS,CAAA;AAEf,IAAA,OAAO,iBAAiB,CAAC,GAAG,CAAC,CAAA;;;;AAI7B,IAAA,OAAO,4BAA4B,CAAC,GAAG,EAAE,UAAU,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA;AAC5E,IAAA,OAAO,4BAA4B,CAAC,GAAG,EAAE,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;AAC1E,IAAA,OAAO,4BAA4B,CAAC,GAAG,EAAE,UAAU,CAAC,eAAe,EAAE,UAAU,CAAC,CAAA;AAChF,IAAA,OAAO,sBAAsB,CAAC,GAAG,CAAC,CAAA;AAElC,IAAA,MAAM,gEAAgE,CAAA;AACtE,IAAA,MAAMA,gBAAS,CAAA;AACf,IAAA,MAAM,sCAAsC,CAAA;AAC5C,IAAA,MAAM,aAAa,CAAA;AACnB,IAAA,MAAMC,gBAAS,CAAA;AACf,IAAA,MAAM,IAAI,CAAA;AAEV,IAAA,MAAM,cAAc,CAAA;AACpB,IAAA,MAAMD,gBAAS,CAAA;AACf,IAAA,MAAM,iBAAiB,CAAA;AACvB,IAAA,MAAMC,gBAAS,CAAA;AACf,IAAA,MAAM,IAAI,CAAA;AAEV,IAAA,MAAM,6CAA6C,CAAA;AACnD,IAAA,MAAMD,gBAAS,CAAA;AACf,IAAA,MAAM,iDAAiD,CAAA;AACvD,IAAA,MAAM,UAAU,CAAA;AAChB,IAAA,MAAMA,gBAAS,CAAA;AACf,IAAA,MAAM,YAAY,CAAA;AAClB,IAAA,MAAM,qHAAqH,CAAA;AAC3H,IAAA,MAAME,6BAAsB,CAAA;AAC5B,IAAA,MAAMD,gBAAS,CAAA;AACf,IAAA,MAAM,IAAI,CAAA;AAEV,IAAA,MAAM,yCAAyC,CAAA;AAC/C,IAAA,MAAMD,gBAAS,CAAA;AACf,IAAA,MAAM,+CAA+C,CAAA;AACrD,IAAA,MAAM,UAAU,CAAA;AAChB,IAAA,MAAMA,gBAAS,CAAA;AACf,IAAA,MAAM,YAAY,CAAA;AAClB,IAAA,MAAM,qHAAqH,CAAA;AAC3H,IAAA,MAAME,6BAAsB,CAAA;AAC5B,IAAA,MAAMA,6BAAsB,CAAA;AAC5B,IAAA,MAAMD,gBAAS,CAAA;IACf,MAAM,CAAA,gBAAA,EAAmB,IAAI,CAAA,QAAA,CAAU,CAAA;AAEvC,IAAA,MAAMC,6BAAsB,CAAA;AAC9B,CAAC;AAED,UAAU,iBAAiB,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,2BAA2B,EAAE,SAAS,EAAoB,EAAA;IACvG,IAAI,UAAU,CAAC,WAAW,CAAC,QAAQ,CAACC,8BAAS,CAAC,EAAE;QAC9C,OAAOC,YAAK,CAAC,CAAA,8BAAA,EAAiC,GAAG,CAAC,IAAI,CAAW,SAAA,CAAA,CAAC,CAAA;QAClE,MAAM,CAAA,uCAAA,EAA0CC,oCAAwB,CAACF,8BAAS,EAAE,GAAG,CAAC,CAAC,IAAI,CAAA,GAAA,CAAK,CAAA;AAClG,QAAA,MAAMH,gBAAS,CAAA;AACf,QAAA,MAAM,iDAAiD,CAAA;AACvD,QAAA,MAAM,aAAa,CAAA;AACnB,QAAA,MAAMC,gBAAS,CAAA;AACf,QAAA,MAAM,IAAI,CAAA;KACX;AAED,IAAA,KAAK,MAAM,eAAe,IAAI,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAKE,8BAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAW,CAAC,EAAE;QAC3G,MAAM,UAAU,GAAG,SAAS,CAAC,wBAAwB,CAAC,2BAA2B,CAAC,eAAe,CAAC,CAAC,CAAA;QACnG,MAAM,mBAAmB,GAAG,SAAS,CAAC,yBAAyB,CAAC,eAAe,CAAC,CAAA;QAChF,MAAM,kBAAkB,GAAG,SAAS,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAA;;QAEtE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,eAAe,CAAC;YAAE,SAAQ;AAC/D,QAAA,OAAOC,YAAK,CAAC,CAAS,MAAA,EAAA,eAAe,CAA4B,yBAAA,EAAA,GAAG,CAAC,IAAI,CAAW,SAAA,CAAA,CAAC,CAAA;AACrF,QAAA,MAAM,CAAG,EAAA,UAAU,CAAwB,qBAAA,EAAA,mBAAmB,QAAQC,oCAAwB,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC,IAAI,KAAK,CAAA;AAC9H,QAAA,MAAML,gBAAS,CAAA;QACf,MAAM,CAAA,2CAAA,EAA8C,kBAAkB,CAAA,SAAA,CAAW,CAAA;AACjF,QAAA,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAkB,KAAK,IAAIM,iBAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,eAAe,CAAC,EAAE,OAAO,CAAC,IAAI,CAAA;AAClI,QAAA,MAAM,sBAAsB,cAAc,IAAI,cAAc,KAAK,MAAM,GAAG,CAAA,iCAAA,EAAoC,mBAAmB,CAAO,KAAA,CAAA,GAAG,WAAW,GAAG,CAAA;AACzJ,QAAA,MAAM,aAAa,CAAA;AACnB,QAAA,MAAML,gBAAS,CAAA;AACf,QAAA,MAAM,IAAI,CAAA;KACX;AACH,CAAC;AAED,UAAU,sBAAsB,CAAC,EAAE,GAAG,EAAoB,EAAA;IACxD,OAAOG,YAAK,CAAC,CAAA,8BAAA,EAAiC,GAAG,CAAC,IAAI,CAAW,SAAA,CAAA,CAAC,CAAA;AAClE,IAAA,MAAM,+CAA+C,CAAA;AACrD,IAAA,MAAMJ,gBAAS,CAAA;AACf,IAAA,MAAM,uDAAuD,CAAA;AAC7D,IAAA,MAAM,aAAa,CAAA;AACnB,IAAA,MAAMC,gBAAS,CAAA;AACf,IAAA,MAAM,IAAI,CAAA;AACZ,CAAC;AAED,UAAU,4BAA4B,CACpC,EAAE,GAAG,EAAE,2BAA2B,EAAE,SAAS,EAAoB,EACjE,OAAmB,EACnB,IAAgD,EAChD,kBAA4B,EAAA;IAE5B,MAAM,QAAQ,GAAG,IAAI,KAAK,QAAQ,GAAG,QAAQ,GAAG,IAAI,KAAK,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAA;AACrF,IAAA,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,MAAM,CAAA,IAAA,EAAO,IAAI,CAAA,IAAA,CAAM,CAAA;AACvB,QAAA,MAAMD,gBAAS,CAAA;AACf,QAAA,MAAM,oBAAoB,CAAA;AAC1B,QAAA,MAAM,UAAU,CAAA;AAChB,QAAA,MAAMA,gBAAS,CAAA;AACf,QAAA,KAAK,MAAM,SAAS,IAAI,OAAO,EAAE;AAC/B,YAAA,IAAI,SAAS,KAAKG,8BAAS,EAAE;gBAC3B,MAAM,CAAA,sCAAA,EAAgG,EAAE,CAAA,GAAA,CAAK,CAAA;AAC7G,gBAAA,MAAMH,gBAAS,CAAA;AACf,gBAAA,MAAM,CAAkB,eAAA,EAAA,QAAQ,CAAkB,eAAA,EAAA,IAAI,gBAAgB,CAAA;AACtE,gBAAA,MAAM,cAAc,CAAA;AACpB,gBAAA,MAAMC,gBAAS,CAAA;AACf,gBAAA,MAAM,IAAI,CAAA;aACX;iBAAM;AACL,gBAAA,MAAM,UAAU,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAA;gBACzD,MAAM,UAAU,GAAG,SAAS,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAA;gBACjE,MAAM,kBAAkB,GAAG,SAAS,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAA;gBACtE,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAA;AACpE,gBAAA,MAAM,CAAG,EAAA,UAAU,CAAwB,qBAAA,EAAA,aAAa,KAA4D,EAAE,KAAK,CAAA;AAC3H,gBAAA,MAAMD,gBAAS,CAAA;AACf,gBAAA,MAAM,kBAAkB,QAAQ,CAAA,yBAAA,EAA4B,IAAI,CAAG,EAAA,kBAAkB,WAAW,CAAA;AAChG,gBAAA,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAkB,KAAK,IAAIM,iBAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,SAAS,CAAC,EAAE,OAAO,CAAC,IAAI,CAAA;AAC5H,gBAAA,MAAM,sBAAsB,cAAc,IAAI,cAAc,KAAK,MAAM,GAAG,CAAA,iCAAA,EAAoC,aAAa,CAAO,KAAA,CAAA,GAAG,WAAW,GAAG,CAAA;AACnJ,gBAAA,MAAM,cAAc,CAAA;AACpB,gBAAA,MAAML,gBAAS,CAAA;AACf,gBAAA,MAAM,IAAI,CAAA;aACX;SACF;AACD,QAAA,MAAMC,6BAAsB,CAAA;AAC5B,QAAA,MAAMD,gBAAS,CAAA;AACf,QAAA,MAAM,IAAI,CAAA;KACX;AACH;;;;"}

package/src/client/call-composer.mjs

@@ -0,0 +1,133 @@
+import { IncIndent, DecIndent, DecIndentAndCloseBlock, jsDoc } from '../output/writer.mjs';
+import { BARE_CALL } from './helpers/get-call-config-summary.mjs';
+import { getCallOnCompleteOptions } from './deploy-types.mjs';
+import { ABIMethod } from 'algosdk';
+
+function* composeMethod(ctx) {
+    const { name, callConfig } = ctx;
+    yield `public newGroup(): ${name}Composer {`;
+    yield IncIndent;
+    yield `const client = this`;
+    yield `const composer = client.appClient.newGroup()`;
+    yield `const resultMappers: Array<undefined | ((x: ABIReturn | undefined) => any)> = []`;
+    yield `return {`;
+    yield IncIndent;
+    yield* callComposerNoops(ctx);
+    // This is async and unless we bring back promiseChain (which is possible) it's not a nice
+    //  experience to expose update method(s)
+    //yield* callComposerOperationMethods(ctx, callConfig.updateMethods, 'update', true)
+    yield* callComposerOperationMethods(ctx, callConfig.deleteMethods, 'delete');
+    yield* callComposerOperationMethods(ctx, callConfig.optInMethods, 'optIn');
+    yield* callComposerOperationMethods(ctx, callConfig.closeOutMethods, 'closeOut');
+    yield* callComposerClearState(ctx);
+    yield `addTransaction(txn: Transaction, signer?: TransactionSigner) {`;
+    yield IncIndent;
+    yield 'composer.addTransaction(txn, signer)';
+    yield 'return this';
+    yield DecIndent;
+    yield '},';
+    yield `composer() {`;
+    yield IncIndent;
+    yield 'return composer';
+    yield DecIndent;
+    yield '},';
+    yield `async simulate(options?: SimulateOptions) {`;
+    yield IncIndent;
+    yield `const result = await composer.simulate(options)`;
+    yield `return {`;
+    yield IncIndent;
+    yield `...result,`;
+    yield `returns: result.returns?.map((val, i) => resultMappers[i] !== undefined ? resultMappers[i]!(val) : val.returnValue)`;
+    yield DecIndentAndCloseBlock;
+    yield DecIndent;
+    yield '},';
+    yield `async execute(params?: ExecuteParams) {`;
+    yield IncIndent;
+    yield `const result = await composer.execute(params)`;
+    yield `return {`;
+    yield IncIndent;
+    yield `...result,`;
+    yield `returns: result.returns?.map((val, i) => resultMappers[i] !== undefined ? resultMappers[i]!(val) : val.returnValue)`;
+    yield DecIndentAndCloseBlock;
+    yield DecIndentAndCloseBlock;
+    yield DecIndent;
+    yield `} as unknown as ${name}Composer`;
+    yield DecIndentAndCloseBlock;
+}
+function* callComposerNoops({ app, callConfig, methodSignatureToUniqueName, sanitizer }) {
+    if (callConfig.callMethods.includes(BARE_CALL)) {
+        yield* jsDoc(`Add a bare method call to the ${app.name} contract`);
+        yield `bare(params: AppClientBareCallParams & ${getCallOnCompleteOptions(BARE_CALL, app).type}) {`;
+        yield IncIndent;
+        yield `composer.addAppCall(client.params.bare(params))`;
+        yield `return this`;
+        yield DecIndent;
+        yield '},';
+    }
+    for (const methodSignature of callConfig.callMethods.filter((m) => m !== BARE_CALL).map((m) => m)) {
+        const methodName = sanitizer.makeSafeMethodIdentifier(methodSignatureToUniqueName[methodSignature]);
+        const methodSignatureSafe = sanitizer.makeSafeStringTypeLiteral(methodSignature);
+        const methodNameAccessor = sanitizer.getSafeMemberAccessor(methodName);
+        // Skip methods which don't support a no_op call config
+        if (!callConfig.callMethods.includes(methodSignature))
+            continue;
+        yield* jsDoc(`Add a ${methodSignature} method call against the ${app.name} contract`);
+        yield `${methodName}(params: CallParams<'${methodSignatureSafe}'> & ${getCallOnCompleteOptions(methodSignature, app).type}) {`;
+        yield IncIndent;
+        yield `composer.addAppCallMethodCall(client.params${methodNameAccessor}(params))`;
+        const outputTypeName = app.methods.find((m) => new ABIMethod(m).getSignature() === methodSignature)?.returns.type;
+        yield `resultMappers.push(${outputTypeName && outputTypeName !== 'void' ? `(v) => client.decodeReturnValue('${methodSignatureSafe}', v)` : 'undefined'})`;
+        yield `return this`;
+        yield DecIndent;
+        yield '},';
+    }
+}
+function* callComposerClearState({ app }) {
+    yield* jsDoc(`Add a clear state call to the ${app.name} contract`);
+    yield `clearState(params: AppClientBareCallParams) {`;
+    yield IncIndent;
+    yield `composer.addAppCall(client.params.clearState(params))`;
+    yield `return this`;
+    yield DecIndent;
+    yield '},';
+}
+function* callComposerOperationMethods({ app, methodSignatureToUniqueName, sanitizer }, methods, verb, includeCompilation) {
+    const callType = verb === 'update' ? 'Update' : verb === 'delete' ? 'Delete' : 'Call';
+    if (methods.length) {
+        yield `get ${verb}() {`;
+        yield IncIndent;
+        yield `const $this = this`;
+        yield `return {`;
+        yield IncIndent;
+        for (const methodSig of methods) {
+            if (methodSig === BARE_CALL) {
+                yield `bare(params?: AppClientBareCallParams ${''}) {`;
+                yield IncIndent;
+                yield `composer.addApp${callType}(client.params.${verb}.bare(params))`;
+                yield `return $this`;
+                yield DecIndent;
+                yield '},';
+            }
+            else {
+                const uniqueName = methodSignatureToUniqueName[methodSig];
+                const methodName = sanitizer.makeSafeMethodIdentifier(uniqueName);
+                const methodNameAccessor = sanitizer.getSafeMemberAccessor(methodName);
+                const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(methodSig);
+                yield `${methodName}(params: CallParams<'${methodSigSafe}'>${''}) {`;
+                yield IncIndent;
+                yield `composer.addApp${callType}MethodCall(client.params.${verb}${methodNameAccessor}(params))`;
+                const outputTypeName = app.methods.find((m) => new ABIMethod(m).getSignature() === methodSig)?.returns.type;
+                yield `resultMappers.push(${outputTypeName && outputTypeName !== 'void' ? `(v) => client.decodeReturnValue('${methodSigSafe}', v)` : 'undefined'})`;
+                yield `return $this`;
+                yield DecIndent;
+                yield '},';
+            }
+        }
+        yield DecIndentAndCloseBlock;
+        yield DecIndent;
+        yield '},';
+    }
+}
+
+export { composeMethod };
+//# sourceMappingURL=call-composer.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"call-composer.mjs","sources":["../../../src/client/call-composer.ts"],"sourcesContent":["import { DecIndent, DecIndentAndCloseBlock, DocumentParts, IncIndent, jsDoc } from '../output/writer'\nimport { GeneratorContext } from './generator-context'\nimport { BARE_CALL, MethodList } from './helpers/get-call-config-summary'\nimport { getCallOnCompleteOptions } from './deploy-types'\nimport { ABIMethod, ABIMethodParams } from 'algosdk'\n\nexport function* composeMethod(ctx: GeneratorContext): DocumentParts {\n  const { name, callConfig } = ctx\n  yield `public newGroup(): ${name}Composer {`\n  yield IncIndent\n\n  yield `const client = this`\n  yield `const composer = client.appClient.newGroup()`\n  yield `const resultMappers: Array<undefined | ((x: ABIReturn | undefined) => any)> = []`\n  yield `return {`\n  yield IncIndent\n\n  yield* callComposerNoops(ctx)\n  // This is async and unless we bring back promiseChain (which is possible) it's not a nice\n  //  experience to expose update method(s)\n  //yield* callComposerOperationMethods(ctx, callConfig.updateMethods, 'update', true)\n  yield* callComposerOperationMethods(ctx, callConfig.deleteMethods, 'delete')\n  yield* callComposerOperationMethods(ctx, callConfig.optInMethods, 'optIn')\n  yield* callComposerOperationMethods(ctx, callConfig.closeOutMethods, 'closeOut')\n  yield* callComposerClearState(ctx)\n\n  yield `addTransaction(txn: Transaction, signer?: TransactionSigner) {`\n  yield IncIndent\n  yield 'composer.addTransaction(txn, signer)'\n  yield 'return this'\n  yield DecIndent\n  yield '},'\n\n  yield `composer() {`\n  yield IncIndent\n  yield 'return composer'\n  yield DecIndent\n  yield '},'\n\n  yield `async simulate(options?: SimulateOptions) {`\n  yield IncIndent\n  yield `const result = await composer.simulate(options)`\n  yield `return {`\n  yield IncIndent\n  yield `...result,`\n  yield `returns: result.returns?.map((val, i) => resultMappers[i] !== undefined ? resultMappers[i]!(val) : val.returnValue)`\n  yield DecIndentAndCloseBlock\n  yield DecIndent\n  yield '},'\n\n  yield `async execute(params?: ExecuteParams) {`\n  yield IncIndent\n  yield `const result = await composer.execute(params)`\n  yield `return {`\n  yield IncIndent\n  yield `...result,`\n  yield `returns: result.returns?.map((val, i) => resultMappers[i] !== undefined ? resultMappers[i]!(val) : val.returnValue)`\n  yield DecIndentAndCloseBlock\n  yield DecIndentAndCloseBlock\n  yield DecIndent\n  yield `} as unknown as ${name}Composer`\n\n  yield DecIndentAndCloseBlock\n}\n\nfunction* callComposerNoops({ app, callConfig, methodSignatureToUniqueName, sanitizer }: GeneratorContext): DocumentParts {\n  if (callConfig.callMethods.includes(BARE_CALL)) {\n    yield* jsDoc(`Add a bare method call to the ${app.name} contract`)\n    yield `bare(params: AppClientBareCallParams & ${getCallOnCompleteOptions(BARE_CALL, app).type}) {`\n    yield IncIndent\n    yield `composer.addAppCall(client.params.bare(params))`\n    yield `return this`\n    yield DecIndent\n    yield '},'\n  }\n\n  for (const methodSignature of callConfig.callMethods.filter((m) => m !== BARE_CALL).map((m) => m as string)) {\n    const methodName = sanitizer.makeSafeMethodIdentifier(methodSignatureToUniqueName[methodSignature])\n    const methodSignatureSafe = sanitizer.makeSafeStringTypeLiteral(methodSignature)\n    const methodNameAccessor = sanitizer.getSafeMemberAccessor(methodName)\n    // Skip methods which don't support a no_op call config\n    if (!callConfig.callMethods.includes(methodSignature)) continue\n    yield* jsDoc(`Add a ${methodSignature} method call against the ${app.name} contract`)\n    yield `${methodName}(params: CallParams<'${methodSignatureSafe}'> & ${getCallOnCompleteOptions(methodSignature, app).type}) {`\n    yield IncIndent\n    yield `composer.addAppCallMethodCall(client.params${methodNameAccessor}(params))`\n    const outputTypeName = app.methods.find((m: ABIMethodParams) => new ABIMethod(m).getSignature() === methodSignature)?.returns.type\n    yield `resultMappers.push(${outputTypeName && outputTypeName !== 'void' ? `(v) => client.decodeReturnValue('${methodSignatureSafe}', v)` : 'undefined'})`\n    yield `return this`\n    yield DecIndent\n    yield '},'\n  }\n}\n\nfunction* callComposerClearState({ app }: GeneratorContext): DocumentParts {\n  yield* jsDoc(`Add a clear state call to the ${app.name} contract`)\n  yield `clearState(params: AppClientBareCallParams) {`\n  yield IncIndent\n  yield `composer.addAppCall(client.params.clearState(params))`\n  yield `return this`\n  yield DecIndent\n  yield '},'\n}\n\nfunction* callComposerOperationMethods(\n  { app, methodSignatureToUniqueName, sanitizer }: GeneratorContext,\n  methods: MethodList,\n  verb: 'update' | 'optIn' | 'closeOut' | 'delete',\n  includeCompilation?: boolean,\n): DocumentParts {\n  const callType = verb === 'update' ? 'Update' : verb === 'delete' ? 'Delete' : 'Call'\n  if (methods.length) {\n    yield `get ${verb}() {`\n    yield IncIndent\n    yield `const $this = this`\n    yield `return {`\n    yield IncIndent\n    for (const methodSig of methods) {\n      if (methodSig === BARE_CALL) {\n        yield `bare(params?: AppClientBareCallParams ${includeCompilation ? '& AppClientCompilationParams ' : ''}) {`\n        yield IncIndent\n        yield `composer.addApp${callType}(client.params.${verb}.bare(params))`\n        yield `return $this`\n        yield DecIndent\n        yield '},'\n      } else {\n        const uniqueName = methodSignatureToUniqueName[methodSig]\n        const methodName = sanitizer.makeSafeMethodIdentifier(uniqueName)\n        const methodNameAccessor = sanitizer.getSafeMemberAccessor(methodName)\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(methodSig)\n        yield `${methodName}(params: CallParams<'${methodSigSafe}'>${includeCompilation ? ' & AppClientCompilationParams' : ''}) {`\n        yield IncIndent\n        yield `composer.addApp${callType}MethodCall(client.params.${verb}${methodNameAccessor}(params))`\n        const outputTypeName = app.methods.find((m: ABIMethodParams) => new ABIMethod(m).getSignature() === methodSig)?.returns.type\n        yield `resultMappers.push(${outputTypeName && outputTypeName !== 'void' ? `(v) => client.decodeReturnValue('${methodSigSafe}', v)` : 'undefined'})`\n        yield `return $this`\n        yield DecIndent\n        yield '},'\n      }\n    }\n    yield DecIndentAndCloseBlock\n    yield DecIndent\n    yield '},'\n  }\n}\n"],"names":[],"mappings":";;;;;AAMe,UAAE,aAAa,CAAC,GAAqB,EAAA;AAClD,IAAA,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,GAAG,CAAA;IAChC,MAAM,CAAA,mBAAA,EAAsB,IAAI,CAAA,UAAA,CAAY,CAAA;AAC5C,IAAA,MAAM,SAAS,CAAA;AAEf,IAAA,MAAM,qBAAqB,CAAA;AAC3B,IAAA,MAAM,8CAA8C,CAAA;AACpD,IAAA,MAAM,kFAAkF,CAAA;AACxF,IAAA,MAAM,UAAU,CAAA;AAChB,IAAA,MAAM,SAAS,CAAA;AAEf,IAAA,OAAO,iBAAiB,CAAC,GAAG,CAAC,CAAA;;;;AAI7B,IAAA,OAAO,4BAA4B,CAAC,GAAG,EAAE,UAAU,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA;AAC5E,IAAA,OAAO,4BAA4B,CAAC,GAAG,EAAE,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;AAC1E,IAAA,OAAO,4BAA4B,CAAC,GAAG,EAAE,UAAU,CAAC,eAAe,EAAE,UAAU,CAAC,CAAA;AAChF,IAAA,OAAO,sBAAsB,CAAC,GAAG,CAAC,CAAA;AAElC,IAAA,MAAM,gEAAgE,CAAA;AACtE,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,sCAAsC,CAAA;AAC5C,IAAA,MAAM,aAAa,CAAA;AACnB,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,IAAI,CAAA;AAEV,IAAA,MAAM,cAAc,CAAA;AACpB,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,iBAAiB,CAAA;AACvB,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,IAAI,CAAA;AAEV,IAAA,MAAM,6CAA6C,CAAA;AACnD,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,iDAAiD,CAAA;AACvD,IAAA,MAAM,UAAU,CAAA;AAChB,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,YAAY,CAAA;AAClB,IAAA,MAAM,qHAAqH,CAAA;AAC3H,IAAA,MAAM,sBAAsB,CAAA;AAC5B,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,IAAI,CAAA;AAEV,IAAA,MAAM,yCAAyC,CAAA;AAC/C,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,+CAA+C,CAAA;AACrD,IAAA,MAAM,UAAU,CAAA;AAChB,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,YAAY,CAAA;AAClB,IAAA,MAAM,qHAAqH,CAAA;AAC3H,IAAA,MAAM,sBAAsB,CAAA;AAC5B,IAAA,MAAM,sBAAsB,CAAA;AAC5B,IAAA,MAAM,SAAS,CAAA;IACf,MAAM,CAAA,gBAAA,EAAmB,IAAI,CAAA,QAAA,CAAU,CAAA;AAEvC,IAAA,MAAM,sBAAsB,CAAA;AAC9B,CAAC;AAED,UAAU,iBAAiB,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,2BAA2B,EAAE,SAAS,EAAoB,EAAA;IACvG,IAAI,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QAC9C,OAAO,KAAK,CAAC,CAAA,8BAAA,EAAiC,GAAG,CAAC,IAAI,CAAW,SAAA,CAAA,CAAC,CAAA;QAClE,MAAM,CAAA,uCAAA,EAA0C,wBAAwB,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,IAAI,CAAA,GAAA,CAAK,CAAA;AAClG,QAAA,MAAM,SAAS,CAAA;AACf,QAAA,MAAM,iDAAiD,CAAA;AACvD,QAAA,MAAM,aAAa,CAAA;AACnB,QAAA,MAAM,SAAS,CAAA;AACf,QAAA,MAAM,IAAI,CAAA;KACX;AAED,IAAA,KAAK,MAAM,eAAe,IAAI,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAW,CAAC,EAAE;QAC3G,MAAM,UAAU,GAAG,SAAS,CAAC,wBAAwB,CAAC,2BAA2B,CAAC,eAAe,CAAC,CAAC,CAAA;QACnG,MAAM,mBAAmB,GAAG,SAAS,CAAC,yBAAyB,CAAC,eAAe,CAAC,CAAA;QAChF,MAAM,kBAAkB,GAAG,SAAS,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAA;;QAEtE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,eAAe,CAAC;YAAE,SAAQ;AAC/D,QAAA,OAAO,KAAK,CAAC,CAAS,MAAA,EAAA,eAAe,CAA4B,yBAAA,EAAA,GAAG,CAAC,IAAI,CAAW,SAAA,CAAA,CAAC,CAAA;AACrF,QAAA,MAAM,CAAG,EAAA,UAAU,CAAwB,qBAAA,EAAA,mBAAmB,QAAQ,wBAAwB,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC,IAAI,KAAK,CAAA;AAC9H,QAAA,MAAM,SAAS,CAAA;QACf,MAAM,CAAA,2CAAA,EAA8C,kBAAkB,CAAA,SAAA,CAAW,CAAA;AACjF,QAAA,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAkB,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,eAAe,CAAC,EAAE,OAAO,CAAC,IAAI,CAAA;AAClI,QAAA,MAAM,sBAAsB,cAAc,IAAI,cAAc,KAAK,MAAM,GAAG,CAAA,iCAAA,EAAoC,mBAAmB,CAAO,KAAA,CAAA,GAAG,WAAW,GAAG,CAAA;AACzJ,QAAA,MAAM,aAAa,CAAA;AACnB,QAAA,MAAM,SAAS,CAAA;AACf,QAAA,MAAM,IAAI,CAAA;KACX;AACH,CAAC;AAED,UAAU,sBAAsB,CAAC,EAAE,GAAG,EAAoB,EAAA;IACxD,OAAO,KAAK,CAAC,CAAA,8BAAA,EAAiC,GAAG,CAAC,IAAI,CAAW,SAAA,CAAA,CAAC,CAAA;AAClE,IAAA,MAAM,+CAA+C,CAAA;AACrD,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,uDAAuD,CAAA;AAC7D,IAAA,MAAM,aAAa,CAAA;AACnB,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,IAAI,CAAA;AACZ,CAAC;AAED,UAAU,4BAA4B,CACpC,EAAE,GAAG,EAAE,2BAA2B,EAAE,SAAS,EAAoB,EACjE,OAAmB,EACnB,IAAgD,EAChD,kBAA4B,EAAA;IAE5B,MAAM,QAAQ,GAAG,IAAI,KAAK,QAAQ,GAAG,QAAQ,GAAG,IAAI,KAAK,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAA;AACrF,IAAA,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,MAAM,CAAA,IAAA,EAAO,IAAI,CAAA,IAAA,CAAM,CAAA;AACvB,QAAA,MAAM,SAAS,CAAA;AACf,QAAA,MAAM,oBAAoB,CAAA;AAC1B,QAAA,MAAM,UAAU,CAAA;AAChB,QAAA,MAAM,SAAS,CAAA;AACf,QAAA,KAAK,MAAM,SAAS,IAAI,OAAO,EAAE;AAC/B,YAAA,IAAI,SAAS,KAAK,SAAS,EAAE;gBAC3B,MAAM,CAAA,sCAAA,EAAgG,EAAE,CAAA,GAAA,CAAK,CAAA;AAC7G,gBAAA,MAAM,SAAS,CAAA;AACf,gBAAA,MAAM,CAAkB,eAAA,EAAA,QAAQ,CAAkB,eAAA,EAAA,IAAI,gBAAgB,CAAA;AACtE,gBAAA,MAAM,cAAc,CAAA;AACpB,gBAAA,MAAM,SAAS,CAAA;AACf,gBAAA,MAAM,IAAI,CAAA;aACX;iBAAM;AACL,gBAAA,MAAM,UAAU,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAA;gBACzD,MAAM,UAAU,GAAG,SAAS,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAA;gBACjE,MAAM,kBAAkB,GAAG,SAAS,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAA;gBACtE,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAA;AACpE,gBAAA,MAAM,CAAG,EAAA,UAAU,CAAwB,qBAAA,EAAA,aAAa,KAA4D,EAAE,KAAK,CAAA;AAC3H,gBAAA,MAAM,SAAS,CAAA;AACf,gBAAA,MAAM,kBAAkB,QAAQ,CAAA,yBAAA,EAA4B,IAAI,CAAG,EAAA,kBAAkB,WAAW,CAAA;AAChG,gBAAA,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAkB,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,SAAS,CAAC,EAAE,OAAO,CAAC,IAAI,CAAA;AAC5H,gBAAA,MAAM,sBAAsB,cAAc,IAAI,cAAc,KAAK,MAAM,GAAG,CAAA,iCAAA,EAAoC,aAAa,CAAO,KAAA,CAAA,GAAG,WAAW,GAAG,CAAA;AACnJ,gBAAA,MAAM,cAAc,CAAA;AACpB,gBAAA,MAAM,SAAS,CAAA;AACf,gBAAA,MAAM,IAAI,CAAA;aACX;SACF;AACD,QAAA,MAAM,sBAAsB,CAAA;AAC5B,QAAA,MAAM,SAAS,CAAA;AACf,QAAA,MAAM,IAAI,CAAA;KACX;AACH;;;;"}

package/src/client/deploy-types.js

@@ -0,0 +1,115 @@
+'use strict';
+
+var writer = require('../output/writer.js');
+var getCallConfigSummary = require('./helpers/get-call-config-summary.js');
+var algosdk = require('algosdk');
+
+function getCreateOnCompleteOptions(method, app) {
+    const validCreateOnCompletes = method === getCallConfigSummary.BARE_CALL ? app.bareActions.create : app.methods.find((m) => new algosdk.ABIMethod(m).getSignature() === method)?.actions?.create;
+    const hasNoOp = validCreateOnCompletes?.includes('NoOp');
+    const onCompleteType = validCreateOnCompletes
+        ? `{onComplete${hasNoOp ? '?' : ''}: ${validCreateOnCompletes.map((oc) => `OnApplicationComplete.${oc}OC`).join(' | ')}}`
+        : {};
+    return {
+        type: onCompleteType,
+        isOptional: hasNoOp,
+    };
+}
+function getCallOnCompleteOptions(method, app) {
+    const validCallOnCompletes = method === getCallConfigSummary.BARE_CALL ? app.bareActions.call : app.methods.find((m) => new algosdk.ABIMethod(m).getSignature() === method)?.actions?.call;
+    const hasNoOp = validCallOnCompletes?.includes('NoOp');
+    const onCompleteType = validCallOnCompletes
+        ? `{onComplete${hasNoOp ? '?' : ''}: ${validCallOnCompletes.map((oc) => `OnApplicationComplete.${oc}OC`).join(' | ')}}`
+        : {};
+    return {
+        type: onCompleteType,
+        isOptional: hasNoOp,
+    };
+}
+function* deployTypes({ app, callConfig, sanitizer, methodSignatureToUniqueName }) {
+    const name = sanitizer.makeSafeTypeIdentifier(app.name);
+    if (callConfig.createMethods.length > 0) {
+        yield* writer.jsDoc('Defines supported create method params for this smart contract');
+        yield `export type ${name}CreateCallParams =`;
+        yield writer.IncIndent;
+        for (const method of callConfig.createMethods) {
+            const onComplete = getCreateOnCompleteOptions(method, app);
+            if (method === getCallConfigSummary.BARE_CALL) {
+                yield `| Expand<AppClientBareCallParams & {method?: undefined} & ${onComplete.type} & CreateSchema>`;
+            }
+            else {
+                const uniqueName = methodSignatureToUniqueName[method];
+                if (uniqueName !== method) {
+                    const methodName = sanitizer.makeSafeStringTypeLiteral(uniqueName);
+                    yield `| Expand<CallParams<'${methodName}'> & {method: '${methodName}'} & ${onComplete.type} & CreateSchema>`;
+                }
+                const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method);
+                yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'} & ${onComplete.type} & CreateSchema>`;
+            }
+        }
+        yield writer.DecIndent;
+    }
+    if (callConfig.updateMethods.length > 0) {
+        yield* writer.jsDoc('Defines supported update method params for this smart contract');
+        yield `export type ${name}UpdateCallParams =`;
+        yield writer.IncIndent;
+        for (const method of callConfig.updateMethods) {
+            if (method === getCallConfigSummary.BARE_CALL) {
+                yield `| Expand<AppClientBareCallParams> & {method?: undefined}`;
+            }
+            else {
+                const uniqueName = methodSignatureToUniqueName[method];
+                if (uniqueName !== method) {
+                    const methodName = sanitizer.makeSafeStringTypeLiteral(uniqueName);
+                    yield `| Expand<CallParams<'${methodName}'> & {method: '${methodName}'}>`;
+                }
+                const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method);
+                yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'}>`;
+            }
+        }
+        yield writer.DecIndent;
+    }
+    if (callConfig.deleteMethods.length > 0) {
+        yield* writer.jsDoc('Defines supported delete method params for this smart contract');
+        yield `export type ${name}DeleteCallParams =`;
+        yield writer.IncIndent;
+        for (const method of callConfig.deleteMethods) {
+            if (method === getCallConfigSummary.BARE_CALL) {
+                yield `| Expand<AppClientBareCallParams> & {method?: undefined}`;
+            }
+            else {
+                const uniqueName = methodSignatureToUniqueName[method];
+                if (uniqueName !== method) {
+                    const methodName = sanitizer.makeSafeStringTypeLiteral(uniqueName);
+                    yield `| Expand<CallParams<'${methodName}'> & {method: '${methodName}'}>`;
+                }
+                const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method);
+                yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'}>`;
+            }
+        }
+        yield writer.DecIndent;
+    }
+    yield* writer.jsDoc('Defines arguments required for the deploy method.');
+    yield `export type ${name}DeployParams = Expand<Omit<AppFactoryDeployParams, 'createParams' | 'updateParams' | 'deleteParams'> & {`;
+    yield writer.IncIndent;
+    if (callConfig.createMethods.length) {
+        yield* writer.jsDoc('Create transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)');
+        yield `createParams?: ${name}CreateCallParams`;
+    }
+    if (callConfig.updateMethods.length) {
+        yield* writer.jsDoc('Update transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)');
+        yield `updateParams?: ${name}UpdateCallParams`;
+    }
+    if (callConfig.deleteMethods.length) {
+        yield* writer.jsDoc('Delete transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)');
+        yield `deleteParams?: ${name}DeleteCallParams`;
+    }
+    yield writer.DecIndent;
+    yield `}>`;
+    yield writer.NewLine;
+}
+
+exports.deployTypes = deployTypes;
+exports.getCallOnCompleteOptions = getCallOnCompleteOptions;
+exports.getCreateOnCompleteOptions = getCreateOnCompleteOptions;
+//# sourceMappingURL=deploy-types.js.map

package/src/client/deploy-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy-types.js","sources":["../../../src/client/deploy-types.ts"],"sourcesContent":["import { DecIndent, DocumentParts, IncIndent, jsDoc, NewLine } from '../output/writer'\nimport { BARE_CALL, MethodIdentifier } from './helpers/get-call-config-summary'\nimport { GeneratorContext } from './generator-context'\nimport { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56'\nimport { ABIMethod } from 'algosdk'\n\nexport function getCreateOnCompleteOptions(method: MethodIdentifier, app: Arc56Contract) {\n  const validCreateOnCompletes =\n    method === BARE_CALL ? app.bareActions.create : app.methods.find((m) => new ABIMethod(m).getSignature() === method)?.actions?.create\n  const hasNoOp = validCreateOnCompletes?.includes('NoOp')\n  const onCompleteType = validCreateOnCompletes\n    ? `{onComplete${hasNoOp ? '?' : ''}: ${validCreateOnCompletes.map((oc) => `OnApplicationComplete.${oc}OC`).join(' | ')}}`\n    : {}\n  return {\n    type: onCompleteType,\n    isOptional: hasNoOp,\n  }\n}\n\nexport function getCallOnCompleteOptions(method: MethodIdentifier, app: Arc56Contract) {\n  const validCallOnCompletes =\n    method === BARE_CALL ? app.bareActions.call : app.methods.find((m) => new ABIMethod(m).getSignature() === method)?.actions?.call\n  const hasNoOp = validCallOnCompletes?.includes('NoOp')\n  const onCompleteType = validCallOnCompletes\n    ? `{onComplete${hasNoOp ? '?' : ''}: ${validCallOnCompletes.map((oc) => `OnApplicationComplete.${oc}OC`).join(' | ')}}`\n    : {}\n  return {\n    type: onCompleteType,\n    isOptional: hasNoOp,\n  }\n}\n\nexport function* deployTypes({ app, callConfig, sanitizer, methodSignatureToUniqueName }: GeneratorContext): DocumentParts {\n  const name = sanitizer.makeSafeTypeIdentifier(app.name)\n\n  if (callConfig.createMethods.length > 0) {\n    yield* jsDoc('Defines supported create method params for this smart contract')\n    yield `export type ${name}CreateCallParams =`\n    yield IncIndent\n    for (const method of callConfig.createMethods) {\n      const onComplete = getCreateOnCompleteOptions(method, app)\n      if (method === BARE_CALL) {\n        yield `| Expand<AppClientBareCallParams & {method?: undefined} & ${onComplete.type} & CreateSchema>`\n      } else {\n        const uniqueName = methodSignatureToUniqueName[method]\n        if (uniqueName !== method) {\n          const methodName = sanitizer.makeSafeStringTypeLiteral(uniqueName)\n          yield `| Expand<CallParams<'${methodName}'> & {method: '${methodName}'} & ${onComplete.type} & CreateSchema>`\n        }\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method)\n        yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'} & ${onComplete.type} & CreateSchema>`\n      }\n    }\n    yield DecIndent\n  }\n  if (callConfig.updateMethods.length > 0) {\n    yield* jsDoc('Defines supported update method params for this smart contract')\n    yield `export type ${name}UpdateCallParams =`\n    yield IncIndent\n    for (const method of callConfig.updateMethods) {\n      if (method === BARE_CALL) {\n        yield `| Expand<AppClientBareCallParams> & {method?: undefined}`\n      } else {\n        const uniqueName = methodSignatureToUniqueName[method]\n        if (uniqueName !== method) {\n          const methodName = sanitizer.makeSafeStringTypeLiteral(uniqueName)\n          yield `| Expand<CallParams<'${methodName}'> & {method: '${methodName}'}>`\n        }\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method)\n        yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'}>`\n      }\n    }\n    yield DecIndent\n  }\n\n  if (callConfig.deleteMethods.length > 0) {\n    yield* jsDoc('Defines supported delete method params for this smart contract')\n    yield `export type ${name}DeleteCallParams =`\n    yield IncIndent\n    for (const method of callConfig.deleteMethods) {\n      if (method === BARE_CALL) {\n        yield `| Expand<AppClientBareCallParams> & {method?: undefined}`\n      } else {\n        const uniqueName = methodSignatureToUniqueName[method]\n        if (uniqueName !== method) {\n          const methodName = sanitizer.makeSafeStringTypeLiteral(uniqueName)\n          yield `| Expand<CallParams<'${methodName}'> & {method: '${methodName}'}>`\n        }\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method)\n        yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'}>`\n      }\n    }\n    yield DecIndent\n  }\n\n  yield* jsDoc('Defines arguments required for the deploy method.')\n  yield `export type ${name}DeployParams = Expand<Omit<AppFactoryDeployParams, 'createParams' | 'updateParams' | 'deleteParams'> & {`\n  yield IncIndent\n  if (callConfig.createMethods.length) {\n    yield* jsDoc(\n      'Create transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)',\n    )\n    yield `createParams?: ${name}CreateCallParams`\n  }\n  if (callConfig.updateMethods.length) {\n    yield* jsDoc(\n      'Update transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)',\n    )\n    yield `updateParams?: ${name}UpdateCallParams`\n  }\n  if (callConfig.deleteMethods.length) {\n    yield* jsDoc(\n      'Delete transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)',\n    )\n    yield `deleteParams?: ${name}DeleteCallParams`\n  }\n  yield DecIndent\n  yield `}>`\n  yield NewLine\n}\n"],"names":["BARE_CALL","ABIMethod","jsDoc","IncIndent","DecIndent","NewLine"],"mappings":";;;;;;AAMgB,SAAA,0BAA0B,CAAC,MAAwB,EAAE,GAAkB,EAAA;AACrF,IAAA,MAAM,sBAAsB,GAC1B,MAAM,KAAKA,8BAAS,GAAG,GAAG,CAAC,WAAW,CAAC,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAIC,iBAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAA;IACtI,MAAM,OAAO,GAAG,sBAAsB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACxD,MAAM,cAAc,GAAG,sBAAsB;AAC3C,UAAE,CAAA,WAAA,EAAc,OAAO,GAAG,GAAG,GAAG,EAAE,CAAA,EAAA,EAAK,sBAAsB,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAyB,sBAAA,EAAA,EAAE,CAAI,EAAA,CAAA,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAG,CAAA,CAAA;UACvH,EAAE,CAAA;IACN,OAAO;AACL,QAAA,IAAI,EAAE,cAAc;AACpB,QAAA,UAAU,EAAE,OAAO;KACpB,CAAA;AACH,CAAC;AAEe,SAAA,wBAAwB,CAAC,MAAwB,EAAE,GAAkB,EAAA;AACnF,IAAA,MAAM,oBAAoB,GACxB,MAAM,KAAKD,8BAAS,GAAG,GAAG,CAAC,WAAW,CAAC,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAIC,iBAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,MAAM,CAAC,EAAE,OAAO,EAAE,IAAI,CAAA;IAClI,MAAM,OAAO,GAAG,oBAAoB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACtD,MAAM,cAAc,GAAG,oBAAoB;AACzC,UAAE,CAAA,WAAA,EAAc,OAAO,GAAG,GAAG,GAAG,EAAE,CAAA,EAAA,EAAK,oBAAoB,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAyB,sBAAA,EAAA,EAAE,CAAI,EAAA,CAAA,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAG,CAAA,CAAA;UACrH,EAAE,CAAA;IACN,OAAO;AACL,QAAA,IAAI,EAAE,cAAc;AACpB,QAAA,UAAU,EAAE,OAAO;KACpB,CAAA;AACH,CAAC;AAEc,UAAE,WAAW,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,SAAS,EAAE,2BAA2B,EAAoB,EAAA;IACxG,MAAM,IAAI,GAAG,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAEvD,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;AACvC,QAAA,OAAOC,YAAK,CAAC,gEAAgE,CAAC,CAAA;QAC9E,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,kBAAA,CAAoB,CAAA;AAC7C,QAAA,MAAMC,gBAAS,CAAA;AACf,QAAA,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,aAAa,EAAE;YAC7C,MAAM,UAAU,GAAG,0BAA0B,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAC1D,YAAA,IAAI,MAAM,KAAKH,8BAAS,EAAE;AACxB,gBAAA,MAAM,CAA6D,0DAAA,EAAA,UAAU,CAAC,IAAI,kBAAkB,CAAA;aACrG;iBAAM;AACL,gBAAA,MAAM,UAAU,GAAG,2BAA2B,CAAC,MAAM,CAAC,CAAA;AACtD,gBAAA,IAAI,UAAU,KAAK,MAAM,EAAE;oBACzB,MAAM,UAAU,GAAG,SAAS,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAA;oBAClE,MAAM,CAAA,qBAAA,EAAwB,UAAU,CAAkB,eAAA,EAAA,UAAU,QAAQ,UAAU,CAAC,IAAI,CAAA,gBAAA,CAAkB,CAAA;iBAC9G;gBACD,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;gBACjE,MAAM,CAAA,qBAAA,EAAwB,aAAa,CAAkB,eAAA,EAAA,aAAa,QAAQ,UAAU,CAAC,IAAI,CAAA,gBAAA,CAAkB,CAAA;aACpH;SACF;AACD,QAAA,MAAMI,gBAAS,CAAA;KAChB;IACD,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;AACvC,QAAA,OAAOF,YAAK,CAAC,gEAAgE,CAAC,CAAA;QAC9E,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,kBAAA,CAAoB,CAAA;AAC7C,QAAA,MAAMC,gBAAS,CAAA;AACf,QAAA,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,aAAa,EAAE;AAC7C,YAAA,IAAI,MAAM,KAAKH,8BAAS,EAAE;AACxB,gBAAA,MAAM,0DAA0D,CAAA;aACjE;iBAAM;AACL,gBAAA,MAAM,UAAU,GAAG,2BAA2B,CAAC,MAAM,CAAC,CAAA;AACtD,gBAAA,IAAI,UAAU,KAAK,MAAM,EAAE;oBACzB,MAAM,UAAU,GAAG,SAAS,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAA;AAClE,oBAAA,MAAM,CAAwB,qBAAA,EAAA,UAAU,CAAkB,eAAA,EAAA,UAAU,KAAK,CAAA;iBAC1E;gBACD,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;AACjE,gBAAA,MAAM,CAAwB,qBAAA,EAAA,aAAa,CAAkB,eAAA,EAAA,aAAa,KAAK,CAAA;aAChF;SACF;AACD,QAAA,MAAMI,gBAAS,CAAA;KAChB;IAED,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;AACvC,QAAA,OAAOF,YAAK,CAAC,gEAAgE,CAAC,CAAA;QAC9E,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,kBAAA,CAAoB,CAAA;AAC7C,QAAA,MAAMC,gBAAS,CAAA;AACf,QAAA,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,aAAa,EAAE;AAC7C,YAAA,IAAI,MAAM,KAAKH,8BAAS,EAAE;AACxB,gBAAA,MAAM,0DAA0D,CAAA;aACjE;iBAAM;AACL,gBAAA,MAAM,UAAU,GAAG,2BAA2B,CAAC,MAAM,CAAC,CAAA;AACtD,gBAAA,IAAI,UAAU,KAAK,MAAM,EAAE;oBACzB,MAAM,UAAU,GAAG,SAAS,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAA;AAClE,oBAAA,MAAM,CAAwB,qBAAA,EAAA,UAAU,CAAkB,eAAA,EAAA,UAAU,KAAK,CAAA;iBAC1E;gBACD,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;AACjE,gBAAA,MAAM,CAAwB,qBAAA,EAAA,aAAa,CAAkB,eAAA,EAAA,aAAa,KAAK,CAAA;aAChF;SACF;AACD,QAAA,MAAMI,gBAAS,CAAA;KAChB;AAED,IAAA,OAAOF,YAAK,CAAC,mDAAmD,CAAC,CAAA;IACjE,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,wGAAA,CAA0G,CAAA;AACnI,IAAA,MAAMC,gBAAS,CAAA;AACf,IAAA,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,EAAE;AACnC,QAAA,OAAOD,YAAK,CACV,uLAAuL,CACxL,CAAA;QACD,MAAM,CAAA,eAAA,EAAkB,IAAI,CAAA,gBAAA,CAAkB,CAAA;KAC/C;AACD,IAAA,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,EAAE;AACnC,QAAA,OAAOA,YAAK,CACV,uLAAuL,CACxL,CAAA;QACD,MAAM,CAAA,eAAA,EAAkB,IAAI,CAAA,gBAAA,CAAkB,CAAA;KAC/C;AACD,IAAA,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,EAAE;AACnC,QAAA,OAAOA,YAAK,CACV,uLAAuL,CACxL,CAAA;QACD,MAAM,CAAA,eAAA,EAAkB,IAAI,CAAA,gBAAA,CAAkB,CAAA;KAC/C;AACD,IAAA,MAAME,gBAAS,CAAA;AACf,IAAA,MAAM,IAAI,CAAA;AACV,IAAA,MAAMC,cAAO,CAAA;AACf;;;;;;"}

package/src/client/deploy-types.mjs

@@ -0,0 +1,111 @@
+import { jsDoc, IncIndent, DecIndent, NewLine } from '../output/writer.mjs';
+import { BARE_CALL } from './helpers/get-call-config-summary.mjs';
+import { ABIMethod } from 'algosdk';
+
+function getCreateOnCompleteOptions(method, app) {
+    const validCreateOnCompletes = method === BARE_CALL ? app.bareActions.create : app.methods.find((m) => new ABIMethod(m).getSignature() === method)?.actions?.create;
+    const hasNoOp = validCreateOnCompletes?.includes('NoOp');
+    const onCompleteType = validCreateOnCompletes
+        ? `{onComplete${hasNoOp ? '?' : ''}: ${validCreateOnCompletes.map((oc) => `OnApplicationComplete.${oc}OC`).join(' | ')}}`
+        : {};
+    return {
+        type: onCompleteType,
+        isOptional: hasNoOp,
+    };
+}
+function getCallOnCompleteOptions(method, app) {
+    const validCallOnCompletes = method === BARE_CALL ? app.bareActions.call : app.methods.find((m) => new ABIMethod(m).getSignature() === method)?.actions?.call;
+    const hasNoOp = validCallOnCompletes?.includes('NoOp');
+    const onCompleteType = validCallOnCompletes
+        ? `{onComplete${hasNoOp ? '?' : ''}: ${validCallOnCompletes.map((oc) => `OnApplicationComplete.${oc}OC`).join(' | ')}}`
+        : {};
+    return {
+        type: onCompleteType,
+        isOptional: hasNoOp,
+    };
+}
+function* deployTypes({ app, callConfig, sanitizer, methodSignatureToUniqueName }) {
+    const name = sanitizer.makeSafeTypeIdentifier(app.name);
+    if (callConfig.createMethods.length > 0) {
+        yield* jsDoc('Defines supported create method params for this smart contract');
+        yield `export type ${name}CreateCallParams =`;
+        yield IncIndent;
+        for (const method of callConfig.createMethods) {
+            const onComplete = getCreateOnCompleteOptions(method, app);
+            if (method === BARE_CALL) {
+                yield `| Expand<AppClientBareCallParams & {method?: undefined} & ${onComplete.type} & CreateSchema>`;
+            }
+            else {
+                const uniqueName = methodSignatureToUniqueName[method];
+                if (uniqueName !== method) {
+                    const methodName = sanitizer.makeSafeStringTypeLiteral(uniqueName);
+                    yield `| Expand<CallParams<'${methodName}'> & {method: '${methodName}'} & ${onComplete.type} & CreateSchema>`;
+                }
+                const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method);
+                yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'} & ${onComplete.type} & CreateSchema>`;
+            }
+        }
+        yield DecIndent;
+    }
+    if (callConfig.updateMethods.length > 0) {
+        yield* jsDoc('Defines supported update method params for this smart contract');
+        yield `export type ${name}UpdateCallParams =`;
+        yield IncIndent;
+        for (const method of callConfig.updateMethods) {
+            if (method === BARE_CALL) {
+                yield `| Expand<AppClientBareCallParams> & {method?: undefined}`;
+            }
+            else {
+                const uniqueName = methodSignatureToUniqueName[method];
+                if (uniqueName !== method) {
+                    const methodName = sanitizer.makeSafeStringTypeLiteral(uniqueName);
+                    yield `| Expand<CallParams<'${methodName}'> & {method: '${methodName}'}>`;
+                }
+                const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method);
+                yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'}>`;
+            }
+        }
+        yield DecIndent;
+    }
+    if (callConfig.deleteMethods.length > 0) {
+        yield* jsDoc('Defines supported delete method params for this smart contract');
+        yield `export type ${name}DeleteCallParams =`;
+        yield IncIndent;
+        for (const method of callConfig.deleteMethods) {
+            if (method === BARE_CALL) {
+                yield `| Expand<AppClientBareCallParams> & {method?: undefined}`;
+            }
+            else {
+                const uniqueName = methodSignatureToUniqueName[method];
+                if (uniqueName !== method) {
+                    const methodName = sanitizer.makeSafeStringTypeLiteral(uniqueName);
+                    yield `| Expand<CallParams<'${methodName}'> & {method: '${methodName}'}>`;
+                }
+                const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method);
+                yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'}>`;
+            }
+        }
+        yield DecIndent;
+    }
+    yield* jsDoc('Defines arguments required for the deploy method.');
+    yield `export type ${name}DeployParams = Expand<Omit<AppFactoryDeployParams, 'createParams' | 'updateParams' | 'deleteParams'> & {`;
+    yield IncIndent;
+    if (callConfig.createMethods.length) {
+        yield* jsDoc('Create transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)');
+        yield `createParams?: ${name}CreateCallParams`;
+    }
+    if (callConfig.updateMethods.length) {
+        yield* jsDoc('Update transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)');
+        yield `updateParams?: ${name}UpdateCallParams`;
+    }
+    if (callConfig.deleteMethods.length) {
+        yield* jsDoc('Delete transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)');
+        yield `deleteParams?: ${name}DeleteCallParams`;
+    }
+    yield DecIndent;
+    yield `}>`;
+    yield NewLine;
+}
+
+export { deployTypes, getCallOnCompleteOptions, getCreateOnCompleteOptions };
+//# sourceMappingURL=deploy-types.mjs.map

package/src/client/deploy-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy-types.mjs","sources":["../../../src/client/deploy-types.ts"],"sourcesContent":["import { DecIndent, DocumentParts, IncIndent, jsDoc, NewLine } from '../output/writer'\nimport { BARE_CALL, MethodIdentifier } from './helpers/get-call-config-summary'\nimport { GeneratorContext } from './generator-context'\nimport { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56'\nimport { ABIMethod } from 'algosdk'\n\nexport function getCreateOnCompleteOptions(method: MethodIdentifier, app: Arc56Contract) {\n  const validCreateOnCompletes =\n    method === BARE_CALL ? app.bareActions.create : app.methods.find((m) => new ABIMethod(m).getSignature() === method)?.actions?.create\n  const hasNoOp = validCreateOnCompletes?.includes('NoOp')\n  const onCompleteType = validCreateOnCompletes\n    ? `{onComplete${hasNoOp ? '?' : ''}: ${validCreateOnCompletes.map((oc) => `OnApplicationComplete.${oc}OC`).join(' | ')}}`\n    : {}\n  return {\n    type: onCompleteType,\n    isOptional: hasNoOp,\n  }\n}\n\nexport function getCallOnCompleteOptions(method: MethodIdentifier, app: Arc56Contract) {\n  const validCallOnCompletes =\n    method === BARE_CALL ? app.bareActions.call : app.methods.find((m) => new ABIMethod(m).getSignature() === method)?.actions?.call\n  const hasNoOp = validCallOnCompletes?.includes('NoOp')\n  const onCompleteType = validCallOnCompletes\n    ? `{onComplete${hasNoOp ? '?' : ''}: ${validCallOnCompletes.map((oc) => `OnApplicationComplete.${oc}OC`).join(' | ')}}`\n    : {}\n  return {\n    type: onCompleteType,\n    isOptional: hasNoOp,\n  }\n}\n\nexport function* deployTypes({ app, callConfig, sanitizer, methodSignatureToUniqueName }: GeneratorContext): DocumentParts {\n  const name = sanitizer.makeSafeTypeIdentifier(app.name)\n\n  if (callConfig.createMethods.length > 0) {\n    yield* jsDoc('Defines supported create method params for this smart contract')\n    yield `export type ${name}CreateCallParams =`\n    yield IncIndent\n    for (const method of callConfig.createMethods) {\n      const onComplete = getCreateOnCompleteOptions(method, app)\n      if (method === BARE_CALL) {\n        yield `| Expand<AppClientBareCallParams & {method?: undefined} & ${onComplete.type} & CreateSchema>`\n      } else {\n        const uniqueName = methodSignatureToUniqueName[method]\n        if (uniqueName !== method) {\n          const methodName = sanitizer.makeSafeStringTypeLiteral(uniqueName)\n          yield `| Expand<CallParams<'${methodName}'> & {method: '${methodName}'} & ${onComplete.type} & CreateSchema>`\n        }\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method)\n        yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'} & ${onComplete.type} & CreateSchema>`\n      }\n    }\n    yield DecIndent\n  }\n  if (callConfig.updateMethods.length > 0) {\n    yield* jsDoc('Defines supported update method params for this smart contract')\n    yield `export type ${name}UpdateCallParams =`\n    yield IncIndent\n    for (const method of callConfig.updateMethods) {\n      if (method === BARE_CALL) {\n        yield `| Expand<AppClientBareCallParams> & {method?: undefined}`\n      } else {\n        const uniqueName = methodSignatureToUniqueName[method]\n        if (uniqueName !== method) {\n          const methodName = sanitizer.makeSafeStringTypeLiteral(uniqueName)\n          yield `| Expand<CallParams<'${methodName}'> & {method: '${methodName}'}>`\n        }\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method)\n        yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'}>`\n      }\n    }\n    yield DecIndent\n  }\n\n  if (callConfig.deleteMethods.length > 0) {\n    yield* jsDoc('Defines supported delete method params for this smart contract')\n    yield `export type ${name}DeleteCallParams =`\n    yield IncIndent\n    for (const method of callConfig.deleteMethods) {\n      if (method === BARE_CALL) {\n        yield `| Expand<AppClientBareCallParams> & {method?: undefined}`\n      } else {\n        const uniqueName = methodSignatureToUniqueName[method]\n        if (uniqueName !== method) {\n          const methodName = sanitizer.makeSafeStringTypeLiteral(uniqueName)\n          yield `| Expand<CallParams<'${methodName}'> & {method: '${methodName}'}>`\n        }\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method)\n        yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'}>`\n      }\n    }\n    yield DecIndent\n  }\n\n  yield* jsDoc('Defines arguments required for the deploy method.')\n  yield `export type ${name}DeployParams = Expand<Omit<AppFactoryDeployParams, 'createParams' | 'updateParams' | 'deleteParams'> & {`\n  yield IncIndent\n  if (callConfig.createMethods.length) {\n    yield* jsDoc(\n      'Create transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)',\n    )\n    yield `createParams?: ${name}CreateCallParams`\n  }\n  if (callConfig.updateMethods.length) {\n    yield* jsDoc(\n      'Update transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)',\n    )\n    yield `updateParams?: ${name}UpdateCallParams`\n  }\n  if (callConfig.deleteMethods.length) {\n    yield* jsDoc(\n      'Delete transaction parameters to use if a create needs to be issued as part of deployment; use `method` to define ABI call (if available) or leave out for a bare call (if available)',\n    )\n    yield `deleteParams?: ${name}DeleteCallParams`\n  }\n  yield DecIndent\n  yield `}>`\n  yield NewLine\n}\n"],"names":[],"mappings":";;;;AAMgB,SAAA,0BAA0B,CAAC,MAAwB,EAAE,GAAkB,EAAA;AACrF,IAAA,MAAM,sBAAsB,GAC1B,MAAM,KAAK,SAAS,GAAG,GAAG,CAAC,WAAW,CAAC,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAA;IACtI,MAAM,OAAO,GAAG,sBAAsB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACxD,MAAM,cAAc,GAAG,sBAAsB;AAC3C,UAAE,CAAA,WAAA,EAAc,OAAO,GAAG,GAAG,GAAG,EAAE,CAAA,EAAA,EAAK,sBAAsB,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAyB,sBAAA,EAAA,EAAE,CAAI,EAAA,CAAA,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAG,CAAA,CAAA;UACvH,EAAE,CAAA;IACN,OAAO;AACL,QAAA,IAAI,EAAE,cAAc;AACpB,QAAA,UAAU,EAAE,OAAO;KACpB,CAAA;AACH,CAAC;AAEe,SAAA,wBAAwB,CAAC,MAAwB,EAAE,GAAkB,EAAA;AACnF,IAAA,MAAM,oBAAoB,GACxB,MAAM,KAAK,SAAS,GAAG,GAAG,CAAC,WAAW,CAAC,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,MAAM,CAAC,EAAE,OAAO,EAAE,IAAI,CAAA;IAClI,MAAM,OAAO,GAAG,oBAAoB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACtD,MAAM,cAAc,GAAG,oBAAoB;AACzC,UAAE,CAAA,WAAA,EAAc,OAAO,GAAG,GAAG,GAAG,EAAE,CAAA,EAAA,EAAK,oBAAoB,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAyB,sBAAA,EAAA,EAAE,CAAI,EAAA,CAAA,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAG,CAAA,CAAA;UACrH,EAAE,CAAA;IACN,OAAO;AACL,QAAA,IAAI,EAAE,cAAc;AACpB,QAAA,UAAU,EAAE,OAAO;KACpB,CAAA;AACH,CAAC;AAEc,UAAE,WAAW,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,SAAS,EAAE,2BAA2B,EAAoB,EAAA;IACxG,MAAM,IAAI,GAAG,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAEvD,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;AACvC,QAAA,OAAO,KAAK,CAAC,gEAAgE,CAAC,CAAA;QAC9E,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,kBAAA,CAAoB,CAAA;AAC7C,QAAA,MAAM,SAAS,CAAA;AACf,QAAA,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,aAAa,EAAE;YAC7C,MAAM,UAAU,GAAG,0BAA0B,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAC1D,YAAA,IAAI,MAAM,KAAK,SAAS,EAAE;AACxB,gBAAA,MAAM,CAA6D,0DAAA,EAAA,UAAU,CAAC,IAAI,kBAAkB,CAAA;aACrG;iBAAM;AACL,gBAAA,MAAM,UAAU,GAAG,2BAA2B,CAAC,MAAM,CAAC,CAAA;AACtD,gBAAA,IAAI,UAAU,KAAK,MAAM,EAAE;oBACzB,MAAM,UAAU,GAAG,SAAS,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAA;oBAClE,MAAM,CAAA,qBAAA,EAAwB,UAAU,CAAkB,eAAA,EAAA,UAAU,QAAQ,UAAU,CAAC,IAAI,CAAA,gBAAA,CAAkB,CAAA;iBAC9G;gBACD,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;gBACjE,MAAM,CAAA,qBAAA,EAAwB,aAAa,CAAkB,eAAA,EAAA,aAAa,QAAQ,UAAU,CAAC,IAAI,CAAA,gBAAA,CAAkB,CAAA;aACpH;SACF;AACD,QAAA,MAAM,SAAS,CAAA;KAChB;IACD,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;AACvC,QAAA,OAAO,KAAK,CAAC,gEAAgE,CAAC,CAAA;QAC9E,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,kBAAA,CAAoB,CAAA;AAC7C,QAAA,MAAM,SAAS,CAAA;AACf,QAAA,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,aAAa,EAAE;AAC7C,YAAA,IAAI,MAAM,KAAK,SAAS,EAAE;AACxB,gBAAA,MAAM,0DAA0D,CAAA;aACjE;iBAAM;AACL,gBAAA,MAAM,UAAU,GAAG,2BAA2B,CAAC,MAAM,CAAC,CAAA;AACtD,gBAAA,IAAI,UAAU,KAAK,MAAM,EAAE;oBACzB,MAAM,UAAU,GAAG,SAAS,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAA;AAClE,oBAAA,MAAM,CAAwB,qBAAA,EAAA,UAAU,CAAkB,eAAA,EAAA,UAAU,KAAK,CAAA;iBAC1E;gBACD,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;AACjE,gBAAA,MAAM,CAAwB,qBAAA,EAAA,aAAa,CAAkB,eAAA,EAAA,aAAa,KAAK,CAAA;aAChF;SACF;AACD,QAAA,MAAM,SAAS,CAAA;KAChB;IAED,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;AACvC,QAAA,OAAO,KAAK,CAAC,gEAAgE,CAAC,CAAA;QAC9E,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,kBAAA,CAAoB,CAAA;AAC7C,QAAA,MAAM,SAAS,CAAA;AACf,QAAA,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,aAAa,EAAE;AAC7C,YAAA,IAAI,MAAM,KAAK,SAAS,EAAE;AACxB,gBAAA,MAAM,0DAA0D,CAAA;aACjE;iBAAM;AACL,gBAAA,MAAM,UAAU,GAAG,2BAA2B,CAAC,MAAM,CAAC,CAAA;AACtD,gBAAA,IAAI,UAAU,KAAK,MAAM,EAAE;oBACzB,MAAM,UAAU,GAAG,SAAS,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAA;AAClE,oBAAA,MAAM,CAAwB,qBAAA,EAAA,UAAU,CAAkB,eAAA,EAAA,UAAU,KAAK,CAAA;iBAC1E;gBACD,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;AACjE,gBAAA,MAAM,CAAwB,qBAAA,EAAA,aAAa,CAAkB,eAAA,EAAA,aAAa,KAAK,CAAA;aAChF;SACF;AACD,QAAA,MAAM,SAAS,CAAA;KAChB;AAED,IAAA,OAAO,KAAK,CAAC,mDAAmD,CAAC,CAAA;IACjE,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,wGAAA,CAA0G,CAAA;AACnI,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,EAAE;AACnC,QAAA,OAAO,KAAK,CACV,uLAAuL,CACxL,CAAA;QACD,MAAM,CAAA,eAAA,EAAkB,IAAI,CAAA,gBAAA,CAAkB,CAAA;KAC/C;AACD,IAAA,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,EAAE;AACnC,QAAA,OAAO,KAAK,CACV,uLAAuL,CACxL,CAAA;QACD,MAAM,CAAA,eAAA,EAAkB,IAAI,CAAA,gBAAA,CAAkB,CAAA;KAC/C;AACD,IAAA,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,EAAE;AACnC,QAAA,OAAO,KAAK,CACV,uLAAuL,CACxL,CAAA;QACD,MAAM,CAAA,eAAA,EAAkB,IAAI,CAAA,gBAAA,CAAkB,CAAA;KAC/C;AACD,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,IAAI,CAAA;AACV,IAAA,MAAM,OAAO,CAAA;AACf;;;;"}