feat(editor-tools): default tools added to user tools, global "underscore" options in models

migrations/tenant/0008-users@add-editor-tools-remove-extensions.sql

@@ -0,0 +1,22 @@
+
+-- Adds "editor_tools" column at "users" if not exists
+DO $$
+BEGIN
+  IF NOT EXISTS(SELECT *
+    FROM information_schema.columns
+    WHERE table_name='users' and column_name='editor_tools')
+  THEN
+    ALTER TABLE "public"."users" ADD COLUMN "editor_tools" jsonb;
+  END IF;
+END $$;
+
+-- Removes "extensions" column at "users" if exists
+DO $$
+BEGIN
+  IF EXISTS(SELECT *
+    FROM information_schema.columns
+    WHERE table_name='users' and column_name='extensions')
+  THEN
+    ALTER TABLE "public"."users" DROP COLUMN "extensions";
+  END IF;
+END $$;

migrations/tenant/0009-editor-tools@rename-camelcase-to-underscore.sql

@@ -0,0 +1,33 @@
+-- "editor_tools" table:
+
+-- Rename column "isDefault" to "is_default" if "isDefault" exists and "is_default" not exists
+DO $$
+BEGIN
+  IF EXISTS(SELECT *
+    FROM information_schema.columns
+    WHERE table_name='editor_tools' and column_name='isDefault')
+  THEN
+    IF NOT EXISTS(SELECT *
+      FROM information_schema.columns
+      WHERE table_name='editor_tools' and column_name='is_default')
+    THEN
+      ALTER TABLE "public"."editor_tools" RENAME COLUMN "isDefault" TO "is_default";
+    END IF;
+  END IF;
+END $$;
+
+-- Rename column "exportName" to "export_name" if "exportName" exists and "export_name" not exists
+DO $$
+BEGIN
+  IF EXISTS(SELECT *
+    FROM information_schema.columns
+    WHERE table_name='editor_tools' and column_name='exportName')
+  THEN
+    IF NOT EXISTS(SELECT *
+      FROM information_schema.columns
+      WHERE table_name='editor_tools' and column_name='export_name')
+    THEN
+      ALTER TABLE "public"."editor_tools" RENAME COLUMN "exportName" TO "export_name";
+    END IF;
+  END IF;
+END $$;

src/domain/entities/user.ts

@@ -1,4 +1,4 @@
-import type UserExtensions from '@domain/entities/userExtensions.js';
+import type EditorTool from './editorTools';
 
 /**
  * User entity
@@ -30,8 +30,7 @@ export default interface User {
   photo?: string;
 
   /**
-   * Custom plugins from the marketplace that improve
-   * editor or notes environment
+   * Custom plugins ids from the marketplace that improve editor or notes environment
    */
-  extensions?: UserExtensions;
+  editorTools?: EditorTool['id'][];
 }

src/domain/index.ts

@@ -63,10 +63,14 @@ export function init(repositories: Repositories, appConfig: AppConfig): DomainSe
     repositories.userSessionRepository
   );
 
-  const userService = new UserService(repositories.userRepository);
-
-  const aiService = new AIService(repositories.aiRepository);
   const editorToolsService = new EditorToolsService(repositories.editorToolsRepository);
