@e22m4u/js-repository 0.6.5 → 0.8.0

package/src/definition/model/model-definition-utils.d.ts

@@ -1,180 +0,0 @@
-import {ModelData} from '../../types.js';
-import {Service} from '@e22m4u/js-service';
-import {DataType} from './properties/index.js';
-import {RelationDefinition} from './relations/index.js';
-import {PropertyDefinition} from './properties/index.js';
-import {PropertyDefinitionMap} from './model-definition.js';
-import {RelationDefinitionMap} from './model-definition.js';
-
-/**
- * Default primary key property name.
- */
-export const DEFAULT_PRIMARY_KEY_PROPERTY_NAME: 'id';
-
-/**
- * Model definition utils.
- */
-export declare class ModelDefinitionUtils extends Service {
-  /**
-   * Get primary key as property name.
-   *
-   * @param modelName
-   */
-  getPrimaryKeyAsPropertyName(modelName: string): string;
-
-  /**
-   * Get primary key as column name.
-   *
-   * @param modelName
-   */
-  getPrimaryKeyAsColumnName(modelName: string): string;
-
-  /**
-   * Get table name by model name.
-   *
-   * @param modelName
-   */
-  getTableNameByModelName(modelName: string): string;
-
-  /**
-   * Get column name by property name.
-   *
-   * @param modelName
-   * @param propertyName
-   */
-  getColumnNameByPropertyName(modelName: string, propertyName: string): string;
-
-  /**
-   * Get default property value.
-   *
-   * @param modelName
-   * @param propertyName
-   */
-  getDefaultPropertyValue(modelName: string, propertyName: string): unknown;
-
-  /**
-   * Set default values to empty properties.
-   *
-   * @param modelName
-   * @param modelData
-   * @param onlyProvidedProperties
-   */
-  setDefaultValuesToEmptyProperties<T extends ModelData>(
-    modelName: string,
-    modelData: T,
-    onlyProvidedProperties?: boolean,
-  ): T;
-
-  /**
-   * Convert property names to column names.
-   *
-   * @param modelName
-   * @param modelData
-   */
-  convertPropertyNamesToColumnNames(
-    modelName: string,
-    modelData: ModelData,
-  ): ModelData;
-
-  /**
-   * Convert column names to property names.
-   *
-   * @param modelName
-   * @param tableData
-   */
-  convertColumnNamesToPropertyNames(
-    modelName: string,
-    tableData: ModelData,
-  ): ModelData;
-
-  /**
-   * Get data type by property name.
-   *
-   * @param modelName
-   * @param propertyName
-   */
-  getDataTypeByPropertyName(modelName: string, propertyName: string): DataType;
-
-  /**
-   * Get data type from property definition.
-   *
-   * @param propDef
-   */
-  getDataTypeFromPropertyDefinition(propDef: PropertyDefinition): DataType;
-
-  /**
-   * Get own properties definition of primary keys.
-   *
-   * @param modelName
-   */
-  getOwnPropertiesDefinitionOfPrimaryKeys(
-    modelName: string,
-  ): PropertyDefinitionMap;
-
-  /**
-   * Get own properties definition without primary keys.
-   *
-   * @param modelName
-   */
-  getOwnPropertiesDefinitionWithoutPrimaryKeys(
-    modelName: string,
-  ): PropertyDefinitionMap;
-
-  /**
-   * Get properties definition in base model hierarchy.
-   *
-   * @param modelName
-   */
-  getPropertiesDefinitionInBaseModelHierarchy(
-    modelName: string,
-  ): PropertyDefinitionMap;
-
-  /**
-   * Get own relations definition.
-   *
-   * @param modelName
-   */
-  getOwnRelationsDefinition(modelName: string): RelationDefinitionMap;
-
-  /**
-   * Get relations definition in base model hierarchy.
-   *
-   * @param modelName
-   */
-  getRelationsDefinitionInBaseModelHierarchy(
-    modelName: string,
-  ): RelationDefinitionMap;
-
-  /**
-   * Get relation definition by name.
-   *
-   * @param modelName
-   * @param relationName
-   */
-  getRelationDefinitionByName(
-    modelName: string,
-    relationName: string,
-  ): RelationDefinition;
-
-  /**
-   * Exclude object keys by relation names.
-   *
-   * @param modelName
-   * @param modelData
-   */
-  excludeObjectKeysByRelationNames<T extends ModelData>(
-    modelName: string,
-    modelData: T,
-  ): Partial<T>;
-
-  /**
-   * Get model name of property value if defined.
-   *
-   * @param modelName
-   * @param propertyName
-   */
-  getModelNameOfPropertyValueIfDefined(
-    modelName: string,
-    propertyName: string,
-  ): string | undefined;
-}

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

