@proteinjs/db-file 1.1.0

package/generated/index.ts

@@ -0,0 +1,35 @@
+/** Load Dependency Source Graphs */
+
+import '@proteinjs/db';
+import '@proteinjs/reflection';
+import '@proteinjs/server-api';
+import '@proteinjs/service';
+import '@proteinjs/user';
+import '@proteinjs/util';
+import 'moment';
+
+/** Generate Source Graph */
+
+const sourceGraph =
+  '{"options":{"directed":true,"multigraph":false,"compound":false},"nodes":[{"v":"@proteinjs/db-file/DefaultFileStorageDriverFactory","value":{"packageName":"@proteinjs/db-file","name":"DefaultFileStorageDriverFactory","filePath":"/home/runner/work/db/db/packages/file/src/FileStorage.ts","qualifiedName":"@proteinjs/db-file/DefaultFileStorageDriverFactory","properties":[],"methods":[{"name":"getDriver","returnType":{"packageName":"@proteinjs/db-file","name":"FileStorageDriver","filePath":null,"qualifiedName":"@proteinjs/db-file/FileStorageDriver","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[]}],"typeParameters":[],"directParents":[{"packageName":"@proteinjs/reflection","name":"Loadable","filePath":null,"qualifiedName":"@proteinjs/reflection/Loadable","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"sourceType":3}},{"v":"@proteinjs/reflection/Loadable"},{"v":"@proteinjs/db-file/FileStorage","value":{"packageName":"@proteinjs/db-file","name":"FileStorage","filePath":"/home/runner/work/db/db/packages/file/src/FileStorage.ts","qualifiedName":"@proteinjs/db-file/FileStorage","isAbstract":false,"isStatic":false,"visibility":"public","properties":[{"name":"defaultDriver","type":{"packageName":"@proteinjs/db-file","name":"FileStorageDriver","filePath":null,"qualifiedName":"@proteinjs/db-file/FileStorageDriver","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":true,"visibility":"private"},{"name":"driver","type":{"packageName":"@proteinjs/db-file","name":"FileStorageDriver","filePath":null,"qualifiedName":"@proteinjs/db-file/FileStorageDriver","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"private"},{"name":"logger","type":{"packageName":"@proteinjs/util","name":"Logger","filePath":null,"qualifiedName":"@proteinjs/util/Logger","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"private"},{"name":"serviceMetadata","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"}],"methods":[{"name":"getDefaultDriver","returnType":{"packageName":"@proteinjs/db-file","name":"FileStorageDriver","filePath":null,"qualifiedName":"@proteinjs/db-file/FileStorageDriver","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"private","parameters":[]},{"name":"createFile","returnType":{"packageName":"","name":"Promise<File>","filePath":null,"qualifiedName":"/Promise<File>","typeParameters":null,"directParents":null},"isAsync":true,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public","parameters":[{"name":"fileMetaData","type":{"packageName":"","name":"Omit<File, keyof ScopedRecord>","filePath":null,"qualifiedName":"/Omit<File, keyof ScopedRecord>","typeParameters":null,"directParents":null}},{"name":"fileData","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}}]},{"name":"getFile","returnType":{"packageName":"","name":"Promise<File>","filePath":null,"qualifiedName":"/Promise<File>","typeParameters":null,"directParents":null},"isAsync":true,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public","parameters":[{"name":"fileId","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}}]},{"name":"getFileData","returnType":{"packageName":"","name":"Promise<string>","filePath":null,"qualifiedName":"/Promise<string>","typeParameters":null,"directParents":null},"isAsync":true,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public","parameters":[{"name":"fileId","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}}]},{"name":"updateFileData","returnType":{"packageName":"","name":"Promise<void>","filePath":null,"qualifiedName":"/Promise<void>","typeParameters":null,"directParents":null},"isAsync":true,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public","parameters":[{"name":"fileId","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}},{"name":"data","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}}]},{"name":"updateFile","returnType":{"packageName":"","name":"Promise<void>","filePath":null,"qualifiedName":"/Promise<void>","typeParameters":null,"directParents":null},"isAsync":true,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public","parameters":[{"name":"file","type":{"packageName":"","name":"Omit<File, keyof ScopedRecord>","filePath":null,"qualifiedName":"/Omit<File, keyof ScopedRecord>","typeParameters":null,"directParents":null}}]},{"name":"deleteFile","returnType":{"packageName":"","name":"Promise<void>","filePath":null,"qualifiedName":"/Promise<void>","typeParameters":null,"directParents":null},"isAsync":true,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public","parameters":[{"name":"fileId","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}}]}],"typeParameters":[],"directParentInterfaces":[{"packageName":"@proteinjs/db-file","name":"FileStorageService","filePath":null,"qualifiedName":"@proteinjs/db-file/FileStorageService","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"directParentClasses":[],"sourceType":2}},{"v":"@proteinjs/db-file/FileStorageService","value":{"packageName":"@proteinjs/db-file","name":"FileStorageService","filePath":"/home/runner/work/db/db/packages/file/src/services/FileStorageService.ts","qualifiedName":"@proteinjs/db-file/FileStorageService","properties":[],"methods":[{"name":"createFile","returnType":{"packageName":"","name":"Promise<File>","filePath":null,"qualifiedName":"/Promise<File>","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[{"name":"fileMetaData","type":{"packageName":"","name":"Omit<File, keyof ScopedRecord>","filePath":null,"qualifiedName":"/Omit<File, keyof ScopedRecord>","typeParameters":null,"directParents":null}},{"name":"fileData","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}}]},{"name":"getFile","returnType":{"packageName":"","name":"Promise<File>","filePath":null,"qualifiedName":"/Promise<File>","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[{"name":"fileId","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}}]},{"name":"getFileData","returnType":{"packageName":"","name":"Promise<string>","filePath":null,"qualifiedName":"/Promise<string>","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[{"name":"fileId","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}}]},{"name":"updateFileData","returnType":{"packageName":"","name":"Promise<void>","filePath":null,"qualifiedName":"/Promise<void>","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[{"name":"fileId","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}},{"name":"data","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}}]},{"name":"updateFile","returnType":{"packageName":"","name":"Promise<void>","filePath":null,"qualifiedName":"/Promise<void>","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[{"name":"file","type":{"packageName":"","name":"Omit<File, keyof ScopedRecord>","filePath":null,"qualifiedName":"/Omit<File, keyof ScopedRecord>","typeParameters":null,"directParents":null}}]},{"name":"deleteFile","returnType":{"packageName":"","name":"Promise<void>","filePath":null,"qualifiedName":"/Promise<void>","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[{"name":"fileId","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}}]}],"typeParameters":[],"directParents":[{"packageName":"@proteinjs/service","name":"Service","filePath":null,"qualifiedName":"@proteinjs/service/Service","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"sourceType":3}},{"v":"@proteinjs/db-file/getFile","value":{"packageName":"@proteinjs/db-file","name":"getFile","filePath":"/home/runner/work/db/db/packages/file/src/routes/getFile.ts","qualifiedName":"@proteinjs/db-file/getFile","type":{"packageName":"@proteinjs/server-api","name":"Route","filePath":null,"qualifiedName":"@proteinjs/server-api/Route","typeParameters":[],"directParents":[{"packageName":"@proteinjs/server-api","name":"Route","filePath":null,"qualifiedName":"@proteinjs/server-api/Route","typeParameters":[],"directParents":null}]},"isExported":true,"isConst":true,"sourceType":0}},{"v":"@proteinjs/server-api/Route"},{"v":"@proteinjs/service/Service"},{"v":"@proteinjs/db-file/FileData","value":{"packageName":"@proteinjs/db-file","name":"FileData","filePath":"/home/runner/work/db/db/packages/file/src/tables/FileDataTable.ts","qualifiedName":"@proteinjs/db-file/FileData","properties":[{"name":"file","type":{"packageName":"","name":"Reference<File>","filePath":null,"qualifiedName":"/Reference<File>","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"order","type":{"packageName":"","name":"number","filePath":null,"qualifiedName":"/number","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"data","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"}],"methods":[],"typeParameters":[],"directParents":[{"packageName":"@proteinjs/user","name":"ScopedRecord","filePath":null,"qualifiedName":"@proteinjs/user/ScopedRecord","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"sourceType":3}},{"v":"@proteinjs/user/ScopedRecord"},{"v":"@proteinjs/db-file/FileDataTable","value":{"packageName":"@proteinjs/db-file","name":"FileDataTable","filePath":"/home/runner/work/db/db/packages/file/src/tables/FileDataTable.ts","qualifiedName":"@proteinjs/db-file/FileDataTable","isAbstract":false,"isStatic":false,"visibility":"public","properties":[{"name":"name","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"auth","type":{"packageName":"","name":"Table<FileData>[\'auth\']","filePath":null,"qualifiedName":"/Table<FileData>[\'auth\']","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"columns","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"}],"methods":[],"typeParameters":[],"directParentInterfaces":[],"directParentClasses":[{"packageName":"@proteinjs/db","name":"Table","filePath":null,"qualifiedName":"@proteinjs/db/Table","isAbstract":false,"isStatic":false,"visibility":"public","properties":[],"methods":[],"typeParameters":["@proteinjs/db-file/FileData"],"directParentInterfaces":[],"directParentClasses":[]}],"sourceType":2}},{"v":"@proteinjs/db/Table"},{"v":"@proteinjs/db-file/File","value":{"packageName":"@proteinjs/db-file","name":"File","filePath":"/home/runner/work/db/db/packages/file/src/tables/FileTable.ts","qualifiedName":"@proteinjs/db-file/File","properties":[{"name":"name","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"type","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"size","type":{"packageName":"","name":"number","filePath":null,"qualifiedName":"/number","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"}],"methods":[],"typeParameters":[],"directParents":[{"packageName":"@proteinjs/user","name":"ScopedRecord","filePath":null,"qualifiedName":"@proteinjs/user/ScopedRecord","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"sourceType":3}},{"v":"@proteinjs/db-file/FileTable","value":{"packageName":"@proteinjs/db-file","name":"FileTable","filePath":"/home/runner/work/db/db/packages/file/src/tables/FileTable.ts","qualifiedName":"@proteinjs/db-file/FileTable","isAbstract":false,"isStatic":false,"visibility":"public","properties":[{"name":"name","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"auth","type":{"packageName":"","name":"Table<File>[\'auth\']","filePath":null,"qualifiedName":"/Table<File>[\'auth\']","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"columns","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"cascadeDeleteReferences","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"}],"methods":[],"typeParameters":[],"directParentInterfaces":[],"directParentClasses":[{"packageName":"@proteinjs/db","name":"Table","filePath":null,"qualifiedName":"@proteinjs/db/Table","isAbstract":false,"isStatic":false,"visibility":"public","properties":[],"methods":[],"typeParameters":["@proteinjs/db-file/File"],"directParentInterfaces":[],"directParentClasses":[]}],"sourceType":2}}],"edges":[{"v":"@proteinjs/db-file/DefaultFileStorageDriverFactory","w":"@proteinjs/reflection/Loadable","value":"extends interface"},{"v":"@proteinjs/db-file/FileStorage","w":"@proteinjs/db-file/FileStorageService","value":"implements interface"},{"v":"@proteinjs/db-file/getFile","w":"@proteinjs/server-api/Route","value":"has type"},{"v":"@proteinjs/db-file/FileStorageService","w":"@proteinjs/service/Service","value":"extends interface"},{"v":"@proteinjs/db-file/FileData","w":"@proteinjs/user/ScopedRecord","value":"extends interface"},{"v":"@proteinjs/db-file/FileDataTable","w":"@proteinjs/db/Table","value":"extends class"},{"v":"@proteinjs/db-file/File","w":"@proteinjs/user/ScopedRecord","value":"extends interface"},{"v":"@proteinjs/db-file/FileTable","w":"@proteinjs/db/Table","value":"extends class"}]}';
+
+/** Generate Source Links */
+
+import { FileStorage } from '../src/FileStorage';
+import { getFile } from '../src/routes/getFile';
+import { FileDataTable } from '../src/tables/FileDataTable';
+import { FileTable } from '../src/tables/FileTable';
+
+const sourceLinks = {
+  '@proteinjs/db-file/FileStorage': FileStorage,
+  '@proteinjs/db-file/getFile': getFile,
+  '@proteinjs/db-file/FileDataTable': FileDataTable,
+  '@proteinjs/db-file/FileTable': FileTable,
+};
+
+/** Load Source Graph and Links */
+
+import { SourceRepository } from '@proteinjs/reflection';
+SourceRepository.merge(sourceGraph, sourceLinks);
+
+export * from '../index';

