@e22m4u/js-repository 0.8.0 → 0.8.1

package/src/adapter/adapter.d.ts

@@ -0,0 +1,153 @@
+import {ModelId} from '../types.js';
+import {AnyObject} from '../types.js';
+import {ModelData} from '../types.js';
+import {Service} from '@e22m4u/js-service';
+import {WhereClause} from '../filter/index.js';
+import {FilterClause} from '../filter/index.js';
+import {ItemFilterClause} from '../filter/index.js';
+import {ServiceContainer} from '@e22m4u/js-service';
+
+/**
+ * Adapter.
+ */
+export declare class Adapter extends Service {
+  /**
+   * Kinds.
+   */
+  static kinds: string[];
+
+  /**
+   * Settings.
+   */
+  get settings(): AnyObject | undefined;
+
+  /**
+   * Constructor.
+   *
+   * @param container
+   * @param settings
+   */
+  constructor(container?: ServiceContainer, settings?: AnyObject);
+
+  /**
+   * Create.
+   *
+   * @param modelName
+   * @param modelData
+   * @param filter
+   */
+  create(
+    modelName: string,
+    modelData: ModelData,
+    filter?: ItemFilterClause,
+  ): Promise<ModelData>;
+
+  /**
+   * Replace by id.
+   *
+   * @param modelName
+   * @param id
+   * @param modelData
+   * @param filter
+   */
+  replaceById(
+    modelName: string,
+    id: ModelId,
+    modelData: ModelData,
+    filter?: ItemFilterClause,
+  ): Promise<ModelData>;
+
+  /**
+   * Replace or create.
+   *
+   * @param modelName
+   * @param modelData
+   * @param filter
+   */
+  replaceOrCreate(
+    modelName: string,
+    modelData: ModelData,
+    filter?: ItemFilterClause,
+  ): Promise<ModelData>;
+
+  /**
+   * Patch.
+   *
+   * @param modelName
+   * @param modelData
+   * @param where
+   */
+  patch(
+    modelName: string,
+    modelData: ModelData,
+    where?: WhereClause,
+  ): Promise<number>;
+
+  /**
+   * Patch by id.
+   *
+   * @param modelName
+   * @param id
+   * @param modelData
+   * @param filter
+   */
+  patchById(
+    modelName: string,
+    id: ModelId,
+    modelData: ModelData,
+    filter?: ItemFilterClause,
+  ): Promise<ModelData>;
+
+  /**
+   * Find.
+   *
+   * @param modelName
+   * @param filter
+   */
+  find(modelName: string, filter?: FilterClause): Promise<ModelData[]>;
+
+  /**
+   * Find by id.
+   *
+   * @param modelName
+   * @param id
+   * @param filter
+   */
+  findById(
+    modelName: string,
+    id: ModelId,
+    filter?: ItemFilterClause,
+  ): Promise<ModelData>;
+
+  /**
+   * Delete.
+   *
+   * @param modelName
+   * @param where
+   */
+  delete(modelName: string, where?: WhereClause): Promise<number>;
+
+  /**
+   * Delete by id.
+   *
+   * @param modelName
+   * @param id
+   */
+  deleteById(modelName: string, id: ModelId): Promise<boolean>;
+
+  /**
+   * Exists.
+   *
+   * @param modelName
+   * @param id
+   */
+  exists(modelName: string, id: ModelId): Promise<boolean>;
+
+  /**
+   * Count.
+   *
+   * @param modelName
+   * @param where
+   */
+  count(modelName: string, where?: WhereClause): Promise<number>;
+}

package/src/adapter/builtin/memory-adapter.d.ts

