client-ts icon indicating copy to clipboard operation
client-ts copied to clipboard

[Meta] Xata SDK 1.0 Milestone

Open SferaDev opened this issue 1 year ago • 0 comments

List of breaking changes proposed for v1:

API:

  • [x] https://github.com/xataio/client-ts/issues/1081

Internal improvements:

  • [x] XataApiClient with Proxies (@SferaDev and @eemmiillyy)
  • [ ] Remove getMetadata in favor or xata_id, xata_version columns (@eemmiillyy)
  • [ ] Schema inference type review
  • [ ] Remove inheritance of query under repository

Configuration (to be discussed):

  • [ ] Do not inject workspace url in codegen: XATA_DATABASE_URL (@eemmiillyy)
  • [ ] Do not default to main branch: XATA_BRANCH (@eemmiillyy)

Front facing:

  • [ ] getXataClient (@SferaDev)
  • [ ] Remove RecordArray: [].hasNextPage() (@eemmiillyy)

For debate:

  • [ ] Get operations renaming: getPaginated(), getMany({ { pagination: { size: 30 } }), getAll()
  • [ ] Remove xata schema edit and defautl to xata schema edit --source
  • [ ] Dates are not serializable, toSerializable brings a lot of confusion

CLI v1:

  • [ ] Codegen default behaviour for incremental builds
  • [ ] Binary download and execute (not blocker)
  • [ ] Auth using OAuth2

SferaDev avatar Apr 21 '23 05:04 SferaDev