package/index.ts

@@ -0,0 +1,14 @@
+import moment from 'moment';
+
+export * from './src/FileStorage';
+
+export * from './src/tables/tables';
+export * from './src/tables/FileTable';
+export * from './src/tables/FileDataTable';
+
+export * from './src/services/FileStorageService';
+
+export * from './src/routes/getFileRoute';
+
+export * from './src/FileStorageDriver';
+export * from './src/DbFileStorageDriver';

package/jest.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  roots: ['<rootDir>/test'],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
+  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  testEnvironment: 'node',
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@proteinjs/db-file",
+  "version": "1.1.0",
+  "description": "File storage in the db",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/proteinjs/db.git"
+  },
+  "bugs": {
+    "url": "https://github.com/proteinjs/db/issues"
+  },
+  "homepage": "https://github.com/proteinjs/db#readme",
+  "author": "Brent Bahry",
+  "license": "ISC",
+  "scripts": {
+    "clean": "rm -rf dist/ node_modules/ generated/",
+    "build": "reflection-build && tsc",
+    "watch": "reflection-watch"
+  },
+  "dependencies": {
+    "@proteinjs/db": "^1.3.0",
+    "@proteinjs/reflection": "1.1.5",
+    "@proteinjs/server-api": "1.3.0",
+    "@proteinjs/service": "1.0.18",
+    "@proteinjs/user": "1.0.24",
+    "@proteinjs/util": "1.1.2",
+    "moment": "2.29.4"
+  },
+  "devDependencies": {
+    "@proteinjs/reflection-build": "1.0.19",
+    "@types/jest": "29.5.5",
+    "@types/node": "14.0.27",
+    "@typescript-eslint/eslint-plugin": "7.8.0",
+    "@typescript-eslint/parser": "7.8.0",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-prettier": "5.1.3",
+    "jest": "29.7.0",
+    "ts-jest": "29.1.1",
+    "typescript": "5.2.2"
+  },
+  "main": "./dist/generated/index.js",
+  "types": "./dist/generated/index.d.ts",
+  "gitHead": "bac0422554df77dee36aad99af215a191ed59bde"
+}

