@frogfish/k2db 1.0.5 → 1.0.6

package/package.json

@@ -1,11 +1,36 @@
 {
   "name": "@frogfish/k2db",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A data handling library for K2 applications.",
-  "main": "data.js",
-  "types": "data.d.ts",
+  "main": "data.js",  
+  "types": "data.d.ts",  
+  "scripts": {
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "dist": "tsc && jest && gulp && npm publish --access public",
+    "build": "tsc",
+    "build:watch": "tsc --watch"
+  },
   "author": "El'Diablo",
   "license": "GPL-3.0-only",
+  "devDependencies": {
+    "@types/axios": "^0.9.36",
+    "@types/debug": "^4.1.12",
+    "@types/jest": "^29.5.13",
+    "@types/mongodb": "^4.0.6",
+    "@types/uuid": "^10.0.0",
+    "jest": "^29.7.0",
+    "mongodb-memory-server": "^10.0.1",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.2",
+    "gulp": "^5.0.0",
+    "gulp-bump": "^3.2.0",
+    "gulp-clean": "^0.4.0",
+    "gulp-json-transform": "^0.5.0",
+    "gulp-tsc": "^1.3.2",
+    "gulp-typescript": "^6.0.0-alpha.1"
+  },
   "dependencies": {
     "@frogfish/k2error": "^1.0.1",
     "debug": "^4.3.7",
@@ -14,6 +39,8 @@
   },
   "files": [
     "data.d.ts",
-    "db.d.ts"
+    "data.js",
+    "db.d.ts",
+    "db.js"
   ]
 }

package/data.d.ts

@@ -1,92 +0,0 @@
-import { DB, BaseDocument } from "./db";
-export declare class Data {
-    private db;
-    private owner;
-    constructor(db: DB, owner: string);
-    /**
-     * Retrieves a single document by UUID.
-     * @param collectionName - Name of the collection.
-     * @param uuid - UUID of the document.
-     */
-    get(collectionName: string, uuid: string): Promise<BaseDocument>;
-    /**
-     * Retrieves a single document matching the criteria.
-     * @param collectionName - Name of the collection.
-     * @param criteria - Search criteria.
-     * @param fields - Optional fields to include.
-     */
-    findOne(collectionName: string, criteria: any, fields?: Array<string>): Promise<BaseDocument | null>;
-    /**
-     * Finds documents based on filter with optional parameters and pagination.
-     */
-    find(collectionName: string, filter: any, params?: any, skip?: number, limit?: number): Promise<BaseDocument[]>;
-    /**
-     * Aggregates documents based on criteria with pagination support.
-     */
-    aggregate(collectionName: string, criteria: any[], skip?: number, limit?: number): Promise<BaseDocument[]>;
-    /**
-     * Creates a new document in the collection.
-     */
-    create(collectionName: string, data: Partial<BaseDocument>): Promise<{
-        id: string;
-    }>;
-    /**
-     * Updates multiple documents based on criteria.
-     */
-    updateAll(collectionName: string, criteria: any, values: Partial<BaseDocument>, replace?: boolean): Promise<any>;
-    /**
-     * Updates a single document by UUID.
-     */
-    update(collectionName: string, id: string, data: Partial<BaseDocument>, replace?: boolean, objectTypeName?: string): Promise<any>;
-    /**
-     * Removes (soft deletes) multiple documents based on criteria.
-     */
-    deleteAll(collectionName: string, criteria: any): Promise<any>;
-    /**
-     * Removes (soft deletes) a single document by UUID.
-     */
-    delete(collectionName: string, id: string): Promise<{
-        id: string;
-    }>;
-    /**
-     * Permanently deletes a document that has been soft-deleted.
-     */
-    purge(collectionName: string, id: string): Promise<{
-        id: string;
-    }>;
-    /**
-     * Restores a soft-deleted document.
-     */
-    restore(collectionName: string, criteria: any): Promise<{
-        status: string;
-        modified: number;
-    }>;
-    /**
-     * Counts documents based on criteria.
-     */
-    count(collectionName: string, criteria: any): Promise<{
-        count: number;
-    }>;
-    /**
-     * Drops an entire collection.
-     */
-    drop(collectionName: string): Promise<{
-        status: string;
-    }>;
-    /**
-     * Executes a transaction with the provided operations.
-     */
-    executeTransaction(operations: (session: any) => Promise<void>): Promise<void>;
-    /**
-     * Creates an index on the specified collection.
-     */
-    createIndex(collectionName: string, indexSpec: any, options?: any): Promise<void>;
-    /**
-     * Drops the entire database.
-     */
-    dropDatabase(): Promise<void>;
-    /**
-     * Checks the health of the database connection.
-     */
-    isHealthy(): Promise<boolean>;
-}

package/data.js

