@object-ui/types 0.3.1 → 2.0.0

package/src/reports.ts

@@ -0,0 +1,408 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @object-ui/types - Report Schema
+ * 
+ * Defines report configuration for data aggregation, visualization, and export.
+ */
+
+import type { BaseSchema, SchemaNode } from './base';
+import type { ChartSchema } from './data-display';
+import type { DataSource } from './data';
+
+/**
+ * Report Export Format
+ */
+export type ReportExportFormat = 'pdf' | 'excel' | 'csv' | 'json' | 'html';
+
+/**
+ * Report Schedule Frequency
+ */
+export type ReportScheduleFrequency = 'once' | 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly';
+
+/**
+ * Report Aggregation Type
+ */
+export type ReportAggregationType = 'sum' | 'avg' | 'min' | 'max' | 'count' | 'distinct';
+
+/**
+ * Report Field Definition
+ */
+export interface ReportField {
+  /**
+   * Field name/identifier
+   */
+  name: string;
+
+  /**
+   * Display label
+   */
+  label?: string;
+
+  /**
+   * Field type
+   */
+  type?: 'string' | 'number' | 'date' | 'boolean';
+
+  /**
+   * Aggregation function
+   */
+  aggregation?: ReportAggregationType;
+
+  /**
+   * Format string
+   */
+  format?: string;
+
+  /**
+   * Show in summary
+   */
+  showInSummary?: boolean;
+
+  /**
+   * Sort order
+   */
+  sortOrder?: number;
+}
+
+/**
+ * Report Filter Definition
+ */
+export interface ReportFilter {
+  /**
+   * Field to filter on
+   */
+  field: string;
+
+  /**
+   * Filter operator
+   */
+  operator: 'equals' | 'not_equals' | 'contains' | 'greater_than' | 'less_than' | 'between' | 'in' | 'not_in';
+
+  /**
+   * Filter value
+   */
+  value?: any;
+
+  /**
+   * Multiple values (for 'in' operator)
+   */
+  values?: any[];
+}
+
+/**
+ * Report Group By Definition
+ */
+export interface ReportGroupBy {
+  /**
+   * Field to group by
+   */
+  field: string;
+
+  /**
+   * Display label
+   */
+  label?: string;
+
+  /**
+   * Sort direction
+   */
+  sort?: 'asc' | 'desc';
+}
+
+/**
+ * Report Section Definition
+ */
+export interface ReportSection {
+  /**
+   * Section type
+   */
+  type: 'header' | 'summary' | 'chart' | 'table' | 'text' | 'page-break';
+
+  /**
+   * Section title
+   */
+  title?: string;
+
+  /**
+   * Section content
+   */
+  content?: SchemaNode | SchemaNode[];
+
+  /**
+   * Chart configuration (for type='chart')
+   */
+  chart?: ChartSchema;
+
+  /**
+   * Columns to display (for type='table')
+   */
+  columns?: ReportField[];
+
+  /**
+   * Text content (for type='text')
+   */
+  text?: string;
+
+  /**
+   * Visibility condition
+   */
+  visible?: boolean | string;
+}
+
+/**
+ * Report Schedule Configuration
+ */
+export interface ReportSchedule {
+  /**
+   * Schedule enabled
+   */
+  enabled?: boolean;
+
+  /**
+   * Frequency
+   */
+  frequency?: ReportScheduleFrequency;
+
+  /**
+   * Specific day of week (for weekly)
+   */
+  dayOfWeek?: number;
+
+  /**
+   * Specific day of month (for monthly)
+   */
+  dayOfMonth?: number;
+
+  /**
+   * Time to run (HH:mm format)
+   */
+  time?: string;
+
+  /**
+   * Timezone
+   */
+  timezone?: string;
+
+  /**
+   * Email recipients
+   */
+  recipients?: string[];
+
+  /**
+   * Email subject
+   */
+  subject?: string;
+
+  /**
+   * Email body
+   */
+  body?: string;
+
+  /**
+   * Export formats to attach
+   */
+  formats?: ReportExportFormat[];
+}
+
+/**
+ * Report Export Configuration
+ */
+export interface ReportExportConfig {
+  /**
+   * Export format
+   */
+  format: ReportExportFormat;
+
+  /**
+   * Filename template
+   */
+  filename?: string;
+
+  /**
+   * Include headers
+   */
+  includeHeaders?: boolean;
+
+  /**
+   * Page orientation (for PDF)
+   */
+  orientation?: 'portrait' | 'landscape';
+
+  /**
+   * Page size (for PDF)
+   */
+  pageSize?: 'A4' | 'A3' | 'Letter' | 'Legal';
+
+  /**
+   * Custom options
+   */
+  options?: Record<string, any>;
+}
+
+/**
+ * Report Schema - Main report configuration
+ */
+export interface ReportSchema extends BaseSchema {
+  type: 'report';
+
+  /**
+   * Report title
+   */
+  title?: string;
+
+  /**
+   * Report description
+   */
+  description?: string;
+
+  /**
+   * Data source configuration
+   */
+  dataSource?: DataSource;
+
+  /**
+   * Report fields
+   */
+  fields?: ReportField[];
+
+  /**
+   * Report filters
+   */
+  filters?: ReportFilter[];
+
+  /**
+   * Group by configuration
+   */
+  groupBy?: ReportGroupBy[];
+
+  /**
+   * Report sections
+   */
+  sections?: ReportSection[];
+
+  /**
+   * Schedule configuration
+   */
+  schedule?: ReportSchedule;
+
+  /**
+   * Default export format
+   */
+  defaultExportFormat?: ReportExportFormat;
+
+  /**
+   * Export configurations
+   */
+  exportConfigs?: Record<ReportExportFormat, ReportExportConfig>;
+
+  /**
+   * Show export buttons
+   */
+  showExportButtons?: boolean;
+
+  /**
+   * Show print button
+   */
+  showPrintButton?: boolean;
+
+  /**
+   * Show schedule button
+   */
+  showScheduleButton?: boolean;
+
+  /**
+   * Auto-refresh interval (in seconds)
+   */
+  refreshInterval?: number;
+
+  /**
+   * Loading state
+   */
+  loading?: boolean;
+
+  /**
+   * Report data
+   */
+  data?: any[];
+}
+
+/**
+ * Report Builder Schema - Interactive report builder component
+ */
+export interface ReportBuilderSchema extends BaseSchema {
+  type: 'report-builder';
+
+  /**
+   * Initial report configuration
+   */
+  report?: ReportSchema;
+
+  /**
+   * Available data sources
+   */
+  dataSources?: DataSource[];
+
+  /**
+   * Available fields
+   */
+  availableFields?: ReportField[];
+
+  /**
+   * Show preview
+   */
+  showPreview?: boolean;
+
+  /**
+   * Save callback
+   */
+  onSave?: string;
+
+  /**
+   * Cancel callback
+   */
+  onCancel?: string;
+}
+
+/**
+ * Report Viewer Schema - Display a generated report
+ */
+export interface ReportViewerSchema extends BaseSchema {
+  type: 'report-viewer';
+
+  /**
+   * Report to display
+   */
+  report?: ReportSchema;
+
+  /**
+   * Report data
+   */
+  data?: any[];
+
+  /**
+   * Show toolbar
+   */
+  showToolbar?: boolean;
+
+  /**
+   * Allow export
+   */
+  allowExport?: boolean;
+
+  /**
+   * Allow print
+   */
+  allowPrint?: boolean;
+
+  /**
+   * Loading state
+   */
+  loading?: boolean;
+}

