chore: add more field types

[catalinpit]

Description

What I've done:

• Moved the title and description (DocumentFlowFormContainerHeader) from edit-template page into each template step. For example, add-template-fields, add-template-settings, etc. have their own title and description. Exactly like it's done for the documents. Why did I do that? So, the header and description from "Field Advanced settings" doesn't collide with the info for each step.

• Create a new file for each new field (checkbox, number, dropdown, radio). Also updated the text field to include advanced settings.

• Created an optional fieldMeta field of JSONB type in the Field model. This way, we can store advanced configuration for each field. Also, the selected/chosen/entered value for each field is stored in the customText field.

• Added the fieldMeta field in the required schemas and types.

• Added the new fields in the signing-page-view so they are visible and usable.

• Added the fields in the document audit log.

• Created tRPC procedures for retrieving and updating the fieldMeta property for a field.

• Modified the getFieldById function to retrieve a field based on the document or template id, depending on which one is passed to the function.

• Created the advanced settings panel that has various fields depending on the field. Each has different properties, with some of them overlapping.

• Added colors for each recipient so it's easier to distinguish between them. The recipients and their associated fields will have the same color.

• Updated the SPM to display the new fields.

.... plus other smaller things.

What's left:

1. Update the dropdown field to actually be a dropdown field.

2. Update the UI according to Goutham's design.

3. Make the new fields work in the SPM mode.

4. Cleanup the code.

5. Fix the TS error from create-document-from-template file, line 217

Related Issue

Changes Made

• Change 1
• Change 2
• ...

Testing Performed

• Tested feature X in scenario Y.
• Ran unit tests for component Z.
• Tested on browsers A, B, and C.
• ...

Checklist

• I have tested these changes locally and they work as expected.
• I have added/updated tests that prove the effectiveness of these changes.
• I have updated the documentation to reflect these changes, if applicable.
• I have followed the project's coding style guidelines.
• I have addressed the code review feedback from the previous submission, if applicable.

Additional Notes

[coderabbitai]

Important

Review Skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates introduce several new field types and functionalities across various components and modules. Key changes include adding fieldMeta properties to handle advanced settings, expanding field types to include NUMBER, RADIO, CHECKBOX, and DROPDOWN, and enhancing document signing capabilities. Additionally, the updates involve schema and database migrations to support these new field types and metadata, as well as modifications to existing functions and components to incorporate these enhancements.

Changes

Files/Paths	Change Summaries
apps/marketing/src/app/(marketing)/singleplayer/client.tsx	Added fieldMeta property to objects within an array and initialized it to an empty object.
apps/web/src/app/(dashboard)/templates/[id]/edit-template.tsx	Removed import and usage of DocumentFlowFormContainerHeader.
apps/web/src/app/(signing)/sign/[token]/checkbox-field.tsx	Added CheckboxField component for handling checkbox field signing.
apps/web/src/app/(signing)/sign/[token]/dropdown-field.tsx	Introduced DropdownField component for dropdown field signing.
apps/web/src/app/(signing)/sign/[token]/number.tsx	Added NumberField component for number field signing.
apps/web/src/app/(signing)/sign/[token]/radio-field.tsx	Added RadioField component for radio field signing.
apps/web/src/app/(signing)/sign/[token]/signing-field-container.tsx	Expanded SignatureFieldProps type to include new field types (Radio, Dropdown, Number, Checkbox).
apps/web/src/app/(signing)/sign/[token]/signing-page-view.tsx	Added new field components (CheckboxField, NumberField, RadioField, DropdownField) to SigningPageView.
apps/web/src/app/(signing)/sign/[token]/text-field.tsx	Updated TextField component to include fieldMeta and related logic.
apps/web/src/components/document/document-read-only-fields.tsx	Updated P.union function call to include new field types (NUMBER, RADIO, CHECKBOX, DROPDOWN).
packages/lib/server-only/field/get-field-by-id.ts	Added templateId parameter to getFieldById function.
packages/lib/server-only/field/set-fields-for-document.ts	Added fieldMeta property to SetFieldsForDocumentOptions and related logic.
packages/lib/server-only/field/set-fields-for-template.ts	Added fieldMeta property to SetFieldsForTemplateOptions and related logic.
packages/lib/server-only/field/sign-field-with-token.ts	Introduced validation for number fields in signFieldWithToken function.
packages/lib/server-only/field/update-field.ts	Added fieldMeta parameter to updateField function.
packages/lib/server-only/template/create-document-from-template.ts	Added fieldMeta property to the object being created in createDocumentFromTemplate.
packages/lib/types/document-audit-logs.ts	Added new field types (RADIO, CHECKBOX, DROPDOWN, NUMBER) to ZDocumentAuditLogEventDocumentFieldInsertedSchema.
packages/lib/types/field-field-meta.ts	Introduced ZFieldMetaSchema for defining field metadata properties.
packages/prisma/migrations/.../migration.sql	Added new field types to FieldType enum and fieldMeta column to the Field table.
packages/prisma/schema.prisma	Added new enum values and fieldMeta field to Field model.
packages/prisma/types/field-with-signature-and-fieldmeta.ts	Introduced FieldWithSignatureAndFieldMeta type.
packages/trpc/server/field-router/router.ts	Added getFieldById and updateField functions and handled field metadata in router logic.
packages/trpc/server/field-router/schema.ts	Added ZFieldMetaSchema and included fieldMeta in various schemas.
packages/trpc/server/singleplayer-router/helper.ts	Added new field types with corresponding custom text values in mapField function.
packages/trpc/server/singleplayer-router/router.ts	Added fieldMeta parameter to singleplayerRouter function.
packages/trpc/server/singleplayer-router/schema.ts	Added ZFieldMetaSchema and included fieldMeta in ZCreateSinglePlayerDocumentMutationSchema.
packages/ui/primitives/document-flow/add-fields.tsx	Added new imports, types, state management, and logic for advanced settings and recipient color classes.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
prd-app	🔄 Building (Inspect)	Visit Preview		May 23, 2024 3:47pm
prd-marketing	🔄 Building (Inspect)	Visit Preview		May 23, 2024 3:47pm
stg-app	❌ Failed (Inspect)			May 23, 2024 3:47pm
stg-docs	❌ Failed (Inspect)			May 23, 2024 3:47pm
stg-marketing	❌ Failed (Inspect)			May 23, 2024 3:47pm

[catalinpit]

couldn't think of a better way of making the hover work on passive/disabled fields. happy to hear suggestions