@e22m4u/js-repository 0.6.5 → 0.8.0

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/definition/model/relations/index.d.ts

@@ -1,3 +0,0 @@
-export * from './relation-type.js';
-export * from './relation-definition.js';
-export * from './relations-definition-validator.js';

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

@@ -1,236 +0,0 @@
-import {RelationType} from './relation-type.js';
-
-/**
- * Relation definition.
- *
- * @example Available options.
- * ```ts
- * {
- *   type: RelationType;
- *   model?: string;
- *   foreignKey?: string;
- *   polymorphic?: boolean | string;
- *   discriminator?: string;
- * }
- * ```
- */
-export declare type RelationDefinition =
-  // belongsTo
-  | BelongsToDefinition
-  | PolyBelongsToDefinition
-  // hasOne
-  | HasOneDefinition
-  | PolyHasOneDefinitionWithTargetRelationName
-  | PolyHasOneDefinitionWithTargetKeys
-  // hasMany
-  | HasManyDefinition
-  | PolyHasManyDefinitionWithTargetRelationName
-  | PolyHasManyDefinitionWithTargetKeys
-  // referencesMany
-  | ReferencesManyDefinition;
-
-/**
- * The regular "belongsTo" relation.
- *
- * @example Required options only.
- * ```
- * {
- *   type: 'belongsTo',
- *   model: 'model',
- * }
- * ```
- *
- * @example Verbose definition.
- * ```
- * {
- *   type: 'belongsTo',
- *   model: 'model',
- *   foreignKey: 'modelId',
- * }
- * ```
- */
-export declare type BelongsToDefinition = {
-  type: typeof RelationType.BELONGS_TO;
-  polymorphic?: false;
-  model: string;
-  foreignKey?: string;
-};
-
-/**
- * The polymorphic "belongsTo" relation.
- *
- * @example Required fields only.
- * ```
- * {
- *   type: 'belongsTo',
- *   polymorphic: true,
- * }
- * ```
- *
- * @example Verbose definition.
- * ```
- * {
- *   type: 'belongsTo',
- *   polymorphic: true,
- *   foreignKey: 'referenceId',
- *   discriminator: 'referenceType',
- * }
- * ```
- */
-export declare type PolyBelongsToDefinition = {
-  type: typeof RelationType.BELONGS_TO;
-  polymorphic: true;
-  foreignKey?: string;
-  discriminator?: string;
-};
-
-/**
- * The regular "hasOne" relation.
- *
- * @example
- * ```ts
- * {
- *   type: 'hasOne',
- *   model: 'model',
- *   foreignKey: 'modelId',
- * }
- * ```
- */
-export declare type HasOneDefinition = {
-  type: typeof RelationType.HAS_ONE;
-  model: string;
-  foreignKey: string;
-  polymorphic?: false;
-  discriminator?: undefined;
-};
-
-/**
- * The polymorphic "hasOne" relation with a target relation name.
- *
- * @example
- * ```ts
- * {
- *   type: 'hasOne',
- *   model: 'model',
- *   polymorphic: 'reference',
- * }
- * ```
- */
-export declare type PolyHasOneDefinitionWithTargetRelationName = {
-  type: typeof RelationType.HAS_ONE;
-  model: string;
-  polymorphic: string;
-  foreignKey?: undefined;
-  discriminator?: undefined;
-};
-
-/**
- * The polymorphic "hasOne" relation with target relation keys.
- *
- * @example
- * ```
- * {
- *   type: 'hasOne',
- *   model: 'model',
- *   polymorphic: true,
- *   foreignKey: 'referenceId',
- *   discriminator: 'referenceType',
- * }
- * ```
- */
-export declare type PolyHasOneDefinitionWithTargetKeys = {
-  type: typeof RelationType.HAS_ONE;
-  model: string;
-  polymorphic: true;
-  foreignKey: string;
-  discriminator: string;
-};
-
-/**
- * The regular "hasMany" relation.
- *
- * @example
- * ```ts
- * {
- *   type: 'hasMany',
- *   model: 'model',
- *   foreignKey: 'modelId',
- * }
- * ```
- */
-export declare type HasManyDefinition = {
-  type: typeof RelationType.HAS_MANY;
-  model: string;
-  foreignKey: string;
-  polymorphic?: false;
-  discriminator?: undefined;
-};
-
-/**
- * The polymorphic "hasMany" relation with a target relation name.
- *
- * @example
- * ```ts
- * {
- *   type: 'hasMany',
- *   model: 'model',
- *   polymorphic: 'reference',
- * }
- * ```
- */
-export declare type PolyHasManyDefinitionWithTargetRelationName = {
-  type: typeof RelationType.HAS_MANY;
-  model: string;
-  polymorphic: string;
-  foreignKey?: undefined;
-  discriminator?: undefined;
-};
-
-/**
- * The polymorphic "hasMany" relation with target relation keys.
- *
- * @example
- * ```
- * {
- *   type: 'hasMany',
- *   model: 'model',
- *   polymorphic: true,
- *   foreignKey: 'referenceId',
- *   discriminator: 'referenceType',
- * }
- * ```
- */
-export declare type PolyHasManyDefinitionWithTargetKeys = {
-  type: typeof RelationType.HAS_MANY;
-  model: string;
-  polymorphic: true;
-  foreignKey: string;
-  discriminator: string;
-};
-
-/**
- * The regular "referencesMany" relation.
- *
- * @example Required options only.
- * ```
- * {
- *   type: 'referencesMany',
- *   model: 'model',
- * }
- * ```
- *
- * @example Verbose definition.
- * ```
- * {
- *   type: 'referencesMany',
- *   model: 'model',
- *   foreignKey: 'modelIds',
- * }
- * ```
- */
-export declare type ReferencesManyDefinition = {
-  type: typeof RelationType.REFERENCES_MANY;
-  model: string;
-  foreignKey?: string;
-  discriminator?: undefined;
-};

