feat: added date type in apiobject and apioptions

[MoumitaM]

PR Description

Please include a summary of the change along with the relevant motivation and context.

Linear task (optional)

https://linear.app/rudderstack/issue/SDK-1416/add-more-type-in-apiobject-interface

Cross Browser Tests

Please confirm you have tested for the following browsers:

• Chrome
• Firefox
• IE11

Sanity Suite

• All sanity suite test cases pass locally

Security

• The code changed/added as part of this pull request won't create any security issues with how the software is being used.

Summary by CodeRabbit

• New Features
  • Expanded data types in analytics to include Date, enhancing event tracking capabilities.

[coderabbitai]

Walkthrough

The recent update introduces the Date type as a valid option within the ApiObject and EventApi structures. This enhancement broadens the types that can be utilized, allowing for more precise and time-sensitive data handling within the analytics framework. The change signifies a move towards embracing more dynamic and date-relevant analytics capabilities.

Changes

File Path	Change Summary
.../src/types/ApiObject.ts, .../src/types/EventApi.ts	Added Date type to ApiObject and EventApi definitions.

🐰✨
In the land of code, where the data streams flow,
A change was made, not fast but slow.
Date has arrived, with precision and grace,
To mark the time, in the right place.
Now analytics can track, with time in their grip,
Thanks to the coders, who made this trip.
📅🚀

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-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 1289217 and d7d61ae.

Files selected for processing (2)

• packages/analytics-js-common/src/types/ApiObject.ts (1 hunks)
• packages/analytics-js-common/src/types/EventApi.ts (1 hunks)

Additional comments: 2

packages/analytics-js-common/src/types/ApiObject.ts (1)

• 12-12: The addition of the Date type to the ApiObject definition is a welcome enhancement, aligning with the PR's objectives to support a wider range of data types.

Please ensure that the handling of Date objects, especially in terms of serialization and deserialization, is thoroughly tested across different parts of the library to maintain data integrity and compatibility.

packages/analytics-js-common/src/types/EventApi.ts (1)

• 25-25: The inclusion of the Date type in the ApiOptions type definition enhances the library's data handling capabilities, consistent with the PR's objectives.

As with the ApiObject changes, please ensure that the handling of Date objects within ApiOptions, particularly regarding serialization and deserialization, is thoroughly tested to ensure data integrity and compatibility.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[github-actions]

size-limit report 📦

Name	Size (Base)	Size (Current)	Size Limit	Status
Common Code - No bundling	15.81 KB	15.81 KB (0%)	16.5 KB	✅
Remote Module Federation Mapping - CDN	330 B	330 B (0%)	512 B	✅
Remote Module Federated Plugins - CDN	5.71 KB	5.71 KB (0%)	6 KB	✅
Core ESM - NPM	7.64 KB	7.64 KB (0%)	8 KB	✅
Core CJS - NPM	22.44 KB	22.44 KB (0%)	23 KB	✅
Core - NPM	22.56 KB	22.56 KB (0%)	23 KB	✅
Core Legacy - CDN	42.98 KB	42.98 KB (0%)	44 KB	✅
Core - CDN	22.71 KB	22.71 KB (0%)	23 KB	✅
Core (legacy build) - CDN - v1.1	31.54 KB	31.54 KB (0%)	32 KB	✅
Core - NPM - v1.1	31.55 KB	31.55 KB (0%)	32 KB	✅
Service Worker Module	22.64 KB	22.64 KB (0%)	24 KB	✅
All Integrations (legacy build) - CDN	98.57 KB	98.57 KB (0%)	105 KB	✅