@object-ui/types 0.3.1 → 2.0.0

package/src/zod/objectql.zod.ts

@@ -17,15 +17,17 @@
  */
 
 import { z } from 'zod';
-import { BaseSchema } from './base.zod';
+import { BaseSchema } from './base.zod.js';
 
 /**
  * HTTP Method Schema
+ * Mirrors @objectstack/spec/ui HttpMethodSchema.
  */
 export const HttpMethodSchema = z.enum(['GET', 'POST', 'PUT', 'PATCH', 'DELETE']);
 
 /**
  * HTTP Request Schema
+ * Mirrors @objectstack/spec/ui HttpRequestSchema.
  */
 export const HttpRequestSchema = z.object({
   url: z.string().describe('API endpoint URL'),
@@ -37,6 +39,7 @@ export const HttpRequestSchema = z.object({
 
 /**
  * View Data Source Schema
+ * Mirrors @objectstack/spec/ui ViewDataSchema.
  */
 export const ViewDataSchema = z.union([
   z.object({
@@ -56,6 +59,7 @@ export const ViewDataSchema = z.union([
 
 /**
  * List Column Schema
+ * Mirrors @objectstack/spec/ui ListColumnSchema.
  */
 export const ListColumnSchema = z.object({
   field: z.string().describe('Field name'),
@@ -67,10 +71,13 @@ export const ListColumnSchema = z.object({
   resizable: z.boolean().optional().describe('Allow resizing'),
   wrap: z.boolean().optional().describe('Allow text wrapping'),
   type: z.string().optional().describe('Renderer type override'),
+  link: z.boolean().optional().describe('Functions as the primary navigation link (triggers View navigation)'),
+  action: z.string().optional().describe('Registered Action ID to execute when clicked'),
 });
 
 /**
  * Selection Config Schema
+ * Mirrors @objectstack/spec/ui SelectionConfigSchema.
  */
 export const SelectionConfigSchema = z.object({
   type: z.enum(['none', 'single', 'multiple']).optional().describe('Selection mode'),
@@ -78,6 +85,7 @@ export const SelectionConfigSchema = z.object({
 
 /**
  * Pagination Config Schema
+ * Mirrors @objectstack/spec/ui PaginationConfigSchema.
  */
 export const PaginationConfigSchema = z.object({
   pageSize: z.number().optional().describe('Page size'),

package/src/zod/overlay.zod.ts

@@ -17,7 +17,7 @@
  */
 
 import { z } from 'zod';
-import { BaseSchema, SchemaNodeSchema } from './base.zod';
+import { BaseSchema, SchemaNodeSchema } from './base.zod.js';
 
 /**
  * Dialog Schema - Dialog/modal component

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,296 @@
+/**
+ * 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.
+ * Aligned with @objectstack/spec UI specification.
+ *
+ * @module zod/theme
+ * @packageDocumentation
+ */
+
+import { z } from 'zod';
+import { BaseSchema } from './base.zod.js';
+
+/**
+ * Color Palette Schema
+ * Mirrors @objectstack/spec/ui ColorPaletteSchema.
+ */
+export const ColorPaletteSchema = z.object({
+  primary: z.string().describe('Primary brand color'),
+  secondary: z.string().optional().describe('Secondary color'),
+  accent: z.string().optional().describe('Accent color'),
+  success: z.string().optional().describe('Success color'),
+  warning: z.string().optional().describe('Warning color'),
+  error: z.string().optional().describe('Error color'),
+  info: z.string().optional().describe('Informational color'),
+  background: z.string().optional().describe('Background color'),
+  surface: z.string().optional().describe('Surface/card background color'),
+  text: z.string().optional().describe('Primary text color'),
+  textSecondary: z.string().optional().describe('Secondary text color'),
+  border: z.string().optional().describe('Border color'),
+  disabled: z.string().optional().describe('Disabled state color'),
+  primaryLight: z.string().optional().describe('Lighter primary variant'),
+  primaryDark: z.string().optional().describe('Darker primary variant'),
+  secondaryLight: z.string().optional().describe('Lighter secondary variant'),
+  secondaryDark: z.string().optional().describe('Darker secondary variant'),
+});
+
+/**
+ * Typography Schema
+ * Mirrors @objectstack/spec/ui TypographySchema.
+ */
+export const TypographySchema = z.object({
+  fontFamily: z.object({
+    base: z.string().optional().describe('Base body font family'),
+    heading: z.string().optional().describe('Heading font family'),
+    mono: z.string().optional().describe('Monospace font family'),
+  }).optional().describe('Font family definitions'),
+  fontSize: z.object({
+    xs: z.string().optional(),
+    sm: z.string().optional(),
+    base: z.string().optional(),
+    lg: z.string().optional(),
+    xl: z.string().optional(),
+    '2xl': z.string().optional(),
+    '3xl': z.string().optional(),
+    '4xl': z.string().optional(),
+  }).optional().describe('Font size scale'),
+  fontWeight: z.object({
+    light: z.number().optional(),
+    normal: z.number().optional(),
+    medium: z.number().optional(),
+    semibold: z.number().optional(),
+    bold: z.number().optional(),
+  }).optional().describe('Font weight scale'),
+  lineHeight: z.object({
+    tight: z.string().optional(),
+    normal: z.string().optional(),
+    relaxed: z.string().optional(),
+    loose: z.string().optional(),
+  }).optional().describe('Line height scale'),
+  letterSpacing: z.object({
+    tighter: z.string().optional(),
+    tight: z.string().optional(),
+    normal: z.string().optional(),
+    wide: z.string().optional(),
+    wider: z.string().optional(),
+  }).optional().describe('Letter spacing scale'),
+});
+
+/**
+ * Spacing Scale Schema
+ * Mirrors @objectstack/spec/ui SpacingSchema.
+ */
+export const SpacingSchema = z.object({
+  '0': z.string().optional(),
+  '1': z.string().optional(),
+  '2': z.string().optional(),
+  '3': z.string().optional(),
+  '4': z.string().optional(),
+  '5': z.string().optional(),
+  '6': z.string().optional(),
+  '8': z.string().optional(),
+  '10': z.string().optional(),
+  '12': z.string().optional(),
+  '16': z.string().optional(),
+  '20': z.string().optional(),
+  '24': z.string().optional(),
+});
+
+/**
+ * Border Radius Schema
+ * Mirrors @objectstack/spec/ui BorderRadiusSchema.
+ */
+export const BorderRadiusSchema = z.object({
+  none: z.string().optional(),
+  sm: z.string().optional(),
+  base: z.string().optional(),
+  md: z.string().optional(),
+  lg: z.string().optional(),
+  xl: z.string().optional(),
+  '2xl': z.string().optional(),
+  full: z.string().optional(),
+});
+
+/**
+ * Shadow Schema
+ * Mirrors @objectstack/spec/ui ShadowSchema.
+ */
+export const ShadowSchema = z.object({
+  none: z.string().optional(),
+  sm: z.string().optional(),
+  base: z.string().optional(),
+  md: z.string().optional(),
+  lg: z.string().optional(),
+  xl: z.string().optional(),
+  '2xl': z.string().optional(),
+  inner: z.string().optional(),
+});
+
+/**
+ * Breakpoints Schema
+ * Mirrors @objectstack/spec/ui BreakpointsSchema.
+ */
+export const BreakpointsSchema = z.object({
+  xs: z.string().optional(),
+  sm: z.string().optional(),
+  md: z.string().optional(),
+  lg: z.string().optional(),
+  xl: z.string().optional(),
+  '2xl': z.string().optional(),
+});
+
+/**
+ * Animation Schema
+ * Mirrors @objectstack/spec/ui AnimationSchema.
+ */
+export const AnimationSchema = z.object({
+  duration: z.object({
+    fast: z.string().optional(),
+    base: z.string().optional(),
+    slow: z.string().optional(),
+  }).optional().describe('Duration presets'),
+  timing: z.object({
+    linear: z.string().optional(),
+    ease: z.string().optional(),
+    easeIn: z.string().optional(),
+    easeOut: z.string().optional(),
+    easeInOut: z.string().optional(),
+  }).optional().describe('Timing function presets'),
+});
+
+/**
+ * Z-Index Schema
+ * Mirrors @objectstack/spec/ui ZIndexSchema.
+ */
+export const ZIndexSchema = z.object({
+  base: z.number().optional(),
+  dropdown: z.number().optional(),
+  sticky: z.number().optional(),
+  fixed: z.number().optional(),
+  modalBackdrop: z.number().optional(),
+  modal: z.number().optional(),
+  popover: z.number().optional(),
+  tooltip: z.number().optional(),
+});
+
+/**
+ * Theme Mode Schema
+ * Mirrors @objectstack/spec/ui ThemeMode.
+ */
+export const ThemeModeSchema = z.enum(['light', 'dark', 'auto']).describe('Theme mode');
+
+/**
+ * Theme Logo Schema
+ * Mirrors the inline logo object in @objectstack/spec ThemeSchema.
+ */
+export const ThemeLogoSchema = z.object({
+  light: z.string().optional().describe('Logo URL for light mode'),
+  dark: z.string().optional().describe('Logo URL for dark mode'),
+  favicon: z.string().optional().describe('Favicon URL'),
+});
+
+/**
+ * Theme Definition Schema
+ * Mirrors @objectstack/spec/ui ThemeSchema.
+ */
+export const ThemeDefinitionSchema = z.object({
+  name: z.string().describe('Theme identifier'),
+  label: z.string().describe('Display label'),
+  description: z.string().optional().describe('Human-readable description'),
+  mode: ThemeModeSchema.default('auto').describe('Theme mode'),
+  colors: ColorPaletteSchema.describe('Semantic color palette'),
+  typography: TypographySchema.optional().describe('Typography design tokens'),
+  spacing: SpacingSchema.optional().describe('Spacing scale'),
+  borderRadius: BorderRadiusSchema.optional().describe('Border radius scale'),
+  shadows: ShadowSchema.optional().describe('Shadow scale'),
+  breakpoints: BreakpointsSchema.optional().describe('Responsive breakpoints'),
+  animation: AnimationSchema.optional().describe('Animation presets'),
+  zIndex: ZIndexSchema.optional().describe('Z-index layering'),
+  customVars: z.record(z.string(), z.string()).optional().describe('Custom CSS variables'),
+  logo: ThemeLogoSchema.optional().describe('Logo/branding assets'),
+  extends: z.string().optional().describe('Extend another theme by name'),
+});
+
+/**
+ * Theme Component Schema (ObjectUI rendering)
+ */
+export const ThemeComponentSchema = 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'),
+});
+
+/**
+ * Legacy alias — use ThemeComponentSchema
+ * @deprecated
+ */
+export const ThemeSchema = ThemeComponentSchema;
+
+/**
+ * Union of all theme component schemas (for AnyComponentSchema union).
+ */
+export const ThemeUnionSchema = z.union([
+  ThemeComponentSchema,
+  ThemeSwitcherSchema,
+  ThemePreviewSchema,
+]);
+
+/**
+ * Legacy alias — use SpacingSchema
+ * @deprecated
+ */
+export const SpacingScaleSchema = SpacingSchema;
+
+/**
+ * Export type inference helpers
+ */
+export type ColorPaletteSchemaType = z.infer<typeof ColorPaletteSchema>;
+export type TypographySchemaType = z.infer<typeof TypographySchema>;
+export type SpacingSchemaType = z.infer<typeof SpacingSchema>;
+export type BorderRadiusSchemaType = z.infer<typeof BorderRadiusSchema>;
+export type ShadowSchemaType = z.infer<typeof ShadowSchema>;
+export type BreakpointsSchemaType = z.infer<typeof BreakpointsSchema>;
+export type AnimationSchemaType = z.infer<typeof AnimationSchema>;
+export type ZIndexSchemaType = z.infer<typeof ZIndexSchema>;
+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>;