docpouch-client 0.8.4 → 0.8.6

package/dist/index.js

@@ -1,40 +1,39 @@
 import { io } from "socket.io-client";
 import packetJson from '../package.json';
-export default class dbPouchClient {
+/**
+ * Client for interacting with docPouch API.
+ */
+export default class docPouchClient {
+    /**
+     * 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, port = 80, callback) {
-        this.authToken = null;
+        /**
+         * Flag indicating whether real-time synchronization is enabled.
+         *
+         * @type {boolean}
+         */
         this.realTimeSync = false;
+        /**
+         * Authentication token used to authorize requests.
+         *
+         * @private
+         * @type {string | null}
+         */
+        this.authToken = null;
+        /**
+         * Flag indicating whether a connection attempt is in progress.
+         *
+         * @private
+         * @type {boolean}
+         */
         this.connectionInProgress = false;
-        this.setRealTimeSync = (newRealTimeSync) => {
-            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();
-                }
-            }
-        };
         this.baseUrl = host;
-        const socketUrl = host.includes('://') ? host : `http://${host}`;
-        // Don't append port twice if it's already in the URL
+        const socketUrl = host.includes('://') ? host : `https://${host}`;
         const socketUrlWithPort = socketUrl.includes(':') && !socketUrl.endsWith(':')
             ? socketUrl
             : `${socketUrl}:${port}`;
@@ -54,105 +53,37 @@ export default class dbPouchClient {
         this.callbackFunction = callback;
         this.setupPermanentSocketListeners();
     }
-    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;
-        });
-    }
-    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");
+    /**
+     * Sets the real-time synchronization status.
+     *
+     * @param {boolean} newRealTimeSync - The new real-time sync setting (true/false).
+     */
+    setRealTimeSync(newRealTimeSync) {
+        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;
         }
-        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, data) => {
-                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;
+        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();
+            }
         }
