Raphaël Bosi
3675f264f1
## Context Logic functions can declare workflow inputs typed as records or arrays of records (e.g. the People Data Labs enrichment functions), but the workflow builder rendered those as a plain text input with a variable picker, which is not usable. ## What this does - Adds an `objectUniversalIdentifier` link on input schema properties, so a record-typed input is tied to a workspace object. - The SDK build infers it from a `TwentyRecord<'objectUniversalIdentifier'>` marker type in the handler signature, reading the object's universal identifier straight from the source; explicit input schemas can still set the field directly. - The workflow builder renders these inputs as a single record picker or a record multi-select with the variable picker on the right. Selected records are stored as record ids; `TwentyRecord<UID>` is a branded `string`, so the handler signature reflects that it receives ids (a bound variable resolves to whatever the referenced step produced). - The multi-select collapses overflowing chips into a `+N` badge (reusing `ExpandableList`) and its variable picker offers both record objects and fields. - Updates the People Data Labs enrichment inputs as the reference implementation. <img width="802" height="824" alt="CleanShot 2026-06-12 at 16 54 10@2x" src="https://github.com/user-attachments/assets/a0896d74-0aab-49bd-a173-14c578a2e533" /> <!-- This is an auto-generated description by cubic. --> <a href="https://cubic.dev/pr/twentyhq/twenty/pull/21494?utm_source=github" target="_blank" rel="noopener noreferrer" data-no-image-dialog="true"><picture><source media="(prefers-color-scheme: dark)" srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a> <!-- End of auto-generated description by cubic. -->
101 lines
3.0 KiB
Markdown
101 lines
3.0 KiB
Markdown
<div align="center">
|
|
<a href="https://twenty.com">
|
|
<picture>
|
|
<img alt="Twenty logo" src="https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-website/public/images/core/logo.svg" height="128">
|
|
</picture>
|
|
</a>
|
|
<h1>Twenty SDK</h1>
|
|
|
|
<a href="https://www.npmjs.com/package/twenty-sdk"><img alt="NPM version" src="https://img.shields.io/npm/v/twenty-sdk.svg?style=for-the-badge&labelColor=000000"></a>
|
|
<a href="https://github.com/twentyhq/twenty/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/npm/l/next.svg?style=for-the-badge&labelColor=000000"></a>
|
|
<a href="https://discord.gg/cx5n4Jzs57"><img alt="Join the community on Discord" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=Twenty&labelColor=000000&logoWidth=20"></a>
|
|
|
|
</div>
|
|
|
|
A CLI and SDK to develop, build, and publish applications that extend [Twenty CRM](https://twenty.com).
|
|
|
|
## Quick start
|
|
|
|
The recommended way to start is with [create-twenty-app](https://www.npmjs.com/package/create-twenty-app):
|
|
|
|
```bash
|
|
npx create-twenty-app@latest my-twenty-app
|
|
cd my-twenty-app
|
|
yarn twenty dev
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Full documentation is available at **[docs.twenty.com/developers/extend/apps](https://docs.twenty.com/developers/extend/apps/getting-started)**:
|
|
|
|
- [Getting Started](https://docs.twenty.com/developers/extend/apps/getting-started) — scaffolding, local server, authentication, dev mode
|
|
- [Building Apps](https://docs.twenty.com/developers/extend/apps/building) — entity definitions, API clients, testing, CLI reference
|
|
- [Publishing](https://docs.twenty.com/developers/extend/apps/publishing) — deploy, npm publish, marketplace
|
|
|
|
Guides in this repository:
|
|
|
|
- [Logic function inputs](./docs/logic-function-inputs.md) — input schema inference, record-typed inputs, and the id contract
|
|
|
|
## Manual installation
|
|
|
|
If you are adding `twenty-sdk` to an existing project instead of using `create-twenty-app`:
|
|
|
|
```bash
|
|
yarn add twenty-sdk twenty-client-sdk
|
|
```
|
|
|
|
Then add a `twenty` script to your `package.json`:
|
|
|
|
```json
|
|
{
|
|
"scripts": {
|
|
"twenty": "twenty"
|
|
}
|
|
}
|
|
```
|
|
|
|
Run `yarn twenty help` to see all available commands.
|
|
|
|
## Configuration
|
|
|
|
The CLI stores credentials per remote in `~/.twenty/config.json`. Run `yarn twenty remote:add` to configure a remote, or `yarn twenty remote:list` to see existing ones.
|
|
|
|
## Troubleshooting
|
|
|
|
- Auth errors: run `yarn twenty remote:add` to re-authenticate.
|
|
- Typings out of date: restart `yarn twenty dev` to refresh the client and types.
|
|
- Not seeing changes in dev: make sure dev mode is running (`yarn twenty dev`).
|
|
|
|
## Contributing
|
|
|
|
### Development setup
|
|
|
|
```bash
|
|
git clone https://github.com/twentyhq/twenty.git
|
|
cd twenty
|
|
yarn install
|
|
```
|
|
|
|
### Development mode
|
|
|
|
```bash
|
|
npx nx run twenty-sdk:dev
|
|
```
|
|
|
|
### Production build
|
|
|
|
```bash
|
|
npx nx run twenty-sdk:build
|
|
```
|
|
|
|
### Running the CLI locally
|
|
|
|
```bash
|
|
npx nx run twenty-sdk:start -- <command>
|
|
```
|
|
|
|
### Resources
|
|
|
|
- See our [GitHub](https://github.com/twentyhq/twenty)
|
|
- Join our [Discord](https://discord.gg/cx5n4Jzs57)
|