valenceai 0.5.0 → 0.5.1

package/CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.1] - 2025-06-24
+
+### Fixed
+- **Documentation Consistency**: Updated `README.dev.md` to use correct package name `valenceai` instead of outdated `valence-sdk-js`
+- **Developer Experience**: Corrected installation instructions for publishing and development workflows
+- **Package Alignment**: Ensured all development documentation reflects current package naming conventions
+
+### Documentation
+- **Developer Guidelines**: Updated publish and install commands with correct package names
+- **Consistency**: Aligned development documentation with current v0.5.x package structure
+- **Clarity**: Improved developer onboarding with accurate installation instructions
+
+### Publishing
+- **npm Commands**: Verified `npm publish --access public` workflow with correct package name
+- **Installation**: Updated to `npm install valenceai` for consistency with published package
+
 ## [0.5.0] - 2025-06-23
 
 ### Added

package/README.dev.md

@@ -3,5 +3,5 @@ npm login
 npm publish --access public
 
 # Install 
-npm install valence-sdk-js
+npm install valenceai
 

package/README.md

@@ -1,6 +1,6 @@
-# Valence SDK for Emotion Detection (JavaScript)
+# Valence SDK for Emotion Detection
 
-**valenceai** is a Node.js SDK for interacting with the [Valence Vibrations](https://valencevibrations.com) Emotion Detection API. It provides full support for uploading discrete and async audio files to retrieve their emotional signatures.
+**valenceai** is a Node.js SDK for interacting with the [Valence AI](https://getvalenceai.com) Pulse API for emotion detection. It provides a convenient interface to upload audio files -— short or long —- and retrieve detected emotional states.
 
 ## Features
 
@@ -28,7 +28,7 @@ While our APIs include the same model offerings in the backend, they are best su
 |               | DiscreteAPI                                                                                                                                                                     | AsynchAPI                                                                                                                          |
 | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
 | Inputs        | A short audio file, 4-10s in length.                                                                                                                                            | A long audio file, at least 5s in length. Inputs can be up to 1 GB large.                                                         |
-| Outputs       | A JSON that includes the primary emotion detected in the file, along with its confidence. Optionally, the confidence scores of all other emotions in the model can be returned. | A time-stamped JSON that includes the classified emotion and its confidence at a rate of 1 classification per 5 seconds of audio. |
+| Outputs       | A JSON that includes the primary emotion detected in the file, along with its confidence. The confidence scores of all other emotions in the model are also returned. | A time-stamped JSON that includes the classified emotion and its confidence at a rate of 1 classification per 5 seconds of audio. |
 | Response Time | 100-500 ms                                                                                                                                                                      | Dependent upon file size                                                                                                          |
 
 The **DiscreteAPI** is built for real-time analysis of emotions in audio data. Small snippets of audio are sent to the API to receive feedback in real-time of what emotions are detected based on tone of voice. This API operates on an approximate per-sentence basis, and audio must be cut to the appropriate size.
@@ -50,7 +50,7 @@ Create a `.env` file in your project root:
 ```env
 VALENCE_API_KEY=your_api_key                    # Required: Your Valence API key
 VALENCE_DISCRETE_URL=https://discrete-api-url   # Optional: Discrete audio endpoint
-VALENCE_ASYNCH_URL=https://async-api-url        # Optional: Asynch audio endpoint  
+VALENCE_ASYNCH_URL=https://asynch-api-url        # Optional: Asynch audio endpoint  
 VALENCE_LOG_LEVEL=info                          # Optional: debug, info, warn, error
 ```
 
@@ -111,7 +111,7 @@ import { ValenceClient } from 'valenceai';
 // Custom client configuration
 const client = new ValenceClient(
   2 * 1024 * 1024,  // 2MB parts
-  5                  // 5 retry attempts
+  5                 // 5 retry attempts
 );
 
 // Upload with custom configuration
@@ -161,7 +161,7 @@ Uploads asynch (long) audio files using multipart upload for processing.
 
 ### `client.asynch.emotions(requestId, maxAttempts?, intervalSeconds?)`
 
-Retrieves emotion prediction results for async audio processing.
+Retrieves emotion prediction results for asynch audio processing.
 
 **Parameters:**
 - `requestId` (string): Request ID from `client.asynch.upload`
@@ -185,7 +185,7 @@ The APIs expect mono audio in the .wav format. An ideal audio file is recorded a
 
 For the **DiscreteAPI**, input data is an audio file in the .wav format. 
 
-For the **AsynchAPI**, input data is an audio file, in the .wav format.
+For the **AsynchAPI**, input data is an audio file in the .wav format.
 
 ### Outputs
 
@@ -212,7 +212,7 @@ The emotion returned in `main_emotion` is the highest confidence emotion returne
 
 ```json
 {
-  "request_id": "27a33189-bdd7-47ca-9817-abacfb7bdaf3",
+  "request_id": "27a33189-bdd7-47ca-9817-abacfb7bdaf4",
   "status": "completed",
   "emotions": [
     {
@@ -287,7 +287,7 @@ npm login
 npm publish --access public
 ```
 
-## What's New in v0.3.0
+## What's New in v0.5.0
 
 ### Major Changes
 - **Unified Client Architecture** - Single `ValenceClient` with nested `discrete` and `asynch` clients

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "valenceai",
-    "version": "0.5.0",
+    "version": "0.5.1",
     "type": "module",
     "main": "src/index.js",
     "scripts": {