@baasix/types 1.0.1

package/src/files.ts

@@ -0,0 +1,191 @@
+/**
+ * File & Asset Types
+ * Shared across core, sdk, and app packages
+ */
+
+// ============================================================================
+// File Types
+// ============================================================================
+
+/**
+ * File metadata
+ */
+export interface FileMetadata {
+  id: string;
+  title?: string;
+  description?: string;
+  filename: string;
+  mimeType: string;
+  size: number;
+  width?: number;
+  height?: number;
+  duration?: number;
+  storage: string;
+  path: string;
+  isPublic?: boolean;
+  uploadedBy?: string;
+  tenant_Id?: string;
+  createdAt: string;
+  updatedAt?: string;
+  [key: string]: unknown;
+}
+
+/**
+ * File data (internal use)
+ */
+export interface FileData {
+  buffer: Buffer;
+  filename: string;
+  mimetype: string;
+  size: number;
+}
+
+/**
+ * Upload options
+ */
+export interface UploadOptions {
+  title?: string;
+  description?: string;
+  folder?: string;
+  storage?: "local" | "s3";
+  isPublic?: boolean;
+  metadata?: Record<string, unknown>;
+  onProgress?: (progress: number) => void;
+  /** Request timeout in milliseconds (default: 30000). Set to 0 for no timeout. */
+  timeout?: number;
+}
+
+/**
+ * Internal uploaded file (from express-fileupload)
+ */
+export interface InternalUploadedFile {
+  name: string;
+  data: Buffer;
+  size: number;
+  encoding: string;
+  tempFilePath: string;
+  truncated: boolean;
+  mimetype: string;
+  md5: string;
+  mv: (path: string) => Promise<void>;
+}
+
+// ============================================================================
+// Asset Transform Types
+// ============================================================================
+
+/**
+ * Asset transform options
+ */
+export interface AssetTransformOptions {
+  width?: number;
+  height?: number;
+  fit?: "cover" | "contain" | "fill" | "inside" | "outside";
+  quality?: number;
+  format?: "jpeg" | "png" | "webp" | "avif";
+}
+
+/**
+ * Asset query parameters (from HTTP query string)
+ * Values can be string | number since they come from query params
+ */
+export interface AssetQuery {
+  width?: string | number;
+  height?: string | number;
+  fit?: "cover" | "contain" | "fill" | "inside" | "outside" | string;
+  quality?: string | number;
+  format?: string;
+  withoutEnlargement?: string | boolean;
+}
+
+/**
+ * Processed image result
+ */
+export interface ProcessedImage {
+  buffer: Buffer;
+  /** Content type (e.g., 'image/jpeg') or format (e.g., 'jpeg') */
+  contentType?: string;
+  format?: string;
+  width?: number;
+  height?: number;
+}
+
+// ============================================================================
+// Storage Types
+// ============================================================================
+
+/**
+ * Storage provider type
+ */
+export type StorageProvider = "local" | "s3" | "gcs" | "azure";
+
+/**
+ * Storage adapter interface
+ */
+export interface StorageAdapter {
+  getItem(key: string): string | null | Promise<string | null>;
+  setItem(key: string, value: string): void | Promise<void>;
+  removeItem(key: string): void | Promise<void>;
+}
+
+// ============================================================================
+// Import/Export Types
+// ============================================================================
+
+/**
+ * Uploaded file interface (from multipart form)
+ */
+export interface UploadedFile {
+  originalname: string;
+  mimetype: string;
+  buffer: Buffer;
+  size: number;
+}
+
+/**
+ * Import options
+ */
+export interface ImportOptions {
+  collection: string;
+  file?: UploadedFile;
+  data?: unknown[];
+  format?: "csv" | "json";
+  mapping?: Record<string, string>;
+  skipValidation?: boolean;
+  batchSize?: number;
+  onProgress?: (processed: number, total: number) => void;
+  onError?: (error: Error, row: unknown, index: number) => void;
+}
+
+/**
+ * Export options
+ */
+export interface ExportOptions {
+  collection: string;
+  format?: "csv" | "json";
+  fields?: string[];
+  filter?: Record<string, unknown>;
+  limit?: number;
+  offset?: number;
+}
+
+/**
+ * Import result
+ */
+export interface ImportResult {
+  success: boolean;
+  imported: number;
+  failed: number;
+  errors: Array<{ row: number; error: string; data?: unknown }>;
+  duration: number;
+}
+
+/**
+ * Export result
+ */
+export interface ExportResult {
+  success: boolean;
+  data: string | unknown[];
+  count: number;
+  format: string;
+}

