@goplusvn/core 0.1.0 → 0.1.1

package/src/types/index.ts

@@ -0,0 +1,703 @@
+// @goerp/core/types
+// Core TypeScript types for GoERP platform
+// Consolidated from packages/shared/types
+
+import type { LucideIcon, icons } from "lucide-react";
+import type { ComponentType, SVGAttributes, ReactNode } from "react";
+import type { z } from "zod";
+
+// ============================================================================
+// Locale & Theme Types
+// ============================================================================
+
+export const supportedLocales = ["vi", "en"] as const;
+export type LocaleType = (typeof supportedLocales)[number];
+
+export interface SearchResultItem {
+  id: string;
+  title: string;
+  subtitle?: string;
+  url?: string;
+  action?: () => void;
+  iconName?: DynamicIconNameType;
+}
+
+export interface SearchGroup {
+  heading: string;
+  items: SearchResultItem[];
+}
+
+export const supportedThemes = [
+  "zinc",
+  "slate",
+  "stone",
+  "gray",
+  "neutral",
+  "red",
+  "rose",
+  "orange",
+  "green",
+  "blue",
+  "yellow",
+  "violet",
+] as const;
+export type ThemeType = (typeof supportedThemes)[number];
+
+export const radii = [0, 0.3, 0.5, 0.75, 1] as const;
+export type RadiusType = (typeof radii)[number];
+
+// ============================================================================
+// Layout & UI Types
+// ============================================================================
+
+export type LayoutType = "vertical" | "horizontal";
+export type ModeType = "light" | "dark" | "system";
+export type OrientationType = "vertical" | "horizontal";
+export type DirectionType = "ltr" | "rtl";
+export type SidebarVariantType = "sidebar" | "floating" | "inset";
+export type SidebarCollapsibleType = "offcanvas" | "icon" | "none";
+export type DensityType = "comfortable" | "compact";
+
+export type SettingsType = {
+  theme: ThemeType;
+  mode: ModeType;
+  radius: RadiusType;
+  layout: LayoutType;
+  locale: LocaleType;
+  sidebarVariant: SidebarVariantType;
+  sidebarCollapsible: SidebarCollapsibleType;
+  density: DensityType;
+};
+
+// ============================================================================
+// Icon Types
+// ============================================================================
+
+export interface IconProps extends SVGAttributes<SVGElement> {
+  children?: never;
+  color?: string;
+}
+
+export type IconType = ComponentType<IconProps> | LucideIcon;
+export type DynamicIconNameType = keyof typeof icons;
+
+// ============================================================================
+// Auth Form Types
+// ============================================================================
+
+export interface ForgotPasswordFormType {
+  email: string;
+}
+
+export interface NewPasswordFormType {
+  password: string;
+  confirmPassword: string;
+}
+
+export interface SignInFormType {
+  email: string;
+  password: string;
+}
+
+export interface RegisterFormType {
+  firstName: string;
+  lastName: string;
+  username: string;
+  email: string;
+  password: string;
+  confirmPassword: string;
+}
+
+export interface VerifyEmailFormType {
+  email: string;
+}
+
+// ============================================================================
+// User Types
+// ============================================================================
+
+export interface UserType {
+  id: string;
+  firstName: string;
+  lastName: string;
+  name: string;
+  password: string;
+  username: string;
+  role: string;
+  avatar: string;
+  background: string;
+  status: string;
+  phoneNumber: string;
+  email: string;
+  state: string;
+  country: string;
+  address: string;
+  zipCode: string;
+  language: string;
+  timeZone: string;
+  currency: string;
+  organization: string;
+  twoFactorAuth: boolean;
+  loginAlerts: boolean;
+  accountReoveryOption?: "email" | "sms" | "codes";
+  connections: number;
+  followers: number;
+}
+
+// ============================================================================
+// Permission Types
+// ============================================================================
+
+export interface Permission {
+  resourceCode: string;
+  actionCode: string;
+}
+
+export type PermissionType = Permission;
+
+export type PermissionMatrix = Record<string, Record<string, boolean>>;
+
+// ============================================================================
+// Route & Navigation Types
+// ============================================================================
+
+export interface RouteType {
+  type: "guest" | "public";
+  exceptions?: string[];
+}
+
+export interface NotificationType {
+  unreadCount: number;
+  notifications: Array<{
+    id: string;
+    iconName: DynamicIconNameType;
+    content: string;
+    url: string;
+    date: Date;
+    isRead: boolean;
+  }>;
+}
+
+export type FormatStyleType = "percent" | "duration" | "currency" | "regular";
+
+export interface NavigationType {
+  title: string;
+  iconName?: DynamicIconNameType;
+  items: NavigationRootItem[];
+}
+
+export type NavigationRootItem =
+  | NavigationRootItemWithHrefType
+  | NavigationRootItemWithItemsType;
+
+export interface NavigationRootItemBasicType {
+  title: string;
+  label?: string;
+  iconName: DynamicIconNameType;
+  resource?: string;
+  action?: string;
+}
+
+export interface NavigationRootItemWithHrefType
+  extends NavigationRootItemBasicType {
+  href: string;
+  items?: never;
+}
+
+export interface NavigationRootItemWithItemsType
+  extends NavigationRootItemBasicType {
+  items: (
+    | NavigationNestedItemWithHrefType
+    | NavigationNestedItemWithItemsType
+  )[];
+  href?: never;
+}
+
+export interface NavigationNestedItemBasicType {
+  title: string;
+  label?: string;
+  resource?: string;
+  action?: string;
+  iconName?: DynamicIconNameType;
+}
+
+export interface NavigationNestedItemWithHrefType
+  extends NavigationNestedItemBasicType {
+  href: string;
+  items?: never;
+}
+
+export interface NavigationNestedItemWithItemsType
+  extends NavigationNestedItemBasicType {
+  items: (
+    | NavigationNestedItemWithHrefType
+    | NavigationNestedItemWithItemsType
+  )[];
+  href?: never;
+}
+
+export type NavigationNestedItem =
+  | NavigationNestedItemWithHrefType
+  | NavigationNestedItemWithItemsType;
+
+// ============================================================================
+// OAuth & File Types
+// ============================================================================
+
+export interface OAuthLinkType {
+  href: string;
+  label: string;
+  icon: IconType;
+}
+
+export interface FileType {
+  id: string;
+  name: string;
+  size: number;
+  type: string;
+  url: string;
+}
+
+// ============================================================================
+// Entity Configuration
+// ============================================================================
+
+export interface EntityConfig {
+  name: string;
+  label: string;
+  pluralLabel: string;
+  icon?: LucideIcon;
+  iconName?: string;
+  description?: string;
+  /**
+   * Resource code used for permission checking.
+   * If not specified, falls back to `name`.
+   * Must match a valid resource code in the Resource table.
+   */
+  permissionResource?: string;
+  apiEndpoint: string;
+  idField: string;
+  displayField: string;
+  fields: FieldConfig[];
+  filters?: FilterConfig[];
+  defaultSort?: {
+    field: string;
+    direction: "asc" | "desc";
+  };
+  permissions?: CrudPermissions;
+  features?: CrudFeatures;
+  codeGeneration?: CodeGenerationConfig;
+  formSections?: FormSection[];
+  formMode?: FormModeConfig;
+  rowActions?: RowAction[];
+  include?: string[];
+}
+
+export interface CodeGenerationConfig {
+  enabled: boolean;
+  field: string;
+  ruleId?: string;
+  entityType?: string;
+  showPreview?: boolean;
+  allowManualOverride?: boolean;
+  generateOnCreate?: boolean;
+  generateOnEdit?: boolean;
+}
+
+export interface FormSection {
+  title: string;
+  description?: string;
+  fields: string[];
+  defaultOpen?: boolean;
+}
+
+export interface FormModeConfig {
+  create?: "dialog" | "sheet" | "navigate";
+  edit?: "dialog" | "sheet" | "navigate";
+  createPath?: string;
+  editPath?: string;
+  sheetSide?: "top" | "right" | "bottom" | "left";
+}
+
+export interface RowAction {
+  label: string;
+  icon?: string;
+  action:
+    | "copy"
+    | "duplicate"
+    | "view"
+    | "archive"
+    | "custom"
+    | "approve"
+    | "reject"
+    | "set-default"
+    | "view-history";
+  handler?: (
+    rowId: string,
+    rowData: Record<string, unknown>,
+  ) => void | Promise<void>;
+  visibleWhen?: (rowData: Record<string, unknown>) => boolean;
+  variant?:
+    | "default"
+    | "destructive"
+    | "outline"
+    | "secondary"
+    | "ghost"
+    | "link";
+  excludeFields?: string[];
+  transformData?: (rowData: Record<string, unknown>) => Record<string, unknown>;
+}
+
+// ============================================================================
+// Field Configuration
+// ============================================================================
+
+export type FieldType =
+  | "text"
+  | "email"
+  | "url"
+  | "number"
+  | "integer"
+  | "textarea"
+  | "boolean"
+  | "date"
+  | "datetime"
+  | "time"
+  | "select"
+  | "multiselect"
+  | "file"
+  | "image"
+  | "json"
+  | "custom"
+  | "switch"
+  | "relation";
+
+export interface FieldConfig {
+  name: string;
+  label: string;
+  type: FieldType;
+  required?: boolean;
+  defaultValue?: unknown;
+  placeholder?: string;
+  helpText?: string;
+  description?: string;
+  rows?: number;
+  disabled?: boolean;
+  disableOnCreate?: boolean;
+  disableOnEdit?: boolean;
+  fullWidth?: boolean;
+  validation?: z.ZodTypeAny;
+  hideInTable?: boolean;
+  hideInForm?: boolean;
+  showInImport?: boolean;
+  width?: number | string;
+  minWidth?: number | string;
+  maxWidth?: number | string;
+  isDisplayOnly?: boolean;
+  sortable?: boolean;
+  filterable?: boolean;
+  order?: number;
+  options?: Array<
+    | string
+    | number
+    | boolean
+    | { label: string; value: string | number | boolean }
+  >;
+  dataSource?: DataSource;
+  dependsOn?: string;
+  section?: string;
+  showWhen?: FieldShowWhen;
+  calculate?: FieldCalculate;
+  format?: FieldFormat;
+  transform?: FieldTransform;
+  actions?: FieldAction[];
+  help?: FieldHelp;
+  dependencies?: FieldDependencies;
+  cascade?: FieldCascade;
+  renderCell?: (value: unknown, row: Record<string, unknown>) => ReactNode;
+  renderForm?: (props: Record<string, unknown>) => ReactNode;
+  renderInput?: (
+    value: unknown,
+    onChange: (value: unknown) => void,
+  ) => ReactNode;
+  relation?: {
+    entity: string;
+    displayField: string;
+    valueField: string;
+    filter?: Record<string, unknown>;
+  };
+}
+
+export interface FieldShowWhen {
+  field: string;
+  value: unknown;
+  operator?:
+    | "equals"
+    | "notEquals"
+    | "contains"
+    | "greaterThan"
+    | "lessThan"
+    | "isEmpty"
+    | "isNotEmpty";
+}
+
+export interface FieldCalculate {
+  dependsOn: string[];
+  formula: string | ((values: Record<string, unknown>) => unknown);
+  mode?: "onChange" | "onBlur" | "always";
+}
+
+export interface FieldFormat {
+  type: "currency" | "percentage" | "date" | "datetime" | "number" | "custom";
+  options?: {
+    currency?: string;
+    locale?: string;
+    decimals?: number;
+    dateFormat?: string;
+    custom?: (value: unknown) => string;
+  };
+}
+
+export interface FieldTransform {
+  input?: (value: unknown) => unknown;
+  output?: (value: unknown) => unknown;
+}
+
+export interface FieldAction {
+  label: string;
+  icon?: string;
+  action: "clear" | "copy" | "generate" | "validate" | "custom";
+  handler?: (
+    field: FieldConfig,
+    formData: Record<string, unknown>,
+  ) => void | Promise<void>;
+  visibleWhen?: {
+    field: string;
+    operator: "equals" | "notEquals" | "isEmpty" | "isNotEmpty";
+    value: unknown;
+  };
+}
+
+export interface FieldHelp {
+  text?: string;
+  tooltip?: string;
+  link?: {
+    url: string;
+    text: string;
+    openInNewTab?: boolean;
+  };
+  examples?: string[];
+}
+
+export interface FieldDependencies {
+  fields: string[];
+  condition: "all" | "any" | "none";
+  rules: Array<{
+    field: string;
+    operator:
+      | "equals"
+      | "notEquals"
+      | "contains"
+      | "greaterThan"
+      | "lessThan"
+      | "isEmpty"
+      | "isNotEmpty";
+    value: unknown;
+  }>;
+}
+
+export interface FieldCascade {
+  triggerField: string;
+  action: "clear" | "reset" | "update";
+  updateFields?: string[];
+}
+
+export interface ValidationRule {
+  type:
+    | "required"
+    | "email"
+    | "url"
+    | "min"
+    | "max"
+    | "minLength"
+    | "maxLength"
+    | "pattern"
+    | "custom";
+  value?: unknown;
+  message: string;
+  validator?: (value: unknown, formData: Record<string, unknown>) => boolean;
+}
+
+// ============================================================================
+// Data Source
+// ============================================================================
+
+export interface DataSource {
+  type: "static" | "api";
+  options?: Array<{ label: string; value: string | number | boolean }>;
+  endpoint?: string;
+  params?: Record<string, unknown>;
+  labelField?: string;
+  valueField?: string;
+  searchable?: boolean;
+  cacheTime?: number;
+  transform?: (
+    data: unknown[],
+  ) => Array<{ label: string; value: string | number | boolean }>;
+}
+
+// ============================================================================
+// Filter Configuration
+// ============================================================================
+
+export type FilterType =
+  | "text"
+  | "datetime"
+  | "select"
+  | "checkbox"
+  | "switch"
+  | "radio"
+  | "custom";
+
+export interface FilterConfig {
+  name: string;
+  label: string;
+  type: FilterType;
+  field: string;
+  operator?: FilterOperator;
+  defaultValue?: unknown;
+  options?: Array<{ label: string; value: string | number | boolean }>;
+  dataSource?: DataSource;
+  renderFilter?: (props: Record<string, unknown>) => ReactNode;
+  multiple?: boolean;
+  mode?: "single" | "range" | string;
+}
+
+export type FilterOperator =
+  | "eq"
+  | "ne"
+  | "gt"
+  | "gte"
+  | "lt"
+  | "lte"
+  | "contains"
+  | "startsWith"
+  | "endsWith"
+  | "in"
+  | "notIn"
+  | "between"
+  | "isNull"
+  | "isNotNull";
+
+export interface ActiveFilter {
+  name: string;
+  value: unknown;
+  operator: FilterOperator;
+}
+
+// ============================================================================
+// CRUD Operations
+// ============================================================================
+
+export interface SortingState {
+  field: string;
+  direction: "asc" | "desc";
+}
+
+export interface CrudQueryParams {
+  page: number;
+  pageSize: number;
+  search?: string;
+  sort?: SortingState;
+  filters?: ActiveFilter[];
+}
+
+export interface CrudResponse<T = unknown> {
+  data: T[];
+  total: number;
+  page: number;
+  pageSize: number;
+}
+
+export interface CrudPermissions {
+  create?: boolean;
+  read?: boolean;
+  update?: boolean;
+  delete?: boolean;
+  export?: boolean;
+  import?: boolean;
+  approve?: boolean;
+  reject?: boolean;
+}
+
+export interface CrudFeatures {
+  search?: boolean;
+  bulkActions?: boolean;
+  export?: boolean;
+  import?: boolean;
+  showRowNumber?: boolean;
+  showRowSelection?: boolean;
+}
+
+// ============================================================================
+// Import/Export
+// ============================================================================
+
+export interface ImportOptions {
+  format: "csv" | "xlsx" | "json";
+  skipErrors?: boolean;
+  updateExisting?: boolean;
+  mapping?: Record<string, string>;
+}
+
+export interface ExportOptions {
+  format: "csv" | "xlsx" | "json";
+  fields?: string[];
+  filters?: ActiveFilter[];
+  allData?: boolean;
+}
+
+export interface ImportResult {
+  success: boolean;
+  imported: number;
+  failed: number;
+  errors: Array<{
+    row: number;
+    field: string;
+    message: string;
+  }>;
+}
+
+// ============================================================================
+// Entity Filter Types
+// ============================================================================
+
+export interface ActionFilters {
+  page?: number;
+  pageSize?: number;
+  search?: string;
+  status?: string;
+}
+
+export interface ResourceFilters {
+  page?: number;
+  pageSize?: number;
+  search?: string;
+  status?: string;
+  group?: string;
+  type?: string;
+}
+
+export interface UomFilters {
+  page?: number;
+  pageSize?: number;
+  search?: string;
+  status?: string;
+}
+
+export interface WarehouseFilters {
+  page?: number;
+  pageSize?: number;
+  search?: string;
+  status?: string;
+}