@nomad-media/full 1.1.28 → 2026.9.2-beta.0

package/README.md

@@ -1,93 +1,74 @@
-## Prerequisites
-
-- Node package manager (npm).
-
-> 📘 Note
-> 
-> You can download npm [here](https://nodejs.org/en/download).
-
-## Setup
-
-To use the Nomad SDK, download the @nomad-media npm. There are two versions, the full version which includes all of the Nomad-Media endpoints, and the public version which only includes the media endpoints.
-
-To install the full version, use the following command:
-```shell
-npm install @nomad-media/full
-```
-
-To install the public version, use the following command:
-```shell
-npm install @nomad-media/public
-```
-
-Then to import it, you can either use the default version, or the debug version. The difference is that the debug version isn't compressed and has more documentation and named parameters. Both full and public have a debug version. Currently the debug version's tooltips don't show up. This is an issue with npm.
-
-To use the default version use:
-
-```javascript
-import NomadMediaSDK from "@nomad-media/full";
-```
-
-To use the debug version user:
-
-```javascript
-import NomadMediaSDK from "@nomad-media/full/debug";
-```
-
-To initialize the sdk, call the NomadMediaSDK class as shown below:
-
-```javascript
-const SDK = NomadMediaSDK(config);
-```
-
-## Logging in
-
-To log in to the sdk, in the config, enter the username/email of your user. Then enter your api key if you are using an api key, or your password.
-
-## Configure Environmental Variables
-
-Follow this format for the config:
-
-```
-const config = {
-    "username": "username",
-    "password": "password",
-    "apiKey": "apiKey",
-    "serviceApiUrl": "serverApiUrl",
-    "apiType": "admin",
-    "debugMode": true,
-    "singleton": false
-};
-```
-
-apiType: Specifies whether the function you are trying to run is **admin** or **portal**.
-
-debugMode: Specifies when running functions, whether of not to print api call information.
-
-singleton: Whether or not to only create one class instance.
-
-Place the config in a file called config.js and import it into your project.
-
-You are now ready to use the SDK in your project.
-
-> 📘 Contact: Make sure to contact Nomad Media support to get username, password, and url for your enviromnent.
-
-> 🚧 Make sure to keep your configuration options secret and do not share them publicly.
-
-## Upgrading NPM
-
-To upgrade the npm, use the following command:
-
-```shell
-npm update @nomad-media/full
-```
-
-## Nomad SDK References
-
-An overview of all of the Nomad SDK methods. Includes prameter details for the methods. Scroll down to the Nomad SDK section.
-
-[Nomad SDK References](https://developer.nomad-cms.com/reference)
-
-## Nomad SDK NPM Samples
-
-[Nomad SDK NPM Samples](https://github.com/Nomad-Media/samples-js)
+# @nomad-media/full
+
+Official JavaScript SDK for the [Nomad Media API](https://docs.nomad.media): admin and portal endpoints.
+For the media-only subset, see [`@nomad-media/public`](https://www.npmjs.com/package/@nomad-media/public).
+
+> **Beta.** The 2026.9 line is a pre-release. Install it with the `beta` tag and
+> [report problems](https://github.com/Nomad-Media/sdk-javascript/issues).
+
+## Install
+
+```shell
+npm install @nomad-media/full@beta
+```
+
+Requires Node.js 18 or higher.
+
+## Quick start
+
+```javascript
+import NomadMediaSDK from "@nomad-media/full";
+
+const sdk = new NomadMediaSDK({
+  serviceApiUrl: "https://your-instance.demos.media",
+  username: "you@example.com",
+  password: "your-password", // or apiKey
+  apiType: "admin"           // "admin" or "portal"
+});
+
+// The SDK logs in automatically on the first call
+const channels = await sdk.getLiveChannels();
+```
+
+Failed calls throw an `Error` whose `.status` is the HTTP status:
+
+```javascript
+try {
+  await sdk.getAsset(assetId);
+} catch (err) {
+  console.error(err.status, err.message);
+}
+```
+
+Uploads send the file in parts and return the new asset id:
+
+```javascript
+const assetId = await sdk.uploadAsset(null, null, null, "replace", "./video.mp4", folderId);
+```
+
+For large files, pass `{ maxWorkers, partConfirmation, onProgress }` as the last argument.
+
+## Upgrading from 1.x
+
+- **Failed requests throw.** 1.x logged the error and returned `null`. Wrap calls in `try`/`catch`.
+- **Timed-out writes are not retried.** A POST, PUT, PATCH or DELETE that times out throws.
+- **Versions follow the API:** `YYYY.M.patch` (for example `2026.9.2`).
+
+The full list of changes is in the [changelog](https://github.com/Nomad-Media/sdk-javascript/blob/main/CHANGELOG.md).
+
+## Configuration
+
+| Option | Description |
+|--------|-------------|
+| `serviceApiUrl` | Your API base URL. Required. |
+| `username`, `password` / `apiKey` | Your credentials. Keep them secret. |
+| `apiType` | `"admin"` or `"portal"`. |
+| `debugMode` | Log API call details. |
+
+An unminified build with parameter names is available as `@nomad-media/full/debug`.
+
+## More
+
+- [Documentation](https://docs.nomad.media)
+- [Samples](https://github.com/Nomad-Media/samples-js)
+- [Issues](https://github.com/Nomad-Media/sdk-javascript/issues)