magicbell-js

Patch Changes

• #292 95a4d26 Thanks @renovate! - Updated dependencies:

  • updated zustand to ^4.5.2.

• Updated dependencies [feb3dd6]:

  • [email protected]

Patch Changes

• #292 95a4d26 Thanks @renovate! - Updated dependencies:

  • updated zustand to ^4.5.2.

• Updated dependencies [95a4d26]:

  • @magicbell/[email protected]

Patch Changes

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

Minor Changes

• #296 fd91c86 Thanks @smeijer! - Move fields to query params for api get requests. This makes it just slightly easier to form urls for GET request when using the api escape hatch in our cli.

  mb api '/notifications' -f seen=false -X get -c user -r curl
  
  curl --url 'https://api.magicbell.com/notifications?seen=false' \
    --request 'GET' \
    --header 'accept: application/json' \
    --header 'accept-version: v2' \
    --header 'x-magicbell-api-key: 8cd...c70' \
    --header 'x-magicbell-user-email: [email protected]' \
    --header 'x-magicbell-user-hmac: uaZ...hU='
  

Patch Changes

• #290 d6640b1 Thanks @smeijer! - only print error when no response body was printed

• Updated dependencies [feb3dd6]:

  • [email protected]

Patch Changes

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

Patch Changes

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

Patch Changes

• Updated dependencies []:
  • @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.

Patch Changes

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

Patch Changes

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

Patch Changes

• #281 c16e604 Thanks @renovate! - Updated dependencies:

  • updated json-schema-to-ts to 3.1.0.

Patch Changes

• 11c30e6 Thanks @renovate[bot]! - Updated dependencies:

  • updated preact to ^10.22.0.

• Updated dependencies []:

  • @magicbell/[email protected]

Patch Changes

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

Patch Changes

• 40601b6 Thanks @renovate[bot]! - Updated dependencies:

  • updated dompurify to ^3.1.3.

Minor Changes

• #276 702ee27 Thanks @smeijer! - Support reading email or external id for user commands from profile. With this change, instead of running magicbell user notifications list --user-email [email protected], one can run also run:

  # magicbell user notifications list --user-email [email protected]
  magicbell config set userEmail [email protected]
  magicbell user notifications list
  

  or

  # magicbell user notifications list --user-external-id abc
  magicbell config set userExternalId abc
  magicbell user notifications list
  

  Note that the arguments still take precedence when provided.

• #277 8f20dec Thanks @smeijer! - Show command description in the help for that specific command.

Patch Changes

• #278 feea558 Thanks @smeijer! - support api --request GET for curl compat

• #274 34a4fd7 Thanks @smeijer! - Restore magicbell config unset {key}.

Patch Changes

• #271 f57ed5e Thanks @smeijer! - Restore magicbell config unset {key}.

Patch Changes

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

Patch Changes

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

Patch Changes

• #265 3982658 Thanks @smeijer! - Don't mix headers for different authentication scopes.

Patch Changes

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