@qrush/types 2.0.39 → 2.1.0

package/README.md

@@ -30,6 +30,8 @@ import { CommonFields } from '@qrush/types/Common';
 import { CustomDocType } from '@qrush/types/CustomDocType';
 import { Timestamp, GeoPoint, formatTimestamp } from '@qrush/types/firebase';
 import { IFireWebappUser, FireWebappUserSnapshotRef } from '@qrush/types/WebappUsers';
+import { IFireChats, IFireMessages, FireChatsSnapshotRef } from '@qrush/types/Chat';
+import { IFireMatchingRound, IFireAttendee, FireMatchingRoundSnapshotRef } from '@qrush/types/Matching';
 ```
 
 ## Available Types
@@ -44,6 +46,8 @@ import { IFireWebappUser, FireWebappUserSnapshotRef } from '@qrush/types/WebappU
 - **CustomDocType** - Custom document type definitions
 - **firebase** - Firebase/Firestore type re-exports and utilities
 - **WebappUsers** - Web application specific user types and interfaces
+- **Chat** - Chat system types and interfaces for messaging functionality
+- **Matching** - Types for the matching system and attendee management
 
 ## Development
 

package/dist/Chat.d.ts

@@ -0,0 +1,60 @@
+import { FireQueryDocSnapshotRef } from '@qrush/types/CustomDocType';
+import type { FieldValue, Timestamp } from '@qrush/types/firebase';
+export interface IFireChats {
+    participants: {
+        [userUID: string]: Participant;
+    };
+    lastSenderUID: string | null;
+    lastMessageAt: Timestamp | null | undefined;
+    lastMessage: string | null;
+    newMessages: number;
+    chatOrigin: ChatOrigin;
+    draftMessages: {
+        [userUID: string]: IFireMessages;
+    };
+}
+export interface Participant {
+    name: string;
+    birthday: Timestamp;
+    pictureURI: string | null;
+    check: true;
+}
+type ChatOrigin = ChatOriginEvent | ChatOriginPersonalQR;
+interface ChatOriginEvent {
+    type: 'event';
+    name: string;
+}
+interface ChatOriginPersonalQR {
+    type: 'personal';
+}
+export type FireChatsSnapshotRef = FireQueryDocSnapshotRef<IFireChats>;
+export type IFireChatsUpdateData = {
+    lastSenderUID: string;
+    lastMessageAt: FieldValue;
+    lastMessage: string;
+    newMessages: FieldValue | number;
+};
+export type IFireChatsMarkAsReadData = {
+    newMessages: 0;
+};
+export interface IFireMessages {
+    senderUID: string;
+    sentAt: Timestamp | undefined;
+    deliveredAt: Timestamp | undefined;
+    readAt: Timestamp | undefined;
+    message?: string;
+    messagePayload?: MessagePayload;
+}
+type MessagePayload = MessageImagePayload;
+interface MessageImagePayload {
+    type: 'image';
+    uri: string;
+}
+export type FireMessagesSnapshotRef = FireQueryDocSnapshotRef<IFireMessages>;
+export interface IFireMessagesCreationData {
+    senderUID: string;
+    sentAt: FieldValue;
+    message?: string;
+    messagePayload?: MessagePayload;
+}
+export {};

package/dist/Chat.js

@@ -0,0 +1 @@
+export {};

package/dist/Matching.d.ts

@@ -0,0 +1,61 @@
+import { Timestamp } from '@firebase/firestore';
+import { FireQueryDocSnapshotRef } from '@qrush/types/CustomDocType';
+import { Gender } from '@qrush/types/Users';
+export interface IFireMatchingRound {
+    scheduledFor: Timestamp;
+    scheduledDuration: number;
+    startedAt: Timestamp | null;
+    closedAt: Timestamp | null;
+    attendees: number;
+    demo: boolean;
+}
+export type FireMatchingRoundSnapshotRef = FireQueryDocSnapshotRef<IFireMatchingRound>;
+export interface IFireMatchingRoundCreationData {
+    scheduledFor: Date;
+    scheduledDuration: number;
+    startedAt: Date | null;
+    closedAt: Date | null;
+    attendees: number;
+    demo: boolean;
+}
+export interface IFireAttendee {
+    name: string;
+    age: number;
+    gender: Gender;
+    pictureURI: string;
+    preference: {
+        [Preference in MatchingPreference]: boolean;
+    };
+    inGroup: boolean;
+    matchAttendeeUID?: string;
+    votes: {
+        [receiverUID: string]: Vote;
+    };
+    ignore: boolean;
+}
+type MatchingPreference = 'dates' | 'friends';
+interface Vote {
+    liked: boolean;
+    time: Timestamp;
+}
+export interface IFireAttendeeCreationData {
+    name: string;
+    age: number;
+    gender: Gender;
+    pictureURI: string;
+    preference: {
+        [Preference in MatchingPreference]: boolean;
+    };
+    inGroup: boolean;
+    matchAttendeeUID?: string;
+    votes: {
+        [receiverUID: string]: VoteCreationData;
+    };
+    ignore: boolean;
+}
+interface VoteCreationData {
+    liked: boolean;
+    time: Date;
+}
+export type FireAttendeeSnapshotRef = FireQueryDocSnapshotRef<IFireAttendee>;
+export {};

package/dist/Matching.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrush/types",
-  "version": "2.0.39",
+  "version": "2.1.0",
   "description": "Shared TypeScript types for the QRush ecosystem",
   "type": "module",
   "scripts": {
@@ -64,6 +64,14 @@
     "./WebappUsers": {
       "import": "./dist/WebappUsers.js",
       "types": "./dist/WebappUsers.d.ts"
+    },
+    "./Chat": {
+      "import": "./dist/Chat.js",
+      "types": "./dist/Chat.d.ts"
+    },
+    "./Matching": {
+      "import": "./dist/Matching.js",
+      "types": "./dist/Matching.d.ts"
     }
   }
 }