@foss.global/interfaces 0.4.0 → 0.6.0

package/changelog.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 2026-07-21 - 0.6.0
+
+### Features
+
+- add repository CI artifact contracts (ci-artifacts)
+  - Add runner job artifact specification types and optional artifact definitions on job specs
+  - Expose artifact upload and repository artifact list view interfaces
+  - Add repositoryCiArtifacts typed request contract
+
+## 2026-07-21 - 0.5.0
+
+### Features
+
+- add repository CI status and run request contracts (repository-ci)
+  - Add repository CI run, commit status, and run log view interfaces.
+  - Add public typed request contracts for CI status, run logs, and run cancellation.
+  - Add test coverage for exported repository CI interfaces and request types.
+
 ## 2026-07-20 - 0.4.0
 
 ### Features

package/dist_ts/00_commitinfo_data.js

@@ -3,7 +3,7 @@
  */
 export const commitinfo = {
     name: '@foss.global/interfaces',
-    version: '0.4.0',
+    version: '0.6.0',
     description: 'Shared TypeScript interfaces and TypedRequest contracts for the foss.global Git platform ecosystem.'
 };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx5QkFBeUI7SUFDL0IsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLHFHQUFxRztDQUNuSCxDQUFBIn0=

package/dist_ts/data/runner.d.ts

@@ -3,6 +3,7 @@ export type TRunnerProtocolVersion = typeof runnerProtocolVersion;
 export type TOciRuntime = 'docker' | 'podman';
 export type TJobNetwork = 'none' | 'bridge';
 export type TLogStream = 'stdout' | 'stderr' | 'runner';
