create-twenty-app 2.2.0 → 2.3.1

package/dist/constants/template/AGENTS.md

@@ -0,0 +1,67 @@
+## Base documentation
+
+- Getting started:
+  - https://docs.twenty.com/developers/extend/apps/getting-started/quick-start.md
+  - https://docs.twenty.com/developers/extend/apps/getting-started/concepts.md
+  - https://docs.twenty.com/developers/extend/apps/getting-started/project-structure.md
+  - https://docs.twenty.com/developers/extend/apps/getting-started/local-server.md
+  - https://docs.twenty.com/developers/extend/apps/getting-started/scaffolding.md
+  - https://docs.twenty.com/developers/extend/apps/getting-started/troubleshooting.md
+- Config:
+  - https://docs.twenty.com/developers/extend/apps/config/overview.md
+  - https://docs.twenty.com/developers/extend/apps/config/application.md
+  - https://docs.twenty.com/developers/extend/apps/config/roles.md
+  - https://docs.twenty.com/developers/extend/apps/config/install-hooks.md
+  - https://docs.twenty.com/developers/extend/apps/config/public-assets.md
+- Data:
+  - https://docs.twenty.com/developers/extend/apps/data/overview.md
+  - https://docs.twenty.com/developers/extend/apps/data/objects.md
+  - https://docs.twenty.com/developers/extend/apps/data/extending-objects.md
+  - https://docs.twenty.com/developers/extend/apps/data/relations.md
+- Logic:
+  - https://docs.twenty.com/developers/extend/apps/logic/overview.md
+  - https://docs.twenty.com/developers/extend/apps/logic/logic-functions.md
+  - https://docs.twenty.com/developers/extend/apps/logic/skills-and-agents.md
+  - https://docs.twenty.com/developers/extend/apps/logic/connections.md
+- Layout:
+  - https://docs.twenty.com/developers/extend/apps/layout/overview.md
+  - https://docs.twenty.com/developers/extend/apps/layout/views.md
+  - https://docs.twenty.com/developers/extend/apps/layout/navigation-menu-items.md
+  - https://docs.twenty.com/developers/extend/apps/layout/page-layouts.md
+  - https://docs.twenty.com/developers/extend/apps/layout/front-components.md
+  - https://docs.twenty.com/developers/extend/apps/layout/command-menu-items.md
+- Operations:
+  - https://docs.twenty.com/developers/extend/apps/operations/overview.md
+  - https://docs.twenty.com/developers/extend/apps/operations/cli.md
+  - https://docs.twenty.com/developers/extend/apps/operations/testing.md
+  - https://docs.twenty.com/developers/extend/apps/operations/publishing.md
+- Rich app example: https://github.com/twentyhq/twenty/tree/main/packages/twenty-apps/examples/postcard
+
+## UUID requirement
+
+- All generated UUIDs must be valid UUID v4.
+
+## Common Pitfalls
+
+- Creating an object without an index view associated. Unless this is a technical object, user will need to visualize it.
+- Creating a view without a navigationMenuItem associated. This will make the view available on the left sidebar.
+- Creating a front-end component that has a scroll instead of being responsive to its fixed widget height and width, unless it is specifically meant to be used in a canvas tab.
+
+## Best practice
+
+It's highly recommended to create new app entities using `yarn twenty add`. These are the options:
+
+| Entity type          | Command                              | Generated file                        |
+| -------------------- | ------------------------------------ | ------------------------------------- |
+| Object               | `yarn twenty add object`             | `src/objects/<name>.ts`               |
+| Field                | `yarn twenty add field`              | `src/fields/<name>.ts`                |
+| Logic function       | `yarn twenty add logicFunction`      | `src/logic-functions/<name>.ts`       |
+| Front component      | `yarn twenty add frontComponent`     | `src/front-components/<name>.tsx`     |
+| Role                 | `yarn twenty add role`               | `src/roles/<name>.ts`                 |
+| Skill                | `yarn twenty add skill`              | `src/skills/<name>.ts`                |
+| Agent                | `yarn twenty add agent`              | `src/agents/<name>.ts`                |
+| View                 | `yarn twenty add view`               | `src/views/<name>.ts`                 |
+| Navigation menu item | `yarn twenty add navigationMenuItem` | `src/navigation-menu-items/<name>.ts` |
+| Page layout          | `yarn twenty add pageLayout`         | `src/page-layouts/<name>.ts`          |
+
+This helps automatically generate required IDs etc.

package/dist/constants/template/README.md

@@ -6,6 +6,6 @@ Run `yarn twenty help` to list all available commands.
 
 ## Learn More
 
