@hermeticacomms/sdk-expo 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,30 @@
-# Temporary Holding Version
+# @hermeticacomms/sdk-expo
 
-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.
+Expo config plugin for Hermeticor. At `expo prebuild` it sets what push needs natively (the `aps-environment` entitlement,
+background remote notifications, Android 13's `POST_NOTIFICATIONS`), optionally the geofencing permissions, and stores the site
+key and endpoint in `extra.hermetica`. The runtime SDK is `@hermeticacomms/sdk-react-native`.
+
+```json
+{
+  "expo": {
+    "plugins": [
+      ["@hermeticacomms/sdk-expo", { "siteKey": "hm_pk_...", "endpoint": "https://api.example.com", "apsEnvironment": "production" }]
+    ]
+  }
+}
+```
+
+```ts
+import Constants from 'expo-constants';
+import * as Notifications from 'expo-notifications';
+import AsyncStorage from '@react-native-async-storage/async-storage';
+import { createReactNativeClient } from '@hermeticacomms/sdk-react-native';
+
+const { siteKey, endpoint } = Constants.expoConfig!.extra!.hermetica;
+const hm = await createReactNativeClient({ siteKey, endpoint, storage: AsyncStorage, platform: Platform.OS === 'ios' ? 'ios' : 'android' });
+const { data: token } = await Notifications.getDevicePushTokenAsync(); // APNs / FCM token
+await hm.setPushToken(token, { platform: Platform.OS, vendor: Platform.OS === 'ios' ? 'apns' : 'fcm', environment: 'release', enablementStatus: 'AUTHORIZED', background: 'AVAILABLE' });
+```
+
+Options: `push` (default true), `apsEnvironment` (`development` | `production`), `geofencing: { locationUsage }` (adds the location
+permissions and the iOS prompt text). A secret `hm_sk_` key is refused. Running the plugin twice changes nothing.

package/app.plugin.js

@@ -0,0 +1 @@
+module.exports = require('./dist/plugin.js').default;

package/dist/plugin.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Expo config plugin for Hermeticor: sets the native config push (and optionally geofencing) need at `expo prebuild`, and puts the
+ * site key and endpoint in `extra.hermetica` for the app to read. It edits only the app config fields Expo already applies
+ * (`ios.entitlements`, `ios.infoPlist`, `android.permissions`, `extra`), so it needs no dependency on @expo/config-plugins.
+ * The runtime SDK is @hermetica/sdk-react-native.
+ */
+export interface HermeticaPluginProps {
+    /** Public site key (never a secret key). Read back with `Constants.expoConfig.extra.hermetica.siteKey`. */
+    siteKey?: string;
+    endpoint?: string;
+    /** APNs environment of the build (default production; development for dev-client builds signed for development). */
+    apsEnvironment?: 'development' | 'production';
+    /** Push setup: aps-environment, background remote notifications, Android 13 POST_NOTIFICATIONS. Default true. */
+    push?: boolean;
+    /** Geofencing permissions; the string is the iOS "always" location prompt. Off unless given. */
+    geofencing?: {
+        locationUsage: string;
+    };
+}
+type Dict = Record<string, unknown>;
+/** The parts of Expo's app config this plugin reads and writes. */
+export interface ExpoConfig {
+    ios?: {
+        entitlements?: Dict;
+        infoPlist?: Dict;
+    } & Dict;
+    android?: {
+        permissions?: string[];
+    } & Dict;
+    extra?: Dict;
+    [k: string]: unknown;
+}
+export default function withHermetica(config: ExpoConfig, props?: HermeticaPluginProps): ExpoConfig;
+export {};

package/dist/plugin.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = withHermetica;
+const add = (list, ...items) => {
+    const out = Array.isArray(list) ? list.filter((x) => typeof x === 'string') : [];
+    for (const i of items)
+        if (!out.includes(i))
+            out.push(i);
+    return out;
+};
+function withHermetica(config, props = {}) {
+    if (props.siteKey?.startsWith('hm_sk_'))
+        throw new Error('withHermetica: use the public site key, never a secret hm_sk_ key, in an app');
+    const ios = { ...config.ios, entitlements: { ...config.ios?.entitlements }, infoPlist: { ...config.ios?.infoPlist } };
+    const android = { ...config.android, permissions: [...(config.android?.permissions ?? [])] };
+    if (props.push !== false) {
+        ios.entitlements['aps-environment'] = props.apsEnvironment ?? 'production';
+        ios.infoPlist['UIBackgroundModes'] = add(ios.infoPlist['UIBackgroundModes'], 'remote-notification');
+        android.permissions = add(android.permissions, 'android.permission.POST_NOTIFICATIONS');
+    }
+    if (props.geofencing) {
+        ios.infoPlist['NSLocationAlwaysAndWhenInUseUsageDescription'] ??= props.geofencing.locationUsage;
+        ios.infoPlist['NSLocationWhenInUseUsageDescription'] ??= props.geofencing.locationUsage;
+        ios.infoPlist['UIBackgroundModes'] = add(ios.infoPlist['UIBackgroundModes'], 'location');
+        android.permissions = add(android.permissions, 'android.permission.ACCESS_FINE_LOCATION', 'android.permission.ACCESS_BACKGROUND_LOCATION');
+    }
+    const hermetica = { ...(props.siteKey ? { siteKey: props.siteKey } : {}), ...(props.endpoint ? { endpoint: props.endpoint } : {}) };
+    return { ...config, ios, android, extra: { ...config.extra, hermetica: { ...config.extra?.['hermetica'], ...hermetica } } };
+}

package/package.json

@@ -1,6 +1,32 @@
 {
   "name": "@hermeticacomms/sdk-expo",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.4.0",
+  "description": "Expo config plugin for Hermetica: push entitlements and permissions, site key in app config",
+  "license": "MIT",
+  "type": "commonjs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hermeticacomms/hermetica-expo.git"
+  },
+  "homepage": "https://github.com/hermeticacomms/hermetica-expo#readme",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "main": "./dist/plugin.js",
+  "types": "./dist/plugin.d.ts",
+  "files": [
+    "dist",
+    "app.plugin.js"
+  ],
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "tsc -p tsconfig.json",
+    "test": "vitest run",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "devDependencies": {
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.5"
+  }
+}