@chipmobilesdk/rn-notification 0.4.0 → 0.5.0

package/src/contract/notification.ts

@@ -1,118 +1,118 @@
-/**
- * Core notification request types.
- *
- * Nothing here carries business meaning. The package accepts fully-described
- * requests and is responsible only for delivering them at the right moment.
- */
-
-/**
- * How a delivery moment is pinned to the passage of time.
- *
- * - `wallClock` — the local clock time named. An 08:00 reminder stays 08:00
- *   after the user crosses a time zone. This is the default, because reminders
- *   are wall-clock things and a caller who does not choose should get what
- *   their users expect.
- * - `absolute` — one fixed instant worldwide, unaffected by zone changes.
- */
-export type AnchoringMode = 'wallClock' | 'absolute';
-
-export const DEFAULT_ANCHORING_MODE: AnchoringMode = 'wallClock';
-
-/** When a notification should be presented, and how that moment is anchored. */
-export interface DeliveryMoment {
-	/** Epoch milliseconds. Interpreted per {@link DeliveryMoment.anchoring}. */
-	readonly at: number;
-	/** Defaults to `wallClock` when omitted. */
-	readonly anchoring?: AnchoringMode;
-}
-
-/**
- * Resolved display strings. The package performs no translation, formatting,
- * or locale resolution — only the consuming app knows its content model.
- */
-export interface NotificationContent {
-	readonly title: string;
-	readonly body: string;
-	/** Optional short text shown in collapsed form on some platforms. */
-	readonly subtitle?: string;
-}
-
-/** Structured data carried to the interaction handler, unchanged. */
-export type RoutingPayload = Readonly<Record<string, unknown>>;
-
-/** A button on a notification. */
-export interface Action {
-	/** Stable action identifier, subject to the same charset rules as a notification id. */
-	readonly id: string;
-	readonly title: string;
-	/**
-	 * `foreground` brings the app up; `background` is handled without opening it,
-	 * inside the platform's bounded execution window.
-	 */
-	readonly mode: 'foreground' | 'background';
-	/** When present, the action accepts short typed input. */
-	readonly input?: {
-		readonly placeholder?: string;
-		readonly submitLabel?: string;
-	};
-}
-
-/** The complete, self-contained description of one notification. */
-export interface NotificationRequest {
-	/**
-	 * Caller-supplied, stable, derived from the caller's own data.
-	 * The package never generates, normalizes, or hashes it.
-	 */
-	readonly id: string;
-	readonly content: NotificationContent;
-	/** Must reference a tone declared in the package configuration. */
-	readonly tone: string;
-	readonly moment: DeliveryMoment;
-	readonly routing?: RoutingPayload;
-	readonly actions?: readonly Action[];
-	/** Opaque partition label. Never interpreted by the package. */
-	readonly ownerTag?: string;
-	/** Opaque cancellation group. Never interpreted by the package. */
-	readonly groupTag?: string;
-}
-
-/** One entry the platform is currently holding, in enough detail to diff against intent. */
-export interface PendingEntry {
-	readonly id: string;
-	/** The instant the platform will actually fire, after anchoring resolution. */
-	readonly resolvedAt: number;
-	readonly anchoring: AnchoringMode;
-	/**
-	 * The IANA zone this entry was last anchored against.
-	 * `undefined` for absolute-instant entries, which are never anchored.
-	 *
-	 * Exists so the one case re-anchoring cannot fix — a zone change while the
-	 * app never ran — is detectable rather than invisible.
-	 */
-	readonly anchoringGeneration?: string;
-	readonly content: NotificationContent;
-	readonly tone: string;
-	readonly routing?: RoutingPayload;
-	readonly actions?: readonly Action[];
-	readonly ownerTag?: string;
-	readonly groupTag?: string;
-	/** Present when this entry was expanded from a recurrence series. */
-	readonly seriesId?: string;
-	/** True when scheduled without exact-alarm capability; delivery may be late. */
-	readonly mayBeDelayed: boolean;
-	/** True when created by a push instruction rather than by app code. */
-	readonly pushCreated: boolean;
-}
-
-/** Outcome of a single schedule call. */
-export interface ScheduleResult {
-	readonly id: string;
-	readonly resolvedAt: number;
-	readonly anchoring: AnchoringMode;
-	/** True when an existing notification under this identifier was replaced. */
-	readonly replaced: boolean;
-	/** True when the moment had just passed and was delivered inside the tolerance window. */
-	readonly deliveredImmediately: boolean;
-	/** True when scheduled in approximate mode for want of exact-alarm capability. */
-	readonly mayBeDelayed: boolean;
-}
+/**
+ * Core notification request types.
+ *
+ * Nothing here carries business meaning. The package accepts fully-described
+ * requests and is responsible only for delivering them at the right moment.
+ */
+
+/**
+ * How a delivery moment is pinned to the passage of time.
+ *
+ * - `wallClock` — the local clock time named. An 08:00 reminder stays 08:00
+ *   after the user crosses a time zone. This is the default, because reminders
+ *   are wall-clock things and a caller who does not choose should get what
+ *   their users expect.
+ * - `absolute` — one fixed instant worldwide, unaffected by zone changes.
+ */
+export type AnchoringMode = 'wallClock' | 'absolute';
+
+export const DEFAULT_ANCHORING_MODE: AnchoringMode = 'wallClock';
+
+/** When a notification should be presented, and how that moment is anchored. */
+export interface DeliveryMoment {
+	/** Epoch milliseconds. Interpreted per {@link DeliveryMoment.anchoring}. */
+	readonly at: number;
+	/** Defaults to `wallClock` when omitted. */
+	readonly anchoring?: AnchoringMode;
+}
+
+/**
+ * Resolved display strings. The package performs no translation, formatting,
+ * or locale resolution — only the consuming app knows its content model.
+ */
+export interface NotificationContent {
+	readonly title: string;
+	readonly body: string;
+	/** Optional short text shown in collapsed form on some platforms. */
+	readonly subtitle?: string;
+}
+
+/** Structured data carried to the interaction handler, unchanged. */
+export type RoutingPayload = Readonly<Record<string, unknown>>;
+
+/** A button on a notification. */
+export interface Action {
+	/** Stable action identifier, subject to the same charset rules as a notification id. */
+	readonly id: string;
+	readonly title: string;
+	/**
+	 * `foreground` brings the app up; `background` is handled without opening it,
+	 * inside the platform's bounded execution window.
+	 */
+	readonly mode: 'foreground' | 'background';
+	/** When present, the action accepts short typed input. */
+	readonly input?: {
+		readonly placeholder?: string;
+		readonly submitLabel?: string;
+	};
+}
+
+/** The complete, self-contained description of one notification. */
+export interface NotificationRequest {
+	/**
+	 * Caller-supplied, stable, derived from the caller's own data.
+	 * The package never generates, normalizes, or hashes it.
+	 */
+	readonly id: string;
+	readonly content: NotificationContent;
+	/** Must reference a tone declared in the package configuration. */
+	readonly tone: string;
+	readonly moment: DeliveryMoment;
+	readonly routing?: RoutingPayload;
+	readonly actions?: readonly Action[];
+	/** Opaque partition label. Never interpreted by the package. */
+	readonly ownerTag?: string;
+	/** Opaque cancellation group. Never interpreted by the package. */
+	readonly groupTag?: string;
+}
+
+/** One entry the platform is currently holding, in enough detail to diff against intent. */
+export interface PendingEntry {
+	readonly id: string;
+	/** The instant the platform will actually fire, after anchoring resolution. */
+	readonly resolvedAt: number;
+	readonly anchoring: AnchoringMode;
+	/**
+	 * The IANA zone this entry was last anchored against.
+	 * `undefined` for absolute-instant entries, which are never anchored.
+	 *
+	 * Exists so the one case re-anchoring cannot fix — a zone change while the
+	 * app never ran — is detectable rather than invisible.
+	 */
+	readonly anchoringGeneration?: string;
+	readonly content: NotificationContent;
+	readonly tone: string;
+	readonly routing?: RoutingPayload;
+	readonly actions?: readonly Action[];
+	readonly ownerTag?: string;
+	readonly groupTag?: string;
+	/** Present when this entry was expanded from a recurrence series. */
+	readonly seriesId?: string;
+	/** True when scheduled without exact-alarm capability; delivery may be late. */
+	readonly mayBeDelayed: boolean;
+	/** True when created by a push instruction rather than by app code. */
+	readonly pushCreated: boolean;
+}
+
+/** Outcome of a single schedule call. */
+export interface ScheduleResult {
+	readonly id: string;
+	readonly resolvedAt: number;
+	readonly anchoring: AnchoringMode;
+	/** True when an existing notification under this identifier was replaced. */
+	readonly replaced: boolean;
+	/** True when the moment had just passed and was delivered inside the tolerance window. */
+	readonly deliveredImmediately: boolean;
+	/** True when scheduled in approximate mode for want of exact-alarm capability. */
+	readonly mayBeDelayed: boolean;
+}

