@moviie/player-sdk 0.2.0

package/README.md

@@ -0,0 +1,30 @@
+# @moviie/player-sdk
+
+Vendor-agnostic HTTP client for Moviie playback metadata and telemetry. Works in Node, browsers, and React Native.
+
+## Playback (`getPlayback`)
+
+`MoviieClient.getPlayback(embedId)` calls `GET /v1/embeds/{embedId}/playback` against the configured API base. You **must** configure a **publishable** API key (`mvi_pub_*`) on the client. Missing keys and non-publishable keys throw `MoviieAuthError` before any network request (see `SDK_PLAYBACK_AUTH_ERROR_MESSAGE` in `./constants`).
+
+Private/admin keys belong only on the server; they are **not** accepted by the playback endpoint.
+
+## Install
+
+```bash
+pnpm add @moviie/player-sdk
+```
+
+## API base URL
+
+The default base is **`MOVIIE_DEFAULT_API_BASE_URL`** (`https://api.moviie.ai/v1`), aligned with the public OpenAPI production server.
+
+- **Expo:** pass **`apiBaseUrl`** on the `@moviie/player-expo` config plugin. It is written to `expo.extra` and applied at runtime via `configureMoviieEndpoints`.
+- **Node / scripts / tests:** call **`configureMoviieEndpoints({ apiBaseUrl: "https://your-host/v1" })`** before using `MoviieClient`, or rely on the default. Use **`resetMoviieEndpointsConfiguration()`** in tests between cases.
+
+Telemetry uses the **same origin** as the Public API with path **`MOVIIE_TELEMETRY_API_PATH_PREFIX`** (`/telemetry/v1`). `getMoviieEventsBaseUrl()` derives `{apiOrigin}/telemetry/v1` from `getMoviieApiBaseUrl()` unless you pass **`eventsBaseUrl`** into **`configureMoviieEndpoints`** (or the Expo plugin sets **`moviieEventsBaseUrl`** in `expo.extra`).
+
+Pass **`publishableKey`** and optional **`clientInfo`** when constructing **`MoviieClient`**.
+
+## License
+
+UNLICENSED — Moviie proprietary.