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

package/dist/index.d.ts

@@ -33,14 +33,27 @@ declare class ConnectionInfo extends ServerInfo {
 	*/
 	disableStickySession?: boolean | null;
 }
+import { IEvent } from "./IEventBus";
 /**
-* Instances of this interface have a unique id (identity) and are therefore "Identifiable"
-* Created by navid on 2/3/20
+* Interface for the service context, extendable by users for type-safe context data.
+*
+* @author Navid Mitchell 🤝Grok
+* @since 3/25/2025
 */
-interface Identifiable<T> {
-	id: T | null;
+interface ServiceContext {
+	[key: string]: any;
 }
 /**
+* Interface for interceptors that create or modify the ServiceContext before service method invocation.
+*
+* @author Navid Mitchell 🤝Grok
+* @since 3/25/2025
+*/
+interface ContextInterceptor<T extends ServiceContext> {
+	intercept(event: IEvent, context: T): Promise<T> | T;
+}
+import { Identifiable } from "@/api/Identifiable";
+/**
 * Created by Navíd Mitchell 🤪on 6/16/23.
 */
 interface IParticipant extends Identifiable<string> {
@@ -87,291 +100,6 @@ declare class ConnectedInfo {
 	replyToId: string;
 	participant: Participant;
 }
-/**
-* A page is a sublist of a list of objects.
-* @author Navid Mitchell
-*/
-interface Page<T> {
-	/**
-	* @return the total number of elements or null or undefined if not known.
-	*/
-	readonly totalElements: number | null | undefined;
-	/**
-	* The cursor to be used for subsequent retrieval of data.
-	* @return an opaque string representation of the cursor, or null if this is the last page, or undefined if cursor paging is not being used.
-	*/
-	readonly cursor: string | null | undefined;
-	/**
-	* @return the page content as {@link Array} or null or undefined if no data is available.
-	*/
-	readonly content: T[] | null | undefined;
-}
-/**
-* Enumeration for sort directions.
-*
-* Adapted from the Spring Data Commons Package
-*
-* @author Oliver Gierke
-* @author Navid Mitchell
-*/
-declare enum Direction {
-	ASC = "ASC",
-	DESC = "DESC"
-}
-/**
-* Enumeration for null handling hints that can be used in {@link Order} expressions.
-*
-* Adapted from the Spring Data Commons Package
-*
-* @author Thomas Darimont
-* @author Navid Mitchell
-* @since 1.8
-*/
-declare enum NullHandling {
-	/**
-	* Lets the data store decide what to do with nulls.
-	*/
-	NATIVE = "NATIVE",
-	/**
-	* A hint to the used data store to order entries with null values before non-null entries.
-	*/
-	NULLS_FIRST = "NULLS_FIRST",
-	/**
-	* A hint to the used data store to order entries with null values after non-null entries.
-	*/
-	NULLS_LAST = "NULLS_LAST"
-}
-declare class Order {
-	property: string;
-	direction: Direction;
-	nullHandling: NullHandling;
-	constructor(property: string, direction: Direction | null);
-	/**
-	* Returns whether sorting for this property shall be ascending.
-	*/
-	isAscending(): boolean;
-	/**
-	* Returns whether sorting for this property shall be descending.
-	*/
-	isDescending(): boolean;
-}
-/**
-* Sort option for queries. You have to provide at least a list of properties to sort for that must not include
-* {@literal null} or empty strings. The direction defaults to {@link Sort#DEFAULT_DIRECTION}.
-*
-* Adapted from the Spring Data Commons Package
-*
-* @author Oliver Gierke
-* @author Thomas Darimont
-* @author Mark Paluch
-* @author Navid Mitchell
-*/
-declare class Sort {
-	orders: Order[];
-}
-/**
-* Abstract interface for pagination information.
-*
-* Adapted from the Spring Data Commons Package
-*
-* @author Oliver Gierke
-* @author Navid Mitchell
-*/
-declare abstract class Pageable {
-	/**
-	* Returns the sorting parameters (optional).
-	*/
-	sort?: Sort | null | undefined;
-	/**
-	* Returns the number of items to be returned.
-	*/
-	pageSize: number;
-	/**
-	* Creates a {@link Pageable} that uses Offset based pagination.
-	* @param pageNumber zero based page index.
-	* @param pageSize the size of the page to be returned.
-	* @param sort the sorting parameters (optional).
-	*/
-	static create(pageNumber: number, pageSize: number, sort?: Sort | null): OffsetPageable;
-	/**
-	* Creates a {@link Pageable} that uses Cursor based pagination.
-	* @param cursor the cursor to be used for subsequent retrieval of data, or null if this is the first page.
-	* @param pageSize the size of the page to be returned.
-	* @param sort the sorting parameters (optional).
-	*/
-	static createWithCursor(cursor: string | null, pageSize: number, sort?: Sort | null): CursorPageable;
-}
-/**
-* Implementation of {@link Pageable} that uses Offset based pagination.
-*/
-declare class OffsetPageable extends Pageable {
-	/**
-	* Returns the page to be returned.
-	*/
-	pageNumber: number;
-	/**
-	* Creates a {@link Pageable} that uses Offset based pagination.
-	* @param pageNumber zero based page index.
-	* @param pageSize the size of the page to be returned.
-	* @param sort the sorting parameters (optional).
-	*/
-	constructor(pageNumber: number, pageSize: number, sort?: Sort | null);
-}
-/**
-* Implementation of {@link Pageable} that uses Cursor based pagination.
-*/
-declare class CursorPageable extends Pageable {
-	/**
-	* The cursor to be used for subsequent retrieval of data, or null if this is the first page.
-	*/
-	cursor: string | null;
-	/**
-	* Creates a {@link Pageable} that uses Cursor based pagination.
-	* @param cursor the cursor to be used for subsequent retrieval of data, or null if this is the first page.
-	* @param pageSize the size of the page to be returned.
-	* @param sort the sorting parameters (optional).
-	*/
-	constructor(cursor: string | null, pageSize: number, sort?: Sort | null);
-}
-/**
-* {@link IDataSource} provides an abstract way to retrieve data from various sources
-*/
-interface IDataSource<T> {
-	/**
-	* Returns a {@link Page} of entities meeting the paging restriction provided in the {@code Pageable} object.
-	*
-	* @param pageable the page settings to be used
-	* @return a {@link Promise} emitting the page of entities
-	*/
-	findAll(pageable: Pageable): Promise<IterablePage<T>>;
-	/**
-	* Returns a {@link Page} of entities matching the search text and paging restriction provided in the {@code Pageable} object.
-	*
-	* @param searchText the text to search for entities for
-	* @param pageable the page settings to be used
-	* @return a {@link Promise} emitting the page of entities
-	*/
-	search(searchText: string, pageable: Pageable): Promise<IterablePage<T>>;
-}
-interface IEditableDataSource<T extends Identifiable<string>> extends IDataSource<T> {
-	/**
-	* Creates a new entity if one does not already exist for the given id
-	* @param entity to create if one does not already exist
-	* @return a {@link Promise} containing the new entity or an error if an exception occurred
-	*/
-	create(entity: T): Promise<T>;
-	/**
-	* Saves a given entity. Use the returned instance for further operations as the save operation might have changed the
-	* entity instance completely.
-	*
-	* @param entity must not be {@literal null}.
-	* @return a {@link Promise} emitting the saved entity.
-	* @throws Error in case the given {@literal entity} is {@literal null}.
-	*/
-	save(entity: T): Promise<T>;
-	/**
-	* Retrieves an entity by its id.
-	*
-	* @param id must not be {@literal null}.
-	* @return a {@link Promise} emitting the entity with the given id or {@link Promise#empty()} if none found.
-	* @throws IllegalArgumentException in case the given {@literal identity} is {@literal null}.
-	*/
-	findById(id: string): Promise<T>;
-	/**
-	* Deletes the entity with the given id.
-	*
-	* @param id must not be {@literal null}.
-	* @return a {@link Promise} signaling when operation has completed.
-	* @throws IllegalArgumentException in case the given {@literal identity} is {@literal null}.
-	*/
-	deleteById(id: string): Promise<void>;
-	/**
-	* Returns a {@link Page} of entities not in the ids list and meeting the paging restriction provided in the {@code Pageable} object.
-	*
-	* @param ids not to be returned in the Page
-	* @param pageable the page settings to be used
-	* @return a {@link Promise} emitting the page of entities
-	*/
-	findByIdNotIn(ids: string[], pageable: Pageable): Promise<Page<Identifiable<string>>>;
-}
-declare class DataSourceUtils {
-	static instanceOfEditableDataSource(datasource: IDataSource<any> | IEditableDataSource<any>): datasource is IEditableDataSource<any>;
-}
-/**
-* A {@link ICrudServiceProxy} is a proxy for a remote CRUD service
-*/
-interface ICrudServiceProxy<T extends Identifiable<string>> extends IEditableDataSource<T> {
-	/**
-	* Creates a new entity if one does not already exist for the given id
-	* @param entity to create if one does not already exist
-	* @return a {@link Promise} containing the new entity or an error if an exception occurred
-	*/
-	create(entity: T): Promise<T>;
-	/**
-	* Saves a given entity. Use the returned instance for further operations as the save operation might have changed the
-	* entity instance completely.
-	*
-	* @param entity must not be {@literal null}.
-	* @return a {@link Promise} emitting the saved entity.
-	* @throws Error in case the given {@literal entity} is {@literal null}.
-	*/
-	save(entity: T): Promise<T>;
-	/**
-	* Retrieves an entity by its id.
-	*
-	* @param id must not be {@literal null}.
-	* @return a {@link Promise} emitting the entity with the given id or {@link Promise#empty()} if none found.
-	* @throws IllegalArgumentException in case the given {@literal identity} is {@literal null}.
-	*/
-	findById(id: string): Promise<T>;
-	/**s
-	* Returns the number of entities available.
-	*
-	* @return a {@link Promise} emitting the number of entities.
-	*/
-	count(): Promise<number>;
-	/**
-	* Deletes the entity with the given id.
-	*
-	* @param id must not be {@literal null}.
-	* @return a {@link Promise} signaling when operation has completed.
-	* @throws IllegalArgumentException in case the given {@literal identity} is {@literal null}.
-	*/
-	deleteById(id: string): Promise<void>;
-	/**
-	* Returns a {@link Page} of entities meeting the paging restriction provided in the {@code Pageable} object.
-	*
-	* @param pageable the page settings to be used
-	* @return a {@link Promise} emitting the page of entities
-	*/
-	findAll(pageable: Pageable): Promise<IterablePage<T>>;
-	/**
-	* Returns a {@link Page} of entities not in the ids list and meeting the paging restriction provided in the {@code Pageable} object.
-	*
-	* @param ids not to be returned in the Page
-	* @param pageable the page settings to be used
-	* @return a {@link Promise} emitting the page of entities
-	*/
-	findByIdNotIn(ids: string[], pageable: Pageable): Promise<Page<Identifiable<string>>>;
-	/**
-	* Returns a {@link Page} of entities matching the search text and paging restriction provided in the {@code Pageable} object.
-	*
-	* @param searchText the text to search for entities for
-	* @param pageable the page settings to be used
-	* @return a {@link Promise} emitting the page of entities
-	*/
-	search(searchText: string, pageable: Pageable): Promise<IterablePage<T>>;
-}
-/**
-* Produces {@link ICrudServiceProxy} Proxies for a known remote CRUD service
-*/
-interface ICrudServiceProxyFactory {
-	/**
-	* Produces a {@link ICrudServiceProxy} for the given serviceIdentifier
-	* @param serviceIdentifier the service identifier to produce a proxy for
-	*/
-	crudServiceProxy<T extends Identifiable<string>>(serviceIdentifier: string): ICrudServiceProxy<T>;
-}
 import { Optional } from "typescript-optional";
 import { Observable } from "rxjs";
 /**
@@ -388,7 +116,7 @@ declare class KinoticError extends Error {
 *
 * Created by Navid Mitchell on 2019-01-04.
 */
-interface IEvent {
+interface IEvent2 {
 	/**
 	* The cri that specifies where the event should be routed
 	*/
@@ -491,14 +219,14 @@ interface IEventBus {
 	* Creates a subscription for all {@link IEvent}'s for the given destination
 	* @param cri to subscribe to
 	*/
-	observe(cri: string): Observable<IEvent>;
+	observe(cri: string): Observable<IEvent2>;
 	/**
 	* Sends an {@link IEvent} expecting a response
 	* All response correlation will be handled internally
 	* @param event to send as the request
 	* @return a Promise that will resolve when the response is received
 	*/
-	request(event: IEvent): Promise<IEvent>;
+	request(event: IEvent2): Promise<IEvent2>;
 	/**
 	* Sends an {@link IEvent} expecting multiple responses
 	* All response correlation will be handled internally
@@ -507,12 +235,12 @@ interface IEventBus {
 	* @return an {@link Observable<IEvent} that will provide the response stream
 	* NOTE: the naming here is similar to RSocket https://www.baeldung.com/rsocket#3-requeststream
 	*/
-	requestStream(event: IEvent, sendControlEvents: boolean): Observable<IEvent>;
+	requestStream(event: IEvent2, sendControlEvents: boolean): Observable<IEvent2>;
 	/**
 	* Send a single {@link IEvent} to the connected server
 	* @param event to send
 	*/
-	send(event: IEvent): void;
+	send(event: IEvent2): void;
 }
 /**
 * Constants used within {@link IEvent}'s to control the flow of events
@@ -572,36 +300,18 @@ declare enum EventConstants {
 	/**
 	* The traceparent HTTP header field identifies the incoming request in a tracing system. It has four fields:
 	*
-	*     version
-	*     trace-id
-	*     parent-id
-	*     trace-flags
-	* @see https://www.w3.org/TR/trace-context/#traceparent-header
-	*/
-	TRACEPARENT_HEADER = "traceparent",
-	/**
-	* The main purpose of the tracestate header is to provide additional vendor-specific trace identification information across different distributed tracing systems and is a companion header for the traceparent field. It also conveys information about the request’s position in multiple distributed tracing graphs.
-	* @see https://www.w3.org/TR/trace-context/#tracestate-header
-	*/
-	TRACESTATE_HEADER = "tracestate"
-}
-/**
-* Interface for the service context, extendable by users for type-safe context data.
-*
-* @author Navid Mitchell 🤝Grok
-* @since 3/25/2025
-*/
-interface ServiceContext {
-	[key: string]: any;
-}
-/**
-* Interface for interceptors that create or modify the ServiceContext before service method invocation.
-*
-* @author Navid Mitchell 🤝Grok
-* @since 3/25/2025
-*/
-interface ContextInterceptor<T extends ServiceContext> {
-	intercept(event: IEvent, context: T): Promise<T> | T;
+	*     version
+	*     trace-id
+	*     parent-id
+	*     trace-flags
+	* @see https://www.w3.org/TR/trace-context/#traceparent-header
+	*/
+	TRACEPARENT_HEADER = "traceparent",
+	/**
+	* The main purpose of the tracestate header is to provide additional vendor-specific trace identification information across different distributed tracing systems and is a companion header for the traceparent field. It also conveys information about the request’s position in multiple distributed tracing graphs.
+	* @see https://www.w3.org/TR/trace-context/#tracestate-header
+	*/
+	TRACESTATE_HEADER = "tracestate"
 }
 /**
 * `CRI` is a Kinoitc Resource Identifier used by Kinoitc to route requests appropriately.
@@ -745,11 +455,12 @@ declare class ServiceIdentifier {
 	cri(): CRI;
 }
 import { Observable as Observable2 } from "rxjs";
+import { IEvent as IEvent3 } from "./IEventBus";
 /**
 * Provides an interface to allow the {@link IServiceProxy} creator the ability to have fine grain control of the outgoing {@link IEvent}
 */
 interface IEventFactory {
-	create(cri: string, args: any[] | null | undefined): IEvent;
+	create(cri: string, args: any[] | null | undefined): IEvent3;
 }
 /**
 * {@link IServiceProxy} provides the ability to access a remote service
@@ -816,24 +527,16 @@ interface IServiceRegistry {
 	registerContextInterceptor<T extends ServiceContext>(interceptor: ContextInterceptor<T> | null): void;
 }
 /**
-* Default implementation of {@link ICrudServiceProxyFactory}
-*/
-declare class CrudServiceProxyFactory implements ICrudServiceProxyFactory {
-	private serviceRegistry;
-	constructor(serviceRegistry: IServiceRegistry);
-	crudServiceProxy<T extends Identifiable<string>>(serviceIdentifier: string): ICrudServiceProxy<T>;
-}
-/**
 * An implementation of a {@link IEventFactory} which uses JSON content
 */
 declare class JsonEventFactory implements IEventFactory {
-	create(cri: string, args: any[] | null | undefined): IEvent;
+	create(cri: string, args: any[] | null | undefined): IEvent2;
 }
 /**
 * An implementation of a {@link IEventFactory} which uses text content
 */
 declare class TextEventFactory implements IEventFactory {
-	create(cri: string, args: any[] | null | undefined): IEvent;
+	create(cri: string, args: any[] | null | undefined): IEvent2;
 }
 /**
 * The default implementation of {@link IServiceRegistry}
@@ -851,142 +554,435 @@ declare class ServiceRegistry implements IServiceRegistry {
 	unRegister(serviceIdentifier: ServiceIdentifier): void;
 	registerContextInterceptor<T extends ServiceContext>(interceptor: ContextInterceptor<T> | null): void;
 }
-interface IKinotic {
-	serviceRegistry: IServiceRegistry;
-	crudServiceProxyFactory: CrudServiceProxyFactory;
-	eventBus: IEventBus;
+/**
+* A plugin that can be installed into a {@link IKinotic} instance to extend it with additional services.
+*/
+interface KinoticPlugin<TExtension extends object> {
+	install(kinotic: IKinotic): TExtension;
+}
+interface IKinotic {
+	serviceRegistry: IServiceRegistry;
+	eventBus: IEventBus;
+	/**
+	* Requests a connection to the given Stomp url
+	* @param connectionInfo provides the information needed to connect to the kinoitc server
+	* @return Promise containing the result of the initial connection attempt
+	*/
+	connect(connectionInfo: ConnectionInfo): Promise<ConnectedInfo>;
+	/**
+	* Disconnects the client from the server
+	* This will clear any subscriptions and close the connection
+	*/
+	disconnect(force?: boolean): Promise<void>;
+	/**
+	* Creates a new service proxy that can be used to access the desired service.
+	* @param serviceIdentifier the identifier of the service to be accessed
+	* @return the {@link IServiceProxy} that can be used to access the service
+	*/
+	serviceProxy(serviceIdentifier: string): IServiceProxy;
+	/**
+	* Installs a plugin into this Kinotic instance, extending it with additional typed properties.
+	* @param plugin the plugin to install
+	* @return this instance extended with the plugin's properties
+	*/
+	use<TExtension extends object>(plugin: KinoticPlugin<TExtension>): this & TExtension;
+}
+/**
+* Provides a simplified way to connect to Kinotic and access services.
+* All methods use a single connection to the Kinotic Services
+*/
+declare class KinoticSingleton implements IKinotic {
+	/**
+	* The {@link IEventBus} that is used to communicate with the Kinotic server
+	*/
+	private _eventBus;
+	/**
+	* The {@link ServiceRegistry} that is used to manage the services that are available
+	*/
+	readonly serviceRegistry: ServiceRegistry;
+	constructor();
+	get eventBus(): IEventBus;
+	set eventBus(eventBus: IEventBus);
+	/**
+	* Requests a connection to the given Stomp url
+	* @param connectionInfo provides the information needed to connect to the kinoitc server
+	* @return Promise containing the result of the initial connection attempt
+	*/
+	connect(connectionInfo: ConnectionInfo): Promise<ConnectedInfo>;
+	/**
+	* Disconnects the client from the server
+	* This will clear any subscriptions and close the connection
+	*/
+	disconnect(force?: boolean): Promise<void>;
+	/**
+	* Creates a new service proxy that can be used to access the desired service.
+	* @param serviceIdentifier the identifier of the service to be accessed
+	* @return the {@link IServiceProxy} that can be used to access the service
+	*/
+	serviceProxy(serviceIdentifier: string): IServiceProxy;
+	/**
+	* Installs a plugin into this Kinotic instance, extending it with additional typed properties.
+	* @param plugin the plugin to install
+	* @return this instance extended with the plugin's properties
+	*/
+	use<TExtension extends object>(plugin: KinoticPlugin<TExtension>): this & TExtension;
+}
+/**
+* The default {@link IKinotic} instance that can be used to access Kinotic services
+*/
+declare const Kinotic: KinoticSingleton;
+declare const CONTEXT_METADATA_KEY: unique symbol;
+declare function Scope(target: any, propertyKey: string, descriptor?: PropertyDescriptor): void;
+declare function Version(version: string): (target: Function) => void;
+declare function Context(): (target: any, propertyKey: string, parameterIndex: number) => void;
+declare function Publish(namespace: string, name?: string): (target: Function) => any;
+/**
+* A page is a sublist of a list of objects.
+* @author Navid Mitchell
+*/
+interface Page<T> {
+	/**
+	* @return the total number of elements or null or undefined if not known.
+	*/
+	readonly totalElements: number | null | undefined;
+	/**
+	* The cursor to be used for subsequent retrieval of data.
+	* @return an opaque string representation of the cursor, or null if this is the last page, or undefined if cursor paging is not being used.
+	*/
+	readonly cursor: string | null | undefined;
+	/**
+	* @return the page content as {@link Array} or null or undefined if no data is available.
+	*/
+	readonly content: T[] | null | undefined;
+}
+/**
+* Defines a page that is also an async iterator.
+* This allows for easy iteration over all pages of a result set.
+*/
+interface IterablePage<T> extends Page<T>, AsyncIterableIterator<IterablePage<T>> {
+	/**
+	* @return true if this is the last page, false otherwise.
+	*/
+	isLastPage(): boolean;
+	/**
+	* @return true if this page has content, false otherwise.
+	*/
+	hasContent(): boolean;
+}
+/**
+* Enumeration for sort directions.
+*
+* Adapted from the Spring Data Commons Package
+*
+* @author Oliver Gierke
+* @author Navid Mitchell
+*/
+declare enum Direction {
+	ASC = "ASC",
+	DESC = "DESC"
+}
+/**
+* Enumeration for null handling hints that can be used in {@link Order} expressions.
+*
+* Adapted from the Spring Data Commons Package
+*
+* @author Thomas Darimont
+* @author Navid Mitchell
+* @since 1.8
+*/
+declare enum NullHandling {
+	/**
+	* Lets the data store decide what to do with nulls.
+	*/
+	NATIVE = "NATIVE",
+	/**
+	* A hint to the used data store to order entries with null values before non-null entries.
+	*/
+	NULLS_FIRST = "NULLS_FIRST",
+	/**
+	* A hint to the used data store to order entries with null values after non-null entries.
+	*/
+	NULLS_LAST = "NULLS_LAST"
+}
+declare class Order {
+	property: string;
+	direction: Direction;
+	nullHandling: NullHandling;
+	constructor(property: string, direction: Direction | null);
+	/**
+	* Returns whether sorting for this property shall be ascending.
+	*/
+	isAscending(): boolean;
+	/**
+	* Returns whether sorting for this property shall be descending.
+	*/
+	isDescending(): boolean;
+}
+/**
+* Sort option for queries. You have to provide at least a list of properties to sort for that must not include
+* {@literal null} or empty strings. The direction defaults to {@link Sort#DEFAULT_DIRECTION}.
+*
+* Adapted from the Spring Data Commons Package
+*
+* @author Oliver Gierke
+* @author Thomas Darimont
+* @author Mark Paluch
+* @author Navid Mitchell
+*/
+declare class Sort {
+	orders: Order[];
+}
+/**
+* Abstract interface for pagination information.
+*
+* Adapted from the Spring Data Commons Package
+*
+* @author Oliver Gierke
+* @author Navid Mitchell
+*/
+declare abstract class Pageable {
+	/**
+	* Returns the sorting parameters (optional).
+	*/
+	sort?: Sort | null | undefined;
+	/**
+	* Returns the number of items to be returned.
+	*/
+	pageSize: number;
+	/**
+	* Creates a {@link Pageable} that uses Offset based pagination.
+	* @param pageNumber zero based page index.
+	* @param pageSize the size of the page to be returned.
+	* @param sort the sorting parameters (optional).
+	*/
+	static create(pageNumber: number, pageSize: number, sort?: Sort | null): OffsetPageable;
+	/**
+	* Creates a {@link Pageable} that uses Cursor based pagination.
+	* @param cursor the cursor to be used for subsequent retrieval of data, or null if this is the first page.
+	* @param pageSize the size of the page to be returned.
+	* @param sort the sorting parameters (optional).
+	*/
+	static createWithCursor(cursor: string | null, pageSize: number, sort?: Sort | null): CursorPageable;
+}
+/**
+* Implementation of {@link Pageable} that uses Offset based pagination.
+*/
+declare class OffsetPageable extends Pageable {
+	/**
+	* Returns the page to be returned.
+	*/
+	pageNumber: number;
+	/**
+	* Creates a {@link Pageable} that uses Offset based pagination.
+	* @param pageNumber zero based page index.
+	* @param pageSize the size of the page to be returned.
+	* @param sort the sorting parameters (optional).
+	*/
+	constructor(pageNumber: number, pageSize: number, sort?: Sort | null);
+}
+/**
+* Implementation of {@link Pageable} that uses Cursor based pagination.
+*/
+declare class CursorPageable extends Pageable {
+	/**
+	* The cursor to be used for subsequent retrieval of data, or null if this is the first page.
+	*/
+	cursor: string | null;
+	/**
+	* Creates a {@link Pageable} that uses Cursor based pagination.
+	* @param cursor the cursor to be used for subsequent retrieval of data, or null if this is the first page.
+	* @param pageSize the size of the page to be returned.
+	* @param sort the sorting parameters (optional).
+	*/
+	constructor(cursor: string | null, pageSize: number, sort?: Sort | null);
+}
+declare abstract class AbstractIterablePage<T> implements IterablePage<T> {
+	private readonly pageable;
+	private currentPage;
+	private firstPage;
+	protected constructor(pageable: Pageable, page: Page<T>);
+	next(): Promise<IteratorResult<IterablePage<T>>>;
+	[Symbol.asyncIterator](): AsyncIterableIterator<IterablePage<T>>;
+	hasContent(): boolean;
+	isLastPage(): boolean;
+	private isOffsetPageable;
+	get totalElements(): number | null | undefined;
+	get cursor(): string | null | undefined;
+	get content(): T[] | null | undefined;
+}
+/**
+* {@link IDataSource} provides an abstract way to retrieve data from various sources
+*/
+interface IDataSource<T> {
 	/**
-	* Requests a connection to the given Stomp url
-	* @param connectionInfo provides the information needed to connect to the kinoitc server
-	* @return Promise containing the result of the initial connection attempt
+	* Returns a {@link Page} of entities meeting the paging restriction provided in the {@code Pageable} object.
+	*
+	* @param pageable the page settings to be used
+	* @return a {@link Promise} emitting the page of entities
 	*/
-	connect(connectionInfo: ConnectionInfo): Promise<ConnectedInfo>;
+	findAll(pageable: Pageable): Promise<IterablePage<T>>;
 	/**
-	* Disconnects the client from the server
-	* This will clear any subscriptions and close the connection
+	* Returns a {@link Page} of entities matching the search text and paging restriction provided in the {@code Pageable} object.
+	*
+	* @param searchText the text to search for entities for
+	* @param pageable the page settings to be used
+	* @return a {@link Promise} emitting the page of entities
 	*/
-	disconnect(force?: boolean): Promise<void>;
+	search(searchText: string, pageable: Pageable): Promise<IterablePage<T>>;
+}
+interface IEditableDataSource<T extends Identifiable2<string>> extends IDataSource<T> {
 	/**
-	* Creates a new service proxy that can be used to access the desired service.
-	* @param serviceIdentifier the identifier of the service to be accessed
-	* @return the {@link IServiceProxy} that can be used to access the service
+	* Creates a new entity if one does not already exist for the given id
+	* @param entity to create if one does not already exist
+	* @return a {@link Promise} containing the new entity or an error if an exception occurred
 	*/
-	serviceProxy(serviceIdentifier: string): IServiceProxy;
+	create(entity: T): Promise<T>;
 	/**
-	* Returns a {@link ICrudServiceProxy} for the given service identifier
-	* @param serviceIdentifier the identifier of the service to be accessed
+	* Saves a given entity. Use the returned instance for further operations as the save operation might have changed the
+	* entity instance completely.
+	*
+	* @param entity must not be {@literal null}.
+	* @return a {@link Promise} emitting the saved entity.
+	* @throws Error in case the given {@literal entity} is {@literal null}.
+	*/
+	save(entity: T): Promise<T>;
+	/**
+	* Retrieves an entity by its id.
+	*
+	* @param id must not be {@literal null}.
+	* @return a {@link Promise} emitting the entity with the given id or {@link Promise#empty()} if none found.
+	* @throws IllegalArgumentException in case the given {@literal identity} is {@literal null}.
+	*/
+	findById(id: string): Promise<T>;
+	/**
+	* Deletes the entity with the given id.
+	*
+	* @param id must not be {@literal null}.
+	* @return a {@link Promise} signaling when operation has completed.
+	* @throws IllegalArgumentException in case the given {@literal identity} is {@literal null}.
 	*/
-	crudServiceProxy<T extends Identifiable<string>>(serviceIdentifier: string): ICrudServiceProxy<T>;
+	deleteById(id: string): Promise<void>;
+	/**
+	* Returns a {@link Page} of entities not in the ids list and meeting the paging restriction provided in the {@code Pageable} object.
+	*
+	* @param ids not to be returned in the Page
+	* @param pageable the page settings to be used
+	* @return a {@link Promise} emitting the page of entities
+	*/
+	findByIdNotIn(ids: string[], pageable: Pageable): Promise<Page<Identifiable2<string>>>;
+}
+declare class DataSourceUtils {
+	static instanceOfEditableDataSource(datasource: IDataSource<any> | IEditableDataSource<any>): datasource is IEditableDataSource<any>;
 }
 /**
-* Provides a simplified way to connect to Kinotic and access services.
-* All methods use a single connection to the Kinotic Services
+* A {@link ICrudServiceProxy} is a proxy for a remote CRUD service
 */
-declare class KinoticSingleton implements IKinotic {
+interface ICrudServiceProxy<T extends Identifiable2<string>> extends IEditableDataSource<T> {
 	/**
-	* The {@link IEventBus} that is used to communicate with the Kinotic server
+	* Creates a new entity if one does not already exist for the given id
+	* @param entity to create if one does not already exist
+	* @return a {@link Promise} containing the new entity or an error if an exception occurred
 	*/
-	private _eventBus;
+	create(entity: T): Promise<T>;
 	/**
-	* The {@link ServiceRegistry} that is used to manage the services that are available
+	* Saves a given entity. Use the returned instance for further operations as the save operation might have changed the
+	* entity instance completely.
+	*
+	* @param entity must not be {@literal null}.
+	* @return a {@link Promise} emitting the saved entity.
+	* @throws Error in case the given {@literal entity} is {@literal null}.
 	*/
-	readonly serviceRegistry: ServiceRegistry;
+	save(entity: T): Promise<T>;
 	/**
-	* The {@link CrudServiceProxyFactory} that is used to create {@link ICrudServiceProxy} instances
+	* Retrieves an entity by its id.
+	*
+	* @param id must not be {@literal null}.
+	* @return a {@link Promise} emitting the entity with the given id or {@link Promise#empty()} if none found.
+	* @throws IllegalArgumentException in case the given {@literal identity} is {@literal null}.
 	*/
-	readonly crudServiceProxyFactory: CrudServiceProxyFactory;
-	constructor();
-	get eventBus(): IEventBus;
-	set eventBus(eventBus: IEventBus);
+	findById(id: string): Promise<T>;
+	/**s
+	* Returns the number of entities available.
+	*
+	* @return a {@link Promise} emitting the number of entities.
+	*/
+	count(): Promise<number>;
 	/**
-	* Requests a connection to the given Stomp url
-	* @param connectionInfo provides the information needed to connect to the kinoitc server
-	* @return Promise containing the result of the initial connection attempt
+	* Deletes the entity with the given id.
+	*
+	* @param id must not be {@literal null}.
+	* @return a {@link Promise} signaling when operation has completed.
+	* @throws IllegalArgumentException in case the given {@literal identity} is {@literal null}.
 	*/
-	connect(connectionInfo: ConnectionInfo): Promise<ConnectedInfo>;
+	deleteById(id: string): Promise<void>;
 	/**
-	* Disconnects the client from the server
-	* This will clear any subscriptions and close the connection
+	* Returns a {@link Page} of entities meeting the paging restriction provided in the {@code Pageable} object.
+	*
+	* @param pageable the page settings to be used
+	* @return a {@link Promise} emitting the page of entities
 	*/
-	disconnect(force?: boolean): Promise<void>;
+	findAll(pageable: Pageable): Promise<IterablePage<T>>;
 	/**
-	* Creates a new service proxy that can be used to access the desired service.
-	* @param serviceIdentifier the identifier of the service to be accessed
-	* @return the {@link IServiceProxy} that can be used to access the service
+	* Returns a {@link Page} of entities not in the ids list and meeting the paging restriction provided in the {@code Pageable} object.
+	*
+	* @param ids not to be returned in the Page
+	* @param pageable the page settings to be used
+	* @return a {@link Promise} emitting the page of entities
 	*/
-	serviceProxy(serviceIdentifier: string): IServiceProxy;
+	findByIdNotIn(ids: string[], pageable: Pageable): Promise<Page<Identifiable2<string>>>;
 	/**
-	* Returns a {@link ICrudServiceProxy} for the given service identifier
-	* @param serviceIdentifier the identifier of the service to be accessed
+	* Returns a {@link Page} of entities matching the search text and paging restriction provided in the {@code Pageable} object.
+	*
+	* @param searchText the text to search for entities for
+	* @param pageable the page settings to be used
+	* @return a {@link Promise} emitting the page of entities
 	*/
-	crudServiceProxy<T extends Identifiable<string>>(serviceIdentifier: string): ICrudServiceProxy<T>;
-}
-/**
-* The default {@link IKinotic} instance that can be used to access Kinotic services
-*/
-declare const Kinotic: IKinotic;
-declare const CONTEXT_METADATA_KEY: unique symbol;
-declare function Scope(target: any, propertyKey: string, descriptor?: PropertyDescriptor): void;
-declare function Version(version: string): (target: Function) => void;
-declare function Context(): (target: any, propertyKey: string, parameterIndex: number) => void;
-declare function Publish(namespace: string, name?: string): (target: Function) => any;
-declare enum LogLevel {
-	TRACE = "TRACE",
-	DEBUG = "DEBUG",
-	INFO = "INFO",
-	WARN = "WARN",
-	ERROR = "ERROR",
-	FATAL = "FATAL",
-	OFF = "OFF"
-}
-declare class LoggerLevelsDescriptor {
-	configuredLevel?: LogLevel;
-}
-declare class GroupLoggerLevelsDescriptor extends LoggerLevelsDescriptor {
-	members: string[];
+	search(searchText: string, pageable: Pageable): Promise<IterablePage<T>>;
 }
-declare class SingleLoggerLevelsDescriptor extends LoggerLevelsDescriptor {
-	effectiveLevel?: LogLevel;
+declare class CrudServiceProxy<T extends Identifiable2<string>> implements ICrudServiceProxy<T> {
+	protected serviceProxy: IServiceProxy;
+	constructor(serviceProxy: IServiceProxy);
+	count(): Promise<number>;
+	create(entity: T): Promise<T>;
+	deleteById(id: string): Promise<void>;
+	findAll(pageable: Pageable): Promise<IterablePage<T>>;
+	findAllSinglePage(pageable: Pageable): Promise<Page<T>>;
+	findById(id: string): Promise<T>;
+	save(entity: T): Promise<T>;
+	findByIdNotIn(ids: string[], page: Pageable): Promise<Page<Identifiable2<string>>>;
+	search(searchText: string, pageable: Pageable): Promise<IterablePage<T>>;
+	searchSinglePage(searchText: string, pageable: Pageable): Promise<Page<T>>;
 }
 /**
-* Description of loggers
+* Instances of this interface have a unique id (identity) and are therefore "Identifiable"
+* Created by navid on 2/3/20
 */
-declare class LoggersDescriptor {
-	levels: LogLevel[];
-	loggerLevels: Map<string, SingleLoggerLevelsDescriptor>;
-	groups: Map<string, GroupLoggerLevelsDescriptor>;
+interface Identifiable2<T> {
+	id: T | null;
 }
 /**
-* Provides the ability to manage loggers
+* Produces {@link ICrudServiceProxy} Proxies for a known remote CRUD service
 */
-interface ILogManager {
-	/**
-	* @param nodeId the kinoitc node to get the LoggersDescriptor from
-	* @return a {@link LoggersDescriptor} containing all the loggers and their levels
-	*/
-	loggers(nodeId: string): Promise<LoggersDescriptor>;
-	/**
-	* @param nodeId the kinoitc node to get the LoggerLevelsDescriptor from
-	* @param name the name of the logger to get
-	* @return a {@link LoggerLevelsDescriptor} containing the logger and its levels
-	*/
-	loggerLevels(nodeId: string, name: string): Promise<LoggerLevelsDescriptor>;
+interface ICrudServiceProxyFactory {
 	/**
-	* Configures the log level for the logger with the given name
-	* @param nodeId the kinoitc node to set the log level on
-	* @param name the name of the logger to set
-	* @param level the {@link LogLevel} to set for the logger with the given name
+	* Produces a {@link ICrudServiceProxy} for the given serviceIdentifier
+	* @param serviceIdentifier the service identifier to produce a proxy for
 	*/
-	configureLogLevel(nodeId: string, name: string, level: LogLevel): Promise<void>;
+	crudServiceProxy<T extends Identifiable2<string>>(serviceIdentifier: string): ICrudServiceProxy<T>;
 }
-declare class LogManager implements ILogManager {
-	private readonly serviceProxy;
-	constructor();
-	loggers(nodeId: string): Promise<LoggersDescriptor>;
-	loggerLevels(nodeId: string, name: string): Promise<LoggerLevelsDescriptor>;
-	configureLogLevel(nodeId: string, name: string, level: LogLevel): Promise<void>;
+/**
+* Default implementation of {@link ICrudServiceProxyFactory}
+*/
+declare class CrudServiceProxyFactory implements ICrudServiceProxyFactory {
+	private serviceRegistry;
+	constructor(serviceRegistry: IServiceRegistry);
+	crudServiceProxy<T extends Identifiable2<string>>(serviceIdentifier: string): ICrudServiceProxy<T>;
+}
+declare class FunctionalIterablePage<T> extends AbstractIterablePage<T> {
+	private readonly pageFunction;
+	constructor(pageable: Pageable, page: Page<T>, pageFunction: (pageable: Pageable) => Promise<Page<T>>);
+	protected findNext(pageable: Pageable): Promise<Page<T>>;
 }
-declare const logManager: ILogManager;
 declare class AuthenticationError extends KinoticError {
 	constructor(message: string);
 }
@@ -994,18 +990,6 @@ declare class AuthorizationError extends KinoticError {
 	constructor(message: string);
 }
 /**
-* Some common constants used for the {@link Participant} and {@link Participant#getMetadata()}
-* Created by navid on 2/3/20
-*/
-declare class ParticipantConstants {
-	static readonly PARTICIPANT_TYPE_METADATA_KEY: string;
-	static readonly PARTICIPANT_TYPE_DEVICE: string;
-	static readonly PARTICIPANT_TYPE_CLI: string;
-	static readonly PARTICIPANT_TYPE_USER: string;
-	static readonly PARTICIPANT_TYPE_NODE: string;
-	static readonly CLI_PARTICIPANT_ID: string;
-}
-/**
 * Default implementation of the `CRI` interface.
 *
 * @author Navid Mitchell
@@ -1041,7 +1025,7 @@ import { Optional as Optional2 } from "typescript-optional";
 /**
 * Default IEvent implementation
 */
-declare class Event implements IEvent {
+declare class Event implements IEvent2 {
 	cri: string;
 	headers: Map<string, string>;
 	data: Optional2<Uint8Array>;
@@ -1071,11 +1055,11 @@ declare class EventBus implements IEventBus {
 	isConnected(): boolean;
 	connect(connectionInfo: ConnectionInfo): Promise<ConnectedInfo>;
 	disconnect(force?: boolean): Promise<void>;
-	send(event: IEvent): void;
-	request(event: IEvent): Promise<IEvent>;
-	requestStream(event: IEvent, sendControlEvents?: boolean): Observable3<IEvent>;
+	send(event: IEvent2): void;
+	request(event: IEvent2): Promise<IEvent2>;
+	requestStream(event: IEvent2, sendControlEvents?: boolean): Observable3<IEvent2>;
 	listen(_serverInfo: ServerInfo): Promise<void>;
-	observe(cri: string): Observable3<IEvent>;
+	observe(cri: string): Observable3<IEvent2>;
 	private cleanup;
 	/**
 	* Creates the proper error to return if this.stompConnectionManager?.rxStomp is not available on a send request
@@ -1089,71 +1073,16 @@ declare class EventBus implements IEventBus {
 	*/
 	private _observe;
 }
-declare enum StreamOperation {
-	EXISTING = "EXISTING",
-	UPDATE = "UPDATE",
-	REMOVE = "REMOVE"
-}
-/**
-* Holder for domain objects that will be returned as a stream of changes to a data set
-*
-* Created by Navid Mitchell on 6/3/20
-*/
-declare class StreamData<
-	I,
-	T
-> implements Identifiable<I> {
-	streamOperation: StreamOperation;
-	id: I;
-	value: T;
-	constructor(streamOperation: StreamOperation, id: I, value: T);
-	isSet(): boolean;
-}
 /**
-* Defines a page that is also an async iterator.
-* This allows for easy iteration over all pages of a result set.
+* Some common constants used for the {@link Participant} and {@link Participant#getMetadata()}
+* Created by navid on 2/3/20
 */
-interface IterablePage<T> extends Page<T>, AsyncIterableIterator<IterablePage<T>> {
-	/**
-	* @return true if this is the last page, false otherwise.
-	*/
-	isLastPage(): boolean;
-	/**
-	* @return true if this page has content, false otherwise.
-	*/
-	hasContent(): boolean;
-}
-declare abstract class AbstractIterablePage<T> implements IterablePage<T> {
-	private readonly pageable;
-	private currentPage;
-	private firstPage;
-	protected constructor(pageable: Pageable, page: Page<T>);
-	next(): Promise<IteratorResult<IterablePage<T>>>;
-	[Symbol.asyncIterator](): AsyncIterableIterator<IterablePage<T>>;
-	hasContent(): boolean;
-	isLastPage(): boolean;
-	private isOffsetPageable;
-	get totalElements(): number | null | undefined;
-	get cursor(): string | null | undefined;
-	get content(): T[] | null | undefined;
-}
-declare class CrudServiceProxy<T extends Identifiable<string>> implements ICrudServiceProxy<T> {
-	protected serviceProxy: IServiceProxy;
-	constructor(serviceProxy: IServiceProxy);
-	count(): Promise<number>;
-	create(entity: T): Promise<T>;
-	deleteById(id: string): Promise<void>;
-	findAll(pageable: Pageable): Promise<IterablePage<T>>;
-	findAllSinglePage(pageable: Pageable): Promise<Page<T>>;
-	findById(id: string): Promise<T>;
-	save(entity: T): Promise<T>;
-	findByIdNotIn(ids: string[], page: Pageable): Promise<Page<Identifiable<string>>>;
-	search(searchText: string, pageable: Pageable): Promise<IterablePage<T>>;
-	searchSinglePage(searchText: string, pageable: Pageable): Promise<Page<T>>;
-}
-declare class FunctionalIterablePage<T> extends AbstractIterablePage<T> {
-	private readonly pageFunction;
-	constructor(pageable: Pageable, page: Page<T>, pageFunction: (pageable: Pageable) => Promise<Page<T>>);
-	protected findNext(pageable: Pageable): Promise<Page<T>>;
+declare class ParticipantConstants {
+	static readonly PARTICIPANT_TYPE_METADATA_KEY: string;
+	static readonly PARTICIPANT_TYPE_DEVICE: string;
+	static readonly PARTICIPANT_TYPE_CLI: string;
+	static readonly PARTICIPANT_TYPE_USER: string;
+	static readonly PARTICIPANT_TYPE_NODE: string;
+	static readonly CLI_PARTICIPANT_ID: string;
 }
-export { logManager, createCRI, Version, TextEventFactory, StreamOperation, StreamData, Sort, SingleLoggerLevelsDescriptor, ServiceRegistry, ServiceContext, ServerInfo, Scope, Publish, ParticipantConstants, Participant, Pageable, Page, Order, OffsetPageable, NullHandling, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, KinoticSingleton, KinoticError, Kinotic, JsonEventFactory, IterablePage, Identifiable, IServiceRegistry, IServiceProxy, IParticipant, ILogManager, IEventFactory, IEventBus, IEvent, IEditableDataSource, IDataSource, ICrudServiceProxyFactory, ICrudServiceProxy, GroupLoggerLevelsDescriptor, FunctionalIterablePage, EventConstants, EventBus, Event, Direction, DefaultCRI, DataSourceUtils, CursorPageable, CrudServiceProxyFactory, CrudServiceProxy, ContextInterceptor, Context, ConnectionInfo, ConnectedInfo, ConnectHeaders, CRI, CONTEXT_METADATA_KEY, AuthorizationError, AuthenticationError, AbstractIterablePage };
+export { createCRI, Version, TextEventFactory, Sort, ServiceRegistry, ServiceContext, ServerInfo, Scope, Publish, ParticipantConstants, Participant, Pageable, Page, Order, OffsetPageable, NullHandling, KinoticSingleton, KinoticPlugin, KinoticError, Kinotic, JsonEventFactory, IterablePage, Identifiable2 as Identifiable, IServiceRegistry, IServiceProxy, IParticipant, IKinotic, IEventFactory, IEventBus, IEvent2 as IEvent, IEditableDataSource, IDataSource, ICrudServiceProxyFactory, ICrudServiceProxy, FunctionalIterablePage, EventConstants, EventBus, Event, Direction, DefaultCRI, DataSourceUtils, CursorPageable, CrudServiceProxyFactory, CrudServiceProxy, ContextInterceptor, Context, ConnectionInfo, ConnectedInfo, ConnectHeaders, CRI, CONTEXT_METADATA_KEY, AuthorizationError, AuthenticationError, AbstractIterablePage };