@e22m4u/js-repository 0.6.5 → 0.7.0

package/src/definition/model/properties/property-validator/builtin/min-length-validator.js

@@ -1,28 +0,0 @@
-import {InvalidArgumentError} from '../../../../../errors/index.js';
-
-/**
- * Min length validator.
- *
- * @param {*} value
- * @param {number|boolean} options
- * @param {object} context
- * @returns {boolean}
- */
-export function minLengthValidator(value, options, context) {
-  if (value == null || options === false) return true;
-  if (typeof options !== 'number')
-    throw new InvalidArgumentError(
-      'The validator %v requires the "options" argument ' +
-        'as a Number, but %v was given.',
-      context.validatorName,
-      options,
-    );
-  if (typeof value === 'string' || Array.isArray(value))
-    return value.length >= options;
-  throw new InvalidArgumentError(
-    'The property validator %v requires a String ' +
-      'or an Array value, but %v was given.',
-    context.validatorName,
-    value,
-  );
-}

package/src/definition/model/properties/property-validator/builtin/min-length-validator.spec.js

@@ -1,100 +0,0 @@
-import {expect} from 'chai';
-import {format} from '@e22m4u/js-format';
-import {minLengthValidator} from './min-length-validator.js';
-
-describe('minLengthValidator', function () {
-  it('returns true if the "options" argument is false', function () {
-    const res = minLengthValidator('test', false, {});
-    expect(res).to.be.true;
-  });
-
-  it('returns true for undefined and null values', function () {
-    const res1 = minLengthValidator(undefined, 10, {});
-    const res2 = minLengthValidator(null, 10, {});
-    expect(res1).to.be.true;
-    expect(res2).to.be.true;
-  });
-
-  it('requires the "value" argument as a String or an Array', function () {
-    const throwable = v => () =>
-      minLengthValidator(v, 0, {
-        validatorName: 'myValidator',
-      });
-    const error = v =>
-      format(
-        'The property validator "myValidator" requires a String ' +
-          'or an Array value, but %s was given.',
-        v,
-      );
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable({})).to.throw(error('Object'));
-    expect(throwable(() => undefined)).to.throw(error('Function'));
-    throwable('str')();
-    throwable('')();
-    throwable([1, 2, 3])();
-    throwable([])();
-    throwable(undefined)();
-    throwable(null)();
-  });
-
-  it('requires the "options" argument to be a number', function () {
-    const throwable = v => () =>
-      minLengthValidator('test', v, {
-        validatorName: 'myValidator',
-      });
-    const error = v =>
-      format(
-        'The validator "myValidator" requires the "options" argument ' +
-          'as a Number, but %s was given.',
-        v,
-      );
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(undefined)).to.throw(error('undefined'));
-    expect(throwable(null)).to.throw(error('null'));
-    expect(throwable({})).to.throw(error('Object'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable(() => undefined)).to.throw(error('Function'));
-    throwable(10)();
-    throwable(0)();
-    throwable(false)();
-  });
-
-  describe('a string value', function () {
-    it('returns false if the value length is lower than the min length option', function () {
-      const res = minLengthValidator('12', 3, {});
-      expect(res).to.be.false;
-    });
-
-    it('returns true if the value length is equal to the min length option', function () {
-      const res = minLengthValidator('123', 3, {});
-      expect(res).to.be.true;
-    });
-
-    it('returns true if the value length is greater than the min length option', function () {
-      const res = minLengthValidator('1234', 3, {});
-      expect(res).to.be.true;
-    });
-  });
-
-  describe('an array value', function () {
-    it('returns false if the value length is lower than the min length option', function () {
-      const res = minLengthValidator([1, 2], 3, {});
-      expect(res).to.be.false;
-    });
-
-    it('returns true if the value length is equal to the min length option', function () {
-      const res = minLengthValidator([1, 2, 3], 3, {});
-      expect(res).to.be.true;
-    });
-
-    it('returns true if the value length is greater than the min length option', function () {
-      const res = minLengthValidator([1, 2, 3, 4], 3, {});
-      expect(res).to.be.true;
-    });
-  });
-});