package/src/definition/model/relations/relation-definition.js

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

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

@@ -1,14 +0,0 @@
-/**
- * Relation type.
- */
-export declare const RelationType: {
-  BELONGS_TO: 'belongsTo';
-  HAS_ONE: 'hasOne';
-  HAS_MANY: 'hasMany';
-  REFERENCES_MANY: 'referencesMany';
-};
-
-/**
- * Type of RelationType.
- */
-export type RelationType = (typeof RelationType)[keyof typeof RelationType];

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

@@ -1,15 +0,0 @@
-import {Service} from '@e22m4u/js-service';
-import {RelationDefinitionMap} from '../model-definition.js';
-
-/**
- * Relations definition validator.
- */
-export declare class RelationsDefinitionValidator extends Service {
-  /**
-   * Validate.
-   *
-   * @param modelName
-   * @param relDefs
-   */
-  validate(modelName: string, relDefs: RelationDefinitionMap): void;
-}

package/src/errors/index.d.ts

@@ -1,3 +0,0 @@
-export * from './not-implemented-error.js';
-export * from './invalid-argument-error.js';
-export * from './invalid-operator-value-error.js';

package/src/errors/invalid-argument-error.d.ts

@@ -1,6 +0,0 @@
-import {Errorf} from '@e22m4u/js-format';
-
-/**
- * Invalid argument error.
- */
-export declare class InvalidArgumentError extends Errorf {}

package/src/errors/invalid-operator-value-error.d.ts

@@ -1,13 +0,0 @@
-/**
- * Invalid operator value error.
- */
-export declare class InvalidOperatorValueError extends Error {
-  /**
-   * Constructor.
-   *
-   * @param operator
-   * @param expects
-   * @param value
-   */
-  constructor(operator: string, expects: string, value: unknown);
-}

package/src/errors/not-implemented-error.d.ts

@@ -1,6 +0,0 @@
-import {Errorf} from '@e22m4u/js-format';
-
-/**
- * Not implemented error.
- */
-export declare class NotImplementedError extends Errorf {}

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

@@ -1,38 +0,0 @@
-import {ModelData} from '../types.js';
-import {Service} from '@e22m4u/js-service';
-import {FieldsClause} from './filter-clause.js';
-import {NormalizedFieldsClause} from './filter-clause.js';
-
-/**
- * Field clause tool.
- */
-export declare class FieldsClauseTool extends Service {
-  /**
-   * Filter.
-   *
-   * @param input
-   * @param modelName
-   * @param clause
-   */
-  filter<T extends ModelData | ModelData[]>(
-    input: T,
-    modelName: string,
-    clause: FieldsClause | undefined,
-  ): T;
-
-  /**
-   * Validate fields clause.
-   *
-   * @param clause
-   */
-  static validateFieldsClause(clause: FieldsClause | undefined): void;
-
-  /**
-   * Normalize fields clause.
-   *
-   * @param clause
-   */
-  static normalizeFieldsClause(
-    clause: FieldsClause | undefined,
-  ): NormalizedFieldsClause | undefined;
-}