FEATURE: Fusion objectPropTypes:FromPrototype to use propTypes from other fusion prototypes

[mficzel]

The prototype PackageFactory.AtomicFusion.PropTypes:ForPrototype allows to define a DataStructureValidator for all props of the prototype specified via prototypeName.

   @propTypes {
       button = PropTypes:FromPrototype {
          prototypeName = 'Vendor.Site:Button'
       }
   }

Resolves: #16

In addition prototypes are added that allow to specify validation in fusion instead of eel

@propTypes {
    # all props can be marked as required via `@required = true`
    int = PropTypes:Int {
      @required = true
    }
    float = PropTypes:Float
    bool = PropTypes:Bool

    # strings allow to specify an optional `regularExpression`
    string = PropTypes:String {
        regularExpression = '/hello world/'
    }

    # allows array values that satisfy the `type`
    array = PropTypes:Array {
        type = PropTypes:Int
    }

    # allow values that satisfy one of the given validators
    union = PropTypes:Union {
        int = PropTypes:Int
        string = PropTypes:String
        ...
    }

    # allow exacly the values that are specified
    enum = PropTypes:Enum {     
      value1 = "foo"
      value2 = "bar"
      ...
    }

    # a nested structure that is valid once all children valídate
    dataStructure = PropTypes:DataStructure {
        title = PropTypes:String
        description = PropTypes:String
        ...
    }

    # a php object that satisfies the given interface
    instanceOf = PropTypes:InstanceOf {
        type = '\DateTimeInterface'
    }

    # data structure validator that uses the defined proptypes from another prototype
    fromPrototype = PropTypes:FromPrototype {
        prototypeName = "Vendor.Site:Prototype"
    }
}

Additionally:

• seperate shape validators are removed ... shape is now an alias for datastructure
• Resolves: Remove Neos.Fusion:RawArray from dynamic @propTypes path evaluation #18

[mhsdesign]

hi öhm #17 hmmm

[mficzel]

@mhsdesign did not see that, sorry ... however this pr allows to specify all proptypes as fusion object

[mhsdesign]

traits make me happy :D

[mhsdesign]

i would argue that "prototype" is the wrong name, its too unspecific propTypes can only be used with components ... so how about ForComponent and componentName ?

[mficzel]

Used it as it is the same as in Sitegeist.Monocle:PreviewPrototype ... bettter suggestions are welcome. Also it would be great to specify a prototype not as string. Did not find a good way to achieve this.

[mhsdesign]

i now some dark magic so you can do

type = Foo.Bar
(without strings ^^)

but thats not really tge fusion way, i think people got used to it ...

[mficzel]

Und dann runtime->evaluate->("type/__meta/propTypes"); ... hmmm really dark. If we find a way to achieve this in a way that works for Sitegeist.Monocle:PreviewPrototype i would love to see this.

[mhsdesign]

hmm one can access the object name via $this->properties["type"]['__objectType'] ;)

(tested)

[mficzel]

@mhsdesign Would still like to go with "string:prototypeName" first. If we find ab better way we can implement the same solution in monocle and here.

[mficzel]

@grebaldi i wonder how this could be adapted to Sitegeist.Monocle.PropTypes ... pretty sure there is a way but i do not see it yet.

[mficzel]

this is how short aliases could look:

prototype(PropTypes:Int) < prototype(PackageFactory.AtomicFusion.PropTypes:Int) {}
prototype(PropTypes:Float) < prototype(PackageFactory.AtomicFusion.PropTypes:Float) {}
prototype(PropTypes:Bool) < prototype(PackageFactory.AtomicFusion.PropTypes:Bool) {}
prototype(PropTypes:String) < prototype(PackageFactory.AtomicFusion.PropTypes:String) {}
prototype(PropTypes:ArrayOf) < prototype(PackageFactory.AtomicFusion.PropTypes:ArrayOf) {}
prototype(PropTypes:AnyOf) < prototype(PackageFactory.AtomicFusion.PropTypes:AnyOf) {}
prototype(PropTypes:OneOf) < prototype(PackageFactory.AtomicFusion.PropTypes:OneOf) {}
prototype(PropTypes:DataStructure) < prototype(PackageFactory.AtomicFusion.PropTypes:DataStructure) {}
prototype(PropTypes:InstanceOf) < prototype(PackageFactory.AtomicFusion.PropTypes:InstanceOf) {}
prototype(PropTypes:For) < prototype(PackageFactory.AtomicFusion.PropTypes:ForPrototype) {}

What i would still like to change / discuss:

• Use a better name for "OneOf" to avoid confusion with "AnyOf" ... maybe PropTypes:Enum
• Maybe use PropTypes:DataStructure.forPrototype instead of PropTypes:For ...
• Maybe use PropTypes:Object.type instead of PropTypes:InstanceOf

[mficzel]

IDEA: combine OneOf and AnyOf

PropTypes:OneOf {
	0 = PropTypes:Int
	1 = "foo"
	2 = "bar"
}
´

PropTypes:ArrayOf {
	0 = PropTypes:Int
	1 = "foo"
	2 = "bar"
}

PropTypes:DataStructure{
	number  = PropTypes:Int
	text = PropTypes:String
}

[grebaldi]

Hi @mficzel,

thanks for building this 👍 , I like the idea.

I added some conceptual comments, but mostly typo stuff :)

RE @mficzel:

@grebaldi i wonder how this could be adapted to Sitegeist.Monocle.PropTypes ... pretty sure there is a way but i do not see it yet.

Oh, I'd be very pleased to take a look at that :)

RE @mficzel:

IDEA: combine OneOf and AnyOf

+1 - And to reduce confusion even more, I'd like to suggest to drop the react-proptypes API naming in this case and call the combined one Union:

myValue = PropsTypes:Union {
    0 = PropTypes:Int
    1 = PropTypes:Float
}

[mhsdesign]

i mus say i also really like PropsTypes:Union ;)

[mficzel]

I added PropTypes:Union and PropTypes:Enum as those are distinct cases. Other than that i think it might actually be ready now.

I kept "prototypeName" for now as it is in line with what Monocle:PreviewPrototype does. Once we have a better solution there i would like to add a "type" that accepts a FusionPrototype without Quotes in another PR.

[mficzel]

@grebaldi prepared the adjustments for monocle-proptypes. Seems to work with buth styles of proptypes ... do you consider this approach valid
sitegeist/Sitegeist.Monocle.PropTypes#3