framer-api 0.0.1 → 0.1.0-beta
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -0
- package/dist/index.d.ts +4919 -0
- package/dist/index.js +14 -0
- package/package.json +55 -9
- package/index.js +0 -0
package/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
<h1 align="center" margin="0">
|
|
2
|
+
<img width="200" src="https://misc.framerstatic.com/framer-api/package-logo.svg">
|
|
3
|
+
</h1>
|
|
4
|
+
<h3 align="center" style="margin: 0;">
|
|
5
|
+
Programmatically interact with Framer projects.
|
|
6
|
+
</h3>
|
|
7
|
+
|
|
8
|
+
<br>
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install framer-api
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Getting Started
|
|
17
|
+
|
|
18
|
+
1. Open your project in Framer
|
|
19
|
+
2. Open settings (Cmd+K → "open settings")
|
|
20
|
+
3. Find the "API Keys" section
|
|
21
|
+
4. Create and copy your API key
|
|
22
|
+
|
|
23
|
+
Set the `FRAMER_API_KEY` environment variable, or pass it as the second argument to `connect()`.
|
|
24
|
+
|
|
25
|
+
## Quick Start
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import { connect } from "framer-api"
|
|
29
|
+
|
|
30
|
+
const framer = await connect("https://framer.com/projects/Website--aabbccdd1122")
|
|
31
|
+
|
|
32
|
+
const info = await framer.getProjectInfo()
|
|
33
|
+
|
|
34
|
+
await framer.disconnect()
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
With Node.js 24+ or Bun 1.3+, use `using` for automatic cleanup:
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
using framer = await connect(projectUrl)
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Documentation
|
|
44
|
+
|
|
45
|
+
- [Introduction](https://www.framer.com/developers/server-api-introduction)
|
|
46
|
+
- [Quick Start](https://www.framer.com/developers/server-api-quick-start)
|
|
47
|
+
- [Reference](https://www.framer.com/developers/server-api-reference)
|
|
48
|
+
- [FAQ](https://www.framer.com/developers/server-api-faq)
|
|
49
|
+
- [Examples](https://github.com/framer/server-api-examples)
|
|
50
|
+
|
|
51
|
+
## Feedback
|
|
52
|
+
|
|
53
|
+
Have questions or feedback? Email us at <server-api-feedback@framer.com>
|