@unchainedshop/core-bookmarks 1.1.3

package/.npm/package/README

@@ -0,0 +1,7 @@
+This directory and the files immediately inside it are automatically generated
+when you change this package's NPM dependencies. Commit the files in this
+directory (npm-shrinkwrap.json, .gitignore, and this README) to source control
+so that others run the same versions of sub-dependencies.
+
+You should NOT check in the node_modules directory that Meteor automatically
+creates; if you are using git, the .gitignore file tells git to ignore it.

package/.npm/package/npm-shrinkwrap.json

@@ -0,0 +1,40 @@
+{
+  "lockfileVersion": 1,
+  "dependencies": {
+    "clone": {
+      "version": "2.1.2",
+      "resolved": "https://registry.npmjs.org/clone/-/clone-2.1.2.tgz",
+      "integrity": "sha512-3Pe/CF1Nn94hyhIYpjtiLhdCoEoz0DqQ+988E9gmeEdQZlojxnOb74wctFyuwWQHzqyf9X7C7MG8juUpqBJT8w=="
+    },
+    "lodash._reinterpolate": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/lodash._reinterpolate/-/lodash._reinterpolate-3.0.0.tgz",
+      "integrity": "sha512-xYHt68QRoYGjeeM/XOE1uJtvXQAgvszfBhjV4yvsQH0u2i9I6cI6c6/eG4Hh3UAOVn0y/xAXwmTzEay49Q//HA=="
+    },
+    "lodash.template": {
+      "version": "4.5.0",
+      "resolved": "https://registry.npmjs.org/lodash.template/-/lodash.template-4.5.0.tgz",
+      "integrity": "sha512-84vYFxIkmidUiFxidA/KjjH9pAycqW+h980j7Fuz5qxRtO9pgB7MDFTdys1N7A5mcucRiDyEq4fusljItR1T/A=="
+    },
+    "lodash.templatesettings": {
+      "version": "4.2.0",
+      "resolved": "https://registry.npmjs.org/lodash.templatesettings/-/lodash.templatesettings-4.2.0.tgz",
+      "integrity": "sha512-stgLz+i3Aa9mZgnjr/O+v9ruKZsPsndy7qPZOchbqk2cnTU1ZaldKK+v7m54WoKIyxiuMZTKT2H81F8BeAc3ZQ=="
+    },
+    "message-box": {
+      "version": "0.2.7",
+      "resolved": "https://registry.npmjs.org/message-box/-/message-box-0.2.7.tgz",
+      "integrity": "sha512-C4ccA5nHb58kTS+pLrgF/JWtr7fAIkHxRDceH7tdy5fMA783nUfbYwZ7H2XLvSeYfcnWIYCig5dWW+icK9X/Ag=="
+    },
+    "mongo-object": {
+      "version": "0.1.4",
+      "resolved": "https://registry.npmjs.org/mongo-object/-/mongo-object-0.1.4.tgz",
+      "integrity": "sha512-QtYk0gupWEn2+iB+DDRt1L+WbcNYvJRaHdih/dcqthOa1DbnREUGSs2WGcW478GNYpElflo/yybZXu0sTiRXHg=="
+    },
+    "simpl-schema": {
+      "version": "1.12.0",
+      "resolved": "https://registry.npmjs.org/simpl-schema/-/simpl-schema-1.12.0.tgz",
+      "integrity": "sha512-lzXC3L8jJbPhNXGR3cjlyIauqqrC5WUJS4O34Ym/wLIvb8K3ZieK+1OfTzs4mBpDc3Y8u53gQFAr1X37DmTcEg=="
+    }
+  }
+}

package/.versions

@@ -0,0 +1,17 @@
+babel-compiler@7.9.0
+babel-runtime@1.5.1
+dynamic-import@0.7.2
+ecmascript@0.16.2
+ecmascript-runtime@0.8.0
+ecmascript-runtime-client@0.12.1
+ecmascript-runtime-server@0.11.0
+fetch@0.1.1
+inter-process-messaging@0.1.1
+meteor@1.10.0
+modern-browsers@0.1.8
+modules@0.18.0
+modules-runtime@0.13.0
+promise@0.12.0
+react-fast-refresh@0.2.3
+typescript@4.5.4
+unchained:core-bookmarks@1.1.1

package/README.md

@@ -0,0 +1,3 @@
+# Bookmarks (Unchained Engine)
+
+This package contains business logic and database abstraction for bookmarks in Unchained.

package/package.js

