Add getList method to PocketbaseArduino class

Author: jeoooo

PocketbaseArduino.cpp

@@ -95,6 +95,7 @@ String PocketbaseArduino::httpsGETRequest(const char *endpoint)
     {
         Serial.printf("[HTTPS] Unable to connect\n");
     }
+    // TODO: improve return value in case failure happens
     return ""; // Return an empty string on failure
 }
 
@@ -167,3 +168,126 @@ String PocketbaseArduino::getOne(const char *recordId, const char *expand /* = n
         return httpGETRequest(fullEndpoint.c_str());
     }
 }
+
+String PocketbaseArduino::getList(
+    const char *page /* = nullptr */,
+    const char *perPage /* = nullptr */,
+    const char *sort /* = nullptr */,
+    const char *filter /* = nullptr */,
+    const char *expand /* = nullptr */,
+    const char *fields /* = nullptr */,
+    const char *skipTotal /* = nullptr */)
+{
+    String fullEndpoint;
+
+    if (base_url.startsWith("https://"))
+    {
+        // Use HTTPS if base URL starts with "https://"
+        fullEndpoint = base_url + String(current_endpoint) + "records/";
+    }
+    else
+    {
+        // Use HTTP for other cases
+        fullEndpoint = base_url + String(current_endpoint) + "records/";
+    }
+
+    if (page != nullptr && strlen(page) > 0)
+    {
+
+        if (fullEndpoint.indexOf('?') == -1)
+        {
+            fullEndpoint += "?";
+        }
+        else
+        {
+            fullEndpoint += "&";
+        }
+
+        fullEndpoint += "page=" + String(page);
+    }
+
+    if (perPage != nullptr && strlen(perPage) > 0)
+    {
+        if (fullEndpoint.indexOf('?') == -1)
+        {
+            fullEndpoint += "?";
+        }
+        else
+        {
+            fullEndpoint += "&";
+        }
+
+        fullEndpoint += "perPage=" + String(perPage);
+    }
+
+    if (sort != nullptr && strlen(sort) > 0)
+    {
+        if (fullEndpoint.indexOf('?') == -1)
+        {
+            fullEndpoint += "?";
+        }
+        else
+        {
+            fullEndpoint += "&";
+        }
+
+        fullEndpoint += "perPage=" + String(sort);
+    }
+
+    if (filter != nullptr && strlen(filter) > 0)
+    {
+        if (fullEndpoint.indexOf('?') == -1)
+        {
+            fullEndpoint += "?";
+        }
+        else
+        {
+            fullEndpoint += "&";
+        }
+
+        fullEndpoint += "perPage=" + String(filter);
+    }
+
+    if (skipTotal != nullptr && strlen(skipTotal) > 0)
+    {
+        if (fullEndpoint.indexOf('?') == -1)
+        {
+            fullEndpoint += "?";
+        }
+        else
+        {
+            fullEndpoint += "&";
+        }
+
+        fullEndpoint += "perPage=" + String(skipTotal);
+    }
+
+    if (expand != nullptr && strlen(expand) > 0)
+    {
+        fullEndpoint += "?expand=" + String(expand);
+    }
+
+    if (fields != nullptr && strlen(fields) > 0)
+    {
+
+        if (fullEndpoint.indexOf('?') == -1)
+        {
+            fullEndpoint += "?";
+        }
+        else
+        {
+            fullEndpoint += "&";
+        }
+
+        fullEndpoint += "fields=" + String(fields);
+    }
+
+    if (base_url.startsWith("https://"))
+    {
+        return httpsGETRequest(fullEndpoint.c_str());
+    }
+    else
+    {
+        return httpGETRequest(fullEndpoint.c_str());
+    }
+}

PocketbaseArduino.h

@@ -36,7 +36,50 @@ class PocketbaseArduino
      *
      *                  For more information, see: https://pocketbase.io/docs
      */
-    String getOne(const char *recordId, const char *expand /* = nullptr */, const char *fields /* = nullptr */);
+    String getOne(
+        const char *recordId,
+        const char *expand /* = nullptr */,
+        const char *fields /* = nullptr */);
+
+    /**
+     * @brief Fetches a multiple records from a Pocketbase collection. Supports sorting and filtering.
+     *
+     * @param page      The page (aka. offset) of the paginated list (default to 1).
+     *
+     * @param perPage   Specify the max returned records per page (default to 30).
+     *
+     * @param sort      Specify the records order attribute(s).
+     *                  Add - / + (default) in front of the attribute for DESC / ASC order. Ex.:
+     *                  // DESC by created and ASC by id
+     *                  ?sort=-created,id
+     *
+     * @param filter    Filter the returned records.
+     *
+     * @param expand    (Optional) Auto expand record relations. Ex.:?expand=relField1,relField2.subRelField Supports up to 6-levels depth nested relations expansion.
+     *                  The expanded relations will be appended to the record under the expand property (eg. "expand": {"relField1": {...}, ...}).
+     *                  Only the relations to which the request user has permissions to view will be expanded.
+     *
+     * @param fields    (Optional) Comma separated string of the fields to return in the JSON response (by default returns all fields). Ex.: ?fields=*,expand.relField.name
+     *                  * targets all keys from the specific depth level.
+     *                  In addition, the following field modifiers are also supported:
+     *                  :excerpt(maxLength, withEllipsis?)
+     *                  Returns a short plain text version of the field string value.
+     *                  Ex.: ?fields=*,description:excerpt(200,true)
+     *
+     * @param skipTotal If it is set the total counts query will be skipped and the response fields totalItems and totalPages will have -1 value.
+     *                  This could drastically speed up the search queries when the total counters are not needed or cursor based pagination is used.
+     *                  For optimization purposes, it is set by default for the getFirstListItem() and getFullList() SDKs methods.
+     *
+     *                  For more information, see: https://pocketbase.io/docs
+     */
+    String getList(
+        const char *page /* = nullptr */,
+        const char *perPage /* = nullptr */,
+        const char *sort /* = nullptr */,
+        const char *filter /* = nullptr */,
+        const char *expand /* = nullptr */,
+        const char *fields /* = nullptr */,
+        const char *skipTotal /* = nullptr */);
 
 private:
     String httpGETRequest(const char *endpoint);