@captainsafia/stitch 0.0.1 → 1.0.0-preview.ae4f088

package/dist/api.d.ts

@@ -0,0 +1,170 @@
+// Generated by dts-bundle-generator v9.5.1
+
+/**
+ * Core type definitions for stitch documents
+ */
+export type StitchId = string;
+export type StitchStatus = "open" | "closed" | "superseded" | "abandoned";
+export type Provenance = "human" | "agent" | "mixed" | "retroactive";
+export type Confidence = "low" | "medium" | "high";
+export type GitLinkCommit = {
+	kind: "commit";
+	sha: string;
+};
+export type GitLinkRange = {
+	kind: "range";
+	range: string;
+};
+export type GitLink = GitLinkCommit | GitLinkRange;
+export type DiffFingerprint = {
+	algo: "sha256";
+	kind: "staged-diff" | "unified-diff";
+	value: string;
+};
+export type StitchScope = {
+	paths?: string[];
+};
+export type StitchRelations = {
+	parent?: StitchId;
+	depends_on?: StitchId[];
+};
+export type StitchGit = {
+	links?: GitLink[];
+	fingerprints?: DiffFingerprint[];
+};
+export type StitchFrontmatter = {
+	id: StitchId;
+	title: string;
+	status: StitchStatus;
+	created_at: string;
+	updated_at: string;
+	provenance?: Provenance;
+	confidence?: Confidence;
+	tags?: string[];
+	scope?: StitchScope;
+	relations?: StitchRelations;
+	git?: StitchGit;
+};
+export type StitchDoc = {
+	frontmatter: StitchFrontmatter;
+	body: string;
+	filePath: string;
+};
+export type BlameLine = {
+	line: number;
+	sha: string;
+	stitchIds: StitchId[];
+	text: string;
+};
+export type ClientOptions = {
+	repoRoot?: string;
+};
+export type StatusResult = {
+	current?: StitchId;
+	lineage: StitchId[];
+};
+export type ListFilter = {
+	status?: StitchStatus;
+};
+export declare class StitchError extends Error {
+	constructor(message: string);
+}
+export declare class RepoNotFoundError extends StitchError {
+	constructor(path?: string);
+}
+export declare class NotInitializedError extends StitchError {
+	constructor();
+}
+export declare class NoCurrentStitchError extends StitchError {
+	constructor();
+}
+export declare class StitchNotFoundError extends StitchError {
+	constructor(id: string);
+}
+export declare class GitError extends StitchError {
+	readonly command: string;
+	readonly exitCode: number;
+	constructor(message: string, command: string, exitCode: number);
+}
+export declare class ValidationError extends StitchError {
+	constructor(message: string);
+}
+/**
+ * StitchClient is the main public API for interacting with stitch.
+ * CLI commands should use this class to perform all operations.
+ */
+export declare class StitchClient {
+	private repoRoot;
+	private repoRootOverride;
+	constructor(options?: ClientOptions);
+	/**
+	 * Get the repository root, resolving it if needed
+	 */
+	private getRepoRoot;
+	/**
+	 * Initialize stitch in the current repository
+	 */
+	init(): Promise<void>;
+	/**
+	 * Check if stitch is initialized
+	 */
+	isInitialized(): Promise<boolean>;
+	/**
+	 * Start a new stitch session
+	 */
+	start(title: string): Promise<StitchDoc>;
+	/**
+	 * Create a child stitch under the current stitch
+	 */
+	child(title: string): Promise<StitchDoc>;
+	/**
+	 * Switch to a different stitch
+	 */
+	switch(id: StitchId): Promise<void>;
+	/**
+	 * Get the current stitch status and lineage
+	 */
+	status(): Promise<StatusResult>;
+	/**
+	 * List all stitches
+	 */
+	list(filter?: ListFilter): Promise<StitchDoc[]>;
+	/**
+	 * Get a stitch by ID
+	 */
+	get(id: StitchId): Promise<StitchDoc>;
+	/**
+	 * Get the current stitch ID, throwing if none is set
+	 */
+	requireCurrentId(): Promise<StitchId>;
+	/**
+	 * Open a stitch in the user's editor
+	 */
+	openInEditor(id?: StitchId): Promise<void>;
+	/**
+	 * Link a commit to a stitch
+	 */
+	linkCommit(sha: string, id?: StitchId): Promise<void>;
+	/**
+	 * Link a commit range to a stitch
+	 */
+	linkRange(range: string, id?: StitchId): Promise<void>;
+	/**
+	 * Link staged diff fingerprint to a stitch
+	 */
+	linkStagedDiff(id?: StitchId): Promise<DiffFingerprint>;
+	/**
+	 * Get stitch blame for a file
+	 */
+	blame(path: string): Promise<BlameLine[]>;
+	/**
+	 * Dispose of the client (for using with `using` keyword)
+	 */
+	[Symbol.dispose](): void;
+	/**
+	 * Close the client and release resources
+	 */
+	close(): void;
+}
+
+export {};