feat: vNext migration

Author: AndreyHirsa

README.md

@@ -12,18 +12,29 @@ composer require lingodotdev/sdk
 
 ## Basic Usage
 
-After installing the package, bootstrap the engine with your API key:
+After installing the package, bootstrap the engine with your API key and Engine ID:
 
 ```php
 require 'vendor/autoload.php';
 
 use LingoDotDev\Sdk\LingoDotDevEngine;
 
 $engine = new LingoDotDevEngine([
-    'apiKey' => 'your-api-key', // replace with your actual key
+    'apiKey' => 'your-api-key',       // replace with your actual key
+    'engineId' => 'your-engine-id',   // replace with your actual engine id
 ]);
 ```
 
+### Configuration Options
+
+| Option | Type | Required | Default | Description |
+|---|---|---|---|---|
+| `apiKey` | string | Yes | — | Your Lingo.dev API key |
+| `engineId` | string | Yes | — | Your Lingo.dev Engine ID |
+| `apiUrl` | string | No | `https://api.lingo.dev` | API base URL |
+| `batchSize` | int | No | `25` | Max items per chunk (1–250) |
+| `idealBatchItemSize` | int | No | `250` | Max words per chunk (1–2500) |
+
 ### Scenarios demonstrated in this README
 
 1. Text Localization
@@ -38,7 +49,6 @@ $engine = new LingoDotDevEngine([
 - PHP 8.1 or higher
 - Composer
 - GuzzleHttp Client
-- Respect Validation
 
 ## Getting Started
 
@@ -74,9 +84,10 @@ Follow these steps to create a new PHP project that uses the Lingo.dev SDK:
 
 use LingoDotDev\Sdk\LingoDotDevEngine;
 
-// Initialize the SDK with your API key
+// Initialize the SDK with your API key and Engine ID
 $engine = new LingoDotDevEngine([
     'apiKey' => 'your-api-key',
+    'engineId' => 'your-engine-id',
 ]);
 ```
 
@@ -93,6 +104,17 @@ $localizedText = $engine->localizeText('Hello, world!', [
 // Output: "¡Hola, mundo!"
 ```
 
+You can enable fast mode for quicker (but potentially lower quality) translations:
+
+```php
+// Localize with fast mode enabled
+$localizedText = $engine->localizeText('Hello, world!', [
+    'sourceLocale' => 'en',
+    'targetLocale' => 'es',
+    'fast' => true,
+]);
+```
+
 ### Object Localization
 
 Translate an array of strings while preserving the structure:
@@ -122,6 +144,21 @@ $localizedObject = $engine->localizeObject([
 */
 ```
 
+You can pass a reference to provide additional context:
+
+```php
+// Localize with reference for additional context
+$localizedObject = $engine->localizeObject([
+    'greeting' => 'Hello',
+], [
+    'sourceLocale' => 'en',
+    'targetLocale' => 'es',
+    'reference' => [
+        'fr' => ['greeting' => 'Bonjour']
+    ],
+]);
+```
+
 ### Chat Localization
 
 Translate a chat conversation while preserving speaker names:
@@ -184,20 +221,20 @@ Track the progress of a localization operation:
 $engine->localizeText('Hello, world!', [
     'sourceLocale' => 'en',
     'targetLocale' => 'es',
-], function ($progress, $chunk, $processedChunk) {
+], function ($progress) {
     echo "Localization progress: $progress%\n";
 });
 ```
 
 ## Demo App
 
-If you prefer to start with a minimal example instead of the detailed scenarios above, create **index.php** in an empty folder, copy the following snippet, install dependencies with `composer require lingodotdev/sdk`, set `LINGODOTDEV_API_KEY`, and run `php index.php`.
+If you prefer to start with a minimal example instead of the detailed scenarios above, create **index.php** in an empty folder, copy the following snippet, install dependencies with `composer require lingodotdev/sdk`, set `LINGODOTDEV_API_KEY` and `LINGODOTDEV_ENGINE_ID`, and run `php index.php`.
 
 Want to see everything in action?
 
 1. Clone this repository or copy the `index.php` from the **demo** below into an empty directory.
 2. Run `composer install` to pull in the SDK.
-3. Populate the `LINGODOTDEV_API_KEY` environment variable with your key.
+3. Populate the `LINGODOTDEV_API_KEY` and `LINGODOTDEV_ENGINE_ID` environment variables.
 4. Execute the script with `php index.php` and observe the output.
 
 `index.php` demo:
@@ -211,22 +248,21 @@ use LingoDotDev\Sdk\LingoDotDevEngine;
 
 $engine = new LingoDotDevEngine([
     'apiKey' => getenv('LINGODOTDEV_API_KEY'),
+    'engineId' => getenv('LINGODOTDEV_ENGINE_ID'),
 ]);
 
 // 1. Text
 $helloEs = $engine->localizeText('Hello world!', [
     'sourceLocale' => 'en',
     'targetLocale' => 'es',
 ]);
-
-echo "Text ES ⇒ $helloEs\n\n";
+echo "Text ES: $helloEs\n\n";
 
 // 2. Object
-$object = [
+$objectFr = $engine->localizeObject([
     'greeting' => 'Good morning',
     'farewell' => 'Good night',
-];
-$objectFr = $engine->localizeObject($object, [
+], [
     'sourceLocale' => 'en',
     'targetLocale' => 'fr',
 ]);
@@ -244,7 +280,6 @@ print_r($chatJa);
 
 // 4. Detect language
 $lang = $engine->recognizeLocale('Ciao mondo');
-
 echo "Detected: $lang\n";
 ```
 

composer.json

@@ -11,8 +11,7 @@
     ],
     "require": {
         "php": "^8.1",
-        "guzzlehttp/guzzle": "^7.0",
-        "respect/validation": "^2.0"
+        "guzzlehttp/guzzle": "^7.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.0"