@object-ui/types 0.3.1 → 0.5.0

package/src/zod/reports.zod.ts

@@ -0,0 +1,183 @@
+/**
+ * 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/zod - Report Schema Zod Validators
+ * 
+ * Zod validation schemas for report configuration.
+ * Following @objectstack/spec UI specification format.
+ * 
+ * @module zod/reports
+ * @packageDocumentation
+ */
+
+import { z } from 'zod';
+import { BaseSchema, SchemaNodeSchema } from './base.zod.js';
+import { ChartSchema } from './data-display.zod.js';
+
+/**
+ * Report Export Format Schema
+ */
+export const ReportExportFormatSchema = z.enum(['pdf', 'excel', 'csv', 'json', 'html']).describe('Report export format');
+
+/**
+ * Report Schedule Frequency Schema
+ */
+export const ReportScheduleFrequencySchema = z.enum(['once', 'daily', 'weekly', 'monthly', 'quarterly', 'yearly']).describe('Report schedule frequency');
+
+/**
+ * Report Aggregation Type Schema
+ */
+export const ReportAggregationTypeSchema = z.enum(['sum', 'avg', 'min', 'max', 'count', 'distinct']).describe('Report aggregation type');
+
+/**
+ * Report Field Schema
+ */
+export const ReportFieldSchema = z.object({
+  name: z.string().describe('Field name/identifier'),
+  label: z.string().optional().describe('Display label'),
+  type: z.enum(['string', 'number', 'date', 'boolean']).optional().describe('Field type'),
+  aggregation: ReportAggregationTypeSchema.optional().describe('Aggregation function'),
+  format: z.string().optional().describe('Format string'),
+  showInSummary: z.boolean().optional().describe('Show in summary'),
+  sortOrder: z.number().optional().describe('Sort order'),
+});
+
+/**
+ * Report Filter Schema
+ */
+export const ReportFilterSchema = z.object({
+  field: z.string().describe('Field to filter on'),
+  operator: z.enum(['equals', 'not_equals', 'contains', 'greater_than', 'less_than', 'between', 'in', 'not_in']).describe('Filter operator'),
+  value: z.any().optional().describe('Filter value'),
+  values: z.array(z.any()).optional().describe('Multiple values (for "in" operator)'),
+});
+
+/**
+ * Report Group By Schema
+ */
+export const ReportGroupBySchema = z.object({
+  field: z.string().describe('Field to group by'),
+  label: z.string().optional().describe('Display label'),
+  sort: z.enum(['asc', 'desc']).optional().describe('Sort direction'),
+});
+
+/**
+ * Report Section Schema
+ */
+export const ReportSectionSchema = z.object({
+  type: z.enum(['header', 'summary', 'chart', 'table', 'text', 'page-break']).describe('Section type'),
+  title: z.string().optional().describe('Section title'),
+  content: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Section content'),
+  chart: ChartSchema.optional().describe('Chart configuration (for type="chart")'),
+  columns: z.array(ReportFieldSchema).optional().describe('Columns to display (for type="table")'),
+  text: z.string().optional().describe('Text content (for type="text")'),
+  visible: z.union([z.boolean(), z.string()]).optional().describe('Visibility condition'),
+});
+
+/**
+ * Report Schedule Schema
+ */
+export const ReportScheduleSchema = z.object({
+  enabled: z.boolean().optional().describe('Schedule enabled'),
+  frequency: ReportScheduleFrequencySchema.optional().describe('Frequency'),
+  dayOfWeek: z.number().optional().describe('Specific day of week (for weekly)'),
+  dayOfMonth: z.number().optional().describe('Specific day of month (for monthly)'),
+  time: z.string().optional().describe('Time to run (HH:mm format)'),
+  timezone: z.string().optional().describe('Timezone'),
+  recipients: z.array(z.string()).optional().describe('Email recipients'),
+  subject: z.string().optional().describe('Email subject'),
+  body: z.string().optional().describe('Email body'),
+  formats: z.array(ReportExportFormatSchema).optional().describe('Export formats to attach'),
+});
+
+/**
+ * Report Export Config Schema
+ */
+export const ReportExportConfigSchema = z.object({
+  format: ReportExportFormatSchema.describe('Export format'),
+  filename: z.string().optional().describe('Filename template'),
+  includeHeaders: z.boolean().optional().describe('Include headers'),
+  orientation: z.enum(['portrait', 'landscape']).optional().describe('Page orientation (for PDF)'),
+  pageSize: z.enum(['A4', 'A3', 'Letter', 'Legal']).optional().describe('Page size (for PDF)'),
+  options: z.record(z.string(), z.any()).optional().describe('Custom options'),
+});
+
+/**
+ * Report Schema
+ */
+export const ReportSchema = BaseSchema.extend({
+  type: z.literal('report'),
+  title: z.string().optional().describe('Report title'),
+  description: z.string().optional().describe('Report description'),
+  dataSource: z.any().optional().describe('Data source configuration'),
+  fields: z.array(ReportFieldSchema).optional().describe('Report fields'),
+  filters: z.array(ReportFilterSchema).optional().describe('Report filters'),
+  groupBy: z.array(ReportGroupBySchema).optional().describe('Group by configuration'),
+  sections: z.array(ReportSectionSchema).optional().describe('Report sections'),
+  schedule: ReportScheduleSchema.optional().describe('Schedule configuration'),
+  defaultExportFormat: ReportExportFormatSchema.optional().describe('Default export format'),
+  exportConfigs: z.record(z.string(), ReportExportConfigSchema).optional().describe('Export configurations'),
+  showExportButtons: z.boolean().optional().describe('Show export buttons'),
+  showPrintButton: z.boolean().optional().describe('Show print button'),
+  showScheduleButton: z.boolean().optional().describe('Show schedule button'),
+  refreshInterval: z.number().optional().describe('Auto-refresh interval (in seconds)'),
+  loading: z.boolean().optional().describe('Loading state'),
+  data: z.array(z.any()).optional().describe('Report data'),
+});
+
+/**
+ * Report Builder Schema
+ */
+export const ReportBuilderSchema = BaseSchema.extend({
+  type: z.literal('report-builder'),
+  report: ReportSchema.optional().describe('Initial report configuration'),
+  dataSources: z.array(z.any()).optional().describe('Available data sources'),
+  availableFields: z.array(ReportFieldSchema).optional().describe('Available fields'),
+  showPreview: z.boolean().optional().describe('Show preview'),
+  onSave: z.string().optional().describe('Save callback'),
+  onCancel: z.string().optional().describe('Cancel callback'),
+});
+
+/**
+ * Report Viewer Schema
+ */
+export const ReportViewerSchema = BaseSchema.extend({
+  type: z.literal('report-viewer'),
+  report: ReportSchema.optional().describe('Report to display'),
+  data: z.array(z.any()).optional().describe('Report data'),
+  showToolbar: z.boolean().optional().describe('Show toolbar'),
+  allowExport: z.boolean().optional().describe('Allow export'),
+  allowPrint: z.boolean().optional().describe('Allow print'),
+  loading: z.boolean().optional().describe('Loading state'),
+});
+
+/**
+ * Union of all report schemas
+ */
+export const ReportComponentSchema = z.union([
+  ReportSchema,
+  ReportBuilderSchema,
+  ReportViewerSchema,
+]);
+
+/**
+ * Export type inference helpers
+ */
+export type ReportExportFormatSchemaType = z.infer<typeof ReportExportFormatSchema>;
+export type ReportScheduleFrequencySchemaType = z.infer<typeof ReportScheduleFrequencySchema>;
+export type ReportAggregationTypeSchemaType = z.infer<typeof ReportAggregationTypeSchema>;
+export type ReportFieldSchemaType = z.infer<typeof ReportFieldSchema>;
+export type ReportFilterSchemaType = z.infer<typeof ReportFilterSchema>;
+export type ReportGroupBySchemaType = z.infer<typeof ReportGroupBySchema>;
+export type ReportSectionSchemaType = z.infer<typeof ReportSectionSchema>;
+export type ReportScheduleSchemaType = z.infer<typeof ReportScheduleSchema>;
+export type ReportExportConfigSchemaType = z.infer<typeof ReportExportConfigSchema>;
+export type ReportSchemaType = z.infer<typeof ReportSchema>;
+export type ReportBuilderSchemaType = z.infer<typeof ReportBuilderSchema>;
+export type ReportViewerSchemaType = z.infer<typeof ReportViewerSchema>;

