Deploying to gh-pages from @ 43d02f8 🚀

hpi-schul-cloud · Oct 12, 2023 · 8cd8dd1 · 8cd8dd1
1 parent 0c4994e
commit 8cd8dd1
Show file tree

Hide file tree

Showing 117 changed files with 3,737 additions and 3,109 deletions.
diff --git a/classes/CopyFileParams.html b/classes/CopyFileParams.html
@@ -147,7 +147,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="94" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:94</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="95" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:95</a></div>
                         </td>
                     </tr>
 
@@ -184,7 +184,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="90" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:90</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="91" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:91</a></div>
                         </td>
                     </tr>
 
@@ -206,6 +206,7 @@ <h3 id="inputs">
         <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { ApiProperty, ApiPropertyOptional } from &#x27;@nestjs/swagger&#x27;;
 import { StringToBoolean } from &#x27;@shared/controller&#x27;;
 import { EntityId } from &#x27;@shared/domain&#x27;;
+import { ScanResult } from &#x27;@shared/infra/antivirus&#x27;;
 import { Allow, IsBoolean, IsEnum, IsMongoId, IsNotEmpty, IsOptional, IsString, ValidateNested } from &#x27;class-validator&#x27;;
 import { FileRecordParentType } from &#x27;../../entity&#x27;;
 import { PreviewOutputMimeTypes, PreviewWidth } from &#x27;../../interface&#x27;;
@@ -256,7 +257,7 @@ <h3 id="inputs">
 	fileName!: string;
 }
 
