docpouch-client 0.8.14 → 0.8.15

package/src/index.ts

@@ -1,532 +1,665 @@
-import {io, Socket} from "socket.io-client";
-import packetJson from '../package.json'
-
-/**
- * Client for interacting with docPouch API.
- */
-export default class docPouchClient {
-    /**
-     * The base URL of the server.
-     *
-     * @type {string}
-     */
-    baseUrl: string;
-    /**
-     * Socket.IO socket instance for real-time communication with the server.
-     *
-     * @type {Socket}
-     */
-    socket: Socket;
-    /**
-     * Callback function to handle socket events.
-     *
-     * @type {(event: I_EventString, data: I_WsMessage) => void}
-     */
-    callbackFunction;
-    /**
-     * Flag indicating whether real-time synchronization is enabled.
-     *
-     * @type {boolean}
-     */
-    realTimeSync: boolean = false;
-    /**
-     * Authentication token used to authorize requests.
-     *
-     * @private
-     * @type {string | null}
-     */
-    private authToken: string | null = null;
-    /**
-     * Flag indicating whether a connection attempt is in progress.
-     *
-     * @private
-     * @type {boolean}
-     */
-    private connectionInProgress = false;
-
-    /**
-     * Creates an instance of docPouchClient.
-     *
-     * @param {string} host - The base URL for the server.
-     * @param {number} [port=80] - The port number to connect to (default is 80).
-     * @param {(event: I_EventString, data: I_WsMessage) => void} [callback] - Optional callback function for socket events.
-     */
-    constructor(host: string, port: number = 80, callback?: (event: I_EventString, data: I_WsMessage) => void) {
-        this.baseUrl = host;
-        const socketUrl = host.includes('://') ? host : `https://${host}`;
-        const socketUrlWithPort = socketUrl.includes(':') && !socketUrl.endsWith(':')
-            ? socketUrl
-            : `${socketUrl}:${port}`;
-
-        console.log(`Initializing Socket.IO with URL: ${socketUrlWithPort}, path: /socket.io`);
-
-        this.socket = io(`${socketUrlWithPort}`, {
-            autoConnect: false,
-            transports: ['websocket'],  // Try websocket only first
-            reconnection: true,
-            reconnectionAttempts: 5,
-            reconnectionDelay: 1000,
-            forceNew: true,  // Force a new connection
-            auth: {
-                token: null  // Will be set later
-            },
-            path: '/socket.io'
-        });
-
-        this.callbackFunction = callback;
-
-        this.setupPermanentSocketListeners();
-    }
-
-    /**
-     * Sets the real-time synchronization status.
-     *
-     * @param {boolean} newRealTimeSync - The new real-time sync setting (true/false).
-     */
-    setRealTimeSync(newRealTimeSync: boolean) {
-        console.log(`Setting realtime sync to: ${newRealTimeSync}. Current setting: ${this.realTimeSync}`);
-
-        // Skip if the setting isn't changing
-        if (newRealTimeSync === this.realTimeSync) {
-            console.log("Realtime sync setting unchanged, skipping");
-            return;
-        }
-
-        this.realTimeSync = newRealTimeSync;
-
-        if (newRealTimeSync && this.authToken) {
-            console.log("Activating realtime updates");
-
-            // Ensure we're not in the middle of another connection attempt
-            if (this.connectionInProgress) {
-                console.log("Connection already in progress, waiting before initializing");
-                setTimeout(() => this.initWebSocket(), 500);
-            } else {
-                this.initWebSocket();
-            }
-        } else if (!newRealTimeSync) {
-            console.log("Deactivating realtime updates");
-            if (this.socket.connected) {
-                console.log("Disconnecting socket");
-                this.socket.disconnect();
-            }
-        }
-    }
-
-    // User Administration Endpoints
-    async login(credentials: I_UserLogin): Promise<I_LoginResponse | null> {
-        const response = await this.request<I_LoginResponse>('/users/login', 'POST', credentials, false);
-        if (response.token) {
-            this.authToken = response.token;
-
-            // Reconnect websocket with new token if realtime sync is enabled
-            if (this.realTimeSync) {
-                this.initWebSocket();
-            }
-
-            return {token: response.token, isAdmin: response.isAdmin, userName: response.userName};
-        }
-        return null;
-    }
-
-    async listUsers(): Promise<I_UserEntry[]> {
-        return await this.request<I_UserEntry[]>('/users/list', 'GET');
-    }
-
-    async updateUser(userID: string, userData: I_UserUpdate): Promise<void> {
-        await this.request<void>(`/users/update/${userID}`, 'PATCH', userData);
-    }
-
-    async createUser(userData: I_UserCreation): Promise<I_UserDisplay> {
-        return await this.request<I_UserDisplay>('/users/create', 'POST', userData);
-    }
-
-    async removeUser(userID: string): Promise<void> {
-        await this.request<void>(`/users/remove/${userID}`, 'DELETE');
-    }
-
-    // Document Management Endpoints
-    async createDocument(document: I_DocumentEntry): Promise<I_DocumentEntry> {
-        return await this.request<I_DocumentEntry>('/docs/create', 'POST', document);
-    }
-
-    async listDocuments(): Promise<I_DocumentEntry[]> {
-        return await this.request<I_DocumentEntry[]>('/docs/list', 'GET');
-    }
-
-    async fetchDocuments(queryObject: I_DocumentQuery): Promise<I_DocumentEntry[]> {
-        return await this.request<I_DocumentEntry[]>(`/docs/fetch/`, 'POST', queryObject);
-    }
-
-    async updateDocument(documentID: string, documentData: I_DocumentEntry): Promise<void> {
-        await this.request<void>(`/docs/update/${documentID}`, 'PATCH', documentData);
-    }
-
-    async removeDocument(documentID: string): Promise<void> {
-        await this.request<void>(`/docs/remove/${documentID}`, 'DELETE');
-    }
-
-    // Data Structure Endpoints
-    async createStructure(structure: I_StructureCreation): Promise<I_DataStructure> {
-        return await this.request<I_DataStructure>('/structures/create', 'POST', structure);
-    }
-
-    async getStructures(): Promise<I_DataStructure[]> {
-        return await this.request<I_DataStructure[]>('/structures/list', 'GET');
-    }
-
-    async updateStructure(structureID: string, structureData: I_DataStructure): Promise<void> {
-        await this.request<void>(`/structures/update/${structureID}`, 'PATCH', structureData);
-    }
-
-    async removeStructure(structureID: string): Promise<void> {
-        await this.request<void>(`/structures/remove/${structureID}`, 'DELETE');
-    }
-
-    // Data Type Endpoints
-    async createType(type: I_DocumentType): Promise<I_DocumentType> {
-        return await this.request<I_DocumentType>('/types/write', 'POST', type);
-    }
-
-    async removeType(typeID: string) {
-        return await this.request<void>(`/types/remove/${typeID}`, 'DELETE');
-    }
-
-    async getTypes(): Promise<I_DocumentType[]> {
-        return await this.request<I_DocumentType[]>('/types/list', 'GET');
-    }
-
-    async updateType(updatedType: I_DocumentType): Promise<void> {
-        await this.request<void>(`/types/write`, 'POST', updatedType);
-    }
-
-    setToken(token: string | null): void {
-        console.log("Setting token to:", token ? "***token***" : "null");
-
-        const tokenChanged = this.authToken !== token;
-        this.authToken = token;
-
-        if (!tokenChanged) {
-            console.log("Token unchanged, no need to reconnect");
-            return;
-        }
-
-        // If we have a new token and realtime sync is enabled
-        if (token && this.realTimeSync) {
-            console.log("New token set, will initialize WebSocket");
-
-            // Ensure any existing connection is closed first
-            if (this.socket.connected) {
-                console.log("Disconnecting existing socket before reconnecting with new token");
-                this.socket.disconnect();
-            }
-
-            // Wait a moment for the disconnect to complete
-            setTimeout(() => {
-                console.log("Initializing WebSocket with new token");
-                this.initWebSocket();
-            }, 300);
-        }
-        // If token was cleared or realtime sync is disabled
-        else if (this.socket.connected) {
-            console.log("Token cleared or realtime sync disabled, disconnecting");
-            this.socket.disconnect();
-        }
-    }
-
-    getVersion() {
-        return packetJson.version;
-    }
-
-    debugSocketConnection(): void {
-        console.log("Socket connection debug info:");
-        console.log("- Connected:", this.socket.connected);
-        console.log("- Socket ID:", this.socket.id);
-        console.log("- Auth token present:", !!this.authToken);
-        console.log("- Connection in progress:", this.connectionInProgress);
-        console.log("- Realtime sync enabled:", this.realTimeSync);
-        console.log("- Socket options:", this.socket.io.opts);
-
-        // Try to force reconnection
-        if (!this.socket.connected && this.authToken && this.realTimeSync) {
-            console.log("Attempting to force reconnection...");
-            this.socket.auth = {token: this.authToken};
-            this.socket.connect();
-        }
-    }
-
-    /**
-     * Sets up permanent socket listeners for the client.
-     *
-     * @private
-     */
-    private setupPermanentSocketListeners() {
-        // These are permanent listeners that won't be removed
-        this.socket.on('connect_error', (error) => {
-            console.error('Socket connection error:', error.message);
-            this.connectionInProgress = false;
-        });
-
-        this.socket.on('connect', () => {
-            console.log('Socket connected successfully with ID:', this.socket.id);
-            this.connectionInProgress = false;
-        });
-
-        this.socket.on('disconnect', (reason) => {
-            console.log('Socket disconnected. Reason:', reason);
-            this.connectionInProgress = false;
-        });
-
-        this.socket.on('error', (error) => {
-            console.error('Socket error:', error);
-            this.connectionInProgress = false;
-        });
-    }
-
-    /**
-     * Initializes the WebSocket connection with the server.
-     *
-     * @private
-     */
-    private initWebSocket() {
-        console.log("initWebSocket called. Auth token present:", !!this.authToken,
-            "Connection in progress:", this.connectionInProgress,
-            "Socket connected:", this.socket.connected);
-
-        if (!this.authToken) {
-            console.log("Skipping WebSocket initialization: No auth token");
-            return;
-        }
-
-        if (this.connectionInProgress) {
-            console.log("Connection already in progress, skipping initialization");
-            return;
-        }
-
-        if (this.socket.connected) {
-            console.log("Socket already connected with ID:", this.socket.id);
-            return;
-        }
-
-        this.connectionInProgress = true;
-
-        try {
-            console.log("Setting up WebSocket connection with token");
-
-            // Update the auth token
-            this.socket.auth = {token: this.authToken};
-
-            // Remove any dynamic event listeners that might have been added
-            this.socket.offAny();
-
-            // Set up event handler for application events
-            this.socket.onAny((event: I_EventString, data: I_WsMessage) => {
-                if (event === "heartbeatPing") {
-                    console.log("Ping event received:", data);
-                    this.socket.emit("heartbeatPong", Date.now());
-                } else if (this.callbackFunction) {
-                    this.callbackFunction(event, data);
-                }
-            });
-
-            // Connect to the server
-            console.log("Connecting socket with auth token");
-            this.socket.connect();
-
-            // Add a timeout to detect if connection is taking too long
-            setTimeout(() => {
-                if (this.connectionInProgress) {
-                    console.warn("Socket connection attempt timed out after 5 seconds");
-                    this.connectionInProgress = false;
-
-                    // If we're still not connected after the timeout, try again with polling
-                    if (!this.socket.connected) {
-                        console.log("Retrying connection with polling transport");
-                        this.socket.io.opts.transports = ['polling', 'websocket'];
-                        this.socket.connect();
-                    }
-                }
-            }, 5000);
-        } catch (error) {
-            console.error('Error in initWebSocket:', error);
-            this.connectionInProgress = false;
-        }
-    }
-
-    private async request<T>(endpoint: string, method: string, body?: any, requiresAuth: boolean = true): Promise<T> {
-        const headers: HeadersInit = {
-            'Content-Type': 'application/json',
-        };
-
-        if (requiresAuth && this.authToken)
-            headers['Authorization'] = `Bearer ${this.authToken}`;
-        if (this.socket.id)
-            headers['X-Socket-ID'] = this.socket.id;
-
-        const options: RequestInit = {
-            method,
-            headers,
-            body: body ? JSON.stringify(body) : undefined
-        };
-
-        const normalizedEndpoint = endpoint.startsWith('/') ? endpoint : `/${endpoint}`;
-        const normalizedBaseUrl = this.baseUrl.endsWith('/') ? this.baseUrl.slice(0, -1) : this.baseUrl;
-        const url = `${normalizedBaseUrl}${normalizedEndpoint}`;
-        const response = await fetch(url, options);
-
-        if (!response.ok) {
-            if (response.status === 401 || response.status === 403) {
-                this.authToken = null;
-            }
-            throw new Error(`API error: ${response.status} ${response.statusText}`);
-        }
-
-        return await response.json() as T;
-    }
-}
-
-// Common type definitions for both frontend and backend
-
-// User related types
-export interface I_UserEntry extends I_UserCreation {
-    _id: string;
-}
-
-export interface I_UserLogin {
-    name: string;
-    password: string;
-}
-
-export interface I_UserCreation {
-    name: string;
-    password: string;
-    email?: string;
-    department: string;
-    group: string;
-    isAdmin: boolean;
-}
-
-export interface I_UserUpdate {
-    _id?: string;
-    name?: string;
-    password?: string;
-    email?: string;
-    department?: string;
-    group?: string;
-    isAdmin?: boolean;
-}
-
-export interface I_UserDisplay {
-    _id: string;
-    username: string;
-    department: string;
-    group: string;
-    email?: string;
-}
-
-export interface I_LoginResponse {
-    token: string;
-    isAdmin: boolean;
-    userName: string;
-}
-
-// Document related types
-export interface I_DocumentEntry extends I_DocumentCreationOwned {
-    _id: string;
-}
-
-export interface I_DocumentCreation {
-    title: string;
-    description?: string;
-    type: number;
-    subType: number;
-    content: any;
-    shareWithGroup: boolean;
-    shareWithDepartment: boolean;
-}
-
-
-export interface I_DocumentCreationOwned extends I_DocumentCreation {
-    owner: string;
-}
-
-export interface I_DocumentUpdate extends I_DocumentQuery {
-    content?: any;
-    description?: string;
-}
-
-export interface I_DocumentQuery {
-    _id?: string;
-    owner?: string;
-    title?: string;
-    type?: number;
-    subType?: number;
-    shareWithGroup?: boolean;
-    shareWithDepartment?: boolean;
-}
-
-
-// Structure related types
-export interface I_DataStructure {
-    _id?: string | undefined;
-    name: string;
-    description: string;
-    fields: I_StructureField[];
-}
-
-export interface I_StructureField {
-    name: string;
-    type: string;
-    items?: string;
-}
-
-export interface I_StructureEntry {
-    _id?: string;
-    name: string;
-    description: string;
-    fields: I_StructureField[];
-}
-
-
-export interface I_StructureCreation {
-    name: string;
-    description?: string;
-    fields: I_StructureField[];
-}
-
-export interface I_StructureUpdate {
-    _id?: string
-    name?: string;
-    description?: string;
-    fields?: I_StructureField[];
-}
-
-// Document type related types
-export interface I_DocumentType {
-    _id?: string;
-    type: number;
-    subType: number;
-    name: string;
-    description?: string;
-    defaultStructureID?: string;
-}
-
-// WebSocket-related types
-export type I_EventString = 'heartbeatPong' | "heartbeatPing" | "newDocument" | "newStructure" |
-    "newUser" | "newType" | "removedID" | "changedDocument" | "changedStructure" | "changedUser" | "changedType" |
-    "removedUser" | "removedStructure" | "removedDocument" | "removedType";
-
-export interface I_WsMessage {
-    newDocument?: I_DocumentEntry;
-    newStructure?: I_StructureEntry;
-    newUser?: I_UserEntry;
-    removedID?: string;
-    changedDocument?: I_DocumentUpdate;
-    changedStructure?: I_StructureUpdate;
-    changedUser?: I_UserUpdate;
-    confirmSubscription?: boolean;
-    confirmUnsubscription?: boolean;
-    heartbeatPing?: number;
-    heartbeatPong?: number;
-    newType?: I_DocumentType;
-}
+import {io, Socket} from "socket.io-client";
+import packetJson from '../package.json'
+
+/**
+ * Client for interacting with docPouch API.
+ */
+export default class docPouchClient {
+    /**
+     * The base URL of the server.
+     *
+     * @type {string}
+     */
+    baseUrl: string;
+    /**
+     * Socket.IO socket instance for real-time communication with the server.
+     *
+     * @type {Socket}
+     */
+    socket: Socket;
+    /**
+     * Callback function to handle socket events.
+     *
+     * @type {(event: I_EventString, data: I_WsMessage) => void}
+     */
+    callbackFunction;
+    /**
+     * Flag indicating whether real-time synchronization is enabled.
+     *
+     * @type {boolean}
+     */
+    realTimeSync: boolean = false;
+    /**
+     * Authentication token used to authorize requests.
+     *
+     * @private
+     * @type {string | null}
+     */
+    private authToken: string | null = null;
+    /**
+     * Flag indicating whether a connection attempt is in progress.
+     *
+     * @private
+     * @type {boolean}
+     */
+    private connectionInProgress = false;
+
+    /**
+     * Creates an instance of docPouchClient.
+     *
+     * @param {string} host - The base URL for the server.
+     * @param {number} [port=80] - The port number to connect to (default is 80).
+     * @param {(event: I_EventString, data: I_WsMessage) => void} [callback] - Optional callback function for socket events.
+     */
+    constructor(host: string, port: number = 80, callback?: (event: I_EventString, data: I_WsMessage) => void) {
+        this.baseUrl = host;
+        const socketUrl = host.includes('://') ? host : `https://${host}`;
+        const socketUrlWithPort = socketUrl.includes(':') && !socketUrl.endsWith(':')
+            ? socketUrl
+            : `${socketUrl}:${port}`;
+
+        console.log(`Initializing Socket.IO with URL: ${socketUrlWithPort}, path: /socket.io`);
+
+        this.socket = io(`${socketUrlWithPort}`, {
+            autoConnect: false,
+            transports: ['websocket'],  // Try websocket only first
+            reconnection: true,
+            reconnectionAttempts: 5,
+            reconnectionDelay: 1000,
+            forceNew: true,  // Force a new connection
+            auth: {
+                token: null  // Will be set later
+            },
+            path: '/socket.io'
+        });
+
+        this.callbackFunction = callback;
+
+        this.setupPermanentSocketListeners();
+    }
+
+    /**
+     * Sets the real-time synchronization status.
+     *
+     * @param {boolean} newRealTimeSync - The new real-time sync setting (true/false).
+     */
+    setRealTimeSync(newRealTimeSync: boolean) {
+        console.log(`Setting realtime sync to: ${newRealTimeSync}. Current setting: ${this.realTimeSync}`);
+
+        // Skip if the setting isn't changing
+        if (newRealTimeSync === this.realTimeSync) {
+            console.log("Realtime sync setting unchanged, skipping");
+            return;
+        }
+
+        this.realTimeSync = newRealTimeSync;
+
+        if (newRealTimeSync && this.authToken) {
+            console.log("Activating realtime updates");
+
+            // Ensure we're not in the middle of another connection attempt
+            if (this.connectionInProgress) {
+                console.log("Connection already in progress, waiting before initializing");
+                setTimeout(() => this.initWebSocket(), 500);
+            } else {
+                this.initWebSocket();
+            }
+        } else if (!newRealTimeSync) {
+            console.log("Deactivating realtime updates");
+            if (this.socket.connected) {
+                console.log("Disconnecting socket");
+                this.socket.disconnect();
+            }
+        }
+    }
+
+    // User Administration Endpoints
+    /**
+     * Authenticates a user and stores the returned token for subsequent requests.
+     *
+     * @param {I_UserLogin} credentials - Username and password credentials.
+     * @returns {Promise<I_LoginResponse | null>} Login payload when successful, otherwise null.
+     */
+    async login(credentials: I_UserLogin): Promise<I_LoginResponse | null> {
+        const response = await this.request<I_LoginResponse>('/users/login', 'POST', credentials, false);
+        if (response.token) {
+            this.authToken = response.token;
+
+            // Reconnect websocket with new token if realtime sync is enabled
+            if (this.realTimeSync) {
+                this.initWebSocket();
+            }
+
+            return {token: response.token, isAdmin: response.isAdmin, userName: response.userName};
+        }
+        return null;
+    }
+
+    /**
+     * Retrieves all users visible to the authenticated user.
+     *
+     * @returns {Promise<I_UserEntry[]>} A list of user entries.
+     */
+    async listUsers(): Promise<I_UserEntry[]> {
+        return await this.request<I_UserEntry[]>('/users/list', 'GET');
+    }
+
+    /**
+     * Updates a user by ID.
+     *
+     * @param {string} userID - The ID of the user to update.
+     * @param {I_UserUpdate} userData - Partial user fields to update.
+     * @returns {Promise<void>}
+     */
+    async updateUser(userID: string, userData: I_UserUpdate): Promise<void> {
+        await this.request<void>(`/users/update/${userID}`, 'PATCH', userData);
+    }
+
+    /**
+     * Creates a new user.
+     *
+     * @param {I_UserCreation} userData - Data used to create the user.
+     * @returns {Promise<I_UserDisplay>} The created user payload returned by the API.
+     */
+    async createUser(userData: I_UserCreation): Promise<I_UserDisplay> {
+        return await this.request<I_UserDisplay>('/users/create', 'POST', userData);
+    }
+
+    /**
+     * Removes a user by ID.
+     *
+     * @param {string} userID - The ID of the user to remove.
+     * @returns {Promise<void>}
+     */
+    async removeUser(userID: string): Promise<void> {
+        await this.request<void>(`/users/remove/${userID}`, 'DELETE');
+    }
+
+    // Document Management Endpoints
+    /**
+     * Creates a new document.
+     *
+     * @param {I_DocumentEntry} document - The document payload to create.
+     * @returns {Promise<I_DocumentEntry>} The created document.
+     */
+    async createDocument(document: I_DocumentEntry): Promise<I_DocumentEntry> {
+        return await this.request<I_DocumentEntry>('/docs/create', 'POST', document);
+    }
+
+    /**
+     * Retrieves all documents visible to the authenticated user.
+     *
+     * @returns {Promise<I_DocumentEntry[]>} A list of document entries.
+     */
+    async listDocuments(): Promise<I_DocumentEntry[]> {
+        return await this.request<I_DocumentEntry[]>('/docs/list', 'GET');
+    }
+
+    /**
+     * Fetches documents matching a query object.
+     *
+     * @param {I_DocumentQuery} queryObject - Query fields used for filtering.
+     * @returns {Promise<I_DocumentEntry[]>} Matching documents.
+     */
+    async fetchDocuments(queryObject: I_DocumentQuery): Promise<I_DocumentEntry[]> {
+        return await this.request<I_DocumentEntry[]>(`/docs/fetch/`, 'POST', queryObject);
+    }
+
+    /**
+     * Updates a document by ID.
+     *
+     * @param {string} documentID - The ID of the document to update.
+     * @param {I_DocumentEntry} documentData - Updated document payload.
+     * @returns {Promise<void>}
+     */
+    async updateDocument(documentID: string, documentData: I_DocumentEntry): Promise<void> {
+        await this.request<void>(`/docs/update/${documentID}`, 'PATCH', documentData);
+    }
+
+    /**
+     * Removes a document by ID.
+     *
+     * @param {string} documentID - The ID of the document to remove.
+     * @returns {Promise<void>}
+     */
+    async removeDocument(documentID: string): Promise<void> {
+        await this.request<void>(`/docs/remove/${documentID}`, 'DELETE');
+    }
+
+    // Data Structure Endpoints
+    /**
+     * Creates a new data structure.
+     *
+     * @param {I_StructureCreation} structure - Data structure payload to create.
+     * @returns {Promise<I_DataStructure>} The created data structure.
+     */
+    async createStructure(structure: I_StructureCreation): Promise<I_DataStructure> {
+        return await this.request<I_DataStructure>('/structures/create', 'POST', structure);
+    }
+
+    /**
+     * Retrieves all data structures.
+     *
+     * @returns {Promise<I_DataStructure[]>} A list of data structures.
+     */
+    async getStructures(): Promise<I_DataStructure[]> {
+        return await this.request<I_DataStructure[]>('/structures/list', 'GET');
+    }
+
+    /**
+     * Updates a data structure by ID.
+     *
+     * @param {string} structureID - The ID of the structure to update.
+     * @param {I_DataStructure} structureData - Updated structure payload.
+     * @returns {Promise<void>}
+     */
+    async updateStructure(structureID: string, structureData: I_DataStructure): Promise<void> {
+        await this.request<void>(`/structures/update/${structureID}`, 'PATCH', structureData);
+    }
+
+    /**
+     * Removes a data structure by ID.
+     *
+     * @param {string} structureID - The ID of the structure to remove.
+     * @returns {Promise<void>}
+     */
+    async removeStructure(structureID: string): Promise<void> {
+        await this.request<void>(`/structures/remove/${structureID}`, 'DELETE');
+    }
+
+    // Data Type Endpoints
+    /**
+     * Creates or writes a document type.
+     *
+     * @param {I_DocumentType} type - The type payload.
+     * @returns {Promise<I_DocumentType>} The created or updated type.
+     */
+    async createType(type: I_DocumentType): Promise<I_DocumentType> {
+        return await this.request<I_DocumentType>('/types/write', 'POST', type);
+    }
+
+    /**
+     * Removes a document type by ID.
+     *
+     * @param {string} typeID - The ID of the type to remove.
+     * @returns {Promise<void>}
+     */
+    async removeType(typeID: string) {
+        return await this.request<void>(`/types/remove/${typeID}`, 'DELETE');
+    }
+
+    /**
+     * Retrieves all document types.
+     *
+     * @returns {Promise<I_DocumentType[]>} A list of document types.
+     */
+    async getTypes(): Promise<I_DocumentType[]> {
+        return await this.request<I_DocumentType[]>('/types/list', 'GET');
+    }
+
+    /**
+     * Updates a document type.
+     *
+     * @param {I_DocumentType} updatedType - The full type payload to persist.
+     * @returns {Promise<void>}
+     */
+    async updateType(updatedType: I_DocumentType): Promise<void> {
+        await this.request<void>(`/types/write`, 'POST', updatedType);
+    }
+
+    /**
+     * Sets or clears the authentication token used for API and WebSocket auth.
+     *
+     * @param {string | null} token - Bearer token to use, or null to clear it.
+     */
+    setToken(token: string | null): void {
+        console.log("Setting token to:", token ? "***token***" : "null");
+
+        const tokenChanged = this.authToken !== token;
+        this.authToken = token;
+
+        if (!tokenChanged) {
+            console.log("Token unchanged, no need to reconnect");
+            return;
+        }
+
+        // If we have a new token and realtime sync is enabled
+        if (token && this.realTimeSync) {
+            console.log("New token set, will initialize WebSocket");
+
+            // Ensure any existing connection is closed first
+            if (this.socket.connected) {
+                console.log("Disconnecting existing socket before reconnecting with new token");
+                this.socket.disconnect();
+            }
+
+            // Wait a moment for the disconnect to complete
+            setTimeout(() => {
+                console.log("Initializing WebSocket with new token");
+                this.initWebSocket();
+            }, 300);
+        }
+        // If token was cleared or realtime sync is disabled
+        else if (this.socket.connected) {
+            console.log("Token cleared or realtime sync disabled, disconnecting");
+            this.socket.disconnect();
+        }
+    }
+
+    /**
+     * Returns the package version of this client.
+     *
+     * @returns {string} The semantic version string.
+     */
+    getVersion() {
+        return packetJson.version;
+    }
+
+    /**
+     * Logs socket diagnostics and attempts a reconnect when possible.
+     *
+     * @returns {void}
+     */
+    debugSocketConnection(): void {
+        console.log("Socket connection debug info:");
+        console.log("- Connected:", this.socket.connected);
+        console.log("- Socket ID:", this.socket.id);
+        console.log("- Auth token present:", !!this.authToken);
+        console.log("- Connection in progress:", this.connectionInProgress);
+        console.log("- Realtime sync enabled:", this.realTimeSync);
+        console.log("- Socket options:", this.socket.io.opts);
+
+        // Try to force reconnection
+        if (!this.socket.connected && this.authToken && this.realTimeSync) {
+            console.log("Attempting to force reconnection...");
+            this.socket.auth = {token: this.authToken};
+            this.socket.connect();
+        }
+    }
+
+    /**
+     * Sets up permanent socket listeners for the client.
+     *
+     * @private
+     */
+    private setupPermanentSocketListeners() {
+        // These are permanent listeners that won't be removed
+        this.socket.on('connect_error', (error) => {
+            console.error('Socket connection error:', error.message);
+            this.connectionInProgress = false;
+        });
+
+        this.socket.on('connect', () => {
+            console.log('Socket connected successfully with ID:', this.socket.id);
+            this.connectionInProgress = false;
+        });
+
+        this.socket.on('disconnect', (reason) => {
+            console.log('Socket disconnected. Reason:', reason);
+            this.connectionInProgress = false;
+        });
+
+        this.socket.on('error', (error) => {
+            console.error('Socket error:', error);
+            this.connectionInProgress = false;
+        });
+    }
+
+    /**
+     * Initializes the WebSocket connection with the server.
+     *
+     * @private
+     */
+    private initWebSocket() {
+        console.log("initWebSocket called. Auth token present:", !!this.authToken,
+            "Connection in progress:", this.connectionInProgress,
+            "Socket connected:", this.socket.connected);
+
+        if (!this.authToken) {
+            console.log("Skipping WebSocket initialization: No auth token");
+            return;
+        }
+
+        if (this.connectionInProgress) {
+            console.log("Connection already in progress, skipping initialization");
+            return;
+        }
+
+        if (this.socket.connected) {
+            console.log("Socket already connected with ID:", this.socket.id);
+            return;
+        }
+
+        this.connectionInProgress = true;
+
+        try {
+            console.log("Setting up WebSocket connection with token");
+
+            // Update the auth token
+            this.socket.auth = {token: this.authToken};
+
+            // Remove any dynamic event listeners that might have been added
+            this.socket.offAny();
+
+            // Set up event handler for application events
+            this.socket.onAny((event: I_EventString, data: I_WsMessage) => {
+                if (event === "heartbeatPing") {
+                    console.log("Ping event received:", data);
+                    this.socket.emit("heartbeatPong", Date.now());
+                } else if (this.callbackFunction) {
+                    this.callbackFunction(event, data);
+                }
+            });
+
+            // Connect to the server
+            console.log("Connecting socket with auth token");
+            this.socket.connect();
+
+            // Add a timeout to detect if connection is taking too long
+            setTimeout(() => {
+                if (this.connectionInProgress) {
+                    console.warn("Socket connection attempt timed out after 5 seconds");
+                    this.connectionInProgress = false;
+
+                    // If we're still not connected after the timeout, try again with polling
+                    if (!this.socket.connected) {
+                        console.log("Retrying connection with polling transport");
+                        this.socket.io.opts.transports = ['polling', 'websocket'];
+                        this.socket.connect();
+                    }
+                }
+            }, 5000);
+        } catch (error) {
+            console.error('Error in initWebSocket:', error);
+            this.connectionInProgress = false;
+        }
+    }
+
+    /**
+     * Sends an HTTP request to the configured docPouch backend.
+     *
+     * @template T
+     * @param {string} endpoint - Relative API endpoint (with or without leading slash).
+     * @param {string} method - HTTP method.
+     * @param {any} [body] - Optional JSON body.
+     * @param {boolean} [requiresAuth=true] - Whether the Authorization header should be attached.
+     * @returns {Promise<T>} Parsed JSON response body.
+     * @private
+     */
+    private async request<T>(endpoint: string, method: string, body?: any, requiresAuth: boolean = true): Promise<T> {
+        const headers: HeadersInit = {
+            'Content-Type': 'application/json',
+        };
+
+        if (requiresAuth && this.authToken)
+            headers['Authorization'] = `Bearer ${this.authToken}`;
+        if (this.socket.id)
+            headers['X-Socket-ID'] = this.socket.id;
+
+        const options: RequestInit = {
+            method,
+            headers,
+            body: body ? JSON.stringify(body) : undefined
+        };
+
+        const normalizedEndpoint = endpoint.startsWith('/') ? endpoint : `/${endpoint}`;
+        const normalizedBaseUrl = this.baseUrl.endsWith('/') ? this.baseUrl.slice(0, -1) : this.baseUrl;
+        const url = `${normalizedBaseUrl}${normalizedEndpoint}`;
+        const response = await fetch(url, options);
+
+        if (!response.ok) {
+            if (response.status === 401 || response.status === 403) {
+                this.authToken = null;
+            }
+            throw new Error(`API error: ${response.status} ${response.statusText}`);
+        }
+
+        return await response.json() as T;
+    }
+}
+
+// Common type definitions for both frontend and backend
+
+// User related types
+export interface I_UserEntry extends I_UserCreation {
+    _id: string;
+}
+
+export interface I_UserLogin {
+    name: string;
+    password: string;
+}
+
+export interface I_UserCreation {
+    name: string;
+    password: string;
+    email?: string;
+    department: string;
+    group: string;
+    isAdmin: boolean;
+}
+
+export interface I_UserUpdate {
+    _id?: string;
+    name?: string;
+    password?: string;
+    email?: string;
+    department?: string;
+    group?: string;
+    isAdmin?: boolean;
+}
+
+export interface I_UserDisplay {
+    _id: string;
+    username: string;
+    department: string;
+    group: string;
+    email?: string;
+}
+
+export interface I_LoginResponse {
+    token: string;
+    isAdmin: boolean;
+    userName: string;
+}
+
+// Document related types
+export interface I_DocumentEntry extends I_DocumentCreationOwned {
+    _id: string;
+}
+
+export interface I_DocumentCreation {
+    title: string;
+    description?: string;
+    type: number;
+    subType: number;
+    content: any;
+    shareWithGroup: boolean;
+    shareWithDepartment: boolean;
+}
+
+
+export interface I_DocumentCreationOwned extends I_DocumentCreation {
+    owner: string;
+}
+
+export interface I_DocumentUpdate extends I_DocumentQuery {
+    content?: any;
+    description?: string;
+}
+
+export interface I_DocumentQuery {
+    _id?: string;
+    owner?: string;
+    title?: string;
+    type?: number;
+    subType?: number;
+    shareWithGroup?: boolean;
+    shareWithDepartment?: boolean;
+}
+
+
+// Structure related types
+export interface I_DataStructure {
+    _id?: string | undefined;
+    name: string;
+    description: string;
+    fields: I_StructureField[];
+}
+
+export interface I_StructureField {
+    name: string;
+    type: string;
+    items?: string;
+}
+
+export interface I_StructureEntry {
+    _id?: string;
+    name: string;
+    description: string;
+    fields: I_StructureField[];
+}
+
+
+export interface I_StructureCreation {
+    name: string;
+    description?: string;
+    fields: I_StructureField[];
+}
+
+export interface I_StructureUpdate {
+    _id?: string
+    name?: string;
+    description?: string;
+    fields?: I_StructureField[];
+}
+
+// Document type related types
+export interface I_DocumentType {
+    _id?: string;
+    type: number;
+    subType: number;
+    name: string;
+    description?: string;
+    defaultStructureID?: string;
+}
+
+// WebSocket-related types
+export type I_EventString = 'heartbeatPong' | "heartbeatPing" | "newDocument" | "newStructure" |
+    "newUser" | "newType" | "removedID" | "changedDocument" | "changedStructure" | "changedUser" | "changedType" |
+    "removedUser" | "removedStructure" | "removedDocument" | "removedType";
+
+export interface I_WsMessage {
+    newDocument?: I_DocumentEntry;
+    newStructure?: I_StructureEntry;
+    newUser?: I_UserEntry;
+    removedID?: string;
+    changedDocument?: I_DocumentUpdate;
+    changedStructure?: I_StructureUpdate;
+    changedUser?: I_UserUpdate;
+    confirmSubscription?: boolean;
+    confirmUnsubscription?: boolean;
+    heartbeatPing?: number;
+    heartbeatPong?: number;
+    newType?: I_DocumentType;
+}