Documint - add preview prop to Create Document action

[michelle0927]

Resolves #17277

Summary by CodeRabbit

• New Features

  • Added an optional setting to control whether created documents include a watermark (preview mode).

• Chores

  • Updated internal package and dependency versions.

[vercel]

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

3 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	⬜️ Ignored (Inspect)			Jul 1, 2025 4:04pm
pipedream-docs	⬜️ Ignored (Inspect)			Jul 1, 2025 4:04pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Jul 1, 2025 4:04pm

[coderabbitai]

Walkthrough

The changes introduce a new optional preview property to the Documint create-document action, allowing users to control whether documents are created with or without a watermark. The property defaults to true. The action and package versions are incremented, and a dependency is updated in the package configuration.

Changes

File(s)	Change Summary
components/documint/actions/create-document/create-document.mjs	Added optional preview prop (default true); used this.preview for the API param; updated summary message; incremented action version.
components/documint/package.json	Bumped package version to 0.1.1; updated @pipedream/platform dependency to ^3.1.0.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Action
    participant DocumintAPI

    User->>Action: Trigger create-document with preview (true/false)
    Action->>DocumintAPI: POST createDocument (preview: true/false)
    DocumintAPI-->>Action: Return document response
    Action-->>User: Output document ID and info

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Make "preview" parameter settable in the UI instead of hardcoded (Issue #17277)	✅
Allow creation of documents without watermark by controlling "preview" param (Issue #17277)	✅

Poem

A toggle for preview, now settable and bright,
No more watermarks haunting your sight!
With a hop and a leap, our docs are anew—
Choose watermark or not, the choice is with you.
🐇✨

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.

components/documint/actions/create-document/create-document.mjs

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 Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202: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 df8a3b7 and eb78600.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (2)

• components/documint/actions/create-document/create-document.mjs (3 hunks)
• components/documint/package.json (2 hunks)

🧰 Additional context used

🧠 Learnings (2)

components/documint/package.json (1)

Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.

components/documint/actions/create-document/create-document.mjs (3)

Learnt from: jcortes
PR: PipedreamHQ/pipedream#14467
File: components/gainsight_px/actions/create-account/create-account.mjs:4-6
Timestamp: 2024-10-30T15:24:39.294Z
Learning: In `components/gainsight_px/actions/create-account/create-account.mjs`, the action name should be "Create Account" instead of "Create Memory".

Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-07-04T18:11:59.822Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.

Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-10-08T15:33:38.240Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.

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

• GitHub Check: pnpm publish
• GitHub Check: Lint Code Base
• GitHub Check: Publish TypeScript components
• GitHub Check: Verify TypeScript components

🔇 Additional comments (6)

components/documint/package.json (2)

3-3: LGTM: Version increment is appropriate.

The patch version increment from 0.1.0 to 0.1.1 is appropriate for adding a new optional property without breaking existing functionality.

---

16-16: Confirm API compatibility when bumping to @pipedream/platform v3

File: components/documint/package.json
Lines: 16

-   "@pipedream/platform": "^1.5.1"
+   "@pipedream/platform": "^3.1.0"

I didn’t find any in-repo migration docs for the v3.x release, and while most other components have already moved to 3.x, this major version jump may include breaking changes. Please:

• Run your component’s unit/integration tests against v3.1.0 to catch any runtime or signature mismatches.
• Review Pipedream’s official v3 migration guide (https://pipedream.com/docs/migration) for API changes between v1.x and v3.x.
• Double-check that all handlers, hooks, and exported function signatures in components/documint remain compatible with the new platform APIs.

components/documint/actions/create-document/create-document.mjs (4)

5-5: LGTM: Version increment is appropriate.

The version increment from 0.0.1 to 0.0.2 is appropriate for adding a new optional feature.

---

22-28: Well-implemented preview property.

The new preview property is well-designed:

• Boolean type is appropriate for watermark control
• Default value of true maintains backward compatibility
• Optional flag prevents breaking existing implementations
• Clear description explains the watermark behavior

---

40-40: LGTM: Dynamic preview parameter implementation.

The change from hardcoded preview: true to this.preview correctly implements the dynamic watermark control feature as intended.

---

48-48: Confirm Documint API uses _id for document identifiers
We ran a search across all components/documint/actions files for response.id and response._id and only found the following usage in the create-document action. Please verify against the Documint API documentation or by testing that the response object indeed provides an _id field (and not id) before shipping this update.

• components/documint/actions/create-document/create-document.mjs (around line 48)

$.export("$summary", `Successfully created document with ID \`${response._id}\``);

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.
  • 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.