Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Turn protocol v1 parts into the old stream format, for widgets before 0.6

Fechada
  • Algo errado?
#240 2 comentários 0 reações 1 responsável Ver no GitHub

Mantenedores costumam responder em até 1 dia

@Saifjafri212213 já está trabalhando nisso.

Desde 20/10/2026.

  • #259 de @Saifjafri212213 — integrado

Avaliação

Esta issue ainda não foi avaliada.

Descrição

core enhancement good first issue hacktoberfest

The 0.6 server streams typed parts (WirePart, in packages/core/src/protocol/v1.ts), but widgets on 0.5 and older read chunks like {"content":"Hi"} and {"done":true}. Those widgets will stay on sites and CDNs for months, so the server needs to translate. This issue is that translation, as one pure function.

What to do
Create packages/core/src/protocol/legacy.ts:

export interface LegacyChunk {
  content?: string;
  done?: boolean;
  error?: string;
  retryAfter?: number;          // seconds
  leadCaptured?: boolean;
  leadData?: Record<string, unknown>;
  suggestedActions?: string[];
}

/** The chunk an old widget expects for this part, or null for parts it has no use for. */
export function toLegacyChunk(part: WirePart): LegacyChunk | null;
v1 part Legacy chunk
text-delta { content: delta }
lead-captured { leadCaptured: true, leadData: lead }
suggestions { suggestedActions: items }
error with rate_limited { error: 'rate_limit', retryAfter }, with retryAfter = retryAfterMs rounded up to seconds, left out when there's none
error with timeout { error: 'timeout' }
error with internal_error { error: 'internal_error' }
error with invalid_request { error: 'Invalid request' } (what 0.5 servers send)
error with any other code { error: 'provider_error' }
finish with reason error or aborted null (the error part already went out, or nobody is listening)
finish with any other reason { done: true }
everything else (start, text-start, text-end, source, tool-call, tool-result, handoff, agent-message) null

Those error strings are the ones the 0.5 widget understands (packages/widget/src/widget.ts, resolveErrorType, line 643).

Where to look

  • packages/core/src/protocol/v1.ts (the part types)
  • packages/server/src/handler.ts, which writes the old chunks today (lines 51, 61, 71, 181, 209, 223, 250)

Acceptance criteria

  • New packages/core/src/protocol/legacy.ts, exported from packages/core/src/protocol/index.ts and from @chatcops/core
  • One test per row of the table, plus retryAfterMs: 1500 becoming retryAfter: 2
  • A test that runs a whole v1 stream through it and gets the exact chunks a 0.5 server sends for the same reply
  • Changeset for @chatcops/core (minor)
  • pnpm test:coverage and pnpm lint pass

Want to work on this? Comment below and I'll assign it to you. Please take one issue at a time, branch off dev, and open your PR against dev with Closes #<this issue number>. Setup notes (pnpm, build before test) are in CONTRIBUTING.md.

Linguagem predominante
TypeScript
Estrelas
13
Forks
7
Merge médio
3h 33min
PRs com merge (30d)
176

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de codercops/chatcops

Todas as issues de codercops/chatcops

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.