Skip to content

Commit

Permalink
Deploying to gh-pages from @ ffc78d5 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@uidp
uidp committed Dec 4, 2023
1 parent 83940c8 commit cc4d807
Show file tree
Hide file tree
Showing 130 changed files with 3,583 additions and 6,635 deletions.
6 changes: 4 additions & 2 deletions classes/BaseEntity.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ <h3 id="inputs">


<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { PrimaryKey, Property, SerializedPrimaryKey } from &#x27;@mikro-orm/core&#x27;;
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { OptionalProps, PrimaryKey, Property, SerializedPrimaryKey } from &#x27;@mikro-orm/core&#x27;;
import { ObjectId } from &#x27;@mikro-orm/mongodb&#x27;;
import type { AuthorizableObject } from &#x27;../domain-object&#x27;;
import type { IEntity } from &#x27;../interface&#x27;;
Expand All @@ -286,7 +286,9 @@ <h3 id="inputs">
// that can be cumbersome e.g. in tests. that&#x27;s why we define it as a root class here.
// TODO check if we can use EntitySchema to prevent code duplication (decorators don&#x27;t work for defining properties btw.)

export abstract class BaseEntityWithTimestamps implements AuthorizableObject {
export abstract class BaseEntityWithTimestamps&lt;Optional &#x3D; never&gt; implements AuthorizableObject {
[OptionalProps]?: Optional | &#x27;createdAt&#x27; | &#x27;updatedAt&#x27;;

@PrimaryKey()
_id!: ObjectId;

Expand Down
45 changes: 39 additions & 6 deletions classes/BaseEntityWithTimestamps.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ <h6><b>Properties</b></h6>
<span class="modifier"></span>
<a href="#id" >id</a>
</li>
<li>
<span class="modifier">Optional</span>
<a href="#OptionalProps" >OptionalProps</a>
</li>
<li>
<span class="modifier"></span>
<a href="#updatedAt" >updatedAt</a>
Expand Down Expand Up @@ -216,7 +220,7 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="25" class="link-to-prism">apps/server/src/shared/domain/entity/base.entity.ts:25</a></div>
<div class="io-line">Defined in <a href="" data-line="27" class="link-to-prism">apps/server/src/shared/domain/entity/base.entity.ts:27</a></div>
</td>
</tr>

Expand Down Expand Up @@ -251,7 +255,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/shared/domain/entity/base.entity.ts:31</a></div>
<div class="io-line">Defined in <a href="" data-line="33" class="link-to-prism">apps/server/src/shared/domain/entity/base.entity.ts:33</a></div>
</td>
</tr>

Expand Down Expand Up @@ -287,7 +291,34 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="28" class="link-to-prism">apps/server/src/shared/domain/entity/base.entity.ts:28</a></div>
<div class="io-line">Defined in <a href="" data-line="30" class="link-to-prism">apps/server/src/shared/domain/entity/base.entity.ts:30</a></div>
</td>
</tr>


</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="OptionalProps"></a>
<span class="name">
<span class="modifier">Optional</span>
<span ><b>OptionalProps</b></span>
<a href="#OptionalProps"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Optional | &quot;createdAt&quot; | &quot;updatedAt&quot;</code>

</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="24" class="link-to-prism">apps/server/src/shared/domain/entity/base.entity.ts:24</a></div>
</td>
</tr>

Expand Down Expand Up @@ -322,7 +353,7 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="34" class="link-to-prism">apps/server/src/shared/domain/entity/base.entity.ts:34</a></div>
<div class="io-line">Defined in <a href="" data-line="36" class="link-to-prism">apps/server/src/shared/domain/entity/base.entity.ts:36</a></div>
</td>
</tr>

Expand All @@ -341,7 +372,7 @@ <h3 id="inputs">


<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { PrimaryKey, Property, SerializedPrimaryKey } from &#x27;@mikro-orm/core&#x27;;
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { OptionalProps, PrimaryKey, Property, SerializedPrimaryKey } from &#x27;@mikro-orm/core&#x27;;
import { ObjectId } from &#x27;@mikro-orm/mongodb&#x27;;
import type { AuthorizableObject } from &#x27;../domain-object&#x27;;
import type { IEntity } from &#x27;../interface&#x27;;
Expand All @@ -363,7 +394,9 @@ <h3 id="inputs">
// that can be cumbersome e.g. in tests. that&#x27;s why we define it as a root class here.
// TODO check if we can use EntitySchema to prevent code duplication (decorators don&#x27;t work for defining properties btw.)

export abstract class BaseEntityWithTimestamps implements AuthorizableObject {
export abstract class BaseEntityWithTimestamps&lt;Optional &#x3D; never&gt; implements AuthorizableObject {
[OptionalProps]?: Optional | &#x27;createdAt&#x27; | &#x27;updatedAt&#x27;;

@PrimaryKey()
_id!: ObjectId;

Expand Down
122 changes: 104 additions & 18 deletions classes/ExternalTool.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,10 @@ <h6><b>Methods</b></h6>
<li>
<a href="#getVersion" >getVersion</a>
</li>
<li>
<span class="modifier">Static</span>
<a href="#isBasicConfig" >isBasicConfig</a>
</li>
<li>
<span class="modifier">Static</span>
<a href="#isLti11Config" >isLti11Config</a>
Expand Down Expand Up @@ -243,7 +247,7 @@ <h3 id="constructor">Constructor</h3>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="50" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:50</a></div>
<div class="io-line">Defined in <a href="" data-line="51" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:51</a></div>
</td>
</tr>

Expand Down Expand Up @@ -305,7 +309,7 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="40" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:40</a></div>
<div class="io-line">Defined in <a href="" data-line="41" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:41</a></div>
</td>
</tr>

Expand All @@ -331,7 +335,7 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="44" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:44</a></div>
<div class="io-line">Defined in <a href="" data-line="45" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:45</a></div>
</td>
</tr>

Expand All @@ -358,7 +362,7 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="38" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:38</a></div>
<div class="io-line">Defined in <a href="" data-line="39" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:39</a></div>
</td>
</tr>

Expand All @@ -385,7 +389,7 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="36" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:36</a></div>
<div class="io-line">Defined in <a href="" data-line="37" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:37</a></div>
</td>
</tr>

Expand All @@ -411,7 +415,7 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="32" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:32</a></div>
<div class="io-line">Defined in <a href="" data-line="33" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:33</a></div>
</td>
</tr>

Expand All @@ -437,7 +441,7 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="46" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:46</a></div>
<div class="io-line">Defined in <a href="" data-line="47" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:47</a></div>
</td>
</tr>

Expand All @@ -464,7 +468,7 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="42" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:42</a></div>
<div class="io-line">Defined in <a href="" data-line="43" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:43</a></div>
</td>
</tr>

Expand All @@ -491,7 +495,7 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="50" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:50</a></div>
<div class="io-line">Defined in <a href="" data-line="51" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:51</a></div>
</td>
</tr>

Expand All @@ -518,7 +522,7 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="34" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:34</a></div>
<div class="io-line">Defined in <a href="" data-line="35" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:35</a></div>
</td>
</tr>

Expand All @@ -544,7 +548,7 @@ <h3 id="inputs">
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="48" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:48</a></div>
<div class="io-line">Defined in <a href="" data-line="49" class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:49</a></div>
</td>
</tr>

Expand Down Expand Up @@ -612,8 +616,8 @@ <h3 id="methods">

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="67"
class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:67</a></div>
<div class="io-line">Defined in <a href="" data-line="76"
class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:76</a></div>
</td>
</tr>

Expand All @@ -629,6 +633,75 @@ <h3 id="methods">
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="isBasicConfig"></a>
<span class="name">
<span class="modifier">Static</span>
<span ><b>isBasicConfig</b></span>
<a href="#isBasicConfig"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>isBasicConfig(config: <a href="../classes/ExternalToolConfig.html" target="_self">ExternalToolConfig</a>)</code>
</td>
</tr>


<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="80"
class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:80</a></div>
</td>
</tr>


<tr>
<td class="col-md-4">

<div class="io-description">
<b>Parameters :</b>

<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>config</td>
<td>
<code><a href="../classes/ExternalToolConfig.html" target="_self" >ExternalToolConfig</a></code>
</td>

<td>
No
</td>


</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="../classes/BasicToolConfig.html" target="_self" >BasicToolConfig</a></code>

</div>
<div class="io-description">

</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
Expand All @@ -651,8 +724,8 @@ <h3 id="methods">

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="75"
class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:75</a></div>
<div class="io-line">Defined in <a href="" data-line="88"
class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:88</a></div>
</td>
</tr>

Expand Down Expand Up @@ -720,8 +793,8 @@ <h3 id="methods">

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="71"
class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:71</a></div>
<div class="io-line">Defined in <a href="" data-line="84"
class="link-to-prism">apps/server/src/modules/tool/external-tool/domain/external-tool.do.ts:84</a></div>
</td>
</tr>

Expand Down Expand Up @@ -778,6 +851,7 @@ <h3 id="methods">

<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { BaseDO } from &#x27;@shared/domain/domainobject/base.do&#x27;;
import { InternalServerErrorException } from &#x27;@nestjs/common&#x27;;
import { ToolVersion } from &#x27;../../common/interface&#x27;;
import { Oauth2ToolConfig, BasicToolConfig, Lti11ToolConfig, ExternalToolConfig } from &#x27;./config&#x27;;
import { CustomParameter } from &#x27;../../common/domain&#x27;;
Expand Down Expand Up @@ -835,7 +909,15 @@ <h3 id="methods">
this.url &#x3D; props.url;
this.logoUrl &#x3D; props.logoUrl;
this.logo &#x3D; props.logo;
this.config &#x3D; props.config;
if (ExternalTool.isBasicConfig(props.config)) {
this.config &#x3D; new BasicToolConfig(props.config);
} else if (ExternalTool.isOauth2Config(props.config)) {
this.config &#x3D; new Oauth2ToolConfig(props.config);
} else if (ExternalTool.isLti11Config(props.config)) {
this.config &#x3D; new Lti11ToolConfig(props.config);
} else {
throw new InternalServerErrorException(&#x60;Unknown tool config&#x60;);
}
this.parameters &#x3D; props.parameters;
this.isHidden &#x3D; props.isHidden;
this.openNewTab &#x3D; props.openNewTab;
Expand All @@ -847,6 +929,10 @@ <h3 id="methods">
return this.version;
}

static isBasicConfig(config: ExternalToolConfig): config is BasicToolConfig {
return ToolConfigType.BASIC &#x3D;&#x3D;&#x3D; config.type;
}

static isOauth2Config(config: ExternalToolConfig): config is Oauth2ToolConfig {
return ToolConfigType.OAUTH2 &#x3D;&#x3D;&#x3D; config.type;
}
Expand Down
Loading

0 comments on commit cc4d807

Please sign in to comment.