Releases - 2024 Week 21

[MagicBella]

Releases

• @magicbell/[email protected]
• @magicbell/[email protected]
• @magicbell/[email protected]
• @magicbell/[email protected]
• @magicbell/[email protected]

[MagicBella]

@magicbell/[email protected]

Patch Changes

• Updated dependencies [c16e604]:
  • [email protected]

[MagicBella]

@magicbell/[email protected]

Patch Changes

• Updated dependencies [7bea88f]:
  • @magicbell/[email protected]
  • @magicbell/[email protected]

[MagicBella]

@magicbell/[email protected]

Major Changes

• #283 7bea88f Thanks @smeijer! - BREAKING CHANGE!

  This is a complete revamp of how we're registering client push notification subscriptions, but given that the v1 API surface is small, migrating should be easy enough. You can find the migration guide on our site.

  The methods mentioned here are the breaking ones that you use when interacting with the browser directly. We've also added a bunch of functions to interact with the MagicBell API directly, leaving all browser interaction for you to implement. Think of use cases where you already have a service worker, and just want to push the channel tokens to our backend, or because you need to list all the currently active channel tokens so the user can unsubscribe from a device they no longer control.

  Please read more about those methods in the docs for @magicbell/webpush

  import { WebPushClient } from '@magicbell/webpush';
  
  const client = new WebPushClient({
    apiKey: '024…0bd',
    userEmail: '[email protected]',
    userHmac: 'NCI…I6M',
  });
  
  await client.isSubscribed();
  await client.subscribe();
  await client.unsubscribe();

  Subscribe to push notifications:

  Subscribing to push notifications is now a single call on the client, instead of the two-step flow from v1.

  - import { getAuthToken, subscribe } from '@magicbell/webpush';
  + import { WebPushClient } from '@magicbell/webpush';
  
  - const token = await getAuthToken({
  + const client = new WebPushClient({
    apiKey: '024…0bd',
    userEmail: '[email protected]',
    userHmac: 'NCI…I6M',
  });
  
  - await subscribe({
  -   token: token.token,
  -   project: token.project,
  - });
  
  + await client.subscribe();

  Unsubscribe from push notifications.

  This is a new method that didn't exist in previous versions. Unsubscribing and resubscribing is now trivial, giving your users the option to "pause" the push notifications.

  import { WebPushClient } from '@magicbell/webpush';
  
  const client = new WebPushClient({
    apiKey: '024…0bd',
    userEmail: '[email protected]',
    userHmac: 'NCI…I6M',
  });
  
  await client.unsubscribe();

  Get subscription status

  Verifying subscription status is now a single call on the client, instead of the two-step flow from v1.

  - import { getAuthToken, isSubscribed } from '@magicbell/webpush';
  + import { WebPushClient } from '@magicbell/webpush';
  
  - const token = await getAuthToken({
  + const client = new WebPushClient({
    apiKey: '024…0bd',
    userEmail: '[email protected]',
    userHmac: 'NCI…I6M',
  });
  
  - const subscribed = await isSubscribed({
  -   token: token.token,
  -   project: token.project,
  - });
  
  + const subscribed = await client.isSubscribed();

  Get authentication token

  The authentication token is no longer required for basic functionality, but can still be used to for example transfer the session to a popup.

  - import { getAuthToken } from '@magicbell/webpush';
  + import { WebPushClient } from '@magicbell/webpush';
  
  - const token = await getAuthToken({
  + const client = new WebPushClient({
    apiKey: '024…0bd',
    userEmail: '[email protected]',
    userHmac: 'NCI…I6M',
  });
  
  + const token = await client.getAuthToken();

  API Methods

  We've added a bunch of useful methods to work with our api directly. Please read more about those methods in the docs for @magicbell/webpush.

[MagicBella]

@magicbell/[email protected]

Patch Changes

• Updated dependencies []:
  • @magicbell/[email protected]

[MagicBella]

@magicbell/[email protected]

Patch Changes

• #284 2095743 Thanks @smeijer! - chore: type fix, apiKey isn't needed when using authToken