docpouch-client 0.8.14 → 0.8.16

package/README.md

@@ -81,35 +81,44 @@ await client.removeUser('user-id');
 ```typescript
 // Create a new document
 const newDocument = await client.createDocument({
+    _id: 'document-id',
+    owner: 'user-id',
+    title: 'Mission Statement',
     type: 17,
     subType: 11,
-    title: "Mission Statement",
-    content: "{\"msg\": \"We strive for a world that...\"}",
+    content: '{"msg": "We strive for a world that..."}',
     shareWithGroup: false,
     shareWithDepartment: false
 });
 
 // Update a document
 await client.updateDocument('document-id', {
+    _id: 'document-id',
+    owner: 'user-id',
     title: 'Updated Mission Statement',
-    content: '{"msg": "Our updated mission..."}'
+    type: 17,
+    subType: 11,
+    content: '{"msg": "Our updated mission..."}',
+    shareWithGroup: false,
+    shareWithDepartment: false
 });
 
 // Delete a document
-await client.deleteDocument('document-id');
+await client.removeDocument('document-id');
+
+// List all documents
+const allDocuments = await client.listDocuments();
 
 // Fetch documents by query
-const documents = await client.fetchDocuments([
-    {type: 17, subType: 11}
-]);
+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",
+const newStructure = await client.createStructure({
+    name: "Data resulting from Vision-Mission-Value-Canvas",
     fields: [
         {
             name: "Mission value statement",
@@ -120,28 +129,30 @@ const newStructure = await client.createDataStructure({
 });
 
 // Update a data structure
-await client.updateDataStructure('structure-id', {
-    title: 'Updated Structure Title',
+await client.updateStructure('structure-id', {
+    _id: 'structure-id',
+    name: 'Updated Structure Title',
+    description: 'Updated structure description',
     fields: [
         {name: 'New Field Name', type: 'number'}
     ]
 });
 
 // Delete a data structure
-await client.deleteDataStructure('structure-id');
+await client.removeStructure('structure-id');
 
 // List all data structures
-const structures = await client.listDataStructures();
+const structures = await client.getStructures();
 ```
 
 ### Document Type Management
 
 ```typescript
 // List all document types
-const docTypes = await client.listDocumentTypes();
+const docTypes = await client.getTypes();
 
-// Create or update a document type
-const newDocType = await client.createOrUpdateDocumentType({
+// Create a new document type
+const newDocType = await client.createType({
     name: "HR Wages",
     description: "HR Wage information Document listing wages per personnel ID",
     type: 14,
@@ -149,8 +160,16 @@ const newDocType = await client.createOrUpdateDocumentType({
     defaultStructureID: 'structure-id'
 });
 
+// Update a document type
+await client.updateType({
+    _id: 'doc-type-id',
+    name: 'Updated HR Wages',
+    type: 14,
+    subType: 2
+});
+
 // Delete a document type
-await client.deleteDocumentType('doc-type-id');
+await client.removeType('doc-type-id');
 ```
 
 ## API Reference
@@ -159,147 +178,272 @@ await client.deleteDocumentType('doc-type-id');
 
 #### Constructor
 
-- `new docPouchClient(baseUrl: string, port: number, callback?: (event: string, data: any) => void)`
+- `new docPouchClient(host: string, port?: number, callback?: (event: I_EventString, data: I_WsMessage) => 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>`
+- `setRealTimeSync(newRealTimeSync: boolean): void`
+- `login(credentials: I_UserLogin): Promise<I_LoginResponse | null>`
+- `listUsers(): Promise<I_UserEntry[]>`
+- `updateUser(userID: string, userData: I_UserUpdate): Promise<void>`
+- `createUser(userData: I_UserCreation): Promise<I_UserDisplay>`
+- `removeUser(userID: string): Promise<void>`
+- `createDocument(document: I_DocumentEntry): Promise<I_DocumentEntry>`
+- `listDocuments(): Promise<I_DocumentEntry[]>`
+- `fetchDocuments(queryObject: I_DocumentQuery): Promise<I_DocumentEntry[]>`
+- `updateDocument(documentID: string, documentData: I_DocumentEntry): Promise<void>`
+- `removeDocument(documentID: string): Promise<void>`
+- `createStructure(structure: I_StructureCreation): Promise<I_DataStructure>`
+- `getStructures(): Promise<I_DataStructure[]>`
+- `updateStructure(structureID: string, structureData: I_DataStructure): Promise<void>`
+- `removeStructure(structureID: string): Promise<void>`
+- `createType(type: I_DocumentType): Promise<I_DocumentType>`
+- `removeType(typeID: string): Promise<void>`
+- `getTypes(): Promise<I_DocumentType[]>`
+- `updateType(updatedType: I_DocumentType): Promise<void>`
+- `setToken(token: string | null): void`
+- `getVersion(): string`
+- `debugSocketConnection(): void`
 
 ## Types
 
