@compforge/harness-common 0.5.7 → 0.5.8

package/dist/system/pull-request.d.ts

@@ -1,5 +1,5 @@
 import type { Identity } from "../identity.js";
-import { type Repository } from "./repository.js";
+import { type Repository, type RepositoryKey, type RepositorySnapshot } from "./repository.js";
 export type PullRequestState = "open" | "merged" | "closed";
 /**
  * A code-review proposal owned by its target Repository (GitHub PR or GitLab MR).
@@ -23,5 +23,19 @@ export interface PullRequest extends Identity {
     readonly updatedAt?: string;
     readonly mergedAt?: string;
 }
+/** The target Repository and its local PR number / MR iid; no methods or observation facts are required. */
+export interface PullRequestKey {
+    readonly repository: RepositoryKey;
+    readonly number: PullRequest["number"];
+}
+/**
+ * @spec A PR snapshot retains the common field names and optional facts, without PR or nested Repository identity methods.
+ * @why JSON and remote observations must not require each consumer to invent a parallel PR shape or reconstruct methods.
+ * @see {@link component://docs/pull-request.md}
+ */
+export type PullRequestSnapshot = Omit<PullRequest, "id" | "repository" | "sourceRepository"> & {
+    readonly repository: RepositorySnapshot;
+    readonly sourceRepository?: RepositorySnapshot;
+};
 /** Derive identity from fields; never trust a consumer's display URL or repository id method. */
-export declare function pullRequestId(pr: Pick<PullRequest, "repository" | "number">): string;
+export declare function pullRequestId<T extends PullRequestKey>(pr: T): string;

package/dist/system/repository.d.ts

@@ -14,8 +14,12 @@ export interface Repository extends Identity {
      */
     readonly forkedFrom?: string | null;
 }
+/** Identity fields usable without constructing an in-process Repository. */
+export type RepositoryKey = Pick<Repository, "forge" | "path">;
+/** Repository facts carried by JSON, storage and remote observations; identity methods are not data. */
+export type RepositorySnapshot = Omit<Repository, "id">;
 /**
  * Derive the Repository.id() value from identity fields.
  * @spec Repository identity is forge.name/path; fork provenance is excluded.
  */
-export declare function repositoryId(repository: Pick<Repository, "forge" | "path">): string;
+export declare function repositoryId(repository: RepositoryKey): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compforge/harness-common",
-  "version": "0.5.7",
+  "version": "0.5.8",
   "description": "Execution-neutral client lifecycle and datasource contracts for harnesses",
   "type": "module",
   "scripts": {