@zhangj1164/dsh-github-issue 0.0.0-stage → 0.1.0

package/lib/types.d.ts

@@ -0,0 +1,137 @@
+//#region src/types.d.ts
+/**
+ * Pure types of the GitHub-issue domain: the one home of the issue report
+ * template, request/response contracts, and the built-in optimization prompt
+ * identity. Free of this package's host-side value imports.
+ *
+ * The issue report template is pinned Markdown so reports are uniform: every
+ * generated report follows the same section structure, which is what makes the
+ * GitHub prefill and human review consistent.
+ *
+ * @module @zhangj1164/dsh-github-issue/types
+ */
+/** Input for generating a GitHub issue report from telemetry analysis. */
+interface GithubIssueGenerateReportRequest {
+  /**
+   * The plugin ids whose failures were analyzed, in the order they were read.
+   *
+   * A list rather than one id because a suite is what a reader cares about: a
+   * report covering only `memo` cannot mention a `github-issue` failure, and the
+   * packages of one deployment fail and get fixed together.
+   */
+  readonly pluginIds: readonly string[];
+  /** Total events recorded for the analyzed plugins. */
+  readonly totalEvents: number;
+  /** Total failure events recorded for the analyzed plugins. */
+  readonly totalFailures: number;
+  /** Failure groups from the telemetry analysis, joined on feature-code anchor. */
+  readonly failureGroups: readonly GithubIssueFailureGroupInput[];
+  /**
+   * Provider route override; omit to use this service's `Config` or the
+   * deployment's `agentDefaultModel`.
+   */
+  readonly provider?: string;
+  /** Model id override; omit to follow the same fallback as `provider`. */
+  readonly model?: string;
+  /**
+   * Time range the analysis read, when it read any events. A report without it
+   * cannot be told apart from one about a live incident.
+   */
+  readonly window?: GithubIssueAnalysisWindow;
+}
+/** The time range one telemetry analysis covered. */
+interface GithubIssueAnalysisWindow {
+  /** Timestamp (epoch ms) of the oldest event considered. */
+  readonly firstEventAt: number;
+  /** Timestamp (epoch ms) of the newest event considered. */
+  readonly lastEventAt: number;
+}
+/** One failure group input — the analysis projection of a feature-code group. */
+interface GithubIssueFailureGroupInput {
+  /** The feature-code anchor shared by every event in this group. */
+  readonly featureCodeRef: string;
+  /** Number of failures in this group. */
+  readonly count: number;
+  /** The most recent failure's error code, when known. */
+  readonly errorCode?: string;
+  /** The most recent failure's error message. */
+  readonly errorMessage?: string;
+  /** Timestamp (epoch ms) of the most recent failure, when the analysis knew it. */
+  readonly lastFailureAt?: number;
+  /** Attempts of the same action recorded after the most recent failure. */
+  readonly attemptsAfterLastFailure?: number;
+  /** Route the most recent failure ran on, when those events recorded one. */
+  readonly route?: GithubIssueFailureRoute;
+}
+/** The model route a failure group ran on. */
+interface GithubIssueFailureRoute {
+  /** Provider id the failing call used. */
+  readonly provider: string;
+  /** Model id the failing call used. */
+  readonly model: string;
+  /** HTTP-style status the adapter reported, when it reported one. */
+  readonly status?: number;
+}
+/** The generated GitHub issue report. */
+interface GithubIssueReport {
+  /** Issue title (concise summary). */
+  readonly title: string;
+  /** Full issue body in Markdown, following the pinned template. */
+  readonly body: string;
+  /** Labels for the issue. */
+  readonly labels: readonly string[];
+}
+/** Result of report generation. */
+type GithubIssueGenerateReportResult = {
+  readonly ok: true;
+  readonly value: GithubIssueReport;
+} | {
+  readonly ok: false;
+  readonly error: {
+    readonly code: 'llm-failure' | 'route-missing';
+    readonly message: string;
+  };
+};
+/** Request to build a pre-filled GitHub issue creation URL. */
+interface GithubIssuePrefillRequest {
+  /** The repository URL (e.g. `https://github.com/owner/repo`). */
+  readonly repoUrl: string;
+  /** The report to prefill. */
+  readonly report: GithubIssueReport;
+}
+/** Result of the prefill URL construction. */
+type GithubIssuePrefillResult = {
+  readonly ok: true;
+  readonly value: string;
+} | {
+  readonly ok: false;
+  readonly error: {
+    readonly code: 'invalid-url';
+    readonly message: string;
+  };
+};
+/** Input for optimizing a natural-language issue description with the model. */
+interface GithubIssueOptimizeRequest {
+  /** The user's raw natural-language description of the problem. */
+  readonly description: string;
+  /**
+   * Provider route override; omit to use this service's `Config` or the
+   * deployment's `agentDefaultModel`.
+   */
+  readonly provider?: string;
+  /** Model id override; omit to follow the same fallback as `provider`. */
+  readonly model?: string;
+}
+/** Result of issue optimization. */
+type GithubIssueOptimizeResult = {
+  readonly ok: true;
+  readonly value: GithubIssueReport;
+} | {
+  readonly ok: false;
+  readonly error: {
+    readonly code: 'llm-failure' | 'empty-input' | 'route-missing';
+    readonly message: string;
+  };
+};
+//#endregion
+export { GithubIssueAnalysisWindow, GithubIssueFailureGroupInput, GithubIssueFailureRoute, GithubIssueGenerateReportRequest, GithubIssueGenerateReportResult, GithubIssueOptimizeRequest, GithubIssueOptimizeResult, GithubIssuePrefillRequest, GithubIssuePrefillResult, GithubIssueReport };

package/lib/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,70 @@
-{
-  "name": "@zhangj1164/dsh-github-issue",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@zhangj1164/dsh-github-issue",
+  "description": "GitHub issue generation and optimization service for DeepSeek Harness: builds structured issue reports from telemetry analysis, pre-filled issue URLs, and AI-optimized descriptions",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./invariant": {
+      "types": "./lib/invariant.d.ts",
+      "default": "./lib/invariant.js"
+    },
+    "./types": {
+      "types": "./lib/types.d.ts",
+      "default": "./lib/types.js"
+    },
+    "./client": {
+      "types": "./lib/client.d.ts",
+      "default": "./lib/client.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib/**/*.js",
+    "lib/**/*.d.ts",
+    "cordis.patch.yml"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "prepare": "tsdown"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zhangj1164/dsh-mega-plugins.git",
+    "directory": "packages/github-issue/dsh-github-issue"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    }
+  },
+  "dependencies": {
+    "@deepseek-ai/schemastery": "^3.18.0",
+    "zod": "^4.4.3"
+  },
+  "peerDependencies": {
+    "@deepseek-ai/cordis": "^4.0.0",
+    "@deepseek-ai/dsh-invariants": "^0.1.5-rc.1",
+    "@deepseek-ai/dsh-llm": "^0.1.5-rc.1",
+    "@deepseek-ai/dsh-typert-protocol": "^0.1.5-rc.1"
+  },
+  "devDependencies": {
+    "@deepseek-ai/cordis": "^4.0.0",
+    "@deepseek-ai/dsh-invariants": "^0.1.5-rc.1",
+    "@deepseek-ai/dsh-llm": "^0.1.5-rc.1",
+    "@deepseek-ai/dsh-typert-protocol": "^0.1.5-rc.1",
+    "@types/node": "^22.20.0",
+    "tsdown": "^0.22.2",
+    "typescript": "^5.9.0",
+    "vite": "^8.2.2"
+  }
+}