@@ -1,14 +0,0 @@
-import {Service} from '@e22m4u/js-service';
-import {ModelDefinition} from './model-definition.js';
-
-/**
- * Model definition validator.
- */
-export declare class ModelDefinitionValidator extends Service {
-  /**
-   * Validate.
-   *
-   * @param modelDef
-   */
-  validate(modelDef: ModelDefinition): void;
-}

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

@@ -1,28 +0,0 @@
-import {RelationDefinition} from './relations/index.js';
-import {PropertyDefinition} from './properties/index.js';
-
-/**
- * Property definition map.
- */
-export declare type PropertyDefinitionMap = {
-  [name: string]: PropertyDefinition;
-};
-
-/**
- * Relation definition map.
- */
-export declare type RelationDefinitionMap = {
-  [name: string]: RelationDefinition;
-};
-
-/**
- * Model definition.
- */
-export declare type ModelDefinition = {
-  name: string;
-  datasource?: string;
-  base?: string;
-  tableName?: string;
-  properties?: PropertyDefinitionMap;
-  relations?: RelationDefinitionMap;
-};

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

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

package/src/definition/model/properties/data-type.d.ts

@@ -1,16 +0,0 @@
-/**
- * Data type.
- */
-export declare const DataType: {
-  ANY: 'any';
-  STRING: 'string';
-  NUMBER: 'number';
-  BOOLEAN: 'boolean';
-  ARRAY: 'array';
-  OBJECT: 'object';
-};
-
-/**
- * Type of DataType.
- */
-export type DataType = (typeof DataType)[keyof typeof DataType];

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

@@ -1,8 +0,0 @@
-export * from './data-type.js';
-export * from './property-definition.js';
-export * from './property-uniqueness.js';
-export * from './property-validator/index.js';
-export * from './property-transformer/index.js';
-export * from './property-uniqueness-validator.js';
-export * from './properties-definition-validator.js';
-export * from './primary-keys-definition-validator.js';

package/src/definition/model/properties/primary-keys-definition-validator.d.ts

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

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

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

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

@@ -1,27 +0,0 @@
-import {DataType} from './data-type.js';
-import {PropertyUniqueness} from './property-uniqueness.js';
-import {PropertyValidateOptions} from './property-validator/index.js';
-import {PropertyTransformOptions} from './property-transformer/index.js';
-
-/**
- * Full property definition.
- */
-export declare type FullPropertyDefinition = {
-  type: DataType;
-  itemType?: DataType;
-  itemModel?: string;
-  model?: string;
-  primaryKey?: boolean;
-  columnName?: string;
-  columnType?: string;
-  required?: boolean;
-  default?: unknown;
-  validate?: PropertyValidateOptions;
-  transform?: PropertyTransformOptions;
-  unique?: boolean | PropertyUniqueness;
-};
-
-/**
- * Property definition.
- */
-declare type PropertyDefinition = DataType | FullPropertyDefinition;

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

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

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

@@ -1,3 +0,0 @@
-export * from './trim-transformer.js';
-export * from './to-lower-case-transformer.js';
-export * from './to-upper-case-transformer.js';

package/src/definition/model/properties/property-transformer/builtin/index.js

@@ -1,3 +0,0 @@
-export * from './trim-transformer.js';
-export * from './to-lower-case-transformer.js';
-export * from './to-upper-case-transformer.js';

package/src/definition/model/properties/property-transformer/builtin/to-lower-case-transformer.d.ts

@@ -1,6 +0,0 @@
-import {PropertyTransformer} from '../property-transformer.js';
-
-/**
- * To lower case transformer.
- */
-export const toLowerCaseTransformer: PropertyTransformer;

package/src/definition/model/properties/property-transformer/builtin/to-lower-case-transformer.js