+export type TJobArtifactWhen = 'always' | 'success' | 'failure';
 export type TJobCompletionStatus = 'succeeded' | 'failed' | 'canceled' | 'timed_out' | 'system_error';
 export type TCiJobState = 'queued' | 'running' | TJobCompletionStatus;
 export interface IRunnerCredential {
@@ -15,7 +16,7 @@ export interface IRunnerCapabilities {
     runtime: TOciRuntime;
     networks: TJobNetwork[];
     sourceArchives: ['tar.gz'];
-    artifacts: false;
+    artifacts: boolean;
     caches: false;
     serviceContainers: false;
 }
@@ -63,6 +64,13 @@ export interface IJobSourceArchive {
     url: string;
     sha256: string;
 }
+export interface IJobArtifactSpec {
+    name: string;
+    path: string;
+    when?: TJobArtifactWhen;
+    required?: boolean;
+    retentionDays?: number;
+}
 export interface IJobSpec {
     image: string;
     command: string[];
@@ -72,6 +80,7 @@ export interface IJobSpec {
     timeoutMs?: number;
     resources?: IJobResources;
     source?: IJobSourceArchive;
+    artifacts?: IJobArtifactSpec[];
 }
 export interface IJobLease {
     jobId: string;
@@ -115,6 +124,17 @@ export interface ILogAcknowledgement {
     serverTime: string;
     nextSequence: number;
 }
+export interface ICiArtifactUploadResponse {
+    artifactId: string;
+    jobId: string;
+    attemptId: string;
+    name: string;
+    sha256: string;
+    sizeBytes: number;
+    contentType: string;
+    createdAt: string;
+    expiresAt: string;
+}
 export interface ICompleteJobRequest extends IJobMutationIdentity {
     status: TJobCompletionStatus;
     exitCode: number | null;
@@ -187,3 +207,53 @@ export interface ICiSetRunnerDrainResponse {
     runnerId: string;
     drainRequested: boolean;
 }
+export type TRepositoryCiTrigger = 'push' | 'manual';
+export type TRepositoryCiRunState = 'dispatching' | TCiJobState;
+export type TRepositoryCiCommitState = 'not_run' | TRepositoryCiRunState;
+export interface IRepositoryCiRunStatus {
+    dispatchId: string;
+    trigger: TRepositoryCiTrigger;
+    refName: string;
+    objectId: string;
+    workflowRevision: number;
+    state: TRepositoryCiRunState;
+    jobId: string | null;
+    attemptNumber?: number;
+    cancelRequested?: boolean;
+    createdAt: string;
+    updatedAt: string;
+    startedAt?: string;
+    completedAt?: string;
+    exitCode?: number | null;
+    failureReason?: string;
+}
+export interface IRepositoryCiCommitStatus {
+    org: string;
+    repo: string;
+    objectId: string;
+    state: TRepositoryCiCommitState;
+    totalRuns: number;
+    counts: Partial<Record<TRepositoryCiRunState, number>>;
+    latestRun: IRepositoryCiRunStatus | null;
+    runs: IRepositoryCiRunStatus[];
+}
+export interface IRepositoryCiRunLogView {
+    run: IRepositoryCiRunStatus;
+    logs: ICiLogPage;
+}
+export interface IRepositoryCiArtifact {
+    artifactId: string;
+    dispatchId: string;
+    jobId: string;
+    attemptId: string;
+    name: string;
+    sha256: string;
+    sizeBytes: number;
+    contentType: string;
+    createdAt: string;
+    expiresAt: string;
+}
+export interface IRepositoryCiArtifactListView {
+    run: IRepositoryCiRunStatus;
+    artifacts: IRepositoryCiArtifact[];
+}

package/dist_ts/requests/public.d.ts

@@ -83,3 +83,51 @@ export interface IReq_PublicCommits extends plugins.typedrequestInterfaces.imple
         selectedCommit: data.IPublicCommitDetail | null;
     };
 }
+export interface IReq_RepositoryCiStatus extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RepositoryCiStatus> {
+    method: 'repositoryCiStatus';
+    request: {
+        org: string;
+        repo: string;
+        objectId: string;
+        accessToken?: string;
+    };
+    response: {
+        available: boolean;
+        status: data.IRepositoryCiCommitStatus | null;
+    };
+}
+export interface IReq_RepositoryCiRunLogs extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RepositoryCiRunLogs> {
+    method: 'repositoryCiRunLogs';
+    request: {
+        org: string;
+        repo: string;
+        dispatchId: string;
+        accessToken: string;
+        attemptId?: string;
+        fromSequence?: number;
+        limit?: number;
+    };
+    response: data.IRepositoryCiRunLogView;
+}
+export interface IReq_RepositoryCiCancelRun extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RepositoryCiCancelRun> {
+    method: 'repositoryCiCancelRun';
+    request: {
+        org: string;
+        repo: string;
+        dispatchId: string;
+        accessToken: string;
+    };
+    response: {
+        run: data.IRepositoryCiRunStatus;
+    };
+}
+export interface IReq_RepositoryCiArtifacts extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RepositoryCiArtifacts> {
+    method: 'repositoryCiArtifacts';
+    request: {
+        org: string;
+        repo: string;
+        dispatchId: string;
+        accessToken: string;
+    };
+    response: data.IRepositoryCiArtifactListView;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foss.global/interfaces",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "private": false,
   "description": "Shared TypeScript interfaces and TypedRequest contracts for the foss.global Git platform ecosystem.",
   "exports": {

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@foss.global/interfaces',
-  version: '0.4.0',
+  version: '0.6.0',
   description: 'Shared TypeScript interfaces and TypedRequest contracts for the foss.global Git platform ecosystem.'
 }

package/ts/data/runner.ts

@@ -4,6 +4,7 @@ export type TRunnerProtocolVersion = typeof runnerProtocolVersion;
 export type TOciRuntime = 'docker' | 'podman';
 export type TJobNetwork = 'none' | 'bridge';
 export type TLogStream = 'stdout' | 'stderr' | 'runner';
+export type TJobArtifactWhen = 'always' | 'success' | 'failure';
 export type TJobCompletionStatus =
   | 'succeeded'
   | 'failed'
@@ -23,7 +24,7 @@ export interface IRunnerCapabilities {
   runtime: TOciRuntime;
   networks: TJobNetwork[];
   sourceArchives: ['tar.gz'];
-  artifacts: false;
+  artifacts: boolean;
   caches: false;
   serviceContainers: false;
 }
@@ -80,6 +81,14 @@ export interface IJobSourceArchive {
   sha256: string;
 }
 
+export interface IJobArtifactSpec {
+  name: string;
+  path: string;
+  when?: TJobArtifactWhen;
+  required?: boolean;
+  retentionDays?: number;
+}
+
 export interface IJobSpec {
   image: string;
   command: string[];
@@ -89,6 +98,7 @@ export interface IJobSpec {
   timeoutMs?: number;
   resources?: IJobResources;
   source?: IJobSourceArchive;
+  artifacts?: IJobArtifactSpec[];
 }
 
 export interface IJobLease {
@@ -140,6 +150,18 @@ export interface ILogAcknowledgement {
   nextSequence: number;
 }
 
+export interface ICiArtifactUploadResponse {
+  artifactId: string;
+  jobId: string;
+  attemptId: string;
+  name: string;
+  sha256: string;
+  sizeBytes: number;
+  contentType: string;
+  createdAt: string;
+  expiresAt: string;
+}
+
 export interface ICompleteJobRequest extends IJobMutationIdentity {
   status: TJobCompletionStatus;
   exitCode: number | null;
@@ -223,3 +245,59 @@ export interface ICiSetRunnerDrainResponse {
   runnerId: string;
   drainRequested: boolean;
 }
+
+export type TRepositoryCiTrigger = 'push' | 'manual';
+export type TRepositoryCiRunState = 'dispatching' | TCiJobState;
+export type TRepositoryCiCommitState = 'not_run' | TRepositoryCiRunState;
+
+export interface IRepositoryCiRunStatus {
+  dispatchId: string;
+  trigger: TRepositoryCiTrigger;
+  refName: string;
+  objectId: string;
+  workflowRevision: number;
+  state: TRepositoryCiRunState;
+  jobId: string | null;
+  attemptNumber?: number;
+  cancelRequested?: boolean;
+  createdAt: string;
+  updatedAt: string;
+  startedAt?: string;
+  completedAt?: string;
+  exitCode?: number | null;
+  failureReason?: string;
+}
+
+export interface IRepositoryCiCommitStatus {
+  org: string;
+  repo: string;
+  objectId: string;
+  state: TRepositoryCiCommitState;
+  totalRuns: number;
+  counts: Partial<Record<TRepositoryCiRunState, number>>;
+  latestRun: IRepositoryCiRunStatus | null;
+  runs: IRepositoryCiRunStatus[];
+}
+
+export interface IRepositoryCiRunLogView {
+  run: IRepositoryCiRunStatus;
+  logs: ICiLogPage;
+}
+
+export interface IRepositoryCiArtifact {
+  artifactId: string;
+  dispatchId: string;
+  jobId: string;
+  attemptId: string;
+  name: string;
+  sha256: string;
+  sizeBytes: number;
+  contentType: string;
+  createdAt: string;
+  expiresAt: string;
+}
+
+export interface IRepositoryCiArtifactListView {
+  run: IRepositoryCiRunStatus;
+  artifacts: IRepositoryCiArtifact[];
+}

package/ts/requests/public.ts

@@ -113,3 +113,71 @@ export interface IReq_PublicCommits
     selectedCommit: data.IPublicCommitDetail | null;
   };
 }
+
+export interface IReq_RepositoryCiStatus
+  extends plugins.typedrequestInterfaces.implementsTR<
+    plugins.typedrequestInterfaces.ITypedRequest,
+    IReq_RepositoryCiStatus
+  > {
+  method: 'repositoryCiStatus';
+  request: {
+    org: string;
+    repo: string;
+    objectId: string;
+    accessToken?: string;
+  };
+  response: {
+    available: boolean;
+    status: data.IRepositoryCiCommitStatus | null;
+  };
+}
+
+export interface IReq_RepositoryCiRunLogs
+  extends plugins.typedrequestInterfaces.implementsTR<
+    plugins.typedrequestInterfaces.ITypedRequest,
+    IReq_RepositoryCiRunLogs
+  > {
+  method: 'repositoryCiRunLogs';
+  request: {
+    org: string;
+    repo: string;
+    dispatchId: string;
+    accessToken: string;
+    attemptId?: string;
+    fromSequence?: number;
+    limit?: number;
+  };
+  response: data.IRepositoryCiRunLogView;
+}
+
+export interface IReq_RepositoryCiCancelRun
+  extends plugins.typedrequestInterfaces.implementsTR<
+    plugins.typedrequestInterfaces.ITypedRequest,
+    IReq_RepositoryCiCancelRun
+  > {
+  method: 'repositoryCiCancelRun';
+  request: {
+    org: string;
+    repo: string;
+    dispatchId: string;
+    accessToken: string;
+  };
+  response: {
+    run: data.IRepositoryCiRunStatus;
+  };
+}
+
+export interface IReq_RepositoryCiArtifacts
+  extends plugins.typedrequestInterfaces.implementsTR<
+    plugins.typedrequestInterfaces.ITypedRequest,
+    IReq_RepositoryCiArtifacts
+  > {
+  method: 'repositoryCiArtifacts';
+  request: {
+    org: string;
+    repo: string;
+    dispatchId: string;
+    accessToken: string;
+  };
+  response: data.IRepositoryCiArtifactListView;
+}