@kinotic-ai/core 1.1.1 → 1.2.2

package/dist/index.d.cts

@@ -59,6 +59,19 @@ interface IParticipant extends Identifiable<string> {
 	*/
 	tenantId?: string | null;
 	/**
+	* The scope layer this participant authenticated against.
+	* Well-known values are "SYSTEM", "ORGANIZATION", and "APPLICATION",
+	* but custom values are allowed for extensibility.
+	*/
+	authScopeType?: string | null;
+	/**
+	* The identifier of the specific scope this participant belongs to.
+	* For example, "kinotic" for system scope, an organization ID, or an application ID.
+	* Together with {@link authScopeType}, uniquely identifies which user pool
+	* this participant was authenticated from.
+	*/
+	authScopeId?: string | null;
+	/**
 	* Metadata is a map of key value pairs that can be used to store additional information about a participant
 	*
 	* @return a map of key value pairs
@@ -77,9 +90,11 @@ interface IParticipant extends Identifiable<string> {
 declare class Participant implements IParticipant {
 	id: string;
 	tenantId?: string | null;
+	authScopeType?: string | null;
+	authScopeId?: string | null;
 	metadata: Map<string, string>;
 	roles: string[];
-	constructor(id: string, tenantId?: string, metadata?: Map<string, string>, roles?: string[]);
+	constructor(id: string, tenantId?: string, authScopeType?: string, authScopeId?: string, metadata?: Map<string, string>, roles?: string[]);
 }
 /**
 * Contains information about the connection that was established
@@ -641,66 +656,6 @@ 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 {
-	/**
-	* The name of the project or undefined if a project name is used.
-	* i.e. if the project is typescript the package.json name will be used.
-	*/
-	name?: string;
-	/**
-	* The description of the project.
-	*/
-	description?: string;
-	/**
-	* The Kinotic Application that this project belongs to.
-	*/
-	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 | EntitiesPathConfig)[];
-	/**
-	* 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;
-	/**
-	* The file extension to use for imports in generated files.
-	*/
-	fileExtensionForImports: string;
-	/**
-	* If true the generated Repository classes will validate all data before sending to the server.
-	*/
-	validate?: boolean;
-}
-/**
 * A page is a sublist of a list of objects.
 * @author Navid Mitchell
 */
@@ -949,6 +904,15 @@ interface ICrudServiceProxy<T extends Identifiable<string>> extends IEditableDat
 	*/
 	create(entity: T): Promise<T>;
 	/**
+	* Creates a new entity if one does not already exist for the given id, and waits for the
+	* change to be visible in search results before returning.
+	* Use this when you need read-your-write consistency immediately after creation.
+	*
+	* @param entity to create if one does not already exist
+	* @return a {@link Promise} containing the new entity after it is searchable, or an error if an exception occurred
+	*/
+	createSync(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.
 	*
@@ -958,6 +922,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}.
@@ -1008,11 +981,13 @@ declare class CrudServiceProxy<T extends Identifiable<string>> implements ICrudS
 	constructor(serviceProxy: IServiceProxy);
 	count(): Promise<number>;
 	create(entity: T): Promise<T>;
+	createSync(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>;
+	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>>;
@@ -1142,4 +1117,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, EntitiesPathConfig, 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, 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 };

package/dist/index.d.ts

@@ -59,6 +59,19 @@ interface IParticipant extends Identifiable<string> {
 	*/
 	tenantId?: string | null;
 	/**
+	* The scope layer this participant authenticated against.
+	* Well-known values are "SYSTEM", "ORGANIZATION", and "APPLICATION",
+	* but custom values are allowed for extensibility.
+	*/
+	authScopeType?: string | null;
+	/**
+	* The identifier of the specific scope this participant belongs to.
+	* For example, "kinotic" for system scope, an organization ID, or an application ID.
+	* Together with {@link authScopeType}, uniquely identifies which user pool
+	* this participant was authenticated from.
+	*/
+	authScopeId?: string | null;
+	/**
 	* Metadata is a map of key value pairs that can be used to store additional information about a participant
 	*
 	* @return a map of key value pairs
@@ -77,9 +90,11 @@ interface IParticipant extends Identifiable<string> {
 declare class Participant implements IParticipant {
 	id: string;
 	tenantId?: string | null;
+	authScopeType?: string | null;
+	authScopeId?: string | null;
 	metadata: Map<string, string>;
 	roles: string[];
-	constructor(id: string, tenantId?: string, metadata?: Map<string, string>, roles?: string[]);
+	constructor(id: string, tenantId?: string, authScopeType?: string, authScopeId?: string, metadata?: Map<string, string>, roles?: string[]);
 }
 /**
 * Contains information about the connection that was established
@@ -641,66 +656,6 @@ 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 {
-	/**
-	* The name of the project or undefined if a project name is used.
-	* i.e. if the project is typescript the package.json name will be used.
-	*/
-	name?: string;
-	/**
-	* The description of the project.
-	*/
-	description?: string;
-	/**
-	* The Kinotic Application that this project belongs to.
-	*/
-	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 | EntitiesPathConfig)[];
-	/**
-	* 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;
-	/**
-	* The file extension to use for imports in generated files.
-	*/
-	fileExtensionForImports: string;
-	/**
-	* If true the generated Repository classes will validate all data before sending to the server.
-	*/
-	validate?: boolean;
-}
-/**
 * A page is a sublist of a list of objects.
 * @author Navid Mitchell
 */
@@ -949,6 +904,15 @@ interface ICrudServiceProxy<T extends Identifiable<string>> extends IEditableDat
 	*/
 	create(entity: T): Promise<T>;
 	/**
+	* Creates a new entity if one does not already exist for the given id, and waits for the
+	* change to be visible in search results before returning.
+	* Use this when you need read-your-write consistency immediately after creation.
+	*
+	* @param entity to create if one does not already exist
+	* @return a {@link Promise} containing the new entity after it is searchable, or an error if an exception occurred
+	*/
+	createSync(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.
 	*
@@ -958,6 +922,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}.
@@ -1008,11 +981,13 @@ declare class CrudServiceProxy<T extends Identifiable<string>> implements ICrudS
 	constructor(serviceProxy: IServiceProxy);
 	count(): Promise<number>;
 	create(entity: T): Promise<T>;
+	createSync(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>;
+	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>>;
@@ -1142,4 +1117,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, EntitiesPathConfig, 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, 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 };