@@ -0,0 +1,21 @@
+Package.describe({
+  name: 'unchained:core-bookmarks',
+  version: '1.1.3',
+  summary: 'Unchained Engine Core: Warehousing',
+  git: 'https://github.com/unchainedshop/unchained',
+  documentation: 'README.md',
+});
+
+Npm.depends({
+  'simpl-schema': '1.12.0',
+  '@unchainedshop/utils': '1.1.3',
+  // '@unchainedshop/events': '1.1.4', // PEER
+});
+
+Package.onUse((api) => {
+  api.versionsFrom('2.7.3');
+  api.use('ecmascript');
+  api.use('typescript');
+
+  api.mainModule('src/bookmarks-index.ts', 'server');
+});

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@unchainedshop/core-bookmarks",
+  "version": "1.1.3",
+  "main": "lib/bookmarks-index.js",
+  "types": "lib/bookmarks-index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "link:core": "npm link @unchainedshop/types",
+    "test": "cross-env METEOR_PACKAGE_DIRS=../ TEST_CLIENT=0 TEST_WATCH=1 meteor test-packages ./ --driver-package meteortesting:mocha --port 4200"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unchainedshop/unchained.git"
+  },
+  "keywords": [
+    "unchained",
+    "ecommerce",
+    "core"
+  ],
+  "author": "Joël Meiller",
+  "license": "EUPL-1.2",
+  "bugs": {
+    "url": "https://github.com/unchainedshop/unchained/issues"
+  },
+  "homepage": "https://github.com/unchainedshop/unchained#readme",
+  "dependencies": {
+    "@unchainedshop/events": "latest",
+    "@unchainedshop/utils": "latest",
+    "simpl-schema": "^1.12.2"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.1",
+    "@types/mocha": "^9.1.1",
+    "@unchainedshop/types": "latest",
+    "chai": "^4.3.6",
+    "cross-env": "^7.0.3",
+    "typescript": "^4.7.4"
+  }
+}

package/src/bookmarks-index.ts

@@ -0,0 +1,2 @@
+export { configureBookmarksModule } from './module/configureBookmarksModule';
+export { bookmarkServices } from './service/bookmarkServices';

package/src/db/BookmarksCollection.ts

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

package/src/db/BookmarksSchema.js

@@ -0,0 +1,11 @@
+import { Schemas } from '@unchainedshop/utils';
+import SimpleSchema from 'simpl-schema';
+
+export const BookmarkSchema = new SimpleSchema(
+  {
+    userId: { type: String, required: true },
+    productId: { type: String, required: true },
+    ...Schemas.timestampFields,
+  },
+  { requiredByDefault: false },
+);

package/src/module/configureBookmarksModule.ts

@@ -0,0 +1,84 @@
+import { emit, registerEvents } from '@unchainedshop/events';
+import { Bookmark, BookmarksModule } from '@unchainedshop/types/bookmarks';
+import { ModuleInput, ModuleMutations } from '@unchainedshop/types/common';
+import { generateDbFilterById, generateDbMutations } from '@unchainedshop/utils';
+import { BookmarksCollection } from '../db/BookmarksCollection';
+import { BookmarkSchema } from '../db/BookmarksSchema';
+
+const BOOKMARK_EVENTS: string[] = ['BOOKMARK_CREATE', 'BOOKMARKS_UPDATE', 'BOOKMARK_REMOVE'];
+
+export const configureBookmarksModule = async ({
+  db,
+}: ModuleInput<Record<string, never>>): Promise<BookmarksModule> => {
+  registerEvents(BOOKMARK_EVENTS);
+
+  const Bookmarks = await BookmarksCollection(db);
+
+  const mutations = generateDbMutations<Bookmark>(Bookmarks, BookmarkSchema, {
+    permanentlyDeleteByDefault: true,
+  }) as ModuleMutations<Bookmark>;
+
+  return {
+    // Queries
+    ...mutations,
+    findByUserId: async (userId) => Bookmarks.find({ userId }).toArray(),
+    findByUserIdAndProductId: async ({ userId, productId }) => Bookmarks.findOne({ userId, productId }),
+    findById: async (bookmarkId) => {
+      const filter = generateDbFilterById(bookmarkId);
+      return Bookmarks.findOne(filter, {});
+    },
+
+    find: async (query) => Bookmarks.find(query).toArray(),
+
+    existsByUserIdAndProductId: async ({ productId, userId }) => {
+      let selector = {};
+      if (productId && userId) {
+        selector = { userId, productId };
+      } else if (userId) {
+        selector = { userId };
+      }
+      const bookmarkCount = await Bookmarks.countDocuments(selector, {
+        limit: 1,
+      });
+
+      return !!bookmarkCount;
+    },
+
+    // Mutations
+    replaceUserId: async (fromUserId, toUserId, userId) => {
+      const result = await Bookmarks.updateMany(
+        { userId: fromUserId },
+        {
+          $set: {
+            userId: toUserId,
+            updated: new Date(),
+            updatedBy: userId,
+          },
+        },
+      );
+      return result.upsertedCount;
+    },
+
+    deleteByUserId: async (toUserId) => {
+      const result = await Bookmarks.deleteMany({ userId: toUserId });
+
+      return result.deletedCount;
+    },
+
+    create: async (doc: Bookmark, userId: string) => {
+      const bookmarkId = await mutations.create(doc, userId);
+      emit('BOOKMARK_CREATE', { bookmarkId });
+      return bookmarkId;
+    },
+    update: async (_id: string, doc: Bookmark, userId: string) => {
+      const bookmarkId = await mutations.update(_id, doc, userId);
+      emit('BOOKMARK_UPDATE', { bookmarkId });
+      return bookmarkId;
+    },
+    delete: async (bookmarkId, userId) => {
+      const deletedCount = await mutations.delete(bookmarkId, userId);
+      emit('BOOKMARK_REMOVE', { bookmarkId });
+      return deletedCount;
+    },
+  };
+};

