nodecommons-esm-database-arangodb 0.0.2

package/dist/index.d.mts

@@ -0,0 +1,5 @@
+import { CommonsArangodbService } from './services/commons-arangodb.service.mjs';
+import { TCommonsArangodbEdge, isTCommonsArangodbEdge } from './types/tcommons-arangodb-edge.mjs';
+import { TCommonsArangodbDocument, isTCommonsArangodbDocument } from './types/tcommons-arangodb-document.mjs';
+import { TCommonsArangodbTraversalDepth, isTCommonsArangodbTraversalDepth } from './types/tcommons-arangodb-traversal-depth.mjs';
+export { CommonsArangodbService, TCommonsArangodbEdge, isTCommonsArangodbEdge, TCommonsArangodbDocument, isTCommonsArangodbDocument, TCommonsArangodbTraversalDepth, isTCommonsArangodbTraversalDepth };

package/dist/index.mjs

@@ -0,0 +1,6 @@
+import { CommonsArangodbService } from './services/commons-arangodb.service.mjs';
+import { isTCommonsArangodbEdge } from './types/tcommons-arangodb-edge.mjs';
+import { isTCommonsArangodbDocument } from './types/tcommons-arangodb-document.mjs';
+import { isTCommonsArangodbTraversalDepth } from './types/tcommons-arangodb-traversal-depth.mjs';
+export { CommonsArangodbService, isTCommonsArangodbEdge, isTCommonsArangodbDocument, isTCommonsArangodbTraversalDepth };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,yCAAyC,CAAC;AACjF,OAAO,EAAwB,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAClG,OAAO,EAA4B,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AAC9G,OAAO,EAAkC,gCAAgC,EAAE,MAAM,+CAA+C,CAAC;AACjI,OAAO,EACN,sBAAsB,EAEtB,sBAAsB,EAEtB,0BAA0B,EAE1B,gCAAgC,EAChC,CAAC"}

package/dist/services/commons-arangodb.service.d.mts

@@ -0,0 +1,21 @@
+import { Database } from 'arangojs';
+import { DocumentCollection, EdgeCollection } from 'arangojs/collections';
+import { Document } from 'arangojs/documents';
+import { Cursor } from 'arangojs/cursors';
+import { GeneratedAqlQuery } from 'arangojs/aql';
+import { TPropertyObject } from 'tscommons-esm-core';
+import { CommonsNosqlDatabaseService, ICommonsCredentials } from 'nodecommons-esm-database';
+import { TCommonsArangodbDocument } from '../types/tcommons-arangodb-document.mjs';
+export declare abstract class CommonsArangodbService extends CommonsNosqlDatabaseService<ICommonsCredentials> {
+    private db;
+    protected init(): Promise<void>;
+    protected getRawDb(): Database;
+    getDocumentCollection<T extends TPropertyObject>(name: string): DocumentCollection<T>;
+    getEdgeCollection<T extends TPropertyObject>(name: string): EdgeCollection<T>;
+    query<T extends TPropertyObject>(query: GeneratedAqlQuery): Promise<Cursor<T>>;
+    protected listTDocumentByQuery<T extends TPropertyObject>(query: GeneratedAqlQuery): Promise<Document<T>[]>;
+    protected getFirstTDocumentByQuery<T extends TPropertyObject>(query: GeneratedAqlQuery): Promise<Document<T> | undefined>;
+    close(): void;
+    saveDocument<T extends TPropertyObject>(document: T, collection: string): Promise<T & TCommonsArangodbDocument>;
+    removeDocument<T extends TPropertyObject>(document: T & TCommonsArangodbDocument, collection: string): Promise<boolean>;
+}

package/dist/services/commons-arangodb.service.mjs

@@ -0,0 +1,65 @@
+import { Database } from 'arangojs';
+import { CommonsNosqlDatabaseService } from 'nodecommons-esm-database';
+export class CommonsArangodbService extends CommonsNosqlDatabaseService {
+    db;
+    async init() {
+        this.db = new Database(`http://${this.credentials.host || 'localhost'}:${this.credentials.port || 8529}`, this.credentials.name);
+        if (this.credentials.user && this.credentials.user !== '') {
+            this.db.useBasicAuth(this.credentials.user, this.credentials.password);
+        }
+    }
+    getRawDb() {
+        if (!this.db)
+            throw new Error('Database not initialised');
+        return this.db;
+    }
+    getDocumentCollection(name) {
+        if (!this.db)
+            throw new Error('The database has not been initialised yet');
+        return this.db.collection(name);
+    }
+    getEdgeCollection(name) {
+        if (!this.db)
+            throw new Error('The database has not been initialised yet');
+        return this.db.collection(name);
+    }
+    async query(query) {
+        if (!this.db)
+            throw new Error('The database has not been initialised yet');
+        return await this.db.query(query);
+    }
+    async listTDocumentByQuery(query) {
+        const cursor = await this.query(query);
+        return cursor.all();
+    }
+    async getFirstTDocumentByQuery(query) {
+        const cursor = await this.query(query);
+        if (!cursor.hasNext)
+            return undefined;
+        const next = await cursor.next();
+        if (!next)
+            return undefined;
+        return next;
+    }
+    close() {
+        if (this.db)
+            this.db.close();
+    }
+    async saveDocument(document, collection) {
+        const c = this.getDocumentCollection(collection);
+        const result = await c.save(document);
+        if (result.new)
+            return result.new;
+        return {
+            ...document,
+            _id: result._id, // eslint-disable-line no-underscore-dangle
+            _key: result._key // eslint-disable-line no-underscore-dangle
+        };
+    }
+    async removeDocument(document, collection) {
+        const c = this.getDocumentCollection(collection);
+        const result = await c.remove(document);
+        return result.old !== undefined;
+    }
+}
+//# sourceMappingURL=commons-arangodb.service.mjs.map