package/src/definition/model/properties/property-validator/builtin/regexp-validator.d.ts

@@ -1,6 +0,0 @@
-import {PropertyValidator} from '../property-validator.js';
-
-/**
- * Regexp validator.
- */
-export const regexpValidator: PropertyValidator;

package/src/definition/model/properties/property-validator/builtin/regexp-validator.js

@@ -1,30 +0,0 @@
-import {stringToRegexp} from '../../../../../utils/index.js';
-import {InvalidArgumentError} from '../../../../../errors/index.js';
-
-/**
- * Regexp validator.
- *
- * @param {*} value
- * @param {string|RegExp|boolean} options
- * @param {object} context
- * @returns {boolean}
- */
-export function regexpValidator(value, options, context) {
-  if (value == null || options === false) return true;
-  if (typeof options !== 'string' && !(options instanceof RegExp))
-    throw new InvalidArgumentError(
-      'The validator %v requires the "options" argument ' +
-        'as a String or RegExp, but %v was given.',
-      context.validatorName,
-      options,
-    );
-  if (typeof value === 'string') {
-    const regexp = stringToRegexp(options);
-    return regexp.test(value);
-  }
-  throw new InvalidArgumentError(
-    'The property validator %v requires ' + 'a String value, but %v was given.',
-    context.validatorName,
-    value,
-  );
-}

package/src/definition/model/properties/property-validator/builtin/regexp-validator.spec.js

@@ -1,102 +0,0 @@
-import {expect} from 'chai';
-import {format} from '@e22m4u/js-format';
-import {regexpValidator} from './regexp-validator.js';
-
-describe('regexpValidator', function () {
-  it('returns true if the "options" argument is false', function () {
-    const res = regexpValidator('test', false, {});
-    expect(res).to.be.true;
-  });
-
-  it('returns true for undefined and null values', function () {
-    const res1 = regexpValidator(undefined, '.*', {});
-    const res2 = regexpValidator(null, '.*', {});
-    expect(res1).to.be.true;
-    expect(res2).to.be.true;
-  });
-
-  it('requires the "value" argument to be a string', function () {
-    const throwable = v => () =>
-      regexpValidator(v, '.*', {
-        validatorName: 'myValidator',
-      });
-    const error = v =>
-      format(
-        'The property validator "myValidator" requires ' +
-          'a String value, but %s was given.',
-        v,
-      );
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable({})).to.throw(error('Object'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable(() => undefined)).to.throw(error('Function'));
-    throwable('str')();
-    throwable('')();
-    throwable(undefined)();
-    throwable(null)();
-  });
-
-  it('requires the "options" argument to be a string or RegExp', function () {
-    const throwable = v => () =>
-      regexpValidator('test', v, {
-        validatorName: 'myValidator',
-      });
-    const error = v =>
-      format(
-        'The validator "myValidator" requires the "options" argument ' +
-          'as a String or RegExp, but %s was given.',
-        v,
-      );
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(undefined)).to.throw(error('undefined'));
-    expect(throwable(null)).to.throw(error('null'));
-    expect(throwable({})).to.throw(error('Object'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable(() => undefined)).to.throw(error('Function'));
-    throwable('str')();
-    throwable('')();
-    throwable(false)();
-    throwable(new RegExp(''))();
-  });
-
-  describe('the given regexp as a String', function () {
-    it('returns false if the given regexp is not matched', function () {
-      const res1 = regexpValidator('foo', 'bar', {});
-      const res2 = regexpValidator('foo', '^\\d+', {});
-      const res3 = regexpValidator('foo', '^baz$', {});
-      expect(res1).to.be.false;
-      expect(res2).to.be.false;
-      expect(res3).to.be.false;
-    });
-
-    it('returns true if the given regexp is matched', function () {
-      const res1 = regexpValidator('foo', '^fo', {});
-      const res2 = regexpValidator('foo', '^foo$', {});
-      const res3 = regexpValidator('foo', '^\\w+$', {});
-      expect(res1).to.be.true;
-      expect(res2).to.be.true;
-      expect(res3).to.be.true;
-    });
-  });
-
-  describe('the given regexp as an instance of RegExp', function () {
-    it('returns false if the given regexp is not matched', function () {
-      const res1 = regexpValidator('foo', /bar/, {});
-      const res2 = regexpValidator('foo', /^\d+/, {});
-      const res3 = regexpValidator('foo', /^bar$/, {});
-      expect(res1).to.be.false;
-      expect(res2).to.be.false;
-      expect(res3).to.be.false;
-    });
-
-    it('returns true if the given regexp is matched', function () {
-      const res1 = regexpValidator('foo', /^fo/, {});
-      const res2 = regexpValidator('foo', /^foo$/, {});
-      const res3 = regexpValidator('foo', /^\w+$/, {});
-      expect(res1).to.be.true;
-      expect(res2).to.be.true;
-      expect(res3).to.be.true;
-    });
-  });
-});