package/src/service/bookmarkServices.ts

@@ -0,0 +1,6 @@
+import { BookmarkServices } from '@unchainedshop/types/bookmarks';
+import { migrateBookmarksService } from './migrateBookmarksService';
+
+export const bookmarkServices: BookmarkServices = {
+  migrateBookmarks: migrateBookmarksService,
+};

package/src/service/migrateBookmarksService.ts

@@ -0,0 +1,18 @@
+import { MigrateBookmarksService } from '@unchainedshop/types/bookmarks';
+
+export const migrateBookmarksService: MigrateBookmarksService = async (
+  { fromUser, toUser, shouldMerge },
+  { modules, userId },
+) => {
+  const fromBookmarks = await modules.bookmarks.find({ userId: fromUser._id });
+  if (!fromBookmarks) {
+    // No bookmarks no copy needed
+    return null;
+  }
+  if (!shouldMerge) {
+    await modules.bookmarks.deleteByUserId(toUser._id, userId);
+  }
+  await modules.bookmarks.replaceUserId(fromUser._id, toUser._id, userId);
+
+  return null;
+};

package/tests/bookmarks-index.test.ts

@@ -0,0 +1,70 @@
+import { assert } from 'chai';
+import { initDb } from 'meteor/unchained:mongodb';
+import { configureBookmarksModule } from 'meteor/unchained:core-bookmarks';
+
+describe('Test exports', () => {
+  let module;
+
+  before(async () => {
+    const db = await initDb();
+    module = await configureBookmarksModule({ db });
+  });
+
+  it('Check Bookmarks module', async () => {
+    assert.ok(module);
+    assert.isFunction(module.findByUserIdAndProductId);
+    assert.isFunction(module.existsByUserIdAndProductId);
+    assert.isFunction(module.create);
+    assert.isFunction(module.update);
+    assert.isFunction(module.delete);
+  });
+
+  it('Mutate bookmark', async () => {
+    const bookmarkId = await module.create(
+      {
+        userId: 'Test-User-1',
+        productId: 'Product-22',
+      },
+      'Test-User-1'
+    );
+
+    assert.ok(bookmarkId);
+    const bookmark = await module.findById(bookmarkId);
+
+    assert.ok(bookmark);
+    assert.equal(bookmark._id, bookmarkId);
+    assert.equal(bookmark.userId, 'Test-User-1');
+    assert.equal(bookmark.productId, 'Product-22');
+    assert.isDefined(bookmark.created);
+    assert.isUndefined(bookmark.updated);
+    assert.isUndefined(bookmark.updatedBy);
+    assert.equal(bookmark.createdBy, 'Test-User-1');
+
+    const deletedCount = await module.delete(bookmarkId);
+    assert.equal(deletedCount, 1);
+  });
+
+  it('Check backwards compatibility', async () => {
+    const Bookmarks = new Mongo.Collection<any>('bookmarks');
+
+    const meteorBookmarkId = Bookmarks.insertOne({
+      userId: 'Legacy-Test-User-1',
+      productId: 'Legacy-Product-22',
+      created: new Date(),
+    });
+
+    assert.ok(meteorBookmarkId);
+    const bookmark = await module.findById(meteorBookmarkId);
+    assert.ok(bookmark);
+    assert.equal(bookmark._id, meteorBookmarkId);
+    assert.equal(bookmark.userId, 'Legacy-Test-User-1');
+    assert.equal(bookmark.productId, 'Legacy-Product-22');
+    assert.isDefined(bookmark.created);
+    assert.isUndefined(bookmark.updated);
+    assert.isUndefined(bookmark.updatedBy);
+    assert.isUndefined(bookmark.createdBy);
+
+    const deletedCount = await module.delete(meteorBookmarkId);
+    assert.equal(deletedCount, 1);
+  });
+});

package/tsconfig.build.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["esnext"],
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noImplicitReturns": true,
+    "noUnusedLocals": false,
+    "outDir": "lib",
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "types": ["node"],
+    "baseUrl": ".", // This must be specified if "paths" is.
+    "paths": {
+      "meteor/unchained:*": ["node_modules/@unchainedshop/types/index.d.ts"]
+    }
+  },
+  "include": ["src"]
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.build.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["node", "mocha"]
+  },
+  "include": ["src", "tests"]
+}