From 77bade811439f8ca55ac8f58d91fd947aaac530d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 24 Mar 2026 17:42:35 +0100 Subject: [PATCH] i18n - docs translations (#18925) Created by Github action Co-authored-by: github-actions --- packages/twenty-docs/docs.json | 2 +- .../l/ar/developers/extend/apps/building.mdx | 6 +- .../extend/apps/getting-started.mdx | 12 +- .../ar/developers/extend/apps/publishing.mdx | 14 +- .../developers/extend/capabilities/apps.mdx | 52 +- .../frontend-commands.mdx | 2 +- .../frontend-development/style-guide.mdx | 4 +- .../contribute/capabilities/local-setup.mdx | 30 +- .../l/cs/developers/extend/api.mdx | 147 ++++ .../l/cs/developers/extend/apps/building.mdx | 689 ++++++++++++++++++ .../extend/apps/getting-started.mdx | 245 +++++++ .../cs/developers/extend/apps/publishing.mdx | 119 +++ .../developers/extend/capabilities/apps.mdx | 512 ++++++++++++- .../l/cs/developers/extend/extend.mdx | 11 +- .../l/cs/developers/extend/webhooks.mdx | 116 +++ .../l/cs/developers/introduction.mdx | 22 +- .../self-host/capabilities/docker-compose.mdx | 4 +- .../self-host/capabilities/setup.mdx | 50 +- .../capabilities/troubleshooting.mdx | 4 + packages/twenty-docs/l/cs/navigation.json | 4 +- .../l/cs/user-guide/ai/capabilities/mcp.mdx | 142 ++++ .../how-tos/export-your-data.mdx | 6 +- .../how-tos/import-data-via-api.mdx | 10 +- .../capabilities/what-is-twenty.mdx | 2 +- .../auto-reply-to-inbound-emails.mdx | 121 +++ .../display-related-record-data.mdx | 2 +- .../l/de/developers/extend/apps/building.mdx | 6 +- .../extend/apps/getting-started.mdx | 12 +- .../de/developers/extend/apps/publishing.mdx | 14 +- .../developers/extend/capabilities/apps.mdx | 52 +- .../l/it/developers/extend/apps/building.mdx | 6 +- .../extend/apps/getting-started.mdx | 12 +- .../it/developers/extend/apps/publishing.mdx | 14 +- .../developers/extend/capabilities/apps.mdx | 58 +- .../l/pt/developers/extend/apps/building.mdx | 6 +- .../extend/apps/getting-started.mdx | 12 +- .../pt/developers/extend/apps/publishing.mdx | 14 +- .../developers/extend/capabilities/apps.mdx | 60 +- .../l/ro/developers/extend/apps/building.mdx | 6 +- .../extend/apps/getting-started.mdx | 12 +- .../ro/developers/extend/apps/publishing.mdx | 14 +- .../developers/extend/capabilities/apps.mdx | 40 +- .../l/ru/developers/extend/apps/building.mdx | 6 +- .../extend/apps/getting-started.mdx | 12 +- .../ru/developers/extend/apps/publishing.mdx | 14 +- .../developers/extend/capabilities/apps.mdx | 56 +- .../l/tr/developers/extend/apps/building.mdx | 6 +- .../extend/apps/getting-started.mdx | 12 +- .../tr/developers/extend/apps/publishing.mdx | 14 +- .../developers/extend/capabilities/apps.mdx | 34 +- .../l/zh/developers/extend/apps/building.mdx | 6 +- .../extend/apps/getting-started.mdx | 12 +- .../zh/developers/extend/apps/publishing.mdx | 22 +- .../developers/extend/capabilities/apps.mdx | 30 +- 54 files changed, 2476 insertions(+), 414 deletions(-) create mode 100644 packages/twenty-docs/l/cs/developers/extend/api.mdx create mode 100644 packages/twenty-docs/l/cs/developers/extend/apps/building.mdx create mode 100644 packages/twenty-docs/l/cs/developers/extend/apps/getting-started.mdx create mode 100644 packages/twenty-docs/l/cs/developers/extend/apps/publishing.mdx create mode 100644 packages/twenty-docs/l/cs/developers/extend/webhooks.mdx create mode 100644 packages/twenty-docs/l/cs/user-guide/ai/capabilities/mcp.mdx create mode 100644 packages/twenty-docs/l/cs/user-guide/workflows/how-tos/crm-automations/auto-reply-to-inbound-emails.mdx diff --git a/packages/twenty-docs/docs.json b/packages/twenty-docs/docs.json index 2b997516d9e..b3ff28b9459 100644 --- a/packages/twenty-docs/docs.json +++ b/packages/twenty-docs/docs.json @@ -1703,7 +1703,7 @@ "l/cs/developers/extend/api", "l/cs/developers/extend/webhooks", { - "group": "Apps", + "group": "Aplikace", "pages": [ "l/cs/developers/extend/apps/getting-started", "l/cs/developers/extend/apps/building", diff --git a/packages/twenty-docs/l/ar/developers/extend/apps/building.mdx b/packages/twenty-docs/l/ar/developers/extend/apps/building.mdx index 0007a7d2820..fbe19ac82bb 100644 --- a/packages/twenty-docs/l/ar/developers/extend/apps/building.mdx +++ b/packages/twenty-docs/l/ar/developers/extend/apps/building.mdx @@ -563,7 +563,7 @@ export default defineFrontComponent({ * المكوّنات الأمامية هي مكوّنات React تُعرَض ضمن سياقات معزولة داخل Twenty. * يشير الحقل `component` إلى مكوّن React الخاص بك. -* يتم بناء المكوّنات ومزامنتها تلقائيًا أثناء `yarn twenty app:dev`. +* يتم بناء المكوّنات ومزامنتها تلقائيًا أثناء `yarn twenty dev`. يمكنك إنشاء مكوّنات أمامية جديدة بطريقتين: @@ -607,7 +607,7 @@ export default defineSkill({ ### عملاء مُولَّدون مضبوطو الأنواع -يتم توليد عميلين مضبوطي الأنواع تلقائيًا بواسطة `yarn twenty app:dev` وتخزينهما في `node_modules/twenty-sdk/generated` استنادًا إلى مخطط مساحة العمل لديك: +يتم توليد عميلين مضبوطي الأنواع تلقائيًا بواسطة `yarn twenty dev` وتخزينهما في `node_modules/twenty-sdk/generated` استنادًا إلى مخطط مساحة العمل لديك: * **`CoreApiClient`** — يُجري استعلامات إلى نقطة النهاية `/graphql` للحصول على بيانات مساحة العمل * **`MetadataApiClient`** — يستعلم عن نقطة النهاية `/metadata` لتكوين مساحة العمل وتحميل الملفات. @@ -622,7 +622,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -يُعاد توليد كلا العميلين تلقائيًا بواسطة `yarn twenty app:dev` كلما تغيّرت كائناتك أو حقولك. +يُعاد توليد كلا العميلين تلقائيًا بواسطة `yarn twenty dev` كلما تغيّرت كائناتك أو حقولك. #### بيانات الاعتماد وقت التشغيل في الدوال المنطقية diff --git a/packages/twenty-docs/l/ar/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/ar/developers/extend/apps/getting-started.mdx index b463205ae72..aa19897764c 100644 --- a/packages/twenty-docs/l/ar/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/ar/developers/extend/apps/getting-started.mdx @@ -32,7 +32,7 @@ npx create-twenty-app@latest my-twenty-app cd my-twenty-app # Start dev mode: automatically syncs local changes to your workspace -yarn twenty app:dev +yarn twenty dev ``` يدعم المُهيئ وضعين للتحكم في ملفات الأمثلة التي سيتم تضمينها: @@ -64,7 +64,7 @@ yarn twenty function:execute --preInstall yarn twenty function:execute --postInstall # Uninstall the application from the current workspace -yarn twenty app:uninstall +yarn twenty uninstall # Display commands' help yarn twenty help @@ -167,7 +167,7 @@ export default defineObject({ ستضيف الأوامر اللاحقة مزيدًا من الملفات والمجلدات: -* سيقوم `yarn twenty app:dev` بتوليد عميلين API مضبوطي الأنواع تلقائيًا في `node_modules/twenty-sdk/generated`: `CoreApiClient` (لبيانات مساحة العمل عبر `/graphql`) و`MetadataApiClient` (لتكوين مساحة العمل وتحميل الملفات عبر `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/generated`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` سيضيف ملفات تعريف الكيانات ضمن `src/` لكائناتك المخصّصة، والوظائف، ومكوّنات الواجهة الأمامية، والأدوار، والمهارات، وغير ذلك. ## المصادقة @@ -221,7 +221,7 @@ yarn add -D twenty-sdk } ``` -الآن يمكنك تشغيل جميع الأوامر عبر `yarn twenty `، مثلًا: `yarn twenty app:dev`، `yarn twenty help`، إلخ. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## كيفية استخدام مثيل محلي من Twenty @@ -239,7 +239,7 @@ yarn twenty remote add --local --port 3000 * أخطاء المصادقة: شغّل `yarn twenty auth:login` وتأكد من أن مفتاح واجهة برمجة التطبيقات لديك يمتلك الأذونات المطلوبة. * يتعذّر الاتصال بالخادم: تحقق من عنوان URL لواجهة برمجة التطبيقات وأن خادم Twenty قابل للوصول. -* الأنواع أو العميل مفقود/قديم: أعد تشغيل `yarn twenty app:dev` — فهو ينشئ العميل مضبوط الأنواع بشكل تلقائي. -* وضع التطوير لا يزامن: تأكد من أن `yarn twenty app:dev` قيد التشغيل وأن التغييرات ليست متجاهلة من بيئتك. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. قناة المساعدة على Discord: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/ar/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/ar/developers/extend/apps/publishing.mdx index 5f901cdec68..ec559697c3b 100644 --- a/packages/twenty-docs/l/ar/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/ar/developers/extend/apps/publishing.mdx @@ -28,13 +28,13 @@ description: وزّع تطبيق Twenty الخاص بك على سوق Twenty أ 1. **قم ببناء تطبيقك** — تقوم أداة CLI بتجميع مصادر TypeScript الخاصة بك وإنشاء ملف بيان التطبيق: ```bash filename="Terminal" -yarn twenty app:build +yarn twenty build ``` 2. **النشر على npm** — ادفع الحزمة المبنية إلى سجل npm: ```bash filename="Terminal" -npx twenty app:publish +npx twenty publish ``` ### الاكتشاف التلقائي @@ -65,14 +65,14 @@ jobs: node-version: "24" registry-url: https://registry.npmjs.org - run: yarn install --immutable - - run: npx twenty app:build + - run: npx twenty build - run: npm publish --provenance --access public working-directory: .twenty/output env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} ``` -بالنسبة لأنظمة CI الأخرى (GitLab CI، CircleCI، إلخ)، تنطبق الأوامر الثلاثة نفسها: `yarn install`، ثم `npx twenty app:build`، ثم `npm publish` من `.twenty/output`. +For other CI systems (GitLab CI, CircleCI, etc.), the same three commands apply: `yarn install`, `npx twenty build`, then `npm publish` from `.twenty/output`. **npm provenance** اختياري ولكنه موصى به. يضيف النشر باستخدام `--provenance` شارة ثقة إلى إدراجك على npm، مما يتيح للمستخدمين التحقق من أن الحزمة تم بناؤها من التزام محدد ضمن خط أنابيب CI عام. راجع [وثائق npm provenance](https://docs.npmjs.com/generating-provenance-statements) للحصول على تعليمات الإعداد. @@ -87,7 +87,7 @@ jobs: قم ببناء تطبيقك وانشره إلى خادم محدد في خطوة واحدة: ```bash filename="Terminal" -npx twenty app:publish --server +npx twenty publish --server ``` يمكن لأي مساحة عمل على ذلك الخادم بعدها تثبيت التطبيق وترقيته من صفحة الإعدادات **التطبيقات**. @@ -97,7 +97,7 @@ npx twenty app:publish --server لطرح تحديث: 1. ارفع قيمة الحقل `version` في ملف `package.json` -2. أرسل tarball جديدًا باستخدام `npx twenty app:publish --server ` +2. Push a new tarball with `npx twenty publish --server ` 3. سترى مساحات العمل على ذلك الخادم الترقية متاحة في إعداداتها @@ -110,7 +110,7 @@ npx twenty app:publish --server | الفئة | كيف يعمل | مرئي في سوق Twenty؟ | | ----------- | ---------------------------------------------------------------------------------------------------- | ------------------- | -| **التطوير** | تطبيقات وضع التطوير المحلي التي تعمل عبر `yarn twenty app:dev`. تُستخدم للبناء والاختبار. | لا | +| **التطوير** | Local dev mode apps running via `yarn twenty dev`. تُستخدم للبناء والاختبار. | لا | | **منشور** | تطبيقات منشورة على npm مع البادئة `twenty-app-`. مدرجة في سوق Twenty لتتمكن أي مساحة عمل من تثبيتها. | نعم | | **داخلي** | تطبيقات منشورة عبر tarball إلى خادم محدد. متاحة فقط لمساحات العمل على ذلك الخادم. | لا | diff --git a/packages/twenty-docs/l/ar/developers/extend/capabilities/apps.mdx b/packages/twenty-docs/l/ar/developers/extend/capabilities/apps.mdx index fa44d43bd82..7db623af3fc 100644 --- a/packages/twenty-docs/l/ar/developers/extend/capabilities/apps.mdx +++ b/packages/twenty-docs/l/ar/developers/extend/capabilities/apps.mdx @@ -93,31 +93,31 @@ yarn twenty remote add --local --port 3000 من هنا يمكنك: ```bash filename="Terminal" -# أضف كيانًا جديدًا إلى تطبيقك (موجّه) +# Add a new entity to your application (guided) yarn twenty entity:add -# راقب سجلات وظائف تطبيقك +# Watch your application's function logs yarn twenty function:logs -# نفّذ وظيفة بالاسم +# Execute a function by name yarn twenty function:execute -n my-function -p '{"name": "test"}' -# نفّذ دالة ما قبل التثبيت +# Execute the pre-install function yarn twenty function:execute --preInstall -# نفّذ دالة ما بعد التثبيت +# Execute the post-install function yarn twenty function:execute --postInstall -# ابنِ التطبيق للتوزيع -yarn twenty app:build +# Build the app for distribution +yarn twenty build -# انشر التطبيق إلى npm أو إلى خادم Twenty -yarn twenty app:publish +# Publish the app to npm or a Twenty server +yarn twenty publish -# أزل تثبيت التطبيق من مساحة العمل الحالية -yarn twenty app:uninstall +# Uninstall the application from the current workspace +yarn twenty uninstall -# اعرض مساعدة الأوامر +# Display commands' help yarn twenty help ``` @@ -221,7 +221,7 @@ export default defineObject({ ستضيف الأوامر اللاحقة مزيدًا من الملفات والمجلدات: -* سيقوم `yarn twenty app:dev` بتوليد عميلين API مضبوطي الأنواع تلقائيًا في `node_modules/twenty-sdk/clients`: `CoreApiClient` (لبيانات مساحة العمل عبر `/graphql`) و`MetadataApiClient` (لتكوين مساحة العمل وتحميل الملفات عبر `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` سيضيف ملفات تعريف الكيانات ضمن `src/` لكائناتك المخصّصة، والوظائف، ومكوّنات الواجهة الأمامية، والأدوار، والمهارات، وغير ذلك. ## المصادقة @@ -880,7 +880,7 @@ export default defineFrontComponent({ * المكوّنات الأمامية هي مكوّنات React تُعرَض ضمن سياقات معزولة داخل Twenty. * يشير الحقل `component` إلى مكوّن React الخاص بك. -* يتم بناء المكوّنات ومزامنتها تلقائيًا أثناء `yarn twenty app:dev`. +* Components are built and synced automatically during `yarn twenty dev`. يمكنك إنشاء مكوّنات أمامية جديدة بطريقتين: @@ -1208,7 +1208,7 @@ export default defineAgent({ ### عملاء مُولَّدون مضبوطو الأنواع -يتم توليد عميلين مضبوطي الأنواع تلقائيًا بواسطة `yarn twenty app:dev` وتخزينهما في `node_modules/twenty-sdk/clients` استنادًا إلى مخطط مساحة العمل لديك: +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/clients` based on your workspace schema: * **`CoreApiClient`** — يُجري استعلامات إلى نقطة النهاية `/graphql` للحصول على بيانات مساحة العمل * **`MetadataApiClient`** — يستعلم عن نقطة النهاية `/metadata` لتكوين مساحة العمل وتحميل الملفات. @@ -1224,7 +1224,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -`CoreApiClient` يُعاد توليده تلقائيًا بواسطة `yarn twenty app:dev` كلما تغيّرت كائناتك أو حقولك. `MetadataApiClient` يأتي مُجهزًا مسبقًا مع SDK. +`CoreApiClient` is re-generated automatically by `yarn twenty dev` whenever your objects or fields change. `MetadataApiClient` يأتي مُجهزًا مسبقًا مع SDK. #### بيانات الاعتماد وقت التشغيل في الوظائف المنطقية @@ -1295,11 +1295,11 @@ uploadFile( بمجرد أن تطوّر تطبيقك باستخدام `app:dev`، استخدم `app:build` لإنشاء حزمة قابلة للتوزيع منه. ```bash filename="Terminal" -# ابنِ التطبيق (الإخراج يذهب إلى .twenty/output/) -yarn twenty app:build +# Build the app (output goes to .twenty/output/) +yarn twenty build -# ابنِ وأنشئ ملف tarball (.tgz) للتوزيع -yarn twenty app:build --tarball +# Build and create a tarball (.tgz) for distribution +yarn twenty build --tarball ``` عملية البناء: @@ -1339,10 +1339,10 @@ yarn twenty app:build --tarball ```bash filename="Terminal" # Publish to npm (requires npm login) -yarn twenty app:publish +yarn twenty publish # Publish with a dist-tag (e.g. beta, next) -yarn twenty app:publish --tag beta +yarn twenty publish --tag beta ``` يقوم هذا ببناء التطبيق وتشغيل `npm publish` من دليل `.twenty/output/`. بعد ذلك يمكن تثبيت الحزمة المنشورة من سوق Twenty بواسطة أي مساحة عمل. @@ -1351,7 +1351,7 @@ yarn twenty app:publish --tag beta ```bash filename="Terminal" # Publish directly to a Twenty server -yarn twenty app:publish --server https://app.twenty.com +yarn twenty publish --server https://app.twenty.com ``` يقوم هذا ببناء التطبيق مع أرشيف tar، ويرفعه إلى الخادم عبر العملية `uploadAppTarball` في GraphQL، ويبدأ التثبيت في خطوة واحدة. يكون هذا مفيدًا لعمليات النشر الخاصة أو للاختبار مقابل خادم محدّد. @@ -1415,13 +1415,13 @@ yarn add -D twenty-sdk } ``` -الآن يمكنك تشغيل جميع الأوامر عبر `yarn twenty `، مثلًا: `yarn twenty app:dev`، `yarn twenty help`، إلخ. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## استكشاف الأخطاء وإصلاحها * أخطاء المصادقة: شغّل `yarn twenty auth:login` وتأكد من أن مفتاح واجهة برمجة التطبيقات لديك يمتلك الأذونات المطلوبة. * يتعذّر الاتصال بالخادم: تحقق من عنوان URL لواجهة البرمجة وأن خادم Twenty قابل للوصول. -* الأنواع أو العميل مفقود/قديم: أعد تشغيل `yarn twenty app:dev` — فهو ينشئ العميل مضبوط الأنواع بشكل تلقائي. -* وضع التطوير لا يزامن: تأكد من أن `yarn twenty app:dev` قيد التشغيل وأن التغييرات ليست متجاهلة من بيئتك. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. قناة المساعدة على Discord: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/cs/developers/contribute/capabilities/frontend-development/frontend-commands.mdx b/packages/twenty-docs/l/cs/developers/contribute/capabilities/frontend-development/frontend-commands.mdx index 81e659957d3..a585ffa655a 100644 --- a/packages/twenty-docs/l/cs/developers/contribute/capabilities/frontend-development/frontend-commands.mdx +++ b/packages/twenty-docs/l/cs/developers/contribute/capabilities/frontend-development/frontend-commands.mdx @@ -77,7 +77,7 @@ To avoid unnecessary [re-renders](/l/cs/developers/contribute/capabilities/front ### Správa stavu -[Jotai](https://jotai.org/) handles state management. +[Jotai](https://jotai.org/) zajišťuje správu stavu. Podívejte se na [osvědčené postupy](/l/cs/developers/contribute/capabilities/frontend-development/best-practices-front#state-management) pro více informací o správě stavu. diff --git a/packages/twenty-docs/l/cs/developers/contribute/capabilities/frontend-development/style-guide.mdx b/packages/twenty-docs/l/cs/developers/contribute/capabilities/frontend-development/style-guide.mdx index 8a2c25dd89c..fab7d693800 100644 --- a/packages/twenty-docs/l/cs/developers/contribute/capabilities/frontend-development/style-guide.mdx +++ b/packages/twenty-docs/l/cs/developers/contribute/capabilities/frontend-development/style-guide.mdx @@ -8,7 +8,7 @@ Cílem zde je mít konzistentní kódovou základnu, která je snadno čitelná Pro toto je lepší být trochu více rozvláčný než být příliš stručný. -Vždy mějte na paměti, že lidé čtou kód častěji, než ho píší, zvláště u projektu s otevřeným zdrojovým kódem, kde může kdokoli přispět. +Vždy mějte na paměti, že lidé čtou kód častěji než ho píší, zejména u projektu s otevřeným zdrojovým kódem, kde může kdokoli přispět. Existuje mnoho pravidel, která zde nejsou definována, ale která jsou automaticky kontrolována lintery. @@ -150,7 +150,7 @@ type MyType = { ### Používejte textové literály místo výčtů -[Textové literály](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#literal-types) jsou preferovaný způsob pro zpracování hodnot podobných výčtům v TypeScriptu. Jsou snadněji rozšířitelné pomocí Pick a Omit a nabízejí lepší uživatelský zážitek, zejména s automatickým dokončováním kódu. +[Textové literály](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#literal-types) jsou preferovaný způsob pro zpracování hodnot podobných výčtům v TypeScriptu. Snadněji se rozšiřují pomocí Pick a Omit a nabízejí lepší vývojářskou zkušenost, zejména s automatickým dokončováním kódu. Proč TypeScript doporučuje vyhnout se výčtům zjistíte [zde](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#enums). diff --git a/packages/twenty-docs/l/cs/developers/contribute/capabilities/local-setup.mdx b/packages/twenty-docs/l/cs/developers/contribute/capabilities/local-setup.mdx index 452182836fe..22a49c3edbb 100644 --- a/packages/twenty-docs/l/cs/developers/contribute/capabilities/local-setup.mdx +++ b/packages/twenty-docs/l/cs/developers/contribute/capabilities/local-setup.mdx @@ -6,7 +6,7 @@ description: Průvodce pro přispěvatele (nebo zvídavé vývojáře), kteří ## Předpoklady - + Než nainstalujete a použijete Twenty, ujistěte se, že máte na svém počítači nainstalovány následující balíčky: * [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) @@ -30,7 +30,7 @@ wsl --install ``` Nyní byste měli vidět výzvu k restartování počítače. Pokud ne, restartujte jej ručně. -Při restartu se otevře okno PowerShell a nainstaluje Ubuntu. Tento proces může chvíli trvat. +Při restartu se otevře okno PowerShellu a nainstaluje Ubuntu. Tento proces může chvíli trvat. Zobrazí se výzva k vytvoření uživatelského jména a hesla pro vaši instalaci Ubuntu. 2. Nainstalujte a nastavte git @@ -102,8 +102,8 @@ Všechny příkazy v následujících krocích byste měli provádět z kořene - **Možnost 1 (doporučeno):** Pro lokalní vytvoření databáze: - Použijte následující odkaz pro instalaci PostgreSQL na vašem Linuxovém stroji: [Instalace PostgreSQL](https://www.postgresql.org/download/linux/) + **Možnost 1 (doporučeno):** Pro lokální vytvoření databáze: + Použijte následující odkaz pro instalaci PostgreSQL na vašem linuxovém stroji: [Instalace PostgreSQL](https://www.postgresql.org/download/linux/) ```bash psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;" ``` @@ -129,8 +129,8 @@ Všechny příkazy v následujících krocích byste měli provádět z kořene brew services list ``` - Instalátor nemusí automaticky vytvořit uživatele `postgres` při instalaci - přes Homebrew na MacOS. Místo toho vytvoří PostgreSQL roli, která odpovídá vašemu uživatelskému jménu v MacOS (např. "john"). + Instalátor nemusí ve výchozím nastavení vytvořit uživatele `postgres` při instalaci + přes Homebrew na macOS. Místo toho vytvoří PostgreSQL roli, která odpovídá vašemu uživatelskému jménu v MacOS (např. "john"). Pro zkontrolování a vytvoření uživatele `postgres`, pokud je to nutné, postupujte takto: ```bash # Připojit se k PostgreSQL @@ -172,8 +172,8 @@ Všechny příkazy v následujících krocích byste měli provádět z kořene Všechny následující kroky je třeba provádět v terminálu WSL (v rámci vaší virtuálního stroje). - **Možnost 1:** Pro lokalní vytvoření PostgreSQL: - Použijte následující odkaz pro instalaci PostgreSQL na vašem Linuxovém virtuálním stroji: [Instalace PostgreSQL](https://www.postgresql.org/download/linux/) + **Možnost 1:** Pro lokální zprovoznění PostgreSQL: + Použijte následující odkaz pro instalaci PostgreSQL na vašem linuxovém virtuálním stroji: [Instalace PostgreSQL](https://www.postgresql.org/download/linux/) ```bash psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;" ``` @@ -188,7 +188,9 @@ Všechny příkazy v následujících krocích byste měli provádět z kořene -Nyní můžete přistupovat k databázi na [localhost:5432](localhost:5432), s uživatelem `postgres` a heslem `postgres`. +Nyní můžete přistupovat k databázi na adrese `localhost:5432`. + +Pokud jste použili výše uvedenou možnost Dockeru, výchozí přihlašovací údaje jsou uživatelské jméno `postgres` a heslo `postgres`. U nativních instalací PostgreSQL použijte přihlašovací údaje a role nakonfigurované na vašem počítači. ## Krok 4: Nastavení Redis databáze (cache) @@ -209,8 +211,10 @@ Twenty vyžaduje ke svému provozu Redis cache pro zajištění nejlepšího vý ```bash brew install redis ``` - Spusťte redis server: - `brew services start redis` + Spusťte svůj server Redis: + ```bash + brew services start redis + ``` **Možnost 2:** Pokud máte nainstalován docker: ```bash @@ -228,11 +232,11 @@ Twenty vyžaduje ke svému provozu Redis cache pro zajištění nejlepšího vý -Pokud potřebujete GUI klienta, doporučujeme [redis insight](https://redis.io/insight/) (dostupná je bezplatná verze) +Pokud potřebujete GUI klienta, doporučujeme [Redis Insight](https://redis.io/insight/) (k dispozici je bezplatná verze). ## Krok 5: Nastavení proměnných prostředí -Použijte proměnné prostředí nebo `.env` soubory, abyste nakonfigurovali váš projekt. Více informací [zde](/l/cs/developers/self-host/capabilities/setup) +Použijte proměnné prostředí nebo `.env` soubory, abyste nakonfigurovali váš projekt. Více informací [zde](/l/cs/developers/self-host/capabilities/setup). Zkopírujte soubory `.env.example` v `/front` a `/server`: diff --git a/packages/twenty-docs/l/cs/developers/extend/api.mdx b/packages/twenty-docs/l/cs/developers/extend/api.mdx new file mode 100644 index 00000000000..d5f9cf89744 --- /dev/null +++ b/packages/twenty-docs/l/cs/developers/extend/api.mdx @@ -0,0 +1,147 @@ +--- +title: API +description: Programově dotazujte a upravujte svá CRM data pomocí REST nebo GraphQL. +--- + +import { VimeoEmbed } from '/snippets/vimeo-embed.mdx'; + +Twenty bylo vytvořeno s ohledem na vývojáře a nabízí výkonná API, která se přizpůsobí vašemu vlastnímu datovému modelu. Nabízíme čtyři typy API, které splňují různé potřeby integrace. + +## Přístup orientovaný na vývojáře + +Twenty generuje API specificky pro váš datový model: + +* **Nejsou vyžadována dlouhá ID**: Používejte v koncových bodech přímo názvy objektů a polí. +* **Standardní a vlastní objekty jsou rovnocenně zpracovány**: Vaše vlastní objekty mají stejnou podporu API jako vestavěné. +* **Vyhrazené koncové body**: Každý objekt a každé pole má svůj vlastní koncový bod API. +* **Vlastní dokumentace**: Generována specificky pro datový model vašeho pracovního prostoru. + + +Vaše personalizovaná dokumentace k API je dostupná v **Nastavení → API & Webhooks** po vytvoření API klíče. Protože Twenty generuje API odpovídající vašemu vlastnímu datovému modelu, dokumentace je jedinečná pro váš pracovní prostor. + + +## Dva typy API + +### Core API + +Přístupné na `/rest/` nebo `/graphql/` + +Pracujte se svými skutečnými **záznamy** (daty): + +* Vytvářejte, čtěte, aktualizujte a mazejte osoby, společnosti, příležitosti atd. +* Dotazujte a filtrujte data +* Spravujte vztahy mezi záznamy. + +### Metadata API + +Přístupné na `/rest/metadata/` nebo `/metadata/` + +Spravujte svůj **pracovní prostor a datový model**: + +* Vytvářejte, upravujte nebo mazejte objekty a pole. +* Konfigurujte nastavení pracovního prostoru. +* Definujte vztahy mezi objekty + +## REST vs GraphQL + +Jak Core, tak Metadata API jsou k dispozici ve formátech REST a GraphQL: + +| Formát | Dostupné operace | +| ----------- | ---------------------------------------------------------------------- | +| **REST** | CRUD, hromadné operace, operace upsert | +| **GraphQL** | Stejné + **hromadné operace upsert**, dotazy na vztahy v jednom volání | + +Zvolte podle svých potřeb — oba formáty přistupují ke stejným datům. + +## Koncové body API + +| Prostředí | Základní URL | +| ------------------- | ------------------------- | +| **Cloud** | `https://api.twenty.com/` | +| **Vlastní hosting** | `https://{your-domain}/` | + +## Ověření + +Každý požadavek na API vyžaduje klíč API v hlavičce: + +``` +Authorization: Bearer YOUR_API_KEY +``` + +### Vytvořit API klíč + +1. Přejděte na **Nastavení → APIs & Webhooks** +2. Klikněte na **+ Vytvořit klíč** +3. Nakonfigurujte: + * **Název**: Popisný název pro klíč + * **Datum vypršení platnosti**: Kdy klíč vyprší +4. Klikněte na **Uložit** +5. **Zkopírujte ihned** — klíč se zobrazí pouze jednou + + + + +Váš klíč API poskytuje přístup k citlivým datům. Nesdílejte ho s nedůvěryhodnými službami. Pokud je kompromitován, okamžitě ho deaktivujte a vygenerujte nový. + + +### Přiřaďte roli klíči API + +Pro vyšší bezpečnost přiřaďte konkrétní roli, abyste omezili přístup: + +1. Přejděte na **Nastavení → Role** +2. Klikněte na roli, kterou chcete přiřadit +3. Otevřete záložku **Přiřazení** +4. V části **API Keys** klikněte na **+ Přiřadit ke klíči API** +5. Vyberte klíč API + +Klíč zdědí oprávnění této role. Podrobnosti viz [Oprávnění](/l/cs/user-guide/permissions-access/capabilities/permissions). + +### Spravovat API klíče + +**Znovu vygenerovat**: Nastavení → APIs & Webhooks → Klikněte na klíč → **Znovu vygenerovat** + +**Smazat**: Nastavení → APIs & Webhooks → Klikněte na klíč → **Smazat** + +## API Playground + +Testujte svá API přímo v prohlížeči pomocí našeho vestavěného playgroundu — k dispozici pro **REST** i **GraphQL**. + +### Přístup do Playgroundu + +1. Přejděte na **Nastavení → APIs & Webhooks** +2. Vytvořte klíč API (povinné) +3. Klikněte na **REST API** nebo **GraphQL API** pro otevření playgroundu + +### Co získáte + +* **Interaktivní dokumentace**: Generována pro váš specifický datový model +* **Živé testování**: Spouštějte reálná volání API vůči vašemu pracovnímu prostoru +* **Průzkumník schématu**: Procházejte dostupné objekty, pole a vztahy +* **Tvůrce požadavků**: Sestavujte dotazy s automatickým doplňováním + +Playground odráží vaše vlastní objekty a pole, takže dokumentace je pro váš pracovní prostor vždy přesná. + +## Hromadné operace + +REST i GraphQL podporují hromadné operace: + +* **Velikost dávky**: Až 60 záznamů na požadavek. +* **Operace**: Vytváření, aktualizace a mazání více záznamů + +**Funkce pouze pro GraphQL:** + +* **Hromadný upsert**: Vytvoření nebo aktualizace v jednom volání +* Používejte množná čísla názvů objektů (např. `CreateCompanies` místo `CreateCompany`) + +## Limity rychlosti + +Požadavky na API jsou omezovány, aby byla zajištěna stabilita platformy: + +| Limit | Hodnota | +| ------------------ | -------------------- | +| **Požadavky** | 100 volání za minutu | +| **Velikost dávky** | 60 záznamů na volání | + + +Pro maximalizaci propustnosti používejte hromadné operace — zpracujte až 60 záznamů v jediném volání API místo odesílání jednotlivých požadavků. + diff --git a/packages/twenty-docs/l/cs/developers/extend/apps/building.mdx b/packages/twenty-docs/l/cs/developers/extend/apps/building.mdx new file mode 100644 index 00000000000..d0de4f1acfd --- /dev/null +++ b/packages/twenty-docs/l/cs/developers/extend/apps/building.mdx @@ -0,0 +1,689 @@ +--- +title: Vytváření aplikací +description: Definujte objekty, logické funkce, frontendové komponenty a další pomocí Twenty SDK. +--- + + +Aplikace jsou aktuálně v alfa testování. Tato funkce je funkční, ale stále se vyvíjí. + + +## Používejte zdroje SDK (typy a konfiguraci) + +twenty-sdk poskytuje typované stavební bloky a pomocné funkce, které používáte ve své aplikaci. Níže jsou klíčové části, se kterými budete nejčastěji pracovat. + +### Pomocné funkce + +SDK poskytuje pomocné funkce pro definování entit vaší aplikace. Jak je popsáno v [Detekce entit](/l/cs/developers/extend/apps/getting-started#entity-detection), musíte použít `export default define({...})`, aby byly vaše entity detekovány: + +| Funkce | Účel | +| -------------------------------- | ----------------------------------------------------------------- | +| `defineApplication` | Nakonfigurujte metadata aplikace (povinné, jedno na aplikaci) | +| `defineObject` | Definice vlastních objektů s poli | +| `defineLogicFunction` | Definice logických funkcí s obslužnými funkcemi | +| `definePreInstallLogicFunction` | Definujte předinstalační logickou funkci (jedna na aplikaci) | +| `definePostInstallLogicFunction` | Definujte postinstalační logickou funkci (jedna na aplikaci) | +| `defineFrontComponent` | Definujte frontendové komponenty pro vlastní uživatelské rozhraní | +| `defineRole` | Konfigurace oprávnění rolí a přístupu k objektům | +| `defineField` | Rozšiřte existující objekty o další pole | +| `defineView` | Definujte uložená zobrazení pro objekty | +| `defineNavigationMenuItem` | Definujte odkazy postranní navigace | +| `defineSkill` | Definujte dovednosti agenta AI | + +Tyto funkce validují vaši konfiguraci v době sestavení a poskytují automatické doplňování v IDE a typovou bezpečnost. + +### Definování objektů + +Vlastní objekty popisují jak schéma, tak chování záznamů ve vašem pracovním prostoru. K definování objektů s vestavěnou validací použijte `defineObject()`: + +```typescript +// src/app/postCard.object.ts +import { defineObject, FieldType } from 'twenty-sdk'; + +enum PostCardStatus { + DRAFT = 'DRAFT', + SENT = 'SENT', + DELIVERED = 'DELIVERED', + RETURNED = 'RETURNED', +} + +export default defineObject({ + universalIdentifier: '54b589ca-eeed-4950-a176-358418b85c05', + nameSingular: 'postCard', + namePlural: 'postCards', + labelSingular: 'Post Card', + labelPlural: 'Post Cards', + description: 'A post card object', + icon: 'IconMail', + fields: [ + { + universalIdentifier: '58a0a314-d7ea-4865-9850-7fb84e72f30b', + name: 'content', + type: FieldType.TEXT, + label: 'Content', + description: "Postcard's content", + icon: 'IconAbc', + }, + { + universalIdentifier: 'c6aa31f3-da76-4ac6-889f-475e226009ac', + name: 'recipientName', + type: FieldType.FULL_NAME, + label: 'Recipient name', + icon: 'IconUser', + }, + { + universalIdentifier: '95045777-a0ad-49ec-98f9-22f9fc0c8266', + name: 'recipientAddress', + type: FieldType.ADDRESS, + label: 'Recipient address', + icon: 'IconHome', + }, + { + universalIdentifier: '87b675b8-dd8c-4448-b4ca-20e5a2234a1e', + name: 'status', + type: FieldType.SELECT, + label: 'Status', + icon: 'IconSend', + defaultValue: `'${PostCardStatus.DRAFT}'`, + options: [ + { value: PostCardStatus.DRAFT, label: 'Draft', position: 0, color: 'gray' }, + { value: PostCardStatus.SENT, label: 'Sent', position: 1, color: 'orange' }, + { value: PostCardStatus.DELIVERED, label: 'Delivered', position: 2, color: 'green' }, + { value: PostCardStatus.RETURNED, label: 'Returned', position: 3, color: 'orange' }, + ], + }, + { + universalIdentifier: 'e06abe72-5b44-4e7f-93be-afc185a3c433', + name: 'deliveredAt', + type: FieldType.DATE_TIME, + label: 'Delivered at', + icon: 'IconCheck', + isNullable: true, + defaultValue: null, + }, + ], +}); +``` + +Hlavní body: + +* Použijte `defineObject()` pro vestavěnou validaci a lepší podporu v IDE. +* Hodnota `universalIdentifier` musí být jedinečná a stabilní napříč nasazeními. +* Každé pole vyžaduje `name`, `type`, `label` a svůj vlastní stabilní `universalIdentifier`. +* Pole `fields` je volitelné — objekty můžete definovat i bez vlastních polí. +* Nové objekty můžete vygenerovat pomocí `yarn twenty entity:add`, který vás provede pojmenováním, poli a vztahy. + + +**Základní pole jsou vytvořena automaticky.** Když definujete vlastní objekt, Twenty automaticky přidá standardní pole +jako `id`, `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy` a `deletedAt`. +Nemusíte je definovat v poli `fields` — přidejte pouze svá vlastní pole. +Výchozí pole můžete přepsat definováním pole se stejným názvem v poli `fields`, +ale to se nedoporučuje. + + +### Konfigurace aplikace (application-config.ts) + +Každá aplikace má jeden soubor `application-config.ts`, který popisuje: + +* **Identitu aplikace**: identifikátory, zobrazovaný název a popis. +* **Jak běží její funkce**: kterou roli používají pro oprávnění. +* **(Volitelné) proměnné**: dvojice klíč–hodnota zpřístupněné vašim funkcím jako proměnné prostředí. +* **(Volitelná) předinstalační funkce**: logická funkce, která se spouští před instalací aplikace. +* **(Volitelná) postinstalační funkce**: logická funkce, která se spouští po instalaci aplikace. + +K definování konfigurace aplikace použijte `defineApplication()`: + +```typescript +// src/application-config.ts +import { defineApplication } from 'twenty-sdk'; +import { DEFAULT_ROLE_UNIVERSAL_IDENTIFIER } from 'src/roles/default-role'; + +export default defineApplication({ + universalIdentifier: '4ec0391d-18d5-411c-b2f3-266ddc1c3ef7', + displayName: 'My Twenty App', + description: 'My first Twenty app', + icon: 'IconWorld', + applicationVariables: { + DEFAULT_RECIPIENT_NAME: { + universalIdentifier: '19e94e59-d4fe-4251-8981-b96d0a9f74de', + description: 'Default recipient name for postcards', + value: 'Jane Doe', + isSecret: false, + }, + }, + defaultRoleUniversalIdentifier: DEFAULT_ROLE_UNIVERSAL_IDENTIFIER, +}); +``` + +Poznámky: + +* Pole `universalIdentifier` jsou deterministická ID, která vlastníte; vygenerujte je jednou a udržujte je stabilní napříč synchronizacemi. +* `applicationVariables` se stanou proměnnými prostředí pro vaše funkce (například `DEFAULT_RECIPIENT_NAME` je dostupné jako `process.env.DEFAULT_RECIPIENT_NAME`). +* `defaultRoleUniversalIdentifier` se musí shodovat se souborem role (viz níže). +* Předinstalační a postinstalační funkce jsou při sestavování manifestu automaticky detekovány. Viz [Předinstalační funkce](#pre-install-functions) a [Postinstalační funkce](#post-install-functions). + +#### Role a oprávnění + +Aplikace mohou definovat role, které zapouzdřují oprávnění k objektům a akcím ve vašem pracovním prostoru. Pole `defaultRoleUniversalIdentifier` v `application-config.ts` určuje výchozí roli používanou logickými funkcemi vaší aplikace. + +* Běhový klíč API vložený jako `TWENTY_API_KEY` je odvozen z této výchozí role funkcí. +* Typovaný klient bude omezen oprávněními udělenými této roli. +* Dodržujte princip nejmenších oprávnění: vytvořte vyhrazenou roli pouze s oprávněními, která vaše funkce potřebují, a poté odkazujte na její univerzální identifikátor. + +##### Výchozí role funkce (*.role.ts) + +Když vygenerujete novou aplikaci, CLI také vytvoří výchozí soubor role. K definování rolí s vestavěnou validací použijte `defineRole()`: + +```typescript +// src/roles/default-role.ts +import { defineRole, PermissionFlag } from 'twenty-sdk'; + +export const DEFAULT_ROLE_UNIVERSAL_IDENTIFIER = + 'b648f87b-1d26-4961-b974-0908fd991061'; + +export default defineRole({ + universalIdentifier: DEFAULT_ROLE_UNIVERSAL_IDENTIFIER, + label: 'Default function role', + description: 'Default role for function Twenty client', + canReadAllObjectRecords: false, + canUpdateAllObjectRecords: false, + canSoftDeleteAllObjectRecords: false, + canDestroyAllObjectRecords: false, + canUpdateAllSettings: false, + canBeAssignedToAgents: false, + canBeAssignedToUsers: false, + canBeAssignedToApiKeys: false, + objectPermissions: [ + { + objectUniversalIdentifier: '9f9882af-170c-4879-b013-f9628b77c050', + canReadObjectRecords: true, + canUpdateObjectRecords: true, + canSoftDeleteObjectRecords: false, + canDestroyObjectRecords: false, + }, + ], + fieldPermissions: [ + { + objectUniversalIdentifier: '9f9882af-170c-4879-b013-f9628b77c050', + fieldUniversalIdentifier: 'b2c37dc0-8ae7-470e-96cd-1476b47dfaff', + canReadFieldValue: false, + canUpdateFieldValue: false, + }, + ], + permissionFlags: [PermissionFlag.APPLICATIONS], +}); +``` + +Na `universalIdentifier` této role se poté odkazuje v `application-config.ts` jako na `defaultRoleUniversalIdentifier`. Jinými slovy: + +* **\*.role.ts** definuje, co může výchozí role funkce dělat. +* **application-config.ts** ukazuje na tuto roli, aby vaše funkce zdědily její oprávnění. + +Poznámky: + +* Začněte rolí vytvořenou scaffolderem a postupně ji omezujte podle principu nejmenších oprávnění. +* Nahraďte `objectPermissions` a `fieldPermissions` objekty/poli, která vaše funkce potřebují. +* `permissionFlags` řídí přístup k schopnostem na úrovni platformy. Držte je na minimu; přidávejte pouze to, co potřebujete. +* Podívejte se na funkční příklad v aplikaci Hello World: [`packages/twenty-apps/hello-world/src/roles/function-role.ts`](https://github.com/twentyhq/twenty/blob/main/packages/twenty-apps/hello-world/src/roles/function-role.ts). + +### Konfigurace logických funkcí a vstupní bod + +Každý soubor funkce používá `defineLogicFunction()` k exportu konfigurace s obslužnou funkcí (handlerem) a volitelnými spouštěči. + +```typescript +// src/app/createPostCard.logic-function.ts +import { defineLogicFunction } from 'twenty-sdk'; +import type { DatabaseEventPayload, ObjectRecordCreateEvent, CronPayload, RoutePayload } from 'twenty-sdk'; +import { CoreApiClient, type Person } from 'twenty-sdk/generated'; + +const handler = async (params: RoutePayload) => { + const client = new CoreApiClient(); + const name = 'name' in params.queryStringParameters + ? params.queryStringParameters.name ?? process.env.DEFAULT_RECIPIENT_NAME ?? 'Hello world' + : 'Hello world'; + + const result = await client.mutation({ + createPostCard: { + __args: { data: { name } }, + id: true, + name: true, + }, + }); + return result; +}; + +export default defineLogicFunction({ + universalIdentifier: 'e56d363b-0bdc-4d8a-a393-6f0d1c75bdcf', + name: 'create-new-post-card', + timeoutSeconds: 2, + handler, + triggers: [ + // Public HTTP route trigger '/s/post-card/create' + { + universalIdentifier: 'c9f84c8d-b26d-40d1-95dd-4f834ae5a2c6', + type: 'route', + path: '/post-card/create', + httpMethod: 'GET', + isAuthRequired: false, + }, + // Cron trigger (CRON pattern) + // { + // universalIdentifier: 'dd802808-0695-49e1-98c9-d5c9e2704ce2', + // type: 'cron', + // pattern: '0 0 1 1 *', + // }, + // Database event trigger + // { + // universalIdentifier: '203f1df3-4a82-4d06-a001-b8cf22a31156', + // type: 'databaseEvent', + // eventName: 'person.updated', + // updatedFields: ['name'], + // }, + ], +}); +``` + +Běžné typy spouštěčů: + +* **route**: Zpřístupní vaši funkci na HTTP cestě a metodě **pod koncovým bodem `/s/`**: + +> např. `path: '/post-card/create',` -> volání na `/s/post-card/create` + +* **cron**: Spouští vaši funkci podle plánu pomocí výrazu CRON. +* **databaseEvent**: Spouští se při událostech životního cyklu objektů v pracovním prostoru. Když je operace události `updated`, lze konkrétní sledovaná pole určit v poli `updatedFields`. Pokud zůstane nedefinované nebo prázdné, spustí funkci jakákoli aktualizace. + +> např. `person.updated` + +Poznámky: + +* Pole `triggers` je volitelné. Funkce bez spouštěčů lze použít jako pomocné funkce volané jinými funkcemi. +* V jedné funkci můžete kombinovat více typů spouštěčů. + +### Předinstalační funkce + +Předinstalační funkce je logická funkce, která se automaticky spouští před instalací vaší aplikace v pracovním prostoru. To je užitečné pro validační úlohy, kontrolu předpokladů nebo přípravu stavu pracovního prostoru před zahájením hlavní instalace. + +Když vygenerujete kostru nové aplikace pomocí `create-twenty-app`, vytvoří se pro vás předinstalační funkce v `src/logic-functions/pre-install.ts`: + +```typescript +// src/logic-functions/pre-install.ts +import { definePreInstallLogicFunction, type InstallLogicFunctionPayload } from 'twenty-sdk'; + +const handler = async (payload: InstallLogicFunctionPayload): Promise => { + console.log('Pre install logic function executed successfully!', payload.previousVersion); +}; + +export default definePreInstallLogicFunction({ + universalIdentifier: '', + name: 'pre-install', + description: 'Runs before installation to prepare the application.', + timeoutSeconds: 300, + handler, +}); +``` + +Předinstalační funkci můžete také kdykoli spustit ručně pomocí CLI: + +```bash filename="Terminal" +yarn twenty function:execute --preInstall +``` + +Hlavní body: + +* Předinstalační funkce používají `definePreInstallLogicFunction()` — specializovanou variantu, která vynechává nastavení spouštěčů (`cronTriggerSettings`, `databaseEventTriggerSettings`, `httpRouteTriggerSettings`, `isTool`). +* Obslužná funkce (handler) obdrží `InstallLogicFunctionPayload` s `{ previousVersion: string }` — verzi aplikace, která byla dříve nainstalována (nebo prázdný řetězec při čisté instalaci). +* Na jednu aplikaci je povolena pouze jedna předinstalační funkce. Sestavení manifestu skončí chybou, pokud je zjištěna více než jedna. +* Identifikátor `universalIdentifier` funkce se během sestavení automaticky nastaví v manifestu aplikace jako `preInstallLogicFunctionUniversalIdentifier` — není potřeba jej uvádět v `defineApplication()`. +* Výchozí časový limit je nastaven na 300 sekund (5 minut), aby umožnil delší přípravné úlohy. +* Předinstalační funkce nepotřebují spouštěče — platforma je vyvolává před instalací nebo je lze spustit ručně pomocí `function:execute --preInstall`. + +### Postinstalační funkce + +Postinstalační funkce je logická funkce, která se automaticky spouští po instalaci vaší aplikace do pracovního prostoru. To je užitečné pro jednorázové úlohy nastavení, jako je naplnění výchozími daty, vytvoření počátečních záznamů nebo konfigurace nastavení pracovního prostoru. + +Když vygenerujete kostru nové aplikace pomocí `create-twenty-app`, vytvoří se pro vás postinstalační funkce v `src/logic-functions/post-install.ts`: + +```typescript +// src/logic-functions/post-install.ts +import { definePostInstallLogicFunction, type InstallLogicFunctionPayload } from 'twenty-sdk'; + +const handler = async (payload: InstallLogicFunctionPayload): Promise => { + console.log('Post install logic function executed successfully!', payload.previousVersion); +}; + +export default definePostInstallLogicFunction({ + universalIdentifier: '', + name: 'post-install', + description: 'Runs after installation to set up the application.', + timeoutSeconds: 300, + handler, +}); +``` + +Postinstalační funkci můžete také kdykoli spustit ručně pomocí CLI: + +```bash filename="Terminal" +yarn twenty function:execute --postInstall +``` + +Hlavní body: + +* Postinstalační funkce používají `definePostInstallLogicFunction()` — specializovanou variantu, která vynechává nastavení spouštěčů (`cronTriggerSettings`, `databaseEventTriggerSettings`, `httpRouteTriggerSettings`, `isTool`). +* Obslužná funkce (handler) obdrží `InstallLogicFunctionPayload` s `{ previousVersion: string }` — verzi aplikace, která byla dříve nainstalována (nebo prázdný řetězec při čisté instalaci). +* Na jednu aplikaci je povolena pouze jedna postinstalační funkce. Sestavení manifestu skončí chybou, pokud je zjištěna více než jedna. +* Identifikátor `universalIdentifier` funkce se během sestavení automaticky nastaví v manifestu aplikace jako `postInstallLogicFunctionUniversalIdentifier` — není potřeba jej uvádět v `defineApplication()`. +* Výchozí časový limit je nastaven na 300 sekund (5 minut), aby umožnil delší úlohy nastavení, jako je naplnění daty. +* Postinstalační funkce nepotřebují spouštěče — jsou spouštěny platformou během instalace nebo ručně pomocí `function:execute --postInstall`. + +### Payload spouštěče trasy + + +**Zpětně nekompatibilní změna (v1.16, leden 2026):** Formát payloadu spouštěče trasy se změnil. Před verzí v1.16 byly parametry dotazu, parametry cesty a tělo odesílány přímo jako payload. Od verze v1.16 jsou zanořeny uvnitř strukturovaného objektu `RoutePayload`. + +**Před v1.16:** +```typescript +const handler = async (params) => { + const { param1, param2 } = params; // Direct access +}; +``` + +**Po v1.16:** +```typescript +const handler = async (event: RoutePayload) => { + const { param1, param2 } = event.body; // Access via .body + const { queryParam } = event.queryStringParameters; + const { id } = event.pathParameters; +}; +``` + +**Jak migrovat existující funkce:** Aktualizujte svůj handler tak, aby destrukturoval z `event.body`, `event.queryStringParameters` nebo `event.pathParameters` místo přímo z objektu params. + + +Když spouštěč trasy vyvolá vaši logickou funkci, ta obdrží objekt `RoutePayload`, který odpovídá formátu AWS HTTP API v2. Importujte typ z `twenty-sdk`: + +```typescript +import { defineLogicFunction, type RoutePayload } from 'twenty-sdk'; + +const handler = async (event: RoutePayload) => { + // Access request data + const { headers, queryStringParameters, pathParameters, body } = event; + + // HTTP method and path are available in requestContext + const { method, path } = event.requestContext.http; + + return { message: 'Success' }; +}; +``` + +Typ `RoutePayload` má následující strukturu: + +| Vlastnost | Typ | Popis | +| ---------------------------- | ------------------------------------- | --------------------------------------------------------------------------------- | +| `headers` | `Record` | Záhlaví HTTP (pouze ta uvedená v `forwardedRequestHeaders`) | +| `queryStringParameters` | `Record` | Parametry query stringu (více hodnot spojených čárkami) | +| `pathParameters` | `Record` | Parametry cesty extrahované ze vzoru trasy (např. `/users/:id` → `{ id: '123' }`) | +| `body` | `object \| null` | Parsované tělo požadavku (JSON) | +| `isBase64Encoded` | `boolean` | Zda je tělo kódováno base64 | +| `requestContext.http.method` | `string` | Metoda HTTP (GET, POST, PUT, PATCH, DELETE) | +| `requestContext.http.path` | `string` | Nezpracovaná cesta požadavku | + +### Přeposílání záhlaví HTTP + +Ve výchozím nastavení se záhlaví HTTP z příchozích požadavků z bezpečnostních důvodů do vaší logické funkce **ne** předávají. Chcete-li zpřístupnit konkrétní záhlaví, výslovně je uveďte v poli `forwardedRequestHeaders`: + +```typescript +export default defineLogicFunction({ + universalIdentifier: 'e56d363b-0bdc-4d8a-a393-6f0d1c75bdcf', + name: 'webhook-handler', + handler, + triggers: [ + { + universalIdentifier: 'c9f84c8d-b26d-40d1-95dd-4f834ae5a2c6', + type: 'route', + path: '/webhook', + httpMethod: 'POST', + isAuthRequired: false, + forwardedRequestHeaders: ['x-webhook-signature', 'content-type'], + }, + ], +}); +``` + +Ve vašem handleru k nim poté můžete přistupovat: + +```typescript +const handler = async (event: RoutePayload) => { + const signature = event.headers['x-webhook-signature']; + const contentType = event.headers['content-type']; + + // Validate webhook signature... + return { received: true }; +}; +``` + + + Názvy záhlaví jsou normalizovány na malá písmena. Přistupujte k nim pomocí klíčů s malými písmeny (například `event.headers['content-type']`). + + +Nové funkce můžete vytvářet dvěma způsoby: + +* **Vygenerované**: Spusťte `yarn twenty entity:add` a zvolte možnost přidat novou logickou funkci. Tím se vygeneruje startovací soubor s obslužnou funkcí a konfigurací. +* **Ruční**: Vytvořte nový soubor `*.logic-function.ts` a použijte `defineLogicFunction()` podle stejného vzoru. + +### Označení logické funkce jako nástroje + +Logické funkce lze zpřístupnit jako **nástroje** pro agenty AI a pracovní postupy. Když je funkce označena jako nástroj, stane se dohledatelnou funkcemi AI produktu Twenty a lze ji vybrat jako krok v automatizacích pracovních postupů. + +Chcete-li označit logickou funkci jako nástroj, nastavte `isTool: true` a poskytněte `toolInputSchema` popisující očekávané vstupní parametry pomocí [JSON Schema](https://json-schema.org/): + +```typescript +// src/logic-functions/enrich-company.logic-function.ts +import { defineLogicFunction } from 'twenty-sdk'; +import { CoreApiClient } from 'twenty-sdk/generated'; + +const handler = async (params: { companyName: string; domain?: string }) => { + const client = new CoreApiClient(); + + const result = await client.mutation({ + createTask: { + __args: { + data: { + title: `Enrich data for ${params.companyName}`, + body: `Domain: ${params.domain ?? 'unknown'}`, + }, + }, + id: true, + }, + }); + + return { taskId: result.createTask.id }; +}; + +export default defineLogicFunction({ + universalIdentifier: 'f47ac10b-58cc-4372-a567-0e02b2c3d479', + name: 'enrich-company', + description: 'Enrich a company record with external data', + timeoutSeconds: 10, + handler, + isTool: true, + toolInputSchema: { + type: 'object', + properties: { + companyName: { + type: 'string', + description: 'The name of the company to enrich', + }, + domain: { + type: 'string', + description: 'The company website domain (optional)', + }, + }, + required: ['companyName'], + }, +}); +``` + +Hlavní body: + +* **`isTool`** (`boolean`, výchozí: `false`): Když je nastaveno na `true`, funkce je zaregistrována jako nástroj a zpřístupní se agentům AI a automatizacím pracovních postupů. +* **`toolInputSchema`** (`object`, volitelné): Objekt JSON Schema, který popisuje parametry, jež vaše funkce přijímá. Agenti AI používají toto schéma k pochopení toho, jaké vstupy nástroj očekává, a k ověřování volání. Pokud je vynecháno, schéma má výchozí podobu `{ type: 'object', properties: {} }` (žádné parametry). +* Funkce s `isTool: false` (nebo není nastaveno) **nejsou** zpřístupněny jako nástroje. Stále je lze spouštět přímo nebo volat z jiných funkcí, ale neobjeví se ve vyhledávání nástrojů. +* **Pojmenování nástrojů**: Když je funkce zpřístupněna jako nástroj, její název se automaticky normalizuje na `logic_function_` (převedeno na malá písmena, nealfanumerické znaky jsou nahrazeny podtržítky). Například `enrich-company` se změní na `logic_function_enrich_company`. +* Můžete kombinovat `isTool` se spouštěči — funkce může být zároveň nástrojem (volatelným agenty AI) i spouštěna událostmi (cron, databázové události, routes). + + +**Napište kvalitní `description`.** Agenti AI se spoléhají na pole funkce `description` při rozhodování, kdy nástroj použít. Buďte konkrétní ohledně toho, co nástroj dělá a kdy se má volat. + + +### Frontendové komponenty + +Frontendové komponenty vám umožňují vytvářet vlastní React komponenty, které se vykreslují v rozhraní Twenty. K definování komponent s vestavěnou validací použijte `defineFrontComponent()`: + +```typescript +// src/front-components/my-widget.tsx +import { defineFrontComponent } from 'twenty-sdk'; + +const MyWidget = () => { + return ( +
+

My Custom Widget

+

This is a custom front component for Twenty.

+
+ ); +}; + +export default defineFrontComponent({ + universalIdentifier: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890', + name: 'my-widget', + description: 'A custom widget component', + component: MyWidget, +}); +``` + +Hlavní body: + +* Frontendové komponenty jsou React komponenty, které se vykreslují v izolovaných kontextech v rámci Twenty. +* Pole `component` odkazuje na vaši React komponentu. +* Komponenty se během `yarn twenty dev` automaticky sestaví a synchronizují. + +Nové frontendové komponenty můžete vytvořit dvěma způsoby: + +* **Vygenerované**: Spusťte `yarn twenty entity:add` a zvolte možnost přidat novou frontendovou komponentu. +* **Ruční**: Vytvořte nový soubor `.tsx` a použijte `defineFrontComponent()`, podle stejného vzoru. + +### Dovednosti + +Dovednosti definují znovupoužitelné pokyny a schopnosti, které mohou agenti AI používat ve vašem pracovním prostoru. K definování dovedností s vestavěnou validací použijte `defineSkill()`: + +```typescript +// src/skills/example-skill.ts +import { defineSkill } from 'twenty-sdk'; + +export default defineSkill({ + universalIdentifier: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890', + name: 'sales-outreach', + label: 'Sales Outreach', + description: 'Guides the AI agent through a structured sales outreach process', + icon: 'IconBrain', + content: `You are a sales outreach assistant. When reaching out to a prospect: +1. Research the company and recent news +2. Identify the prospect's role and likely pain points +3. Draft a personalized message referencing specific details +4. Keep the tone professional but conversational`, +}); +``` + +Hlavní body: + +* `name` je jedinečný identifikátor dovednosti (doporučuje se kebab-case). +* `label` je uživatelsky čitelný název zobrazovaný v UI. +* `content` obsahuje pokyny dovednosti — je to text, který agent AI používá. +* `icon` (volitelné) nastavuje ikonu zobrazovanou v UI. +* `description` (volitelné) poskytuje doplňující kontext o účelu dovednosti. + +Nové dovednosti můžete vytvářet dvěma způsoby: + +* **Vygenerované**: Spusťte `yarn twenty entity:add` a zvolte možnost přidat novou dovednost. +* **Ruční**: Vytvořte nový soubor a použijte `defineSkill()` podle stejného vzoru. + +### Generované typované klienty + +Dva typovaní klienti jsou automaticky generováni pomocí `yarn twenty dev` a ukládají se do `node_modules/twenty-sdk/generated` podle schématu vašeho pracovního prostoru: + +* **`CoreApiClient`** — provádí dotazy na endpoint `/graphql` za účelem získání dat pracovního prostoru +* **`MetadataApiClient`** — odesílá dotazy na endpoint `/metadata` pro konfiguraci pracovního prostoru a nahrávání souborů + +```typescript +import { CoreApiClient, MetadataApiClient } from 'twenty-sdk/generated'; + +const client = new CoreApiClient(); +const { me } = await client.query({ me: { id: true, displayName: true } }); + +const metadataClient = new MetadataApiClient(); +const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); +``` + +Oba klienti se automaticky znovu generují pomocí `yarn twenty dev` kdykoli se změní vaše objekty nebo pole. + +#### Běhové přihlašovací údaje v logických funkcích + +Když vaše funkce běží na Twenty, platforma před spuštěním kódu vloží přihlašovací údaje jako proměnné prostředí: + +* `TWENTY_API_URL`: Základní URL Twenty API, na které vaše aplikace cílí. +* `TWENTY_API_KEY`: Krátkodobý klíč s rozsahem omezeným na výchozí roli funkce vaší aplikace. + +Poznámky: + +* Není nutné předávat URL ani klíč API vygenerovanému klientovi. Za běhu čte `TWENTY_API_URL` a `TWENTY_API_KEY` z process.env. +* Oprávnění klíče API jsou určena rolí odkazovanou ve vašem `application-config.ts` prostřednictvím `defaultRoleUniversalIdentifier`. Toto je výchozí role používaná logickými funkcemi vaší aplikace. +* Aplikace mohou definovat role podle principu nejmenších oprávnění. Udělte pouze oprávnění, která vaše funkce potřebují, a poté nastavte `defaultRoleUniversalIdentifier` na univerzální identifikátor této role. + +#### Nahrávání souborů + +Vygenerovaný `MetadataApiClient` obsahuje metodu `uploadFile` pro připojování souborů k polím typu souboru u objektů ve vašem pracovním prostoru. Protože standardní klienti GraphQL nativně nepodporují nahrávání souborů pomocí multipart, klient poskytuje tuto speciální metodu, která interně implementuje [specifikaci multipart požadavků GraphQL](https://github.com/jaydenseric/graphql-multipart-request-spec). + +```typescript +import { MetadataApiClient } from 'twenty-sdk/generated'; +import * as fs from 'fs'; + +const metadataClient = new MetadataApiClient(); + +const fileBuffer = fs.readFileSync('./invoice.pdf'); + +const uploadedFile = await metadataClient.uploadFile( + fileBuffer, // file contents as a Buffer + 'invoice.pdf', // filename + 'application/pdf', // MIME type (defaults to 'application/octet-stream') + '58a0a314-d7ea-4865-9850-7fb84e72f30b', // field universal identifier +); + +console.log(uploadedFile); +// { id: '...', path: '...', size: 12345, createdAt: '...', url: 'https://...' } +``` + +Signatura metody: + +```typescript +uploadFile( + fileBuffer: Buffer, + filename: string, + contentType: string, + fieldMetadataUniversalIdentifier: string, +): Promise<{ id: string; path: string; size: number; createdAt: string; url: string }> +``` + +| Parametr | Typ | Popis | +| ---------------------------------- | -------- | --------------------------------------------------------------------------- | +| `fileBuffer` | `Buffer` | Surový obsah souboru | +| `filename` | `string` | Název souboru (používá se pro ukládání a zobrazení) | +| `contentType` | `string` | Typ MIME souboru (pokud je vynechán, výchozí je `application/octet-stream`) | +| `fieldMetadataUniversalIdentifier` | `string` | `universalIdentifier` pole typu souboru ve vašem objektu | + +Hlavní body: + +* Metoda `uploadFile` je k dispozici v `MetadataApiClient`, protože mutaci nahrávání obsluhuje endpoint `/metadata`. +* Používá `universalIdentifier` pole (nikoli jeho ID specifické pro pracovní prostor), takže váš kód pro nahrávání funguje ve všech pracovních prostorech, kde je vaše aplikace nainstalována — v souladu s tím, jak aplikace odkazují na pole všude jinde. +* Vrácená hodnota `url` je podepsaná adresa URL, kterou můžete použít k přístupu k nahranému souboru. + +### Příklad Hello World + +Prozkoumejte minimalistický end-to-end příklad, který demonstruje objekty, logické funkce, frontendové komponenty a více spouštěčů [zde](https://github.com/twentyhq/twenty/tree/main/packages/twenty-apps/hello-world). diff --git a/packages/twenty-docs/l/cs/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/cs/developers/extend/apps/getting-started.mdx new file mode 100644 index 00000000000..95ef5188d90 --- /dev/null +++ b/packages/twenty-docs/l/cs/developers/extend/apps/getting-started.mdx @@ -0,0 +1,245 @@ +--- +title: Začínáme +description: Vytvořte svou první aplikaci Twenty během několika minut. +--- + + +Aplikace jsou aktuálně v alfa testování. Tato funkce je funkční, ale stále se vyvíjí. + + +Aplikace vám umožňují rozšířit Twenty o vlastní objekty, pole, logické funkce, AI schopnosti a komponenty uživatelského rozhraní — vše je spravováno jako kód. + +**Co můžete dělat už dnes:** + +* Definujte vlastní objekty a pole jako kód (spravovaný datový model) +* Vytvářejte logické funkce s vlastními spouštěči (HTTP routy, cron, databázové události) +* Definujte dovednosti agentů AI +* Vytvářejte frontendové komponenty, které se vykreslují uvnitř uživatelského rozhraní Twenty +* Nasazujte stejnou aplikaci do více pracovních prostorů + +## Předpoklady + +* Node.js 24+ a Yarn 4 +* Docker (pro místní vývojový server Twenty) + +## Začínáme + +Vytvořte novou aplikaci pomocí oficiálního scaffolderu, poté se ověřte a začněte vyvíjet: + +```bash filename="Terminal" +# Scaffold a new app (includes all examples by default) +npx create-twenty-app@latest my-twenty-app +cd my-twenty-app + +# Start dev mode: automatically syncs local changes to your workspace +yarn twenty dev +``` + +Nástroj pro generování kostry podporuje dva režimy pro řízení toho, které ukázkové soubory jsou zahrnuty: + +```bash filename="Terminal" +# Default (exhaustive): all examples (object, field, logic function, front component, view, navigation menu item, skill, agent) +npx create-twenty-app@latest my-app + +# Minimal: only core files (application-config.ts and default-role.ts) +npx create-twenty-app@latest my-app --minimal +``` + +Odtud můžete: + +```bash filename="Terminal" +# Add a new entity to your application (guided) +yarn twenty entity:add + +# Watch your application's function logs +yarn twenty function:logs + +# Execute a function by name +yarn twenty function:execute -n my-function -p '{"name": "test"}' + +# Execute the pre-install function +yarn twenty function:execute --preInstall + +# Execute the post-install function +yarn twenty function:execute --postInstall + +# Uninstall the application from the current workspace +yarn twenty uninstall + +# Display commands' help +yarn twenty help +``` + +Viz také: referenční stránky CLI pro [create-twenty-app](https://www.npmjs.com/package/create-twenty-app) a [twenty-sdk CLI](https://www.npmjs.com/package/twenty-sdk). + +## Struktura projektu (vytvořená scaffolderem) + +Když spustíte `npx create-twenty-app@latest my-twenty-app`, scaffolder: + +* Zkopíruje minimální základní aplikaci do `my-twenty-app/` +* Přidá lokální závislost `twenty-sdk` a konfiguraci pro Yarn 4 +* Vytvoří konfigurační soubory a skripty napojené na `twenty` CLI +* Vygeneruje základní soubory (konfigurace aplikace, výchozí role funkcí, předinstalační a postinstalační funkce) a k nim ukázkové soubory podle zvoleného režimu generování kostry + +Čerstvě vygenerovaná aplikace s výchozím režimem `--exhaustive` vypadá takto: + +```text filename="my-twenty-app/" +my-twenty-app/ + package.json + yarn.lock + .gitignore + .nvmrc + .yarnrc.yml + .yarn/ + install-state.gz + .oxlintrc.json + tsconfig.json + README.md + public/ # Public assets folder (images, fonts, etc.) + src/ + ├── application-config.ts # Required - main application configuration + ├── roles/ + │ └── default-role.ts # Default role for logic functions + ├── objects/ + │ └── example-object.ts # Example custom object definition + ├── fields/ + │ └── example-field.ts # Example standalone field definition + ├── logic-functions/ + │ ├── hello-world.ts # Example logic function + │ ├── pre-install.ts # Pre-install logic function + │ └── post-install.ts # Post-install logic function + ├── front-components/ + │ └── hello-world.tsx # Example front component + ├── views/ + │ └── example-view.ts # Example saved view definition + ├── navigation-menu-items/ + │ └── example-navigation-menu-item.ts # Example sidebar navigation link + └── skills/ + └── example-skill.ts # Example AI agent skill definition +``` + +S volbou `--minimal` se vytvoří pouze základní soubory (`application-config.ts`, `roles/default-role.ts`, `logic-functions/pre-install.ts` a `logic-functions/post-install.ts`). + +V kostce: + +* **package.json**: Deklaruje název aplikace, verzi, engines (Node 24+, Yarn 4) a přidává `twenty-sdk` plus skript `twenty`, který deleguje na lokální `twenty` CLI. Spusťte `yarn twenty help` pro výpis všech dostupných příkazů. +* **.gitignore**: Ignoruje běžné artefakty jako `node_modules`, `.yarn`, `generated/` (typovaný klient), `dist/`, `build/`, složky s coverage, logy a soubory `.env*`. +* **yarn.lock**, **.yarnrc.yml**, **.yarn/**: Zamykají a konfigurují nástrojový řetězec Yarn 4 používaný projektem. +* **.nvmrc**: Fixuje verzi Node.js požadovanou projektem. +* **.oxlintrc.json** a **tsconfig.json**: Poskytují lintování a konfiguraci TypeScriptu pro zdrojové soubory vaší aplikace v TypeScriptu. +* **README.md**: Krátké README v kořeni aplikace se základními pokyny. +* **public/**: Složka pro ukládání veřejných prostředků (obrázky, písma, statické soubory), které bude vaše aplikace poskytovat. Soubory umístěné zde se během synchronizace nahrají a jsou za běhu dostupné. +* **src/**: Hlavní místo, kde definujete svou aplikaci jako kód + +### Detekce entit + +SDK detekuje entity analýzou vašich souborů TypeScript a hledá volání **`export default define({...})`**. Každý typ entity má odpovídající pomocnou funkci exportovanou z `twenty-sdk`: + +| Pomocná funkce | Typ entity | +| -------------------------------- | --------------------------------------------------------- | +| `defineObject` | Definice vlastních objektů | +| `defineLogicFunction` | Definice logických funkcí | +| `definePreInstallLogicFunction` | Předinstalační logická funkce (spouští se před instalací) | +| `definePostInstallLogicFunction` | Postinstalační logická funkce (spouští se po instalaci) | +| `defineFrontComponent` | Definice frontendových komponent | +| `defineRole` | Definice rolí | +| `defineField` | Rozšíření polí u existujících objektů | +| `defineView` | Definice uložených zobrazení | +| `defineNavigationMenuItem` | Definice položek navigační nabídky | +| `defineSkill` | Definice dovedností agenta AI | + + +**Pojmenování souborů je flexibilní.** Detekce entit je založená na AST — SDK prochází vaše zdrojové soubory a hledá vzor `export default define({...})`. Soubory a složky můžete organizovat, jak chcete. Seskupování podle typu entity (např. `logic-functions/`, `roles/`) je pouze konvence pro organizaci kódu, nikoli požadavek. + + +Příklad detekované entity: + +```typescript +// This file can be named anything and placed anywhere in src/ +import { defineObject, FieldType } from 'twenty-sdk'; + +export default defineObject({ + universalIdentifier: '...', + nameSingular: 'postCard', + // ... rest of config +}); +``` + +Pozdější příkazy přidají další soubory a složky: + +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/generated`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). +* `yarn twenty entity:add` přidá soubory s definicemi entit do `src/` pro vaše vlastní objekty, funkce, frontové komponenty, role, dovednosti a další. + +## Ověření + +Při prvním spuštění `yarn twenty auth:login` budete vyzváni k zadání: + +* URL API (výchozí je http://localhost:3000 nebo váš aktuální profil pracovního prostoru) +* Klíč API + +Vaše přihlašovací údaje se ukládají pro jednotlivé uživatele do `~/.twenty/config.json`. Můžete spravovat více profilů a přepínat mezi nimi. + +### Správa pracovních prostorů + +```bash filename="Terminal" +# Login interactively (recommended) +yarn twenty auth:login + +# Login to a specific workspace profile +yarn twenty auth:login --workspace my-custom-workspace + +# List all configured workspaces +yarn twenty auth:list + +# Switch the default workspace (interactive) +yarn twenty auth:switch + +# Switch to a specific workspace +yarn twenty auth:switch production + +# Check current authentication status +yarn twenty auth:status +``` + +Jakmile přepnete pracovní prostor pomocí `yarn twenty auth:switch`, všechny následující příkazy budou tento pracovní prostor používat jako výchozí. Můžete jej stále dočasně přepsat pomocí `--workspace `. + +## Ruční nastavení (bez scaffolderu) + +Ačkoli pro nejlepší začátky doporučujeme použít `create-twenty-app`, projekt můžete nastavit i ručně. Neinstalujte CLI globálně. Místo toho přidejte `twenty-sdk` jako lokální závislost a přidejte jeden skript do souboru package.json: + +```bash filename="Terminal" +yarn add -D twenty-sdk +``` + +Poté přidejte skript `twenty`: + +```json filename="package.json" +{ + "scripts": { + "twenty": "twenty" + } +} +``` + +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. + +## Jak používat lokální instanci Twenty + +Pokud již lokálně provozujete instanci Twenty (např. pomocí `npx nx start twenty-server`), můžete se k ní připojit namísto použití Dockeru: + +```bash filename="Terminal" +# During scaffolding — skip Docker, connect to your running instance +npx create-twenty-app@latest my-app --port 3000 + +# Or after scaffolding — add a remote pointing to your instance +yarn twenty remote add --local --port 3000 +``` + +## Řešení potíží + +* Chyby ověření: spusťte `yarn twenty auth:login` a ujistěte se, že váš klíč API má požadovaná oprávnění. +* Nelze se připojit k serveru: ověřte URL API a že je server Twenty dosažitelný. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. + +Kanál podpory na Discordu: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/cs/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/cs/developers/extend/apps/publishing.mdx new file mode 100644 index 00000000000..ba8d1e3e33f --- /dev/null +++ b/packages/twenty-docs/l/cs/developers/extend/apps/publishing.mdx @@ -0,0 +1,119 @@ +--- +title: Publikování +description: Distribuujte svou aplikaci Twenty do Marketplace nebo ji nasaďte interně. +--- + + +Aplikace jsou aktuálně v alfa testování. Tato funkce je funkční, ale stále se vyvíjí. + + +## Přehled + +Jakmile je vaše aplikace [sestavena a otestována lokálně](/l/cs/developers/extend/apps/building), máte dvě cesty, jak ji distribuovat: + +* **Publish to npm** — uveďte svou aplikaci v Marketplace Twenty, aby ji mohl kterýkoli pracovní prostor objevit a nainstalovat. +* **Odeslat tarball** — nasaďte svou aplikaci na konkrétní server Twenty pro interní použití, aniž by byla veřejně dostupná. + +## Publikování na npm + +Publikování na npm zajistí, že bude vaše aplikace dohledatelná v Marketplace Twenty. Jakýkoli pracovní prostor Twenty může procházet, instalovat a aktualizovat aplikace z Marketplace přímo z UI. + +### Požadavky + +* Účet na [npm](https://www.npmjs.com) +* Název vašeho balíčku **musí** používat předponu `twenty-app-` (např. `twenty-app-postcard-sender`) + +### Postup + +1. **Sestavte svou aplikaci** — CLI zkompiluje vaše zdrojové soubory TypeScript a vygeneruje manifest aplikace: + +```bash filename="Terminal" +yarn twenty build +``` + +2. **Publikujte na npm** — odešlete sestavený balíček do registru npm: + +```bash filename="Terminal" +npx twenty publish +``` + +### Automatické rozpoznání + +Balíčky s předponou `twenty-app-` jsou automaticky rozpoznávány katalogem Marketplace Twenty. Po publikování se vaše aplikace během několika minut objeví v Marketplace — nevyžaduje žádnou ruční registraci ani schvalování. + +### Publikování pomocí CI + +Vygenerovaný projekt obsahuje pracovní postup GitHub Actions, který publikuje při každém vydání. Spouští `app:build`, a poté `npm publish --provenance` z výstupu buildu: + +```yaml filename=".github/workflows/publish.yml" +name: Publish +on: + release: + types: [published] + +permissions: + contents: read + id-token: write + +jobs: + publish: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + node-version: "24" + registry-url: https://registry.npmjs.org + - run: yarn install --immutable + - run: npx twenty build + - run: npm publish --provenance --access public + working-directory: .twenty/output + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} +``` + +For other CI systems (GitLab CI, CircleCI, etc.), the same three commands apply: `yarn install`, `npx twenty build`, then `npm publish` from `.twenty/output`. + + +**npm provenance** je volitelné, ale doporučené. Publikování s `--provenance` přidá k vašemu záznamu na npm odznak důvěryhodnosti a umožní uživatelům ověřit, že balíček byl sestaven z konkrétního commitu ve veřejné CI pipeline. Pokyny k nastavení najdete v [dokumentaci k npm provenance](https://docs.npmjs.com/generating-provenance-statements). + + +## Interní distribuce + +Pro aplikace, které nechcete zpřístupnit veřejně — proprietární nástroje, integrace pouze pro enterprise nebo experimentální buildy — můžete odeslat tarball přímo na server Twenty. + +### Odeslat tarball + +Sestavte svou aplikaci a nasaďte ji na konkrétní server v jednom kroku: + +```bash filename="Terminal" +npx twenty publish --server +``` + +Jakýkoli pracovní prostor na tomto serveru pak může aplikaci instalovat a aktualizovat ze stránky nastavení **Applications**. + +### Správa verzí + +Chcete-li vydat aktualizaci: + +1. Zvyšte hodnotu pole `version` v souboru `package.json` +2. Push a new tarball with `npx twenty publish --server ` +3. Pracovní prostory na tomto serveru uvidí dostupnou aktualizaci ve svém nastavení + + +Interní aplikace jsou omezené na server, na který jsou odeslány. Nezobrazí se ve veřejném Marketplace a nelze je instalovat v pracovních prostorech na jiných serverech. + + +## Kategorie aplikací + +Twenty organizuje aplikace do tří kategorií podle způsobu distribuce: + +| Kategorie | Jak to funguje | Viditelné v Marketplace? | +| --------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | +| **Vývoj** | Local dev mode apps running via `yarn twenty dev`. Slouží k sestavování a testování. | Ne | +| **Publikováno** | Aplikace publikované na npm s předponou `twenty-app-`. Uvedeny v Marketplace, aby je mohl kterýkoli pracovní prostor nainstalovat. | Ano | +| **Interní** | Aplikace nasazené pomocí tarballu na konkrétní server. Dostupné pouze pro pracovní prostory na tomto serveru. | Ne | + + +Začněte v režimu **Development** při sestavování své aplikace. Až bude připravena, zvolte **Published** (npm) pro širokou distribuci nebo **Internal** (tarball) pro soukromé nasazení. + diff --git a/packages/twenty-docs/l/cs/developers/extend/capabilities/apps.mdx b/packages/twenty-docs/l/cs/developers/extend/capabilities/apps.mdx index e50be44f2f0..2cf21df7b46 100644 --- a/packages/twenty-docs/l/cs/developers/extend/capabilities/apps.mdx +++ b/packages/twenty-docs/l/cs/developers/extend/capabilities/apps.mdx @@ -21,19 +21,51 @@ Aplikace vám umožňují vytvářet a spravovat přizpůsobení Twenty **jako k ## Předpoklady * Node.js 24+ a Yarn 4 -* Pracovní prostor Twenty a klíč API (vytvořte si jej na https://app.twenty.com/settings/api-webhooks) +* Docker (pro místní vývojový server Twenty) ## Začínáme -Vytvořte novou aplikaci pomocí oficiálního scaffolderu, poté se ověřte a začněte vyvíjet: +Vytvořte novou aplikaci pomocí oficiálního generátoru kostry. Může vám automaticky spustit místní instanci Twenty: ```bash filename="Terminal" -# Vygenerujte kostru nové aplikace (ve výchozím nastavení zahrnuje všechny příklady) +# Vygenerujte kostru nové aplikace — CLI nabídne spuštění místního serveru Twenty npx create-twenty-app@latest my-twenty-app cd my-twenty-app # Spusťte vývojový režim: automaticky synchronizuje místní změny s vaším pracovním prostorem -yarn twenty app:dev +yarn twenty dev +``` + +### Správa místního serveru + +SDK obsahuje příkazy ke správě místního vývojového serveru Twenty (all-in-one obraz Dockeru s PostgreSQL, Redisem, serverem a workerem): + +```bash filename="Terminal" +# Spusťte místní server (v případě potřeby stáhne obraz) +yarn twenty server start + +# Zkontrolujte stav serveru +yarn twenty server status + +# Streamujte logy serveru +yarn twenty server logs + +# Zastavte server +yarn twenty server stop + +# Resetujte všechna data a začněte znovu +yarn twenty server reset +``` + +Lokální server je předem naplněn pracovním prostorem a uživatelem (`tim@apple.dev` / `tim@apple.dev`), takže můžete začít vyvíjet okamžitě bez jakéhokoli ručního nastavení. + +### Ověření + +Připojte svou aplikaci k lokálnímu serveru pomocí OAuth: + +```bash filename="Terminal" +# Ověřte se pomocí OAuth (otevře prohlížeč) +yarn twenty remote add --local ``` Nástroj pro generování kostry podporuje dva režimy pro řízení toho, které ukázkové soubory jsou zahrnuty: @@ -46,28 +78,46 @@ npx create-twenty-app@latest my-app npx create-twenty-app@latest my-app --minimal ``` +### Jak používat lokální instanci Twenty + +Pokud již lokálně provozujete instanci Twenty, můžete se k ní připojit místo použití Dockeru. Zadejte port, na kterém váš lokální server naslouchá (výchozí: `3000`): + +```bash filename="Terminal" +# Během vytváření kostry +npx create-twenty-app@latest my-app --port 3000 + +# Nebo po vytvoření kostry +yarn twenty remote add --local --port 3000 +``` + Odtud můžete: ```bash filename="Terminal" -# Přidejte do vaší aplikace novou entitu (s průvodcem) +# Add a new entity to your application (guided) yarn twenty entity:add -# Sledujte logy funkcí vaší aplikace +# Watch your application's function logs yarn twenty function:logs -# Spusťte funkci podle názvu +# Execute a function by name yarn twenty function:execute -n my-function -p '{"name": "test"}' -# Spusťte předinstalační funkci +# Execute the pre-install function yarn twenty function:execute --preInstall -# Spusťte postinstalační funkci +# Execute the post-install function yarn twenty function:execute --postInstall -# Odinstalujte aplikaci z aktuálního pracovního prostoru -yarn twenty app:uninstall +# Build the app for distribution +yarn twenty build -# Zobrazte nápovědu k příkazům +# Publish the app to npm or a Twenty server +yarn twenty publish + +# Uninstall the application from the current workspace +yarn twenty uninstall + +# Display commands' help yarn twenty help ``` @@ -171,7 +221,7 @@ export default defineObject({ Pozdější příkazy přidají další soubory a složky: -* `yarn twenty app:dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` přidá soubory s definicemi entit do `src/` pro vaše vlastní objekty, funkce, frontové komponenty, role, dovednosti a další. ## Ověření @@ -321,6 +371,72 @@ Výchozí pole můžete přepsat definováním pole se stejným názvem v poli ` ale to se nedoporučuje. +### Definování polí u existujících objektů + +Použijte `defineField()` k přidání vlastních polí k existujícím objektům — jak ke standardním objektům (např. `company`, `person`, `opportunity`), tak k vlastním objektům definovaným jinými aplikacemi. Každé pole je ve svém vlastním souboru a odkazuje na cílový objekt pomocí jeho `universalIdentifier`. + +Chcete-li odkazovat na standardní objekty, importujte `STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS` z `twenty-sdk`. Tato konstanta poskytuje stabilní identifikátory pro všechny vestavěné objekty a jejich pole: + +```typescript +// src/fields/apollo-total-funding.field.ts +import { + defineField, + FieldType, + STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS, +} from 'twenty-sdk'; + +export default defineField({ + universalIdentifier: 'c90ae72d-4ddf-4f22-882f-eef98c91e40e', + objectUniversalIdentifier: + STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.universalIdentifier, + type: FieldType.CURRENCY, + name: 'apolloTotalFunding', + label: 'Total Funding', + description: 'Total funding raised by the company', + icon: 'IconCash', +}); +``` + +Hlavní body: + +* `objectUniversalIdentifier` určuje, ke kterému objektu má Twenty pole připojit. Použijte `STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS..universalIdentifier` pro standardní objekty. +* Každé pole vyžaduje svůj vlastní stabilní `universalIdentifier`, `name`, `type`, `label` a cílový `objectUniversalIdentifier`. +* Nová pole můžete vygenerovat pomocí `yarn twenty entity:add` a zvolit možnost pole. +* `STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS` je pro pohodlí exportován také jako `STANDARD_OBJECT` — obojí odkazuje na stejnou konstantu. + +Mezi dostupné standardní objekty patří: `attachment`, `blocklist`, `calendarChannel`, `calendarEvent`, `calendarEventParticipant`, `company`, `connectedAccount`, `dashboard`, `favorite`, `favoriteFolder`, `message`, `messageChannel`, `messageParticipant`, `messageThread`, `note`, `noteTarget`, `opportunity`, `person`, `task`, `taskTarget`, `timelineActivity`, `workflow`, `workflowAutomatedTrigger`, `workflowRun`, `workflowVersion` a `workspaceMember`. + +Každý standardní objekt také zpřístupňuje identifikátory svých polí. Například chcete-li odkázat na konkrétní pole u standardního objektu v oprávněních pro role: + +```typescript +STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.fields.name.universalIdentifier +``` + +#### Vztahová pole u existujících objektů + +Můžete také definovat vztahová pole, která propojí existující objekty s vašimi vlastními objekty: + +```typescript +// src/fields/people-on-call-recording.field.ts +import { defineField, FieldType, RelationType, STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS } from 'twenty-sdk'; +import { CALL_RECORDING_OBJECT_UNIVERSAL_IDENTIFIER } from 'src/objects/call-recording'; +import { CALL_RECORDING_ON_PERSON_ID } from 'src/fields/call-recording-on-person.field'; + +export default defineField({ + universalIdentifier: '4a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d', + objectUniversalIdentifier: + CALL_RECORDING_OBJECT_UNIVERSAL_IDENTIFIER, + type: FieldType.RELATION, + name: 'person', + label: 'Person', + relationTargetObjectMetadataUniversalIdentifier: + STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.person.universalIdentifier, + relationTargetFieldMetadataUniversalIdentifier: + CALL_RECORDING_ON_PERSON_ID, + relationType: RelationType.MANY_TO_ONE, +}); +``` + ### Konfigurace aplikace (application-config.ts) Každá aplikace má jeden soubor `application-config.ts`, který popisuje: @@ -764,13 +880,262 @@ Hlavní body: * Frontendové komponenty jsou React komponenty, které se vykreslují v izolovaných kontextech v rámci Twenty. * Pole `component` odkazuje na vaši React komponentu. -* Komponenty se během `yarn twenty app:dev` automaticky sestaví a synchronizují. +* Components are built and synced automatically during `yarn twenty dev`. Nové frontendové komponenty můžete vytvořit dvěma způsoby: * **Vygenerované**: Spusťte `yarn twenty entity:add` a zvolte možnost přidat novou frontendovou komponentu. * **Ruční**: Vytvořte nový soubor `.tsx` a použijte `defineFrontComponent()`, podle stejného vzoru. +#### Kde lze použít front komponenty + +Front komponenty se mohou vykreslovat na dvou místech v rámci Twenty: + +* **Postranní panel** — Ne-headless front komponenty se otevírají v pravém postranním panelu. Toto je výchozí chování, když je front komponenta vyvolána z menu příkazů. +* **Widgety (nástěnky a stránky záznamů)** — Front komponenty lze vkládat jako widgety do rozložení stránek. Při konfiguraci nástěnky nebo rozložení stránky záznamu mohou uživatelé přidat widget front komponenty. + +#### Headless vs. ne-headless + +Front komponenty existují ve dvou režimech vykreslování řízených volbou `isHeadless`: + +**Ne-headless (výchozí)** — Komponenta vykreslí viditelné uživatelské rozhraní. Po vyvolání z menu příkazů se otevře v postranním panelu. Toto je výchozí chování, když je `isHeadless` `false` nebo když tato volba není uvedena. + +**Headless** — Komponenta se neviditelně inicializuje na pozadí. Neotevírá postranní panel. Headless komponenty jsou určené pro akce, které provedou logiku a poté se odpojí — například spuštění asynchronního úkolu, navigaci na stránku nebo zobrazení potvrzovacího modálního okna. Přirozeně se hodí ke komponentám SDK Command popsaným níže. + +```typescript +export default defineFrontComponent({ + universalIdentifier: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890', + name: 'my-action', + description: 'Runs an action without opening the side panel', + component: MyAction, + isHeadless: true, + command: { + universalIdentifier: 'b2c3d4e5-f6a7-8901-bcde-f12345678901', + label: 'Run my action', + }, +}); +``` + +#### Přidávání položek menu příkazů + +Aby se front komponenta zobrazila jako položka v menu příkazů Twenty, přidejte vlastnost `command` k `defineFrontComponent()`. Když uživatelé otevřou menu příkazů (Cmd+K / Ctrl+K), položka se zobrazí a po kliknutí spustí front komponentu. + +Objekt `command` přijímá následující pole: + +| Pole | Typ | Popis | +| --------------------------------------- | -------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `universalIdentifier` | `string` (povinné) | Jedinečné ID položky menu příkazů | +| `štítek` | `string` (povinné) | Text zobrazený v menu příkazů | +| `ikona` | `string` (nepovinné) | Název ikony (např. `'IconSparkles'`) | +| `isPinned` | `boolean` (nepovinné) | Zda je příkaz připnutý nahoře v menu | +| `availabilityType` | `'GLOBAL' \| 'RECORD_SELECTION'` (nepovinné) | `GLOBAL` zobrazuje příkaz všude; `RECORD_SELECTION` jej zobrazuje pouze v kontextech záznamů | +| `availabilityObjectUniversalIdentifier` | `string` (nepovinné) | Omezí příkaz na konkrétní typ objektu (např. Person) | + +Zde je příklad z aplikace pro nahrávání hovorů, který přidává příkaz omezený na záznamy typu Person: + +```typescript +import { defineFrontComponent } from 'twenty-sdk'; + +export default defineFrontComponent({ + universalIdentifier: 'c3d4e5f6-a7b8-9012-cdef-123456789012', + name: 'Summarize Person Call Recordings', + description: 'Generates a summary of call recordings for a person', + component: SummarizePersonRecordings, + command: { + universalIdentifier: 'd4e5f6a7-b8c9-0123-defa-234567890123', + label: 'Summarize call recordings', + icon: 'IconSparkles', + isPinned: false, + availabilityType: 'RECORD_SELECTION', + availabilityObjectUniversalIdentifier: + '20202020-e674-48e5-a542-72570eee7213', + }, +}); +``` + +Když se příkaz synchronizuje, objeví se v menu příkazů. Pokud je front komponenta ne-headless, otevře se postranní panel s komponentou vykreslenou uvnitř. Pokud je headless, komponenta se inicializuje na pozadí a provede svou logiku. + +#### Komponenty SDK Command + +Balíček `twenty-sdk` poskytuje čtyři pomocné komponenty Command navržené pro headless front komponenty. Každá komponenta při připojení provede akci, chyby zpracuje zobrazením oznámení ve snackbaru a po dokončení automaticky odpojí front komponentu. + +Importujte je z `twenty-sdk/command`: + +* **`Command`** — Spustí asynchronní callback přes prop `execute`. +* **`CommandLink`** — Naviguje na cestu v aplikaci. Props: `to`, `params`, `queryParams`, `options`. +* **`CommandModal`** — Otevře potvrzovací modální okno. Pokud uživatel potvrdí, provede callback `execute`. Props: `title`, `subtitle`, `execute`, `confirmButtonText`, `confirmButtonAccent`. +* **`CommandOpenSidePanelPage`** — Otevře konkrétní stránku postranního panelu. Props: `page`, `pageTitle`, `pageIcon`. + +Zde je kompletní příklad headless front komponenty, která pomocí `Command` spouští akci z menu příkazů: + +```typescript +// src/front-components/run-action.tsx +import { defineFrontComponent } from 'twenty-sdk'; +import { Command } from 'twenty-sdk/command'; +import { CoreApiClient } from 'twenty-sdk/clients'; + +const RunAction = () => { + const execute = async () => { + const client = new CoreApiClient(); + + await client.mutation({ + createTask: { + __args: { data: { title: 'Created by my app' } }, + id: true, + }, + }); + }; + + return ; +}; + +export default defineFrontComponent({ + universalIdentifier: 'e5f6a7b8-c9d0-1234-efab-345678901234', + name: 'run-action', + description: 'Creates a task from the command menu', + component: RunAction, + isHeadless: true, + command: { + universalIdentifier: 'f6a7b8c9-d0e1-2345-fabc-456789012345', + label: 'Run my action', + icon: 'IconPlayerPlay', + }, +}); +``` + +A příklad s použitím `CommandModal` k vyžádání potvrzení před provedením: + +```typescript +// src/front-components/delete-draft.tsx +import { defineFrontComponent } from 'twenty-sdk'; +import { CommandModal } from 'twenty-sdk/command'; + +const DeleteDraft = () => { + const execute = async () => { + // perform the deletion + }; + + return ( + + ); +}; + +export default defineFrontComponent({ + universalIdentifier: 'a7b8c9d0-e1f2-3456-abcd-567890123456', + name: 'delete-draft', + description: 'Deletes a draft with confirmation', + component: DeleteDraft, + isHeadless: true, + command: { + universalIdentifier: 'b8c9d0e1-f2a3-4567-bcde-678901234567', + label: 'Delete draft', + icon: 'IconTrash', + }, +}); +``` + +#### Kontext provádění + +Každá front komponenta získá kontext provádění, který poskytuje informace o tom, kde a jak běží. K hodnotám kontextu přistupujte pomocí hooků z `twenty-sdk`: + +| Hook | Návratový typ | Popis | +| ----------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `useFrontComponentId()` | `string` | Jedinečné ID aktuální instance front komponenty | +| `useRecordId()` | `string \| null` | ID aktuálního záznamu, když komponenta běží v kontextu záznamu (např. widget na stránce záznamu nebo příkaz omezený na záznam). V opačném případě vrací `null`. | +| `useUserId()` | `string \| null` | ID aktuálního uživatele | + +```typescript +import { useRecordId, useUserId } from 'twenty-sdk'; + +const MyWidget = () => { + const recordId = useRecordId(); + const userId = useUserId(); + + return ( +
+

Record: {recordId ?? 'none'}

+

User: {userId ?? 'anonymous'}

+
+ ); +}; +``` + +Kontext je reaktivní — pokud se okolní záznam změní, hooky automaticky vrátí aktualizované hodnoty. + +#### Funkce hostitelského API + +Front komponenty běží v izolovaném sandboxu, ale mohou interagovat s UI Twenty prostřednictvím sady funkcí poskytovaných hostitelem. Importujte je přímo z `twenty-sdk`: + +```typescript +import { + navigate, + closeSidePanel, + enqueueSnackbar, + unmountFrontComponent, + openSidePanelPage, + openCommandConfirmationModal, +} from 'twenty-sdk'; +``` + +| Funkce | Signatura | Popis | +| ------------------------------ | -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `navigovat` | `(to, params?, queryParams?, options?) => Promise` | Přejde na typovanou cestu aplikace v rámci Twenty | +| `closeSidePanel` | `() => Promise` | Zavře postranní panel | +| `enqueueSnackbar` | `(params) => Promise` | Zobrazí oznámení ve snackbaru. Parametry: `message`, `variant` (`'error'`, `'success'`, `'info'`, `'warning'`), volitelně `duration`, `detailedMessage`, `dedupeKey` | +| `unmountFrontComponent` | `() => Promise` | Odpojí aktuální front komponentu (používají headless komponenty k úklidu po vykonání) | +| `openSidePanelPage` | `(params) => Promise` | Otevře stránku v postranním panelu. Parametry: `page`, `pageTitle`, `pageIcon`, `shouldResetSearchState` | +| `openCommandConfirmationModal` | `(params) => Promise<'confirm' \| 'cancel'>` | Zobrazí potvrzovací modální okno a počká na reakci uživatele. Parametry: `title`, `subtitle`, `confirmButtonText`, `confirmButtonAccent` (`'default'`, `'blue'`, `'danger'`) | + +Zde je příklad, který používá hostitelské API k zobrazení snackbaru a zavření postranního panelu po dokončení akce: + +```typescript +import { defineFrontComponent, useRecordId } from 'twenty-sdk'; +import { enqueueSnackbar, closeSidePanel } from 'twenty-sdk'; +import { CoreApiClient } from 'twenty-sdk/clients'; + +const ArchiveRecord = () => { + const recordId = useRecordId(); + + const handleArchive = async () => { + const client = new CoreApiClient(); + + await client.mutation({ + updateTask: { + __args: { id: recordId, data: { status: 'ARCHIVED' } }, + id: true, + }, + }); + + await enqueueSnackbar({ + message: 'Record archived', + variant: 'success', + }); + + await closeSidePanel(); + }; + + return ( +
+

Archive this record?

+ +
+ ); +}; + +export default defineFrontComponent({ + universalIdentifier: 'c9d0e1f2-a3b4-5678-cdef-789012345678', + name: 'archive-record', + description: 'Archives the current record', + component: ArchiveRecord, +}); +``` + ### Dovednosti Dovednosti definují znovupoužitelné pokyny a schopnosti, které mohou agenti AI používat ve vašem pracovním prostoru. K definování dovedností s vestavěnou validací použijte `defineSkill()`: @@ -843,7 +1208,7 @@ Nové agenty můžete vytvářet dvěma způsoby: ### Generované typované klienty -Two typed clients are auto-generated by `yarn twenty app:dev` and stored in `node_modules/twenty-sdk/clients` based on your workspace schema: +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/clients` based on your workspace schema: * **`CoreApiClient`** — provádí dotazy na endpoint `/graphql` za účelem získání dat pracovního prostoru * **`MetadataApiClient`** — odesílá dotazy na endpoint `/metadata` pro konfiguraci pracovního prostoru a nahrávání souborů @@ -859,7 +1224,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -`CoreApiClient` is re-generated automatically by `yarn twenty app:dev` whenever your objects or fields change. `MetadataApiClient` ships pre-built with the SDK. +`CoreApiClient` is re-generated automatically by `yarn twenty dev` whenever your objects or fields change. `MetadataApiClient` je v SDK k dispozici již předem sestavený. #### Běhové přihlašovací údaje v logických funkcích @@ -876,7 +1241,7 @@ Poznámky: #### Nahrávání souborů -The `MetadataApiClient` includes an `uploadFile` method for attaching files to file-type fields on your workspace objects. Protože standardní klienti GraphQL nativně nepodporují nahrávání souborů pomocí multipart, klient poskytuje tuto speciální metodu, která interně implementuje [specifikaci multipart požadavků GraphQL](https://github.com/jaydenseric/graphql-multipart-request-spec). +`MetadataApiClient` obsahuje metodu `uploadFile` pro připojování souborů k polím typu souboru u objektů ve vašem pracovním prostoru. Protože standardní klienti GraphQL nativně nepodporují nahrávání souborů pomocí multipart, klient poskytuje tuto speciální metodu, která interně implementuje [specifikaci multipart požadavků GraphQL](https://github.com/jaydenseric/graphql-multipart-request-spec). ```typescript import { MetadataApiClient } from 'twenty-sdk/clients'; @@ -925,6 +1290,113 @@ Hlavní body: Prozkoumejte minimalistický end-to-end příklad, který demonstruje objekty, logické funkce, frontendové komponenty a více spouštěčů [zde](https://github.com/twentyhq/twenty/tree/main/packages/twenty-apps/hello-world): +## Sestavení vaší aplikace + +Jakmile vyvinete svou aplikaci pomocí `app:dev`, použijte `app:build` k jejímu zkompilování do distribučního balíčku. + +```bash filename="Terminal" +# Build the app (output goes to .twenty/output/) +yarn twenty build + +# Build and create a tarball (.tgz) for distribution +yarn twenty build --tarball +``` + +Proces sestavení: + +1. **Parsuje a ověřuje manifest** — čte všechny entity `defineX()` z vašich zdrojových souborů a ověřuje strukturu manifestu. +2. **Kompiluje logické funkce a frontendové komponenty** — slučuje zdrojové soubory TypeScriptu do ESM souborů `.mjs` pomocí esbuild. +3. **Generuje kontrolní součty** — vypočítá MD5 hashe pro každý sestavený soubor, které jsou v manifestu uloženy jako `builtHandlerChecksum` / `builtComponentChecksum`. +4. **Vygeneruje typovaného klienta API** — prozkoumá schéma GraphQL a vygeneruje typované klienty `CoreApiClient` a `MetadataApiClient`. +5. **Spustí kontrolu typů TypeScriptu** — spustí `tsc --noEmit`, aby zachytil chyby typů před publikováním. +6. **Znovu sestaví s vygenerovaným klientem** — provede druhý průchod kompilace, aby byly zahrnuty typy vygenerovaného klienta. +7. **Volitelně vytvoří tarball** — pokud je předán `--tarball`, spustí `npm pack` a vytvoří soubor `.tgz` připravený k distribuci. + +Výstup sestavení v `.twenty/output/` obsahuje: + +```text +.twenty/output/ +├── manifest.json # Manifest with checksums for all built files +├── package.json # Copied from app root +├── yarn.lock # Copied from app root +├── src/ +│ ├── logic-functions/ # Compiled .mjs logic function files +│ └── front-components/ # Compiled .mjs front component files +├── public/ # Static assets (if any) +└── my-app-1.0.0.tgz # Only with --tarball flag +``` + +| Možnost | Popis | +| ----------- | ----------------------------------------------------- | +| `[appPath]` | Cesta k adresáři aplikace (výchozí: aktuální adresář) | +| `--tarball` | Také zabalí výstup do tarballu `.tgz` | + +## Publikování vaší aplikace + +Použijte `app:publish` k distribuci své aplikace — buď do registru npm, nebo přímo na server Twenty. + +### Publikovat na npm (výchozí) + +```bash filename="Terminal" +# Publish to npm (requires npm login) +yarn twenty publish + +# Publish with a dist-tag (e.g. beta, next) +yarn twenty publish --tag beta +``` + +Tímto se aplikace sestaví a spustí se `npm publish` z adresáře `.twenty/output/`. Publikovaný balíček pak může být nainstalován z tržiště Twenty jakýmkoli pracovním prostorem. + +### Publikovat na server Twenty + +```bash filename="Terminal" +# Publish directly to a Twenty server +yarn twenty publish --server https://app.twenty.com +``` + +Tímto se aplikace sestaví s tarballem, nahraje se na server pomocí GraphQL mutace `uploadAppTarball` a v jednom kroku se spustí instalace. To je užitečné pro soukromá nasazení nebo testování proti konkrétnímu serveru. + +| Možnost | Popis | +| ----------------- | ------------------------------------------------------------------ | +| `[appPath]` | Cesta k adresáři aplikace (výchozí: aktuální adresář) | +| `--server ` | Publikovat na server Twenty místo npm | +| `--token ` | Autentizační token pro cílový server | +| `--tag ` | npm dist-tag (např. `beta`, `next`) — pouze pro publikování na npm | + +## Registrace aplikace + +Než může být aplikace nainstalována v pracovním prostoru, musí být **zaregistrována**. Registrace je záznam metadat, který popisuje, odkud aplikace pochází a jak ji autentizovat. Ve většině případů to CLI zpracuje automaticky. + +### Typy zdrojů + +Každá registrace má **typ zdroje**, který určuje, jak se při instalaci získávají soubory aplikace: + +| Typ zdroje | Jak se získávají soubory | Typický případ použití | +| ---------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------- | +| `LOCAL` | Soubory jsou průběžně synchronizovány nástrojem CLI watcher v reálném čase — instalace se přeskočí | Vývoj s `app:dev` | +| `NPM` | Získáváno z registru npm prostřednictvím pole `sourcePackage` | Publikované aplikace na npm | +| `TARBALL` | Extrahováno z nahraného souboru `.tgz` uloženého na serveru | Soukromé aplikace publikované pomocí `--server` | + +### Jak probíhá registrace + +* **`app:dev`** — při prvním spuštění vývojového režimu pro pracovní prostor automaticky vytvoří registraci `LOCAL`. +* **`app:publish --server`** — nahraje tarball a vytvoří (nebo aktualizuje) registraci `TARBALL` a poté nainstaluje aplikaci. +* **tržiště npm** — registrace `NPM` se vytvářejí, když jsou aplikace synchronizovány z registru npm do katalogu tržiště Twenty. +* **GraphQL API** — registrace můžete vytvářet také programově pomocí mutace `createApplicationRegistration`. + +### Registrace vs instalace + +**Registrace** a **instalace** jsou odlišné pojmy: + +* **Registrace** (`ApplicationRegistration`) je globální záznam metadat popisující aplikaci: její název, typ zdroje, přihlašovací údaje OAuth a stav zařazení na tržišti. Existuje nezávisle na jakémkoli pracovním prostoru. +* **Instalace** (`Application`) je instancí na úrovni pracovního prostoru. Když uživatel nainstaluje aplikaci, Twenty načte balíček ze zdroje uvedeného v registraci, zapíše sestavené soubory do úložiště a synchronizuje manifest (vytváření objektů, polí, logických funkcí atd.) v daném pracovním prostoru. + +Jedna registrace může být nainstalována v mnoha pracovních prostorech. Každý pracovní prostor získá svou vlastní kopii souborů a datového modelu aplikace. + +### Přihlašovací údaje OAuth + +Každá registrace obsahuje přihlašovací údaje OAuth (`oAuthClientId` a `oAuthClientSecret`) vygenerované při vytvoření. Tyto údaje aplikace používá k autentizaci požadavků na API jménem uživatelů. Tajný klíč klienta je při vytvoření vrácen **pouze jednou** — uložte jej bezpečně. Později jej můžete rotovat prostřednictvím mutace `rotateApplicationRegistrationClientSecret`. + ## Ruční nastavení (bez scaffolderu) Ačkoli pro nejlepší začátky doporučujeme použít `create-twenty-app`, projekt můžete nastavit i ručně. Neinstalujte CLI globálně. Místo toho přidejte `twenty-sdk` jako lokální závislost a přidejte jeden skript do souboru package.json: @@ -943,13 +1415,13 @@ Poté přidejte skript `twenty`: } ``` -Nyní můžete spouštět všechny příkazy přes `yarn twenty `, např. `yarn twenty app:dev`, `yarn twenty help` atd. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## Řešení potíží * Chyby ověření: spusťte `yarn twenty auth:login` a ujistěte se, že váš klíč API má požadovaná oprávnění. * Nelze se připojit k serveru: ověřte URL API a že je server Twenty dosažitelný. -* Types or client missing/outdated: restart `yarn twenty app:dev` — it auto-generates the typed client. -* Režim vývoje se nesynchronizuje: ujistěte se, že běží `yarn twenty app:dev` a že vaše prostředí změny neignoruje. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Kanál podpory na Discordu: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/cs/developers/extend/extend.mdx b/packages/twenty-docs/l/cs/developers/extend/extend.mdx index 03f9f60f787..c0b7dcfea8a 100644 --- a/packages/twenty-docs/l/cs/developers/extend/extend.mdx +++ b/packages/twenty-docs/l/cs/developers/extend/extend.mdx @@ -1,7 +1,6 @@ --- title: Rozšiřte description: Rozšiřte funkčnost Twenty pomocí rozhraní API, webhooků a vlastních aplikací. -redirect: /developers/introduction --- @@ -16,18 +15,18 @@ Twenty je navrženo tak, aby bylo rozšiřitelné. Použijte naše rozhraní API * **API**: Programově dotazujte a upravujte svá CRM data pomocí REST nebo GraphQL * **Webhooky**: Dostávejte oznámení v reálném čase, když v Twenty dojde k událostem -* **Aplikace**: Vytvářejte vlastní aplikace, které rozšiřují možnosti Twenty - Již brzy! +* **Aplikace**: Vytvářejte vlastní aplikace, které rozšiřují možnosti Twenty ## Začínáme - + Programově se připojte k Twenty - + Dostávejte oznámení o událostech v reálném čase - - Vytvářejte přizpůsobení jako kód (Alpha) + + Vytvářejte přizpůsobení jako kód diff --git a/packages/twenty-docs/l/cs/developers/extend/webhooks.mdx b/packages/twenty-docs/l/cs/developers/extend/webhooks.mdx new file mode 100644 index 00000000000..814e59780e9 --- /dev/null +++ b/packages/twenty-docs/l/cs/developers/extend/webhooks.mdx @@ -0,0 +1,116 @@ +--- +title: Webhooky +description: Dostávejte oznámení v reálném čase, když ve vašem CRM dojde k událostem. +--- + +import { VimeoEmbed } from '/snippets/vimeo-embed.mdx'; + +Webhooky posílají data do vašich systémů v reálném čase, když v Twenty dojde k událostem — bez potřeby průběžného dotazování. Použijte je k udržování externích systémů v synchronizaci, spouštění automatizací nebo zasílání upozornění. + +## Vytvořit Webhook + +1. Přejděte na **Nastavení → API & Webhooks → Webhooks** +2. Klikněte na **+ Vytvořit webhook** +3. Zadejte adresu URL svého webhooku (musí být veřejně přístupná) +4. Klikněte na **Uložit** + +Webhook se aktivuje okamžitě a začne odesílat oznámení. + + + +### Spravovat Webhooky + +**Upravit**: Klikněte na webhook → Aktualizovat adresu URL → **Uložit** + +**Odstranit**: Klikněte na webhook → **Odstranit** → Potvrdit + +## Události + +Twenty odesílá webhooky pro tyto typy událostí: + +| Událost | Příklad | +| -------------------------- | ---------------------------------------------------------- | +| **Záznam je vytvořen** | `person.created`, `company.created`, `note.created` | +| **Záznam je aktualizován** | `person.updated`, `company.updated`, `opportunity.updated` | +| **Záznam je odstraněn** | `person.deleted`, `company.deleted` | + +Všechny typy událostí jsou odesílány na adresu URL vašeho webhooku. Filtrování událostí může být přidáno v budoucích verzích. + +## Formát payloadu + +Každý webhook odesílá HTTP POST s tělem ve formátu JSON: + +```json +{ + "event": "person.created", + "data": { + "id": "abc12345", + "firstName": "Alice", + "lastName": "Doe", + "email": "alice@example.com", + "createdAt": "2025-02-10T15:30:45Z", + "createdBy": "user_123" + }, + "timestamp": "2025-02-10T15:30:50Z" +} +``` + +| Pole | Popis | +| ----------- | ------------------------------------------------------ | +| `event` | Co se stalo (např. `person.created`) | +| `data` | Celý záznam, který byl vytvořen/aktualizován/odstraněn | +| `timestamp` | Kdy k události došlo (UTC) | + + +Odpovězte se **stavem HTTP 2xx** (200–299) pro potvrzení přijetí. Odpovědi mimo 2xx se zaznamenávají jako selhání doručení. + + +## Ověření Webhooku + +Twenty kvůli bezpečnosti podepisuje každý požadavek webhooku. Ověřujte podpisy, abyste zajistili, že požadavky jsou autentické. + +### Záhlaví + +| Hlavička | Popis | +| ---------------------------- | ------------------------ | +| `X-Twenty-Webhook-Signature` | Podpis HMAC SHA256 | +| `X-Twenty-Webhook-Timestamp` | Časové razítko požadavku | + +### Kroky ověření + +1. Získejte časové razítko z `X-Twenty-Webhook-Timestamp` +2. Vytvořte řetězec: `{timestamp}:{JSON payload}` +3. Vypočítejte HMAC SHA256 pomocí vašeho tajného klíče webhooku +4. Porovnejte s `X-Twenty-Webhook-Signature` + +### Příklad (Node.js) + +```javascript +const crypto = require("crypto"); + +const timestamp = req.headers["x-twenty-webhook-timestamp"]; +const payload = JSON.stringify(req.body); +const secret = "your-webhook-secret"; + +const stringToSign = `${timestamp}:${payload}`; +const expectedSignature = crypto + .createHmac("sha256", secret) + .update(stringToSign) + .digest("hex"); + +const receivedSignature = req.headers["x-twenty-webhook-signature"]; +const isValid = crypto.timingSafeEqual( + Buffer.from(expectedSignature, "hex"), + Buffer.from(receivedSignature, "hex") +); +``` + +## Webhooky vs. pracovní postupy + +| Metoda | Směr | Případ použití | +| ----------------------------------------- | ---- | --------------------------------------------------------------- | +| **Webhooky** | OUT | Automaticky informujte externí systémy o jakékoli změně záznamu | +| **Pracovní postup + požadavek HTTP** | OUT | Odesílejte data ven s vlastní logikou (filtry, transformace) | +| **Spouštěč webhooku v pracovním postupu** | IN | Přijímejte data do Twenty z externích systémů | + +Pro příjem externích dat viz [Nastavení spouštěče webhooku](/l/cs/user-guide/workflows/how-tos/connect-to-other-tools/set-up-a-webhook-trigger). diff --git a/packages/twenty-docs/l/cs/developers/introduction.mdx b/packages/twenty-docs/l/cs/developers/introduction.mdx index 7a012b24bb6..a155d446d2d 100644 --- a/packages/twenty-docs/l/cs/developers/introduction.mdx +++ b/packages/twenty-docs/l/cs/developers/introduction.mdx @@ -5,28 +5,18 @@ description: Vítejte v dokumentaci pro vývojáře Twenty, která je vaším zd import { CardTitle } from "/snippets/card-title.mdx" - - - API - Dotazujte a upravujte data CRM pomocí REST nebo GraphQL. + + + Rozšiřte + Vytvářejte integrace pomocí API, webhooků a vlastních aplikací. - - Webhooks - Přijímejte oznámení v reálném čase při výskytu událostí. - - - - Apps - Vytvářejte vlastní aplikace rozšiřující možnosti Twenty. - - - + Hostujte sami Nasaďte a spravujte Twenty na vlastní infrastruktuře. - + Přispějte Připojte se k naší open-source komunitě a přispívejte do Twenty. diff --git a/packages/twenty-docs/l/cs/developers/self-host/capabilities/docker-compose.mdx b/packages/twenty-docs/l/cs/developers/self-host/capabilities/docker-compose.mdx index 104ef52996e..8f824a96d95 100644 --- a/packages/twenty-docs/l/cs/developers/self-host/capabilities/docker-compose.mdx +++ b/packages/twenty-docs/l/cs/developers/self-host/capabilities/docker-compose.mdx @@ -3,7 +3,7 @@ title: Docker Compose jedním kliknutím --- -Docker kontejnery jsou určeny pro produkční hosting nebo samohostování; pro přispívání si prosím přečtěte [Lokální nastavení](/l/cs/developers/contribute/capabilities/local-setup). +Docker kontejnery jsou určeny pro produkční provoz nebo vlastní hostování. Pro přispívání se podívejte na [Lokální nastavení](/l/cs/developers/contribute/capabilities/local-setup). ## Přehled @@ -12,7 +12,7 @@ Tato příručka poskytuje podrobný návod k instalaci a konfiguraci aplikace T **Důležité:** Měňte pouze nastavení výslovně uvedená v tomto průvodci. Změna jiných konfigurací může vést k problémům. -Podívejte se na dokumentaci [Nastavení Proměnných Prostředí](/l/cs/developers/self-host/capabilities/setup) pro pokročilou konfiguraci. Všechny proměnné prostředí musí být deklarovány v souboru docker-compose.yml na úrovni serveru a/nebo pracovníka v závislosti na proměnné. +Viz [Nastavení proměnných prostředí](/l/cs/developers/self-host/capabilities/setup) pro pokročilou konfiguraci. Všechny proměnné prostředí musí být deklarovány v souboru `docker-compose.yml` na úrovni serveru a/nebo pracovníka, v závislosti na proměnné. ## Systémové Požadavky diff --git a/packages/twenty-docs/l/cs/developers/self-host/capabilities/setup.mdx b/packages/twenty-docs/l/cs/developers/self-host/capabilities/setup.mdx index 5da188049f6..614ad3bbef1 100644 --- a/packages/twenty-docs/l/cs/developers/self-host/capabilities/setup.mdx +++ b/packages/twenty-docs/l/cs/developers/self-host/capabilities/setup.mdx @@ -297,46 +297,60 @@ yarn command:prod cron:workflow:automated-cron-trigger **Režim pouze s prostředím:** Pokud nastavíte `IS_CONFIG_VARIABLES_IN_DB_ENABLED=false`, přidejte tyto proměnné do souboru `.env` -## Logické funkce +## Logické funkce a interpret kódu -Twenty podporuje logické funkce pro pracovní postupy a vlastní logiku. Běhové prostředí se konfiguruje pomocí proměnné prostředí `SERVERLESS_TYPE`. +Twenty podporuje logické funkce pro pracovní postupy a interpret kódu pro analýzu dat s využitím AI. Obě spouštějí kód poskytnutý uživatelem a z důvodu zabezpečení vyžadují explicitní konfiguraci. + +### Výchozí nastavení zabezpečení + +**V produkci (NODE_ENV=production):** Jak logické funkce, tak interpret kódu mají ve výchozím nastavení stav **Zakázáno**. Pokud tyto funkce potřebujete, musíte je explicitně povolit pomocí `LOGIC_FUNCTION_TYPE` a `CODE_INTERPRETER_TYPE`. + +**V prostředí vývoje (NODE_ENV=development):** Obě mají ve výchozím nastavení **LOCAL** pro pohodlí při lokálním spuštění. -**Upozornění na zabezpečení:** Místní ovladač (`SERVERLESS_TYPE=LOCAL`) spouští kód přímo na hostiteli v procesu Node.js bez sandboxu. Měl by být používán pouze pro důvěryhodný kód při vývoji. Pro produkční nasazení, která pracují s nedůvěryhodným kódem, důrazně doporučujeme použít `SERVERLESS_TYPE=LAMBDA` nebo `SERVERLESS_TYPE=DISABLED`. +**Upozornění na zabezpečení:** Místní ovladač (`LOGIC_FUNCTION_TYPE=LOCAL` nebo `CODE_INTERPRETER_TYPE=LOCAL`) spouští kód přímo na hostiteli v procesu Node.js bez sandboxu. Měl by být používán pouze pro důvěryhodný kód při vývoji. Pro produkční nasazení, která pracují s nedůvěryhodným kódem, použijte `LOGIC_FUNCTION_TYPE=LAMBDA` nebo `CODE_INTERPRETER_TYPE=E2B` (se sandboxem), případně je ponechte vypnuté. -### Dostupné ovladače +### Logické funkce - dostupné ovladače -| Ovladač | Proměnná prostředí | Případ použití | Úroveň zabezpečení | -| --------- | -------------------------- | ------------------------------------------ | ----------------------------------- | -| Neaktivní | `SERVERLESS_TYPE=DISABLED` | Úplně zakázat logické funkce | N/A | -| Lokální | `SERVERLESS_TYPE=LOCAL` | Vývojová a důvěryhodná prostředí | Nízká (bez sandboxu) | -| Lambda | `SERVERLESS_TYPE=LAMBDA` | Produkční prostředí s nedůvěryhodným kódem | Vysoká (izolace na úrovni hardwaru) | +| Ovladač | Proměnná prostředí | Případ použití | Úroveň zabezpečení | +| --------- | ------------------------------ | ------------------------------------------ | ----------------------------------- | +| Neaktivní | `LOGIC_FUNCTION_TYPE=DISABLED` | Úplně zakázat logické funkce | N/A | +| Lokální | `LOGIC_FUNCTION_TYPE=LOCAL` | Vývojová a důvěryhodná prostředí | Nízká (bez sandboxu) | +| Lambda | `LOGIC_FUNCTION_TYPE=LAMBDA` | Produkční prostředí s nedůvěryhodným kódem | Vysoká (izolace na úrovni hardwaru) | -### Doporučená konfigurace +### Logické funkce - doporučená konfigurace **Pro vývoj:** ```bash -SERVERLESS_TYPE=LOCAL # default +LOGIC_FUNCTION_TYPE=LOCAL # default when NODE_ENV=development ``` **Pro produkci (AWS):** ```bash -SERVERLESS_TYPE=LAMBDA -SERVERLESS_LAMBDA_REGION=us-east-1 -SERVERLESS_LAMBDA_ROLE=arn:aws:iam::123456789:role/your-lambda-role -SERVERLESS_LAMBDA_ACCESS_KEY_ID=your-access-key -SERVERLESS_LAMBDA_SECRET_ACCESS_KEY=your-secret-key +LOGIC_FUNCTION_TYPE=LAMBDA +LOGIC_FUNCTION_LAMBDA_REGION=us-east-1 +LOGIC_FUNCTION_LAMBDA_ROLE=arn:aws:iam::123456789:role/your-lambda-role +LOGIC_FUNCTION_LAMBDA_ACCESS_KEY_ID=your-access-key +LOGIC_FUNCTION_LAMBDA_SECRET_ACCESS_KEY=your-secret-key ``` **Pro zakázání logických funkcí:** ```bash -SERVERLESS_TYPE=DISABLED +LOGIC_FUNCTION_TYPE=DISABLED # default when NODE_ENV=production ``` +### Interpret kódu - dostupné ovladače + +| Ovladač | Proměnná prostředí | Případ použití | Úroveň zabezpečení | +| --------- | -------------------------------- | ----------------------------------------------- | -------------------------- | +| Neaktivní | `CODE_INTERPRETER_TYPE=DISABLED` | Zakázat spouštění kódu AI | N/A | +| Lokální | `CODE_INTERPRETER_TYPE=LOCAL` | Pouze pro vývoj | Nízká (bez sandboxu) | +| E2B | `CODE_INTERPRETER_TYPE=E_2_B` | Produkční prostředí se sandboxovaným spouštěním | Vysoká (izolovaný sandbox) | + -Při použití `SERVERLESS_TYPE=DISABLED` skončí každý pokus o spuštění logické funkce chybou. To je užitečné, pokud chcete provozovat Twenty bez podpory logických funkcí. +Při použití `LOGIC_FUNCTION_TYPE=DISABLED` nebo `CODE_INTERPRETER_TYPE=DISABLED` vrátí každý pokus o spuštění chybu. To je užitečné, pokud chcete provozovat Twenty bez těchto schopností. diff --git a/packages/twenty-docs/l/cs/developers/self-host/capabilities/troubleshooting.mdx b/packages/twenty-docs/l/cs/developers/self-host/capabilities/troubleshooting.mdx index 08ece4b7b7d..fde534cf80c 100644 --- a/packages/twenty-docs/l/cs/developers/self-host/capabilities/troubleshooting.mdx +++ b/packages/twenty-docs/l/cs/developers/self-host/capabilities/troubleshooting.mdx @@ -167,6 +167,10 @@ plugins: [ Spusťte `UPDATE core."user" SET "canAccessFullAdminPanel" = TRUE WHERE email = 'you@yourdomain.com';` v databázovém kontejneru pro získání přístupu k administračnímu panelu. +#### Při spuštění workflow dojde k chybě "Logic function execution is disabled. Set LOGIC_FUNCTION_TYPE to LOCAL or LAMBDA to enable." + +V produkčním prostředí jsou logické funkce ve výchozím nastavení zakázané. Nastavte proměnnou prostředí `LOGIC_FUNCTION_TYPE` na `LOCAL` nebo `LAMBDA`, abyste je povolili. Toto lze nakonfigurovat pomocí proměnných prostředí nebo prostřednictvím proměnných databáze v administračním panelu. Podrobnosti najdete v [průvodci nastavením Logic Functions](/l/cs/developers/self-host/capabilities/setup#logic-functions-available-drivers). + ### Docker Compose jedním kliknutím #### Nelze se přihlásit diff --git a/packages/twenty-docs/l/cs/navigation.json b/packages/twenty-docs/l/cs/navigation.json index ebd77b9843a..5b8df0cb33c 100644 --- a/packages/twenty-docs/l/cs/navigation.json +++ b/packages/twenty-docs/l/cs/navigation.json @@ -149,8 +149,8 @@ "extend": { "label": "Rozšíření", "groups": { - "extendCapabilities": { - "label": "Možnosti" + "apps": { + "label": "Aplikace" } } }, diff --git a/packages/twenty-docs/l/cs/user-guide/ai/capabilities/mcp.mdx b/packages/twenty-docs/l/cs/user-guide/ai/capabilities/mcp.mdx new file mode 100644 index 00000000000..c1d971065aa --- /dev/null +++ b/packages/twenty-docs/l/cs/user-guide/ai/capabilities/mcp.mdx @@ -0,0 +1,142 @@ +--- +title: MCP Server +description: Připojte asistenty AI ke svému pracovnímu prostoru Twenty pomocí protokolu Model Context Protocol. +--- + + +MCP je v současnosti ve fázi **alpha** a je dostupný pouze v některých pracovních prostorech. MCP nemusí být ve vašem pracovním prostoru ještě povolen. + + +Twenty zpřístupňuje server [MCP](https://modelcontextprotocol.io/), aby AI asistenti — Claude Desktop, Claude Code, Cursor, ChatGPT a další — mohli číst a zapisovat data vašeho CRM pomocí přirozeného jazyka. + +Použijte svou **adresu URL pracovní oblasti** (adresu URL, kterou používáte k přístupu k Twenty) jako koncový bod MCP. V Twenty Cloud může vaše adresa URL pracovní oblasti být `https://{mycompany}.twenty.com` nebo vlastní doména. Server je dostupný na: + +| Prostředí | Koncový bod MCP | +| ------------------- | ----------------------------------------------------------------------------- | +| **Cloud** | `https://{your-workspace-url}/mcp` (např. `https://mycompany.twenty.com/mcp`) | +| **Vlastní hosting** | `https://{your-domain}/mcp` | + +## Metody ověření + +Máte dva způsoby, jak ověřit svého klienta MCP: **OAuth** (doporučeno) nebo **klíč API**. + +### Možnost A — OAuth (doporučeno) + +S OAuth váš klient MCP otevře okno prohlížeče, abyste se mohli přihlásit. V konfiguračních souborech se neukládají žádné tajné údaje a tokeny se automaticky obnovují. + + +OAuth vyžaduje klienta MCP, který podporuje [specifikaci autorizace MCP](https://modelcontextprotocol.io/specification/2025-03-26/basic/authorization). Podporují ji Claude Desktop, Claude Code, Cursor a ChatGPT. + + +Přidejte toto do konfigurace svého klienta MCP a nahraďte `{your-workspace-url}` hostitelem vaší pracovní oblasti (např. `mycompany.twenty.com`): + +```json +{ + "mcpServers": { + "twenty": { + "type": "streamable-http", + "url": "https://{your-workspace-url}/mcp" + } + } +} +``` + +To je vše — není potřeba žádný klíč API. Když se klient připojí poprvé, provede: + +1. Získá metadata OAuth služby Twenty pomocí `/.well-known/oauth-protected-resource` a `/.well-known/oauth-authorization-server` +2. Zaregistruje se jako klient OAuth prostřednictvím dynamické registrace klienta (RFC 7591) +3. Otevře váš prohlížeč k autorizaci přístupu +4. Převezme tokeny a připojí se k serveru MCP + +Následující připojení znovu použijí uložené tokeny a automaticky je obnoví. + +### Možnost B — klíč API + +Pokud váš klient MCP nepodporuje OAuth, nebo dáváte přednost statickým přihlašovacím údajům, předejte klíč API v hlavičce `Authorization`: + +```json +{ + "mcpServers": { + "twenty": { + "type": "streamable-http", + "url": "https://{your-workspace-url}/mcp", + "headers": { + "Authorization": "Bearer YOUR_API_KEY" + } + } + } +} +``` + + +Váš klíč API poskytuje přístup k datům pracovní oblasti. Nenechávejte jej ve verzovacím systému ani ve sdílených dotfiles. + + +Chcete-li vytvořit klíč API, přejděte do **Settings > APIs & Webhooks > + Create key**. Podrobnosti viz [Rozhraní API](/l/cs/developers/extend/api#create-an-api-key). + +## Rychlý start + +### 1. Zkopírujte konfiguraci + +V Twenty přejděte do **Settings > AI > More > MCP Server**. Vyberte metodu ověření (OAuth nebo klíč API), zkopírujte úryvek JSON (už bude používat adresu URL vaší pracovní oblasti) a vložte jej do konfiguračního souboru klienta MCP. + +| Klient | Umístění konfiguračního souboru | +| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Claude Desktop** | `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) nebo `%APPDATA%\Claude\claude_desktop_config.json` (Windows) | +| **Claude Code** | `~/.claude.json` (uživatel) nebo `.mcp.json` (projekt) | +| **Cursor** | `.cursor/mcp.json` ve vašem projektu nebo `~/.cursor/mcp.json` globálně | +| **ChatGPT** | Zapněte Developer Mode v **Settings > Apps & Connectors > Advanced settings**, poté použijte **Create** v **Settings > Apps & Connectors** k přidání serveru MCP | + +### 2. Připojení + +Restartujte svého klienta MCP (nebo znovu načtěte konfiguraci). Pokud používáte OAuth, budete přesměrováni do Twenty k autorizaci přístupu. Pokud používáte klíč API, připojení je okamžité. + +### 3. Začněte jej používat + +Požádejte svého AI asistenta, aby pracoval s vaším CRM: + +* *"Ukaž mi 5 nejnověji vytvořených společností"* +* *"Vytvoř novou osobu jménem Jane Doe ve společnosti Acme Corp"* +* *"Najdi všechny otevřené příležitosti s hodnotou vyšší než 10 000 $"* + +## Dostupné nástroje + +Po připojení server MCP zpřístupní nástroje, které odpovídají rozhraní Twenty API. Doporučený pracovní postup je: + +1. **`get_tool_catalog`** — zjistit všechny dostupné nástroje +2. **`learn_tools`** — získat vstupní schéma pro konkrétní nástroje +3. **`execute_tool`** — spustit nástroj + +Není potřeba si pamatovat názvy nástrojů. Zeptejte se svého AI asistenta, co umí, a automaticky zavolá `get_tool_catalog`. + +## Oprávnění + +Připojení MCP dědí oprávnění ověřeného uživatele (OAuth) nebo roli přiřazenou ke klíči API. Chcete-li omezit, co může server MCP provádět: + +* **OAuth**: Platí role uživatele v pracovní oblasti. +* **Klíč API**: Přiřaďte klíči API roli v **Settings > Roles**. Viz [Oprávnění](/l/cs/user-guide/permissions-access/capabilities/permissions). + +## Konfigurace pro self-hosting + +U samostatně hostovaných instancí nahraďte `{your-workspace-url}` adresou URL svého serveru. Ujistěte se, že `SERVER_URL` ve vašem prostředí odpovídá veřejné adrese URL vaší instance Twenty — tato hodnota se používá k vygenerování metadat pro zjišťování OAuth. + +```bash +SERVER_URL=https://twenty.yourcompany.com +``` + +Koncový bod MCP, koncové body OAuth a metadata pro zjišťování se z této hodnoty odvozují. + +## Řešení potíží + +**Chyby "Unauthorized" nebo 401** + +* OAuth: Proveďte znovu autorizaci vymazáním uložených tokenů ve vašem klientovi MCP a znovu se připojte. +* Klíč API: Ověřte, že je klíč platný a nevypršela mu platnost. V případě potřeby jej znovu vygenerujte. + +**Tok OAuth neotevírá prohlížeč** + +* Ujistěte se, že váš klient MCP podporuje autorizaci MCP. Pokud ne, použijte metodu s klíčem API. + +**Časový limit připojení** + +* Ověřte, že je adresa URL koncového bodu MCP dosažitelná z vašeho počítače. U samostatně hostovaných instancí zkontrolujte, že server běží a že je `SERVER_URL` nastaven správně. diff --git a/packages/twenty-docs/l/cs/user-guide/data-migration/how-tos/export-your-data.mdx b/packages/twenty-docs/l/cs/user-guide/data-migration/how-tos/export-your-data.mdx index 5380130930e..29991b3f476 100644 --- a/packages/twenty-docs/l/cs/user-guide/data-migration/how-tos/export-your-data.mdx +++ b/packages/twenty-docs/l/cs/user-guide/data-migration/how-tos/export-your-data.mdx @@ -24,7 +24,7 @@ Exportujte data svého pracovního prostoru do CSV pro zálohování, vytvářen * Exportují se pouze **viditelné sloupce** * Exportují se pouze **filtrované záznamy** (podle vašeho aktuálního zobrazení) -U větších exportů (20 000+ záznamů) použijte filtry pro export po dávkách nebo použijte [API](/l/cs/developers/api). +U větších exportů (20 000+ záznamů) použijte filtry pro export po dávkách nebo použijte [API](/l/cs/developers/extend/api). ### Oprávnění @@ -148,7 +148,7 @@ API nemá limit počtu záznamů: 2. Použijte GraphQL API k dotazování na záznamy 3. Zpracujte výsledky ve své aplikaci -Viz: [Dokumentace API](/l/cs/developers/api) +Viz: [Dokumentace API](/l/cs/developers/extend/api) ## Tipy a osvědčené postupy @@ -206,4 +206,4 @@ Exportované soubory mohou obsahovat citlivá data: * [Jak aktualizovat existující záznamy](/l/cs/user-guide/data-migration/how-tos/update-existing-records-via-import) — upravte a znovu importujte svůj export * [Jak importovat data přes API](/l/cs/user-guide/data-migration/how-tos/import-data-via-api) — pro velké datové sady -* [Dokumentace API](/l/cs/developers/api) — vytvářejte vlastní pracovní postupy pro export +* [Dokumentace API](/l/cs/developers/extend/api) — vytvářejte vlastní pracovní postupy pro export diff --git a/packages/twenty-docs/l/cs/user-guide/data-migration/how-tos/import-data-via-api.mdx b/packages/twenty-docs/l/cs/user-guide/data-migration/how-tos/import-data-via-api.mdx index 40f540db954..4eae5f3b6e5 100644 --- a/packages/twenty-docs/l/cs/user-guide/data-migration/how-tos/import-data-via-api.mdx +++ b/packages/twenty-docs/l/cs/user-guide/data-migration/how-tos/import-data-via-api.mdx @@ -57,10 +57,10 @@ Kdokoli s vaším klíčem API může přistupovat k datům vašeho pracovního Twenty podporuje dva typy API: -| API | Vhodné pro | Dokumentace | -| ----------- | ----------------------------------------------------------------- | ------------------------------------------------------- | -| **GraphQL** | Flexibilní dotazy, získávání souvisejících dat, komplexní operace | [Dokumentace API](/l/cs/developers/api) | -| **REST** | Jednoduché CRUD operace, známé postupy REST | [Dokumentace API](/l/cs/developers/api) | +| API | Vhodné pro | Dokumentace | +| ----------- | ----------------------------------------------------------------- | ----------------------------------------- | +| **GraphQL** | Flexibilní dotazy, získávání souvisejících dat, komplexní operace | [Dokumentace API](/l/cs/developers/extend/api) | +| **REST** | Jednoduché CRUD operace, známé postupy REST | [Dokumentace API](/l/cs/developers/extend/api) | Obě API podporují: @@ -173,4 +173,4 @@ Kontaktujte nás na [contact@twenty.com](mailto:contact@twenty.com) nebo prozkou Úplné podrobnosti implementace, ukázky kódu a referenci schématu najdete zde: -* [Dokumentace API](/l/cs/developers/api) +* [Dokumentace API](/l/cs/developers/extend/api) diff --git a/packages/twenty-docs/l/cs/user-guide/getting-started/capabilities/what-is-twenty.mdx b/packages/twenty-docs/l/cs/user-guide/getting-started/capabilities/what-is-twenty.mdx index d3bc17fa844..348c0ac5ebf 100644 --- a/packages/twenty-docs/l/cs/user-guide/getting-started/capabilities/what-is-twenty.mdx +++ b/packages/twenty-docs/l/cs/user-guide/getting-started/capabilities/what-is-twenty.mdx @@ -35,7 +35,7 @@ Open-source je základ našeho přístupu, zajišťuje, že Twenty se vyvíjí s * **Přehledy:** Sledujte výkon pomocí vlastních sestav a vizualizací. [Zobrazit přehledy](/l/cs/user-guide/dashboards/overview). * **Oprávnění a přístup:** Ovládejte, kdo může zobrazit, upravovat a spravovat vaše data pomocí oprávnění založených na rolích. [Nastavte přístup](/l/cs/user-guide/permissions-access/overview). * **Poznámky a úkoly:** Vytvářejte poznámky a úkoly propojené s vašimi záznamy pro lepší spolupráci. -* **API & Webhooks:** Připojte se k dalším aplikacím a vytvářejte vlastní integrace. [Začněte integraci](/l/cs/developers/api). +* **API & Webhooks:** Připojte se k dalším aplikacím a vytvářejte vlastní integrace. [Začněte integraci](/l/cs/developers/extend/api). ## Připojte se nyní diff --git a/packages/twenty-docs/l/cs/user-guide/workflows/how-tos/crm-automations/auto-reply-to-inbound-emails.mdx b/packages/twenty-docs/l/cs/user-guide/workflows/how-tos/crm-automations/auto-reply-to-inbound-emails.mdx new file mode 100644 index 00000000000..7d917b96740 --- /dev/null +++ b/packages/twenty-docs/l/cs/user-guide/workflows/how-tos/crm-automations/auto-reply-to-inbound-emails.mdx @@ -0,0 +1,121 @@ +--- +title: Automatická odpověď na příchozí e-maily +description: Vytvořte pracovní postup, který pomocí AI třídí příchozí e-maily a automaticky odesílá odpovědi ve vláknu. +--- + +Odpovídejte na příchozí e-maily během několika sekund — ne hodin. Tento pracovní postup využívá AI agenta k odfiltrování šumu (newslettery, spam, automatické odpovědi) a k vytvoření personalizované odpovědi na skutečné zprávy, kterou poté odešle jako odpověď ve vláknu v rámci původní konverzace. + +## Jak funguje vláknování e-mailů + +Každý e-mail obsahuje skrytou hlavičku `Message-ID` — jedinečný identifikátor přiřazený poštovním serverem odesílatele. Když odpovíte na e-mail, váš poštovní klient nastaví hlavičku `In-Reply-To`, která odkazuje na tento otisk. Takto Gmail, Outlook a další klienti seskupují zprávy do vláken. + +V Twenty je tento otisk uložen jako `headerMessageId` na objektu Message. Váš pracovní postup jej vezme a předá do pole In-Reply-To akce Odeslat e-mail. + +## Sestavení pracovního postupu + +### Krok 1: Vytvořte nový pracovní postup + +Přejděte do **Nastavení -> Pracovní postupy** a klikněte na **+ Nový pracovní postup**. + +### Krok 2: Spouštění při příchozích zprávách + +Vyberte **Když je vytvořen záznam** a zvolte **Zprávy**. + +Pokaždé, když do Twenty dorazí e-mail, toto se spustí. + + + +### Krok 3: Vyhledejte, kdo to poslal + +Přidejte akci **Vyhledat záznamy**. + +Adresa odesílatele není přímo v samotné zprávě — je v souvisejícím záznamu Message Participant. + +| Pole | Hodnota | +| ---------- | ------------------------------ | +| **Objekt** | Účastníci zprávy | +| **Filtr** | Zpráva **je** `{{trigger.id}}` | +| **Filtr** | Role **je** From | +| **Limit** | 1 | + +To vám poskytne e-mail odesílatele v `handle` a jeho jméno v `displayName`. + + + +### Krok 4: Třídění pomocí AI a návrh odpovědi + +Přidejte akci **AI Agent**. Tento jediný krok dělá dvě věci: rozhodne, zda si e-mail zaslouží odpověď, a pokud ano, napíše ji. + +Použijte prompt například takto: + +``` +You are an email triage assistant for a sales team. Read the following +inbound email and decide if it deserves a reply. + +Subject: {{trigger.subject}} +Body: {{trigger.text}} +From: {{Find Sender.first.displayName}} ({{Find Sender.first.handle}}) + +If this email is spam, a newsletter, an automated notification, or +otherwise does not need a human reply, respond with exactly: SKIP + +Otherwise, write a short, professional reply (3-4 sentences max) that: +- Acknowledges their specific message +- Lets them know someone from the team will follow up shortly +- Is warm but not overly casual + +Respond with only the reply text, no subject line or greeting prefix. +``` + +AI Agent vypíše svou odpověď do pole `response`, na které mohou navazující kroky odkazovat. + + + +### Krok 5: Rozvětvěte podle rozhodnutí AI + +Přidejte akci **If/Else** k ověření, zda se AI rozhodla odpovědět, nebo přeskočit. + +| Pole | Hodnota | +| ------------ | ----------------------------------------- | +| **Podmínka** | AI Agent `response` **neobsahuje** `SKIP` | +| **If true** | Pokračovat na Odeslat e-mail | +| **Else** | Nedělat nic (pracovní postup končí) | + +Spam, newslettery a automaticky generované zprávy se zahodí. Vše ostatní přejde do dalšího kroku. + + + +### Krok 6: Odeslat odpověď ve vlákně + +Přidejte akci **Odeslat e-mail** ve větvi "if true". Klikněte na **Pokročilé možnosti** a poté na **Přidat In-Reply-To**. + +| Pole | Hodnota | +| --------------- | -------------------------------------- | +| **Komu** | `{{Find Sender.first.handle}}` | +| **Předmět** | `Re: {{trigger.subject}}` | +| **Text zprávy** | `{{AI Triage & Draft Reply.response}}` | +| **In-Reply-To** | `{{trigger.headerMessageId}}` | + +Pole In-Reply-To je to, co z toho dělá odpověď místo nové konverzace. Příjemce ji uvidí zařazenou pod původní e-mail ve službě Gmail, v Outlooku nebo v jiném klientovi. + + + + +**In-Reply-To** očekává ze spouštěče `message.headerMessageId` — jde o jedinečný otisk e-mailu, nikoli adresu příjemce. Pokud jej necháte prázdné, e-mail se i tak odešle, jen jako samostatná zpráva. + + + +Gmail používá předmět k seskupování zpráv do vláken. Předmět **musí** začínat `Re:` (včetně dvojtečky a mezery), aby Gmail zobrazil odpověď v rámci původního vlákna. Bez toho se odpověď zobrazí jako samostatná konverzace — i když je hlavička In-Reply-To nastavena správně. + + +### Krok 7: Otestujte a aktivujte + +Klikněte na **Test**, poté zkontrolujte svého e-mailového klienta. Odpověď by se měla zobrazit vnořená pod původní zprávou. + +Aktivujte, až s tím budete spokojeni. + +## Nápady k rozšíření + +* **Odpovídat pouze VIP** — přidejte větev, která zkontroluje doménu odesílatele nebo zda existuje jako Kontakt v Twenty +* **Směrovat podle záměru** — použijte samostatné prompty pro AI Agenta k odlišnému zpracování obchodních dotazů oproti požadavkům na podporu +* **Obohaťte před odpovědí** — přidejte krok Vyhledat záznamy, který do promptu AI načte společnost odesílatele nebo historii obchodů pro osobnější odpovědi diff --git a/packages/twenty-docs/l/cs/user-guide/workflows/how-tos/crm-automations/display-related-record-data.mdx b/packages/twenty-docs/l/cs/user-guide/workflows/how-tos/crm-automations/display-related-record-data.mdx index df57a76f77f..50b4638c43e 100644 --- a/packages/twenty-docs/l/cs/user-guide/workflows/how-tos/crm-automations/display-related-record-data.mdx +++ b/packages/twenty-docs/l/cs/user-guide/workflows/how-tos/crm-automations/display-related-record-data.mdx @@ -95,7 +95,7 @@ Vytvořte cílová pole v **Nastavení → Datový model → Příležitosti**: * Velikost společnosti: `{{searchRecords[0].employees}}` -**Omezení pro Úkoly a Poznámky**: Relace u Úkolů a Poznámek jsou napevno nastaveny jako mnoho k mnoha a zatím nejsou k dispozici ve spouštěčích ani akcích pracovních postupů. Pro přístup k těmto relacím použijte místo toho [API](/l/cs/developers/api). +**Omezení pro Úkoly a Poznámky**: Relace u Úkolů a Poznámek jsou napevno nastaveny jako mnoho k mnoha a zatím nejsou k dispozici ve spouštěčích ani akcích pracovních postupů. Pro přístup k těmto relacím použijte místo toho [API](/l/cs/developers/extend/api). ## Oboustranná synchronizace diff --git a/packages/twenty-docs/l/de/developers/extend/apps/building.mdx b/packages/twenty-docs/l/de/developers/extend/apps/building.mdx index 9d83333538f..6e47243344a 100644 --- a/packages/twenty-docs/l/de/developers/extend/apps/building.mdx +++ b/packages/twenty-docs/l/de/developers/extend/apps/building.mdx @@ -563,7 +563,7 @@ Hauptpunkte: * Frontend-Komponenten sind React-Komponenten, die in isolierten Kontexten innerhalb von Twenty gerendert werden. * Das Feld `component` verweist auf Ihre React-Komponente. -* Komponenten werden während `yarn twenty app:dev` automatisch gebaut und synchronisiert. +* Komponenten werden während `yarn twenty dev` automatisch gebaut und synchronisiert. Sie können neue Frontend-Komponenten auf zwei Arten erstellen: @@ -607,7 +607,7 @@ Sie können neue Skills auf zwei Arten erstellen: ### Generierte typisierte Clients -Zwei typisierte Clients werden von `yarn twenty app:dev` automatisch generiert und basierend auf Ihrem Arbeitsbereichs-Schema in `node_modules/twenty-sdk/generated` gespeichert: +Zwei typisierte Clients werden von `yarn twenty dev` automatisch generiert und basierend auf Ihrem Arbeitsbereichs-Schema in `node_modules/twenty-sdk/generated` gespeichert: * **`CoreApiClient`** — fragt den `/graphql`-Endpunkt nach Arbeitsbereichsdaten ab * **`MetadataApiClient`** — ruft über den Endpunkt `/metadata` die Arbeitsbereichskonfiguration und Datei-Uploads ab. @@ -622,7 +622,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -Beide Clients werden von `yarn twenty app:dev` automatisch neu generiert, sobald sich Ihre Objekte oder Felder ändern. +Beide Clients werden von `yarn twenty dev` automatisch neu generiert, sobald sich Ihre Objekte oder Felder ändern. #### Laufzeit-Anmeldedaten in Logikfunktionen diff --git a/packages/twenty-docs/l/de/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/de/developers/extend/apps/getting-started.mdx index a2e8aba2c67..336ac168c22 100644 --- a/packages/twenty-docs/l/de/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/de/developers/extend/apps/getting-started.mdx @@ -32,7 +32,7 @@ npx create-twenty-app@latest my-twenty-app cd my-twenty-app # Start dev mode: automatically syncs local changes to your workspace -yarn twenty app:dev +yarn twenty dev ``` Das Scaffolding-Tool unterstützt zwei Modi, um zu steuern, welche Beispieldateien enthalten sind: @@ -64,7 +64,7 @@ yarn twenty function:execute --preInstall yarn twenty function:execute --postInstall # Uninstall the application from the current workspace -yarn twenty app:uninstall +yarn twenty uninstall # Display commands' help yarn twenty help @@ -167,7 +167,7 @@ export default defineObject({ Spätere Befehle fügen weitere Dateien und Ordner hinzu: -* `yarn twenty app:dev` generiert automatisch zwei typisierte API-Clients in `node_modules/twenty-sdk/generated`: `CoreApiClient` (für Arbeitsbereichsdaten über `/graphql`) und `MetadataApiClient` (für Arbeitsbereichskonfiguration und Datei-Uploads über `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/generated`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` fügt unter `src/` Entitätsdefinitionsdateien für Ihre benutzerdefinierten Objekte, Funktionen, Frontend-Komponenten, Rollen, Skills und mehr hinzu. ## Authentifizierung @@ -221,7 +221,7 @@ Fügen Sie dann ein `twenty`-Skript hinzu: } ``` -Jetzt können Sie alle Befehle über `yarn twenty ` ausführen, z. B. `yarn twenty app:dev`, `yarn twenty help` usw. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## So verwenden Sie eine lokale Twenty-Instanz @@ -239,7 +239,7 @@ yarn twenty remote add --local --port 3000 * Authentifizierungsfehler: Führen Sie `yarn twenty auth:login` aus und stellen Sie sicher, dass Ihr API-Schlüssel die erforderlichen Berechtigungen hat. * Verbindung zum Server nicht möglich: Überprüfen Sie die API-URL und dass der Twenty-Server erreichbar ist. -* Typen oder Client fehlen/veraltet: Starten Sie `yarn twenty app:dev` neu — der typisierte Client wird automatisch generiert. -* Dev-Modus synchronisiert nicht: Stellen Sie sicher, dass `yarn twenty app:dev` läuft und dass Änderungen von Ihrer Umgebung nicht ignoriert werden. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Discord-Hilfekanal: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/de/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/de/developers/extend/apps/publishing.mdx index 221bb8b0fe7..e8061f17840 100644 --- a/packages/twenty-docs/l/de/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/de/developers/extend/apps/publishing.mdx @@ -28,13 +28,13 @@ Die Veröffentlichung auf npm macht Ihre App im Twenty-Marktplatz auffindbar. Je 1. **App erstellen** — die CLI kompiliert Ihre TypeScript-Quellen und erzeugt das Anwendungsmanifest: ```bash filename="Terminal" -yarn twenty app:build +yarn twenty build ``` 2. **Auf npm veröffentlichen** — pushen Sie das gebaute Paket in die npm-Registry: ```bash filename="Terminal" -npx twenty app:publish +npx twenty publish ``` ### Automatische Erkennung @@ -65,14 +65,14 @@ jobs: node-version: "24" registry-url: https://registry.npmjs.org - run: yarn install --immutable - - run: npx twenty app:build + - run: npx twenty build - run: npm publish --provenance --access public working-directory: .twenty/output env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} ``` -Für andere CI-Systeme (GitLab CI, CircleCI usw.) gelten die gleichen drei Befehle: `yarn install`, `npx twenty app:build` und anschließend `npm publish` aus `.twenty/output`. +For other CI systems (GitLab CI, CircleCI, etc.), the same three commands apply: `yarn install`, `npx twenty build`, then `npm publish` from `.twenty/output`. **npm-Provenance** ist optional, wird jedoch empfohlen. Das Veröffentlichen mit `--provenance` fügt Ihrem npm-Eintrag ein Vertrauensabzeichen hinzu, sodass Nutzer überprüfen können, dass das Paket aus einem bestimmten Commit in einer öffentlichen CI-Pipeline gebaut wurde. Siehe die [npm-Provenance-Dokumentation](https://docs.npmjs.com/generating-provenance-statements) für Einrichtungshinweise. @@ -87,7 +87,7 @@ Für Apps, die Sie nicht öffentlich verfügbar machen möchten — proprietäre Erstellen Sie Ihre App und stellen Sie sie in einem Schritt auf einem bestimmten Server bereit: ```bash filename="Terminal" -npx twenty app:publish --server +npx twenty publish --server ``` Jeder Arbeitsbereich auf diesem Server kann die App anschließend über die Seite **Applications** in den Einstellungen installieren und aktualisieren. @@ -97,7 +97,7 @@ Jeder Arbeitsbereich auf diesem Server kann die App anschließend über die Seit So veröffentlichen Sie ein Update: 1. Erhöhen Sie das Feld `version` in Ihrer `package.json` -2. Pushen Sie einen neuen Tarball mit `npx twenty app:publish --server ` +2. Push a new tarball with `npx twenty publish --server ` 3. Arbeitsbereiche auf diesem Server sehen in ihren Einstellungen, dass ein Upgrade verfügbar ist. @@ -110,7 +110,7 @@ Twenty organisiert Apps in drei Kategorien, basierend auf ihrer Vertriebsart: | Kategorie | Wie es funktioniert | Im Marktplatz sichtbar? | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- | -| **Entwicklung** | Lokale Apps im Entwicklungsmodus, die über `yarn twenty app:dev` ausgeführt werden. Zum Erstellen und Testen verwendet. | Nein | +| **Entwicklung** | Local dev mode apps running via `yarn twenty dev`. Zum Erstellen und Testen verwendet. | Nein | | **Veröffentlicht** | Auf npm veröffentlichte Apps mit dem Präfix `twenty-app-`. Im Marktplatz gelistet, damit jeder Arbeitsbereich sie installieren kann. | Ja | | **Intern** | Apps, die per Tarball auf einen bestimmten Server bereitgestellt werden. Nur für Arbeitsbereiche auf diesem Server verfügbar. | Nein | diff --git a/packages/twenty-docs/l/de/developers/extend/capabilities/apps.mdx b/packages/twenty-docs/l/de/developers/extend/capabilities/apps.mdx index f04177250ae..72f003ba8c6 100644 --- a/packages/twenty-docs/l/de/developers/extend/capabilities/apps.mdx +++ b/packages/twenty-docs/l/de/developers/extend/capabilities/apps.mdx @@ -93,31 +93,31 @@ yarn twenty remote add --local --port 3000 Von hier aus können Sie: ```bash filename="Terminal" -# Eine neue Entität zu Ihrer Anwendung hinzufügen (geführt) +# Add a new entity to your application (guided) yarn twenty entity:add -# Die Funktionsprotokolle Ihrer Anwendung überwachen +# Watch your application's function logs yarn twenty function:logs -# Eine Funktion anhand ihres Namens ausführen +# Execute a function by name yarn twenty function:execute -n my-function -p '{"name": "test"}' -# Die Pre-Installationsfunktion ausführen +# Execute the pre-install function yarn twenty function:execute --preInstall -# Die Post-Installationsfunktion ausführen +# Execute the post-install function yarn twenty function:execute --postInstall -# Die Anwendung für die Verteilung erstellen -yarn twenty app:build +# Build the app for distribution +yarn twenty build -# Die Anwendung auf npm oder einen Twenty-Server veröffentlichen -yarn twenty app:publish +# Publish the app to npm or a Twenty server +yarn twenty publish -# Die Anwendung aus dem aktuellen Arbeitsbereich deinstallieren -yarn twenty app:uninstall +# Uninstall the application from the current workspace +yarn twenty uninstall -# Hilfe zu Befehlen anzeigen +# Display commands' help yarn twenty help ``` @@ -221,7 +221,7 @@ export default defineObject({ Spätere Befehle fügen weitere Dateien und Ordner hinzu: -* `yarn twenty app:dev` generiert automatisch zwei typisierte API-Clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (für Arbeitsbereichsdaten über `/graphql`) und `MetadataApiClient` (für Arbeitsbereichskonfiguration und Datei-Uploads über `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` fügt unter `src/` Entitätsdefinitionsdateien für Ihre benutzerdefinierten Objekte, Funktionen, Frontend-Komponenten, Rollen, Skills und mehr hinzu. ## Authentifizierung @@ -880,7 +880,7 @@ Hauptpunkte: * Frontend-Komponenten sind React-Komponenten, die in isolierten Kontexten innerhalb von Twenty gerendert werden. * Das Feld `component` verweist auf Ihre React-Komponente. -* Komponenten werden während `yarn twenty app:dev` automatisch gebaut und synchronisiert. +* Components are built and synced automatically during `yarn twenty dev`. Sie können neue Frontend-Komponenten auf zwei Arten erstellen: @@ -1208,7 +1208,7 @@ Sie können neue Agenten auf zwei Arten erstellen: ### Generierte typisierte Clients -Zwei typisierte Clients werden von `yarn twenty app:dev` automatisch generiert und basierend auf Ihrem Arbeitsbereichs-Schema in `node_modules/twenty-sdk/clients` gespeichert: +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/clients` based on your workspace schema: * **`CoreApiClient`** — fragt den `/graphql`-Endpunkt nach Arbeitsbereichsdaten ab * **`MetadataApiClient`** — ruft über den Endpunkt `/metadata` die Arbeitsbereichskonfiguration und Datei-Uploads ab. @@ -1224,7 +1224,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -`CoreApiClient` wird von `yarn twenty app:dev` automatisch neu generiert, sobald sich Ihre Objekte oder Felder ändern. `MetadataApiClient` ist im SDK bereits enthalten. +`CoreApiClient` is re-generated automatically by `yarn twenty dev` whenever your objects or fields change. `MetadataApiClient` ist im SDK bereits enthalten. #### Laufzeit-Anmeldedaten in Logikfunktionen @@ -1295,11 +1295,11 @@ Ein minimales End-to-End-Beispiel, das Objekte, Logikfunktionen, Frontend-Kompon Sobald Sie Ihre App mit `app:dev` entwickelt haben, verwenden Sie `app:build`, um sie in ein verteilbares Paket zu kompilieren. ```bash filename="Terminal" -# Die App erstellen (Ausgabe nach .twenty/output/) -yarn twenty app:build +# Build the app (output goes to .twenty/output/) +yarn twenty build -# Build ausführen und ein Tarball (.tgz) für die Verteilung erstellen -yarn twenty app:build --tarball +# Build and create a tarball (.tgz) for distribution +yarn twenty build --tarball ``` Der Build-Prozess: @@ -1339,10 +1339,10 @@ Verwenden Sie `app:publish`, um Ihre App zu verteilen — entweder zur npm-Regis ```bash filename="Terminal" # Publish to npm (requires npm login) -yarn twenty app:publish +yarn twenty publish # Publish with a dist-tag (e.g. beta, next) -yarn twenty app:publish --tag beta +yarn twenty publish --tag beta ``` Dies baut die App und führt `npm publish` aus dem Verzeichnis `.twenty/output/` aus. Das veröffentlichte Paket kann dann von jedem Arbeitsbereich über den Twenty-Marktplatz installiert werden. @@ -1351,7 +1351,7 @@ Dies baut die App und führt `npm publish` aus dem Verzeichnis `.twenty/output/` ```bash filename="Terminal" # Publish directly to a Twenty server -yarn twenty app:publish --server https://app.twenty.com +yarn twenty publish --server https://app.twenty.com ``` Dies erstellt beim Build einen Tarball, lädt ihn über die GraphQL-Mutation `uploadAppTarball` auf den Server hoch und stößt die Installation in einem Schritt an. Dies ist nützlich für private Bereitstellungen oder Tests gegen einen bestimmten Server. @@ -1415,13 +1415,13 @@ Fügen Sie dann ein `twenty`-Skript hinzu: } ``` -Jetzt können Sie alle Befehle über `yarn twenty ` ausführen, z. B. `yarn twenty app:dev`, `yarn twenty help` usw. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## Fehlerbehebung * Authentifizierungsfehler: Führen Sie `yarn twenty auth:login` aus und stellen Sie sicher, dass Ihr API-Schlüssel die erforderlichen Berechtigungen hat. * Verbindung zum Server nicht möglich: Überprüfen Sie die API-URL und dass der Twenty-Server erreichbar ist. -* Typen oder Client fehlen/veraltet: Starten Sie `yarn twenty app:dev` neu — der typisierte Client wird automatisch generiert. -* Dev-Modus synchronisiert nicht: Stellen Sie sicher, dass `yarn twenty app:dev` läuft und dass Änderungen von Ihrer Umgebung nicht ignoriert werden. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Discord-Hilfekanal: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/it/developers/extend/apps/building.mdx b/packages/twenty-docs/l/it/developers/extend/apps/building.mdx index b92c486b6fd..7c3e09ce5fe 100644 --- a/packages/twenty-docs/l/it/developers/extend/apps/building.mdx +++ b/packages/twenty-docs/l/it/developers/extend/apps/building.mdx @@ -563,7 +563,7 @@ Punti chiave: * I componenti front-end sono componenti React che eseguono il rendering in contesti isolati all'interno di Twenty. * Il campo `component` fa riferimento al tuo componente React. -* I componenti vengono compilati e sincronizzati automaticamente durante `yarn twenty app:dev`. +* I componenti vengono compilati e sincronizzati automaticamente durante `yarn twenty dev`. Puoi creare nuovi componenti front-end in due modi: @@ -607,7 +607,7 @@ Puoi creare nuove skill in due modi: ### Client tipizzati generati -Due client tipizzati sono generati automaticamente da `yarn twenty app:dev` e salvati in `node_modules/twenty-sdk/generated` in base allo schema del tuo spazio di lavoro: +Due client tipizzati sono generati automaticamente da `yarn twenty dev` e salvati in `node_modules/twenty-sdk/generated` in base allo schema del tuo spazio di lavoro: * **`CoreApiClient`** — interroga l'endpoint `/graphql` per i dati dello spazio di lavoro * **`MetadataApiClient`** — interroga l'endpoint `/metadata` per la configurazione dello spazio di lavoro e il caricamento dei file @@ -622,7 +622,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -Entrambi i client vengono rigenerati automaticamente da `yarn twenty app:dev` ogni volta che i tuoi oggetti o campi cambiano. +Entrambi i client vengono rigenerati automaticamente da `yarn twenty dev` ogni volta che i tuoi oggetti o campi cambiano. #### Credenziali di runtime nelle funzioni logiche diff --git a/packages/twenty-docs/l/it/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/it/developers/extend/apps/getting-started.mdx index f0921c22f46..1996217c560 100644 --- a/packages/twenty-docs/l/it/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/it/developers/extend/apps/getting-started.mdx @@ -32,7 +32,7 @@ npx create-twenty-app@latest my-twenty-app cd my-twenty-app # Start dev mode: automatically syncs local changes to your workspace -yarn twenty app:dev +yarn twenty dev ``` Lo strumento di scaffolding supporta due modalità per controllare quali file di esempio vengono inclusi: @@ -64,7 +64,7 @@ yarn twenty function:execute --preInstall yarn twenty function:execute --postInstall # Uninstall the application from the current workspace -yarn twenty app:uninstall +yarn twenty uninstall # Display commands' help yarn twenty help @@ -167,7 +167,7 @@ export default defineObject({ Comandi successivi aggiungeranno altri file e cartelle: -* `yarn twenty app:dev` genererà automaticamente due client API tipizzati in `node_modules/twenty-sdk/generated`: `CoreApiClient` (per i dati dell'area di lavoro tramite `/graphql`) e `MetadataApiClient` (per la configurazione dell'area di lavoro e il caricamento di file tramite `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/generated`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` aggiungerà file di definizione delle entità sotto `src/` per i tuoi oggetti, funzioni, componenti front-end, ruoli, competenze e altro ancora. ## Autenticazione @@ -221,7 +221,7 @@ Quindi aggiungi uno script `twenty`: } ``` -Ora puoi eseguire tutti i comandi tramite `yarn twenty `, ad es. `yarn twenty app:dev`, `yarn twenty help`, ecc. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## Come utilizzare un'istanza locale di Twenty @@ -239,7 +239,7 @@ yarn twenty remote add --local --port 3000 * Errori di autenticazione: esegui `yarn twenty auth:login` e assicurati che la tua chiave API abbia i permessi richiesti. * Impossibile connettersi al server: verifica l'URL dell'API e che il server Twenty sia raggiungibile. -* Tipi o client mancanti/obsoleti: riavvia `yarn twenty app:dev` — genera automaticamente il client tipizzato. -* Modalità di sviluppo non sincronizzata: assicurati che `yarn twenty app:dev` sia in esecuzione e che le modifiche non vengano ignorate dal tuo ambiente. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Canale di supporto su Discord: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/it/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/it/developers/extend/apps/publishing.mdx index 9f194c5e845..c546b4eb3a2 100644 --- a/packages/twenty-docs/l/it/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/it/developers/extend/apps/publishing.mdx @@ -28,13 +28,13 @@ La pubblicazione su npm rende la tua app scopribile nel marketplace di Twenty. Q 1. **Compila la tua app** — la CLI compila i tuoi sorgenti TypeScript e genera il manifest dell'applicazione: ```bash filename="Terminal" -yarn twenty app:build +yarn twenty build ``` 2. **Pubblica su npm** — esegui il push del pacchetto compilato al registro npm: ```bash filename="Terminal" -npx twenty app:publish +npx twenty publish ``` ### Rilevamento automatico @@ -65,14 +65,14 @@ jobs: node-version: "24" registry-url: https://registry.npmjs.org - run: yarn install --immutable - - run: npx twenty app:build + - run: npx twenty build - run: npm publish --provenance --access public working-directory: .twenty/output env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} ``` -Per altri sistemi CI (GitLab CI, CircleCI, ecc.), si applicano gli stessi tre comandi: `yarn install`, `npx twenty app:build`, quindi `npm publish` da `.twenty/output`. +For other CI systems (GitLab CI, CircleCI, etc.), the same three commands apply: `yarn install`, `npx twenty build`, then `npm publish` from `.twenty/output`. **npm provenance** è opzionale ma consigliata. La pubblicazione con `--provenance` aggiunge un badge di attendibilità alla tua scheda npm, consentendo agli utenti di verificare che il pacchetto sia stato creato a partire da uno specifico commit in una pipeline CI pubblica. Consulta la [documentazione su npm provenance](https://docs.npmjs.com/generating-provenance-statements) per le istruzioni di configurazione. @@ -87,7 +87,7 @@ Per le app che non vuoi rendere pubbliche — strumenti proprietari, integrazion Compila la tua app e distribuiscila su un server specifico in un solo passaggio: ```bash filename="Terminal" -npx twenty app:publish --server +npx twenty publish --server ``` Qualsiasi spazio di lavoro su quel server può quindi installare e aggiornare l'app dalla pagina delle impostazioni **Applicazioni**. @@ -97,7 +97,7 @@ Qualsiasi spazio di lavoro su quel server può quindi installare e aggiornare l' Per rilasciare un aggiornamento: 1. Incrementa il campo `version` nel tuo `package.json` -2. Esegui il push di un nuovo tarball con `npx twenty app:publish --server ` +2. Push a new tarball with `npx twenty publish --server ` 3. Gli spazi di lavoro su quel server vedranno l'aggiornamento disponibile nelle proprie impostazioni @@ -110,7 +110,7 @@ Twenty organizza le app in tre categorie in base a come vengono distribuite: | Categoria | Come funziona | Visibile nel marketplace? | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | -| **Sviluppo** | App in modalità di sviluppo locale eseguite tramite `yarn twenty app:dev`. Usate per la compilazione e i test. | No | +| **Sviluppo** | Local dev mode apps running via `yarn twenty dev`. Usate per la compilazione e i test. | No | | **Pubblicata** | App pubblicate su npm con il prefisso `twenty-app-`. Elencate nel marketplace per l'installazione da parte di qualsiasi spazio di lavoro. | Sì | | **Interna** | App distribuite tramite tarball su un server specifico. Disponibili solo per gli spazi di lavoro su quel server. | No | diff --git a/packages/twenty-docs/l/it/developers/extend/capabilities/apps.mdx b/packages/twenty-docs/l/it/developers/extend/capabilities/apps.mdx index de4de170420..2f26313dee3 100644 --- a/packages/twenty-docs/l/it/developers/extend/capabilities/apps.mdx +++ b/packages/twenty-docs/l/it/developers/extend/capabilities/apps.mdx @@ -93,31 +93,31 @@ yarn twenty remote add --local --port 3000 Da qui puoi: ```bash filename="Terminal" -# Aggiungi una nuova entità alla tua applicazione (guidata) +# Add a new entity to your application (guided) yarn twenty entity:add -# Monitora i log delle funzioni della tua applicazione +# Watch your application's function logs yarn twenty function:logs -# Esegui una funzione per nome +# Execute a function by name yarn twenty function:execute -n my-function -p '{"name": "test"}' -# Esegui la funzione di pre-installazione +# Execute the pre-install function yarn twenty function:execute --preInstall -# Esegui la funzione post-installazione +# Execute the post-install function yarn twenty function:execute --postInstall -# Compila l'app per la distribuzione -yarn twenty app:build +# Build the app for distribution +yarn twenty build -# Pubblica l'app su npm o su un server Twenty -yarn twenty app:publish +# Publish the app to npm or a Twenty server +yarn twenty publish -# Disinstalla l'applicazione dallo spazio di lavoro corrente -yarn twenty app:uninstall +# Uninstall the application from the current workspace +yarn twenty uninstall -# Mostra l'aiuto dei comandi +# Display commands' help yarn twenty help ``` @@ -221,7 +221,7 @@ export default defineObject({ Comandi successivi aggiungeranno altri file e cartelle: -* `yarn twenty app:dev` genererà automaticamente due client API tipizzati in `node_modules/twenty-sdk/clients`: `CoreApiClient` (per i dati dell'area di lavoro tramite `/graphql`) e `MetadataApiClient` (per la configurazione dell'area di lavoro e il caricamento di file tramite `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` will add entity definition files under `src/` for your custom objects, functions, front components, roles, skills, and more. ## Autenticazione @@ -880,7 +880,7 @@ Punti chiave: * I componenti front-end sono componenti React che eseguono il rendering in contesti isolati all'interno di Twenty. * Il campo `component` fa riferimento al tuo componente React. -* I componenti vengono compilati e sincronizzati automaticamente durante `yarn twenty app:dev`. +* Components are built and synced automatically during `yarn twenty dev`. Puoi creare nuovi componenti front-end in due modi: @@ -1208,7 +1208,7 @@ Puoi creare nuovi agenti in due modi: ### Client tipizzati generati -Due client tipizzati sono generati automaticamente da `yarn twenty app:dev` e salvati in `node_modules/twenty-sdk/clients` in base allo schema della tua area di lavoro: +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/clients` based on your workspace schema: * **`CoreApiClient`** — interroga l'endpoint `/graphql` per i dati dell'area di lavoro * **`MetadataApiClient`** — interroga l'endpoint `/metadata` per la configurazione dello spazio di lavoro e il caricamento dei file @@ -1224,7 +1224,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -`CoreApiClient` viene rigenerato automaticamente da `yarn twenty app:dev` ogni volta che i tuoi oggetti o campi cambiano. `MetadataApiClient` è fornito pronto all'uso con l'SDK. +`CoreApiClient` is re-generated automatically by `yarn twenty dev` whenever your objects or fields change. `MetadataApiClient` è fornito pronto all'uso con l'SDK. #### Credenziali di runtime nelle funzioni logiche @@ -1295,11 +1295,11 @@ Esplora un esempio minimale end-to-end che dimostra oggetti, funzioni logiche, c Una volta che hai sviluppato la tua app con `app:dev`, usa `app:build` per compilarla in un pacchetto distribuibile. ```bash filename="Terminal" -# Compila l'app (l'output va in .twenty/output/) -yarn twenty app:build +# Build the app (output goes to .twenty/output/) +yarn twenty build -# Compila e crea un tarball (.tgz) per la distribuzione -yarn twenty app:build --tarball +# Build and create a tarball (.tgz) for distribution +yarn twenty build --tarball ``` Il processo di compilazione: @@ -1338,11 +1338,11 @@ Usa `app:publish` per distribuire la tua app — al registro npm oppure direttam ### Pubblica su npm (predefinito) ```bash filename="Terminal" -# Pubblica su npm (richiede l'accesso a npm) -yarn twenty app:publish +# Publish to npm (requires npm login) +yarn twenty publish -# Pubblica con un dist-tag (ad es. beta, next) -yarn twenty app:publish --tag beta +# Publish with a dist-tag (e.g. beta, next) +yarn twenty publish --tag beta ``` Questo compila l'app ed esegue `npm publish` dalla directory `.twenty/output/`. Il pacchetto pubblicato può quindi essere installato dal marketplace di Twenty da qualsiasi area di lavoro. @@ -1350,8 +1350,8 @@ Questo compila l'app ed esegue `npm publish` dalla directory `.twenty/output/`. ### Pubblica su un server Twenty ```bash filename="Terminal" -# Pubblica direttamente su un server Twenty -yarn twenty app:publish --server https://app.twenty.com +# Publish directly to a Twenty server +yarn twenty publish --server https://app.twenty.com ``` Questo compila l'app con un tarball, lo carica sul server tramite la mutation GraphQL `uploadAppTarball` e avvia l'installazione in un unico passaggio. Questo è utile per distribuzioni private o per effettuare test su un server specifico. @@ -1415,13 +1415,13 @@ Quindi aggiungi uno script `twenty`: } ``` -Ora puoi eseguire tutti i comandi tramite `yarn twenty `, ad es. `yarn twenty app:dev`, `yarn twenty help`, ecc. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## Risoluzione dei problemi * Errori di autenticazione: esegui `yarn twenty auth:login` e assicurati che la tua chiave API abbia i permessi richiesti. * Impossibile connettersi al server: verifica l'URL dell'API e che il server Twenty sia raggiungibile. -* Types or client missing/outdated: restart `yarn twenty app:dev` — it auto-generates the typed client. -* Modalità di sviluppo non sincronizzata: assicurati che `yarn twenty app:dev` sia in esecuzione e che le modifiche non vengano ignorate dal tuo ambiente. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Canale di supporto su Discord: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/pt/developers/extend/apps/building.mdx b/packages/twenty-docs/l/pt/developers/extend/apps/building.mdx index 8d312c23e75..d65ea5f1822 100644 --- a/packages/twenty-docs/l/pt/developers/extend/apps/building.mdx +++ b/packages/twenty-docs/l/pt/developers/extend/apps/building.mdx @@ -563,7 +563,7 @@ Pontos-chave: * Componentes de front-end são componentes React que renderizam em contextos isolados dentro do Twenty. * O campo `component` faz referência ao seu componente React. -* Os componentes são compilados e sincronizados automaticamente durante `yarn twenty app:dev`. +* Components are built and synced automatically during `yarn twenty dev`. Você pode criar novos componentes de front-end de duas formas: @@ -607,7 +607,7 @@ Você pode criar novas habilidades de duas formas: ### Clientes tipados gerados -Dois clientes tipados são gerados automaticamente pelo `yarn twenty app:dev` e armazenados em `node_modules/twenty-sdk/generated` com base no esquema do seu espaço de trabalho: +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/generated` based on your workspace schema: * **`CoreApiClient`** — consulta o endpoint `/graphql` para dados do espaço de trabalho * **`MetadataApiClient`** — consulta o endpoint `/metadata` para obter a configuração do espaço de trabalho e o carregamento de arquivos @@ -622,7 +622,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -Ambos os clientes são regenerados automaticamente pelo `yarn twenty app:dev` sempre que seus objetos ou campos forem alterados. +Both clients are re-generated automatically by `yarn twenty dev` whenever your objects or fields change. #### Credenciais em tempo de execução em funções de lógica diff --git a/packages/twenty-docs/l/pt/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/pt/developers/extend/apps/getting-started.mdx index 63a9df9b943..f2f35b93ddd 100644 --- a/packages/twenty-docs/l/pt/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/pt/developers/extend/apps/getting-started.mdx @@ -32,7 +32,7 @@ npx create-twenty-app@latest my-twenty-app cd my-twenty-app # Start dev mode: automatically syncs local changes to your workspace -yarn twenty app:dev +yarn twenty dev ``` O gerador de estrutura oferece suporte a dois modos para controlar quais arquivos de exemplo são incluídos: @@ -64,7 +64,7 @@ yarn twenty function:execute --preInstall yarn twenty function:execute --postInstall # Uninstall the application from the current workspace -yarn twenty app:uninstall +yarn twenty uninstall # Display commands' help yarn twenty help @@ -167,7 +167,7 @@ export default defineObject({ Comandos posteriores adicionarão mais arquivos e pastas: -* `yarn twenty app:dev` irá gerar automaticamente dois clientes de API tipados em `node_modules/twenty-sdk/generated`: `CoreApiClient` (para dados do espaço de trabalho via `/graphql`) e `MetadataApiClient` (para configuração do espaço de trabalho e envio de arquivos via `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/generated`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` adicionará arquivos de definição de entidade em `src/` para seus objetos, funções, componentes de front-end, papéis e habilidades personalizados, entre outros. ## Autenticação @@ -221,7 +221,7 @@ Em seguida, adicione um script `twenty`: } ``` -Agora você pode executar todos os comandos via `yarn twenty `, por exemplo, `yarn twenty app:dev`, `yarn twenty help`, etc. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## Como usar uma instância local do Twenty @@ -239,7 +239,7 @@ yarn twenty remote add --local --port 3000 * Erros de autenticação: execute `yarn twenty auth:login` e certifique-se de que sua chave de API tenha as permissões necessárias. * Não é possível conectar ao servidor: verifique a URL da API e se o servidor do Twenty está acessível. -* Tipos ou cliente ausentes/desatualizados: reinicie `yarn twenty app:dev` — ele gera automaticamente o cliente tipado. -* Modo de desenvolvimento não sincronizando: certifique-se de que `yarn twenty app:dev` esteja em execução e de que as alterações não estejam sendo ignoradas pelo seu ambiente. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Canal de ajuda no Discord: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/pt/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/pt/developers/extend/apps/publishing.mdx index 56ccd080876..4bbf37b2972 100644 --- a/packages/twenty-docs/l/pt/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/pt/developers/extend/apps/publishing.mdx @@ -28,13 +28,13 @@ Publicar no npm torna seu aplicativo descobrível no Marketplace da Twenty. Qual 1. **Compile seu aplicativo** — a CLI compila seus códigos-fonte TypeScript e gera o manifesto do aplicativo: ```bash filename="Terminal" -yarn twenty app:build +yarn twenty build ``` 2. **Publicar no npm** — envie o pacote compilado para o registro do npm: ```bash filename="Terminal" -npx twenty app:publish +npx twenty publish ``` ### Descoberta automática @@ -65,14 +65,14 @@ jobs: node-version: "24" registry-url: https://registry.npmjs.org - run: yarn install --immutable - - run: npx twenty app:build + - run: npx twenty build - run: npm publish --provenance --access public working-directory: .twenty/output env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} ``` -Para outros sistemas de CI (GitLab CI, CircleCI etc.), aplicam-se os mesmos três comandos: `yarn install`, `npx twenty app:build` e depois `npm publish` a partir de `.twenty/output`. +For other CI systems (GitLab CI, CircleCI, etc.), the same three commands apply: `yarn install`, `npx twenty build`, then `npm publish` from `.twenty/output`. **Proveniência do npm** é opcional, mas recomendada. Publicar com `--provenance` adiciona um selo de confiança à sua listagem no npm, permitindo que os usuários verifiquem que o pacote foi construído a partir de um commit específico em um pipeline de CI público. Consulte a [documentação de proveniência do npm](https://docs.npmjs.com/generating-provenance-statements) para instruções de configuração. @@ -87,7 +87,7 @@ Para aplicativos que você não quer disponibilizar publicamente — ferramentas Compile seu aplicativo e implante-o em um servidor específico em uma única etapa: ```bash filename="Terminal" -npx twenty app:publish --server +npx twenty publish --server ``` Qualquer espaço de trabalho nesse servidor pode então instalar e atualizar o aplicativo na página de configurações de **Aplicativos**. @@ -97,7 +97,7 @@ Qualquer espaço de trabalho nesse servidor pode então instalar e atualizar o a Para lançar uma atualização: 1. Atualize o campo `version` no seu `package.json` -2. Envie um novo tarball com `npx twenty app:publish --server ` +2. Push a new tarball with `npx twenty publish --server ` 3. Os espaços de trabalho nesse servidor verão a atualização disponível nas suas configurações @@ -110,7 +110,7 @@ A Twenty organiza os aplicativos em três categorias com base em como são distr | Categoria | Como Funciona | Visível no Marketplace? | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -| **Desenvolvimento** | Aplicativos em modo de desenvolvimento local executados via `yarn twenty app:dev`. Usados para compilação e testes. | Não | +| **Desenvolvimento** | Local dev mode apps running via `yarn twenty dev`. Usados para compilação e testes. | Não | | **Publicado** | Aplicativos publicados no npm com o prefixo `twenty-app-`. Listados no Marketplace para que qualquer espaço de trabalho possa instalar. | Sim | | **Interno** | Aplicativos implantados via tarball em um servidor específico. Disponível apenas para espaços de trabalho nesse servidor. | Não | diff --git a/packages/twenty-docs/l/pt/developers/extend/capabilities/apps.mdx b/packages/twenty-docs/l/pt/developers/extend/capabilities/apps.mdx index 0a59954fa08..d4907c1a094 100644 --- a/packages/twenty-docs/l/pt/developers/extend/capabilities/apps.mdx +++ b/packages/twenty-docs/l/pt/developers/extend/capabilities/apps.mdx @@ -78,46 +78,46 @@ npx create-twenty-app@latest my-app npx create-twenty-app@latest my-app --minimal ``` -### How to use a local Twenty instance +### Como usar uma instância local do Twenty -If you're already running a local Twenty instance, you can connect to it instead of using Docker. Pass the port your local server is listening on (default: `3000`): +Se você já estiver executando uma instância local do Twenty, você pode conectar-se a ela em vez de usar o Docker. Informe a porta em que seu servidor local está escutando (padrão: `3000`): ```bash filename="Terminal" -# During scaffolding +# Durante a criação do projeto npx create-twenty-app@latest my-app --port 3000 -# Or after scaffolding +# Ou após a criação do projeto yarn twenty remote add --local --port 3000 ``` A partir daqui você pode: ```bash filename="Terminal" -# Adicionar uma nova entidade à sua aplicação (assistido) +# Add a new entity to your application (guided) yarn twenty entity:add -# Acompanhar os logs das funções da sua aplicação +# Watch your application's function logs yarn twenty function:logs -# Executar uma função pelo nome +# Execute a function by name yarn twenty function:execute -n my-function -p '{"name": "test"}' -# Executar a função de pré-instalação +# Execute the pre-install function yarn twenty function:execute --preInstall -# Executar a função de pós-instalação +# Execute the post-install function yarn twenty function:execute --postInstall -# Compilar a aplicação para distribuição -yarn twenty app:build +# Build the app for distribution +yarn twenty build -# Publicar a aplicação no npm ou em um servidor Twenty -yarn twenty app:publish +# Publish the app to npm or a Twenty server +yarn twenty publish -# Desinstalar a aplicação do espaço de trabalho atual -yarn twenty app:uninstall +# Uninstall the application from the current workspace +yarn twenty uninstall -# Exibir a ajuda dos comandos +# Display commands' help yarn twenty help ``` @@ -221,7 +221,7 @@ export default defineObject({ Comandos posteriores adicionarão mais arquivos e pastas: -* `yarn twenty app:dev` irá gerar automaticamente dois clientes de API tipados em `node_modules/twenty-sdk/clients`: `CoreApiClient` (para dados do espaço de trabalho via `/graphql`) e `MetadataApiClient` (para configuração do espaço de trabalho e envio de ficheiros via `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` adicionará arquivos de definição de entidade em `src/` para seus objetos, funções, componentes de front-end, papéis e habilidades personalizados, entre outros. ## Autenticação @@ -881,7 +881,7 @@ Pontos-chave: * Componentes de front-end são componentes React que renderizam em contextos isolados dentro do Twenty. * O campo `component` faz referência ao seu componente React. -* Os componentes são compilados e sincronizados automaticamente durante `yarn twenty app:dev`. +* Components are built and synced automatically during `yarn twenty dev`. Você pode criar novos componentes de front-end de duas formas: @@ -1209,7 +1209,7 @@ Você pode criar novos agentes de duas formas: ### Clientes tipados gerados -Dois clientes tipados são gerados automaticamente pelo `yarn twenty app:dev` e armazenados em `node_modules/twenty-sdk/clients` com base no esquema do seu espaço de trabalho: +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/clients` based on your workspace schema: * **`CoreApiClient`** — consulta o endpoint `/graphql` para dados do espaço de trabalho * **`MetadataApiClient`** — consulta o endpoint `/metadata` para obter a configuração do espaço de trabalho e o carregamento de ficheiros @@ -1225,7 +1225,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -`CoreApiClient` é regenerado automaticamente pelo `yarn twenty app:dev` sempre que os seus objetos ou campos forem alterados. `MetadataApiClient` é fornecido pré-compilado com o SDK. +`CoreApiClient` is re-generated automatically by `yarn twenty dev` whenever your objects or fields change. `MetadataApiClient` é fornecido pré-compilado com o SDK. #### Credenciais em tempo de execução em funções de lógica @@ -1296,11 +1296,11 @@ Explore um exemplo mínimo de ponta a ponta que demonstra objetos, funções de Depois de desenvolver seu app com `app:dev`, use `app:build` para compilá-lo em um pacote distribuível. ```bash filename="Terminal" -# Compilar o app (a saída vai para .twenty/output/) -yarn twenty app:build +# Build the app (output goes to .twenty/output/) +yarn twenty build -# Compilar e criar um tarball (.tgz) para distribuição -yarn twenty app:build --tarball +# Build and create a tarball (.tgz) for distribution +yarn twenty build --tarball ``` O processo de build: @@ -1340,10 +1340,10 @@ Use `app:publish` para distribuir seu app — ou para o registro do npm ou diret ```bash filename="Terminal" # Publish to npm (requires npm login) -yarn twenty app:publish +yarn twenty publish # Publish with a dist-tag (e.g. beta, next) -yarn twenty app:publish --tag beta +yarn twenty publish --tag beta ``` Isso compila o app e executa `npm publish` a partir do diretório `.twenty/output/`. O pacote publicado pode então ser instalado no marketplace da Twenty por qualquer espaço de trabalho. @@ -1352,7 +1352,7 @@ Isso compila o app e executa `npm publish` a partir do diretório `.twenty/outpu ```bash filename="Terminal" # Publish directly to a Twenty server -yarn twenty app:publish --server https://app.twenty.com +yarn twenty publish --server https://app.twenty.com ``` Isso compila o app com um tarball, faz o upload para o servidor via a mutação GraphQL `uploadAppTarball` e aciona a instalação em uma única etapa. Isso é útil para implantações privadas ou para testar em um servidor específico. @@ -1416,13 +1416,13 @@ Em seguida, adicione um script `twenty`: } ``` -Agora você pode executar todos os comandos via `yarn twenty `, por exemplo, `yarn twenty app:dev`, `yarn twenty help`, etc. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## Resolução de Problemas * Erros de autenticação: execute `yarn twenty auth:login` e certifique-se de que sua chave de API tenha as permissões necessárias. * Não é possível conectar ao servidor: verifique a URL da API e se o servidor do Twenty está acessível. -* Tipos ou cliente ausentes/desatualizados: reinicie `yarn twenty app:dev` — ele gera automaticamente o cliente tipado. -* Modo de desenvolvimento não sincronizando: certifique-se de que `yarn twenty app:dev` esteja em execução e de que as alterações não estejam sendo ignoradas pelo seu ambiente. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Canal de ajuda no Discord: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/ro/developers/extend/apps/building.mdx b/packages/twenty-docs/l/ro/developers/extend/apps/building.mdx index e224ed294f9..e5a6fb6b5ad 100644 --- a/packages/twenty-docs/l/ro/developers/extend/apps/building.mdx +++ b/packages/twenty-docs/l/ro/developers/extend/apps/building.mdx @@ -563,7 +563,7 @@ Puncte cheie: * Componentele Front sunt componente React care sunt randate în contexte izolate în cadrul Twenty. * Câmpul `component` face referire la componenta React. -* Componentele sunt construite și sincronizate automat în timpul `yarn twenty app:dev`. +* Components are built and synced automatically during `yarn twenty dev`. Puteți crea componente Front noi în două moduri: @@ -607,7 +607,7 @@ Puteți crea abilități noi în două moduri: ### Clienți tipizați generați -Doi clienți tipizați sunt generați automat de `yarn twenty app:dev` și stocați în `node_modules/twenty-sdk/generated`, pe baza schemei spațiului tău de lucru: +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/generated` based on your workspace schema: * **`CoreApiClient`** — interoghează endpointul `/graphql` pentru datele spațiului de lucru * **`MetadataApiClient`** — interoghează endpointul `/metadata` pentru configurarea spațiului de lucru și încărcarea fișierelor @@ -622,7 +622,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -Ambii clienți sunt regenerați automat de `yarn twenty app:dev` ori de câte ori obiectele sau câmpurile tale se schimbă. +Both clients are re-generated automatically by `yarn twenty dev` whenever your objects or fields change. #### Acreditări la runtime în funcțiile de logică diff --git a/packages/twenty-docs/l/ro/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/ro/developers/extend/apps/getting-started.mdx index 63dd10ad238..8672d196e0b 100644 --- a/packages/twenty-docs/l/ro/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/ro/developers/extend/apps/getting-started.mdx @@ -32,7 +32,7 @@ npx create-twenty-app@latest my-twenty-app cd my-twenty-app # Start dev mode: automatically syncs local changes to your workspace -yarn twenty app:dev +yarn twenty dev ``` Generatorul de schelet acceptă două moduri pentru a controla ce fișiere de exemplu sunt incluse: @@ -64,7 +64,7 @@ yarn twenty function:execute --preInstall yarn twenty function:execute --postInstall # Uninstall the application from the current workspace -yarn twenty app:uninstall +yarn twenty uninstall # Display commands' help yarn twenty help @@ -167,7 +167,7 @@ export default defineObject({ Comenzile ulterioare vor adăuga mai multe fișiere și foldere: -* `yarn twenty app:dev` va genera automat doi clienți API tipizați în `node_modules/twenty-sdk/generated`: `CoreApiClient` (pentru datele spațiului de lucru prin `/graphql`) și `MetadataApiClient` (pentru configurarea spațiului de lucru și încărcarea fișierelor prin `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/generated`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` va adăuga fișiere de definire a entităților în `src/` pentru obiectele, funcțiile, componentele front-end, rolurile, abilitățile și altele. ## Autentificare @@ -221,7 +221,7 @@ Apoi adăugați un script `twenty`: } ``` -Acum puteți rula toate comenzile prin `yarn twenty `, de ex. `yarn twenty app:dev`, `yarn twenty help`, etc. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## Cum să folosești o instanță Twenty locală @@ -239,7 +239,7 @@ yarn twenty remote add --local --port 3000 * Erori de autentificare: rulați `yarn twenty auth:login` și asigurați-vă că cheia API are permisiunile necesare. * Nu se poate conecta la server: verificați URL-ul API și că serverul Twenty este accesibil. -* Tipuri sau client lipsă/învechite: reporniți `yarn twenty app:dev` — acesta generează automat clientul tipizat. -* Modul dev nu sincronizează: asigurați-vă că `yarn twenty app:dev` rulează și că modificările nu sunt ignorate de mediul dvs. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Canal de ajutor pe Discord: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/ro/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/ro/developers/extend/apps/publishing.mdx index 42624544d4b..154d6479645 100644 --- a/packages/twenty-docs/l/ro/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/ro/developers/extend/apps/publishing.mdx @@ -28,13 +28,13 @@ Publicarea pe npm face ca aplicația ta să poată fi descoperită în marketpla 1. **Construiește-ți aplicația** — CLI compilează sursele TypeScript și generează manifestul aplicației: ```bash filename="Terminal" -yarn twenty app:build +yarn twenty build ``` 2. **Publică pe npm** — publică pachetul construit în registrul npm: ```bash filename="Terminal" -npx twenty app:publish +npx twenty publish ``` ### Descoperire automată @@ -65,14 +65,14 @@ jobs: node-version: "24" registry-url: https://registry.npmjs.org - run: yarn install --immutable - - run: npx twenty app:build + - run: npx twenty build - run: npm publish --provenance --access public working-directory: .twenty/output env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} ``` -Pentru alte sisteme CI (GitLab CI, CircleCI etc.), se aplică aceleași trei comenzi: `yarn install`, `npx twenty app:build`, apoi `npm publish` din `.twenty/output`. +For other CI systems (GitLab CI, CircleCI, etc.), the same three commands apply: `yarn install`, `npx twenty build`, then `npm publish` from `.twenty/output`. **npm provenance** este opțională, dar recomandată. Publicarea cu `--provenance` adaugă un badge de încredere la listarea ta în npm, permițând utilizatorilor să verifice că pachetul a fost construit dintr-un commit specific într-un pipeline CI public. Vezi [documentația npm provenance](https://docs.npmjs.com/generating-provenance-statements) pentru instrucțiuni de configurare. @@ -87,7 +87,7 @@ Pentru aplicațiile pe care nu le dorești disponibile public — instrumente pr Construiește-ți aplicația și implementeaz-o pe un server specific, într-un singur pas: ```bash filename="Terminal" -npx twenty app:publish --server +npx twenty publish --server ``` Orice spațiu de lucru de pe acel server poate apoi instala și actualiza aplicația din pagina de setări **Applications**. @@ -97,7 +97,7 @@ Orice spațiu de lucru de pe acel server poate apoi instala și actualiza aplica Pentru a lansa o actualizare: 1. Actualizează câmpul `version` din `package.json` -2. Trimite un tarball nou cu `npx twenty app:publish --server ` +2. Push a new tarball with `npx twenty publish --server ` 3. Spațiile de lucru de pe acel server vor vedea actualizarea disponibilă în setările lor @@ -110,7 +110,7 @@ Twenty organizează aplicațiile în trei categorii, în funcție de modul în c | Categorie | Cum funcționează | Vizibilă în marketplace? | | -------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | -| **Dezvoltare** | Aplicații în modul de dezvoltare local, rulate prin `yarn twenty app:dev`. Folosite pentru construire și testare. | Nu | +| **Dezvoltare** | Local dev mode apps running via `yarn twenty dev`. Folosite pentru construire și testare. | Nu | | **Publicat** | Aplicații publicate pe npm cu prefixul `twenty-app-`. Listate în marketplace pentru ca orice spațiu de lucru să le poată instala. | Da | | **Intern** | Aplicații implementate prin tarball pe un server specific. Disponibile doar pentru spațiile de lucru de pe acel server. | Nu | diff --git a/packages/twenty-docs/l/ro/developers/extend/capabilities/apps.mdx b/packages/twenty-docs/l/ro/developers/extend/capabilities/apps.mdx index b445e3dcb71..352f1afd029 100644 --- a/packages/twenty-docs/l/ro/developers/extend/capabilities/apps.mdx +++ b/packages/twenty-docs/l/ro/developers/extend/capabilities/apps.mdx @@ -78,9 +78,9 @@ npx create-twenty-app@latest my-app npx create-twenty-app@latest my-app --minimal ``` -### How to use a local Twenty instance +### Cum să folosești o instanță Twenty locală -If you're already running a local Twenty instance, you can connect to it instead of using Docker. Pass the port your local server is listening on (default: `3000`): +Dacă rulezi deja o instanță Twenty locală, te poți conecta la ea în loc să folosești Docker. Specifică portul pe care ascultă serverul tău local (implicit: `3000`): ```bash filename="Terminal" # During scaffolding @@ -109,13 +109,13 @@ yarn twenty function:execute --preInstall yarn twenty function:execute --postInstall # Build the app for distribution -yarn twenty app:build +yarn twenty build # Publish the app to npm or a Twenty server -yarn twenty app:publish +yarn twenty publish # Uninstall the application from the current workspace -yarn twenty app:uninstall +yarn twenty uninstall # Display commands' help yarn twenty help @@ -221,7 +221,7 @@ export default defineObject({ Comenzile ulterioare vor adăuga mai multe fișiere și foldere: -* `yarn twenty app:dev` va genera automat doi clienți API tipizați în `node_modules/twenty-sdk/clients`: `CoreApiClient` (pentru datele spațiului de lucru prin `/graphql`) și `MetadataApiClient` (pentru configurarea spațiului de lucru și încărcarea fișierelor prin `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` va adăuga fișiere de definire a entităților în `src/` pentru obiectele, funcțiile, componentele front-end, rolurile, abilitățile și altele. ## Autentificare @@ -880,7 +880,7 @@ Puncte cheie: * Componentele Front sunt componente React care sunt randate în contexte izolate în cadrul Twenty. * Câmpul `component` face referire la componenta React. -* Componentele sunt construite și sincronizate automat în timpul `yarn twenty app:dev`. +* Components are built and synced automatically during `yarn twenty dev`. Puteți crea componente Front noi în două moduri: @@ -1208,7 +1208,7 @@ Puteți crea agenți noi în două moduri: ### Generated typed clients -Doi clienți tipizați sunt generați automat de `yarn twenty app:dev` și stocați în `node_modules/twenty-sdk/clients`, pe baza schemei spațiului tău de lucru: +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/clients` based on your workspace schema: * **`CoreApiClient`** — queries the `/graphql` endpoint for workspace data * **`MetadataApiClient`** — interoghează endpointul `/metadata` pentru configurarea spațiului de lucru și încărcarea fișierelor @@ -1224,7 +1224,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -`CoreApiClient` este regenerat automat de `yarn twenty app:dev` ori de câte ori obiectele sau câmpurile tale se schimbă. `MetadataApiClient` este livrat preconstruit împreună cu SDK-ul. +`CoreApiClient` is re-generated automatically by `yarn twenty dev` whenever your objects or fields change. `MetadataApiClient` este livrat preconstruit împreună cu SDK-ul. #### Acreditări la runtime în funcțiile de logică @@ -1296,10 +1296,10 @@ Once you've developed your app with `app:dev`, use `app:build` to compile it int ```bash filename="Terminal" # Build the app (output goes to .twenty/output/) -yarn twenty app:build +yarn twenty build # Build and create a tarball (.tgz) for distribution -yarn twenty app:build --tarball +yarn twenty build --tarball ``` The build process: @@ -1338,11 +1338,11 @@ Folosește `app:publish` pentru a distribui aplicația — fie în registrul npm ### Publicare pe npm (implicit) ```bash filename="Terminal" -# Publicare pe npm (necesită autentificare npm) -yarn twenty app:publish +# Publish to npm (requires npm login) +yarn twenty publish -# Publicare cu un dist-tag (de ex. beta, next) -yarn twenty app:publish --tag beta +# Publish with a dist-tag (e.g. beta, next) +yarn twenty publish --tag beta ``` Aceasta construiește aplicația și rulează `npm publish` din directorul `.twenty/output/`. Pachetul publicat poate fi apoi instalat din marketplace-ul Twenty de către orice spațiu de lucru. @@ -1350,8 +1350,8 @@ Aceasta construiește aplicația și rulează `npm publish` din directorul `.twe ### Publicare pe un server Twenty ```bash filename="Terminal" -# Publicare direct pe un server Twenty -yarn twenty app:publish --server https://app.twenty.com +# Publish directly to a Twenty server +yarn twenty publish --server https://app.twenty.com ``` Aceasta construiește aplicația cu un tarball, o încarcă pe server prin mutația GraphQL `uploadAppTarball` și declanșează instalarea într-un singur pas. Acest lucru este util pentru implementări private sau pentru testare pe un server specific. @@ -1415,13 +1415,13 @@ Apoi adăugați un script `twenty`: } ``` -Acum poți rula toate comenzile prin `yarn twenty `, de ex. `yarn twenty app:dev`, `yarn twenty help`, etc. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## Depanare * Erori de autentificare: rulați `yarn twenty auth:login` și asigurați-vă că cheia API are permisiunile necesare. * Nu se poate conecta la server: verificați URL-ul API și că serverul Twenty este accesibil. -* Types or client missing/outdated: restart `yarn twenty app:dev` — it auto-generates the typed client. -* Modul dev nu sincronizează: asigurați-vă că `yarn twenty app:dev` rulează și că modificările nu sunt ignorate de mediul dvs. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Canal de ajutor pe Discord: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/ru/developers/extend/apps/building.mdx b/packages/twenty-docs/l/ru/developers/extend/apps/building.mdx index c6dd6aa8aa0..2a3e76e6f82 100644 --- a/packages/twenty-docs/l/ru/developers/extend/apps/building.mdx +++ b/packages/twenty-docs/l/ru/developers/extend/apps/building.mdx @@ -563,7 +563,7 @@ export default defineFrontComponent({ * Фронт-компоненты — это компоненты React, которые рендерятся в изолированных контекстах внутри Twenty. * Поле `component` ссылается на ваш компонент React. -* Компоненты автоматически собираются и синхронизируются во время `yarn twenty app:dev`. +* Components are built and synced automatically during `yarn twenty dev`. Вы можете создать новые фронт-компоненты двумя способами: @@ -607,7 +607,7 @@ export default defineSkill({ ### Сгенерированные типизированные клиенты -Два типизированных клиента автоматически генерируются с помощью `yarn twenty app:dev` и сохраняются в `node_modules/twenty-sdk/generated` на основе схемы вашего рабочего пространства: +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/generated` based on your workspace schema: * **`CoreApiClient`** — выполняет запросы к конечной точке `/graphql` для получения данных рабочего пространства * **`MetadataApiClient`** — выполняет запросы к эндпоинту `/metadata` для получения конфигурации рабочего пространства и загрузки файлов. @@ -622,7 +622,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -Оба клиента автоматически перегенерируются с помощью `yarn twenty app:dev` при изменении ваших объектов или полей. +Both clients are re-generated automatically by `yarn twenty dev` whenever your objects or fields change. #### Учётные данные времени выполнения в логических функциях diff --git a/packages/twenty-docs/l/ru/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/ru/developers/extend/apps/getting-started.mdx index d1fffa35266..801a48ffdb0 100644 --- a/packages/twenty-docs/l/ru/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/ru/developers/extend/apps/getting-started.mdx @@ -32,7 +32,7 @@ npx create-twenty-app@latest my-twenty-app cd my-twenty-app # Start dev mode: automatically syncs local changes to your workspace -yarn twenty app:dev +yarn twenty dev ``` Генератор каркаса поддерживает два режима для управления тем, какие файлы-примеры включаются: @@ -64,7 +64,7 @@ yarn twenty function:execute --preInstall yarn twenty function:execute --postInstall # Uninstall the application from the current workspace -yarn twenty app:uninstall +yarn twenty uninstall # Display commands' help yarn twenty help @@ -167,7 +167,7 @@ export default defineObject({ Позднее команды добавят больше файлов и папок: -* `yarn twenty app:dev` автоматически сгенерирует два типизированных клиента API в `node_modules/twenty-sdk/generated`: `CoreApiClient` (для данных рабочего пространства через `/graphql`) и `MetadataApiClient` (для конфигурации рабочего пространства и загрузки файлов через `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/generated`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` добавит файлы определений сущностей в `src/` для ваших пользовательских объектов, функций, фронтенд-компонентов, ролей, навыков и многого другого. ## Аутентификация @@ -221,7 +221,7 @@ yarn add -D twenty-sdk } ``` -Теперь вы можете запускать все команды через `yarn twenty `, например, `yarn twenty app:dev`, `yarn twenty help` и т. д. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## Как использовать локальный экземпляр Twenty @@ -239,7 +239,7 @@ yarn twenty remote add --local --port 3000 * Ошибки аутентификации: выполните `yarn twenty auth:login` и убедитесь, что у вашего ключа API есть необходимые права. * Не удаётся подключиться к серверу: проверьте URL API и доступность сервера Twenty. -* Типы или клиент отсутствуют/устарели: перезапустите `yarn twenty app:dev` — он автоматически генерирует типизированный клиент. -* Режим разработки не синхронизируется: убедитесь, что запущен `yarn twenty app:dev`, и что ваша среда не игнорирует изменения. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Канал помощи в Discord: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/ru/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/ru/developers/extend/apps/publishing.mdx index 47b0cfcac78..56671369d6c 100644 --- a/packages/twenty-docs/l/ru/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/ru/developers/extend/apps/publishing.mdx @@ -28,13 +28,13 @@ description: Распространяйте своё приложение Twenty 1. **Соберите приложение** — CLI компилирует исходные файлы TypeScript и генерирует манифест приложения: ```bash filename="Terminal" -yarn twenty app:build +yarn twenty build ``` 2. **Опубликуйте в npm** — отправьте собранный пакет в реестр npm: ```bash filename="Terminal" -npx twenty app:publish +npx twenty publish ``` ### Автоматическое обнаружение @@ -65,14 +65,14 @@ jobs: node-version: "24" registry-url: https://registry.npmjs.org - run: yarn install --immutable - - run: npx twenty app:build + - run: npx twenty build - run: npm publish --provenance --access public working-directory: .twenty/output env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} ``` -Для других CI-систем (GitLab CI, CircleCI и др.) применимы те же три команды: `yarn install`, `npx twenty app:build`, затем `npm publish` из `.twenty/output`. +For other CI systems (GitLab CI, CircleCI, etc.), the same three commands apply: `yarn install`, `npx twenty build`, then `npm publish` from `.twenty/output`. **npm provenance** — опционально, но рекомендуется. Публикация с флагом `--provenance` добавляет к вашему пакету в npm значок доверия, позволяя пользователям проверить, что пакет был собран из конкретного коммита в общедоступном конвейере CI. См. инструкции по настройке в [документации по npm provenance](https://docs.npmjs.com/generating-provenance-statements). @@ -87,7 +87,7 @@ jobs: Соберите приложение и разверните его на конкретном сервере одним шагом: ```bash filename="Terminal" -npx twenty app:publish --server +npx twenty publish --server ``` Любое рабочее пространство на этом сервере сможет установить и обновить приложение на странице настроек **Applications**. @@ -97,7 +97,7 @@ npx twenty app:publish --server Чтобы выпустить обновление: 1. Обновите значение поля `version` в файле `package.json` -2. Отправьте новый tarball командой `npx twenty app:publish --server ` +2. Push a new tarball with `npx twenty publish --server ` 3. Рабочие пространства на этом сервере увидят доступное обновление в своих настройках @@ -110,7 +110,7 @@ Twenty группирует приложения в три категории в | Категория | Как это работает | Отображается в маркетплейсе? | | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| **Разработка** | Локальные приложения в режиме разработки, запущенные через `yarn twenty app:dev`. Используются для сборки и тестирования. | Нет | +| **Разработка** | Local dev mode apps running via `yarn twenty dev`. Используются для сборки и тестирования. | Нет | | **Опубликовано** | Приложения, опубликованные в npm с префиксом `twenty-app-`. Отображаются в маркетплейсе, доступные для установки любому рабочему пространству. | Да | | **Внутренний** | Приложения, развернутые через tarball на конкретном сервере. Доступны только рабочим пространствам на этом сервере. | Нет | diff --git a/packages/twenty-docs/l/ru/developers/extend/capabilities/apps.mdx b/packages/twenty-docs/l/ru/developers/extend/capabilities/apps.mdx index f23253bd84b..aedb6b6c5fd 100644 --- a/packages/twenty-docs/l/ru/developers/extend/capabilities/apps.mdx +++ b/packages/twenty-docs/l/ru/developers/extend/capabilities/apps.mdx @@ -78,9 +78,9 @@ npx create-twenty-app@latest my-app npx create-twenty-app@latest my-app --minimal ``` -### How to use a local Twenty instance +### Как использовать локальный экземпляр Twenty -If you're already running a local Twenty instance, you can connect to it instead of using Docker. Pass the port your local server is listening on (default: `3000`): +Если у вас уже запущен локальный экземпляр Twenty, вы можете подключиться к нему вместо использования Docker. Укажите порт, который слушает ваш локальный сервер (по умолчанию: `3000`): ```bash filename="Terminal" # During scaffolding @@ -93,31 +93,31 @@ yarn twenty remote add --local --port 3000 Отсюда вы можете: ```bash filename="Terminal" -# Добавить новую сущность в ваше приложение (с мастером) +# Add a new entity to your application (guided) yarn twenty entity:add -# Просматривать логи функций вашего приложения +# Watch your application's function logs yarn twenty function:logs -# Выполнить функцию по имени +# Execute a function by name yarn twenty function:execute -n my-function -p '{"name": "test"}' -# Выполнить предустановочную функцию +# Execute the pre-install function yarn twenty function:execute --preInstall -# Выполнить послеустановочную функцию +# Execute the post-install function yarn twenty function:execute --postInstall -# Собрать приложение для распространения -yarn twenty app:build +# Build the app for distribution +yarn twenty build -# Опубликовать приложение в npm или на сервер Twenty -yarn twenty app:publish +# Publish the app to npm or a Twenty server +yarn twenty publish -# Удалить приложение из текущего рабочего пространства -yarn twenty app:uninstall +# Uninstall the application from the current workspace +yarn twenty uninstall -# Показать справку по командам +# Display commands' help yarn twenty help ``` @@ -221,7 +221,7 @@ export default defineObject({ Позднее команды добавят больше файлов и папок: -* `yarn twenty app:dev` автоматически сгенерирует два типизированных клиента API в `node_modules/twenty-sdk/clients`: `CoreApiClient` (для данных рабочего пространства через `/graphql`) и `MetadataApiClient` (для конфигурации рабочего пространства и загрузки файлов через `/metadata`). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` добавит файлы определений сущностей в `src/` для ваших пользовательских объектов, функций, фронтенд-компонентов, ролей, навыков и многого другого. ## Аутентификация @@ -880,7 +880,7 @@ export default defineFrontComponent({ * Фронт-компоненты — это компоненты React, которые рендерятся в изолированных контекстах внутри Twenty. * Поле `component` ссылается на ваш компонент React. -* Компоненты автоматически собираются и синхронизируются во время `yarn twenty app:dev`. +* Components are built and synced automatically during `yarn twenty dev`. Вы можете создать новые фронт-компоненты двумя способами: @@ -1208,7 +1208,7 @@ export default defineAgent({ ### Сгенерированные типизированные клиенты -Два типизированных клиента автоматически генерируются с помощью `yarn twenty app:dev` и сохраняются в `node_modules/twenty-sdk/clients` на основе схемы вашего рабочего пространства: +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/clients` based on your workspace schema: * **`CoreApiClient`** — выполняет запросы к конечной точке `/graphql` для получения данных рабочего пространства * **`MetadataApiClient`** — выполняет запросы к эндпоинту `/metadata` для получения конфигурации рабочего пространства и загрузки файлов. @@ -1224,7 +1224,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -`CoreApiClient` автоматически перегенерируется с помощью `yarn twenty app:dev` при изменении ваших объектов или полей. `MetadataApiClient` поставляется готовым в составе SDK. +`CoreApiClient` is re-generated automatically by `yarn twenty dev` whenever your objects or fields change. `MetadataApiClient` поставляется готовым в составе SDK. #### Учётные данные времени выполнения в логических функциях @@ -1295,11 +1295,11 @@ uploadFile( После того как вы разработали приложение с помощью `app:dev`, используйте `app:build`, чтобы скомпилировать его в распространяемый пакет. ```bash filename="Terminal" -# Собрать приложение (результат сохраняется в .twenty/output/) -yarn twenty app:build +# Build the app (output goes to .twenty/output/) +yarn twenty build -# Собрать и создать tarball (.tgz) для распространения -yarn twenty app:build --tarball +# Build and create a tarball (.tgz) for distribution +yarn twenty build --tarball ``` Процесс сборки: @@ -1339,10 +1339,10 @@ yarn twenty app:build --tarball ```bash filename="Terminal" # Publish to npm (requires npm login) -yarn twenty app:publish +yarn twenty publish # Publish with a dist-tag (e.g. beta, next) -yarn twenty app:publish --tag beta +yarn twenty publish --tag beta ``` Это собирает приложение и выполняет `npm publish` из каталога `.twenty/output/`. Опубликованный пакет затем может быть установлен из маркетплейса Twenty любым рабочим пространством. @@ -1351,7 +1351,7 @@ yarn twenty app:publish --tag beta ```bash filename="Terminal" # Publish directly to a Twenty server -yarn twenty app:publish --server https://app.twenty.com +yarn twenty publish --server https://app.twenty.com ``` Это собирает приложение с tar-архивом, загружает его на сервер через мутацию GraphQL `uploadAppTarball` и запускает установку в один шаг. Это полезно для приватных развёртываний или тестирования на конкретном сервере. @@ -1415,13 +1415,13 @@ yarn add -D twenty-sdk } ``` -Теперь вы можете запускать все команды через `yarn twenty `, например, `yarn twenty app:dev`, `yarn twenty help` и т. д. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## Устранение неполадок * Ошибки аутентификации: выполните `yarn twenty auth:login` и убедитесь, что у вашего ключа API есть необходимые права. * Не удаётся подключиться к серверу: проверьте URL API и доступность сервера Twenty. -* Types or client missing/outdated: restart `yarn twenty app:dev` — it auto-generates the typed client. -* Режим разработки не синхронизируется: убедитесь, что запущен `yarn twenty app:dev`, и что ваша среда не игнорирует изменения. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Канал помощи в Discord: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/tr/developers/extend/apps/building.mdx b/packages/twenty-docs/l/tr/developers/extend/apps/building.mdx index bdc8277fe4f..aa4d4fd7c83 100644 --- a/packages/twenty-docs/l/tr/developers/extend/apps/building.mdx +++ b/packages/twenty-docs/l/tr/developers/extend/apps/building.mdx @@ -563,7 +563,7 @@ export default defineFrontComponent({ * Ön uç bileşenleri, Twenty içinde yalıtılmış bağlamlarda görüntülenen React bileşenleridir. * `component` alanı, React bileşeninize referans verir. -* Bileşenler, `yarn twenty app:dev` sırasında otomatik olarak oluşturulur ve senkronize edilir. +* Components are built and synced automatically during `yarn twenty dev`. Yeni ön uç bileşenlerini iki şekilde oluşturabilirsiniz: @@ -607,7 +607,7 @@ Yeni yetenekleri iki şekilde oluşturabilirsiniz: ### Oluşturulan tiplendirilmiş istemciler -Çalışma alanı şemanıza göre `yarn twenty app:dev` tarafından iki tiplendirilmiş istemci otomatik olarak oluşturulur ve `node_modules/twenty-sdk/generated` içine kaydedilir: +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/generated` based on your workspace schema: * **`CoreApiClient`** — çalışma alanı verileri için `/graphql` uç noktasını sorgular * **`MetadataApiClient`** — çalışma alanı yapılandırması ve dosya yüklemeleri için `/metadata` uç noktasını sorgular. @@ -622,7 +622,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -Her iki istemci de, nesneleriniz veya alanlarınız değiştiğinde, `yarn twenty app:dev` tarafından otomatik olarak yeniden oluşturulur. +Both clients are re-generated automatically by `yarn twenty dev` whenever your objects or fields change. #### Mantık fonksiyonlarında çalışma zamanı kimlik bilgileri diff --git a/packages/twenty-docs/l/tr/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/tr/developers/extend/apps/getting-started.mdx index b25d472b0ff..99367e20989 100644 --- a/packages/twenty-docs/l/tr/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/tr/developers/extend/apps/getting-started.mdx @@ -32,7 +32,7 @@ npx create-twenty-app@latest my-twenty-app cd my-twenty-app # Start dev mode: automatically syncs local changes to your workspace -yarn twenty app:dev +yarn twenty dev ``` İskelet oluşturucu, hangi örnek dosyaların dahil edileceğini kontrol etmek için iki modu destekler: @@ -64,7 +64,7 @@ yarn twenty function:execute --preInstall yarn twenty function:execute --postInstall # Uninstall the application from the current workspace -yarn twenty app:uninstall +yarn twenty uninstall # Display commands' help yarn twenty help @@ -167,7 +167,7 @@ export default defineObject({ İlerideki komutlar daha fazla dosya ve klasör ekleyecektir: -* `yarn twenty app:dev`, `node_modules/twenty-sdk/generated` içinde iki tiplendirilmiş API istemcisini otomatik olarak oluşturur: `CoreApiClient` (`/graphql` üzerinden çalışma alanı verileri için) ve `MetadataApiClient` (çalışma alanı yapılandırması ve `/metadata` üzerinden dosya yüklemeleri için). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/generated`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add`, özel nesneleriniz, fonksiyonlarınız, ön bileşenleriniz, rolleriniz, yetenekleriniz ve daha fazlası için `src/` altında varlık tanım dosyaları ekler. ## Kimlik Doğrulama @@ -221,7 +221,7 @@ Ardından bir `twenty` betiği ekleyin: } ``` -Artık tüm komutları `yarn twenty ` üzerinden çalıştırabilirsiniz; örn. `yarn twenty app:dev`, `yarn twenty help` vb. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## Yerel bir Twenty örneği nasıl kullanılır? @@ -239,7 +239,7 @@ yarn twenty remote add --local --port 3000 * Kimlik doğrulama hataları: `yarn twenty auth:login` çalıştırın ve API anahtarınızın gerekli izinlere sahip olduğundan emin olun. * Sunucuya bağlanılamıyor: API URL’sini ve Twenty sunucusunun erişilebilir olduğunu doğrulayın. -* Türler veya istemci eksik/eski: `yarn twenty app:dev` komutunu yeniden çalıştırın — tiplendirilmiş istemciyi otomatik olarak oluşturur. -* Geliştirme modu eşitlenmiyor: `yarn twenty app:dev`'in çalıştığından ve değişikliklerin ortamınız tarafından yok sayılmadığından emin olun. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Discord Yardım Kanalı: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/tr/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/tr/developers/extend/apps/publishing.mdx index 6962471fa6f..eae3251cdca 100644 --- a/packages/twenty-docs/l/tr/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/tr/developers/extend/apps/publishing.mdx @@ -28,13 +28,13 @@ npm’ye yayımlamak, uygulamanızın Twenty pazaryerinde keşfedilebilir olmas 1. **Uygulamanızı derleyin** — CLI, TypeScript kaynaklarınızı derler ve uygulama manifestini oluşturur: ```bash filename="Terminal" -yarn twenty app:build +yarn twenty build ``` 2. **npm’ye yayımlayın** — derlenmiş paketi npm registry’ye gönderin: ```bash filename="Terminal" -npx twenty app:publish +npx twenty publish ``` ### Otomatik keşif @@ -65,14 +65,14 @@ jobs: node-version: "24" registry-url: https://registry.npmjs.org - run: yarn install --immutable - - run: npx twenty app:build + - run: npx twenty build - run: npm publish --provenance --access public working-directory: .twenty/output env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} ``` -Diğer CI sistemleri (GitLab CI, CircleCI, vb.) için de aynı üç komut geçerlidir: `yarn install`, `npx twenty app:build` ve ardından `.twenty/output` dizininden `npm publish`. +For other CI systems (GitLab CI, CircleCI, etc.), the same three commands apply: `yarn install`, `npx twenty build`, then `npm publish` from `.twenty/output`. **npm provenance** isteğe bağlıdır ancak önerilir. `--provenance` ile yayımlamak, npm listenize bir güven rozeti ekler ve kullanıcıların paketin herkese açık bir CI ardışık düzenindeki belirli bir commit’ten oluşturulduğunu doğrulamasını sağlar. Kurulum talimatları için [npm provenance belgelerine](https://docs.npmjs.com/generating-provenance-statements) bakın. @@ -87,7 +87,7 @@ Genel kullanıma açık olmasını istemediğiniz uygulamalar — sahipli araçl Uygulamanızı derleyin ve tek adımda belirli bir sunucuya dağıtın: ```bash filename="Terminal" -npx twenty app:publish --server +npx twenty publish --server ``` Daha sonra, bu sunucudaki herhangi bir çalışma alanı uygulamayı **Applications** ayarları sayfasından yükleyip güncelleyebilir. @@ -97,7 +97,7 @@ Daha sonra, bu sunucudaki herhangi bir çalışma alanı uygulamayı **Applicati Bir güncelleme yayımlamak için: 1. `package.json` içindeki `version` alanını artırın -2. `npx twenty app:publish --server ` ile yeni bir tarball gönderin +2. Push a new tarball with `npx twenty publish --server ` 3. O sunucudaki çalışma alanları, ayarlarında kullanılabilir güncellemeyi görecektir. @@ -110,7 +110,7 @@ Twenty, uygulamaları nasıl dağıtıldıklarına göre üç kategoriye ayırı | Kategori | Nasıl Çalışır | Pazaryerinde görünür mü? | | --------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | -| **Geliştirme** | `yarn twenty app:dev` ile çalışan yerel geliştirme modu uygulamaları. Derleme ve test için kullanılır. | Hayır | +| **Geliştirme** | Local dev mode apps running via `yarn twenty dev`. Derleme ve test için kullanılır. | Hayır | | **Yayımlanmış** | `twenty-app-` önekiyle npm’ye yayımlanan uygulamalar. Herhangi bir çalışma alanının yükleyebilmesi için pazaryerinde listelenir. | Evet | | **Dahili** | Bir tarball aracılığıyla belirli bir sunucuya dağıtılan uygulamalar. Yalnızca o sunucudaki çalışma alanlarının kullanımına açıktır. | Hayır | diff --git a/packages/twenty-docs/l/tr/developers/extend/capabilities/apps.mdx b/packages/twenty-docs/l/tr/developers/extend/capabilities/apps.mdx index e3c18511b7e..13d00049c13 100644 --- a/packages/twenty-docs/l/tr/developers/extend/capabilities/apps.mdx +++ b/packages/twenty-docs/l/tr/developers/extend/capabilities/apps.mdx @@ -78,9 +78,9 @@ npx create-twenty-app@latest my-app npx create-twenty-app@latest my-app --minimal ``` -### How to use a local Twenty instance +### Yerel bir Twenty örneği nasıl kullanılır? -If you're already running a local Twenty instance, you can connect to it instead of using Docker. Pass the port your local server is listening on (default: `3000`): +Zaten yerel olarak bir Twenty örneği çalıştırıyorsanız, Docker kullanmak yerine ona bağlanabilirsiniz. Yerel sunucunuzun dinlediği bağlantı noktasını belirtin (varsayılan: `3000`): ```bash filename="Terminal" # During scaffolding @@ -109,13 +109,13 @@ yarn twenty function:execute --preInstall yarn twenty function:execute --postInstall # Build the app for distribution -yarn twenty app:build +yarn twenty build # Publish the app to npm or a Twenty server -yarn twenty app:publish +yarn twenty publish # Uninstall the application from the current workspace -yarn twenty app:uninstall +yarn twenty uninstall # Display commands' help yarn twenty help @@ -221,7 +221,7 @@ export default defineObject({ İlerideki komutlar daha fazla dosya ve klasör ekleyecektir: -* `yarn twenty app:dev`, `node_modules/twenty-sdk/clients` içinde iki tiplendirilmiş API istemcisini otomatik olarak oluşturur: `CoreApiClient` (`/graphql` üzerinden çalışma alanı verileri için) ve `MetadataApiClient` (çalışma alanı yapılandırması ve `/metadata` üzerinden dosya yüklemeleri için). +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add`, özel nesneleriniz, fonksiyonlarınız, ön bileşenleriniz, rolleriniz, yetenekleriniz ve daha fazlası için `src/` altında varlık tanım dosyaları ekler. ## Kimlik Doğrulama @@ -880,7 +880,7 @@ export default defineFrontComponent({ * Ön uç bileşenleri, Twenty içinde yalıtılmış bağlamlarda görüntülenen React bileşenleridir. * `component` alanı, React bileşeninize referans verir. -* Bileşenler, `yarn twenty app:dev` sırasında otomatik olarak oluşturulur ve senkronize edilir. +* Components are built and synced automatically during `yarn twenty dev`. Yeni ön uç bileşenlerini iki şekilde oluşturabilirsiniz: @@ -1208,7 +1208,7 @@ Yeni ajanları iki şekilde oluşturabilirsiniz: ### Oluşturulan tiplendirilmiş istemciler -Çalışma alanı şemanıza göre `yarn twenty app:dev` tarafından iki tiplendirilmiş istemci otomatik olarak oluşturulur ve `node_modules/twenty-sdk/clients` içine kaydedilir: +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/clients` based on your workspace schema: * **`CoreApiClient`** — çalışma alanı verileri için `/graphql` uç noktasını sorgular * **`MetadataApiClient`** — çalışma alanı yapılandırması ve dosya yüklemeleri için `/metadata` uç noktasını sorgular. @@ -1224,7 +1224,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -`CoreApiClient`, nesneleriniz veya alanlarınız değiştiğinde `yarn twenty app:dev` tarafından otomatik olarak yeniden oluşturulur. `MetadataApiClient`, SDK ile birlikte önceden hazırlanmış olarak gelir. +`CoreApiClient` is re-generated automatically by `yarn twenty dev` whenever your objects or fields change. `MetadataApiClient`, SDK ile birlikte önceden hazırlanmış olarak gelir. #### Mantık fonksiyonlarında çalışma zamanı kimlik bilgileri @@ -1296,10 +1296,10 @@ Uygulamanızı `app:dev` ile geliştirdikten sonra, `app:build` kullanarak onu d ```bash filename="Terminal" # Build the app (output goes to .twenty/output/) -yarn twenty app:build +yarn twenty build # Build and create a tarball (.tgz) for distribution -yarn twenty app:build --tarball +yarn twenty build --tarball ``` Derleme süreci: @@ -1339,10 +1339,10 @@ Uygulamanızı dağıtmak için `app:publish` komutunu kullanın — npm kayıt ```bash filename="Terminal" # Publish to npm (requires npm login) -yarn twenty app:publish +yarn twenty publish # Publish with a dist-tag (e.g. beta, next) -yarn twenty app:publish --tag beta +yarn twenty publish --tag beta ``` Bu, uygulamayı derler ve `.twenty/output/` dizininden `npm publish` çalıştırır. Yayımlanan paket daha sonra Twenty pazar yerinden herhangi bir çalışma alanı tarafından kurulabilir. @@ -1351,7 +1351,7 @@ Bu, uygulamayı derler ve `.twenty/output/` dizininden `npm publish` çalıştı ```bash filename="Terminal" # Publish directly to a Twenty server -yarn twenty app:publish --server https://app.twenty.com +yarn twenty publish --server https://app.twenty.com ``` Bu, uygulamayı bir tarball ile derler, `uploadAppTarball` GraphQL mutasyonu aracılığıyla sunucuya yükler ve tek adımda kurulumu tetikler. Bu, özel dağıtımlar veya belirli bir sunucuya karşı test yapmak için kullanışlıdır. @@ -1415,13 +1415,13 @@ Ardından bir `twenty` betiği ekleyin: } ``` -Artık tüm komutları `yarn twenty ` üzerinden çalıştırabilirsiniz; örn. `yarn twenty app:dev`, `yarn twenty help` vb. +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## Sorun Giderme * Kimlik doğrulama hataları: `yarn twenty auth:login` çalıştırın ve API anahtarınızın gerekli izinlere sahip olduğundan emin olun. * Sunucuya bağlanılamıyor: API URL’sini ve Twenty sunucusunun erişilebilir olduğunu doğrulayın. -* Türler veya istemci eksik/eski: `yarn twenty app:dev` komutunu yeniden çalıştırın — tip tanımlı istemciyi otomatik olarak oluşturur. -* Geliştirme modu eşitlenmiyor: `yarn twenty app:dev`'in çalıştığından ve değişikliklerin ortamınız tarafından yok sayılmadığından emin olun. +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Discord Yardım Kanalı: https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/zh/developers/extend/apps/building.mdx b/packages/twenty-docs/l/zh/developers/extend/apps/building.mdx index 8f84ee3b3e0..5cd20c07a3e 100644 --- a/packages/twenty-docs/l/zh/developers/extend/apps/building.mdx +++ b/packages/twenty-docs/l/zh/developers/extend/apps/building.mdx @@ -563,7 +563,7 @@ export default defineFrontComponent({ * 前端组件是在 Twenty 中的隔离上下文中渲染的 React 组件。 * `component` 字段引用你的 React 组件。 -* 组件会在 `yarn twenty app:dev` 期间自动构建并同步。 +* 组件会在 `yarn twenty dev` 期间自动构建并同步。 你可以通过两种方式创建新的前端组件： @@ -607,7 +607,7 @@ export default defineSkill({ ### 生成的类型化客户端 -两个类型化客户端由 `yarn twenty app:dev` 自动生成（基于你的工作区架构），并存放在 `node_modules/twenty-sdk/generated`： +两个类型化客户端会由 `yarn twenty dev` 基于你的工作区架构自动生成，并存放在 `node_modules/twenty-sdk/generated`： * **`CoreApiClient`** — 查询 `/graphql` 端点以获取工作区数据 * **`MetadataApiClient`** — 查询 `/metadata` 端点以获取工作区配置并处理文件上传 @@ -622,7 +622,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -每当你的对象或字段发生变化时，`yarn twenty app:dev` 都会自动重新生成这两个客户端。 +每当你的对象或字段发生变化时，`yarn twenty dev` 都会自动重新生成这两个客户端。 #### 逻辑函数中的运行时凭据 diff --git a/packages/twenty-docs/l/zh/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/zh/developers/extend/apps/getting-started.mdx index 29121a4b53d..5e82500dd20 100644 --- a/packages/twenty-docs/l/zh/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/zh/developers/extend/apps/getting-started.mdx @@ -32,7 +32,7 @@ npx create-twenty-app@latest my-twenty-app cd my-twenty-app # Start dev mode: automatically syncs local changes to your workspace -yarn twenty app:dev +yarn twenty dev ``` 脚手架工具支持两种模式，用于控制包含哪些示例文件： @@ -64,7 +64,7 @@ yarn twenty function:execute --preInstall yarn twenty function:execute --postInstall # Uninstall the application from the current workspace -yarn twenty app:uninstall +yarn twenty uninstall # Display commands' help yarn twenty help @@ -167,7 +167,7 @@ export default defineObject({ 后续命令将添加更多文件和文件夹： -* `yarn twenty app:dev` 会在 `node_modules/twenty-sdk/generated` 中自动生成两个类型化 API 客户端：`CoreApiClient`（通过 `/graphql` 获取工作区数据）和 `MetadataApiClient`（通过 `/metadata` 处理工作区配置和文件上传）。 +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/generated`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` 会在 `src/` 下为你的自定义对象、函数、前端组件、角色、技能等添加实体定义文件。 ## 身份验证 @@ -221,7 +221,7 @@ yarn add -D twenty-sdk } ``` -现在你可以通过 `yarn twenty ` 运行所有命令，例如 `yarn twenty app:dev`、`yarn twenty help` 等。 +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## 如何使用本地 Twenty 实例 @@ -239,7 +239,7 @@ yarn twenty remote add --local --port 3000 * 身份验证错误：运行 `yarn twenty auth:login`，并确保你的 API 密钥具有所需权限。 * 无法连接到服务器：请验证 API URL，并确保 Twenty 服务器可达。 -* 类型或客户端缺失/过期：重启 `yarn twenty app:dev` — 它会自动生成类型化客户端。 -* 开发模式未同步：确保 `yarn twenty app:dev` 正在运行，并且你的环境不会忽略变更。 +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Discord 帮助频道：https://discord.com/channels/1130383047699738754/1130386664812982322 diff --git a/packages/twenty-docs/l/zh/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/zh/developers/extend/apps/publishing.mdx index 34c27b92ead..9d8932979be 100644 --- a/packages/twenty-docs/l/zh/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/zh/developers/extend/apps/publishing.mdx @@ -28,13 +28,13 @@ description: 将你的 Twenty 应用分发到应用市场，或进行内部部 1. **构建你的应用** — CLI 会编译你的 TypeScript 源码并生成应用清单： ```bash filename="Terminal" -yarn twenty app:build +yarn twenty build ``` 2. **发布到 npm** — 将构建好的包推送到 npm 注册表： ```bash filename="Terminal" -npx twenty app:publish +npx twenty publish ``` ### 自动发现 @@ -65,14 +65,14 @@ jobs: node-version: "24" registry-url: https://registry.npmjs.org - run: yarn install --immutable - - run: npx twenty app:build + - run: npx twenty build - run: npm publish --provenance --access public working-directory: .twenty/output env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} ``` -对于其他 CI 系统（GitLab CI、CircleCI 等），同样适用以下三条命令：`yarn install`、`npx twenty app:build`，然后在 `.twenty/output` 目录下执行 `npm publish`。 +For other CI systems (GitLab CI, CircleCI, etc.), the same three commands apply: `yarn install`, `npx twenty build`, then `npm publish` from `.twenty/output`. **npm provenance** 可选，但建议启用。 使用 `--provenance` 发布会在你的 npm 列表中添加可信徽章，使用户可以验证该包是由公共 CI 流水线中的特定提交构建的。 有关设置说明，请参见 [npm provenance 文档](https://docs.npmjs.com/generating-provenance-statements)。 @@ -87,7 +87,7 @@ jobs: 在一步中构建你的应用并将其部署到特定服务器： ```bash filename="Terminal" -npx twenty app:publish --server +npx twenty publish --server ``` 该服务器上的任何工作区随后都可以在**应用程序**设置页面安装和升级该应用。 @@ -97,7 +97,7 @@ npx twenty app:publish --server 要发布更新： 1. 更新 `package.json` 中的 `version` 字段 -2. 使用 `npx twenty app:publish --server ` 推送新的 tar 包 +2. Push a new tarball with `npx twenty publish --server ` 3. 该服务器上的工作区会在其设置中看到可用的升级 @@ -108,11 +108,11 @@ npx twenty app:publish --server Twenty 会根据分发方式将应用归为三类： -| 类别 | 工作原理 | 在应用市场中可见？ | -| ------- | ------------------------------------------------- | --------- | -| **开发** | 通过 `yarn twenty app:dev` 运行的本地开发模式应用。 用于构建和测试。 | 否 | -| **已发布** | 使用 `twenty-app-` 前缀发布到 npm 的应用。 在应用市场上架，供任何工作区安装。 | 是 | -| **内部** | 通过 tar 包部署到特定服务器的应用。 仅对该服务器上的工作区可用。 | 否 | +| 类别 | 工作原理 | 在应用市场中可见？ | +| ------- | ----------------------------------------------------------- | --------- | +| **开发** | Local dev mode apps running via `yarn twenty dev`. 用于构建和测试。 | 否 | +| **已发布** | 使用 `twenty-app-` 前缀发布到 npm 的应用。 在应用市场上架，供任何工作区安装。 | 是 | +| **内部** | 通过 tar 包部署到特定服务器的应用。 仅对该服务器上的工作区可用。 | 否 | 在构建你的应用时，从**开发**模式开始。 准备就绪后，选择用于广泛分发的**已发布**（npm），或用于私有部署的**内部**（tar 包）。 diff --git a/packages/twenty-docs/l/zh/developers/extend/capabilities/apps.mdx b/packages/twenty-docs/l/zh/developers/extend/capabilities/apps.mdx index 3d6db480190..2c75c88098b 100644 --- a/packages/twenty-docs/l/zh/developers/extend/capabilities/apps.mdx +++ b/packages/twenty-docs/l/zh/developers/extend/capabilities/apps.mdx @@ -109,13 +109,13 @@ yarn twenty function:execute --preInstall yarn twenty function:execute --postInstall # Build the app for distribution -yarn twenty app:build +yarn twenty build # Publish the app to npm or a Twenty server -yarn twenty app:publish +yarn twenty publish # Uninstall the application from the current workspace -yarn twenty app:uninstall +yarn twenty uninstall # Display commands' help yarn twenty help @@ -221,7 +221,7 @@ export default defineObject({ 后续命令将添加更多文件和文件夹： -* `yarn twenty app:dev` 会在 `node_modules/twenty-sdk/clients` 中自动生成两个类型化 API 客户端：`CoreApiClient`（通过 `/graphql` 获取工作区数据）和 `MetadataApiClient`（通过 `/metadata` 处理工作区配置和文件上传）。 +* `yarn twenty dev` will auto-generate two typed API clients in `node_modules/twenty-sdk/clients`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`). * `yarn twenty entity:add` will add entity definition files under `src/` for your custom objects, functions, front components, roles, skills, and more. ## 身份验证 @@ -880,7 +880,7 @@ export default defineFrontComponent({ * 前端组件是在 Twenty 中的隔离上下文中渲染的 React 组件。 * `component` 字段引用你的 React 组件。 -* 组件会在 `yarn twenty app:dev` 期间自动构建并同步。 +* Components are built and synced automatically during `yarn twenty dev`. 你可以通过两种方式创建新的前端组件： @@ -1208,7 +1208,7 @@ export default defineAgent({ ### 生成的类型化客户端 -两个类型化客户端由 `yarn twenty app:dev` 自动生成（基于你的工作区架构），并存放在 `node_modules/twenty-sdk/clients`： +Two typed clients are auto-generated by `yarn twenty dev` and stored in `node_modules/twenty-sdk/clients` based on your workspace schema: * **`CoreApiClient`** — 查询 `/graphql` 端点以获取工作区数据 * **`MetadataApiClient`** — 查询 `/metadata` 端点以获取工作区配置并处理文件上传 @@ -1224,7 +1224,7 @@ const metadataClient = new MetadataApiClient(); const { currentWorkspace } = await metadataClient.query({ currentWorkspace: { id: true } }); ``` -每当你的对象或字段发生变化时，`yarn twenty app:dev` 都会自动重新生成 `CoreApiClient`。 `MetadataApiClient` 随 SDK 一并提供，已预构建。 +`CoreApiClient` is re-generated automatically by `yarn twenty dev` whenever your objects or fields change. `MetadataApiClient` 随 SDK 一并提供，已预构建。 #### 逻辑函数中的运行时凭据 @@ -1296,10 +1296,10 @@ Once you've developed your app with `app:dev`, use `app:build` to compile it int ```bash filename="Terminal" # Build the app (output goes to .twenty/output/) -yarn twenty app:build +yarn twenty build # Build and create a tarball (.tgz) for distribution -yarn twenty app:build --tarball +yarn twenty build --tarball ``` The build process: @@ -1339,10 +1339,10 @@ The build process: ```bash filename="Terminal" # Publish to npm (requires npm login) -yarn twenty app:publish +yarn twenty publish # Publish with a dist-tag (e.g. beta, next) -yarn twenty app:publish --tag beta +yarn twenty publish --tag beta ``` 这会构建应用，并在 `.twenty/output/` 目录下运行 `npm publish`。 发布后的软件包可由任何工作区从 Twenty 市场进行安装。 @@ -1351,7 +1351,7 @@ yarn twenty app:publish --tag beta ```bash filename="Terminal" # Publish directly to a Twenty server -yarn twenty app:publish --server https://app.twenty.com +yarn twenty publish --server https://app.twenty.com ``` 这会以 tar 包方式构建应用，通过 `uploadAppTarball` GraphQL 变更将其上传到服务器，并在一步中触发安装。 这对于私有部署或针对特定服务器进行测试非常有用。 @@ -1415,13 +1415,13 @@ yarn add -D twenty-sdk } ``` -现在你可以通过 `yarn twenty ` 运行所有命令，例如 `yarn twenty app:dev`、`yarn twenty help` 等。 +Now you can run all commands via `yarn twenty `, e.g. `yarn twenty dev`, `yarn twenty help`, etc. ## 故障排除 * 身份验证错误：运行 `yarn twenty auth:login`，并确保你的 API 密钥具有所需权限。 * 无法连接到服务器：请验证 API URL，并确保 Twenty 服务器可达。 -* 类型或客户端缺失/过期：重启 `yarn twenty app:dev` — 它会自动生成类型化客户端。 -* 开发模式未同步：确保 `yarn twenty app:dev` 正在运行，并且你的环境不会忽略变更。 +* Types or client missing/outdated: restart `yarn twenty dev` — it auto-generates the typed client. +* Dev mode not syncing: ensure `yarn twenty dev` is running and that changes are not ignored by your environment. Discord 帮助频道：https://discord.com/channels/1130383047699738754/1130386664812982322