@kinotic-ai/os-api 2.0.0 → 3.1.0

package/dist/index.cjs

@@ -43,6 +43,7 @@ __export(exports_src, {
   isSystemParticipant: () => isSystemParticipant,
   isOrganizationParticipant: () => isOrganizationParticipant,
   isApplicationParticipant: () => isApplicationParticipant,
+  appZone: () => appZone,
   WorkloadStatus: () => WorkloadStatus,
   WorkloadServiceProxy: () => WorkloadServiceProxy,
   Workload: () => Workload,
@@ -56,6 +57,7 @@ __export(exports_src, {
   TenantSelectionC3Type: () => TenantSelectionC3Type,
   TenantIdDecorator: () => TenantIdDecorator,
   SingleLoggerLevelsDescriptor: () => SingleLoggerLevelsDescriptor,
+  SYSTEM_ZONE: () => SYSTEM_ZONE,
   RepositoryConnectionStatus: () => RepositoryConnectionStatus,
   QueryOptionsC3Type: () => QueryOptionsC3Type,
   QueryDecorator: () => QueryDecorator,
@@ -71,6 +73,7 @@ __export(exports_src, {
   OsApiPlugin: () => OsApiPlugin,
   OrganizationService: () => OrganizationService,
   Organization: () => Organization,
+  OS_API_ZONE: () => OS_API_ZONE,
   NotIndexedDecorator: () => NotIndexedDecorator,
   NestedDecorator: () => NestedDecorator,
   NamedQueriesDefinitionService: () => NamedQueriesDefinitionService,
@@ -105,7 +108,9 @@ __export(exports_src, {
   AutoGeneratedIdDecorator: () => AutoGeneratedIdDecorator,
   AuthType: () => AuthType,
   ApplicationService: () => ApplicationService,
-  Application: () => Application
+  Application: () => Application,
+  APP_ZONE_PREFIX: () => APP_ZONE_PREFIX,
+  APP_API_ZONE: () => import_persistence2.APP_API_ZONE
 });
 module.exports = __toCommonJS(exports_src);
 
@@ -288,11 +293,12 @@ class TenantSelectionC3Type extends import_idl17.ArrayC3Type {
 class Application {
   id;
   organizationId;
+  name;
   description;
   tenantPerUser = false;
   updated = null;
-  constructor(id, description) {
-    this.id = id;
+  constructor(name, description) {
+    this.name = name;
     this.description = description;
   }
 }
@@ -582,12 +588,24 @@ class KinoticOsCredentialsAuthProvider {
     return this.authHeaders;
   }
 }
-// packages/os-api/src/api/services/IApplicationService.ts
+// packages/os-api/src/api/PlatformZones.ts
 var import_core = require("@kinotic-ai/core");
+var import_persistence2 = require("@kinotic-ai/persistence");
+var OS_API_ZONE = "os-api";
+var SYSTEM_ZONE = "system";
+var APP_ZONE_PREFIX = "app";
+function appZone(organizationId, applicationId) {
+  import_core.validateLabel(organizationId);
+  import_core.validateLabel(applicationId);
+  return `${APP_ZONE_PREFIX}.${organizationId}.${applicationId}`;
+}
+
+// packages/os-api/src/api/services/IApplicationService.ts
+var import_core2 = require("@kinotic-ai/core");
 
-class ApplicationService extends import_core.CrudServiceProxy {
+class ApplicationService extends import_core2.CrudServiceProxy {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.os.api.services.ApplicationService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.ApplicationService`));
   }
   createApplicationIfNotExist(id, description) {
     return this.serviceProxy.invoke("createApplicationIfNotExist", [id, description]);
@@ -597,11 +615,11 @@ class ApplicationService extends import_core.CrudServiceProxy {
   }
 }
 // packages/os-api/src/api/services/IOrganizationService.ts
-var import_core2 = require("@kinotic-ai/core");
+var import_core3 = require("@kinotic-ai/core");
 
-class OrganizationService extends import_core2.CrudServiceProxy {
+class OrganizationService extends import_core3.CrudServiceProxy {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.os.api.services.OrganizationService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.OrganizationService`));
   }
   getOidcConfigurations(organizationId) {
     return this.serviceProxy.invoke("getOidcConfigurations", [organizationId]);
@@ -637,11 +655,11 @@ class LoggersDescriptor {
   groups = new Map;
 }
 // packages/os-api/src/api/services/IProjectService.ts
-var import_core3 = require("@kinotic-ai/core");
+var import_core4 = require("@kinotic-ai/core");
 
-class ProjectService extends import_core3.CrudServiceProxy {
+class ProjectService extends import_core4.CrudServiceProxy {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.os.api.services.ProjectService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.ProjectService`));
   }
   countForApplication(applicationId) {
     return this.serviceProxy.invoke("countForApplication", [applicationId]);
@@ -651,7 +669,7 @@ class ProjectService extends import_core3.CrudServiceProxy {
   }
   async findAllForApplication(applicationId, pageable) {
     const page = await this.findAllForApplicationSinglePage(applicationId, pageable);
-    return new import_core3.FunctionalIterablePage(pageable, page, (pageable2) => this.findAllForApplicationSinglePage(applicationId, pageable2));
+    return new import_core4.FunctionalIterablePage(pageable, page, (pageable2) => this.findAllForApplicationSinglePage(applicationId, pageable2));
   }
   findAllForApplicationSinglePage(applicationId, pageable) {
     return this.serviceProxy.invoke("findAllForApplication", [applicationId, pageable]);
@@ -667,7 +685,7 @@ class ProjectService extends import_core3.CrudServiceProxy {
 class LogManager {
   serviceProxy;
   constructor(kinotic) {
-    this.serviceProxy = kinotic.serviceProxy("org.kinotic.os.api.services.LogManager");
+    this.serviceProxy = kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.LogManager`);
   }
   loggers(nodeId) {
     return this.serviceProxy.invoke("loggers", null, nodeId);
@@ -693,7 +711,7 @@ class LogManager {
 class LogService {
   serviceProxy;
   constructor(kinotic) {
-    this.serviceProxy = kinotic.serviceProxy("org.kinotic.os.api.services.LogService");
+    this.serviceProxy = kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.LogService`);
   }
   tail(workloadId) {
     return this.serviceProxy.invokeStream("tail", [workloadId]);
@@ -703,11 +721,11 @@ class LogService {
   }
 }
 // packages/os-api/src/api/services/IEntityDefinitionService.ts
-var import_core4 = require("@kinotic-ai/core");
+var import_core5 = require("@kinotic-ai/core");
 
-class EntityDefinitionService extends import_core4.CrudServiceProxy {
+class EntityDefinitionService extends import_core5.CrudServiceProxy {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.persistence.api.services.EntityDefinitionService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.persistence.api.services.EntityDefinitionService`));
   }
   countForApplication(applicationId) {
     return this.serviceProxy.invoke("countForApplication", [applicationId]);
@@ -720,14 +738,14 @@ class EntityDefinitionService extends import_core4.CrudServiceProxy {
   }
   async findAllForApplication(applicationId, pageable) {
     const page = await this.findAllForApplicationSinglePage(applicationId, pageable);
-    return new import_core4.FunctionalIterablePage(pageable, page, (pageable2) => this.findAllForApplicationSinglePage(applicationId, pageable2));
+    return new import_core5.FunctionalIterablePage(pageable, page, (pageable2) => this.findAllForApplicationSinglePage(applicationId, pageable2));
   }
   findAllPublishedForApplication(applicationId, pageable) {
     return this.serviceProxy.invoke("findAllPublishedForApplication", [applicationId, pageable]);
   }
   async findAllForProject(projectId, pageable) {
     const page = await this.findAllForProjectSinglePage(projectId, pageable);
-    return new import_core4.FunctionalIterablePage(pageable, page, (pageable2) => this.findAllForProjectSinglePage(projectId, pageable2));
+    return new import_core5.FunctionalIterablePage(pageable, page, (pageable2) => this.findAllForProjectSinglePage(projectId, pageable2));
   }
   findAllForProjectSinglePage(projectId, pageable) {
     return this.serviceProxy.invoke("findAllForProject", [projectId, pageable]);
@@ -743,11 +761,11 @@ class EntityDefinitionService extends import_core4.CrudServiceProxy {
   }
 }
 // packages/os-api/src/api/services/INamedQueriesDefinitionService.ts
-var import_core5 = require("@kinotic-ai/core");
+var import_core6 = require("@kinotic-ai/core");
 
-class NamedQueriesDefinitionService extends import_core5.CrudServiceProxy {
+class NamedQueriesDefinitionService extends import_core6.CrudServiceProxy {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.persistence.api.services.NamedQueriesDefinitionService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.persistence.api.services.NamedQueriesDefinitionService`));
   }
   syncIndex() {
     return this.serviceProxy.invoke("syncIndex", []);
@@ -757,7 +775,7 @@ class NamedQueriesDefinitionService extends import_core5.CrudServiceProxy {
 class MigrationService {
   serviceProxy;
   constructor(kinotic) {
-    this.serviceProxy = kinotic.serviceProxy("org.kinotic.persistence.api.services.MigrationService");
+    this.serviceProxy = kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.persistence.api.services.MigrationService`);
   }
   executeMigrations(migrationRequest) {
     return this.serviceProxy.invoke("executeMigrations", [migrationRequest]);
@@ -773,18 +791,18 @@ class MigrationService {
 class DataInsightsService {
   serviceProxy;
   constructor(kinotic) {
-    this.serviceProxy = kinotic.serviceProxy("org.kinotic.persistence.api.services.insights.DataInsightsService");
+    this.serviceProxy = kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.persistence.api.services.insights.DataInsightsService`);
   }
   processRequest(request) {
     return this.serviceProxy.invokeStream("processRequest", [request]);
   }
 }
 // packages/os-api/src/api/services/IVmNodeService.ts
-var import_core6 = require("@kinotic-ai/core");
+var import_core7 = require("@kinotic-ai/core");
 
-class VmNodeServiceProxy extends import_core6.CrudServiceProxy {
+class VmNodeServiceProxy extends import_core7.CrudServiceProxy {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.os.api.services.VmNodeService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.VmNodeService`));
   }
   findAvailableNode(requiredCpus, requiredMemoryMb, requiredDiskMb) {
     return this.serviceProxy.invoke("findAvailableNode", [requiredCpus, requiredMemoryMb, requiredDiskMb]);
@@ -794,15 +812,15 @@ class VmNodeServiceProxy extends import_core6.CrudServiceProxy {
   }
 }
 // packages/os-api/src/api/services/IWorkloadService.ts
-var import_core7 = require("@kinotic-ai/core");
+var import_core8 = require("@kinotic-ai/core");
 
-class WorkloadServiceProxy extends import_core7.CrudServiceProxy {
+class WorkloadServiceProxy extends import_core8.CrudServiceProxy {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.os.api.services.WorkloadService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.WorkloadService`));
   }
   async findAllForNode(nodeId, pageable) {
     const page = await this.findAllForNodeSinglePage(nodeId, pageable);
-    return new import_core7.FunctionalIterablePage(pageable, page, (pageable2) => this.findAllForNodeSinglePage(nodeId, pageable2));
+    return new import_core8.FunctionalIterablePage(pageable, page, (pageable2) => this.findAllForNodeSinglePage(nodeId, pageable2));
   }
   findAllForNodeSinglePage(nodeId, pageable) {
     return this.serviceProxy.invoke("findAllForNode", [nodeId, pageable]);
@@ -815,20 +833,20 @@ class WorkloadServiceProxy extends import_core7.CrudServiceProxy {
   }
 }
 // packages/os-api/src/api/services/IMemberService.ts
-var import_core8 = require("@kinotic-ai/core");
+var import_core9 = require("@kinotic-ai/core");
 
 class MemberService {
   serviceProxy;
   constructor(kinotic) {
-    this.serviceProxy = kinotic.serviceProxy("org.kinotic.os.api.services.iam.MemberService");
+    this.serviceProxy = kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.iam.MemberService`);
   }
   async findMembers(applicationId, pageable) {
     const page = await this.serviceProxy.invoke("findMembers", [applicationId, pageable]);
-    return new import_core8.FunctionalIterablePage(pageable, page, (next) => this.serviceProxy.invoke("findMembers", [applicationId, next]));
+    return new import_core9.FunctionalIterablePage(pageable, page, (next) => this.serviceProxy.invoke("findMembers", [applicationId, next]));
   }
   async searchMembers(searchText, applicationId, pageable) {
     const page = await this.serviceProxy.invoke("searchMembers", [searchText, applicationId, pageable]);
-    return new import_core8.FunctionalIterablePage(pageable, page, (next) => this.serviceProxy.invoke("searchMembers", [searchText, applicationId, next]));
+    return new import_core9.FunctionalIterablePage(pageable, page, (next) => this.serviceProxy.invoke("searchMembers", [searchText, applicationId, next]));
   }
   inviteMember(email, displayName, applicationId) {
     return this.serviceProxy.invoke("inviteMember", [email, displayName, applicationId]);
@@ -841,7 +859,7 @@ class MemberService {
   }
   async findPendingInvites(applicationId, pageable) {
     const page = await this.serviceProxy.invoke("findPendingInvites", [applicationId, pageable]);
-    return new import_core8.FunctionalIterablePage(pageable, page, (next) => this.serviceProxy.invoke("findPendingInvites", [applicationId, next]));
+    return new import_core9.FunctionalIterablePage(pageable, page, (next) => this.serviceProxy.invoke("findPendingInvites", [applicationId, next]));
   }
   cancelInvite(inviteId) {
     return this.serviceProxy.invoke("cancelInvite", [inviteId]);
@@ -854,11 +872,11 @@ class MemberService {
   }
 }
 // packages/os-api/src/api/services/IInviteEmailTemplateService.ts
-var import_core9 = require("@kinotic-ai/core");
+var import_core10 = require("@kinotic-ai/core");
 
-class InviteEmailTemplateService extends import_core9.CrudServiceProxy {
+class InviteEmailTemplateService extends import_core10.CrudServiceProxy {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.os.api.services.InviteEmailTemplateService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.InviteEmailTemplateService`));
   }
   findByApplication(applicationId) {
     return this.serviceProxy.invoke("findByApplication", [applicationId]);
@@ -868,18 +886,18 @@ class InviteEmailTemplateService extends import_core9.CrudServiceProxy {
 class DeviceApprovalService {
   serviceProxy;
   constructor(kinotic) {
-    this.serviceProxy = kinotic.serviceProxy("org.kinotic.os.api.services.iam.DeviceApprovalService");
+    this.serviceProxy = kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.iam.DeviceApprovalService`);
   }
   approve(userCode) {
     return this.serviceProxy.invoke("approve", [userCode]);
   }
 }
 // packages/os-api/src/api/services/IGitHubAppInstallationService.ts
-var import_core10 = require("@kinotic-ai/core");
+var import_core11 = require("@kinotic-ai/core");
 
-class GitHubAppInstallationService extends import_core10.CrudServiceProxy {
+class GitHubAppInstallationService extends import_core11.CrudServiceProxy {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.github.api.services.GitHubAppInstallationService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.github.api.services.GitHubAppInstallationService`));
   }
   startInstall(returnTo) {
     return this.serviceProxy.invoke("startInstall", [returnTo]);

package/dist/index.d.cts

@@ -137,6 +137,9 @@ declare class TenantSelectionC3Type extends ArrayC3Type {
 }
 import { Identifiable } from "@kinotic-ai/core";
 declare class Application implements Identifiable<string> {
+	/**
+	* The slugified {@link name}, minted by the server at creation
+	*/
 	id: string;
 	/**
 	* The id of the organization that owns this application.
@@ -144,6 +147,7 @@ declare class Application implements Identifiable<string> {
 	* with a missing or mismatched organizationId.
 	*/
 	organizationId: string;
+	name: string;
 	description: string;
 	/**
 	* When true, every APPLICATION-scope user created for this application receives an
@@ -152,7 +156,7 @@ declare class Application implements Identifiable<string> {
 	*/
 	tenantPerUser: boolean;
 	updated: number | null;
-	constructor(id: string, description: string);
+	constructor(name: string, description: string);
 }
 import { Identifiable as Identifiable2 } from "@kinotic-ai/core";
 /**
@@ -934,13 +938,15 @@ import { IKinotic } from "@kinotic-ai/core";
 import { CrudServiceProxy, ICrudServiceProxy } from "@kinotic-ai/core";
 interface IApplicationService extends ICrudServiceProxy<Application> {
 	/**
-	* Creates a new application if it does not already exist. The organization id is derived
-	* from the authenticated participant on the server.
-	* @param id the id of the application to create
+	* Creates a new application if it does not already exist, deriving its id from the
+	* slugified name. The organization id is derived from the authenticated participant on
+	* the server.
+	* @param name the name of the application to create
 	* @param description the description of the application to create
-	* @return {@link Promise} emitting the created application
+	* @return {@link Promise} emitting the created application, or the existing application
+	*         whose id matches the slugified name
 	*/
-	createApplicationIfNotExist(id: string, description: string): Promise<Application>;
+	createApplicationIfNotExist(name: string, description: string): Promise<Application>;
 	/**
 	* This operation makes all the recent writes immediately available for search.
 	* @return a Promise that resolves when the operation is complete
@@ -1420,7 +1426,28 @@ interface IOsApiExtension {
 	githubAppInstallations: IGitHubAppInstallationService;
 }
 declare const OsApiPlugin: KinoticPlugin<IOsApiExtension>;
+import { APP_API_ZONE } from "@kinotic-ai/persistence";
+/**
+* The zone for platform services organizations use to manage the system, such as member,
+* application, and entity definition management
+*/
+declare const OS_API_ZONE = "os-api";
+/**
+* The zone for services internal to the platform, only reachable by system participants
+*/
+declare const SYSTEM_ZONE = "system";
+/**
+* The leading label of application zones, which follow the form app.<organizationId>.<applicationId>
+*/
+declare const APP_ZONE_PREFIX = "app";
+/**
+* Builds the zone that all of an application's services live in
+* @param organizationId the id of the organization that owns the application
+* @param applicationId the id of the application
+* @return the application zone, app.<organizationId>.<applicationId>
+*/
+declare function appZone(organizationId: string, applicationId: string): string;
 declare module "@kinotic-ai/core" {
 	interface KinoticSingleton extends IOsApiExtension {}
 }
-export { isSystemParticipant, isOrganizationParticipant, isApplicationParticipant, WorkloadStatus, WorkloadServiceProxy, Workload, VolumeMount, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, SignUpRequest, SignUpCompleteRequest, RepositoryConnectionStatus, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PortProtocol, PortMapping, PendingInviteSummary, ParticipantType, PageableC3Type, PageC3Type, OsApiPlugin, OrganizationService, Organization, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, MemberService, LoggersDescriptor, LoggerLevelsDescriptor, LogService, LogQuery, LogManager, LogLevel, KinoticProjectConfig, KinoticOsCredentialsAuthProvider, InviteEmailTemplateService, InviteEmailTemplate, InsightRequest, InsightProgress, IdDecorator, IamUser, IWorkloadService, IVmNodeService, ISystemParticipant, IProjectService, IOsApiExtension, IOrganizationService, IOrganizationParticipant, INamedQueriesDefinitionService, IMigrationService, IMemberService, ILogService, ILogManager, IInviteEmailTemplateService, 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 };
+export { isSystemParticipant, isOrganizationParticipant, isApplicationParticipant, appZone, WorkloadStatus, WorkloadServiceProxy, Workload, VolumeMount, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, SignUpRequest, SignUpCompleteRequest, SYSTEM_ZONE, RepositoryConnectionStatus, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PortProtocol, PortMapping, PendingInviteSummary, ParticipantType, PageableC3Type, PageC3Type, OsApiPlugin, OrganizationService, Organization, OS_API_ZONE, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, MemberService, LoggersDescriptor, LoggerLevelsDescriptor, LogService, LogQuery, LogManager, LogLevel, KinoticProjectConfig, KinoticOsCredentialsAuthProvider, InviteEmailTemplateService, InviteEmailTemplate, InsightRequest, InsightProgress, IdDecorator, IamUser, IWorkloadService, IVmNodeService, ISystemParticipant, IProjectService, IOsApiExtension, IOrganizationService, IOrganizationParticipant, INamedQueriesDefinitionService, IMigrationService, IMemberService, ILogService, ILogManager, IInviteEmailTemplateService, 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, APP_ZONE_PREFIX, APP_API_ZONE };

package/dist/index.d.ts

@@ -137,6 +137,9 @@ declare class TenantSelectionC3Type extends ArrayC3Type {
 }
 import { Identifiable } from "@kinotic-ai/core";
 declare class Application implements Identifiable<string> {
+	/**
+	* The slugified {@link name}, minted by the server at creation
+	*/
 	id: string;
 	/**
 	* The id of the organization that owns this application.
@@ -144,6 +147,7 @@ declare class Application implements Identifiable<string> {
 	* with a missing or mismatched organizationId.
 	*/
 	organizationId: string;
+	name: string;
 	description: string;
 	/**
 	* When true, every APPLICATION-scope user created for this application receives an
@@ -152,7 +156,7 @@ declare class Application implements Identifiable<string> {
 	*/
 	tenantPerUser: boolean;
 	updated: number | null;
-	constructor(id: string, description: string);
+	constructor(name: string, description: string);
 }
 import { Identifiable as Identifiable2 } from "@kinotic-ai/core";
 /**
@@ -934,13 +938,15 @@ import { IKinotic } from "@kinotic-ai/core";
 import { CrudServiceProxy, ICrudServiceProxy } from "@kinotic-ai/core";
 interface IApplicationService extends ICrudServiceProxy<Application> {
 	/**
-	* Creates a new application if it does not already exist. The organization id is derived
-	* from the authenticated participant on the server.
-	* @param id the id of the application to create
+	* Creates a new application if it does not already exist, deriving its id from the
+	* slugified name. The organization id is derived from the authenticated participant on
+	* the server.
+	* @param name the name of the application to create
 	* @param description the description of the application to create
-	* @return {@link Promise} emitting the created application
+	* @return {@link Promise} emitting the created application, or the existing application
+	*         whose id matches the slugified name
 	*/
-	createApplicationIfNotExist(id: string, description: string): Promise<Application>;
+	createApplicationIfNotExist(name: string, description: string): Promise<Application>;
 	/**
 	* This operation makes all the recent writes immediately available for search.
 	* @return a Promise that resolves when the operation is complete
@@ -1420,7 +1426,28 @@ interface IOsApiExtension {
 	githubAppInstallations: IGitHubAppInstallationService;
 }
 declare const OsApiPlugin: KinoticPlugin<IOsApiExtension>;
+import { APP_API_ZONE } from "@kinotic-ai/persistence";
+/**
+* The zone for platform services organizations use to manage the system, such as member,
+* application, and entity definition management
+*/
+declare const OS_API_ZONE = "os-api";
+/**
+* The zone for services internal to the platform, only reachable by system participants
+*/
+declare const SYSTEM_ZONE = "system";
+/**
+* The leading label of application zones, which follow the form app.<organizationId>.<applicationId>
+*/
+declare const APP_ZONE_PREFIX = "app";
+/**
+* Builds the zone that all of an application's services live in
+* @param organizationId the id of the organization that owns the application
+* @param applicationId the id of the application
+* @return the application zone, app.<organizationId>.<applicationId>
+*/
+declare function appZone(organizationId: string, applicationId: string): string;
 declare module "@kinotic-ai/core" {
 	interface KinoticSingleton extends IOsApiExtension {}
 }
-export { isSystemParticipant, isOrganizationParticipant, isApplicationParticipant, WorkloadStatus, WorkloadServiceProxy, Workload, VolumeMount, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, SignUpRequest, SignUpCompleteRequest, RepositoryConnectionStatus, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PortProtocol, PortMapping, PendingInviteSummary, ParticipantType, PageableC3Type, PageC3Type, OsApiPlugin, OrganizationService, Organization, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, MemberService, LoggersDescriptor, LoggerLevelsDescriptor, LogService, LogQuery, LogManager, LogLevel, KinoticProjectConfig, KinoticOsCredentialsAuthProvider, InviteEmailTemplateService, InviteEmailTemplate, InsightRequest, InsightProgress, IdDecorator, IamUser, IWorkloadService, IVmNodeService, ISystemParticipant, IProjectService, IOsApiExtension, IOrganizationService, IOrganizationParticipant, INamedQueriesDefinitionService, IMigrationService, IMemberService, ILogService, ILogManager, IInviteEmailTemplateService, 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 };
+export { isSystemParticipant, isOrganizationParticipant, isApplicationParticipant, appZone, WorkloadStatus, WorkloadServiceProxy, Workload, VolumeMount, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, SignUpRequest, SignUpCompleteRequest, SYSTEM_ZONE, RepositoryConnectionStatus, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PortProtocol, PortMapping, PendingInviteSummary, ParticipantType, PageableC3Type, PageC3Type, OsApiPlugin, OrganizationService, Organization, OS_API_ZONE, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, MemberService, LoggersDescriptor, LoggerLevelsDescriptor, LogService, LogQuery, LogManager, LogLevel, KinoticProjectConfig, KinoticOsCredentialsAuthProvider, InviteEmailTemplateService, InviteEmailTemplate, InsightRequest, InsightProgress, IdDecorator, IamUser, IWorkloadService, IVmNodeService, ISystemParticipant, IProjectService, IOsApiExtension, IOrganizationService, IOrganizationParticipant, INamedQueriesDefinitionService, IMigrationService, IMemberService, ILogService, ILogManager, IInviteEmailTemplateService, 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, APP_ZONE_PREFIX, APP_API_ZONE };

package/dist/index.js

@@ -177,11 +177,12 @@ class TenantSelectionC3Type extends ArrayC3Type {
 class Application {
   id;
   organizationId;
+  name;
   description;
   tenantPerUser = false;
   updated = null;
-  constructor(id, description) {
-    this.id = id;
+  constructor(name, description) {
+    this.name = name;
     this.description = description;
   }
 }
@@ -471,12 +472,24 @@ class KinoticOsCredentialsAuthProvider {
     return this.authHeaders;
   }
 }
+// packages/os-api/src/api/PlatformZones.ts
+import { validateLabel } from "@kinotic-ai/core";
+import { APP_API_ZONE } from "@kinotic-ai/persistence";
+var OS_API_ZONE = "os-api";
+var SYSTEM_ZONE = "system";
+var APP_ZONE_PREFIX = "app";
+function appZone(organizationId, applicationId) {
+  validateLabel(organizationId);
+  validateLabel(applicationId);
+  return `${APP_ZONE_PREFIX}.${organizationId}.${applicationId}`;
+}
+
 // packages/os-api/src/api/services/IApplicationService.ts
 import { CrudServiceProxy } from "@kinotic-ai/core";
 
 class ApplicationService extends CrudServiceProxy {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.os.api.services.ApplicationService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.ApplicationService`));
   }
   createApplicationIfNotExist(id, description) {
     return this.serviceProxy.invoke("createApplicationIfNotExist", [id, description]);
@@ -490,7 +503,7 @@ import { CrudServiceProxy as CrudServiceProxy2 } from "@kinotic-ai/core";
 
 class OrganizationService extends CrudServiceProxy2 {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.os.api.services.OrganizationService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.OrganizationService`));
   }
   getOidcConfigurations(organizationId) {
     return this.serviceProxy.invoke("getOidcConfigurations", [organizationId]);
@@ -530,7 +543,7 @@ import { CrudServiceProxy as CrudServiceProxy3, FunctionalIterablePage } from "@
 
 class ProjectService extends CrudServiceProxy3 {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.os.api.services.ProjectService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.ProjectService`));
   }
   countForApplication(applicationId) {
     return this.serviceProxy.invoke("countForApplication", [applicationId]);
@@ -556,7 +569,7 @@ class ProjectService extends CrudServiceProxy3 {
 class LogManager {
   serviceProxy;
   constructor(kinotic) {
-    this.serviceProxy = kinotic.serviceProxy("org.kinotic.os.api.services.LogManager");
+    this.serviceProxy = kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.LogManager`);
   }
   loggers(nodeId) {
     return this.serviceProxy.invoke("loggers", null, nodeId);
@@ -582,7 +595,7 @@ class LogManager {
 class LogService {
   serviceProxy;
   constructor(kinotic) {
-    this.serviceProxy = kinotic.serviceProxy("org.kinotic.os.api.services.LogService");
+    this.serviceProxy = kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.LogService`);
   }
   tail(workloadId) {
     return this.serviceProxy.invokeStream("tail", [workloadId]);
@@ -596,7 +609,7 @@ import { CrudServiceProxy as CrudServiceProxy4, FunctionalIterablePage as Functi
 
 class EntityDefinitionService extends CrudServiceProxy4 {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.persistence.api.services.EntityDefinitionService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.persistence.api.services.EntityDefinitionService`));
   }
   countForApplication(applicationId) {
     return this.serviceProxy.invoke("countForApplication", [applicationId]);
@@ -636,7 +649,7 @@ import { CrudServiceProxy as CrudServiceProxy5 } from "@kinotic-ai/core";
 
 class NamedQueriesDefinitionService extends CrudServiceProxy5 {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.persistence.api.services.NamedQueriesDefinitionService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.persistence.api.services.NamedQueriesDefinitionService`));
   }
   syncIndex() {
     return this.serviceProxy.invoke("syncIndex", []);
@@ -646,7 +659,7 @@ class NamedQueriesDefinitionService extends CrudServiceProxy5 {
 class MigrationService {
   serviceProxy;
   constructor(kinotic) {
-    this.serviceProxy = kinotic.serviceProxy("org.kinotic.persistence.api.services.MigrationService");
+    this.serviceProxy = kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.persistence.api.services.MigrationService`);
   }
   executeMigrations(migrationRequest) {
     return this.serviceProxy.invoke("executeMigrations", [migrationRequest]);
@@ -662,7 +675,7 @@ class MigrationService {
 class DataInsightsService {
   serviceProxy;
   constructor(kinotic) {
-    this.serviceProxy = kinotic.serviceProxy("org.kinotic.persistence.api.services.insights.DataInsightsService");
+    this.serviceProxy = kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.persistence.api.services.insights.DataInsightsService`);
   }
   processRequest(request) {
     return this.serviceProxy.invokeStream("processRequest", [request]);
@@ -673,7 +686,7 @@ import { CrudServiceProxy as CrudServiceProxy6 } from "@kinotic-ai/core";
 
 class VmNodeServiceProxy extends CrudServiceProxy6 {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.os.api.services.VmNodeService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.VmNodeService`));
   }
   findAvailableNode(requiredCpus, requiredMemoryMb, requiredDiskMb) {
     return this.serviceProxy.invoke("findAvailableNode", [requiredCpus, requiredMemoryMb, requiredDiskMb]);
@@ -687,7 +700,7 @@ import { CrudServiceProxy as CrudServiceProxy7, FunctionalIterablePage as Functi
 
 class WorkloadServiceProxy extends CrudServiceProxy7 {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.os.api.services.WorkloadService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.WorkloadService`));
   }
   async findAllForNode(nodeId, pageable) {
     const page = await this.findAllForNodeSinglePage(nodeId, pageable);
@@ -711,7 +724,7 @@ import {
 class MemberService {
   serviceProxy;
   constructor(kinotic) {
-    this.serviceProxy = kinotic.serviceProxy("org.kinotic.os.api.services.iam.MemberService");
+    this.serviceProxy = kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.iam.MemberService`);
   }
   async findMembers(applicationId, pageable) {
     const page = await this.serviceProxy.invoke("findMembers", [applicationId, pageable]);
@@ -749,7 +762,7 @@ import { CrudServiceProxy as CrudServiceProxy8 } from "@kinotic-ai/core";
 
 class InviteEmailTemplateService extends CrudServiceProxy8 {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.os.api.services.InviteEmailTemplateService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.InviteEmailTemplateService`));
   }
   findByApplication(applicationId) {
     return this.serviceProxy.invoke("findByApplication", [applicationId]);
@@ -759,7 +772,7 @@ class InviteEmailTemplateService extends CrudServiceProxy8 {
 class DeviceApprovalService {
   serviceProxy;
   constructor(kinotic) {
-    this.serviceProxy = kinotic.serviceProxy("org.kinotic.os.api.services.iam.DeviceApprovalService");
+    this.serviceProxy = kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.os.api.services.iam.DeviceApprovalService`);
   }
   approve(userCode) {
     return this.serviceProxy.invoke("approve", [userCode]);
@@ -770,7 +783,7 @@ import { CrudServiceProxy as CrudServiceProxy9 } from "@kinotic-ai/core";
 
 class GitHubAppInstallationService extends CrudServiceProxy9 {
   constructor(kinotic) {
-    super(kinotic.serviceProxy("org.kinotic.github.api.services.GitHubAppInstallationService"));
+    super(kinotic.serviceProxy(`${OS_API_ZONE}.org.kinotic.github.api.services.GitHubAppInstallationService`));
   }
   startInstall(returnTo) {
     return this.serviceProxy.invoke("startInstall", [returnTo]);
@@ -807,6 +820,7 @@ export {
   isSystemParticipant,
   isOrganizationParticipant,
   isApplicationParticipant,
+  appZone,
   WorkloadStatus,
   WorkloadServiceProxy,
   Workload,
@@ -820,6 +834,7 @@ export {
   TenantSelectionC3Type,
   TenantIdDecorator,
   SingleLoggerLevelsDescriptor,
+  SYSTEM_ZONE,
   RepositoryConnectionStatus,
   QueryOptionsC3Type,
   QueryDecorator,
@@ -835,6 +850,7 @@ export {
   OsApiPlugin,
   OrganizationService,
   Organization,
+  OS_API_ZONE,
   NotIndexedDecorator,
   NestedDecorator,
   NamedQueriesDefinitionService,
@@ -869,5 +885,7 @@ export {
   AutoGeneratedIdDecorator,
   AuthType,
   ApplicationService,
-  Application
+  Application,
+  APP_ZONE_PREFIX,
+  APP_API_ZONE
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kinotic-ai/os-api",
-  "version": "2.0.0",
+  "version": "3.1.0",
   "type": "module",
   "files": [
     "dist"
@@ -32,15 +32,15 @@
     "coverage": "bun test --coverage --pass-with-no-tests"
   },
   "peerDependencies": {
-    "@kinotic-ai/core": ">=2.0.0"
+    "@kinotic-ai/core": ">=3.1.0"
   },
   "dependencies": {
     "@kinotic-ai/idl": "1.0.10",
-    "@kinotic-ai/persistence": "2.0.0",
+    "@kinotic-ai/persistence": "3.1.0",
     "rxjs": "^7.8.2"
   },
   "devDependencies": {
-    "@kinotic-ai/core": "2.0.0",
+    "@kinotic-ai/core": "3.1.0",
     "@types/node": "^25.3.2",
     "tslib": "^2.8.1",
     "typescript": "^5.9.3"