package/src/DbFileStorageDriver.ts

@@ -0,0 +1,67 @@
+import { getScopedDb } from '@proteinjs/user';
+import { QueryBuilderFactory, Reference } from '@proteinjs/db';
+import { File } from './tables/FileTable';
+import { tables } from './tables/tables';
+import { FileStorageDriver } from './FileStorageDriver';
+
+export class DbFileStorageDriver implements FileStorageDriver {
+  private chunkSize = 1048576; // Max length of data written to `FileData.data` (1mb)
+
+  /**
+   * @param chunkSize the size, in bytes, to be stored in each `FileDataTable` record; default is 1mb
+   */
+  constructor(chunkSize?: number) {
+    if (chunkSize != undefined) {
+      this.chunkSize = chunkSize;
+    }
+  }
+
+  async createFile(file: File, fileData: string): Promise<void> {
+    const db = getScopedDb();
+    const chunks = this.splitIntoChunks(fileData);
+    for (let index = 0; index < chunks.length; index++) {
+      const chunk = chunks[index];
+      await db.insert(tables.FileData, {
+        file: new Reference(tables.FileData.name, file.id),
+        order: index,
+        data: chunk,
+      });
+    }
+  }
+
+  private splitIntoChunks(data: string): string[] {
+    const chunks = [];
+    for (let i = 0; i < data.length; i += this.chunkSize) {
+      chunks.push(data.substring(i, i + this.chunkSize));
+    }
+    return chunks;
+  }
+
+  async getFileData(fileId: string): Promise<string> {
+    const db = getScopedDb();
+    const qb = new QueryBuilderFactory()
+      .getQueryBuilder(tables.FileData, { file: fileId })
+      .sort([{ field: 'order', desc: false }]);
+    const fileDataRecords = await db.query(tables.FileData, qb);
+    return fileDataRecords.map((record) => record.data).join('');
+  }
+
+  async updateFileData(fileId: string, data: string): Promise<void> {
+    const db = getScopedDb();
+
+    // Delete existing data
+    const deleteQuery = new QueryBuilderFactory().getQueryBuilder(tables.FileData, { file: fileId });
+    await db.delete(tables.FileData, deleteQuery);
+
+    // Split new data into chunks and insert
+    const chunks = this.splitIntoChunks(data);
+    for (let index = 0; index < chunks.length; index++) {
+      const chunk = chunks[index];
+      await db.insert(tables.FileData, {
+        file: new Reference(tables.FileData.name, fileId),
+        order: index,
+        data: chunk,
+      });
+    }
+  }
+}

