@kinotic-ai/persistence 1.0.10 → 1.1.1

package/dist/index.d.cts

@@ -90,188 +90,414 @@ import { C3Decorator } from "@kinotic-ai/idl";
 * This class denotes {@link C3Decorator} that can be applied to an {@link EntityService} using the {@link EntityServiceDecoratorsDecorator}
 */
 declare abstract class EntityServiceDecorator extends C3Decorator {}
-import { Pageable as Pageable2, IterablePage as IterablePage2 } from "@kinotic-ai/core";
+import { IEntityService } from "@/api/IEntityService";
+type IfFunction<
+	T,
+	U
+> = T extends (...args: any[]) => any ? U : never;
+type MethodsOf<T> = { [K in keyof T] : IfFunction<T[K], K> }[keyof T];
+type ExcludedMethods = "namedQuery" | "namedQueryPage";
+type FilteredMethods<T> = Exclude<MethodsOf<T>, ExcludedMethods>;
+type DecoratedFunction = FilteredMethods<IEntityService<any>> | "allCreate" | "allRead" | "allUpdate" | "allDelete";
+/**
+* Configuration for the {@link EntityServiceDecoratorsDecorator}
+* This is a map of method names to an array of decorators that should be applied to that method
+*/
+type EntityServiceDecoratorsConfig = Partial<Record<DecoratedFunction, EntityServiceDecorator[]>>;
+declare enum KinoticPersistenceDecorator {
+	Entity = "__structures-entity__",
+	Id = "__structures-id__",
+	AutoGeneratedId = "__structures-auto-generated-id__",
+	Flattened = "__structures-flattened__",
+	Nested = "__structures-nested__",
+	Text = "__structures-text__",
+	NotNull = "__structures-notnull__",
+	Precision = "__structures-precision__",
+	Discriminator = "__structures-discriminator__",
+	Query = "__structures-query__",
+	EntityServiceDecorators = "__structures-entity-service-decorators__"
+}
+/**
+* Signifies that a property is an auto-generated ID for the entity.
+*/
+declare function AutoGeneratedId(target: any, propertyKey: string): void;
+declare class DiscriminatorConfig {
+	propertyName: string;
+	constructor(propertyName: string);
+}
+/**
+* Signifies that a property is a discriminator for the entity.
+* This is used to determine the type of the entity when deserializing from JSON.
+* @param propertyName the name of the property to use as the discriminator
+*/
+declare function Discriminator(propertyName: string): (target: any, propertyKey: string) => void;
+declare class EntityConfig {
+	multiTenancyType: MultiTenancyType;
+	entityType: EntityType;
+	constructor(multiTenancyType: MultiTenancyType, entityType?: EntityType);
+}
+/**
+* Signifies that a class is a Structures Entity.
+* This is required to define the class as an entity in the Structures framework.
+* @param multiTenancyType the type of multi-tenancy to use for this entity
+* @param entityType the type of entity to use for this entity
+*/
+declare function Entity(multiTenancyType?: MultiTenancyType, entityType?: EntityType): (constructor: Function) => void;
+/**
+* A class Decorator when applied to an Entity will configure Decorators to be applied to the EntityService
+* @param config the {@link EntityServiceDecoratorsConfig} to use
+*/
+declare function EntityServiceDecorators(_config: EntityServiceDecoratorsConfig): (_constructor: Function) => void;
+/**
+* Provides configuration for the Elasticsearch index.
+* This can be used to override the default index settings and mappings used by Structures.
+*/
+declare function EsIndexConfiguration(_value: EsIndexConfigurationData): (_constructor: Function) => void;
+declare function Flattened(target: any, propertyKey: string): void;
+/**
+* Signifies that a property is the ID of the entity.
+*/
+declare function Id(target: any, propertyKey: string): void;
+declare function Nested(target: any, propertyKey: string): void;
+/**
+* Signifies that a property is not indexed in Elasticsearch.
+*/
+declare function NotIndexed(_target: any, _propertyKey: string): void;
+declare function NotNull(target: any, propertyKey: string): void;
+declare function Policy(_policies: string[][]): (_target: any, _propertyKey?: string, _descriptor?: PropertyDescriptor) => void;
+declare class PrecisionConfig {
+	precisionType: PrecisionType;
+	constructor(precisionType: PrecisionType);
+}
+declare function Precision(precisionType?: PrecisionType): (target: any, propertyKey: string) => void;
+declare function Query(statements: string): (target: any, key: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+declare function Role(_roles: string[]): (_target: any, _propertyKey?: string, _descriptor?: PropertyDescriptor) => void;
+declare function Text(target: any, propertyKey: string): void;
+/**
+* This is used for data streams to signify the field that should be used as the time reference.
+*/
+declare function TimeReference(_target: any, _propertyKey: string): void;
+declare function Version(_target: any, _propertyKey: string): void;
+declare function TenantId(_target: any, _propertyKey: string): void;
+import { C3Decorator as C3Decorator2 } from "@kinotic-ai/idl";
+/**
+* Provides a way to add decorators to an entity service
+*/
+declare class EntityServiceDecoratorsDecorator extends C3Decorator2 {
+	config: EntityServiceDecoratorsConfig;
+	constructor();
+}
+declare class PolicyDecorator extends EntityServiceDecorator {
+	policies: string[][];
+	constructor(policies: string[][]);
+}
+/**
+* Provides a mechanism to apply the @Policy decorator to an {@link EntityService}
+* @param policies to be supplied
+*/
+declare function $Policy(policies: string[][]): PolicyDecorator;
+declare class RoleDecorator extends EntityServiceDecorator {
+	roles: string[];
+	constructor(roles: string[]);
+}
+/**
+* Provides a mechanism to apply the @Role decorator to an {@link EntityService}
+* @param roles to be supplied
+*/
+declare function $Role(roles: string[]): RoleDecorator;
 import { IKinotic } from "@kinotic-ai/core";
 import { IServiceProxy, Page, Pageable, IterablePage } from "@kinotic-ai/core";
-interface IEntitiesService {
+interface IEntitiesRepository {
 	/**
 	* Saves all given entities.
-	* @param structureId the id of the structure to save the entities for
+	* @param entityDefinitionId the id of the structure to save the entities for
 	* @param entities all the entities to save
 	* @return Promise that will complete when all entities have been saved
 	*/
-	bulkSave<T>(structureId: string, entities: T[]): Promise<void>;
+	bulkSave<T>(entityDefinitionId: string, entities: T[]): Promise<void>;
 	/**
 	* Updates all given entities.
-	* @param structureId the id of the structure to update the entities for
+	* @param entityDefinitionId the id of the structure to update the entities for
 	* @param entities all the entities to save
 	* @return Promise that will complete when all entities have been saved
 	*/
-	bulkUpdate<T>(structureId: string, entities: T[]): Promise<void>;
+	bulkUpdate<T>(entityDefinitionId: string, entities: T[]): Promise<void>;
 	/**
 	* Returns the number of entities available.
-	* @param structureId the id of the structure to count
+	* @param entityDefinitionId the id of the structure to count
 	* @return {@link Promise} emitting the number of entities.
 	*/
-	count(structureId: string): Promise<number>;
+	count(entityDefinitionId: string): Promise<number>;
 	/**
 	* Returns the number of entities available for the given query.
 	*
-	* @param structureId the id of the structure to save the entity for
+	* @param entityDefinitionId the id of the structure to save the entity for
 	* @param query       the query used to limit result
 	* @return Promise    emitting the number of entities
 	*/
-	countByQuery(structureId: string, query: string): Promise<number>;
+	countByQuery(entityDefinitionId: string, query: string): Promise<number>;
 	/**
 	* Deletes the entity with the given id.
 	*
-	* @param structureId the id of the structure to save the entity for
+	* @param entityDefinitionId the id of the structure to save the entity for
 	* @param id          must not be {@literal null}
 	* @return {@link Promise} emitting when delete is complete
 	* @throws IllegalArgumentException in case the given {@literal id} is {@literal null}
 	*/
-	deleteById(structureId: string, id: string): Promise<void>;
+	deleteById(entityDefinitionId: string, id: string): Promise<void>;
 	/**
 	* Deletes the entity with the given id.
 	*
-	* @param structureId the id of the structure to save the entity for
+	* @param entityDefinitionId the id of the structure to save the entity for
 	* @param query      the query used to filter records to delete, must not be {@literal null}
 	* @return Promise signaling when operation has completed
 	* @throws Error in case the given {@literal query} is {@literal null}
 	*/
-	deleteByQuery(structureId: string, query: string): Promise<void>;
+	deleteByQuery(entityDefinitionId: string, query: string): Promise<void>;
 	/**
 	* Returns a {@link IterablePage} of entities meeting the paging restriction provided in the {@link Pageable} object.
 	*
-	* @param structureId the id of the structure to save the entity for
+	* @param entityDefinitionId the id of the structure to save the entity for
 	* @param pageable    the page settings to be used
 	* @return a page of entities
 	*/
-	findAll<T>(structureId: string, pageable: Pageable): Promise<IterablePage<T>>;
+	findAll<T>(entityDefinitionId: string, pageable: Pageable): Promise<IterablePage<T>>;
 	/**
 	* Returns a single {@link Page} of entities meeting the paging restriction provided in the {@link Pageable} object.
-	* @param structureId the id of the structure to save the entity for
+	* @param entityDefinitionId the id of the structure to save the entity for
 	* @param pageable the page settings to be used
 	*/
-	findAllSinglePage<T>(structureId: string, pageable: Pageable): Promise<Page<T>>;
+	findAllSinglePage<T>(entityDefinitionId: string, pageable: Pageable): Promise<Page<T>>;
 	/**
 	* Retrieves an entity by its id.
 	*
-	* @param structureId the id of the structure to save the entity for
+	* @param entityDefinitionId the id of the structure to save the entity for
 	* @param id          must not be {@literal null}
 	* @return {@link Promise} with the entity with the given id or {@link Promise} emitting null if none found
 	* @throws IllegalArgumentException in case the given {@literal id} is {@literal null}
 	*/
-	findById<T>(structureId: string, id: string): Promise<T>;
+	findById<T>(entityDefinitionId: string, id: string): Promise<T | null>;
 	/**
 	* Retrieves a list of entities by their id.
 	*
-	* @param structureId the id of the structure to save the entity for
+	* @param entityDefinitionId the id of the structure to save the entity for
 	* @param ids      must not be {@literal null}
 	* @return Promise emitting the entities with the given ids or Promise emitting null if none found
 	* @throws Error in case the given {@literal ids} is {@literal null}
 	*/
-	findByIds<T>(structureId: string, ids: string[]): Promise<T[]>;
+	findByIds<T>(entityDefinitionId: string, ids: string[]): Promise<T[]>;
 	/**
 	* Executes a named query.
-	* @param structureId the id of the structure that this named query is defined for
+	* @param entityDefinitionId the id of the structure that this named query is defined for
 	* @param queryName the name of the function that defines the query
 	* @param parameters to pass to the query
 	* @returns Promise with the result of the query
 	*/
-	namedQuery<T>(structureId: string, queryName: string, parameters: QueryParameter[]): Promise<T>;
+	namedQuery<T>(entityDefinitionId: string, queryName: string, parameters: QueryParameter[]): Promise<T>;
 	/**
 	* Executes a named query and returns a Page of results.
-	* @param structureId the id of the structure that this named query is defined for
+	* @param entityDefinitionId the id of the structure that this named query is defined for
 	* @param queryName the name of the function that defines the query
 	* @param parameters to pass to the query
 	* @param pageable the page settings to be used
 	* @returns Promise with the result of the query
 	*/
-	namedQueryPage<T>(structureId: string, queryName: string, parameters: QueryParameter[], pageable: Pageable): Promise<IterablePage<T>>;
+	namedQueryPage<T>(entityDefinitionId: string, queryName: string, parameters: QueryParameter[], pageable: Pageable): Promise<IterablePage<T>>;
 	/**
 	* Saves a given entity. Use the returned instance for further operations as the save operation might have changed the
 	* entity instance completely.
 	*
-	* @param structureId the id of the structure to save the entity for
+	* @param entityDefinitionId the id of the structure to save the entity for
 	* @param entity      must not be {@literal null}
 	* @return {@link Promise} emitting the saved entity
 	* @throws IllegalArgumentException in case the given {@literal entity} is {@literal null}
 	*/
-	save<T>(structureId: string, entity: T): Promise<T>;
+	save<T>(entityDefinitionId: string, entity: T): Promise<T>;
 	/**
 	* Returns a {@link IterablePage} of entities matching the search text and paging restriction provided in the {@link Pageable} object.
 	*
-	* @param structureId the id of the structure to save the entity for
+	* @param entityDefinitionId the id of the structure to save the entity for
 	* @param searchText  the text to search for entities for
 	* @param pageable    the page settings to be used
 	* @return a page of entities
 	*/
-	search<T>(structureId: string, searchText: string, pageable: Pageable): Promise<IterablePage<T>>;
+	search<T>(entityDefinitionId: string, searchText: string, pageable: Pageable): Promise<IterablePage<T>>;
 	/**
 	* Returns a single {@link Page} of entities matching the search text and paging restriction provided in the {@link Pageable} object.
 	*
-	* @param structureId the id of the structure to save the entity for
+	* @param entityDefinitionId the id of the structure to save the entity for
 	* @param searchText  the text to search for entities for
 	* @param pageable    the page settings to be used
 	* @return a page of entities
 	*/
-	searchSinglePage<T>(structureId: string, searchText: string, pageable: Pageable): Promise<Page<T>>;
+	searchSinglePage<T>(entityDefinitionId: string, searchText: string, pageable: Pageable): Promise<Page<T>>;
 	/**
 	* This operation makes all the recent writes immediately available for search.
-	* @param structureId the id of the structure to sync the index for.
+	* @param entityDefinitionId the id of the structure to sync the index for.
 	* @return a Promise that resolves when the operation is complete
 	*/
-	syncIndex(structureId: string): Promise<void>;
+	syncIndex(entityDefinitionId: string): Promise<void>;
 	/**
 	* Updates a given entity. This will only override the fields that are present in the given entity.
 	* If any fields are not present in the given entity data, they will not be changed.
 	* If the entity does not exist, it will be created.
 	*
-	* @param structureId the id of the structure to update the entity for
+	* @param entityDefinitionId the id of the structure to update the entity for
 	* @param entity      must not be {@literal null}
 	* @return Promise emitting the saved entity
 	* @throws Error in case the given {@literal entity} is {@literal null}
 	*/
-	update<T>(structureId: string, entity: T): Promise<T>;
+	update<T>(entityDefinitionId: string, entity: T): Promise<T>;
 }
-declare class EntitiesService implements IEntitiesService {
+declare class EntitiesRepository implements IEntitiesRepository {
 	protected serviceProxy: IServiceProxy;
 	constructor(kinotic: IKinotic);
-	bulkSave<T>(structureId: string, entities: T[]): Promise<void>;
-	bulkUpdate<T>(structureId: string, entities: T[]): Promise<void>;
-	count(structureId: string): Promise<number>;
-	countByQuery(structureId: string, query: string): Promise<number>;
-	deleteById(structureId: string, id: string): Promise<void>;
-	deleteByQuery(structureId: string, query: string): Promise<void>;
-	findAll<T>(structureId: string, pageable: Pageable): Promise<IterablePage<T>>;
-	findAllSinglePage<T>(structureId: string, pageable: Pageable): Promise<Page<T>>;
-	findById<T>(structureId: string, id: string): Promise<T>;
-	findByIds<T>(structureId: string, ids: string[]): Promise<T[]>;
-	namedQuery<T>(structureId: string, queryName: string, parameters: QueryParameter[]): Promise<T>;
-	namedQueryPage<T>(structureId: string, queryName: string, parameters: QueryParameter[], pageable: Pageable): Promise<IterablePage<T>>;
-	namedQuerySinglePage<T>(structureId: string, queryName: string, parameters: QueryParameter[], pageable: Pageable): Promise<Page<T>>;
-	save<T>(structureId: string, entity: T): Promise<T>;
-	search<T>(structureId: string, searchText: string, pageable: Pageable): Promise<IterablePage<T>>;
-	searchSinglePage<T>(structureId: string, searchText: string, pageable: Pageable): Promise<Page<T>>;
-	syncIndex(structureId: string): Promise<void>;
-	update<T>(structureId: string, entity: T): Promise<T>;
+	bulkSave<T>(entityDefinitionId: string, entities: T[]): Promise<void>;
+	bulkUpdate<T>(entityDefinitionId: string, entities: T[]): Promise<void>;
+	count(entityDefinitionId: string): Promise<number>;
+	countByQuery(entityDefinitionId: string, query: string): Promise<number>;
+	deleteById(entityDefinitionId: string, id: string): Promise<void>;
+	deleteByQuery(entityDefinitionId: string, query: string): Promise<void>;
+	findAll<T>(entityDefinitionId: string, pageable: Pageable): Promise<IterablePage<T>>;
+	findAllSinglePage<T>(entityDefinitionId: string, pageable: Pageable): Promise<Page<T>>;
+	findById<T>(entityDefinitionId: string, id: string): Promise<T | null>;
+	findByIds<T>(entityDefinitionId: string, ids: string[]): Promise<T[]>;
+	namedQuery<T>(entityDefinitionId: string, queryName: string, parameters: QueryParameter[]): Promise<T>;
+	namedQueryPage<T>(entityDefinitionId: string, queryName: string, parameters: QueryParameter[], pageable: Pageable): Promise<IterablePage<T>>;
+	namedQuerySinglePage<T>(entityDefinitionId: string, queryName: string, parameters: QueryParameter[], pageable: Pageable): Promise<Page<T>>;
+	save<T>(entityDefinitionId: string, entity: T): Promise<T>;
+	search<T>(entityDefinitionId: string, searchText: string, pageable: Pageable): Promise<IterablePage<T>>;
+	searchSinglePage<T>(entityDefinitionId: string, searchText: string, pageable: Pageable): Promise<Page<T>>;
+	syncIndex(entityDefinitionId: string): Promise<void>;
+	update<T>(entityDefinitionId: string, entity: T): Promise<T>;
+}
+import { IKinotic as IKinotic2 } from "@kinotic-ai/core";
+import { IServiceProxy as IServiceProxy2, Page as Page2, Pageable as Pageable2, IterablePage as IterablePage2 } from "@kinotic-ai/core";
+type TenantSelection = string[];
+interface IAdminEntitiesRepository {
+	/**
+	* Returns the number of entities available.
+	* @param structureId the id of the structure to count
+	* @param tenantSelection the list of tenants to use when retrieving the entity records
+	* @return {@link Promise} emitting the number of entities.
+	*/
+	count(entityDefinitionId: string, tenantSelection: TenantSelection): Promise<number>;
+	/**
+	* Returns the number of entities available for the given query.
+	*
+	* @param entityDefinitionId the id of the structure to save the entity for
+	* @param query       the query used to limit result
+	* @param tenantSelection the list of tenants to use when retrieving the entity records
+	* @return Promise    emitting the number of entities
+	*/
+	countByQuery(entityDefinitionId: string, query: string, tenantSelection: TenantSelection): Promise<number>;
+	/**
+	* Deletes the entity with the given id.
+	*
+	* @param entityDefinitionId the id of the structure to save the entity for
+	* @param id          must not be {@literal null}
+	* @return {@link Promise} emitting when delete is complete
+	* @throws IllegalArgumentException in case the given {@literal id} is {@literal null}
+	*/
+	deleteById(entityDefinitionId: string, id: TenantSpecificId): Promise<void>;
+	/**
+	* Deletes the entity with the given id.
+	*
+	* @param entityDefinitionId the id of the structure to save the entity for
+	* @param query      the query used to filter records to delete, must not be {@literal null}
+	* @param tenantSelection the list of tenants to use when deleting the entity records
+	* @return Promise signaling when operation has completed
+	* @throws Error in case the given {@literal query} is {@literal null}
+	*/
+	deleteByQuery(entityDefinitionId: string, query: string, tenantSelection: TenantSelection): Promise<void>;
+	/**
+	* Returns a {@link IterablePage} of entities meeting the paging restriction provided in the {@link Pageable} object.
+	*
+	* @param entityDefinitionId the id of the structure to save the entity for
+	* @param tenantSelection the list of tenants to use when retrieving the entity records
+	* @param pageable    the page settings to be used
+	* @return a page of entities
+	*/
+	findAll<T>(entityDefinitionId: string, tenantSelection: TenantSelection, pageable: Pageable2): Promise<IterablePage2<T>>;
+	/**
+	* Retrieves an entity by its id.
+	*
+	* @param entityDefinitionId the id of the structure to save the entity for
+	* @param id          must not be {@literal null}
+	* @return {@link Promise} with the entity with the given id or {@link Promise} emitting null if none found
+	* @throws IllegalArgumentException in case the given {@literal id} is {@literal null}
+	*/
+	findById<T>(entityDefinitionId: string, id: TenantSpecificId): Promise<T | null>;
+	/**
+	* Retrieves a list of entities by their id.
+	*
+	* @param entityDefinitionId the id of the structure to save the entity for
+	* @param ids      must not be {@literal null}
+	* @return Promise emitting the entities with the given ids or Promise emitting null if none found
+	* @throws Error in case the given {@literal ids} is {@literal null}
+	*/
+	findByIds<T>(entityDefinitionId: string, ids: TenantSpecificId[]): Promise<T[]>;
+	/**
+	* Executes a named query.
+	* @param entityDefinitionId the id of the structure that this named query is defined for
+	* @param queryName the name of the function that defines the query
+	* @param parameters to pass to the query
+	* @returns Promise with the result of the query
+	*/
+	namedQuery<T>(entityDefinitionId: string, queryName: string, parameters: QueryParameter[]): Promise<T>;
+	/**
+	* Executes a named query and returns a Page of results.
+	* @param entityDefinitionId the id of the structure that this named query is defined for
+	* @param queryName the name of the function that defines the query
+	* @param parameters to pass to the query
+	* @param pageable the page settings to be used
+	* @returns Promise with the result of the query
+	*/
+	namedQueryPage<T>(entityDefinitionId: string, queryName: string, parameters: QueryParameter[], pageable: Pageable2): Promise<IterablePage2<T>>;
+	/**
+	* Returns a {@link IterablePage} of entities matching the search text and paging restriction provided in the {@link Pageable} object.
+	*
+	* @param entityDefinitionId the id of the structure to save the entity for
+	* @param searchText  the text to search for entities for
+	* @param tenantSelection the list of tenants to use when retrieving the entity records
+	* @param pageable    the page settings to be used
+	* @return a page of entities
+	*/
+	search<T>(entityDefinitionId: string, searchText: string, tenantSelection: TenantSelection, pageable: Pageable2): Promise<IterablePage2<T>>;
+}
+declare class AdminEntitiesRepository implements IAdminEntitiesRepository {
+	protected serviceProxy: IServiceProxy2;
+	constructor(kinotic: IKinotic2);
+	count(entityDefinitionId: string, tenantSelection: TenantSelection): Promise<number>;
+	countByQuery(entityDefinitionId: string, query: string, tenantSelection: TenantSelection): Promise<number>;
+	deleteById(entityDefinitionId: string, id: TenantSpecificId): Promise<void>;
+	deleteByQuery(entityDefinitionId: string, query: string, tenantSelection: TenantSelection): Promise<void>;
+	findAll<T>(entityDefinitionId: string, tenantSelection: TenantSelection, pageable: Pageable2): Promise<IterablePage2<T>>;
+	findAllSinglePage<T>(entityDefinitionId: string, tenantSelection: TenantSelection, pageable: Pageable2): Promise<Page2<T>>;
+	findById<T>(entityDefinitionId: string, id: TenantSpecificId): Promise<T>;
+	findByIds<T>(entityDefinitionId: string, ids: TenantSpecificId[]): Promise<T[]>;
+	namedQuery<T>(entityDefinitionId: string, queryName: string, parameters: QueryParameter[]): Promise<T>;
+	namedQueryPage<T>(entityDefinitionId: string, queryName: string, parameters: QueryParameter[], pageable: Pageable2): Promise<IterablePage2<T>>;
+	namedQuerySinglePage<T>(entityDefinitionId: string, queryName: string, parameters: QueryParameter[], pageable: Pageable2): Promise<Page2<T>>;
+	search<T>(entityDefinitionId: string, searchText: string, tenantSelection: TenantSelection, pageable: Pageable2): Promise<IterablePage2<T>>;
+	searchSinglePage<T>(entityDefinitionId: string, searchText: string, tenantSelection: TenantSelection, pageable: Pageable2): Promise<Page2<T>>;
 }
+import { Pageable as Pageable3, IterablePage as IterablePage3 } from "@kinotic-ai/core";
 /**
-* This is the base interface for all entity services.
+* This is the base interface for all entity repositories.
 * It provides the basic CRUD operations for entities.
 */
-interface IEntityService<T> {
+interface IEntityRepository<T> {
 	/**
-	* The applicationId of the Entity this service is for
+	* The applicationId of the Entity this repository is for
 	*/
 	entityApplicationId: string;
 	/**
-	* The name of the Entity this service is for
+	* The name of the Entity this repository is for
 	*/
 	entityName: string;
 	/**
-	* The id of the Entity this service is for
+	* The id of the Entity this repository is for
 	* Which is the applicationId + '.' + name
 	*/
 	entityId: string;
@@ -322,7 +548,7 @@ interface IEntityService<T> {
 	* @param pageable the page settings to be used
 	* @return a page of entities
 	*/
-	findAll(pageable: Pageable2): Promise<IterablePage2<T>>;
+	findAll(pageable: Pageable3): Promise<IterablePage3<T>>;
 	/**
 	* Retrieves an entity by its id.
 	*
@@ -330,7 +556,7 @@ interface IEntityService<T> {
 	* @return Promise emitting the entity with the given id or Promise emitting null if none found
 	* @throws Error in case the given {@literal id} is {@literal null}
 	*/
-	findById(id: string): Promise<T>;
+	findById(id: string): Promise<T | null>;
 	/**
 	* Retrieves a list of entities by their id.
 	*
@@ -353,7 +579,7 @@ interface IEntityService<T> {
 	* @param pageable the page settings to be used
 	* @returns Promise with the result of the query
 	*/
-	namedQueryPage<U>(queryName: string, queryParameters: QueryParameter[], pageable: Pageable2): Promise<IterablePage2<U>>;
+	namedQueryPage<U>(queryName: string, queryParameters: QueryParameter[], pageable: Pageable3): Promise<IterablePage3<U>>;
 	/**
 	* Saves a given entity. This will override all data if there is an existing entity with the same id.
 	* Use the returned instance for further operations as the save operation might have changed the entity instance.
@@ -370,7 +596,7 @@ interface IEntityService<T> {
 	* @param pageable   the page settings to be used
 	* @return a page of entities
 	*/
-	search(searchText: string, pageable: Pageable2): Promise<IterablePage2<T>>;
+	search(searchText: string, pageable: Pageable3): Promise<IterablePage3<T>>;
 	/**
 	* This operation makes all the recent writes immediately available for search.
 	* @return a Promise that resolves when the operation is complete
@@ -388,274 +614,49 @@ interface IEntityService<T> {
 	update(entity: T): Promise<T>;
 }
 /**
-* This is the base class for all entity services.
+* This is the base class for all entity repositories.
 * It provides the basic CRUD operations for entities.
 */
-declare class EntityService<T> implements IEntityService<T> {
+declare class EntityRepository<T> implements IEntityRepository<T> {
 	entityApplicationId: string;
 	entityName: string;
 	entityId: string;
-	private readonly entitiesService;
-	constructor(structureApplicationId: string, structureName: string, entitiesService?: IEntitiesService);
+	private readonly entitiesRepository;
+	constructor(entityApplicationId: string, entityName: string, entitiesRepository?: IEntitiesRepository);
 	bulkSave(entities: T[]): Promise<void>;
 	bulkUpdate(entities: T[]): Promise<void>;
 	count(): Promise<number>;
 	countByQuery(query: string): Promise<number>;
 	deleteById(id: string): Promise<void>;
 	deleteByQuery(query: string): Promise<void>;
-	findAll(pageable: Pageable2): Promise<IterablePage2<T>>;
-	findById(id: string): Promise<T>;
+	findAll(pageable: Pageable3): Promise<IterablePage3<T>>;
+	findById(id: string): Promise<T | null>;
 	findByIds(ids: string[]): Promise<T[]>;
 	namedQuery<U>(queryName: string, queryParameters: QueryParameter[]): Promise<U>;
-	namedQueryPage<U>(queryName: string, queryParameters: QueryParameter[], pageable: Pageable2): Promise<IterablePage2<U>>;
+	namedQueryPage<U>(queryName: string, queryParameters: QueryParameter[], pageable: Pageable3): Promise<IterablePage3<U>>;
 	save(entity: T): Promise<T>;
-	search(searchText: string, pageable: Pageable2): Promise<IterablePage2<T>>;
+	search(searchText: string, pageable: Pageable3): Promise<IterablePage3<T>>;
 	syncIndex(): Promise<void>;
 	update(entity: T): Promise<T>;
 	protected beforeBulkSaveOrUpdate(entities: T[]): Promise<T[]>;
 	protected beforeSaveOrUpdate(entity: T): Promise<T>;
 }
-type IfFunction<
-	T,
-	U
-> = T extends (...args: any[]) => any ? U : never;
-type MethodsOf<T> = { [K in keyof T] : IfFunction<T[K], K> }[keyof T];
-type ExcludedMethods = "namedQuery" | "namedQueryPage";
-type FilteredMethods<T> = Exclude<MethodsOf<T>, ExcludedMethods>;
-type DecoratedFunction = FilteredMethods<IEntityService<any>> | "allCreate" | "allRead" | "allUpdate" | "allDelete";
-/**
-* Configuration for the {@link EntityServiceDecoratorsDecorator}
-* This is a map of method names to an array of decorators that should be applied to that method
-*/
-type EntityServiceDecoratorsConfig = Partial<Record<DecoratedFunction, EntityServiceDecorator[]>>;
-declare enum KinoticPersistenceDecorator {
-	Entity = "__structures-entity__",
-	Id = "__structures-id__",
-	AutoGeneratedId = "__structures-auto-generated-id__",
-	Flattened = "__structures-flattened__",
-	Nested = "__structures-nested__",
-	Text = "__structures-text__",
-	NotNull = "__structures-notnull__",
-	Precision = "__structures-precision__",
-	Discriminator = "__structures-discriminator__",
-	Query = "__structures-query__",
-	EntityServiceDecorators = "__structures-entity-service-decorators__"
-}
-/**
-* Signifies that a property is an auto-generated ID for the entity.
-*/
-declare function AutoGeneratedId(target: any, propertyKey: string): void;
-declare class DiscriminatorConfig {
-	propertyName: string;
-	constructor(propertyName: string);
-}
-/**
-* Signifies that a property is a discriminator for the entity.
-* This is used to determine the type of the entity when deserializing from JSON.
-* @param propertyName the name of the property to use as the discriminator
-*/
-declare function Discriminator(propertyName: string): (target: any, propertyKey: string) => void;
-declare class EntityConfig {
-	multiTenancyType: MultiTenancyType;
-	entityType: EntityType;
-	constructor(multiTenancyType: MultiTenancyType, entityType?: EntityType);
-}
-/**
-* Signifies that a class is a Structures Entity.
-* This is required to define the class as an entity in the Structures framework.
-* @param multiTenancyType the type of multi-tenancy to use for this entity
-* @param entityType the type of entity to use for this entity
-*/
-declare function Entity(multiTenancyType?: MultiTenancyType, entityType?: EntityType): (constructor: Function) => void;
-/**
-* A class Decorator when applied to an Entity will configure Decorators to be applied to the EntityService
-* @param config the {@link EntityServiceDecoratorsConfig} to use
-*/
-declare function EntityServiceDecorators(_config: EntityServiceDecoratorsConfig): (_constructor: Function) => void;
-/**
-* Provides configuration for the Elasticsearch index.
-* This can be used to override the default index settings and mappings used by Structures.
-*/
-declare function EsIndexConfiguration(_value: EsIndexConfigurationData): (_constructor: Function) => void;
-declare function Flattened(target: any, propertyKey: string): void;
-/**
-* Signifies that a property is the ID of the entity.
-*/
-declare function Id(target: any, propertyKey: string): void;
-declare function Nested(target: any, propertyKey: string): void;
-/**
-* Signifies that a property is not indexed in Elasticsearch.
-*/
-declare function NotIndexed(_target: any, _propertyKey: string): void;
-declare function NotNull(target: any, propertyKey: string): void;
-declare function Policy(_policies: string[][]): (_target: any, _propertyKey?: string, _descriptor?: PropertyDescriptor) => void;
-declare class PrecisionConfig {
-	precisionType: PrecisionType;
-	constructor(precisionType: PrecisionType);
-}
-declare function Precision(precisionType?: PrecisionType): (target: any, propertyKey: string) => void;
-declare function Query(statements: string): (target: any, key: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-declare function Role(_roles: string[]): (_target: any, _propertyKey?: string, _descriptor?: PropertyDescriptor) => void;
-declare function Text(target: any, propertyKey: string): void;
-/**
-* This is used for data streams to signify the field that should be used as the time reference.
-*/
-declare function TimeReference(_target: any, _propertyKey: string): void;
-declare function Version(_target: any, _propertyKey: string): void;
-declare function TenantId(_target: any, _propertyKey: string): void;
-import { C3Decorator as C3Decorator2 } from "@kinotic-ai/idl";
-/**
-* Provides a way to add decorators to an entity service
-*/
-declare class EntityServiceDecoratorsDecorator extends C3Decorator2 {
-	config: EntityServiceDecoratorsConfig;
-	constructor();
-}
-declare class PolicyDecorator extends EntityServiceDecorator {
-	policies: string[][];
-	constructor(policies: string[][]);
-}
-/**
-* Provides a mechanism to apply the @Policy decorator to an {@link EntityService}
-* @param policies to be supplied
-*/
-declare function $Policy(policies: string[][]): PolicyDecorator;
-declare class RoleDecorator extends EntityServiceDecorator {
-	roles: string[];
-	constructor(roles: string[]);
-}
-/**
-* Provides a mechanism to apply the @Role decorator to an {@link EntityService}
-* @param roles to be supplied
-*/
-declare function $Role(roles: string[]): RoleDecorator;
-import { IKinotic as IKinotic2 } from "@kinotic-ai/core";
-import { IServiceProxy as IServiceProxy2, Page as Page2, Pageable as Pageable3, IterablePage as IterablePage3 } from "@kinotic-ai/core";
-type TenantSelection = string[];
-interface IAdminEntitiesService {
-	/**
-	* Returns the number of entities available.
-	* @param structureId the id of the structure to count
-	* @param tenantSelection the list of tenants to use when retrieving the entity records
-	* @return {@link Promise} emitting the number of entities.
-	*/
-	count(structureId: string, tenantSelection: TenantSelection): Promise<number>;
-	/**
-	* Returns the number of entities available for the given query.
-	*
-	* @param structureId the id of the structure to save the entity for
-	* @param query       the query used to limit result
-	* @param tenantSelection the list of tenants to use when retrieving the entity records
-	* @return Promise    emitting the number of entities
-	*/
-	countByQuery(structureId: string, query: string, tenantSelection: TenantSelection): Promise<number>;
-	/**
-	* Deletes the entity with the given id.
-	*
-	* @param structureId the id of the structure to save the entity for
-	* @param id          must not be {@literal null}
-	* @return {@link Promise} emitting when delete is complete
-	* @throws IllegalArgumentException in case the given {@literal id} is {@literal null}
-	*/
-	deleteById(structureId: string, id: TenantSpecificId): Promise<void>;
-	/**
-	* Deletes the entity with the given id.
-	*
-	* @param structureId the id of the structure to save the entity for
-	* @param query      the query used to filter records to delete, must not be {@literal null}
-	* @param tenantSelection the list of tenants to use when deleting the entity records
-	* @return Promise signaling when operation has completed
-	* @throws Error in case the given {@literal query} is {@literal null}
-	*/
-	deleteByQuery(structureId: string, query: string, tenantSelection: TenantSelection): Promise<void>;
-	/**
-	* Returns a {@link IterablePage} of entities meeting the paging restriction provided in the {@link Pageable} object.
-	*
-	* @param structureId the id of the structure to save the entity for
-	* @param tenantSelection the list of tenants to use when retrieving the entity records
-	* @param pageable    the page settings to be used
-	* @return a page of entities
-	*/
-	findAll<T>(structureId: string, tenantSelection: TenantSelection, pageable: Pageable3): Promise<IterablePage3<T>>;
-	/**
-	* Retrieves an entity by its id.
-	*
-	* @param structureId the id of the structure to save the entity for
-	* @param id          must not be {@literal null}
-	* @return {@link Promise} with the entity with the given id or {@link Promise} emitting null if none found
-	* @throws IllegalArgumentException in case the given {@literal id} is {@literal null}
-	*/
-	findById<T>(structureId: string, id: TenantSpecificId): Promise<T>;
-	/**
-	* Retrieves a list of entities by their id.
-	*
-	* @param structureId the id of the structure to save the entity for
-	* @param ids      must not be {@literal null}
-	* @return Promise emitting the entities with the given ids or Promise emitting null if none found
-	* @throws Error in case the given {@literal ids} is {@literal null}
-	*/
-	findByIds<T>(structureId: string, ids: TenantSpecificId[]): Promise<T[]>;
-	/**
-	* Executes a named query.
-	* @param structureId the id of the structure that this named query is defined for
-	* @param queryName the name of the function that defines the query
-	* @param parameters to pass to the query
-	* @returns Promise with the result of the query
-	*/
-	namedQuery<T>(structureId: string, queryName: string, parameters: QueryParameter[]): Promise<T>;
-	/**
-	* Executes a named query and returns a Page of results.
-	* @param structureId the id of the structure that this named query is defined for
-	* @param queryName the name of the function that defines the query
-	* @param parameters to pass to the query
-	* @param pageable the page settings to be used
-	* @returns Promise with the result of the query
-	*/
-	namedQueryPage<T>(structureId: string, queryName: string, parameters: QueryParameter[], pageable: Pageable3): Promise<IterablePage3<T>>;
-	/**
-	* Returns a {@link IterablePage} of entities matching the search text and paging restriction provided in the {@link Pageable} object.
-	*
-	* @param structureId the id of the structure to save the entity for
-	* @param searchText  the text to search for entities for
-	* @param tenantSelection the list of tenants to use when retrieving the entity records
-	* @param pageable    the page settings to be used
-	* @return a page of entities
-	*/
-	search<T>(structureId: string, searchText: string, tenantSelection: TenantSelection, pageable: Pageable3): Promise<IterablePage3<T>>;
-}
-declare class AdminEntitiesService implements IAdminEntitiesService {
-	protected serviceProxy: IServiceProxy2;
-	constructor(kinotic: IKinotic2);
-	count(structureId: string, tenantSelection: TenantSelection): Promise<number>;
-	countByQuery(structureId: string, query: string, tenantSelection: TenantSelection): Promise<number>;
-	deleteById(structureId: string, id: TenantSpecificId): Promise<void>;
-	deleteByQuery(structureId: string, query: string, tenantSelection: TenantSelection): Promise<void>;
-	findAll<T>(structureId: string, tenantSelection: TenantSelection, pageable: Pageable3): Promise<IterablePage3<T>>;
-	findAllSinglePage<T>(structureId: string, tenantSelection: TenantSelection, pageable: Pageable3): Promise<Page2<T>>;
-	findById<T>(structureId: string, id: TenantSpecificId): Promise<T>;
-	findByIds<T>(structureId: string, ids: TenantSpecificId[]): Promise<T[]>;
-	namedQuery<T>(structureId: string, queryName: string, parameters: QueryParameter[]): Promise<T>;
-	namedQueryPage<T>(structureId: string, queryName: string, parameters: QueryParameter[], pageable: Pageable3): Promise<IterablePage3<T>>;
-	namedQuerySinglePage<T>(structureId: string, queryName: string, parameters: QueryParameter[], pageable: Pageable3): Promise<Page2<T>>;
-	search<T>(structureId: string, searchText: string, tenantSelection: TenantSelection, pageable: Pageable3): Promise<IterablePage3<T>>;
-	searchSinglePage<T>(structureId: string, searchText: string, tenantSelection: TenantSelection, pageable: Pageable3): Promise<Page2<T>>;
-}
 import { Pageable as Pageable4, IterablePage as IterablePage4 } from "@kinotic-ai/core";
 /**
-* This is the base interface for all admin entity services.
+* This is the base interface for all admin entity repositories.
 * It provides the basic CRUD operations for entities with multi-tenancy support.
 */
-interface IAdminEntityService<T> {
+interface IAdminEntityRepository<T> {
 	/**
-	* The application id of the Entity this service is for
+	* The application id of the Entity this repository is for
 	*/
 	entityApplicationId: string;
 	/**
-	* The name of the Entity this service is for
+	* The name of the Entity this repository is for
 	*/
 	entityName: string;
 	/**
-	* The id of the Entity this service is for
+	* The id of the Entity this repository is for
 	* Which is the applicationId + '.' + name
 	*/
 	entityId: string;
@@ -706,7 +707,7 @@ interface IAdminEntityService<T> {
 	* @return Promise emitting the entity with the given id or Promise emitting null if none found
 	* @throws Error in case the given {@literal id} is {@literal null}
 	*/
-	findById(id: TenantSpecificId): Promise<T>;
+	findById(id: TenantSpecificId): Promise<T | null>;
 	/**
 	* Retrieves a list of entities by their id.
 	*
@@ -741,15 +742,15 @@ interface IAdminEntityService<T> {
 	search(searchText: string, tenantSelection: TenantSelection, pageable: Pageable4): Promise<IterablePage4<T>>;
 }
 /**
-* This is the base class for all admin entity services.
+* This is the base class for all admin entity repositories.
 * It provides the basic CRUD operations for entities with multi-tenancy support.
 */
-declare class AdminEntityService<T> implements IAdminEntityService<T> {
+declare class AdminEntityRepository<T> implements IAdminEntityRepository<T> {
 	entityApplicationId: string;
 	entityName: string;
 	entityId: string;
-	private readonly adminEntitiesService;
-	constructor(structureApplicationId: string, structureName: string, adminEntitiesService?: IAdminEntitiesService);
+	private readonly adminEntitiesRepository;
+	constructor(entityApplicationId: string, entityName: string, adminEntitiesRepository?: IAdminEntitiesRepository);
 	count(tenantSelection: TenantSelection): Promise<number>;
 	countByQuery(query: string, tenantSelection: TenantSelection): Promise<number>;
 	deleteById(id: TenantSpecificId): Promise<void>;
@@ -763,11 +764,11 @@ declare class AdminEntityService<T> implements IAdminEntityService<T> {
 }
 import { KinoticPlugin } from "@kinotic-ai/core";
 interface IPersistenceExtension {
-	entities: IEntitiesService;
-	adminEntities: IAdminEntitiesService;
+	entities: IEntitiesRepository;
+	adminEntities: IAdminEntitiesRepository;
 }
 declare const PersistencePlugin: KinoticPlugin<IPersistenceExtension>;
 declare module "@kinotic-ai/core" {
 	interface KinoticSingleton extends IPersistenceExtension {}
 }
-export { Version, TimeReference, Text, TenantSpecificId, TenantSelection, TenantId, RoleDecorator, Role, QueryParameter, QueryOptions, Query, PrecisionType, PrecisionConfig, Precision, PolicyDecorator, Policy, PersistencePlugin, NotNull, NotIndexed, Nested, MultiTenancyType, KinoticPersistenceDecorator, Id, IPersistenceExtension, IEntityService, IEntitiesService, IAdminEntityService, IAdminEntitiesService, Flattened, EsIndexConfigurationData, EsIndexConfiguration, EntityType, EntityServiceDecoratorsDecorator, EntityServiceDecoratorsConfig, EntityServiceDecorators, EntityServiceDecorator, EntityService, EntityConfig, Entity, EntitiesService, DiscriminatorConfig, Discriminator, DecoratedFunction, AutoGeneratedId, AdminEntityService, AdminEntitiesService, $Role, $Policy };
+export { Version, TimeReference, Text, TenantSpecificId, TenantSelection, TenantId, RoleDecorator, Role, QueryParameter, QueryOptions, Query, PrecisionType, PrecisionConfig, Precision, PolicyDecorator, Policy, PersistencePlugin, NotNull, NotIndexed, Nested, MultiTenancyType, KinoticPersistenceDecorator, Id, IPersistenceExtension, IEntityRepository, IEntitiesRepository, IAdminEntityRepository, IAdminEntitiesRepository, Flattened, EsIndexConfigurationData, EsIndexConfiguration, EntityType, EntityServiceDecoratorsDecorator, EntityServiceDecoratorsConfig, EntityServiceDecorators, EntityServiceDecorator, EntityRepository, EntityConfig, Entity, EntitiesRepository, DiscriminatorConfig, Discriminator, DecoratedFunction, AutoGeneratedId, AdminEntityRepository, AdminEntitiesRepository, $Role, $Policy };