@baukit/notifications-expo 0.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Patrick Koss
+
+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

@@ -0,0 +1,51 @@
+# `@baukit/notifications-expo`
+
+The `expo-notifications` implementation of the `@baukit/notifications-core` platform port. It
+schedules, lists, and cancels only the notifications that carry its owner's marker, and it never
+calls `cancelAllScheduledNotificationsAsync`.
+
+```ts
+import { resolveNotificationOccurrences } from '@baukit/notifications-core';
+import {
+  createExpoOwnedNotificationScheduler,
+  IOS_PENDING_NOTIFICATION_LIMIT,
+} from '@baukit/notifications-expo';
+import * as Notifications from 'expo-notifications';
+
+const scheduler = createExpoOwnedNotificationScheduler(Notifications, {
+  pendingLimit: IOS_PENDING_NOTIFICATION_LIMIT,
+});
+
+const { desired } = resolveNotificationOccurrences({ occurrences, timeZone, gap, fold, clock, horizonDays });
+const outcome = await scheduler.replaceOwned(
+  { namespace: 'reminders' },
+  desired.map((entry) => ({
+    ...entry,
+    content: { content: { title: entry.title, body: entry.body }, channelId: 'reminders' },
+  })),
+);
+```
+
+- Create one scheduler per app and share it. Replacements for one namespace run one at a time on
+  that instance.
+- Each request gets the identifier `baukit:<namespace>:<logicalId>` and a DATE trigger at the
+  planned instant. `channelId` is optional and Android only.
+- The adapter writes its marker under the `baukitNotification` key in `content.data`, next to the
+  product's own data. Product data that already uses that key rejects with
+  `NotificationPlanError('reserved_data_key')`.
+- Permission counts as granted when `granted` is true or the iOS status is authorized, provisional,
+  or ephemeral. `undetermined` counts as not granted, so the product asks first.
+- `IOS_PENDING_NOTIFICATION_LIMIT` is 64. The limit counts every pending request on the device, so
+  pass a lower number when other features schedule too.
+- The outcome reports list, cancel, permission, schedule, and limit failures by code and logical ID,
+  never with the notification content.
+
+The module is passed in, and the package imports only types from `expo-notifications`, so the
+package itself loads in Node and in tests. The tests run the core conformance suite against a
+mocked module.
+
+## Boundaries
+
+The package does not request permission, create Android channels, set a notification handler, or
+choose copy. It does not support repeating triggers; plan a rolling horizon and replace it when the
+app opens or the plan changes.

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import { type NotificationPlatform, type OwnedNotificationScheduler, type OwnedNotificationSchedulerOptions } from '@baukit/notifications-core';
+import type * as ExpoNotifications from 'expo-notifications';
+import type { NotificationContentInput } from 'expo-notifications';
+export declare const IOS_PENDING_NOTIFICATION_LIMIT = 64;
+export type ExpoNotificationsApi = Pick<typeof ExpoNotifications, 'getAllScheduledNotificationsAsync' | 'cancelScheduledNotificationAsync' | 'scheduleNotificationAsync' | 'getPermissionsAsync' | 'SchedulableTriggerInputTypes' | 'IosAuthorizationStatus'>;
+export interface ExpoNotificationContent {
+    readonly content: NotificationContentInput;
+    readonly channelId?: string;
+}
+export type ExpoOwnedNotificationSchedulerOptions = OwnedNotificationSchedulerOptions;
+export declare function createExpoNotificationPlatform(api: ExpoNotificationsApi): NotificationPlatform<ExpoNotificationContent>;
+export declare function createExpoOwnedNotificationScheduler(api: ExpoNotificationsApi, options?: ExpoOwnedNotificationSchedulerOptions): OwnedNotificationScheduler<ExpoNotificationContent>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,oBAAoB,EACzB,KAAK,0BAA0B,EAE/B,KAAK,iCAAiC,EAEvC,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,KAAK,iBAAiB,MAAM,oBAAoB,CAAC;AAC7D,OAAO,KAAK,EAEV,wBAAwB,EAGzB,MAAM,oBAAoB,CAAC;AAE5B,eAAO,MAAM,8BAA8B,KAAK,CAAC;AAEjD,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,OAAO,iBAAiB,EACtB,mCAAmC,GACnC,kCAAkC,GAClC,2BAA2B,GAC3B,qBAAqB,GACrB,8BAA8B,GAC9B,wBAAwB,CAC3B,CAAC;AAEF,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,OAAO,EAAE,wBAAwB,CAAC;IAC3C,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,MAAM,qCAAqC,GAAG,iCAAiC,CAAC;AAItF,wBAAgB,8BAA8B,CAC5C,GAAG,EAAE,oBAAoB,GACxB,oBAAoB,CAAC,uBAAuB,CAAC,CAoB/C;AAED,wBAAgB,oCAAoC,CAClD,GAAG,EAAE,oBAAoB,EACzB,OAAO,GAAE,qCAA0C,GAClD,0BAA0B,CAAC,uBAAuB,CAAC,CAWrD"}

