@misternooblet/squara-types 1.0.19 → 1.0.20

package/dist/notification/index.d.ts

@@ -1,2 +1 @@
-export { NotificationType, Notification, NOTIFICATION_TYPE_TO_PAYLOAD_MAP } from "./notification";
-export { GroupUpdateNotification, PendingSettlementNotification, NewGroupMemberNotification, NewGroupExpenseNotification } from "./notification";
+export { NotificationType, SquaraNotification, NOTIFICATION_TYPE_TO_PAYLOAD_MAP, NotificationPayload, NotificationDataInput, GroupUpdateNotification, PendingSettlementNotification, NewGroupMemberNotification, NewGroupExpenseNotification, isNotificationType, isGroupUpdate, isPendingSettlement, isNewGroupMember, isNewGroupExpense, parseNotificationData, buildNotificationData, } from './notification';

package/dist/notification/index.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NOTIFICATION_TYPE_TO_PAYLOAD_MAP = exports.NotificationType = void 0;
+exports.buildNotificationData = exports.parseNotificationData = exports.isNewGroupExpense = exports.isNewGroupMember = exports.isPendingSettlement = exports.isGroupUpdate = exports.isNotificationType = exports.NOTIFICATION_TYPE_TO_PAYLOAD_MAP = exports.NotificationType = void 0;
 var notification_1 = require("./notification");
 Object.defineProperty(exports, "NotificationType", { enumerable: true, get: function () { return notification_1.NotificationType; } });
 Object.defineProperty(exports, "NOTIFICATION_TYPE_TO_PAYLOAD_MAP", { enumerable: true, get: function () { return notification_1.NOTIFICATION_TYPE_TO_PAYLOAD_MAP; } });
+Object.defineProperty(exports, "isNotificationType", { enumerable: true, get: function () { return notification_1.isNotificationType; } });
+Object.defineProperty(exports, "isGroupUpdate", { enumerable: true, get: function () { return notification_1.isGroupUpdate; } });
+Object.defineProperty(exports, "isPendingSettlement", { enumerable: true, get: function () { return notification_1.isPendingSettlement; } });
+Object.defineProperty(exports, "isNewGroupMember", { enumerable: true, get: function () { return notification_1.isNewGroupMember; } });
+Object.defineProperty(exports, "isNewGroupExpense", { enumerable: true, get: function () { return notification_1.isNewGroupExpense; } });
+Object.defineProperty(exports, "parseNotificationData", { enumerable: true, get: function () { return notification_1.parseNotificationData; } });
+Object.defineProperty(exports, "buildNotificationData", { enumerable: true, get: function () { return notification_1.buildNotificationData; } });

package/dist/notification/notification.d.ts

@@ -4,14 +4,16 @@ export declare enum NotificationType {
     NewGroupMember = "NEW_GROUP_MEMBER",
     NewGroupExpense = "NEW_GROUP_EXPENSE"
 }
