aurae icon indicating copy to clipboard operation
aurae copied to clipboard

Create high level typescript API alongside auraescript but in its own repo

Open bpmooch opened this issue 1 year ago • 4 comments

I'd like to split auraescript into its own repo. Auraescript has the potential to be a novel way to interact with an aurae cluster. It is, however, in more of a state of experimentation than auraed. Splitting auraescript out and the required release management work to do so will benefit auraescript and auraed, getting us to a mature gRPC API more quickly than the current setup

bpmooch avatar Jun 20 '24 16:06 bpmooch

by "auraescript" do you mean "a typescript API"? i wonder if we continue to support auraescript as a generated low-level typescript API but in addition we create a separate high level abstraction API in typescript as a separate repo.

much as we've done with ae.

dmah42 avatar Jun 21 '24 13:06 dmah42

I mean a high level typescript api. I have no opinion in terms of naming. Could you expand a little bit on how you see the software arch for auraed -> auraescript -> high level api?

bpmooch avatar Jun 23 '24 19:06 bpmooch

there are two options for a typescript API i think:

  1. auraed -> auto-generated auraescript -> hand-written typescript high-level API that offers an abstracted logic
  2. auraed -> hand-written typescript high-level API that offers an abstracted logic

the former means that out-of-the-box we get an API that anyone can use which is aligned with the auraed version. but some people might want a more abstract API than we can auto-generate.

dmah42 avatar Jun 25 '24 14:06 dmah42

by "auraescript" do you mean "a typescript API"? i wonder if we continue to support auraescript as a generated low-level typescript API but in addition we create a separate high level abstraction API in typescript as a separate repo.

much as we've done with ae.

I didn't fully understand what you meant by this!! yes this is the way

bpmooch avatar Aug 04 '24 13:08 bpmooch