@e22m4u/js-repository 0.6.5 → 0.8.0

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

@@ -1,105 +0,0 @@
-import {expect} from 'chai';
-import {chai} from '../../chai.js';
-import {Adapter} from '../adapter.js';
-import {DatabaseSchema} from '../../database-schema.js';
-import {ModelDataValidator} from '../../definition/index.js';
-
-const dbs = new DatabaseSchema();
-dbs.defineModel({name: 'model'});
-
-class TestAdapter extends Adapter {
-  // eslint-disable-next-line no-unused-vars
-  create(modelName, modelData, filter = undefined) {
-    return Promise.resolve(modelData);
-  }
-
-  // eslint-disable-next-line no-unused-vars
-  replaceById(modelName, id, modelData, filter = undefined) {
-    return Promise.resolve(modelData);
-  }
-
-  // eslint-disable-next-line no-unused-vars
-  replaceOrCreate(modelName, modelData, filter = undefined) {
-    return Promise.resolve(modelData);
-  }
-
-  // eslint-disable-next-line no-unused-vars
-  patch(modelName, modelData, where = undefined) {
-    return Promise.resolve(modelData);
-  }
-
-  // eslint-disable-next-line no-unused-vars
-  patchById(modelName, id, modelData, filter = undefined) {
-    return Promise.resolve(modelData);
-  }
-}
-
-const A = dbs.getService(TestAdapter);
-const V = dbs.getService(ModelDataValidator);
-const sandbox = chai.spy.sandbox();
-
-describe('DataValidationDecorator', function () {
-  afterEach(function () {
-    sandbox.restore();
-  });
-
-  it('overrides the "create" method and validates a given data', async function () {
-    const data = {kind: 'data'};
-    sandbox.on(V, 'validate', (modelName, modelData, isPartial = false) => {
-      expect(modelName).to.be.eq('model');
-      expect(modelData).to.be.eql(data);
-      expect(isPartial).to.be.false;
-    });
-    const res = await A.create('model', data);
-    expect(res).to.be.eql(data);
-    expect(V.validate).to.be.called.once;
-  });
-
-  it('overrides the "replaceById" method and validates a given data', async function () {
-    const data = {kind: 'data'};
-    sandbox.on(V, 'validate', (modelName, modelData, isPartial = false) => {
-      expect(modelName).to.be.eq('model');
-      expect(modelData).to.be.eql(data);
-      expect(isPartial).to.be.false;
-    });
-    const res = await A.replaceById('model', 1, data);
-    expect(res).to.be.eql(data);
-    expect(V.validate).to.be.called.once;
-  });
-
-  it('overrides the "replaceOrCreate" method and validates a given data', async function () {
-    const data = {kind: 'data'};
-    sandbox.on(V, 'validate', (modelName, modelData, isPartial = false) => {
-      expect(modelName).to.be.eq('model');
-      expect(modelData).to.be.eql(data);
-      expect(isPartial).to.be.false;
-    });
-    const res = await A.replaceOrCreate('model', data);
-    expect(res).to.be.eql(data);
-    expect(V.validate).to.be.called.once;
-  });
-
-  it('overrides the "patch" method and validates a given data', async function () {
-    const data = {kind: 'data'};
-    sandbox.on(V, 'validate', (modelName, modelData, isPartial = false) => {
-      expect(modelName).to.be.eq('model');
-      expect(modelData).to.be.eql(data);
-      expect(isPartial).to.be.true;
-    });
-    const res = await A.patch('model', data);
-    expect(res).to.be.eql(data);
-    expect(V.validate).to.be.called.once;
-  });
-
-  it('overrides the "patchById" method and validates a given data', async function () {
-    const data = {kind: 'data'};
-    sandbox.on(V, 'validate', (modelName, modelData, isPartial = false) => {
-      expect(modelName).to.be.eq('model');
-      expect(modelData).to.be.eql(data);
-      expect(isPartial).to.be.true;
-    });
-    const res = await A.patchById('model', 1, data);
-    expect(res).to.be.eql(data);
-    expect(V.validate).to.be.called.once;
-  });
-});

package/src/adapter/decorator/default-values-decorator.d.ts

@@ -1,14 +0,0 @@
-import {Service} from '@e22m4u/js-service';
-import {Adapter} from '../adapter.js';
-
-/**
- * Default values decorator.
- */
-export declare class DefaultValuesDecorator extends Service {
-  /**
-   * Decorate.
-   *
-   * @param adapter
-   */
-  decorate(adapter: Adapter): void;
-}

