[Live][Stimulus] Removing experimental & auditing internal classes

weaverryan · Jan 28, 2024 · 9ebae32 · 9ebae32
1 parent b07f864
commit 9ebae32
Show file tree

Hide file tree

Showing 61 changed files with 26 additions and 118 deletions.
diff --git a/src/LiveComponent/README.md b/src/LiveComponent/README.md
@@ -1,15 +1,12 @@
 # Live Components
 
-**EXPERIMENTAL** This component is currently experimental and is
-likely to change, or even change drastically.
-
 Live components work with the [TwigComponent](https://symfony.com/bundles/ux-twig-component/current/index.html)
 library to give you the power to automatically update your
 Twig components on the frontend as the user interacts with them.
 Inspired by [Livewire](https://laravel-livewire.com/) and
 [Phoenix LiveView](https://hexdocs.pm/phoenix_live_view/Phoenix.LiveView.html).
 
-Want a demo? Check out https://github.com/weaverryan/live-demo.
+Want a demo? Check out https://ux.symfony.com/live-component.
 
 **This repository is a READ-ONLY sub-tree split**. See
 https://github.com/symfony/ux to create issues or submit pull requests.

diff --git a/src/LiveComponent/doc/index.rst b/src/LiveComponent/doc/index.rst
@@ -1,11 +1,6 @@
 Live Components
 ===============
 
-.. caution::
-
-    This component is currently experimental and is likely to change, or even
-    change drastically.
-
 Live components builds on top of the `TwigComponent`_ library
 to give you the power to automatically update your Twig components on
 the frontend as the user interacts with them. Inspired by
@@ -3459,8 +3454,10 @@ This bundle aims at following the same Backward Compatibility promise as
 the Symfony framework:
 https://symfony.com/doc/current/contributing/code/bc.html
 
-However it is currently considered `experimental`_, meaning it is not
-bound to Symfony's BC policy for the moment.
+For JavaScript files, the public API (i.e. documented features and exports
+from the main JavaScript file) is protected by the backward compatibility
+promise. However, any internal implementation in the JavaScript files
+(i.e. exports from internal files) is not protected.
 
 .. _`TwigComponent`: https://symfony.com/bundles/ux-twig-component/current/index.html
 .. _TwigComponent documentation: https://symfony.com/bundles/ux-twig-component/current/index.html
@@ -3469,7 +3466,6 @@ bound to Symfony's BC policy for the moment.
 .. _`Twig Component`: https://symfony.com/bundles/ux-twig-component/current/index.html
 .. _`Twig Component mount documentation`: https://symfony.com/bundles/ux-twig-component/current/index.html#the-mount-method
 .. _`Symfony form`: https://symfony.com/doc/current/forms.html
-.. _`experimental`: https://symfony.com/doc/current/contributing/code/experimental.html
 .. _`dependent form fields`: https://ux.symfony.com/live-component/demos/dependent-form-fields
 .. _StimulusBundle configured in your app: https://symfony.com/bundles/StimulusBundle/current/index.html
 .. _`localizes its URLs`: https://symfony.com/doc/current/translation/locale.html#translation-locale-url

diff --git a/src/LiveComponent/src/Attribute/AsLiveComponent.php b/src/LiveComponent/src/Attribute/AsLiveComponent.php
@@ -20,8 +20,6 @@
  * @see https://symfony.com/bundles/ux-live-component
  *
  * @author Kevin Bond <[email protected]>
- *
- * @experimental
  */
 #[\Attribute(\Attribute::TARGET_CLASS)]
 final class AsLiveComponent extends AsTwigComponent

diff --git a/src/LiveComponent/src/Attribute/LiveAction.php b/src/LiveComponent/src/Attribute/LiveAction.php
@@ -15,8 +15,6 @@
  * An attribute to register a LiveAction method.
  *
  * @see https://symfony.com/bundles/ux-live-component/current/index.html#actions
- *
- * @experimental
  */
 #[\Attribute(\Attribute::TARGET_METHOD)]
 class LiveAction

diff --git a/src/LiveComponent/src/Attribute/LiveArg.php b/src/LiveComponent/src/Attribute/LiveArg.php
@@ -17,8 +17,6 @@
  * @see https://symfony.com/bundles/ux-live-component/current/index.html#actions-arguments
  *
  * @author Tomas Norkūnas <[email protected]>
- *
- * @experimental
  */
 #[\Attribute(\Attribute::TARGET_PARAMETER)]
 final class LiveArg

diff --git a/src/LiveComponent/src/Attribute/LiveListener.php b/src/LiveComponent/src/Attribute/LiveListener.php
@@ -18,8 +18,6 @@
  * method and re-render the component.
  *
  * @see https://symfony.com/bundles/ux-live-component/current/index.html#listeners
- *
- * @experimental
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
 class LiveListener extends LiveAction

diff --git a/src/LiveComponent/src/Attribute/LiveProp.php b/src/LiveComponent/src/Attribute/LiveProp.php
@@ -15,8 +15,6 @@
  * An attribute to mark a property as a "LiveProp".
  *
  * @see https://symfony.com/bundles/ux-live-component/current/index.html#liveprops-stateful-component-properties
- *
- * @experimental
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY)]
 final class LiveProp

diff --git a/src/LiveComponent/src/Attribute/PostHydrate.php b/src/LiveComponent/src/Attribute/PostHydrate.php
@@ -13,8 +13,6 @@
 
 /**
  * An attribute to register a PostHydrate hook.
- *
- * @experimental
  */
 #[\Attribute(\Attribute::TARGET_METHOD)]
 final class PostHydrate

diff --git a/src/LiveComponent/src/Attribute/PreDehydrate.php b/src/LiveComponent/src/Attribute/PreDehydrate.php
@@ -13,8 +13,6 @@
 
 /**
  * An attribute to register a PreDehydrate hook.
- *
- * @experimental
  */
 #[\Attribute(\Attribute::TARGET_METHOD)]
 final class PreDehydrate

diff --git a/src/LiveComponent/src/Attribute/PreReRender.php b/src/LiveComponent/src/Attribute/PreReRender.php
@@ -16,8 +16,6 @@
  *
  * This hook ONLY happens when rendering via HTTP: it does
  * not happen during the initial render of a component.
- *
- * @experimental
  */
 #[\Attribute(\Attribute::TARGET_METHOD)]
 final class PreReRender

diff --git a/src/LiveComponent/src/ComponentToolsTrait.php b/src/LiveComponent/src/ComponentToolsTrait.php
@@ -17,8 +17,6 @@
  * Trait with shortcut methods useful for live components.
  *
  * @author Ryan Weaver <[email protected]>
- *
- * @experimental
  */
 trait ComponentToolsTrait
 {

diff --git a/src/LiveComponent/src/ComponentValidator.php b/src/LiveComponent/src/ComponentValidator.php
@@ -19,8 +19,6 @@
 /**
  * @author Ryan Weaver <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 class ComponentValidator implements ComponentValidatorInterface, ServiceSubscriberInterface

diff --git a/src/LiveComponent/src/ComponentValidatorInterface.php b/src/LiveComponent/src/ComponentValidatorInterface.php
@@ -15,8 +15,6 @@
 
 /**
  * @author Ryan Weaver <[email protected]>
- *
- * @experimental
  */
 interface ComponentValidatorInterface
 {

diff --git a/src/LiveComponent/src/ComponentWithFormTrait.php b/src/LiveComponent/src/ComponentWithFormTrait.php
@@ -23,8 +23,6 @@
 
 /**
  * @author Ryan Weaver <[email protected]>
- *
- * @experimental
  */
 trait ComponentWithFormTrait
 {

diff --git a/src/LiveComponent/src/DefaultActionTrait.php b/src/LiveComponent/src/DefaultActionTrait.php
@@ -13,8 +13,6 @@
 
 /**
  * @author Kevin Bond <[email protected]>
- *
- * @experimental
  */
 trait DefaultActionTrait
 {

diff --git a/src/LiveComponent/src/DependencyInjection/Compiler/ComponentDefaultActionPass.php b/src/LiveComponent/src/DependencyInjection/Compiler/ComponentDefaultActionPass.php
@@ -17,8 +17,6 @@
 /**
  * @author Kevin Bond <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 final class ComponentDefaultActionPass implements CompilerPassInterface

diff --git a/src/LiveComponent/src/DependencyInjection/Compiler/OptionalDependencyPass.php b/src/LiveComponent/src/DependencyInjection/Compiler/OptionalDependencyPass.php
@@ -21,8 +21,6 @@
 /**
  * @author Kevin Bond <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 final class OptionalDependencyPass implements CompilerPassInterface

diff --git a/src/LiveComponent/src/DependencyInjection/LiveComponentExtension.php b/src/LiveComponent/src/DependencyInjection/LiveComponentExtension.php
@@ -55,8 +55,6 @@
 /**
  * @author Kevin Bond <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 final class LiveComponentExtension extends Extension implements PrependExtensionInterface

diff --git a/src/LiveComponent/src/EventListener/AddLiveAttributesSubscriber.php b/src/LiveComponent/src/EventListener/AddLiveAttributesSubscriber.php
@@ -29,8 +29,6 @@
  *
  * @author Kevin Bond <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 final class AddLiveAttributesSubscriber implements EventSubscriberInterface, ServiceSubscriberInterface

diff --git a/src/LiveComponent/src/EventListener/DeferLiveComponentSubscriber.php b/src/LiveComponent/src/EventListener/DeferLiveComponentSubscriber.php
@@ -17,6 +17,11 @@
 use Symfony\UX\TwigComponent\Event\PostMountEvent;
 use Symfony\UX\TwigComponent\Event\PreRenderEvent;
 
+/**
+ * Handles the "defer" key, which causes the component to be rendered asynchronously.
+ *
+ * @internal
+ */
 final class DeferLiveComponentSubscriber implements EventSubscriberInterface
 {
     private const DEFAULT_LOADING_TAG = 'div';

diff --git a/src/LiveComponent/src/EventListener/InterceptChildComponentRenderSubscriber.php b/src/LiveComponent/src/EventListener/InterceptChildComponentRenderSubscriber.php
@@ -25,8 +25,6 @@
  *
  * @author Ryan Weaver <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 class InterceptChildComponentRenderSubscriber implements EventSubscriberInterface, ServiceSubscriberInterface

diff --git a/src/LiveComponent/src/EventListener/LiveComponentSubscriber.php b/src/LiveComponent/src/EventListener/LiveComponentSubscriber.php
@@ -42,8 +42,6 @@
  * @author Kevin Bond <[email protected]>
  * @author Ryan Weaver <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 class LiveComponentSubscriber implements EventSubscriberInterface, ServiceSubscriberInterface

diff --git a/src/LiveComponent/src/EventListener/QueryStringInitializeSubscriber.php b/src/LiveComponent/src/EventListener/QueryStringInitializeSubscriber.php
@@ -20,8 +20,6 @@
 /**
  * @author Nicolas Rigaud <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 class QueryStringInitializeSubscriber implements EventSubscriberInterface

diff --git a/src/LiveComponent/src/EventListener/ResetDeterministicIdSubscriber.php b/src/LiveComponent/src/EventListener/ResetDeterministicIdSubscriber.php
@@ -36,8 +36,6 @@
  *
  * @author Ryan Weaver <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 final class ResetDeterministicIdSubscriber implements EventSubscriberInterface

diff --git a/src/LiveComponent/src/Exception/HydrationException.php b/src/LiveComponent/src/Exception/HydrationException.php
@@ -20,8 +20,6 @@
  *
  * @author Ryan Weaver <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 class HydrationException extends BadRequestHttpException

diff --git a/src/LiveComponent/src/Form/Type/LiveCollectionType.php b/src/LiveComponent/src/Form/Type/LiveCollectionType.php
@@ -21,8 +21,6 @@
 
 /**
  * @author Gábor Egyed <[email protected]>
- *
- * @experimental
  */
 final class LiveCollectionType extends AbstractType
 {

diff --git a/src/LiveComponent/src/Hydration/DoctrineEntityHydrationExtension.php b/src/LiveComponent/src/Hydration/DoctrineEntityHydrationExtension.php
@@ -15,6 +15,11 @@
 use Doctrine\Persistence\ManagerRegistry;
 use Doctrine\Persistence\ObjectManager;
 
+/**
+ * Handles hydration of Doctrine entities.
+ *
+ * @internal
+ */
 class DoctrineEntityHydrationExtension implements HydrationExtensionInterface
 {
     /**

diff --git a/src/LiveComponent/src/Hydration/HydrationExtensionInterface.php b/src/LiveComponent/src/Hydration/HydrationExtensionInterface.php
@@ -11,6 +11,9 @@
 
 namespace Symfony\UX\LiveComponent\Hydration;
 
+/**
+ * Interface for custom hydration of objects.
+ */
 interface HydrationExtensionInterface
 {
     /**

diff --git a/src/LiveComponent/src/LiveCollectionTrait.php b/src/LiveComponent/src/LiveCollectionTrait.php
@@ -17,8 +17,6 @@
 
 /**
  * @author Gábor Egyed <[email protected]>
- *
- * @experimental
  */
 trait LiveCollectionTrait
 {

diff --git a/src/LiveComponent/src/LiveComponentBundle.php b/src/LiveComponent/src/LiveComponentBundle.php
@@ -19,8 +19,6 @@
 
 /**
  * @author Kevin Bond <[email protected]>
- *
- * @experimental
  */
 final class LiveComponentBundle extends Bundle
 {

diff --git a/src/LiveComponent/src/LiveComponentHydrator.php b/src/LiveComponent/src/LiveComponentHydrator.php
@@ -35,8 +35,6 @@
 /**
  * @author Kevin Bond <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 final class LiveComponentHydrator

diff --git a/src/LiveComponent/src/LiveResponder.php b/src/LiveComponent/src/LiveResponder.php
@@ -12,8 +12,6 @@
 namespace Symfony\UX\LiveComponent;
 
 /**
- * @experimental
- *
  * @author Ryan Weaver <[email protected]>
  */
 final class LiveResponder

diff --git a/src/LiveComponent/src/Metadata/LiveComponentMetadata.php b/src/LiveComponent/src/Metadata/LiveComponentMetadata.php
@@ -16,8 +16,6 @@
 /**
  * @author Ryan Weaver <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 class LiveComponentMetadata

diff --git a/src/LiveComponent/src/Metadata/LiveComponentMetadataFactory.php b/src/LiveComponent/src/Metadata/LiveComponentMetadataFactory.php
@@ -20,8 +20,6 @@
 /**
  * @author Ryan Weaver <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 class LiveComponentMetadataFactory implements ResetInterface

diff --git a/src/LiveComponent/src/Metadata/LivePropMetadata.php b/src/LiveComponent/src/Metadata/LivePropMetadata.php
@@ -17,8 +17,6 @@
 /**
  * @author Kevin Bond <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 final class LivePropMetadata

diff --git a/src/LiveComponent/src/Twig/DeterministicTwigIdCalculator.php b/src/LiveComponent/src/Twig/DeterministicTwigIdCalculator.php
@@ -17,8 +17,6 @@
 /**
  * @author Ryan Weaver <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 class DeterministicTwigIdCalculator

diff --git a/src/LiveComponent/src/Twig/LiveComponentExtension.php b/src/LiveComponent/src/Twig/LiveComponentExtension.php
@@ -17,8 +17,6 @@
 /**
  * @author Kevin Bond <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 final class LiveComponentExtension extends AbstractExtension

diff --git a/src/LiveComponent/src/Twig/LiveComponentRuntime.php b/src/LiveComponent/src/Twig/LiveComponentRuntime.php
@@ -19,8 +19,6 @@
 /**
  * @author Kevin Bond <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 final class LiveComponentRuntime

diff --git a/src/LiveComponent/src/Util/ChildComponentPartialRenderer.php b/src/LiveComponent/src/Util/ChildComponentPartialRenderer.php
@@ -20,8 +20,6 @@
 /**
  * @author Ryan Weaver <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 class ChildComponentPartialRenderer implements ServiceSubscriberInterface

diff --git a/src/LiveComponent/src/Util/DehydratedProps.php b/src/LiveComponent/src/Util/DehydratedProps.php
@@ -16,8 +16,6 @@
  *
  * @author Ryan Weaver <[email protected]>
  *
- * @experimental
- *
  * @internal
  */
 class DehydratedProps
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,8 +15,6 @@ @@
     /**
      * @author Ryan Weaver <[email protected]>
-     *
-     * @experimental
      */
     interface ComponentValidatorInterface
     {
@@ Expand Down @@