package/src/zod/theme.zod.ts

@@ -0,0 +1,155 @@
+/**
+ * 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/zod - Theme Schema Zod Validators
+ * 
+ * Zod validation schemas for theme configuration.
+ * Following @objectstack/spec UI specification format.
+ * 
+ * @module zod/theme
+ * @packageDocumentation
+ */
+
+import { z } from 'zod';
+import { BaseSchema } from './base.zod.js';
+
+/**
+ * Color Palette Schema
+ */
+export const ColorPaletteSchema = z.object({
+  primary: z.string().optional().describe('Primary brand color'),
+  secondary: z.string().optional().describe('Secondary color'),
+  accent: z.string().optional().describe('Accent color'),
+  background: z.string().optional().describe('Background color'),
+  foreground: z.string().optional().describe('Foreground/text color'),
+  muted: z.string().optional().describe('Muted color'),
+  mutedForeground: z.string().optional().describe('Muted foreground color'),
+  border: z.string().optional().describe('Border color'),
+  input: z.string().optional().describe('Input border color'),
+  ring: z.string().optional().describe('Ring/focus color'),
+  success: z.string().optional().describe('Success color'),
+  warning: z.string().optional().describe('Warning color'),
+  destructive: z.string().optional().describe('Error/destructive color'),
+  info: z.string().optional().describe('Info color'),
+  card: z.string().optional().describe('Card background color'),
+  cardForeground: z.string().optional().describe('Card foreground color'),
+  popover: z.string().optional().describe('Popover background color'),
+  popoverForeground: z.string().optional().describe('Popover foreground color'),
+});
+
+/**
+ * Typography Schema
+ */
+export const TypographySchema = z.object({
+  fontSans: z.array(z.string()).optional().describe('Font family for sans-serif text'),
+  fontSerif: z.array(z.string()).optional().describe('Font family for serif text'),
+  fontMono: z.array(z.string()).optional().describe('Font family for monospace text'),
+  fontSize: z.number().optional().describe('Base font size (in rem)'),
+  lineHeight: z.number().optional().describe('Line height'),
+  headingWeight: z.number().optional().describe('Font weight for headings'),
+  bodyWeight: z.number().optional().describe('Font weight for body text'),
+});
+
+/**
+ * Spacing Scale Schema
+ */
+export const SpacingScaleSchema = z.object({
+  base: z.number().optional().describe('Base spacing unit (in rem)'),
+  scale: z.record(z.string(), z.string()).optional().describe('Custom spacing values'),
+});
+
+/**
+ * Border Radius Schema
+ */
+export const BorderRadiusSchema = z.object({
+  sm: z.string().optional().describe('Small radius'),
+  default: z.string().optional().describe('Default radius'),
+  md: z.string().optional().describe('Medium radius'),
+  lg: z.string().optional().describe('Large radius'),
+  xl: z.string().optional().describe('Extra large radius'),
+});
+
+/**
+ * Theme Mode Schema
+ */
+export const ThemeModeSchema = z.enum(['light', 'dark', 'system']).describe('Theme mode');
+
+/**
+ * Theme Definition Schema
+ */
+export const ThemeDefinitionSchema = z.object({
+  name: z.string().describe('Theme name/identifier'),
+  label: z.string().optional().describe('Theme display label'),
+  light: ColorPaletteSchema.optional().describe('Light mode color palette'),
+  dark: ColorPaletteSchema.optional().describe('Dark mode color palette'),
+  typography: TypographySchema.optional().describe('Typography configuration'),
+  spacing: SpacingScaleSchema.optional().describe('Spacing scale configuration'),
+  radius: BorderRadiusSchema.optional().describe('Border radius configuration'),
+  cssVariables: z.record(z.string(), z.string()).optional().describe('Custom CSS variables'),
+  tailwind: z.record(z.string(), z.any()).optional().describe('Tailwind configuration overrides'),
+});
+
+/**
+ * Theme Schema
+ */
+export const ThemeSchema = BaseSchema.extend({
+  type: z.literal('theme'),
+  mode: ThemeModeSchema.optional().describe('Current theme mode'),
+  themes: z.array(ThemeDefinitionSchema).optional().describe('Available themes'),
+  activeTheme: z.string().optional().describe('Active theme name'),
+  allowSwitching: z.boolean().optional().describe('Allow user theme switching'),
+  persistPreference: z.boolean().optional().describe('Persist theme preference'),
+  storageKey: z.string().optional().describe('Storage key for persisting theme'),
+});
+
+/**
+ * Theme Switcher Schema
+ */
+export const ThemeSwitcherSchema = BaseSchema.extend({
+  type: z.literal('theme-switcher'),
+  variant: z.enum(['dropdown', 'toggle', 'buttons']).optional().describe('Switcher variant'),
+  showMode: z.boolean().optional().describe('Show mode selector (light/dark)'),
+  showThemes: z.boolean().optional().describe('Show theme selector'),
+  lightIcon: z.string().optional().describe('Icon for light mode'),
+  darkIcon: z.string().optional().describe('Icon for dark mode'),
+});
+
+/**
+ * Theme Preview Schema
+ */
+export const ThemePreviewSchema = BaseSchema.extend({
+  type: z.literal('theme-preview'),
+  theme: ThemeDefinitionSchema.optional().describe('Theme to preview'),
+  mode: ThemeModeSchema.optional().describe('Preview mode'),
+  showColors: z.boolean().optional().describe('Show color palette'),
+  showTypography: z.boolean().optional().describe('Show typography samples'),
+  showComponents: z.boolean().optional().describe('Show component samples'),
+});
+
+/**
+ * Union of all theme schemas
+ */
+export const ThemeComponentSchema = z.union([
+  ThemeSchema,
+  ThemeSwitcherSchema,
+  ThemePreviewSchema,
+]);
+
+/**
+ * Export type inference helpers
+ */
+export type ColorPaletteSchemaType = z.infer<typeof ColorPaletteSchema>;
+export type TypographySchemaType = z.infer<typeof TypographySchema>;
+export type SpacingScaleSchemaType = z.infer<typeof SpacingScaleSchema>;
+export type BorderRadiusSchemaType = z.infer<typeof BorderRadiusSchema>;
+export type ThemeModeSchemaType = z.infer<typeof ThemeModeSchema>;
+export type ThemeDefinitionSchemaType = z.infer<typeof ThemeDefinitionSchema>;
+export type ThemeSchemaType = z.infer<typeof ThemeSchema>;
+export type ThemeSwitcherSchemaType = z.infer<typeof ThemeSwitcherSchema>;
+export type ThemePreviewSchemaType = z.infer<typeof ThemePreviewSchema>;