package/src/definition/model/properties/property-validator/index.d.ts

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

package/src/definition/model/properties/property-validator/index.js

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

package/src/definition/model/properties/property-validator/property-validator-registry.d.ts

@@ -1,29 +0,0 @@
-import {Service} from '@e22m4u/js-service';
-import {PropertyValidator} from './property-validator.js';
-
-/**
- * Property validator registry.
- */
-export declare class PropertyValidatorRegistry extends Service {
-  /**
-   * Add validator.
-   *
-   * @param name
-   * @param validator
-   */
-  addValidator(name: string, validator: PropertyValidator): this;
-
-  /**
-   * Has validator.
-   *
-   * @param name
-   */
-  hasValidator(name: string): boolean;
-
-  /**
-   * Get validator.
-   *
-   * @param name
-   */
-  getValidator(name: string): PropertyValidator;
-}

package/src/definition/model/properties/property-validator/property-validator-registry.js

@@ -1,76 +0,0 @@
-import {Service} from '@e22m4u/js-service';
-import {regexpValidator} from './builtin/index.js';
-import {maxLengthValidator} from './builtin/index.js';
-import {minLengthValidator} from './builtin/index.js';
-import {InvalidArgumentError} from '../../../../errors/index.js';
-
-/**
- * Property validator registry.
- */
-export class PropertyValidatorRegistry extends Service {
-  /**
-   * Validators.
-   *
-   * @type {object}
-   */
-  _validators = {
-    maxLength: maxLengthValidator,
-    minLength: minLengthValidator,
-    regexp: regexpValidator,
-  };
-
-  /**
-   * Add validator.
-   *
-   * @param {string} name
-   * @param {Function} validator
-   * @returns {PropertyValidatorRegistry}
-   */
-  addValidator(name, validator) {
-    if (!name || typeof name !== 'string')
-      throw new InvalidArgumentError(
-        'A name of the property validator must ' +
-          'be a non-empty String, but %v was given.',
-        name,
-      );
-    if (name in this._validators)
-      throw new InvalidArgumentError(
-        'The property validator %v is already defined.',
-        name,
-      );
-    if (typeof validator !== 'function')
-      throw new InvalidArgumentError(
-        'The property validator %v must be a Function, but %v was given.',
-        name,
-        validator,
-      );
-    this._validators[name] = validator;
-    return this;
-  }
-
-  /**
-   * Has validator.
-   *
-   * @param {string} name
-   * @returns {boolean}
-   */
-  hasValidator(name) {
-    return Boolean(this._validators[name]);
-  }
-
-  /**
-   * Get validator.
-   *
-   * @param {string} name
-   * @returns {Function}
-   */
-  getValidator(name) {
-    const validator = this._validators[name];
-    if (!validator)
-      throw new InvalidArgumentError(
-        'The property validator %v is not defined.',
-        name,
-      );
-    return validator;
-  }
-}

package/src/definition/model/properties/property-validator/property-validator-registry.spec.js

