Browse Source

fix: typings

e22m4u 2 years ago
parent
commit
1041c165ea

+ 11 - 7
src/adapter/adapter.d.ts

@@ -1,10 +1,10 @@
 import {ModelId} from '../types.js';
 import {AnyObject} from '../types.js';
 import {ModelData} from '../types.js';
-import {Filter} from '../filter/index.js';
 import {Service} from '@e22m4u/js-service';
-import {ItemFilter} from '../filter/index.js';
 import {WhereClause} from '../filter/index.js';
+import {FilterClause} from '../filter/index.js';
+import {ItemFilterClause} from '../filter/index.js';
 import {ServiceContainer} from '@e22m4u/js-service';
 
 /**
@@ -34,7 +34,7 @@ export declare class Adapter extends Service {
   create(
     modelName: string,
     modelData: ModelData,
-    filter?: ItemFilter,
+    filter?: ItemFilterClause,
   ): Promise<ModelData>;
 
   /**
@@ -49,7 +49,7 @@ export declare class Adapter extends Service {
     modelName: string,
     id: ModelId,
     modelData: ModelData,
-    filter?: ItemFilter,
+    filter?: ItemFilterClause,
   ): Promise<ModelData>;
 
   /**
@@ -64,7 +64,7 @@ export declare class Adapter extends Service {
     modelName: string,
     id: ModelId,
     modelData: ModelData,
-    filter?: ItemFilter,
+    filter?: ItemFilterClause,
   ): Promise<ModelData>;
 
   /**
@@ -73,7 +73,7 @@ export declare class Adapter extends Service {
    * @param modelName
    * @param filter
    */
-  find(modelName: string, filter?: Filter): Promise<ModelData[]>;
+  find(modelName: string, filter?: FilterClause): Promise<ModelData[]>;
 
   /**
    * Find by id.
@@ -82,7 +82,11 @@ export declare class Adapter extends Service {
    * @param id
    * @param filter
    */
-  findById(modelName: string, id: ModelId, filter?: Filter): Promise<ModelData>;
+  findById(
+    modelName: string,
+    id: ModelId,
+    filter?: ItemFilterClause,
+  ): Promise<ModelData>;
 
   /**
    * Delete.

+ 11 - 7
src/adapter/builtin/memory-adapter.d.ts

@@ -2,10 +2,10 @@ import {Adapter} from '../adapter.js';
 import {ModelId} from '../../types.js';
 import {AnyObject} from '../../types.js';
 import {ModelData} from '../../types.js';
-import {Filter} from '../../filter/index.js';
-import {ItemFilter} from '../../filter/index.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.
@@ -34,7 +34,7 @@ export declare class MemoryAdapter extends Adapter {
   create(
     modelName: string,
     modelData: ModelData,
-    filter?: ItemFilter,
+    filter?: ItemFilterClause,
   ): Promise<ModelData>;
 
   /**
@@ -49,7 +49,7 @@ export declare class MemoryAdapter extends Adapter {
     modelName: string,
     id: ModelId,
     modelData: ModelData,
-    filter?: ItemFilter,
+    filter?: ItemFilterClause,
   ): Promise<ModelData>;
 
   /**
@@ -64,7 +64,7 @@ export declare class MemoryAdapter extends Adapter {
     modelName: string,
     id: ModelId,
     modelData: ModelData,
-    filter?: ItemFilter,
+    filter?: ItemFilterClause,
   ): Promise<ModelData>;
 
   /**
@@ -73,7 +73,7 @@ export declare class MemoryAdapter extends Adapter {
    * @param modelName
    * @param filter
    */
-  find(modelName: string, filter?: Filter): Promise<ModelData[]>;
+  find(modelName: string, filter?: FilterClause): Promise<ModelData[]>;
 
   /**
    * Find by id.
@@ -82,7 +82,11 @@ export declare class MemoryAdapter extends Adapter {
    * @param id
    * @param filter
    */
-  findById(modelName: string, id: ModelId, filter?: Filter): Promise<ModelData>;
+  findById(
+    modelName: string,
+    id: ModelId,
+    filter?: ItemFilterClause,
+  ): Promise<ModelData>;
 
   /**
    * Delete.

+ 2 - 2
src/filter/fields-clause-tool.d.ts

@@ -1,7 +1,7 @@
 import {ModelData} from '../types.js';
-import {FieldsClause} from './filter.js';
 import {Service} from '@e22m4u/js-service';
-import {NormalizedFieldsClause} from './filter.js';
+import {FieldsClause} from './filter-clause.js';
+import {NormalizedFieldsClause} from './filter-clause.js';
 
 /**
  * Field clause tool.

+ 5 - 5
src/filter/filter.d.ts → src/filter/filter-clause.d.ts

@@ -1,9 +1,9 @@
 import {ModelData} from '../types.js';
 
 /**
- * Filter.
+ * Filter clause.
  */