package/src/zod/views.zod.ts

@@ -0,0 +1,182 @@
+/**
+ * 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/zod - View Component Zod Validators
+ * 
+ * Zod validation schemas for view components.
+ * Following @objectstack/spec UI specification format.
+ * 
+ * @module zod/views
+ * @packageDocumentation
+ */
+
+import { z } from 'zod';
+import { BaseSchema, SchemaNodeSchema } from './base.zod.js';
+
+/**
+ * View Type Schema
+ */
+export const ViewTypeSchema = z.enum(['list', 'detail', 'grid', 'kanban', 'calendar', 'timeline', 'map']).describe('View type');
+
+/**
+ * Detail View Field Schema
+ */
+export const DetailViewFieldSchema = z.object({
+  name: z.string().describe('Field name/path'),
+  label: z.string().optional().describe('Display label'),
+  type: z.enum(['text', 'image', 'link', 'badge', 'date', 'datetime', 'json', 'html', 'markdown', 'custom']).optional().describe('Field type for rendering'),
+  format: z.string().optional().describe('Format string (e.g., date format)'),
+  render: SchemaNodeSchema.optional().describe('Custom renderer'),
+  value: z.any().optional().describe('Field value'),
+  readonly: z.boolean().optional().describe('Whether field is read-only'),
+  visible: z.union([z.boolean(), z.string()]).optional().describe('Field visibility condition'),
+  span: z.number().optional().describe('Span across columns (for grid layout)'),
+});
+
+/**
+ * Detail View Section Schema
+ */
+export const DetailViewSectionSchema = z.object({
+  title: z.string().optional().describe('Section title'),
+  description: z.string().optional().describe('Section description'),
+  icon: z.string().optional().describe('Section icon'),
+  fields: z.array(DetailViewFieldSchema).describe('Fields in this section'),
+  collapsible: z.boolean().optional().describe('Collapsible section'),
+  defaultCollapsed: z.boolean().optional().describe('Default collapsed state'),
+  columns: z.number().optional().describe('Grid columns for field layout'),
+  visible: z.union([z.boolean(), z.string()]).optional().describe('Section visibility condition'),
+});
+
+/**
+ * Detail View Tab Schema
+ */
+export const DetailViewTabSchema = z.object({
+  key: z.string().describe('Tab key/identifier'),
+  label: z.string().describe('Tab label'),
+  icon: z.string().optional().describe('Tab icon'),
+  content: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).describe('Tab content'),
+  visible: z.union([z.boolean(), z.string()]).optional().describe('Tab visibility condition'),
+  badge: z.union([z.string(), z.number()]).optional().describe('Badge count'),
+});
+
+/**
+ * Detail View Schema
+ */
+export const DetailViewSchema = BaseSchema.extend({
+  type: z.literal('detail-view'),
+  title: z.string().optional().describe('Detail title'),
+  api: z.string().optional().describe('API endpoint to fetch detail data'),
+  resourceId: z.union([z.string(), z.number()]).optional().describe('Resource ID to display'),
+  objectName: z.string().optional().describe('Object name (for ObjectQL integration)'),
+  data: z.any().optional().describe('Data to display (if not fetching from API)'),
+  layout: z.enum(['vertical', 'horizontal', 'grid']).optional().describe('Layout mode'),
+  columns: z.number().optional().describe('Grid columns (for grid layout)'),
+  sections: z.array(DetailViewSectionSchema).optional().describe('Field sections for organized display'),
+  fields: z.array(DetailViewFieldSchema).optional().describe('Direct fields (without sections)'),
+  actions: z.array(z.any()).optional().describe('Actions available in detail view'),
+  tabs: z.array(DetailViewTabSchema).optional().describe('Tabs for additional content'),
+  showBack: z.boolean().optional().default(true).describe('Show back button'),
+  backUrl: z.string().optional().describe('Back button URL'),
+  onBack: z.string().optional().describe('Custom back action'),
+  showEdit: z.boolean().optional().describe('Show edit button'),
+  editUrl: z.string().optional().describe('Edit button URL'),
+  showDelete: z.boolean().optional().describe('Show delete button'),
+  deleteConfirmation: z.string().optional().describe('Delete confirmation message'),
+  loading: z.boolean().optional().default(true).describe('Whether to show loading state'),
+  header: SchemaNodeSchema.optional().describe('Custom header content'),
+  footer: SchemaNodeSchema.optional().describe('Custom footer content'),
+  related: z.array(z.object({
+    title: z.string().describe('Relation title'),
+    type: z.enum(['list', 'grid', 'table']).describe('Relation type'),
+    api: z.string().optional().describe('API endpoint for related data'),
+    data: z.array(z.any()).optional().describe('Static data'),
+    columns: z.array(z.any()).optional().describe('Columns for table view'),
+    fields: z.array(z.string()).optional().describe('Fields for list view'),
+  })).optional().describe('Related records section'),
+});
+
+/**
+ * View Switcher Schema
+ */
+export const ViewSwitcherSchema = BaseSchema.extend({
+  type: z.literal('view-switcher'),
+  views: z.array(z.object({
+    type: ViewTypeSchema.describe('View type'),
+    label: z.string().optional().describe('View label'),
+    icon: z.string().optional().describe('View icon'),
+    schema: SchemaNodeSchema.optional().describe('View schema'),
+  })).describe('Available view types'),
+  defaultView: ViewTypeSchema.optional().describe('Default/active view'),
+  activeView: ViewTypeSchema.optional().describe('Current active view'),
+  variant: z.enum(['tabs', 'buttons', 'dropdown']).optional().describe('Switcher variant'),
+  position: z.enum(['top', 'bottom', 'left', 'right']).optional().describe('Switcher position'),
+  onViewChange: z.string().optional().describe('View change callback'),
+  persistPreference: z.boolean().optional().describe('Persist view preference'),
+  storageKey: z.string().optional().describe('Storage key for persisting view'),
+});
+
+/**
+ * Filter UI Schema
+ */
+export const FilterUISchema = BaseSchema.extend({
+  type: z.literal('filter-ui'),
+  filters: z.array(z.object({
+    field: z.string().describe('Filter field'),
+    label: z.string().optional().describe('Filter label'),
+    type: z.enum(['text', 'number', 'select', 'date', 'date-range', 'boolean']).describe('Filter type'),
+    operator: z.enum(['equals', 'contains', 'startsWith', 'gt', 'lt', 'between', 'in']).optional().describe('Filter operator'),
+    options: z.array(z.object({ label: z.string(), value: z.any() })).optional().describe('Options for select filter'),
+    placeholder: z.string().optional().describe('Placeholder'),
+  })).describe('Available filters'),
+  values: z.record(z.string(), z.any()).optional().describe('Current filter values'),
+  onChange: z.string().optional().describe('Filter change callback'),
+  showClear: z.boolean().optional().describe('Show clear button'),
+  showApply: z.boolean().optional().describe('Show apply button'),
+  layout: z.enum(['inline', 'popover', 'drawer']).optional().describe('Filter layout'),
+});
+
+/**
+ * Sort UI Schema
+ */
+export const SortUISchema = BaseSchema.extend({
+  type: z.literal('sort-ui'),
+  fields: z.array(z.object({
+    field: z.string().describe('Field name'),
+    label: z.string().optional().describe('Field label'),
+  })).describe('Sortable fields'),
+  sort: z.array(z.object({
+    field: z.string().describe('Field to sort by'),
+    direction: z.enum(['asc', 'desc']).describe('Sort direction'),
+  })).optional().describe('Current sort configuration'),
+  onChange: z.string().optional().describe('Sort change callback'),
+  multiple: z.boolean().optional().describe('Allow multiple sort fields'),
+  variant: z.enum(['dropdown', 'buttons']).optional().describe('UI variant'),
+});
+
+/**
+ * Union of all view schemas
+ */
+export const ViewComponentSchema = z.union([
+  DetailViewSchema,
+  ViewSwitcherSchema,
+  FilterUISchema,
+  SortUISchema,
+]);
+
+/**
+ * Export type inference helpers
+ */
+export type ViewTypeSchemaType = z.infer<typeof ViewTypeSchema>;
+export type DetailViewFieldSchemaType = z.infer<typeof DetailViewFieldSchema>;
+export type DetailViewSectionSchemaType = z.infer<typeof DetailViewSectionSchema>;
+export type DetailViewTabSchemaType = z.infer<typeof DetailViewTabSchema>;
+export type DetailViewSchemaType = z.infer<typeof DetailViewSchema>;
+export type ViewSwitcherSchemaType = z.infer<typeof ViewSwitcherSchema>;
+export type FilterUISchemaType = z.infer<typeof FilterUISchema>;
+export type SortUISchemaType = z.infer<typeof SortUISchema>;