package/src/adapter/decorator/fields-filtering-decorator.d.ts

@@ -1,14 +0,0 @@
-import {Service} from '@e22m4u/js-service';
-import {Adapter} from '../adapter.js';
-
-/**
- * Fields filtering decorator.
- */
-export declare class FieldsFilteringDecorator extends Service {
-  /**
-   * Decorate.
-   *
-   * @param adapter
-   */
-  decorate(adapter: Adapter): void;
-}

package/src/adapter/decorator/inclusion-decorator.d.ts

@@ -1,14 +0,0 @@
-import {Service} from '@e22m4u/js-service';
-import {Adapter} from '../adapter.js';
-
-/**
- * Inclusion decorator.
- */
-export declare class InclusionDecorator extends Service {
-  /**
-   * Decorate.
-   *
-   * @param adapter
-   */
-  decorate(adapter: Adapter): void;
-}

package/src/adapter/decorator/index.d.ts

@@ -1,7 +0,0 @@
-export * from './inclusion-decorator.js';
-export * from './default-values-decorator.js';
-export * from './data-sanitizing-decorator.js';
-export * from './data-validation-decorator.js';
-export * from './fields-filtering-decorator.js';
-export * from './data-transformation-decorator.js';
-export * from './property-uniqueness-decorator.js';

package/src/adapter/decorator/property-uniqueness-decorator.d.ts

@@ -1,14 +0,0 @@
-import {Adapter} from '../adapter.js';
-import {Service} from '@e22m4u/js-service';
-
-/**
- * Property uniqueness decorator.
- */
-export declare class PropertyUniquenessDecorator extends Service {
-  /**
-   * Decorate.
-   *
-   * @param adapter
-   */
-  decorate(adapter: Adapter): void;
-}

package/src/adapter/index.d.ts

@@ -1,3 +0,0 @@
-export * from './adapter.js';
-export * from './adapter-loader.js';
-export * from './adapter-registry.js';

package/src/database-schema.d.ts

@@ -1,37 +0,0 @@
-import {ModelId} from './types.js';
-import {ModelData} from './types.js';
-import {Service} from '@e22m4u/js-service';
-import {Repository} from './repository/index.js';
-import {ModelDefinition} from './definition/index.js';
-import {DatasourceDefinition} from './definition/index.js';
-import {DEFAULT_PRIMARY_KEY_PROPERTY_NAME} from './definition/index.js';
-
-/**
- * Database schema.
- */
-export declare class DatabaseSchema extends Service {
-  /**
-   * Define datasource.
-   *
-   * @param datasourceDef
-   */
-  defineDatasource(datasourceDef: DatasourceDefinition): this;
-
-  /**
-   * Define model.
-   *
-   * @param modelDef
-   */
-  defineModel(modelDef: ModelDefinition): this;
-
-  /**
-   * Get repository.
-   *
-   * @param modelName
-   */
-  getRepository<
-    Data extends object = ModelData,
-    IdType extends ModelId = ModelId,
-    IdName extends string = typeof DEFAULT_PRIMARY_KEY_PROPERTY_NAME,
-  >(modelName: string): Repository<Data, IdType, IdName>;
-}

package/src/definition/datasource/datasource-definition-validator.d.ts

@@ -1,14 +0,0 @@
-import {Service} from '@e22m4u/js-service';
-import {DatasourceDefinition} from './datasource-definition.js';
-
-/**
- * Datasource definition validator.
- */
-export declare class DatasourceDefinitionValidator extends Service {
-  /**
-   * Validate.
-   *
-   * @param datasourceDef
-   */
-  validate(datasourceDef: DatasourceDefinition): void;
-}

package/src/definition/datasource/datasource-definition.d.ts

@@ -1,8 +0,0 @@
-/**
- * Datasource definition.
- */
-export declare type DatasourceDefinition = {
-  name: string;
-  adapter: string;
-  [option: string]: unknown;
-};

package/src/definition/datasource/index.d.ts

@@ -1,2 +0,0 @@
-export * from './datasource-definition.js';
-export * from './datasource-definition-validator.js';

package/src/definition/definition-registry.d.ts