package/dist/services/commons-arangodb.service.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"commons-arangodb.service.mjs","sourceRoot":"","sources":["../../src/services/commons-arangodb.service.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAQpC,OAAO,EAAE,2BAA2B,EAAuB,MAAM,0BAA0B,CAAC;AAI5F,MAAM,OAAgB,sBAAuB,SAAQ,2BAAgD;IAC5F,EAAE,CAAqB;IAErB,KAAK,CAAC,IAAI;QACnB,IAAI,CAAC,EAAE,GAAG,IAAI,QAAQ,CACpB,UAAU,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,IAAI,EAAE,EACjF,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAC;QACF,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,EAAE,EAAE,CAAC;YAC3D,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxE,CAAC;IACF,CAAC;IAES,QAAQ;QACjB,IAAI,CAAC,IAAI,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,EAAE,CAAC;IAChB,CAAC;IAEM,qBAAqB,CAC1B,IAAY;QAEb,IAAI,CAAC,IAAI,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAA0B,CAAC;IAC1D,CAAC;IAEM,iBAAiB,CACtB,IAAY;QAEb,IAAI,CAAC,IAAI,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAE3E,OAAO,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAsB,CAAC;IACtD,CAAC;IAEM,KAAK,CAAC,KAAK,CAChB,KAAwB;QAEzB,IAAI,CAAC,IAAI,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAE3E,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAES,KAAK,CAAC,oBAAoB,CAA4B,KAAwB;QACvF,MAAM,MAAM,GAAwB,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAE5D,OAAO,MAAM,CAAC,GAAG,EAAE,CAAC;IACrB,CAAC;IAES,KAAK,CAAC,wBAAwB,CAA4B,KAAwB;QAC3F,MAAM,MAAM,GAAwB,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAE5D,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO,SAAS,CAAC;QAEtC,MAAM,IAAI,GAA0B,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QACxD,IAAI,CAAC,IAAI;YAAE,OAAO,SAAS,CAAC;QAE5B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,KAAK;QACX,IAAI,IAAI,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,YAAY,CACvB,QAAW,EACX,UAAkB;QAEnB,MAAM,CAAC,GAA0B,IAAI,CAAC,qBAAqB,CAAI,UAAU,CAAC,CAAC;QAE3E,MAAM,MAAM,GAER,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE3B,IAAI,MAAM,CAAC,GAAG;YAAE,OAAO,MAAM,CAAC,GAAG,CAAC;QAElC,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,2CAA2C;YAC5D,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,2CAA2C;SAC9D,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,cAAc,CACzB,QAAsC,EACtC,UAAkB;QAEnB,MAAM,CAAC,GAA0B,IAAI,CAAC,qBAAqB,CAAI,UAAU,CAAC,CAAC;QAE3E,MAAM,MAAM,GAER,MAAM,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAE7B,OAAO,MAAM,CAAC,GAAG,KAAK,SAAS,CAAC;IACjC,CAAC;CACD"}

package/dist/types/tcommons-arangodb-document.d.mts

@@ -0,0 +1,5 @@
+export type TCommonsArangodbDocument = {
+    _id: string;
+    _key: string;
+};
+export declare function isTCommonsArangodbDocument(test: unknown): test is TCommonsArangodbDocument;

package/dist/types/tcommons-arangodb-document.mjs

@@ -0,0 +1,9 @@
+import { commonsTypeHasPropertyString } from 'tscommons-esm-core';
+export function isTCommonsArangodbDocument(test) {
+    if (!commonsTypeHasPropertyString(test, '_id'))
+        return false;
+    if (!commonsTypeHasPropertyString(test, '_key'))
+        return false;
+    return true;
+}
+//# sourceMappingURL=tcommons-arangodb-document.mjs.map

package/dist/types/tcommons-arangodb-document.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tcommons-arangodb-document.mjs","sourceRoot":"","sources":["../../src/types/tcommons-arangodb-document.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAOlE,MAAM,UAAU,0BAA0B,CAAC,IAAa;IACvD,IAAI,CAAC,4BAA4B,CAAC,IAAI,EAAE,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7D,IAAI,CAAC,4BAA4B,CAAC,IAAI,EAAE,MAAM,CAAC;QAAE,OAAO,KAAK,CAAC;IAE9D,OAAO,IAAI,CAAC;AACb,CAAC"}

