Merge pull request #23 from Excali-Studio/EXD-88-simple-search

[EXD-88] Added "description" field to Canvas & simple search by part …

src/canvas/canvas.controller.ts

@@ -72,6 +72,7 @@ export class CanvasController {
     return {
       id: canvas.id,
       name: canvas.name,
+      description: canvas.description,
       tags: canvas.tags,
       dateCreated: canvas.dateCreated,
       dateUpdated: canvas.dateUpdated,
@@ -115,6 +116,7 @@ export class CanvasController {
     return {
       id: canvas.id,
       name: canvas.name,
+      description: canvas.description,
       tags: canvas.tags,
       dateCreated: canvas.dateCreated,
       dateUpdated: canvas.dateUpdated,
@@ -168,6 +170,7 @@ export class CanvasController {
     return {
       id: canvas.id,
       name: canvas.name,
+      description: canvas.description,
       tags: canvas.tags,
       dateCreated: canvas.dateCreated,
       dateUpdated: canvas.dateUpdated,

src/canvas/canvas.interface.ts

@@ -17,6 +17,7 @@ import { Transform } from 'class-transformer';
 
 export interface CanvasCreateCommand {
   name: string;
+  description?: string;
   userId: Uuid;
 }
 
@@ -30,6 +31,7 @@ export interface CanvasContentUpdateCommand {
 export interface CanvasMetadataUpdateCommand {
   id: Uuid;
   name: string;
+  description?: string;
 }
 
 export interface GiveAccessCommand {
@@ -68,12 +70,18 @@ export class CanvasMetadataUpdateDTO {
   @MinLength(3)
   @MaxLength(255)
   name: string;
+  @IsOptional()
+  @MaxLength(4000)
+  description?: string;
 }
 
 export class CanvasCreateDTO {
   @MinLength(3)
   @MaxLength(255)
   name: string;
+  @IsOptional()
+  @MaxLength(4000)
+  description?: string;
 }
 
 export class CanvasContentUpdateDTO {
@@ -88,6 +96,7 @@ export interface CanvasDTO {
   dateCreated: Date;
   dateUpdated: Date;
   name: string;
+  description: string;
   tags: CanvasTagDTO[];
 }
 
@@ -129,7 +138,7 @@ export class CanvasFilter extends ListFilter {
   @Transform(({ value }) => (Array.isArray(value) ? value : Array(value)))
   tagIds?: Uuid[] = [];
   @ApiProperty({ required: false })
-  searchName?: string;
+  searchQuery?: string;
 }
 
 export class CanvasStateFilter {

src/canvas/canvas.service.ts

@@ -1,5 +1,5 @@
 import { Injectable, NotFoundException } from '@nestjs/common';
-import { Repository } from 'typeorm';
+import { Brackets, Repository } from 'typeorm';
 import { CanvasEntity } from './entity/canvas.entity';
 import { InjectRepository } from '@nestjs/typeorm';
 import {
@@ -50,6 +50,7 @@ export class CanvasService {
     });
     const canvas = new CanvasEntity();
     canvas.name = command.name.trim();
+    canvas.description = command.description?.trim();
     await this.canvasRepository.save(canvas);
     const canvasAccess = new CanvasAccessEntity();
     canvasAccess.isOwner = true;
@@ -95,6 +96,7 @@ export class CanvasService {
     }
 
     canvas.name = command.name.trim();
+    canvas.description = command.description?.trim();
     canvas.dateUpdated = new Date();
     await this.canvasRepository.save(canvas);
 
@@ -132,10 +134,16 @@ export class CanvasService {
         .setParameter(`tagId${index}`, tagId);
     });
 
-    if (canvasFilter.searchName) {
-      queryBuilder.andWhere('LOWER(canvas.name) like :searchName', {
-        searchName: `%${canvasFilter.searchName.toLowerCase()}%`,
-      });
+    if (canvasFilter.searchQuery) {
+      queryBuilder.andWhere(
+        new Brackets((qb) => {
+          qb.where('LOWER(canvas.name) like :searchQuery', {
+            searchQuery: `%${canvasFilter.searchQuery.toLowerCase()}%`,
+          }).orWhere('LOWER(canvas.description) like :searchQuery', {
+            searchQuery: `%${canvasFilter.searchQuery.toLowerCase()}%`,
+          });
+        }),
+      );
     }
 
     return PageableUtils.producePagedResult(

src/canvas/entity/canvas.entity.ts

@@ -17,6 +17,12 @@ export class CanvasEntity {
   @Column({ nullable: false })
   name: string;
 
+  @Column({
+    type: 'text',
+    nullable: true,
+  })
+  description: string;
+
   @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
   dateCreated: Date;