-export declare type Filter = {
+export declare type FilterClause = {
   where?: WhereClause;
   order?: OrderClause;
   limit?: number;
@@ -13,9 +13,9 @@ export declare type Filter = {
 };
 
 /**
- * Item filter.
+ * Item filter clause.
  */
-export declare type ItemFilter = Pick<Filter, 'fields' | 'include'>;
+export declare type ItemFilterClause = Pick<FilterClause, 'fields' | 'include'>;
 
 /**
  * Where clause.
@@ -331,5 +331,5 @@ export declare type NestedIncludeClause = {
  */
 export declare type NormalizedIncludeClause = {
   relation: string;
-  scope?: Filter;
+  scope?: FilterClause;
 };

+ 7 - 5
src/filter/include-clause-tool.d.ts

@@ -1,8 +1,8 @@
-import {Filter} from './filter.js';
 import {ModelData} from '../types.js';
-import {IncludeClause} from './filter.js';
 import {Service} from '@e22m4u/js-service';
-import {NormalizedIncludeClause} from './filter.js';
+import {FilterClause} from './filter-clause.js';
+import {IncludeClause} from './filter-clause.js';
+import {NormalizedIncludeClause} from './filter-clause.js';
 
 /**
  * Include clause tool.
@@ -33,7 +33,7 @@ export declare class IncludeClauseTool extends Service {
    *
    * @param clause
    */
-  static validateScopeClause(clause: Filter | undefined): void;
+  static validateScopeClause(clause: FilterClause | undefined): void;
 
   /**
    * Normalize include clause.
@@ -49,5 +49,7 @@ export declare class IncludeClauseTool extends Service {
    *
    * @param clause
    */
-  static normalizeScopeClause(clause: Filter | undefined): Filter | undefined;
+  static normalizeScopeClause(
+    clause: FilterClause | undefined,
+  ): FilterClause | undefined;
 }

+ 1 - 1
src/filter/index.d.ts

@@ -1,4 +1,4 @@
-export * from './filter.js';
+export * from './filter-clause.js';
 export * from './slice-clause-tool.js';
 export * from './order-clause-tool.js';
 export * from './where-clause-tool.js';

+ 1 - 1
src/filter/order-clause-tool.d.ts

@@ -1,6 +1,6 @@
 import {ModelData} from '../types.js';
-import {OrderClause} from './filter.js';
 import {Service} from '@e22m4u/js-service';
+import {OrderClause} from './filter-clause.js';
 
 /**
  * Order clause tool.

+ 1 - 1
src/filter/slice-clause-tool.js

@@ -6,7 +6,7 @@ import {InvalidArgumentError} from '../errors/index.js';
  */
 export class SliceClauseTool extends Service {
   /**
-   * Filter.
+   * Slice.
    *
    * @param {object[]} entities
    * @param {number|undefined} skip

+ 1 - 1
src/filter/where-clause-tool.d.ts

@@ -1,6 +1,6 @@
 import {ModelData} from '../types.js';
-import {WhereClause} from './filter.js';
 import {Service} from '@e22m4u/js-service';
+import {WhereClause} from './filter-clause.js';
 
 /**
  * Where clause tool.

+ 3 - 3
src/relations/belongs-to-resolver.d.ts

@@ -1,6 +1,6 @@
 import {ModelData} from '../types.js';
-import {Filter} from '../filter/index.js';
 import {Service} from '@e22m4u/js-service';
+import {FilterClause} from '../filter/index.js';
 
 /**
  * Belongs to resolver.
@@ -22,7 +22,7 @@ export declare class BelongsToResolver extends Service {
     targetName: string,
     relationName: string,
     foreignKey?: string,
-    scope?: Filter,
+    scope?: FilterClause,
   ): Promise<void>;
 
   /**
@@ -41,6 +41,6 @@ export declare class BelongsToResolver extends Service {
     relationName: string,
     foreignKey?: string,
     discriminator?: string,
-    scope?: Filter,
+    scope?: FilterClause,
   ): Promise<void>;
 }

+ 4 - 4
src/relations/has-many-resolver.d.ts

@@ -1,6 +1,6 @@
 import {ModelData} from '../types.js';
-import {Filter} from '../filter/index.js';
 import {Service} from '@e22m4u/js-service';
+import {FilterClause} from '../filter/index.js';
 
 /**
  * Has many resolver.
@@ -22,7 +22,7 @@ export declare class HasManyResolver extends Service {
     targetName: string,
     relationName: string,
     foreignKey: string,
-    scope?: Filter,
+    scope?: FilterClause,
   ): Promise<void>;
 
   /**
@@ -43,7 +43,7 @@ export declare class HasManyResolver extends Service {
     relationName: string,
     foreignKey: string,
     discriminator: string,
-    scope?: Filter,
+    scope?: FilterClause,
   ): Promise<void>;
 
   /**
@@ -62,6 +62,6 @@ export declare class HasManyResolver extends Service {
     targetName: string,
     relationName: string,
     targetRelationName: string,
-    scope?: Filter,
+    scope?: FilterClause,
   ): Promise<void>;
 }

+ 4 - 4
src/relations/has-one-resolver.d.ts

@@ -1,6 +1,6 @@
 import {ModelData} from '../types.js';
-import {Filter} from '../filter/index.js';
 import {Service} from '@e22m4u/js-service';
+import {FilterClause} from '../filter/index.js';
 
 /**
  * Has one resolver.
@@ -22,7 +22,7 @@ export declare class HasOneResolver extends Service {
     targetName: string,
     relationName: string,
     foreignKey: string,
-    scope?: Filter,
+    scope?: FilterClause,
   ): Promise<void>;
 
   /**
@@ -43,7 +43,7 @@ export declare class HasOneResolver extends Service {
     relationName: string,
     foreignKey: string,
     discriminator: string,
-    scope?: Filter,
+    scope?: FilterClause,
   ): Promise<void>;
 
   /**
@@ -62,6 +62,6 @@ export declare class HasOneResolver extends Service {
     targetName: string,
     relationName: string,
     targetRelationName: string,
-    scope?: Filter,
+    scope?: FilterClause,
   ): Promise<void>;
 }

+ 2 - 2
src/relations/references-many-resolver.d.ts

@@ -1,6 +1,6 @@
 import {ModelData} from '../types.js';
-import {Filter} from '../filter/index.js';
 import {Service} from '@e22m4u/js-service';
+import {FilterClause} from '../filter/index.js';
 
 /**
  * References many resolver.
@@ -22,6 +22,6 @@ export declare class ReferencesManyResolver extends Service {
     targetName: string,
     relationName: string,
     foreignKey?: string,
-    scope?: Filter,
+    scope?: FilterClause,
   ): Promise<void>;
 }

+ 9 - 9
src/repository/repository.d.ts

@@ -2,11 +2,11 @@ import {ModelId} from '../types.js';
 import {Flatten} from '../types.js';
 import {ModelData} from '../types.js';
 import {PartialBy} from '../types.js';
-import {Filter} from '../filter/index.js';
 import {Service} from '@e22m4u/js-service';
 import {Adapter} from '../adapter/index.js';
-import {ItemFilter} from '../filter/index.js';
 import {WhereClause} from '../filter/index.js';
+import {FilterClause} from '../filter/index.js';
+import {ItemFilterClause} from '../filter/index.js';
 import {ServiceContainer} from '@e22m4u/js-service';
 import {DEFAULT_PRIMARY_KEY_PROPERTY_NAME} from '../definition/index.js';
 
@@ -50,7 +50,7 @@ export declare class Repository<
    */
   create(
     data: OptionalUnlessRequiredId<IdName, FlatData>,
-    filter?: ItemFilter,
+    filter?: ItemFilterClause,
   ): Promise<FlatData>;
 
   /**
@@ -63,7 +63,7 @@ export declare class Repository<
   replaceById(
     id: IdType,
     data: WithoutId<IdName, FlatData>,
-    filter?: ItemFilter,
+    filter?: ItemFilterClause,
   ): Promise<FlatData>;
 
   /**
@@ -74,7 +74,7 @@ export declare class Repository<
    */
   replaceOrCreate(
     data: OptionalUnlessRequiredId<IdName, Data>,
-    filter?: ItemFilter,
+    filter?: ItemFilterClause,
   ): Promise<FlatData>;
 
   /**
@@ -87,7 +87,7 @@ export declare class Repository<
   patchById(
     id: IdType,
     data: PartialWithoutId<IdName, Data>,
-    filter?: ItemFilter,
+    filter?: ItemFilterClause,
   ): Promise<FlatData>;
 
   /**
@@ -95,14 +95,14 @@ export declare class Repository<
    *
    * @param filter
    */
-  find(filter?: Filter): Promise<FlatData[]>;
+  find(filter?: FilterClause): Promise<FlatData[]>;
 
   /**
    * Find one.
    *
    * @param filter
    */
-  findOne(filter?: ItemFilter): Promise<FlatData | undefined>;
+  findOne(filter?: FilterClause): Promise<FlatData | undefined>;
 
   /**
    * Find by id.
@@ -110,7 +110,7 @@ export declare class Repository<
    * @param id
    * @param filter
    */
-  findById(id: IdType, filter?: ItemFilter): Promise<FlatData>;
+  findById(id: IdType, filter?: ItemFilterClause): Promise<FlatData>;
 
   /**
    * Delete.