package/src/FileStorage.ts

@@ -0,0 +1,128 @@
+import { ScopedRecord, getScopedDb } from '@proteinjs/user';
+import { File } from './tables/FileTable';
+import { tables } from './tables/tables';
+import { FileStorageService, getFileStorageService } from './services/FileStorageService';
+import { FileStorageDriver } from './FileStorageDriver';
+import { Loadable, SourceRepository } from '@proteinjs/reflection';
+import { Logger } from '@proteinjs/util';
+import { DbFileStorageDriver } from './DbFileStorageDriver';
+
+/**
+ * A convenience factory function so code using this is portable (can be used in server or browser).
+ * @returns an instance of the `FileStorageService` when called from the browser, and an instance of `FileStorage` otherwise
+ * */
+export const getFileStorage = () =>
+  typeof self === 'undefined' ? new FileStorage() : (getFileStorageService() as FileStorage);
+
+/**
+ * A convenience factory to provide a default `FileStorageDriver`
+ */
+export interface DefaultFileStorageDriverFactory extends Loadable {
+  getDriver(): FileStorageDriver;
+}
+
+/**
+ * A simple api for file storage.
+ * File metadata is stored in the `FileTable`.
+ * File data is stored by the `FileStorageDriver`.
+ */
+export class FileStorage implements FileStorageService {
+  private static defaultDriver: FileStorageDriver;
+  private driver: FileStorageDriver;
+  private logger: Logger = new Logger(this.constructor.name);
+
+  public serviceMetadata = {
+    auth: {
+      allUsers: true,
+    },
+  };
+
+  constructor(driver?: FileStorageDriver) {
+    this.driver = driver ? driver : this.getDefaultDriver();
+  }
+
+  private getDefaultDriver(): FileStorageDriver {
+    if (!FileStorage.defaultDriver) {
+      const defaultDriverFactory = SourceRepository.get().object<DefaultFileStorageDriverFactory>(
+        '@proteinjs/db-file/DefaultFileStorageDriverFactory'
+      );
+      if (defaultDriverFactory) {
+        FileStorage.defaultDriver = defaultDriverFactory.getDriver();
+      } else {
+        this.logger.info(`Defaulting to DbFileStorageDriver since no FileStorageDriver was provided`);
+        FileStorage.defaultDriver = new DbFileStorageDriver();
+      }
+    }
+
+    return FileStorage.defaultDriver;
+  }
+
+  /**
+   * Creates a new file record and its associated data chunks.
+   * @param fileMetaData - The file metadata (name, type, size).
+   * @param fileData - The file data as a string.
+   * @returns The created file record.
+   */
+  async createFile(fileMetaData: Omit<File, keyof ScopedRecord>, fileData: string): Promise<File> {
+    const db = getScopedDb();
+    const file = await db.insert(tables.File, fileMetaData);
+    await this.driver.createFile(file, fileData);
+    return file;
+  }
+
+  /**
+   * Retrieves the metadata of a given file.
+   * @param fileId - The `id` of the file.
+   * @returns The file metadata.
+   */
+  async getFile(fileId: string): Promise<File> {
+    const db = getScopedDb();
+    const file = await db.get(tables.File, { id: fileId });
+    return file;
+  }
+
+  /**
+   * Retrieves the data chunks associated with a given file.
+   * @param fileId - The `id` of the file.
+   * @returns The file data as a single string.
+   */
+  async getFileData(fileId: string): Promise<string> {
+    return await this.driver.getFileData(fileId);
+  }
+
+  /**
+   * Updates the data chunks associated with a given file.
+   * @param fileId - The `id` of the file.
+   * @param data - The new data string to replace the existing data.
+   */
+  async updateFileData(fileId: string, data: string): Promise<void> {
+    await this.driver.updateFileData(fileId, data);
+  }
+
+  /**
+   * Updates the metadata of a given file.
+   * @param file - The updated file to persist.
+   */
+  async updateFile(file: Omit<File, keyof ScopedRecord>): Promise<void> {
+    const db = getScopedDb();
+    await db.update(tables.File, file);
+
+    if (this.driver.updateFile) {
+      await this.driver.updateFile(file as File);
+    }
+  }
+
+  /**
+   * Deletes a file and its data.
+   * The file data is deleted by a cascade delete rule defined on the `FileTable`
+   * @param fileId - The `id` of the file to delete.
+   */
+  async deleteFile(fileId: string): Promise<void> {
+    const db = getScopedDb();
+    if (this.driver.deleteFile) {
+      await this.driver.deleteFile(fileId);
+    }
+
+    await db.delete(tables.File, { id: fileId });
+  }
+}

