chore: updates README.md

README.md

@@ -259,6 +259,109 @@ schema.defineModel({
 - `hasMany` - обратная сторона `belongsTo` по принципу "один ко многим"
 - `referencesMany` - документ содержит массив с идентификаторами целевой модели
 
+**belongsTo**
+
+Базовое определение `belongsTo`
+
+```js
+{
+  type: RelationType.BELONGS_TO,
+  model: 'target',
+  foreignKey: 'targetId', // опционально
+}
+```
+
+Полиморфная версия `belongsTo`
+
+```js
+{
+  type: RelationType.BELONGS_TO,
+  polymorphic: true,
+  foreignKey: 'referenceId',      // опционально
+  discriminator: 'referenceType', // опционально
+}
+```
+
+**hasOne**
+
+Базовое определение `hasOne`
+
+```js
+{
+  type: RelationType.HAS_ONE,
+  model: 'target',
+  foreignKey: 'sourceId',
+}
+```
+
+Полиморфная версия `hasOne` с указанием имени связи целевой модели.
+
+```js
+{
+  type: RelationType.HAS_ONE,
+  model: 'target',
+  polymorphic: 'relation',
+}
+```
+
+Полиморфная версия `hasOne` с указанием свойств целевой модели.
+
+```js
+{
+  type: RelationType.HAS_ONE,
+  model: 'target',
+  polymorphic: true,
+  foreignKey: 'referenceId',
+  discriminator: 'referenceType,
+}
+```
+
+**hasMany**
+
+Базовое определение `hasMany`
+
+```js
+{
+  type: RelationType.HAS_MANY,
+  model: 'target',
+  foreignKey: 'sourceId',
+}
+```
+
+Полиморфная версия `hasMany` с указанием имени связи целевой модели.
+
+```js
+{
+  type: RelationType.HAS_MANY,
+  model: 'target',
+  polymorphic: 'relation',
+}
+```
+
+Полиморфная версия `hasMany` с указанием свойств целевой модели.
+
+```js
+{
+  type: RelationType.HAS_MANY,
+  model: 'target',
+  polymorphic: true,
+  foreignKey: 'referenceId',
+  discriminator: 'referenceType,
+}
+```
+
+**referencesMany**
+
+Определение связи `referencesMany`
+
+```js
+{
+  type: RelationType.REFERENCES_MANY,
+  model: 'target',
+  foreignKey: 'targetIds', // опционально
+}
+```
+
 ## Тесты
 
 ```bash

docs/index.html

@@ -138,6 +138,37 @@
 <li><code>hasMany</code> - обратная сторона <code>belongsTo</code> по принципу &quot;один ко многим&quot;</li>
 <li><code>referencesMany</code> - документ содержит массив с идентификаторами целевой модели</li>
 </ul>
+<p><strong>belongsTo</strong></p>
+<p>Базовое определение <code>belongsTo</code></p>
+<pre><code class="language-js"><span class="hl-1">{</span><br/><span class="hl-1">  </span><span class="hl-9">type</span><span class="hl-1">: </span><span class="hl-4">RelationType</span><span class="hl-1">.</span><span class="hl-7">BELONGS_TO</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">model</span><span class="hl-1">: </span><span class="hl-2">&#39;target&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">foreignKey</span><span class="hl-1">: </span><span class="hl-2">&#39;targetId&#39;</span><span class="hl-1">, </span><span class="hl-5">// опционально</span><br/><span class="hl-1">}</span>
+</code><button>Copy</button></pre>
+<p>Полиморфная версия <code>belongsTo</code></p>
+<pre><code class="language-js"><span class="hl-1">{</span><br/><span class="hl-1">  </span><span class="hl-9">type</span><span class="hl-1">: </span><span class="hl-4">RelationType</span><span class="hl-1">.</span><span class="hl-7">BELONGS_TO</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">polymorphic</span><span class="hl-1">: </span><span class="hl-6">true</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">foreignKey</span><span class="hl-1">: </span><span class="hl-2">&#39;referenceId&#39;</span><span class="hl-1">,      </span><span class="hl-5">// опционально</span><br/><span class="hl-1">  </span><span class="hl-9">discriminator</span><span class="hl-1">: </span><span class="hl-2">&#39;referenceType&#39;</span><span class="hl-1">, </span><span class="hl-5">// опционально</span><br/><span class="hl-1">}</span>
+</code><button>Copy</button></pre>
+<p><strong>hasOne</strong></p>
+<p>Базовое определение <code>hasOne</code></p>
+<pre><code class="language-js"><span class="hl-1">{</span><br/><span class="hl-1">  </span><span class="hl-9">type</span><span class="hl-1">: </span><span class="hl-4">RelationType</span><span class="hl-1">.</span><span class="hl-7">HAS_ONE</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">model</span><span class="hl-1">: </span><span class="hl-2">&#39;target&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">foreignKey</span><span class="hl-1">: </span><span class="hl-2">&#39;sourceId&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">}</span>
+</code><button>Copy</button></pre>
+<p>Полиморфная версия <code>hasOne</code> с указанием имени связи целевой модели.</p>
+<pre><code class="language-js"><span class="hl-1">{</span><br/><span class="hl-1">  </span><span class="hl-9">type</span><span class="hl-1">: </span><span class="hl-4">RelationType</span><span class="hl-1">.</span><span class="hl-7">HAS_ONE</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">model</span><span class="hl-1">: </span><span class="hl-2">&#39;target&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">polymorphic</span><span class="hl-1">: </span><span class="hl-2">&#39;relation&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">}</span>
+</code><button>Copy</button></pre>
+<p>Полиморфная версия <code>hasOne</code> с указанием свойств целевой модели.</p>
+<pre><code class="language-js"><span class="hl-1">{</span><br/><span class="hl-1">  </span><span class="hl-9">type</span><span class="hl-1">: </span><span class="hl-4">RelationType</span><span class="hl-1">.</span><span class="hl-7">HAS_ONE</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">model</span><span class="hl-1">: </span><span class="hl-2">&#39;target&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">polymorphic</span><span class="hl-1">: </span><span class="hl-6">true</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">foreignKey</span><span class="hl-1">: </span><span class="hl-2">&#39;referenceId&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">discriminator</span><span class="hl-1">: </span><span class="hl-2">&#39;referenceType</span><span class="hl-10">,</span><br/><span class="hl-1">}</span>
+</code><button>Copy</button></pre>
+<p><strong>hasMany</strong></p>
+<p>Базовое определение <code>hasMany</code></p>
+<pre><code class="language-js"><span class="hl-1">{</span><br/><span class="hl-1">  </span><span class="hl-9">type</span><span class="hl-1">: </span><span class="hl-4">RelationType</span><span class="hl-1">.</span><span class="hl-7">HAS_MANY</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">model</span><span class="hl-1">: </span><span class="hl-2">&#39;target&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">foreignKey</span><span class="hl-1">: </span><span class="hl-2">&#39;sourceId&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">}</span>
+</code><button>Copy</button></pre>
+<p>Полиморфная версия <code>hasMany</code> с указанием имени связи целевой модели.</p>
+<pre><code class="language-js"><span class="hl-1">{</span><br/><span class="hl-1">  </span><span class="hl-9">type</span><span class="hl-1">: </span><span class="hl-4">RelationType</span><span class="hl-1">.</span><span class="hl-7">HAS_MANY</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">model</span><span class="hl-1">: </span><span class="hl-2">&#39;target&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">polymorphic</span><span class="hl-1">: </span><span class="hl-2">&#39;relation&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">}</span>
+</code><button>Copy</button></pre>
+<p>Полиморфная версия <code>hasMany</code> с указанием свойств целевой модели.</p>
+<pre><code class="language-js"><span class="hl-1">{</span><br/><span class="hl-1">  </span><span class="hl-9">type</span><span class="hl-1">: </span><span class="hl-4">RelationType</span><span class="hl-1">.</span><span class="hl-7">HAS_MANY</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">model</span><span class="hl-1">: </span><span class="hl-2">&#39;target&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">polymorphic</span><span class="hl-1">: </span><span class="hl-6">true</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">foreignKey</span><span class="hl-1">: </span><span class="hl-2">&#39;referenceId&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">discriminator</span><span class="hl-1">: </span><span class="hl-2">&#39;referenceType</span><span class="hl-10">,</span><br/><span class="hl-1">}</span>
+</code><button>Copy</button></pre>
+<p><strong>referencesMany</strong></p>
+<p>Определение связи <code>referencesMany</code></p>
+<pre><code class="language-js"><span class="hl-1">{</span><br/><span class="hl-1">  </span><span class="hl-9">type</span><span class="hl-1">: </span><span class="hl-4">RelationType</span><span class="hl-1">.</span><span class="hl-7">REFERENCES_MANY</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">model</span><span class="hl-1">: </span><span class="hl-2">&#39;target&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-9">foreignKey</span><span class="hl-1">: </span><span class="hl-2">&#39;targetIds&#39;</span><span class="hl-1">, </span><span class="hl-5">// опционально</span><br/><span class="hl-1">}</span>
+</code><button>Copy</button></pre>
 <a id="md:тесты" class="tsd-anchor"></a><h2><a href="#md:тесты">Тесты</a></h2><pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">test</span>
 </code><button>Copy</button></pre>
 <a id="md:лицензия" class="tsd-anchor"></a><h2><a href="#md:лицензия">Лицензия</a></h2><p>MIT</p>

src/definition/model/relations/relations-definition-validator.js

@@ -94,8 +94,8 @@ export class RelationsDefinitionValidator extends Service {
    * {
    *   type: RelationType.BELONGS_TO,
    *   polymorphic: true,
-   *   foreignKey: 'referenceId',     // optional
-   *   discriminator: 'referenceType, // optional
+   *   foreignKey: 'referenceId',      // optional
+   *   discriminator: 'referenceType', // optional
    * }
    * ```
    *