@kinotic-ai/os-api 1.0.13 → 1.0.15

package/dist/index.cjs

@@ -72,6 +72,8 @@ __export(exports_src, {
   LogManager: () => LogManager,
   LogLevel: () => LogLevel,
   IdDecorator: () => IdDecorator,
+  IamUserService: () => IamUserService,
+  IamUser: () => IamUser,
   GroupLoggerLevelsDescriptor: () => GroupLoggerLevelsDescriptor,
   FlattenedDecorator: () => FlattenedDecorator,
   EsIndexConfigurationDecorator: () => EsIndexConfigurationDecorator,
@@ -81,6 +83,7 @@ __export(exports_src, {
   DiscriminatorDecorator: () => DiscriminatorDecorator,
   DataInsightsService: () => DataInsightsService,
   AutoGeneratedIdDecorator: () => AutoGeneratedIdDecorator,
+  AuthType: () => AuthType,
   ApplicationService: () => ApplicationService,
   Application: () => Application
 });
@@ -403,6 +406,27 @@ class VmNode {
     this.hostname = hostname;
   }
 }
+// packages/os-api/src/api/model/iam/AuthType.ts
+var AuthType;
+((AuthType2) => {
+  AuthType2["LOCAL"] = "LOCAL";
+  AuthType2["OIDC"] = "OIDC";
+})(AuthType ||= {});
+// packages/os-api/src/api/model/iam/IamUser.ts
+class IamUser {
+  id = null;
+  email = "";
+  displayName = null;
+  authType = null;
+  oidcSubject = null;
+  oidcConfigId = null;
+  authScopeType = "";
+  authScopeId = "";
+  tenantId = null;
+  enabled = true;
+  created = null;
+  updated = null;
+}
 // packages/os-api/src/api/services/IApplicationService.ts
 var import_core = require("@kinotic-ai/core");
 
@@ -608,6 +632,29 @@ class WorkloadServiceProxy extends import_core6.CrudServiceProxy {
     return this.serviceProxy.invoke("syncIndex", []);
   }
 }
+// packages/os-api/src/api/services/iam/IIamUserService.ts
+var import_core7 = require("@kinotic-ai/core");
+
+class IamUserService extends import_core7.CrudServiceProxy {
+  constructor(kinotic) {
+    super(kinotic.serviceProxy("org.kinotic.os.api.services.iam.IamUserService"));
+  }
+  findByEmailAndScope(email, authScopeType, authScopeId) {
+    return this.serviceProxy.invoke("findByEmailAndScope", [email, authScopeType, authScopeId]);
+  }
+  findByScope(authScopeType, authScopeId, pageable) {
+    return this.serviceProxy.invoke("findByScope", [authScopeType, authScopeId, pageable]);
+  }
+  createUser(user, password) {
+    return this.serviceProxy.invoke("createUser", [user, password]);
+  }
+  changePassword(userId, currentPassword, newPassword) {
+    return this.serviceProxy.invoke("changePassword", [userId, currentPassword, newPassword]);
+  }
+  resetPassword(userId, newPassword) {
+    return this.serviceProxy.invoke("resetPassword", [userId, newPassword]);
+  }
+}
 // packages/os-api/src/api/OsApiPlugin.ts
 var OsApiPlugin = {
   install(kinotic) {
@@ -620,7 +667,8 @@ var OsApiPlugin = {
       migrations: new MigrationService(kinotic),
       dataInsights: new DataInsightsService(kinotic),
       vmNodes: new VmNodeServiceProxy(kinotic),
-      workloads: new WorkloadServiceProxy(kinotic)
+      workloads: new WorkloadServiceProxy(kinotic),
+      iamUsers: new IamUserService(kinotic)
     };
   }
 };

package/dist/index.d.cts

@@ -472,6 +472,62 @@ declare class VmNode implements Identifiable6<string> {
 	lastSeen: number | null;
 	constructor(id: string, name: string, hostname: string);
 }
