Skip to content

Add tests for entry type method generation #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
snoble merged 19 commits into from
Dec 11, 2025
Merged

Add tests for entry type method generation #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
0abe121
Add tests for entry type method generation
snoble Dec 11, 2025
e71ff7d
Move entry type method tests to basic-test.test.ts
snoble Dec 11, 2025
e5f7aa6
Update generated files
snoble Dec 11, 2025
c98ceb4
Add documentation for Post<entry> type-specific methods
snoble Dec 11, 2025
c4339b5
Update tests to handle both parameter styles for Post methods
snoble Dec 11, 2025
adabb7f
Add parameter style detection and verification tests
snoble Dec 11, 2025
838db6e
Make tests fail if using wrong parameter signature
snoble Dec 11, 2025
f3fe7b2
Add test schema with generated SDK and CI verification
snoble Dec 11, 2025
db6230f
Install Fragment CLI via Homebrew in CI
snoble Dec 11, 2025
d77466f
Use full path to fragment command in verification step
snoble Dec 11, 2025
89af221
Add caching for Homebrew and Fragment CLI
snoble Dec 11, 2025
f310b56
Remove sentence about methods availability from README
snoble Dec 11, 2025
8298a81
Add typeVersion support to test schema and tests
snoble Dec 11, 2025
8e24b43
Add fee line to typeVersion 2 with feeAmount parameter
snoble Dec 11, 2025
723c48b
Add documentation for typeVersion in Post methods
snoble Dec 11, 2025
0dabf75
Fix: Add typeVersion to GraphQL query response fields
snoble Dec 11, 2025
0ed7103
Update generation script to add typeVersion to response fields
snoble Dec 11, 2025
9182d84
Remove typeVersion from tests - verify versions by line structure ins…
snoble Dec 11, 2025
72733c1
Update README.md
snoble Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,29 @@ jobs:
max_attempts: 2
command: yarn

- name: Cache Homebrew
id: cache-homebrew
uses: actions/cache@v4
with:
path: |
/home/linuxbrew/.linuxbrew
~/.cache/Homebrew
key: ${{ runner.os }}-homebrew-fragment-cli
restore-keys: |
${{ runner.os }}-homebrew-

- name: Install Fragment CLI
run: |
if [ ! -d "/home/linuxbrew/.linuxbrew" ]; then
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
fi
echo "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" >> $GITHUB_ENV
eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
/home/linuxbrew/.linuxbrew/bin/brew tap fragment-dev/tap || true
if ! /home/linuxbrew/.linuxbrew/bin/brew list fragment-dev/tap/fragment-cli &>/dev/null; then
/home/linuxbrew/.linuxbrew/bin/brew install fragment-dev/tap/fragment-cli
fi

- name: Typecheck
run: yarn typecheck

Expand All @@ -56,3 +79,10 @@ jobs:
yarn build
git diff --exit-code
exit $?

- name: Verify test schema generated files are up-to-date
run: |
/home/linuxbrew/.linuxbrew/bin/fragment gen-graphql --path tests/fixtures/test-schema.json --output tests/fixtures/test-schema-queries.graphql
yarn fragment-node-client-codegen -i tests/fixtures/test-schema-queries.graphql -o tests/fixtures/generated-test-client.ts
git diff --exit-code tests/fixtures/test-schema-queries.graphql tests/fixtures/generated-test-client.ts
exit $?
46 changes: 46 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,52 @@ await fragment.addLedgerEntryRuntime({
});
```

### Post a Ledger Entry using type-specific methods

When your Schema defines Ledger Entry types with lines, the SDK generates type-specific methods for posting those entries. These methods follow the naming convention `Post<EntryType>` where the entry type name is converted to PascalCase.

For example, an entry type `user-funds-account` generates a method `PostUserFundsAccount`:

```typescript
await fragment.PostUserFundsAccount({
ik: "some-ik",
ledgerIk: "your-ledger-ik",
amount: "200",
});
```

The SDK handles different naming conventions:
- Hyphenated: `user-funds-account` → `PostUserFundsAccount`
- CamelCase: `fundingSettlement` → `PostFundingSettlement`
- Underscore: `payment_processing` → `PostPaymentProcessing`

#### Entry Type Versions

When your schema defines multiple versions of the same entry type using `typeVersion`, the SDK generates separate methods for each version. Version 1 uses the base method name, and subsequent versions append `_v2`, `_v3`, etc.

For example, an entry type `user-funds-account` with `typeVersion: 1` and `typeVersion: 2` generates:
- `PostUserFundsAccount` for version 1
- `PostUserFundsAccount_v2` for version 2

```typescript
// Post version 1 entry
await fragment.PostUserFundsAccount({
ik: "entry-ik-1",
ledgerIk: "your-ledger-ik",
amount: "200",
});

// Post version 2 entry (with additional feeAmount parameter)
await fragment.PostUserFundsAccount_v2({
ik: "entry-ik-2",
ledgerIk: "your-ledger-ik",
amount: "200",
feeAmount: "10",
});
```

Each version can have different parameters and line structures, and the generated methods will reflect those differences.

### Sync transactions

To sync transaction using a [Custom Link](https://fragment.dev/docs#reconcile-transactions-link-any-system):
Expand Down
12 changes: 10 additions & 2 deletions dist/cjs/generated/generated.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

48 changes: 35 additions & 13 deletions dist/cjs/types/generated/generated.d.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/cjs/types/generated/generated.d.ts.map
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions dist/esm/generated/generated.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading