[Request] Add MinimalEffectsMixin interface for consistency

[andreincu]

This is a feature request for adding MinimalEffectsMixin for being consistent with the rest, plus adding the ability to extract nodes that support effects.

Before:

interface BlendMixin extends MinimalBlendMixin {
  isMask: boolean
  maskType: MaskType
  effects: ReadonlyArray<Effect>
  effectStyleId: string
  setEffectStyleIdAsync(styleId: string): Promise<void>
}

After:

interface MinimalEffectsMixin {
  effects: ReadonlyArray<Effect>
  effectStyleId: string
  setEffectStyleIdAsync(styleId: string): Promise<void>
}

interface BlendMixin extends MinimalBlendMixin, MinimalEffectsMixin {
  isMask: boolean
  maskType: MaskType
}

This will allow doing the following:

type NodeWithEffects = Extract<SceneNode, MinimalBlendMixin>
// Output: type NodeWithEffects = FrameNode | GroupNode | ComponentSetNode | ComponentNode | InstanceNode | BooleanOperationNode | VectorNode | StarNode | LineNode | EllipseNode | PolygonNode | RectangleNode | TextNode | StampNode | HighlightNode | WashiTapeNode

https://github.com/figma/plugin-typings/blob/67cdb4a189db19caa1d4e5f87971e7a3931e273b/plugin-api.d.ts#L1626C1-L1627C24

[rohitchouhan8]

Will flag internally! Seems like a good improvement overall.

[andreincu]

Should I create another ticket for layoutGrids as well?

Or is sufficient to leave it here in the comments:

type MinimalLayoutGridMixin = Pick<BaseFrameMixin, 'layoutGrids' | 'gridStyleId' | 'setGridStyleIdAsync'>;

Ofc, in your case, you'll need to define and extend the BaseFrameMixin.

[jefflee-figma]

@andreincu Could you clarify what the purpose of this change is? It seems like after this change, BlendMixin would be the only interface to inherit from MinimalEffectsMixin, which seems like it could be a premature abstraction.

[andreincu]

Hi @jefflee-figma,

I proposed this change for mainly 2 reasons:

1. [consistency] since these properties seems to be similar with MinimalFillsMixin, MinimalStrokesMixin, then for me, it made sense to have an interface for Effects as well
2. [extensiveness/modularity] similar to fills, strokes, autolayout, to allow us, the people consuming the types, to extend them with ease without redefined them locally. e.g.: Exclude<SceneNode, MinimalEffectsMixin> this way I can quickly verify the scenarios where effects do not exists.