Fix civil-date public types: Day.date, currentPeriod, activeDate → YYYY-MM-DD strings

Aperta
  • Qualcosa non va?
#27 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
api

Direzione di ricerca

Start by reading the public types for Day and CalendarStore, then search for all-day event boundaries and existing tests that use Temporal.PlainDate. Update the affected exported types and usages so civil dates are YYYY-MM-DD strings while event start/end remain Date objects. Done means no exported type exposes Temporal.PlainDate, the named values and tests use identical ISO date strings, and consumers get a TypeScript error for the old property access.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

Parent

https://github.com/TanStack/time/issues/25

What to build

Change every civil-date value at the public boundary from `Temporal.PlainDate` to a `YYYY-MM-DD` ISO string. This is a targeted breaking change that must land before the module API is built, so the correct types are foundational from the start.

Civil values affected: `Day.date`, `CalendarStore.currentPeriod`, `CalendarStore.activeDate`, and any all-day event boundary that is currently typed as `Temporal.PlainDate`.

Why: encoding a civil date as a `Temporal.PlainDate` leaks the Temporal polyfill into consumer types. Encoding it as a `Date` object introduces the all-day off-by-one bug (UTC-midnight reads incorrectly in west-of-UTC timezones). A `YYYY-MM-DD` string is the honest, zero-ambiguity representation of a calendar-civil day.

Instant-bearing values (event `start`/`end`) are unaffected — those remain `Date` objects.

Acceptance criteria

  • `Day.date` is typed as `string` and carries a `YYYY-MM-DD` value
  • `CalendarStore.currentPeriod` and `activeDate` are typed as `string` (`YYYY-MM-DD`)
  • No `Temporal.PlainDate` appears in any exported type
  • `Day.isoDate` (already present) is confirmed as the canonical fast-path key; `Day.date` and `Day.isoDate` carry identical values — one of them may be removed if redundant
  • All existing tests updated to reflect the new types
  • A consumer who previously accessed `Day.date.year` / `.month` / `.day` receives a TypeScript error pointing them to the ISO string instead

Blocked by

https://github.com/TanStack/time/issues/26

Lingua principale
TypeScript
Stelle
620
Fork
6
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TanStack/time

Tutte le issue di TanStack/time

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.