@hermeticacomms/sdk-capacitor 0.0.0-stage → 0.4.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Hermetica
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,32 @@
-# Temporary Holding Version
+# @hermeticacomms/sdk-capacitor
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Hermeticor for Capacitor and Ionic apps. The browser SDK runs unchanged in the WebView (consent gate, batching, retries with one
+`Idempotency-Key` per batch); this package adds native push tokens from `@capacitor/push-notifications`, push open tracking, and
+in-app messages targeted at the app's platform.
+
+```ts
+import { Capacitor } from '@capacitor/core';
+import { PushNotifications } from '@capacitor/push-notifications';
+import { createCapacitorClient } from '@hermeticacomms/sdk-capacitor';
+
+const hm = createCapacitorClient({
+  siteKey: 'hm_pk_...', endpoint: 'https://api.example.com',
+  platform: Capacitor.getPlatform() === 'ios' ? 'ios' : 'android',
+  push: PushNotifications, pushEnvironment: import.meta.env.DEV ? 'debug' : 'release',
+  onDeepLink: (link) => router.push(link),
+});
+hm.consent.update({ analytics: true, marketing: true });
+hm.identify('user-42', { email: 'ada@example.com' });
+hm.screen('Cart');
+hm.track('add_to_cart', { sku: 'A1' }, { value: 1999, currency: 'USD' });
+await hm.enablePush(); // asks for permission if needed, then registers the APNs (iOS) or FCM (Android) token
+```
+
+- The token follows the profile: `identify`, `setProfile` and `reset` re-register it. `hm.unregisterPushToken()` on logout.
+- Coming back from system settings re-sends the token when the notification permission changed there.
+- Tapped notifications track `$opened_push` and go to `onDeepLink`; received ones track `$received_push`.
+- In-app messages show on start, on `screen` and on `track` (`inApp: false` turns them off). Link buttons go to `onDeepLink`.
+- Consent and suppression are enforced by the server too; opening a notification is an event and needs analytics consent.
+
+On iOS, `@capacitor/push-notifications` hands over the APNs token; enable the Push Notifications capability. On Android it hands
+over the FCM token; add `google-services.json`.

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+import { type AppPushToken, type HybridClient, type HybridOptions } from '@hermeticacomms/sdk-browser';
+export type { AppDevice, HybridClient, ProfileIds } from '@hermeticacomms/sdk-browser';
+type Permission = {
+    receive: string;
+};
+type Handle = Promise<unknown> | unknown;
+/** The slice of `@capacitor/push-notifications`' `PushNotifications` used here (pass the plugin object itself). */
+export interface CapacitorPush {
+    checkPermissions(): Promise<Permission>;
+    requestPermissions(): Promise<Permission>;
+    register(): Promise<void>;
+    addListener(event: 'registration', cb: (token: {
+        value: string;
+    }) => void): Handle;
+    addListener(event: 'registrationError', cb: (error: unknown) => void): Handle;
+    addListener(event: 'pushNotificationReceived', cb: (notification: unknown) => void): Handle;
+    addListener(event: 'pushNotificationActionPerformed', cb: (action: {
+        notification: unknown;
+    }) => void): Handle;
+}
+export interface CapacitorOptions extends HybridOptions {
+    /** `PushNotifications` from @capacitor/push-notifications. Without it, push is off (call `setPushToken` yourself). */
+    push?: CapacitorPush;
+    /** Show the notification prompt on start when the user has not decided (default false: call `enablePush()` when it fits). */
+    requestPushPermission?: boolean;
+    /** APNs environment of this build; debug for development-signed iOS builds. */
+    pushEnvironment?: 'debug' | 'release';
+}
+export type CapacitorClient = HybridClient & {
+    /** Asks for notification permission if needed, registers with APNs/FCM, and sends the token. Resolves the permission. */
+    enablePush(): Promise<AppPushToken['enablementStatus']>;
+};
+/**
+ * Hermeticor for Capacitor (and Ionic): the browser SDK runs as is in the WebView (consent gate, batching, retries with one
+ * Idempotency-Key per batch); this adds the native push token from @capacitor/push-notifications, push open tracking, and in-app
+ * messages for ios / android. Tapped notifications go to `onDeepLink`.
+ */
+export declare function createCapacitorClient(o: CapacitorOptions): CapacitorClient;

package/dist/index.js

@@ -0,0 +1,55 @@
+/// <reference lib="dom" />
+import { createHybridClient } from '@hermeticacomms/sdk-browser';
+const status = (p) => p.receive === 'granted' ? 'AUTHORIZED' : p.receive === 'denied' ? 'DENIED' : 'NOT_DETERMINED';
+/**
+ * Hermeticor for Capacitor (and Ionic): the browser SDK runs as is in the WebView (consent gate, batching, retries with one
+ * Idempotency-Key per batch); this adds the native push token from @capacitor/push-notifications, push open tracking, and in-app
+ * messages for ios / android. Tapped notifications go to `onDeepLink`.
+ */
+export function createCapacitorClient(o) {
+    const { push, requestPushPermission = false, pushEnvironment = 'release', ...rest } = o;
+    const hm = createHybridClient(rest);
+    const vendor = o.platform === 'ios' ? 'apns' : 'fcm';
+    let last = null;
+    let enablement = 'NOT_DETERMINED';
+    if (push) {
+        void push.addListener('registration', (t) => {
+            last = { token: t.value, vendor, environment: pushEnvironment, enablementStatus: enablement };
+            void hm.setPushToken(last);
+        });
+        void push.addListener('pushNotificationReceived', (n) => hm.handlePushReceived(n));
+        void push.addListener('pushNotificationActionPerformed', (a) => hm.handlePushOpened(a.notification));
+        // Back from system settings: re-send the token when the permission changed there.
+        document.addEventListener('visibilitychange', () => {
+            if (document.visibilityState !== 'visible' || !last)
+                return;
+            void push.checkPermissions().then((p) => {
+                const s = status(p);
+                if (!last || s === last.enablementStatus)
+                    return;
+                enablement = s;
+                last = { ...last, enablementStatus: s };
+                void hm.setPushToken(last);
+            });
+        });
+    }
+    async function enablePush() {
+        if (!push)
+            return 'UNAUTHORIZED';
+        let p = await push.checkPermissions();
+        if (p.receive !== 'granted' && p.receive !== 'denied')
+            p = await push.requestPermissions();
+        enablement = status(p);
+        // Register even when denied: the server then knows this device exists but cannot be pushed to.
+        await push.register();
+        return enablement;
+    }
+    if (push && requestPushPermission)
+        void enablePush();
+    else if (push)
+        void push.checkPermissions().then((p) => { if (p.receive === 'granted') {
+            enablement = 'AUTHORIZED';
+            void push.register();
+        } });
+    return { ...hm, enablePush };
+}

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@hermeticacomms/sdk-capacitor",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.4.0",
+  "description": "Hermetica for Capacitor and Ionic: events, consent, native push tokens, in-app messages",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hermeticacomms/hermetica-capacitor.git"
+  },
+  "homepage": "https://github.com/hermeticacomms/hermetica-capacitor#readme",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "tsc -p tsconfig.json",
+    "test": "vitest run",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "dependencies": {
+    "@hermeticacomms/sdk-browser": "^0.4.0"
+  },
+  "devDependencies": {
+    "happy-dom": "^21.0.4",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.5"
+  },
+  "peerDependencies": {
+    "@capacitor/push-notifications": ">=5"
+  },
+  "peerDependenciesMeta": {
+    "@capacitor/push-notifications": {
+      "optional": true
+    }
+  }
+}