+/**
+* Authentication method for an {@link IamUser}.
+*/
+declare enum AuthType {
+	LOCAL = "LOCAL",
+	OIDC = "OIDC"
+}
+import { Identifiable as Identifiable7 } from "@kinotic-ai/core";
+/**
+* Represents an authenticated identity at any scope layer in the IAM system.
+* Each user is scoped to exactly one layer and is unique by email within that scope.
+*
+* - For SYSTEM and ORGANIZATION scopes, {@link tenantId} must be null.
+* - For APPLICATION scopes, {@link tenantId} is required and identifies the
+*   client tenant the user belongs to within the application's data.
+*/
+declare class IamUser implements Identifiable7<string> {
+	id: string | null;
+	email: string;
+	displayName: string | null;
+	authType: AuthType | null;
+	oidcSubject: string | null;
+	oidcConfigId: string | null;
+	authScopeType: string;
+	authScopeId: string;
+	tenantId: string | null;
+	enabled: boolean;
+	created: number | null;
+	updated: number | null;
+}
+/**
+* Sent to the server to initiate an organization sign-up.
+* The user provides {@link orgName}, {@link orgDescription}, {@link email}, and
+* {@link displayName}. The remaining fields ({@link id}, {@link verificationToken},
+* {@link expiresAt}, {@link created}) are populated by the server before the record
+* is persisted.
+*/
+interface SignUpRequest {
+	id?: string | null;
+	verificationToken?: string | null;
+	expiresAt?: number | null;
+	created?: number | null;
+	orgName: string;
+	orgDescription?: string | null;
+	email: string;
+	displayName: string;
+}
+/**
+* Sent to the server to complete an organization sign-up after email verification.
+* The {@link token} comes from the verification email link; the {@link password}
+* is what the user enters on the "set your password" form.
+*/
+interface SignUpCompleteRequest {
+	token: string;
+	password: string;
+}
 import { IKinotic } from "@kinotic-ai/core";
 import { CrudServiceProxy, ICrudServiceProxy } from "@kinotic-ai/core";
 interface IApplicationService extends ICrudServiceProxy<Application> {
@@ -774,6 +830,39 @@ declare class WorkloadServiceProxy extends CrudServiceProxy6<Workload> implement
 	countForNode(nodeId: string): Promise<number>;
 	syncIndex(): Promise<void>;
 }
