Skip to content

Commit

Permalink
Deploying to gh-pages from @ a7273a1 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@bischofmax
bischofmax committed Nov 9, 2023
1 parent 938a5af commit 4c8539b
Show file tree
Hide file tree
Showing 98 changed files with 3,611 additions and 3,587 deletions.
74 changes: 49 additions & 25 deletions controllers/FilesStorageController.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ <h6><b>Methods</b></h6>
<span class="modifier"></span>
<span class="modifier"></span>
<span class="modifier"></span>
<span class="modifier"></span>
<span class="modifier">Async</span>
<a href="#downloadPreview" >downloadPreview</a>
</li>
Expand Down Expand Up @@ -279,8 +280,8 @@ <h3 id="methods">

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="295"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:295</a></div>
<div class="io-line">Defined in <a href="" data-line="305"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:305</a></div>
</td>
</tr>

Expand Down Expand Up @@ -386,8 +387,8 @@ <h3 id="methods">

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="312"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:312</a></div>
<div class="io-line">Defined in <a href="" data-line="322"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:322</a></div>
</td>
</tr>

Expand Down Expand Up @@ -493,8 +494,8 @@ <h3 id="methods">

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="229"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:229</a></div>
<div class="io-line">Defined in <a href="" data-line="239"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:239</a></div>
</td>
</tr>

Expand Down Expand Up @@ -588,8 +589,8 @@ <h3 id="methods">

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="246"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:246</a></div>
<div class="io-line">Defined in <a href="" data-line="256"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:256</a></div>
</td>
</tr>