package/dist/index.js

@@ -0,0 +1,75 @@
+import { createOwnedNotificationScheduler, decodeOwnedNotificationMarker, encodeOwnedNotificationMarker, NotificationPlanError, OWNED_NOTIFICATION_DATA_KEY, } from '@baukit/notifications-core';
+export const IOS_PENDING_NOTIFICATION_LIMIT = 64;
+const UNDETERMINED = 'undetermined';
+export function createExpoNotificationPlatform(api) {
+    return {
+        async list() {
+            const requests = await api.getAllScheduledNotificationsAsync();
+            return requests.map(pendingNotification);
+        },
+        cancel(identifier) {
+            return api.cancelScheduledNotificationAsync(identifier);
+        },
+        async permission() {
+            return permissionFrom(api, await api.getPermissionsAsync());
+        },
+        async schedule(request) {
+            await api.scheduleNotificationAsync({
+                identifier: request.identifier,
+                content: contentWithMarker(request),
+                trigger: dateTrigger(api, request),
+            });
+        },
+    };
+}
+export function createExpoOwnedNotificationScheduler(api, options = {}) {
+    const scheduler = createOwnedNotificationScheduler(createExpoNotificationPlatform(api), options);
+    return {
+        replaceOwned(owner, desired, replaceOptions) {
+            const reserved = desired.find((entry) => hasReservedKey(entry.content.content));
+            if (reserved !== undefined) {
+                return Promise.reject(new NotificationPlanError('reserved_data_key', reserved.logicalId));
+            }
+            return scheduler.replaceOwned(owner, desired, replaceOptions);
+        },
+    };
+}
+function pendingNotification(request) {
+    return {
+        identifier: request.identifier,
+        marker: decodeOwnedNotificationMarker(request.content.data?.[OWNED_NOTIFICATION_DATA_KEY]),
+    };
+}
+function hasReservedKey(content) {
+    return content.data !== undefined && Object.hasOwn(content.data, OWNED_NOTIFICATION_DATA_KEY);
+}
+function contentWithMarker(request) {
+    const { content } = request.content;
+    return {
+        ...content,
+        data: {
+            ...content.data,
+            [OWNED_NOTIFICATION_DATA_KEY]: encodeOwnedNotificationMarker(request.marker),
+        },
+    };
+}
+function dateTrigger(api, request) {
+    const trigger = {
+        type: api.SchedulableTriggerInputTypes.DATE,
+        date: request.marker.epochMilliseconds,
+    };
+    const { channelId } = request.content;
+    return channelId === undefined ? trigger : { ...trigger, channelId };
+}
+function permissionFrom(api, permission) {
+    const iosStatus = permission.ios?.status;
+    if (permission.granted ||
+        iosStatus === api.IosAuthorizationStatus.AUTHORIZED ||
+        iosStatus === api.IosAuthorizationStatus.PROVISIONAL ||
+        iosStatus === api.IosAuthorizationStatus.EPHEMERAL) {
+        return 'granted';
+    }
+    const status = permission.status;
+    return status === UNDETERMINED ? 'undetermined' : 'denied';
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gCAAgC,EAChC,6BAA6B,EAC7B,6BAA6B,EAC7B,qBAAqB,EACrB,2BAA2B,GAO5B,MAAM,4BAA4B,CAAC;AASpC,MAAM,CAAC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAmBjD,MAAM,YAAY,GAAG,cAAc,CAAC;AAEpC,MAAM,UAAU,8BAA8B,CAC5C,GAAyB;IAEzB,OAAO;QACL,KAAK,CAAC,IAAI;YACR,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,iCAAiC,EAAE,CAAC;YAC/D,OAAO,QAAQ,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QAC3C,CAAC;QACD,MAAM,CAAC,UAAU;YACf,OAAO,GAAG,CAAC,gCAAgC,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC;QACD,KAAK,CAAC,UAAU;YACd,OAAO,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,mBAAmB,EAAE,CAAC,CAAC;QAC9D,CAAC;QACD,KAAK,CAAC,QAAQ,CAAC,OAAO;YACpB,MAAM,GAAG,CAAC,yBAAyB,CAAC;gBAClC,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC;gBACnC,OAAO,EAAE,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC;aACnC,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oCAAoC,CAClD,GAAyB,EACzB,UAAiD,EAAE;IAEnD,MAAM,SAAS,GAAG,gCAAgC,CAAC,8BAA8B,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;IACjG,OAAO;QACL,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc;YACzC,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;YAChF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,qBAAqB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;YAC5F,CAAC;YACD,OAAO,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;QAChE,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,OAA4B;IACvD,OAAO;QACL,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,MAAM,EAAE,6BAA6B,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,2BAA2B,CAAC,CAAC;KAC3F,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,OAAiC;IACvD,OAAO,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAC;AAChG,CAAC;AAED,SAAS,iBAAiB,CACxB,OAAkE;IAElE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IACpC,OAAO;QACL,GAAG,OAAO;QACV,IAAI,EAAE;YACJ,GAAG,OAAO,CAAC,IAAI;YACf,CAAC,2BAA2B,CAAC,EAAE,6BAA6B,CAAC,OAAO,CAAC,MAAM,CAAC;SAC7E;KACF,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAClB,GAAyB,EACzB,OAAkE;IAElE,MAAM,OAAO,GAAqB;QAChC,IAAI,EAAE,GAAG,CAAC,4BAA4B,CAAC,IAAI;QAC3C,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,iBAAiB;KACvC,CAAC;IACF,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IACtC,OAAO,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,CAAC;AACvE,CAAC;AAED,SAAS,cAAc,CACrB,GAAyB,EACzB,UAAyC;IAEzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC;IACzC,IACE,UAAU,CAAC,OAAO;QAClB,SAAS,KAAK,GAAG,CAAC,sBAAsB,CAAC,UAAU;QACnD,SAAS,KAAK,GAAG,CAAC,sBAAsB,CAAC,WAAW;QACpD,SAAS,KAAK,GAAG,CAAC,sBAAsB,CAAC,SAAS,EAClD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,MAAM,GAAW,UAAU,CAAC,MAAM,CAAC;IACzC,OAAO,MAAM,KAAK,YAAY,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC7D,CAAC"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@baukit/notifications-expo",
+  "version": "0.5.0",
+  "description": "Optional expo-notifications adapter for @baukit/notifications-core that replaces only notifications carrying one owner's namespace marker.",
+  "license": "MIT",
+  "author": "Patrick Koss",
+  "homepage": "https://github.com/PatrickKoss/baukit#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PatrickKoss/baukit.git",
+    "directory": "typescript/packages/notifications-expo"
+  },
+  "bugs": {
+    "url": "https://github.com/PatrickKoss/baukit/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepare": "pnpm run build",
+    "test": "tsc -p tsconfig.test.json && vitest run --config ../../vitest.config.ts && node ../../scripts/test-packed-exports.mjs",
+    "lint": "eslint src --max-warnings=0",
+    "format:check": "prettier --check src package.json tsconfig.json tsconfig.test.json"
+  },
+  "devDependencies": {
+    "@baukit/localization-core": "workspace:*",
+    "@baukit/notifications-core": "workspace:*",
+    "expo-notifications": "57.0.13",
+    "typescript": "6.0.3",
+    "vitest": "4.1.10"
+  },
+  "peerDependencies": {
+    "@baukit/notifications-core": "^0.5.0",
+    "expo-notifications": "^57.0.13"
+  }
+}