docpouch-client 0.8.0 → 0.8.2

package/dist/index.d.ts

@@ -1,8 +1,10 @@
-import type { I_UserEntry, I_UserLogin, I_UserCreation, I_UserUpdate, I_UserDisplay, I_DocumentEntry, I_DataStructure, I_LoginResponse } from "./types.js";
+import type { I_UserEntry, I_UserLogin, I_UserCreation, I_UserUpdate, I_UserDisplay, I_DocumentEntry, I_DataStructure, I_LoginResponse, I_DocumentQuery, I_StructureCreation, I_WsMessage } from "./types.js";
+import { Manager } from "socket.io-client";
 export default class Index {
     baseUrl: string;
     private token;
-    constructor(baseUrl: string);
+    socketManager: Manager<import("@socket.io/component-emitter").DefaultEventsMap, import("@socket.io/component-emitter").DefaultEventsMap>;
+    constructor(baseUrl: string, callback?: (event: string, data: I_WsMessage) => void);
     private request;
     login(credentials: I_UserLogin): Promise<I_LoginResponse | null>;
     listUsers(): Promise<I_UserEntry[]>;
@@ -11,10 +13,10 @@ export default class Index {
     removeUser(userID: string): Promise<void>;
     createDocument(document: I_DocumentEntry): Promise<I_DocumentEntry>;
     listDocuments(): Promise<I_DocumentEntry[]>;
-    fetchDocument(documentID: string): Promise<I_DocumentEntry>;
+    fetchDocument(queryObject: I_DocumentQuery): Promise<I_DocumentEntry[]>;
     updateDocument(documentID: string, documentData: I_DocumentEntry): Promise<void>;
     removeDocument(documentID: string): Promise<void>;
-    createStructure(structure: I_DataStructure): Promise<I_DataStructure>;
+    createStructure(structure: I_StructureCreation): Promise<I_DataStructure>;
     getStructures(): Promise<I_DataStructure[]>;
     updateStructure(structureID: string, structureData: I_DataStructure): Promise<void>;
     removeStructure(structureID: string): Promise<void>;

package/dist/index.js

@@ -1,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const socket_io_client_1 = require("socket.io-client");
 class Index {
-    constructor(baseUrl) {
+    constructor(baseUrl, callback) {
         this.token = null;
         this.baseUrl = baseUrl;
+        this.socketManager = new socket_io_client_1.Manager(baseUrl, { autoConnect: false });
+        if (callback) {
+            this.socketManager.connect();
+            this.socketManager.onAny((event, data) => callback(event, data));
+        }
     }
     async request(endpoint, method, body, requiresAuth = true) {
         const headers = {
@@ -54,8 +60,8 @@ class Index {
     async listDocuments() {
         return await this.request('/docs/list', 'GET');
     }
-    async fetchDocument(documentID) {
-        return await this.request(`/docs/fetch/${documentID}`, 'GET');
+    async fetchDocument(queryObject) {
+        return await this.request(`/docs/fetch/`, 'GET');
     }
     async updateDocument(documentID, documentData) {
         await this.request(`/docs/update/${documentID}`, 'PATCH', documentData);

package/dist/types.d.ts

@@ -39,6 +39,18 @@ export interface I_DocumentCreation {
 export interface I_DocumentCreationOwned extends I_DocumentCreation {
     owner: string;
 }
+export interface I_DocumentUpdate extends I_DocumentQuery {
+    _id: string;
+    content?: any;
+    description?: string;
+}
+export interface I_DocumentQuery {
+    _id?: string;
+    owner?: string;
+    title?: string;
+    type?: number;
+    subType?: number;
+}
 export interface I_DataStructure {
     _id?: string | undefined;
     name: string;
@@ -59,3 +71,23 @@ export interface I_StructureCreation {
     reference?: any;
     fields: any[];
 }
+export interface I_StructureUpdate {
+    _id: string;
+    name?: string;
+    description?: string;
+    reference?: any;
+    fields?: any[];
+}
+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;
+    ping?: number;
+    pong?: number;
+}

package/package.json

@@ -1,17 +1,21 @@
 {
   "name": "docpouch-client",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc"
   },
-  "keywords": ["docPouch", "API"],
+  "keywords": [
+    "docPouch",
+    "API"
+  ],
   "author": "Jan Frecè",
   "license": "MIT",
   "description": "A small class to more easily access the docPouch API",
   "devDependencies": {
-    "@types/node": "^22.15.17"
+    "@types/node": "^22.15.23",
+    "socket.io-client": "^4.8.1"
   },
   "dependencies": {
     "typescript": "^5.8.3"

package/src/index.ts

@@ -1,20 +1,37 @@
-import type { 
+import type {
     I_UserEntry,
     I_UserLogin,
     I_UserCreation,
     I_UserUpdate,
-    I_UserDisplay, 
+    I_UserDisplay,
     I_DocumentEntry,
-    I_DataStructure, 
-    I_LoginResponse
+    I_DataStructure,
+    I_LoginResponse, I_DocumentQuery, I_StructureCreation, I_WsMessage, I_EventString
 } from "./types.js";
+import {io, Socket} from "socket.io-client";
+import packetJson from '../package.json'
 
 export default class Index {
     baseUrl: string;
     private token: string | null = null;
+    socket: Socket
 
-    constructor(baseUrl: string) {
+    constructor(baseUrl: string, callback?: (event: I_EventString, data: I_WsMessage) => void) {
         this.baseUrl = baseUrl;
+
+        this.socket = io(baseUrl, { autoConnect: false });
+        if (callback) {
+            this.socket.connect();
+            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 {
+                    callback(event, data);
+                }
+            });
+        }
     }
 
     private async request<T>(endpoint: string, method: string, body?: any, requiresAuth: boolean = true): Promise<T> {
@@ -79,8 +96,8 @@ export default class Index {
         return await this.request<I_DocumentEntry[]>('/docs/list', 'GET');
     }
 
-    async fetchDocument(documentID: string): Promise<I_DocumentEntry> {
-        return await this.request<I_DocumentEntry>(`/docs/fetch/${documentID}`, 'GET');
+    async fetchDocument(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> {
@@ -92,7 +109,7 @@ export default class Index {
     }
 
     // Data Structure Endpoints
-    async createStructure(structure: I_DataStructure): Promise<I_DataStructure> {
+    async createStructure(structure: I_StructureCreation): Promise<I_DataStructure> {
         return await this.request<I_DataStructure>('/structures/create', 'POST', structure);
     }
 
@@ -113,7 +130,11 @@ export default class Index {
     }
 
     getToken() {
-        return this.token;
+        return packetJson.version;
+    }
+
+    getVersion() {
+        return "0.0.1";
     }
 }
 

package/src/types.ts

@@ -14,6 +14,8 @@ export interface I_UserCreation {
     name: string;
     password: string;
     email?: string;
+    department: string;
+    group: string;
     isAdmin: boolean;
 }
 
@@ -21,12 +23,16 @@ export interface I_UserUpdate {
     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;
 }
 
@@ -52,6 +58,20 @@ export interface I_DocumentCreationOwned extends I_DocumentCreation {
     owner: string;
 }
 
+export interface I_DocumentUpdate extends I_DocumentQuery{
+    _id: string;
+    content?: any;
+    description?: string;
+}
+
+export interface I_DocumentQuery {
+    _id?: string;
+    owner?: string;
+    title?: string;
+    type?: number;
+    subType?: number;
+}
+
 // Structure related types
 export interface I_DataStructure {
     _id?: string | undefined;
@@ -74,4 +94,31 @@ export interface I_StructureCreation {
     description?: string;
     reference?: any;
     fields: any[];
+}
+
+export interface I_StructureUpdate {
+    _id: string;
+    name?: string;
+    description?: string;
+    reference?: any;
+    fields?: any[];
+}
+
+// WebSocket-related types
+export type I_EventString = 'subscribe' | 'unsubscribe' | 'heartbeatPong' | "heartbeatPing" | "newDocument" | "newStructure" |
+    "newUser" | "removedID" | "changedDocument" | "changedStructure" | "changedUser" | "confirmSubscription" |
+    "confirmUnsubscription";
+
+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;
 }

package/tsconfig.json

@@ -12,7 +12,8 @@
     "rootDir": "./src",
     "declaration": true,
     "emitDeclarationOnly": false,
+    "resolveJsonModule": true
   },
   "include": ["**/*.ts", "**/*.tsx"],
-  "exclude": ["node_modules", "**/*.test.ts", "**/*.types.ts"]
+  "exclude": ["node_modules", "**/*.test.ts", "**/*.types.ts", "./dist/**/*"]
 }