docpouch-client 0.8.5 → 0.8.6

package/README.md

@@ -0,0 +1,305 @@
+# docpouch-client
+
+A TypeScript client library for interacting with the [docPouch](https://github.com/BFH-JTF/doc-pouch) database API.
+
+## Description
+
+docpouch-client provides a simple and intuitive interface to access the docPouch API, allowing you to manage users,
+documents, data structures, and document types. It also supports real-time synchronization via WebSockets.
+
+## Installation
+
+```bash
+npm install docpouch-client
+```
+
+## Usage
+
+### Initializing the Client
+
+```typescript
+import docPouchClient from 'docpouch-client';
+
+// Initialize the client with the server URL
+const client = new docPouchClient('https://your-docpouch-server.com', 80);
+
+// Initialize with a callback for real-time updates
+const client = new docPouchClient('https://your-docpouch-server.com', 80,
+    (event, data) => {
+        console.log(`Received event: ${event}`, data);
+    }
+);
+```
+
+### Authentication
+
+```typescript
+// Login to get an authentication token
+const loginResponse = await client.login({
+    name: 'username',
+    password: 'password'
+});
+
+if (loginResponse) {
+    console.log('Login successful!');
+    console.log(`Token: ${loginResponse.token}`);
+} else {
+    console.log('Login failed');
+}
+
+// Set an existing token
+client.setToken('your-auth-token');
+```
+
+### User Management
+
+```typescript
+// List all users
+const users = await client.listUsers();
+
+// Create a new user
+const newUser = await client.createUser({
+    name: 'newuser',
+    password: 'password',
+    department: 'IT',
+    group: 'Developers',
+    isAdmin: false
+});
+
+// Update a user
+await client.updateUser('user-id', {
+    department: 'Engineering',
+    group: 'Frontend'
+});
+
+// Remove a user
+await client.removeUser('user-id');
+```
+
+### Document Management
+
+```typescript
+// Create a new document
+const newDocument = await client.createDocument({
+    type: 17,
+    subType: 11,
+    title: "Mission Statement",
+    content: "{\"msg\": \"We strive for a world that...\"}",
+    shareWithGroup: false,
+    shareWithDepartment: false
+});
+
+// Update a document
+await client.updateDocument('document-id', {
+    title: 'Updated Mission Statement',
+    content: '{"msg": "Our updated mission..."}'
+});
+
+// Delete a document
+await client.deleteDocument('document-id');
+
+// Fetch documents by query
+const documents = await client.fetchDocuments([
+    {type: 17, subType: 11}
+]);
+```
+
+### Data Structure Management
+
+```typescript
+// Create a new data structure
+const newStructure = await client.createDataStructure({
+    title: "Data resulting from Vision-Mission-Value-Canvas",
+    fields: [
+        {
+            name: "Mission value statement",
+            type: "string"
+        },
+        // Add more fields as needed
+    ]
+});
+
+// Update a data structure
+await client.updateDataStructure('structure-id', {
+    title: 'Updated Structure Title',
+    fields: [
+        {name: 'New Field Name', type: 'number'}
+    ]
+});
+
+// Delete a data structure
+await client.deleteDataStructure('structure-id');
+
+// List all data structures
+const structures = await client.listDataStructures();
+```
+
+### Document Type Management
+
+```typescript
+// List all document types
+const docTypes = await client.listDocumentTypes();
+
+// Create or update a document type
+const newDocType = await client.createOrUpdateDocumentType({
+    name: "HR Wages",
+    description: "HR Wage information Document listing wages per personnel ID",
+    type: 14,
+    subType: 2,
+    defaultStructureID: 'structure-id'
+});
+
+// Delete a document type
+await client.deleteDocumentType('doc-type-id');
+```
+
+## API Reference
+
+### Client Class
+
+#### Constructor
+
+- `new docPouchClient(baseUrl: string, port: number, callback?: (event: string, data: any) => void)`
+
+#### Methods
+
+- `login(credentials: { name: string, password: string }): Promise<{ token: string } | null>`
+- `setToken(token: string): void`
+- `listUsers(): Promise<UserDisplay[]>`
+- `createUser(userData: UserCreation): Promise<UserDisplay>`
+- `updateUser(id: string, userData: UserUpdate): Promise<void>`
+- `removeUser(id: string): Promise<void>`
+- `createDocument(docData: NewDocument): Promise<Document>`
+- `updateDocument(id: string, docData: Partial<Document>): Promise<void>`
+- `deleteDocument(id: string): Promise<void>`
+- `fetchDocuments(query: DocumentQuery[]): Promise<Document[]>`
+- `createDataStructure(structureData: DataStructureCreation): Promise<DataStructure>`
+- `updateDataStructure(id: string, structureData: Partial<DataStructure>): Promise<void>`
+- `deleteDataStructure(id: string): Promise<void>`
+- `listDataStructures(): Promise<DataStructure[]>`
+- `listDocumentTypes(): Promise<DocumentTypeEdit[]>`
+- `createOrUpdateDocumentType(typeData: DocumentTypeEdit): Promise<void>`
+- `deleteDocumentType(id: string): Promise<void>`
+
+## Types
+
+### UserDisplay
+
+```typescript
+{
+    _id: number;
+    name: string;
+    email ? : string;
+    department: string;
+    group: string;
+}
+```
+
+### UserCreation
+
+```typescript
+{
+    name: string;
+    password: string;
+    email ? : string;
+    department: string;
+    group: string;
+    isAdmin: boolean;
+}
+```
+
+### UserUpdate
+
+```typescript
+{
+    name ? : string;
+    password ? : string;
+    email ? : string;
+    isAdmin ? : boolean;
+    department ? : string;
+    group ? : string;
+}
+```
+
+### Document
+
+```typescript
+{
+    _id: string;
+    type: number;
+    subType: number;
+    title: string;
+    content: string;
+    shareWithGroup: boolean;
+    shareWithDepartment: boolean;
+}
+```
+
+### NewDocument
+
+```typescript
+{
+    type: number;
+    subType: number;
+    title: string;
+    content: string;
+    shareWithGroup: boolean;
+    shareWithDepartment: boolean;
+}
+```
+
+### DocumentQuery
+
+```typescript
+{
+    _id ? : string;
+    type ? : number;
+    subType ? : number;
+    title ? : string;
+    description ? : string;
+    shareWithGroup ? : boolean;
+    shareWithDepartment ? : boolean;
+}
+```
+
+### DataStructure
+
+```typescript
+{
+    _id: number;
+    title: string;
+    fields: DataField[];
+}
+```
+
+### DataStructureCreation
+
+```typescript
+{
+    title: string;
+    fields: DataField[];
+}
+```
+
+### DataField
+
+```typescript
+{
+    name: string;
+    type: 'number' | 'string' | 'boolean' | 'array' | 'structure';
+    items ? : string; // For array and structure types
+}
+```
+
+### DocumentTypeEdit
+
+```typescript
+{
+    _id ? : string;
+    name: string;
+    description ? : string;
+    type: number;
+    subType: number;
+    defaultStructureID ? : string;
+}
+```

package/dist/index.js

@@ -94,7 +94,7 @@ export default class docPouchClient {
             if (this.realTimeSync) {
                 this.initWebSocket();
             }
-            return { token: response.token, isAdmin: response.isAdmin };
+            return { token: response.token, isAdmin: response.isAdmin, userName: response.userName };
         }
         return null;
     }

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.5",
+  "version": "0.8.6",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
@@ -23,8 +23,8 @@
   "description": "A small class to more easily access the docPouch API",
   "devDependencies": {
     "@types/jest": "^30.0.0",
-    "@types/node": "^24.0.3",
-    "jest": "^30.0.2",
+    "@types/node": "^24.0.7",
+    "jest": "^30.0.3",
     "ts-jest": "^29.4.0"
   },
   "dependencies": {

package/src/index.ts

@@ -134,7 +134,7 @@ export default class docPouchClient {
         this.initWebSocket();
       }
 
-      return {token: response.token, isAdmin: response.isAdmin};
+      return {token: response.token, isAdmin: response.isAdmin, userName: response.userName};
     }
     return null;
   }
