@chipmobilesdk/rn-notification 0.4.0 → 0.5.0

package/src/index.ts

@@ -1,208 +1,208 @@
-/**
- * @chipmobilesdk/rn-notification
- *
- * Default entrypoint: scheduling, recurrence, reconciliation, permissions,
- * channels, interaction, and diagnostics.
- *
- * Push lives behind `@chipmobilesdk/rn-notification/push` so an app that never
- * enables it ships no provider code, no push permissions, and no entitlements.
- * Test doubles live behind `@chipmobilesdk/rn-notification/testing` so they
- * never reach a production bundle.
- *
- * No engine, provider, or storage type is reachable from here — that is what
- * makes each of them replaceable.
- */
-
-export type {
-	// Notification
-	AnchoringMode,
-	DeliveryMoment,
-	NotificationContent,
-	RoutingPayload,
-	Action,
-	NotificationRequest,
-	PendingEntry,
-	ScheduleResult,
-	// Recurrence
-	Weekday,
-	DailyPattern,
-	WeeklyPattern,
-	MonthlyByDayPattern,
-	RecurrencePattern,
-	EndCondition,
-	OccurrenceTemplate,
-	RecurrenceRule,
-	LookaheadConfig,
-	SeriesResult,
-	SeriesSummary,
-	// Reconciliation
-	ReconcileInput,
-	ReconcileResult,
-	RejectedEntry,
-	TruncationReport,
-	PendingDiscrepancy,
-	MaintenanceResult,
-	// Permission
-	PermissionKind,
-	PermissionState,
-	PermissionReport,
-	PermissionCapability,
-	RestrictionStatus,
-	RestrictionReport,
-	// Channel
-	ToneUrgency,
-	ToneSound,
-	ToneRepeatAlert,
-	ToneDeclaration,
-	ChannelGroup,
-	ChannelApplyResult,
-	// Reachable through EngineScheduleRequest, so the engine port is unusable
-	// without it — a consumer supplying its own engine must be able to name it.
-	ResolvedTone,
-	// Interaction
-	InteractionKind,
-	AppStateAtInteraction,
-	InteractionEvent,
-	InteractionHandler,
-	TargetMissingSignal,
-	Unsubscribe,
-	// Diagnostics
-	DiagnosticSeverity,
-	DiagnosticEvent,
-	EventSink,
-	CollectionHealth,
-	StateHealth,
-	StateSnapshot,
-	BurstThreshold,
-	NotificationConfig,
-	InitializeResult,
-} from './contract';
-
-export {
-	DEFAULT_ANCHORING_MODE,
-	DEFAULT_LOOKAHEAD,
-	REPEAT_ALERT_BOUNDS,
-	LOOKAHEAD_BOUNDS,
-	INTERACTION_BUFFER_LIMITS,
-	MAX_ROUTING_PAYLOAD_BYTES,
-	MAX_ACTIONS_PER_NOTIFICATION,
-	DEFAULT_BURST_THRESHOLD,
-	DIAGNOSTIC_CODES,
-	ALL_DIAGNOSTIC_CODES,
-	NotificationError,
-	isNotificationError,
-	isNonFailure,
-} from './contract';
-
-export type { DiagnosticCode } from './contract';
-
-/**
- * The engine port. Exported so a consuming app can supply its own engine, which
- * is the mechanism behind provider and engine substitution.
- */
-export type {
-	NotificationEngineAdapter,
-	DeliveryEvent,
-	EngineCapabilities,
-	EngineScheduleRequest,
-	RepeatStop,
-	ToneDeclarationOutcome,
-} from './engine/adapter';
-
-/** The default engine. Consumers may substitute their own via the port above. */
-export { createNotifyKitEngine } from './engine/notify-kit-engine';
-
-/** Initialization and the assembled runtime. */
-export { initialize } from './initialize';
-export type { RuntimeDependencies, NotificationRuntime } from './initialize';
-
-/** Scheduling operations. */
-export { createScheduler } from './schedule';
-export type { Scheduler, ScheduleDependencies } from './schedule';
-
-/** Reconciliation — always consumer-invoked, never automatic. */
-export { createReconciler } from './reconcile';
-export type { Reconciler, ReconcileDependencies } from './reconcile';
-
-/** Recurrence — declare a rule once; the package maintains a bounded window. */
-export { createRecurrence } from './recurrence';
-export type { Recurrence, RecurrenceDependencies } from './recurrence';
-export { occurrenceId } from './recurrence/expand';
-
-/** Channels and tones — declared once, mapped to each platform, migrated on change. */
-export { createChannels } from './channel/migrate';
-export type { Channels, ChannelDependencies } from './channel/migrate';
-export { channelIdFor, createToneResolver, parseChannelId, resolveTone } from './channel/tone-map';
-export { validateToneDeclaration, validateToneDeclarations } from './channel/validate-tone';
-
-/**
- * Repeat expiry — what bounds an alert that repeats until it is handled.
- *
- * `registerBackgroundNotificationHandler` is the one piece a consumer wires up
- * themselves, at module scope in `index.js`. An app that declares no repeating
- * tone needs none of this.
- */
-export {
-	createRepeatExpiryHandler,
-	registerBackgroundNotificationHandler,
-	REPEAT_STOP_PREFIX,
-} from './repeat';
-export type {
-	BackgroundHandlerRegistration,
-	RepeatExpiryHandler,
-	RepeatExpiryDependencies,
-} from './repeat';
-
-/** Interaction routing — one handler for foreground, background, and cold start. */
-export { createInteractions } from './interaction';
-export type { Interactions, InteractionDependencies } from './interaction';
-
-/** Observability — snapshot and burst detection. */
-export { createSnapshot } from './diagnostics/snapshot';
-export type { Snapshot, SnapshotDependencies } from './diagnostics/snapshot';
-export { createBurstDetector } from './diagnostics/burst';
-export type { BurstDetector, BurstStatus } from './diagnostics/burst';
-export { DiagnosticEmitter } from './diagnostics/events';
-
-/** Permission coordination — reading never prompts; a refusal never fails the caller. */
-export { createPermissions } from './permission';
-export type { Permissions, PermissionDependencies, PermissionChangeHandler } from './permission';
-export { canDisplay, capabilityFor, isTerminal, shouldOfferSettings } from './permission/state';
-export type { PlatformInfo } from './permission/state';
-
-/** Maintenance steps, registered with the runtime's registry. */
-export { createPermissionRefreshStep } from './maintenance/permission-refresh';
-export { createReAnchorStep } from './maintenance/reanchor';
-export { createVerifyStep } from './maintenance/verify';
-export { createWindowRefreshStep } from './maintenance/window-refresh';
-export type { MaintenanceStep, MaintenanceTrigger, MaintenanceContext } from './maintenance/cycle';
-export { MaintenanceRegistry, MaintenanceScopeViolation } from './maintenance/cycle';
-export { MaintenanceController } from './maintenance/toggle';
-
-/** Public state controls — the only two ways a consumer may touch persisted state. */
-export { resetState, clearOwner } from './state/reset';
-export type { ResetOutcome } from './state/reset';
-
-/**
- * State plumbing. The record's *schema* stays private — a consumer can create
- * and reset the store, but has no way to read or write what is inside it.
- */
-export { createMmkvStore } from './state/mmkv-store';
-export { StateManager } from './state/record';
-export type { StateStore } from './state/store';
-
-/** Documented limits, exported so a consumer can validate before calling. */
-export { MAX_IDENTIFIER_LENGTH } from './schedule/validate-identifier';
-export { CONTENT_LIMITS } from './schedule/validate-content';
-export { PAST_TOLERANCE_MS } from './schedule/resolve-moment';
-
-/**
- * Reads the platform time zone, which anchoring depends on.
- *
- * Exported because every consumer needs it and pure JavaScript cannot provide
- * it reliably — `Intl.DateTimeFormat().resolvedOptions().timeZone` does not
- * update when the device zone changes. Leaving consumers to write this
- * themselves is how a subtly wrong version ends up in each of them.
- */
-export { createPlatformTimeZoneReader, isValidTimeZone } from './schedule/anchor';
-export type { TimeZoneReader } from './schedule/anchor';
+/**
+ * @chipmobilesdk/rn-notification
+ *
+ * Default entrypoint: scheduling, recurrence, reconciliation, permissions,
+ * channels, interaction, and diagnostics.
+ *
+ * Push lives behind `@chipmobilesdk/rn-notification/push` so an app that never
+ * enables it ships no provider code, no push permissions, and no entitlements.
+ * Test doubles live behind `@chipmobilesdk/rn-notification/testing` so they
+ * never reach a production bundle.
+ *
+ * No engine, provider, or storage type is reachable from here — that is what
+ * makes each of them replaceable.
+ */
+
+export type {
+	// Notification
+	AnchoringMode,
+	DeliveryMoment,
+	NotificationContent,
+	RoutingPayload,
+	Action,
+	NotificationRequest,
+	PendingEntry,
+	ScheduleResult,
+	// Recurrence
+	Weekday,
+	DailyPattern,
+	WeeklyPattern,
+	MonthlyByDayPattern,
+	RecurrencePattern,
+	EndCondition,
+	OccurrenceTemplate,
+	RecurrenceRule,
+	LookaheadConfig,
+	SeriesResult,
+	SeriesSummary,
+	// Reconciliation
+	ReconcileInput,
+	ReconcileResult,
+	RejectedEntry,
+	TruncationReport,
+	PendingDiscrepancy,
+	MaintenanceResult,
+	// Permission
+	PermissionKind,
+	PermissionState,
+	PermissionReport,
+	PermissionCapability,
+	RestrictionStatus,
+	RestrictionReport,
+	// Channel
+	ToneUrgency,
+	ToneSound,
+	ToneRepeatAlert,
+	ToneDeclaration,
+	ChannelGroup,
+	ChannelApplyResult,
+	// Reachable through EngineScheduleRequest, so the engine port is unusable
+	// without it — a consumer supplying its own engine must be able to name it.
+	ResolvedTone,
+	// Interaction
+	InteractionKind,
+	AppStateAtInteraction,
+	InteractionEvent,
+	InteractionHandler,
+	TargetMissingSignal,
+	Unsubscribe,
+	// Diagnostics
+	DiagnosticSeverity,
+	DiagnosticEvent,
+	EventSink,
+	CollectionHealth,
+	StateHealth,
+	StateSnapshot,
+	BurstThreshold,
+	NotificationConfig,
+	InitializeResult,
+} from './contract';
+
+export {
+	DEFAULT_ANCHORING_MODE,
+	DEFAULT_LOOKAHEAD,
+	REPEAT_ALERT_BOUNDS,
+	LOOKAHEAD_BOUNDS,
+	INTERACTION_BUFFER_LIMITS,
+	MAX_ROUTING_PAYLOAD_BYTES,
+	MAX_ACTIONS_PER_NOTIFICATION,
+	DEFAULT_BURST_THRESHOLD,
+	DIAGNOSTIC_CODES,
+	ALL_DIAGNOSTIC_CODES,
+	NotificationError,
+	isNotificationError,
+	isNonFailure,
+} from './contract';
+
+export type { DiagnosticCode } from './contract';
+
+/**
+ * The engine port. Exported so a consuming app can supply its own engine, which
+ * is the mechanism behind provider and engine substitution.
+ */
+export type {
+	NotificationEngineAdapter,
+	DeliveryEvent,
+	EngineCapabilities,
+	EngineScheduleRequest,
+	RepeatStop,
+	ToneDeclarationOutcome,
+} from './engine/adapter';
+
+/** The default engine. Consumers may substitute their own via the port above. */
+export { createNotifyKitEngine } from './engine/notify-kit-engine';
+
+/** Initialization and the assembled runtime. */
+export { initialize } from './initialize';
+export type { RuntimeDependencies, NotificationRuntime } from './initialize';
+
+/** Scheduling operations. */
+export { createScheduler } from './schedule';
+export type { Scheduler, ScheduleDependencies } from './schedule';
+
+/** Reconciliation — always consumer-invoked, never automatic. */
+export { createReconciler } from './reconcile';
+export type { Reconciler, ReconcileDependencies } from './reconcile';
+
+/** Recurrence — declare a rule once; the package maintains a bounded window. */
+export { createRecurrence } from './recurrence';
+export type { Recurrence, RecurrenceDependencies } from './recurrence';
+export { occurrenceId } from './recurrence/expand';
+
+/** Channels and tones — declared once, mapped to each platform, migrated on change. */
+export { createChannels } from './channel/migrate';
+export type { Channels, ChannelDependencies } from './channel/migrate';
+export { channelIdFor, createToneResolver, parseChannelId, resolveTone } from './channel/tone-map';
+export { validateToneDeclaration, validateToneDeclarations } from './channel/validate-tone';
+
+/**
+ * Repeat expiry — what bounds an alert that repeats until it is handled.
+ *
+ * `registerBackgroundNotificationHandler` is the one piece a consumer wires up
+ * themselves, at module scope in `index.js`. An app that declares no repeating
+ * tone needs none of this.
+ */
+export {
+	createRepeatExpiryHandler,
+	registerBackgroundNotificationHandler,
+	REPEAT_STOP_PREFIX,
+} from './repeat';
+export type {
+	BackgroundHandlerRegistration,
+	RepeatExpiryHandler,
+	RepeatExpiryDependencies,
+} from './repeat';
+
+/** Interaction routing — one handler for foreground, background, and cold start. */
+export { createInteractions } from './interaction';
+export type { Interactions, InteractionDependencies } from './interaction';
+
+/** Observability — snapshot and burst detection. */
+export { createSnapshot } from './diagnostics/snapshot';
+export type { Snapshot, SnapshotDependencies } from './diagnostics/snapshot';
+export { createBurstDetector } from './diagnostics/burst';
+export type { BurstDetector, BurstStatus } from './diagnostics/burst';
+export { DiagnosticEmitter } from './diagnostics/events';
+
+/** Permission coordination — reading never prompts; a refusal never fails the caller. */
+export { createPermissions } from './permission';
+export type { Permissions, PermissionDependencies, PermissionChangeHandler } from './permission';
+export { canDisplay, capabilityFor, isTerminal, shouldOfferSettings } from './permission/state';
+export type { PlatformInfo } from './permission/state';
+
+/** Maintenance steps, registered with the runtime's registry. */
+export { createPermissionRefreshStep } from './maintenance/permission-refresh';
+export { createReAnchorStep } from './maintenance/reanchor';
+export { createVerifyStep } from './maintenance/verify';
+export { createWindowRefreshStep } from './maintenance/window-refresh';
+export type { MaintenanceStep, MaintenanceTrigger, MaintenanceContext } from './maintenance/cycle';
+export { MaintenanceRegistry, MaintenanceScopeViolation } from './maintenance/cycle';
+export { MaintenanceController } from './maintenance/toggle';
+
+/** Public state controls — the only two ways a consumer may touch persisted state. */
+export { resetState, clearOwner } from './state/reset';
+export type { ResetOutcome } from './state/reset';
+
+/**
+ * State plumbing. The record's *schema* stays private — a consumer can create
+ * and reset the store, but has no way to read or write what is inside it.
+ */
+export { createMmkvStore } from './state/mmkv-store';
+export { StateManager } from './state/record';
+export type { StateStore } from './state/store';
+
+/** Documented limits, exported so a consumer can validate before calling. */
+export { MAX_IDENTIFIER_LENGTH } from './schedule/validate-identifier';
+export { CONTENT_LIMITS } from './schedule/validate-content';
+export { PAST_TOLERANCE_MS } from './schedule/resolve-moment';
+
+/**
+ * Reads the platform time zone, which anchoring depends on.
+ *
+ * Exported because every consumer needs it and pure JavaScript cannot provide
+ * it reliably — `Intl.DateTimeFormat().resolvedOptions().timeZone` does not
+ * update when the device zone changes. Leaving consumers to write this
+ * themselves is how a subtly wrong version ends up in each of them.
+ */
+export { createPlatformTimeZoneReader, isValidTimeZone } from './schedule/anchor';
+export type { TimeZoneReader } from './schedule/anchor';