+  const userService = new UserService(repositories.userRepository, {
+    editorTools: editorToolsService,
+    /**
+     * @todo find a way how to resolve circular dependency
+     */
+  });
+  const aiService = new AIService(repositories.aiRepository);
 
   return {
     noteService,

src/domain/service/editorTools.ts

@@ -1,11 +1,12 @@
 import type EditorToolsRepository from '@repository/editorTools.repository.js';
 import type EditorTool from '@domain/entities/editorTools.js';
 import { createEditorToolId } from '@infrastructure/utils/id.js';
+import type EditorToolsServiceSharedMethods from './shared/editorTools.js';
 
 /**
  * Editor tools service
  */
-export default class EditorToolsService {
+export default class EditorToolsService implements EditorToolsServiceSharedMethods {
   /**
    * User repository instance
    */
@@ -32,10 +33,17 @@ export default class EditorToolsService {
    *
    * @param editorToolIds - tool ids
    */
-  public async getToolsByIds(editorToolIds: EditorTool['id'][] ): Promise<EditorTool[] | null> {
+  public async getToolsByIds(editorToolIds: EditorTool['id'][]): Promise<EditorTool[]> {
     return await this.repository.getToolsByIds(editorToolIds);
   }
 
+  /**
+   * Return tools that are available at Editor by default
+   */
+  public async getDefaultTools(): Promise<EditorTool[]> {
+    return await this.repository.getDefaultTools();
+  }
+
   /**
    * Adding custom editor tool
    *

src/domain/service/shared/README.md

@@ -0,0 +1,30 @@
+# Shared Domain Services
+
+Sometimes you may want to call some domain method from other domain. We can inject them in constructor, but it creates a direct dependency.
+
+One way do decouple domains is to create a Shared Interfaces — domain will "expose" some public methods though it. You can call it "Contract".
+So dependant domain will depend on it instead of direct dependency.
+
+
+## Example
+
+```ts
+interface DomainASharedMethods {
+  someMethodA: () => void;
+}
+
+export type SharedDomainMethods = {
+  domainA: DomainASharedMethods;
+};
+
+
+class DomainA implements DomainASharedMethods {
+  public someMethodA (){}
+}
+
+class DomainB {
+  constructor(private readonly shared: SharedDomainMethods) {
+    this.shared.domainA.someMethodA(); // here we call method of Domain A, but without direct dependency
+  }
+}
+```

src/domain/service/shared/editorTools.ts

@@ -0,0 +1,19 @@
+import type EditorTool from '@domain/entities/editorTools';
+
+/**
+ * Which methods of Domain can be used by other domains
+ * Uses to decouple domains from each other
+ */
+export default interface  EditorToolsServiceSharedMethods {
+  /**
+   * Return tools that are available at Editor by default
+   */
+  getDefaultTools(): Promise<EditorTool[]>;
+
+  /**
+   * Get bunch of editor tools by their ids
+   *
+   * @param ids - tool ids to resolve
+   */
+  getToolsByIds(ids: EditorTool['id'][]): Promise<EditorTool[]>;
+}

src/domain/service/shared/index.ts

@@ -0,0 +1,5 @@
+import type EditorToolsServiceSharedMethods from './editorTools';
+
+export type SharedDomainMethods = {
+  editorTools: EditorToolsServiceSharedMethods;
+};

src/domain/service/user.ts

@@ -2,6 +2,7 @@ import type UserRepository from '@repository/user.repository.js';
 import { Provider } from '@repository/user.repository.js';
 import type User from '@domain/entities/user.js';
 import type EditorTool from '@domain/entities/editorTools';
+import type { SharedDomainMethods } from './shared/index.js';
 
 export {
   Provider
@@ -20,8 +21,9 @@ export default class UserService {
    * User service constructor
    *
    * @param repository - user repository instance
+   * @param shared - shared domains
    */
-  constructor(repository: UserRepository) {
+  constructor(repository: UserRepository, private readonly shared: SharedDomainMethods) {
     this.repository = repository;
   }
 
@@ -47,15 +49,28 @@ export default class UserService {
   }
 
   /**
-   * Get user extensions that contains only editoTools for now
-   * TODO: Simplify extenisons
+   * Get user editor tools ids
    *
    * @param userId - user unique identifier
    */
-  public async getUserExtensions(userId: User['id']): Promise<User['extensions']> {
+  public async getUserEditorTools(userId: User['id']): Promise<EditorTool[]> {
     const user = await this.getUserById(userId);
 
-    return user?.extensions ?? {};
+    if (user === null) {
+      throw new Error('User not found');
+    }
+
+    const userToolsIds = user.editorTools ?? [];
+    const defaultTools = await this.shared.editorTools.getDefaultTools();
+    const uniqueDefaultEditorTools = defaultTools.filter(({ id }) => !userToolsIds.includes(id));
+    const userTools = await this.shared.editorTools.getToolsByIds(userToolsIds) ?? [];
+
+    /**
+     * Combine user tools and default tools
+     *
+     * @todo load tools in notes service
+     */
+    return [...userTools, ...uniqueDefaultEditorTools];
   }
 
   /**
@@ -65,16 +80,14 @@ export default class UserService {
    */
   public async addUserEditorTool({
     userId,
-    editorToolId,
+    toolId,
   }: {
     userId: User['id'],
-    editorToolId: EditorTool['id'],
+    toolId: EditorTool['id'],
   }): Promise<void> {
     return await this.repository.addUserEditorTool({
       userId,
-      tool: {
-        id: editorToolId,
-      },
+      toolId,
     });
   }
 }

src/presentation/http/router/user.ts

@@ -30,7 +30,6 @@ const UserRouter: FastifyPluginCallback<UserRouterOptions> = (fastify, opts, don
    * Manage user data
    */
   const userService = opts.userService;
-  const editorToolsService = opts.editorToolsService;
 
   /**
    * Get user by session
@@ -63,7 +62,7 @@ const UserRouter: FastifyPluginCallback<UserRouterOptions> = (fastify, opts, don
   });
 
   /**
-   * Get user extensions
+   * Get user editor tools
    */
   fastify.get('/editor-tools', {
     config: {
@@ -93,12 +92,10 @@ const UserRouter: FastifyPluginCallback<UserRouterOptions> = (fastify, opts, don
   }, async (request, reply) => {
     const userId = request.userId as number;
 
-    const userExtensions = await userService.getUserExtensions(userId);
-    const userEditorToolIds = userExtensions?.editorTools?.map(tools => tools.id) ?? [];
-    const editorTools = await editorToolsService.getToolsByIds(userEditorToolIds) ?? [];
+    const tools = await userService.getUserEditorTools(userId);
 
     return reply.send({
-      data: editorTools,
+      data: tools,
     });
   });
 
@@ -124,16 +121,16 @@ const UserRouter: FastifyPluginCallback<UserRouterOptions> = (fastify, opts, don
       },
     },
   }, async (request, reply) => {
-    const editorToolId = request.body.toolId;
+    const toolId = request.body.toolId;
     const userId = request.userId as number;
 
     await userService.addUserEditorTool({
       userId,
-      editorToolId,
+      toolId,
     });
 
     return reply.send({
-      data: editorToolId,
+      data: toolId,
     });
   });
 

src/presentation/http/schema/User.ts

@@ -10,4 +10,11 @@ export const UserSchema = {
     name: { type: 'string' },
     photo: { type: 'string' },
   },
+  editorTools: {
+    type: 'array',
+    description: 'List of editor tools ids installed by user from Marketplace',
+    items: {
+      type: 'string',
+    },
+  },
 };

src/repository/editorTools.repository.ts

@@ -34,6 +34,13 @@ export default class EditorToolsRepository {
     return tools;
   }
 
+  /**
+   * Get all default tools
+   */
+  public async getDefaultTools(): Promise<EditorTool[]> {
+    return await this.storage.getDefaultTools();
+  }
+
   /**
    * Get all editor tools
    */

src/repository/note.repository.ts

@@ -1,6 +1,5 @@
 import type { Note, NoteCreationAttributes, NoteInternalId, NotePublicId } from '@domain/entities/note.js';
 import type NoteStorage from '@repository/storage/note.storage.js';
-import type { NoteList } from '@domain/entities/noteList.js';
 
 /**
  * Repository allows accessing data from business-logic (domain) level
@@ -85,7 +84,6 @@ export default class NoteRepository {
    * @param id - note creator id
    * @param offset - number of skipped notes
    * @param limit - number of notes to get
-   * @returns { Promise<NoteList> } note
    */
   public async getNoteListByCreatorId(id: number, offset: number, limit: number): Promise<Note[]> {
     return await this.storage.getNoteListByCreatorId(id, offset, limit);