docpouch-client 0.8.14 → 0.8.16

package/dist/index.js

@@ -86,6 +86,12 @@ export default class docPouchClient {
         }
     }
     // 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) {
         const response = await this.request('/users/login', 'POST', credentials, false);
         if (response.token) {
@@ -98,60 +104,166 @@ export default class docPouchClient {
         }
         return null;
     }
+    /**
+     * Retrieves all users visible to the authenticated user.
+     *
+     * @returns {Promise<I_UserEntry[]>} A list of user entries.
+     */
     async listUsers() {
         return await this.request('/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, userData) {
         await this.request(`/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) {
         return await this.request('/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) {
         await this.request(`/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) {
         return await this.request('/docs/create', 'POST', document);
     }
+    /**
+     * Retrieves all documents visible to the authenticated user.
+     *
+     * @returns {Promise<I_DocumentEntry[]>} A list of document entries.
+     */
     async listDocuments() {
         return await this.request('/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) {
         return await this.request(`/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, documentData) {
         await this.request(`/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) {
         await this.request(`/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) {
         return await this.request('/structures/create', 'POST', structure);
     }
+    /**
+     * Retrieves all data structures.
+     *
+     * @returns {Promise<I_DataStructure[]>} A list of data structures.
+     */
     async getStructures() {
         return await this.request('/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, structureData) {
         await this.request(`/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) {
         await this.request(`/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) {
         return await this.request('/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) {
         return await this.request(`/types/remove/${typeID}`, 'DELETE');
     }
+    /**
+     * Retrieves all document types.
+     *
+     * @returns {Promise<I_DocumentType[]>} A list of document types.
+     */
     async getTypes() {
         return await this.request('/types/list', 'GET');
     }
+    /**
+     * Updates a document type.
+     *
+     * @param {I_DocumentType} updatedType - The full type payload to persist.
+     * @returns {Promise<void>}
+     */
     async updateType(updatedType) {
         await this.request(`/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) {
         console.log("Setting token to:", token ? "***token***" : "null");
         const tokenChanged = this.authToken !== token;
@@ -180,9 +292,19 @@ export default class docPouchClient {
             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() {
         console.log("Socket connection debug info:");
         console.log("- Connected:", this.socket.connected);
@@ -280,6 +402,17 @@ export default class docPouchClient {
             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
+     */
     async request(endpoint, method, body, requiresAuth = true) {
         const headers = {
             'Content-Type': 'application/json',

package/package.json

@@ -1,38 +1,38 @@
-{
-  "name": "docpouch-client",
-  "version": "0.8.14",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.js"
-    }
-  },
-  "type": "module",
-  "scripts": {
-    "build": "tsc",
-    "test": "jest"
-  },
-  "keywords": [
-    "docPouch",
-    "API"
-  ],
-  "author": "Jan Frecè",
-  "license": "MIT",
-  "description": "A small class to more easily access the docPouch API",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/BFH-JTF/docpouch-client"
-  },
-  "devDependencies": {
-    "@types/jest": "^30.0.0",
-    "@types/node": "^24.3.0",
-    "jest": "^30.0.5",
-    "ts-jest": "^29.4.1",
-    "typescript": "^5.9.2"
-  },
-  "dependencies": {
-    "socket.io-client": "^4.8.1"
-  }
-}
+{
+  "name": "docpouch-client",
+  "version": "0.8.16",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest"
+  },
+  "keywords": [
+    "docPouch",
+    "API"
+  ],
+  "author": "Jan Frecè",
+  "license": "MIT",
+  "description": "A small class to more easily access the docPouch API",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BFH-JTF/docpouch-client"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.3.0",
+    "jest": "^30.0.5",
+    "ts-jest": "^29.4.1",
+    "typescript": "^5.9.2"
+  },
+  "dependencies": {
+    "socket.io-client": "^4.8.1"
+  }
+}