Generate type for loaderArgs and handlerArgs per event

[JonoPrest]

Quick one following up from this discussion: #539

When creating a loader outside of the handler registration, using the generated types means you can't use type inference for loader return.

Eg. from Paul:

type LoaderReturn = {
  asset: Entity.Asset | undefined;
  batch: Entity.Batch | undefined;
  batcher: Entity.Batcher | undefined;
  watcher: Entity.Watcher | undefined;
};

const loader: SablierLockup_v2_0_CreateLockupTranchedStream_loader<LoaderReturn> = async ({
  context,
  event,
}): Promise<LoaderReturn> => {
  const assetId = Id.asset(event.srcAddress, event.chainId);
  const asset = await context.Asset.get(assetId);

  const sender = event.params.commonParams[1];
  const batchId = Id.batch(event, sender);
  const batch = await context.Batch.get(batchId);

  const batcherId = Id.batcher(event, sender);
  const batcher = await context.Batcher.get(batcherId);

  const watcherId = event.chainId.toString();
  const watcher = await context.Watcher.get(watcherId);
  return {
    asset,
    batch,
    batcher,
    watcher,
  };
};

It's more ergonomic to add a type to just the args and let TS infer the return.

I've added the type for handlerArgs as well (although not sure how useful it is because you would need to define loaderReturn)

Summary by CodeRabbit

• Refactor
  • Improved the structure of type alias declarations for event loaders and handlers, making them more modular and easier to understand. No changes to existing functionality.

[coderabbitai]

Walkthrough

The change refactors type alias declarations for event loaders and handlers in the generated ReScript code. It introduces intermediate type aliases (loaderArgs and handlerArgs) to modularize complex generic arguments, and updates the corresponding loader and handler type aliases to use these new intermediates. All new aliases are annotated with @genType.

Changes

File(s)	Change Summary
codegenerator/cli/src/hbs_templating/codegen_templates.rs	Refactored type aliases for event loaders and handlers by introducing loaderArgs and handlerArgs intermediates, updating loader and handler definitions, and annotating new aliases with @genType. No changes to contractRegister type.

Poem

In the warren of code, new aliases bloom,
Loader and handler, now given more room.
With @genType tags, they hop into view,
Modular and tidy, their purpose anew.
A carrot for clarity, a hop for the day—
The rabbits refactor, and hop on their way! 🥕

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c9e1ba5 and d290fe9.

📒 Files selected for processing (1)

• codegenerator/cli/src/hbs_templating/codegen_templates.rs (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• codegenerator/cli/src/hbs_templating/codegen_templates.rs

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build_and_test

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[DZakh]

I don't really like that they will be exposed in lowercase, but I think we'll be able to sort it out in v3.

[DZakh]

Looks like some tests are failing. I'll help to fix them

[PaulRBerg]

Could you guys please show an example for how the new loaderArgs can be used to avoid the LoaderReturn declaration?

I've fiddled with it for a while but I wasn't able to make it work.

[DZakh]

I see that they are not exposed with the preload_handlers: true. I'll add the types back in the next release.