@chipmobilesdk/rn-notification 0.4.0 → 0.5.0

package/src/engine/codec.ts

@@ -1,89 +1,89 @@
-/**
- * The metadata codec for a notification's platform data bag.
- *
- * Anchoring, series origin, tags, routing and actions have no engine
- * equivalent, and `getPending` must return them (FR-010) or a consumer cannot
- * diff against intent. They travel as strings in the free-form data bag, which
- * is the one field both platforms carry through unchanged.
- *
- * Shared by the real engine and the fake. When the fake stored requests
- * verbatim it could not lose a field the real engine lost — `actions` never
- * came back from a device, so every reconcile replaced every notification that
- * had them, and the fake-backed tests never saw it.
- */
-
-import type { EngineScheduleRequest } from './adapter';
-import type { Action, AnchoringMode, PendingEntry, RoutingPayload } from '../contract/notification';
-
-/** Everything `getPending` reports that only the data bag can carry. */
-export type PackedMetadata = Pick<
-	PendingEntry,
-	| 'anchoring'
-	| 'anchoringGeneration'
-	| 'tone'
-	| 'routing'
-	| 'actions'
-	| 'ownerTag'
-	| 'groupTag'
-	| 'seriesId'
-	| 'mayBeDelayed'
-	| 'pushCreated'
->;
-
-export function packData(request: EngineScheduleRequest): Record<string, string> {
-	return {
-		__cms_anchoring: request.request.moment.anchoring ?? 'wallClock',
-		// The IANA zone, not the tone. Storing the wrong value here does not merely
-		// mislabel an entry: the re-anchoring pass feeds it straight to
-		// Intl.DateTimeFormat, which throws a hard Hermes error on an invalid zone.
-		...(request.anchoringGeneration !== undefined
-			? { __cms_generation: request.anchoringGeneration }
-			: {}),
-		__cms_tone: request.request.tone,
-		__cms_approximate: String(request.approximate),
-		__cms_pushCreated: String(request.pushCreated ?? false),
-		...(request.seriesId !== undefined ? { __cms_series: request.seriesId } : {}),
-		...(request.request.ownerTag !== undefined ? { __cms_owner: request.request.ownerTag } : {}),
-		...(request.request.groupTag !== undefined ? { __cms_group: request.request.groupTag } : {}),
-		...(request.request.routing !== undefined
-			? { __cms_routing: JSON.stringify(request.request.routing) }
-			: {}),
-		...(request.request.actions !== undefined
-			? { __cms_actions: JSON.stringify(request.request.actions) }
-			: {}),
-		// A stop marker's whole payload. It travels here rather than in `ownerTag`
-		// or `routing` so it can never collide with a value a consumer owns.
-		...(request.repeatStop !== undefined
-			? {
-					__cms_stop_target: request.repeatStop.targetId,
-					__cms_stop_due: String(request.repeatStop.dueAt),
-				}
-			: {}),
-	};
-}
-
-/** A JSON field we cannot parse is reported as absent: the notification is still valid. */
-function parseJson<T>(raw: string | undefined): T | undefined {
-	if (typeof raw !== 'string') return undefined;
-	try {
-		return JSON.parse(raw) as T;
-	} catch {
-		return undefined;
-	}
-}
-
-export function unpackData(data: Record<string, string>): PackedMetadata {
-	const anchoring: AnchoringMode = data.__cms_anchoring === 'absolute' ? 'absolute' : 'wallClock';
-	return {
-		anchoring,
-		anchoringGeneration: anchoring === 'absolute' ? undefined : data.__cms_generation,
-		tone: data.__cms_tone ?? '',
-		routing: parseJson<RoutingPayload>(data.__cms_routing),
-		actions: parseJson<readonly Action[]>(data.__cms_actions),
-		ownerTag: data.__cms_owner,
-		groupTag: data.__cms_group,
-		seriesId: data.__cms_series,
-		mayBeDelayed: data.__cms_approximate === 'true',
-		pushCreated: data.__cms_pushCreated === 'true',
-	};
-}
+/**
+ * The metadata codec for a notification's platform data bag.
+ *
+ * Anchoring, series origin, tags, routing and actions have no engine
+ * equivalent, and `getPending` must return them (FR-010) or a consumer cannot
+ * diff against intent. They travel as strings in the free-form data bag, which
+ * is the one field both platforms carry through unchanged.
+ *
+ * Shared by the real engine and the fake. When the fake stored requests
+ * verbatim it could not lose a field the real engine lost — `actions` never
+ * came back from a device, so every reconcile replaced every notification that
+ * had them, and the fake-backed tests never saw it.
+ */
+
+import type { EngineScheduleRequest } from './adapter';
+import type { Action, AnchoringMode, PendingEntry, RoutingPayload } from '../contract/notification';
+
+/** Everything `getPending` reports that only the data bag can carry. */
+export type PackedMetadata = Pick<
+	PendingEntry,
+	| 'anchoring'
+	| 'anchoringGeneration'
+	| 'tone'
+	| 'routing'
+	| 'actions'
+	| 'ownerTag'
+	| 'groupTag'
+	| 'seriesId'
+	| 'mayBeDelayed'
+	| 'pushCreated'
+>;
+
+export function packData(request: EngineScheduleRequest): Record<string, string> {
+	return {
+		__cms_anchoring: request.request.moment.anchoring ?? 'wallClock',
+		// The IANA zone, not the tone. Storing the wrong value here does not merely
+		// mislabel an entry: the re-anchoring pass feeds it straight to
+		// Intl.DateTimeFormat, which throws a hard Hermes error on an invalid zone.
+		...(request.anchoringGeneration !== undefined
+			? { __cms_generation: request.anchoringGeneration }
+			: {}),
+		__cms_tone: request.request.tone,
+		__cms_approximate: String(request.approximate),
+		__cms_pushCreated: String(request.pushCreated ?? false),
+		...(request.seriesId !== undefined ? { __cms_series: request.seriesId } : {}),
+		...(request.request.ownerTag !== undefined ? { __cms_owner: request.request.ownerTag } : {}),
+		...(request.request.groupTag !== undefined ? { __cms_group: request.request.groupTag } : {}),
+		...(request.request.routing !== undefined
+			? { __cms_routing: JSON.stringify(request.request.routing) }
+			: {}),
+		...(request.request.actions !== undefined
+			? { __cms_actions: JSON.stringify(request.request.actions) }
+			: {}),
+		// A stop marker's whole payload. It travels here rather than in `ownerTag`
+		// or `routing` so it can never collide with a value a consumer owns.
+		...(request.repeatStop !== undefined
+			? {
+					__cms_stop_target: request.repeatStop.targetId,
+					__cms_stop_due: String(request.repeatStop.dueAt),
+				}
+			: {}),
+	};
+}
+
+/** A JSON field we cannot parse is reported as absent: the notification is still valid. */
+function parseJson<T>(raw: string | undefined): T | undefined {
+	if (typeof raw !== 'string') return undefined;
+	try {
+		return JSON.parse(raw) as T;
+	} catch {
+		return undefined;
+	}
+}
+
+export function unpackData(data: Record<string, string>): PackedMetadata {
+	const anchoring: AnchoringMode = data.__cms_anchoring === 'absolute' ? 'absolute' : 'wallClock';
+	return {
+		anchoring,
+		anchoringGeneration: anchoring === 'absolute' ? undefined : data.__cms_generation,
+		tone: data.__cms_tone ?? '',
+		routing: parseJson<RoutingPayload>(data.__cms_routing),
+		actions: parseJson<readonly Action[]>(data.__cms_actions),
+		ownerTag: data.__cms_owner,
+		groupTag: data.__cms_group,
+		seriesId: data.__cms_series,
+		mayBeDelayed: data.__cms_approximate === 'true',
+		pushCreated: data.__cms_pushCreated === 'true',
+	};
+}