@@ -1,132 +0,0 @@
-import {expect} from 'chai';
-import {format} from '@e22m4u/js-format';
-import {regexpValidator} from './builtin/index.js';
-import {maxLengthValidator} from './builtin/index.js';
-import {minLengthValidator} from './builtin/index.js';
-import {PropertyValidatorRegistry} from './property-validator-registry.js';
-
-describe('PropertyValidatorRegistry', function () {
-  it('has builtin validators', function () {
-    const pvr = new PropertyValidatorRegistry();
-    expect(pvr['_validators']).to.be.eql({
-      maxLength: maxLengthValidator,
-      minLength: minLengthValidator,
-      regexp: regexpValidator,
-    });
-  });
-
-  describe('addValidator', function () {
-    it('adds a given validator with the name', function () {
-      const pvr = new PropertyValidatorRegistry();
-      const myValidator = () => undefined;
-      const res = pvr.addValidator('myValidator', myValidator);
-      expect(res).to.be.eq(pvr);
-      expect(pvr['_validators']['myValidator']).to.be.eq(myValidator);
-    });
-
-    it('requires the given name to be a non-empty string', function () {
-      const pvr = new PropertyValidatorRegistry();
-      const throwable = v => () => pvr.addValidator(v, () => undefined);
-      const error = v =>
-        format(
-          'A name of the property validator must ' +
-            'be a non-empty String, but %s was given.',
-          v,
-        );
-      expect(throwable('')).to.throw(error('""'));
-      expect(throwable(10)).to.throw(error('10'));
-      expect(throwable(0)).to.throw(error('0'));
-      expect(throwable(false)).to.throw(error('false'));
-      expect(throwable(undefined)).to.throw(error('undefined'));
-      expect(throwable(null)).to.throw(error('null'));
-      expect(throwable({})).to.throw(error('Object'));
-      expect(throwable([])).to.throw(error('Array'));
-      expect(throwable(() => undefined)).to.throw(error('Function'));
-      throwable('str')();
-    });
-
-    it('throws an error if the given name already exists', function () {
-      const pvr = new PropertyValidatorRegistry();
-      pvr.addValidator('test', () => undefined);
-      const throwable = () => pvr.addValidator('test', () => undefined);
-      expect(throwable).to.throw(
-        'The property validator "test" is already defined.',
-      );
-    });
-
-    it('requires the given validator to be a function', function () {
-      const pvr = new PropertyValidatorRegistry();
-      const throwable = v => () => pvr.addValidator('test', v);
-      const error = v =>
-        format(
-          'The property validator "test" must be a Function, but %s was given.',
-          v,
-        );
-      expect(throwable('str')).to.throw(error('"str"'));
-      expect(throwable('')).to.throw(error('""'));
-      expect(throwable(10)).to.throw(error('10'));
-      expect(throwable(0)).to.throw(error('0'));
-      expect(throwable(false)).to.throw(error('false'));
-      expect(throwable(undefined)).to.throw(error('undefined'));
-      expect(throwable(null)).to.throw(error('null'));
-      expect(throwable({})).to.throw(error('Object'));
-      expect(throwable([])).to.throw(error('Array'));
-      throwable(() => undefined)();
-    });
-  });
-
-  describe('hasValidator', function () {
-    it('returns false for a not existing name', function () {
-      const pvr = new PropertyValidatorRegistry();
-      expect(pvr.hasValidator('str')).to.be.false;
-      expect(pvr.hasValidator('')).to.be.false;
-      expect(pvr.hasValidator(10)).to.be.false;
-      expect(pvr.hasValidator(0)).to.be.false;
-      expect(pvr.hasValidator(true)).to.be.false;
-      expect(pvr.hasValidator(false)).to.be.false;
-      expect(pvr.hasValidator(null)).to.be.false;
-      expect(pvr.hasValidator(undefined)).to.be.false;
-      expect(pvr.hasValidator({})).to.be.false;
-      expect(pvr.hasValidator([])).to.be.false;
-      expect(pvr.hasValidator(() => undefined)).to.be.false;
-    });
-
-    it('returns true for an existing name', function () {
-      const pvr = new PropertyValidatorRegistry();
-      expect(pvr.hasValidator('test')).to.be.false;
-      pvr.addValidator('test', () => undefined);
-      expect(pvr.hasValidator('test')).to.be.true;
-    });
-  });
-
-  describe('getValidator', function () {
-    it('returns validator by its name', function () {
-      const pvr = new PropertyValidatorRegistry();
-      const myValidator1 = () => undefined;
-      const myValidator2 = () => undefined;
-      pvr.addValidator('foo', myValidator1);
-      pvr.addValidator('bar', myValidator2);
-      const res1 = pvr.getValidator('foo');
-      const res2 = pvr.getValidator('bar');
-      expect(res1).to.be.eq(myValidator1);
-      expect(res2).to.be.eq(myValidator2);
-    });
-
-    it('throws an error for a not existed name', function () {
-      const pvr = new PropertyValidatorRegistry();
-      const throwable = v => () => pvr.getValidator(v);
-      const error = v => format('The property validator %s is not defined.', v);
-      expect(throwable('str')).to.throw(error('"str"'));
-      expect(throwable('')).to.throw(error('""'));
-      expect(throwable(10)).to.throw(error('10'));
-      expect(throwable(0)).to.throw(error('0'));
-      expect(throwable(true)).to.throw(error('true'));
-      expect(throwable(false)).to.throw(error('false'));
-      expect(throwable(null)).to.throw(error('null'));
-      expect(throwable(undefined)).to.throw(error('undefined'));
-      expect(throwable({})).to.throw(error('Object'));
-      expect(throwable([])).to.throw(error('Array'));
-      expect(throwable(() => undefined)).to.throw(error('Function'));
-    });
-  });
-});