@@ -0,0 +1,148 @@
+import {Adapter} from '../adapter.js';
+import {ModelId} from '../../types.js';
+import {AnyObject} from '../../types.js';
+import {ModelData} from '../../types.js';
+import {WhereClause} from '../../filter/index.js';
+import {FilterClause} from '../../filter/index.js';
+import {ServiceContainer} from '@e22m4u/js-service';
+import {ItemFilterClause} from '../../filter/index.js';
+
+/**
+ * Memory adapter.
+ */
+export declare class MemoryAdapter extends Adapter {
+  /**
+   * Settings.
+   */
+  get settings(): AnyObject | undefined;
+
+  /**
+   * Constructor.
+   *
+   * @param container
+   * @param settings
+   */
+  constructor(container?: ServiceContainer, settings?: AnyObject);
+
+  /**
+   * Create.
+   *
+   * @param modelName
+   * @param modelData
+   * @param filter
+   */
+  create(
+    modelName: string,
+    modelData: ModelData,
+    filter?: ItemFilterClause,
+  ): Promise<ModelData>;
+
+  /**
+   * Replace by id.
+   *
+   * @param modelName
+   * @param id
+   * @param modelData
+   * @param filter
+   */
+  replaceById(
+    modelName: string,
+    id: ModelId,
+    modelData: ModelData,
+    filter?: ItemFilterClause,
+  ): Promise<ModelData>;
+
+  /**
+   * Replace or create.
+   *
+   * @param modelName
+   * @param modelData
+   * @param filter
+   */
+  replaceOrCreate(
+    modelName: string,
+    modelData: ModelData,
+    filter?: ItemFilterClause,
+  ): Promise<ModelData>;
+
+  /**
+   * Patch.
+   *
+   * @param modelName
+   * @param modelData
+   * @param where
+   */
+  patch(
+    modelName: string,
+    modelData: ModelData,
+    where?: WhereClause,
+  ): Promise<number>;
+
+  /**
+   * Patch by id.
+   *
+   * @param modelName
+   * @param id
+   * @param modelData
+   * @param filter
+   */
+  patchById(
+    modelName: string,
+    id: ModelId,
+    modelData: ModelData,
+    filter?: ItemFilterClause,
+  ): Promise<ModelData>;
+
+  /**
+   * Find.
+   *
+   * @param modelName
+   * @param filter
+   */
+  find(modelName: string, filter?: FilterClause): Promise<ModelData[]>;
+
+  /**
+   * Find by id.
+   *
+   * @param modelName
+   * @param id
+   * @param filter
+   */
+  findById(
+    modelName: string,
+    id: ModelId,
+    filter?: ItemFilterClause,
+  ): Promise<ModelData>;
+
+  /**
+   * Delete.
+   *
+   * @param modelName
+   * @param where
+   */
+  delete(modelName: string, where?: WhereClause): Promise<number>;
+
+  /**
+   * Delete by id.
+   *
+   * @param modelName
+   * @param id
+   */
+  deleteById(modelName: string, id: ModelId): Promise<boolean>;
+
+  /**
+   * Exists.
+   *
+   * @param modelName
+   * @param id
+   */
+  exists(modelName: string, id: ModelId): Promise<boolean>;
+
+  /**
+   * Count.
+   *
+   * @param modelName
+   * @param where
+   */
+  count(modelName: string, where?: WhereClause): Promise<number>;
+}

package/src/adapter/builtin/memory-adapter.js

@@ -1,6 +1,6 @@
 import {Adapter} from '../adapter.js';
-import {cloneDeep, capitalize} from '../../utils/index.js';
 import {InvalidArgumentError} from '../../errors/index.js';
+import {cloneDeep, capitalize} from '../../utils/index.js';
 import {DataType, ModelDefinitionUtils} from '../../definition/index.js';
 
 import {

package/src/adapter/decorator/data-sanitizing-decorator.d.ts

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

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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,14 @@
+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

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

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

@@ -0,0 +1,14 @@
+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

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

package/src/database-schema.d.ts

@@ -0,0 +1,37 @@
+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

@@ -0,0 +1,14 @@
+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

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

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

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

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

@@ -0,0 +1,50 @@
+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

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

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

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

package/src/definition/model/index.js

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

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

@@ -0,0 +1,15 @@
+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;
+}