3.0.0 (Beta 1)

User Model (Beta)

🚧 Beta release. Please test thoroughly prior to production use. 🚧

In this major version beta release for the OneSignal SDK, we are making a significant shift from a device-centered model to a user-centered model. A user-centered model allows for more powerful omni-channel integrations within the OneSignal platform.

For information please see the migration guide

What's Changed

• Bump ejs from 3.1.6 to 3.1.7 in /example by @dependabot in #68
• Add issue templates by @rgomezp in #72
• removed . npmignore file by @kesheshyan in #73
• Bump json5 from 1.0.1 to 1.0.2 by @dependabot in #89
• Update README.md by @rgomezp in #84
• Adding the release drafter action by @emawby in #91
• Close asana tasks generated from Github issues by @emawby in #88
• Generator Update by @onesignal-deploy in #98

New Contributors

• @kesheshyan made their first contribution in #73
• @emawby made their first contribution in #91
• @onesignal-deploy made their first contribution in #98

Full Changelog: 2.0.4...3.0.0-beta1

2.0.4

What's Changed

• Update README with updated type definitions by @rgomezp in #64
• Update README with Troubleshooting section by @rgomezp in #65
• Example App by @rgomezp in #66
• Bump minimist from 1.2.5 to 1.2.6 by @dependabot in #63
• Bump ansi-regex from 4.1.0 to 4.1.1 by @dependabot in #67

What's fixed

• 2.0.4 Release - fix typescript compiler errors related to event handler functions by @rgomezp in #71

Full Changelog: 2.0.3...2.0.4

2.0.3

What's Changed

• Update README to include Service Worker config info by @rgomezp in #56
• 2.0.3 Release by @rgomezp in #59

Fixed

• Switch from a timeout strategy during OneSignal initialization to script#onload and script#onerror so that calls to #init will always resolve.

Full Changelog: 2.0.2...2.0.3

2.0.2

• Fixes functions that weren't returning promises. See #53

2.0.1

Adds homepage and repository links from #50

2.0.0

2.0.0 Release

🚧 Includes breaking changes 🚧

If migrating from a 1.0+ version, read the migration guide.

---

The React OneSignal NPM package previously lacked several OneSignal WebSDK functions. The package was also dependent on an initialization helper set-up hook. This ensured OneSignal was ready to execute the functions before doing so. The initialization function was also different from our WebSDK initialization.

This release addresses the above points by:

• adding all supported functions
• changing the initialization function
• removing the need for the set-up hook

Additionally, the release includes some clean-up:

• restructures repository so the package is at the top level
• removes unneeded files
• updates the README

We hope the changes will greatly simplify the package and improve usability. We also want to ensure adopters have access to all of the most up-to-date functions and features provided by OneSignal.

Events

The events object is no longer needed either. In its place, the event handlers can now be added directly via the on function to match the WebSDK 1:1.

Typescript Support

This release also adds full Typescript support for all functions.

Release 2.0 (Beta)

See #44 for more info.

1.7.0

🔥 Support Slidedown prompts

This release adds two new functions: showSlidedownPrompt and showCategorySlidedown. With these, you can call the option to show the registration mode. Docs here.

Thanks to @RodolfoSilva for the contributions! 🚀

1.6.0

🔥 New setup hook!

You can now use the new setup hook to setup your OneSignal settings as soon as OneSignal is initialized into the page. This makes it much easier for you to apply your settings since you don't have to check if OneSignal is initialized or not! 😆

Here's a quick example:

import OneSignal, { useOneSignalSetup } from 'react-onesignal';

type AppProps = {
  user: {
    id: string;
    email: string;
  };
};

function App(props: AppProps) {
  const { user } = props;

  useOneSignalSetup(() => {
    OneSignal.setEmail(user.email);
    OneSignal.setExternalUserId(user.id);
  });
}

🔥 New functions

This version adds two more functions to help setup OneSignal:

• logoutEmail
• removeExternalUserId

Examples:

import OneSignal from 'react-onesignal';

// Remove email tracking
OneSignal.logoutEmail();

// Remove external user ID
OneSignal.removeExternalUserId();

💅 Improvements

This version also brings up some improvements, raising the bar on code quality and upgrading some dependencies.

Thanks to @BigsonLvrocha for the contributions! 🚀

1.5.0

🔥 Support new options

This version adds support for new methods:

• isPushNotificationsEnabled
• isPushNotificationsSupported
• setSubscription

🔥 Improve error handling

If your OneSignal is not set up properly, this lib will now throw an exception.

Thanks to @Matiyeu and @BigsonLvrocha for the contributions! 🚀