package/src/definition/model/properties/property-validator/property-validator.d.ts

@@ -1,25 +0,0 @@
-/**
- * Property validator context.
- */
-export type PropertyValidatorContext = {
-  validatorName: string,
-  modelName: string,
-  propName: string,
-}
-
-/**
- * Property validator.
- */
-export type PropertyValidator = (
-  value: unknown,
-  options: unknown,
-  context: PropertyValidatorContext,
-) => boolean;
-
-/**
- * Property validate options.
- */
-export type PropertyValidateOptions =
-  | (string | PropertyValidator)
-  | (string | PropertyValidator)[]
-  | {[key: string]: unknown};

package/src/definition/model/properties/property-validator/property-validator.js

@@ -1 +0,0 @@
-export {};

package/src/utils/get-ctor-name.d.ts

@@ -1,6 +0,0 @@
-/**
- * Get ctor name.
- *
- * @param value
- */
-export declare function getCtorName(value: unknown): string | undefined;

package/src/utils/get-ctor-name.js

@@ -1,11 +0,0 @@
-/**
- * Get ctor name.
- *
- * @param {*} value
- * @returns {string|undefined}
- */
-export function getCtorName(value) {
-  if (value === null) return 'Null';
-  if (value === undefined) return 'Undefined';
-  return (value.constructor && value.constructor.name) || undefined;
-}

package/src/utils/get-ctor-name.spec.js

@@ -1,17 +0,0 @@
-import {expect} from 'chai';
-import {getCtorName} from './get-ctor-name.js';
-
-describe('getCtorName', function () {
-  it('returns a constructor name of a given value', function () {
-    expect(getCtorName({})).to.be.eq('Object');
-    expect(getCtorName(new Date())).to.be.eq('Date');
-    expect(getCtorName([])).to.be.eq('Array');
-    expect(getCtorName(() => undefined)).to.be.eq('Function');
-    expect(getCtorName('string')).to.be.eq('String');
-    expect(getCtorName(10)).to.be.eq('Number');
-    expect(getCtorName(true)).to.be.eq('Boolean');
-    expect(getCtorName(false)).to.be.eq('Boolean');
-    expect(getCtorName(null)).to.be.eq('Null');
-    expect(getCtorName(undefined)).to.be.eq('Undefined');
-  });
-});

