Refactored SDK package to TypeScript #2352

mfbz · 2025-04-24T14:07:42Z

Closes #2332.

Migration TS/JS ratio
From (20 / 123) 16.26% → To (106 / 125) 84.80% (Improvement ~70%)

Type Coverage
From (8605 / 9982) 86.18% → To (9669 / 10520) 92.21% (Improvement ~6%)

changeset-bot · 2025-04-24T14:07:47Z

🦋 Changeset detected

Latest commit: ba6de5b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages

Name	Type
@onflow/typedefs	Minor
@onflow/sdk	Minor
@onflow/fcl-core	Patch
@onflow/fcl-react-native	Patch
@onflow/fcl-wc	Patch
@onflow/fcl	Patch
@onflow/fcl-ethereum-provider	Patch
@onflow/fcl-rainbowkit-adapter	Patch
@onflow/fcl-wagmi-adapter	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

jribbink

Here's the comments I had so far (I've only got through 100/131 files so far)

packages/sdk/src/account/account.ts

packages/sdk/src/node-version-info/node-version-info.ts

packages/sdk/src/build/build.ts

Copilot

Pull Request Overview

This PR refactors the SDK package to TypeScript, significantly increasing TS/JS and type coverage ratios. Key changes include removing legacy JavaScript files, introducing new TypeScript versions of builder functions, and updating related test files.

Reviewed Changes

Copilot reviewed 130 out of 131 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/sdk/src/build/build-authorizations.js	Removed legacy JS authorization builders
packages/sdk/src/build/build-at-latest-block.ts	New TS builder for fetching the latest block
packages/sdk/src/build/build-at-block-id.ts	Updated TS implementation with explicit typing
packages/sdk/src/build/build-at-block-height.ts	New TS builder for fetching a block by height
packages/sdk/src/block/block.ts	Updated TS block fetching logic
packages/sdk/src/account/account.ts	Updated account fetch with TS imports and improved typing
packages/sdk/src/VERSION.ts	New TS version file export
packages/kit/src/mocks/fcl.ts	Updated mock to use type assertion for actualFcl
.changeset/tame-pianos-doubt.md	Changeset reflecting the refactoring

Files not reviewed (1)

packages/sdk/package.json: Language not supported

packages/sdk/src/build/build-at-block-id.ts

chasefleming · 2025-05-02T21:22:14Z

packages/sdk/src/decode/decode.ts

