@oxyfoo/whymeet-types 0.0.1

package/dist/WS/Request.d.ts

@@ -0,0 +1,794 @@
+import type { Profile } from '../Models/Profile.js';
+import type { MatchCandidate, MatchRequest } from '../Models/Match.js';
+import type { Conversation, Message } from '../Models/Conversation.js';
+import type { SearchFilters } from '../Models/Search.js';
+import type { Notification } from '../Models/Notification.js';
+import type { UserSettings, DiscoveryPreferences, VisibilityPreferences } from '../Models/Settings.js';
+import type { TagSuggestion } from '../Models/Tag.js';
+import type { UserSubscription, UserBoost, TokenBalance, BoostPack, SubscriptionPlatform } from '../Models/Subscription.js';
+import type { ReportReason, ReportSourceType } from '../Models/Report.js';
+import type { BlockedUser } from '../Models/Block.js';
+import type { Activity, ActivitySummary, ActivitySearchFilters } from '../Models/Activity.js';
+import type { IntentionKey, InterestCategoryKey } from '../Models/Intention.js';
+export interface WSRequest_Handshake {
+    command: 'handshake';
+    payload: {
+        version: string;
+    };
+}
+export interface WSRequest_GetProfile {
+    command: 'get-profile';
+    payload: Record<string, never>;
+}
+export interface WSRequest_UpdateProfile {
+    command: 'update-profile';
+    payload: {
+        data: Partial<Profile>;
+    };
+}
+export interface WSRequest_GetCandidates {
+    command: 'get-candidates';
+    payload: {
+        filters?: SearchFilters;
+    };
+}
+export interface WSRequest_GetCandidateCounts {
+    command: 'get-candidate-counts';
+    payload: Record<string, never>;
+}
+export interface WSRequest_Like {
+    command: 'like';
+    payload: {
+        candidateId: string;
+    };
+}
+export interface WSRequest_Skip {
+    command: 'skip';
+    payload: {
+        candidateId: string;
+    };
+}
+export interface WSRequest_Star {
+    command: 'star';
+    payload: {
+        candidateId: string;
+    };
+}
+export interface WSRequest_Search {
+    command: 'search';
+    payload: {
+        filters: SearchFilters;
+    };
+}
+export interface WSRequest_GetConversations {
+    command: 'get-conversations';
+    payload: Record<string, never>;
+}
+export interface WSRequest_GetMessages {
+    command: 'get-messages';
+    payload: {
+        conversationId: string;
+        cursor?: string;
+        limit?: number;
+    };
+}
+export interface WSRequest_SendMessage {
+    command: 'send-message';
+    payload: {
+        conversationId: string;
+        text: string;
+    };
+}
+export interface WSRequest_GetRequests {
+    command: 'get-requests';
+    payload: Record<string, never>;
+}
+export interface WSRequest_AcceptRequest {
+    command: 'accept-request';
+    payload: {
+        senderId: string;
+    };
+}
+export interface WSRequest_DeclineRequest {
+    command: 'decline-request';
+    payload: {
+        senderId: string;
+    };
+}
+export interface WSRequest_GetNotifications {
+    command: 'get-notifications';
+    payload: Record<string, never>;
+}
+export interface WSRequest_MarkNotificationRead {
+    command: 'mark-notification-read';
+    payload: {
+        notificationId: string;
+    };
+}
+export interface WSRequest_BlockUser {
+    command: 'block-user';
+    payload: {
+        userId: string;
+    };
+}
+export interface WSRequest_ReportUser {
+    command: 'report-user';
+    payload: {
+        userId: string;
+        reason: ReportReason;
+        sourceType: ReportSourceType;
+        sourceId?: string;
+        message?: string;
+    };
+}
+export interface WSRequest_AppealSuspension {
+    command: 'appeal-suspension';
+    payload: {
+        message?: string;
+    };
+}
+export interface WSRequest_Unmatch {
+    command: 'unmatch';
+    payload: {
+        userId: string;
+    };
+}
+export interface WSRequest_GetSettings {
+    command: 'get-settings';
+    payload: Record<string, never>;
+}
+export interface WSRequest_UpdateSettings {
+    command: 'update-settings';
+    payload: {
+        data: Partial<UserSettings>;
+    };
+}
+export interface WSRequest_TagSuggest {
+    command: 'tag-suggest';
+    payload: {
+        query: string;
+        type: 'interest' | 'skill';
+        limit?: number;
+    };
+}
+export interface WSRequest_GetPreferences {
+    command: 'get-preferences';
+    payload: Record<string, never>;
+}
+export interface WSRequest_UpdatePreferences {
+    command: 'update-preferences';
+    payload: {
+        discovery?: Partial<DiscoveryPreferences>;
+        visibility?: Partial<VisibilityPreferences>;
+        syncVisibility?: boolean;
+    };
+}
+export interface WSRequest_DeleteAccount {
+    command: 'delete-account';
+    payload: {
+        confirmation: string;
+    };
+}
+export interface WSRequest_RegisterPushToken {
+    command: 'register-push-token';
+    payload: {
+        token: string;
+        provider: 'fcm';
+    };
+}
+export interface WSRequest_MarkRead {
+    command: 'mark-read';
+    payload: {
+        conversationId: string;
+    };
+}
+export interface WSRequest_GetUserProfile {
+    command: 'get-user-profile';
+    payload: {
+        userId: string;
+    };
+}
+export interface WSRequest_CreateActivity {
+    command: 'create-activity';
+    payload: {
+        title: string;
+        description: string;
+        category: InterestCategoryKey;
+        dateTime?: string;
+        locationName: string;
+        latitude?: number;
+        longitude?: number;
+        maxParticipants?: number;
+    };
+}
+export interface WSRequest_UpdateActivity {
+    command: 'update-activity';
+    payload: {
+        activityId: string;
+        data: {
+            title?: string;
+            description?: string;
+            category?: InterestCategoryKey;
+            dateTime?: string | null;
+            locationName?: string;
+            latitude?: number | null;
+            longitude?: number | null;
+            maxParticipants?: number | null;
+        };
+    };
+}
+export interface WSRequest_CancelActivity {
+    command: 'cancel-activity';
+    payload: {
+        activityId: string;
+    };
+}
+export interface WSRequest_GetActivity {
+    command: 'get-activity';
+    payload: {
+        activityId: string;
+    };
+}
+export interface WSRequest_JoinActivity {
+    command: 'join-activity';
+    payload: {
+        activityId: string;
+    };
+}
+export interface WSRequest_LeaveActivity {
+    command: 'leave-activity';
+    payload: {
+        activityId: string;
+    };
+}
+export interface WSRequest_GetActivities {
+    command: 'get-activities';
+    payload: {
+        filters?: ActivitySearchFilters;
+    };
+}
+export interface WSRequest_GetActivityCounts {
+    command: 'get-activity-counts';
+    payload: Record<string, never>;
+}
+export interface WSRequest_SearchActivities {
+    command: 'search-activities';
+    payload: {
+        filters: ActivitySearchFilters;
+    };
+}
+export interface WSRequest_ReportActivity {
+    command: 'report-activity';
+    payload: {
+        activityId: string;
+        reason: ReportReason;
+        message?: string;
+    };
+}
+export interface WSRequest_GetBlockedUsers {
+    command: 'get-blocked-users';
+    payload: Record<string, never>;
+}
+export interface WSRequest_UnblockUser {
+    command: 'unblock-user';
+    payload: {
+        userId: string;
+    };
+}
+export interface WSRequest_GetSubscription {
+    command: 'get-subscription';
+    payload: Record<string, never>;
+}
+export interface WSRequest_ValidateReceipt {
+    command: 'validate-receipt';
+    payload: {
+        receipt: string;
+        platform: SubscriptionPlatform;
+        productId: string;
+    };
+}
+export interface WSRequest_GetTokenBalance {
+    command: 'get-token-balance';
+    payload: Record<string, never>;
+}
+export interface WSRequest_SearchWithToken {
+    command: 'search-with-token';
+    payload: {
+        filters: SearchFilters;
+    };
+}
+export interface WSRequest_PreviewSearch {
+    command: 'preview-search';
+    payload: {
+        filters: SearchFilters;
+    };
+}
+export interface WSRequest_PurchaseBoost {
+    command: 'purchase-boost';
+    payload: {
+        receipt: string;
+        platform: SubscriptionPlatform;
+        boostPack: BoostPack;
+    };
+}
+export interface WSRequest_GetBoostStatus {
+    command: 'get-boost-status';
+    payload: Record<string, never>;
+}
+export type WSClientRequest = WSRequest_Handshake | WSRequest_GetProfile | WSRequest_UpdateProfile | WSRequest_GetCandidates | WSRequest_GetCandidateCounts | WSRequest_GetSubIntentionCounts | WSRequest_GetPopularTags | WSRequest_Like | WSRequest_Skip | WSRequest_Star | WSRequest_Search | WSRequest_GetConversations | WSRequest_GetMessages | WSRequest_SendMessage | WSRequest_GetRequests | WSRequest_AcceptRequest | WSRequest_DeclineRequest | WSRequest_GetNotifications | WSRequest_MarkNotificationRead | WSRequest_BlockUser | WSRequest_ReportUser | WSRequest_Unmatch | WSRequest_AppealSuspension | WSRequest_GetSettings | WSRequest_UpdateSettings | WSRequest_TagSuggest | WSRequest_GetPreferences | WSRequest_UpdatePreferences | WSRequest_DeleteAccount | WSRequest_RegisterPushToken | WSRequest_GetSubscription | WSRequest_ValidateReceipt | WSRequest_GetTokenBalance | WSRequest_SearchWithToken | WSRequest_PreviewSearch | WSRequest_PurchaseBoost | WSRequest_GetBoostStatus | WSRequest_MarkRead | WSRequest_GetUserProfile | WSRequest_CreateActivity | WSRequest_UpdateActivity | WSRequest_CancelActivity | WSRequest_GetActivity | WSRequest_JoinActivity | WSRequest_LeaveActivity | WSRequest_GetActivities | WSRequest_GetActivityCounts | WSRequest_SearchActivities | WSRequest_ReportActivity | WSRequest_GetBlockedUsers | WSRequest_UnblockUser;
+export type WSClientCommand = WSClientRequest['command'];
+export interface WSResponse_Handshake {
+    command: 'handshake';
+    payload: {
+        success: boolean;
+        serverVersion: string;
+    };
+}
+export interface WSResponse_GetProfile {
+    command: 'get-profile';
+    payload: {
+        user: Profile;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_UpdateProfile {
+    command: 'update-profile';
+    payload: {
+        user: Profile;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetCandidates {
+    command: 'get-candidates';
+    payload: {
+        candidates: MatchCandidate[];
+        totalAvailable: number;
+        swipesRemaining: number;
+        dailySwipeLimit: number;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetCandidateCounts {
+    command: 'get-candidate-counts';
+    payload: {
+        counts: Record<string, number>;
+    } | {
+        error: string;
+    };
+}
+export interface WSRequest_GetSubIntentionCounts {
+    command: 'get-subintention-counts';
+    payload: {
+        intention: IntentionKey;
+    };
+}
+export interface WSResponse_GetSubIntentionCounts {
+    command: 'get-subintention-counts';
+    payload: {
+        counts: Record<string, number>;
+    } | {
+        error: string;
+    };
+}
+export interface WSRequest_GetPopularTags {
+    command: 'get-popular-tags';
+    payload: {
+        intention: IntentionKey;
+        subCategories: string[];
+    };
+}
+export interface WSResponse_GetPopularTags {
+    command: 'get-popular-tags';
+    payload: {
+        tags: string[];
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_Like {
+    command: 'like';
+    payload: {
+        matched: boolean;
+        conversationId?: string;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_Skip {
+    command: 'skip';
+    payload: {
+        success: boolean;
+    };
+}
+export interface WSResponse_Star {
+    command: 'star';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_Search {
+    command: 'search';
+    payload: {
+        results: MatchCandidate[];
+        tokensRemaining: number;
+        totalCount: number;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetConversations {
+    command: 'get-conversations';
+    payload: {
+        conversations: Conversation[];
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetMessages {
+    command: 'get-messages';
+    payload: {
+        messages: Message[];
+        hasMore: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_SendMessage {
+    command: 'send-message';
+    payload: {
+        message: Message;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetRequests {
+    command: 'get-requests';
+    payload: {
+        requests: MatchRequest[];
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_AcceptRequest {
+    command: 'accept-request';
+    payload: {
+        conversationId: string;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_DeclineRequest {
+    command: 'decline-request';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetNotifications {
+    command: 'get-notifications';
+    payload: {
+        notifications: Notification[];
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_MarkNotificationRead {
+    command: 'mark-notification-read';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_BlockUser {
+    command: 'block-user';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_ReportUser {
+    command: 'report-user';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_AppealSuspension {
+    command: 'appeal-suspension';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_Unmatch {
+    command: 'unmatch';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetSettings {
+    command: 'get-settings';
+    payload: {
+        settings: UserSettings;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_UpdateSettings {
+    command: 'update-settings';
+    payload: {
+        settings: UserSettings;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_TagSuggest {
+    command: 'tag-suggest';
+    payload: {
+        suggestions: TagSuggestion[];
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetPreferences {
+    command: 'get-preferences';
+    payload: {
+        discovery: DiscoveryPreferences;
+        visibility: VisibilityPreferences;
+        syncVisibility: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_UpdatePreferences {
+    command: 'update-preferences';
+    payload: {
+        discovery: DiscoveryPreferences;
+        visibility: VisibilityPreferences;
+        syncVisibility: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_DeleteAccount {
+    command: 'delete-account';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_RegisterPushToken {
+    command: 'register-push-token';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetSubscription {
+    command: 'get-subscription';
+    payload: {
+        subscription: UserSubscription | null;
+        isPremium: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_ValidateReceipt {
+    command: 'validate-receipt';
+    payload: {
+        subscription: UserSubscription;
+        isPremium: boolean;
+        boost: UserBoost;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetTokenBalance {
+    command: 'get-token-balance';
+    payload: {
+        balance: TokenBalance;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_SearchWithToken {
+    command: 'search-with-token';
+    payload: {
+        results: MatchCandidate[];
+        tokensRemaining: number;
+        totalCount: number;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_PreviewSearch {
+    command: 'preview-search';
+    payload: {
+        results: MatchCandidate[];
+        totalCount: number;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_PurchaseBoost {
+    command: 'purchase-boost';
+    payload: {
+        boost: UserBoost;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetBoostStatus {
+    command: 'get-boost-status';
+    payload: {
+        boost: UserBoost;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_MarkRead {
+    command: 'mark-read';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetUserProfile {
+    command: 'get-user-profile';
+    payload: {
+        candidate: MatchCandidate;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_CreateActivity {
+    command: 'create-activity';
+    payload: {
+        activity: Activity;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_UpdateActivity {
+    command: 'update-activity';
+    payload: {
+        activity: Activity;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_CancelActivity {
+    command: 'cancel-activity';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetActivity {
+    command: 'get-activity';
+    payload: {
+        activity: Activity;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_JoinActivity {
+    command: 'join-activity';
+    payload: {
+        activity: Activity;
+        conversationId: string;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_LeaveActivity {
+    command: 'leave-activity';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetActivities {
+    command: 'get-activities';
+    payload: {
+        activities: ActivitySummary[];
+        totalCount: number;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetActivityCounts {
+    command: 'get-activity-counts';
+    payload: {
+        counts: Record<string, number>;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_SearchActivities {
+    command: 'search-activities';
+    payload: {
+        activities: ActivitySummary[];
+        totalCount: number;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_ReportActivity {
+    command: 'report-activity';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_GetBlockedUsers {
+    command: 'get-blocked-users';
+    payload: {
+        blockedUsers: BlockedUser[];
+    } | {
+        error: string;
+    };
+}
+export interface WSResponse_UnblockUser {
+    command: 'unblock-user';
+    payload: {
+        success: boolean;
+    } | {
+        error: string;
+    };
+}
+export type WSServerResponse = WSResponse_Handshake | WSResponse_GetProfile | WSResponse_UpdateProfile | WSResponse_GetCandidates | WSResponse_GetCandidateCounts | WSResponse_GetSubIntentionCounts | WSResponse_GetPopularTags | WSResponse_Like | WSResponse_Skip | WSResponse_Star | WSResponse_Search | WSResponse_GetConversations | WSResponse_GetMessages | WSResponse_SendMessage | WSResponse_GetRequests | WSResponse_AcceptRequest | WSResponse_DeclineRequest | WSResponse_GetNotifications | WSResponse_MarkNotificationRead | WSResponse_BlockUser | WSResponse_ReportUser | WSResponse_Unmatch | WSResponse_AppealSuspension | WSResponse_GetSettings | WSResponse_UpdateSettings | WSResponse_TagSuggest | WSResponse_GetPreferences | WSResponse_UpdatePreferences | WSResponse_DeleteAccount | WSResponse_RegisterPushToken | WSResponse_GetSubscription | WSResponse_ValidateReceipt | WSResponse_GetTokenBalance | WSResponse_SearchWithToken | WSResponse_PreviewSearch | WSResponse_PurchaseBoost | WSResponse_GetBoostStatus | WSResponse_CreateActivity | WSResponse_UpdateActivity | WSResponse_CancelActivity | WSResponse_GetActivity | WSResponse_JoinActivity | WSResponse_LeaveActivity | WSResponse_GetActivities | WSResponse_GetActivityCounts | WSResponse_SearchActivities | WSResponse_ReportActivity | WSResponse_MarkRead | WSResponse_GetUserProfile | WSResponse_GetBlockedUsers | WSResponse_UnblockUser;
+export interface WSEvent_NewMessage {
+    event: 'new-message';
+    payload: {
+        conversationId: string;
+        message: Message;
+    };
+}
+export interface WSEvent_NewMatch {
+    event: 'new-match';
+    payload: {
+        conversationId: string;
+        participant: Profile;
+    };
+}
+export interface WSEvent_Notification {
+    event: 'notification';
+    payload: {
+        notification: Notification;
+    };
+}
+export interface WSEvent_MarkRead {
+    event: 'mark-read';
+    payload: {
+        conversationId: string;
+    };
+}
+export interface WSEvent_Suspended {
+    event: 'suspended';
+    payload: Record<string, never>;
+}
+export type WSServerEvent = WSEvent_NewMessage | WSEvent_NewMatch | WSEvent_Notification | WSEvent_MarkRead | WSEvent_Suspended;
+export interface WSEnvelope<T = WSClientRequest | WSServerResponse | WSServerEvent> {
+    id: string;
+    timestamp: number;
+    data: T;
+}