package/src/utils/get-decorator-target-type.d.ts

@@ -1,27 +0,0 @@
-/**
- * Decorator target type.
- */
-export declare enum DecoratorTargetType {
-  CONSTRUCTOR = 'constructor',
-  INSTANCE = 'instance',
-  STATIC_METHOD = 'staticMethod',
-  INSTANCE_METHOD = 'instanceMethod',
-  STATIC_PROPERTY = 'staticProperty',
-  INSTANCE_PROPERTY = 'instanceProperty',
-  CONSTRUCTOR_PARAMETER = 'constructorParameter',
-  STATIC_METHOD_PARAMETER = 'staticMethodParameter',
-  INSTANCE_METHOD_PARAMETER = 'instanceMethodParameter',
-}
-
-/**
- * Get decorator target type.
- *
- * @param target
- * @param propertyKey
- * @param descriptorOrIndex
- */
-export declare function getDecoratorTargetType(
-  target: object,
-  propertyKey?: string,
-  descriptorOrIndex?: PropertyDescriptor | number,
-): DecoratorTargetType;

package/src/utils/get-decorator-target-type.js

@@ -1,63 +0,0 @@
-/**
- * @typedef {object} PropertyDescriptor
- * @property {boolean|undefined} configurable
- * @property {boolean|undefined} enumerable
- * @property {*} value
- * @property {boolean|undefined} writable
- * @property {Function} get
- * @property {Function} set
- */
-
-/**
- * Decorator target type.
- *
- * @enum {string}
- * @property {string} CONSTRUCTOR
- * @property {string} INSTANCE
- * @property {string} STATIC_METHOD
- * @property {string} INSTANCE_METHOD
- * @property {string} STATIC_PROPERTY
- * @property {string} INSTANCE_PROPERTY
- * @property {string} CONSTRUCTOR_PARAMETER
- * @property {string} STATIC_METHOD_PARAMETER
- * @property {string} INSTANCE_METHOD_PARAMETER
- */
-export const DecoratorTargetType = {
-  CONSTRUCTOR: 'constructor',
-  INSTANCE: 'instance',
-  STATIC_METHOD: 'staticMethod',
-  INSTANCE_METHOD: 'instanceMethod',
-  STATIC_PROPERTY: 'staticProperty',
-  INSTANCE_PROPERTY: 'instanceProperty',
-  CONSTRUCTOR_PARAMETER: 'constructorParameter',
-  STATIC_METHOD_PARAMETER: 'staticMethodParameter',
-  INSTANCE_METHOD_PARAMETER: 'instanceMethodParameter',
-};
-
-/**
- * Get decorator target type.
- *
- * @param {object} target
- * @param {string|undefined} propertyKey
- * @param {PropertyDescriptor|number|undefined} descriptorOrIndex
- * @returns {DecoratorTargetType}
- */
-export function getDecoratorTargetType(target, propertyKey, descriptorOrIndex) {
-  const isCtor = typeof target === 'function';
-  const isParameter = typeof descriptorOrIndex === 'number';
-  const isProperty = propertyKey != null && descriptorOrIndex == null;
-  const isMethod = propertyKey != null && descriptorOrIndex != null;
-  const D = DecoratorTargetType;
-  if (isCtor) {
-    if (isParameter)
-      return propertyKey ? D.STATIC_METHOD_PARAMETER : D.CONSTRUCTOR_PARAMETER;
-    if (isProperty) return D.STATIC_PROPERTY;
-    if (isMethod) return D.STATIC_METHOD;
-    return D.CONSTRUCTOR;
-  } else {
-    if (isParameter) return D.INSTANCE_METHOD_PARAMETER;
-    if (isProperty) return D.INSTANCE_PROPERTY;
-    if (isMethod) return D.INSTANCE_METHOD;
-    return D.INSTANCE;
-  }
-}