🎉 Initial commit

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,11 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.editorconfig               export-ignore
+/.gitattributes              export-ignore
+/.gitignore                  export-ignore
+/ISSUE_TEMPLATE.md           export-ignore
+/phpcs.xml.dist              export-ignore
+/phpunit.xml.dist            export-ignore
+/tests                       export-ignore

.gitignore

@@ -0,0 +1,7 @@
+/.idea
+/vendor
+/.phpunit.cache
+composer.lock
+.php_cs.cache
+.phpunit.result.cache
+.php-cs-fixer.cache

.php-cs-fixer.php

@@ -0,0 +1,48 @@
+<?php
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PSR12' => true,
+        'binary_operator_spaces' => true,
+        'blank_line_after_opening_tag' => true,
+        'compact_nullable_typehint' => true,
+        'declare_equal_normalize' => true,
+        'lowercase_cast' => true,
+        'lowercase_static_reference' => true,
+        'new_with_braces' => true,
+        'no_blank_lines_after_class_opening' => true,
+        'no_leading_import_slash' => true,
+        'no_whitespace_in_blank_line' => true,
+        'ordered_class_elements' => [
+            'order' => [
+                'use_trait',
+            ],
+        ],
+        'ordered_imports' => [
+            'imports_order' => [
+                'class',
+                'function',
+                'const',
+            ],
+            'sort_algorithm' => 'none',
+        ],
+        'return_type_declaration' => true,
+        'short_scalar_cast' => true,
+        'single_blank_line_before_namespace' => true,
+        'single_trait_insert_per_statement' => true,
+        'ternary_operator_spaces' => true,
+        'unary_operator_spaces' => true,
+        'visibility_required' => [
+            'elements' => [
+                'const',
+                'method',
+                'property',
+            ],
+        ],
+    ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->exclude('vendor')
+            ->in([__DIR__.'/src/', __DIR__.'/tests/'])
+    )
+    ;

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to `bigpipe-util` will be documented in this file.
+
+Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
+
+## v0.1.1 - 2022-03-27
+
+### Added
+- Part of BigPipe implementation for Webpack.

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+We accept contributions via Pull Requests on [Github](https://github.com/richardDobron/bigpipe-php).
+
+
+## Pull Requests
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **Create feature branches** - Don't ask us to pull from your master branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+
+## Running Tests
+
+``` bash
+$ composer test
+```
+
+
+**Happy coding**!

ISSUE_TEMPLATE.md

@@ -0,0 +1,27 @@
+<!-- Provide a general summary of the issue in the Title above -->
+
+## Detailed description
+
+Provide a detailed description of the change or addition you are proposing.
+
+Make it clear if the issue is a bug, an enhancement or just a question.
+
+## Context
+
+Why is this change important to you? How would you use it?
+
+How can it benefit other users?
+
+## Possible implementation
+
+Not obligatory, but suggest an idea for implementing addition or change.
+
+## Your environment
+
+Include as many relevant details about the environment you experienced the bug in and how to reproduce it.
+
+* Version used (e.g. PHP 5.6, HHVM 3):
+* Operating system and version (e.g. Ubuntu 16.04, Windows 7):
+* Link to your project:
+* ...
+* ...

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Richard Dobroň
+
+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

@@ -0,0 +1,184 @@
+<img src="bigpipe.svg">
+
+This library currently implements small part of [Facebook BigPipe][blog] so far, but the advantage is to efficiently insert/replace content and work with the DOM. It is also possible to easily call JavaScript modules from PHP.
+
+## Demo App
+Try the app with [live demo](http://bigpipe.xf.cz).
+
+## Requirements
+* PHP 7.1 or higher
+* Node 8, 10+.
+* Webpack
+
+## Installation
+
+These steps are required:
+1. Install composer package:
+```shell
+$ composer require richarddobron/bigpipe
+```
+
+2. Install npm package:
+```shell
+$ npm install bigpipe-util
+```
+
+3. Add this lines to /path/to/resources/js/app.js:
+```javascript
+import Primer from 'bigpipe-util/src/Primer';
+
+Primer();
+
+window.require = (modulePath) => {
+    return modulePath.startsWith('bigpipe-util/')
+        ? require('bigpipe-util/' + modulePath.substring(13) + '.js').default
+        : require('./' + modulePath).default;
+};
+```
+
+4. Create file /path/to/resources/js/ServerJS.js
+   - this step is optional, but if you skip it, use this in next step:
+   ```require("bigpipe-util/ServerJS")```
+```javascript
+import ServerJSImpl from 'bigpipe-util/src/ServerJS';
+export default class ServerJS extends ServerJSImpl {
+}
+```
+
+5. Add this lines to page footer:
+```html
+<script>
+    (new (require("ServerJS"))).handle(<?=json_encode(\dobron\BigPipe\BigPipe::jsmods())?>);
+</script>
+```
+
+
+## DOMOPS API
+- **setContent**: Sets the content of an element.
+- **appendContent**: Insert content as the last child of specified element.
+- **prependContent**: Insert content as the first child of specified element.
+- **insertAfter**: Insert content after specified element.
+- **insertBefore**: Insert content before specified element.
+- **remove**: Remove specified element and its children.
+- **replace**: Replace specified element with content.
+- **eval**: Evaluates JavaScript code represented as a string.
+
+```php
+$response = new \dobron\BigPipe\AsyncResponse();
+
+$response->setContent('div#content', $newContent);
+$response->send();
+```
+
+## Refresh & Redirecting
+
+```php
+$response = new \dobron\BigPipe\AsyncResponse();
+
+$response->reload(250); // reload page with 250ms delay
+// or
+$response->redirect('/onboarding', 500); // redirect with 500ms delay
+
+$response->send();
+```
+
+## Payload
+
+```php
+$response = new \dobron\BigPipe\AsyncResponse();
+
+$response->setPayload([
+    'username' => $_POST['username'],
+    'status' => 'unavailable',
+    'message' => 'Username is unavailable.',
+]);
+
+$response->send();
+```
+
+## BigPipe API
+- **require**: Call JavaScript module method. You can call a specific class method or a regular function with the custom arguments.
+
+Example PHP code:
+```php
+$asyncResponse = new \dobron\BigPipe\AsyncResponse();
+
+$asyncResponse->bigPipe()->require("require('SecretModule').run()", [
+    'first argument',
+    'second argument',
+    ...
+]);
+$asyncResponse->send();
+```
+Example JavaScript code:
+```javascript
+class SecretModule {
+    run(first, second) {
+        // ...
+    }
+}
+```
+- **transport**: Through transport markers you can send HTML content but also transform the content into JavaScript objects (such as Map, Set or Element).
+
+Example PHP code:
+```php
+$asyncResponse = new \dobron\BigPipe\AsyncResponse();
+$asyncResponse->bigPipe()->require("require('Chart').setup()", [
+    'element' => \dobron\BigPipe\TransportMarker::transportElement('chart-div'),
+    'dataPoints' => $asyncResponse->transport()->transportSet([
+        ['x' => 10, 'y' => 71],
+        ['x' => 20, 'y' => 55],
+        ['x' => 30, 'y' => 50],
+        ['x' => 40, 'y' => 65],
+    ]),
+]);
+$asyncResponse->send();
+```
+
+# What all can be Ajaxifed?
+
+## Links
+```html
+<a href="#"
+   ajaxify="/ajax/remove.php"
+   rel="async">Remove Item</a>
+```
+
+## Forms
+```html
+<form action="/submit.php"
+      method="POST"
+      rel="async">
+    <input name="user">
+    <input type="submit" name="Done">
+</form>
+```
+
+## Dialogs
+```html
+<a href="#"
+   ajaxify="/ajax/modal.php"
+   rel="dialog">Open Modal</a>
+```
+
+## Inspiration
+
+BigPipe is inspired by the concept behind Facebook's BigPipe. For more details
+read their blog post: [Pipelining web pages for high performance][blog].
+
+## Motivation
+
+There is a large number of PHP projects for which moving to modern frameworks like Laravel Livewire, React, Vue.js (and many more!) could be very challenging.
+
+The purpose of this library is to rapidly reduce the continuously repetitive code to work with the DOM and improve the communication barrier between PHP and JavaScript.
+
+## Credits
+
+- [Richard Dobroň][link-author]
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+
+[link-author]: https://github.com/richardDobron
+[blog]: https://www.facebook.com/notes/facebook-engineering/bigpipe-pipelining-web-pages-for-high-performance/389414033919