-    acc[v.name] = await recurseDecode(v.value, decoders, [...stack, v.name])
-    return acc
-  }, Promise.resolve({}))
+const decodeDictionary = async (


Do we want JSDoc for all these?

If the function is exported, I think we should add JSDoc comments. Otherwise, if it’s a simple internal function, we could skip it for now. That said, we can always add them later, and the end, JSDoc comments are safe to include in separate PRs since they only affect documentation and not the actual code.

packages/sdk/src/decode/decode.ts

jribbink

It looks great, I just ran through most of the files now.

There's a couple types that I'm not sure about and I'll have to dive a bit deeper into the code for tomorrow to double check (specifically some things with the authz functions and decoding). But I'll get on this ASAP

packages/sdk/src/build/build-voucher-intercept.ts

packages/sdk/src/build/build-authorizations.ts

jribbink · 2025-05-12T21:22:42Z

packages/sdk/src/interaction/interaction.ts


-type AcctFn = (acct: InteractionAccount) => InteractionAccount
-type AccountFn = AcctFn & Partial<InteractionAccount>
+export type AcctFn = (acct: InteractionAccount) => InteractionAccount


Suggested change

export type AcctFn = (acct: InteractionAccount) => InteractionAccount

export type AuthorizationFn = (acct: InteractionAccount) => InteractionAccount

For consistency with docs https://developers.flow.com/tools/wallet-provider-spec/authorization-function#how-to-create-an-authorization-function

jribbink · 2025-05-12T21:24:02Z

packages/sdk/src/interaction/interaction.ts

+export type AccountFn =
+  | (AcctFn & Partial<InteractionAccount>)
+  | Partial<InteractionAccount>


Can we name this something without the Fn suffix? IMO it's probably a bit of a misnomer since it's a union type.

How about something like AccountAuthorization?

Yep AccountAuthorization fits really well, considering also the refactoring that AcctFn is now AuthorizationFn 👍

jribbink

Two naming comments, but other than that it looks good to me 🥳

# Conflicts: # package-lock.json # packages/kit/src/__mocks__/fcl.ts

* PKG -- [transport-http] Create SubscriptionManager and subscribe function (#2019) * PKG -- [sdk] Create SDK subscribe function (#2024) * Update to latest streaming API changes (#2202) * PKG -- [transport-http] Add Blocks DataProvider (#2033) * PKG -- [transport-http] Add BlockDigests DataProvider (#2034) * PKG -- [transport-http] Add BlockHeaders DataProvider (#2035) * PKG -- [transport-http] Add TransactionStatuses DataProvider (#2041) * PKG -- [transport-http] Add Events DataProvider (#2037) * PKG -- [fcl] Expose new streaming endpoints (#2038) * PKG -- [transport-http] Add AccountStatuses DataProvider (#2036) * Switch to synchronous subscriptions with callback-based error reporting (#2242) * Switch `fcl.events` to use new event streaming method (#2241) * Fix resume args for `events` & `account_statuses` (#2249) * Cleanup subscriptions types & align with decoded representation (#2256) * Fix endpoint for WS subscriptions (#2277) * Replace `fcl.tx` with realtime streaming (#2258) * Reorganize subscriptions types (#2301) * Add legacy `fcl.events` fallback for emulator (#2287) * Add emulator fallback for fcl.tx (#2294) * Fix resume args type check not checking if value is falsy (#2309) * Add missing decoders (#2320) * Improve WebSocket Lifecycle Management (#2312) * Add changesets * Fix Account Status Decoding * Add `useIsCadenceWalletConnected` hook (#2326) * Expose origin in `onMessageFromFCL` callback (#2384) * Update and clean up WalletConnect dependencies (#2382) * Deprecate manual `appIdentifier` in favour of window origin (#2378) * Updated types to interfaces and comments cleanup (#2393) * Updated types to interfaces and comments cleanup * Added changeset --------- Co-authored-by: mfbz <[email protected]> * Version Packages (#2371) * Add `useFlowChainId` hook (#2367) * Rename `useFlowTransaction` to `useFlowTransactionStatus` (#2413) * Rename tx hook to tx status hook * Fix import --------- Co-authored-by: Chase Fleming <[email protected]> * Add changeset (#2414) * Add changeset * Update moody-ligers-rule.md * Update .changeset/moody-ligers-rule.md Co-authored-by: Jordan Ribbink <[email protected]> --------- Co-authored-by: Chase Fleming <[email protected]> Co-authored-by: Jordan Ribbink <[email protected]> * Add comment about renaming (#2416) Co-authored-by: Chase Fleming <[email protected]> * Fix `useFlowRevertibleRandom` range (#2417) * Update readme with `useFlowRevertibleRandom` hook (#2419) Co-authored-by: Chase Fleming <[email protected]> * Add `useCrossVmBatchTransaction` function (#2368) * Refactored SDK package to TypeScript (#2352) * Added onflow/typedefs and onflow/types types into sdk package * Updated first part of files * Updated encode and decode folders * Updated send.js * Updated sdk resolve files * Fixed build problems * Updated wallet-utils folder * Moved typedefs and types back to their package * Fixed build * Refactored more js to ts files * Fixed tests * Added onflow/types re-export from sdk * Added missing onflow/types package to sdk * Updated readme with typescript examples * Fixed build error on type problem * Added changeset file * Cleaned up types and docs * Minor comments fix * Removed unused cast * Added suport to conditional interaction callbacks in build * After install update * Fixed build-transaction input params * Updated send function null check * Re-added resolve comments to two special functions * Added Voucher export from sdk * Improved input params for send function * Renamed InteractionCallback to InteractionBuilderFn * Improve with central function definition from interaction file * Improved atBlockId validator types * Strongly typed voucher intercept param * Improved signing function interface and minor refactoring * Refactored AcctFn function name * Refactored AccountFn name --------- Co-authored-by: mfbz <[email protected]> * Fix payload type * Fix payload decoding * Fix Typos in Documentation Files (#2420) * Enter alpha mode (#2421) * Version Packages (alpha) (#2396) * Fix current user returning false before checking authenticated (#2428) Co-authored-by: Chase Fleming <[email protected]> * Allow undefined value for `useFlowTransactionStatus` (#2439) * Fixed fcl.mutate hanging (#2434) * Fixed fcl-mutate not working * Update packages/sdk/src/block/block.ts Co-authored-by: Jordan Ribbink <[email protected]> * Update packages/sdk/src/block/block.ts Co-authored-by: Jordan Ribbink <[email protected]> * Update packages/sdk/src/block/block.ts Co-authored-by: Jordan Ribbink <[email protected]> * Update packages/sdk/src/node-version-info/node-version-info.ts Co-authored-by: Jordan Ribbink <[email protected]> * Update packages/sdk/src/resolve/resolve.ts Co-authored-by: Jordan Ribbink <[email protected]> * Added validator improvement * Create four-frogs-jump.md --------- Co-authored-by: mfbz <[email protected]> Co-authored-by: Jordan Ribbink <[email protected]> * Version Packages (alpha) (#2440) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Fix build * Prettier --------- Co-authored-by: Jordan Ribbink <[email protected]> Co-authored-by: Jordan Ribbink <[email protected]> Co-authored-by: Michael Fabozzi <[email protected]> Co-authored-by: mfbz <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Chase Fleming <[email protected]> Co-authored-by: leopardracer <[email protected]>

mfbz added 17 commits April 17, 2025 23:55

Added onflow/typedefs and onflow/types types into sdk package

4262766

Updated first part of files

26c8f64

Updated encode and decode folders

3ecc6e4

Updated send.js

c437d6f

Updated sdk resolve files

2fa32ef

Fixed build problems

121a217

Updated wallet-utils folder

0d81083

Merge branch 'master' into mfbz/typed-sdk

7f90608

Moved typedefs and types back to their package

d701dcf

Fixed build

6c585a4

Refactored more js to ts files

76fbc84

Fixed tests

0aa3195

Added onflow/types re-export from sdk

73cdc52

Added missing onflow/types package to sdk

502ca86

Updated readme with typescript examples

15269e7

Merge branch 'master' into mfbz/typed-sdk

2f87bda

Fixed build error on type problem

041d3e2

mfbz requested a review from a team as a code owner April 24, 2025 14:07

Added changeset file

7138db7

chasefleming mentioned this pull request Apr 24, 2025

Add useBatchTransaction hook to @onflow/kit #2353

Closed

mfbz added 4 commits April 29, 2025 14:44

Cleaned up types and docs

3275dff

Minor comments fix

e371894

Merge branch 'master' into mfbz/typed-sdk

9180492

Removed unused cast

eea449f

jribbink reviewed May 1, 2025

View reviewed changes

packages/sdk/src/account/account.ts Show resolved Hide resolved

packages/sdk/src/node-version-info/node-version-info.ts Outdated Show resolved Hide resolved

packages/sdk/src/build/build.ts Outdated Show resolved Hide resolved

mfbz added 3 commits May 1, 2025 19:37

Added suport to conditional interaction callbacks in build

213a005

After install update

0e64cf1

Merge branch 'master' into mfbz/typed-sdk

17677a2

mfbz requested a review from jribbink May 1, 2025 17:47

mfbz added 2 commits May 1, 2025 22:08

Renamed InteractionCallback to InteractionBuilderFn

84dde8f

Improve with central function definition from interaction file

daffadc

mfbz requested a review from jribbink May 1, 2025 20:42

jribbink requested a review from Copilot May 2, 2025 20:21

Copilot AI reviewed May 2, 2025

View reviewed changes

packages/sdk/src/build/build-at-block-id.ts Outdated Show resolved Hide resolved

Improved atBlockId validator types

4c06caa

chasefleming reviewed May 2, 2025

View reviewed changes

packages/sdk/src/decode/decode.ts Show resolved Hide resolved

mfbz requested a review from chasefleming May 3, 2025 19:54

mfbz added 2 commits May 7, 2025 15:51

Merge branch 'master' into mfbz/typed-sdk

141cb7b

Merge branch 'master' into mfbz/typed-sdk

21147d5

jribbink reviewed May 8, 2025

View reviewed changes

packages/sdk/src/build/build-voucher-intercept.ts Outdated Show resolved Hide resolved

jribbink reviewed May 8, 2025

View reviewed changes

packages/sdk/src/build/build-authorizations.ts Outdated Show resolved Hide resolved

mfbz and others added 5 commits May 8, 2025 13:18

Merge branch 'master' into mfbz/typed-sdk

b5e523b

Strongly typed voucher intercept param

cc8734c

Improved signing function interface and minor refactoring

995f5ba

Merge branch 'master' into mfbz/typed-sdk

c59bdbc

Merge branch 'master' into mfbz/typed-sdk

a60b7b3

jribbink reviewed May 12, 2025

View reviewed changes

jribbink approved these changes May 12, 2025

View reviewed changes

mfbz added 2 commits May 12, 2025 23:34

Refactored AcctFn function name

9bca890

Refactored AccountFn name

76b963b

chasefleming approved these changes May 13, 2025

View reviewed changes

Merge branch 'master' into mfbz/typed-sdk

ba6de5b

# Conflicts: # package-lock.json # packages/kit/src/__mocks__/fcl.ts

mfbz merged commit 4d3bb08 into master May 13, 2025
1 check passed

mfbz deleted the mfbz/typed-sdk branch May 13, 2025 07:57

github-actions bot mentioned this pull request May 13, 2025

Version Packages (alpha) #2396

Merged

github-actions bot mentioned this pull request May 22, 2025

Version Packages #2467

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refactored SDK package to TypeScript #2352

Refactored SDK package to TypeScript #2352

Uh oh!

mfbz commented Apr 24, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Apr 24, 2025 •

edited

Loading

Uh oh!

jribbink left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

chasefleming May 2, 2025

Uh oh!

mfbz May 2, 2025

Uh oh!

Uh oh!

jribbink left a comment

Uh oh!

Uh oh!

Uh oh!

jribbink May 12, 2025 •

edited

Loading

Uh oh!

mfbz May 12, 2025

Uh oh!

jribbink May 12, 2025

Uh oh!

mfbz May 12, 2025 •

edited

Loading

Uh oh!

jribbink left a comment

Uh oh!

Uh oh!

Uh oh!

	export type AcctFn = (acct: InteractionAccount) => InteractionAccount
	export type AuthorizationFn = (acct: InteractionAccount) => InteractionAccount

Refactored SDK package to TypeScript #2352

Refactored SDK package to TypeScript #2352

Uh oh!

Conversation

mfbz commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

jribbink left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

chasefleming May 2, 2025

Choose a reason for hiding this comment

Uh oh!

mfbz May 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jribbink left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jribbink May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mfbz May 12, 2025

Choose a reason for hiding this comment

Uh oh!

jribbink May 12, 2025

Choose a reason for hiding this comment

Uh oh!

mfbz May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jribbink left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mfbz commented Apr 24, 2025 •

edited

Loading

changeset-bot bot commented Apr 24, 2025 •

edited

Loading

jribbink May 12, 2025 •

edited

Loading

mfbz May 12, 2025 •

edited

Loading