-    }
-    async request(endpoint, method, body, requiresAuth = true) {
-        const headers = {
-            '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 = {
-            method,
-            headers,
-            body: body ? JSON.stringify(body) : undefined
-        };
-        // Ensure endpoint starts with /
-        const normalizedEndpoint = endpoint.startsWith('/') ? endpoint : `/${endpoint}`;
-        // Ensure baseUrl doesn't end with /
-        const normalizedBaseUrl = this.baseUrl.endsWith('/') ? this.baseUrl.slice(0, -1) : this.baseUrl;
-        const url = `${normalizedBaseUrl}${normalizedEndpoint}`;
-        console.log(`Making ${method} request to: ${url}`);
-        const response = await fetch(url, options);
-        if (!response.ok) {
-            if (response.status === 401 || response.status === 403) {
-                this.authToken = null;
+        else if (!newRealTimeSync) {
+            console.log("Deactivating realtime updates");
+            if (this.socket.connected) {
+                console.log("Disconnecting socket");
+                this.socket.disconnect();
             }
-            throw new Error(`API error: ${response.status} ${response.statusText}`);
         }
-        return await response.json();
     }
     // User Administration Endpoints
     async login(credentials) {
@@ -163,7 +94,7 @@ export default class dbPouchClient {
             if (this.realTimeSync) {
                 this.initWebSocket();
             }
-            return { token: response.token, isAdmin: response.isAdmin };
+            return { token: response.token, isAdmin: response.isAdmin, userName: response.userName };
         }
         return null;
     }
@@ -210,7 +141,7 @@ export default class dbPouchClient {
     }
     // Data Type Endpoints
     async createType(type) {
-        return await this.request('/types/write', 'POST', type);
+        return await this.request('/types/write', 'PATCH', type);
     }
     async removeType(typeID) {
         return await this.request(`/types/remove/${typeID}`, 'DELETE');
@@ -218,6 +149,9 @@ export default class dbPouchClient {
     async getTypes() {
         return await this.request('/types/list', 'GET');
     }
+    async updateType(updatedType) {
+        await this.request(`/types/write`, 'PATCH', updatedType);
+    }
     setToken(token) {
         console.log("Setting token to:", token ? "***token***" : "null");
         const tokenChanged = this.authToken !== token;
@@ -264,4 +198,111 @@ export default class dbPouchClient {
             this.socket.connect();
         }
     }
+    /**
+     * Sets up permanent socket listeners for the client.
+     *
+     * @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
+     */
+    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, data) => {
+                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;
+        }
+    }
+    async request(endpoint, method, body, requiresAuth = true) {
+        const headers = {
+            '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 = {
+            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();
+    }
 }

package/dist/types.d.ts

@@ -14,6 +14,7 @@ export interface I_UserCreation {
     isAdmin: boolean;
 }
 export interface I_UserUpdate {
+    _id: string;
     name?: string;
     password?: string;
     email?: string;
@@ -31,6 +32,7 @@ export interface I_UserDisplay {
 export interface I_LoginResponse {
     token: string;
     isAdmin: boolean;
+    userName: string;
 }
 export interface I_DocumentEntry extends I_DocumentCreationOwned {
     _id: string;
@@ -41,6 +43,8 @@ export interface I_DocumentCreation {
     type: number;
     subType: number;
     content: any;
+    shareWithGroup: boolean;
+    shareWithDepartment: boolean;
 }
 export interface I_DocumentCreationOwned extends I_DocumentCreation {
     owner: string;
@@ -56,33 +60,36 @@ export interface I_DocumentQuery {
     title?: string;
     type?: number;
     subType?: number;
+    shareWithGroup?: boolean;
+    shareWithDepartment?: boolean;
 }
 export interface I_DataStructure {
     _id?: string | undefined;
     name: string;
     description: string;
-    reference?: any;
-    fields: any[];
+    fields: I_StructureField[];
+}
+export interface I_StructureField {
+    name: string;
+    type: string;
+    items?: string;
 }
 export interface I_StructureEntry {
     _id?: string;
     name: string;
     description: string;
-    reference?: any;
-    fields: any[];
+    fields: I_StructureField[];
 }
 export interface I_StructureCreation {
     name: string;
     description?: string;
-    reference?: any;
-    fields: any[];
+    fields: I_StructureField[];
 }
 export interface I_StructureUpdate {
     _id: string;
     name?: string;
     description?: string;
-    reference?: any;
-    fields?: any[];
+    fields?: I_StructureField[];
 }
 export interface I_DocumentType {
     _id?: string;
@@ -92,7 +99,7 @@ export interface I_DocumentType {
     description?: string;
     defaultStructureID?: string;
 }
-export type I_EventString = 'subscribe' | 'unsubscribe' | 'heartbeatPong' | "heartbeatPing" | "newDocument" | "newStructure" | "newUser" | "removedID" | "changedDocument" | "changedStructure" | "changedUser" | "confirmSubscription" | "confirmUnsubscription" | "removedUser" | "removedStructure" | "removedDocument";
+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;
@@ -105,4 +112,5 @@ export interface I_WsMessage {
     confirmUnsubscription?: boolean;
     heartbeatPing?: number;
     heartbeatPong?: number;
+    newType?: I_DocumentType;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docpouch-client",
-  "version": "0.8.4",
+  "version": "0.8.6",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
@@ -22,9 +22,9 @@
   "license": "MIT",
   "description": "A small class to more easily access the docPouch API",
   "devDependencies": {
-    "@types/jest": "^29.5.14",
-    "@types/node": "^24.0.1",
-    "jest": "^30.0.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.0.7",
+    "jest": "^30.0.3",
     "ts-jest": "^29.4.0"
   },
   "dependencies": {

package/src/__tests__/index.test.ts

@@ -1,4 +1,4 @@
-import dbPouchClient from '../index.js';
+import docPouchClient from '../index.js';
 import packetJson from '../../package.json';
 import {
   I_UserLogin,
@@ -28,7 +28,7 @@ global.fetch = jest.fn();
 const mockFetch = global.fetch as jest.Mock;
 
 describe('Index Class', () => {
-  let index: dbPouchClient;
+  let index: docPouchClient;
   const baseUrl = 'http://example.com';
 
   beforeEach(() => {
@@ -37,7 +37,7 @@ describe('Index Class', () => {
     mockFetch.mockClear();
 
     // Create a new instance of Index for each test
-    index = new dbPouchClient(baseUrl);
+    index = new docPouchClient(baseUrl);
 
     // Mock successful fetch response
     mockFetch.mockImplementation(() => 
@@ -62,7 +62,7 @@ describe('Index Class', () => {
 
     it('should connect socket and set up event handler when callback is provided', () => {
       const mockCallback = jest.fn();
-      const indexWithCallback = new dbPouchClient(baseUrl, mockCallback);
+      const indexWithCallback = new docPouchClient(baseUrl, mockCallback);
 
       expect(indexWithCallback.socket.connect).toHaveBeenCalled();
       expect(indexWithCallback.socket.onAny).toHaveBeenCalled();
@@ -86,7 +86,7 @@ describe('Index Class', () => {
       jest.mock('../../package.json', () => ({ version: packetJson.version }), { virtual: true });
 
       // We need to re-create the index instance to pick up the mocked package.json
-      const newIndex = new dbPouchClient(baseUrl);
+      const newIndex = new docPouchClient(baseUrl);
       expect(newIndex.getVersion()).toBe(packetJson.version);
     });
   });
@@ -472,7 +472,7 @@ describe('Index Class', () => {
   describe('WebSocket functionality', () => {
     it('should connect socket when callback is provided', () => {
       const mockCallback = jest.fn();
-      const indexWithCallback = new dbPouchClient(baseUrl, mockCallback);
+      const indexWithCallback = new docPouchClient(baseUrl, mockCallback);
 
       // Verify that connect was called
       expect(indexWithCallback.socket.connect).toHaveBeenCalled();
@@ -480,7 +480,7 @@ describe('Index Class', () => {
 
     it('should set up event handler when callback is provided', () => {
       const mockCallback = jest.fn();
-      const indexWithCallback = new dbPouchClient(baseUrl, mockCallback);
+      const indexWithCallback = new docPouchClient(baseUrl, mockCallback);
 
       // Verify that onAny was called
       expect(indexWithCallback.socket.onAny).toHaveBeenCalled();