-export class ScanResultParams {
+export class ScanResultParams implements ScanResult {
 	@ApiProperty()
 	@Allow()
 	virus_detected?: boolean;

diff --git a/classes/CopyFilesOfParentParams.html b/classes/CopyFilesOfParentParams.html
@@ -142,7 +142,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="84" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:84</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="85" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:85</a></div>
                         </td>
                     </tr>
 
@@ -164,6 +164,7 @@ <h3 id="inputs">
         <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { ApiProperty, ApiPropertyOptional } from &#x27;@nestjs/swagger&#x27;;
 import { StringToBoolean } from &#x27;@shared/controller&#x27;;
 import { EntityId } from &#x27;@shared/domain&#x27;;
+import { ScanResult } from &#x27;@shared/infra/antivirus&#x27;;
 import { Allow, IsBoolean, IsEnum, IsMongoId, IsNotEmpty, IsOptional, IsString, ValidateNested } from &#x27;class-validator&#x27;;
 import { FileRecordParentType } from &#x27;../../entity&#x27;;
 import { PreviewOutputMimeTypes, PreviewWidth } from &#x27;../../interface&#x27;;
@@ -214,7 +215,7 @@ <h3 id="inputs">
 	fileName!: string;
 }
 
-export class ScanResultParams {
+export class ScanResultParams implements ScanResult {
 	@ApiProperty()
 	@Allow()
 	virus_detected?: boolean;

diff --git a/classes/CopyFilesOfParentPayload.html b/classes/CopyFilesOfParentPayload.html
@@ -148,7 +148,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="102" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:102</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="103" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:103</a></div>
                         </td>
                     </tr>
 
@@ -184,7 +184,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="105" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:105</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="106" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:106</a></div>
                         </td>
                     </tr>
 
@@ -220,7 +220,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="99" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:99</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="100" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:100</a></div>
                         </td>
                     </tr>
 
@@ -242,6 +242,7 @@ <h3 id="inputs">
         <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { ApiProperty, ApiPropertyOptional } from &#x27;@nestjs/swagger&#x27;;
 import { StringToBoolean } from &#x27;@shared/controller&#x27;;
 import { EntityId } from &#x27;@shared/domain&#x27;;
+import { ScanResult } from &#x27;@shared/infra/antivirus&#x27;;
 import { Allow, IsBoolean, IsEnum, IsMongoId, IsNotEmpty, IsOptional, IsString, ValidateNested } from &#x27;class-validator&#x27;;
 import { FileRecordParentType } from &#x27;../../entity&#x27;;
 import { PreviewOutputMimeTypes, PreviewWidth } from &#x27;../../interface&#x27;;
@@ -292,7 +293,7 @@ <h3 id="inputs">
 	fileName!: string;
 }
 
-export class ScanResultParams {
+export class ScanResultParams implements ScanResult {
 	@ApiProperty()
 	@Allow()
 	virus_detected?: boolean;

diff --git a/classes/DownloadFileParams.html b/classes/DownloadFileParams.html
@@ -147,7 +147,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="51" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:51</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="52" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:52</a></div>
                         </td>
                     </tr>
 
@@ -184,7 +184,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="47" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:47</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="48" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:48</a></div>
                         </td>
                     </tr>
 
@@ -206,6 +206,7 @@ <h3 id="inputs">
         <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { ApiProperty, ApiPropertyOptional } from &#x27;@nestjs/swagger&#x27;;
 import { StringToBoolean } from &#x27;@shared/controller&#x27;;
 import { EntityId } from &#x27;@shared/domain&#x27;;
+import { ScanResult } from &#x27;@shared/infra/antivirus&#x27;;
 import { Allow, IsBoolean, IsEnum, IsMongoId, IsNotEmpty, IsOptional, IsString, ValidateNested } from &#x27;class-validator&#x27;;
 import { FileRecordParentType } from &#x27;../../entity&#x27;;
 import { PreviewOutputMimeTypes, PreviewWidth } from &#x27;../../interface&#x27;;
@@ -256,7 +257,7 @@ <h3 id="inputs">
 	fileName!: string;
 }
 
-export class ScanResultParams {
+export class ScanResultParams implements ScanResult {
 	@ApiProperty()
 	@Allow()
 	virus_detected?: boolean;

diff --git a/classes/FileParams.html b/classes/FileParams.html
@@ -142,7 +142,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="41" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:41</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="42" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:42</a></div>
                         </td>
                     </tr>
 
@@ -164,6 +164,7 @@ <h3 id="inputs">
         <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { ApiProperty, ApiPropertyOptional } from &#x27;@nestjs/swagger&#x27;;
 import { StringToBoolean } from &#x27;@shared/controller&#x27;;
 import { EntityId } from &#x27;@shared/domain&#x27;;
+import { ScanResult } from &#x27;@shared/infra/antivirus&#x27;;
 import { Allow, IsBoolean, IsEnum, IsMongoId, IsNotEmpty, IsOptional, IsString, ValidateNested } from &#x27;class-validator&#x27;;
 import { FileRecordParentType } from &#x27;../../entity&#x27;;
 import { PreviewOutputMimeTypes, PreviewWidth } from &#x27;../../interface&#x27;;
@@ -214,7 +215,7 @@ <h3 id="inputs">
 	fileName!: string;
 }
 
-export class ScanResultParams {
+export class ScanResultParams implements ScanResult {
 	@ApiProperty()
 	@Allow()
 	virus_detected?: boolean;

diff --git a/classes/FileRecordParams.html b/classes/FileRecordParams.html
@@ -152,7 +152,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:15</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="16" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:16</a></div>
                         </td>
                     </tr>
 
@@ -189,7 +189,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="19" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:19</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="20" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:20</a></div>
                         </td>
                     </tr>
 
@@ -226,7 +226,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="11" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:11</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="12" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:12</a></div>
                         </td>
                     </tr>
 
@@ -248,6 +248,7 @@ <h3 id="inputs">
         <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { ApiProperty, ApiPropertyOptional } from &#x27;@nestjs/swagger&#x27;;
 import { StringToBoolean } from &#x27;@shared/controller&#x27;;
 import { EntityId } from &#x27;@shared/domain&#x27;;
+import { ScanResult } from &#x27;@shared/infra/antivirus&#x27;;
 import { Allow, IsBoolean, IsEnum, IsMongoId, IsNotEmpty, IsOptional, IsString, ValidateNested } from &#x27;class-validator&#x27;;
 import { FileRecordParentType } from &#x27;../../entity&#x27;;
 import { PreviewOutputMimeTypes, PreviewWidth } from &#x27;../../interface&#x27;;
@@ -298,7 +299,7 @@ <h3 id="inputs">
 	fileName!: string;
 }
 
-export class ScanResultParams {
+export class ScanResultParams implements ScanResult {
 	@ApiProperty()
 	@Allow()
 	virus_detected?: boolean;

diff --git a/classes/FileRecordSecurityCheck.html b/classes/FileRecordSecurityCheck.html
@@ -638,6 +638,12 @@ <h3 id="inputs">
 		return isVerified;
 	}
 
+	public isPreviewPossible(): boolean {
+		const isPreviewPossible &#x3D; Object.values&lt;string&gt;(PreviewInputMimeTypes).includes(this.mimeType);
+
+		return isPreviewPossible;
+	}
+
 	public getParentInfo(): IParentInfo {
 		const { parentId, parentType, schoolId } &#x3D; this;
 
@@ -653,7 +659,7 @@ <h3 id="inputs">
 			return PreviewStatus.PREVIEW_NOT_POSSIBLE_SCAN_STATUS_BLOCKED;
 		}
 
-		if (!Object.values&lt;string&gt;(PreviewInputMimeTypes).includes(this.mimeType)) {
+		if (!this.isPreviewPossible()) {
 			return PreviewStatus.PREVIEW_NOT_POSSIBLE_WRONG_MIME_TYPE;
 		}
 

diff --git a/classes/FileUrlParams.html b/classes/FileUrlParams.html
@@ -156,7 +156,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="31" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:31</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="32" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:32</a></div>
                         </td>
                     </tr>
 
@@ -194,7 +194,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="35" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:35</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="36" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:36</a></div>
                         </td>
                     </tr>
 
@@ -232,7 +232,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="26" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:26</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="27" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:27</a></div>
                         </td>
                     </tr>
 
@@ -254,6 +254,7 @@ <h3 id="inputs">
         <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { ApiProperty, ApiPropertyOptional } from &#x27;@nestjs/swagger&#x27;;
 import { StringToBoolean } from &#x27;@shared/controller&#x27;;
 import { EntityId } from &#x27;@shared/domain&#x27;;
+import { ScanResult } from &#x27;@shared/infra/antivirus&#x27;;
 import { Allow, IsBoolean, IsEnum, IsMongoId, IsNotEmpty, IsOptional, IsString, ValidateNested } from &#x27;class-validator&#x27;;
 import { FileRecordParentType } from &#x27;../../entity&#x27;;
 import { PreviewOutputMimeTypes, PreviewWidth } from &#x27;../../interface&#x27;;
@@ -304,7 +305,7 @@ <h3 id="inputs">
 	fileName!: string;
 }
 
-export class ScanResultParams {
+export class ScanResultParams implements ScanResult {
 	@ApiProperty()
 	@Allow()
 	virus_detected?: boolean;

diff --git a/classes/PreviewParams.html b/classes/PreviewParams.html
@@ -162,7 +162,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="125" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:125</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="126" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:126</a></div>
                         </td>
                     </tr>
 
@@ -201,7 +201,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="112" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:112</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="113" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:113</a></div>
                         </td>
                     </tr>
 
@@ -240,7 +240,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="117" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:117</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="118" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:118</a></div>
                         </td>
                     </tr>
 
@@ -262,6 +262,7 @@ <h3 id="inputs">
         <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { ApiProperty, ApiPropertyOptional } from &#x27;@nestjs/swagger&#x27;;
 import { StringToBoolean } from &#x27;@shared/controller&#x27;;
 import { EntityId } from &#x27;@shared/domain&#x27;;
+import { ScanResult } from &#x27;@shared/infra/antivirus&#x27;;
 import { Allow, IsBoolean, IsEnum, IsMongoId, IsNotEmpty, IsOptional, IsString, ValidateNested } from &#x27;class-validator&#x27;;
 import { FileRecordParentType } from &#x27;../../entity&#x27;;
 import { PreviewOutputMimeTypes, PreviewWidth } from &#x27;../../interface&#x27;;
@@ -312,7 +313,7 @@ <h3 id="inputs">
 	fileName!: string;
 }
 
-export class ScanResultParams {
+export class ScanResultParams implements ScanResult {
 	@ApiProperty()
 	@Allow()
 	virus_detected?: boolean;

diff --git a/classes/RenameFileParams.html b/classes/RenameFileParams.html
@@ -144,7 +144,7 @@ <h3 id="inputs">
                 </tr>
                     <tr>
                         <td class="col-md-4">
-                                <div class="io-line">Defined in <a href="" data-line="78" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:78</a></div>
+                                <div class="io-line">Defined in <a href="" data-line="79" class="link-to-prism">apps/server/src/modules/files-storage/controller/dto/file-storage.params.ts:79</a></div>
                         </td>
                     </tr>
 
@@ -166,6 +166,7 @@ <h3 id="inputs">
         <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { ApiProperty, ApiPropertyOptional } from &#x27;@nestjs/swagger&#x27;;
 import { StringToBoolean } from &#x27;@shared/controller&#x27;;
 import { EntityId } from &#x27;@shared/domain&#x27;;
+import { ScanResult } from &#x27;@shared/infra/antivirus&#x27;;
 import { Allow, IsBoolean, IsEnum, IsMongoId, IsNotEmpty, IsOptional, IsString, ValidateNested } from &#x27;class-validator&#x27;;
 import { FileRecordParentType } from &#x27;../../entity&#x27;;
 import { PreviewOutputMimeTypes, PreviewWidth } from &#x27;../../interface&#x27;;
@@ -216,7 +217,7 @@ <h3 id="inputs">
 	fileName!: string;
 }
 
-export class ScanResultParams {
+export class ScanResultParams implements ScanResult {
 	@ApiProperty()
 	@Allow()
 	virus_detected?: boolean;