@kinotic-ai/core 1.1.0 → 1.2.1

package/dist/index.d.cts

@@ -641,6 +641,27 @@ 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;
 /**
+* Configuration for a single entities path and its corresponding repository output.
+*/
+type EntitiesPathConfig = {
+	/**
+	* The path to search for classes decorated with @Entity.
+	*/
+	path: string;
+	/**
+	* The path where generated Repository classes will be placed.
+	*/
+	repositoryPath: string;
+	/**
+	* If true, the subfolder structure under the entities path will be mirrored under the repository path.
+	* For example, if entitiesPath is "src/model" and contains "payments/Payment.ts",
+	* the generated repository will be placed in "repositoryPath/payments/".
+	* If false, all generated repositories are placed directly in the repositoryPath.
+	* Defaults to true.
+	*/
+	mirrorFolderStructure?: boolean;
+};
+/**
 * The project configuration for a Kinotic project.
 */
 declare class KinoticProjectConfig {
@@ -659,18 +680,23 @@ declare class KinoticProjectConfig {
 	application: string;
 	/**
 	* The paths to search for classes decorated with @Entity that Kinotic will be created for.
+	* Each entry can be a string (simple path) or an {@link EntitiesPathConfig} object for full control
+	* over where repository classes are generated.
+	*
+	* When a plain string is provided, the {@link generatedPath} will be used as the repository output path.
 	*/
-	entitiesPaths: string[];
+	entitiesPaths: (string | EntitiesPathConfig)[];
 	/**
-	* The path to where generated files will be placed.
+	* The default path to where generated files will be placed when entitiesPaths contains plain strings.
+	* Ignored for entitiesPaths entries that use {@link EntitiesPathConfig}.
 	*/
-	generatedPath: string;
+	generatedPath?: string;
 	/**
 	* The file extension to use for imports in generated files.
 	*/
 	fileExtensionForImports: string;
 	/**
-	* If true the generated EntityService classes will validate all data before sending to the server.
+	* If true the generated Repository classes will validate all data before sending to the server.
 	*/
 	validate?: boolean;
 }
@@ -932,6 +958,15 @@ interface ICrudServiceProxy<T extends Identifiable<string>> extends IEditableDat
 	*/
 	save(entity: T): Promise<T>;
 	/**
+	* Saves a given entity and waits for the changes to be visible in search results before returning.
+	* 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}.
+	*/
+	saveSync(entity: T): Promise<T>;
+	/**
 	* Retrieves an entity by its id.
 	*
 	* @param id must not be {@literal null}.
@@ -987,6 +1022,7 @@ declare class CrudServiceProxy<T extends Identifiable<string>> implements ICrudS
 	findAllSinglePage(pageable: Pageable): Promise<Page<T>>;
 	findById(id: string): Promise<T>;
 	save(entity: T): Promise<T>;
+	saveSync(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>>;
@@ -1116,4 +1152,4 @@ declare class ParticipantConstants {
 	static readonly PARTICIPANT_TYPE_NODE: string;
 	static readonly CLI_PARTICIPANT_ID: string;
 }
-export { createCRI, Version, TextEventFactory, Sort, ServiceRegistry, ServiceContext, ServerInfo, Scope, Publish, ParticipantConstants, Participant, Pageable, Page, Order, OffsetPageable, NullHandling, KinoticSingleton, KinoticProjectConfig, KinoticPlugin, KinoticError, Kinotic, JsonEventFactory, IterablePage, Identifiable, IServiceRegistry, IServiceProxy, IParticipant, IKinotic, IEventFactory, IEventBus, 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 };
+export { createCRI, Version, TextEventFactory, Sort, ServiceRegistry, ServiceContext, ServerInfo, Scope, Publish, ParticipantConstants, Participant, Pageable, Page, Order, OffsetPageable, NullHandling, KinoticSingleton, KinoticProjectConfig, KinoticPlugin, KinoticError, Kinotic, JsonEventFactory, IterablePage, Identifiable, IServiceRegistry, IServiceProxy, IParticipant, IKinotic, IEventFactory, IEventBus, IEvent, IEditableDataSource, IDataSource, ICrudServiceProxyFactory, ICrudServiceProxy, FunctionalIterablePage, EventConstants, EventBus, Event, EntitiesPathConfig, Direction, DefaultCRI, DataSourceUtils, CursorPageable, CrudServiceProxyFactory, CrudServiceProxy, ContextInterceptor, Context, ConnectionInfo, ConnectedInfo, ConnectHeaders, CRI, CONTEXT_METADATA_KEY, AuthorizationError, AuthenticationError, AbstractIterablePage };

package/dist/index.d.ts

@@ -641,6 +641,27 @@ 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;
 /**
+* Configuration for a single entities path and its corresponding repository output.
+*/
+type EntitiesPathConfig = {
+	/**
+	* The path to search for classes decorated with @Entity.
+	*/
+	path: string;
+	/**
+	* The path where generated Repository classes will be placed.
+	*/
+	repositoryPath: string;
+	/**
+	* If true, the subfolder structure under the entities path will be mirrored under the repository path.
+	* For example, if entitiesPath is "src/model" and contains "payments/Payment.ts",
+	* the generated repository will be placed in "repositoryPath/payments/".
+	* If false, all generated repositories are placed directly in the repositoryPath.
+	* Defaults to true.
+	*/
+	mirrorFolderStructure?: boolean;
+};
+/**
 * The project configuration for a Kinotic project.
 */
 declare class KinoticProjectConfig {
@@ -659,18 +680,23 @@ declare class KinoticProjectConfig {
 	application: string;
 	/**
 	* The paths to search for classes decorated with @Entity that Kinotic will be created for.
+	* Each entry can be a string (simple path) or an {@link EntitiesPathConfig} object for full control
+	* over where repository classes are generated.
+	*
+	* When a plain string is provided, the {@link generatedPath} will be used as the repository output path.
 	*/
-	entitiesPaths: string[];
+	entitiesPaths: (string | EntitiesPathConfig)[];
 	/**
-	* The path to where generated files will be placed.
+	* The default path to where generated files will be placed when entitiesPaths contains plain strings.
+	* Ignored for entitiesPaths entries that use {@link EntitiesPathConfig}.
 	*/
-	generatedPath: string;
+	generatedPath?: string;
 	/**
 	* The file extension to use for imports in generated files.
 	*/
 	fileExtensionForImports: string;
 	/**
-	* If true the generated EntityService classes will validate all data before sending to the server.
+	* If true the generated Repository classes will validate all data before sending to the server.
 	*/
 	validate?: boolean;
 }
@@ -932,6 +958,15 @@ interface ICrudServiceProxy<T extends Identifiable<string>> extends IEditableDat
 	*/
 	save(entity: T): Promise<T>;
 	/**
+	* Saves a given entity and waits for the changes to be visible in search results before returning.
+	* 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}.
+	*/
+	saveSync(entity: T): Promise<T>;
+	/**
 	* Retrieves an entity by its id.
 	*
 	* @param id must not be {@literal null}.
@@ -987,6 +1022,7 @@ declare class CrudServiceProxy<T extends Identifiable<string>> implements ICrudS
 	findAllSinglePage(pageable: Pageable): Promise<Page<T>>;
 	findById(id: string): Promise<T>;
 	save(entity: T): Promise<T>;
+	saveSync(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>>;
@@ -1116,4 +1152,4 @@ declare class ParticipantConstants {
 	static readonly PARTICIPANT_TYPE_NODE: string;
 	static readonly CLI_PARTICIPANT_ID: string;
 }
-export { createCRI, Version, TextEventFactory, Sort, ServiceRegistry, ServiceContext, ServerInfo, Scope, Publish, ParticipantConstants, Participant, Pageable, Page, Order, OffsetPageable, NullHandling, KinoticSingleton, KinoticProjectConfig, KinoticPlugin, KinoticError, Kinotic, JsonEventFactory, IterablePage, Identifiable, IServiceRegistry, IServiceProxy, IParticipant, IKinotic, IEventFactory, IEventBus, 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 };
+export { createCRI, Version, TextEventFactory, Sort, ServiceRegistry, ServiceContext, ServerInfo, Scope, Publish, ParticipantConstants, Participant, Pageable, Page, Order, OffsetPageable, NullHandling, KinoticSingleton, KinoticProjectConfig, KinoticPlugin, KinoticError, Kinotic, JsonEventFactory, IterablePage, Identifiable, IServiceRegistry, IServiceProxy, IParticipant, IKinotic, IEventFactory, IEventBus, IEvent, IEditableDataSource, IDataSource, ICrudServiceProxyFactory, ICrudServiceProxy, FunctionalIterablePage, EventConstants, EventBus, Event, EntitiesPathConfig, Direction, DefaultCRI, DataSourceUtils, CursorPageable, CrudServiceProxyFactory, CrudServiceProxy, ContextInterceptor, Context, ConnectionInfo, ConnectedInfo, ConnectHeaders, CRI, CONTEXT_METADATA_KEY, AuthorizationError, AuthenticationError, AbstractIterablePage };