-### UserDisplay
+### I_UserEntry
 
 ```typescript
 {
-    _id: number;
+    _id: string;
     name: string;
-    email ? : string;
+    password: string;
+    email?: string;
     department: string;
     group: string;
+    isAdmin: boolean;
 }
 ```
 
-### UserCreation
+### I_UserLogin
 
 ```typescript
 {
     name: string;
     password: string;
-    email ? : string;
+}
+```
+
+### I_UserDisplay
+
+```typescript
+{
+    _id: string;
+    username: string;
+    department: string;
+    group: string;
+    email?: string;
+}
+```
+
+### I_UserCreation
+
+```typescript
+{
+    name: string;
+    password: string;
+    email?: string;
     department: string;
     group: string;
     isAdmin: boolean;
 }
 ```
 
-### UserUpdate
+### I_UserUpdate
+
+```typescript
+{
+    _id?: string;
+    name?: string;
+    password?: string;
+    email?: string;
+    department?: string;
+    group?: string;
+    isAdmin?: boolean;
+}
+```
+
+### I_LoginResponse
 
 ```typescript
 {
-    name ? : string;
-    password ? : string;
-    email ? : string;
-    isAdmin ? : boolean;
-    department ? : string;
-    group ? : string;
+    token: string;
+    isAdmin: boolean;
+    userName: string;
 }
 ```
 
-### Document
+### I_DocumentEntry
 
 ```typescript
 {
     _id: string;
+    owner: string;
+    title: string;
+    description?: string;
     type: number;
     subType: number;
-    title: string;
-    content: string;
+    content: any;
     shareWithGroup: boolean;
     shareWithDepartment: boolean;
 }
 ```
 
-### NewDocument
+### I_DocumentCreation
 
 ```typescript
 {
+    title: string;
+    description?: string;
     type: number;
     subType: number;
+    content: any;
+    shareWithGroup: boolean;
+    shareWithDepartment: boolean;
+}
+```
+
+### I_DocumentCreationOwned
+
+```typescript
+{
+    owner: string;
     title: string;
-    content: string;
+    description?: string;
+    type: number;
+    subType: number;
+    content: any;
     shareWithGroup: boolean;
     shareWithDepartment: boolean;
 }
 ```
 
-### DocumentQuery
+### I_DocumentUpdate
 
 ```typescript
 {
-    _id ? : string;
-    type ? : number;
-    subType ? : number;
-    title ? : string;
-    description ? : string;
-    shareWithGroup ? : boolean;
-    shareWithDepartment ? : boolean;
+    _id?: string;
+    owner?: string;
+    title?: string;
+    type?: number;
+    subType?: number;
+    shareWithGroup?: boolean;
+    shareWithDepartment?: boolean;
+    content?: any;
+    description?: string;
 }
 ```
 
-### DataStructure
+### I_DocumentQuery
 
 ```typescript
 {
-    _id: number;
-    title: string;
-    fields: DataField[];
+    _id?: string;
+    owner?: string;
+    title?: string;
+    type?: number;
+    subType?: number;
+    shareWithGroup?: boolean;
+    shareWithDepartment?: boolean;
 }
 ```
 
-### DataStructureCreation
+### I_DataStructure
 
 ```typescript
 {
-    title: string;
-    fields: DataField[];
+    _id?: string;
+    name: string;
+    description: string;
+    fields: I_StructureField[];
+}
+```
+
+### I_StructureCreation
+
+```typescript
+{
+    name: string;
+    description?: string;
+    fields: I_StructureField[];
+}
+```
+
+### I_StructureUpdate
+
+```typescript
+{
+    _id?: string;
+    name?: string;
+    description?: string;
+    fields?: I_StructureField[];
+}
+```
+
+### I_StructureField
+
+```typescript
+{
+    name: string;
+    type: string;
+    items?: string;
 }
 ```
 
-### DataField
+### I_StructureEntry
 
 ```typescript
 {
+    _id?: string;
     name: string;
-    type: 'number' | 'string' | 'boolean' | 'array' | 'structure';
-    items ? : string; // For array and structure types
+    description: string;
+    fields: I_StructureField[];
 }
 ```
 