Expand Down Expand Up @@ -798,6 +799,7 @@ <h3 id="methods">
<span class="modifier"></span>
<span class="modifier"></span>
<span class="modifier"></span>
<span class="modifier"></span>
<span class="modifier">Async</span>
<span ><b>downloadPreview</b></span>
<a href="#downloadPreview"><span class="icon ion-ios-link"></span></a>
Expand All @@ -807,22 +809,22 @@ <h3 id="methods">
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>downloadPreview(params: <a href="../classes/DownloadFileParams.html" target="_self">DownloadFileParams</a>, currentUser: <a href="../interfaces/ICurrentUser.html" target="_self">ICurrentUser</a>, previewParams: <a href="../classes/PreviewParams.html" target="_self">PreviewParams</a>, req: Request, response: Response, bytesRange?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
<code>downloadPreview(params: <a href="../classes/DownloadFileParams.html" target="_self">DownloadFileParams</a>, currentUser: <a href="../interfaces/ICurrentUser.html" target="_self">ICurrentUser</a>, previewParams: <a href="../classes/PreviewParams.html" target="_self">PreviewParams</a>, req: Request, response: Response, bytesRange?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, etag?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
</td>
</tr>

<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>@ApiOperation({summary: &#x27;Streamable download of a preview file.&#x27;})<br />@ApiResponse({status: 200, type: StreamableFile})<br />@ApiResponse({status: 206, type: StreamableFile})<br />@ApiResponse({status: 400, type: ApiValidationError})<br />@ApiResponse({status: 403, type: ForbiddenException})<br />@ApiResponse({status: 404, type: NotFoundException})<br />@ApiResponse({status: 422, type: UnprocessableEntityException})<br />@ApiResponse({status: 500, type: InternalServerErrorException})<br />@ApiHeader({name: &#x27;Range&#x27;, required: false})<br />@Get(&#x27;/preview/:fileRecordId/:fileName&#x27;)<br />@RequestTimeout(undefined.INCOMING_REQUEST_TIMEOUT)<br /></code>
<code>@ApiOperation({summary: &#x27;Streamable download of a preview file.&#x27;})<br />@ApiResponse({status: 200, type: StreamableFile})<br />@ApiResponse({status: 206, type: StreamableFile})<br />@ApiResponse({status: 304, description: &#x27;Not Modified&#x27;})<br />@ApiResponse({status: 400, type: ApiValidationError})<br />@ApiResponse({status: 403, type: ForbiddenException})<br />@ApiResponse({status: 404, type: NotFoundException})<br />@ApiResponse({status: 422, type: UnprocessableEntityException})<br />@ApiResponse({status: 500, type: InternalServerErrorException})<br />@ApiHeader({name: &#x27;Range&#x27;, required: false})<br />@Get(&#x27;/preview/:fileRecordId/:fileName&#x27;)<br />@RequestTimeout(undefined.INCOMING_REQUEST_TIMEOUT)<br /></code>
</td>
</tr>

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="131"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:131</a></div>
<div class="io-line">Defined in <a href="" data-line="132"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:132</a></div>
</td>
</tr>

Expand Down Expand Up @@ -913,12 +915,24 @@ <h3 id="methods">
</td>


</tr>
<tr>
<td>etag</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>

<td>
Yes
</td>


</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="../interfaces/File.html" target="_self" >Promise&lt;StreamableFile&gt;</a></code>
<b>Returns : </b> <code><a href="../interfaces/File.html" target="_self" >Promise&lt;StreamableFile | void&gt;</a></code>

</div>
<div class="io-description">
Expand Down Expand Up @@ -962,8 +976,8 @@ <h3 id="methods">

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="183"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:183</a></div>
<div class="io-line">Defined in <a href="" data-line="193"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:193</a></div>
</td>
</tr>

Expand Down Expand Up @@ -1070,8 +1084,8 @@ <h3 id="methods">

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="207"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:207</a></div>
<div class="io-line">Defined in <a href="" data-line="217"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:217</a></div>
</td>
</tr>

Expand Down Expand Up @@ -1175,8 +1189,8 @@ <h3 id="methods">

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="262"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:262</a></div>
<div class="io-line">Defined in <a href="" data-line="272"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:272</a></div>
</td>
</tr>

Expand Down Expand Up @@ -1268,8 +1282,8 @@ <h3 id="methods">

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="278"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:278</a></div>
<div class="io-line">Defined in <a href="" data-line="288"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:288</a></div>
</td>
</tr>

Expand Down Expand Up @@ -1349,8 +1363,8 @@ <h3 id="methods">

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="151"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:151</a></div>
<div class="io-line">Defined in <a href="" data-line="161"
class="link-to-prism">apps/server/src/modules/files-storage/controller/files-storage.controller.ts:161</a></div>
</td>
</tr>

Expand Down Expand Up @@ -1785,6 +1799,7 @@ <h3 id="methods">
@ApiOperation({ summary: &#x27;Streamable download of a preview file.&#x27; })
@ApiResponse({ status: 200, type: StreamableFile })
@ApiResponse({ status: 206, type: StreamableFile })
@ApiResponse({ status: 304, description: &#x27;Not Modified&#x27; })
@ApiResponse({ status: 400, type: ApiValidationError })
@ApiResponse({ status: 403, type: ForbiddenException })
@ApiResponse({ status: 404, type: NotFoundException })
Expand All @@ -1799,15 +1814,24 @@ <h3 id="methods">
@Query() previewParams: PreviewParams,
@Req() req: Request,
@Res({ passthrough: true }) response: Response,
@Headers(&#x27;Range&#x27;) bytesRange?: string
): Promise&lt;StreamableFile&gt; {
@Headers(&#x27;Range&#x27;) bytesRange?: string,
@Headers(&#x27;If-None-Match&#x27;) etag?: string
): Promise&lt;StreamableFile | void&gt; {
const fileResponse &#x3D; await this.filesStorageUC.downloadPreview(
currentUser.userId,
params,
previewParams,
bytesRange
);

response.set({ ETag: fileResponse.etag });

if (etag &#x3D;&#x3D;&#x3D; fileResponse.etag) {
response.status(HttpStatus.NOT_MODIFIED);

return undefined;
}

const streamableFile &#x3D; this.streamFileToClient(req, fileResponse, response, bytesRange);

return streamableFile;
Expand Down
4 changes: 2 additions & 2 deletions js/search/search_index.js
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 4c8539b

Please sign in to comment.