@heavybit/pendoadmin-shared-lib 1.0.0

package/src/types/index.ts

@@ -0,0 +1,239 @@
+// ──────────────────────────────────────────────
+// User & Auth Types
+// ──────────────────────────────────────────────
+
+export interface IUser {
+  id: string;
+  email: string;
+  first_name: string;
+  last_name: string;
+  phone?: string | null;
+  password_hash: string;
+  company_id: string;
+  is_superadmin: boolean;
+  is_active: boolean;
+  email_verified: boolean;
+  failed_login_attempts: number;
+  locked_until: Date | null;
+  change_password_next_login: boolean;
+  last_login_at: Date | null;
+  created_at: Date;
+  updated_at: Date;
+}
+
+export interface IUserCreate {
+  email: string;
+  first_name: string;
+  last_name: string;
+  phone?: string;
+  password_hash: string;
+  company_id: string;
+  is_superadmin?: boolean;
+}
+
+export interface IUserUpdate {
+  email?: string;
+  first_name?: string;
+  last_name?: string;
+  phone?: string;
+  password_hash?: string;
+  company_id?: string;
+  is_active?: boolean;
+  email_verified?: boolean;
+  failed_login_attempts?: number;
+  locked_until?: Date | null;
+  change_password_next_login?: boolean;
+  last_login_at?: Date | null;
+}
+
+export interface IJwtPayload {
+  sub: string;
+  email: string;
+  companyId: string;
+  roles: string[];
+  permissions: string[];
+  isSuperAdmin: boolean;
+  iat?: number;
+  exp?: number;
+  iss?: string;
+}
+
+export interface ITokenPair {
+  accessToken: string;
+  refreshToken: string;
+  expiresIn: number;
+}
+
+export interface IAuthUser {
+  id: string;
+  email: string;
+  companyId: string;
+  roles: string[];
+  permissions: string[];
+  isSuperAdmin: boolean;
+}
+
+// ──────────────────────────────────────────────
+// Company & Branch Types
+// ──────────────────────────────────────────────
+
+export interface ICompany {
+  id: string;
+  name: string;
+  short_name?: string | null;
+  company_type?: string | null;
+  email?: string | null;
+  phone?: string | null;
+  address?: string | null;
+  city?: string | null;
+  country?: string | null;
+  logo_url?: string | null;
+  website?: string | null;
+  is_active: boolean;
+  created_at: Date;
+  updated_at: Date;
+}
+
+export interface ICompanyCreate {
+  name: string;
+  short_name?: string;
+  company_type?: string;
+  email?: string;
+  phone?: string;
+  address?: string;
+  city?: string;
+  country?: string;
+}
+
+export interface ICompanyUpdate {
+  name?: string;
+  short_name?: string;
+  company_type?: string;
+  email?: string;
+  phone?: string;
+  address?: string;
+  city?: string;
+  country?: string;
+  logo_url?: string;
+  website?: string;
+  is_active?: boolean;
+}
+
+export interface ICompanyBranch {
+  id: string;
+  company_id: string;
+  name: string;
+  code?: string | null;
+  address?: string | null;
+  city?: string | null;
+  phone?: string | null;
+  email?: string | null;
+  is_active: boolean;
+  created_at: Date;
+  updated_at: Date;
+}
+
+export interface ICompanyServiceConfig {
+  id: string;
+  company_id: string;
+  service_name: string;
+  config: Record<string, unknown>;
+  is_active: boolean;
+  created_at: Date;
+  updated_at: Date;
+}
+
+// ──────────────────────────────────────────────
+// Role & Permission Types
+// ──────────────────────────────────────────────
+
+export interface IRole {
+  id: string;
+  name: string;
+  slug: string;
+  description?: string | null;
+  company_id?: string | null;
+  is_system_role: boolean;
+  is_editable: boolean;
+  created_at: Date;
+  updated_at: Date;
+}
+
+export interface IPermission {
+  id: string;
+  name: string;
+  description?: string | null;
+  category: string;
+  is_active: boolean;
+  created_at: Date;
+}
+
+// ──────────────────────────────────────────────
+// API Response Types
+// ──────────────────────────────────────────────
+
+export interface IApiResponse<T = unknown> {
+  success: boolean;
+  message: string;
+  data?: T;
+  errors?: Record<string, string[]>;
+  meta?: IPaginationMeta;
+}
+
+export interface IPaginationMeta {
+  page: number;
+  limit: number;
+  total: number;
+  totalPages: number;
+  hasNext: boolean;
+  hasPrev: boolean;
+}
+
+export interface IPaginationParams {
+  page: number;
+  limit: number;
+  search?: string;
+  sortBy?: string;
+  sortOrder?: 'asc' | 'desc';
+}
+
+export interface IPaginatedResult<T> {
+  data: T[];
+  meta: IPaginationMeta;
+}
+
+// ──────────────────────────────────────────────
+// Analytics Types
+// ──────────────────────────────────────────────
+
+export interface IAnalyticsEvent {
+  event_type: string;
+  event_data: Record<string, unknown>;
+  company_id?: string;
+  timestamp?: Date;
+}
+
+// ──────────────────────────────────────────────
+// Service Config Types
+// ──────────────────────────────────────────────
+
+export interface IServiceConfig {
+  serviceName: string;
+  serviceUrl: string;
+  healthEndpoint: string;
+}
+
+// ──────────────────────────────────────────────
+// Gateway Header Types
+// ──────────────────────────────────────────────
+
+export const GATEWAY_HEADERS = {
+  USER_ID: 'x-user-id',
+  COMPANY_ID: 'x-company-id',
+  USER_EMAIL: 'x-user-email',
+  USER_ROLES: 'x-user-roles',
+  USER_PERMISSIONS: 'x-user-permissions',
+  IS_SUPERADMIN: 'x-is-superadmin',
+  CORRELATION_ID: 'x-correlation-id',
+  SERVICE_NAME: 'x-service-name',
+} as const;

package/src/validation/index.ts

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+
+export const paginationSchema = z.object({
+  page: z.coerce.number().int().min(1).default(1),
+  limit: z.coerce.number().int().min(1).max(100).default(20),
+  search: z.string().optional(),
+  sortBy: z.string().optional(),
+  sortOrder: z.enum(['asc', 'desc']).default('desc'),
+});
+
+export const emailSchema = z.string().email('Invalid email address').toLowerCase().trim();
+
+export const phoneSchema = z.string().min(9).max(15).regex(/^\+?[0-9]+$/, 'Invalid phone number');
+
+export const uuidSchema = z.string().uuid('Invalid UUID');
+
+export const passwordSchema = z.string()
+  .min(8, 'Password must be at least 8 characters')
+  .regex(/[A-Z]/, 'Password must contain at least one uppercase letter')
+  .regex(/[a-z]/, 'Password must contain at least one lowercase letter')
+  .regex(/[0-9]/, 'Password must contain at least one digit')
+  .regex(/[!@#$%^&*()_+\-=\[\]{};':"\\|,.<>\/?]/, 'Password must contain at least one special character');
+
+export const idParamSchema = z.object({
+  id: z.string().min(1),
+});

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "node",
+    "lib": ["ES2022"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}