@@ -1,50 +0,0 @@
-import {Service} from '@e22m4u/js-service';
-import {ModelDefinition} from './model/index.js';
-import {DatasourceDefinition} from './datasource/index.js';
-
-/**
- * Definition registry.
- */
-export declare class DefinitionRegistry extends Service {
-  /**
-   * Add datasource.
-   *
-   * @param datasourceDef
-   */
-  addDatasource(datasourceDef: DatasourceDefinition): void;
-
-  /**
-   * Has datasource.
-   *
-   * @param name
-   */
-  hasDatasource(name: string): boolean;
-
-  /**
-   * Get datasource.
-   *
-   * @param name
-   */
-  getDatasource(name: string): DatasourceDefinition;
-
-  /**
-   * Add model.
-   *
-   * @param modelDef
-   */
-  addModel(modelDef: ModelDefinition): void;
-
-  /**
-   * Has model.
-   *
-   * @param name
-   */
-  hasModel(name: string): boolean;
-
-  /**
-   * Get model.
-   *
-   * @param name
-   */
-  getModel(name: string): ModelDefinition;
-}

package/src/definition/index.d.ts

@@ -1,3 +0,0 @@
-export * from './model/index.js';
-export * from './datasource/index.js';
-export * from './definition-registry.js';

package/src/definition/model/index.d.ts

@@ -1,8 +0,0 @@
-export * from './relations/index.js';
-export * from './properties/index.js';
-export * from './model-definition.js';
-export * from './model-data-validator.js';
-export * from './model-data-sanitizer.js';
-export * from './model-data-transformer.js';
-export * from './model-definition-utils.js';
-export * from './model-definition-validator.js';

package/src/definition/model/model-data-sanitizer.d.ts

@@ -1,15 +0,0 @@
-import {ModelData} from '../../types.js';
-import {Service} from '@e22m4u/js-service';
-
-/**
- * Model data sanitizer.
- */
-export declare class ModelDataSanitizer extends Service {
-  /**
-   * Sanitize.
-   *
-   * @param modelName
-   * @param modelData
-   */
-  sanitize(modelName: string, modelData: ModelData): ModelData;
-}

package/src/definition/model/model-data-transformer.d.ts

@@ -1,16 +0,0 @@
-import {ModelData} from '../../types.js';
-import {Service} from '@e22m4u/js-service';
-import {ValueOrPromise} from '../../types.js';
-
-/**
- * Model data transformer.
- */
-export declare class ModelDataTransformer extends Service {
-  /**
-   * Transform.
-   *
-   * @param modelName
-   * @param modelData
-   */
-  transform(modelName: string, modelData: ModelData): ValueOrPromise<ModelData>;
-}

package/src/definition/model/model-data-transformer.js

