@e22m4u/js-repository 0.7.0 → 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,6 +0,0 @@
-export * from './data-type.js';
-export * from './property-definition.js';
-export * from './property-uniqueness.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,23 +0,0 @@
-import {DataType} from './data-type.js';
-import {PropertyUniqueness} from './property-uniqueness.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;
-  unique?: boolean | PropertyUniqueness;
-};
-
-/**
- * Property definition.
- */
-export declare type PropertyDefinition = DataType | FullPropertyDefinition;

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

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

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

@@ -1,31 +0,0 @@
-import {ModelId} from '../../../types.js';
-import {Service} from '@e22m4u/js-service';
-import {ModelData} from '../../../types.js';
-import {WhereClause} from '../../../filter/index.js';
-
-/**
- * Count method.
- */
-type CountMethod = (where: WhereClause) => Promise<number>;
-
-/**
- * Property uniqueness validator.
- */
-export declare class PropertyUniquenessValidator extends Service {
-  /**
-   * Validate.
-   *
-   * @param countMethod
-   * @param methodName
-   * @param modelName
-   * @param modelData
-   * @param modelId
-   */
-  validate(
-    countMethod: CountMethod,
-    methodName: string,
-    modelName: string,
-    modelData: ModelData,
-    modelId?: ModelId,
-  ): Promise<void>;
-}

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

@@ -1,14 +0,0 @@
-/**
- * Property uniqueness.
- */
-export declare const PropertyUniqueness: {
-  STRICT: 'strict';
-  SPARSE: 'sparse';
-  NON_UNIQUE: 'nonUnique';
-};
-
-/**
- * Type of PropertyUniqueness.
- */
-export type PropertyUniqueness =
-  (typeof PropertyUniqueness)[keyof typeof PropertyUniqueness];

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 {}