@only-chat/types 0.2.0-beta.10

package/README.md

@@ -0,0 +1,2 @@
+# only-chat
+TypeScript definitions for only-chat

package/index.d.ts

@@ -0,0 +1,4 @@
+export type * as Log from './log.d.ts'
+export type * as Queue from './queue.js'
+export type * as Store from './store.js'
+export type * as Transport from './transport.ts'

package/log.d.ts

@@ -0,0 +1,8 @@
+export interface Log {
+    debug(message?: any, ...optionalParams: any[]): void
+    error(message?: any, ...optionalParams: any[]): void
+    info(message?: any, ...optionalParams: any[]): void
+    log(message?: any, ...optionalParams: any[]): void
+    trace(message?: any, ...optionalParams: any[]): void
+    warn(message?: any, ...optionalParams: any[]): void
+}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@only-chat/types",
+  "version": "0.2.0-beta.10",
+  "description": "TypeScript definitions for only-chat",
+  "homepage": "https://github.com/only-chat/node-backend/packages/types",
+  "main": "",
+  "types": "index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/only-chat/node-backend.git",
+    "directory": "packages/types"
+  },
+  "scripts": {},
+  "author": "only-chat",
+  "license": "MIT",
+  "dependencies": {
+    "@types/node": "^22.7.4"
+  },
+  "keywords": [
+    "only-chat",
+    "type"
+  ]
+}

package/queue.d.ts

@@ -0,0 +1,54 @@
+export interface ConversationUpdate {
+    conversationId?: string
+    title?: string
+    participants?: string[]
+    closedAt?: Date
+    deletedAt?: Date
+    updatedAt?: Date
+}
+
+export interface FileMessage {
+    link: string
+    name: string
+    type: string
+    size: number
+}
+
+export interface TextMessage {
+    text: string
+}
+
+export interface MessageDelete {
+    messageId: string
+}
+
+export interface MessageUpdate extends Partial<FileMessage>, Partial<TextMessage> {
+    messageId: string
+    updatedAt: Date
+}
+
+export type MessageType = 'connected' | 'disconnected' | 'joined' | 'left' | 'closed' | 'deleted' | 'loaded' | 'updated' | 'message-updated' | 'message-deleted' | 'text' | 'file'
+
+export type MessageData = ConversationUpdate | FileMessage | MessageDelete | MessageUpdate | TextMessage | null
+
+export interface Message {
+    type: MessageType
+    id?: string
+    clientMessageId?: string  
+    instanceId: string
+    conversationId?: string
+    participants?: string[]
+    connectionId: string
+    fromId: string
+    data: MessageData
+    createdAt: Date
+    updatedAt?: Date
+    deletedAt?: Date
+}
+
+export interface MessageQueue {
+    acceptTypes?: MessageType[]
+    publish: (msg: Message) => Promise<boolean>
+    subscribe: (callback: (msg: Message) => Promise<void>) => Promise<boolean>
+    unsubscribe?: (callback: (msg: Message) => Promise<void>) => Promise<boolean>
+}

package/store.d.ts

@@ -0,0 +1,114 @@
+export interface Connection {
+    id?: string
+    instanceId: string
+    timestamp: Date
+    userId: string
+}
+
+export interface Conversation {
+    id?: string
+    title?: string
+    participants: string[]
+    createdBy: string
+    createdAt: Date
+    updatedAt?: Date
+    closedAt?: Date
+    deletedAt?: Date
+}
+
+export interface ConversationUpdate {
+    conversationId?: string
+    title?: string
+    participants?: string[]
+    closedAt?: Date
+    deletedAt?: Date
+    updatedAt?: Date
+}
+
+export interface FileMessage {
+    link: string
+    name: string
+    type: string
+    size: number
+}
+
+export interface TextMessage {
+    text: string
+}
+
+export interface MessageDelete {
+    messageId: string
+}
+
+export interface MessageUpdate extends Partial<FileMessage>, Partial<TextMessage> {
+    messageId: string
+    updatedAt: Date
+}
+
+export interface FindRequest {
+    from?: number
+    size?: number
+    sort?: string
+    sortDesc?: boolean
+    ids?: string[]
+    clientMessageIds?: string[]
+    excludeIds?: string[]
+    conversationIds?: string[]
+    fromIds?: string[]
+    types?: MessageType[]
+    createdFrom?: Date
+    createdTo?: Date
+    text?: string
+}
+
+export interface FindResult {
+    messages: Message[]
+    from: number
+    size: number
+    total: number
+}
+
+export type MessageType = 'joined' | 'left' | 'closed' | 'deleted' | 'updated' | 'message-updated' | 'message-deleted' | 'text' | 'file'
+
+export type MessageData = ConversationUpdate | FileMessage | MessageDelete | MessageUpdate | TextMessage | null
+
+export interface Message {
+    type: MessageType
+    id?: string
+    clientMessageId?: string
+    conversationId?: string
+    participants?: string[]
+    connectionId: string
+    fromId: string
+    data: MessageData
+    createdAt: Date
+    updatedAt?: Date
+    deletedAt?: Date
+}
+
+export interface SaveResponse {
+    _id: string
+    result: string
+}
+
+export type ConversationLastMessages = Record<string, { latest?: Message, left?: Date }>
+
+export interface ConversationsResult {
+    conversations: Conversation[]
+    from: number
+    size: number
+    total: number
+}
+
+export interface MessageStore {
+    findMessages: (r: FindRequest) => Promise<FindResult>
+    getConversationById: (id: string) => Promise<Conversation | undefined>
+    getLastMessagesTimestamps: (fromId: string, conversationId: string[]) => Promise<ConversationLastMessages>
+    getParticipantConversationById: (participant: string | undefined, id: string) => Promise<Conversation | undefined>
+    getParticipantConversations: (participant: string, excludeIds: string[], from: number, size: number) => Promise<ConversationsResult>
+    getParticipantLastMessage: (participant: string, conversationId: string) => Promise<Message | undefined>
+    getPeerToPeerConversationId(peer1: string, peer2: string): Promise<string | undefined>
+    saveConnection: (userId: string, instanceId: string) => Promise<SaveResponse>
+    saveConversation: (c: Conversation) => Promise<SaveResponse>
+    saveMessage: (m: Message) => Promise<SaveResponse>
+}

package/transport.d.ts

@@ -0,0 +1,22 @@
+import { EventEmitter } from 'events'
+
+export declare enum TransportState {
+    /** The connection is not yet open. */
+    CONNECTING = 0,
+    /** The connection is open and ready to communicate. */
+    OPEN = 1,
+    /** The connection is in the process of closing. */
+    CLOSING = 2,
+    /** The connection is closed. */
+    CLOSED = 3
+}
+
+export interface Transport extends EventEmitter {
+    readonly readyState: TransportState
+
+    close(code?: number, data?: string | Buffer): void
+    send(data: string, options: {
+        binary?: boolean | undefined
+        fin?: boolean | undefined
+    },): void
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "NodeNext",
+    "lib": [
+      "ESNext"
+    ],
+  },
+}

package/userStore.d.ts

@@ -0,0 +1,11 @@
+export interface AuthenticationInfo {}
+
+export interface UserStore {
+    /**
+     * Verifies provided user credentials
+     * 
+     * @param authInfo User credentials
+     * @returns User identifier
+     */
+    authenticate(authInfo: AuthenticationInfo): Promise<string | undefined>
+}