feat: add equalityFn option for complex objects and array

[paoloricciuti]

Summary by CodeRabbit

• New Features

  • Introduced an equalityFn option for handling complex objects and arrays in search parameters.
  • Added new visual elements to display changes in query parameters within the UI.

• Enhancements

  • Improved tracking of query parameter changes with custom equality functions.
  • Added reactivity for changes in query parameters and store values.

• Tests

  • Enhanced test coverage to ensure reactivity and navigation behave as expected with the new equalityFn feature.

[changeset-bot]

🦋 Changeset detected

Latest commit: 2a57bf4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
sveltekit-search-params	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[netlify]

✅ Deploy Preview for sveltekit-search-params ready!

Name	Link
🔨 Latest commit	2a57bf4
🔍 Latest deploy log	https://app.netlify.com/sites/sveltekit-search-params/deploys/65a867e9870e1d0008807021
😎 Deploy Preview	https://deploy-preview-64--sveltekit-search-params.netlify.app/
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

Walkthrough

The project has introduced a new feature that allows for more nuanced state management in SvelteKit applications. It focuses on handling and comparing complex query parameters with custom equality functions to prevent unnecessary reactivity. This feature is integrated into the application's UI and thoroughly tested to ensure that changes in complex objects and arrays do not trigger multiple reactivity updates unless necessary.

Changes

File Path	Change Summary
.changeset/brave-waves-dance.md	Introduced sveltekit-search-params with equalityFn option.
README.md	Request to summarize diff in specified format was declined.
playground/src/routes/+page.svelte, playground/src/routes/equalityFn/+page.svelte, playground/src/routes/queryparameters/+page.svelte	Added variables and reactive statements for tracking changes; updated UI to display changes.
src/lib/sveltekit-search-params.ts	Modified StoreOptions to include equalityFn; added isComplexEqual function; corrected ssp object type; updated queryParameters and queryParam functions.
tests/index.test.ts	Updated tests to reflect new features and ensure correct reactivity with complex objects.

🐇✨
In the code's green field, under the byte's bright sun,
A rabbit hopped forth, for the changes were done.
With each query param, so uniquely compared,
"No excess reactivity!" it joyfully declared. 🎉
🐇✨

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.
• 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 from git 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: 8

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between ccd7412 and 2a57bf4.

Files selected for processing (7)

• .changeset/brave-waves-dance.md (1 hunks)
• README.md (1 hunks)
• playground/src/routes/+page.svelte (2 hunks)
• playground/src/routes/equalityFn/+page.svelte (1 hunks)
• playground/src/routes/queryparameters/+page.svelte (2 hunks)
• src/lib/sveltekit-search-params.ts (7 hunks)
• tests/index.test.ts (5 hunks)

Additional comments: 10

.changeset/brave-waves-dance.md (1)

• 5-5: The changeset file brave-waves-dance.md correctly documents the addition of the equalityFn option as a minor update.

playground/src/routes/queryparameters/+page.svelte (1)

• 22-27: The reactive block for change_in_store correctly increments the variable whenever the $store changes, aligning with the PR objectives.

playground/src/routes/+page.svelte (3)

• 14-20: The reactive statement for obj_changes correctly increments the variable whenever $obj changes, which is consistent with the PR objectives.
• 23-25: The reactive statement for arr_changes correctly increments the variable whenever $arr changes, which is consistent with the PR objectives.
• 28-29: The reactive statement for lz_changes correctly increments the variable whenever $lz changes, which is consistent with the PR objectives.

src/lib/sveltekit-search-params.ts (4)

• 41-43: The StoreOptions type definition correctly includes the equalityFn property, allowing for custom equality functions for complex objects.
• 174-174: The correction to the ssp object's type definition ensures type safety and clarity in the codebase.
• 191-192: The inclusion of the equalityFn in the queryParameters and queryParam functions is consistent with the PR objectives and allows for custom equality checks.
• 269-271: The isComplexEqual function is used correctly to prevent unnecessary reactivity when the data structure has not changed, aligning with the PR objectives.

README.md (1)

• 424-444: The documentation in the README.md file correctly explains the purpose and usage of the equalityFn option, providing clear examples and notes on its behavior.