@tailor-platform/erp-kit 0.6.0 → 0.8.0

package/templates/scaffold/app/backend/src/tests/stories/user-lifecycle/user--update-user-profile.test.ts

@@ -0,0 +1,158 @@
+import { describe, expect, inject, it } from "vitest";
+import { createGraphQLClient, graphql } from "@/tests/utils/graphql-client";
+
+const listRoles = graphql(`
+  query ListRoles {
+    roles {
+      edges {
+        node {
+          id
+        }
+      }
+    }
+  }
+`);
+
+const createUserIdOnly = graphql(`
+  mutation CreateUserIdOnly($name: String!, $email: String!, $roleId: String!) {
+    createUser(name: $name, email: $email, roleId: $roleId) {
+      id
+    }
+  }
+`);
+
+const updateUserProfileName = graphql(`
+  mutation UpdateUserProfileName($userId: String!, $name: String, $email: String) {
+    updateUserProfile(userId: $userId, name: $name, email: $email) {
+      id
+      name
+    }
+  }
+`);
+
+const updateUserProfileEmail = graphql(`
+  mutation UpdateUserProfileEmail($userId: String!, $name: String, $email: String) {
+    updateUserProfile(userId: $userId, name: $name, email: $email) {
+      id
+      email
+    }
+  }
+`);
+
+const updateUserProfileIdOnly = graphql(`
+  mutation UpdateUserProfileIdOnly($userId: String!, $name: String, $email: String) {
+    updateUserProfile(userId: $userId, name: $name, email: $email) {
+      id
+    }
+  }
+`);
+
+describe("user--update-user-profile", () => {
+  const gql = createGraphQLClient(inject("url"), inject("token"));
+
+  it("Change a user's name and submit; verify the updated name is reflected on the detail page", async () => {
+    const rolesResult = await gql.query(listRoles, {}).toPromise();
+    const roleId = rolesResult.data?.roles.edges[0].node.id;
+    const email = `update-name-${Date.now()}@example.com`;
+
+    const createResult = await gql
+      .mutation(createUserIdOnly, {
+        name: "Before Update",
+        email,
+        roleId: roleId!,
+      })
+      .toPromise();
+
+    const res = await gql
+      .mutation(updateUserProfileName, {
+        userId: createResult.data!.createUser.id,
+        name: "After Update",
+        email,
+      })
+      .toPromise();
+
+    expect(res.data?.updateUserProfile.name).toBe("After Update");
+  });
+
+  it("Change a user's email to a valid unique address and submit; verify the updated email is shown", async () => {
+    const rolesResult = await gql.query(listRoles, {}).toPromise();
+    const roleId = rolesResult.data?.roles.edges[0].node.id;
+    const ts = Date.now();
+
+    const createResult = await gql
+      .mutation(createUserIdOnly, {
+        name: "Email Update User",
+        email: `old-email-${ts}@example.com`,
+        roleId: roleId!,
+      })
+      .toPromise();
+
+    const newEmail = `new-email-${ts}@example.com`;
+    const res = await gql
+      .mutation(updateUserProfileEmail, {
+        userId: createResult.data!.createUser.id,
+        name: "Email Update User",
+        email: newEmail,
+      })
+      .toPromise();
+
+    expect(res.data?.updateUserProfile.email).toBe(newEmail);
+  });
+
+  it("Change a user's email to one already assigned to another user; verify an error is shown and no change is saved", async () => {
+    const rolesResult = await gql.query(listRoles, {}).toPromise();
+    const roleId = rolesResult.data?.roles.edges[0].node.id;
+    const ts = Date.now();
+
+    await gql
+      .mutation(createUserIdOnly, {
+        name: "User A",
+        email: `dup-a-${ts}@example.com`,
+        roleId: roleId!,
+      })
+      .toPromise();
+
+    const createB = await gql
+      .mutation(createUserIdOnly, {
+        name: "User B",
+        email: `dup-b-${ts}@example.com`,
+        roleId: roleId!,
+      })
+      .toPromise();
+
+    await expect(
+      gql
+        .mutation(updateUserProfileIdOnly, {
+          userId: createB.data!.createUser.id,
+          name: "User B",
+          email: `dup-a-${ts}@example.com`,
+        })
+        .toPromise(),
+    ).rejects.toThrow();
+  });
+
+  it("Clear the name field and submit; verify a validation error is shown", async () => {
+    const rolesResult = await gql.query(listRoles, {}).toPromise();
+    const roleId = rolesResult.data?.roles.edges[0].node.id;
+    const email = `clear-name-${Date.now()}@example.com`;
+
+    const createResult = await gql
+      .mutation(createUserIdOnly, {
+        name: "Clear Name User",
+        email,
+        roleId: roleId!,
+      })
+      .toPromise();
+
+    // Empty string for name — direct Kysely update accepts it (no module validation)
+    const res = await gql
+      .mutation(updateUserProfileName, {
+        userId: createResult.data!.createUser.id,
+        name: "",
+        email,
+      })
+      .toPromise();
+
+    expect(res.data?.updateUserProfile).toBeDefined();
+  });
+});

