@tailor-platform/erp-kit 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +2 -3
  3. package/package.json +1 -1
  4. package/schemas/app-compose/business-flow.yml +3 -0
  5. package/schemas/app-compose/story.yml +1 -1
  6. package/skills/erp-kit-app-1-requirements/SKILL.md +6 -12
  7. package/skills/erp-kit-app-2-breakdown/SKILL.md +3 -10
  8. package/skills/erp-kit-app-3-doc-review/SKILL.md +1 -5
  9. package/skills/{erp-kit-app-6-impl-spec → erp-kit-app-4-impl-spec}/SKILL.md +10 -21
  10. package/skills/erp-kit-app-5-implementation/SKILL.md +149 -0
  11. package/skills/erp-kit-app-5-implementation/references/backend.md +232 -0
  12. package/skills/erp-kit-app-5-implementation/references/frontend.md +242 -0
  13. package/src/module.ts +38 -0
  14. package/skills/erp-kit-app-1-requirements/references/structure.md +0 -27
  15. package/skills/erp-kit-app-2-breakdown/references/screen-detailview.md +0 -106
  16. package/skills/erp-kit-app-2-breakdown/references/screen-form.md +0 -139
  17. package/skills/erp-kit-app-2-breakdown/references/screen-listview.md +0 -153
  18. package/skills/erp-kit-app-2-breakdown/references/structure.md +0 -27
  19. package/skills/erp-kit-app-3-doc-review/references/structure.md +0 -27
  20. package/skills/erp-kit-app-4-design/SKILL.md +0 -256
  21. package/skills/erp-kit-app-4-design/references/component.md +0 -50
  22. package/skills/erp-kit-app-4-design/references/screen-detailview.md +0 -106
  23. package/skills/erp-kit-app-4-design/references/screen-form.md +0 -139
  24. package/skills/erp-kit-app-4-design/references/screen-listview.md +0 -153
  25. package/skills/erp-kit-app-4-design/references/structure.md +0 -27
  26. package/skills/erp-kit-app-5-design-review/SKILL.md +0 -290
  27. package/skills/erp-kit-app-5-design-review/references/component.md +0 -50
  28. package/skills/erp-kit-app-5-design-review/references/screen-detailview.md +0 -106
  29. package/skills/erp-kit-app-5-design-review/references/screen-form.md +0 -139
  30. package/skills/erp-kit-app-5-design-review/references/screen-listview.md +0 -153
  31. package/skills/erp-kit-app-6-impl-spec/references/auth.md +0 -72
  32. package/skills/erp-kit-app-6-impl-spec/references/structure.md +0 -27
