@kinotic-ai/persistence 1.0.0-beta.0 → 1.0.0-beta.2

package/dist/index.d.cts

@@ -0,0 +1,681 @@
+/**
+* Represents a query parameter for a named query.
+*/
+type QueryParameter = {
+	key: string;
+	value: any;
+};
+/**
+* Options for a Named Query
+*/
+declare class QueryOptions {
+	timeZone: string;
+	requestTimeout: number;
+	pageTimeout: string;
+}
+/**
+* An identifier that can be used to find a Entity for a specific id and tenant
+*/
+declare class TenantSpecificId {
+	/**
+	* The id of the entity
+	*/
+	entityId: string;
+	/**
+	* The id of the tenant
+	*/
+	tenantId: string;
+	constructor(entityId: string, tenantId: string);
+}
+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 { IKinotic } from "@kinotic-ai/core";
+import { IServiceProxy, Page, Pageable, IterablePage } from "@kinotic-ai/core";
+interface IEntitiesService {
+	/**
+	* Saves all given entities.
+	* @param structureId 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>;
+	/**
+	* Updates all given entities.
+	* @param structureId 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>;
+	/**
+	* Returns the number of entities available.
+	* @param structureId the id of the structure to count
+	* @return {@link Promise} emitting the number of entities.
+	*/
+	count(structureId: 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 query       the query used to limit result
+	* @return Promise    emitting the number of entities
+	*/
+	countByQuery(structureId: 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 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>;
+	/**
+	* 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}
+	* @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>;
+	/**
+	* 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 pageable    the page settings to be used
+	* @return a page of entities
+	*/
+	findAll<T>(structureId: 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 pageable the page settings to be used
+	*/
+	findAllSinglePage<T>(structureId: 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 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>;
+	/**
+	* 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: string[]): 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: 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 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>;
+	/**
+	* 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 pageable    the page settings to be used
+	* @return a page of entities
+	*/
+	search<T>(structureId: 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 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>>;
+	/**
+	* This operation makes all the recent writes immediately available for search.
+	* @param structureId 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>;
+	/**
+	* 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 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>;
+}
+declare class EntitiesService implements IEntitiesService {
+	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>;
+}
+/**
+* This is the base interface for all entity services.
+* It provides the basic CRUD operations for entities.
+*/
+interface IEntityService<T> {
+	/**
+	* The applicationId of the structure this service is for
+	*/
+	structureApplicationId: string;
+	/**
+	* The name of the structure this service is for
+	*/
+	structureName: string;
+	/**
+	* The id of the structure this service is for
+	* Which is the applicationId + '.' + name
+	*/
+	structureId: string;
+	/**
+	* Saves all given entities.
+	* @param entities all the entities to save
+	* @return Promise that will complete when all entities have been saved
+	*/
+	bulkSave(entities: T[]): Promise<void>;
+	/**
+	* Updates all given entities.
+	* @param entities all the entities to save
+	* @return Promise that will complete when all entities have been saved
+	*/
+	bulkUpdate(entities: T[]): Promise<void>;
+	/**
+	* Returns the number of entities available.
+	*
+	* @return Promise emitting the number of entities
+	*/
+	count(): Promise<number>;
+	/**
+	* Returns the number of entities available for the given query.
+	*
+	* @param query       the query used to limit result
+	* @return Promise    emitting the number of entities
+	*/
+	countByQuery(query: string): Promise<number>;
+	/**
+	* Deletes the entity with the given id.
+	*
+	* @param id      must not be {@literal null}
+	* @return Promise signaling when operation has completed
+	* @throws Error in case the given {@literal id} is {@literal null}
+	*/
+	deleteById(id: string): Promise<void>;
+	/**
+	* Deletes the entity with the given id.
+	*
+	* @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(query: string): Promise<void>;
+	/**
+	* Returns a {@link Page} of entities meeting the paging restriction provided in the {@link Pageable} object.
+	*
+	* @param pageable the page settings to be used
+	* @return a page of entities
+	*/
+	findAll(pageable: Pageable2): Promise<IterablePage2<T>>;
+	/**
+	* Retrieves an entity by its id.
+	*
+	* @param id      must not be {@literal null}
+	* @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>;
+	/**
+	* Retrieves a list of entities by their id.
+	*
+	* @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(ids: string[]): Promise<T[]>;
+	/**
+	* Executes a named query.
+	* @param queryName the name of the function that defines the query
+	* @param queryParameters to pass to the query
+	* @returns Promise with the result of the query
+	*/
+	namedQuery<U>(queryName: string, queryParameters: QueryParameter[]): Promise<U>;
+	/**
+	* Executes a named query and returns a Page of results.
+	* @param queryName the name of the function that defines the query
+	* @param queryParameters to pass to the query
+	* @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>>;
+	/**
+	* 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.
+	*
+	* @param entity  must not be {@literal null}
+	* @return Promise emitting the saved entity
+	* @throws Error in case the given {@literal entity} is {@literal null}
+	*/
+	save(entity: T): Promise<T>;
+	/**
+	* Returns a {@link Page} of entities matching the search text and paging restriction provided in the {@link Pageable} object.
+	*
+	* @param searchText the text to search for entities for
+	* @param pageable   the page settings to be used
+	* @return a page of entities
+	*/
+	search(searchText: string, pageable: Pageable2): Promise<IterablePage2<T>>;
+	/**
+	* This operation makes all the recent writes immediately available for search.
+	* @return a Promise that resolves when the operation is complete
+	*/
+	syncIndex(): 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 entity      must not be {@literal null}
+	* @return Promise emitting the saved entity
+	* @throws Error in case the given {@literal entity} is {@literal null}
+	*/
+	update(entity: T): Promise<T>;
+}
+/**
+* This is the base class for all entity services.
+* It provides the basic CRUD operations for entities.
+*/
+declare class EntityService<T> implements IEntityService<T> {
+	structureApplicationId: string;
+	structureName: string;
+	structureId: string;
+	private readonly entitiesService;
+	constructor(structureApplicationId: string, structureName: string, entitiesService?: IEntitiesService);
+	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>;
+	findByIds(ids: string[]): Promise<T[]>;
+	namedQuery<U>(queryName: string, queryParameters: QueryParameter[]): Promise<U>;
+	namedQueryPage<U>(queryName: string, queryParameters: QueryParameter[], pageable: Pageable2): Promise<IterablePage2<U>>;
+	save(entity: T): Promise<T>;
+	search(searchText: string, pageable: Pageable2): Promise<IterablePage2<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[]>>;
+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 enum EntityType {
+	/**
+	* This is the default type of entity. It is a basic single table entity.
+	*/
+	TABLE = 0,
+	/**
+	* This entity is a stream entity. It is used for streaming data.
+	*/
+	STREAM = 1
+}
+/**
+* Provides configuration for the Elasticsearch index.
+* This can be used to override the default index settings and mappings used by Structures.
+*/
+declare class EsIndexConfigurationData {
+	/**
+	* The Elasticsearch component templates to use when creating this index.
+	*/
+	componentTemplates: string[];
+}
+/**
+* MultiTenancyType is an enum that represents the different types of multi-tenancy that can be applied to an entity.
+*/
+declare enum MultiTenancyType {
+	/**
+	* Default, no multi-tenancy
+	*/
+	NONE = 0,
+	/**
+	* Shared table multi-tenancy
+	*/
+	SHARED = 1
+}
+/**
+* The {@link PrecisionType} enum is used to define the precision of a numeric field in the Continuum IDL.
+*/
+declare enum PrecisionType {
+	/**
+	* A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.
+	*/
+	DOUBLE = 0,
+	/**
+	* A single-precision 32-bit IEEE 754 floating point number, restricted to finite values.
+	*/
+	FLOAT = 1,
+	/**
+	* A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.
+	*/
+	INT = 2,
+	/**
+	* A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.
+	*/
+	LONG = 3,
+	/**
+	* A signed 16-bit integer with a minimum value of -32,768 and a maximum value of 32,767.
+	*/
+	SHORT = 4
+}
+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.
+* It provides the basic CRUD operations for entities with multi-tenancy support.
+*/
+interface IAdminEntityService<T> {
+	/**
+	* The application id of the structure this service is for
+	*/
+	structureApplicationId: string;
+	/**
+	* The name of the structure this service is for
+	*/
+	structureName: string;
+	/**
+	* The id of the structure this service is for
+	* Which is the applicationId + '.' + name
+	*/
+	structureId: string;
+	/**
+	* Returns the number of entities available.
+	*
+	* @param tenantSelection the list of tenants to use when retrieving the entity records
+	* @return Promise emitting the number of entities
+	*/
+	count(tenantSelection: TenantSelection): Promise<number>;
+	/**
+	* Returns the number of entities available for the given query.
+	*
+	* @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(query: string, tenantSelection: TenantSelection): Promise<number>;
+	/**
+	* Deletes the entity with the given id.
+	*
+	* @param id      must not be {@literal null}
+	* @return Promise signaling when operation has completed
+	* @throws Error in case the given {@literal id} is {@literal null}
+	*/
+	deleteById(id: TenantSpecificId): Promise<void>;
+	/**
+	* Deletes the entity with the given id.
+	*
+	* @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(query: string, tenantSelection: TenantSelection): Promise<void>;
+	/**
+	* Returns a {@link Page} of entities meeting the paging restriction provided in the {@link Pageable} object.
+	*
+	* @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(tenantSelection: TenantSelection, pageable: Pageable4): Promise<IterablePage4<T>>;
+	/**
+	* Retrieves an entity by its id.
+	*
+	* @param id      must not be {@literal null}
+	* @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>;
+	/**
+	* Retrieves a list of entities by their id.
+	*
+	* @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(ids: TenantSpecificId[]): Promise<T[]>;
+	/**
+	* Executes a named query.
+	* @param queryName the name of the function that defines the query
+	* @param queryParameters to pass to the query
+	* @returns Promise with the result of the query
+	*/
+	namedQuery<U>(queryName: string, queryParameters: QueryParameter[]): Promise<U>;
+	/**
+	* Executes a named query and returns a Page of results.
+	* @param queryName the name of the function that defines the query
+	* @param queryParameters to pass to the query
+	* @param pageable the page settings to be used
+	* @returns Promise with the result of the query
+	*/
+	namedQueryPage<U>(queryName: string, queryParameters: QueryParameter[], pageable: Pageable4): Promise<IterablePage4<U>>;
+	/**
+	* Returns a {@link Page} of entities matching the search text and paging restriction provided in the {@link Pageable} object.
+	*
+	* @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(searchText: string, tenantSelection: TenantSelection, pageable: Pageable4): Promise<IterablePage4<T>>;
+}
+/**
+* This is the base class for all admin entity services.
+* It provides the basic CRUD operations for entities with multi-tenancy support.
+*/
+declare class AdminEntityService<T> implements IAdminEntityService<T> {
+	structureApplicationId: string;
+	structureName: string;
+	structureId: string;
+	private readonly adminEntitiesService;
+	constructor(structureApplicationId: string, structureName: string, adminEntitiesService?: IAdminEntitiesService);
+	count(tenantSelection: TenantSelection): Promise<number>;
+	countByQuery(query: string, tenantSelection: TenantSelection): Promise<number>;
+	deleteById(id: TenantSpecificId): Promise<void>;
+	deleteByQuery(query: string, tenantSelection: TenantSelection): Promise<void>;
+	findAll(tenantSelection: TenantSelection, pageable: Pageable4): Promise<IterablePage4<T>>;
+	findById(id: TenantSpecificId): Promise<T>;
+	findByIds(ids: TenantSpecificId[]): Promise<T[]>;
+	namedQuery<U>(queryName: string, queryParameters: QueryParameter[]): Promise<U>;
+	namedQueryPage<U>(queryName: string, queryParameters: QueryParameter[], pageable: Pageable4): Promise<IterablePage4<U>>;
+	search(searchText: string, tenantSelection: TenantSelection, pageable: Pageable4): Promise<IterablePage4<T>>;
+}
+import { KinoticPlugin } from "@kinotic-ai/core";
+interface IPersistenceExtension {
+	entities: IEntitiesService;
+	adminEntities: IAdminEntitiesService;
+}
+declare const PersistencePlugin: KinoticPlugin<IPersistenceExtension>;
+import { Kinotic, KinoticSingleton as KinoticSingleton2, IKinotic as IKinotic3, KinoticPlugin as KinoticPlugin2 } from "@kinotic-ai/core";
+declare module "@kinotic-ai/core" {
+	interface KinoticSingleton extends IPersistenceExtension {}
+}
+export { TenantSpecificId, TenantSelection, QueryParameter, QueryOptions, PrecisionType, PersistencePlugin, MultiTenancyType, KinoticSingleton2 as KinoticSingleton, KinoticPlugin2 as KinoticPlugin, Kinotic, IPersistenceExtension, IKinotic3 as IKinotic, IEntityService, IEntitiesService, IAdminEntityService, IAdminEntitiesService, EsIndexConfigurationData, EntityType, EntityServiceDecoratorsDecorator, EntityServiceDecoratorsConfig, EntityServiceDecorator, EntityService, EntitiesService, DecoratedFunction, AdminEntityService, AdminEntitiesService };