@e22m4u/js-repository 0.2.7 → 0.3.0

package/src/adapter/decorator/data-sanitizing-decorator.spec.js

@@ -1,11 +1,11 @@
 import {expect} from 'chai';
 import {chai} from '../../chai.js';
 import {Adapter} from '../adapter.js';
-import {Schema} from '../../schema.js';
+import {DatabaseSchema} from '../../database-schema.js';
 import {ModelDataSanitizer} from '../../definition/index.js';
 
-const S = new Schema();
-S.defineModel({name: 'model'});
+const dbs = new DatabaseSchema();
+dbs.defineModel({name: 'model'});
 
 class TestAdapter extends Adapter {
   // eslint-disable-next-line no-unused-vars
@@ -34,8 +34,8 @@ class TestAdapter extends Adapter {
   }
 }
 
-const A = S.getService(TestAdapter);
-const V = S.getService(ModelDataSanitizer);
+const A = dbs.getService(TestAdapter);
+const V = dbs.getService(ModelDataSanitizer);
 const sandbox = chai.spy.sandbox();
 
 describe('DataSanitizingDecorator', function () {

package/src/adapter/decorator/data-transformation-decorator.spec.js

@@ -1,7 +1,7 @@
 import {expect} from 'chai';
 import {chai} from '../../chai.js';
 import {Adapter} from '../adapter.js';
-import {Schema} from '../../schema.js';
+import {DatabaseSchema} from '../../database-schema.js';
 import {ModelDataTransformer} from '../../definition/index.js';
 
 const MODEL_NAME = 'myModel';
@@ -46,10 +46,10 @@ class TestAdapter extends Adapter {
   }
 }
 
-const S = new Schema();
-S.defineModel({name: MODEL_NAME});
-const A = S.getService(TestAdapter);
-const T = S.getService(ModelDataTransformer);
+const dbs = new DatabaseSchema();
+dbs.defineModel({name: MODEL_NAME});
+const A = dbs.getService(TestAdapter);
+const T = dbs.getService(ModelDataTransformer);
 const sandbox = chai.spy.sandbox();
 
 describe('DataTransformationDecorator', function () {

package/src/adapter/decorator/data-validation-decorator.spec.js

@@ -1,11 +1,11 @@
 import {expect} from 'chai';
 import {chai} from '../../chai.js';
 import {Adapter} from '../adapter.js';
-import {Schema} from '../../schema.js';
+import {DatabaseSchema} from '../../database-schema.js';
 import {ModelDataValidator} from '../../definition/index.js';
 
-const S = new Schema();
-S.defineModel({name: 'model'});
+const dbs = new DatabaseSchema();
+dbs.defineModel({name: 'model'});
 
 class TestAdapter extends Adapter {
   // eslint-disable-next-line no-unused-vars
@@ -34,8 +34,8 @@ class TestAdapter extends Adapter {
   }
 }
 
-const A = S.getService(TestAdapter);
-const V = S.getService(ModelDataValidator);
+const A = dbs.getService(TestAdapter);
+const V = dbs.getService(ModelDataValidator);
 const sandbox = chai.spy.sandbox();
 
 describe('DataValidationDecorator', function () {

package/src/adapter/decorator/default-values-decorator.spec.js

@@ -1,12 +1,12 @@
 import {expect} from 'chai';
 import {chai} from '../../chai.js';
 import {Adapter} from '../adapter.js';
-import {Schema} from '../../schema.js';
 import {DataType} from '../../definition/index.js';
+import {DatabaseSchema} from '../../database-schema.js';
 import {ModelDefinitionUtils} from '../../definition/index.js';
 
-const S = new Schema();
-S.defineModel({
+const dbs = new DatabaseSchema();
+dbs.defineModel({
   name: 'model',
   properties: {
     prop: {
@@ -56,8 +56,8 @@ class TestAdapter extends Adapter {
   }
 }
 
-const A = S.getService(TestAdapter);
-const U = S.getService(ModelDefinitionUtils);
+const A = dbs.getService(TestAdapter);
+const U = dbs.getService(ModelDefinitionUtils);
 const sandbox = chai.spy.sandbox();
 
 describe('DefaultValuesDecorator', function () {

package/src/adapter/decorator/fields-filtering-decorator.spec.js

@@ -1,12 +1,12 @@
 import {expect} from 'chai';
 import {chai} from '../../chai.js';
 import {Adapter} from '../adapter.js';
-import {Schema} from '../../schema.js';
 import {FieldsClauseTool} from '../../filter/index.js';
+import {DatabaseSchema} from '../../database-schema.js';
 
-const S = new Schema();
+const dbs = new DatabaseSchema();
 const MODEL_NAME = 'model';
-S.defineModel({name: MODEL_NAME});
+dbs.defineModel({name: MODEL_NAME});
 
 const FILTER = {fields: ['foo', 'bar']};
 const MODEL_DATA = {
@@ -53,8 +53,8 @@ class TestAdapter extends Adapter {
   }
 }
 
-const A = S.getService(TestAdapter);
-const T = S.getService(FieldsClauseTool);
+const A = dbs.getService(TestAdapter);
+const T = dbs.getService(FieldsClauseTool);
 const sandbox = chai.spy.sandbox();
 
 describe('FieldsFilteringDecorator', function () {

package/src/adapter/decorator/inclusion-decorator.spec.js

@@ -1,11 +1,11 @@
 import {expect} from 'chai';
 import {chai} from '../../chai.js';
 import {Adapter} from '../adapter.js';
-import {Schema} from '../../schema.js';
+import {DatabaseSchema} from '../../database-schema.js';
 import {IncludeClauseTool} from '../../filter/index.js';
 
-const S = new Schema();
-S.defineModel({name: 'model'});
+const dbs = new DatabaseSchema();
+dbs.defineModel({name: 'model'});
 const FILTER = {include: 'parent'};
 
 const MODEL_DATA = {
@@ -51,8 +51,8 @@ class TestAdapter extends Adapter {
   }
 }
 
-const A = S.getService(TestAdapter);
-const T = S.getService(IncludeClauseTool);
+const A = dbs.getService(TestAdapter);
+const T = dbs.getService(IncludeClauseTool);
 const sandbox = chai.spy.sandbox();
 
 describe('InclusionDecorator', function () {

package/src/adapter/decorator/property-uniqueness-decorator.spec.js

@@ -1,11 +1,11 @@
 import {expect} from 'chai';
 import {chai} from '../../chai.js';
 import {Adapter} from '../adapter.js';
-import {Schema} from '../../schema.js';
+import {DatabaseSchema} from '../../database-schema.js';
 import {PropertyUniquenessValidator} from '../../definition/index.js';
 
-const S = new Schema();
-S.defineModel({name: 'model'});
+const dbs = new DatabaseSchema();
+dbs.defineModel({name: 'model'});
 
 class TestAdapter extends Adapter {
   // eslint-disable-next-line no-unused-vars
@@ -34,8 +34,8 @@ class TestAdapter extends Adapter {
   }
 }
 
-const A = S.getService(TestAdapter);
-const V = S.getService(PropertyUniquenessValidator);
+const A = dbs.getService(TestAdapter);
+const V = dbs.getService(PropertyUniquenessValidator);
 const sandbox = chai.spy.sandbox();
 
 describe('PropertyUniquenessDecorator', function () {

package/src/{schema.d.ts → database-schema.d.ts}

@@ -7,9 +7,9 @@ import {DatasourceDefinition} from './definition/index.js';
 import {DEFAULT_PRIMARY_KEY_PROPERTY_NAME} from './definition/index.js';
 
 /**
- * Schema.
+ * Database schema.
  */
-export declare class Schema extends Service {
+export declare class DatabaseSchema extends Service {
   /**
    * Define datasource.
    *

package/src/{schema.js → database-schema.js}

@@ -4,9 +4,9 @@ import {DefinitionRegistry} from './definition/index.js';
 import {RepositoryRegistry} from './repository/index.js';
 
 /**
- * Schema.
+ * Database schema.
  */
-export class Schema extends Service {
+export class DatabaseSchema extends Service {
   /**
    * Define datasource.
    *

package/src/database-schema.spec.ts

@@ -0,0 +1,86 @@
+import {expect} from 'chai';
+import {Repository} from './repository/index.js';
+import {DatabaseSchema} from './database-schema.js';
+import {DefinitionRegistry} from './definition/index.js';
+
+describe('DatabaseSchema', function () {
+  describe('defineDatasource', function () {
+    it('returns this', function () {
+      const dbs = new DatabaseSchema();
+      const res = dbs.defineDatasource({
+        name: 'datasource',
+        adapter: 'memory',
+      });
+      expect(res).to.be.eq(dbs);
+    });
+
+    it('sets the datasource definition', function () {
+      const dbs = new DatabaseSchema();
+      dbs.defineDatasource({name: 'datasource', adapter: 'memory'});
+      const res =
+        dbs.getService(DefinitionRegistry).getDatasource('datasource');
+      expect(res).to.be.eql({name: 'datasource', adapter: 'memory'});
+    });
+
+    it('throws an error if the datasource name already defined', function () {
+      const dbs = new DatabaseSchema();
+      dbs.defineDatasource({name: 'datasource', adapter: 'memory'});
+      const throwable =
+        () => dbs.defineDatasource({name: 'datasource', adapter: 'memory'});
+      expect(throwable).to.throw(
+        'The datasource "datasource" is already defined.',
+      );
+    });
+  });
+
+  describe('defineModel', function () {
+    it('returns this', function () {
+      const dbs = new DatabaseSchema();
+      const res = dbs.defineModel({name: 'model'});
+      expect(res).to.be.eq(dbs);
+    });
+
+    it('sets the model definition', function () {
+      const dbs = new DatabaseSchema();
+      dbs.defineModel({name: 'model'});
+      const res = dbs.getService(DefinitionRegistry).getModel('model');
+      expect(res).to.be.eql({name: 'model'});
+    });
+
+    it('throws an error if the model name already defined', function () {
+      const dbs = new DatabaseSchema();
+      dbs.defineModel({name: 'model'});
+      const throwable = () => dbs.defineModel({name: 'model'});
+      expect(throwable).to.throw('The model "model" is already defined.');
+    });
+  });
+
+  describe('getRepository', function () {
+    it('returns a repository by the model name', function () {
+      const dbs = new DatabaseSchema();
+      dbs.defineDatasource({name: 'datasource', adapter: 'memory'});
+      dbs.defineModel({name: 'model', datasource: 'datasource'});
+      const res = dbs.getRepository('model');
+      expect(res).to.be.instanceof(Repository);
+    });
+
+    it('throws an error if the model is not defined', function () {
+      const dbs = new DatabaseSchema();
+      const throwable = () => dbs.getRepository('model');
+      expect(throwable).to.throw('The model "model" is not defined.');
+    });
+
+    it('uses generic types to define the repository type', function () {
+      const dbs = new DatabaseSchema();
+      dbs.defineDatasource({name: 'datasource', adapter: 'memory'});
+      dbs.defineModel({name: 'model', datasource: 'datasource'});
+      interface MyModel {
+        myId: number;
+      }
+      const res1: Repository = dbs.getRepository('model');
+      const res2: Repository<MyModel, number, 'myId'> =
+        dbs.getRepository<MyModel, number, 'myId'>('model');
+      expect(res1).to.be.eq(res2);
+    });
+  });
+});