Generate concrete typescript types for JSON columns based on pg_jsonschema

Aperta
  • Qualcosa non va?
#834 1 commento 8 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
postgresql, typescript
Ambito
databases, tooling

Direzione di ricerca

Parti dall'entry point supabase gen types typescript e traccia il modo in cui le colonne JSON di PostgreSQL vengono attualmente generate come JSON. Analizza come potrebbero essere identificate e convertite le verifiche pg_jsonschema, quindi verifica che lo schema dell'array di esempio produca string[], mentre le verifiche non supportate o complesse ricadano su JSON.

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

Descrizione

When I create JSON checks on columns with pg_jsonschema it would be super cool to have it also in generated ts types.

Currently when I create the following table

CREATE TABLE public.some_table (
    id SERIAL PRIMARY KEY,
    arr jsonb not null check (
      jsonb_matches_schema ('{
        "type": "array",
        "items": {
           "type": "string"
         }       
      }',
      arr
      )
    )
);

Generating types with supabase gen types typescript produces the following types

...
arr: JSON
...

But I'd like to get

...
arr: string[]
...

Potentially it would be achievable by parsing passed schema in checks via a tool like https://github.com/bcherny/json-schema-to-typescript

Describe alternatives you've considered
I haven't found any other alternatives aligned with the current CLI architecture

Additional context
I don't know what I'd expect with more complex check expressions. Maybe ignore them and fall back to JSON.

Lingua principale
TypeScript
Stelle
1.3k
Fork
228
Merge medio
1g 8h
PR unite (30g)
3

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 supabase/postgres-meta

Tutte le issue di supabase/postgres-meta

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.