@@ -1,118 +0,0 @@
-"use strict";
-// src/Data.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Data = void 0;
-class Data {
-    constructor(db, owner) {
-        this.db = db;
-        this.owner = owner;
-    }
-    /**
-     * Retrieves a single document by UUID.
-     * @param collectionName - Name of the collection.
-     * @param uuid - UUID of the document.
-     */
-    async get(collectionName, uuid) {
-        return this.db.get(collectionName, uuid);
-    }
-    /**
-     * Retrieves a single document matching the criteria.
-     * @param collectionName - Name of the collection.
-     * @param criteria - Search criteria.
-     * @param fields - Optional fields to include.
-     */
-    async findOne(collectionName, criteria, fields) {
-        return this.db.findOne(collectionName, criteria, fields);
-    }
-    /**
-     * Finds documents based on filter with optional parameters and pagination.
-     */
-    async find(collectionName, filter, params, skip, limit) {
-        return this.db.find(collectionName, filter, params, skip, limit);
-    }
-    /**
-     * Aggregates documents based on criteria with pagination support.
-     */
-    async aggregate(collectionName, criteria, skip, limit) {
-        return this.db.aggregate(collectionName, criteria, skip, limit);
-    }
-    /**
-     * Creates a new document in the collection.
-     */
-    async create(collectionName, data) {
-        return this.db.create(collectionName, this.owner, data);
-    }
-    /**
-     * Updates multiple documents based on criteria.
-     */
-    async updateAll(collectionName, criteria, values, replace) {
-        return this.db.updateAll(collectionName, criteria, values, replace);
-    }
-    /**
-     * Updates a single document by UUID.
-     */
-    async update(collectionName, id, data, replace, objectTypeName) {
-        return this.db.update(collectionName, id, data, replace, objectTypeName);
-    }
-    /**
-     * Removes (soft deletes) multiple documents based on criteria.
-     */
-    async deleteAll(collectionName, criteria) {
-        return this.db.deleteAll(collectionName, criteria);
-    }
-    /**
-     * Removes (soft deletes) a single document by UUID.
-     */
-    async delete(collectionName, id) {
-        return this.db.delete(collectionName, id);
-    }
-    /**
-     * Permanently deletes a document that has been soft-deleted.
-     */
-    async purge(collectionName, id) {
-        return this.db.purge(collectionName, id);
-    }
-    /**
-     * Restores a soft-deleted document.
-     */
-    async restore(collectionName, criteria) {
-        return this.db.restore(collectionName, criteria);
-    }
-    /**
-     * Counts documents based on criteria.
-     */
-    async count(collectionName, criteria) {
-        return this.db.count(collectionName, criteria);
-    }
-    /**
-     * Drops an entire collection.
-     */
-    async drop(collectionName) {
-        return this.db.drop(collectionName);
-    }
-    /**
-     * Executes a transaction with the provided operations.
-     */
-    async executeTransaction(operations) {
-        return this.db.executeTransaction(operations);
-    }
-    /**
-     * Creates an index on the specified collection.
-     */
-    async createIndex(collectionName, indexSpec, options) {
-        return this.db.createIndex(collectionName, indexSpec, options);
-    }
-    /**
-     * Drops the entire database.
-     */
-    async dropDatabase() {
-        return this.db.dropDatabase();
-    }
-    /**
-     * Checks the health of the database connection.
-     */
-    async isHealthy() {
-        return this.db.isHealthy();
-    }
-}
-exports.Data = Data;

package/db.d.ts

