stonecut 1.1.1 → 1.2.1

package/src/sources/types.ts

@@ -0,0 +1,47 @@
+/**
+ * Source provider interface — abstraction for importing PRDs and issues
+ * from external systems (GitHub, and future: Jira, Linear).
+ *
+ * Providers are stateless on reads. Write operations (onIssueComplete,
+ * onPrdComplete) are the only side effects.
+ */
+
+/** Data returned by fetchPrd(). */
+export interface PrdData {
+	title: string;
+	body: string;
+	issueNumber: number;
+}
+
+/** A single issue from an external source. */
+export interface IssueData {
+	title: string;
+	body: string;
+	number: number;
+	/** Upstream state (e.g. "OPEN", "CLOSED"). Absent for local-only sources. */
+	state?: string;
+}
+
+/** Summary of a PRD from an external source, used for listing/selection. */
+export interface PrdSummary {
+	number: number;
+	title: string;
+}
+
+/** Protocol that all source providers must satisfy. */
+export interface SourceProvider {
+	/** Fetch a PRD by identifier (e.g. issue number). Validates it is a PRD. */
+	fetchPrd(identifier: string): Promise<PrdData>;
+
+	/** Fetch sub-issues for a PRD, ordered by number. */
+	fetchIssues(identifier: string): Promise<IssueData[]>;
+
+	/** List available PRDs from the source (e.g. issues with `prd` label). */
+	listPrds(): Promise<PrdSummary[]>;
+
+	/** Sync completion of a single issue back to the source (e.g. close GitHub issue). */
+	onIssueComplete(issueId: string): Promise<void>;
+
+	/** Sync completion of the parent PRD back to the source (e.g. close parent issue). */
+	onPrdComplete(prdId: string): Promise<void>;
+}

package/src/types.ts

@@ -47,21 +47,7 @@ export interface Issue {
 	content: string;
 }
 
-/** Structured metadata for a GitHub-backed PRD issue. */
-export interface GitHubPrd {
-	number: number;
-	title: string;
-	body: string;
-}
-
-/** A single sub-issue from a GitHub PRD. */
-export interface GitHubIssue {
-	number: number;
-	title: string;
-	body: string;
-}
-
-/** Source interface for reading issues from any backend (local or GitHub). */
+/** Source interface for reading issues from the local backend. */
 export interface Source<T> {
 	getNextIssue(): Promise<T | null>;
 	completeIssue(issue: T): Promise<void>;