Align with official figma types? about figma-api HOT 2 OPEN

hey @gossi I am not a super expert in TypeScript, so I am not 100% sure I am grasping what you're suggesting and its implications (not only potential breaking changes, but also in ease of maintainability of the library itself).

Would you have time to open a small PR/demo to show what you mean? Doesn't need to be a full-fledged PR, just an MVP to better understand the changes you're proposing.

Thanks

from figma-api.

Yes, sure.

Given these things:

• I'm an author of a figma plugin, that uses the official types from @figma/plugin-typings.
• I'm also a direct user of AST Types (instead of the Figma.Api). That is I'm fetching the figma file myself and then use the types from this project for my code.

Now, I'm using two different (type) libraries to express the same code - as the figma plugin API and the response from the figma rest API are pretty much equal (the same for my use-case). BUT the types are different. Let's make an example for a text node:

• Official types: TextNode
• This library: TEXT or Node<'TEXT'>

This confuses me 😵 - so I was wondering, if the types from this library can/should be renamed to match the name from the official plugin api, so from TEXT -> TextNode.

Schematic code:

// figma-api/types.ts

export type TextNode = VectorNode & {
  // ...
}

been used as:

import { TextNode } from 'figma-api';

interface MyOwnLibrary {
  /** a text field */
  textField: TextNode;
}

My second idea (to use the official types under the hood) is kinda not possible as these types are not importable.

The idea is a combination of an aesthetic request (in my eyes 🙈) and DX improvements for folks working in a figma plugin and with the rest api. A possible migration is to allow both APIs, mark the existing one deprecated and remove it with the next major release. The effort of course is heavily questionnable.

I hope it is clearer?

from figma-api.