+import { CrudServiceProxy as CrudServiceProxy7, IKinotic as IKinotic10, ICrudServiceProxy as ICrudServiceProxy7, Page as Page3, Pageable as Pageable4 } from "@kinotic-ai/core";
+interface IIamUserService extends ICrudServiceProxy7<IamUser> {
+	/**
+	* Finds the user with the given email within the given auth scope.
+	* @return Promise emitting the user or null if no user matches
+	*/
+	findByEmailAndScope(email: string, authScopeType: string, authScopeId: string): Promise<IamUser | null>;
+	/**
+	* Finds all users registered against the given auth scope.
+	*/
+	findByScope(authScopeType: string, authScopeId: string, pageable: Pageable4): Promise<Page3<IamUser>>;
+	/**
+	* Creates a user and, if a password is provided, the matching credential.
+	* APPLICATION-scoped users must carry a {@code tenantId}; SYSTEM and ORGANIZATION users must not.
+	*/
+	createUser(user: IamUser, password: string | null): Promise<IamUser>;
+	/**
+	* Verifies the current password and updates it. Used when the user knows their current password.
+	*/
+	changePassword(userId: string, currentPassword: string, newPassword: string): Promise<void>;
+	/**
+	* Replaces the user's password without verifying the current one. Administrative reset.
+	*/
+	resetPassword(userId: string, newPassword: string): Promise<void>;
+}
+declare class IamUserService extends CrudServiceProxy7<IamUser> implements IIamUserService {
+	constructor(kinotic: IKinotic10);
+	findByEmailAndScope(email: string, authScopeType: string, authScopeId: string): Promise<IamUser | null>;
+	findByScope(authScopeType: string, authScopeId: string, pageable: Pageable4): Promise<Page3<IamUser>>;
+	createUser(user: IamUser, password: string | null): Promise<IamUser>;
+	changePassword(userId: string, currentPassword: string, newPassword: string): Promise<void>;
+	resetPassword(userId: string, newPassword: string): Promise<void>;
+}
 import { KinoticPlugin } from "@kinotic-ai/core";
 interface IOsApiExtension {
 	applications: IApplicationService;
@@ -785,9 +874,10 @@ interface IOsApiExtension {
 	dataInsights: IDataInsightsService;
 	vmNodes: IVmNodeService;
 	workloads: IWorkloadService;
+	iamUsers: IIamUserService;
 }
 declare const OsApiPlugin: KinoticPlugin<IOsApiExtension>;
 declare module "@kinotic-ai/core" {
 	interface KinoticSingleton extends IOsApiExtension {}
 }
-export { WorkloadStatus, WorkloadServiceProxy, Workload, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PageableC3Type, PageC3Type, OsApiPlugin, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, InsightRequest, InsightProgress, IdDecorator, IWorkloadService, IVmNodeService, IProjectService, IOsApiExtension, INamedQueriesDefinitionService, IMigrationService, ILogManager, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, ApplicationService, Application };
+export { WorkloadStatus, WorkloadServiceProxy, Workload, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, SignUpRequest, SignUpCompleteRequest, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PageableC3Type, PageC3Type, OsApiPlugin, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, InsightRequest, InsightProgress, IdDecorator, IamUserService, IamUser, IWorkloadService, IVmNodeService, IProjectService, IOsApiExtension, INamedQueriesDefinitionService, IMigrationService, ILogManager, IIamUserService, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, AuthType, ApplicationService, Application };

package/dist/index.d.ts

@@ -472,6 +472,62 @@ declare class VmNode implements Identifiable6<string> {
 	lastSeen: number | null;
 	constructor(id: string, name: string, hostname: string);
 }
+/**
+* Authentication method for an {@link IamUser}.
+*/
+declare enum AuthType {
+	LOCAL = "LOCAL",
+	OIDC = "OIDC"
+}
+import { Identifiable as Identifiable7 } from "@kinotic-ai/core";
+/**
+* Represents an authenticated identity at any scope layer in the IAM system.
+* Each user is scoped to exactly one layer and is unique by email within that scope.
+*
+* - For SYSTEM and ORGANIZATION scopes, {@link tenantId} must be null.
+* - For APPLICATION scopes, {@link tenantId} is required and identifies the
+*   client tenant the user belongs to within the application's data.
+*/
+declare class IamUser implements Identifiable7<string> {
+	id: string | null;
+	email: string;
+	displayName: string | null;
+	authType: AuthType | null;
+	oidcSubject: string | null;
+	oidcConfigId: string | null;
+	authScopeType: string;
+	authScopeId: string;
+	tenantId: string | null;
+	enabled: boolean;
+	created: number | null;
+	updated: number | null;
+}
+/**
+* Sent to the server to initiate an organization sign-up.
+* The user provides {@link orgName}, {@link orgDescription}, {@link email}, and
+* {@link displayName}. The remaining fields ({@link id}, {@link verificationToken},
+* {@link expiresAt}, {@link created}) are populated by the server before the record
+* is persisted.
+*/
+interface SignUpRequest {
+	id?: string | null;
+	verificationToken?: string | null;
+	expiresAt?: number | null;
+	created?: number | null;
+	orgName: string;
+	orgDescription?: string | null;
+	email: string;
+	displayName: string;
+}
+/**
+* Sent to the server to complete an organization sign-up after email verification.
+* The {@link token} comes from the verification email link; the {@link password}
+* is what the user enters on the "set your password" form.
+*/
+interface SignUpCompleteRequest {
+	token: string;
+	password: string;
+}
 import { IKinotic } from "@kinotic-ai/core";
 import { CrudServiceProxy, ICrudServiceProxy } from "@kinotic-ai/core";
 interface IApplicationService extends ICrudServiceProxy<Application> {
@@ -774,6 +830,39 @@ declare class WorkloadServiceProxy extends CrudServiceProxy6<Workload> implement
 	countForNode(nodeId: string): Promise<number>;
 	syncIndex(): Promise<void>;
 }
+import { CrudServiceProxy as CrudServiceProxy7, IKinotic as IKinotic10, ICrudServiceProxy as ICrudServiceProxy7, Page as Page3, Pageable as Pageable4 } from "@kinotic-ai/core";
+interface IIamUserService extends ICrudServiceProxy7<IamUser> {
+	/**
+	* Finds the user with the given email within the given auth scope.
+	* @return Promise emitting the user or null if no user matches
+	*/
+	findByEmailAndScope(email: string, authScopeType: string, authScopeId: string): Promise<IamUser | null>;
+	/**
+	* Finds all users registered against the given auth scope.
+	*/
+	findByScope(authScopeType: string, authScopeId: string, pageable: Pageable4): Promise<Page3<IamUser>>;
+	/**
+	* Creates a user and, if a password is provided, the matching credential.
+	* APPLICATION-scoped users must carry a {@code tenantId}; SYSTEM and ORGANIZATION users must not.
+	*/
+	createUser(user: IamUser, password: string | null): Promise<IamUser>;
+	/**
+	* Verifies the current password and updates it. Used when the user knows their current password.
+	*/
+	changePassword(userId: string, currentPassword: string, newPassword: string): Promise<void>;
+	/**
+	* Replaces the user's password without verifying the current one. Administrative reset.
+	*/
+	resetPassword(userId: string, newPassword: string): Promise<void>;
+}
+declare class IamUserService extends CrudServiceProxy7<IamUser> implements IIamUserService {
+	constructor(kinotic: IKinotic10);
+	findByEmailAndScope(email: string, authScopeType: string, authScopeId: string): Promise<IamUser | null>;
+	findByScope(authScopeType: string, authScopeId: string, pageable: Pageable4): Promise<Page3<IamUser>>;
+	createUser(user: IamUser, password: string | null): Promise<IamUser>;
+	changePassword(userId: string, currentPassword: string, newPassword: string): Promise<void>;
+	resetPassword(userId: string, newPassword: string): Promise<void>;
+}
 import { KinoticPlugin } from "@kinotic-ai/core";
 interface IOsApiExtension {
 	applications: IApplicationService;
@@ -785,9 +874,10 @@ interface IOsApiExtension {
 	dataInsights: IDataInsightsService;
 	vmNodes: IVmNodeService;
 	workloads: IWorkloadService;
+	iamUsers: IIamUserService;
 }
 declare const OsApiPlugin: KinoticPlugin<IOsApiExtension>;
 declare module "@kinotic-ai/core" {
 	interface KinoticSingleton extends IOsApiExtension {}
 }
-export { WorkloadStatus, WorkloadServiceProxy, Workload, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PageableC3Type, PageC3Type, OsApiPlugin, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, InsightRequest, InsightProgress, IdDecorator, IWorkloadService, IVmNodeService, IProjectService, IOsApiExtension, INamedQueriesDefinitionService, IMigrationService, ILogManager, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, ApplicationService, Application };
+export { WorkloadStatus, WorkloadServiceProxy, Workload, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, SignUpRequest, SignUpCompleteRequest, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PageableC3Type, PageC3Type, OsApiPlugin, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, InsightRequest, InsightProgress, IdDecorator, IamUserService, IamUser, IWorkloadService, IVmNodeService, IProjectService, IOsApiExtension, INamedQueriesDefinitionService, IMigrationService, ILogManager, IIamUserService, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, AuthType, ApplicationService, Application };

package/dist/index.js

@@ -315,6 +315,27 @@ class VmNode {
     this.hostname = hostname;
   }
 }
+// packages/os-api/src/api/model/iam/AuthType.ts
+var AuthType;
+((AuthType2) => {
+  AuthType2["LOCAL"] = "LOCAL";
+  AuthType2["OIDC"] = "OIDC";
+})(AuthType ||= {});
+// packages/os-api/src/api/model/iam/IamUser.ts
+class IamUser {
+  id = null;
+  email = "";
+  displayName = null;
+  authType = null;
+  oidcSubject = null;
+  oidcConfigId = null;
+  authScopeType = "";
+  authScopeId = "";
+  tenantId = null;
+  enabled = true;
+  created = null;
+  updated = null;
+}
 // packages/os-api/src/api/services/IApplicationService.ts
 import { CrudServiceProxy } from "@kinotic-ai/core";
 
@@ -520,6 +541,29 @@ class WorkloadServiceProxy extends CrudServiceProxy6 {
     return this.serviceProxy.invoke("syncIndex", []);
   }
 }
