codama-renderers-dart 0.5.1 → 0.5.3

package/{readme.md → README.md}

@@ -13,18 +13,14 @@ Fixed-size Codama types generate non-truncating encoders. Values within the decl
 ```bash
 pnpm add codama-renderers-dart
 # or
-
-[![pub package](https://img.shields.io/pub/v/codama-renderers-dart.svg)](https://pub.dev/packages/codama-renderers-dart)
-[![CI](https://github.com/openbudgetfun/solana_kit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/openbudgetfun/solana_kit/actions/workflows/ci.yml)
-[![Coverage](https://codecov.io/gh/openbudgetfun/solana_kit/branch/main/graph/badge.svg?flag=codama-renderers-dart)](https://codecov.io/gh/openbudgetfun/solana_kit?flag=codama-renderers-dart)
 npm install codama-renderers-dart
 ```
 
-## Quick Start
+## Quick start
 
 ### Programmatic API
 
-```typescript
+```ts
 import { renderVisitor } from "codama-renderers-dart";
 import { visit } from "@codama/visitors-core";
 import { rootNode, programNode /* ... */ } from "@codama/nodes";
@@ -43,7 +39,7 @@ visit(root, renderVisitor("lib/src/generated", {
 
 `renderVisitor` accepts parsed Codama JSON as well as roots made with Codama constructors. Pina omits empty collections from its serialized IDLs; the renderer restores those structural defaults on an internal copy before traversal, leaving the parsed object unchanged.
 
-```typescript
+```ts
 import { readFile } from "node:fs/promises";
 import { visit } from "@codama/visitors-core";
 import { renderVisitor } from "codama-renderers-dart";
@@ -76,7 +72,7 @@ Then run:
 codama run dart
 ```
 
-## Generated Output Structure
+## Generated output structure
 
 For a program called `myProgram`, the renderer generates:
 
@@ -104,7 +100,7 @@ lib/src/generated/
     my_pda.dart                      # PDA seeds class + finder function
 ```
 
-## Generated Code Patterns
+## Generated code patterns
 
 ### Accounts
 
@@ -166,7 +162,7 @@ Top-level instruction decoders require exact input consumption. Account decoders
 
 Optional instruction accounts use Codama's `programId` strategy by default. When an optional account is absent, the builder emits a readonly program-address placeholder so every later account keeps its declared index. The account slot is removed only when the instruction explicitly selects the legacy `omitted` strategy.
 
-### Scalar Enums
+### Scalar enums
 
 Scalar enums (all-empty variants) generate a Dart `enum` with index-based encoder/decoder:
 
@@ -183,7 +179,7 @@ Decoder<AccountStatus> getAccountStatusDecoder() { ... }
 
 The generated enum API is the same for `u8`, `u16`, `u32`, and `u64` discriminators. The renderer converts `u64` indices to and from `BigInt` at the codec boundary and rejects out-of-range discriminators before converting them to Dart enum indices.
 
-### Data Enums (Discriminated Unions)
+### Data enums (discriminated unions)
 
 Data enums generate Dart 3 `sealed class` hierarchies:
 
@@ -231,7 +227,7 @@ Future<(Address, int)> findMyPdaPda({
 }) async { ... }
 ```
 
-## Type Mapping
+## Type mapping
 
 | Codama Type                         | Dart Type       | Codec                            |
 | ----------------------------------- | --------------- | -------------------------------- |
@@ -266,7 +262,7 @@ Future<(Address, int)> findMyPdaPda({
 
 All naming conventions are customizable:
 
-```typescript
+```ts
 import { renderVisitor, createDartNameApi } from "codama-renderers-dart";
 
 const nameApi = {
@@ -277,7 +273,7 @@ const nameApi = {
 visit(root, renderVisitor("output", { nameApi }));
 ```
 
-## Target Packages
+## Target packages
 
 Generated Dart code depends on these solana_kit packages:
 
@@ -311,39 +307,10 @@ Key source files:
 ## Development
 
 ```bash
-# Install dependencies
-
-[![pub package](https://img.shields.io/pub/v/codama-renderers-dart.svg)](https://pub.dev/packages/codama-renderers-dart)
-[![CI](https://github.com/openbudgetfun/solana_kit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/openbudgetfun/solana_kit/actions/workflows/ci.yml)
-[![Coverage](https://codecov.io/gh/openbudgetfun/solana_kit/branch/main/graph/badge.svg?flag=codama-renderers-dart)](https://codecov.io/gh/openbudgetfun/solana_kit?flag=codama-renderers-dart)
 pnpm install
-
-# Type check
-
-[![pub package](https://img.shields.io/pub/v/codama-renderers-dart.svg)](https://pub.dev/packages/codama-renderers-dart)
-[![CI](https://github.com/openbudgetfun/solana_kit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/openbudgetfun/solana_kit/actions/workflows/ci.yml)
-[![Coverage](https://codecov.io/gh/openbudgetfun/solana_kit/branch/main/graph/badge.svg?flag=codama-renderers-dart)](https://codecov.io/gh/openbudgetfun/solana_kit?flag=codama-renderers-dart)
 npx tsc --noEmit
-
-# Run tests
-
-[![pub package](https://img.shields.io/pub/v/codama-renderers-dart.svg)](https://pub.dev/packages/codama-renderers-dart)
-[![CI](https://github.com/openbudgetfun/solana_kit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/openbudgetfun/solana_kit/actions/workflows/ci.yml)
-[![Coverage](https://codecov.io/gh/openbudgetfun/solana_kit/branch/main/graph/badge.svg?flag=codama-renderers-dart)](https://codecov.io/gh/openbudgetfun/solana_kit?flag=codama-renderers-dart)
 pnpm test
-
-# Watch mode
-
-[![pub package](https://img.shields.io/pub/v/codama-renderers-dart.svg)](https://pub.dev/packages/codama-renderers-dart)
-[![CI](https://github.com/openbudgetfun/solana_kit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/openbudgetfun/solana_kit/actions/workflows/ci.yml)
-[![Coverage](https://codecov.io/gh/openbudgetfun/solana_kit/branch/main/graph/badge.svg?flag=codama-renderers-dart)](https://codecov.io/gh/openbudgetfun/solana_kit?flag=codama-renderers-dart)
 pnpm test:watch
-
-# Build
-
-[![pub package](https://img.shields.io/pub/v/codama-renderers-dart.svg)](https://pub.dev/packages/codama-renderers-dart)
-[![CI](https://github.com/openbudgetfun/solana_kit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/openbudgetfun/solana_kit/actions/workflows/ci.yml)
-[![Coverage](https://codecov.io/gh/openbudgetfun/solana_kit/branch/main/graph/badge.svg?flag=codama-renderers-dart)](https://codecov.io/gh/openbudgetfun/solana_kit?flag=codama-renderers-dart)
 pnpm build
 ```
 

package/dist/index.browser.cjs

@@ -84,9 +84,83 @@ function setEmptyCollection(record, key) {
 function pascalCase(str) {
   return str.replace(/[-_\s]+(.)?/g, (_, c) => c ? c.toUpperCase() : "").replace(/^(.)/, (c) => c.toUpperCase());
 }
+var DART_RESERVED_WORDS = /* @__PURE__ */ new Set([
+  "abstract",
+  "as",
+  "assert",
+  "async",
+  "augment",
+  "await",
+  "base",
+  "break",
+  "case",
+  "catch",
+  "class",
+  "const",
+  "continue",
+  "covariant",
+  "default",
+  "deferred",
+  "do",
+  "dynamic",
+  "else",
+  "enum",
+  "export",
+  "extends",
+  "extension",
+  "external",
+  "factory",
+  "false",
+  "final",
+  "finally",
+  "for",
+  "get",
+  "hide",
+  "if",
+  "implements",
+  "import",
+  "in",
+  "interface",
+  "is",
+  "late",
+  "library",
+  "mixin",
+  "native",
+  "new",
+  "null",
+  "of",
+  "on",
+  "operator",
+  "part",
+  "required",
+  "rethrow",
+  "return",
+  "sealed",
+  "set",
+  "show",
+  "static",
+  "super",
+  "switch",
+  "sync",
+  "this",
+  "throw",
+  "true",
+  "try",
+  "typedef",
+  "var",
+  "void",
+  "when",
+  "while",
+  "with",
+  "yield"
+]);
+function escapeDartIdentifier(name) {
+  return DART_RESERVED_WORDS.has(name) ? `${name}_` : name;
+}
 function camelCase(str) {
   const pascal = pascalCase(str);
-  return pascal.charAt(0).toLowerCase() + pascal.slice(1);
+  const cased = pascal.charAt(0).toLowerCase() + pascal.slice(1);
+  return escapeDartIdentifier(cased);
 }
 function snakeCase(str) {
   return str.replace(/([A-Z])/g, "_$1").replace(/[-\s]+/g, "_").replace(/^_/, "").replace(/_+/g, "_").toLowerCase();
@@ -674,7 +748,7 @@ function getTypeManifestVisitor(input) {
         encoder: fragment`${use(
           "getArrayEncoder",
           "solanaCodecsDataStructures"
-        )}<${itemType}>(${itemEncoder}${encoderSizeExpr})`,
+        )}(${itemEncoder}${encoderSizeExpr})`,
         decoder: fragment`${use(
           "getArrayDecoder",
           "solanaCodecsDataStructures"
@@ -730,18 +804,28 @@ function getTypeManifestVisitor(input) {
         typeFragment.imports.mergeWith(m.type.imports);
       }
       const encoderListStr = encoderList.map((e) => e.content).join(", ");
+      const decoderListStr = decoderList.map((d) => d.content).join(", ");
+      let tupleEncoderFn = "getTupleEncoder";
+      let tupleDecoderFn = "getTupleDecoder";
+      let tupleEncoderArgs = `[${encoderListStr}]`;
+      let tupleDecoderArgs = `[${decoderListStr}]`;
+      if (itemManifests.length === 2) {
+        tupleEncoderFn = "getTuple2Encoder";
+        tupleDecoderFn = "getTuple2Decoder";
+        tupleEncoderArgs = encoderListStr;
+        tupleDecoderArgs = decoderListStr;
+      }
       const encoderFrag = fragment`${use(
-        "getTupleEncoder",
+        tupleEncoderFn,
         "solanaCodecsDataStructures"
-      )}([${fragmentFromString(encoderListStr)}])`;
+      )}(${tupleEncoderArgs})`;
       for (const e of encoderList) {
         encoderFrag.imports.mergeWith(e.imports);
       }
-      const decoderListStr = decoderList.map((d) => d.content).join(", ");
       const decoderFrag = fragment`${use(
-        "getTupleDecoder",
+        tupleDecoderFn,
         "solanaCodecsDataStructures"
-      )}([${fragmentFromString(decoderListStr)}])`;
+      )}(${tupleDecoderArgs})`;
       for (const d of decoderList) {
         decoderFrag.imports.mergeWith(d.imports);
       }
@@ -828,7 +912,10 @@ function getTypeManifestVisitor(input) {
         encoder: fragment`${use(
           "getNullableEncoder",
           "solanaCodecsDataStructures"
-        )}<${fragmentFromString(itemTypeStr)}>(${itemManifest.encoder}${fragmentFromString(prefixExpr)}${fragmentFromString(noneValueExpr)})`,
+        )}<${fragmentFromString(itemTypeStr)}>(${use(
+          "transformEncoder",
+          "solanaCodecsCore"
+        )}(${itemManifest.encoder}, (${fragmentFromString(itemTypeStr)} value) => value)${fragmentFromString(prefixExpr)}${fragmentFromString(noneValueExpr)})`,
         decoder: fragment`${use(
           "getNullableDecoder",
           "solanaCodecsDataStructures"
@@ -1589,6 +1676,10 @@ ${dataCtorInitializers}` : ""};`;
   const accountNames = new Set(accounts.map((a) => camelCase(a.name)));
   const hasProgramAddressCollision = argNames.has("programAddress") || accountNames.has("programAddress");
   const instrProgramParam = hasProgramAddressCollision ? "instructionProgramAddress" : "programAddress";
+  let instructionDataLocal = "instructionData";
+  while (argNames.has(instructionDataLocal) || accountNames.has(instructionDataLocal)) {
+    instructionDataLocal = `${instructionDataLocal}_`;
+  }
   const accountParams = accounts.map((acc) => {
     const fieldName = camelCase(acc.name);
     const isRequired = !(acc.isOptional ?? false);
@@ -1697,7 +1788,7 @@ Instruction ${fragmentFromString(instrFnName)}({
 ${fragmentFromString(accountParams)}
 ${fragmentFromString(argParams)}
 }) {
-  final instructionData = ${fragmentFromString(dataClassName)}(
+  final ${instructionDataLocal} = ${fragmentFromString(dataClassName)}(
 ${fragmentFromString(dataConstruction)}
   );
 
@@ -1706,7 +1797,7 @@ ${fragmentFromString(dataConstruction)}
     accounts: [
 ${fragmentFromString(accountMetas)}
     ],
-    data: ${fragmentFromString(dataEncoderName)}().encode(instructionData),
+    data: ${fragmentFromString(dataEncoderName)}().encode(${instructionDataLocal}),
   );
 }`);
   parts.push(fragment`
@@ -2130,6 +2221,7 @@ function getDataEnumPageFragment(node, variants, scope) {
   const decoderVariants = [];
   const encodeCases = [];
   const decodeCases = [];
+  let pageHasListEnums = false;
   const allVariantManifests = [];
   for (let i = 0; i < variants.length; i++) {
     const variant = variants[i];
@@ -2177,10 +2269,14 @@ function getDataEnumPageFragment(node, variants, scope) {
       const ctorSignature = fields.length === 0 ? `  const ${variantClassName}();` : `  const ${variantClassName}({
 ${ctorParams}
   });`;
-      const eqChecks = fields.length === 0 ? "true" : fields.map((f) => `${camelCase(f.name)} == other.${camelCase(f.name)}`).join(" &&\n          ");
-      const hashExpression = getHashExpression(
-        fields.map((f) => camelCase(f.name))
-      );
+      const eqChecks = fields.length === 0 ? "true" : fields.map((f, index) => {
+        const fieldName = camelCase(f.name);
+        return isListManifest(fieldManifests[index].manifest) ? `_listEquals(${fieldName}, other.${fieldName})` : `${fieldName} == other.${fieldName}`;
+      }).join(" &&\n          ");
+      const hashExpression = getValueHashExpression(fields, fieldManifests);
+      if (fieldManifests.some(({ manifest }) => isListManifest(manifest))) {
+        pageHasListEnums = true;
+      }
       const toStringFields = fields.map((f) => `${camelCase(f.name)}: $${camelCase(f.name)}`).join(", ");
       variantClasses.push(`final class ${variantClassName} extends ${typeName} {
 ${ctorSignature}
@@ -2286,7 +2382,7 @@ sealed class ${fragmentFromString(typeName)} {
   const ${fragmentFromString(typeName)}();
 }
 
-${fragmentFromString(variantClasses.join("\n\n"))}
+${fragmentFromString(variantClasses.join("\n\n"))}${pageHasListEnums ? LIST_VALUE_HELPERS : ""}
 
 Encoder<${fragmentFromString(typeName)}> ${fragmentFromString(encoderName)}() {
   return transformEncoder<Map<String, Object?>, ${fragmentFromString(typeName)}>(
@@ -2329,6 +2425,7 @@ function getStructPageFragment(node, scope) {
   const structNode = node.type;
   if (structNode.kind !== "structTypeNode") return emptyFragment();
   const fields = structNode.fields ?? [];
+  let pageHasListStructs = false;
   const fieldManifests = fields.map((f) => ({
     field: f,
     manifest: visitorsCore.visit(f.type, scope.typeManifestVisitor)
@@ -2340,10 +2437,13 @@ function getStructPageFragment(node, scope) {
   const ctorSignature = fields.length === 0 ? `  const ${typeName}();` : `  const ${typeName}({
 ${ctorParams}
   });`;
-  const eqChecks = fields.length === 0 ? "true" : fields.map(
-    (f) => `${camelCase(f.name)} == other.${camelCase(f.name)}`
-  ).join(" &&\n          ");
-  fields.length === 0 ? "runtimeType" : fields.map((f) => camelCase(f.name)).join(", ");
+  const eqChecks = fields.length === 0 ? "true" : fieldManifests.map(({ field: f, manifest }, index) => {
+    const fieldName = camelCase(f.name);
+    return isListManifest(manifest) ? `_listEquals(${fieldName}, other.${fieldName})` : `${fieldName} == other.${fieldName}`;
+  }).join(" &&\n          ");
+  if (fieldManifests.some(({ manifest }) => isListManifest(manifest))) {
+    pageHasListStructs = true;
+  }
   const toStringFields = fields.map(
     (f) => `${camelCase(f.name)}: $${camelCase(f.name)}`
   ).join(", ");
@@ -2393,12 +2493,14 @@ ${fragmentFromString(fieldDecls)}
           ${fragmentFromString(eqChecks)};
 
   @override
-  int get hashCode => ${fragmentFromString(getHashExpression(fields.map((f) => camelCase(f.name))))};
+  int get hashCode => ${fragmentFromString(
+    getValueHashExpression(fields, fieldManifests)
+  )};
 
   @override
   String toString() => '${fragmentFromString(typeName)}(${fragmentFromString(toStringFields)})';
 }
-
+${pageHasListStructs ? LIST_VALUE_HELPERS : ""}
 Encoder<${fragmentFromString(typeName)}> ${fragmentFromString(encoderName)}() {
   final structEncoder = getStructEncoder(<(String, Encoder<Object?>)>[
 ${fragmentFromString(encFields)}
@@ -2464,6 +2566,56 @@ Codec<${fragmentFromString(typeName)}, ${fragmentFromString(typeName)}> ${fragme
   return combineCodec(${fragmentFromString(encoderName)}(), ${fragmentFromString(decoderName)}());
 }`;
 }
+function isListManifest(manifest) {
+  return manifest.type.content.startsWith("List<") || manifest.type.content === "Uint8List";
+}
+var LIST_VALUE_HELPERS = `
+bool _listEquals<T>(List<T>? a, List<T>? b) {
+  if (identical(a, b)) return true;
+  if (a == null || b == null) return a == b;
+  if (a.length != b.length) return false;
+  for (var i = 0; i < a.length; i++) {
+    final left = a[i];
+    final right = b[i];
+    if (left is List<Object?> && right is List<Object?>) {
+      if (!_listEquals(left, right)) return false;
+    } else if (left != right) {
+      return false;
+    }
+  }
+  return true;
+}
+
+Object? _deepHash(Object? value) {
+  if (value is List<Object?>) {
+    return Object.hashAll(value.map(_deepHash));
+  }
+  return value;
+}
+
+int _listHashCode<T>(List<T>? a) {
+  if (a == null) return 0;
+  return Object.hashAll(a.map(_deepHash));
+}
+`;
+function getValueHashExpression(fields, fieldManifests) {
+  const fieldNames = fields.map(
+    (f) => camelCase(f.name)
+  );
+  const hasListFields = fieldManifests.some(
+    ({ manifest }) => isListManifest(manifest)
+  );
+  if (!hasListFields) {
+    return getHashExpression(fieldNames);
+  }
+  if (fieldNames.length === 1) {
+    return `_listHashCode(${fieldNames[0]})`;
+  }
+  const hashArgs = fields.map(
+    (f, index) => isListManifest(fieldManifests[index].manifest) ? `_listHashCode(${camelCase(f.name)})` : camelCase(f.name)
+  );
+  return `Object.hash(${hashArgs.join(", ")})`;
+}
 function getHashExpression(fields) {
   if (fields.length === 0) return "runtimeType.hashCode";
   if (fields.length === 1) return `${fields[0]}.hashCode`;