package/src/tenant.ts

@@ -0,0 +1,153 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @object-ui/types - Multi-Tenancy Types
+ * 
+ * Type definitions for multi-tenant architecture support including
+ * tenant isolation, scoped queries, and custom branding.
+ * 
+ * @module tenant
+ * @packageDocumentation
+ */
+
+import type { Theme } from './theme';
+
+// ============================================================================
+// Tenant Configuration
+// ============================================================================
+
+/** Tenant isolation strategy */
+export type TenantIsolationStrategy = 'database' | 'schema' | 'row' | 'hybrid';
+
+/** Tenant status */
+export type TenantStatus = 'active' | 'suspended' | 'pending' | 'archived';
+
+/** Tenant plan/tier */
+export type TenantPlan = 'free' | 'starter' | 'professional' | 'enterprise' | 'custom';
+
+/** Tenant definition */
+export interface TenantConfig {
+  /** Unique tenant identifier */
+  id: string;
+  /** Tenant display name */
+  name: string;
+  /** Tenant slug (URL-friendly identifier) */
+  slug: string;
+  /** Tenant status */
+  status: TenantStatus;
+  /** Subscription plan */
+  plan?: TenantPlan;
+  /** Tenant domain (for custom domain support) */
+  domain?: string;
+  /** Data isolation strategy */
+  isolation: TenantIsolationStrategy;
+  /** Custom branding */
+  branding?: TenantBranding;
+  /** Feature flags */
+  features?: Record<string, boolean>;
+  /** Usage limits */
+  limits?: TenantLimits;
+  /** Tenant metadata */
+  metadata?: Record<string, unknown>;
+  /** Created timestamp */
+  createdAt?: string;
+  /** Updated timestamp */
+  updatedAt?: string;
+}
+
+/** Tenant branding configuration */
+export interface TenantBranding {
+  /** Company logo URL */
+  logo?: string;
+  /** Favicon URL */
+  favicon?: string;
+  /** Primary brand color */
+  primaryColor?: string;
+  /** Secondary brand color */
+  secondaryColor?: string;
+  /** Custom theme override */
+  theme?: Partial<Theme>;
+  /** Custom CSS */
+  customCSS?: string;
+  /** Company name displayed in UI */
+  companyName?: string;
+  /** Support email */
+  supportEmail?: string;
+  /** Custom login page background */
+  loginBackground?: string;
+  /** Email templates branding */
+  emailBranding?: {
+    headerLogo?: string;
+    footerText?: string;
+    primaryColor?: string;
+  };
+}
+
+/** Tenant usage limits */
+export interface TenantLimits {
+  /** Maximum number of users */
+  maxUsers?: number;
+  /** Maximum storage in bytes */
+  maxStorage?: number;
+  /** Maximum API calls per day */
+  maxAPICallsPerDay?: number;
+  /** Maximum objects/tables */
+  maxObjects?: number;
+  /** Maximum records per object */
+  maxRecordsPerObject?: number;
+  /** Maximum file upload size in bytes */
+  maxFileSize?: number;
+}
+
+/** Tenant context for runtime use */
+export interface TenantContext {
+  /** Current tenant configuration */
+  tenant: TenantConfig;
+  /** Whether the user is a tenant admin */
+  isTenantAdmin: boolean;
+  /** Resolved branding (merged with defaults) */
+  branding: TenantBranding;
+  /** Active feature flags */
+  features: Record<string, boolean>;
+}
+
+/** Tenant resolution strategy */
+export type TenantResolutionStrategy = 'subdomain' | 'path' | 'header' | 'query' | 'cookie' | 'custom';
+
+/** Tenant provider configuration */
+export interface TenantProviderConfig {
+  /** How to resolve tenant from request */
+  resolution: TenantResolutionStrategy;
+  /** Custom resolution function name */
+  customResolver?: string;
+  /** Header name for 'header' strategy */
+  headerName?: string;
+  /** Query parameter name for 'query' strategy */
+  queryParam?: string;
+  /** Cookie name for 'cookie' strategy */
+  cookieName?: string;
+  /** Default tenant ID for fallback */
+  defaultTenantId?: string;
+  /** Enable tenant caching */
+  caching?: boolean;
+  /** Cache TTL in seconds */
+  cacheTTL?: number;
+}
+
+/** Scoped query configuration for tenant isolation */
+export interface TenantScopedQueryConfig {
+  /** Tenant ID field name in records */
+  tenantField: string;
+  /** Whether to auto-inject tenant filter */
+  autoFilter: boolean;
+  /** Objects excluded from tenant scoping */
+  excludedObjects?: string[];
+  /** Whether to enforce tenant scope on writes */
+  enforceOnWrite: boolean;
+}