@e22m4u/js-repository 0.0.41 → 0.0.42

package/README.md

@@ -9,7 +9,7 @@ npm install @e22m4u/js-repository
 ```
 
 Опционально устанавливаем адаптер. Например, если используется
-*MongoDB*, то для подключения потребуется добавить
+*MongoDB*, то для подключения потребуется установить
 [адаптер mongodb](https://www.npmjs.com/package/@e22m4u/js-repository-mongodb-adapter)
 как отдельную зависимость.
 
@@ -167,7 +167,7 @@ schema.defineModel({
 ```json
 {
   "id": 1,
-  "name": "Burger King at Avenue Mall",
+  "name": "Burger King",
   "location": {
     "lat": 32.412891,
     "lng": 34.7660061
@@ -230,7 +230,7 @@ const rep = schema.getRepository('place');
 
 ```js
 const place = await rep.create({
-  "name": "Burger King at Avenue Mall",
+  "name": "Burger King",
   "location": {
     "lat": 32.412891,
     "lng": 34.7660061
@@ -240,7 +240,7 @@ const place = await rep.create({
 console.log(place);
 // {
 //   "id": 1,
-//   "name": "Burger King at Avenue Mall",
+//   "name": "Burger King",
 //   "location": {
 //     "lat": 32.412891,
 //     "lng": 34.7660061
@@ -257,22 +257,73 @@ console.log(place);
 ```js
 // {
 //   "id": 1,
-//   "name": "Burger King at Avenue Mall",
+//   "name": "Burger King",
 //   "location": {
 //     "lat": 32.412891,
 //     "lng": 34.7660061
 //   }
 // }
 const result = rep.replaceById(place.id, {
-  name: 'Terminal 21 Shopping Mall',
-  address: 'Sukhumvit 19 Alley'
+  name: 'Starbucks',
+  address: 'Sukhumvit Alley'
 });
 
 console.log(result);
 // {
 //   "id": 1,
-//   "name": "Terminal 21 Shopping Mall",
-//   "address": "Sukhumvit 19 Alley"
+//   "name": "Starbucks",
+//   "address": "Sukhumvit Alley"
+// }
+```
+
+#### replaceOrCreate(data, filter = undefined)
+
+Если вы знакомы с методом PUT в архитектуре REST, когда документ
+добавляется, если его не существовало, или же обновляется существующий,
+то `replaceOrCreate` работает схожим образом. Если параметр
+`data` передаваемый первым аргументом будет содержать идентификатор,
+то метод будет вести себя как `replaceById`, в противном случае будет
+создан новый документ.
+
+```js
+// {
+//   "id": 1,
+//   "name": "Starbucks",
+//   "address": "Sukhumvit Alley"
+// }
+const result = rep.replaceOrCreate({
+  id: 1,
+  name: 'Airport',
+  city: 'Antalya',
+  code: 'AYT'
+});
+
+console.log(result);
+// {
+//   "id": 1,
+//   "name": "Airport",
+//   "city": "Antalya"
+//   "code": "AYT"
+// }
+```
+
+В примере выше был передан первичный ключ `id` для поиска и
+замены существующего документа. Теперь рассмотрим создание 
+документа с новым идентификатором.
+
+```js
+const result = rep.replaceOrCreate({
+  name: 'Airport',
+  city: 'Bangkok',
+  code: 'BKK',
+});
+
+console.log(result);
+// {
+//   "id": 2,
+//   "name": "Airport",
+//   "city": "Bangkok",
+//   "code": "BKK"
 // }
 ```
 
@@ -284,21 +335,22 @@ console.log(result);
 
 ```js
 // {
-//   "id": 1,
-//   "name": "Terminal 21 Shopping Mall",
-//   "address": "Sukhumvit 19 Alley"
+//   "id": 2,
+//   "name": "Airport",
+//   "city": "Bangkok",
+//   "code": "BKK"
 // }
 const result = rep.patchById(place.id, {
-  address: 'Moo 6',
-  city: 'Pattaya',
+  city: 'Moscow',
+  code: 'SVO'
 });
 
 console.log(result);
 // {
-//   "id": 1,
-//   "name": "Terminal 21 Shopping Mall",
-//   "address": "Moo 6",
-//   "city": "Pattaya"
+//   "id": 2,
+//   "name": "Airport",
+//   "city": "Moscow",
+//   "code": "SVO"
 // }
 ```
 
@@ -669,7 +721,7 @@ schema.defineModel({
     order: {
       type: 'hasOne',
       model: 'order',
-      foreignKey: 'customerId', // опционально
+      foreignKey: 'customerId', // поле целевой модели
     },
   },
 });
@@ -721,7 +773,7 @@ schema.defineModel({
     orders: {
       type: 'hasMany',
       model: 'order',
-      foreignKey: 'customerId', // опционально
+      foreignKey: 'customerId', // поле целевой модели
     },
   },
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e22m4u/js-repository",
-  "version": "0.0.41",
+  "version": "0.0.42",
   "description": "Абстракция для работы с базами данных для Node.js",
   "type": "module",
   "main": "src/index.js",

package/src/adapter/builtin/memory-adapter.spec.js

@@ -1589,11 +1589,11 @@ describe('MemoryAdapter', function () {
         properties: {
           foo: {
             type: DataType.STRING,
-            columnName: 'fooVal',
+            columnName: 'fooCol',
           },
           bar: {
             type: DataType.STRING,
-            columnName: 'barVal',
+            columnName: 'barCol',
           },
         },
       });
@@ -1610,17 +1610,17 @@ describe('MemoryAdapter', function () {
       const table = adapter._getTableOrCreate('model');
       const createdItems = Array.from(table.values());
       expect(createdItems).to.be.eql([
-        {[DEF_PK]: id1, fooVal: 'a', barVal: '1'},
-        {[DEF_PK]: id2, fooVal: 'b', barVal: '2'},
-        {[DEF_PK]: id3, fooVal: 'c', barVal: '2'},
+        {[DEF_PK]: id1, fooCol: 'a', barCol: '1'},
+        {[DEF_PK]: id2, fooCol: 'b', barCol: '2'},
+        {[DEF_PK]: id3, fooCol: 'c', barCol: '2'},
       ]);
       const result = await adapter.patch('model', {foo: 'd'}, {bar: '2'});
       expect(result).to.be.eq(2);
       const patchedItems = Array.from(table.values());
       expect(patchedItems).to.be.eql([
-        {[DEF_PK]: id1, fooVal: 'a', barVal: '1'},
-        {[DEF_PK]: id2, fooVal: 'd', barVal: '2'},
-        {[DEF_PK]: id3, fooVal: 'd', barVal: '2'},
+        {[DEF_PK]: id1, fooCol: 'a', barCol: '1'},
+        {[DEF_PK]: id2, fooCol: 'd', barCol: '2'},
+        {[DEF_PK]: id3, fooCol: 'd', barCol: '2'},
       ]);
     });
 

package/src/definition/model/relations/relation-definition.d.ts

@@ -99,8 +99,8 @@ export declare type PolyBelongsToDefinition = {
 export declare type HasOneDefinition = {
   type: RelationType.HAS_ONE;
   model: string;
+  foreignKey: string;
   polymorphic?: false;
-  foreignKey?: string;
   discriminator?: undefined;
 };
 
@@ -127,16 +127,7 @@ export declare type PolyHasOneDefinitionWithTargetRelationName = {
 /**
  * The polymorphic "hasOne" relation with target relation keys.
  *
- * @example Required options only.
- * ```
- * {
- *   type: RelationType.HAS_ONE,
- *   model: 'model',
- *   polymorphic: true,
- * }
- * ```
- *
- * @example Verbose definition.
+ * @example
  * ```
  * {
  *   type: RelationType.HAS_ONE,
@@ -151,8 +142,8 @@ export declare type PolyHasOneDefinitionWithTargetKeys = {
   type: RelationType.HAS_ONE;
   model: string;
   polymorphic: true;
-  foreignKey?: string;
-  discriminator?: string;
+  foreignKey: string;
+  discriminator: string;
 };
 
 /**
@@ -170,8 +161,8 @@ export declare type PolyHasOneDefinitionWithTargetKeys = {
 export declare type HasManyDefinition = {
   type: RelationType.HAS_MANY;
   model: string;
+  foreignKey: string;
   polymorphic?: false;
-  foreignKey?: string;
   discriminator?: undefined;
 };
 
@@ -198,16 +189,7 @@ export declare type PolyHasManyDefinitionWithTargetRelationName = {
 /**
  * The polymorphic "hasMany" relation with target relation keys.
  *
- * @example Required options only.
- * ```
- * {
- *   type: RelationType.HAS_MANY,
- *   model: 'model',
- *   polymorphic: true,
- * }
- * ```
- *
- * @example Verbose definition.
+ * @example
  * ```
  * {
  *   type: RelationType.HAS_MANY,
@@ -222,8 +204,8 @@ export declare type PolyHasManyDefinitionWithTargetKeys = {
   type: RelationType.HAS_MANY;
   model: string;
   polymorphic: true;
-  foreignKey?: string;
-  discriminator?: string;
+  foreignKey: string;
+  discriminator: string;
 };
 
 /**

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

@@ -253,15 +253,15 @@ describe('RelationsDefinitionValidator', function () {
           const validate = v => {
             const foo = {
               type: RelationType.HAS_ONE,
-              model: 'model',
-              foreignKey: v,
+              model: v,
+              foreignKey: 'modelId',
             };
             return () => S.validate('model', {foo});
           };
           const error = v =>
             format(
               'The relation "foo" of the model "model" has the type "hasOne", ' +
-                'so it requires the option "foreignKey" to be a non-empty String, ' +
+                'so it requires the option "model" to be a non-empty String, ' +
                 'but %s given.',
               v,
             );
@@ -273,22 +273,22 @@ describe('RelationsDefinitionValidator', function () {
           expect(validate([])).to.throw(error('Array'));
           expect(validate(undefined)).to.throw(error('undefined'));
           expect(validate(null)).to.throw(error('null'));
-          validate('modelId')();
+          validate('model')();
         });
 
-        it('requires the option "foreignKey" to be a string', function () {
+        it('requires the option "foreignKey" to be a non-empty string', function () {
           const validate = v => {
             const foo = {
               type: RelationType.HAS_ONE,
-              model: v,
-              foreignKey: 'modelId',
+              model: 'model',
+              foreignKey: v,
             };
             return () => S.validate('model', {foo});
           };
           const error = v =>
             format(
               'The relation "foo" of the model "model" has the type "hasOne", ' +
-                'so it requires the option "model" to be a non-empty String, ' +
+                'so it requires the option "foreignKey" to be a non-empty String, ' +
                 'but %s given.',
               v,
             );
@@ -300,7 +300,7 @@ describe('RelationsDefinitionValidator', function () {
           expect(validate([])).to.throw(error('Array'));
           expect(validate(undefined)).to.throw(error('undefined'));
           expect(validate(null)).to.throw(error('null'));
-          validate('model')();
+          validate('modelId')();
         });
 
         it('throws an error if the option "discriminator" is provided', function () {
@@ -479,15 +479,15 @@ describe('RelationsDefinitionValidator', function () {
           const validate = v => {
             const foo = {
               type: RelationType.HAS_MANY,
-              model: 'model',
-              foreignKey: v,
+              model: v,
+              foreignKey: 'modelId',
             };
             return () => S.validate('model', {foo});
           };
           const error = v =>
             format(
               'The relation "foo" of the model "model" has the type "hasMany", ' +
-                'so it requires the option "foreignKey" to be a non-empty String, ' +
+                'so it requires the option "model" to be a non-empty String, ' +
                 'but %s given.',
               v,
             );
@@ -499,22 +499,22 @@ describe('RelationsDefinitionValidator', function () {
           expect(validate([])).to.throw(error('Array'));
           expect(validate(undefined)).to.throw(error('undefined'));
           expect(validate(null)).to.throw(error('null'));
-          validate('modelId')();
+          validate('model')();
         });
 
-        it('requires the option "foreignKey" to be a string', function () {
+        it('requires the option "foreignKey" to be a non-empty string', function () {
           const validate = v => {
             const foo = {
               type: RelationType.HAS_MANY,
-              model: v,
-              foreignKey: 'modelId',
+              model: 'model',
+              foreignKey: v,
             };
             return () => S.validate('model', {foo});
           };
           const error = v =>
             format(
               'The relation "foo" of the model "model" has the type "hasMany", ' +
-                'so it requires the option "model" to be a non-empty String, ' +
+                'so it requires the option "foreignKey" to be a non-empty String, ' +
                 'but %s given.',
               v,
             );
@@ -526,7 +526,7 @@ describe('RelationsDefinitionValidator', function () {
           expect(validate([])).to.throw(error('Array'));
           expect(validate(undefined)).to.throw(error('undefined'));
           expect(validate(null)).to.throw(error('null'));
-          validate('model')();
+          validate('modelId')();
         });
 
         it('throws an error if the option "discriminator" is provided', function () {

package/src/filter/filter-clause.d.ts

@@ -43,9 +43,9 @@ export declare type ItemFilterClause = Pick<FilterClause, 'fields' | 'include'>;
  * ```
  */
 export declare type WhereClause =
-  | AndClause
-  | OrClause
-  | PropertiesClause;
+  & AndClause
+  & OrClause
+  & PropertiesClause;
 
 /**
  * Properties clause.
@@ -67,7 +67,8 @@ export type PropertiesClause = {
     | boolean
     | RegExp
     | null
-    | undefined;
+    | undefined
+    | object;
 };
 
 /**