docpouch-client 0.8.5 → 0.8.7

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.d.ts

@@ -1,4 +1,3 @@
-import type { I_UserEntry, I_UserLogin, I_UserCreation, I_UserUpdate, I_UserDisplay, I_DocumentEntry, I_DataStructure, I_LoginResponse, I_DocumentQuery, I_StructureCreation, I_WsMessage, I_EventString, I_DocumentType } from "./types.js";
 import { Socket } from "socket.io-client";
 /**
  * Client for interacting with docPouch API.
@@ -91,3 +90,119 @@ export default class docPouchClient {
     private initWebSocket;
     private request;
 }
+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;
+}
+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 {
+    _id: string;
+    content?: any;
+    description?: string;
+}
+export interface I_DocumentQuery {
+    _id?: string;
+    owner?: string;
+    title?: string;
+    type?: number;
+    subType?: number;
+    shareWithGroup?: boolean;
+    shareWithDepartment?: boolean;
+}
+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[];
+}
+export interface I_DocumentType {
+    _id?: string;
+    type: number;
+    subType: number;
+    name: string;
+    description?: string;
+    defaultStructureID?: string;
+}
+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;
+}

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;
     }
@@ -141,7 +141,7 @@ export default class docPouchClient {
     }
     // Data Type Endpoints
     async createType(type) {
-        return await this.request('/types/write', 'PATCH', type);
+        return await this.request('/types/write', 'POST', type);
     }
     async removeType(typeID) {
         return await this.request(`/types/remove/${typeID}`, 'DELETE');
@@ -150,7 +150,7 @@ export default class docPouchClient {
         return await this.request('/types/list', 'GET');
     }
     async updateType(updatedType) {
-        await this.request(`/types/write`, 'PATCH', updatedType);
+        await this.request(`/types/write`, 'POST', updatedType);
     }
     setToken(token) {
         console.log("Setting token to:", token ? "***token***" : "null");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docpouch-client",
-  "version": "0.8.5",
+  "version": "0.8.7",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
@@ -21,14 +21,18 @@
   "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.0.3",
-    "jest": "^30.0.2",
-    "ts-jest": "^29.4.0"
+    "@types/node": "^24.0.7",
+    "jest": "^30.0.3",
+    "ts-jest": "^29.4.0",
+    "typescript": "^5.8.3"
   },
   "dependencies": {
-    "socket.io-client": "^4.8.1",
-    "typescript": "^5.8.3"
+    "socket.io-client": "^4.8.1"
   }
 }

package/src/index.ts

@@ -1,13 +1,3 @@
-import type {
-    I_UserEntry,
-    I_UserLogin,
-    I_UserCreation,
-    I_UserUpdate,
-    I_UserDisplay,
-    I_DocumentEntry,
-    I_DataStructure,
-  I_LoginResponse, I_DocumentQuery, I_StructureCreation, I_WsMessage, I_EventString, I_DocumentType
-} from "./types.js";
 import {io, Socket} from "socket.io-client";
 import packetJson from '../package.json'
 
@@ -134,7 +124,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 +185,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 +197,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 {
@@ -393,5 +383,151 @@ export default class docPouchClient {
 
     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{
+  _id: string;
+  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;
 }

package/tsconfig.json

@@ -17,5 +17,5 @@
     "allowSyntheticDefaultImports": true
   },
   "include": ["**/*.ts", "**/*.tsx"],
-  "exclude": ["node_modules", "**/*.test.ts", "**/*.types.ts", "./dist/**/*"]
+  "exclude": ["node_modules", "**/*.test.ts", "./dist/**/*"]
 }

package/dist/types.d.ts

@@ -1,108 +0,0 @@
-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 {
-    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;
-}
-export interface I_DocumentEntry extends I_DocumentCreationOwned {
-    _id: string;
-}
-export interface I_DocumentCreation {
-    title: string;
-    description?: string;
-    type: number;
-    subType: number;
-    content: any;
-}
-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;
-    description: string;
-    reference?: any;
-    fields: any[];
-}
-export interface I_StructureEntry {
-    _id?: string;
-    name: string;
-    description: string;
-    reference?: any;
-    fields: any[];
-}
-export interface I_StructureCreation {
-    name: string;
-    description?: string;
-    reference?: any;
-    fields: any[];
-}
-export interface I_StructureUpdate {
-    _id: string;
-    name?: string;
-    description?: string;
-    reference?: any;
-    fields?: any[];
-}
-export interface I_DocumentType {
-    _id?: string;
-    type: number;
-    subType: number;
-    name: string;
-    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 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/dist/types.js

@@ -1,2 +0,0 @@
-// Common type definitions for both frontend and backend
-export {};

package/src/types.ts

@@ -1,134 +0,0 @@
-// 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 {
-    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;
-}
-
-// 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;
-}
-
-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;
-    name: string;
-    description: string;
-    reference?: any;
-    fields: any[];
-}
-
-export interface I_StructureEntry {
-    _id?: string;
-    name: string;
-    description: string;
-    reference?: any;
-    fields: any[];
-}
-
-export interface I_StructureCreation {
-    name: string;
-    description?: string;
-    reference?: any;
-    fields: any[];
-}
-
-export interface I_StructureUpdate {
-    _id: string;
-    name?: string;
-    description?: string;
-    reference?: any;
-    fields?: any[];
-}
-
-// 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 = 'subscribe' | 'unsubscribe' | 'heartbeatPong' | "heartbeatPing" | "newDocument" | "newStructure" |
-    "newUser" | "removedID" | "changedDocument" | "changedStructure" | "changedUser" | "confirmSubscription" |
-    "confirmUnsubscription" | "removedUser" | "removedStructure" | "removedDocument";
-
-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;
-}