@kinotic-ai/os-api 1.2.0 → 1.4.0

package/dist/index.cjs

@@ -78,6 +78,9 @@ __export(exports_src, {
   IamUserService: () => IamUserService,
   IamUser: () => IamUser,
   GroupLoggerLevelsDescriptor: () => GroupLoggerLevelsDescriptor,
+  GitHubInstallationToken: () => GitHubInstallationToken,
+  GitHubAppInstallationService: () => GitHubAppInstallationService,
+  GitHubAppInstallation: () => GitHubAppInstallation,
   FlattenedDecorator: () => FlattenedDecorator,
   EsIndexConfigurationDecorator: () => EsIndexConfigurationDecorator,
   EntityDefinitionService: () => EntityDefinitionService,
@@ -296,6 +299,10 @@ class Project {
   name;
   description;
   sourceOfTruth = null;
+  repoFullName = null;
+  repoId = null;
+  defaultBranch = null;
+  repoPrivate = true;
   updated = null;
   constructor(id, applicationId, name, description) {
     this.id = id;
@@ -445,6 +452,24 @@ class IamUser {
   created = null;
   updated = null;
 }
+// packages/os-api/src/api/model/github/GitHubAppInstallation.ts
+class GitHubAppInstallation {
+  id = null;
+  organizationId = "";
+  githubInstallationId = 0;
+  accountLogin = "";
+  accountType = "";
+  suspendedAt = null;
+  created = null;
+  updated = null;
+}
+// packages/os-api/src/api/model/github/GitHubInstallationToken.ts
+class GitHubInstallationToken {
+  token = "";
+  expiresAt = 0;
+  cloneUrl = "";
+  defaultBranch = "";
+}
 // packages/os-api/src/api/model/KinoticProjectConfig.ts
 class KinoticProjectConfig {
   name;
@@ -672,7 +697,7 @@ class WorkloadServiceProxy extends import_core7.CrudServiceProxy {
     return this.serviceProxy.invoke("syncIndex", []);
   }
 }
-// packages/os-api/src/api/services/iam/IIamUserService.ts
+// packages/os-api/src/api/services/IIamUserService.ts
 var import_core8 = require("@kinotic-ai/core");
 
 class IamUserService extends import_core8.CrudServiceProxy {
@@ -698,6 +723,20 @@ class IamUserService extends import_core8.CrudServiceProxy {
     return this.serviceProxy.invoke("findFirstByEmailInScopeType", [email, authScopeType]);
   }
 }
+// packages/os-api/src/api/services/IGitHubAppInstallationService.ts
+var import_core9 = require("@kinotic-ai/core");
+
+class GitHubAppInstallationService extends import_core9.CrudServiceProxy {
+  constructor(kinotic) {
+    super(kinotic.serviceProxy("org.kinotic.github.api.services.GitHubAppInstallationService"));
+  }
+  startInstall() {
+    return this.serviceProxy.invoke("startInstall", []);
+  }
+  findForCurrentOrg() {
+    return this.serviceProxy.invoke("findForCurrentOrg", []);
+  }
+}
 // packages/os-api/src/api/OsApiPlugin.ts
 var OsApiPlugin = {
   install(kinotic) {
@@ -712,7 +751,8 @@ var OsApiPlugin = {
       dataInsights: new DataInsightsService(kinotic),
       vmNodes: new VmNodeServiceProxy(kinotic),
       workloads: new WorkloadServiceProxy(kinotic),
-      iamUsers: new IamUserService(kinotic)
+      iamUsers: new IamUserService(kinotic),
+      githubAppInstallations: new GitHubAppInstallationService(kinotic)
     };
   }
 };

package/dist/index.d.cts

@@ -198,6 +198,25 @@ declare class Project implements Identifiable3<string> {
 	*/
 	sourceOfTruth: ProjectType | null;
 	/**
+	* Full name ({@code owner/repo}) of the GitHub repository backing this project.
+	* Stamped at create time by the server-side repo provisioner.
+	*/
+	repoFullName: string | null;
+	/**
+	* GitHub's stable repository id. Survives renames on the GitHub side.
+	*/
+	repoId: number | null;
+	/**
+	* Default branch of the backing repository at the time it was provisioned.
+	*/
+	defaultBranch: string | null;
+	/**
+	* Visibility chosen for the backing repository at create time. The SPA sets
+	* this on the create call; the platform passes it through to GitHub. Snapshot
+	* only — not synced back if changed on GitHub later.
+	*/
+	repoPrivate: boolean;
+	/**
 	* The date and time the project was updated.
 	*/
 	updated: number | null;
@@ -562,6 +581,39 @@ interface SignUpCompleteRequest {
 	token: string;
 	password: string;
 }
+import { Identifiable as Identifiable9 } from "@kinotic-ai/core";
+/**
+* Persisted record of one GitHub App installation that a Kinotic Org has authorised.
+* The durable binding that says "Org X has access to GitHub install Y" — without it,
+* no installation token can be minted on behalf of the org and webhook deliveries
+* can't be matched to a project.
+*/
+declare class GitHubAppInstallation implements Identifiable9<string> {
+	id: string | null;
+	organizationId: string;
+	githubInstallationId: number;
+	accountLogin: string;
+	accountType: string;
+	suspendedAt: number | null;
+	created: number | null;
+	updated: number | null;
+}
+/**
+* What worker nodes receive when they ask for clone credentials. The token is a
+* short-lived GitHub installation access token scoped to a single repository with
+* {@code contents:read} permission; {@code expiresAt} is the absolute UTC instant
+* (epoch milliseconds).
+*/
+declare class GitHubInstallationToken {
+	/** Bearer token to send as {@code Authorization: Bearer <token>} on git over HTTPS. */
+	token: string;
+	/** Absolute expiry (epoch milliseconds). Workers should not use the token beyond this point. */
+	expiresAt: number;
+	/** {@code https://github.com/<owner>/<repo>.git} for the linked repo. */
+	cloneUrl: string;
+	/** Default branch on the linked repo (e.g. {@code main}). */
+	defaultBranch: string;
+}
 /**
 * Configuration for a single entities path and its corresponding repository output.
 */
@@ -630,7 +682,8 @@ 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.
+	* 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
 	* @param description the description of the application to create
 	* @return {@link Promise} emitting the created application
@@ -1004,6 +1057,29 @@ declare class IamUserService extends CrudServiceProxy8<IamUser> implements IIamU
 	resetPassword(userId: string, newPassword: string): Promise<void>;
 	findFirstByEmailInScopeType(email: string, authScopeType: string): Promise<IamUser | null>;
 }
+import { CrudServiceProxy as CrudServiceProxy9, IKinotic as IKinotic12, ICrudServiceProxy as ICrudServiceProxy9 } from "@kinotic-ai/core";
+interface IGitHubAppInstallationService extends ICrudServiceProxy9<GitHubAppInstallation> {
+	/**
+	* Stages a single-use {@code state} token bound to the caller's organization in
+	* a cluster-wide store, then returns the GitHub install URL with that state
+	* embedded. The SPA performs {@code window.location = url}.
+	* <p>
+	* Caller must be authenticated under {@code ORGANIZATION} scope; the org is read
+	* from the participant. The state expires after 10 minutes if unused.
+	*/
+	startInstall(): Promise<string>;
+	/**
+	* Returns the (at-most-one) installation bound to the caller's organization, or
+	* {@code null} if GitHub is not yet linked. Drives the "linked / not linked"
+	* indicator in the org-settings UI.
+	*/
+	findForCurrentOrg(): Promise<GitHubAppInstallation | null>;
+}
+declare class GitHubAppInstallationService extends CrudServiceProxy9<GitHubAppInstallation> implements IGitHubAppInstallationService {
+	constructor(kinotic: IKinotic12);
+	startInstall(): Promise<string>;
+	findForCurrentOrg(): Promise<GitHubAppInstallation | null>;
+}
 import { KinoticPlugin } from "@kinotic-ai/core";
 interface IOsApiExtension {
 	applications: IApplicationService;
@@ -1017,9 +1093,10 @@ interface IOsApiExtension {
 	vmNodes: IVmNodeService;
 	workloads: IWorkloadService;
 	iamUsers: IIamUserService;
+	githubAppInstallations: IGitHubAppInstallationService;
 }
 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, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, EntitiesPathConfig, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, AuthType, 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, 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, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, GitHubInstallationToken, GitHubAppInstallationService, GitHubAppInstallation, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, EntitiesPathConfig, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, AuthType, ApplicationService, Application };

package/dist/index.d.ts

@@ -198,6 +198,25 @@ declare class Project implements Identifiable3<string> {
 	*/
 	sourceOfTruth: ProjectType | null;
 	/**
+	* Full name ({@code owner/repo}) of the GitHub repository backing this project.
+	* Stamped at create time by the server-side repo provisioner.
+	*/
+	repoFullName: string | null;
+	/**
+	* GitHub's stable repository id. Survives renames on the GitHub side.
+	*/
+	repoId: number | null;
+	/**
+	* Default branch of the backing repository at the time it was provisioned.
+	*/
+	defaultBranch: string | null;
+	/**
+	* Visibility chosen for the backing repository at create time. The SPA sets
+	* this on the create call; the platform passes it through to GitHub. Snapshot
+	* only — not synced back if changed on GitHub later.
+	*/
+	repoPrivate: boolean;
+	/**
 	* The date and time the project was updated.
 	*/
 	updated: number | null;
@@ -562,6 +581,39 @@ interface SignUpCompleteRequest {
 	token: string;
 	password: string;
 }
+import { Identifiable as Identifiable9 } from "@kinotic-ai/core";
+/**
+* Persisted record of one GitHub App installation that a Kinotic Org has authorised.
+* The durable binding that says "Org X has access to GitHub install Y" — without it,
+* no installation token can be minted on behalf of the org and webhook deliveries
+* can't be matched to a project.
+*/
+declare class GitHubAppInstallation implements Identifiable9<string> {
+	id: string | null;
+	organizationId: string;
+	githubInstallationId: number;
+	accountLogin: string;
+	accountType: string;
+	suspendedAt: number | null;
+	created: number | null;
+	updated: number | null;
+}
+/**
+* What worker nodes receive when they ask for clone credentials. The token is a
+* short-lived GitHub installation access token scoped to a single repository with
+* {@code contents:read} permission; {@code expiresAt} is the absolute UTC instant
+* (epoch milliseconds).
+*/
+declare class GitHubInstallationToken {
+	/** Bearer token to send as {@code Authorization: Bearer <token>} on git over HTTPS. */
+	token: string;
+	/** Absolute expiry (epoch milliseconds). Workers should not use the token beyond this point. */
+	expiresAt: number;
+	/** {@code https://github.com/<owner>/<repo>.git} for the linked repo. */
+	cloneUrl: string;
+	/** Default branch on the linked repo (e.g. {@code main}). */
+	defaultBranch: string;
+}
 /**
 * Configuration for a single entities path and its corresponding repository output.
 */
@@ -630,7 +682,8 @@ 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.
+	* 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
 	* @param description the description of the application to create
 	* @return {@link Promise} emitting the created application
@@ -1004,6 +1057,29 @@ declare class IamUserService extends CrudServiceProxy8<IamUser> implements IIamU
 	resetPassword(userId: string, newPassword: string): Promise<void>;
 	findFirstByEmailInScopeType(email: string, authScopeType: string): Promise<IamUser | null>;
 }
+import { CrudServiceProxy as CrudServiceProxy9, IKinotic as IKinotic12, ICrudServiceProxy as ICrudServiceProxy9 } from "@kinotic-ai/core";
+interface IGitHubAppInstallationService extends ICrudServiceProxy9<GitHubAppInstallation> {
+	/**
+	* Stages a single-use {@code state} token bound to the caller's organization in
+	* a cluster-wide store, then returns the GitHub install URL with that state
+	* embedded. The SPA performs {@code window.location = url}.
+	* <p>
+	* Caller must be authenticated under {@code ORGANIZATION} scope; the org is read
+	* from the participant. The state expires after 10 minutes if unused.
+	*/
+	startInstall(): Promise<string>;
+	/**
+	* Returns the (at-most-one) installation bound to the caller's organization, or
+	* {@code null} if GitHub is not yet linked. Drives the "linked / not linked"
+	* indicator in the org-settings UI.
+	*/
+	findForCurrentOrg(): Promise<GitHubAppInstallation | null>;
+}
+declare class GitHubAppInstallationService extends CrudServiceProxy9<GitHubAppInstallation> implements IGitHubAppInstallationService {
+	constructor(kinotic: IKinotic12);
+	startInstall(): Promise<string>;
+	findForCurrentOrg(): Promise<GitHubAppInstallation | null>;
+}
 import { KinoticPlugin } from "@kinotic-ai/core";
 interface IOsApiExtension {
 	applications: IApplicationService;
@@ -1017,9 +1093,10 @@ interface IOsApiExtension {
 	vmNodes: IVmNodeService;
 	workloads: IWorkloadService;
 	iamUsers: IIamUserService;
+	githubAppInstallations: IGitHubAppInstallationService;
 }
 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, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, EntitiesPathConfig, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, AuthType, 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, 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, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, GitHubInstallationToken, GitHubAppInstallationService, GitHubAppInstallation, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, EntitiesPathConfig, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, AuthType, ApplicationService, Application };

package/dist/index.js

@@ -202,6 +202,10 @@ class Project {
   name;
   description;
   sourceOfTruth = null;
+  repoFullName = null;
+  repoId = null;
+  defaultBranch = null;
+  repoPrivate = true;
   updated = null;
   constructor(id, applicationId, name, description) {
     this.id = id;
@@ -351,6 +355,24 @@ class IamUser {
   created = null;
   updated = null;
 }
+// packages/os-api/src/api/model/github/GitHubAppInstallation.ts
+class GitHubAppInstallation {
+  id = null;
+  organizationId = "";
+  githubInstallationId = 0;
+  accountLogin = "";
+  accountType = "";
+  suspendedAt = null;
+  created = null;
+  updated = null;
+}
+// packages/os-api/src/api/model/github/GitHubInstallationToken.ts
+class GitHubInstallationToken {
+  token = "";
+  expiresAt = 0;
+  cloneUrl = "";
+  defaultBranch = "";
+}
 // packages/os-api/src/api/model/KinoticProjectConfig.ts
 class KinoticProjectConfig {
   name;
@@ -578,7 +600,7 @@ class WorkloadServiceProxy extends CrudServiceProxy7 {
     return this.serviceProxy.invoke("syncIndex", []);
   }
 }
-// packages/os-api/src/api/services/iam/IIamUserService.ts
+// packages/os-api/src/api/services/IIamUserService.ts
 import { CrudServiceProxy as CrudServiceProxy8 } from "@kinotic-ai/core";
 
 class IamUserService extends CrudServiceProxy8 {
@@ -604,6 +626,20 @@ class IamUserService extends CrudServiceProxy8 {
     return this.serviceProxy.invoke("findFirstByEmailInScopeType", [email, authScopeType]);
   }
 }
+// packages/os-api/src/api/services/IGitHubAppInstallationService.ts
+import { CrudServiceProxy as CrudServiceProxy9 } from "@kinotic-ai/core";
+
+class GitHubAppInstallationService extends CrudServiceProxy9 {
+  constructor(kinotic) {
+    super(kinotic.serviceProxy("org.kinotic.github.api.services.GitHubAppInstallationService"));
+  }
+  startInstall() {
+    return this.serviceProxy.invoke("startInstall", []);
+  }
+  findForCurrentOrg() {
+    return this.serviceProxy.invoke("findForCurrentOrg", []);
+  }
+}
 // packages/os-api/src/api/OsApiPlugin.ts
 var OsApiPlugin = {
   install(kinotic) {
@@ -618,7 +654,8 @@ var OsApiPlugin = {
       dataInsights: new DataInsightsService(kinotic),
       vmNodes: new VmNodeServiceProxy(kinotic),
       workloads: new WorkloadServiceProxy(kinotic),
-      iamUsers: new IamUserService(kinotic)
+      iamUsers: new IamUserService(kinotic),
+      githubAppInstallations: new GitHubAppInstallationService(kinotic)
     };
   }
 };
@@ -661,6 +698,9 @@ export {
   IamUserService,
   IamUser,
   GroupLoggerLevelsDescriptor,
+  GitHubInstallationToken,
+  GitHubAppInstallationService,
+  GitHubAppInstallation,
   FlattenedDecorator,
   EsIndexConfigurationDecorator,
   EntityDefinitionService,

package/package.json

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