@@ -1,19 +0,0 @@
-import {InvalidArgumentError} from '../../../../../errors/index.js';
-
-/**
- * To lower case transformer.
- *
- * @param {*} value
- * @param {undefined} options
- * @param {object} context
- * @returns {string|undefined|null}
- */
-export function toLowerCaseTransformer(value, options, context) {
-  if (value == null) return value;
-  if (typeof value === 'string') return value.toLowerCase();
-  throw new InvalidArgumentError(
-    'The property transformer %v requires a String value, but %v was given.',
-    context.transformerName,
-    value,
-  );
-}

package/src/definition/model/properties/property-transformer/builtin/to-lower-case-transformer.spec.js

@@ -1,39 +0,0 @@
-import {expect} from 'chai';
-import {format} from '@e22m4u/js-format';
-import {toLowerCaseTransformer} from './to-lower-case-transformer.js';
-
-describe('toLowerCaseTransformer', function () {
-  it('returns undefined and null values as is', function () {
-    const res1 = toLowerCaseTransformer(undefined, undefined, {});
-    const res2 = toLowerCaseTransformer(null, undefined, {});
-    expect(res1).to.be.undefined;
-    expect(res2).to.be.null;
-  });
-
-  it('converts the given string to lower case', function () {
-    const res = toLowerCaseTransformer('TEST', undefined, {});
-    expect(res).to.be.eq('test');
-  });
-
-  it('throws an error if the given value is not a string', function () {
-    const throwable = v => () =>
-      toLowerCaseTransformer(v, undefined, {
-        transformerName: 'toLowerCase',
-      });
-    const error = v =>
-      format(
-        'The property transformer "toLowerCase" requires a String 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([])).to.throw(error('Array'));
-    throwable('str')();
-    throwable('')();
-    throwable(undefined)();
-    throwable(null)();
-  });
-});

package/src/definition/model/properties/property-transformer/builtin/to-upper-case-transformer.d.ts

@@ -1,6 +0,0 @@
-import {PropertyTransformer} from '../property-transformer.js';
-
-/**
- * To upper case transformer.
- */
-export const toUpperCaseTransformer: PropertyTransformer;

package/src/definition/model/properties/property-transformer/builtin/to-upper-case-transformer.js

@@ -1,19 +0,0 @@
-import {InvalidArgumentError} from '../../../../../errors/index.js';
-
-/**
- * To upper case transformer.
- *
- * @param {*} value
- * @param {undefined} options
- * @param {object} context
- * @returns {string|undefined|null}
- */
-export function toUpperCaseTransformer(value, options, context) {
-  if (value == null) return value;
-  if (typeof value === 'string') return value.toUpperCase();
-  throw new InvalidArgumentError(
-    'The property transformer %v requires a String value, but %v was given.',
-    context.transformerName,
-    value,
-  );
-}

package/src/definition/model/properties/property-transformer/builtin/to-upper-case-transformer.spec.js

@@ -1,39 +0,0 @@
-import {expect} from 'chai';
-import {format} from '@e22m4u/js-format';
-import {toUpperCaseTransformer} from './to-upper-case-transformer.js';
-
-describe('toUpperCaseTransformer', function () {
-  it('returns undefined and null values as is', function () {
-    const res1 = toUpperCaseTransformer(undefined, undefined, {});
-    const res2 = toUpperCaseTransformer(null, undefined, {});
-    expect(res1).to.be.undefined;
-    expect(res2).to.be.null;
-  });
-
-  it('converts the given string to upper case', function () {
-    const res = toUpperCaseTransformer('test', undefined, {});
-    expect(res).to.be.eq('TEST');
-  });
-
-  it('throws an error if the given value is not a string', function () {
-    const throwable = v => () =>
-      toUpperCaseTransformer(v, undefined, {
-        transformerName: 'toUpperCase',
-      });
-    const error = v =>
-      format(
-        'The property transformer "toUpperCase" requires a String 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([])).to.throw(error('Array'));
-    throwable('str')();
-    throwable('')();
-    throwable(undefined)();
-    throwable(null)();
-  });
-});

package/src/definition/model/properties/property-transformer/builtin/trim-transformer.d.ts

@@ -1,6 +0,0 @@
-import {PropertyTransformer} from '../property-transformer.js';
-
-/**
- * Trim transformer.
- */
-export declare type trimTransformer = PropertyTransformer;

package/src/definition/model/properties/property-transformer/builtin/trim-transformer.js

@@ -1,19 +0,0 @@
-import {InvalidArgumentError} from '../../../../../errors/index.js';
-
-/**
- * Trim transformer.
- *
- * @param {*} value
- * @param {undefined} options
- * @param {object} context
- * @returns {string|undefined|null}
- */
-export function trimTransformer(value, options, context) {
-  if (value == null) return value;
-  if (typeof value === 'string') return value.trim();
-  throw new InvalidArgumentError(
-    'The property transformer %v requires a String value, but %v was given.',
-    context.transformerName,
-    value,
-  );
-}

package/src/definition/model/properties/property-transformer/builtin/trim-transformer.spec.js

@@ -1,39 +0,0 @@
-import {expect} from 'chai';
-import {format} from '@e22m4u/js-format';
-import {trimTransformer} from './trim-transformer.js';
-
-describe('trimTransformer', function () {
-  it('returns undefined and null values as is', function () {
-    const res1 = trimTransformer(undefined, undefined, {});
-    const res2 = trimTransformer(null, undefined, {});
-    expect(res1).to.be.undefined;
-    expect(res2).to.be.null;
-  });
-
-  it('trims the given string', function () {
-    const res = trimTransformer(' test ', undefined, {});
-    expect(res).to.be.eq('test');
-  });
-
-  it('throws an error if the given value is not a string', function () {
-    const throwable = v => () =>
-      trimTransformer(v, undefined, {
-        transformerName: 'trim',
-      });
-    const error = v =>
-      format(
-        'The property transformer "trim" requires a String 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([])).to.throw(error('Array'));
-    throwable('str')();
-    throwable('')();
-    throwable(undefined)();
-    throwable(null)();
-  });
-});

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

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

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

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

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

@@ -1,29 +0,0 @@
-import {Service} from '@e22m4u/js-service';
-import {PropertyTransformer} from './property-transformer.js';
-
-/**
- * Property transformer registry.
- */
-export declare class PropertyTransformerRegistry extends Service {
-  /**
-   * Add transformer.
-   *
-   * @param name
-   * @param transformer
-   */
-  addTransformer(name: string, transformer: PropertyTransformer): this;
-
-  /**
-   * Has transformer.
-   *
-   * @param name
-   */
-  hasTransformer(name: string): boolean;
-
-  /**
-   * Get transformer.
-   *
-   * @param name
-   */
-  getTransformer(name: string): PropertyTransformer;
-}

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

@@ -1,76 +0,0 @@
-import {Service} from '@e22m4u/js-service';
-import {trimTransformer} from './builtin/index.js';
-import {toUpperCaseTransformer} from './builtin/index.js';
-import {toLowerCaseTransformer} from './builtin/index.js';
-import {InvalidArgumentError} from '../../../../errors/index.js';
-
-/**
- * Property transformer registry.
- */
-export class PropertyTransformerRegistry extends Service {
-  /**
-   * Transformers.
-   *
-   * @type {object}
-   */
-  _transformers = {
-    trim: trimTransformer,
-    toUpperCase: toUpperCaseTransformer,
-    toLowerCase: toLowerCaseTransformer,
-  };
-
-  /**
-   * Add transformer.
-   *
-   * @param {string} name
-   * @param {Function} transformer
-   * @returns {PropertyTransformerRegistry}
-   */
-  addTransformer(name, transformer) {
-    if (!name || typeof name !== 'string')
-      throw new InvalidArgumentError(
-        'A name of the property transformer must ' +
-          'be a non-empty String, but %v was given.',
-        name,
-      );
-    if (name in this._transformers)
-      throw new InvalidArgumentError(
-        'The property transformer %v is already defined.',
-        name,
-      );
-    if (typeof transformer !== 'function')
-      throw new InvalidArgumentError(
-        'The property transformer %v must be a Function, but %v was given.',
-        name,
-        transformer,
-      );
-    this._transformers[name] = transformer;
-    return this;
-  }
-
-  /**
-   * Has transformer.
-   *
-   * @param {string} name
-   * @returns {boolean}
-   */
-  hasTransformer(name) {
-    return Boolean(this._transformers[name]);
-  }
-
-  /**
-   * Get transformer.
-   *
-   * @param {string} name
-   * @returns {Function}
-   */
-  getTransformer(name) {
-    const transformer = this._transformers[name];
-    if (!transformer)
-      throw new InvalidArgumentError(
-        'The property transformer %v is not defined.',
-        name,
-      );
-    return transformer;
-  }
-}