@appcorp/fusion-storybook 0.2.13 → 0.2.14

package/types/user-management.d.ts

@@ -0,0 +1,236 @@
+/**
+ * TypeScript Types Generated from Prisma Schema - User Management
+ *
+ * This file contains TypeScript interfaces for user, workspace, role,
+ * permission, plan, school, and campus domain models.
+ */
+import { USER_ROLE, ACCESS_LEVEL, CURRENCY, BILLING_INTERVAL, PLAN_TYPE } from "./enums";
+import type { AdmissionBE } from "./admission";
+import type { AttendanceBE, ClassBE, CourseBE, FamilyBE, GradeBE, ScheduleBE, SectionBE, SubjectBE, TeacherBE } from "./academics";
+import type { ExpenseBE, FeeStructureBE, DiscountCodeBE, StudentFeeBE } from "./finance";
+import type { BlogPostBE, BlogCommentBE, BlogPostClapBE, BlogCommentClapBE, MobileNotificationBE, NotificationPreferenceBE, UserPushTokenBE } from "./communication";
+/**
+ * Subscription plan defining usage limits and features for workspaces
+ */
+export interface PlanBE {
+    createdAt: string;
+    currency: CURRENCY;
+    enabled: boolean;
+    id: string;
+    maxClasses: number;
+    maxCourses: number;
+    maxFamilies: number;
+    maxStaffAccounts: number;
+    maxStudents: number;
+    maxTeachers: number;
+    name: string;
+    priceMonthly: number;
+    priceYearly: number;
+    storageLimitMB: number;
+    type: PLAN_TYPE;
+    updatedAt: string;
+    workspaces?: WorkspaceBE[];
+}
+/**
+ * Workspace represents a tenant in the multi-vendor system
+ * Each workspace has exactly ONE school (1:1 relationship)
+ */
+export interface WorkspaceBE {
+    agreedCurrency: CURRENCY;
+    agreedPrice: number;
+    billingDate: number;
+    billingInterval: BILLING_INTERVAL;
+    classesCount: number;
+    coursesCount: number;
+    createdAt: string;
+    description: string | null;
+    dueDateLength: number;
+    enabled: boolean;
+    familiesCount: number;
+    id: string;
+    logo: string | null;
+    name: string;
+    planEndDate: Date | string | null;
+    planId: string | null;
+    planStartDate: Date | string | null;
+    secrets?: any | null;
+    staffAccountsCount: number;
+    storageUsedMB: number;
+    studentsCount: number;
+    subdomain: string;
+    teachersCount: number;
+    updatedAt: string;
+    customRoles?: RoleBE[];
+    plan?: PlanBE;
+    rolePermissions?: RolePermissionBE[];
+    school?: SchoolBE;
+    users?: WorkspaceUserBE[];
+}
+/**
+ * Join table managing user-workspace relationships and roles
+ * Allows users to belong to multiple workspaces with different roles
+ */
+export interface WorkspaceUserBE {
+    createdAt: string;
+    enabled: boolean;
+    id: string;
+    roleId: string | null;
+    updatedAt: string;
+    userId: string;
+    workspaceId: string;
+    role?: RoleBE;
+    user?: UserBE;
+    workspace?: WorkspaceBE;
+    workspaceUserPermissions?: WorkspaceUserPermissionBE[];
+}
+/**
+ * Role defines a named set of default permissions.
+ * System roles (isSystem = true) are seeded once and map 1:1 with UserRole enum values.
+ * Workspace custom roles (isSystem = false, workspaceId set) are created by SCHOOL_ADMINs.
+ */
+export interface RoleBE {
+    createdAt: string;
+    description: string | null;
+    id: string;
+    isSystem: boolean;
+    name: string;
+    updatedAt: string;
+    userRole: USER_ROLE | null;
+    workspaceId: string | null;
+    rolePermissions?: RolePermissionBE[];
+    workspace?: WorkspaceBE;
+    workspaceUsers?: WorkspaceBE[];
+}
+/**
+ * Permission describes a module-level capability and access level (e.g., "courses", READ/READ_WRITE).
+ */
+export interface PermissionBE {
+    access: ACCESS_LEVEL;
+    createdAt: string;
+    description: string | null;
+    id: string;
+    module: string;
+    updatedAt: string;
+    rolePermissions?: RolePermissionBE[];
+    workspaceUserPermissions?: WorkspaceUserPermissionBE[];
+}
+/**
+ * RolePermission links a Permission to a Role, with an optional workspace scope.
+ * workspaceId IS NULL → global default grant for the role (seeded by system)
+ * workspaceId IS SET → workspace-level override set by SCHOOL_ADMIN for their workspace
+ * allowed = true → explicitly grant the permission
+ * allowed = false → explicitly deny/revoke the permission (overrides the global default)
+ */
+export interface RolePermissionBE {
+    allowed: boolean;
+    createdAt: string;
+    id: string;
+    permissionId: string;
+    roleId: string;
+    updatedAt: string;
+    workspaceId: string | null;
+    permission?: PermissionBE;
+    role?: RoleBE;
+    workspace?: WorkspaceBE;
+}
+/**
+ * WorkspaceUserPermission is a per-user override for a given Permission within a workspace.
+ * allowed indicates explicit allow (true) or deny (false); overrides take precedence over role grants.
+ */
+export interface WorkspaceUserPermissionBE {
+    allowed: boolean;
+    createdAt: string;
+    id: string;
+    permissionId: string;
+    updatedAt: string;
+    workspaceUserId: string;
+    permission?: PermissionBE;
+    workspaceUser?: WorkspaceUserBE;
+}
+/**
+ * School represents an individual educational institution
+ * Has a 1:1 relationship with Workspace (each school is a separate tenant)
+ */
+export interface SchoolBE {
+    address: string | null;
+    city: string | null;
+    code: string;
+    country: string | null;
+    createdAt: string;
+    currency: CURRENCY;
+    email: string | null;
+    enabled: boolean;
+    id: string;
+    logo: string | null;
+    name: string;
+    phone: string | null;
+    postalCode: string | null;
+    principalId: string | null;
+    state: string | null;
+    updatedAt: string;
+    website: string | null;
+    workspaceId: string;
+    attendances?: AttendanceBE[];
+    blogPosts?: BlogPostBE[];
+    classes?: ClassBE[];
+    courses?: CourseBE[];
+    expenses?: ExpenseBE[];
+    families?: FamilyBE[];
+    feeStructures?: FeeStructureBE[];
+    discountCodes?: DiscountCodeBE[];
+    grades?: GradeBE[];
+    schedules?: ScheduleBE[];
+    sections?: SectionBE[];
+    admissions?: AdmissionBE[];
+    studentFees?: StudentFeeBE[];
+    subjects?: SubjectBE[];
+    teachers?: TeacherBE[];
+    workspace?: WorkspaceBE;
+}
+/**
+ * Core user model synchronized with Supabase Auth
+ * Shared by entire family - parents and students use same login
+ */
+export interface UserBE {
+    avatar: string | null;
+    createdAt: string;
+    email: string;
+    enabled: boolean;
+    id: string;
+    name: string | null;
+    phone: string | null;
+    updatedAt: string;
+    blogCommentClaps?: BlogCommentClapBE[];
+    blogComments?: BlogCommentBE[];
+    blogPostClaps?: BlogPostClapBE[];
+    blogPosts?: BlogPostBE[];
+    mobileNotifications?: MobileNotificationBE[];
+    notificationPreference?: NotificationPreferenceBE;
+    pushTokens?: UserPushTokenBE[];
+    teacherProfile?: TeacherBE;
+    workspaces?: WorkspaceUserBE[];
+}
+/**
+ * Campus represents a physical branch/location of a school
+ */
+export interface CampusBE {
+    address: string | null;
+    campusId?: string | null;
+    city: string | null;
+    code: string;
+    country: string | null;
+    createdAt: string;
+    enabled: boolean;
+    id: string;
+    name: string;
+    phone: string | null;
+    schoolId: string;
+    state: string | null;
+    updatedAt: string;
+    school?: SchoolBE;
+    _count?: {
+        classes: number;
+        teachers: number;
+        studentProfiles: number;
+    };
+}

package/types/user-management.js

@@ -0,0 +1,7 @@
+/**
+ * TypeScript Types Generated from Prisma Schema - User Management
+ *
+ * This file contains TypeScript interfaces for user, workspace, role,
+ * permission, plan, school, and campus domain models.
+ */
+export {};