feat: enable fuels callbacks to be asynchronous (#3637)

* chore: updated callbacks

* docs: added type hints to callback

* chore: changeset

* Update .changeset/three-taxis-do.md

Co-authored-by: Nedim Salkić <[email protected]>

---------

Co-authored-by: Nedim Salkić <[email protected]>

Author: petertonysmith94

.changeset/three-taxis-do.md

@@ -0,0 +1,5 @@
+---
+"fuels": patch
+---
+
+feat: enable `fuels` callbacks to be asynchronous

apps/demo-fuels/fuels.config.full.ts

@@ -85,31 +85,31 @@ export default createConfig({
   // #endregion deployConfig-fn
 
   // #region onBuild
-  onBuild: (config: FuelsConfig) => {
+  onBuild: (config: FuelsConfig): void | Promise<void> => {
     console.log('fuels:onBuild', { config });
   },
   // #endregion onBuild
 
   // #region onDeploy
-  onDeploy: (config: FuelsConfig, data: DeployedData) => {
+  onDeploy: (config: FuelsConfig, data: DeployedData): void | Promise<void> => {
     console.log('fuels:onDeploy', { config, data });
   },
   // #endregion onDeploy
 
   // #region onDev
-  onDev: (config: FuelsConfig) => {
+  onDev: (config: FuelsConfig): void | Promise<void> => {
     console.log('fuels:onDev', { config });
   },
   // #endregion onDev
 
   // #region onNode
-  onNode: (config: FuelsConfig) => {
+  onNode: (config: FuelsConfig): void | Promise<void> => {
     console.log('fuels:onNode', { config });
   },
   // #endregion onNode
 
   // #region onFailure
-  onFailure: (config: FuelsConfig, error: Error) => {
+  onFailure: (config: FuelsConfig, error: Error): void | Promise<void> => {
     console.log('fuels:onFailure', { config, error });
   },
   // #endregion onFailure

packages/fuels/src/cli/commands/build/index.ts

@@ -13,7 +13,7 @@ export async function build(config: FuelsConfig, program?: Command) {
 
   await buildSwayPrograms(config);
   await generateTypes(config);
-  config.onBuild?.(config);
+  await config.onBuild?.(config);
 
   const options = program?.opts();
   if (options?.deploy) {

packages/fuels/src/cli/commands/deploy/index.ts

@@ -27,7 +27,7 @@ export async function deploy(config: FuelsConfig) {
   const predicates = await deployPredicates(config);
   savePredicateFiles(predicates, config);
 
-  config.onDeploy?.(config, {
+  await config.onDeploy?.(config, {
     contracts,
     scripts,
     predicates,

packages/fuels/src/cli/commands/dev/index.ts

@@ -19,7 +19,7 @@ export const closeAllFileHandlers = (handlers: FSWatcher[]) => {
 export const buildAndDeploy = async (config: FuelsConfig) => {
   await build(config);
   const deployedContracts = await deploy(config);
-  config.onDev?.(config);
+  await config.onDev?.(config);
 
   return deployedContracts;
 };

packages/fuels/src/cli/commands/node/index.ts

@@ -34,7 +34,7 @@ export const configFileChanged = (state: NodeState) => async (_event: string, pa
   try {
     // eslint-disable-next-line @typescript-eslint/no-use-before-define
     await node(await loadConfig(state.config.basePath));
-    state.config.onNode?.(state.config);
+    await state.config.onNode?.(state.config);
   } catch (err: unknown) {
     await withConfigErrorHandler(<Error>err, state.config);
   }

packages/fuels/src/cli/types.ts

@@ -70,7 +70,7 @@ export type OptionsFunction = (
 export type FuelsEventListener<CType extends Commands> = (
   config: FuelsConfig,
   data: Extract<CommandEvent, { type: CType }>['data']
-) => void;
+) => void | Promise<void>;
 
 export type UserFuelsConfig = {
   /** Relative directory path to Forc workspace */
@@ -164,7 +164,7 @@ export type UserFuelsConfig = {
    * @param config - Configuration in use
    * @param error - Original error object
    */
-  onFailure?: (config: FuelsConfig, error: Error) => void;
+  onFailure?: (config: FuelsConfig, error: Error) => void | Promise<void>;
 };
 
 export type FuelsConfig = UserFuelsConfig &