Allow block_order on preset

[miazbikowski]

When preset blocks are a hash, they require block_order since the order is lost (as opposed to the blocks array).

We noticed while working in theme-tools that we were getting a red highlight saying block_order property not allowed (or something to that effect). This is to fix that.

---

🎩

I was able to get the autocomplete for both the root and nested level blocks:

You can also tophat by opening this repo on this branch and playing with the fixtures, it should pop up the autocomplete.

---

Additional case: nested blocks must be the same type as their parents - blocks arrays can only contain blocks that are also arrays, block hashes can only contain blocks that have block hashes

🎩

[miazbikowski]

I encountered an issue where presets with only name and settings could be validated by either of these refs, so by adding blocks as required to the presetWithBlocksHash it ensured there was no such conflict. A preset with only name (and usually settings, otherwise the whole preset's kinda useless) will get validated by the presetWithBlocksArray.

Optionally, we could make blocks required in presetWithBlocksArray too and require a third option for presets with just name and settings. A trivial change, if it's preferred. I'm on the fence, myself.

[charlespwd]

maybe...

"allOf": [
  { "$ref": "#/definitions/presetBase" }
  { "oneOf": [
    { "$ref": "#/definitions/presetBlocksArray" },
    { "$ref": "#/definitions/presetBlocksHash" },
  ]}
]

?

[miazbikowski]

So I remember when we chatted in person, we agreed it wasn't worth complicating things just to extract out name and settings - though I'd be down to do it if it solved the presets with "only" name and settings more elegantly... Although the one you posted still requires that the data fit into either presetBlocksArray and presetBlocksHash?

Wouldn't it be more like this to accommodate all 3 possible cases?

  { "oneOf": [
    { "$ref": "#/definitions/presetBase" }
    { "$ref": "#/definitions/presetBlocksArray" },
    { "$ref": "#/definitions/presetBlocksHash" },
  ]}

[charlespwd]

I mean that works too so long as presetBase doesn't accept other properties and that the array/hash have blocks & blocks order required. Same same

[miazbikowski]

Cool. The change you proposed ended up being easier to implement - my version was giving me a hard time for a reason I can't figure out, so, if it's same same, then yours works :)

Did some tophatting locally:

(overall the presets autocomplete worked with blocks as arrays and blocks as hash)

[charlespwd]

Something is off:
When I have an array element with a hash child, the block_order doesn't complete 🤔

[charlespwd]

ezpz!

[charlespwd]

tophat looks good to me! We'll need to adjust the types in Shopify/theme-tools to match but we're good to go!

[albchu]

Looks great! Thank you Mia!

[navdeep5]

🎩 ed and things look good!