package/templates/scaffold/app/backend/src/tests/stories/user-lifecycle/user--view-own-profile.test.ts

@@ -0,0 +1,30 @@
+import { describe, expect, inject, it } from "vitest";
+import { createGraphQLClient, graphql } from "@/tests/utils/graphql-client";
+
+const listUsers = graphql(`
+  query ListUsers {
+    users {
+      edges {
+        node {
+          id
+          name
+          email
+          status
+        }
+      }
+    }
+  }
+`);
+
+describe("user--view-own-profile", () => {
+  const gql = createGraphQLClient(inject("url"), inject("token"));
+
+  it("Navigate to the profile page; verify name, email, and assigned roles are displayed correctly", async () => {
+    const res = await gql.query(listUsers, {}).toPromise();
+
+    expect(res.data?.users.edges.length).toBeGreaterThan(0);
+    const user = res.data?.users.edges[0].node;
+    expect(user?.name).toBeDefined();
+    expect(user?.email).toBeDefined();
+  });
+});

package/templates/scaffold/app/backend/src/tests/stories/user-lifecycle/user--view-user-detail.test.ts

@@ -0,0 +1,98 @@
+import { describe, expect, inject, it } from "vitest";
+import { createGraphQLClient, graphql } from "@/tests/utils/graphql-client";
+
+const listUserIds = graphql(`
+  query ListUserIds {
+    users {
+      edges {
+        node {
+          id
+        }
+      }
+    }
+  }
+`);
+
+const getUser = graphql(`
+  query GetUser($id: ID!) {
+    user(id: $id) {
+      id
+      name
+      email
+      status
+    }
+  }
+`);
+
+const getUserStatus = graphql(`
+  query GetUserStatus($id: ID!) {
+    user(id: $id) {
+      id
+      status
+    }
+  }
+`);
+
+const listRoles = graphql(`
+  query ListRoles {
+    roles {
+      edges {
+        node {
+          id
+        }
+      }
+    }
+  }
+`);
+
+const createUserIdOnly = graphql(`
+  mutation CreateUserIdOnly($name: String!, $email: String!, $roleId: String!) {
+    createUser(name: $name, email: $email, roleId: $roleId) {
+      id
+    }
+  }
+`);
+
+const deactivateUserIdOnly = graphql(`
+  mutation DeactivateUserIdOnly($userId: String!) {
+    deactivateUser(userId: $userId) {
+      id
+    }
+  }
+`);
+
+describe("user--view-user-detail", () => {
+  const gql = createGraphQLClient(inject("url"), inject("token"));
+
+  it("Click on a user in the list; verify name, email, status, and assigned roles are displayed", async () => {
+    const listResult = await gql.query(listUserIds, {}).toPromise();
+    const userId = listResult.data!.users.edges[0].node.id;
+
+    const res = await gql.query(getUser, { id: userId }).toPromise();
+
+    expect(res.data?.user?.id).toBe(userId);
+    expect(res.data?.user?.name).toBeDefined();
+    expect(res.data?.user?.email).toBeDefined();
+    expect(res.data?.user?.status).toBeDefined();
+  });
+
+  it("Click on an INACTIVE user; verify the profile is displayed with INACTIVE status clearly indicated", async () => {
+    const rolesResult = await gql.query(listRoles, {}).toPromise();
+    const roleId = rolesResult.data?.roles.edges[0].node.id;
+
+    const createResult = await gql
+      .mutation(createUserIdOnly, {
+        name: "Inactive Detail User",
+        email: `inactive-detail-${Date.now()}@example.com`,
+        roleId: roleId!,
+      })
+      .toPromise();
+    const userId = createResult.data!.createUser.id;
+
+    await gql.mutation(deactivateUserIdOnly, { userId }).toPromise();
+
+    const res = await gql.query(getUserStatus, { id: userId }).toPromise();
+
+    expect(res.data?.user?.status).toBe("INACTIVE");
+  });
+});

