@punks/backend-entity-manager 0.0.132 → 0.0.134

package/dist/esm/types/__test__/entity/foo.d.ts

@@ -1,7 +1,7 @@
 import { IEntityManagerServiceRoot } from "../../abstractions/configuration";
 import { IEntityConverter } from "../../abstractions/converters";
 import { IEntitiesQueryBuilder } from "../../abstractions/queries";
-import { IEntitySearchParameters } from "../../abstractions/searchParameters";
+import { IEntitySearchParameters, ISearchSorting } from "../../abstractions/searchParameters";
 import { IEntitiesSearchResults } from "../../models";
 import { EntityServiceLocator } from "../../providers/services";
 import { InMemoryRepository } from "../../testing/mocks/repository";
@@ -35,6 +35,10 @@ export interface FooFacets {
 export declare class FooQueryBuilder implements IEntitiesQueryBuilder<FooEntity, string, FooSearchParameters, FooSorting, FooCursor, FooFacets, unknown> {
     private readonly repository;
     constructor(services: EntityServiceLocator<FooEntity, string>);
+    find(request?: {
+        filters?: FooSearchFilters | undefined;
+        sorting?: ISearchSorting<FooSorting> | undefined;
+    } | undefined, context?: IAuthenticationContext<unknown> | undefined): Promise<FooEntity>;
     get(id: string): Promise<FooEntity | undefined>;
     exists(filters: FooSearchFilters, context?: IAuthenticationContext<unknown> | undefined): Promise<boolean>;
     count(filters: FooSearchFilters, context?: IAuthenticationContext<unknown> | undefined): Promise<number>;

package/dist/esm/types/abstractions/errors.d.ts

@@ -7,7 +7,8 @@ export declare enum EntityOperationType {
     Update = 1,
     Delete = 2,
     Read = 3,
-    Search = 4
+    Search = 4,
+    Find = 5
 }
 export declare abstract class EntityManagerUnauthorizedException extends EntityManagerException {
     constructor(message: string);

package/dist/esm/types/abstractions/manager.d.ts

@@ -1,11 +1,12 @@
 import { IEntitiesDeleteCommand, IEntitiesDeleteParameters, IEntitiesExportCommand, IEntitiesImportCommand, IEntitiesSampleDownloadCommand, IEntityCreateCommand, IEntityDeleteCommand, IEntityUpdateCommand, IEntityUpsertCommand } from "./commands";
 import { SortingType } from "./common";
-import { IEntitiesCountQuery, IEntitiesSearchQuery, IEntityExistsQuery, IEntityGetQuery, IEntityVersionsSearchQuery } from "./queries";
+import { IEntitiesCountQuery, IEntitiesFindQuery, IEntitiesSearchQuery, IEntityExistsQuery, IEntityGetQuery, IEntityVersionsSearchQuery } from "./queries";
 import { IEntitySearchParameters } from "./searchParameters";
 import { IEntityFacets } from "./searchResults";
 export interface IEntityManager<TEntity, TEntityId, TEntityCreateData, TEntityUpdateData, TEntitiesDeleteParameters extends IEntitiesDeleteParameters<TSorting>, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets extends IEntityFacets> {
     get get(): IEntityGetQuery<TEntity, TEntityId>;
     get search(): IEntitiesSearchQuery<TEntity, TEntitySearchParameters, TSorting, TCursor, TFacets>;
+    get find(): IEntitiesFindQuery<TEntity, TEntitySearchParameters, TSorting, TCursor>;
     get exists(): IEntityExistsQuery<TEntity, NonNullable<TEntitySearchParameters["filters"]>>;
     get count(): IEntitiesCountQuery<TEntity, NonNullable<TEntitySearchParameters["filters"]>>;
     get create(): IEntityCreateCommand<TEntity, TEntityCreateData>;

package/dist/esm/types/abstractions/queries.d.ts

@@ -10,6 +10,12 @@ export interface IEntitiesSearchQuery<TEntity, TEntitySearchParameters extends I
 export interface IEntityGetQuery<TEntity, TEntityId> {
     execute(id: TEntityId): Promise<TEntity | undefined>;
 }
+export interface IEntitiesFindQuery<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor> {
+    execute(request: {
+        filters?: TEntitySearchParameters["filters"];
+        sorting?: TEntitySearchParameters["sorting"];
+    }): Promise<TEntity>;
+}
 export interface IEntityExistsQuery<TEntity, TEntityFilters extends ISearchFilters> {
     execute(filters: TEntityFilters): Promise<boolean>;
 }
@@ -21,6 +27,10 @@ export interface IEntityVersionsSearchQuery<TEntity, TCursor> {
 }
 export interface IEntitiesQueryBuilder<TEntity, TEntityId, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets extends IEntityFacets, TUserContext> {
     get(id: TEntityId, context?: IAuthenticationContext<TUserContext>): Promise<TEntity | undefined>;
+    find(request?: {
+        filters?: TEntitySearchParameters["filters"];
+        sorting?: TEntitySearchParameters["sorting"];
+    }, context?: IAuthenticationContext<TUserContext>): Promise<TEntity>;
     search(request: TEntitySearchParameters, context?: IAuthenticationContext<TUserContext>): Promise<IEntitiesSearchResults<TEntitySearchParameters, TEntity, TSorting, TCursor, TFacets>>;
     exists(filters: NonNullable<TEntitySearchParameters["filters"]>, context?: IAuthenticationContext<TUserContext>): Promise<boolean>;
     count(filters: NonNullable<TEntitySearchParameters["filters"]>, context?: IAuthenticationContext<TUserContext>): Promise<number>;

package/dist/esm/types/concrete/index.d.ts

@@ -2,7 +2,7 @@ import { IEntitiesCountAction, IEntitiesDeleteAction, IEntitiesExportAction, IEn
 import { IEntitiesDeleteCommand, IEntitiesDeleteParameters, IEntitiesExportCommand, IEntitiesImportCommand, IEntitiesSampleDownloadCommand, IEntityCreateCommand, IEntityDeleteCommand, IEntityUpdateCommand, IEntityUpsertCommand } from "../abstractions/commands";
 import { SortingType } from "../abstractions/common";
 import { IEntityManager } from "../abstractions/manager";
-import { IEntitiesCountQuery, IEntitiesSearchQuery, IEntityExistsQuery, IEntityGetQuery, IEntityVersionsSearchQuery } from "../abstractions/queries";
+import { IEntitiesCountQuery, IEntitiesFindQuery, IEntitiesSearchQuery, IEntityExistsQuery, IEntityGetQuery, IEntityVersionsSearchQuery } from "../abstractions/queries";
 import { IEntitySearchParameters } from "../abstractions/searchParameters";
 import { IEntityFacets } from "../abstractions/searchResults";
 import { EntityServiceLocator } from "../providers/services";
@@ -14,6 +14,7 @@ export declare class EntityManager<TEntity, TEntityId, TEntityCreateData, TEntit
     get deleteItems(): IEntitiesDeleteCommand<TEntity, TEntitiesDeleteParameters, TSorting>;
     get get(): IEntityGetQuery<TEntity, TEntityId>;
     get search(): IEntitiesSearchQuery<TEntity, TEntitySearchParameters, TSorting, TCursor, TFacets>;
+    get find(): IEntitiesFindQuery<TEntity, TEntitySearchParameters, TSorting, TCursor>;
     get create(): IEntityCreateCommand<TEntity, TEntityCreateData>;
     get update(): IEntityUpdateCommand<TEntity, TEntityId, TEntityUpdateData>;
     get upsert(): IEntityUpsertCommand<TEntity, TEntityId, TEntityUpdateData>;

package/dist/esm/types/providers/services.d.ts

@@ -9,7 +9,7 @@ import { IEntityConverter } from "../abstractions/converters";
 import { IEntityEventsManager, IEventEmitter } from "../abstractions/events";
 import { IEntityManager } from "../abstractions/manager";
 import { IPipelinesController } from "../abstractions/pipelines";
-import { IEntitiesCountQuery, IEntitiesQueryBuilder, IEntitiesSearchQuery, IEntityExistsQuery, IEntityGetQuery, IEntityVersionsSearchQuery } from "../abstractions/queries";
+import { IEntitiesCountQuery, IEntitiesFindQuery, IEntitiesQueryBuilder, IEntitiesSearchQuery, IEntityExistsQuery, IEntityGetQuery, IEntityVersionsSearchQuery } from "../abstractions/queries";
 import { IEntityReplicaDeleteManager, IEntityReplicaSyncManager, IReplicasConfiguration } from "../abstractions/replication";
 import { IEntityRepository } from "../abstractions/repository";
 import { IEntitySearchParameters, ISearchFilters } from "../abstractions/searchParameters";
@@ -42,6 +42,7 @@ export declare class EntityServiceLocator<TEntity, TEntityId> {
     resolveCountQuery<TEntityFilters extends ISearchFilters>(): IEntitiesCountQuery<TEntity, TEntityFilters>;
     resolveVersionsSearchQuery<TCursor>(): IEntityVersionsSearchQuery<TEntity, TCursor>;
     resolveSearchQuery<TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets extends IEntityFacets>(): IEntitiesSearchQuery<TEntity, TEntitySearchParameters, TSorting, TCursor, TFacets>;
+    resolveFindQuery<TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor>(): IEntitiesFindQuery<TEntity, TEntitySearchParameters, TSorting, TCursor>;
     resolveCreateCommand<TEntityCreateData>(): IEntityCreateCommand<TEntity, TEntityCreateData>;
     resolveUpdateCommand<TEntityUpdateData>(): IEntityUpdateCommand<TEntity, TEntityId, TEntityUpdateData>;
     resolveUpsertCommand<TEntityUpdateData>(): IEntityUpsertCommand<TEntity, TEntityId, TEntityUpdateData>;
@@ -128,6 +129,8 @@ export declare class EntitiesServiceLocator {
     registerGetQuery<TEntity, TEntityId>(entityName: string, instance: IEntityGetQuery<TEntity, TEntityId>): void;
     resolveSearchQuery<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets extends IEntityFacets>(entityName: string): IEntitiesSearchQuery<TEntity, TEntitySearchParameters, TSorting, TCursor, TFacets>;
     registerSearchQuery<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets extends IEntityFacets>(entityName: string, instance: IEntitiesSearchQuery<TEntity, TEntitySearchParameters, TSorting, TCursor, TFacets>): void;
+    resolveFindQuery<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor>(entityName: string): IEntitiesFindQuery<TEntity, TEntitySearchParameters, TSorting, TCursor>;
+    registerFindQuery<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor>(entityName: string, instance: IEntitiesFindQuery<TEntity, TEntitySearchParameters, TSorting, TCursor>): void;
     resolveExistsQuery<TEntity, TEntityFilters extends ISearchFilters>(entityName: string): IEntityExistsQuery<TEntity, TEntityFilters>;
     registerExistsQuery<TEntity, TEntityFilters extends ISearchFilters>(entityName: string, instance: IEntityExistsQuery<TEntity, TEntityFilters>): void;
     resolveCountQuery<TEntity, TEntityFilters extends ISearchFilters>(entityName: string): IEntitiesCountQuery<TEntity, TEntityFilters>;

package/dist/esm/types/queries/find.d.ts

@@ -0,0 +1,12 @@
+import { SortingType } from "../abstractions/common";
+import { IEntitiesFindQuery } from "../abstractions/queries";
+import { IEntitySearchParameters } from "../abstractions/searchParameters";
+import { EntityServiceLocator } from "../providers/services";
+export declare class EntitiesFindQuery<TEntity, TEntityId, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TUserContext> implements IEntitiesFindQuery<TEntity, TEntitySearchParameters, TSorting, TCursor> {
+    private readonly services;
+    constructor(services: EntityServiceLocator<TEntity, TEntityId>);
+    execute(request: TEntitySearchParameters): Promise<TEntity>;
+    private getContext;
+    private filterAllowedEntities;
+    private authorizeSearch;
+}

package/dist/esm/types/symbols/ioc.d.ts

@@ -46,6 +46,7 @@ export declare const EntityServices: {
         IEntityCountQuery: string;
         IEntityExistsQuery: string;
         IEntityGetQuery: string;
+        IEntitiesFindQuery: string;
         IEntitiesSearchQuery: string;
         IEntitiesQueryBuilder: string;
         IEntityVersionsSearchQuery: string;

package/dist/index.d.ts

@@ -643,6 +643,12 @@ interface IEntitiesSearchQuery<TEntity, TEntitySearchParameters extends IEntityS
 interface IEntityGetQuery<TEntity, TEntityId> {
     execute(id: TEntityId): Promise<TEntity | undefined>;
 }
+interface IEntitiesFindQuery<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor> {
+    execute(request: {
+        filters?: TEntitySearchParameters["filters"];
+        sorting?: TEntitySearchParameters["sorting"];
+    }): Promise<TEntity>;
+}
 interface IEntityExistsQuery<TEntity, TEntityFilters extends ISearchFilters> {
     execute(filters: TEntityFilters): Promise<boolean>;
 }
@@ -654,6 +660,10 @@ interface IEntityVersionsSearchQuery<TEntity, TCursor> {
 }
 interface IEntitiesQueryBuilder<TEntity, TEntityId, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets extends IEntityFacets, TUserContext> {
     get(id: TEntityId, context?: IAuthenticationContext<TUserContext>): Promise<TEntity | undefined>;
+    find(request?: {
+        filters?: TEntitySearchParameters["filters"];
+        sorting?: TEntitySearchParameters["sorting"];
+    }, context?: IAuthenticationContext<TUserContext>): Promise<TEntity>;
     search(request: TEntitySearchParameters, context?: IAuthenticationContext<TUserContext>): Promise<IEntitiesSearchResults<TEntitySearchParameters, TEntity, TSorting, TCursor, TFacets>>;
     exists(filters: NonNullable<TEntitySearchParameters["filters"]>, context?: IAuthenticationContext<TUserContext>): Promise<boolean>;
     count(filters: NonNullable<TEntitySearchParameters["filters"]>, context?: IAuthenticationContext<TUserContext>): Promise<number>;
@@ -663,6 +673,7 @@ interface IEntitiesQueryBuilder<TEntity, TEntityId, TEntitySearchParameters exte
 interface IEntityManager<TEntity, TEntityId, TEntityCreateData, TEntityUpdateData, TEntitiesDeleteParameters extends IEntitiesDeleteParameters<TSorting>, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets extends IEntityFacets> {
     get get(): IEntityGetQuery<TEntity, TEntityId>;
     get search(): IEntitiesSearchQuery<TEntity, TEntitySearchParameters, TSorting, TCursor, TFacets>;
+    get find(): IEntitiesFindQuery<TEntity, TEntitySearchParameters, TSorting, TCursor>;
     get exists(): IEntityExistsQuery<TEntity, NonNullable<TEntitySearchParameters["filters"]>>;
     get count(): IEntitiesCountQuery<TEntity, NonNullable<TEntitySearchParameters["filters"]>>;
     get create(): IEntityCreateCommand<TEntity, TEntityCreateData>;
@@ -748,6 +759,7 @@ declare class EntityServiceLocator<TEntity, TEntityId> {
     resolveCountQuery<TEntityFilters extends ISearchFilters>(): IEntitiesCountQuery<TEntity, TEntityFilters>;
     resolveVersionsSearchQuery<TCursor>(): IEntityVersionsSearchQuery<TEntity, TCursor>;
     resolveSearchQuery<TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets extends IEntityFacets>(): IEntitiesSearchQuery<TEntity, TEntitySearchParameters, TSorting, TCursor, TFacets>;
+    resolveFindQuery<TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor>(): IEntitiesFindQuery<TEntity, TEntitySearchParameters, TSorting, TCursor>;
     resolveCreateCommand<TEntityCreateData>(): IEntityCreateCommand<TEntity, TEntityCreateData>;
     resolveUpdateCommand<TEntityUpdateData>(): IEntityUpdateCommand<TEntity, TEntityId, TEntityUpdateData>;
     resolveUpsertCommand<TEntityUpdateData>(): IEntityUpsertCommand<TEntity, TEntityId, TEntityUpdateData>;
@@ -834,6 +846,8 @@ declare class EntitiesServiceLocator {
     registerGetQuery<TEntity, TEntityId>(entityName: string, instance: IEntityGetQuery<TEntity, TEntityId>): void;
     resolveSearchQuery<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets extends IEntityFacets>(entityName: string): IEntitiesSearchQuery<TEntity, TEntitySearchParameters, TSorting, TCursor, TFacets>;
     registerSearchQuery<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor, TFacets extends IEntityFacets>(entityName: string, instance: IEntitiesSearchQuery<TEntity, TEntitySearchParameters, TSorting, TCursor, TFacets>): void;
+    resolveFindQuery<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor>(entityName: string): IEntitiesFindQuery<TEntity, TEntitySearchParameters, TSorting, TCursor>;
+    registerFindQuery<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor>(entityName: string, instance: IEntitiesFindQuery<TEntity, TEntitySearchParameters, TSorting, TCursor>): void;
     resolveExistsQuery<TEntity, TEntityFilters extends ISearchFilters>(entityName: string): IEntityExistsQuery<TEntity, TEntityFilters>;
     registerExistsQuery<TEntity, TEntityFilters extends ISearchFilters>(entityName: string, instance: IEntityExistsQuery<TEntity, TEntityFilters>): void;
     resolveCountQuery<TEntity, TEntityFilters extends ISearchFilters>(entityName: string): IEntitiesCountQuery<TEntity, TEntityFilters>;
@@ -962,7 +976,8 @@ declare enum EntityOperationType {
     Update = 1,
     Delete = 2,
     Read = 3,
-    Search = 4
+    Search = 4,
+    Find = 5
 }
 declare abstract class EntityManagerUnauthorizedException extends EntityManagerException {
     constructor(message: string);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@punks/backend-entity-manager",
-  "version": "0.0.132",
+  "version": "0.0.134",
   "description": "",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",