Skip to content

Requirements: Phase 5 — API Proxy Update

The @arda-cards/api-proxy package shall define TypeScript types matching the new composite response shape:

  • CompositeRenderResult with job, asOF, and results array
  • GroupRenderResult with templateId, description, itemCount, url, error, and optional debugPayload

The existing RenderResult type shall be replaced or aliased.

Traces to: SAC::PRINT::FR-0003, Phase 2 (CompositeRenderResult)

The ItemProxy.printLabels(), ItemProxy.printBreadcrumbs(), and KanbanProxy.printCards() methods shall return Promise<CompositeRenderResult> instead of Promise<RenderResult>.

Traces to: Phase 2 (endpoint response type change)

The print proxy methods shall accept optional diagnostic parameters (debug, dryRun, livePrint) and pass them as query parameters to the API.

Traces to: SAC::PRINT-DX::FR-0003, SAC::PRINT-DX::FR-0006, Phase 3

REQ-P5-004: Unmark-as-printed proxy method

Section titled “REQ-P5-004: Unmark-as-printed proxy method”

KanbanProxy shall expose an unmarkPrinted(cardEId: string) method that calls POST /v1/kanban/kanban-card/{eId}/event/unmark.

Traces to: SAC::PRINT::FR-0012, Phase 1

All new and modified proxy methods shall have unit tests following the existing test patterns in the api-proxy repository (Vitest + fetch mocks).

The api-proxy CHANGELOG shall be updated with the version entry.


Copyright: (c) Arda Systems 2025-2026, All rights reserved