feat!!: add v30 changes

.github/workflows/tests.yml

@@ -6,23 +6,28 @@ jobs:
   test:
     name: Run tests with PHP v8.3
     runs-on: ubuntu-latest
-    services:
-      typesense:
-        image: typesense/typesense:28.0.rc36
-        ports:
-          - 8108:8108/tcp
-        volumes:
-          - /tmp/typesense-server-data:/data
-        env:
-          TYPESENSE_DATA_DIR: /data
-          TYPESENSE_API_KEY: xyz
-          TYPESENSE_ENABLE_CORS: true
     steps:
+      - name: Start Typesense
+        run: |
+          docker run -d \
+          -p 8108:8108 \
+          --name typesense \
+          -v /tmp/typesense-data:/data \
+          -v /tmp/typesense-analytics-data:/analytics-data \
+          typesense/typesense:30.0.alpha1 \
+          --api-key=xyz \
+          --data-dir=/data \
+          --enable-search-analytics=true \
+          --analytics-dir=/analytics-data \
+          --analytics-flush-interval=60 \
+          --analytics-minute-rate-limit=50 \
+          --enable-cors
+
       - uses: actions/checkout@v4
       - name: Setup PHP 8.3
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.3'
+          php-version: "8.3"
           coverage: xdebug
       - uses: php-actions/composer@v6
       - name: Run tests

src/Analytics.php

@@ -32,4 +32,4 @@ public function events()
         }
         return $this->events;
     }
-}
+} 

src/AnalyticsEvents.php

@@ -4,6 +4,8 @@
 
 /**
  * Class AnalyticsEvents
+ * 
+ * Implements the updated analytics events API for Typesense v30.0+
  *
  * @package \Typesense
  */
@@ -27,21 +29,25 @@ public function __construct(ApiCall $apiCall)
     }
 
     /**
-     * @param array $params
-     *
-     * @return array
+     * Create an analytics event
+     * 
+     * @param array $params Event parameters including name, event_type, and data
+     * @return array Response from the API
      * @throws TypesenseClientError|HttpClientException
      */
-    public function create($params)
+    public function create(array $params)
     {
-        return $this->apiCall->post($this->endpoint_path(), $params);
+        return $this->apiCall->post(self::RESOURCE_PATH, $params);
     }
 
     /**
-     * @return string
+     * Retrieve analytics events
+     * 
+     * @param array $params Query parameters
+     * @return array Response from the API
      */
-    private function endpoint_path($operation = null)
+    public function retrieve(array $params = [])
     {
-        return self::RESOURCE_PATH . ($operation === null ? '' : "/$operation");
+        return $this->apiCall->get(self::RESOURCE_PATH, $params);
     }
-}
+} 

src/AnalyticsEventsV1.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Typesense;
+
+/**
+ * Class AnalyticsEventsV1
+ *
+ * @package \Typesense
+ */
+class AnalyticsEventsV1
+{
+    const RESOURCE_PATH = '/analytics/events';
+
+    /**
+     * @var ApiCall
+     */
+    private ApiCall $apiCall;
+
+    /**
+     * AnalyticsEventsV1 constructor.
+     *
+     * @param ApiCall $apiCall
+     */
+    public function __construct(ApiCall $apiCall)
+    {
+        $this->apiCall = $apiCall;
+    }
+
+    /**
+     * @param array $params
+     *
+     * @return array
+     * @throws TypesenseClientError|HttpClientException
+     */
+    public function create($params)
+    {
+        return $this->apiCall->post($this->endpoint_path(), $params);
+    }
+
+    /**
+     * @return string
+     */
+    private function endpoint_path($operation = null)
+    {
+        return self::RESOURCE_PATH . ($operation === null ? '' : "/$operation");
+    }
+}

src/AnalyticsRule.php

@@ -4,27 +4,48 @@
 
 class AnalyticsRule
 {
-    private $ruleName;
+    private string $ruleName;
     private ApiCall $apiCall;
 
     public function __construct(string $ruleName, ApiCall $apiCall)
     {
         $this->ruleName = $ruleName;
-        $this->apiCall  = $apiCall;
+        $this->apiCall = $apiCall;
     }
 
+    /**
+     * Retrieve a specific analytics rule
+     * 
+     * @return array Response from the API
+     */
     public function retrieve()
     {
         return $this->apiCall->get($this->endpointPath(), []);
     }
 
+    /**
+     * Delete a specific analytics rule
+     * 
+     * @return array Response from the API
+     */
     public function delete()
     {
         return $this->apiCall->delete($this->endpointPath());
     }
 
+    /**
+     * Update a specific analytics rule
+     * 
+     * @param array $params Rule parameters
+     * @return array Response from the API
+     */
+    public function update(array $params)
+    {
+        return $this->apiCall->put($this->endpointPath(), $params);
+    }
+
     private function endpointPath()
     {
         return AnalyticsRules::RESOURCE_PATH . '/' . encodeURIComponent($this->ruleName);
     }
-}
+} 

