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

package/client/deploy-types.mjs

@@ -1,94 +1,111 @@
-import { jsDoc, IncIndent, DecIndent, DecIndentAndCloseBlock, NewLine } from '../output/writer.mjs';
+import { jsDoc, IncIndent, DecIndent, NewLine } from '../output/writer.mjs';
 import { BARE_CALL } from './helpers/get-call-config-summary.mjs';
-import { OnCompleteCodeMap } from './utility-types.mjs';
+import { ABIMethod } from 'algosdk';
 
 function getCreateOnCompleteOptions(method, app) {
-    const callConfig = method === BARE_CALL ? app.bare_call_config : app.hints?.[method]?.call_config;
-    const hasNoOp = callConfig?.no_op === 'ALL' || callConfig?.no_op === 'CREATE';
-    const onCompleteType = callConfig
-        ? `(${Object.entries(callConfig)
-            .filter(([_, value]) => value === 'ALL' || value === 'CREATE')
-            .map(([oc]) => OnCompleteCodeMap[oc])
-            .join(' | ')})`
+    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* deployTypes({ app, callConfig, sanitizer }) {
-    const name = sanitizer.makeSafeTypeIdentifier(app.contract.name);
+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(`A factory for available 'create' calls`);
-        yield `export type ${name}CreateCalls = (typeof ${name}CallFactory)['create']`;
-        yield* jsDoc('Defines supported create methods for this smart contract');
+        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 `| (TypedCallParams<undefined> & ${onComplete.type})`;
+                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 `| (TypedCallParams<'${methodSigSafe}'> & ${onComplete.type})`;
+                yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'} & ${onComplete.type} & CreateSchema>`;
             }
         }
         yield DecIndent;
     }
     if (callConfig.updateMethods.length > 0) {
-        yield* jsDoc(`A factory for available 'update' calls`);
-        yield `export type ${name}UpdateCalls = (typeof ${name}CallFactory)['update']`;
-        yield* jsDoc('Defines supported update methods for this smart contract');
+        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 `| TypedCallParams<undefined>`;
+                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 `| TypedCallParams<'${methodSigSafe}'>`;
+                yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'}>`;
             }
         }
         yield DecIndent;
     }
     if (callConfig.deleteMethods.length > 0) {
-        yield* jsDoc(`A factory for available 'delete' calls`);
-        yield `export type ${name}DeleteCalls = (typeof ${name}CallFactory)['delete']`;
-        yield* jsDoc('Defines supported delete methods for this smart contract');
+        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 `| TypedCallParams<undefined>`;
+                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 `| TypedCallParams<'${methodSigSafe}'>`;
+                yield `| Expand<CallParams<'${methodSigSafe}'> & {method: '${methodSigSafe}'}>`;
             }
         }
         yield DecIndent;
     }
     yield* jsDoc('Defines arguments required for the deploy method.');
-    yield `export type ${name}DeployArgs = {`;
+    yield `export type ${name}DeployParams = Expand<Omit<AppFactoryDeployParams, 'createParams' | 'updateParams' | 'deleteParams'> & {`;
     yield IncIndent;
-    yield `deployTimeParams?: TealTemplateParams`;
     if (callConfig.createMethods.length) {
-        yield* jsDoc('A delegate which takes a create call factory and returns the create call params for this smart contract');
-        yield `createCall?: (callFactory: ${name}CreateCalls) => ${name}CreateCallParams`;
+        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('A delegate which takes a update call factory and returns the update call params for this smart contract');
-        yield `updateCall?: (callFactory: ${name}UpdateCalls) => ${name}UpdateCallParams`;
+        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('A delegate which takes a delete call factory and returns the delete call params for this smart contract');
-        yield `deleteCall?: (callFactory: ${name}DeleteCalls) => ${name}DeleteCallParams`;
+        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 DecIndentAndCloseBlock;
+    yield DecIndent;
+    yield `}>`;
     yield NewLine;
 }
 
-export { deployTypes, getCreateOnCompleteOptions };
+export { deployTypes, getCallOnCompleteOptions, getCreateOnCompleteOptions };
 //# sourceMappingURL=deploy-types.mjs.map