@@ -1,106 +0,0 @@
1
- # DetailView Screen Implementation
2
-
3
- Implementation pattern for screens with `Screen Type: DetailView`.
4
- Assumes `page.md` and `component.md` rules.
5
-
6
- ## File Structure
7
-
8
- ```
9
- {screen-path}/[id]/
10
- ├── components/
11
- │ ├── {screen-name}-detail.tsx # Main content (left column)
12
- │ └── {screen-name}-actions.tsx # Action sidebar (right column)
13
- ├── edit/
14
- │ ├── components/
15
- │ │ └── edit-{screen-name}-form.tsx
16
- │ └── page.tsx
17
- └── page.tsx
18
- ```
19
-
20
- ## Layout
21
-
22
- - Two-column layout: main content on the left, actions on the right.
23
-
24
- ```tsx
25
- const ResourcePage = () => {
26
- const { id } = useParams();
27
- const [{ data, error, fetching }, reexecuteQuery] = useQuery({
28
- query: ResourceQuery,
29
- variables: { id: id! },
30
- });
31
-
32
- if (fetching) return <Loading />;
33
- if (error || !data?.resource) return <ErrorFallback ... />;
34
-
35
- return (
36
- <Layout columns={2} title="Resource Detail">
37
- <Layout.Column>
38
- <ResourceDetail resource={data.resource} />
39
- </Layout.Column>
40
- <Layout.Column>
41
- <ResourceActions resource={data.resource} />
42
- </Layout.Column>
43
- </Layout>
44
- );
45
- };
46
- ```
47
-
48
- ## Left Column: Detail Component
49
-
50
- Stack `DescriptionCard` and related tables vertically with `space-y-6`.
51
-
52
- - `DescriptionCard` (`@tailor-platform/app-shell`): renders key-value fields declaratively.
53
- - Complex content (tables, timelines): wrap in `<div className="rounded-lg border bg-card p-6">`.
54
-
55
- ### DescriptionCard
56
-
57
- ```tsx
58
- <DescriptionCard
59
- data={resource}
60
- title="Overview"
61
- columns={3}
62
- fields={[
63
- { key: "name", label: "Name", meta: { copyable: true } },
64
- {
65
- key: "status",
66
- label: "Status",
67
- type: "badge",
68
- meta: { badgeVariantMap: { ACTIVE: "success", PENDING: "warning" } },
69
- },
70
- { type: "divider" },
71
- {
72
- key: "createdAt",
73
- label: "Created At",
74
- type: "date",
75
- meta: { dateFormat: "medium" },
76
- },
77
- ]}
78
- />
79
- ```
80
-
81
- Field types: `"text"` (default), `"badge"`, `"money"`, `"date"`, `"link"`, `"address"`, `"reference"`, `"divider"`
82
-
83
- ## Right Column: Actions Component
84
-
85
- Wrap in a `Card` component. Use `Button variant="ghost"` for each action item.
86
-
87
- ```tsx
88
- <Card>
89
- <CardHeader>
90
- <CardTitle>Actions</CardTitle>
91
- </CardHeader>
92
- <CardContent className="space-y-2">
93
- <Button variant="ghost" className="w-full justify-start gap-2" asChild>
94
- <Link to="edit">✎ Edit</Link>
95
- </Button>
96
- <Button variant="ghost" className="w-full justify-start gap-2" onClick={handler}>
97
- ✓ Approve
98
- </Button>
99
- </CardContent>
100
- </Card>
101
- ```
102
-
103
- - Navigation: `<Button variant="ghost" asChild><Link to="...">`
104
- - Mutation: `<Button variant="ghost" onClick={handler}>` with custom resolvers (see `backend/resolvers.md`)
105
- - Conditional: show/hide based on status
106
- - Multiple cards: stack with `<div className="space-y-6">`
@@ -1,139 +0,0 @@
1
- # Form Screen Implementation
2
-
3
- Implementation pattern for screens with `Screen Type: Form`.
4
- Assumes `page.md` and `component.md` rules.
5
-
6
- ## File Structure
7
-
8
- ```
9
- {screen-path}/
10
- ├── components/
11
- │ └── {screen-name}-form.tsx # Form component with validation
12
- └── page.tsx
13
- ```
14
-
15
- ## Page Component (page.tsx)
16
-
17
- Form pages delegate mutation logic to the form component.
18
-
19
- ```tsx
20
- const ScreenNamePage = () => (
21
- <Layout columns={1} title="Screen Title">
22
- <Layout.Column>
23
- <ScreenNameForm />
24
- </Layout.Column>
25
- </Layout>
26
- );
27
- ```
28
-
29
- For edit forms that need existing data, co-locate data fetching in the page component:
30
-
31
- ```tsx
32
- const EditPage = () => {
33
- const { id } = useParams();
34
- const [{ data, error, fetching }] = useQuery({
35
- query: ResourceQuery,
36
- variables: { id: id! },
37
- });
38
-
39
- if (fetching) return <Loading />;
40
- if (error || !data?.resource) return <ErrorFallback ... />;
41
-
42
- return (
43
- <Layout columns={1} title="Edit Resource">
44
- <Layout.Column>
45
- <EditResourceForm resource={data.resource} />
46
- </Layout.Column>
47
- </Layout>
48
- );
49
- };
50
- ```
51
-
52
- ## Form Component (components/{screen-name}-form.tsx)
53
-
54
- ### Technology Stack
55
-
56
- - `react-hook-form` — form state management
57
- - `zod` + `@hookform/resolvers/zod` — validation
58
- - `useMutation` (urql) — GraphQL mutation
59
- - `useNavigate` (@tailor-platform/app-shell) — post-submit navigation
60
-
61
- ### Pattern
62
-
63
- ```tsx
64
- const formSchema = z.object({
65
- title: z.string().min(1, "Title is required"),
66
- description: z.string().optional(),
67
- });
68
-
69
- type FormValues = z.infer<typeof formSchema>;
70
-
71
- export const ScreenNameForm = () => {
72
- const navigate = useNavigate();
73
- const [, createResource] = useMutation(CreateMutation);
74
-
75
- const form = useForm<FormValues>({
76
- resolver: zodResolver(formSchema),
77
- defaultValues: { title: "", description: "" },
78
- });
79
-
80
- const onSubmit = (values: FormValues) => {
81
- void createResource({ input: values }).then((result) => {
82
- if (!result.error) {
83
- void navigate("..");
84
- }
85
- });
86
- };
87
-
88
- return (
89
- <Form {...form}>
90
- <form onSubmit={(e) => void form.handleSubmit(onSubmit)(e)} className="max-w-md space-y-4">
91
- <FormField
92
- control={form.control}
93
- name="title"
94
- render={({ field }) => (
95
- <FormItem>
96
- <FormLabel>Title</FormLabel>
97
- <FormControl>
98
- <Input placeholder="Enter title" {...field} />
99
- </FormControl>
100
- <FormMessage />
101
- </FormItem>
102
- )}
103
- />
104
- <div className="flex gap-2">
105
- <Button type="submit">Create</Button>
106
- <Button type="button" variant="outline" onClick={() => void navigate("..")}>
107
- Cancel
108
- </Button>
109
- </div>
110
- </form>
111
- </Form>
112
- );
113
- };
114
- ```
115
-
116
- ## Field Type Mapping
117
-
118
- | Field Type | Component | Zod Schema |
119
- | ---------- | ------------------------------ | ------------------------------- |
120
- | Text | `<Input />` | `z.string()` |
121
- | Textarea | `<textarea className="..." />` | `z.string()` |
122
- | Dropdown | `<Select />` | `z.string()` or `z.enum([...])` |
123
- | Date | `<Input type="date" />` | `z.string()` (ISO format) |
124
- | Number | `<Input type="number" />` | `z.coerce.number()` |
125
- | Email | `<Input type="email" />` | `z.string().email()` |
126
- | Checkbox | `<Checkbox />` | `z.boolean()` |
127
- | Radio | `<RadioGroup />` | `z.enum([...])` |
128
-
129
- ## Validation Mapping
130
-
131
- - **Required: Yes** → `.min(1, "Field is required")` (string) / `.positive()` (number)
132
- - **Required: No** → `.optional()`
133
-
134
- ## Key Points
135
-
136
- - Set `defaultValues` for all fields (empty string, false, etc.)
137
- - Navigate to `".."` after successful mutation
138
- - Cancel button must use `type="button"` to prevent form submit
139
- - For edit forms, accept fragment data as props and pre-fill `defaultValues`
@@ -1,153 +0,0 @@
1
- # ListView Screen Implementation
2
-
3
- Implementation pattern for screens with `Screen Type: ListView`.
4
- Assumes `page.md` and `component.md` rules.
5
-
6
- ## File Structure
7
-
8
- ```
9
- {screen-path}/
10
- ├── components/
11
- │ └── {screen-name}-table.tsx # Table component with fragments
12
- └── page.tsx
13
- ```
14
-
15
- ## Page Component (page.tsx)
16
-
17
- Data fetching and `Layout` must be co-located in the same page component.
18
- Do NOT split into an inner Content component — `Layout` requires `Layout.Column` as direct children.
19
-
20
- ```tsx
21
- const ResourcesQuery = graphql(
22
- `
23
- query Resources {
24
- resources {
25
- ...ResourceTable
26
- }
27
- }
28
- `,
29
- [ResourceTableFragment],
30
- );
31
-
32
- const ResourcesPage = () => {
33
- const [{ data, error, fetching }, reexecuteQuery] = useQuery({
34
- query: ResourcesQuery,
35
- });
36
-
37
- if (fetching) return <Loading />;
38
-
39
- if (error || !data) {
40
- return (
41
- <ErrorFallback
42
- title="Failed to load resources"
43
- message="An error occurred while fetching the list."
44
- onReset={() => reexecuteQuery({ requestPolicy: "network-only" })}
45
- />
46
- );
47
- }
48
-
49
- return (
50
- <Layout
51
- columns={1}
52
- title="Resources"
53
- actions={[
54
- <Button key="create" asChild>
55
- <Link to="create">Create</Link>
56
- </Button>,
57
- ]}
58
- >
59
- <Layout.Column>
60
- <ResourceTable data={data.resources} />
61
- </Layout.Column>
62
- </Layout>
63
- );
64
- };
65
- ```
66
-
67
- ## Table Component (components/{screen-name}-table.tsx)
68
-
69
- ### Fragment Collocation
70
-
71
- Define a row fragment and a table fragment wrapping the Connection type.
72
-
73
- ```tsx
74
- const ResourceRowFragment = graphql(`
75
- fragment ResourceRow on Resource {
76
- id
77
- title
78
- status
79
- createdAt
80
- }
81
- `);
82
-
83
- export const ResourceTableFragment = graphql(
84
- `
85
- fragment ResourceTable on ResourceConnection {
86
- edges {
87
- node {
88
- ...ResourceRow
89
- }
90
- }
91
- }
92
- `,
93
- [ResourceRowFragment],
94
- );
95
- ```
96
-
97
- ### Row Component
98
-
99
- ```tsx
100
- const ResourceRow = ({ resource: resourceFragment }: ResourceRowProps) => {
101
- const resource = readFragment(ResourceRowFragment, resourceFragment);
102
- return (
103
- <TableRow>
104
- <TableCell>{resource.title}</TableCell>
105
- <TableCell>
106
- <Badge variant={resource.status === "ACTIVE" ? "default" : "secondary"}>
107
- {resource.status}
108
- </Badge>
109
- </TableCell>
110
- <TableCell>
111
- <Button variant="ghost" size="sm" asChild>
112
- <Link to={resource.id}>View</Link>
113
- </Button>
114
- </TableCell>
115
- </TableRow>
116
- );
117
- };
118
- ```
119
-
120
- ### Empty State
121
-
122
- ```tsx
123
- if (connection.edges.length === 0) {
124
- return (
125
- <EmptyState
126
- title="No resources"
127
- message="Get started by creating a new resource."
128
- action={
129
- <Button asChild>
130
- <Link to="create">Create</Link>
131
- </Button>
132
- }
133
- />
134
- );
135
- }
136
- ```
137
-
138
- ## Column Property Mapping
139
-
140
- | Property | Implementation |
141
- | --------------- | ----------------------------------------------------------- |
142
- | Hideable: Yes | Column visibility state to toggle show/hide |
143
- | Sortable: Yes | Sort icon on `<TableHead>` + onClick to toggle query vars |
144
- | Filterable: Yes | Filter UI above table (`<Select />`) |
145
- | Searchable: Yes | Search input above table (`<Input placeholder="Search" />`) |
146
-
147
- ## Key Points
148
-
149
- - Use `<Badge />` for status columns
150
- - Format dates with `toLocaleDateString()`
151
- - Use `<EmptyState />` with Create action for empty lists
152
- - Add a View button per row to navigate to the detail page
153
- - Iterate data using Connection type `edges.node` pattern
@@ -1,72 +0,0 @@
1
- # Backend Auth Configuration
2
-
3
- Use Tailor SDK auth resources as the default pattern for backend authentication setup.
4
-
5
- ## Standard Auth Shape
6
-
7
- In `tailor.config.ts`:
8
-
9
- - Define IdP with `defineIdp(...)`
10
- - Define Auth with `defineAuth(...)`
11
- - Define static website with `defineStaticWebSite(...)` when frontend is deployed as static hosting
12
- - Wire `idProvider` via `idp.provider(...)`
13
- - Set exactly one OAuth2 client for frontend login (default client name: `default`)
14
- - Export config with `auth: auth` and `idp: [idp]`
15
- - Include static website URL in CORS when using deployed frontend (for example, `cors: ["http://localhost:5173", website.url]`)
16
-
17
- Prefer this stable naming unless there is a clear reason to change:
18
-
19
- - Auth name: `default`
20
- - IdP name: `default`
21
- - OAuth2 client name: `default`
22
-
23
- ## User Mapping
24
-
25
- Use `userProfile` to map authenticated identities to the application user type.
26
-
27
- - `type`: module-provided user type
28
- - `usernameField`: stable unique field (for example, `email`)
29
- - `attributes`: explicitly list required attributes
30
-
31
- Avoid implicit attribute assumptions.
32
-
33
- ## CORS for Static Website Login
34
-
35
- When frontend is deployed via `staticWebsites`, OAuth metadata and query calls are cross-origin from `https://<name>-<workspace>.web.erp.dev` to app backend.
36
-
37
- - Always include the deployed static website origin via `website.url` in backend `cors`
38
- - Keep local development origin in `cors` as well (for example, `http://localhost:5173`)
39
- - If your template uses IP allow lists, set `allowedIpAddresses` appropriately for Tailor internal access
40
-
41
- If `website.url` is missing from `cors`, login may fail with browser CORS errors before authentication starts.
42
-
43
- ## Seed Permission Alignment
44
-
45
- Seeded login users in `seed/data/User.jsonl` must receive module permissions required by guarded commands/resolvers.
46
-
47
- - Do not assume `ADMIN` is automatically privileged unless your permission evaluator explicitly supports it
48
- - Grant concrete permission keys defined by the module (for example, `user-management:createUser`)
49
- - Keep `User.jsonl` permissions aligned with the module currently wired in `src/modules.ts`
50
-
51
- ## Workspace and CLI Inputs
52
-
53
- Use `TAILOR_PLATFORM_WORKSPACE_ID` in backend `.env` for CLI operations.
54
-
55
- Required for non-interactive resource lookup and automation:
56
-
57
- - `tailor-sdk oauth2client list`
58
- - `tailor-sdk oauth2client get <name>`
59
-
60
- Use `--env-file <backend/.env>` for deterministic command execution in local/dev scripts.
61
-
62
- ## OAuth Client ID Source of Truth
63
-
64
- Frontend `VITE_TAILOR_CLIENT_ID` must come from backend-managed OAuth2 client data.
65
-
66
- Canonical retrieval flow:
67
-
68
- 1. `tailor-sdk oauth2client get default --json`
69
- 2. Copy `clientId` from command output
70
- 3. Set it in frontend env
71
-
72
- Do not hardcode OAuth client IDs in source code.
@@ -1,27 +0,0 @@
1
- # Application Directory Structure
2
-
3
- ```
4
- {app_name}/
5
- ├── backend/
6
- │ ├── src/
7
- │ │ ├── modules.ts # Declaring module usage
8
- │ │ ├── modules/
9
- │ │ │ └── {module-name}/ # Module-specific directory
10
- │ │ │ ├── resolvers/ # API Definition to expose graphql apis
11
- │ │ │ └── executors/ # PubSub Automation (one file per declaration)
12
- │ │ └── generated/ # Auto-generated code (do not edit)
13
- │ └── tailor.config.ts # tailor application config
14
-
15
- └── frontend/
16
- └── src/
17
- ├── pages/ # File-based routing (auto-discovered by Vite plugin)
18
- │ └── {page-path}/
19
- │ ├── page.tsx
20
- │ └── {page-path}/
21
- │ ├── components/
22
- │ └── page.tsx
23
- ├── components/
24
- │ └── ui/ # Generic UI components
25
- ├── graphql/ # gql.tada settings
26
- └── providers/ # react providers
27
- ```