fix(types): additionalProps context

[joscha]

this is bound to the current set of props.
See https://pipedream.com/docs/workflows/contributing/components/api/

Example:

pipedream/components/google_calendar/sources/upcoming-event-alert/upcoming-event-alert.mjs

Line 40 in 3aea15a

if (this.time > 0) {

Summary by CodeRabbit

• Chores
  • Made behind-the-scenes improvements to enhance context management, boosting overall system consistency and reliability.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Mar 25, 2025 4:32pm

[vercel]

@joscha is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The changes update the additionalProps method signature within the BaseSource interface in types/src/index.ts. A this parameter of type PropThis<SourcePropDefinitions> has been added to the method, altering the context in which the function is executed. The change provides direct access to the instance's properties during invocation, while the run method remains unchanged.

Changes

File	Change Summary
types/src/index.ts	Updated the additionalProps method signature in the BaseSource interface by adding a this: PropThis<SourcePropDefinitions> parameter to enhance context.

Suggested reviewers

• jverce

Poem

I'm a code bunny, hopping with delight,
I found a new "this" that makes our types just right,
Context now guides the function's leap,
In BaseSource fields where secrets we keep,
With a joyful hop, I nibble each change in sight!
🐰💻

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

types/src/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

---

📜 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 6d05dd1 and 40603d1.

📒 Files selected for processing (1)

• types/src/index.ts (1 hunks)

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

• types/src/index.ts

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

types/src/index.ts (1)

344-347: Good addition of explicit this type for improved type safety.

Adding the this: SourcePropDefinitions parameter to the additionalProps method provides better type safety by explicitly declaring the type of this within the function context. This matches the PR description that "this is bound to the current set of properties" and improves developer experience by providing proper TypeScript hints.

However, I noticed that the Action interface has a similar additionalProps method (lines 388-390) but without the same this parameter. For consistency, consider applying the same pattern there.

Consider also updating the additionalProps method in the Action interface for consistency:

  additionalProps?: (
+   this: ActionPropDefinitions,
    previousPropDefs: ActionPropDefinitions
  ) => Promise<ActionPropDefinitions>;

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3aea15a and 6d05dd1.

📒 Files selected for processing (1)

• types/src/index.ts (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: Pull Request Checks

types/src/index.ts

[error] 1-1: Definition for rule '@typescript-eslint/ban-types' was not found.

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

• GitHub Check: pnpm publish