feat(notification): Add overload support for notify function to enhance flexibility

[sanduluca]

This PR introduces overload support for the notify function, enabling it to handle multiple usage patterns in a type-safe manner. The changes improve developer ergonomics by allowing the function to be called in various ways:

Supported Call Patterns

notify('error', title);
notify('error', title, description);
notify('error', title, setup);
notify('error', title, description, setup);
notify('error', setup);

Key Changes

1. Function Overloads: Added multiple overloads to the Notify type to define various valid function signatures.
2. Flexible Implementation: Updated the implementation of notify to dynamically handle different combinations of title, description, and setup arguments using type guards.
3. Type Safety: Ensured the notify function adheres to TypeScript's type safety, allowing clear and precise error messages during development.

Motivation

The notify function previously required a rigid setup object for all calls, which reduced flexibility. These enhancements allow developers to quickly show notifications with minimal boilerplate while retaining the ability to configure advanced notification options.

Examples

notify('error', 'Something went wrong');
notify('error', 'Something went wrong', 'Additional details about the error');
notify('error', 'Something went wrong', {
  params: { title: 'Something went wrong', description: 'Details' },
  config: { timeout: 5000 },
});
notify('error', 'Something went wrong', 'Details', {
  params: { title: 'Something went wrong', description: 'Details' },
  config: { timeout: 5000 },
});
notify('error', {
  params: { title: 'Something went wrong', description: 'Details' },
  config: { timeout: 5000 },
});

Let me know if any additional information or refinements are needed!

[PdoubleU]

Hi @sanduluca thanks for such improvement, I like TS's ability to implement a function overload mechanism. Give me a couple of days, I'll take a look and see if we can release it.

[sanduluca]

up

[PdoubleU]

Is there a better option than 'any' here? Maybe doesn't type as 'any' but use only the inferred types from the Notify

[PdoubleU]

In general good PR, I'd like to test it first to check if it has fully backward compatibility with the current interface. Then deploy :)

[sanduluca]

kind reminder

[sanduluca]

Hey @PdoubleU, thank for approving this. Can this be merged as well ?

[sanduluca]

Hi. Any plans merging this ?