js-repository/src/schema.spec.ts

import {expect} from 'chai';
import {Schema} from './schema.js';
import {Repository} from './repository/index.js';
import {DefinitionRegistry} from './definition/index.js';

describe('Schema', function () {
  describe('defineDatasource', function () {
    it('returns this', function () {
      const schema = new Schema();
      const res = schema.defineDatasource({
        name: 'datasource',
        adapter: 'memory',
      });
      expect(res).to.be.eq(schema);
    });

    it('sets the datasource definition', function () {
      const schema = new Schema();
      schema.defineDatasource({name: 'datasource', adapter: 'memory'});
      const res =
        schema.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 schema = new Schema();
      schema.defineDatasource({name: 'datasource', adapter: 'memory'});
      const throwable =
        () => schema.defineDatasource({name: 'datasource', adapter: 'memory'});
      expect(throwable).to.throw(
        'The datasource "datasource" is already defined.',
      );
    });
  });

  describe('defineModel', function () {
    it('returns this', function () {
      const schema = new Schema();
      const res = schema.defineModel({name: 'model'});
      expect(res).to.be.eq(schema);
    });

    it('sets the model definition', function () {
      const schema = new Schema();
      schema.defineModel({name: 'model'});
      const res = schema.getService(DefinitionRegistry).getModel('model');
      expect(res).to.be.eql({name: 'model'});
    });

    it('throws an error if the model name already defined', function () {
      const schema = new Schema();
      schema.defineModel({name: 'model'});
      const throwable = () => schema.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 schema = new Schema();
      schema.defineDatasource({name: 'datasource', adapter: 'memory'});
      schema.defineModel({name: 'model', datasource: 'datasource'});
      const res = schema.getRepository('model');
      expect(res).to.be.instanceof(Repository);
    });

    it('throws an error if the model is not defined', function () {
      const schema = new Schema();
      const throwable = () => schema.getRepository('model');
      expect(throwable).to.throw('The model "model" is not defined.');
    });

    it('uses generic types to define the repository type', function () {
      const schema = new Schema();
      schema.defineDatasource({name: 'datasource', adapter: 'memory'});
      schema.defineModel({name: 'model', datasource: 'datasource'});
      interface MyModel {
        myId: number;
      }
      const res1: Repository = schema.getRepository('model');
      const res2: Repository<MyModel, number, 'myId'> =
        schema.getRepository<MyModel, number, 'myId'>('model');
      expect(res1).to.be.eq(res2);
    });
  });
});