diff --git a/docs/protos/home.mdx b/docs/protos/home.mdx index 38b30fcbc..7135963d2 100644 --- a/docs/protos/home.mdx +++ b/docs/protos/home.mdx @@ -16,13 +16,23 @@ Neosync, like many web services these days, is a full-fledged API. Check out the All of our APIs are generated from Protobuf files. For this reason, a client can easily be generated in any of the many supported languages. Internally, we make great use of the Go SDK as well as the TypeScript SDK. -## Generating a client +## Clients ### Go -The Go SDK can be easily generated, or the SDK that is committed to the Neosync repo may be freely imported and utilized. -See the [Go SDK](./go.mdx) page for more information on how to do this. +The Go SDK that is committed to the Neosync repo may be freely imported and utilized. +See the [Go SDK](./go.mdx) page for more information on how to use the SDK. -### Other languages +All of the generated code lives [here](https://github.com/nucleuscloud/neosync/tree/main/backend/gen/go/protos/mgmt/v1alpha1). -We are working on publishing Neosync SDKs in a few other languages, but as the Neosync protos are public, they can be downloaded separately and used to generate a client in the chosen language using `protoc` or `buf`. +### TypeScript + +The TypeScript SDK is published to the `npm` registry. It is generated from Neosync protos and is used by the Neosync App. +See the [TS SDK](./typescript.mdx) page for more information on how to use the SDK. + +All of the generated code lives [here](https://github.com/nucleuscloud/neosync/tree/main/frontend/packages/sdk). + +### Protos + +All of Neosync's protos are public and can be found [here](https://github.com/nucleuscloud/neosync/tree/main/backend/protos). +A new SDK can be easily generated by augmenting the `buf.gen.yaml` file, or providing a separate one when running the `buf` cli to generate a different SDK for other purposes. diff --git a/docs/protos/mgmt/v1alpha1/connection.proto.mdx b/docs/protos/mgmt/v1alpha1/connection.proto.mdx index be7e66258..68400615d 100644 --- a/docs/protos/mgmt/v1alpha1/connection.proto.mdx +++ b/docs/protos/mgmt/v1alpha1/connection.proto.mdx @@ -18,7 +18,7 @@ _**package** mgmt.v1alpha1_ ### `AwsS3ConnectionConfig` - + ### `AwsS3Credentials` diff --git a/docs/protos/typescript.mdx b/docs/protos/typescript.mdx index 6bcca45a1..58ff0a9f1 100644 --- a/docs/protos/typescript.mdx +++ b/docs/protos/typescript.mdx @@ -12,6 +12,11 @@ import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx'; ## Introduction The Neosync TS SDK is publicly available and can be added to any TS/JS-based project. +This package supports both ES-Modules and CommonJS. + +The correct entrypoint will be chosen based on using `import` or `require`. + +The `tsup` package is used to generated the distributed code. Neosync's Dashboard App is the primary user of the TS SDK today, and can be used as a reference for examples of how to use the SDK.