-- [Twenty Apps documentation](https://docs.twenty.com/developers/extend/apps/getting-started)
+- [Twenty Apps documentation](https://docs.twenty.com/developers/extend/apps/getting-started/quick-start)
 - [twenty-sdk CLI reference](https://www.npmjs.com/package/twenty-sdk)
 - [Discord](https://discord.gg/cx5n4Jzs57)

package/dist/constants/template/src/application-config.ts

@@ -4,12 +4,10 @@ import {
   APP_DESCRIPTION,
   APP_DISPLAY_NAME,
   APPLICATION_UNIVERSAL_IDENTIFIER,
-  DEFAULT_ROLE_UNIVERSAL_IDENTIFIER,
 } from 'src/constants/universal-identifiers';
 
 export default defineApplication({
   universalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
   displayName: APP_DISPLAY_NAME,
   description: APP_DESCRIPTION,
-  defaultRoleUniversalIdentifier: DEFAULT_ROLE_UNIVERSAL_IDENTIFIER,
 });

package/dist/constants/template/src/default-role.ts

@@ -1,11 +1,11 @@
-import { defineRole } from 'twenty-sdk/define';
+import { defineApplicationRole } from 'twenty-sdk/define';
 
 import {
   APP_DISPLAY_NAME,
   DEFAULT_ROLE_UNIVERSAL_IDENTIFIER,
 } from 'src/constants/universal-identifiers';
 
-export default defineRole({
+export default defineApplicationRole({
   universalIdentifier: DEFAULT_ROLE_UNIVERSAL_IDENTIFIER,
   label: `${APP_DISPLAY_NAME} default function role`,
   description: `${APP_DISPLAY_NAME} default function role`,

package/dist/create-app.command.d.ts

@@ -8,12 +8,16 @@ type CreateAppOptions = {
     yes?: boolean;
 };
 export declare class CreateAppCommand {
+    private static TOTAL_STEPS;
     execute(options?: CreateAppOptions): Promise<void>;
     private getAppInfos;
     private validateDirectory;
     private tryDownloadExample;
-    private logCreationInfo;
+    private promptScaffoldConfirmation;
+    private logStep;
+    private logDetail;
     private shouldStartServer;
+    private logServerSkipped;
     private promptConnectToLocal;
     private logSuccess;
 }

package/dist/utils/app-template.d.ts

@@ -1,6 +1,7 @@
-export declare const copyBaseApplicationProject: ({ appName, appDisplayName, appDescription, appDirectory, }: {
+export declare const copyBaseApplicationProject: ({ appName, appDisplayName, appDescription, appDirectory, onProgress, }: {
     appName: string;
     appDisplayName: string;
     appDescription: string;
     appDirectory: string;
+    onProgress?: (message: string) => void;
 }) => Promise<void>;

package/dist/utils/install.d.ts

@@ -1 +1 @@
-export declare const install: (root: string) => Promise<void>;
+export declare const install: (root: string, onProgress?: (message: string) => void) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-twenty-app",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "Command-line interface to create Twenty application",
   "main": "dist/cli.cjs",
   "bin": "dist/cli.cjs",
@@ -36,7 +36,7 @@
     "lodash.camelcase": "^4.3.0",
     "lodash.kebabcase": "^4.1.1",
     "lodash.startcase": "^4.4.0",
-    "twenty-sdk": "2.2.0",
+    "twenty-sdk": "2.3.1",
     "uuid": "^13.0.0"
   },
   "devDependencies": {

package/src/constants/template/README.md

@@ -6,6 +6,6 @@ Run `yarn twenty help` to list all available commands.
 
 ## Learn More
 
-- [Twenty Apps documentation](https://docs.twenty.com/developers/extend/apps/getting-started)
+- [Twenty Apps documentation](https://docs.twenty.com/developers/extend/apps/getting-started/quick-start)
 - [twenty-sdk CLI reference](https://www.npmjs.com/package/twenty-sdk)
 - [Discord](https://discord.gg/cx5n4Jzs57)

package/dist/constants/template/AGENT.md

@@ -1,14 +0,0 @@
-## Base documentation
-
-- Documentation: https://docs.twenty.com/developers/extend/apps/getting-started
-- Rich app example: https://github.com/twentyhq/twenty/tree/main/packages/twenty-apps/examples/postcard
-
-## UUID requirement
-
-- All generated UUIDs must be valid UUID v4.
-
-## Common Pitfalls
-
-- Creating an object without an index view associated. Unless this is a technical object, user will need to visualize it.
-- Creating a view without a navigationMenuItem associated. This will make the view available on the left sidebar.
-- Creating a front-end component that has a scroll instead of being responsive to its fixed widget height and width, unless it is specifically meant to be used in a canvas tab.

package/dist/constants/template/CLAUDE.md

@@ -1,14 +0,0 @@
-## Base documentation
-
-- Documentation: https://docs.twenty.com/developers/extend/apps/getting-started
-- Rich app example: https://github.com/twentyhq/twenty/tree/main/packages/twenty-apps/examples/postcard
-
-## UUID requirement
-
-- All generated UUIDs must be valid UUID v4.
-
-## Common Pitfalls
-
-- Creating an object without an index view associated. Unless this is a technical object, user will need to visualize it.
-- Creating a view without a navigationMenuItem associated. This will make the view available on the left sidebar.
-- Creating a front-end component that has a scroll instead of being responsive to its fixed widget height and width, unless it is specifically meant to be used in a canvas tab.

package/dist/constants/template/LLMS.md

@@ -1,14 +0,0 @@
-## Base documentation
-
-- Documentation: https://docs.twenty.com/developers/extend/apps/getting-started
-- Rich app example: https://github.com/twentyhq/twenty/tree/main/packages/twenty-apps/examples/postcard
-
-## UUID requirement
-
-- All generated UUIDs must be valid UUID v4.
-
-## Common Pitfalls
-
-- Creating an object without an index view associated. Unless this is a technical object, user will need to visualize it.
-- Creating a view without a navigationMenuItem associated. This will make the view available on the left sidebar.
-- Creating a front-end component that has a scroll instead of being responsive to its fixed widget height and width, unless it is specifically meant to be used in a canvas tab.