@@ -1,181 +0,0 @@
-import { ObjectId } from "mongodb";
-export interface HostConfig {
-    host: string;
-    port?: number;
-}
-export interface DatabaseConfig {
-    name: string;
-    user?: string;
-    password?: string;
-    hosts?: HostConfig[];
-    replicaset?: string;
-}
-export interface BaseDocument {
-    _id?: ObjectId;
-    _uuid: string;
-    _created: number;
-    _updated: number;
-    _owner: string;
-    _deleted?: boolean;
-    [key: string]: any;
-}
-export declare class DB {
-    private conf;
-    private db;
-    private connection;
-    constructor(conf: DatabaseConfig);
-    /**
-     * Initializes the MongoDB connection.
-     */
-    init(): Promise<void>;
-    /**
-     * Retrieves a collection from the database.
-     * @param collectionName - Name of the collection.
-     */
-    private getCollection;
-    get(collectionName: string, uuid: string): Promise<BaseDocument>;
-    /**
-     * Retrieves a single document by UUID.
-     * @param collectionName - Name of the collection.
-     * @param uuid - UUID of the document.
-     * @param objectTypeName - Optional object type name.
-     * @param fields - Optional array of fields to include.
-     */
-    findOne(collectionName: string, criteria: any, fields?: Array<string>): Promise<BaseDocument | null>;
-    /**
-     * Finds documents based on parameters with pagination support.
-     * @param collectionName - Name of the collection.
-     * @param filter - Criteria to filter the documents.
-     * @param params - Optional search parameters (for sorting, including/excluding fields).
-     * @param skip - Number of documents to skip (for pagination).
-     * @param limit - Maximum number of documents to return.
-     */
-    find(collectionName: string, filter: any, params?: any, skip?: number, limit?: number): Promise<BaseDocument[]>;
-    /**
-     * Aggregates documents based on criteria with pagination support.
-     * @param collectionName - Name of the collection.
-     * @param criteria - Aggregation pipeline criteria.
-     * @param skip - Number of documents to skip (for pagination).
-     * @param limit - Maximum number of documents to return.
-     */
-    aggregate(collectionName: string, criteria: any[], skip?: number, limit?: number): Promise<BaseDocument[]>;
-    /**
-     * Creates a new document in the collection.
-     * @param collectionName - Name of the collection.
-     * @param owner - Owner of the document.
-     * @param data - Data to insert.
-     */
-    create(collectionName: string, owner: string, data: Partial<BaseDocument>): Promise<{
-        id: string;
-    }>;
-    /**
-     * Updates multiple documents based on criteria.
-     * Can either replace the documents or patch them.
-     * @param collectionName - Name of the collection.
-     * @param criteria - Update criteria.
-     * @param values - Values to update or replace with.
-     * @param replace - If true, replaces the entire document (PUT), otherwise patches (PATCH).
-     */
-    updateAll(collectionName: string, criteria: any, values: Partial<BaseDocument>, replace?: boolean): Promise<any>;
-    /**
-     * Updates a single document by UUID.
-     * Can either replace the document or patch it.
-     * @param collectionName - Name of the collection.
-     * @param id - UUID string to identify the document.
-     * @param data - Data to update or replace with.
-     * @param replace - If true, replaces the entire document (PUT), otherwise patches (PATCH).
-     * @param objectTypeName - Optional object type name.
-     */
-    update(collectionName: string, id: string, data: Partial<BaseDocument>, replace?: boolean, objectTypeName?: string): Promise<any>;
-    /**
-     * Removes (soft deletes) multiple documents based on criteria.
-     * @param collectionName - Name of the collection.
-     * @param criteria - Removal criteria.
-     */
-    deleteAll(collectionName: string, criteria: any): Promise<any>;
-    /**
-     * Removes (soft deletes) a single document by UUID.
-     * @param collectionName - Name of the collection.
-     * @param id - UUID of the document.
-     */
-    delete(collectionName: string, id: string): Promise<{
-        id: string;
-    }>;
-    /**
-     * Permanently deletes a document that has been soft-deleted.
-     * @param collectionName - Name of the collection.
-     * @param id - UUID of the document.
-     */
-    purge(collectionName: string, id: string): Promise<{
-        id: string;
-    }>;
-    /**
-     * Restores a soft-deleted document.
-     * @param collectionName - Name of the collection.
-     * @param criteria - Criteria to identify the document.
-     */
-    restore(collectionName: string, criteria: any): Promise<{
-        status: string;
-        modified: number;
-    }>;
-    /**
-     * Counts documents based on criteria.
-     * @param collectionName - Name of the collection.
-     * @param criteria - Counting criteria.
-     */
-    count(collectionName: string, criteria: any): Promise<{
-        count: number;
-    }>;
-    /**
-     * Drops an entire collection.
-     * @param collectionName - Name of the collection.
-     */
-    drop(collectionName: string): Promise<{
-        status: string;
-    }>;
-    /**
-     * Sanitizes aggregation criteria.
-     * @param criteria - Aggregation stage criteria.
-     */
-    private static sanitiseCriteria;
-    /**
-     * Optional: Executes a transaction with the provided operations.
-     * @param operations - A function that performs operations within a transaction session.
-     */
-    executeTransaction(operations: (session: any) => Promise<void>): Promise<void>;
-    /**
-     * Optional: Creates an index on the specified collection.
-     * @param collectionName - Name of the collection.
-     * @param indexSpec - Specification of the index.
-     * @param options - Optional index options.
-     */
-    createIndex(collectionName: string, indexSpec: any, options?: any): Promise<void>;
-    /**
-     * Releases the MongoDB connection.
-     */
-    release(): Promise<void>;
-    /**
-     * Closes the MongoDB connection.
-     */
-    close(): void;
-    /**
-     * Drops the entire database.
-     */
-    dropDatabase(): Promise<void>;
-    /**
-     * Validates the MongoDB collection name.
-     * @param collectionName - The name of the collection to validate.
-     * @throws {K2Error} - If the collection name is invalid.
-     */
-    validateCollectionName(collectionName: string): void;
-    /**
-     * Optional: Checks the health of the database connection.
-     */
-    isHealthy(): Promise<boolean>;
-    /**
-     * Utility to normalize the error type.
-     * @param err - The caught error of type `unknown`.
-     * @returns A normalized error of type `Error`.
-     */
-    private normalizeError;
-}