@kinotic-ai/os-api 1.7.0 → 1.8.0

package/dist/index.cjs

@@ -40,6 +40,9 @@ var __export = (target, all) => {
 // packages/os-api/src/index.ts
 var exports_src = {};
 __export(exports_src, {
+  isSystemParticipant: () => isSystemParticipant,
+  isOrganizationParticipant: () => isOrganizationParticipant,
+  isApplicationParticipant: () => isApplicationParticipant,
   WorkloadStatus: () => WorkloadStatus,
   WorkloadServiceProxy: () => WorkloadServiceProxy,
   Workload: () => Workload,
@@ -59,6 +62,7 @@ __export(exports_src, {
   ProjectService: () => ProjectService,
   Project: () => Project,
   ProgressType: () => ProgressType,
+  ParticipantType: () => ParticipantType,
   PageableC3Type: () => PageableC3Type,
   PageC3Type: () => PageC3Type,
   OsApiPlugin: () => OsApiPlugin,
@@ -493,6 +497,27 @@ class KinoticProjectConfig {
   fileExtensionForImports = ".js";
   validate;
 }
+// packages/os-api/src/api/security/ParticipantType.ts
+var ParticipantType;
+((ParticipantType2) => {
+  ParticipantType2["SYSTEM"] = "system";
+  ParticipantType2["ORGANIZATION"] = "organization";
+  ParticipantType2["APPLICATION"] = "application";
+})(ParticipantType ||= {});
+// packages/os-api/src/api/security/ParticipantGuards.ts
+function scopeType(participant) {
+  return participant.type;
+}
+function isSystemParticipant(participant) {
+  return scopeType(participant) === "system" /* SYSTEM */;
+}
+function isOrganizationParticipant(participant) {
+  const type = scopeType(participant);
+  return type === "organization" /* ORGANIZATION */ || type === "application" /* APPLICATION */;
+}
+function isApplicationParticipant(participant) {
+  return scopeType(participant) === "application" /* APPLICATION */;
+}
 // packages/os-api/src/api/services/IApplicationService.ts
 var import_core = require("@kinotic-ai/core");
 

package/dist/index.d.cts

@@ -696,6 +696,73 @@ declare class KinoticProjectConfig {
 	*/
 	validate?: boolean;
 }
+/**
+* Identifies which scope layer a participant authenticated against. The server serializes this as
+* the {@code type} discriminator on a participant, and it is used to narrow a base
+* {@code IParticipant} to one of the scope-typed participant interfaces.
+*/
+declare enum ParticipantType {
+	SYSTEM = "system",
+	ORGANIZATION = "organization",
+	APPLICATION = "application"
+}
+import { IParticipant } from "@kinotic-ai/core";
+/**
+* A participant authenticated against the platform SYSTEM scope — a platform operator with no
+* organization or application context. Mirrors the server {@code SystemParticipant}.
+*/
+interface ISystemParticipant extends IParticipant {
+	type: ParticipantType.SYSTEM;
+}
+import { IParticipant as IParticipant2 } from "@kinotic-ai/core";
+/**
+* A participant authenticated against an Organization. {@link organizationId} is the id of the
+* owning Organization and is never null. {@link IApplicationParticipant} extends this type, so an
+* application-scoped participant also satisfies it. Mirrors the server
+* {@code OrganizationParticipant}.
+*/
+interface IOrganizationParticipant extends IParticipant2 {
+	type: ParticipantType.ORGANIZATION | ParticipantType.APPLICATION;
+	/**
+	* The id of the Organization this participant is authenticated under; never null.
+	*/
+	organizationId: string;
+}
+/**
+* A participant authenticated against an Application. Extends {@link IOrganizationParticipant}
+* because every Application belongs to an Organization, so an application-scoped session
+* intrinsically carries the owning Organization's id as well. Mirrors the server
+* {@code ApplicationParticipant}.
+*/
+interface IApplicationParticipant extends IOrganizationParticipant {
+	type: ParticipantType.APPLICATION;
+	/**
+	* The id of the Application this participant is authenticated under; never null.
+	*/
+	applicationId: string;
+	/**
+	* The tenant slice of the Application's end-user data this participant belongs to, or null
+	* when the Application is not multi-tenant.
+	*/
+	tenantId?: string | null;
+}
+import { IParticipant as IParticipant3 } from "@kinotic-ai/core";
+/**
+* @return true if the participant authenticated against the platform SYSTEM scope
+*/
+declare function isSystemParticipant(participant: IParticipant3): participant is ISystemParticipant;
+/**
+* Narrows to an {@link IOrganizationParticipant}, which carries an {@code organizationId}. An
+* application-scoped participant satisfies this too, since every Application is owned by an
+* Organization.
+*
+* @return true if the participant authenticated against an Organization or an Application
+*/
+declare function isOrganizationParticipant(participant: IParticipant3): participant is IOrganizationParticipant;
+/**
+* @return true if the participant authenticated against an Application
+*/
+declare function isApplicationParticipant(participant: IParticipant3): participant is IApplicationParticipant;
 import { IKinotic } from "@kinotic-ai/core";
 import { CrudServiceProxy, ICrudServiceProxy } from "@kinotic-ai/core";
 interface IApplicationService extends ICrudServiceProxy<Application> {
@@ -1126,4 +1193,4 @@ 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, SignUpRequest, SignUpCompleteRequest, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PageableC3Type, PageC3Type, OsApiPlugin, OrganizationService, Organization, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, KinoticProjectConfig, InsightRequest, InsightProgress, IdDecorator, IamUserService, IamUser, IWorkloadService, IVmNodeService, IProjectService, IOsApiExtension, IOrganizationService, INamedQueriesDefinitionService, IMigrationService, ILogManager, IIamUserService, IGitHubAppInstallationService, IEntityDefinitionService, IDeviceApprovalService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, GitHubToken, GitHubRepoToken, GitHubInstallCompletion, GitHubAppInstallationService, GitHubAppInstallation, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, EntitiesPathConfig, DiscriminatorDecorator, DeviceApprovalService, DataInsightsService, DataInsightsComponent, CompleteOrgRequest, AutoGeneratedIdDecorator, AuthType, ApplicationService, Application };
+export { isSystemParticipant, isOrganizationParticipant, isApplicationParticipant, WorkloadStatus, WorkloadServiceProxy, Workload, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, SignUpRequest, SignUpCompleteRequest, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, ParticipantType, PageableC3Type, PageC3Type, OsApiPlugin, OrganizationService, Organization, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, KinoticProjectConfig, InsightRequest, InsightProgress, IdDecorator, IamUserService, IamUser, IWorkloadService, IVmNodeService, ISystemParticipant, IProjectService, IOsApiExtension, IOrganizationService, IOrganizationParticipant, INamedQueriesDefinitionService, IMigrationService, ILogManager, IIamUserService, IGitHubAppInstallationService, IEntityDefinitionService, IDeviceApprovalService, IDataInsightsService, IApplicationService, IApplicationParticipant, GroupLoggerLevelsDescriptor, GitHubToken, GitHubRepoToken, GitHubInstallCompletion, GitHubAppInstallationService, GitHubAppInstallation, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, EntitiesPathConfig, DiscriminatorDecorator, DeviceApprovalService, DataInsightsService, DataInsightsComponent, CompleteOrgRequest, AutoGeneratedIdDecorator, AuthType, ApplicationService, Application };

package/dist/index.d.ts

@@ -696,6 +696,73 @@ declare class KinoticProjectConfig {
 	*/
 	validate?: boolean;
 }
+/**
+* Identifies which scope layer a participant authenticated against. The server serializes this as
+* the {@code type} discriminator on a participant, and it is used to narrow a base
+* {@code IParticipant} to one of the scope-typed participant interfaces.
+*/
+declare enum ParticipantType {
+	SYSTEM = "system",
+	ORGANIZATION = "organization",
+	APPLICATION = "application"
+}
+import { IParticipant } from "@kinotic-ai/core";
+/**
+* A participant authenticated against the platform SYSTEM scope — a platform operator with no
+* organization or application context. Mirrors the server {@code SystemParticipant}.
+*/
+interface ISystemParticipant extends IParticipant {
+	type: ParticipantType.SYSTEM;
+}
+import { IParticipant as IParticipant2 } from "@kinotic-ai/core";
+/**
+* A participant authenticated against an Organization. {@link organizationId} is the id of the
+* owning Organization and is never null. {@link IApplicationParticipant} extends this type, so an
+* application-scoped participant also satisfies it. Mirrors the server
+* {@code OrganizationParticipant}.
+*/
+interface IOrganizationParticipant extends IParticipant2 {
+	type: ParticipantType.ORGANIZATION | ParticipantType.APPLICATION;
+	/**
+	* The id of the Organization this participant is authenticated under; never null.
+	*/
+	organizationId: string;
+}
+/**
+* A participant authenticated against an Application. Extends {@link IOrganizationParticipant}
+* because every Application belongs to an Organization, so an application-scoped session
+* intrinsically carries the owning Organization's id as well. Mirrors the server
+* {@code ApplicationParticipant}.
+*/
+interface IApplicationParticipant extends IOrganizationParticipant {
+	type: ParticipantType.APPLICATION;
+	/**
+	* The id of the Application this participant is authenticated under; never null.
+	*/
+	applicationId: string;
+	/**
+	* The tenant slice of the Application's end-user data this participant belongs to, or null
+	* when the Application is not multi-tenant.
+	*/
+	tenantId?: string | null;
+}
+import { IParticipant as IParticipant3 } from "@kinotic-ai/core";
+/**
+* @return true if the participant authenticated against the platform SYSTEM scope
+*/
+declare function isSystemParticipant(participant: IParticipant3): participant is ISystemParticipant;
+/**
+* Narrows to an {@link IOrganizationParticipant}, which carries an {@code organizationId}. An
+* application-scoped participant satisfies this too, since every Application is owned by an
+* Organization.
+*
+* @return true if the participant authenticated against an Organization or an Application
+*/
+declare function isOrganizationParticipant(participant: IParticipant3): participant is IOrganizationParticipant;
+/**
+* @return true if the participant authenticated against an Application
+*/
+declare function isApplicationParticipant(participant: IParticipant3): participant is IApplicationParticipant;
 import { IKinotic } from "@kinotic-ai/core";
 import { CrudServiceProxy, ICrudServiceProxy } from "@kinotic-ai/core";
 interface IApplicationService extends ICrudServiceProxy<Application> {
@@ -1126,4 +1193,4 @@ 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, SignUpRequest, SignUpCompleteRequest, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PageableC3Type, PageC3Type, OsApiPlugin, OrganizationService, Organization, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, KinoticProjectConfig, InsightRequest, InsightProgress, IdDecorator, IamUserService, IamUser, IWorkloadService, IVmNodeService, IProjectService, IOsApiExtension, IOrganizationService, INamedQueriesDefinitionService, IMigrationService, ILogManager, IIamUserService, IGitHubAppInstallationService, IEntityDefinitionService, IDeviceApprovalService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, GitHubToken, GitHubRepoToken, GitHubInstallCompletion, GitHubAppInstallationService, GitHubAppInstallation, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, EntitiesPathConfig, DiscriminatorDecorator, DeviceApprovalService, DataInsightsService, DataInsightsComponent, CompleteOrgRequest, AutoGeneratedIdDecorator, AuthType, ApplicationService, Application };
+export { isSystemParticipant, isOrganizationParticipant, isApplicationParticipant, WorkloadStatus, WorkloadServiceProxy, Workload, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, SignUpRequest, SignUpCompleteRequest, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, ParticipantType, PageableC3Type, PageC3Type, OsApiPlugin, OrganizationService, Organization, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, KinoticProjectConfig, InsightRequest, InsightProgress, IdDecorator, IamUserService, IamUser, IWorkloadService, IVmNodeService, ISystemParticipant, IProjectService, IOsApiExtension, IOrganizationService, IOrganizationParticipant, INamedQueriesDefinitionService, IMigrationService, ILogManager, IIamUserService, IGitHubAppInstallationService, IEntityDefinitionService, IDeviceApprovalService, IDataInsightsService, IApplicationService, IApplicationParticipant, GroupLoggerLevelsDescriptor, GitHubToken, GitHubRepoToken, GitHubInstallCompletion, GitHubAppInstallationService, GitHubAppInstallation, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, EntitiesPathConfig, DiscriminatorDecorator, DeviceApprovalService, DataInsightsService, DataInsightsComponent, CompleteOrgRequest, AutoGeneratedIdDecorator, AuthType, ApplicationService, Application };

package/dist/index.js

@@ -393,6 +393,27 @@ class KinoticProjectConfig {
   fileExtensionForImports = ".js";
   validate;
 }
+// packages/os-api/src/api/security/ParticipantType.ts
+var ParticipantType;
+((ParticipantType2) => {
+  ParticipantType2["SYSTEM"] = "system";
+  ParticipantType2["ORGANIZATION"] = "organization";
+  ParticipantType2["APPLICATION"] = "application";
+})(ParticipantType ||= {});
+// packages/os-api/src/api/security/ParticipantGuards.ts
+function scopeType(participant) {
+  return participant.type;
+}
+function isSystemParticipant(participant) {
+  return scopeType(participant) === "system" /* SYSTEM */;
+}
+function isOrganizationParticipant(participant) {
+  const type = scopeType(participant);
+  return type === "organization" /* ORGANIZATION */ || type === "application" /* APPLICATION */;
+}
+function isApplicationParticipant(participant) {
+  return scopeType(participant) === "application" /* APPLICATION */;
+}
 // packages/os-api/src/api/services/IApplicationService.ts
 import { CrudServiceProxy } from "@kinotic-ai/core";
 
@@ -680,6 +701,9 @@ var OsApiPlugin = {
   }
 };
 export {
+  isSystemParticipant,
+  isOrganizationParticipant,
+  isApplicationParticipant,
   WorkloadStatus,
   WorkloadServiceProxy,
   Workload,
@@ -699,6 +723,7 @@ export {
   ProjectService,
   Project,
   ProgressType,
+  ParticipantType,
   PageableC3Type,
   PageC3Type,
   OsApiPlugin,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kinotic-ai/os-api",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "type": "module",
   "files": [
     "dist"
@@ -33,15 +33,15 @@
     "ui-test": "vitest --ui --coverage.enabled=true --mode development"
   },
   "peerDependencies": {
-    "@kinotic-ai/core": ">=1.4.0"
+    "@kinotic-ai/core": ">=1.6.0"
   },
   "dependencies": {
     "@kinotic-ai/idl": "1.0.9",
-    "@kinotic-ai/persistence": "1.3.0",
+    "@kinotic-ai/persistence": "1.3.1",
     "rxjs": "^7.8.2"
   },
   "devDependencies": {
-    "@kinotic-ai/core": "1.4.0",
+    "@kinotic-ai/core": "1.6.0",
     "@types/node": "^25.3.2",
     "@vitest/coverage-v8": "^4.0.18",
     "@vitest/runner": "^4.0.18",