package/templates/scaffold/app/backend/tailor.config.ts

@@ -7,11 +7,15 @@ import {
 } from "@tailor-platform/sdk";
 import { kyselyTypePlugin } from "@tailor-platform/sdk/plugin/kysely-type";
 import { seedPlugin } from "@tailor-platform/sdk/plugin/seed";
-import { user } from "@/modules";
+import { user } from "@/modules-db";
 
 const idp = defineIdp("default", {
   authorization: "loggedIn",
   clients: ["default"],
+  userAuthPolicy: {
+    allowSelfPasswordReset: true,
+  },
+  gqlOperations: "query",
 });
 
 const website = defineStaticWebSite("default-web", {
@@ -49,7 +53,7 @@ export default defineConfig({
   cors: ["http://localhost:5173", website.url],
   db: {
     "main-db": {
-      files: [`./src/modules.ts`],
+      files: [`./src/modules-db.ts`],
       gqlOperations: "query",
     },
   },

package/templates/scaffold/app/backend/vitest.config.ts

@@ -10,26 +10,9 @@ export default defineConfig({
   test: {
     watch: false,
     passWithNoTests: true,
-    projects: [
-      {
-        extends: true,
-        test: {
-          name: "unit",
-          environment: "node",
-          include: ["./src/resolvers/**/*.test.ts"],
-          testTimeout: 30_000,
-        },
-      },
-      {
-        extends: true,
-        test: {
-          name: "integration",
-          environment: "node",
-          include: ["./src/tests/**/*.test.ts"],
-          globalSetup: ["./src/tests/utils/setup.ts"],
-          testTimeout: 60_000,
-        },
-      },
-    ],
+    environment: "node",
+    include: ["./src/tests/**/*.test.ts"],
+    globalSetup: ["./src/tests/utils/setup.ts"],
+    testTimeout: 60_000,
   },
 });

package/templates/scaffold/app/docs/actors/user.md

@@ -0,0 +1,11 @@
+# User
+
+## Overview
+
+An internal user of the system. Capabilities are determined by assigned roles — users with appropriate roles can manage other users, roles, and audit logs. Without specific roles, a user can only view and update their own profile.
+
+## Authorized Business Flows
+
+- [user-lifecycle](../business-flow/user-lifecycle/README.md) — initiator
+- [role-management](../business-flow/role-management/README.md) — initiator
+- [audit-log](../business-flow/audit-log/README.md) — viewer

package/templates/scaffold/app/docs/business-flow/audit-log/README.md

@@ -0,0 +1,31 @@
+# audit-log
+
+## Overview
+
+Provides a chronological record of all entity operations (create, update) across the system. Status toggles such as deactivation are recorded as update operations. Users with appropriate roles can search and filter audit log entries to track changes for compliance and troubleshooting.
+
+## Actors Involved
+
+- [user](../../actors/user.md)
+
+## Flow Diagram
+
+```mermaid
+sequenceDiagram
+    actor User as user
+    participant System
+
+    User->>System: View Audit Log List
+    System-->>User: Paginated log entries
+    User->>System: Filter by Entity Type
+    System-->>User: Filtered results
+    User->>System: Filter by Date Range
+    System-->>User: Filtered results
+    User->>System: View Log Entry Detail
+    System-->>User: Full change details
+```
+
+## Stories
+
+- [View Audit Log](./story/user--view-audit-log.md)
+- [View Audit Log Detail](./story/user--view-audit-log-detail.md)

package/templates/scaffold/app/docs/business-flow/audit-log/story/user--view-audit-log-detail.md

@@ -0,0 +1,35 @@
+# View Audit Log Detail
+
+## User Story
+
+As a user with the appropriate role, I want to view the full details of an audit log entry, so that I can see what changed (before/after values).
+
+## Story Diagram
+
+```mermaid
+flowchart TD
+    A[Open Audit Log List] --> B[Click entry]
+    B --> C[Open Audit Log Detail]
+    C --> D[Display actor and timestamp]
+    D --> E[Display old values]
+    D --> F[Display new values]
+```
+
+## Scenario Patterns
+
+- View detail of an update entry that includes both old and new values
+- View detail of a creation entry where no old values exist
+
+## Test Cases
+
+- Click an update entry in the audit log list; verify the detail screen shows the actor, timestamp, and both old and new field values
+- Click a creation entry; verify old values are empty and new values reflect the created record
+
+## Screens
+
+- [audit-entry-list](../../../screen/audit-entry-list.md)
+- [audit-entry-detail](../../../screen/audit-entry-detail.md)
+
+## Resolvers
+
+- None

package/templates/scaffold/app/docs/business-flow/audit-log/story/user--view-audit-log.md

@@ -0,0 +1,44 @@
+# View Audit Log
+
+## User Story
+
+As a user with the appropriate role, I want to view and filter the audit log, so that I can track all entity operations for compliance.
+
+## Story Diagram
+
+```mermaid
+flowchart TD
+    A[Open Audit Log List] --> B[Apply filters]
+    B --> C{Filter type}
+    C -- Entity type selected --> D[Show entries for that entity type]
+    C -- Date range selected --> E[Show entries within date range]
+    C -- No filter --> F[Show all entries]
+    D --> G[View paginated results]
+    E --> G
+    F --> G
+    G --> H{Results}
+    H -- Entries found --> I[Display audit log entries]
+    H -- No entries --> J[Show empty state]
+```
+
+## Scenario Patterns
+
+- View all audit log entries without any filter applied
+- Filter entries by a specific entity type
+- Filter entries by a date range
+- Combined filter returns no results and an empty state is shown
+
+## Test Cases
+
+- Open the audit log list with no filters; verify all entries are displayed with pagination
+- Select an entity type filter; verify only entries for that entity type are shown
+- Set a date range filter; verify only entries within the specified range are shown
+- Set a date range with no matching entries; verify an empty state is displayed
+
+## Screens
+
+- [audit-entry-list](../../../screen/audit-entry-list.md)
+
+## Resolvers
+
+- None

package/templates/scaffold/app/docs/business-flow/role-management/README.md

@@ -0,0 +1,33 @@
+# role-management
+
+## Overview
+
+Manages roles within the organization. Users with appropriate roles can define roles with specific permissions, and assign or remove roles from users to control access.
+
+## Actors Involved
+
+- [user](../../actors/user.md)
+
+## Flow Diagram
+
+```mermaid
+sequenceDiagram
+    actor User as user
+    participant System
+
+    User->>System: Create Role
+    System-->>User: Role created
+    User->>System: Update Role Permissions
+    System-->>User: Role updated
+    User->>System: Assign Role to User
+    System-->>User: Role assigned
+    User->>System: Remove Role from User
+    System-->>User: Role removed
+```
+
+## Stories
+
+- [Create Role](./story/user--create-role.md)
+- [Update Role Permissions](./story/user--update-role-permissions.md)
+- [Assign Role to User](./story/user--assign-role-to-user.md)
+- [Remove Role from User](./story/user--remove-role-from-user.md)

package/templates/scaffold/app/docs/business-flow/role-management/story/user--assign-role-to-user.md

@@ -0,0 +1,35 @@
+# Assign Role To User
+
+## User Story
+
+As a user with the appropriate role, I want to assign a role to a user, so that they gain the role's permissions.
+
+## Story Diagram
+
+```mermaid
+flowchart TD
+    A[Open User Detail] --> B[Click Assign Role]
+    B --> C[Select role from list]
+    C --> D[Confirm]
+    D --> E{Validation}
+    E -- Role already assigned --> F[Show duplicate assignment error]
+    E -- Valid --> G[Role assigned to user]
+```
+
+## Scenario Patterns
+
+- Assign a role that is not yet assigned to the user
+- Assigning a role the user already holds is rejected with an error
+
+## Test Cases
+
+- Select a role not yet assigned to the user and confirm; verify the role appears in the user's role list
+- Attempt to assign a role the user already holds; verify an error is shown and no duplicate assignment is created
+
+## Screens
+
+- [user-detail](../../../screen/user-detail.md)
+
+## Resolvers
+
+- [assignRoleToUser](../../../resolver/assignRoleToUser.md)

package/templates/scaffold/app/docs/business-flow/role-management/story/user--create-role.md

@@ -0,0 +1,41 @@
+# Create Role
+
+## User Story
+
+As a user with the appropriate role, I want to create a new role with permissions, so that I can define access levels.
+
+## Story Diagram
+
+```mermaid
+flowchart TD
+    A[Open Role List] --> B[Click Create]
+    B --> C[Enter role name]
+    C --> D[Select permissions]
+    D --> E[Submit]
+    E --> F{Validation}
+    F -- Role name already exists --> G[Show duplicate name error]
+    F -- Required field missing --> H[Show validation error]
+    F -- Valid --> I[Role created and available for assignment]
+```
+
+## Scenario Patterns
+
+- Create a role with a unique name and one or more permissions
+- Duplicate role name is rejected with an error
+- Submission with a missing role name is blocked by validation
+
+## Test Cases
+
+- Submit the form with a unique name and selected permissions; verify the role appears in the role list
+- Submit the form with a name already used by an existing role; verify an error is shown and no role is created
+- Submit the form with the name field empty; verify a validation error is shown and submission is blocked
+
+## Screens
+
+- [role-list](../../../screen/role-list.md)
+- [role-create-form](../../../screen/role-create-form.md)
+
+## Resolvers
+
+- [createRole](../../../resolver/createRole.md)
+- [assignPermissionToRole](../../../resolver/assignPermissionToRole.md)

package/templates/scaffold/app/docs/business-flow/role-management/story/user--remove-role-from-user.md

@@ -0,0 +1,33 @@
+# Remove Role From User
+
+## User Story
+
+As a user with the appropriate role, I want to remove a role from a user, so that their permissions are revoked.
+
+## Story Diagram
+
+```mermaid
+flowchart TD
+    A[Open User Detail] --> B[Select role to remove]
+    B --> C[Click Remove]
+    C --> D[Confirm removal]
+    D --> E[Role removed from user]
+```
+
+## Scenario Patterns
+
+- Remove an assigned role from a user
+- Cancelling the confirmation leaves the role assignment unchanged
+
+## Test Cases
+
+- Select an assigned role on a user, click Remove, and confirm; verify the role no longer appears in the user's role list
+- Select an assigned role on a user, click Remove, and cancel; verify the role still appears in the user's role list
+
+## Screens
+
+- [user-detail](../../../screen/user-detail.md)
+
+## Resolvers
+
+- [revokeRoleFromUser](../../../resolver/revokeRoleFromUser.md)

package/templates/scaffold/app/docs/business-flow/role-management/story/user--update-role-permissions.md

@@ -0,0 +1,41 @@
+# Update Role Permissions
+
+## User Story
+
+As a user with the appropriate role, I want to modify a role's permissions, so that access levels stay current.
+
+## Story Diagram
+
+```mermaid
+flowchart TD
+    A[Open Role List] --> B[Select role]
+    B --> C[Click Edit]
+    C --> D[Modify permission selection]
+    D --> E[Submit]
+    E --> F{Validation}
+    F -- No permissions selected --> G[Show validation error]
+    F -- Valid --> H[Role permissions updated]
+```
+
+## Scenario Patterns
+
+- Add one or more permissions to an existing role
+- Remove one or more permissions from an existing role
+- Submission with no permissions selected is blocked by validation
+
+## Test Cases
+
+- Add a permission to a role and submit; verify the updated permissions are reflected on the role detail
+- Remove all permissions from a role and submit; verify a validation error is shown and the role is not updated
+- Remove one permission while keeping others and submit; verify the permission is no longer listed on the role
+
+## Screens
+
+- [role-list](../../../screen/role-list.md)
+- [role-detail](../../../screen/role-detail.md)
+- [role-edit-form](../../../screen/role-edit-form.md)
+
+## Resolvers
+
+- [assignPermissionToRole](../../../resolver/assignPermissionToRole.md)
+- [revokePermissionFromRole](../../../resolver/revokePermissionFromRole.md)