zth / pgtyped-rescript Goto Github PK

It'd be nice to generate variations of every function:

e.g.

/* @name findDataSetCaseById */
SELECT * FROM test_case where id = :id! limit 1;

could generate:

• findDataSetCaseById- a list of results
• findDataSetCaseByIdOne - a single result, throws an exception if there isn't exactly one element
  -findDataSetCaseByIdOneOpt - a single option of a result

What should error handling look like? Postgres can error on queries.

There are a few low-hanging bits of fruit that would enable a first-pass at genType support!

As an example of the changes necessary, here is are the manual tweaks I made to the pgtyped-rescript artifacts https://gist.github.com/sgrove/68c85bd81f3776bfa4bf9ad9baf1bb48/revisions

1. type aliases with @genType.opaque to hide the upstream types (pgClient, Null.t) + manual type specification for the parameters rescript-association/genType#636 and rescript-association/genType#634 (comment)
2. No labeled arguments, since genType just outputs the wrong stuff rescript-association/genType#635

With those changes, we get this behavior in TypeScript:

It doesn't provide an all-the-way optimal experience on the other side (e.g. pgClient isn't appropriately typed):

But it's a minor detail compared to the experience before!

That, or just document how to do it.

Describe the bug
Selecting a column of type jsonb[] will generate invalid rescript:

/* @name findById */
SELECT examples FROM test_case where id = :id! limit 1;

generates:

open PgTyped
type Js.Json.tArray = array<Js.Json.t>

/** 'FindById' parameters type */
type findByIdParams = {
  id: string,
}

/** 'FindById' return type */
type findByIdResult = {
  /** Examples conforming to the input schema */
  examples: Null.t<Js.Json.tArray>,
}

type Js.Json.tArray is syntactically invalid

Expected behavior
The type value is fine, so maybe just munging Js.Json.tArray to jsJsontArray would be enough?