package/src/FileStorageDriver.ts

@@ -0,0 +1,9 @@
+import { File } from './tables/FileTable';
+
+export interface FileStorageDriver {
+  createFile(file: File, fileData: string): Promise<void>;
+  getFileData(fileId: string): Promise<string>;
+  updateFileData(fileId: string, data: string): Promise<void>;
+  updateFile?(file: File): Promise<void>;
+  deleteFile?(fileId: string): Promise<void>;
+}

package/src/routes/getFile.ts

@@ -0,0 +1,33 @@
+import { Route } from '@proteinjs/server-api';
+import { getFileStorage } from '../FileStorage';
+import { UserAuth } from '@proteinjs/user';
+
+export const getFile: Route = {
+  path: '/file/:id',
+  method: 'get',
+  onRequest: async (request, response): Promise<void> => {
+    if (!UserAuth.isLoggedIn()) {
+      response.status(401).send('User not logged in');
+      return;
+    }
+
+    const fileId = request.params.id;
+    const fileStorage = getFileStorage();
+    try {
+      const file = await fileStorage.getFile(fileId);
+      const fileDataBase64 = await fileStorage.getFileData(fileId);
+      if (!file || !fileDataBase64) {
+        response.status(404).send('File not found');
+      } else {
+        const safeFilename = encodeURIComponent(file.name);
+        const fileData = file.type.startsWith('image/') ? Buffer.from(fileDataBase64, 'base64') : fileDataBase64;
+        response.setHeader('Content-Disposition', `inline; filename="${safeFilename}"`);
+        response.setHeader('Content-Type', file.type);
+        response.send(fileData);
+      }
+    } catch (error) {
+      console.error(`Error fetching file (${fileId}):`, error);
+      response.status(500).send('Internal Server Error');
+    }
+  },
+};