src/AnalyticsRuleV1.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Typesense;
+
+class AnalyticsRuleV1
+{
+    private $ruleName;
+    private ApiCall $apiCall;
+
+    public function __construct(string $ruleName, ApiCall $apiCall)
+    {
+        $this->ruleName = $ruleName;
+        $this->apiCall  = $apiCall;
+    }
+
+    public function retrieve()
+    {
+        return $this->apiCall->get($this->endpointPath(), []);
+    }
+
+    public function delete()
+    {
+        return $this->apiCall->delete($this->endpointPath());
+    }
+
+    private function endpointPath()
+    {
+        return AnalyticsRulesV1::RESOURCE_PATH . '/' . encodeURIComponent($this->ruleName);
+    }
+}

src/AnalyticsRules.php

@@ -7,38 +7,58 @@ class AnalyticsRules implements \ArrayAccess
     const RESOURCE_PATH = '/analytics/rules';
 
     private ApiCall $apiCall;
-    private $analyticsRules = [];
+
+    /**
+     * @var array
+     */
+    private array $analyticsRules = [];
 
     public function __construct(ApiCall $apiCall)
     {
         $this->apiCall = $apiCall;
     }
 
-    public function __get($ruleName)
-    {
-        if (!isset($this->analyticsRules[$ruleName])) {
-            $this->analyticsRules[$ruleName] = new AnalyticsRule($ruleName, $this->apiCall);
-        }
-        return $this->analyticsRules[$ruleName];
-    }
-
-    public function upsert($ruleName, $params)
+    /**
+     * Create multiple analytics rules
+     * 
+     * @param array $rules Array of rule objects
+     * @return array Response from the API
+     */
+    public function create(array $rules)
     {
-        return $this->apiCall->put($this->endpoint_path($ruleName), $params);
+        return $this->apiCall->post(self::RESOURCE_PATH, $rules);
     }
 
+    /**
+     * Retrieve all analytics rules
+     * 
+     * @return array Response from the API
+     */
     public function retrieve()
     {
-        return $this->apiCall->get($this->endpoint_path(), []);
+        return $this->apiCall->get(self::RESOURCE_PATH, []);
     }
 
-    private function endpoint_path($operation = null)
+    /**
+     * Get a specific rule by name
+     * 
+     * @param string $ruleName
+     * @return AnalyticsRule
+     */
+    public function __get($ruleName)
     {
-        return self::RESOURCE_PATH . ($operation === null ? '' : "/" . encodeURIComponent($operation));
+        if (isset($this->{$ruleName})) {
+            return $this->{$ruleName};
+        }
+        if (!isset($this->analyticsRules[$ruleName])) {
+            $this->analyticsRules[$ruleName] = new AnalyticsRule($ruleName, $this->apiCall);
+        }
+
+        return $this->analyticsRules[$ruleName];
     }
 
     /**
-     * @inheritDoc
+     * ArrayAccess implementation for backwards compatibility
      */
     public function offsetExists($offset): bool
     {
@@ -72,4 +92,4 @@ public function offsetUnset($offset): void
     {
         unset($this->analyticsRules[$offset]);
     }
-}
+} 

src/AnalyticsRulesV1.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Typesense;
+
+class AnalyticsRulesV1 implements \ArrayAccess
+{
+    const RESOURCE_PATH = '/analytics/rules';
+
+    private ApiCall $apiCall;
+    private $analyticsRules = [];
+
+    public function __construct(ApiCall $apiCall)
+    {
+        $this->apiCall = $apiCall;
+    }
+
+    public function __get($ruleName)
+    {
+        if (!isset($this->analyticsRules[$ruleName])) {
+            $this->analyticsRules[$ruleName] = new AnalyticsRuleV1($ruleName, $this->apiCall);
+        }
+        return $this->analyticsRules[$ruleName];
+    }
+
+    public function upsert($ruleName, $params)
+    {
+        return $this->apiCall->put($this->endpoint_path($ruleName), $params);
+    }
+
+    public function retrieve()
+    {
+        return $this->apiCall->get($this->endpoint_path(), []);
+    }
+
+    private function endpoint_path($operation = null)
+    {
+        return self::RESOURCE_PATH . ($operation === null ? '' : "/" . encodeURIComponent($operation));
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function offsetExists($offset): bool
+    {
+        return isset($this->analyticsRules[$offset]);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function offsetGet($offset): AnalyticsRuleV1
+    {
+        if (!isset($this->analyticsRules[$offset])) {
+            $this->analyticsRules[$offset] = new AnalyticsRuleV1($offset, $this->apiCall);
+        }
+
+        return $this->analyticsRules[$offset];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function offsetSet($offset, $value): void
+    {
+        $this->analyticsRules[$offset] = $value;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function offsetUnset($offset): void
+    {
+        unset($this->analyticsRules[$offset]);
+    }
+}