@@ -1,170 +0,0 @@
-import {Service} from '@e22m4u/js-service';
-import {cloneDeep} from '../../utils/index.js';
-import {isPlainObject} from '../../utils/index.js';
-import {transformPromise} from '../../utils/index.js';
-import {EmptyValuesService} from '@e22m4u/js-empty-values';
-import {InvalidArgumentError} from '../../errors/index.js';
-import {ModelDefinitionUtils} from './model-definition-utils.js';
-import {PropertyTransformerRegistry} from './properties/index.js';
-
-/**
- * Model data transformer.
- */
-export class ModelDataTransformer extends Service {
-  /**
-   * Transform.
-   *
-   * @param {string} modelName
-   * @param {object} modelData
-   * @param {boolean} isPartial
-   * @returns {object|Promise<object>}
-   */
-  transform(modelName, modelData, isPartial = false) {
-    if (!isPlainObject(modelData))
-      throw new InvalidArgumentError(
-        'The data of the model %v should be an Object, but %v was given.',
-        modelName,
-        modelData,
-      );
-    const emptyValuesService = this.getService(EmptyValuesService);
-    const modelDefinitionUtils = this.getService(ModelDefinitionUtils);
-    const propDefs =
-      modelDefinitionUtils.getPropertiesDefinitionInBaseModelHierarchy(
-        modelName,
-      );
-    const propNames = Object.keys(isPartial ? modelData : propDefs);
-    const transformedData = cloneDeep(modelData);
-    return propNames.reduce((transformedDataOrPromise, propName) => {
-      const propDef = propDefs[propName];
-      if (!propDef) return transformedDataOrPromise;
-      const propType =
-        modelDefinitionUtils.getDataTypeFromPropertyDefinition(propDef);
-      const propValue = modelData[propName];
-      const isEmpty = emptyValuesService.isEmptyByType(propType, propValue);
-      if (isEmpty) return transformedDataOrPromise;
-      const newPropValueOrPromise = this._transformPropertyValue(
-        modelName,
-        propName,
-        propDef,
-        propValue,
-      );
-      return transformPromise(newPropValueOrPromise, newPropValue => {
-        return transformPromise(transformedDataOrPromise, resolvedData => {
-          if (newPropValue !== propValue) resolvedData[propName] = newPropValue;
-          return resolvedData;
-        });
-      });
-    }, transformedData);
-  }
-
-  /**
-   * Transform property value.
-   *
-   * @param {string} modelName
-   * @param {string} propName
-   * @param {string|object} propDef
-   * @param {*} propValue
-   * @returns {*|Promise<*>}
-   */
-  _transformPropertyValue(modelName, propName, propDef, propValue) {
-    if (typeof propDef === 'string' || propDef.transform == null)
-      return propValue;
-    const transformDef = propDef.transform;
-    const transformerRegistry = this.getService(PropertyTransformerRegistry);
-    const transformFn = (
-      value,
-      transformerOrName,
-      transformerOptions = undefined,
-    ) => {
-      let transformerName, transformerFn;
-      // если второй аргумент является строкой, то строка
-      // воспринимается как название зарегистрированного
-      // трансформера
-      if (typeof transformerOrName === 'string') {
-        transformerName = transformerOrName;
-        transformerFn = transformerRegistry.getTransformer(transformerName);
-      }
-      // если второй аргумент является функцией,
-      // то функция воспринимается как трансформер
-      else if (typeof transformerOrName === 'function') {
-        transformerName =
-          transformerOrName.name && transformerOrName.name !== 'transform'
-            ? transformerOrName.name
-            : undefined;
-        transformerFn = transformerOrName;
-      }
-      // если второй аргумент не является строкой
-      // и функцией, то выбрасывается ошибка
-      else {
-        throw new InvalidArgumentError(
-          'Transformer must be a non-empty String or ' +
-            'a Function, but %v was given.',
-          transformerOrName,
-        );
-      }
-      const context = {transformerName, modelName, propName};
-      return transformerFn(value, transformerOptions, context);
-    };
-    // если значением опции "transform" является строка,
-    // то строка воспринимается как название трансформера
-    if (transformDef && typeof transformDef === 'string') {
-      return transformFn(propValue, transformDef);
-    }
-    // если значением опции "transform" является функция,
-    // то функция воспринимается как трансформер
-    else if (transformDef && typeof transformDef === 'function') {
-      return transformFn(propValue, transformDef);
-    }
-    // если значение опции "transform" является массив, то каждый
-    // элемент массива воспринимается как название трансформера
-    // или функция-валидатор
-    else if (Array.isArray(transformDef)) {
-      return transformDef.reduce((valueOrPromise, transformerOrName) => {
-        if (
-          !transformerOrName ||
-          (typeof transformerOrName !== 'string' &&
-            typeof transformerOrName !== 'function')
-        ) {
-          throw new InvalidArgumentError(
-            'The provided option "transform" for the property %v ' +
-              'in the model %v has an Array value that should contain ' +
-              'transformer names or transformer functions, but %v was given.',
-            propName,
-            modelName,
-            transformerOrName,
-          );
-        }
-        return transformPromise(valueOrPromise, value => {
-          return transformFn(value, transformerOrName);
-        });
-      }, propValue);
-    }
-    // если значение опции "transform" является объектом,
-    // то ключи объекта воспринимаются как названия трансформеров,
-    // а их значения аргументами
-    else if (transformDef !== null && typeof transformDef === 'object') {
-      return Object.keys(transformDef).reduce(
-        (valueOrPromise, transformerName) => {
-          const transformerOptions = transformDef[transformerName];
-          return transformPromise(valueOrPromise, value => {
-            return transformFn(value, transformerName, transformerOptions);
-          });
-        },
-        propValue,
-      );
-    }
-    // если значение опции "transform" не является строкой,
-    // функцией и массивом, то выбрасывается ошибка
-    else {
-      throw new InvalidArgumentError(
-        'The provided option "transform" for the property %v in the model %v ' +
-          'should be either a transformer name, a transformer function, an array ' +
-          'of transformer names or functions, or an object mapping transformer ' +
-          'names to their arguments, but %v was given.',
-        propName,
-        modelName,
-        transformDef,
-      );
-    }
-  }
-}