@modesto_ma/dsh-guanxiang 0.1.0 → 0.2.0-beta.2

package/src/settings/contract.ts

@@ -11,9 +11,15 @@ export const STATE_ROUTE = '/guanxiang/state'
 export const SETTINGS_ROUTE = '/guanxiang/settings'
 /** POST：立即重新拉取全部仓库，或 body `{ url }` 指定的一个仓库。 */
 export const SYNC_ROUTE = '/guanxiang/sync'
-/** PUT：body `{ tokenEnv, value }` 把令牌存入 DSH 凭据库；DELETE：body `{ tokenEnv }` 删除已存的值。只接受已保存的访问令牌配置引用的名称。 */
+/** PUT：body `{ tokenEnv, value }` 把令牌存入 DSH 凭据库；DELETE：body `{ tokenEnv }` 删除已存的值。只接受已保存的访问令牌配置引用的名称和分析接口令牌的名称。 */
 export const TOKEN_ROUTE = '/guanxiang/token'
 
+/**
+ * POST：日志平台分析接口（Bearer 令牌鉴权，不走 DSH 登录）。它在 DSH 的
+ * `/api` 命名空间之外，网关可以把它和需要登录的 DSH 接口分开暴露。
+ */
+export const ANALYZE_ROUTE = '/open-api/logalyze'
+
 /** One configured application repository. */
 export interface RepoSpec {
   /** Git remote address, cloned with the host machine's existing git credentials or a matching {@link GitCredentialSpec}. */
@@ -22,10 +28,15 @@ export interface RepoSpec {
   branch?: string
 }
 
+/** Credential reference grammar of `@deepseek-ai/dsh-credentials` (a POSIX shell identifier), which {@link GitCredentialSpec.tokenEnv} follows. */
+export const TOKEN_ENV_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*$/
+
 /** HTTPS access token used for the repositories under one address prefix. */
 export interface GitCredentialSpec {
   /** `https://host[:port][/path]` (or `http://`) prefix; repository addresses under it use this token. */
   url: string
+  /** Display name the panel shows for this token; omitted shows the address. */
+  alias?: string
   /** HTTP username sent with the token; GitLab personal access tokens accept `oauth2`. */
   username: string
   /** Credential reference (environment-variable name) whose value in DSH's credential store is the token. */
@@ -52,6 +63,12 @@ export interface SkillUpdateSettings {
   maxFileBytes: number
 }
 
+/** The log-platform analyze API ({@link ANALYZE_ROUTE}). */
+export interface AnalyzeSettings {
+  /** Whether the API accepts requests; switched off it answers 404. */
+  enabled: boolean
+}
+
 /** The settings the Web panel can override; every field is required on the wire. */
 export interface EditableSettings {
   /** Absolute directory holding the cloned repositories (`~` expands to the home directory). */
@@ -70,10 +87,12 @@ export interface EditableSettings {
   download: DownloadSettings
   /** SKILL improvement proposals. */
   skillUpdates: SkillUpdateSettings
+  /** Log-platform analyze API. */
+  analyze: AnalyzeSettings
 }
 
 /** Keys of {@link EditableSettings}, in panel order. */
-export const EDITABLE_KEYS = ['reposDir', 'repos', 'gitCredentials', 'fetchIntervalMs', 'maxAppsPerRequest', 'dispatchTimeoutMs', 'download', 'skillUpdates'] as const satisfies readonly (keyof EditableSettings)[]
+export const EDITABLE_KEYS = ['reposDir', 'repos', 'gitCredentials', 'fetchIntervalMs', 'maxAppsPerRequest', 'dispatchTimeoutMs', 'download', 'skillUpdates', 'analyze'] as const satisfies readonly (keyof EditableSettings)[]
 
 /** One editable key. */
 export type EditableKey = (typeof EDITABLE_KEYS)[number]
@@ -141,6 +160,25 @@ export interface CredentialsWire {
   tokens: TokenStatusWire[]
 }
 
+/**
+ * Whether dsh-channels provides the `feishuTopics` service the analyze API
+ * posts through: `missing` while it is not loaded (or older than 0.8, which
+ * serves the API itself), `incompatible` when its contract version is not
+ * the one this plugin speaks.
+ */
+export type TopicsAvailability = 'ready' | 'missing' | 'incompatible'
+
+/** Analyze API view of the panel. */
+export interface AnalyzeWire {
+  /** Route the log platform posts to. */
+  route: string
+  /** Credential reference (`analyzeTokenRef`) holding the bearer token. */
+  tokenEnv: string
+  /** Token status; absent while the DSH composition has no credential store. */
+  token?: TokenStatusWire
+  topics: TopicsAvailability
+}
+
 /** `GET /guanxiang/state` response. */
 export interface StateWire {
   /** Effective settings: cordis.yml values with panel overrides applied. */
@@ -153,6 +191,7 @@ export interface StateWire {
   overlayError?: string
   repos: RepoStatusWire[]
   credentials: CredentialsWire
+  analyze: AnalyzeWire
 }
 
 /** Successful mutation response. */