@mpgd/adapter-capacitor 0.11.0 → 0.12.0

package/README.md

@@ -194,6 +194,7 @@ import { resolveNotificationTopicsForTarget } from '@mpgd/catalog';
 import {
   createCapacitorNotificationServiceProvider,
   loadCapacitorNotificationSdks,
+  openCapacitorNotificationSettings,
 } from '@mpgd/adapter-capacitor/notifications';
 
 const sdks = await loadCapacitorNotificationSdks();
@@ -201,8 +202,8 @@ const notifications = createCapacitorNotificationServiceProvider({
   platform: 'android',
   topics: resolveNotificationTopicsForTarget(catalog, 'android'),
   ...sdks,
-  // Optional: opens this app's notification settings (see below).
-  openSettings,
+  // Opens this app's notification settings (see below).
+  openSettings: openCapacitorNotificationSettings,
 });
 const gateway = createCapacitorPlatformGateway({ ..., providers: [notifications] });
 ```
@@ -296,11 +297,21 @@ is created, which is how a cold-start open reaches it.
   - The action opens the `optOutRoute` of the advertising topic the push names
     in its `topic` data key; without that key it opens nothing.
   - An Android FCM notification message cannot carry actions, so an Android
-    advertising push needs the shell to render it natively with the action;
-    the template work for that is C1's.
-- **Settings.** Neither plugin opens the notification settings, so the shell
-  passes `openSettings` (for example a small native method); without it
-  `permission.settings` is `false` and `openSettings` answers `unavailable`.
+    advertising push needs the shell to render it natively with the action,
+    which is not built yet (a follow-up after C1). Until then map no
+    advertising topic to `android`: the push would arrive without the
+    opt-out action the Korean rules require (see the RFC's advertising
+    rules). The kit's starter maps its sample advertising topic to iOS only.
+- **Settings.** Neither plugin opens the notification settings, so the
+  provider takes an `openSettings` opener; without one `permission.settings`
+  is `false` and `openSettings` answers `unavailable`.
+  `openCapacitorNotificationSettings` is the kit's opener: it calls
+  `openNotificationSettings` of `@mpgd/capacitor-game-services` (Android 8+
+  `Settings.ACTION_APP_NOTIFICATION_SETTINGS`, iOS 16+
+  `UIApplication.openNotificationSettingsURLString`, and each app's settings
+  page on older versions) and throws when the screen did not open. A shell
+  built with a plugin older than the method rejects the call, and the
+  provider then answers `unavailable` and reports the error.
   The provider resolves `openSettings` only once the app is back in the
   foreground, after at most two minutes (`settingsReturnTimeoutMs`), or after
   five seconds when the app never left.

package/dist/notifications-settings.d.ts

@@ -0,0 +1,14 @@
+import { type CapacitorGameServicesPlugin } from '@mpgd/capacitor-game-services';
+/** The part of `@mpgd/capacitor-game-services` the settings opener calls. */
+export type CapacitorNotificationSettingsPlugin = Pick<CapacitorGameServicesPlugin, 'openNotificationSettings'>;
+/**
+* Opens this app's notification settings through
+* `@mpgd/capacitor-game-services` (Android 8+ app notification settings, iOS
+* 16+ notification settings, each app's settings page on older versions).
+* Pass it as the provider's `openSettings`, which then declares
+* `permission.settings: true` and waits for the player to come back. It
+* throws when the system could not open the screen, and the plugin rejects
+* it as unimplemented in a shell built with a plugin older than the method;
+* the provider reports either failure and answers `unavailable`.
+*/
+export declare function openCapacitorNotificationSettings(plugin?: CapacitorNotificationSettingsPlugin): Promise<void>;

package/dist/notifications-settings.js

@@ -0,0 +1,18 @@
+import { CapacitorGameServices, } from '@mpgd/capacitor-game-services';
+/**
+ * Opens this app's notification settings through
+ * `@mpgd/capacitor-game-services` (Android 8+ app notification settings, iOS
+ * 16+ notification settings, each app's settings page on older versions).
+ * Pass it as the provider's `openSettings`, which then declares
+ * `permission.settings: true` and waits for the player to come back. It
+ * throws when the system could not open the screen, and the plugin rejects
+ * it as unimplemented in a shell built with a plugin older than the method;
+ * the provider reports either failure and answers `unavailable`.
+ */
+export async function openCapacitorNotificationSettings(plugin = CapacitorGameServices) {
+    const result = await plugin.openNotificationSettings();
+    if (typeof result !== 'object' || result === null
+        || result.opened !== true) {
+        throw new Error('The notification settings screen could not be opened.');
+    }
+}

package/dist/notifications.d.ts

@@ -3,6 +3,7 @@ import type { CapacitorNotificationServiceProvider } from './providers.js';
 export { capacitorNotificationPluginNames, loadCapacitorNotificationSdks, type CapacitorNotificationSdkRuntime, type CapacitorNotificationSdks, type LoadCapacitorNotificationSdksInput, type LocalNotificationSdk, type LocalNotificationSdkActionType, type LocalNotificationSdkEntry, type LocalNotificationSdkSchema, type NotificationSdkChannel, type PushSdk, type PushSdkActionEvent, type PushSdkNotification, } from './notifications-sdk.js';
 export { capacitorAdvertisingActionTypeId, capacitorIosMaxPendingLocalNotifications, capacitorLocalNotificationId, capacitorNotificationChannelId, capacitorNotificationDataKeys, capacitorNotificationProviderId, capacitorSettingsLeaveTimeoutMs, capacitorSettingsReturnTimeoutMs, createCapacitorNotificationProvider, type CapacitorNotificationAppEvents, type CapacitorNotificationChannelSettings, type CapacitorNotificationProvider, type CreateCapacitorNotificationProviderInput, } from './notifications-provider.js';
 export { createBridgeNotificationProvider, createNotificationProviderBridge, createNotificationServiceProvider, createNotificationSubscriptionAdapter, type CreateBridgeNotificationProviderInput, type CreateNotificationProviderBridgeInput, type CreateNotificationServiceProviderInput, type NotificationProviderBridge, } from './notifications-bridge.js';
+export { openCapacitorNotificationSettings, type CapacitorNotificationSettingsPlugin, } from './notifications-settings.js';
 export type { CapacitorNotificationServiceProvider, CapacitorNotificationsV2Service, } from './providers.js';
 export interface CreateCapacitorNotificationServiceProviderInput extends CreateCapacitorNotificationProviderInput {
   /** The registry id; 'capacitor-notifications' when absent. */

package/dist/notifications.js

@@ -8,6 +8,7 @@ import { createCapacitorNotificationProvider, } from './notifications-provider.j
 export { capacitorNotificationPluginNames, loadCapacitorNotificationSdks, } from './notifications-sdk.js';
 export { capacitorAdvertisingActionTypeId, capacitorIosMaxPendingLocalNotifications, capacitorLocalNotificationId, capacitorNotificationChannelId, capacitorNotificationDataKeys, capacitorNotificationProviderId, capacitorSettingsLeaveTimeoutMs, capacitorSettingsReturnTimeoutMs, createCapacitorNotificationProvider, } from './notifications-provider.js';
 export { createBridgeNotificationProvider, createNotificationProviderBridge, createNotificationServiceProvider, createNotificationSubscriptionAdapter, } from './notifications-bridge.js';
+export { openCapacitorNotificationSettings, } from './notifications-settings.js';
 /**
  * The provider and its registry entry in one call, with the same topics, for
  * `createCapacitorPlatformGateway({ providers: [...] })`:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mpgd/adapter-capacitor",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Capacitor platform adapter for mpgd Android and iOS shells.",
   "license": "MIT",
   "repository": {
@@ -43,11 +43,11 @@
   ],
   "dependencies": {
     "@capacitor/app": "8.1.1",
-    "@mpgd/bridge": "0.13.2",
-    "@mpgd/game-services": "0.25.0",
-    "@mpgd/capacitor-game-services": "0.7.2",
-    "@mpgd/platform": "0.24.0",
-    "@mpgd/target-config": "0.23.2"
+    "@mpgd/capacitor-game-services": "0.8.0",
+    "@mpgd/bridge": "0.14.1",
+    "@mpgd/platform": "0.26.0",
+    "@mpgd/game-services": "0.26.0",
+    "@mpgd/target-config": "0.23.4"
   },
   "peerDependencies": {
     "@capacitor-community/admob": "^8.1.0",
@@ -74,7 +74,7 @@
     "ttsc": "0.32.1",
     "typescript": "7.0.2",
     "vitest": "^4.0.0",
-    "@mpgd/game-runtime": "0.7.2"
+    "@mpgd/game-runtime": "0.7.4"
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",