add activitySelectionMetadata and set functions (#45)

* add activitySelectionMetadata and set functions

* going back to npm for example

* Solid first iteration on set functionality

* Lots of updates to support multiple blocks with separate shields

* switch to monorepo structure

* working directory for pr publish

* fix absolute paths

* fix pkg-pr-new publish path

* try npx

* try using wildcard

* break out tests

* try not using setup-node

* always use latest pkg-pr-new

* try removing gitignore from apps/example

* remove husky from packages/react-native-device-activity

* Add set tests

* add set tests

* makre sure xcode picks up swiftlint config

* coderabbit nitpicks

* remove unnessecary comments

* coderabbit nitpicks

* Stabilizing

* add more tests

* fix empty webDomainCategories check

* Going back to familyActivitySelectionId for some things

* better naming and add resetBlocks everywhere

* add resetblocks to device-activity action types

* change name to whitelistCurrentApp

* add shieldactions for unblocking selections

* typo + docs

* remove unnessecary tries

* typo

* add refreshManagedSettingsStore and clearAllManagedSettingsStoreSettings

* fix: isSubset was comparing with wrong set

* add onlyFamilySelectionIdsContainingMonitoredActivityNames for getPossibleFamilyActivitySelectionIds

* add whitelistPossibleFamilyActivitySelection and whitelistAllPossibleFamilyActivitySelections to shield action

* add sortByGranularity to getPossibleFamilyActivitySelectionIds

* add setup-bun

* uppercase NPM_TOKEN

* add debug npm token

* add env to debug token

* rename to NPM_AUTH_TOKEN

* add working-directory

* trying something else

* use other approach

* fix git url

* add npm version

* remove -m

* hackaround

* maybe git commit is not needed

* fix working-directory

* move bun install

* revert

* add working directory, remove all mumbo-jumbo

* add nail version script

* trying a different approach

* remove potential newline

* add --no-verify

* make sure we get a clean version

* bump version

* change push logic

* add more debugging

* test

* add git add and commit

* update again

* git commit —no-verify

* chore: update version

* add test for getActivitySelectionPrefixedConfigFromUserDefaults

* upgrade rn

* tests

* more tests, add missing categoryTokens, update types

* fix types

* chore: update version

* fix tests by ignoring test activityNames

* swiftlint

* add timeouts to workflows

* starts bundler before running native tests

* bump xcode-elect to 16.2

* copying swiftlint config to make sure it’s available, also remove it from build process

* Add some more to the readme

* stricter peer deps, clean up names and comments

* prettier

* skip rn setup for native tests

* update lockfiles

* specify swift version once

* try swift_version 5.8

* print out swift version, remove trailing commas

* adjust platforms

Author: robertherber

.github/workflows/npm-publish.yml

@@ -45,17 +45,43 @@ jobs:
 
       - uses: actions/setup-node@v4
 
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
       - run: git config user.name "$(git log -n 1 --pretty=format:%an)"
       - run: git config user.email "$(git log -n 1 --pretty=format:%ae)"
-      - run: echo "versionTag=`npm version ${{ github.event.inputs.release_type }} -m "%s ${{ github.event.inputs.description }}"`" >> $GITHUB_ENV
 
       - run: bun install
 
+      - run: bun run nail-workspace-dependency-versions
+
+      - run: npm version ${{ github.event.inputs.release_type }}
+        working-directory: packages/react-native-device-activity
+
+      - run: |
+          VERSION=$(node -p "require('./package.json').version")
+          echo "versionTag=v${VERSION}" >> $GITHUB_ENV
+        working-directory: packages/react-native-device-activity
+
+      - name: Setup NPM Authentication
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > .npmrc
+
+      - run: git add packages/react-native-device-activity/package.json
+
+      - run: |
+          git commit -m 'chore: update version' --no-verify
+
       - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+        working-directory: packages/react-native-device-activity
 
-      - run: git push --follow-tags
+      - run: |
+          git status
+          git branch -a
+          git log -1
+          git push origin HEAD --no-verify
+          git push origin --tags --no-verify
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 

.github/workflows/pr.yml

@@ -14,13 +14,13 @@ jobs:
         with:
           bun-version: latest
 
-      - uses: actions/setup-node@v4
-        with:
-          registry-url: https://registry.npmjs.org/
-          scope: '@kingstinct'
-
       - run: bun install
 
-      - run: bun run prepublishOnly
+      - name: Build package
+        run: |
+          cd packages/react-native-device-activity
+          bun run build
+          bun run prepublishOnly
       
-      - run: npx pkg-pr-new publish
+      - name: Publish preview
+        run: bunx pkg-pr-new@latest publish './packages/*'

.github/workflows/test.yml

@@ -10,6 +10,7 @@ jobs:
   lint:
     name: eslint
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
 
@@ -24,6 +25,7 @@ jobs:
   typecheck:
     name: Typecheck
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
 
@@ -38,6 +40,7 @@ jobs:
   typecheck-example:
     name: Typecheck (example project)
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
 
@@ -47,15 +50,13 @@ jobs:
 
       - run: bun install
 
-      - run: bun install
-        working-directory: example
-
       - run: bun typecheck
-        working-directory: example
+        working-directory: apps/example
 
   bundle-example:
     name: Expo Bundle (example project)
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
 
@@ -65,14 +66,12 @@ jobs:
 
       - run: bun install
 
-      - run: bun install
-        working-directory: example
-
       - run: bunx expo export
-        working-directory: example
+        working-directory: apps/example
 
   config-example:
     name: Expo Config (example project)
+    timeout-minutes: 10
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -83,15 +82,13 @@ jobs:
 
       - run: bun install
 
-      - run: bun install
-        working-directory: example
-
       - run: bunx expo config
-        working-directory: example
+        working-directory: apps/example
 
   prebuild-example:
     name: Expo Prebuild (example project)
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
 
@@ -101,15 +98,13 @@ jobs:
 
       - run: bun install
 
-      - run: bun install
-        working-directory: example
-
       - run: bunx expo prebuild
-        working-directory: example
+        working-directory: apps/example
 
   swift-lint:
     name: SwiftLint (example project)
     runs-on: macos-latest
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
 
@@ -125,18 +120,16 @@ jobs:
             ${{ runner.os }}-pods-
 
       - run: bun install
-      
-      - run: bun install
-        working-directory: example
-      
+
       - run: pod install
-        working-directory: example/ios
+        working-directory: apps/example/ios
 
-      - run: example/ios/Pods/SwiftLint/swiftlint lint
+      - run: apps/example/ios/Pods/SwiftLint/swiftlint lint
 
   swift-test:
     name: Swift Test (example project)
     runs-on: macos-latest
+    timeout-minutes: 25
     steps:
       - uses: actions/checkout@v4
 
@@ -150,6 +143,10 @@ jobs:
 
       - run: bun install
 
+      - name: Start bundler
+        run: bun start &
+        working-directory: apps/example
+
       - uses: actions/cache@v4
         with:
           path: example/ios/Pods
@@ -169,16 +166,18 @@ jobs:
           restore-keys: xcode-cache-deriveddata-${{ github.workflow }}-
 
       - name: Set up Xcode version
-        run: sudo xcode-select -s /Applications/Xcode_16.1.app/Contents/Developer
-      
-      - run: bun install
-        working-directory: example
-      
+        run: sudo xcode-select -s /Applications/Xcode_16.2.app/Contents/Developer
+
+      - name: Check Swift version
+        run: swift --version
+    
       - run: pod install
-        working-directory: example/ios
+        working-directory: apps/example/ios
+
+      - run: cp .swiftlint.yml apps/example/ios
 
       - run: xcodebuild test -workspace reactnativedeviceactivityexample.xcworkspace -scheme Tests -allowProvisioningUpdates -destination "platform=iOS Simulator,OS=latest,name=iPhone 16"
-        working-directory: example/ios
+        working-directory: apps/example/ios
 
 
 

.gitignore

@@ -65,4 +65,34 @@ android/keystores/debug.keystore
 !.yarn/plugins
 !.yarn/releases
 !.yarn/sdks
-!.yarn/versions
+!.yarn/versions
+
+# Expo
+.expo/
+dist/
+web-build/
+
+# Native
+*.orig.*
+*.jks
+*.p8
+*.p12
+*.key
+*.mobileprovision
+
+# Metro
+.metro-health-check*
+
+# debug
+npm-debug.*
+yarn-debug.*
+yarn-error.*
+
+# macOS
+*.pem
+
+# local env files
+.env*.local
+
+# typescript
+*.tsbuildinfo

.husky/pre-commit

@@ -1,2 +1,2 @@
-swift format -i -p -r ./targets ./ios ./example/ios
-example/ios/Pods/SwiftLint/swiftlint lint --fix
+swift format -i -p -r ./packages/react-native-device-activity/ios ./packages/react-native-device-activity/targets ./apps/example/ios
+apps/example/ios/Pods/SwiftLint/swiftlint lint --fix

.swiftlint.yml

@@ -9,8 +9,9 @@ disabled_rules:
   - cyclomatic_complexity
   - file_length
   - function_parameter_count
+  - inclusive_language
 
 included:
-- ios
-- example/ios
-- targets
+- packages/react-native-device-activity/ios
+- apps/example/ios
+- packages/react-native-device-activity/targets

.vscode/extensions.json

@@ -1,6 +1,6 @@
 {
   "recommendations": [
     "vknabel.vscode-swiftlint",
-    "sswg.swift-lang"
+    "swiftlang.swift-vscode"
   ],
 }

.vscode/settings.json

@@ -2,5 +2,6 @@
   "cSpell.words": [
     "Triggerable"
   ],
-  "swiftlint.path": "example/ios/Pods/SwiftLint/swiftlint"
+  "swiftlint.path": "apps/example/ios/Pods/SwiftLint/swiftlint",
+  "swift.SDK": "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS18.2.sdk"
 }

