Registry / storage / figma-rest-api-typescript-definitions

figma-rest-api-typescript-definitions

library0.2.0jsnpmunverified

TypeScript type definitions for Figma's REST API JSON responses, currently at version 0.2.0. These definitions are generated from Rust structs via 1Password's typeshare, ensuring type accuracy but potentially missing less-used fields. The package is updated infrequently, as it is derived from the Figma Rust project. Key differentiators: provides type safety for Figma API consumers in TypeScript projects, though coverage is limited to fields implemented in the Rust library. Alternatives like @figma/rest-api-spec offer hand-maintained types with broader coverage.

storage

npm install figma-rest-api-typescript-definitions

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · FIGMA-REST-API-TYP

figma-rest-api-typescript-definitions

storagejavascriptv0.2.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

figmaTypes

✓ import * as figmaTypes from 'figma-rest-api-typescript-definitions'

✗ import figmaTypes from 'figma-rest-api-typescript-definitions'

Package exports types via a namespace. Default import is not supported.

Node

✓ import { Node } from 'figma-rest-api-typescript-definitions'

✗ import { Node } from 'figma-rest-api-typescript-definitions/index.d.ts'

Individual types can be imported directly. Avoid appending the file path.

DocumentNode

✓ import type { DocumentNode } from 'figma-rest-api-typescript-definitions'

✗ const { DocumentNode } = require('figma-rest-api-typescript-definitions')

CommonJS require does not work with type-only exports; use ESM import type syntax.

Shows importing type definitions and using them to type a Figma API response.

// Install: npm install figma-rest-api-typescript-definitions import type { DocumentNode, Node, PageNode } from 'figma-rest-api-typescript-definitions'; // Example function using types function getNodeType(node: Node): string { if (node.type === 'DOCUMENT') { return 'Document'; } return node.type; } // Mock API response typed with definitions const apiResponse: { document: DocumentNode } = { document: { id: '0:1', name: 'My Document', type: 'DOCUMENT', children: [ { id: '1:2', name: 'Page 1', type: 'PAGE', children: [] } as PageNode ] } }; console.log(getNodeType(apiResponse.document));

Debug

Known issues

gotchaPackage may lack types for less common API fields; types are generated from Rust definitions and may be incomplete.

fix

Use the parent Rust project's 'echo' subcommand to inspect actual API data.

affects: >=0

gotchaNo default export; namespace import or named imports must be used.

fix

Use import * as figmaTypes from 'figma-rest-api-typescript-definitions' or import { specificType }.

affects: >=0.1.0

deprecatedTypeScript version older than 4.0 may not support the type definitions correctly.

fix

Upgrade TypeScript to >=4.0.

affects: <0.2.0

Errors

Common errors & fixes

Cannot find module 'figma-rest-api-typescript-definitions' or its corresponding type declarations.

Package not installed or not included in tsconfig.json types.

fix

Run 'npm install figma-rest-api-typescript-definitions' and ensure tsconfig includes "node_modules/@types" or the package.

Module '"figma-rest-api-typescript-definitions"' has no default export.

Attempting to import as default when exports are named or namespace.

fix

Use import * as figmaTypes from 'figma-rest-api-typescript-definitions' or import { specificType }.

Type 'Node' is not generic.

Using Node type in older versions where it was incorrectly defined as generic (v0.0.1).

fix

Update to version 0.2.0: 'npm install figma-rest-api-typescript-definitions@latest'.

Upgrade

Version history

0.2.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

36 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/ccouzens/figma-rust ↗

packagefigma-rest-api-typescript-definitions ↗

homepagehttps://github.com/ccouzens/figma-rust/tree/main/typescript ↗