Flow Type Support about plank

[bkase]

Cool! The only thing I see is a minor enhancement. For the Objective-C backend, we generate a comment next to the integer enum types:

typedef NS_ENUM(NSInteger, PIPinAttributionImageType) {
    PIPinAttributionImageTypeUnset /* unset */,
    PIPinAttributionImageTypeBoard /* board */,
    PIPinAttributionImageTypeInterest /* interest */,
    PIPinAttributionImageTypeUser /* user */
};

I think this information especially important in JavaScript since the Flow definition doesn't name the numbers (although it could). Perhaps we at least include the comments like we do in Objective-C:

export type PinAvailabilityType =
    | 1 /* in_stock */
    | 2 /* out_of_stock */
    | 3 /* preorder */
    | 4 /* unavailable */;

[bradencanderson]

For PinAvailabilityType -- why are we using numeric enums? Seems error-prone since enums are structurally typed.

type o1 = 1 | 2;
type o2 = 1 | 2;
const a: o1 = 1;
(a: o2) // o1 and o2 shouldn't be interchangeable

My opinion: we should require that descriptions are unique and short (maybe introduce another key field) and we should use those as enums instead. We can convert back to ints when sending them over the wire if desired.

[maicki]

@bkase: Added the description to the integer enums.

@bradencanderson: The enum types are based on how it's defined in the PDK. We support integer and string enums.

E.g. This is a string enum:

"object_type": {
  "type" : "string",
  "enum": [
      { "default" : "none", "description" : "none" },
      { "default" : "board", "description" : "board" },
      ...
  ],
  "default": "none"
},

And that's an integer enum:

"container_type": {
    "type": "integer",
    "enum": [
        { "default" : 0, "description" : "none" },
        { "default" : 1, "description" : "carousel" },
        ...
    ]
},

[bradencanderson]

Integer enums seem problematic because they're structurally typed -- 0 | 1 is a subtype of 0 | 1 | 2, etc.

[rahul-malik]

Merged