@chipmobilesdk/rn-notification 0.1.2 → 0.2.0

package/src/contract/permission.ts

@@ -1,60 +1,60 @@
-/**
- * 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;
+}

package/src/contract/recurrence.ts

@@ -1,123 +1,123 @@
-/**
- * Recurrence declaration types.
- *
- * A caller declares a rule once; the package expands it inside a finite
- * lookahead window. No caller ever writes an expansion loop, and no unbounded
- * series is ever handed to the platform.
- */
-
-import type { AnchoringMode, NotificationContent, Action, RoutingPayload } from './notification';
-
-/** Days of the week, `0` = Sunday, matching `Date.prototype.getDay`. */
-export type Weekday = 0 | 1 | 2 | 3 | 4 | 5 | 6;
-
-/** Every day at the declared clock time. */
-export interface DailyPattern {
-	readonly kind: 'daily';
-	readonly hour: number;
-	readonly minute: number;
-	/** Fire every `interval` days. Defaults to 1. */
-	readonly interval?: number;
-}
-
-/** Selected weekdays at the declared clock time. */
-export interface WeeklyPattern {
-	readonly kind: 'weekly';
-	readonly weekdays: readonly Weekday[];
-	readonly hour: number;
-	readonly minute: number;
-	/** Fire every `interval` weeks. Defaults to 1. */
-	readonly interval?: number;
-}
-
-/**
- * A fixed day of the month at the declared clock time.
- *
- * Months shorter than `dayOfMonth` are skipped rather than clamped: a caller
- * asking for the 31st means the 31st, and inventing the 28th would be the
- * package deciding something it was not asked to decide.
- */
-export interface MonthlyByDayPattern {
-	readonly kind: 'monthlyByDay';
-	readonly dayOfMonth: number;
-	readonly hour: number;
-	readonly minute: number;
-	/** Fire every `interval` months. Defaults to 1. */
-	readonly interval?: number;
-}
-
-export type RecurrencePattern = DailyPattern | WeeklyPattern | MonthlyByDayPattern;
-
-/** When a series stops producing occurrences. */
-export type EndCondition =
-	| { readonly kind: 'unbounded' }
-	| { readonly kind: 'untilDate'; readonly until: number }
-	| { readonly kind: 'count'; readonly count: number };
-
-/** Content shared by every occurrence of a series. Identity and moment are derived. */
-export interface OccurrenceTemplate {
-	readonly content: NotificationContent;
-	readonly tone: string;
-	readonly routing?: RoutingPayload;
-	readonly actions?: readonly Action[];
-	readonly ownerTag?: string;
-	readonly groupTag?: string;
-}
-
-export interface RecurrenceRule {
-	/** Stable series identifier, subject to the same charset rules as a notification id. */
-	readonly id: string;
-	readonly pattern: RecurrencePattern;
-	/**
-	 * Declared once for the whole series and inherited by every occurrence.
-	 * A series may not mix modes. Defaults to `wallClock`.
-	 */
-	readonly anchoring?: AnchoringMode;
-	/** The instant from which occurrences are generated. Defaults to now. */
-	readonly startAt?: number;
-	readonly end: EndCondition;
-	readonly template: OccurrenceTemplate;
-}
-
-/**
- * How far ahead occurrences are registered with the platform.
- *
- * Bounded by both a duration and a count because either alone fails: a duration
- * alone lets a frequent series exhaust the platform ceiling, and a count alone
- * leaves an annual series scheduled a decade out.
- */
-export interface LookaheadConfig {
-	readonly days: number;
-	readonly occurrencesPerSeries: number;
-}
-
-export const DEFAULT_LOOKAHEAD: LookaheadConfig = {
-	days: 60,
-	occurrencesPerSeries: 32,
-};
-
-/** Bounds on consumer adjustment, because the platform ceiling is not negotiable. */
-export const LOOKAHEAD_BOUNDS = {
-	minDays: 1,
-	maxDays: 365,
-	minOccurrences: 1,
-	maxOccurrences: 64,
-} as const;
-
-export interface SeriesResult {
-	readonly seriesId: string;
-	/** Occurrences registered with the platform in this pass. */
-	readonly scheduled: number;
-	/** The horizon expansion reached, in epoch milliseconds. */
-	readonly expandedThrough: number;
-	/** True when the series has produced its final occurrence. */
-	readonly exhausted: boolean;
-}
-
-export interface SeriesSummary {
-	readonly seriesId: string;
-	readonly anchoring: AnchoringMode;
-	readonly expandedThrough: number;
-	readonly pendingOccurrences: number;
-	readonly exhausted: boolean;
-}
+/**
+ * Recurrence declaration types.
+ *
+ * A caller declares a rule once; the package expands it inside a finite
+ * lookahead window. No caller ever writes an expansion loop, and no unbounded
+ * series is ever handed to the platform.
+ */
+
+import type { AnchoringMode, NotificationContent, Action, RoutingPayload } from './notification';
+
+/** Days of the week, `0` = Sunday, matching `Date.prototype.getDay`. */
+export type Weekday = 0 | 1 | 2 | 3 | 4 | 5 | 6;
+
+/** Every day at the declared clock time. */
+export interface DailyPattern {
+	readonly kind: 'daily';
+	readonly hour: number;
+	readonly minute: number;
+	/** Fire every `interval` days. Defaults to 1. */
+	readonly interval?: number;
+}
+
+/** Selected weekdays at the declared clock time. */
+export interface WeeklyPattern {
+	readonly kind: 'weekly';
+	readonly weekdays: readonly Weekday[];
+	readonly hour: number;
+	readonly minute: number;
+	/** Fire every `interval` weeks. Defaults to 1. */
+	readonly interval?: number;
+}
+
+/**
+ * A fixed day of the month at the declared clock time.
+ *
+ * Months shorter than `dayOfMonth` are skipped rather than clamped: a caller
+ * asking for the 31st means the 31st, and inventing the 28th would be the
+ * package deciding something it was not asked to decide.
+ */
+export interface MonthlyByDayPattern {
+	readonly kind: 'monthlyByDay';
+	readonly dayOfMonth: number;
+	readonly hour: number;
+	readonly minute: number;
+	/** Fire every `interval` months. Defaults to 1. */
+	readonly interval?: number;
+}
+
+export type RecurrencePattern = DailyPattern | WeeklyPattern | MonthlyByDayPattern;
+
+/** When a series stops producing occurrences. */
+export type EndCondition =
+	| { readonly kind: 'unbounded' }
+	| { readonly kind: 'untilDate'; readonly until: number }
+	| { readonly kind: 'count'; readonly count: number };
+
+/** Content shared by every occurrence of a series. Identity and moment are derived. */
+export interface OccurrenceTemplate {
+	readonly content: NotificationContent;
+	readonly tone: string;
+	readonly routing?: RoutingPayload;
+	readonly actions?: readonly Action[];
+	readonly ownerTag?: string;
+	readonly groupTag?: string;
+}
+
+export interface RecurrenceRule {
+	/** Stable series identifier, subject to the same charset rules as a notification id. */
+	readonly id: string;
+	readonly pattern: RecurrencePattern;
+	/**
+	 * Declared once for the whole series and inherited by every occurrence.
+	 * A series may not mix modes. Defaults to `wallClock`.
+	 */
+	readonly anchoring?: AnchoringMode;
+	/** The instant from which occurrences are generated. Defaults to now. */
+	readonly startAt?: number;
+	readonly end: EndCondition;
+	readonly template: OccurrenceTemplate;
+}
+
+/**
+ * How far ahead occurrences are registered with the platform.
+ *
+ * Bounded by both a duration and a count because either alone fails: a duration
+ * alone lets a frequent series exhaust the platform ceiling, and a count alone
+ * leaves an annual series scheduled a decade out.
+ */
+export interface LookaheadConfig {
+	readonly days: number;
+	readonly occurrencesPerSeries: number;
+}
+
+export const DEFAULT_LOOKAHEAD: LookaheadConfig = {
+	days: 60,
+	occurrencesPerSeries: 32,
+};
+
+/** Bounds on consumer adjustment, because the platform ceiling is not negotiable. */
+export const LOOKAHEAD_BOUNDS = {
+	minDays: 1,
+	maxDays: 365,
+	minOccurrences: 1,
+	maxOccurrences: 64,
+} as const;
+
+export interface SeriesResult {
+	readonly seriesId: string;
+	/** Occurrences registered with the platform in this pass. */
+	readonly scheduled: number;
+	/** The horizon expansion reached, in epoch milliseconds. */
+	readonly expandedThrough: number;
+	/** True when the series has produced its final occurrence. */
+	readonly exhausted: boolean;
+}
+
+export interface SeriesSummary {
+	readonly seriesId: string;
+	readonly anchoring: AnchoringMode;
+	readonly expandedThrough: number;
+	readonly pendingOccurrences: number;
+	readonly exhausted: boolean;
+}