@unchainedshop/core-files 4.3.4 → 4.5.0

package/README.md

@@ -1 +1,110 @@
-# Files (Unchained)
+[![npm version](https://img.shields.io/npm/v/@unchainedshop/core-files.svg)](https://npmjs.com/package/@unchainedshop/core-files)
+[![License: EUPL-1.2](https://img.shields.io/badge/License-EUPL--1.2-blue.svg)](https://opensource.org/licenses/EUPL-1.2)
+
+# @unchainedshop/core-files
+
+File management module for the Unchained Engine. Handles media file metadata storage and URL normalization.
+
+## Installation
+
+```bash
+npm install @unchainedshop/core-files
+```
+
+## Usage
+
+```typescript
+import { configureFilesModule } from '@unchainedshop/core-files';
+
+const filesModule = await configureFilesModule({
+  db,
+  options: {
+    transformUrl: (url, params) => url, // Optional URL transformation
+  },
+});
+
+// Create a file record
+const fileId = await filesModule.create({
+  name: 'product-image.jpg',
+  type: 'image/jpeg',
+  path: 'products/123',
+  url: '/uploads/product-image.jpg',
+});
+
+// Find file and normalize URL
+const file = await filesModule.findFile({ fileId });
+const normalizedUrl = filesModule.normalizeUrl(file.url, {});
+```
+
+## API Overview
+
+### Module Configuration
+
+| Export | Description |
+|--------|-------------|
+| `configureFilesModule` | Configure and return the files module |
+
+### Queries
+
+| Method | Description |
+|--------|-------------|
+| `findFile` | Find file by ID or URL |
+| `findFiles` | Find files with custom selector |
+
+### Mutations
+
+| Method | Description |
+|--------|-------------|
+| `create` | Create a new file record |
+| `update` | Update an existing file |
+| `delete` | Delete a file record |
+| `deleteMany` | Delete multiple file records |
+| `unexpire` | Remove expiration from a file |
+
+### Helper Methods
+
+| Method | Description |
+|--------|-------------|
+| `normalizeUrl` | Normalize and transform file URL |
+
+### Utilities
+
+| Export | Description |
+|--------|-------------|
+| `getFileAdapter` | Get configured file storage adapter |
+| `getFileFromFileData` | Convert file data to File object |
+| `filesSettings` | Access file module settings |
+
+### Types
+
+| Export | Description |
+|--------|-------------|
+| `File` | File document type |
+| `FilesModule` | Module interface type |
+| `FilesSettingsOptions` | Configuration options type |
+
+## Configuration
+
+```typescript
+const filesModule = await configureFilesModule({
+  db,
+  options: {
+    transformUrl: (url, params) => {
+      // Transform URLs for CDN, thumbnails, etc.
+      return `https://cdn.example.com${url}`;
+    },
+  },
+});
+```
+
+## Events
+
+| Event | Description |
+|-------|-------------|
+| `FILE_CREATE` | Emitted when a file is created |
+| `FILE_UPDATE` | Emitted when a file is updated |
+| `FILE_REMOVE` | Emitted when a file is removed |
+
+## License
+
+EUPL-1.2

package/lib/db/MediaObjectsCollection.d.ts

@@ -1,5 +1,5 @@
 import { mongodb } from '@unchainedshop/mongodb';
-import { TimestampFields } from '@unchainedshop/mongodb';
+import type { TimestampFields } from '@unchainedshop/mongodb';
 export type File = {
     _id: string;
     expires: Date | null;
@@ -14,4 +14,3 @@ export type SignedFileUpload = File & {
     putURL: string;
 };
 export declare const MediaObjectsCollection: (db: mongodb.Db) => Promise<mongodb.Collection<File>>;
-//# sourceMappingURL=MediaObjectsCollection.d.ts.map

package/lib/db/MediaObjectsCollection.js

@@ -1,4 +1,4 @@
-import { buildDbIndexes } from '@unchainedshop/mongodb';
+import { mongodb, buildDbIndexes } from '@unchainedshop/mongodb';
 export const MediaObjectsCollection = async (db) => {
     const MediaObjects = db.collection('media_objects');
     await buildDbIndexes(MediaObjects, [
@@ -8,4 +8,3 @@ export const MediaObjectsCollection = async (db) => {
     ]);
     return MediaObjects;
 };
-//# sourceMappingURL=MediaObjectsCollection.js.map

package/lib/files-index.d.ts

@@ -1,6 +1,5 @@
-export * from './module/configureFilesModule.js';
-export * from './db/MediaObjectsCollection.js';
-export * from './files-settings.js';
-export * from './utils/getFileAdapter.js';
-export * from './utils/getFileFromFileData.js';
-//# sourceMappingURL=files-index.d.ts.map
+export * from './module/configureFilesModule.ts';
+export * from './db/MediaObjectsCollection.ts';
+export * from './files-settings.ts';
+export * from './utils/getFileAdapter.ts';
+export * from './utils/getFileFromFileData.ts';

package/lib/files-index.js

@@ -1,6 +1,5 @@
-export * from './module/configureFilesModule.js';
-export * from './db/MediaObjectsCollection.js';
-export * from './files-settings.js';
-export * from './utils/getFileAdapter.js';
-export * from './utils/getFileFromFileData.js';
-//# sourceMappingURL=files-index.js.map
+export * from "./module/configureFilesModule.js";
+export * from "./db/MediaObjectsCollection.js";
+export * from "./files-settings.js";
+export * from "./utils/getFileAdapter.js";
+export * from "./utils/getFileFromFileData.js";

package/lib/files-settings.d.ts

@@ -7,4 +7,3 @@ export type FilesSettingsOptions = Omit<Partial<FilesSettings>, 'configureSettin
 export declare const defaultTransformUrl: (url: any) => any;
 export declare const PRIVATE_FILE_SHARING_MAX_AGE = 86400000;
 export declare const filesSettings: FilesSettings;
-//# sourceMappingURL=files-settings.d.ts.map

package/lib/files-settings.js

@@ -1,5 +1,5 @@
 export const defaultTransformUrl = (url) => url;
-export const PRIVATE_FILE_SHARING_MAX_AGE = 86400000; // 24 hours in milliseconds
+export const PRIVATE_FILE_SHARING_MAX_AGE = 86400000;
 export const filesSettings = {
     transformUrl: defaultTransformUrl,
     privateFileSharingMaxAge: PRIVATE_FILE_SHARING_MAX_AGE,
@@ -8,4 +8,3 @@ export const filesSettings = {
         filesSettings.privateFileSharingMaxAge = privateFileSharingMaxAge || PRIVATE_FILE_SHARING_MAX_AGE;
     },
 };
-//# sourceMappingURL=files-settings.js.map

package/lib/module/configureFilesModule.d.ts

@@ -1,7 +1,15 @@
-import { ModuleInput } from '@unchainedshop/mongodb';
+import type { ModuleInput } from '@unchainedshop/mongodb';
 import { mongodb } from '@unchainedshop/mongodb';
-import { File } from '../db/MediaObjectsCollection.js';
-import { FilesSettingsOptions } from '../files-settings.js';
+import { type File } from '../db/MediaObjectsCollection.ts';
+import { type FilesSettingsOptions } from '../files-settings.ts';
+export interface FileQuery {
+    fileIds?: string[];
+    excludeFileId?: string;
+    path?: string;
+    paths?: string[];
+    meta?: Record<string, any>;
+    createdBefore?: Date;
+}
 export declare const configureFilesModule: ({ db, options: filesOptions, }: ModuleInput<FilesSettingsOptions>) => Promise<{
     normalizeUrl: (url: string, params: Record<string, any>) => string;
     findFile: (params: {
@@ -9,7 +17,7 @@ export declare const configureFilesModule: ({ db, options: filesOptions, }: Modu
     } | {
         url: string;
     }, options?: mongodb.FindOptions) => Promise<File | null>;
-    findFiles: (selector: mongodb.Filter<File>, options?: mongodb.FindOptions) => Promise<File[]>;
+    findFiles: (query: FileQuery, options?: mongodb.FindOptions) => Promise<File[]>;
     deleteMany: (fileIds: string[]) => Promise<number>;
     create: (doc: Omit<File, "_id" | "created"> & Pick<Partial<File>, "_id" | "created">) => Promise<string>;
     update: (fileId: string, doc: Partial<File>) => Promise<string>;
@@ -17,4 +25,3 @@ export declare const configureFilesModule: ({ db, options: filesOptions, }: Modu
     delete: (fileId: string) => Promise<number>;
 }>;
 export type FilesModule = Awaited<ReturnType<typeof configureFilesModule>>;
-//# sourceMappingURL=configureFilesModule.d.ts.map

package/lib/module/configureFilesModule.js

@@ -1,12 +1,11 @@
 import { emit, registerEvents } from '@unchainedshop/events';
-import { generateDbFilterById, generateDbObjectId } from '@unchainedshop/mongodb';
-import { MediaObjectsCollection } from '../db/MediaObjectsCollection.js';
-import { filesSettings } from '../files-settings.js';
+import { generateDbFilterById, generateDbObjectId, mongodb } from '@unchainedshop/mongodb';
+import { MediaObjectsCollection } from "../db/MediaObjectsCollection.js";
+import { filesSettings } from "../files-settings.js";
 const FILE_EVENTS = ['FILE_CREATE', 'FILE_UPDATE', 'FILE_REMOVE'];
 const { ROOT_URL = 'http://localhost:4010' } = process.env;
 export const configureFilesModule = async ({ db, options: filesOptions = {}, }) => {
     registerEvents(FILE_EVENTS);
-    // Settings
     await filesSettings.configureSettings(filesOptions);
     const Files = await MediaObjectsCollection(db);
     return {
@@ -28,7 +27,28 @@ export const configureFilesModule = async ({ db, options: filesOptions = {}, })
             }
             return Files.findOne(generateDbFilterById(params.fileId), options);
         },
-        findFiles: async (selector, options) => {
+        findFiles: async (query, options) => {
+            const selector = {};
+            if (query.fileIds) {
+                selector._id = { $in: query.fileIds };
+            }
+            if (query.excludeFileId) {
+                selector._id = { $ne: query.excludeFileId };
+            }
+            if (query.path) {
+                selector.path = query.path;
+            }
+            if (query.paths) {
+                selector.path = { $in: query.paths };
+            }
+            if (query.meta) {
+                Object.entries(query.meta).forEach(([key, value]) => {
+                    selector[`meta.${key}`] = value;
+                });
+            }
+            if (query.createdBefore) {
+                selector.created = { $lt: query.createdBefore };
+            }
             return Files.find(selector, options).toArray();
         },
         deleteMany: async (fileIds) => {
@@ -71,4 +91,3 @@ export const configureFilesModule = async ({ db, options: filesOptions = {}, })
         },
     };
 };
-//# sourceMappingURL=configureFilesModule.js.map

package/lib/utils/getFileAdapter.d.ts

@@ -1,2 +1 @@
 export declare const getFileAdapter: () => import("@unchainedshop/file-upload").IFileAdapter<unknown>;
-//# sourceMappingURL=getFileAdapter.d.ts.map

package/lib/utils/getFileAdapter.js

@@ -3,7 +3,5 @@ export const getFileAdapter = () => {
     const adapters = FileDirector.getAdapters();
     if (adapters.length === 0)
         throw Error('No file adapter found.');
-    // For now we return the first file upload adapter without further filter options
     return adapters[0];
 };
-//# sourceMappingURL=getFileAdapter.js.map

package/lib/utils/getFileFromFileData.d.ts

@@ -1,4 +1,4 @@
-import { UploadFileData } from '@unchainedshop/file-upload';
+import type { UploadFileData } from '@unchainedshop/file-upload';
 export declare const getFileFromFileData: (fileData: UploadFileData, meta: any) => {
     _id: string;
     path: string;
@@ -10,4 +10,3 @@ export declare const getFileFromFileData: (fileData: UploadFileData, meta: any)
     meta: any;
 };
 export default getFileFromFileData;
-//# sourceMappingURL=getFileFromFileData.d.ts.map

package/lib/utils/getFileFromFileData.js

@@ -9,4 +9,3 @@ export const getFileFromFileData = (fileData, meta) => ({
     meta,
 });
 export default getFileFromFileData;
-//# sourceMappingURL=getFileFromFileData.js.map

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@unchainedshop/core-files",
-  "version": "4.3.4",
+  "version": "4.5.0",
   "main": "lib/files-index.js",
   "types": "lib/files-index.d.ts",
   "type": "module",
+  "sideEffects": false,
   "scripts": {
     "clean": "tsc -b --clean",
     "build": "tsc -b",
     "prepublishOnly": "npm run clean && npm run build",
     "watch": "tsc -w",
-    "test": "tsx --test",
-    "test:watch": "tsx --test --watch"
+    "test": "node --test",
+    "test:watch": "node --test --watch"
   },
   "repository": {
     "type": "git",
@@ -22,8 +23,10 @@
     "core"
   ],
   "authors": [
-    "Joël Meiller",
-    "Pascal Kaufmann"
+    "Pascal Kaufmann",
+    "Mikael Araya",
+    "Vedran Rudelj",
+    "Joël Meiller"
   ],
   "license": "EUPL-1.2",
   "bugs": {
@@ -31,14 +34,13 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/events": "^4.3.0",
-    "@unchainedshop/file-upload": "^4.3.0",
-    "@unchainedshop/logger": "^4.3.0",
-    "@unchainedshop/utils": "^4.3.0"
+    "@unchainedshop/events": "^4.5.0",
+    "@unchainedshop/file-upload": "^4.5.0",
+    "@unchainedshop/logger": "^4.5.0",
+    "@unchainedshop/utils": "^4.5.0"
   },
   "devDependencies": {
-    "@types/node": "^24.0.13",
-    "tsx": "^4.20.3",
+    "@types/node": "^25.0.0",
     "typescript": "^5.8.3"
   }
 }

package/lib/db/MediaObjectsCollection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"MediaObjectsCollection.d.ts","sourceRoot":"","sources":["../../src/db/MediaObjectsCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAkB,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,MAAM,MAAM,IAAI,GAAG;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,GAAG,eAAe,CAAC;AAEpB,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG;IACpC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AACF,eAAO,MAAM,sBAAsB,GAAU,IAAI,OAAO,CAAC,EAAE,sCAU1D,CAAC"}

package/lib/db/MediaObjectsCollection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"MediaObjectsCollection.js","sourceRoot":"","sources":["../../src/db/MediaObjectsCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAiBjE,MAAM,CAAC,MAAM,sBAAsB,GAAG,KAAK,EAAE,EAAc,EAAE,EAAE;IAC7D,MAAM,YAAY,GAAG,EAAE,CAAC,UAAU,CAAO,eAAe,CAAC,CAAC;IAE1D,MAAM,cAAc,CAAO,YAAY,EAAE;QACvC,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE;QACrB,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAAE,CAAC,EAAE,EAAE;QAC7D,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;KAC3B,CAAC,CAAC;IAEH,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC"}

package/lib/files-index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"files-index.d.ts","sourceRoot":"","sources":["../src/files-index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gCAAgC,CAAC"}

package/lib/files-index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"files-index.js","sourceRoot":"","sources":["../src/files-index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gCAAgC,CAAC"}

package/lib/files-settings.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"files-settings.d.ts","sourceRoot":"","sources":["../src/files-settings.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC;IACnE,wBAAwB,EAAE,MAAM,CAAC;IACjC,iBAAiB,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAC;CAC5D;AAED,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,mBAAmB,CAAC,CAAC;AAErF,eAAO,MAAM,mBAAmB,GAAI,QAAG,QAAQ,CAAC;AAChD,eAAO,MAAM,4BAA4B,WAAW,CAAC;AAErD,eAAO,MAAM,aAAa,EAAE,aAO3B,CAAC"}

package/lib/files-settings.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"files-settings.js","sourceRoot":"","sources":["../src/files-settings.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC;AAChD,MAAM,CAAC,MAAM,4BAA4B,GAAG,QAAQ,CAAC,CAAC,2BAA2B;AAEjF,MAAM,CAAC,MAAM,aAAa,GAAkB;IAC1C,YAAY,EAAE,mBAAmB;IACjC,wBAAwB,EAAE,4BAA4B;IACtD,iBAAiB,EAAE,CAAC,EAAE,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAE,EAAE,EAAE;QACrE,aAAa,CAAC,YAAY,GAAG,YAAY,IAAI,mBAAmB,CAAC;QACjE,aAAa,CAAC,wBAAwB,GAAG,wBAAwB,IAAI,4BAA4B,CAAC;IACpG,CAAC;CACF,CAAC"}

package/lib/module/configureFilesModule.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"configureFilesModule.d.ts","sourceRoot":"","sources":["../../src/module/configureFilesModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD,OAAO,EAA4C,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC3F,OAAO,EAA0B,IAAI,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAiB,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAM3E,eAAO,MAAM,oBAAoB,GAAU,gCAGxC,WAAW,CAAC,oBAAoB,CAAC;wBASZ,MAAM,UAAU,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,MAAM;uBAYvC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,YAAY,OAAO,CAAC,WAAW;0BAQhF,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,YACpB,OAAO,CAAC,WAAW,KAC5B,OAAO,CAAC,IAAI,EAAE,CAAC;0BAIU,MAAM,EAAE,KAAG,OAAO,CAAC,MAAM,CAAC;kBAKlC,IAAI,CAAC,IAAI,EAAE,KAAK,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;qBAUnE,MAAM,OAAO,OAAO,CAAC,IAAI,CAAC;uBAcxB,MAAM;qBAcR,MAAM;EAMhC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC,CAAC"}

package/lib/module/configureFilesModule.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"configureFilesModule.js","sourceRoot":"","sources":["../../src/module/configureFilesModule.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAW,MAAM,wBAAwB,CAAC;AAC3F,OAAO,EAAE,sBAAsB,EAAQ,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAwB,MAAM,sBAAsB,CAAC;AAE3E,MAAM,WAAW,GAAa,CAAC,aAAa,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;AAE5E,MAAM,EAAE,QAAQ,GAAG,uBAAuB,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;AAE3D,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EAAE,EACzC,EAAE,EACF,OAAO,EAAE,YAAY,GAAG,EAAE,GACQ,EAAE,EAAE;IACtC,cAAc,CAAC,WAAW,CAAC,CAAC;IAE5B,WAAW;IACX,MAAM,aAAa,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;IAEpD,MAAM,KAAK,GAAG,MAAM,sBAAsB,CAAC,EAAE,CAAC,CAAC;IAE/C,OAAO;QACL,YAAY,EAAE,CAAC,GAAW,EAAE,MAA2B,EAAU,EAAE;YACjE,MAAM,oBAAoB,GAAG,aAAa,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YACrE,IAAI,GAAG,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBACvC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,CAAC;gBAC/C,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;iBAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,oBAAoB,EAAE,QAAQ,CAAC,EAAE,CAAC;gBACxD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC;gBACzD,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;YACD,OAAO,oBAAoB,CAAC;QAC9B,CAAC;QAED,QAAQ,EAAE,KAAK,EAAE,MAA4C,EAAE,OAA6B,EAAE,EAAE;YAC9F,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;gBACpB,OAAO,KAAK,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,KAAK,CAAC,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;QACrE,CAAC;QAED,SAAS,EAAE,KAAK,EACd,QAA8B,EAC9B,OAA6B,EACZ,EAAE;YACnB,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;QACjD,CAAC;QAED,UAAU,EAAE,KAAK,EAAE,OAAiB,EAAmB,EAAE;YACvD,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;YACzE,OAAO,cAAc,CAAC,YAAY,CAAC;QACrC,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAA2E,EAAE,EAAE;YAC5F,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC;gBACnD,GAAG,EAAE,kBAAkB,EAAE;gBACzB,OAAO,EAAE,IAAI,IAAI,EAAE;gBACnB,GAAG,GAAG;aACP,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YACtC,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,MAAc,EAAE,GAAkB,EAAE,EAAE;YACnD,MAAM,KAAK,CAAC,SAAS,CACnB,EAAE,GAAG,EAAE,MAAM,EAAE,EACf;gBACE,IAAI,EAAE;oBACJ,OAAO,EAAE,IAAI,IAAI,EAAE;oBACnB,GAAG,GAAG;iBACP;aACF,CACF,CAAC;YACF,MAAM,IAAI,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YACtC,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,QAAQ,EAAE,KAAK,EAAE,MAAc,EAAE,EAAE;YACjC,MAAM,KAAK,CAAC,SAAS,CACnB,EAAE,GAAG,EAAE,MAAM,EAAE,EACf;gBACE,IAAI,EAAE;oBACJ,OAAO,EAAE,IAAI,IAAI,EAAE;iBACpB;gBACD,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE;aACvB,CACF,CAAC;YACF,MAAM,IAAI,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YACtC,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,MAAc,EAAE,EAAE;YAC/B,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;YAChE,MAAM,IAAI,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YACtC,OAAO,YAAY,CAAC;QACtB,CAAC;KACF,CAAC;AACJ,CAAC,CAAC"}

package/lib/utils/getFileAdapter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getFileAdapter.d.ts","sourceRoot":"","sources":["../../src/utils/getFileAdapter.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,cAAc,kEAM1B,CAAC"}

package/lib/utils/getFileAdapter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getFileAdapter.js","sourceRoot":"","sources":["../../src/utils/getFileAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,EAAE;IACjC,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC;IAC5C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAEjE,iFAAiF;IACjF,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;AACrB,CAAC,CAAC"}

package/lib/utils/getFileFromFileData.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getFileFromFileData.d.ts","sourceRoot":"","sources":["../../src/utils/getFileFromFileData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAE5D,eAAO,MAAM,mBAAmB,GAAI,UAAU,cAAc,EAAE,MAAM,GAAG;;;;;;;;;CASrE,CAAC;AAEH,eAAe,mBAAmB,CAAC"}

package/lib/utils/getFileFromFileData.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getFileFromFileData.js","sourceRoot":"","sources":["../../src/utils/getFileFromFileData.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAwB,EAAE,IAAS,EAAE,EAAE,CAAC,CAAC;IAC3E,GAAG,EAAE,QAAQ,CAAC,GAAG;IACjB,IAAI,EAAE,QAAQ,CAAC,aAAa;IAC5B,OAAO,EAAE,QAAQ,CAAC,UAAU,IAAI,IAAI;IACpC,IAAI,EAAE,QAAQ,CAAC,QAAQ;IACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;IACnB,IAAI,EAAE,QAAQ,CAAC,IAAI,IAAI,0BAA0B;IACjD,GAAG,EAAE,QAAQ,CAAC,GAAG;IACjB,IAAI;CACL,CAAC,CAAC;AAEH,eAAe,mBAAmB,CAAC"}

package/src/db/MediaObjectsCollection.ts

@@ -1,28 +0,0 @@
-import { mongodb, buildDbIndexes } from '@unchainedshop/mongodb';
-import { TimestampFields } from '@unchainedshop/mongodb';
-
-export type File = {
-  _id: string;
-  expires: Date | null;
-  path: string;
-  meta?: Record<string, unknown>;
-  name: string;
-  size?: number;
-  type?: string;
-  url?: string;
-} & TimestampFields;
-
-export type SignedFileUpload = File & {
-  putURL: string;
-};
-export const MediaObjectsCollection = async (db: mongodb.Db) => {
-  const MediaObjects = db.collection<File>('media_objects');
-
-  await buildDbIndexes<File>(MediaObjects, [
-    { index: { url: 1 } },
-    { index: { expires: 1 }, options: { expireAfterSeconds: 0 } },
-    { index: { created: -1 } },
-  ]);
-
-  return MediaObjects;
-};

package/src/files-index.ts

@@ -1,5 +0,0 @@
-export * from './module/configureFilesModule.js';
-export * from './db/MediaObjectsCollection.js';
-export * from './files-settings.js';
-export * from './utils/getFileAdapter.js';
-export * from './utils/getFileFromFileData.js';

package/src/files-settings.ts

@@ -1,19 +0,0 @@
-export interface FilesSettings {
-  transformUrl: (url: string, params: Record<string, any>) => string;
-  privateFileSharingMaxAge: number;
-  configureSettings: (options: FilesSettingsOptions) => void;
-}
-
-export type FilesSettingsOptions = Omit<Partial<FilesSettings>, 'configureSettings'>;
-
-export const defaultTransformUrl = (url) => url;
-export const PRIVATE_FILE_SHARING_MAX_AGE = 86400000; // 24 hours in milliseconds
-
-export const filesSettings: FilesSettings = {
-  transformUrl: defaultTransformUrl,
-  privateFileSharingMaxAge: PRIVATE_FILE_SHARING_MAX_AGE,
-  configureSettings: ({ transformUrl, privateFileSharingMaxAge } = {}) => {
-    filesSettings.transformUrl = transformUrl || defaultTransformUrl;
-    filesSettings.privateFileSharingMaxAge = privateFileSharingMaxAge || PRIVATE_FILE_SHARING_MAX_AGE;
-  },
-};

package/src/module/configureFilesModule.ts

@@ -1,100 +0,0 @@
-import { ModuleInput } from '@unchainedshop/mongodb';
-import { emit, registerEvents } from '@unchainedshop/events';
-import { generateDbFilterById, generateDbObjectId, mongodb } from '@unchainedshop/mongodb';
-import { MediaObjectsCollection, File } from '../db/MediaObjectsCollection.js';
-import { filesSettings, FilesSettingsOptions } from '../files-settings.js';
-
-const FILE_EVENTS: string[] = ['FILE_CREATE', 'FILE_UPDATE', 'FILE_REMOVE'];
-
-const { ROOT_URL = 'http://localhost:4010' } = process.env;
-
-export const configureFilesModule = async ({
-  db,
-  options: filesOptions = {},
-}: ModuleInput<FilesSettingsOptions>) => {
-  registerEvents(FILE_EVENTS);
-
-  // Settings
-  await filesSettings.configureSettings(filesOptions);
-
-  const Files = await MediaObjectsCollection(db);
-
-  return {
-    normalizeUrl: (url: string, params: Record<string, any>): string => {
-      const transformedURLString = filesSettings.transformUrl(url, params);
-      if (URL.canParse(transformedURLString)) {
-        const finalURL = new URL(transformedURLString);
-        return finalURL.href;
-      } else if (URL.canParse(transformedURLString, ROOT_URL)) {
-        const finalURL = new URL(transformedURLString, ROOT_URL);
-        return finalURL.href;
-      }
-      return transformedURLString;
-    },
-
-    findFile: async (params: { fileId: string } | { url: string }, options?: mongodb.FindOptions) => {
-      if ('url' in params) {
-        return Files.findOne({ url: params.url }, options);
-      }
-      return Files.findOne(generateDbFilterById(params.fileId), options);
-    },
-
-    findFiles: async (
-      selector: mongodb.Filter<File>,
-      options?: mongodb.FindOptions,
-    ): Promise<File[]> => {
-      return Files.find(selector, options).toArray();
-    },
-
-    deleteMany: async (fileIds: string[]): Promise<number> => {
-      const deletionResult = await Files.deleteMany({ _id: { $in: fileIds } });
-      return deletionResult.deletedCount;
-    },
-
-    create: async (doc: Omit<File, '_id' | 'created'> & Pick<Partial<File>, '_id' | 'created'>) => {
-      const { insertedId: fileId } = await Files.insertOne({
-        _id: generateDbObjectId(),
-        created: new Date(),
-        ...doc,
-      });
-      await emit('FILE_CREATE', { fileId });
-      return fileId;
-    },
-
-    update: async (fileId: string, doc: Partial<File>) => {
-      await Files.updateOne(
-        { _id: fileId },
-        {
-          $set: {
-            updated: new Date(),
-            ...doc,
-          },
-        },
-      );
-      await emit('FILE_UPDATE', { fileId });
-      return fileId;
-    },
-
-    unexpire: async (fileId: string) => {
-      await Files.updateOne(
-        { _id: fileId },
-        {
-          $set: {
-            updated: new Date(),
-          },
-          $unset: { expires: 1 },
-        },
-      );
-      await emit('FILE_UPDATE', { fileId });
-      return fileId;
-    },
-
-    delete: async (fileId: string) => {
-      const { deletedCount } = await Files.deleteOne({ _id: fileId });
-      await emit('FILE_REMOVE', { fileId });
-      return deletedCount;
-    },
-  };
-};
-
-export type FilesModule = Awaited<ReturnType<typeof configureFilesModule>>;

package/src/utils/getFileAdapter.ts

@@ -1,9 +0,0 @@
-import { FileDirector } from '@unchainedshop/file-upload';
-
-export const getFileAdapter = () => {
-  const adapters = FileDirector.getAdapters();
-  if (adapters.length === 0) throw Error('No file adapter found.');
-
-  // For now we return the first file upload adapter without further filter options
-  return adapters[0];
-};

package/src/utils/getFileFromFileData.ts

@@ -1,14 +0,0 @@
-import { UploadFileData } from '@unchainedshop/file-upload';
-
-export const getFileFromFileData = (fileData: UploadFileData, meta: any) => ({
-  _id: fileData._id,
-  path: fileData.directoryName,
-  expires: fileData.expiryDate || null,
-  name: fileData.fileName,
-  size: fileData.size,
-  type: fileData.type || 'application/octet-stream',
-  url: fileData.url,
-  meta,
-});
-
-export default getFileFromFileData;

package/tests/files-index.test.ts

@@ -1,8 +0,0 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
-
-describe('Files', () => {
-  it('Init', () => {
-    assert(true);
-  });
-});

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../shared/base.tsconfig.json",
-  "compilerOptions": {
-    "declarationDir": "./lib",
-    "rootDir": "./src",
-    "outDir": "./lib",
-    
-  },
-  "exclude": ["**/*.test.ts", "**/*.test.js", "tests", "lib"]
-}