-### DocumentTypeEdit
+### I_DocumentType
 
 ```typescript
 {
-    _id ? : string;
+    _id?: string;
     name: string;
-    description ? : string;
+    description?: string;
     type: number;
     subType: number;
-    defaultStructureID ? : string;
+    defaultStructureID?: string;
+}
+```
+
+### I_EventString
+
+```typescript
+'heartbeatPong' | 'heartbeatPing' | 'newDocument' | 'newStructure' |
+'newUser' | 'newType' | 'removedID' | 'changedDocument' |
+'changedStructure' | 'changedUser' | 'changedType' | 'removedUser' |
+'removedStructure' | 'removedDocument' | 'removedType'
+```
+
+### I_WsMessage
+
+```typescript
+{
+    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.d.ts

@@ -55,26 +55,148 @@ export default class docPouchClient {
      * @param {boolean} newRealTimeSync - The new real-time sync setting (true/false).
      */
     setRealTimeSync(newRealTimeSync: boolean): void;
+    /**
+     * 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.
+     */
     login(credentials: I_UserLogin): Promise<I_LoginResponse | null>;
+    /**
+     * Retrieves all users visible to the authenticated user.
+     *
+     * @returns {Promise<I_UserEntry[]>} A list of user entries.
+     */
     listUsers(): Promise<I_UserEntry[]>;
+    /**
+     * 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>}
+     */
     updateUser(userID: string, userData: I_UserUpdate): Promise<void>;
+    /**
+     * 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.
+     */
     createUser(userData: I_UserCreation): Promise<I_UserDisplay>;
+    /**
+     * Removes a user by ID.
+     *
+     * @param {string} userID - The ID of the user to remove.
+     * @returns {Promise<void>}
+     */
     removeUser(userID: string): Promise<void>;
+    /**
+     * Creates a new document.
+     *
+     * @param {I_DocumentEntry} document - The document payload to create.
+     * @returns {Promise<I_DocumentEntry>} The created document.
+     */
     createDocument(document: I_DocumentEntry): Promise<I_DocumentEntry>;
+    /**
+     * Retrieves all documents visible to the authenticated user.
+     *
+     * @returns {Promise<I_DocumentEntry[]>} A list of document entries.
+     */
     listDocuments(): Promise<I_DocumentEntry[]>;
+    /**
+     * Fetches documents matching a query object.
+     *
+     * @param {I_DocumentQuery} queryObject - Query fields used for filtering.
+     * @returns {Promise<I_DocumentEntry[]>} Matching documents.
+     */
     fetchDocuments(queryObject: I_DocumentQuery): Promise<I_DocumentEntry[]>;
+    /**
+     * 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>}
+     */
     updateDocument(documentID: string, documentData: I_DocumentEntry): Promise<void>;
+    /**
+     * Removes a document by ID.
+     *
+     * @param {string} documentID - The ID of the document to remove.
+     * @returns {Promise<void>}
+     */
     removeDocument(documentID: string): Promise<void>;
+    /**
+     * Creates a new data structure.
+     *
+     * @param {I_StructureCreation} structure - Data structure payload to create.
+     * @returns {Promise<I_DataStructure>} The created data structure.
+     */
     createStructure(structure: I_StructureCreation): Promise<I_DataStructure>;
+    /**
+     * Retrieves all data structures.
+     *
+     * @returns {Promise<I_DataStructure[]>} A list of data structures.
+     */
     getStructures(): Promise<I_DataStructure[]>;
+    /**
+     * 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>}
+     */
     updateStructure(structureID: string, structureData: I_DataStructure): Promise<void>;
+    /**
+     * Removes a data structure by ID.
+     *
+     * @param {string} structureID - The ID of the structure to remove.
+     * @returns {Promise<void>}
+     */
     removeStructure(structureID: string): Promise<void>;
+    /**
+     * Creates or writes a document type.
+     *
+     * @param {I_DocumentType} type - The type payload.
+     * @returns {Promise<I_DocumentType>} The created or updated type.
+     */
     createType(type: I_DocumentType): Promise<I_DocumentType>;
+    /**
+     * Removes a document type by ID.
+     *
+     * @param {string} typeID - The ID of the type to remove.
+     * @returns {Promise<void>}
+     */
     removeType(typeID: string): Promise<void>;
+    /**
+     * Retrieves all document types.
+     *
+     * @returns {Promise<I_DocumentType[]>} A list of document types.
+     */
     getTypes(): Promise<I_DocumentType[]>;
+    /**
+     * Updates a document type.
+     *
+     * @param {I_DocumentType} updatedType - The full type payload to persist.
+     * @returns {Promise<void>}
+     */
     updateType(updatedType: I_DocumentType): Promise<void>;
+    /**
+     * 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: string | null): void;
+    /**
+     * Returns the package version of this client.
+     *
+     * @returns {string} The semantic version string.
+     */
     getVersion(): string;
+    /**
+     * Logs socket diagnostics and attempts a reconnect when possible.
+     *
+     * @returns {void}
+     */
     debugSocketConnection(): void;
     /**
      * Sets up permanent socket listeners for the client.
@@ -88,6 +210,17 @@ export default class docPouchClient {
      * @private
      */
     private initWebSocket;
+    /**
+     * 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
+     */
     private request;
 }
 export interface I_UserEntry extends I_UserCreation {