@unchainedshop/core-bookmarks 4.3.4 → 4.4.0

package/README.md

@@ -1,3 +1,75 @@
-# Bookmarks (Unchained Engine)
+[![npm version](https://img.shields.io/npm/v/@unchainedshop/core-bookmarks.svg)](https://npmjs.com/package/@unchainedshop/core-bookmarks)
+[![License: EUPL-1.2](https://img.shields.io/badge/License-EUPL--1.2-blue.svg)](https://opensource.org/licenses/EUPL-1.2)
 
-This package contains business logic and database abstraction for bookmarks in Unchained.
+# @unchainedshop/core-bookmarks
+
+Bookmark management module for the Unchained Engine. Allows users to bookmark products for later reference.
+
+## Installation
+
+```bash
+npm install @unchainedshop/core-bookmarks
+```
+
+## Usage
+
+```typescript
+import { configureBookmarksModule } from '@unchainedshop/core-bookmarks';
+
+const bookmarksModule = await configureBookmarksModule({ db });
+
+// Create a bookmark
+const bookmarkId = await bookmarksModule.create({
+  userId: 'user-123',
+  productId: 'product-456',
+});
+
+// Find bookmarks by user
+const bookmarks = await bookmarksModule.findBookmarksByUserId('user-123');
+```
+
+## API Overview
+
+### Module Configuration
+
+| Export | Description |
+|--------|-------------|
+| `configureBookmarksModule` | Configure and return the bookmarks module |
+
+### Queries
+
+| Method | Description |
+|--------|-------------|
+| `findBookmarkById` | Find a bookmark by its ID |
+| `findBookmarksByUserId` | Find all bookmarks for a user |
+| `findBookmarks` | Find bookmarks with custom query |
+
+### Mutations
+
+| Method | Description |
+|--------|-------------|
+| `create` | Create a new bookmark |
+| `update` | Update an existing bookmark |
+| `delete` | Delete a bookmark |
+| `deleteByUserId` | Delete all bookmarks for a user |
+| `deleteByProductId` | Delete all bookmarks for a product |
+| `replaceUserId` | Transfer bookmarks between users |
+
+### Types
+
+| Export | Description |
+|--------|-------------|
+| `Bookmark` | Bookmark document type |
+| `BookmarksModule` | Module interface type |
+
+## Events
+
+| Event | Description |
+|-------|-------------|
+| `BOOKMARK_CREATE` | Emitted when a bookmark is created |
+| `BOOKMARK_UPDATE` | Emitted when a bookmark is updated |
+| `BOOKMARK_REMOVE` | Emitted when a bookmark is removed |
+
+## License
+
+EUPL-1.2

package/lib/bookmarks-index.d.ts

@@ -1,3 +1,2 @@
-export * from './module/configureBookmarksModule.js';
-export * from './db/BookmarksCollection.js';
-//# sourceMappingURL=bookmarks-index.d.ts.map
+export * from './module/configureBookmarksModule.ts';
+export * from './db/BookmarksCollection.ts';

package/lib/bookmarks-index.js

@@ -1,3 +1,2 @@
-export * from './module/configureBookmarksModule.js';
-export * from './db/BookmarksCollection.js';
-//# sourceMappingURL=bookmarks-index.js.map
+export * from "./module/configureBookmarksModule.js";
+export * from "./db/BookmarksCollection.js";

package/lib/db/BookmarksCollection.d.ts

@@ -1,4 +1,3 @@
 import { mongodb } from '@unchainedshop/mongodb';
-import { Bookmark } from '../bookmarks-index.js';
+import type { Bookmark } from '../bookmarks-index.ts';
 export declare const BookmarksCollection: (db: mongodb.Db) => Promise<mongodb.Collection<Bookmark>>;
-//# sourceMappingURL=BookmarksCollection.d.ts.map

package/lib/db/BookmarksCollection.js

@@ -1,7 +1,7 @@
+import { mongodb } from '@unchainedshop/mongodb';
 export const BookmarksCollection = async (db) => {
     const Bookmarks = db.collection('bookmarks');
     await Bookmarks.createIndex({ userId: 1 });
     await Bookmarks.createIndex({ productId: 1 });
     return Bookmarks;
 };
-//# sourceMappingURL=BookmarksCollection.js.map

package/lib/module/configureBookmarksModule.d.ts

@@ -1,4 +1,4 @@
-import { mongodb, TimestampFields, ModuleInput } from '@unchainedshop/mongodb';
+import { mongodb, type TimestampFields, type ModuleInput } from '@unchainedshop/mongodb';
 export type Bookmark = {
     _id: string;
     userId: string;
@@ -17,4 +17,3 @@ export declare const configureBookmarksModule: ({ db }: ModuleInput<Record<strin
     delete: (bookmarkId: string) => Promise<number>;
 }>;
 export type BookmarksModule = Awaited<ReturnType<typeof configureBookmarksModule>>;
-//# sourceMappingURL=configureBookmarksModule.d.ts.map

package/lib/module/configureBookmarksModule.js

@@ -1,19 +1,17 @@
 import { emit, registerEvents } from '@unchainedshop/events';
-import { generateDbFilterById, generateDbObjectId, } from '@unchainedshop/mongodb';
-import { BookmarksCollection } from '../db/BookmarksCollection.js';
+import { generateDbFilterById, generateDbObjectId, mongodb, } from '@unchainedshop/mongodb';
+import { BookmarksCollection } from "../db/BookmarksCollection.js";
 const BOOKMARK_EVENTS = ['BOOKMARK_CREATE', 'BOOKMARK_UPDATE', 'BOOKMARK_REMOVE'];
 export const configureBookmarksModule = async ({ db }) => {
     registerEvents(BOOKMARK_EVENTS);
     const Bookmarks = await BookmarksCollection(db);
     return {
-        // Queries
         findBookmarksByUserId: async (userId) => Bookmarks.find({ userId }).toArray(),
         findBookmarkById: async (bookmarkId) => {
             const filter = generateDbFilterById(bookmarkId);
             return Bookmarks.findOne(filter, {});
         },
         findBookmarks: async (query) => Bookmarks.find(query).toArray(),
-        // Mutations
         replaceUserId: async (fromUserId, toUserId, bookmarkIds) => {
             const selector = { userId: fromUserId };
             if (bookmarkIds) {
@@ -65,4 +63,3 @@ export const configureBookmarksModule = async ({ db }) => {
         },
     };
 };
-//# sourceMappingURL=configureBookmarksModule.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unchainedshop/core-bookmarks",
-  "version": "4.3.4",
+  "version": "4.4.0",
   "main": "lib/bookmarks-index.js",
   "types": "lib/bookmarks-index.d.ts",
   "type": "module",
@@ -9,9 +9,10 @@
     "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"
   },
+  "sideEffects": false,
   "repository": {
     "type": "git",
     "url": "git+https://github.com/unchainedshop/unchained.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,12 +34,11 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/events": "^4.3.0",
-    "@unchainedshop/mongodb": "^4.3.0"
+    "@unchainedshop/events": "^4.4.0",
+    "@unchainedshop/mongodb": "^4.4.0"
   },
   "devDependencies": {
-    "@types/node": "^24.0.13",
-    "tsx": "^4.20.3",
+    "@types/node": "^25.0.0",
     "typescript": "^5.8.3"
   }
 }

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

@@ -1 +0,0 @@
-{"version":3,"file":"bookmarks-index.d.ts","sourceRoot":"","sources":["../src/bookmarks-index.ts"],"names":[],"mappings":"AAAA,cAAc,sCAAsC,CAAC;AACrD,cAAc,6BAA6B,CAAC"}

package/lib/bookmarks-index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"bookmarks-index.js","sourceRoot":"","sources":["../src/bookmarks-index.ts"],"names":[],"mappings":"AAAA,cAAc,sCAAsC,CAAC;AACrD,cAAc,6BAA6B,CAAC"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"BookmarksCollection.d.ts","sourceRoot":"","sources":["../../src/db/BookmarksCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD,eAAO,MAAM,mBAAmB,GAAU,IAAI,OAAO,CAAC,EAAE,0CAOvD,CAAC"}

package/lib/db/BookmarksCollection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"BookmarksCollection.js","sourceRoot":"","sources":["../../src/db/BookmarksCollection.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAE,EAAc,EAAE,EAAE;IAC1D,MAAM,SAAS,GAAG,EAAE,CAAC,UAAU,CAAW,WAAW,CAAC,CAAC;IAEvD,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;IAC3C,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;IAE9C,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"configureBookmarksModule.d.ts","sourceRoot":"","sources":["../../src/module/configureBookmarksModule.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,OAAO,EACP,eAAe,EACf,WAAW,EACZ,MAAM,wBAAwB,CAAC;AAKhC,MAAM,MAAM,QAAQ,GAAG;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ,GAAG,eAAe,CAAC;AAEpB,eAAO,MAAM,wBAAwB,GAAU,QAAQ,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;oCAO/C,MAAM,KAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;mCAE7B,MAAM;2BAId,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;gCAK7D,MAAM,YACR,MAAM,gBACF,MAAM,EAAE,KACrB,OAAO,CAAC,MAAM,CAAC;6BAaa,MAAM;mCAMA,MAAM;;yBAehB,MAAM,OAAO,OAAO,CAAC,QAAQ,CAAC;yBAa9B,MAAM;EAMpC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAC,CAAC"}

package/lib/module/configureBookmarksModule.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"configureBookmarksModule.js","sourceRoot":"","sources":["../../src/module/configureBookmarksModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EACL,oBAAoB,EACpB,kBAAkB,GAInB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAEnE,MAAM,eAAe,GAAa,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;AAS5F,MAAM,CAAC,MAAM,wBAAwB,GAAG,KAAK,EAAE,EAAE,EAAE,EAAsC,EAAE,EAAE;IAC3F,cAAc,CAAC,eAAe,CAAC,CAAC;IAEhC,MAAM,SAAS,GAAG,MAAM,mBAAmB,CAAC,EAAE,CAAC,CAAC;IAEhD,OAAO;QACL,UAAU;QACV,qBAAqB,EAAE,KAAK,EAAE,MAAc,EAAuB,EAAE,CACnE,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;QACtC,gBAAgB,EAAE,KAAK,EAAE,UAAkB,EAAE,EAAE;YAC7C,MAAM,MAAM,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;YAChD,OAAO,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACvC,CAAC;QACD,aAAa,EAAE,KAAK,EAAE,KAA+B,EAAuB,EAAE,CAC5E,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE;QAEjC,YAAY;QACZ,aAAa,EAAE,KAAK,EAClB,UAAkB,EAClB,QAAgB,EAChB,WAAsB,EACL,EAAE;YACnB,MAAM,QAAQ,GAA6B,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YAClE,IAAI,WAAW,EAAE,CAAC;gBAChB,QAAQ,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC;YACtC,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE;gBAClD,IAAI,EAAE;oBACJ,MAAM,EAAE,QAAQ;oBAChB,OAAO,EAAE,IAAI,IAAI,EAAE;iBACpB;aACF,CAAC,CAAC;YACH,OAAO,MAAM,CAAC,aAAa,CAAC;QAC9B,CAAC;QACD,cAAc,EAAE,KAAK,EAAE,MAAc,EAAE,EAAE;YACvC,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;YAC5F,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;YACtD,MAAM,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;YAC9F,OAAO,MAAM,CAAC,YAAY,CAAC;QAC7B,CAAC;QACD,iBAAiB,EAAE,KAAK,EAAE,SAAiB,EAAE,EAAE;YAC7C,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;YAC/F,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;YACzD,MAAM,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;YAC9F,OAAO,MAAM,CAAC,YAAY,CAAC;QAC7B,CAAC;QACD,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YACpB,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC;gBAC3D,GAAG,EAAE,kBAAkB,EAAE;gBACzB,OAAO,EAAE,IAAI,IAAI,EAAE;gBACnB,GAAG,GAAG;aACP,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,iBAAiB,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;YAC9C,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,MAAM,EAAE,KAAK,EAAE,UAAkB,EAAE,GAAsB,EAAE,EAAE;YAC3D,MAAM,SAAS,CAAC,SAAS,CACvB,EAAE,GAAG,EAAE,UAAU,EAAE,EACnB;gBACE,IAAI,EAAE;oBACJ,OAAO,EAAE,IAAI,IAAI,EAAE;oBACnB,GAAG,GAAG;iBACP;aACF,CACF,CAAC;YACF,MAAM,IAAI,CAAC,iBAAiB,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;YAC9C,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,MAAM,EAAE,KAAK,EAAE,UAAkB,EAAE,EAAE;YACnC,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;YACxE,MAAM,IAAI,CAAC,iBAAiB,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;YAC9C,OAAO,YAAY,CAAC;QACtB,CAAC;KACF,CAAC;AACJ,CAAC,CAAC"}

package/src/bookmarks-index.ts

@@ -1,2 +0,0 @@
-export * from './module/configureBookmarksModule.js';
-export * from './db/BookmarksCollection.js';

package/src/db/BookmarksCollection.ts

@@ -1,11 +0,0 @@
-import { mongodb } from '@unchainedshop/mongodb';
-import { Bookmark } from '../bookmarks-index.js';
-
-export const BookmarksCollection = async (db: mongodb.Db) => {
-  const Bookmarks = db.collection<Bookmark>('bookmarks');
-
-  await Bookmarks.createIndex({ userId: 1 });
-  await Bookmarks.createIndex({ productId: 1 });
-
-  return Bookmarks;
-};

package/src/module/configureBookmarksModule.ts

@@ -1,96 +0,0 @@
-import { emit, registerEvents } from '@unchainedshop/events';
-import {
-  generateDbFilterById,
-  generateDbObjectId,
-  mongodb,
-  TimestampFields,
-  ModuleInput,
-} from '@unchainedshop/mongodb';
-import { BookmarksCollection } from '../db/BookmarksCollection.js';
-
-const BOOKMARK_EVENTS: string[] = ['BOOKMARK_CREATE', 'BOOKMARK_UPDATE', 'BOOKMARK_REMOVE'];
-
-export type Bookmark = {
-  _id: string;
-  userId: string;
-  productId: string;
-  meta?: any;
-} & TimestampFields;
-
-export const configureBookmarksModule = async ({ db }: ModuleInput<Record<string, never>>) => {
-  registerEvents(BOOKMARK_EVENTS);
-
-  const Bookmarks = await BookmarksCollection(db);
-
-  return {
-    // Queries
-    findBookmarksByUserId: async (userId: string): Promise<Bookmark[]> =>
-      Bookmarks.find({ userId }).toArray(),
-    findBookmarkById: async (bookmarkId: string) => {
-      const filter = generateDbFilterById(bookmarkId);
-      return Bookmarks.findOne(filter, {});
-    },
-    findBookmarks: async (query: mongodb.Filter<Bookmark>): Promise<Bookmark[]> =>
-      Bookmarks.find(query).toArray(),
-
-    // Mutations
-    replaceUserId: async (
-      fromUserId: string,
-      toUserId: string,
-      bookmarkIds?: string[],
-    ): Promise<number> => {
-      const selector: mongodb.Filter<Bookmark> = { userId: fromUserId };
-      if (bookmarkIds) {
-        selector._id = { $in: bookmarkIds };
-      }
-      const result = await Bookmarks.updateMany(selector, {
-        $set: {
-          userId: toUserId,
-          updated: new Date(),
-        },
-      });
-      return result.upsertedCount;
-    },
-    deleteByUserId: async (userId: string) => {
-      const bookmarks = await Bookmarks.find({ userId }, { projection: { _id: true } }).toArray();
-      const result = await Bookmarks.deleteMany({ userId });
-      await Promise.all(bookmarks.map(async (b) => emit('BOOKMARK_REMOVE', { bookmarkId: b._id })));
-      return result.deletedCount;
-    },
-    deleteByProductId: async (productId: string) => {
-      const bookmarks = await Bookmarks.find({ productId }, { projection: { _id: true } }).toArray();
-      const result = await Bookmarks.deleteMany({ productId });
-      await Promise.all(bookmarks.map(async (b) => emit('BOOKMARK_REMOVE', { bookmarkId: b._id })));
-      return result.deletedCount;
-    },
-    create: async (doc) => {
-      const { insertedId: bookmarkId } = await Bookmarks.insertOne({
-        _id: generateDbObjectId(),
-        created: new Date(),
-        ...doc,
-      });
-      await emit('BOOKMARK_CREATE', { bookmarkId });
-      return bookmarkId;
-    },
-    update: async (bookmarkId: string, doc: Partial<Bookmark>) => {
-      await Bookmarks.updateOne(
-        { _id: bookmarkId },
-        {
-          $set: {
-            updated: new Date(),
-            ...doc,
-          },
-        },
-      );
-      await emit('BOOKMARK_UPDATE', { bookmarkId });
-      return bookmarkId;
-    },
-    delete: async (bookmarkId: string) => {
-      const { deletedCount } = await Bookmarks.deleteOne({ _id: bookmarkId });
-      await emit('BOOKMARK_REMOVE', { bookmarkId });
-      return deletedCount;
-    },
-  };
-};
-
-export type BookmarksModule = Awaited<ReturnType<typeof configureBookmarksModule>>;

package/tests/bookmarks-index.test.ts

@@ -1,8 +0,0 @@
-import assert from 'node:assert';
-import { describe, it } from 'node:test';
-
-describe('Bookmark', () => {
-  it('Check Bookmarks module', () => {
-    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"]
-}