-export interface Notification {
+export interface SquaraNotification {
     type: NotificationType;
+    title?: string;
+    body?: string;
 }
-export interface GroupUpdateNotification extends Notification {
+export interface GroupUpdateNotification extends SquaraNotification {
     type: NotificationType.GroupUpdate;
     groupId: string;
 }
-export interface PendingSettlementNotification extends Notification {
+export interface PendingSettlementNotification extends SquaraNotification {
     type: NotificationType.PendingSettlement;
     settlementId: string;
     settlementFromUserId: string;
@@ -20,12 +22,12 @@ export interface PendingSettlementNotification extends Notification {
     amount: number;
     currency: string;
 }
-export interface NewGroupMemberNotification extends Notification {
+export interface NewGroupMemberNotification extends SquaraNotification {
     type: NotificationType.NewGroupMember;
     groupId: string;
     userId: string;
 }
-export interface NewGroupExpenseNotification extends Notification {
+export interface NewGroupExpenseNotification extends SquaraNotification {
     type: NotificationType.NewGroupExpense;
     groupId: string;
     expenseId: string;
@@ -38,3 +40,12 @@ export declare const NOTIFICATION_TYPE_TO_PAYLOAD_MAP: {
     NEW_GROUP_MEMBER: NewGroupMemberNotification;
     NEW_GROUP_EXPENSE: NewGroupExpenseNotification;
 };
+export type NotificationPayload = (typeof NOTIFICATION_TYPE_TO_PAYLOAD_MAP)[keyof typeof NOTIFICATION_TYPE_TO_PAYLOAD_MAP];
+export type NotificationDataInput<T extends NotificationType> = Omit<(typeof NOTIFICATION_TYPE_TO_PAYLOAD_MAP)[T], keyof SquaraNotification>;
+export declare function isNotificationType(value: unknown): value is NotificationType;
+export declare function isGroupUpdate(p: NotificationPayload): p is GroupUpdateNotification;
+export declare function isPendingSettlement(p: NotificationPayload): p is PendingSettlementNotification;
+export declare function isNewGroupMember(p: NotificationPayload): p is NewGroupMemberNotification;
+export declare function isNewGroupExpense(p: NotificationPayload): p is NewGroupExpenseNotification;
+export declare function parseNotificationData(data: Record<string, string>): NotificationPayload | null;
+export declare function buildNotificationData<T extends NotificationType>(type: T, payload: NotificationDataInput<T>): Record<string, string>;

package/dist/notification/notification.js

@@ -1,6 +1,14 @@
 "use strict";
+// ─── Enum ─────────────────────────────────────────────────────────────────
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NOTIFICATION_TYPE_TO_PAYLOAD_MAP = exports.NotificationType = void 0;
+exports.isNotificationType = isNotificationType;
+exports.isGroupUpdate = isGroupUpdate;
+exports.isPendingSettlement = isPendingSettlement;
+exports.isNewGroupMember = isNewGroupMember;
+exports.isNewGroupExpense = isNewGroupExpense;
+exports.parseNotificationData = parseNotificationData;
+exports.buildNotificationData = buildNotificationData;
 var NotificationType;
 (function (NotificationType) {
     NotificationType["GroupUpdate"] = "GROUP_UPDATE";
@@ -8,9 +16,76 @@ var NotificationType;
     NotificationType["NewGroupMember"] = "NEW_GROUP_MEMBER";
     NotificationType["NewGroupExpense"] = "NEW_GROUP_EXPENSE";
 })(NotificationType || (exports.NotificationType = NotificationType = {}));
+// ─── Map ──────────────────────────────────────────────────────────────────
 exports.NOTIFICATION_TYPE_TO_PAYLOAD_MAP = {
     [NotificationType.GroupUpdate]: {},
     [NotificationType.PendingSettlement]: {},
     [NotificationType.NewGroupMember]: {},
     [NotificationType.NewGroupExpense]: {},
 };
+// ─── Type guards ──────────────────────────────────────────────────────────
+function isNotificationType(value) {
+    return typeof value === 'string' && Object.values(NotificationType).includes(value);
+}
+function isGroupUpdate(p) {
+    return p.type === NotificationType.GroupUpdate;
+}
+function isPendingSettlement(p) {
+    return p.type === NotificationType.PendingSettlement;
+}
+function isNewGroupMember(p) {
+    return p.type === NotificationType.NewGroupMember;
+}
+function isNewGroupExpense(p) {
+    return p.type === NotificationType.NewGroupExpense;
+}
+// ─── Parser (frontend) ────────────────────────────────────────────────────
+// Firebase sends all data values as strings — validates and re-shapes to typed payload
+function parseNotificationData(data) {
+    if (!isNotificationType(data.type))
+        return null;
+    const base = { title: data.title, body: data.body };
+    switch (data.type) {
+        case NotificationType.GroupUpdate:
+            if (!data.groupId)
+                return null;
+            return { ...base, type: data.type, groupId: data.groupId };
+        case NotificationType.PendingSettlement:
+            if (!data.settlementId || !data.groupId)
+                return null;
+            return {
+                ...base,
+                type: data.type,
+                settlementId: data.settlementId,
+                settlementFromUserId: data.settlementFromUserId,
+                settlementToUserId: data.settlementToUserId,
+                groupId: data.groupId,
+                amount: parseFloat(data.amount),
+                currency: data.currency,
+            };
+        case NotificationType.NewGroupMember:
+            if (!data.groupId || !data.userId)
+                return null;
+            return { ...base, type: data.type, groupId: data.groupId, userId: data.userId };
+        case NotificationType.NewGroupExpense:
+            if (!data.groupId || !data.expenseId)
+                return null;
+            return {
+                ...base,
+                type: data.type,
+                groupId: data.groupId,
+                expenseId: data.expenseId,
+                amount: parseFloat(data.amount),
+                currency: data.currency,
+            };
+        default:
+            return null;
+    }
+}
+// ─── Builder (backend) ────────────────────────────────────────────────────
+// Pass type + exact required fields → Firebase-ready Record<string, string>
+// IDE errors on missing fields, wrong fields, and wrong value types
+function buildNotificationData(type, payload) {
+    const raw = { type, ...payload };
+    return Object.fromEntries(Object.entries(raw).map(([k, v]) => [k, String(v)]));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@misternooblet/squara-types",
-  "version": "1.0.19",
+  "version": "1.0.20",
   "description": "Shared TypeScript types for the Squara app.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",