@enrichlayer/el-linear 1.6.0 → 1.9.0

package/dist/utils/formatters/summary.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Human-readable summary formatters for the `--format summary` output mode.
+ *
+ * These are pure functions: each takes the same shape that the JSON output
+ * path receives (a single resource object or a `{ data, meta }` envelope)
+ * and returns a plain string suitable for terminal display.
+ *
+ * Why this exists: every consumer (humans and LLMs) was piping
+ * `el-linear ... | python -c 'json.load(...)'` or jq-based extraction to
+ * pull out title/state/assignee. This codifies that recurring shape as a
+ * first-class output mode, so callers don't reinvent it in shell.
+ *
+ * The summary format is intentionally stable — it's a contract, not a
+ * pretty-print. Field ordering and labels should not change across
+ * patch releases without a CHANGELOG entry.
+ */
+export declare function formatIssueSummary(issue: Record<string, unknown>): string;
+export declare function formatIssueList(issues: unknown[]): string;
+export declare function formatProjectSummary(project: Record<string, unknown>): string;
+export declare function formatProjectList(projects: unknown[]): string;
+export declare function formatCommentSummary(comment: Record<string, unknown>): string;
+export declare function formatCommentList(comments: unknown[]): string;
+export declare function formatCycleSummary(cycle: Record<string, unknown>): string;
+export declare function formatCycleList(cycles: unknown[]): string;
+export declare function formatMilestoneSummary(milestone: Record<string, unknown>): string;
+export declare function formatMilestoneList(milestones: unknown[]): string;
+export declare function formatTeamList(teams: unknown[]): string;
+export declare function formatLabelList(labels: unknown[]): string;
+export declare function formatUserSummary(user: Record<string, unknown>): string;
+export declare function formatUserList(users: unknown[]): string;
+export declare function formatDocumentSummary(doc: Record<string, unknown>): string;
+export declare function formatDocumentList(docs: unknown[]): string;
+export declare function formatTemplateSummary(tpl: Record<string, unknown>): string;
+export declare function formatTemplateList(tpls: unknown[]): string;
+export declare function formatAttachmentList(attachments: unknown[]): string;
+export declare function formatReleaseSummary(release: Record<string, unknown>): string;
+export declare function formatReleaseList(releases: unknown[]): string;
+export declare function formatSearchResultList(results: unknown[]): string;
+/**
+ * Generic fallback for resources we don't have a dedicated formatter for
+ * yet (e.g. profile/config/template/document). Renders any object as a
+ * label-padded key/value block, with a "..." footer hinting at JSON for
+ * the full payload. Lists fall back to a simple bulleted list.
+ */
+export declare function formatGenericSummary(value: unknown): string;
+export type ResourceKind = "issue" | "issue-list" | "project" | "project-list" | "comment" | "comment-list" | "cycle" | "cycle-list" | "milestone" | "milestone-list" | "team-list" | "label-list" | "user" | "user-list" | "document" | "document-list" | "template" | "template-list" | "attachment-list" | "release" | "release-list" | "search-result-list" | "empty-list" | "generic";
+/**
+ * Heuristic — used by the central `outputSuccess` path which doesn't know
+ * which command produced the payload. Looks at the shape of the data to
+ * pick a formatter.
+ *
+ * Single-resource detection: uses signature fields (e.g. `identifier` +
+ * `state` for issues, `name` + `progress` for projects). When a payload
+ * doesn't match any known shape we fall through to `formatGenericSummary`.
+ */
+export declare function inferKindFromPayload(value: unknown): ResourceKind;
+/**
+ * Central dispatch: given a resource kind and payload, return the
+ * formatted string. The payload for list kinds may be either the raw
+ * array or a `{ data: [...] }` envelope — both are handled.
+ */
+export declare function dispatch(kind: ResourceKind, payload: unknown): string;