@@ -195,7 +195,7 @@ export default class docPouchClient {
 
   // Data Type Endpoints
   async createType(type: I_DocumentType): Promise<I_DocumentType> {
-    return await this.request<I_DocumentType>('/types/write', 'PATCH', type);
+    return await this.request<I_DocumentType>('/types/write', 'POST', type);
   }
 
   async removeType(typeID: string) {
@@ -207,7 +207,7 @@ export default class docPouchClient {
   }
 
   async updateType(updatedType: I_DocumentType): Promise<void> {
-    await this.request<void>(`/types/write`, 'PATCH', updatedType);
+    await this.request<void>(`/types/write`, 'POST', updatedType);
   }
 
   setToken(token: string | null): void {

package/src/types.ts

@@ -20,6 +20,7 @@ export interface I_UserCreation {
 }
 
 export interface I_UserUpdate {
+    _id: string;
     name?: string;
     password?: string;
     email?: string;
@@ -39,6 +40,7 @@ export interface I_UserDisplay {
 export interface I_LoginResponse {
     token: string;
     isAdmin: boolean;
+    userName: string;
 }
 
 // Document related types
@@ -52,8 +54,11 @@ export interface I_DocumentCreation {
     type: number;
     subType: number;
     content: any;
+    shareWithGroup: boolean;
+    shareWithDepartment: boolean;
 }
 
+
 export interface I_DocumentCreationOwned extends I_DocumentCreation {
     owner: string;
 }
@@ -70,38 +75,44 @@ export interface I_DocumentQuery {
     title?: string;
     type?: number;
     subType?: number;
+    shareWithGroup?: boolean;
+    shareWithDepartment?: boolean;
 }
 
+
 // Structure related types
 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[];
 }
 
 // Document type related types
@@ -115,9 +126,9 @@ export interface I_DocumentType {
 }
 
 // WebSocket-related types
-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;
@@ -131,4 +142,5 @@ export interface I_WsMessage {
     confirmUnsubscription?: boolean;
     heartbeatPing?: number;
     heartbeatPong?: number;
+    newType?: I_DocumentType;
 }