document-drive 1.0.0-alpha.4 → 1.0.0-alpha.41

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "document-drive",
-    "version": "1.0.0-alpha.4",
+    "version": "1.0.0-alpha.41",
     "license": "AGPL-3.0-only",
     "type": "module",
     "module": "./src/index.ts",
@@ -13,8 +13,11 @@
         "./storage/filesystem": "./src/storage/filesystem.ts",
         "./storage/memory": "./src/storage/memory.ts",
         "./storage/prisma": "./src/storage/prisma.ts",
+        "./cache/redis": "./src/cache/redis.ts",
+        "./cache/memory": "./src/cache/memory.ts",
         "./utils": "./src/utils/index.ts",
-        "./utils/graphql": "./src/utils/graphql.ts"
+        "./utils/graphql": "./src/utils/graphql.ts",
+        "./logger": "./src/utils/logger.ts"
     },
     "files": [
         "./src"
@@ -29,10 +32,13 @@
         "test:watch": "vitest watch"
     },
     "peerDependencies": {
-        "@prisma/client": "5.8.1",
-        "document-model": "^1.0.29",
-        "document-model-libs": "^1.1.44",
+        "document-model": "^1.0.45",
+        "document-model-libs": "^1.34.0"
+    },
+    "optionalDependencies": {
+        "@prisma/client": "5.11.0",
         "localforage": "^1.10.0",
+        "redis": "^4.6.13",
         "sequelize": "^6.35.2",
         "sqlite3": "^5.1.7"
     },
@@ -45,28 +51,29 @@
     },
     "devDependencies": {
         "@commitlint/cli": "^18.6.1",
-        "@commitlint/config-conventional": "^18.6.2",
-        "@prisma/client": "5.8.1",
+        "@commitlint/config-conventional": "^18.6.3",
+        "@prisma/client": "5.11.0",
         "@semantic-release/changelog": "^6.0.3",
         "@semantic-release/git": "^10.0.1",
         "@total-typescript/ts-reset": "^0.5.1",
-        "@types/node": "^20.11.16",
-        "@typescript-eslint/eslint-plugin": "^6.18.1",
-        "@typescript-eslint/parser": "^6.18.1",
-        "@vitest/coverage-v8": "^0.34.6",
-        "document-model": "^1.0.30",
-        "document-model-libs": "^1.1.51",
-        "eslint": "^8.56.0",
+        "@types/node": "^20.12.7",
+        "@typescript-eslint/eslint-plugin": "^6.21.0",
+        "@typescript-eslint/parser": "^6.21.0",
+        "@vitest/coverage-v8": "^1.4.0",
+        "document-model": "^1.0.45",
+        "document-model-libs": "^1.34.0",
+        "eslint": "^8.57.0",
         "eslint-config-prettier": "^9.1.0",
-        "fake-indexeddb": "^5.0.1",
+        "fake-indexeddb": "^5.0.2",
         "localforage": "^1.10.0",
-        "msw": "^2.1.2",
-        "prettier": "^3.1.1",
+        "msw": "^2.2.13",
+        "prettier": "^3.2.5",
         "prettier-plugin-organize-imports": "^3.2.4",
-        "semantic-release": "^23.0.2",
-        "sequelize": "^6.35.2",
+        "prisma": "^5.12.1",
+        "semantic-release": "^23.0.8",
+        "sequelize": "^6.37.2",
         "sqlite3": "^5.1.7",
-        "typescript": "^5.3.2",
-        "vitest": "^1.2.2"
+        "typescript": "^5.4.4",
+        "vitest": "^1.5.0"
     }
 }

package/src/cache/index.ts

@@ -0,0 +1,2 @@
+export * from './memory';
+export * from './types';

package/src/cache/memory.ts

@@ -0,0 +1,24 @@
+import { Document } from "document-model/document";
+import { ICache } from "./types";
+
+class InMemoryCache implements ICache {
+    private cache = new Map<string, Map<string, Document>>();
+
+    async setDocument(drive: string, id: string, document: Document) {
+        if (!this.cache.has(drive)) {
+            this.cache.set(drive, new Map());
+        }
+        this.cache.get(drive)?.set(id, document);
+        return true;
+    }
+
+    async deleteDocument(drive: string, id: string) {
+        return this.cache.get(drive)?.delete(id) ?? false;
+    }
+
+    async getDocument(drive: string, id: string) {
+        return this.cache.get(drive)?.get(id);
+    }
+}
+
+export default InMemoryCache;

package/src/cache/redis.ts

@@ -0,0 +1,29 @@
+import { Document } from "document-model/document";
+import { ICache } from "./types";
+import type { RedisClientType } from "redis";
+import { logger } from "../utils/logger";
+
+class RedisCache implements ICache {
+    private redis: RedisClientType;
+
+    constructor(redis: RedisClientType) {
+        this.redis = redis;
+        this.redis.flushAll().catch(logger.error);
+    }
+
+    async setDocument(drive: string, id: string, document: Document) {
+        return (await this.redis.hSet(drive, id, JSON.stringify(document))) > 0;
+    }
+
+    async getDocument(drive: string, id: string) {
+        const doc = await this.redis.hGet(drive, id);
+
+        return doc ? JSON.parse(doc) as Document : undefined;
+    }
+
+    async deleteDocument(drive: string, id: string) {
+        return (await this.redis.hDel(drive, id)) > 0;
+    }
+}
+
+export default RedisCache;

package/src/cache/types.ts

@@ -0,0 +1,9 @@
+import type { Document } from "document-model/document";
+
+export interface ICache {
+    setDocument(drive: string, id: string, document: Document): Promise<boolean>
+    getDocument(drive: string, id: string): Promise<Document | undefined>
+
+    // @returns — true if a document existed and has been removed, or false if the document is not cached.
+    deleteDocument(drive: string, id: string): Promise<boolean>
+}

package/src/server/error.ts

@@ -16,3 +16,20 @@ export class OperationError extends Error {
         this.operation = operation;
     }
 }
+
+export class ConflictOperationError extends OperationError {
+    constructor(existingOperation: Operation, newOperation: Operation) {
+        super(
+            'CONFLICT',
+            newOperation,
+            `Conflicting operation on index ${newOperation.index}`,
+            { existingOperation, newOperation }
+        );
+    }
+}
+
+export class MissingOperationError extends OperationError {
+    constructor(index: number, operation: Operation) {
+        super('MISSING', operation, `Missing operation on index ${index}`);
+    }
+}