docpouch-client 1.0.1 → 1.0.4

package/README.md

@@ -1,630 +1,630 @@
-# docpouch-client
-
-A TypeScript client library for interacting with the [docPouch](https://github.com/BFH-JTF/doc-pouch) database API.
-Supports JWT and OIDC (OpenID Connect) authentication.
-
-## Table of Contents
-
-- [Description](#description)
-- [Installation](#installation)
-- [Usage](#usage)
-    - [Initializing the Client](#initializing-the-client)
-    - [JWT Authentication](#jwt-authentication)
-    - [OIDC Authentication](#oidc-authentication)
-    - [OIDC Dynamic Client Registration](#oidc-dynamic-client-registration)
-    - [User Management](#user-management)
-    - [Document Management](#document-management)
-    - [Data Structure Management](#data-structure-management)
-    - [Real-Time Synchronization](#real-time-synchronization)
-- [Error Handling](#error-handling)
-- [API Reference](#api-reference)
-- [Types](#types)
-- [License](#license)
-
-## Description
-
-docpouch-client provides a simple and intuitive interface to access the docPouch API, allowing you to manage users,
-documents, and data structures. It supports real-time synchronization via WebSockets and two authentication
-methods: traditional JWT (username/password) and OpenID Connect (OIDC).
-
-## 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);
-    }
-);
-```
-
-### JWT 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');
-
-// Check authentication state
-console.log(client.isAuthenticated());   // boolean
-console.log(client.getAuthMethod());     // 'jwt' | 'oidc' | 'none'
-console.log(client.getToken());          // string | null
-```
-
-### OIDC Authentication
-
-```typescript
-// Initiate OIDC login (redirects the browser to the identity provider)
-await client.loginWithOidc({
-    issuer: 'https://your-oidc-provider.com',
-    clientId: 'your-client-id',
-    redirectUri: 'https://yourapp.com/callback',
-    scopes: ['openid', 'profile', 'email']
-});
-
-// Handle the OIDC callback on your redirect page
-const handled = await client.handleOidcCallback();
-if (handled) {
-    console.log('OIDC login successful');
-}
-
-// The access token is automatically refreshed when needed
-const validToken = await client.ensureValidOidcToken();
-
-// Log out (clears tokens, disconnects WebSocket, cleans up URL params)
-await client.logout();
-```
-
-### OIDC Dynamic Client Registration
-
-```typescript
-// Register a new OIDC client
-const registered = await client.registerOidcClient({
-    client_name: 'My Application',
-    redirect_uris: ['https://yourapp.com/callback'],
-    grant_types: ['authorization_code'],
-    response_types: ['code'],
-    token_endpoint_auth_method: 'client_secret_basic'
-});
-console.log(registered.client_id);
-
-// Retrieve an existing client registration
-const clientInfo = await client.getOidcClient('client-id');
-
-// Update a client registration
-await client.updateOidcClient('client-id', {
-    client_name: 'Updated Application Name'
-});
-
-// Delete a client registration
-await client.deleteOidcClient('client-id');
-```
-
-### 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({
-    _id: 'document-id',
-    owner: 'user-id',
-    title: 'Mission Statement',
-    type: 17,
-    subType: 11,
-    content: '{"msg": "We strive for a world that..."}',
-    shareWithGroup: false,
-    shareWithDepartment: false,
-    public: false
-});
-
-// Update a document
-await client.updateDocument('document-id', {
-    _id: 'document-id',
-    owner: 'user-id',
-    title: 'Updated Mission Statement',
-    type: 17,
-    subType: 11,
-    content: '{"msg": "Our updated mission..."}',
-    shareWithGroup: false,
-    shareWithDepartment: false,
-    public: false
-});
-
-// Delete a document
-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});
-```
-
-### Data Structure Management
-
-```typescript
-// Create a new data structure
-const newStructure = await client.createStructure({
-    name: "Data resulting from Vision-Mission-Value-Canvas",
-    fields: [
-        {
-            name: "mission_value_statement",
-            displayName: "Mission value statement",
-            type: "string"
-        },
-    ]
-});
-
-// Update a data structure
-await client.updateStructure('structure-id', {
-    _id: 'structure-id',
-    name: 'Updated Structure Title',
-    description: 'Updated structure description',
-    type: 17,
-    subType: 11,
-    fields: [
-        {name: 'new_field', displayName: 'New Field Name', type: 'number'}
-    ]
-});
-
-// Delete a data structure
-await client.removeStructure('structure-id');
-
-// List all data structures
-const structures = await client.getStructures();
-```
-
-### Real-Time Synchronization
-
-```typescript
-// Enable real-time sync (WebSocket connection is established automatically)
-client.setRealTimeSync(true);
-
-// Disable real-time sync
-client.setRealTimeSync(false);
-
-// Debug the socket connection state
-client.debugSocketConnection();
-
-// Get the client library version
-console.log(client.getVersion());
-```
-
-## Error Handling
-
-All API methods throw exceptions on failure. Use try/catch to handle errors:
-
-```typescript
-try {
-    const documents = await client.listDocuments();
-} catch (error) {
-    if (error instanceof Error) {
-        console.error(`API error: ${error.message}`);
-        // error.message will be something like "API error: 401 Unauthorized"
-    }
-}
-```
-
-Authentication failures (HTTP 401/403) automatically clear the stored JWT token.
-
-## API Reference
-
-### Client Class
-
-#### Constructor
-
-- `new docPouchClient(host: string, port?: number, callback?: (event: I_EventString, data: I_WsMessage) => void)`
-
-#### Methods
-
-**Authentication & Session**
-
-- `login(credentials: I_UserLogin): Promise<I_LoginResponse | null>` — JWT login
-- `setToken(token: string | null): void` — Set or clear the JWT token
-- `getToken(): string | null` — Returns the active token (JWT or OIDC)
-- `getAuthMethod(): 'jwt' | 'oidc' | 'none'` — Returns current auth method
-- `isAuthenticated(): boolean` — Checks if the client is authenticated
-- `logout(): Promise<void>` — Clears all tokens and disconnects WebSocket
-- `getVersion(): string` — Returns the package version
-
-**OIDC Authentication**
-
-- `loginWithOidc(config: I_OidcConfig): Promise<void>` — Initiates OIDC authorization code flow (PKCE)
-- `handleOidcCallback(): Promise<boolean>` — Handles the OIDC redirect callback
-- `ensureValidOidcToken(): Promise<string>` — Returns a valid OIDC access token, refreshing if needed
-
-**OIDC Dynamic Client Registration**
-
--
-`registerOidcClient(registration: I_OidcClientRegistration, registrationToken?: string): Promise<I_OidcClientResponse>`
-- `getOidcClient(clientId: string, registrationToken?: string): Promise<I_OidcClientResponse>`
--
-`updateOidcClient(clientId: string, registration: I_OidcClientRegistration, registrationToken?: string): Promise<I_OidcClientResponse>`
-- `deleteOidcClient(clientId: string, registrationToken?: string): Promise<void>`
-
-**Real-Time Sync**
-- `setRealTimeSync(newRealTimeSync: boolean): void`
-- `debugSocketConnection(): void`
-
-**User Management**
-- `listUsers(): Promise<I_UserEntry[]>`
-- `updateUser(userID: string, userData: I_UserUpdate): Promise<void>`
-- `createUser(userData: I_UserCreation): Promise<I_UserDisplay>`
-- `removeUser(userID: string): Promise<void>`
-
-**Document Management**
-- `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>`
-
-**Data Structure Management**
-- `createStructure(structure: I_StructureCreation): Promise<I_DataStructure>`
-- `getStructures(): Promise<I_DataStructure[]>`
-- `updateStructure(structureID: string, structureData: I_DataStructure): Promise<void>`
-- `removeStructure(structureID: string): Promise<void>`
-
-## Types
-
-### I_UserEntry
-
-```typescript
-{
-    _id: string;
-    name: string;
-    password: string;
-    email?: string;
-    department: string;
-    group: string;
-    isAdmin: boolean;
-}
-```
-
-### I_UserLogin
-
-```typescript
-{
-    name: string;
-    password: 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;
-}
-```
-
-### I_UserUpdate
-
-```typescript
-{
-    _id?: string;
-    name?: string;
-    password?: string;
-    email?: string;
-    department?: string;
-    group?: string;
-    isAdmin?: boolean;
-}
-```
-
-### I_LoginResponse
-
-```typescript
-{
-    _id: string;
-    token?: string;
-    isAdmin: boolean;
-    userName: string;
-    expiresIn?: number;
-}
-```
-
-### I_OidcConfig
-
-```typescript
-{
-    issuer: string;
-    clientId: string;
-    redirectUri: string;
-    scopes?: string[];
-    clientSecret?: string;
-}
-```
-
-### I_OidcTokenResponse
-
-```typescript
-{
-    accessToken: string;
-    refreshToken?: string;
-    idToken?: string;
-    expiresIn: number;
-    tokenType: string;
-    scope: string;
-}
-```
-
-### I_OidcUserInfo
-
-```typescript
-{
-    sub: string;
-    name?: string;
-    email?: string;
-}
-```
-
-### I_OidcClientRegistration
-
-```typescript
-{
-    client_name: string;
-    redirect_uris: string[];
-    grant_types?: string[];
-    response_types?: string[];
-    scope?: string;
-    token_endpoint_auth_method?: 'client_secret_basic' | 'client_secret_post' | 'none';
-    application_type?: 'web' | 'native';
-    logo_uri?: string;
-    client_uri?: string;
-    policy_uri?: string;
-    tos_uri?: string;
-}
-```
-
-### I_OidcClientResponse
-
-```typescript
-{
-    client_id: string;
-    client_secret?: string;
-    client_secret_expires_at?: number;
-    client_id_issued_at?: number;
-    registration_access_token?: string;
-    registration_client_uri?: string;
-    client_name?: string;
-    redirect_uris?: string[];
-    grant_types?: string[];
-    response_types?: string[];
-    scope?: string;
-    token_endpoint_auth_method?: string;
-}
-```
-
-### I_AuthState
-
-```typescript
-{
-    method: 'jwt' | 'oidc' | 'none';
-    token: string | null;
-    isAdmin: boolean;
-    userName: string;
-}
-```
-
-### I_DocumentEntry
-
-```typescript
-{
-    _id: string;
-    owner: string;
-    title: string;
-    description?: string;
-    type: number;
-    subType: number;
-    content: any;
-    shareWithGroup: boolean;
-    shareWithDepartment: boolean;
-    public: boolean;
-}
-```
-
-### I_DocumentCreation
-
-```typescript
-{
-    title: string;
-    description?: string;
-    type: number;
-    subType: number;
-    content: any;
-    shareWithGroup: boolean;
-    shareWithDepartment: boolean;
-    public: boolean;
-}
-```
-
-### I_DocumentCreationOwned
-
-```typescript
-{
-    owner: string;
-    title: string;
-    description?: string;
-    type: number;
-    subType: number;
-    content: any;
-    shareWithGroup: boolean;
-    shareWithDepartment: boolean;
-    public: boolean;
-}
-```
-
-### I_DocumentUpdate
-
-```typescript
-{
-    _id?: string;
-    owner?: string;
-    title?: string;
-    type?: number;
-    subType?: number;
-    shareWithGroup?: boolean;
-    shareWithDepartment?: boolean;
-    public?: boolean;
-    content?: any;
-    description?: string;
-}
-```
-
-### I_DocumentQuery
-
-```typescript
-{
-    _id?: string;
-    owner?: string;
-    title?: string;
-    type?: number;
-    subType?: number;
-    shareWithGroup?: boolean;
-    shareWithDepartment?: boolean;
-    public?: boolean;
-}
-```
-
-### I_DataStructure
-
-```typescript
-{
-    _id?: string;
-    name: string;
-    description: string;
-    type: number;
-    subType: number;
-    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;
-    displayName: string;
-    type: string;
-    items?: 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_DataStructure;
-    newUser?: I_UserEntry;
-    removedID?: string;
-    changedDocument?: I_DocumentUpdate;
-    changedStructure?: I_StructureUpdate;
-    changedUser?: I_UserUpdate;
-    confirmSubscription?: boolean;
-    confirmUnsubscription?: boolean;
-    heartbeatPing?: number;
-    heartbeatPong?: number;
-}
-```
-
-## License
-
-[MIT](LICENSE)
+# docpouch-client
+
+A TypeScript client library for interacting with the [docPouch](https://github.com/BFH-JTF/doc-pouch) database API.
+Supports JWT and OIDC (OpenID Connect) authentication.
+
+## Table of Contents
+
+- [Description](#description)
+- [Installation](#installation)
+- [Usage](#usage)
+    - [Initializing the Client](#initializing-the-client)
+    - [JWT Authentication](#jwt-authentication)
+    - [OIDC Authentication](#oidc-authentication)
+    - [OIDC Dynamic Client Registration](#oidc-dynamic-client-registration)
+    - [User Management](#user-management)
+    - [Document Management](#document-management)
+    - [Data Structure Management](#data-structure-management)
+    - [Real-Time Synchronization](#real-time-synchronization)
+- [Error Handling](#error-handling)
+- [API Reference](#api-reference)
+- [Types](#types)
+- [License](#license)
+
+## Description
+
+docpouch-client provides a simple and intuitive interface to access the docPouch API, allowing you to manage users,
+documents, and data structures. It supports real-time synchronization via WebSockets and two authentication
+methods: traditional JWT (username/password) and OpenID Connect (OIDC).
+
+## 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);
+    }
+);
+```
+
+### JWT 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');
+
+// Check authentication state
+console.log(client.isAuthenticated());   // boolean
+console.log(client.getAuthMethod());     // 'jwt' | 'oidc' | 'none'
+console.log(client.getToken());          // string | null
+```
+
+### OIDC Authentication
+
+```typescript
+// Initiate OIDC login (redirects the browser to the identity provider)
+await client.loginWithOidc({
+    issuer: 'https://your-oidc-provider.com',
+    clientId: 'your-client-id',
+    redirectUri: 'https://yourapp.com/callback',
+    scopes: ['openid', 'profile', 'email']
+});
+
+// Handle the OIDC callback on your redirect page
+const handled = await client.handleOidcCallback();
+if (handled) {
+    console.log('OIDC login successful');
+}
+
+// The access token is automatically refreshed when needed
+const validToken = await client.ensureValidOidcToken();
+
+// Log out (clears tokens, disconnects WebSocket, cleans up URL params)
+await client.logout();
+```
+
+### OIDC Dynamic Client Registration
+
+```typescript
+// Register a new OIDC client
+const registered = await client.registerOidcClient({
+    client_name: 'My Application',
+    redirect_uris: ['https://yourapp.com/callback'],
+    grant_types: ['authorization_code'],
+    response_types: ['code'],
+    token_endpoint_auth_method: 'client_secret_basic'
+});
+console.log(registered.client_id);
+
+// Retrieve an existing client registration
+const clientInfo = await client.getOidcClient('client-id');
+
+// Update a client registration
+await client.updateOidcClient('client-id', {
+    client_name: 'Updated Application Name'
+});
+
+// Delete a client registration
+await client.deleteOidcClient('client-id');
+```
+
+### 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({
+    _id: 'document-id',
+    owner: 'user-id',
+    title: 'Mission Statement',
+    type: 17,
+    subType: 11,
+    content: '{"msg": "We strive for a world that..."}',
+    shareWithGroup: false,
+    shareWithDepartment: false,
+    public: false
+});
+
+// Update a document
+await client.updateDocument('document-id', {
+    _id: 'document-id',
+    owner: 'user-id',
+    title: 'Updated Mission Statement',
+    type: 17,
+    subType: 11,
+    content: '{"msg": "Our updated mission..."}',
+    shareWithGroup: false,
+    shareWithDepartment: false,
+    public: false
+});
+
+// Delete a document
+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});
+```
+
+### Data Structure Management
+
+```typescript
+// Create a new data structure
+const newStructure = await client.createStructure({
+    name: "Data resulting from Vision-Mission-Value-Canvas",
+    fields: [
+        {
+            name: "mission_value_statement",
+            displayName: "Mission value statement",
+            type: "string"
+        },
+    ]
+});
+
+// Update a data structure
+await client.updateStructure('structure-id', {
+    _id: 'structure-id',
+    name: 'Updated Structure Title',
+    description: 'Updated structure description',
+    type: 17,
+    subType: 11,
+    fields: [
+        {name: 'new_field', displayName: 'New Field Name', type: 'number'}
+    ]
+});
+
+// Delete a data structure
+await client.removeStructure('structure-id');
+
+// List all data structures
+const structures = await client.getStructures();
+```
+
+### Real-Time Synchronization
+
+```typescript
+// Enable real-time sync (WebSocket connection is established automatically)
+client.setRealTimeSync(true);
+
+// Disable real-time sync
+client.setRealTimeSync(false);
+
+// Debug the socket connection state
+client.debugSocketConnection();
+
+// Get the client library version
+console.log(client.getVersion());
+```
+
+## Error Handling
+
+All API methods throw exceptions on failure. Use try/catch to handle errors:
+
+```typescript
+try {
+    const documents = await client.listDocuments();
+} catch (error) {
+    if (error instanceof Error) {
+        console.error(`API error: ${error.message}`);
+        // error.message will be something like "API error: 401 Unauthorized"
+    }
+}
+```
+
+Authentication failures (HTTP 401/403) automatically clear the stored JWT token.
+
+## API Reference
+
+### Client Class
+
+#### Constructor
+
+- `new docPouchClient(host: string, port?: number, callback?: (event: I_EventString, data: I_WsMessage) => void)`
+
+#### Methods
+
+**Authentication & Session**
+
+- `login(credentials: I_UserLogin): Promise<I_LoginResponse | null>` — JWT login
+- `setToken(token: string | null): void` — Set or clear the JWT token
+- `getToken(): string | null` — Returns the active token (JWT or OIDC)
+- `getAuthMethod(): 'jwt' | 'oidc' | 'none'` — Returns current auth method
+- `isAuthenticated(): boolean` — Checks if the client is authenticated
+- `logout(): Promise<void>` — Clears all tokens and disconnects WebSocket
+- `getVersion(): string` — Returns the package version
+
+**OIDC Authentication**
+
+- `loginWithOidc(config: I_OidcConfig): Promise<void>` — Initiates OIDC authorization code flow (PKCE)
+- `handleOidcCallback(): Promise<boolean>` — Handles the OIDC redirect callback
+- `ensureValidOidcToken(): Promise<string>` — Returns a valid OIDC access token, refreshing if needed
+
+**OIDC Dynamic Client Registration**
+
+-
+`registerOidcClient(registration: I_OidcClientRegistration, registrationToken?: string): Promise<I_OidcClientResponse>`
+- `getOidcClient(clientId: string, registrationToken?: string): Promise<I_OidcClientResponse>`
+-
+`updateOidcClient(clientId: string, registration: I_OidcClientRegistration, registrationToken?: string): Promise<I_OidcClientResponse>`
+- `deleteOidcClient(clientId: string, registrationToken?: string): Promise<void>`
+
+**Real-Time Sync**
+- `setRealTimeSync(newRealTimeSync: boolean): void`
+- `debugSocketConnection(): void`
+
+**User Management**
+- `listUsers(): Promise<I_UserEntry[]>`
+- `updateUser(userID: string, userData: I_UserUpdate): Promise<void>`
+- `createUser(userData: I_UserCreation): Promise<I_UserDisplay>`
+- `removeUser(userID: string): Promise<void>`
+
+**Document Management**
+- `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>`
+
+**Data Structure Management**
+- `createStructure(structure: I_StructureCreation): Promise<I_DataStructure>`
+- `getStructures(): Promise<I_DataStructure[]>`
+- `updateStructure(structureID: string, structureData: I_DataStructure): Promise<void>`
+- `removeStructure(structureID: string): Promise<void>`
+
+## Types
+
+### I_UserEntry
+
+```typescript
+{
+    _id: string;
+    name: string;
+    password: string;
+    email?: string;
+    department: string;
+    group: string;
+    isAdmin: boolean;
+}
+```
+
+### I_UserLogin
+
+```typescript
+{
+    name: string;
+    password: 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;
+}
+```
+
+### I_UserUpdate
+
+```typescript
+{
+    _id?: string;
+    name?: string;
+    password?: string;
+    email?: string;
+    department?: string;
+    group?: string;
+    isAdmin?: boolean;
+}
+```
+
+### I_LoginResponse
+
+```typescript
+{
+    _id: string;
+    token?: string;
+    isAdmin: boolean;
+    userName: string;
+    expiresIn?: number;
+}
+```
+
+### I_OidcConfig
+
+```typescript
+{
+    issuer: string;
+    clientId: string;
+    redirectUri: string;
+    scopes?: string[];
+    clientSecret?: string;
+}
+```
+
+### I_OidcTokenResponse
+
+```typescript
+{
+    accessToken: string;
+    refreshToken?: string;
+    idToken?: string;
+    expiresIn: number;
+    tokenType: string;
+    scope: string;
+}
+```
+
+### I_OidcUserInfo
+
+```typescript
+{
+    sub: string;
+    name?: string;
+    email?: string;
+}
+```
+
+### I_OidcClientRegistration
+
+```typescript
+{
+    client_name: string;
+    redirect_uris: string[];
+    grant_types?: string[];
+    response_types?: string[];
+    scope?: string;
+    token_endpoint_auth_method?: 'client_secret_basic' | 'client_secret_post' | 'none';
+    application_type?: 'web' | 'native';
+    logo_uri?: string;
+    client_uri?: string;
+    policy_uri?: string;
+    tos_uri?: string;
+}
+```
+
+### I_OidcClientResponse
+
+```typescript
+{
+    client_id: string;
+    client_secret?: string;
+    client_secret_expires_at?: number;
+    client_id_issued_at?: number;
+    registration_access_token?: string;
+    registration_client_uri?: string;
+    client_name?: string;
+    redirect_uris?: string[];
+    grant_types?: string[];
+    response_types?: string[];
+    scope?: string;
+    token_endpoint_auth_method?: string;
+}
+```
+
+### I_AuthState
+
+```typescript
+{
+    method: 'jwt' | 'oidc' | 'none';
+    token: string | null;
+    isAdmin: boolean;
+    userName: string;
+}
+```
+
+### I_DocumentEntry
+
+```typescript
+{
+    _id: string;
+    owner: string;
+    title: string;
+    description?: string;
+    type: number;
+    subType: number;
+    content: any;
+    shareWithGroup: boolean;
+    shareWithDepartment: boolean;
+    public: boolean;
+}
+```
+
+### I_DocumentCreation
+
+```typescript
+{
+    title: string;
+    description?: string;
+    type: number;
+    subType: number;
+    content: any;
+    shareWithGroup: boolean;
+    shareWithDepartment: boolean;
+    public: boolean;
+}
+```
+
+### I_DocumentCreationOwned
+
+```typescript
+{
+    owner: string;
+    title: string;
+    description?: string;
+    type: number;
+    subType: number;
+    content: any;
+    shareWithGroup: boolean;
+    shareWithDepartment: boolean;
+    public: boolean;
+}
+```
+
+### I_DocumentUpdate
+
+```typescript
+{
+    _id?: string;
+    owner?: string;
+    title?: string;
+    type?: number;
+    subType?: number;
+    shareWithGroup?: boolean;
+    shareWithDepartment?: boolean;
+    public?: boolean;
+    content?: any;
+    description?: string;
+}
+```
+
+### I_DocumentQuery
+
+```typescript
+{
+    _id?: string;
+    owner?: string;
+    title?: string;
+    type?: number;
+    subType?: number;
+    shareWithGroup?: boolean;
+    shareWithDepartment?: boolean;
+    public?: boolean;
+}
+```
+
+### I_DataStructure
+
+```typescript
+{
+    _id?: string;
+    name: string;
+    description: string;
+    type: number;
+    subType: number;
+    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;
+    displayName: string;
+    type: string;
+    items?: 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_DataStructure;
+    newUser?: I_UserEntry;
+    removedID?: string;
+    changedDocument?: I_DocumentUpdate;
+    changedStructure?: I_StructureUpdate;
+    changedUser?: I_UserUpdate;
+    confirmSubscription?: boolean;
+    confirmUnsubscription?: boolean;
+    heartbeatPing?: number;
+    heartbeatPong?: number;
+}
+```
+
+## License
+
+[MIT](LICENSE)