package/src/routes/getFileRoute.ts

@@ -0,0 +1 @@
+export const getFileRoute = { path: (fileId: string) => `/file/${fileId}`, method: 'get' };

package/src/services/FileStorageService.ts

@@ -0,0 +1,14 @@
+import { Service, serviceFactory } from '@proteinjs/service';
+import { ScopedRecord } from '@proteinjs/user';
+import { File } from '../tables/FileTable';
+
+export const getFileStorageService = serviceFactory<FileStorageService>('@proteinjs/db-file/FileStorageService');
+
+export interface FileStorageService extends Service {
+  createFile(fileMetaData: Omit<File, keyof ScopedRecord>, fileData: string): Promise<File>;
+  getFile(fileId: string): Promise<File>;
+  getFileData(fileId: string): Promise<string>;
+  updateFileData(fileId: string, data: string): Promise<void>;
+  updateFile(file: Omit<File, keyof ScopedRecord>): Promise<void>;
+  deleteFile(fileId: string): Promise<void>;
+}

package/src/tables/FileDataTable.ts

@@ -0,0 +1,26 @@
+import { Table, StringColumn, IntegerColumn, ReferenceColumn, Reference } from '@proteinjs/db';
+import { ScopedRecord, withScopedRecordColumns } from '@proteinjs/user';
+import { File, FileTable } from './FileTable';
+
+export interface FileData extends ScopedRecord {
+  file: Reference<File>;
+  order: number;
+  data: string;
+}
+
+export class FileDataTable extends Table<FileData> {
+  public name = 'file_data';
+  public auth: Table<FileData>['auth'] = {
+    db: {
+      all: 'authenticated',
+    },
+    service: {
+      all: 'authenticated',
+    },
+  };
+  public columns = withScopedRecordColumns<FileData>({
+    file: new ReferenceColumn<File>('file', new FileTable().name, false),
+    order: new IntegerColumn('order'),
+    data: new StringColumn('data', {}, 'MAX'),
+  });
+}

