codama-renderers-dart 0.5.1 → 0.5.4

package/{readme.md → README.md}

@@ -6,6 +6,8 @@ A [Codama](https://github.com/codama-idl/codama) renderer that generates Dart co
 
 Given a Codama IDL (Interface Description Language) describing a Solana program, this renderer produces a complete Dart package with typed account classes, instruction builders, codec functions, error definitions, PDA helpers, and barrel exports.
 
+Numeric prefix codecs retain the declared byte order, and pre/post offset types retain their cursor or padding strategy. Constant PDA integer seeds use the matching Dart integer type; malformed hexadecimal seeds and unsupported byte encodings are rejected.
+
 Fixed-size Codama types generate non-truncating encoders. Values within the declared byte capacity are zero-padded, while over-capacity values throw before any malformed bytes can be emitted. For UTF-8 strings, capacity is measured in encoded bytes rather than Dart code units.
 
 ## Installation
@@ -13,18 +15,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 +41,9 @@ 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
+IDL names may contain letters, digits, underscores, hyphens, and spaces; names containing path separators, quotes, or other source syntax are rejected. Documentation and string values are escaped before they enter generated Dart. Rendering resolves all output before clearing the previous generated directory, so invalid IDLs do not delete an existing client. Formatter paths are passed as literal process arguments. Numeric defaults, counts, sizes, and error codes are validated before they are written as source. Duplicate generated paths are rejected, including names reserved for category barrel files, so nodes cannot silently replace one another.
+
+```ts
 import { readFile } from "node:fs/promises";
 import { visit } from "@codama/visitors-core";
 import { renderVisitor } from "codama-renderers-dart";
@@ -76,7 +76,7 @@ Then run:
 codama run dart
 ```
 
-## Generated Output Structure
+## Generated output structure
 
 For a program called `myProgram`, the renderer generates:
 
@@ -104,7 +104,7 @@ lib/src/generated/
     my_pda.dart                      # PDA seeds class + finder function
 ```
 
-## Generated Code Patterns
+## Generated code patterns
 
 ### Accounts
 
@@ -164,9 +164,11 @@ Account and instruction decoders validate every declared constant, field, and si
 
 Top-level instruction decoders require exact input consumption. Account decoders always reject truncated data, but accept unread trailing capacity unless the account declares a `sizeDiscriminatorNode`; size-discriminated accounts reject both truncation and suffix bytes.
 
+Accounts declared with `isSigner: "either"` expose an additional boolean such as `authorityIsSigner`, defaulting to `true`. Set it to `false` when the authority does not sign, including multisig authorities.
+
 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 +185,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 +233,7 @@ Future<(Address, int)> findMyPdaPda({
 }) async { ... }
 ```
 
-## Type Mapping
+## Type mapping
 
 | Codama Type                         | Dart Type       | Codec                            |
 | ----------------------------------- | --------------- | -------------------------------- |
@@ -266,7 +268,7 @@ Future<(Address, int)> findMyPdaPda({
 
 All naming conventions are customizable:
 
-```typescript
+```ts
 import { renderVisitor, createDartNameApi } from "codama-renderers-dart";
 
 const nameApi = {
@@ -277,7 +279,7 @@ const nameApi = {
 visit(root, renderVisitor("output", { nameApi }));
 ```
 
-## Target Packages
+## Target packages
 
 Generated Dart code depends on these solana_kit packages:
 
@@ -311,39 +313,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
 ```