package/src/index.ts

@@ -0,0 +1,309 @@
+/**
+ * @baasix/types
+ * Shared TypeScript types for Baasix packages
+ *
+ * This package provides common type definitions used across:
+ * - @baasix/core (backend)
+ * - @baasix/sdk (client SDK)
+ * - @baasix/cli (command-line interface)
+ * - @baasix/app (admin panel)
+ */
+
+// ============================================================================
+// Auth Types
+// ============================================================================
+export type {
+  // User types
+  User,
+  UserWithPassword,
+  UserWithRolesAndPermissions,
+  // Role & Permission types
+  Role,
+  PermissionAction,
+  Permission,
+  PermissionData,
+  CreatePermissionData,
+  // Tenant types
+  Tenant,
+  // Session & Token types
+  Session,
+  AuthTokens,
+  JWTPayload,
+  // Accountability
+  Accountability,
+  // Auth request/response types
+  LoginCredentials,
+  RegisterData,
+  AuthResponse,
+  AuthStateEvent,
+  AuthState,
+  MagicLinkOptions,
+  PasswordResetOptions,
+  // OAuth types
+  OAuth2Tokens,
+  OAuth2UserInfo,
+  // Auth mode
+  AuthMode,
+} from "./auth";
+
+// ============================================================================
+// Schema Types
+// ============================================================================
+export type {
+  // Field types
+  FieldType,
+  DefaultValueType,
+  FieldValidationRules,
+  FieldValues,
+  FieldDefinition,
+  FlattenedField,
+  FieldInfo,
+  // Schema types
+  IndexDefinition,
+  SchemaDefinition,
+  SchemaInfo,
+  SchemaValidation,
+  FieldValidation,
+  ValidationResult,
+  // Relationship types
+  RelationshipType,
+  AssociationType,
+  RelationshipDefinition,
+  AssociationDefinition,
+  IncludeConfig,
+  ProcessedInclude,
+} from "./schema";
+
+// ============================================================================
+// Query Types (includes Report & Stats query types)
+// ============================================================================
+export type {
+  // Filter types
+  FilterOperator,
+  OperatorName,
+  FilterValue,
+  FilterCondition,
+  LogicalFilter,
+  Filter,
+  FilterObject,
+  // Sort types
+  SortDirection,
+  Sort,
+  SortItem,
+  SortObject,
+  // Pagination types
+  PaginationOptions,
+  PaginationMetadata,
+  // Aggregation types
+  AggregateFunction,
+  AggregateConfig,
+  Aggregate,
+  AggregateMapping,
+  DatePart,
+  DateTruncPrecision,
+  // Query parameters
+  QueryParams,
+  QueryOptions,
+  QueryContext,
+  // Report query types
+  ReportConfig,
+  ReportResult,
+  ReportQuery,
+  // Stats query types
+  StatsQuery,
+  StatsResult,
+} from "./query";
+
+// ============================================================================
+// Response Types
+// ============================================================================
+export type {
+  PaginatedResponse,
+  SingleResponse,
+  MutationResponse,
+  DeleteResponse,
+  BulkResponse,
+  ReadResult,
+  ErrorResponse,
+} from "./response";
+
+// ============================================================================
+// File Types (includes Import/Export types)
+// ============================================================================
+export type {
+  // File metadata
+  FileMetadata,
+  FileData,
+  UploadOptions,
+  InternalUploadedFile,
+  // Asset types
+  AssetTransformOptions,
+  AssetQuery,
+  ProcessedImage,
+  // Storage types
+  StorageProvider,
+  StorageAdapter,
+  // Import/Export types
+  UploadedFile,
+  ImportOptions,
+  ExportOptions,
+  ImportResult,
+  ExportResult,
+} from "./files";
+
+// ============================================================================
+// Workflow Types
+// ============================================================================
+export type {
+  WorkflowTriggerType,
+  WorkflowStatus,
+  Workflow,
+  WorkflowFlowData,
+  WorkflowTrigger,
+  WorkflowNode,
+  WorkflowNodeData,
+  WorkflowEdge,
+  WorkflowExecutionStatus,
+  WorkflowExecution,
+  WorkflowExecutionLog,
+} from "./workflow";
+
+// ============================================================================
+// Notification Types
+// ============================================================================
+export type {
+  NotificationType,
+  Notification,
+  NotificationOptions,
+  SendNotificationData,
+} from "./notification";
+
+// ============================================================================
+// Spatial/GeoJSON Types
+// ============================================================================
+export type {
+  GeoJSONPoint,
+  GeoJSONLineString,
+  GeoJSONPolygon,
+  GeoJSONGeometry,
+} from "./spatial";
+
+// ============================================================================
+// Cache Types
+// ============================================================================
+export type {
+  CacheConfig,
+  CacheSetOptions,
+  CacheStrategy,
+  CacheEntry,
+  ICacheAdapter,
+} from "./cache";
+
+// ============================================================================
+// Common Types
+// ============================================================================
+export type {
+  // Base types
+  BaseItem,
+  TimestampedItem,
+  SoftDeletableItem,
+  // Utility types
+  DeepPartial,
+  CollectionItem,
+  WithRequired,
+  WithOptional,
+  KeysOfType,
+  AnyRecord,
+  // Settings types
+  Settings,
+  TenantSettings,
+  // Task types
+  BackgroundTask,
+  // Hook types
+  HookEvent,
+  HookContext,
+  HookHandler,
+  Hook,
+  // HTTP types
+  HttpMethod,
+  // Mail types
+  MailOptions,
+  SenderConfig,
+  // Seed types
+  SeedData,
+  SeedResult,
+} from "./common";
+
+// ============================================================================
+// Plugin Types
+// ============================================================================
+export type {
+  // Express types (actual Express types from @types/express)
+  Request,
+  Response,
+  NextFunction,
+  Express,
+  Router,
+  // Express type aliases
+  ExpressRequest,
+  ExpressResponse,
+  ExpressNextFunction,
+  ExpressApp,
+  ExpressRouter,
+  // Express-compatible types (can be used without importing express)
+  PluginRequest,
+  PluginResponse,
+  PluginNextFunction,
+  PluginApp,
+  PluginRouter,
+  // Service interfaces
+  ServiceOptions,
+  IItemsService,
+  IPermissionService,
+  IMailService,
+  IStorageService,
+  ISettingsService,
+  ISocketService,
+  IRealtimeService,
+  ITasksService,
+  IWorkflowService,
+  IMigrationService,
+  IHooksManager,
+  HookFunction,
+  ICacheService,
+  IFilesService,
+  IAssetsService,
+  INotificationService,
+  IReportService,
+  IStatsService,
+  // Plugin types
+  PluginType,
+  PluginMeta,
+  PluginSchemaDefinition,
+  PluginRouteContext,
+  PluginRouteHandler,
+  PluginRoute,
+  PluginHookEvent,
+  PluginHookContext,
+  PluginHookHandler,
+  PluginHook,
+  PluginContext,
+  PluginServiceFactory,
+  PluginService,
+  AuthProviderType,
+  OAuth2Config,
+  PluginAuthProvider,
+  PluginMiddleware,
+  PluginSchedule,
+  PluginDefinition,
+  PluginFactory,
+  BaasixPlugin,
+  LoadedPlugin,
+  PluginManagerOptions,
+  StartServerOptions,
+  // Express-typed plugin types (for core package)
+  ExpressPluginRouteHandler,
+  ExpressPluginRoute,
+  ExpressPluginMiddleware,
+  ExpressPluginContext,
+} from "./plugin";

package/src/notification.ts

@@ -0,0 +1,52 @@
+/**
+ * Notification Types
+ * Shared across core, sdk, and app packages
+ */
+
+// ============================================================================
+// Notification Types
+// ============================================================================
+
+/**
+ * Notification type
+ */
+export type NotificationType = "info" | "success" | "warning" | "error" | string;
+
+/**
+ * Notification
+ */
+export interface Notification {
+  id: string;
+  type: NotificationType;
+  title: string;
+  message: string;
+  data?: Record<string, unknown>;
+  seen: boolean;
+  user_Id: string;
+  tenant_Id?: string;
+  createdAt: string;
+  updatedAt?: string;
+}
+
+/**
+ * Notification options (for creating)
+ */
+export interface NotificationOptions {
+  type?: NotificationType;
+  title: string;
+  message: string;
+  data?: Record<string, unknown>;
+  userIds?: string[];
+  tenant_Id?: string;
+}
+
+/**
+ * Send notification data
+ */
+export interface SendNotificationData {
+  type?: NotificationType;
+  title: string;
+  message: string;
+  data?: Record<string, unknown>;
+  userIds: string[];
+}