package/src/tables/FileTable.ts

@@ -0,0 +1,32 @@
+import { Table, StringColumn, IntegerColumn } from '@proteinjs/db';
+import { ScopedRecord, withScopedRecordColumns } from '@proteinjs/user';
+import { FileDataTable } from './FileDataTable';
+
+export interface File extends ScopedRecord {
+  name: string;
+  type: string;
+  size: number;
+}
+
+export class FileTable extends Table<File> {
+  public name = 'file';
+  public auth: Table<File>['auth'] = {
+    db: {
+      all: 'authenticated',
+    },
+    service: {
+      all: 'authenticated',
+    },
+  };
+  public columns = withScopedRecordColumns<File>({
+    name: new StringColumn('name'),
+    type: new StringColumn('type'),
+    size: new IntegerColumn('size'),
+  });
+  public cascadeDeleteReferences = () => [
+    {
+      table: new FileDataTable().name,
+      referenceColumn: new FileDataTable().columns.file.name,
+    },
+  ];
+}

package/src/tables/tables.ts

@@ -0,0 +1,8 @@
+import { Table } from '@proteinjs/db';
+import { FileTable, File } from './FileTable';
+import { FileDataTable, FileData } from './FileDataTable';
+
+export const tables = {
+  File: new FileTable() as Table<File>,
+  FileData: new FileDataTable() as Table<FileData>,
+};

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "rootDir": "./",
+    "target": "es5",
+    "module": "commonjs",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "./dist/",
+    "strict": true,
+    "noImplicitAny": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "typeRoots": ["./node_modules/@types"],
+    "types": ["node", "jest"]
+  }
+}