@skypath-io/web-sdk 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @skypath-io/web-sdk
 
+## 1.1.0
+
+### Minor Changes
+
+- 3e26952: Remove the GTG flow: `createGtgFlow` and `IS_GTG_ENABLED` are no longer exposed by the SDK. Breaking for anyone who used `createGtgFlow`. There is no replacement because the GTG service was retired.
+
+### Patch Changes
+
+- 11c7907: Prefix request error messages with the HTTP status code (e.g. `[503] Request failed`) instead of "Unknown error".
+
 ## 1.0.1
 
 ### Patch Changes

package/README.md

@@ -1,43 +1,134 @@
-# SkyPath JavaScript SDK for Web 🌐
+# SkyPath Web SDK
 
-🛠️ The SkyPath Web SDK provides a comprehensive suite of tools designed to facilitate the development of performant, secure, and scalable web clients on the SkyPath platform. This SDK includes utility functions, classes, configurations, and documentation tailored to streamline the implementation of SkyPath APIs and features.
+[![npm](https://img.shields.io/npm/v/@skypath-io/web-sdk)](https://www.npmjs.com/package/@skypath-io/web-sdk)
 
-## Documentation 📚
+The SkyPath JavaScript SDK for web clients. It signs in to the SkyPath platform and gives you ready flows for turbulence observations, forecast, OneLayer and ADS-B data.
 
-For detailed information on how to use the SDK, please check the [Official Documentation.](https://docs.skypath.io/js/next/introduction/)
+|                   |                                                                                 |
+| ----------------- | ------------------------------------------------------------------------------- |
+| **Documentation** | [docs.skypath.io/js](https://docs.skypath.io/js/introduction)                   |
+| **Demo app**      | [skypath-web-sdk-demo](https://github.com/Yamasee/skypath-web-sdk-demo) (React) |
+| **Changelog**     | [CHANGELOG.md](./CHANGELOG.md)                                                  |
+| **Node**          | `>= 22.14.0`                                                                    |
+| **Builds**        | ES module, CommonJS and IIFE, with TypeScript types                             |
 
-## Demo Application 🖥️
+## Install
 
-Explore the SDK's capabilities through our [React Demo Application](https://github.com/Yamasee/skypath-web-sdk-demo)
+```bash
+npm install @skypath-io/web-sdk
+```
 
-## Development 🔧
+## Quick start
 
-### Publishing Alpha Versions
+```js
+import createSkyPathSDK from "@skypath-io/web-sdk";
 
-For testing features before official release, we support alpha version publishing through `rc/*` branches.
+const sdk = await createSkyPathSDK({
+  apiKey: "YOUR_API_KEY",
+  userId: "YOUR_USER_ID",
+  companyName: "YOUR_COMPANY_NAME",
+});
 
-**Quick start:**
-```bash
-# Create an RC branch
-git checkout -b rc/your-feature
+const observationsFlow = sdk.createObservationsFlow();
 
-# Create a changeset
-npm run changeset
+observationsFlow.onData((data) => {
+  // update your map layer
+});
+observationsFlow.start();
+```
 
-# Push to trigger alpha publish
-git push origin rc/your-feature
+> **`apiKey` is for development only.** In production, sign a JWT on your server and pass it through `authCallback`, so the API key never reaches the browser. See [Configuration](https://docs.skypath.io/js/configuration).
+
+<details>
+<summary><b>Sign in with a signed JWT</b></summary>
+
+```js
+const sdk = await createSkyPathSDK({
+  authCallback: async () => ({
+    jwt: await getSignedJwtFromYourServer(),
+    partnerId: "YOUR_PARTNER_ID",
+  }),
+});
+```
+
+</details>
+
+### Options
+
+| Option         | Type                                                    | Description                                   |
+| -------------- | ------------------------------------------------------- | --------------------------------------------- |
+| `apiKey`       | `string`                                                | API key, used with `userId` and `companyName` |
+| `userId`       | `string`                                                | The current user ID                           |
+| `companyName`  | `string`                                                | Your company name                             |
+| `authCallback` | `() => Promise<{ jwt, partnerId }>`                     | Returns a signed JWT, instead of `apiKey`     |
+| `environment`  | `"local" \| "development" \| "staging" \| "production"` | Default: `"staging"`                          |
+| `proxyUrl`     | `string`                                                | Send API requests through your own proxy      |
+
+### Flows
+
+| Flow                                                                  | Created with               | Available when        |
+| --------------------------------------------------------------------- | -------------------------- | --------------------- |
+| [Observations](https://docs.skypath.io/js/features/observations-flow) | `createObservationsFlow()` | always                |
+| [Forecast](https://docs.skypath.io/js/features/forecast-flow)         | `createForecastFlow()`     | `IS_FORECAST_ENABLED` |
+| [OneLayer](https://docs.skypath.io/js/features/onelayer-flow)         | `createOneLayerFlow()`     | `IS_ONELAYER_ENABLED` |
+| [ADS-B](https://docs.skypath.io/js/features/adsb-flow)                | `createAdsbFlow()`         | `IS_ADSB_ENABLED`     |
+
+The flags are set per user by SkyPath; check them before creating a flow. OneLayer already includes observations, so run OneLayer or Observations, not both.
+
+Utilities and constants are described in the [documentation](https://docs.skypath.io/js/features/utilities).
+
+## Development
+
+<details>
+<summary><b>Setup, scripts and releases</b></summary>
+
+### Setup
+
+```bash
+nvm use        # Node version from .nvmrc
+npm install    # also installs the Husky pre-commit hook
+npm run dev    # rebuilds dist/ and the types on every change
 ```
 
-## Support 🆘
+### Scripts
+
+| Command             | What it does                                      |
+| ------------------- | ------------------------------------------------- |
+| `npm run dev`       | Rollup in watch mode, types regenerated on change |
+| `npm run build`     | Production build and types into `dist/`           |
+| `npm run test`      | Unit tests (Vitest)                               |
+| `npm run lint`      | ESLint over `src/`                                |
+| `npm run format`    | Prettier over `src/`                              |
+| `npm run changeset` | Adds a changeset for the next release             |
+
+Every pull request runs lint, tests and the build.
+
+### Releasing a version
+
+Versions and the changelog are managed by [Changesets](https://github.com/changesets/changesets).
+
+1. Add a changeset to your pull request: `npm run changeset`, pick the bump (patch, minor or major) and write one line for the changelog.
+2. Merge the pull request into `master`. The release workflow opens a **Version Packages** pull request with the new version and changelog.
+3. Merge **Version Packages**. The workflow publishes the new version to npm under the `latest` tag.
 
-For any issues or questions, please contact the SkyPath team or consult our documentation.
+### Alpha versions
 
-## License 📄
+To try a change in another project before a release, publish it under the `alpha` tag from an `rc/*` branch:
 
-SkyPath JavaScript SDK for Web
+```bash
+git checkout -b rc/your-feature
+npm run changeset
+git push origin rc/your-feature
+```
+
+The workflow versions the package (for example `1.0.2-alpha.0`), publishes it, and pushes the version commits back to the branch, so pull before your next push. Install it with:
+
+```bash
+npm install @skypath-io/web-sdk@alpha
+```
 
-Copyright © 2025 SkyPath
+</details>
 
-All rights reserved.
+## License
 
-SkyPath JavaScript SDK for Web must be used according to the [SkyPath Terms of Use](https://skypath.io/terms/)
+Copyright © SkyPath. All rights reserved. See [LICENSE.txt](./LICENSE.txt) and the [SkyPath Terms of Use](https://skypath.io/terms/).