docpouch-client 0.8.0

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import type { I_UserEntry, I_UserLogin, I_UserCreation, I_UserUpdate, I_UserDisplay, I_DocumentEntry, I_DataStructure, I_LoginResponse } from "./types.js";
+export default class Index {
+    baseUrl: string;
+    private token;
+    constructor(baseUrl: string);
+    private request;
+    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[]>;
+    fetchDocument(documentID: string): Promise<I_DocumentEntry>;
+    updateDocument(documentID: string, documentData: I_DocumentEntry): Promise<void>;
+    removeDocument(documentID: string): Promise<void>;
+    createStructure(structure: I_DataStructure): Promise<I_DataStructure>;
+    getStructures(): Promise<I_DataStructure[]>;
+    updateStructure(structureID: string, structureData: I_DataStructure): Promise<void>;
+    removeStructure(structureID: string): Promise<void>;
+    setToken(token: string | null): void;
+    getToken(): string | null;
+}

package/dist/index.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Index {
+    constructor(baseUrl) {
+        this.token = null;
+        this.baseUrl = baseUrl;
+    }
+    async request(endpoint, method, body, requiresAuth = true) {
+        const headers = {
+            'Content-Type': 'application/json'
+        };
+        if (requiresAuth && this.token) {
+            headers['Authorization'] = `Bearer ${this.token}`;
+        }
+        const options = {
+            method,
+            headers,
+            body: body ? JSON.stringify(body) : undefined
+        };
+        const response = await fetch(`${this.baseUrl}${endpoint}`, options);
+        if (!response.ok) {
+            if (response.status === 401 || response.status === 403) {
+                this.token = null;
+            }
+            throw new Error(`API error: ${response.status} ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    // User Administration Endpoints
+    async login(credentials) {
+        const response = await this.request('/users/login', 'POST', credentials, false);
+        if (response.token) {
+            this.token = response.token;
+            return { token: response.token, isAdmin: response.isAdmin };
+        }
+        return null;
+    }
+    async listUsers() {
+        return await this.request('/users/list', 'GET');
+    }
+    async updateUser(userID, userData) {
+        await this.request(`/users/update/${userID}`, 'PATCH', userData);
+    }
+    async createUser(userData) {
+        return await this.request('/users/create', 'POST', userData);
+    }
+    async removeUser(userID) {
+        await this.request(`/users/remove/${userID}`, 'DELETE');
+    }
+    // Document Management Endpoints
+    async createDocument(document) {
+        return await this.request('/docs/create', 'POST', document);
+    }
+    async listDocuments() {
+        return await this.request('/docs/list', 'GET');
+    }
+    async fetchDocument(documentID) {
+        return await this.request(`/docs/fetch/${documentID}`, 'GET');
+    }
+    async updateDocument(documentID, documentData) {
+        await this.request(`/docs/update/${documentID}`, 'PATCH', documentData);
+    }
+    async removeDocument(documentID) {
+        await this.request(`/docs/remove/${documentID}`, 'DELETE');
+    }
+    // Data Structure Endpoints
+    async createStructure(structure) {
+        return await this.request('/structures/create', 'POST', structure);
+    }
+    async getStructures() {
+        return await this.request('/structures/list', 'GET');
+    }
+    async updateStructure(structureID, structureData) {
+        await this.request(`/structures/update/${structureID}`, 'PATCH', structureData);
+    }
+    async removeStructure(structureID) {
+        await this.request(`/structures/remove/${structureID}`, 'DELETE');
+    }
+    setToken(token) {
+        this.token = token;
+    }
+    getToken() {
+        return this.token;
+    }
+}
+exports.default = Index;
+module.exports = Index;

package/dist/types.d.ts

@@ -0,0 +1,61 @@
+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;
+    isAdmin: boolean;
+}
+export interface I_UserUpdate {
+    name?: string;
+    password?: string;
+    email?: string;
+    isAdmin?: boolean;
+}
+export interface I_UserDisplay {
+    _id: string;
+    username: 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_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[];
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+// Common type definitions for both frontend and backend
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "docpouch-client",
+  "version": "0.8.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "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"
+  },
+  "dependencies": {
+    "typescript": "^5.8.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,120 @@
+import type { 
+    I_UserEntry,
+    I_UserLogin,
+    I_UserCreation,
+    I_UserUpdate,
+    I_UserDisplay, 
+    I_DocumentEntry,
+    I_DataStructure, 
+    I_LoginResponse
+} from "./types.js";
+
+export default class Index {
+    baseUrl: string;
+    private token: string | null = null;
+
+    constructor(baseUrl: string) {
+        this.baseUrl = baseUrl;
+    }
+
+    private async request<T>(endpoint: string, method: string, body?: any, requiresAuth: boolean = true): Promise<T> {
+        const headers: HeadersInit = {
+            'Content-Type': 'application/json'
+        };
+
+        if (requiresAuth && this.token) {
+            headers['Authorization'] = `Bearer ${this.token}`;
+        }
+
+        const options: RequestInit = {
+            method,
+            headers,
+            body: body ? JSON.stringify(body) : undefined
+        };
+
+        const response = await fetch(`${this.baseUrl}${endpoint}`, options);
+
+        if (!response.ok) {
+            if (response.status === 401 || response.status === 403) {
+                this.token = null;
+            }
+            throw new Error(`API error: ${response.status} ${response.statusText}`);
+        }
+
+        return await response.json() as T;
+    }
+
+    // User Administration Endpoints
+    async login(credentials: I_UserLogin): Promise<I_LoginResponse | null> {
+        const response = await this.request<I_LoginResponse>('/users/login', 'POST', credentials, false);
+        if (response.token) {
+            this.token = response.token;
+            return {token: response.token, isAdmin: response.isAdmin};
+        }
+        return null;
+    }
+
+    async listUsers(): Promise<I_UserEntry[]> {
+        return await this.request<I_UserEntry[]>('/users/list', 'GET');
+    }
+
+    async updateUser(userID: string, userData: I_UserUpdate): Promise<void> {
+        await this.request<void>(`/users/update/${userID}`, 'PATCH', userData);
+    }
+
+    async createUser(userData: I_UserCreation): Promise<I_UserDisplay> {
+        return await this.request<I_UserDisplay>('/users/create', 'POST', userData);
+    }
+
+    async removeUser(userID: string): Promise<void> {
+        await this.request<void>(`/users/remove/${userID}`, 'DELETE');
+    }
+
+    // Document Management Endpoints
+    async createDocument(document: I_DocumentEntry): Promise<I_DocumentEntry> {
+        return await this.request<I_DocumentEntry>('/docs/create', 'POST', document);
+    }
+
+    async listDocuments(): Promise<I_DocumentEntry[]> {
+        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 updateDocument(documentID: string, documentData: I_DocumentEntry): Promise<void> {
+        await this.request<void>(`/docs/update/${documentID}`, 'PATCH', documentData);
+    }
+
+    async removeDocument(documentID: string): Promise<void> {
+        await this.request<void>(`/docs/remove/${documentID}`, 'DELETE');
+    }
+
+    // Data Structure Endpoints
+    async createStructure(structure: I_DataStructure): Promise<I_DataStructure> {
+        return await this.request<I_DataStructure>('/structures/create', 'POST', structure);
+    }
+
+    async getStructures(): Promise<I_DataStructure[]> {
+        return await this.request<I_DataStructure[]>('/structures/list', 'GET');
+    }
+
+    async updateStructure(structureID: string, structureData: I_DataStructure): Promise<void> {
+        await this.request<void>(`/structures/update/${structureID}`, 'PATCH', structureData);
+    }
+
+    async removeStructure(structureID: string): Promise<void> {
+        await this.request<void>(`/structures/remove/${structureID}`, 'DELETE');
+    }
+
+    setToken(token: string | null): void {
+        this.token = token;
+    }
+
+    getToken() {
+        return this.token;
+    }
+}
+
+module.exports = Index;

package/src/types.ts

@@ -0,0 +1,77 @@
+// 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;
+    isAdmin: boolean;
+}
+
+export interface I_UserUpdate {
+    name?: string;
+    password?: string;
+    email?: string;
+    isAdmin?: boolean;
+}
+
+export interface I_UserDisplay {
+    _id: string;
+    username: 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;
+}
+
+// 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[];
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "Node16",
+    "lib": ["ES6", "DOM"],
+    "moduleResolution": "Node16",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "declaration": true,
+    "emitDeclarationOnly": false,
+  },
+  "include": ["**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules", "**/*.test.ts", "**/*.types.ts"]
+}