package/client/deploy-types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"deploy-types.mjs","sources":["../../src/client/deploy-types.ts"],"sourcesContent":["import { DecIndent, DecIndentAndCloseBlock, DocumentParts, IncIndent, jsDoc, NewLine } from '../output/writer'\n\nimport { BARE_CALL, MethodIdentifier } from './helpers/get-call-config-summary'\nimport { GeneratorContext } from './generator-context'\nimport { AlgoAppSpec, CallConfig } from '../schema/application'\nimport { OnCompleteCodeMap } from './utility-types'\n\nexport function getCreateOnCompleteOptions(method: MethodIdentifier, app: AlgoAppSpec) {\n  const callConfig = method === BARE_CALL ? app.bare_call_config : app.hints?.[method]?.call_config\n  const hasNoOp = callConfig?.no_op === 'ALL' || callConfig?.no_op === 'CREATE'\n  const onCompleteType = callConfig\n    ? `(${Object.entries(callConfig)\n        .filter(([_, value]) => value === 'ALL' || value === 'CREATE')\n        .map(([oc]) => OnCompleteCodeMap[oc as keyof CallConfig])\n        .join(' | ')})`\n    : {}\n  return {\n    type: onCompleteType,\n    isOptional: hasNoOp,\n  }\n}\n\nexport function* deployTypes({ app, callConfig, sanitizer }: GeneratorContext): DocumentParts {\n  const name = sanitizer.makeSafeTypeIdentifier(app.contract.name)\n\n  if (callConfig.createMethods.length > 0) {\n    yield* jsDoc(`A factory for available 'create' calls`)\n    yield `export type ${name}CreateCalls = (typeof ${name}CallFactory)['create']`\n    yield* jsDoc('Defines supported create methods 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 `| (TypedCallParams<undefined> & ${onComplete.type})`\n      } else {\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method)\n        yield `| (TypedCallParams<'${methodSigSafe}'> & ${onComplete.type})`\n      }\n    }\n    yield DecIndent\n  }\n  if (callConfig.updateMethods.length > 0) {\n    yield* jsDoc(`A factory for available 'update' calls`)\n\n    yield `export type ${name}UpdateCalls = (typeof ${name}CallFactory)['update']`\n    yield* jsDoc('Defines supported update methods 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 `| TypedCallParams<undefined>`\n      } else {\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method)\n\n        yield `| TypedCallParams<'${methodSigSafe}'>`\n      }\n    }\n    yield DecIndent\n  }\n\n  if (callConfig.deleteMethods.length > 0) {\n    yield* jsDoc(`A factory for available 'delete' calls`)\n\n    yield `export type ${name}DeleteCalls = (typeof ${name}CallFactory)['delete']`\n\n    yield* jsDoc('Defines supported delete methods 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 `| TypedCallParams<undefined>`\n      } else {\n        const methodSigSafe = sanitizer.makeSafeStringTypeLiteral(method)\n\n        yield `| TypedCallParams<'${methodSigSafe}'>`\n      }\n    }\n    yield DecIndent\n  }\n\n  yield* jsDoc('Defines arguments required for the deploy method.')\n  yield `export type ${name}DeployArgs = {`\n  yield IncIndent\n  yield `deployTimeParams?: TealTemplateParams`\n  if (callConfig.createMethods.length) {\n    yield* jsDoc('A delegate which takes a create call factory and returns the create call params for this smart contract')\n    yield `createCall?: (callFactory: ${name}CreateCalls) => ${name}CreateCallParams`\n  }\n  if (callConfig.updateMethods.length) {\n    yield* jsDoc('A delegate which takes a update call factory and returns the update call params for this smart contract')\n    yield `updateCall?: (callFactory: ${name}UpdateCalls) => ${name}UpdateCallParams`\n  }\n  if (callConfig.deleteMethods.length) {\n    yield* jsDoc('A delegate which takes a delete call factory and returns the delete call params for this smart contract')\n    yield `deleteCall?: (callFactory: ${name}DeleteCalls) => ${name}DeleteCallParams`\n  }\n  yield DecIndentAndCloseBlock\n  yield NewLine\n}\n"],"names":[],"mappings":";;;;AAOgB,SAAA,0BAA0B,CAAC,MAAwB,EAAE,GAAgB,EAAA;IACnF,MAAM,UAAU,GAAG,MAAM,KAAK,SAAS,GAAG,GAAG,CAAC,gBAAgB,GAAG,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,EAAE,WAAW,CAAA;AACjG,IAAA,MAAM,OAAO,GAAG,UAAU,EAAE,KAAK,KAAK,KAAK,IAAI,UAAU,EAAE,KAAK,KAAK,QAAQ,CAAA;IAC7E,MAAM,cAAc,GAAG,UAAU;AAC/B,UAAE,CAAI,CAAA,EAAA,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;AAC3B,aAAA,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,QAAQ,CAAC;AAC7D,aAAA,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,iBAAiB,CAAC,EAAsB,CAAC,CAAC;aACxD,IAAI,CAAC,KAAK,CAAC,CAAG,CAAA,CAAA;UACjB,EAAE,CAAA;IACN,OAAO;AACL,QAAA,IAAI,EAAE,cAAc;AACpB,QAAA,UAAU,EAAE,OAAO;KACpB,CAAA;AACH,CAAC;AAEK,UAAW,WAAW,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,SAAS,EAAoB,EAAA;AAC3E,IAAA,MAAM,IAAI,GAAG,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IAEhE,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;AACvC,QAAA,OAAO,KAAK,CAAC,CAAA,sCAAA,CAAwC,CAAC,CAAA;AACtD,QAAA,MAAM,CAAe,YAAA,EAAA,IAAI,CAAyB,sBAAA,EAAA,IAAI,wBAAwB,CAAA;AAC9E,QAAA,OAAO,KAAK,CAAC,0DAA0D,CAAC,CAAA;QACxE,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,CAAmC,gCAAA,EAAA,UAAU,CAAC,IAAI,GAAG,CAAA;aAC5D;iBAAM;gBACL,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;AACjE,gBAAA,MAAM,uBAAuB,aAAa,CAAA,KAAA,EAAQ,UAAU,CAAC,IAAI,GAAG,CAAA;aACrE;SACF;AACD,QAAA,MAAM,SAAS,CAAA;KAChB;IACD,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;AACvC,QAAA,OAAO,KAAK,CAAC,CAAA,sCAAA,CAAwC,CAAC,CAAA;AAEtD,QAAA,MAAM,CAAe,YAAA,EAAA,IAAI,CAAyB,sBAAA,EAAA,IAAI,wBAAwB,CAAA;AAC9E,QAAA,OAAO,KAAK,CAAC,0DAA0D,CAAC,CAAA;QACxE,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,8BAA8B,CAAA;aACrC;iBAAM;gBACL,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;gBAEjE,MAAM,CAAA,mBAAA,EAAsB,aAAa,CAAA,EAAA,CAAI,CAAA;aAC9C;SACF;AACD,QAAA,MAAM,SAAS,CAAA;KAChB;IAED,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;AACvC,QAAA,OAAO,KAAK,CAAC,CAAA,sCAAA,CAAwC,CAAC,CAAA;AAEtD,QAAA,MAAM,CAAe,YAAA,EAAA,IAAI,CAAyB,sBAAA,EAAA,IAAI,wBAAwB,CAAA;AAE9E,QAAA,OAAO,KAAK,CAAC,0DAA0D,CAAC,CAAA;QACxE,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,8BAA8B,CAAA;aACrC;iBAAM;gBACL,MAAM,aAAa,GAAG,SAAS,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;gBAEjE,MAAM,CAAA,mBAAA,EAAsB,aAAa,CAAA,EAAA,CAAI,CAAA;aAC9C;SACF;AACD,QAAA,MAAM,SAAS,CAAA;KAChB;AAED,IAAA,OAAO,KAAK,CAAC,mDAAmD,CAAC,CAAA;IACjE,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,cAAA,CAAgB,CAAA;AACzC,IAAA,MAAM,SAAS,CAAA;AACf,IAAA,MAAM,uCAAuC,CAAA;AAC7C,IAAA,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,EAAE;AACnC,QAAA,OAAO,KAAK,CAAC,yGAAyG,CAAC,CAAA;AACvH,QAAA,MAAM,CAA8B,2BAAA,EAAA,IAAI,CAAmB,gBAAA,EAAA,IAAI,kBAAkB,CAAA;KAClF;AACD,IAAA,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,EAAE;AACnC,QAAA,OAAO,KAAK,CAAC,yGAAyG,CAAC,CAAA;AACvH,QAAA,MAAM,CAA8B,2BAAA,EAAA,IAAI,CAAmB,gBAAA,EAAA,IAAI,kBAAkB,CAAA;KAClF;AACD,IAAA,IAAI,UAAU,CAAC,aAAa,CAAC,MAAM,EAAE;AACnC,QAAA,OAAO,KAAK,CAAC,yGAAyG,CAAC,CAAA;AACvH,QAAA,MAAM,CAA8B,2BAAA,EAAA,IAAI,CAAmB,gBAAA,EAAA,IAAI,kBAAkB,CAAA;KAClF;AACD,IAAA,MAAM,sBAAsB,CAAA;AAC5B,IAAA,MAAM,OAAO,CAAA;AACf;;;;"}
+{"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;;;;"}

package/client/generate.d.ts

@@ -1,4 +1,4 @@
 import { DocumentParts } from '../output/writer';
-import { AlgoAppSpec } from '../schema/application';
 import { GeneratorOptions } from './generator-context';