+// packages/os-api/src/api/services/iam/IIamUserService.ts
+import { CrudServiceProxy as CrudServiceProxy7 } from "@kinotic-ai/core";
+
+class IamUserService extends CrudServiceProxy7 {
+  constructor(kinotic) {
+    super(kinotic.serviceProxy("org.kinotic.os.api.services.iam.IamUserService"));
+  }
+  findByEmailAndScope(email, authScopeType, authScopeId) {
+    return this.serviceProxy.invoke("findByEmailAndScope", [email, authScopeType, authScopeId]);
+  }
+  findByScope(authScopeType, authScopeId, pageable) {
+    return this.serviceProxy.invoke("findByScope", [authScopeType, authScopeId, pageable]);
+  }
+  createUser(user, password) {
+    return this.serviceProxy.invoke("createUser", [user, password]);
+  }
+  changePassword(userId, currentPassword, newPassword) {
+    return this.serviceProxy.invoke("changePassword", [userId, currentPassword, newPassword]);
+  }
+  resetPassword(userId, newPassword) {
+    return this.serviceProxy.invoke("resetPassword", [userId, newPassword]);
+  }
+}
 // packages/os-api/src/api/OsApiPlugin.ts
 var OsApiPlugin = {
   install(kinotic) {
@@ -532,7 +576,8 @@ var OsApiPlugin = {
       migrations: new MigrationService(kinotic),
       dataInsights: new DataInsightsService(kinotic),
       vmNodes: new VmNodeServiceProxy(kinotic),
-      workloads: new WorkloadServiceProxy(kinotic)
+      workloads: new WorkloadServiceProxy(kinotic),
+      iamUsers: new IamUserService(kinotic)
     };
   }
 };
@@ -569,6 +614,8 @@ export {
   LogManager,
   LogLevel,
   IdDecorator,
+  IamUserService,
+  IamUser,
   GroupLoggerLevelsDescriptor,
   FlattenedDecorator,
   EsIndexConfigurationDecorator,
@@ -578,6 +625,7 @@ export {
   DiscriminatorDecorator,
   DataInsightsService,
   AutoGeneratedIdDecorator,
+  AuthType,
   ApplicationService,
   Application
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kinotic-ai/os-api",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "type": "module",
   "files": [
     "dist"