Add changeset tooling

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/workflows/changeset.yml

@@ -0,0 +1,33 @@
+name: Changeset
+on:
+  push:
+    branches:
+      - main
+      - ullrich/add-changesets
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.BELLA_ACTION_TOKEN }}
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - uses: bahmutov/npm-install@v1
+
+      - name: Create release PR or publish release
+        uses: changesets/action@v1
+        with:
+          version: yarn changeset version
+          publish: yarn changeset publish
+          commit: 'chore: version package'
+          title: 'chore: version package'
+          createGithubReleases: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.BELLA_ACTION_TOKEN }}

.gitignore

@@ -28,4 +28,7 @@ output.json
 google-services.json
 
 # Android Profiling
-*.hprof
+*.hprof
+
+# Node
+node_modules/

CHANGELOG.md

@@ -0,0 +1,33 @@
+# MagicBell Android SDK
+
+## 2.0.0
+
+This release is mostly compatible with version 1.0.0 of the SDK. It introduces two breaking changes though. Please consult the Readme for detailed reference.
+
+### Breaking: Updated Notification Preferences API
+
+The shape of the returned preferences object changed and now contains categories and channels.
+
+### Breaking: HMAC validation
+
+Instead of being required to pass the API secret, the HMAC should be computed on backend and passed to the frontend, where it is expected as an argument on the connectUser call.
+Also the MagicBellClient does not have a enableHMAC flag anymore. The behaviour whether to send an HMAC header is now defined by whether one was passed as an argument to the connectUser call.
+
+### APNS Integration
+
+The previous SDK was registering device tokens using the `/push_subscriptions` API endpoint. Since version 2, the SDK uses the `/integrations/mobile_push/apns`
+
+### What's Changed
+
+- Upgrading Android and Gradle Tooling by @stigi in https://github.com/magicbell-io/magicbell-android/pull/13
+- Remove API secret in favor of explicitly passing user HMAC by @stigi in https://github.com/magicbell-io/magicbell-android/pull/14
+- Notification preferences update by @stigi in https://github.com/magicbell-io/magicbell-android/pull/15
+- fix: Use correct keys when parsing action URL and custom Attributes from notification response by @stigi in https://github.com/magicbell-io/magicbell-android/pull/16
+- chore: Migrate from Push Subscriptions to FCM Integration by @stigi in https://github.com/magicbell-io/magicbell-android/pull/17
+- chore: Bump SDK version to 2.0.0 by @stigi in https://github.com/magicbell-io/magicbell-android/pull/18
+
+### New Contributors
+
+- @stigi made their first contribution in https://github.com/magicbell-io/magicbell-android/pull/13
+
+**Full Changelog**: https://github.com/magicbell-io/magicbell-android/compare/1.0.0...2.0.0

README.md

@@ -74,9 +74,9 @@ This repo also contains a full blown example. To run the project:
 Add the dependency in your build.gradle file.
 ```groovy
   // MagicBell SDK
-  implementation 'com.magicbell:magicbell-sdk:1.0.0'
+  implementation 'com.magicbell:magicbell-sdk:2.0.0'
   // MagicBell Compose
-  implementation 'com.magicbell:magicbell-sdk-compose:1.0.0'
+  implementation 'com.magicbell:magicbell-sdk-compose:2.0.0'
 ```
 
 ## The MagicBell Client
@@ -551,7 +551,7 @@ user.preferences.update().getOrElse { }
 
 To update a single channel you can use the provided convenience function `updateChannel`.
 
-```swift
+```kotlin
 user.preferences.updateChannel("new_comment", "in_app", true).getOrElse { }
 ```
 

example/build.gradle

@@ -55,10 +55,7 @@ dependencies {
   implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.0'
 
   // MagicBell
-  // implementation 'com.magicbell:magicbell-sdk:2.0.0'
   implementation project(":sdk") // using local dependency
-
-  // implementation 'com.magicbell:magicbell-sdk-compose:2.0.0'
   implementation project(":sdk-compose") // using local dependency
 
   // Compose

package.json

@@ -0,0 +1,15 @@
+{
+  "name": "magicbell-android",
+  "version": "2.0.0",
+  "private": true,
+  "type": "module",
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.8",
+    "replace-in-file": "^8.2.0",
+    "tsx": "^4.19.1"
+  },
+  "scripts": {
+    "changeset": "./scripts/changeset-wrapper.sh"
+  }
+}

scripts/changeset-wrapper.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+# make sure the script runs relative to the repo root
+set -euo pipefail && cd "$(dirname "${BASH_SOURCE[0]}")/.."
+
+# some helpers and error handling:
+info()  { printf "%s\n" "$*" >&1; }
+error() { printf "%s\n" "$*" >&2; }
+trap 'echo Changeset interrupted >&2; exit 2' INT TERM
+
+# pass all arguments to changeset
+./node_modules/.bin/changeset "$@"
+
+changeset_exit=$?
+if [ ${changeset_exit} -gt 0 ];
+then
+    error "Changeset finished with error"
+    exit ${changeset_exit}
+fi
+
+# if first argument was `version` also run the `update-version.ts` script
+args=("$@")
+if [ $# -gt 0 ] && [ ${args[0]} = "version" ]
+then
+    yarn tsx scripts/update-version.ts
+fi

scripts/update-version.ts

@@ -0,0 +1,36 @@
+import { replaceInFile } from 'replace-in-file';
+
+import pkgJson from '../package.json';
+
+const version = pkgJson.version
+
+// Warning:
+// Make sure to bundle replacements in the same file into one, otherwise the `Promise.all`
+// later on can lead to race conditions, overwriting previously applied replacements
+
+const replacements = [
+  {
+    files: 'README.md',
+    from: [
+      // Gradle instructions
+      /implementation 'com.magicbell:magicbell-sdk:\d\.\d\.\d'/g,
+      /implementation 'com.magicbell:magicbell-sdk-compose:\d\.\d\.\d'/g,
+    ],
+    to: [
+      `implementation 'com.magicbell:magicbell-sdk:${version}'`,
+      `implementation 'com.magicbell:magicbell-sdk-compose:${version}'`
+    ],
+  },
+  {
+    files: 'gradle-mvn-push.gradle',
+    from: /version = '\d\.\d\.\d'/g,
+    to: `version = '${version}'`,
+  }
+]
+
+await Promise.all(
+  replacements.map(options => replaceInFile(options))
+).catch(e => {
+  process.stdout.write(`Error updating version via update-version.ts: ${e}\n`);
+  process.exit(1);
+})