@envsync-cloud/envsync-ts-sdk 0.3.7 → 0.6.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 EnvSync Cloud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,5 +1,69 @@
-# envsync-ts-sdk
+# `@envsync-cloud/envsync-ts-sdk`
 
-This is generated SDK for EnvSync API developed by EnvSync Cloud
+TypeScript SDK for the EnvSync API.
 
-## envsync-cloud
+This package provides the generated fetch-based client, models, and service types for interacting with EnvSync from browser or server-side TypeScript applications.
+
+## Install
+
+```bash
+npm install @envsync-cloud/envsync-ts-sdk
+```
+
+```bash
+bun add @envsync-cloud/envsync-ts-sdk
+```
+
+```bash
+pnpm add @envsync-cloud/envsync-ts-sdk
+```
+
+## Basic Usage
+
+```ts
+import { EnvSyncAPISDK } from "@envsync-cloud/envsync-ts-sdk";
+
+const sdk = new EnvSyncAPISDK({
+	BASE: "https://api.envsync.cloud",
+	TOKEN: process.env.ENVSYNC_TOKEN,
+});
+
+const apps = await sdk.applications.getApps();
+
+console.log(apps);
+```
+
+## Runtime Notes
+
+- The SDK uses the generated `fetch` client from `openapi-typescript-codegen`.
+- It works in browser bundlers and modern Node runtimes that provide `fetch`.
+- Configure the API base URL and auth headers through the SDK config.
+
+## Exports
+
+The package exports:
+
+- `EnvSyncAPISDK`
+- `OpenAPI`
+- `ApiError` and other core request types
+- generated models and services from the EnvSync OpenAPI spec
+
+## Regeneration
+
+The source for this package is generated from the EnvSync API OpenAPI spec.
+
+- Regenerate locally with `bun run generate:local`
+- Build with `bun run build`
+
+Do not hand-edit generated source under `src/`; regeneration will overwrite it.
+
+## Links
+
+- Repository: https://github.com/EnvSync-Cloud/envsync
+- Issues: https://github.com/EnvSync-Cloud/envsync/issues
+- Monorepo docs: https://github.com/EnvSync-Cloud/envsync#readme
+- Self-hosting guide: https://github.com/EnvSync-Cloud/envsync/blob/main/SELFHOSTING.md
+
+## Releases
+
+Published npm releases are tied to monorepo tags in the form `vX.Y.Z`.