@rallycry/conveyor-incidents 0.2.0 → 0.3.1

package/README.md

@@ -73,10 +73,33 @@ await incidents.report({
 });
 ```
 
+### Creator attribution (`createdBy`)
+
+`createdBy` is an optional single email, matched against the target project's members the same way as `assigned`/`review`:
+
+- A resolvable project-member email becomes the card's creator.
+- When omitted — or when the email doesn't resolve to a member — the card is attributed to the **"Conveyor Incidents" system user**, not a human.
+- Applied **only when a new card is created**; dedup hits keep the existing creator.
+
+> **Behavior change in 0.3.0:** previously, cards reported through this endpoint were attributed to the token owner (suggestions/tasks) or the project owner (incidents). Pass `createdBy` explicitly if you want a specific member credited.
+
+```ts
+await incidents.report({
+  type: "task",
+  title: "Wire up the new webhook",
+  createdBy: "logan@rallycry.gg",
+});
+```
+
 ### About `source` and `fingerprintKey`
 
 Conveyor deduplicates reports by a fingerprint derived from `(projectId, source, fingerprintKey)` — or by `(projectId, source, title)` if `fingerprintKey` is omitted. **Use stable values** for `source` (e.g. `"prod-web"`, not `"node-pid-1234"`) so that repeat reports collapse into a single incident instead of creating noise.
 
+### Attachment limits
+
+- **5 MB per file** (`MAX_ATTACHMENT_BYTES`, exported). Oversized files are rejected client-side with a descriptive `attachmentResults` error — no HTTP call is made.
+- **10 attachments per card** (server-enforced).
+
 ### Error handling
 
 - The main `report()` call throws `ConveyorIncidentsError` on non-2xx responses; it exposes `.status` and `.body`.
@@ -114,6 +137,7 @@ client.report({
   type?: "incident" | "suggestion" | "task";          // default: "incident"
   assigned?: string[]; // project-member emails; first match becomes assignee
   review?: string[];   // project-member emails; every match becomes a reviewer
+  createdBy?: string;  // project-member email; no match → "Conveyor Incidents" system user
   attachments?: Array<{
     fileName: string;
     mimeType: string;

package/dist/index.d.ts

@@ -4,6 +4,10 @@ declare class ConveyorIncidentsError extends Error {
     constructor(message: string, status: number, body: unknown);
 }
 
+/** Server-side per-file ceiling — keep in sync with MAX_ATTACHMENT_BYTES in
+ * conveyor's incident-routes.ts. Checked client-side so an oversized file
+ * fails with a descriptive `attachmentResults` error instead of an HTTP 413. */
+declare const MAX_ATTACHMENT_BYTES: number;
 type IncidentSeverity = "critical" | "high" | "medium" | "low";
 type ConveyorCardType = "incident" | "suggestion" | "task";
 interface ConveyorIncidentsOptions {
@@ -39,6 +43,12 @@ interface ReportIncidentInput {
      * skipped.
      */
     review?: string[];
+    /**
+     * Project-member email used as the card's creator. When omitted — or when
+     * the email doesn't resolve to a member of the target project — the card
+     * is attributed to the "Conveyor Incidents" system user.
+     */
+    createdBy?: string;
 }
 interface AttachmentResult {
     fileName: string;
@@ -62,4 +72,4 @@ declare class ConveyorIncidents {
     private uploadAttachment;
 }
 
-export { type AttachmentResult, type ConveyorCardType, ConveyorIncidents, ConveyorIncidentsError, type ConveyorIncidentsOptions, type IncidentAttachment, type IncidentSeverity, type ReportIncidentInput, type ReportIncidentResult };
+export { type AttachmentResult, type ConveyorCardType, ConveyorIncidents, ConveyorIncidentsError, type ConveyorIncidentsOptions, type IncidentAttachment, type IncidentSeverity, MAX_ATTACHMENT_BYTES, type ReportIncidentInput, type ReportIncidentResult };

package/dist/index.js

@@ -14,6 +14,7 @@ var ConveyorIncidentsError = class extends Error {
 var DEFAULT_BASE_URL = "https://api.conveyor.rallycryapp.com";
 var DEFAULT_SOURCE = "client";
 var DEFAULT_SEVERITY = "medium";
+var MAX_ATTACHMENT_BYTES = 5 * 1024 * 1024;
 var ConveyorIncidents = class {
   apiKey;
   projectId;
@@ -46,7 +47,8 @@ var ConveyorIncidents = class {
       fingerprintKey: input.fingerprintKey,
       type: input.type,
       assigned: input.assigned,
-      review: input.review
+      review: input.review,
+      createdBy: input.createdBy
     };
     const res = await this.fetchImpl(`${this.baseUrl}/api/incidents/report`, {
       method: "POST",
@@ -82,7 +84,15 @@ var ConveyorIncidents = class {
   }
   async uploadAttachment(incidentId, attachment) {
     try {
-      const contentBase64 = toBase64(attachment.content);
+      const bytes = typeof attachment.content === "string" ? new TextEncoder().encode(attachment.content) : attachment.content;
+      if (bytes.byteLength > MAX_ATTACHMENT_BYTES) {
+        return {
+          fileName: attachment.fileName,
+          ok: false,
+          error: `Attachment is ${bytes.byteLength} bytes \u2014 exceeds the ${MAX_ATTACHMENT_BYTES}-byte (5 MB) server limit; upload skipped`
+        };
+      }
+      const contentBase64 = bytesToBase64(bytes);
       const res = await this.fetchImpl(
         `${this.baseUrl}/api/incidents/${encodeURIComponent(incidentId)}/files`,
         {
@@ -146,10 +156,6 @@ function formatErrorBody(status, statusText, body) {
   }
   return prefix;
 }
-function toBase64(content) {
-  const bytes = typeof content === "string" ? new TextEncoder().encode(content) : content;
-  return bytesToBase64(bytes);
-}
 function bytesToBase64(bytes) {
   if (typeof Buffer !== "undefined") {
     return Buffer.from(bytes).toString("base64");
@@ -162,6 +168,7 @@ function bytesToBase64(bytes) {
 }
 export {
   ConveyorIncidents,
-  ConveyorIncidentsError
+  ConveyorIncidentsError,
+  MAX_ATTACHMENT_BYTES
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/errors.ts","../src/index.ts"],"sourcesContent":["export class ConveyorIncidentsError extends Error {\n  readonly status: number;\n  readonly body: unknown;\n\n  constructor(message: string, status: number, body: unknown) {\n    super(message);\n    this.name = \"ConveyorIncidentsError\";\n    this.status = status;\n    this.body = body;\n  }\n}\n","import { ConveyorIncidentsError } from \"./errors.js\";\n\nexport { ConveyorIncidentsError } from \"./errors.js\";\n\nconst DEFAULT_BASE_URL = \"https://api.conveyor.rallycryapp.com\";\nconst DEFAULT_SOURCE = \"client\";\nconst DEFAULT_SEVERITY: IncidentSeverity = \"medium\";\n\nexport type IncidentSeverity = \"critical\" | \"high\" | \"medium\" | \"low\";\n\nexport type ConveyorCardType = \"incident\" | \"suggestion\" | \"task\";\n\nexport interface ConveyorIncidentsOptions {\n  apiKey: string;\n  projectId: string;\n  baseUrl?: string;\n  fetch?: typeof fetch;\n}\n\nexport interface IncidentAttachment {\n  fileName: string;\n  mimeType: string;\n  content: Uint8Array | string;\n}\n\nexport interface ReportIncidentInput {\n  title: string;\n  description?: string;\n  severity?: IncidentSeverity;\n  source?: string;\n  fingerprintKey?: string;\n  plan?: string;\n  attachments?: IncidentAttachment[];\n  /** Card type to create. The server defaults to \"incident\" when omitted. */\n  type?: ConveyorCardType;\n  /**\n   * Project-member emails. The FIRST email that resolves to a member of the\n   * target project becomes the card's assignee; the rest are ignored.\n   * Non-member emails are silently skipped.\n   */\n  assigned?: string[];\n  /**\n   * Project-member emails. EVERY email that resolves to a member of the\n   * target project is added as a reviewer. Non-member emails are silently\n   * skipped.\n   */\n  review?: string[];\n}\n\nexport interface AttachmentResult {\n  fileName: string;\n  ok: boolean;\n  fileId?: string;\n  error?: string;\n}\n\nexport interface ReportIncidentResult {\n  incidentId: string;\n  /** Alias of `incidentId` — prefer this when reporting type \"suggestion\" or \"task\". */\n  cardId: string;\n  attachmentResults: AttachmentResult[];\n}\n\nexport class ConveyorIncidents {\n  private readonly apiKey: string;\n  private readonly projectId: string;\n  private readonly baseUrl: string;\n  private readonly fetchImpl: typeof fetch;\n\n  constructor(opts: ConveyorIncidentsOptions) {\n    if (!opts.apiKey) {\n      throw new Error(\"ConveyorIncidents: apiKey is required\");\n    }\n    if (!opts.projectId) {\n      throw new Error(\"ConveyorIncidents: projectId is required\");\n    }\n    const resolvedFetch = opts.fetch ?? globalThis.fetch;\n    if (typeof resolvedFetch !== \"function\") {\n      throw new Error(\"ConveyorIncidents: no global fetch available — pass opts.fetch on Node <18\");\n    }\n    this.apiKey = opts.apiKey;\n    this.projectId = opts.projectId;\n    this.baseUrl = stripTrailingSlash(opts.baseUrl ?? DEFAULT_BASE_URL);\n    this.fetchImpl = resolvedFetch;\n  }\n\n  async report(input: ReportIncidentInput): Promise<ReportIncidentResult> {\n    const body = {\n      projectId: this.projectId,\n      source: input.source ?? DEFAULT_SOURCE,\n      severity: input.severity ?? DEFAULT_SEVERITY,\n      title: input.title,\n      description: input.description,\n      plan: input.plan,\n      fingerprintKey: input.fingerprintKey,\n      type: input.type,\n      assigned: input.assigned,\n      review: input.review,\n    };\n\n    const res = await this.fetchImpl(`${this.baseUrl}/api/incidents/report`, {\n      method: \"POST\",\n      headers: {\n        \"Content-Type\": \"application/json\",\n        Authorization: `Bearer ${this.apiKey}`,\n      },\n      body: JSON.stringify(body),\n    });\n\n    const payload = await readJson(res);\n\n    if (!res.ok) {\n      throw new ConveyorIncidentsError(\n        `Failed to report incident: ${res.status} ${res.statusText}`,\n        res.status,\n        payload,\n      );\n    }\n\n    const incidentId = extractId(payload, \"incidentId\") ?? extractId(payload, \"cardId\");\n\n    if (!incidentId) {\n      throw new ConveyorIncidentsError(\n        \"Invalid response from /api/incidents/report: missing incidentId\",\n        res.status,\n        payload,\n      );\n    }\n\n    const attachmentResults: AttachmentResult[] = [];\n    if (input.attachments && input.attachments.length > 0) {\n      for (const attachment of input.attachments) {\n        attachmentResults.push(await this.uploadAttachment(incidentId, attachment));\n      }\n    }\n\n    return { incidentId, cardId: incidentId, attachmentResults };\n  }\n\n  private async uploadAttachment(\n    incidentId: string,\n    attachment: IncidentAttachment,\n  ): Promise<AttachmentResult> {\n    try {\n      const contentBase64 = toBase64(attachment.content);\n      const res = await this.fetchImpl(\n        `${this.baseUrl}/api/incidents/${encodeURIComponent(incidentId)}/files`,\n        {\n          method: \"POST\",\n          headers: {\n            \"Content-Type\": \"application/json\",\n            Authorization: `Bearer ${this.apiKey}`,\n          },\n          body: JSON.stringify({\n            fileName: attachment.fileName,\n            mimeType: attachment.mimeType,\n            contentBase64,\n          }),\n        },\n      );\n\n      const payload = await readJson(res);\n\n      if (!res.ok) {\n        return {\n          fileName: attachment.fileName,\n          ok: false,\n          error: formatErrorBody(res.status, res.statusText, payload),\n        };\n      }\n\n      const fileId =\n        payload && typeof payload === \"object\" && \"fileId\" in payload\n          ? String((payload as { fileId: unknown }).fileId)\n          : undefined;\n\n      return { fileName: attachment.fileName, ok: true, fileId };\n    } catch (err) {\n      return {\n        fileName: attachment.fileName,\n        ok: false,\n        error: err instanceof Error ? err.message : String(err),\n      };\n    }\n  }\n}\n\nfunction stripTrailingSlash(url: string): string {\n  return url.endsWith(\"/\") ? url.slice(0, -1) : url;\n}\n\nfunction extractId(payload: unknown, key: \"incidentId\" | \"cardId\"): string | undefined {\n  if (payload && typeof payload === \"object\" && key in payload) {\n    const value = (payload as Record<string, unknown>)[key];\n    if (value !== undefined && value !== null) return String(value);\n  }\n  return undefined;\n}\n\nasync function readJson(res: Response): Promise<unknown> {\n  const text = await res.text();\n  if (!text) return undefined;\n  try {\n    return JSON.parse(text);\n  } catch {\n    return text;\n  }\n}\n\nfunction formatErrorBody(status: number, statusText: string, body: unknown): string {\n  const prefix = `${status} ${statusText}`.trim();\n  if (body && typeof body === \"object\" && \"error\" in body) {\n    return `${prefix}: ${String((body as { error: unknown }).error)}`;\n  }\n  if (typeof body === \"string\" && body.length > 0) {\n    return `${prefix}: ${body}`;\n  }\n  return prefix;\n}\n\nfunction toBase64(content: Uint8Array | string): string {\n  const bytes = typeof content === \"string\" ? new TextEncoder().encode(content) : content;\n  return bytesToBase64(bytes);\n}\n\nfunction bytesToBase64(bytes: Uint8Array): string {\n  if (typeof Buffer !== \"undefined\") {\n    return Buffer.from(bytes).toString(\"base64\");\n  }\n  let binary = \"\";\n  for (const byte of bytes) {\n    binary += String.fromCharCode(byte);\n  }\n  return btoa(binary);\n}\n"],"mappings":";AAAO,IAAM,yBAAN,cAAqC,MAAM;AAAA,EACvC;AAAA,EACA;AAAA,EAET,YAAY,SAAiB,QAAgB,MAAe;AAC1D,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,SAAS;AACd,SAAK,OAAO;AAAA,EACd;AACF;;;ACNA,IAAM,mBAAmB;AACzB,IAAM,iBAAiB;AACvB,IAAM,mBAAqC;AAyDpC,IAAM,oBAAN,MAAwB;AAAA,EACZ;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEjB,YAAY,MAAgC;AAC1C,QAAI,CAAC,KAAK,QAAQ;AAChB,YAAM,IAAI,MAAM,uCAAuC;AAAA,IACzD;AACA,QAAI,CAAC,KAAK,WAAW;AACnB,YAAM,IAAI,MAAM,0CAA0C;AAAA,IAC5D;AACA,UAAM,gBAAgB,KAAK,SAAS,WAAW;AAC/C,QAAI,OAAO,kBAAkB,YAAY;AACvC,YAAM,IAAI,MAAM,iFAA4E;AAAA,IAC9F;AACA,SAAK,SAAS,KAAK;AACnB,SAAK,YAAY,KAAK;AACtB,SAAK,UAAU,mBAAmB,KAAK,WAAW,gBAAgB;AAClE,SAAK,YAAY;AAAA,EACnB;AAAA,EAEA,MAAM,OAAO,OAA2D;AACtE,UAAM,OAAO;AAAA,MACX,WAAW,KAAK;AAAA,MAChB,QAAQ,MAAM,UAAU;AAAA,MACxB,UAAU,MAAM,YAAY;AAAA,MAC5B,OAAO,MAAM;AAAA,MACb,aAAa,MAAM;AAAA,MACnB,MAAM,MAAM;AAAA,MACZ,gBAAgB,MAAM;AAAA,MACtB,MAAM,MAAM;AAAA,MACZ,UAAU,MAAM;AAAA,MAChB,QAAQ,MAAM;AAAA,IAChB;AAEA,UAAM,MAAM,MAAM,KAAK,UAAU,GAAG,KAAK,OAAO,yBAAyB;AAAA,MACvE,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,eAAe,UAAU,KAAK,MAAM;AAAA,MACtC;AAAA,MACA,MAAM,KAAK,UAAU,IAAI;AAAA,IAC3B,CAAC;AAED,UAAM,UAAU,MAAM,SAAS,GAAG;AAElC,QAAI,CAAC,IAAI,IAAI;AACX,YAAM,IAAI;AAAA,QACR,8BAA8B,IAAI,MAAM,IAAI,IAAI,UAAU;AAAA,QAC1D,IAAI;AAAA,QACJ;AAAA,MACF;AAAA,IACF;AAEA,UAAM,aAAa,UAAU,SAAS,YAAY,KAAK,UAAU,SAAS,QAAQ;AAElF,QAAI,CAAC,YAAY;AACf,YAAM,IAAI;AAAA,QACR;AAAA,QACA,IAAI;AAAA,QACJ;AAAA,MACF;AAAA,IACF;AAEA,UAAM,oBAAwC,CAAC;AAC/C,QAAI,MAAM,eAAe,MAAM,YAAY,SAAS,GAAG;AACrD,iBAAW,cAAc,MAAM,aAAa;AAC1C,0BAAkB,KAAK,MAAM,KAAK,iBAAiB,YAAY,UAAU,CAAC;AAAA,MAC5E;AAAA,IACF;AAEA,WAAO,EAAE,YAAY,QAAQ,YAAY,kBAAkB;AAAA,EAC7D;AAAA,EAEA,MAAc,iBACZ,YACA,YAC2B;AAC3B,QAAI;AACF,YAAM,gBAAgB,SAAS,WAAW,OAAO;AACjD,YAAM,MAAM,MAAM,KAAK;AAAA,QACrB,GAAG,KAAK,OAAO,kBAAkB,mBAAmB,UAAU,CAAC;AAAA,QAC/D;AAAA,UACE,QAAQ;AAAA,UACR,SAAS;AAAA,YACP,gBAAgB;AAAA,YAChB,eAAe,UAAU,KAAK,MAAM;AAAA,UACtC;AAAA,UACA,MAAM,KAAK,UAAU;AAAA,YACnB,UAAU,WAAW;AAAA,YACrB,UAAU,WAAW;AAAA,YACrB;AAAA,UACF,CAAC;AAAA,QACH;AAAA,MACF;AAEA,YAAM,UAAU,MAAM,SAAS,GAAG;AAElC,UAAI,CAAC,IAAI,IAAI;AACX,eAAO;AAAA,UACL,UAAU,WAAW;AAAA,UACrB,IAAI;AAAA,UACJ,OAAO,gBAAgB,IAAI,QAAQ,IAAI,YAAY,OAAO;AAAA,QAC5D;AAAA,MACF;AAEA,YAAM,SACJ,WAAW,OAAO,YAAY,YAAY,YAAY,UAClD,OAAQ,QAAgC,MAAM,IAC9C;AAEN,aAAO,EAAE,UAAU,WAAW,UAAU,IAAI,MAAM,OAAO;AAAA,IAC3D,SAAS,KAAK;AACZ,aAAO;AAAA,QACL,UAAU,WAAW;AAAA,QACrB,IAAI;AAAA,QACJ,OAAO,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAAA,MACxD;AAAA,IACF;AAAA,EACF;AACF;AAEA,SAAS,mBAAmB,KAAqB;AAC/C,SAAO,IAAI,SAAS,GAAG,IAAI,IAAI,MAAM,GAAG,EAAE,IAAI;AAChD;AAEA,SAAS,UAAU,SAAkB,KAAkD;AACrF,MAAI,WAAW,OAAO,YAAY,YAAY,OAAO,SAAS;AAC5D,UAAM,QAAS,QAAoC,GAAG;AACtD,QAAI,UAAU,UAAa,UAAU,KAAM,QAAO,OAAO,KAAK;AAAA,EAChE;AACA,SAAO;AACT;AAEA,eAAe,SAAS,KAAiC;AACvD,QAAM,OAAO,MAAM,IAAI,KAAK;AAC5B,MAAI,CAAC,KAAM,QAAO;AAClB,MAAI;AACF,WAAO,KAAK,MAAM,IAAI;AAAA,EACxB,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAEA,SAAS,gBAAgB,QAAgB,YAAoB,MAAuB;AAClF,QAAM,SAAS,GAAG,MAAM,IAAI,UAAU,GAAG,KAAK;AAC9C,MAAI,QAAQ,OAAO,SAAS,YAAY,WAAW,MAAM;AACvD,WAAO,GAAG,MAAM,KAAK,OAAQ,KAA4B,KAAK,CAAC;AAAA,EACjE;AACA,MAAI,OAAO,SAAS,YAAY,KAAK,SAAS,GAAG;AAC/C,WAAO,GAAG,MAAM,KAAK,IAAI;AAAA,EAC3B;AACA,SAAO;AACT;AAEA,SAAS,SAAS,SAAsC;AACtD,QAAM,QAAQ,OAAO,YAAY,WAAW,IAAI,YAAY,EAAE,OAAO,OAAO,IAAI;AAChF,SAAO,cAAc,KAAK;AAC5B;AAEA,SAAS,cAAc,OAA2B;AAChD,MAAI,OAAO,WAAW,aAAa;AACjC,WAAO,OAAO,KAAK,KAAK,EAAE,SAAS,QAAQ;AAAA,EAC7C;AACA,MAAI,SAAS;AACb,aAAW,QAAQ,OAAO;AACxB,cAAU,OAAO,aAAa,IAAI;AAAA,EACpC;AACA,SAAO,KAAK,MAAM;AACpB;","names":[]}
+{"version":3,"sources":["../src/errors.ts","../src/index.ts"],"sourcesContent":["export class ConveyorIncidentsError extends Error {\n  readonly status: number;\n  readonly body: unknown;\n\n  constructor(message: string, status: number, body: unknown) {\n    super(message);\n    this.name = \"ConveyorIncidentsError\";\n    this.status = status;\n    this.body = body;\n  }\n}\n","import { ConveyorIncidentsError } from \"./errors.js\";\n\nexport { ConveyorIncidentsError } from \"./errors.js\";\n\nconst DEFAULT_BASE_URL = \"https://api.conveyor.rallycryapp.com\";\nconst DEFAULT_SOURCE = \"client\";\nconst DEFAULT_SEVERITY: IncidentSeverity = \"medium\";\n\n/** Server-side per-file ceiling — keep in sync with MAX_ATTACHMENT_BYTES in\n * conveyor's incident-routes.ts. Checked client-side so an oversized file\n * fails with a descriptive `attachmentResults` error instead of an HTTP 413. */\nexport const MAX_ATTACHMENT_BYTES = 5 * 1024 * 1024;\n\nexport type IncidentSeverity = \"critical\" | \"high\" | \"medium\" | \"low\";\n\nexport type ConveyorCardType = \"incident\" | \"suggestion\" | \"task\";\n\nexport interface ConveyorIncidentsOptions {\n  apiKey: string;\n  projectId: string;\n  baseUrl?: string;\n  fetch?: typeof fetch;\n}\n\nexport interface IncidentAttachment {\n  fileName: string;\n  mimeType: string;\n  content: Uint8Array | string;\n}\n\nexport interface ReportIncidentInput {\n  title: string;\n  description?: string;\n  severity?: IncidentSeverity;\n  source?: string;\n  fingerprintKey?: string;\n  plan?: string;\n  attachments?: IncidentAttachment[];\n  /** Card type to create. The server defaults to \"incident\" when omitted. */\n  type?: ConveyorCardType;\n  /**\n   * Project-member emails. The FIRST email that resolves to a member of the\n   * target project becomes the card's assignee; the rest are ignored.\n   * Non-member emails are silently skipped.\n   */\n  assigned?: string[];\n  /**\n   * Project-member emails. EVERY email that resolves to a member of the\n   * target project is added as a reviewer. Non-member emails are silently\n   * skipped.\n   */\n  review?: string[];\n  /**\n   * Project-member email used as the card's creator. When omitted — or when\n   * the email doesn't resolve to a member of the target project — the card\n   * is attributed to the \"Conveyor Incidents\" system user.\n   */\n  createdBy?: string;\n}\n\nexport interface AttachmentResult {\n  fileName: string;\n  ok: boolean;\n  fileId?: string;\n  error?: string;\n}\n\nexport interface ReportIncidentResult {\n  incidentId: string;\n  /** Alias of `incidentId` — prefer this when reporting type \"suggestion\" or \"task\". */\n  cardId: string;\n  attachmentResults: AttachmentResult[];\n}\n\nexport class ConveyorIncidents {\n  private readonly apiKey: string;\n  private readonly projectId: string;\n  private readonly baseUrl: string;\n  private readonly fetchImpl: typeof fetch;\n\n  constructor(opts: ConveyorIncidentsOptions) {\n    if (!opts.apiKey) {\n      throw new Error(\"ConveyorIncidents: apiKey is required\");\n    }\n    if (!opts.projectId) {\n      throw new Error(\"ConveyorIncidents: projectId is required\");\n    }\n    const resolvedFetch = opts.fetch ?? globalThis.fetch;\n    if (typeof resolvedFetch !== \"function\") {\n      throw new Error(\"ConveyorIncidents: no global fetch available — pass opts.fetch on Node <18\");\n    }\n    this.apiKey = opts.apiKey;\n    this.projectId = opts.projectId;\n    this.baseUrl = stripTrailingSlash(opts.baseUrl ?? DEFAULT_BASE_URL);\n    this.fetchImpl = resolvedFetch;\n  }\n\n  async report(input: ReportIncidentInput): Promise<ReportIncidentResult> {\n    const body = {\n      projectId: this.projectId,\n      source: input.source ?? DEFAULT_SOURCE,\n      severity: input.severity ?? DEFAULT_SEVERITY,\n      title: input.title,\n      description: input.description,\n      plan: input.plan,\n      fingerprintKey: input.fingerprintKey,\n      type: input.type,\n      assigned: input.assigned,\n      review: input.review,\n      createdBy: input.createdBy,\n    };\n\n    const res = await this.fetchImpl(`${this.baseUrl}/api/incidents/report`, {\n      method: \"POST\",\n      headers: {\n        \"Content-Type\": \"application/json\",\n        Authorization: `Bearer ${this.apiKey}`,\n      },\n      body: JSON.stringify(body),\n    });\n\n    const payload = await readJson(res);\n\n    if (!res.ok) {\n      throw new ConveyorIncidentsError(\n        `Failed to report incident: ${res.status} ${res.statusText}`,\n        res.status,\n        payload,\n      );\n    }\n\n    const incidentId = extractId(payload, \"incidentId\") ?? extractId(payload, \"cardId\");\n\n    if (!incidentId) {\n      throw new ConveyorIncidentsError(\n        \"Invalid response from /api/incidents/report: missing incidentId\",\n        res.status,\n        payload,\n      );\n    }\n\n    const attachmentResults: AttachmentResult[] = [];\n    if (input.attachments && input.attachments.length > 0) {\n      for (const attachment of input.attachments) {\n        attachmentResults.push(await this.uploadAttachment(incidentId, attachment));\n      }\n    }\n\n    return { incidentId, cardId: incidentId, attachmentResults };\n  }\n\n  private async uploadAttachment(\n    incidentId: string,\n    attachment: IncidentAttachment,\n  ): Promise<AttachmentResult> {\n    try {\n      const bytes =\n        typeof attachment.content === \"string\"\n          ? new TextEncoder().encode(attachment.content)\n          : attachment.content;\n      if (bytes.byteLength > MAX_ATTACHMENT_BYTES) {\n        return {\n          fileName: attachment.fileName,\n          ok: false,\n          error: `Attachment is ${bytes.byteLength} bytes — exceeds the ${MAX_ATTACHMENT_BYTES}-byte (5 MB) server limit; upload skipped`,\n        };\n      }\n      const contentBase64 = bytesToBase64(bytes);\n      const res = await this.fetchImpl(\n        `${this.baseUrl}/api/incidents/${encodeURIComponent(incidentId)}/files`,\n        {\n          method: \"POST\",\n          headers: {\n            \"Content-Type\": \"application/json\",\n            Authorization: `Bearer ${this.apiKey}`,\n          },\n          body: JSON.stringify({\n            fileName: attachment.fileName,\n            mimeType: attachment.mimeType,\n            contentBase64,\n          }),\n        },\n      );\n\n      const payload = await readJson(res);\n\n      if (!res.ok) {\n        return {\n          fileName: attachment.fileName,\n          ok: false,\n          error: formatErrorBody(res.status, res.statusText, payload),\n        };\n      }\n\n      const fileId =\n        payload && typeof payload === \"object\" && \"fileId\" in payload\n          ? String((payload as { fileId: unknown }).fileId)\n          : undefined;\n\n      return { fileName: attachment.fileName, ok: true, fileId };\n    } catch (err) {\n      return {\n        fileName: attachment.fileName,\n        ok: false,\n        error: err instanceof Error ? err.message : String(err),\n      };\n    }\n  }\n}\n\nfunction stripTrailingSlash(url: string): string {\n  return url.endsWith(\"/\") ? url.slice(0, -1) : url;\n}\n\nfunction extractId(payload: unknown, key: \"incidentId\" | \"cardId\"): string | undefined {\n  if (payload && typeof payload === \"object\" && key in payload) {\n    const value = (payload as Record<string, unknown>)[key];\n    if (value !== undefined && value !== null) return String(value);\n  }\n  return undefined;\n}\n\nasync function readJson(res: Response): Promise<unknown> {\n  const text = await res.text();\n  if (!text) return undefined;\n  try {\n    return JSON.parse(text);\n  } catch {\n    return text;\n  }\n}\n\nfunction formatErrorBody(status: number, statusText: string, body: unknown): string {\n  const prefix = `${status} ${statusText}`.trim();\n  if (body && typeof body === \"object\" && \"error\" in body) {\n    return `${prefix}: ${String((body as { error: unknown }).error)}`;\n  }\n  if (typeof body === \"string\" && body.length > 0) {\n    return `${prefix}: ${body}`;\n  }\n  return prefix;\n}\n\nfunction bytesToBase64(bytes: Uint8Array): string {\n  if (typeof Buffer !== \"undefined\") {\n    return Buffer.from(bytes).toString(\"base64\");\n  }\n  let binary = \"\";\n  for (const byte of bytes) {\n    binary += String.fromCharCode(byte);\n  }\n  return btoa(binary);\n}\n"],"mappings":";AAAO,IAAM,yBAAN,cAAqC,MAAM;AAAA,EACvC;AAAA,EACA;AAAA,EAET,YAAY,SAAiB,QAAgB,MAAe;AAC1D,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,SAAS;AACd,SAAK,OAAO;AAAA,EACd;AACF;;;ACNA,IAAM,mBAAmB;AACzB,IAAM,iBAAiB;AACvB,IAAM,mBAAqC;AAKpC,IAAM,uBAAuB,IAAI,OAAO;AA+DxC,IAAM,oBAAN,MAAwB;AAAA,EACZ;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEjB,YAAY,MAAgC;AAC1C,QAAI,CAAC,KAAK,QAAQ;AAChB,YAAM,IAAI,MAAM,uCAAuC;AAAA,IACzD;AACA,QAAI,CAAC,KAAK,WAAW;AACnB,YAAM,IAAI,MAAM,0CAA0C;AAAA,IAC5D;AACA,UAAM,gBAAgB,KAAK,SAAS,WAAW;AAC/C,QAAI,OAAO,kBAAkB,YAAY;AACvC,YAAM,IAAI,MAAM,iFAA4E;AAAA,IAC9F;AACA,SAAK,SAAS,KAAK;AACnB,SAAK,YAAY,KAAK;AACtB,SAAK,UAAU,mBAAmB,KAAK,WAAW,gBAAgB;AAClE,SAAK,YAAY;AAAA,EACnB;AAAA,EAEA,MAAM,OAAO,OAA2D;AACtE,UAAM,OAAO;AAAA,MACX,WAAW,KAAK;AAAA,MAChB,QAAQ,MAAM,UAAU;AAAA,MACxB,UAAU,MAAM,YAAY;AAAA,MAC5B,OAAO,MAAM;AAAA,MACb,aAAa,MAAM;AAAA,MACnB,MAAM,MAAM;AAAA,MACZ,gBAAgB,MAAM;AAAA,MACtB,MAAM,MAAM;AAAA,MACZ,UAAU,MAAM;AAAA,MAChB,QAAQ,MAAM;AAAA,MACd,WAAW,MAAM;AAAA,IACnB;AAEA,UAAM,MAAM,MAAM,KAAK,UAAU,GAAG,KAAK,OAAO,yBAAyB;AAAA,MACvE,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,eAAe,UAAU,KAAK,MAAM;AAAA,MACtC;AAAA,MACA,MAAM,KAAK,UAAU,IAAI;AAAA,IAC3B,CAAC;AAED,UAAM,UAAU,MAAM,SAAS,GAAG;AAElC,QAAI,CAAC,IAAI,IAAI;AACX,YAAM,IAAI;AAAA,QACR,8BAA8B,IAAI,MAAM,IAAI,IAAI,UAAU;AAAA,QAC1D,IAAI;AAAA,QACJ;AAAA,MACF;AAAA,IACF;AAEA,UAAM,aAAa,UAAU,SAAS,YAAY,KAAK,UAAU,SAAS,QAAQ;AAElF,QAAI,CAAC,YAAY;AACf,YAAM,IAAI;AAAA,QACR;AAAA,QACA,IAAI;AAAA,QACJ;AAAA,MACF;AAAA,IACF;AAEA,UAAM,oBAAwC,CAAC;AAC/C,QAAI,MAAM,eAAe,MAAM,YAAY,SAAS,GAAG;AACrD,iBAAW,cAAc,MAAM,aAAa;AAC1C,0BAAkB,KAAK,MAAM,KAAK,iBAAiB,YAAY,UAAU,CAAC;AAAA,MAC5E;AAAA,IACF;AAEA,WAAO,EAAE,YAAY,QAAQ,YAAY,kBAAkB;AAAA,EAC7D;AAAA,EAEA,MAAc,iBACZ,YACA,YAC2B;AAC3B,QAAI;AACF,YAAM,QACJ,OAAO,WAAW,YAAY,WAC1B,IAAI,YAAY,EAAE,OAAO,WAAW,OAAO,IAC3C,WAAW;AACjB,UAAI,MAAM,aAAa,sBAAsB;AAC3C,eAAO;AAAA,UACL,UAAU,WAAW;AAAA,UACrB,IAAI;AAAA,UACJ,OAAO,iBAAiB,MAAM,UAAU,6BAAwB,oBAAoB;AAAA,QACtF;AAAA,MACF;AACA,YAAM,gBAAgB,cAAc,KAAK;AACzC,YAAM,MAAM,MAAM,KAAK;AAAA,QACrB,GAAG,KAAK,OAAO,kBAAkB,mBAAmB,UAAU,CAAC;AAAA,QAC/D;AAAA,UACE,QAAQ;AAAA,UACR,SAAS;AAAA,YACP,gBAAgB;AAAA,YAChB,eAAe,UAAU,KAAK,MAAM;AAAA,UACtC;AAAA,UACA,MAAM,KAAK,UAAU;AAAA,YACnB,UAAU,WAAW;AAAA,YACrB,UAAU,WAAW;AAAA,YACrB;AAAA,UACF,CAAC;AAAA,QACH;AAAA,MACF;AAEA,YAAM,UAAU,MAAM,SAAS,GAAG;AAElC,UAAI,CAAC,IAAI,IAAI;AACX,eAAO;AAAA,UACL,UAAU,WAAW;AAAA,UACrB,IAAI;AAAA,UACJ,OAAO,gBAAgB,IAAI,QAAQ,IAAI,YAAY,OAAO;AAAA,QAC5D;AAAA,MACF;AAEA,YAAM,SACJ,WAAW,OAAO,YAAY,YAAY,YAAY,UAClD,OAAQ,QAAgC,MAAM,IAC9C;AAEN,aAAO,EAAE,UAAU,WAAW,UAAU,IAAI,MAAM,OAAO;AAAA,IAC3D,SAAS,KAAK;AACZ,aAAO;AAAA,QACL,UAAU,WAAW;AAAA,QACrB,IAAI;AAAA,QACJ,OAAO,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAAA,MACxD;AAAA,IACF;AAAA,EACF;AACF;AAEA,SAAS,mBAAmB,KAAqB;AAC/C,SAAO,IAAI,SAAS,GAAG,IAAI,IAAI,MAAM,GAAG,EAAE,IAAI;AAChD;AAEA,SAAS,UAAU,SAAkB,KAAkD;AACrF,MAAI,WAAW,OAAO,YAAY,YAAY,OAAO,SAAS;AAC5D,UAAM,QAAS,QAAoC,GAAG;AACtD,QAAI,UAAU,UAAa,UAAU,KAAM,QAAO,OAAO,KAAK;AAAA,EAChE;AACA,SAAO;AACT;AAEA,eAAe,SAAS,KAAiC;AACvD,QAAM,OAAO,MAAM,IAAI,KAAK;AAC5B,MAAI,CAAC,KAAM,QAAO;AAClB,MAAI;AACF,WAAO,KAAK,MAAM,IAAI;AAAA,EACxB,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAEA,SAAS,gBAAgB,QAAgB,YAAoB,MAAuB;AAClF,QAAM,SAAS,GAAG,MAAM,IAAI,UAAU,GAAG,KAAK;AAC9C,MAAI,QAAQ,OAAO,SAAS,YAAY,WAAW,MAAM;AACvD,WAAO,GAAG,MAAM,KAAK,OAAQ,KAA4B,KAAK,CAAC;AAAA,EACjE;AACA,MAAI,OAAO,SAAS,YAAY,KAAK,SAAS,GAAG;AAC/C,WAAO,GAAG,MAAM,KAAK,IAAI;AAAA,EAC3B;AACA,SAAO;AACT;AAEA,SAAS,cAAc,OAA2B;AAChD,MAAI,OAAO,WAAW,aAAa;AACjC,WAAO,OAAO,KAAK,KAAK,EAAE,SAAS,QAAQ;AAAA,EAC7C;AACA,MAAI,SAAS;AACb,aAAW,QAAQ,OAAO;AACxB,cAAU,OAAO,aAAa,IAAI;AAAA,EACpC;AACA,SAAO,KAAK,MAAM;AACpB;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rallycry/conveyor-incidents",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Typed TypeScript client for Conveyor's public incidents REST API",
   "keywords": [
     "client",