package/src/contract/permission.ts

@@ -1,60 +1,55 @@
-/**
- * Permission types.
- *
- * Display permission and exact-alarm permission are different things serving
- * different purposes, so they are requested and reported independently. State
- * is always readable without triggering a dialog.
- */
-
-export type PermissionKind = 'display' | 'exactAlarm';
-
-/**
- * Six states, never collapsed into one another.
- *
- * - `notAsked` — distinguishable from `denied`, which is the whole point of
- *   being able to read state without prompting.
- * - `provisional` — iOS quiet delivery. Neither granted nor denied.
- * - `notRequired` — the running platform version has no such concept. Never
- *   reported as `denied`, which would imply a refusal that never happened.
- */
-export type PermissionState =
-	| 'notAsked'
-	| 'granted'
-	| 'denied'
-	| 'permanentlyDenied'
-	| 'provisional'
-	| 'notRequired';
-
-export interface PermissionReport {
-	readonly display: PermissionState;
-	readonly exactAlarm: PermissionState;
-	readonly readAt: number;
-}
-
-/** Whether a manufacturer-level restriction is in force, where it can be known. */
-export type RestrictionStatus = 'unrestricted' | 'restricted' | 'unknown';
-
-/**
- * Manufacturer background restrictions, reported for information only.
- *
- * `unknown` is a first-class answer: some vendors stop apps in ways with no
- * standard detection API, and guessing would be worse than admitting it.
- * The package never changes any of these settings on the user's behalf.
- */
-export interface RestrictionReport {
-	readonly batteryOptimization: RestrictionStatus;
-	readonly autoStart: RestrictionStatus;
-	readonly manufacturer?: string;
-	readonly readAt: number;
-}
-
-/** Whether a permission request can even be presented on this platform version. */
-export interface PermissionCapability {
-	readonly kind: PermissionKind;
-	readonly supported: boolean;
-	/**
-	 * True when the platform grants this only through system settings rather
-	 * than an in-app dialog.
-	 */
-	readonly settingsOnly: boolean;
-}
+/**
+ * Permission types.
+ *
+ * Display permission and exact-alarm permission are different things serving
+ * different purposes, so they are requested and reported independently. State
+ * is always readable without triggering a dialog.
+ */
+
+export type PermissionKind = 'display' | 'exactAlarm';
+
+/**
+ * Six states, never collapsed into one another.
+ *
+ * - `notAsked` — distinguishable from `denied`, which is the whole point of
+ *   being able to read state without prompting.
+ * - `provisional` — iOS quiet delivery. Neither granted nor denied.
+ * - `notRequired` — the running platform version has no such concept. Never
+ *   reported as `denied`, which would imply a refusal that never happened.
+ */
+export type PermissionState =
+	'notAsked' | 'granted' | 'denied' | 'permanentlyDenied' | 'provisional' | 'notRequired';
+
+export interface PermissionReport {
+	readonly display: PermissionState;
+	readonly exactAlarm: PermissionState;
+	readonly readAt: number;
+}
+
+/** Whether a manufacturer-level restriction is in force, where it can be known. */
+export type RestrictionStatus = 'unrestricted' | 'restricted' | 'unknown';
+
+/**
+ * Manufacturer background restrictions, reported for information only.
+ *
+ * `unknown` is a first-class answer: some vendors stop apps in ways with no
+ * standard detection API, and guessing would be worse than admitting it.
+ * The package never changes any of these settings on the user's behalf.
+ */
+export interface RestrictionReport {
+	readonly batteryOptimization: RestrictionStatus;
+	readonly autoStart: RestrictionStatus;
+	readonly manufacturer?: string;
+	readonly readAt: number;
+}
+
+/** Whether a permission request can even be presented on this platform version. */
+export interface PermissionCapability {
+	readonly kind: PermissionKind;
+	readonly supported: boolean;
+	/**
+	 * True when the platform grants this only through system settings rather
+	 * than an in-app dialog.
+	 */
+	readonly settingsOnly: boolean;
+}