-export declare function generate(app: AlgoAppSpec, options?: GeneratorOptions): DocumentParts;
+import { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56';
+export declare function generate(app: Arc56Contract, options?: GeneratorOptions): DocumentParts;

package/client/generate.js

@@ -1,15 +1,22 @@
 'use strict';
 
 var writer = require('../output/writer.js');
-var callFactory = require('./call-factory.js');
-var callClient = require('./call-client.js');
+var paramsFactory = require('./params-factory.js');
+var appClient = require('./app-client.js');
 var deployTypes = require('./deploy-types.js');
 var utilityTypes = require('./utility-types.js');
 var imports = require('./imports.js');
 var generatorContext = require('./generator-context.js');
 var appTypes = require('./app-types.js');
 var callComposerTypes = require('./call-composer-types.js');
+var appFactory = require('./app-factory.js');
 
+function convertStructs(s, sanitizer) {
+    return Object.fromEntries(Object.keys(s).map((key) => [
+        sanitizer.makeSafePropertyIdentifier(key),
+        typeof s[key] === 'string' ? s[key] : convertStructs(s[key], sanitizer),
+    ]));
+}
 function* generate(app, options = { preserveNames: false }) {
     const ctx = generatorContext.createGeneratorContext(app, options);
     yield `/* eslint-disable */`;
@@ -17,10 +24,13 @@ function* generate(app, options = { preserveNames: false }) {
     yield `/**`;
     yield ` * This file was automatically generated by @algorandfoundation/algokit-client-generator.`;
     yield ` * DO NOT MODIFY IT BY HAND.`;
-    yield ` * requires: @algorandfoundation/algokit-utils: ^2`;
+    yield ` * requires: @algorandfoundation/algokit-utils: ^3`;
     yield ` */`;
     yield* imports.imports();
-    yield* writer.inline('export const APP_SPEC: AppSpec = ', JSON.stringify(app, undefined, 2));
+    // Change the structs definition to sanitize property names according to the defined rules
+    // for instance, this may (unless you passed in --preserve-names) convert properties like my_prop to myProp
+    app.structs = Object.fromEntries(Object.keys(app.structs).map((key) => [key, convertStructs(app.structs[key], ctx.sanitizer)]));
+    yield* writer.inline('export const APP_SPEC: Arc56Contract = ', JSON.stringify(app));
     yield writer.NewLine;
     yield* utilityTypes.utilityTypes();
     yield writer.NewLine;
@@ -28,10 +38,12 @@ function* generate(app, options = { preserveNames: false }) {
     yield* deployTypes.deployTypes(ctx);
     yield writer.NewLine;
     // Write a call factory
-    yield* callFactory.callFactory(ctx);
+    yield* paramsFactory.paramsFactory(ctx);
     yield writer.NewLine;
+    // Write a factory
+    yield* appFactory.appFactory(ctx);
     // Write a client
-    yield* callClient.callClient(ctx);
+    yield* appClient.appClient(ctx);
     yield* callComposerTypes.callComposerType(ctx);
 }
 

package/client/generate.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate.js","sources":["../../src/client/generate.ts"],"sourcesContent":["import { DocumentParts, inline, NewLine } from '../output/writer'\nimport { AlgoAppSpec } from '../schema/application'\nimport { callFactory } from './call-factory'\nimport { callClient } from './call-client'\nimport { deployTypes } from './deploy-types'\nimport { utilityTypes } from './utility-types'\nimport { imports } from './imports'\nimport { createGeneratorContext, GeneratorOptions } from './generator-context'\nimport { appTypes } from './app-types'\nimport { callComposerType } from './call-composer-types'\n\nexport function* generate(app: AlgoAppSpec, options: GeneratorOptions = { preserveNames: false }): DocumentParts {\n  const ctx = createGeneratorContext(app, options)\n  yield `/* eslint-disable */`\n  yield `// @ts-nocheck`\n  yield `/**`\n  yield ` * This file was automatically generated by @algorandfoundation/algokit-client-generator.`\n  yield ` * DO NOT MODIFY IT BY HAND.`\n  yield ` * requires: @algorandfoundation/algokit-utils: ^2`\n  yield ` */`\n\n  yield* imports()\n  yield* inline('export const APP_SPEC: AppSpec = ', JSON.stringify(app, undefined, 2))\n  yield NewLine\n\n  yield* utilityTypes()\n  yield NewLine\n  yield* appTypes(ctx)\n  yield* deployTypes(ctx)\n  yield NewLine\n\n  // Write a call factory\n  yield* callFactory(ctx)\n  yield NewLine\n  // Write a client\n  yield* callClient(ctx)\n\n  yield* callComposerType(ctx)\n}\n"],"names":["createGeneratorContext","imports","inline","NewLine","utilityTypes","appTypes","deployTypes","callFactory","callClient","callComposerType"],"mappings":";;;;;;;;;;;;AAWe,UAAE,QAAQ,CAAC,GAAgB,EAAE,OAAA,GAA4B,EAAE,aAAa,EAAE,KAAK,EAAE,EAAA;IAC9F,MAAM,GAAG,GAAGA,uCAAsB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;AAChD,IAAA,MAAM,sBAAsB,CAAA;AAC5B,IAAA,MAAM,gBAAgB,CAAA;AACtB,IAAA,MAAM,KAAK,CAAA;AACX,IAAA,MAAM,2FAA2F,CAAA;AACjG,IAAA,MAAM,8BAA8B,CAAA;AACpC,IAAA,MAAM,oDAAoD,CAAA;AAC1D,IAAA,MAAM,KAAK,CAAA;AAEX,IAAA,OAAOC,eAAO,EAAE,CAAA;AAChB,IAAA,OAAOC,aAAM,CAAC,mCAAmC,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAA;AACrF,IAAA,MAAMC,cAAO,CAAA;AAEb,IAAA,OAAOC,yBAAY,EAAE,CAAA;AACrB,IAAA,MAAMD,cAAO,CAAA;AACb,IAAA,OAAOE,iBAAQ,CAAC,GAAG,CAAC,CAAA;AACpB,IAAA,OAAOC,uBAAW,CAAC,GAAG,CAAC,CAAA;AACvB,IAAA,MAAMH,cAAO,CAAA;;AAGb,IAAA,OAAOI,uBAAW,CAAC,GAAG,CAAC,CAAA;AACvB,IAAA,MAAMJ,cAAO,CAAA;;AAEb,IAAA,OAAOK,qBAAU,CAAC,GAAG,CAAC,CAAA;AAEtB,IAAA,OAAOC,kCAAgB,CAAC,GAAG,CAAC,CAAA;AAC9B;;;;"}
+{"version":3,"file":"generate.js","sources":["../../src/client/generate.ts"],"sourcesContent":["import { DocumentParts, inline, NewLine } from '../output/writer'\nimport { paramsFactory } from './params-factory'\nimport { appClient } from './app-client'\nimport { deployTypes } from './deploy-types'\nimport { utilityTypes } from './utility-types'\nimport { imports } from './imports'\nimport { createGeneratorContext, GeneratorOptions } from './generator-context'\nimport { appTypes } from './app-types'\nimport { callComposerType } from './call-composer-types'\nimport { Arc56Contract, StructFields } from '@algorandfoundation/algokit-utils/types/app-arc56'\nimport { appFactory } from './app-factory'\nimport { Sanitizer } from '../util/sanitization'\n\nfunction convertStructs(s: StructFields, sanitizer: Sanitizer): StructFields {\n  return Object.fromEntries(\n    Object.keys(s).map((key) => [\n      sanitizer.makeSafePropertyIdentifier(key),\n      typeof s[key] === 'string' ? s[key] : convertStructs(s[key] as StructFields, sanitizer),\n    ]),\n  )\n}\n\nexport function* generate(app: Arc56Contract, options: GeneratorOptions = { preserveNames: false }): DocumentParts {\n  const ctx = createGeneratorContext(app, options)\n  yield `/* eslint-disable */`\n  yield `// @ts-nocheck`\n  yield `/**`\n  yield ` * This file was automatically generated by @algorandfoundation/algokit-client-generator.`\n  yield ` * DO NOT MODIFY IT BY HAND.`\n  yield ` * requires: @algorandfoundation/algokit-utils: ^3`\n  yield ` */`\n\n  yield* imports()\n  // Change the structs definition to sanitize property names according to the defined rules\n  // for instance, this may (unless you passed in --preserve-names) convert properties like my_prop to myProp\n  app.structs = Object.fromEntries(Object.keys(app.structs).map((key) => [key, convertStructs(app.structs[key], ctx.sanitizer)]))\n  yield* inline('export const APP_SPEC: Arc56Contract = ', JSON.stringify(app))\n  yield NewLine\n\n  yield* utilityTypes()\n  yield NewLine\n  yield* appTypes(ctx)\n  yield* deployTypes(ctx)\n  yield NewLine\n\n  // Write a call factory\n  yield* paramsFactory(ctx)\n  yield NewLine\n  // Write a factory\n  yield* appFactory(ctx)\n  // Write a client\n  yield* appClient(ctx)\n\n  yield* callComposerType(ctx)\n}\n"],"names":["createGeneratorContext","imports","inline","NewLine","utilityTypes","appTypes","deployTypes","paramsFactory","appFactory","appClient","callComposerType"],"mappings":";;;;;;;;;;;;;AAaA,SAAS,cAAc,CAAC,CAAe,EAAE,SAAoB,EAAA;AAC3D,IAAA,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK;AAC1B,QAAA,SAAS,CAAC,0BAA0B,CAAC,GAAG,CAAC;QACzC,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,CAAiB,EAAE,SAAS,CAAC;AACxF,KAAA,CAAC,CACH,CAAA;AACH,CAAC;AAEc,UAAE,QAAQ,CAAC,GAAkB,EAAE,OAAA,GAA4B,EAAE,aAAa,EAAE,KAAK,EAAE,EAAA;IAChG,MAAM,GAAG,GAAGA,uCAAsB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;AAChD,IAAA,MAAM,sBAAsB,CAAA;AAC5B,IAAA,MAAM,gBAAgB,CAAA;AACtB,IAAA,MAAM,KAAK,CAAA;AACX,IAAA,MAAM,2FAA2F,CAAA;AACjG,IAAA,MAAM,8BAA8B,CAAA;AACpC,IAAA,MAAM,oDAAoD,CAAA;AAC1D,IAAA,MAAM,KAAK,CAAA;AAEX,IAAA,OAAOC,eAAO,EAAE,CAAA;;;AAGhB,IAAA,GAAG,CAAC,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,EAAE,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;AAC/H,IAAA,OAAOC,aAAM,CAAC,yCAAyC,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;AAC7E,IAAA,MAAMC,cAAO,CAAA;AAEb,IAAA,OAAOC,yBAAY,EAAE,CAAA;AACrB,IAAA,MAAMD,cAAO,CAAA;AACb,IAAA,OAAOE,iBAAQ,CAAC,GAAG,CAAC,CAAA;AACpB,IAAA,OAAOC,uBAAW,CAAC,GAAG,CAAC,CAAA;AACvB,IAAA,MAAMH,cAAO,CAAA;;AAGb,IAAA,OAAOI,2BAAa,CAAC,GAAG,CAAC,CAAA;AACzB,IAAA,MAAMJ,cAAO,CAAA;;AAEb,IAAA,OAAOK,qBAAU,CAAC,GAAG,CAAC,CAAA;;AAEtB,IAAA,OAAOC,mBAAS,CAAC,GAAG,CAAC,CAAA;AAErB,IAAA,OAAOC,kCAAgB,CAAC,GAAG,CAAC,CAAA;AAC9B;;;;"}

package/client/generate.mjs

@@ -1,13 +1,20 @@
 import { inline, NewLine } from '../output/writer.mjs';
-import { callFactory } from './call-factory.mjs';
-import { callClient } from './call-client.mjs';
+import { paramsFactory } from './params-factory.mjs';
+import { appClient } from './app-client.mjs';
 import { deployTypes } from './deploy-types.mjs';
 import { utilityTypes } from './utility-types.mjs';
 import { imports } from './imports.mjs';
 import { createGeneratorContext } from './generator-context.mjs';
 import { appTypes } from './app-types.mjs';
 import { callComposerType } from './call-composer-types.mjs';
+import { appFactory } from './app-factory.mjs';
 
+function convertStructs(s, sanitizer) {
+    return Object.fromEntries(Object.keys(s).map((key) => [
+        sanitizer.makeSafePropertyIdentifier(key),
+        typeof s[key] === 'string' ? s[key] : convertStructs(s[key], sanitizer),
+    ]));
+}
 function* generate(app, options = { preserveNames: false }) {
     const ctx = createGeneratorContext(app, options);
     yield `/* eslint-disable */`;
@@ -15,10 +22,13 @@ function* generate(app, options = { preserveNames: false }) {
     yield `/**`;
     yield ` * This file was automatically generated by @algorandfoundation/algokit-client-generator.`;
     yield ` * DO NOT MODIFY IT BY HAND.`;
-    yield ` * requires: @algorandfoundation/algokit-utils: ^2`;
+    yield ` * requires: @algorandfoundation/algokit-utils: ^3`;
     yield ` */`;
     yield* imports();
-    yield* inline('export const APP_SPEC: AppSpec = ', JSON.stringify(app, undefined, 2));
+    // Change the structs definition to sanitize property names according to the defined rules
+    // for instance, this may (unless you passed in --preserve-names) convert properties like my_prop to myProp
+    app.structs = Object.fromEntries(Object.keys(app.structs).map((key) => [key, convertStructs(app.structs[key], ctx.sanitizer)]));
+    yield* inline('export const APP_SPEC: Arc56Contract = ', JSON.stringify(app));
     yield NewLine;
     yield* utilityTypes();
     yield NewLine;
@@ -26,10 +36,12 @@ function* generate(app, options = { preserveNames: false }) {
     yield* deployTypes(ctx);
     yield NewLine;
     // Write a call factory
-    yield* callFactory(ctx);
+    yield* paramsFactory(ctx);
     yield NewLine;
+    // Write a factory
+    yield* appFactory(ctx);
     // Write a client
-    yield* callClient(ctx);
+    yield* appClient(ctx);
     yield* callComposerType(ctx);
 }
 

package/client/generate.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"generate.mjs","sources":["../../src/client/generate.ts"],"sourcesContent":["import { DocumentParts, inline, NewLine } from '../output/writer'\nimport { AlgoAppSpec } from '../schema/application'\nimport { callFactory } from './call-factory'\nimport { callClient } from './call-client'\nimport { deployTypes } from './deploy-types'\nimport { utilityTypes } from './utility-types'\nimport { imports } from './imports'\nimport { createGeneratorContext, GeneratorOptions } from './generator-context'\nimport { appTypes } from './app-types'\nimport { callComposerType } from './call-composer-types'\n\nexport function* generate(app: AlgoAppSpec, options: GeneratorOptions = { preserveNames: false }): DocumentParts {\n  const ctx = createGeneratorContext(app, options)\n  yield `/* eslint-disable */`\n  yield `// @ts-nocheck`\n  yield `/**`\n  yield ` * This file was automatically generated by @algorandfoundation/algokit-client-generator.`\n  yield ` * DO NOT MODIFY IT BY HAND.`\n  yield ` * requires: @algorandfoundation/algokit-utils: ^2`\n  yield ` */`\n\n  yield* imports()\n  yield* inline('export const APP_SPEC: AppSpec = ', JSON.stringify(app, undefined, 2))\n  yield NewLine\n\n  yield* utilityTypes()\n  yield NewLine\n  yield* appTypes(ctx)\n  yield* deployTypes(ctx)\n  yield NewLine\n\n  // Write a call factory\n  yield* callFactory(ctx)\n  yield NewLine\n  // Write a client\n  yield* callClient(ctx)\n\n  yield* callComposerType(ctx)\n}\n"],"names":[],"mappings":";;;;;;;;;;AAWe,UAAE,QAAQ,CAAC,GAAgB,EAAE,OAAA,GAA4B,EAAE,aAAa,EAAE,KAAK,EAAE,EAAA;IAC9F,MAAM,GAAG,GAAG,sBAAsB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;AAChD,IAAA,MAAM,sBAAsB,CAAA;AAC5B,IAAA,MAAM,gBAAgB,CAAA;AACtB,IAAA,MAAM,KAAK,CAAA;AACX,IAAA,MAAM,2FAA2F,CAAA;AACjG,IAAA,MAAM,8BAA8B,CAAA;AACpC,IAAA,MAAM,oDAAoD,CAAA;AAC1D,IAAA,MAAM,KAAK,CAAA;AAEX,IAAA,OAAO,OAAO,EAAE,CAAA;AAChB,IAAA,OAAO,MAAM,CAAC,mCAAmC,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAA;AACrF,IAAA,MAAM,OAAO,CAAA;AAEb,IAAA,OAAO,YAAY,EAAE,CAAA;AACrB,IAAA,MAAM,OAAO,CAAA;AACb,IAAA,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAA;AACpB,IAAA,OAAO,WAAW,CAAC,GAAG,CAAC,CAAA;AACvB,IAAA,MAAM,OAAO,CAAA;;AAGb,IAAA,OAAO,WAAW,CAAC,GAAG,CAAC,CAAA;AACvB,IAAA,MAAM,OAAO,CAAA;;AAEb,IAAA,OAAO,UAAU,CAAC,GAAG,CAAC,CAAA;AAEtB,IAAA,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;AAC9B;;;;"}
+{"version":3,"file":"generate.mjs","sources":["../../src/client/generate.ts"],"sourcesContent":["import { DocumentParts, inline, NewLine } from '../output/writer'\nimport { paramsFactory } from './params-factory'\nimport { appClient } from './app-client'\nimport { deployTypes } from './deploy-types'\nimport { utilityTypes } from './utility-types'\nimport { imports } from './imports'\nimport { createGeneratorContext, GeneratorOptions } from './generator-context'\nimport { appTypes } from './app-types'\nimport { callComposerType } from './call-composer-types'\nimport { Arc56Contract, StructFields } from '@algorandfoundation/algokit-utils/types/app-arc56'\nimport { appFactory } from './app-factory'\nimport { Sanitizer } from '../util/sanitization'\n\nfunction convertStructs(s: StructFields, sanitizer: Sanitizer): StructFields {\n  return Object.fromEntries(\n    Object.keys(s).map((key) => [\n      sanitizer.makeSafePropertyIdentifier(key),\n      typeof s[key] === 'string' ? s[key] : convertStructs(s[key] as StructFields, sanitizer),\n    ]),\n  )\n}\n\nexport function* generate(app: Arc56Contract, options: GeneratorOptions = { preserveNames: false }): DocumentParts {\n  const ctx = createGeneratorContext(app, options)\n  yield `/* eslint-disable */`\n  yield `// @ts-nocheck`\n  yield `/**`\n  yield ` * This file was automatically generated by @algorandfoundation/algokit-client-generator.`\n  yield ` * DO NOT MODIFY IT BY HAND.`\n  yield ` * requires: @algorandfoundation/algokit-utils: ^3`\n  yield ` */`\n\n  yield* imports()\n  // Change the structs definition to sanitize property names according to the defined rules\n  // for instance, this may (unless you passed in --preserve-names) convert properties like my_prop to myProp\n  app.structs = Object.fromEntries(Object.keys(app.structs).map((key) => [key, convertStructs(app.structs[key], ctx.sanitizer)]))\n  yield* inline('export const APP_SPEC: Arc56Contract = ', JSON.stringify(app))\n  yield NewLine\n\n  yield* utilityTypes()\n  yield NewLine\n  yield* appTypes(ctx)\n  yield* deployTypes(ctx)\n  yield NewLine\n\n  // Write a call factory\n  yield* paramsFactory(ctx)\n  yield NewLine\n  // Write a factory\n  yield* appFactory(ctx)\n  // Write a client\n  yield* appClient(ctx)\n\n  yield* callComposerType(ctx)\n}\n"],"names":[],"mappings":";;;;;;;;;;;AAaA,SAAS,cAAc,CAAC,CAAe,EAAE,SAAoB,EAAA;AAC3D,IAAA,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK;AAC1B,QAAA,SAAS,CAAC,0BAA0B,CAAC,GAAG,CAAC;QACzC,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,CAAiB,EAAE,SAAS,CAAC;AACxF,KAAA,CAAC,CACH,CAAA;AACH,CAAC;AAEc,UAAE,QAAQ,CAAC,GAAkB,EAAE,OAAA,GAA4B,EAAE,aAAa,EAAE,KAAK,EAAE,EAAA;IAChG,MAAM,GAAG,GAAG,sBAAsB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;AAChD,IAAA,MAAM,sBAAsB,CAAA;AAC5B,IAAA,MAAM,gBAAgB,CAAA;AACtB,IAAA,MAAM,KAAK,CAAA;AACX,IAAA,MAAM,2FAA2F,CAAA;AACjG,IAAA,MAAM,8BAA8B,CAAA;AACpC,IAAA,MAAM,oDAAoD,CAAA;AAC1D,IAAA,MAAM,KAAK,CAAA;AAEX,IAAA,OAAO,OAAO,EAAE,CAAA;;;AAGhB,IAAA,GAAG,CAAC,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,EAAE,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;AAC/H,IAAA,OAAO,MAAM,CAAC,yCAAyC,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;AAC7E,IAAA,MAAM,OAAO,CAAA;AAEb,IAAA,OAAO,YAAY,EAAE,CAAA;AACrB,IAAA,MAAM,OAAO,CAAA;AACb,IAAA,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAA;AACpB,IAAA,OAAO,WAAW,CAAC,GAAG,CAAC,CAAA;AACvB,IAAA,MAAM,OAAO,CAAA;;AAGb,IAAA,OAAO,aAAa,CAAC,GAAG,CAAC,CAAA;AACzB,IAAA,MAAM,OAAO,CAAA;;AAEb,IAAA,OAAO,UAAU,CAAC,GAAG,CAAC,CAAA;;AAEtB,IAAA,OAAO,SAAS,CAAC,GAAG,CAAC,CAAA;AAErB,IAAA,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;AAC9B;;;;"}

package/client/generator-context.d.ts

@@ -1,8 +1,8 @@
-import { AlgoAppSpec } from '../schema/application';
 import { CallConfigSummary } from './helpers/get-call-config-summary';
 import { Sanitizer } from '../util/sanitization';
+import { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56';
 export type GeneratorContext = {
-    app: AlgoAppSpec;
+    app: Arc56Contract;
     name: string;
     callConfig: CallConfigSummary;
     methodSignatureToUniqueName: Record<string, string>;
@@ -11,9 +11,9 @@ export type GeneratorContext = {
 export type GeneratorOptions = {
     preserveNames: boolean;
 };
-export declare const createGeneratorContext: (app: AlgoAppSpec, options: GeneratorOptions) => {
+export declare const createGeneratorContext: (app: Arc56Contract, options: GeneratorOptions) => {
     sanitizer: Sanitizer;
-    app: AlgoAppSpec;
+    app: Arc56Contract;
     name: string;
     callConfig: CallConfigSummary;
     methodSignatureToUniqueName: Record<string, string>;

package/client/generator-context.js

@@ -2,37 +2,18 @@
 
 var getCallConfigSummary = require('./helpers/get-call-config-summary.js');
 var sanitization = require('../util/sanitization.js');
-var algokit = require('@algorandfoundation/algokit-utils');
-
-function _interopNamespaceDefault(e) {
-    var n = Object.create(null);
-    if (e) {
-        Object.keys(e).forEach(function (k) {
-            if (k !== 'default') {
-                var d = Object.getOwnPropertyDescriptor(e, k);
-                Object.defineProperty(n, k, d.get ? d : {
-                    enumerable: true,
-                    get: function () { return e[k]; }
-                });
-            }
-        });
-    }
-    n.default = e;
-    return Object.freeze(n);
-}
-
-var algokit__namespace = /*#__PURE__*/_interopNamespaceDefault(algokit);
+var algosdk = require('algosdk');
 
 const createGeneratorContext = (app, options) => {
     const sanitizer = sanitization.getSanitizer(options);
     return {
         sanitizer,
         app,
-        name: sanitizer.makeSafeTypeIdentifier(app.contract.name),
+        name: sanitizer.makeSafeTypeIdentifier(app.name),
         callConfig: getCallConfigSummary.getCallConfigSummary(app),
-        methodSignatureToUniqueName: app.contract.methods.reduce((acc, cur) => {
-            const signature = algokit__namespace.getABIMethodSignature(cur);
-            acc[signature] = app.contract.methods.some((m) => m.name === cur.name && m !== cur) ? signature : cur.name;
+        methodSignatureToUniqueName: app.methods.reduce((acc, cur) => {
+            const signature = new algosdk.ABIMethod(cur).getSignature();
+            acc[signature] = app.methods.some((m) => m.name === cur.name && m !== cur) ? signature : cur.name;
             return acc;
         }, {}),
     };

package/client/generator-context.js.map

@@ -1 +1 @@
-{"version":3,"file":"generator-context.js","sources":["../../src/client/generator-context.ts"],"sourcesContent":["import { AlgoAppSpec } from '../schema/application'\nimport { CallConfigSummary, getCallConfigSummary } from './helpers/get-call-config-summary'\nimport { getSanitizer, Sanitizer } from '../util/sanitization'\nimport * as algokit from '@algorandfoundation/algokit-utils'\n\nexport type GeneratorContext = {\n  app: AlgoAppSpec\n  name: string\n  callConfig: CallConfigSummary\n  methodSignatureToUniqueName: Record<string, string>\n  sanitizer: Sanitizer\n}\n\nexport type GeneratorOptions = {\n  preserveNames: boolean\n}\n\nexport const createGeneratorContext = (app: AlgoAppSpec, options: GeneratorOptions) => {\n  const sanitizer = getSanitizer(options)\n  return {\n    sanitizer,\n    app,\n    name: sanitizer.makeSafeTypeIdentifier(app.contract.name),\n    callConfig: getCallConfigSummary(app),\n    methodSignatureToUniqueName: app.contract.methods.reduce(\n      (acc, cur) => {\n        const signature = algokit.getABIMethodSignature(cur)\n        acc[signature] = app.contract.methods.some((m) => m.name === cur.name && m !== cur) ? signature : cur.name\n        return acc\n      },\n      {} as Record<string, string>,\n    ),\n  }\n}\n"],"names":["getSanitizer","getCallConfigSummary","algokit"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;MAiBa,sBAAsB,GAAG,CAAC,GAAgB,EAAE,OAAyB,KAAI;AACpF,IAAA,MAAM,SAAS,GAAGA,yBAAY,CAAC,OAAO,CAAC,CAAA;IACvC,OAAO;QACL,SAAS;QACT,GAAG;QACH,IAAI,EAAE,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;AACzD,QAAA,UAAU,EAAEC,yCAAoB,CAAC,GAAG,CAAC;AACrC,QAAA,2BAA2B,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CACtD,CAAC,GAAG,EAAE,GAAG,KAAI;YACX,MAAM,SAAS,GAAGC,kBAAO,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAA;AACpD,YAAA,GAAG,CAAC,SAAS,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,SAAS,GAAG,GAAG,CAAC,IAAI,CAAA;AAC1G,YAAA,OAAO,GAAG,CAAA;SACX,EACD,EAA4B,CAC7B;KACF,CAAA;AACH;;;;"}
+{"version":3,"file":"generator-context.js","sources":["../../src/client/generator-context.ts"],"sourcesContent":["import { CallConfigSummary, getCallConfigSummary } from './helpers/get-call-config-summary'\nimport { getSanitizer, Sanitizer } from '../util/sanitization'\nimport { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56'\nimport { ABIMethod } from 'algosdk'\n\nexport type GeneratorContext = {\n  app: Arc56Contract\n  name: string\n  callConfig: CallConfigSummary\n  methodSignatureToUniqueName: Record<string, string>\n  sanitizer: Sanitizer\n}\n\nexport type GeneratorOptions = {\n  preserveNames: boolean\n}\n\nexport const createGeneratorContext = (app: Arc56Contract, options: GeneratorOptions) => {\n  const sanitizer = getSanitizer(options)\n  return {\n    sanitizer,\n    app,\n    name: sanitizer.makeSafeTypeIdentifier(app.name),\n    callConfig: getCallConfigSummary(app),\n    methodSignatureToUniqueName: app.methods.reduce(\n      (acc, cur) => {\n        const signature = new ABIMethod(cur).getSignature()\n        acc[signature] = app.methods.some((m) => m.name === cur.name && m !== cur) ? signature : cur.name\n        return acc\n      },\n      {} as Record<string, string>,\n    ),\n  }\n}\n"],"names":["getSanitizer","getCallConfigSummary","ABIMethod"],"mappings":";;;;;;MAiBa,sBAAsB,GAAG,CAAC,GAAkB,EAAE,OAAyB,KAAI;AACtF,IAAA,MAAM,SAAS,GAAGA,yBAAY,CAAC,OAAO,CAAC,CAAA;IACvC,OAAO;QACL,SAAS;QACT,GAAG;QACH,IAAI,EAAE,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC;AAChD,QAAA,UAAU,EAAEC,yCAAoB,CAAC,GAAG,CAAC;AACrC,QAAA,2BAA2B,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAC7C,CAAC,GAAG,EAAE,GAAG,KAAI;YACX,MAAM,SAAS,GAAG,IAAIC,iBAAS,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,CAAA;AACnD,YAAA,GAAG,CAAC,SAAS,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,SAAS,GAAG,GAAG,CAAC,IAAI,CAAA;AACjG,YAAA,OAAO,GAAG,CAAA;SACX,EACD,EAA4B,CAC7B;KACF,CAAA;AACH;;;;"}

package/client/generator-context.mjs

@@ -1,17 +1,17 @@
 import { getCallConfigSummary } from './helpers/get-call-config-summary.mjs';
 import { getSanitizer } from '../util/sanitization.mjs';
-import * as algokit from '@algorandfoundation/algokit-utils';
+import { ABIMethod } from 'algosdk';
 
 const createGeneratorContext = (app, options) => {
     const sanitizer = getSanitizer(options);
     return {
         sanitizer,
         app,
-        name: sanitizer.makeSafeTypeIdentifier(app.contract.name),
+        name: sanitizer.makeSafeTypeIdentifier(app.name),
         callConfig: getCallConfigSummary(app),
-        methodSignatureToUniqueName: app.contract.methods.reduce((acc, cur) => {
-            const signature = algokit.getABIMethodSignature(cur);
-            acc[signature] = app.contract.methods.some((m) => m.name === cur.name && m !== cur) ? signature : cur.name;
+        methodSignatureToUniqueName: app.methods.reduce((acc, cur) => {
+            const signature = new ABIMethod(cur).getSignature();
+            acc[signature] = app.methods.some((m) => m.name === cur.name && m !== cur) ? signature : cur.name;
             return acc;
         }, {}),
     };

package/client/generator-context.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"generator-context.mjs","sources":["../../src/client/generator-context.ts"],"sourcesContent":["import { AlgoAppSpec } from '../schema/application'\nimport { CallConfigSummary, getCallConfigSummary } from './helpers/get-call-config-summary'\nimport { getSanitizer, Sanitizer } from '../util/sanitization'\nimport * as algokit from '@algorandfoundation/algokit-utils'\n\nexport type GeneratorContext = {\n  app: AlgoAppSpec\n  name: string\n  callConfig: CallConfigSummary\n  methodSignatureToUniqueName: Record<string, string>\n  sanitizer: Sanitizer\n}\n\nexport type GeneratorOptions = {\n  preserveNames: boolean\n}\n\nexport const createGeneratorContext = (app: AlgoAppSpec, options: GeneratorOptions) => {\n  const sanitizer = getSanitizer(options)\n  return {\n    sanitizer,\n    app,\n    name: sanitizer.makeSafeTypeIdentifier(app.contract.name),\n    callConfig: getCallConfigSummary(app),\n    methodSignatureToUniqueName: app.contract.methods.reduce(\n      (acc, cur) => {\n        const signature = algokit.getABIMethodSignature(cur)\n        acc[signature] = app.contract.methods.some((m) => m.name === cur.name && m !== cur) ? signature : cur.name\n        return acc\n      },\n      {} as Record<string, string>,\n    ),\n  }\n}\n"],"names":[],"mappings":";;;;MAiBa,sBAAsB,GAAG,CAAC,GAAgB,EAAE,OAAyB,KAAI;AACpF,IAAA,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAA;IACvC,OAAO;QACL,SAAS;QACT,GAAG;QACH,IAAI,EAAE,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;AACzD,QAAA,UAAU,EAAE,oBAAoB,CAAC,GAAG,CAAC;AACrC,QAAA,2BAA2B,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CACtD,CAAC,GAAG,EAAE,GAAG,KAAI;YACX,MAAM,SAAS,GAAG,OAAO,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAA;AACpD,YAAA,GAAG,CAAC,SAAS,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,SAAS,GAAG,GAAG,CAAC,IAAI,CAAA;AAC1G,YAAA,OAAO,GAAG,CAAA;SACX,EACD,EAA4B,CAC7B;KACF,CAAA;AACH;;;;"}
+{"version":3,"file":"generator-context.mjs","sources":["../../src/client/generator-context.ts"],"sourcesContent":["import { CallConfigSummary, getCallConfigSummary } from './helpers/get-call-config-summary'\nimport { getSanitizer, Sanitizer } from '../util/sanitization'\nimport { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56'\nimport { ABIMethod } from 'algosdk'\n\nexport type GeneratorContext = {\n  app: Arc56Contract\n  name: string\n  callConfig: CallConfigSummary\n  methodSignatureToUniqueName: Record<string, string>\n  sanitizer: Sanitizer\n}\n\nexport type GeneratorOptions = {\n  preserveNames: boolean\n}\n\nexport const createGeneratorContext = (app: Arc56Contract, options: GeneratorOptions) => {\n  const sanitizer = getSanitizer(options)\n  return {\n    sanitizer,\n    app,\n    name: sanitizer.makeSafeTypeIdentifier(app.name),\n    callConfig: getCallConfigSummary(app),\n    methodSignatureToUniqueName: app.methods.reduce(\n      (acc, cur) => {\n        const signature = new ABIMethod(cur).getSignature()\n        acc[signature] = app.methods.some((m) => m.name === cur.name && m !== cur) ? signature : cur.name\n        return acc\n      },\n      {} as Record<string, string>,\n    ),\n  }\n}\n"],"names":[],"mappings":";;;;MAiBa,sBAAsB,GAAG,CAAC,GAAkB,EAAE,OAAyB,KAAI;AACtF,IAAA,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAA;IACvC,OAAO;QACL,SAAS;QACT,GAAG;QACH,IAAI,EAAE,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC;AAChD,QAAA,UAAU,EAAE,oBAAoB,CAAC,GAAG,CAAC;AACrC,QAAA,2BAA2B,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAC7C,CAAC,GAAG,EAAE,GAAG,KAAI;YACX,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,CAAA;AACnD,YAAA,GAAG,CAAC,SAAS,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,SAAS,GAAG,GAAG,CAAC,IAAI,CAAA;AACjG,YAAA,OAAO,GAAG,CAAA;SACX,EACD,EAA4B,CAC7B;KACF,CAAA;AACH;;;;"}

package/client/helpers/get-call-config-summary.d.ts

@@ -1,7 +1,12 @@
-import { AlgoAppSpec } from '../../schema/application.js';
+import { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56';
 export declare const BARE_CALL: unique symbol;
 export type MethodIdentifier = string | typeof BARE_CALL;
 export type MethodList = Array<MethodIdentifier>;
+export type OnComplete = 'NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication';
+export type Actions = {
+    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[];
+    call: OnComplete[];
+};
 export type CallConfigSummary = {
     createMethods: MethodList;
     callMethods: MethodList;
@@ -10,5 +15,5 @@ export type CallConfigSummary = {
     optInMethods: MethodList;
     closeOutMethods: MethodList;
 };
-export declare const getCallConfigSummary: (app: AlgoAppSpec) => CallConfigSummary;
-export declare const getCreateOnComplete: (app: AlgoAppSpec, method: MethodIdentifier) => string;
+export declare const getCallConfigSummary: (app: Arc56Contract) => CallConfigSummary;
+export declare const getCreateOnComplete: (app: Arc56Contract, method: MethodIdentifier) => string;

package/client/helpers/get-call-config-summary.js

@@ -1,5 +1,7 @@
 'use strict';
 
+var algosdk = require('algosdk');
+
 const BARE_CALL = Symbol('bare');
 const getCallConfigSummary = (app) => {
     const result = {
@@ -10,47 +12,47 @@ const getCallConfigSummary = (app) => {
         optInMethods: [],
         closeOutMethods: [],
     };
-    if (app.bare_call_config) {
-        addToConfig(result, BARE_CALL, app.bare_call_config);
+    if (app.bareActions) {
+        addToConfig(result, BARE_CALL, app.bareActions);
     }
-    if (app.hints) {
-        for (const [method, hints] of Object.entries(app.hints)) {
-            if (hints.call_config) {
-                addToConfig(result, method, hints.call_config);
+    if (app.methods) {
+        for (const m of app.methods) {
+            if (m.actions) {
+                addToConfig(result, new algosdk.ABIMethod(m).getSignature(), m.actions);
             }
         }
     }
     return result;
 };
 const addToConfig = (result, method, config) => {
-    if (hasCall(config.no_op)) {
+    if (hasCall(config, 'NoOp')) {
         result.callMethods.push(method);
     }
-    if (hasCreate(config.no_op) ||
-        hasCreate(config.opt_in) ||
-        hasCreate(config.close_out) ||
-        hasCreate(config.update_application) ||
-        hasCreate(config.delete_application)) {
+    if (hasCreate(config, 'NoOp') ||
+        hasCreate(config, 'OptIn') ||
+        hasCreate(config, 'CloseOut') ||
+        hasCreate(config, 'UpdateApplication') ||
+        hasCreate(config, 'DeleteApplication')) {
         result.createMethods.push(method);
     }
-    if (hasCall(config.delete_application)) {
+    if (hasCall(config, 'DeleteApplication')) {
         result.deleteMethods.push(method);
     }
-    if (hasCall(config.update_application)) {
+    if (hasCall(config, 'UpdateApplication')) {
         result.updateMethods.push(method);
     }
-    if (hasCall(config.opt_in)) {
+    if (hasCall(config, 'OptIn')) {
         result.optInMethods.push(method);
     }
-    if (hasCall(config.close_out)) {
+    if (hasCall(config, 'CloseOut')) {
         result.closeOutMethods.push(method);
     }
 };
-const hasCall = (config) => {
-    return config === 'CALL' || config === 'ALL';
+const hasCall = (config, action) => {
+    return config?.call.includes(action);
 };
-const hasCreate = (config) => {
-    return config === 'CREATE' || config === 'ALL';
+const hasCreate = (config, action) => {
+    return (config?.create).includes(action);
 };
 
 exports.BARE_CALL = BARE_CALL;

package/client/helpers/get-call-config-summary.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-call-config-summary.js","sources":["../../../src/client/helpers/get-call-config-summary.ts"],"sourcesContent":["import { pascalCase } from 'change-case'\nimport { AlgoAppSpec, CallConfig, CallConfigValue } from '../../schema/application.js'\n\nexport const BARE_CALL = Symbol('bare')\n\nexport type MethodIdentifier = string | typeof BARE_CALL\n\nexport type MethodList = Array<MethodIdentifier>\n\nexport type CallConfigSummary = {\n  createMethods: MethodList\n  callMethods: MethodList\n  deleteMethods: MethodList\n  updateMethods: MethodList\n  optInMethods: MethodList\n  closeOutMethods: MethodList\n}\nexport const getCallConfigSummary = (app: AlgoAppSpec) => {\n  const result: CallConfigSummary = {\n    createMethods: [],\n    callMethods: [],\n    deleteMethods: [],\n    updateMethods: [],\n    optInMethods: [],\n    closeOutMethods: [],\n  }\n  if (app.bare_call_config) {\n    addToConfig(result, BARE_CALL, app.bare_call_config)\n  }\n  if (app.hints) {\n    for (const [method, hints] of Object.entries(app.hints)) {\n      if (hints.call_config) {\n        addToConfig(result, method, hints.call_config)\n      }\n    }\n  }\n  return result\n}\n\nexport const getCreateOnComplete = (app: AlgoAppSpec, method: MethodIdentifier) => {\n  const callConfig = method === BARE_CALL ? app.bare_call_config : app.hints?.[method]?.call_config\n  if (!callConfig) {\n    return ''\n  }\n  const hasNoOp = callConfig.no_op === 'ALL' || callConfig.no_op === 'CREATE'\n  return `{ onCompleteAction${hasNoOp ? '?' : ''}: ${getCreateOnCompleteTypes(callConfig)} }`\n}\n\nconst getCreateOnCompleteTypes = (config: CallConfig) => {\n  return Object.keys(config)\n    .map((oc) => oc as keyof CallConfig)\n    .filter((oc) => config[oc] === 'ALL' || config[oc] === 'CREATE')\n    .map((oc) => `'${oc}' | OnApplicationComplete.${pascalCase(oc)}OC`)\n    .join(' | ')\n}\n\nconst addToConfig = (result: CallConfigSummary, method: MethodIdentifier, config: CallConfig) => {\n  if (hasCall(config.no_op)) {\n    result.callMethods.push(method)\n  }\n  if (\n    hasCreate(config.no_op) ||\n    hasCreate(config.opt_in) ||\n    hasCreate(config.close_out) ||\n    hasCreate(config.update_application) ||\n    hasCreate(config.delete_application)\n  ) {\n    result.createMethods.push(method)\n  }\n  if (hasCall(config.delete_application)) {\n    result.deleteMethods.push(method)\n  }\n  if (hasCall(config.update_application)) {\n    result.updateMethods.push(method)\n  }\n  if (hasCall(config.opt_in)) {\n    result.optInMethods.push(method)\n  }\n  if (hasCall(config.close_out)) {\n    result.closeOutMethods.push(method)\n  }\n}\n\nconst hasCall = (config: CallConfigValue | undefined) => {\n  return config === 'CALL' || config === 'ALL'\n}\nconst hasCreate = (config: CallConfigValue | undefined) => {\n  return config === 'CREATE' || config === 'ALL'\n}\n"],"names":[],"mappings":";;MAGa,SAAS,GAAG,MAAM,CAAC,MAAM,EAAC;AAc1B,MAAA,oBAAoB,GAAG,CAAC,GAAgB,KAAI;AACvD,IAAA,MAAM,MAAM,GAAsB;AAChC,QAAA,aAAa,EAAE,EAAE;AACjB,QAAA,WAAW,EAAE,EAAE;AACf,QAAA,aAAa,EAAE,EAAE;AACjB,QAAA,aAAa,EAAE,EAAE;AACjB,QAAA,YAAY,EAAE,EAAE;AAChB,QAAA,eAAe,EAAE,EAAE;KACpB,CAAA;AACD,IAAA,IAAI,GAAG,CAAC,gBAAgB,EAAE;QACxB,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,CAAC,gBAAgB,CAAC,CAAA;KACrD;AACD,IAAA,IAAI,GAAG,CAAC,KAAK,EAAE;AACb,QAAA,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;AACvD,YAAA,IAAI,KAAK,CAAC,WAAW,EAAE;gBACrB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,CAAA;aAC/C;SACF;KACF;AACD,IAAA,OAAO,MAAM,CAAA;AACf,EAAC;AAmBD,MAAM,WAAW,GAAG,CAAC,MAAyB,EAAE,MAAwB,EAAE,MAAkB,KAAI;AAC9F,IAAA,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;AACzB,QAAA,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KAChC;AACD,IAAA,IACE,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC;AACvB,QAAA,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC;AACxB,QAAA,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC;AAC3B,QAAA,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC;AACpC,QAAA,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,EACpC;AACA,QAAA,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KAClC;AACD,IAAA,IAAI,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE;AACtC,QAAA,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KAClC;AACD,IAAA,IAAI,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE;AACtC,QAAA,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KAClC;AACD,IAAA,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;AAC1B,QAAA,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KACjC;AACD,IAAA,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;AAC7B,QAAA,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KACpC;AACH,CAAC,CAAA;AAED,MAAM,OAAO,GAAG,CAAC,MAAmC,KAAI;AACtD,IAAA,OAAO,MAAM,KAAK,MAAM,IAAI,MAAM,KAAK,KAAK,CAAA;AAC9C,CAAC,CAAA;AACD,MAAM,SAAS,GAAG,CAAC,MAAmC,KAAI;AACxD,IAAA,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,KAAK,CAAA;AAChD,CAAC;;;;;"}
+{"version":3,"file":"get-call-config-summary.js","sources":["../../../src/client/helpers/get-call-config-summary.ts"],"sourcesContent":["import { pascalCase } from 'change-case'\nimport { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56'\nimport { ABIMethod } from 'algosdk'\n\nexport const BARE_CALL = Symbol('bare')\n\nexport type MethodIdentifier = string | typeof BARE_CALL\n\nexport type MethodList = Array<MethodIdentifier>\n\nexport type OnComplete = 'NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication'\n\nexport type Actions = {\n  create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n  call: OnComplete[]\n}\n\nexport type CallConfigSummary = {\n  createMethods: MethodList\n  callMethods: MethodList\n  deleteMethods: MethodList\n  updateMethods: MethodList\n  optInMethods: MethodList\n  closeOutMethods: MethodList\n}\nexport const getCallConfigSummary = (app: Arc56Contract) => {\n  const result: CallConfigSummary = {\n    createMethods: [],\n    callMethods: [],\n    deleteMethods: [],\n    updateMethods: [],\n    optInMethods: [],\n    closeOutMethods: [],\n  }\n  if (app.bareActions) {\n    addToConfig(result, BARE_CALL, app.bareActions)\n  }\n  if (app.methods) {\n    for (const m of app.methods) {\n      if (m.actions) {\n        addToConfig(result, new ABIMethod(m).getSignature(), m.actions)\n      }\n    }\n  }\n  return result\n}\n\nexport const getCreateOnComplete = (app: Arc56Contract, method: MethodIdentifier) => {\n  const actions = method === BARE_CALL ? app.bareActions : app.methods?.find((m) => m.name === method)?.actions\n  if (!actions) {\n    return ''\n  }\n  const hasNoOp = actions.create.includes('NoOp')\n  return `{ onCompleteAction${hasNoOp ? '?' : ''}: ${getCreateOnCompleteTypes(actions)} }`\n}\n\nconst getCreateOnCompleteTypes = (config: Actions) => {\n  return config.create.map((oc) => `'${oc}' | OnApplicationComplete.${pascalCase(oc)}OC`).join(' | ')\n}\n\nconst addToConfig = (result: CallConfigSummary, method: MethodIdentifier, config: Actions) => {\n  if (hasCall(config, 'NoOp')) {\n    result.callMethods.push(method)\n  }\n  if (\n    hasCreate(config, 'NoOp') ||\n    hasCreate(config, 'OptIn') ||\n    hasCreate(config, 'CloseOut') ||\n    hasCreate(config, 'UpdateApplication') ||\n    hasCreate(config, 'DeleteApplication')\n  ) {\n    result.createMethods.push(method)\n  }\n  if (hasCall(config, 'DeleteApplication')) {\n    result.deleteMethods.push(method)\n  }\n  if (hasCall(config, 'UpdateApplication')) {\n    result.updateMethods.push(method)\n  }\n  if (hasCall(config, 'OptIn')) {\n    result.optInMethods.push(method)\n  }\n  if (hasCall(config, 'CloseOut')) {\n    result.closeOutMethods.push(method)\n  }\n}\n\nconst hasCall = (config: Actions | undefined, action: OnComplete) => {\n  return config?.call.includes(action)\n}\nconst hasCreate = (config: Actions | undefined, action: OnComplete) => {\n  return (config?.create as OnComplete[]).includes(action)\n}\n"],"names":["ABIMethod"],"mappings":";;;;MAIa,SAAS,GAAG,MAAM,CAAC,MAAM,EAAC;AAqB1B,MAAA,oBAAoB,GAAG,CAAC,GAAkB,KAAI;AACzD,IAAA,MAAM,MAAM,GAAsB;AAChC,QAAA,aAAa,EAAE,EAAE;AACjB,QAAA,WAAW,EAAE,EAAE;AACf,QAAA,aAAa,EAAE,EAAE;AACjB,QAAA,aAAa,EAAE,EAAE;AACjB,QAAA,YAAY,EAAE,EAAE;AAChB,QAAA,eAAe,EAAE,EAAE;KACpB,CAAA;AACD,IAAA,IAAI,GAAG,CAAC,WAAW,EAAE;QACnB,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,CAAC,WAAW,CAAC,CAAA;KAChD;AACD,IAAA,IAAI,GAAG,CAAC,OAAO,EAAE;AACf,QAAA,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE;AAC3B,YAAA,IAAI,CAAC,CAAC,OAAO,EAAE;AACb,gBAAA,WAAW,CAAC,MAAM,EAAE,IAAIA,iBAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAA;aAChE;SACF;KACF;AACD,IAAA,OAAO,MAAM,CAAA;AACf,EAAC;AAeD,MAAM,WAAW,GAAG,CAAC,MAAyB,EAAE,MAAwB,EAAE,MAAe,KAAI;AAC3F,IAAA,IAAI,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE;AAC3B,QAAA,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KAChC;AACD,IAAA,IACE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;AACzB,QAAA,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;AAC1B,QAAA,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC;AAC7B,QAAA,SAAS,CAAC,MAAM,EAAE,mBAAmB,CAAC;AACtC,QAAA,SAAS,CAAC,MAAM,EAAE,mBAAmB,CAAC,EACtC;AACA,QAAA,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KAClC;AACD,IAAA,IAAI,OAAO,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAAE;AACxC,QAAA,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KAClC;AACD,IAAA,IAAI,OAAO,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAAE;AACxC,QAAA,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KAClC;AACD,IAAA,IAAI,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;AAC5B,QAAA,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KACjC;AACD,IAAA,IAAI,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE;AAC/B,QAAA,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;KACpC;AACH,CAAC,CAAA;AAED,MAAM,OAAO,GAAG,CAAC,MAA2B,EAAE,MAAkB,KAAI;IAClE,OAAO,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;AACtC,CAAC,CAAA;AACD,MAAM,SAAS,GAAG,CAAC,MAA2B,EAAE,MAAkB,KAAI;IACpE,OAAO,CAAC,MAAM,EAAE,MAAuB,EAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;AAC1D,CAAC;;;;;"}