README.md

@@ -88,7 +88,7 @@ The package requires native code, which includes a custom app target. Currently
       "expo-build-properties",
       {
         "ios": {
-          "deploymentTarget": "15.0"
+          "deploymentTarget": "15.1"
         },
       },
     ],
@@ -110,6 +110,18 @@ For Expo to be able to automatically handle provisioning you need to specify ext
 
 You can potentially modify the targets manually, although you risk the library and your app code diverging. If you want to disable the automatic copying of the targets, you can set `copyToTargetFolder` to `false` in the plugin configuration [as seen here](https://github.com/Intentional-Digital/react-native-device-activity/blob/main/example/app.json#L53).
 
+## Some notes
+- It's not possible to 100% know which familyActivitySelection an event being handled is triggered for in the context of the Shield UI/actions. We try to make a best guess here - prioritizing apps/websites in an activitySelection over categories, and smaller activitySelections over larger ones (i.e. "Instagram" over "Instagram + Facebook" over "Social Media Apps"). This means that if you display a shield specific for the Instagram selection that will take precedence over the less specific shields.
+- When determining which familyActivitySelectionId that should be used it will only look for familyActivitySelectionIds that are contained in any of the currently monitored activity names (i.e. if familyActivitySelectionId is "social-media-apps" it will only trigger if there is an activity name that contains "social-media-apps"). This might be a limitation for some implementations, it would probably be nice to make this configurable.
+
+## Data model
+Almost all the functionality is built around persisting configuration as well as event history to UserDefaults.
+
+- familyActivitySelectionId mapping. This makes it possible for us to tie a familyActivitySelection token to an id that we can reuse and refer to at a later stage.
+- Triggers. This includes configuring shield UI/actions as well as sending web requests or notifications from the Swift background side, in the context of the device activity monitor process. Prefixed like actions_for_${goalId} in userDefaults. This is how we do blocking of apps, updates to shield UI/actions etc.
+- Event history. Contains information of which events have been triggered and when. Prefixed like events_${goalId} in userDefaults. This can be useful for tracking time spent.
+- ShieldIds. To reduce the storage strain on userDefaults shields are referenced with shieldIds.
+
 # Installation in bare React Native projects
 
 For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing.
@@ -130,7 +142,7 @@ As early as possible you want to [request approval from Apple](https://developer
 
 Note that until you have approval for all bundleIdentifiers you want to use, you are stuck with local development builds in XCode. I.e. you can't even build an Expo Dev Client.
 
-For every base bundleIdentifier you need approval for 4 bundleIdentifiers:
+For every base bundleIdentifier you need approval for 4 bundleIdentifiers (if you want to use all the native extensions that is, you can potentially just use the Shield-related ones if you have no need to listen to the events, or similarly just use the ActivityMonitor if you do not need control over the Shield UI):
 
 - com.your-bundleIdentifier
 - com.your-bundleIdentifier.ActivityMonitor
@@ -141,12 +153,33 @@ Once you've gotten approval you need to manually add the "Family Controls (Distr
 
 ⚠️ If you don't do all the above you will run in to a lot of strange provisioning errors.
 
-## Limitations and weird/notable things
-
-- The DeviceActivitySelectionView is prone to crashes, which is outside of our control. The best we can do is provide fallback views that allows the user to know what's happening and reload the view.
-- If you've asked about the authorization status once and the user after that revokes it outside the app, the native APIs won't reflect this until the app is restarted.
-- requestAuthorization() can be called multiple times, even when the user has already denied permission.
-
 # Contributing
 
 Contributions are very welcome! Please refer to guidelines described in the [contributing guide](https://github.com/expo/expo#contributing).
+
+# Weird behaviors ⚠️
+
+- Authorization changes outside app not captured
+When we've asked whether the user has authorized us to use screen time, and the state is changed outside the app, the native API doesn't update until the app restarts, i.e. this flow:
+  1. Ask for current permission
+  2. Change permission outside the app
+  3. Ask for current permission again will return same as (1)
+  4. **Workaround: restart the app**
+
+- We can both request and revoke permissions as we like, and how many times we like, even when the user has denied permissions. This is very unlike most authorization flows on iOS.
+
+- When calling `getAuthorizationStatus` it can sometimes return `notDetermined` even though the user has already made a choice, this comes with a delay. Workaround: keep polling the status for a while (`pollAuthorizationStatus` is a convenience function for this).
+
+- The DeviceActivitySelectionView is prone to crashes, which is outside of our control. The best we can do is provide fallback views that allows the user to know what's happening and reload the view.
+
+# Troubleshooting 📱
+The Screen Time APIs are known to be very finnicky. Here are some things you can try to troubleshoot events not being reported:
+
+- Disable Low Power Mode (mentioned by Apple Community Specialist [here](https://discussions.apple.com/thread/254808070)) 🪫
+- Turn off/turn on app & website activity
+- Disable/reenable sync between devices for screen time
+- Restart device
+- Make sure device is not low on storage (mentioned by Apple Community Specialist [here](https://discussions.apple.com/thread/254808070)) 💾
+- Upgrade iOS version
+- Content & Privacy Restrictions: If any restrictions are enabled under Screen Time’s Content & Privacy Restrictions, ensure none are blocking your app.
+- Reset all device settings