package/dist/types/tcommons-arangodb-edge.d.mts

@@ -0,0 +1,6 @@
+import { TCommonsArangodbDocument } from './tcommons-arangodb-document.mjs';
+export type TCommonsArangodbEdge = TCommonsArangodbDocument & {
+    _from: string;
+    _to: string;
+};
+export declare function isTCommonsArangodbEdge(test: unknown): test is TCommonsArangodbEdge;

package/dist/types/tcommons-arangodb-edge.mjs

@@ -0,0 +1,12 @@
+import { commonsTypeHasPropertyString } from 'tscommons-esm-core';
+import { isTCommonsArangodbDocument } from './tcommons-arangodb-document.mjs';
+export function isTCommonsArangodbEdge(test) {
+    if (!isTCommonsArangodbDocument(test))
+        return false;
+    if (!commonsTypeHasPropertyString(test, '_from'))
+        return false;
+    if (!commonsTypeHasPropertyString(test, '_to'))
+        return false;
+    return true;
+}
+//# sourceMappingURL=tcommons-arangodb-edge.mjs.map

package/dist/types/tcommons-arangodb-edge.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tcommons-arangodb-edge.mjs","sourceRoot":"","sources":["../../src/types/tcommons-arangodb-edge.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAElE,OAAO,EAA4B,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAOxG,MAAM,UAAU,sBAAsB,CAAC,IAAa;IACnD,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAEpD,IAAI,CAAC,4BAA4B,CAAC,IAAI,EAAE,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/D,IAAI,CAAC,4BAA4B,CAAC,IAAI,EAAE,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAE7D,OAAO,IAAI,CAAC;AACb,CAAC"}

package/dist/types/tcommons-arangodb-traversal-depth.d.mts

@@ -0,0 +1,5 @@
+export type TCommonsArangodbTraversalDepth = {
+    min: number;
+    max: number;
+};
+export declare function isTCommonsArangodbTraversalDepth(test: unknown): test is TCommonsArangodbTraversalDepth;

package/dist/types/tcommons-arangodb-traversal-depth.mjs

@@ -0,0 +1,9 @@
+import { commonsTypeHasPropertyNumber } from 'tscommons-esm-core';
+export function isTCommonsArangodbTraversalDepth(test) {
+    if (!commonsTypeHasPropertyNumber(test, 'min'))
+        return false;
+    if (!commonsTypeHasPropertyNumber(test, 'max'))
+        return false;
+    return true;
+}
+//# sourceMappingURL=tcommons-arangodb-traversal-depth.mjs.map

package/dist/types/tcommons-arangodb-traversal-depth.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tcommons-arangodb-traversal-depth.mjs","sourceRoot":"","sources":["../../src/types/tcommons-arangodb-traversal-depth.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAOlE,MAAM,UAAU,gCAAgC,CAAC,IAAa;IAC7D,IAAI,CAAC,4BAA4B,CAAC,IAAI,EAAE,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7D,IAAI,CAAC,4BAA4B,CAAC,IAAI,EAAE,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAE7D,OAAO,IAAI,CAAC;AACb,CAAC"}

package/package.json

@@ -0,0 +1,33 @@
+{
+	"name": "nodecommons-esm-database-arangodb",
+	"version": "0.0.2",
+	"description": "",
+	"scripts": {
+		"tsc": "./node_modules/typescript/bin/tsc",
+		"preprepare": "rm -rf ./dist; php ~/Dev/etim.php src/ && npm run tsc",
+		"publish-major": "rm -rf dist; npm run tsc && npx eslint . && npm run preprepare && npm version major && npm install && npm publish && git add . && git commit -m 'publish'",
+		"publish-minor": "rm -rf dist; npm run tsc && npx eslint . && npm run preprepare && npm version minor && npm install && npm publish && git add . && git commit -m 'publish'",
+		"publish-patch": "rm -rf dist; npm run tsc && npx eslint . && npm run preprepare && npm version patch && npm install && npm publish && git add . && git commit -m 'publish'"
+	},
+	"main": "dist/index.mjs",
+	"types": "dist/index.d.mjs",
+	"type": "module",
+	"author": "Pete Morris",
+	"license": "ISC",
+	"devDependencies": {
+		"@stylistic/eslint-plugin-ts": "^2.11.0",
+		"@types/node": "^22.10.0",
+		"eslint-plugin-import": "^2.31.0",
+		"eslint-plugin-prefer-arrow-functions": "^3.4.1",
+		"typescript": "^5.7.2",
+		"typescript-eslint": "^8.16.0"
+	},
+	"files": [
+		"dist/**/*"
+	],
+	"dependencies": {
+		"arangojs": "^10.1.1",
+		"nodecommons-esm-database": "^0.0.12",
+		"tscommons-esm-core": "^0.0.5"
+	}
+}