package/src/contract/reconcile.ts

@@ -1,88 +1,88 @@
-/**
- * Reconciliation types.
- *
- * A caller hands over the complete set its data currently implies; the package
- * computes the minimal operation set that makes the device match. Running it
- * twice with unchanged input performs zero platform operations — that
- * idempotence is the package's central testable promise.
- */
-
-import type { NotificationRequest } from './notification';
-
-export interface ReconcileInput {
-	/**
-	 * Bounds what may be cancelled. Notifications outside this domain are never
-	 * touched, including those scheduled by other parts of the app or by other
-	 * libraries.
-	 */
-	readonly domain: string;
-	readonly desired: readonly NotificationRequest[];
-	/**
-	 * When false (the default), push-created notifications are left alone rather
-	 * than cancelled for being absent from a locally-computed desired set.
-	 */
-	readonly includePushCreated?: boolean;
-}
-
-/** Why a desired entry was refused rather than applied. */
-export interface RejectedEntry {
-	readonly id: string;
-	readonly code: string;
-	readonly reason: string;
-	/** How many times this identifier appeared in the desired set. */
-	readonly occurrences: number;
-	/**
-	 * True when a notification already scheduled under this identifier was left
-	 * in place. Stated explicitly so a rejection is never misread as a
-	 * cancellation.
-	 */
-	readonly existingLeftInPlace: boolean;
-}
-
-/** What was dropped for exceeding the platform's pending ceiling. */
-export interface TruncationReport {
-	readonly ceiling: number;
-	readonly droppedCount: number;
-	readonly droppedIds: readonly string[];
-	/**
-	 * Dropped entries are not lost — they are re-evaluated at each window
-	 * refresh as nearer entries deliver.
-	 */
-	readonly reEvaluatedOnNextRefresh: true;
-}
-
-export interface ReconcileResult {
-	readonly domain: string;
-	readonly created: readonly string[];
-	readonly replaced: readonly string[];
-	readonly cancelled: readonly string[];
-	readonly unchanged: readonly string[];
-	readonly rejected: readonly RejectedEntry[];
-	readonly truncated?: TruncationReport;
-	/** Total platform operations issued. Zero on a no-change pass. */
-	readonly operationCount: number;
-	readonly durationMs: number;
-}
-
-/** A discrepancy between what the package expects and what the platform holds. */
-export interface PendingDiscrepancy {
-	/** Expected from the series ledger or last reconciliation, but absent. */
-	readonly missing: readonly string[];
-	/** Present on the platform but not recognized by the package. */
-	readonly unrecognized: readonly string[];
-	readonly detectedAt: number;
-}
-
-/** Outcome of one automatic maintenance cycle. */
-export interface MaintenanceResult {
-	readonly ranAt: number;
-	readonly windowRefreshed: boolean;
-	readonly occurrencesScheduled: number;
-	readonly reAnchored: number;
-	readonly timeZoneChanged: boolean;
-	readonly permissionChanged: boolean;
-	/** Detected and reported only — never repaired. */
-	readonly discrepancy?: PendingDiscrepancy;
-	readonly operationCount: number;
-	readonly durationMs: number;
-}
+/**
+ * Reconciliation types.
+ *
+ * A caller hands over the complete set its data currently implies; the package
+ * computes the minimal operation set that makes the device match. Running it
+ * twice with unchanged input performs zero platform operations — that
+ * idempotence is the package's central testable promise.
+ */
+
+import type { NotificationRequest } from './notification';
+
+export interface ReconcileInput {
+	/**
+	 * Bounds what may be cancelled. Notifications outside this domain are never
+	 * touched, including those scheduled by other parts of the app or by other
+	 * libraries.
+	 */
+	readonly domain: string;
+	readonly desired: readonly NotificationRequest[];
+	/**
+	 * When false (the default), push-created notifications are left alone rather
+	 * than cancelled for being absent from a locally-computed desired set.
+	 */
+	readonly includePushCreated?: boolean;
+}
+
+/** Why a desired entry was refused rather than applied. */
+export interface RejectedEntry {
+	readonly id: string;
+	readonly code: string;
+	readonly reason: string;
+	/** How many times this identifier appeared in the desired set. */
+	readonly occurrences: number;
+	/**
+	 * True when a notification already scheduled under this identifier was left
+	 * in place. Stated explicitly so a rejection is never misread as a
+	 * cancellation.
+	 */
+	readonly existingLeftInPlace: boolean;
+}
+
+/** What was dropped for exceeding the platform's pending ceiling. */
+export interface TruncationReport {
+	readonly ceiling: number;
+	readonly droppedCount: number;
+	readonly droppedIds: readonly string[];
+	/**
+	 * Dropped entries are not lost — they are re-evaluated at each window
+	 * refresh as nearer entries deliver.
+	 */
+	readonly reEvaluatedOnNextRefresh: true;
+}
+
+export interface ReconcileResult {
+	readonly domain: string;
+	readonly created: readonly string[];
+	readonly replaced: readonly string[];
+	readonly cancelled: readonly string[];
+	readonly unchanged: readonly string[];
+	readonly rejected: readonly RejectedEntry[];
+	readonly truncated?: TruncationReport;
+	/** Total platform operations issued. Zero on a no-change pass. */
+	readonly operationCount: number;
+	readonly durationMs: number;
+}
+
+/** A discrepancy between what the package expects and what the platform holds. */
+export interface PendingDiscrepancy {
+	/** Expected from the series ledger or last reconciliation, but absent. */
+	readonly missing: readonly string[];
+	/** Present on the platform but not recognized by the package. */
+	readonly unrecognized: readonly string[];
+	readonly detectedAt: number;
+}
+
+/** Outcome of one automatic maintenance cycle. */
+export interface MaintenanceResult {
+	readonly ranAt: number;
+	readonly windowRefreshed: boolean;
+	readonly occurrencesScheduled: number;
+	readonly reAnchored: number;
+	readonly timeZoneChanged: boolean;
+	readonly permissionChanged: boolean;
+	/** Detected and reported only — never repaired. */
+	readonly discrepancy?: PendingDiscrepancy;
+	readonly operationCount: number;
+	readonly durationMs: number;
+}