Merge remote-tracking branch 'origin/main'

# Conflicts:
#	.gitignore

Author: 123kiran17

.github/workflows/cs-fixer.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.2
+          php-version: 8.1
           tools: composer
 
       - name: Install dependencies

.github/workflows/psalm.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.3
+          php-version: 8.1
           tools: composer, psalm
 
       - name: Install dependencies

.github/workflows/test.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.2
+          php-version: 8.1
           tools: composer, xdebug
 
       - name: Cache Composer dependencies

.github/workflows/testaura.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.2
+          php-version: 8.1
           tools: composer, xdebug
 
       - name: Cache Composer dependencies

.gitignore

@@ -15,4 +15,6 @@ test
 .php-cs-fixer.cache
 
 
-coverage
+coverage
+
+composer.lock

Contributing.md

@@ -0,0 +1,94 @@
+# Contributing to Neo4j QueryAPI he PHP Client
+
+Thank you for your interest in contributing to the Neo4j QueryAPI PHP Client! We welcome all contributions, whether it's bug fixes, feature enhancements, or documentation improvements.
+
+## Getting Started
+
+1. **Fork the Repository**\
+   Click the "Fork" button at the top right of the repository page.
+
+2. **Clone Your Fork**
+
+   ```bash
+   git clone https://github.com/your-username/Neo4j-Client.git
+   cd Neo4j-Client
+   ```
+
+3. **Set Up the Environment**
+
+    - Ensure you have PHP installed (compatible with PHP < 7.1).
+    - Install dependencies using Composer:
+
+   ```bash
+   composer install
+   ```
+
+    - Copy the `phpunit.dist.xml` file to `phpunit.xml` and configure the necessary environment variables like `NEO4J_ADDRESS`, `NEO4J_USERNAME`, `NEO4J_PASSWORD`.
+   
+
+
+4. **Run Tests**\
+   Our tests use PHPUnit. To run tests:
+
+   ```bash
+  composer/phpunit
+   ```
+
+## Code Guidelines
+
+- Ensure your code is **PSR-12 compliant**.
+- Use **Psalm** for static analysis. Run:
+  ```bash
+  composer psalm
+  ```
+- Apply **code style fixes** using:
+  ```bash
+  composer cs:fix
+  ```
+
+## Making Changes
+
+1. **Create a New Branch**\
+   Use a descriptive branch name:
+
+   ```bash
+   git checkout -b fix/issue-123
+   ```
+
+2. **Make Your Edits**\
+   Ensure all tests pass and code is properly formatted.
+
+3. **Commit Your Changes**\
+   Write clear commit messages:
+
+   ```bash
+   git commit -m "Fix: Corrected query parsing for ProfiledQueryPlan"
+   ```
+
+4. **Push Your Branch**
+
+   ```bash
+   git push origin fix/issue-123
+   ```
+
+## Submitting a Pull Request
+
+1. Go to your forked repository on GitHub.
+2. Click on the "New pull request" button.
+3. Select your branch and submit the pull request.
+4. Add a clear description of the changes you made.
+
+## Review Process
+
+- All PRs are reviewed by the maintainers.
+- Ensure CI tests pass before requesting a review.
+- Be open to feedback and make revisions as needed.
+
+## Reporting Issues
+
+If you spot a bug or want to suggest a new feature, please [open an issue](https://github.com/NagelsIT/Neo4j-Client/issues) and provide detailed information.
+
+---
+
+We appreciate your contribution — let’s build something powerful together!
+

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Nagels IT
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,10 +1,138 @@
+Neo4jQueryAPI client
+
+The Neo4j QueryAPI client is for developers and data engineers who want to interact programmatically with Neo4j databases — running queries, handling results, and managing database configurations. It offers:
+
+- Easy configuration to pick and choose drivers
+- An intuitive API for smooth query execution
+- Extensibility for custom use cases
+- Built and tested under close collaboration with the official Neo4j driver team
+- Easier to start with, just need a client to any neo4j instance
+- Fully typed with Psalm and CS fixed for code quality
+- It does not supports Bolt, Rather compatible with HTTP, and auto-routed drivers
+
+
+
 # Query API
 
-Usage example:
+A PHP client for Neo4j, a graph database.
+
+## Installation
+
+You can install the package via Composer:
+
+```sh
+composer require this-repo/neo4j-client
+```
+
+## Usage
+
+### Connecting to Neo4j
 
 ```php
 use Neo4j\QueryAPI\Neo4jQueryAPI;
-use Neo4j\QueryAPI\Objects\Authentication;
+use Neo4j\QueryAPI\Authentication\AuthenticateInterface;
+
+$client = Neo4jQueryAPI::login('http://localhost:7474', new AuthenticateInterface('username', 'password'));
+```
+
+### Running a Query
+
+```php
+$query = 'MATCH (n) RETURN n';
+$result = $client->run($query);
+
+foreach ($result as $record) {
+    print_r($record);
+}
+```
+
+### Transactions
+
+#### Begin a Transaction
+
+```php
+$transaction = $client->beginTransaction();
+```
+
+#### Run a Query in a Transaction
+
+```php
+$query = 'CREATE (n:Person {name: $name}) RETURN n';
+$parameters = ['name' => 'John Doe'];
+$result = $transaction->run($query, $parameters);
+```
+
+#### Commit a Transaction
+
+```php
+$transaction->commit();
+```
+
+#### Rollback a Transaction
+
+```php
+$transaction->rollback();
+```
+
+## Testing
+
+To run the tests, execute the following command:
+
+```sh
+vendor/bin/phpunit
+```
+
+Cypher values and types map to these php types and classes:
+
+| Cypher             |        PHP        |
+|--------------------|:-----------------:|
+| Single name        |                   |
+| Integer            |   ``` * int ```   |
+| Float              |  ``` * float ```  |
+| Boolean            |  ``` * bool ```   |
+| Null               |  ``` * null ```   |
+| String             | ``` * string  ``` |
+| Array              |                   |
+| Date               |                   |
+| Duration           |                   |
+| 2D Point           |                   |
+| 3D Point           |                   |
+| Cartesian 2D Point |                   |
+| Cartesian 3D Point |                   |
+| Node               |                   |
+| Path               |                   |
+| Map                |                   |
+| Exact name         |                   |
+| Bookmarks          |        Yes        |
+
+## Diving deeper:
+
+| Feature   |      Supported?    | 
+|----------|:-------------:|
+| Authentication |  Yes |
+| Transaction |    Yes   |
+| HTTP | Yes |
+| Cluster |  Yes |
+| Aura |    Partly (recent versions) | 
+| Bookmarks | Yes |
+
+> **_NOTE:_**  It supports neo4j databases versions > 5.25 (which has QueryAPI enabled.)
+
+
+
+## Contributing
+
+Please see CONTRIBUTING for details.
+
+## Security
+
+If you discover any security-related issues, please email *[email protected]* instead of using the issue tracker.
+
+## Credits
+
+- [Your Name](https://github.com/your-github-username)
+- [All Contributors](https://github.com/your-repo/neo4j-client/graphs/contributors)
+
+## License
 
-$client = Neo4jQueryAPI::login('https://myaddress.com', Authentication::bearer('mytokken'))
-```
+The MIT License (MIT). Please see License File for more information.

composer.json

@@ -3,20 +3,21 @@
     "name": "neo4j-php/query-api",
     "description": "Easy to use class to run Cypher queries on the Query API",
     "require": {
-        "guzzlehttp/guzzle": "^7.9",
         "psr/http-client": "^1.0",
         "ext-json": "*",
         "php": "^8.1",
-        "nyholm/psr7": "^1.8"
+        "nyholm/psr7": "^1.8",
+        "php-http/discovery": "^1.17"
     },
     "require-dev": {
+        "guzzlehttp/guzzle": "^7.9",
         "phpunit/phpunit": "^10.0",
         "friendsofphp/php-cs-fixer": "^3.68",
         "vimeo/psalm": "^6.8",
         "dg/bypass-finals": "^1.9",
         "psalm/plugin-phpunit": "^0.19.2"
-
     },
+
     "autoload": {
         "psr-4": {
             "Neo4j\\QueryAPI\\": "src/"
@@ -50,7 +51,8 @@
     "scripts": {
         "cs": "vendor/bin/php-cs-fixer fix --dry-run --diff --allow-risky=yes",
         "cs:fix": "vendor/bin/php-cs-fixer fix --allow-risky=yes",
-        "psalm": "vendor/bin/psalm --no-cache --show-info=true"
+        "psalm": "vendor/bin/psalm --no-cache --show-info=true",
+        "phpunit" : "vendor/bin/phpunit"
     }
 
 }