@object-ui/types 0.3.0 → 0.5.0

package/src/zod/blocks.zod.ts

@@ -0,0 +1,170 @@
+/**
+ * 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 - Block Schema Zod Validators
+ * 
+ * Zod validation schemas for reusable component blocks.
+ * Following @objectstack/spec UI specification format.
+ * 
+ * @module zod/blocks
+ * @packageDocumentation
+ */
+
+import { z } from 'zod';
+import { BaseSchema, SchemaNodeSchema } from './base.zod.js';
+
+/**
+ * Block Variable Schema
+ */
+export const BlockVariableSchema = z.object({
+  name: z.string().describe('Variable name'),
+  label: z.string().optional().describe('Display label'),
+  type: z.enum(['string', 'number', 'boolean', 'object', 'array', 'component']).optional().describe('Variable type'),
+  defaultValue: z.any().optional().describe('Default value'),
+  description: z.string().optional().describe('Description/help text'),
+  required: z.boolean().optional().describe('Whether this variable is required'),
+  validation: z.any().optional().describe('Validation rules'),
+  enum: z.array(z.any()).optional().describe('Enum options (for string/number types)'),
+});
+
+/**
+ * Block Slot Schema
+ */
+export const BlockSlotSchema = z.object({
+  name: z.string().describe('Slot name'),
+  label: z.string().optional().describe('Display label'),
+  description: z.string().optional().describe('Description'),
+  defaultContent: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Default content'),
+  allowedTypes: z.array(z.string()).optional().describe('Allowed component types'),
+  maxChildren: z.number().optional().describe('Maximum number of children'),
+  required: z.boolean().optional().describe('Whether this slot is required'),
+});
+
+/**
+ * Block Metadata Schema
+ */
+export const BlockMetadataSchema = z.object({
+  name: z.string().describe('Block name/identifier'),
+  label: z.string().optional().describe('Display label'),
+  description: z.string().optional().describe('Block description'),
+  category: z.string().optional().describe('Block category'),
+  icon: z.string().optional().describe('Block icon'),
+  tags: z.array(z.string()).optional().describe('Block tags for search'),
+  author: z.string().optional().describe('Author/creator'),
+  version: z.string().optional().describe('Version'),
+  license: z.string().optional().describe('License'),
+  repository: z.string().optional().describe('Repository URL'),
+  preview: z.string().optional().describe('Preview image URL'),
+  premium: z.boolean().optional().describe('Is this a premium/paid block'),
+});
+
+/**
+ * Block Schema
+ */
+export const BlockSchema = BaseSchema.extend({
+  type: z.literal('block'),
+  meta: BlockMetadataSchema.optional().describe('Block metadata'),
+  variables: z.array(BlockVariableSchema).optional().describe('Block variables/props'),
+  slots: z.array(BlockSlotSchema).optional().describe('Block slots for content injection'),
+  template: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Block template (component tree)'),
+  values: z.record(z.string(), z.any()).optional().describe('Variable values (when using a block)'),
+  slotContent: z.record(z.string(), z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)])).optional().describe('Slot content (when using a block)'),
+  blockRef: z.string().optional().describe('Block reference (for reusing saved blocks)'),
+  editable: z.boolean().optional().describe('Enable edit mode'),
+});
+
+/**
+ * Block Library Item Schema
+ */
+export const BlockLibraryItemSchema = z.object({
+  id: z.string().describe('Unique identifier'),
+  meta: BlockMetadataSchema.describe('Block metadata'),
+  schema: BlockSchema.describe('Block schema'),
+  installs: z.number().optional().describe('Installation count'),
+  rating: z.number().optional().describe('Rating (1-5)'),
+  ratingCount: z.number().optional().describe('Number of ratings'),
+  updatedAt: z.string().optional().describe('Last updated timestamp'),
+  createdAt: z.string().optional().describe('Created timestamp'),
+});
+
+/**
+ * Block Library Schema
+ */
+export const BlockLibrarySchema = BaseSchema.extend({
+  type: z.literal('block-library'),
+  apiEndpoint: z.string().optional().describe('Library API endpoint'),
+  category: z.string().optional().describe('Filter by category'),
+  searchQuery: z.string().optional().describe('Search query'),
+  tags: z.array(z.string()).optional().describe('Filter by tags'),
+  showPremium: z.boolean().optional().describe('Show premium blocks'),
+  blocks: z.array(BlockLibraryItemSchema).optional().describe('Blocks to display'),
+  loading: z.boolean().optional().describe('Loading state'),
+  onInstall: z.string().optional().describe('Install callback'),
+  onPreview: z.string().optional().describe('Preview callback'),
+});
+
+/**
+ * Block Editor Schema
+ */
+export const BlockEditorSchema = BaseSchema.extend({
+  type: z.literal('block-editor'),
+  block: BlockSchema.optional().describe('Block being edited'),
+  showVariables: z.boolean().optional().describe('Show variable editor'),
+  showSlots: z.boolean().optional().describe('Show slot editor'),
+  showTemplate: z.boolean().optional().describe('Show template editor'),
+  showPreview: z.boolean().optional().describe('Show preview'),
+  onSave: z.string().optional().describe('Save callback'),
+  onCancel: z.string().optional().describe('Cancel callback'),
+});
+
+/**
+ * Block Instance Schema
+ */
+export const BlockInstanceSchema = BaseSchema.extend({
+  type: z.literal('block-instance'),
+  blockId: z.string().describe('Block reference ID'),
+  blockName: z.string().optional().describe('Block name (for local blocks)'),
+  values: z.record(z.string(), z.any()).optional().describe('Variable values'),
+  slotContent: z.record(z.string(), z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)])).optional().describe('Slot content'),
+  overrideStyles: z.boolean().optional().describe('Override styles'),
+});
+
+/**
+ * Component Schema
+ */
+export const ComponentSchema = BaseSchema.extend({
+  type: z.literal('component'),
+  componentName: z.string().optional().describe('Component name/identifier'),
+  props: z.record(z.string(), z.any()).optional().describe('Component props'),
+  children: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Component children'),
+});
+
+/**
+ * Union of all block schemas
+ */
+export const BlockComponentSchema = z.union([
+  BlockSchema,
+  BlockLibrarySchema,
+  BlockEditorSchema,
+  BlockInstanceSchema,
+  ComponentSchema,
+]);
+
+/**
+ * Export type inference helpers
+ */
+export type BlockVariableSchemaType = z.infer<typeof BlockVariableSchema>;
+export type BlockSlotSchemaType = z.infer<typeof BlockSlotSchema>;
+export type BlockMetadataSchemaType = z.infer<typeof BlockMetadataSchema>;
+export type BlockSchemaType = z.infer<typeof BlockSchema>;
+export type BlockLibraryItemSchemaType = z.infer<typeof BlockLibraryItemSchema>;
+export type BlockLibrarySchemaType = z.infer<typeof BlockLibrarySchema>;
+export type BlockEditorSchemaType = z.infer<typeof BlockEditorSchema>;
+export type BlockInstanceSchemaType = z.infer<typeof BlockInstanceSchema>;
+export type ComponentSchemaType = z.infer<typeof ComponentSchema>;

package/src/zod/complex.zod.ts

@@ -0,0 +1,258 @@
+/**
+ * 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 - Complex Component Zod Validators
+ * 
+ * Zod validation schemas for advanced/composite components.
+ * Following @objectstack/spec UI specification format.
+ * 
+ * @module zod/complex
+ * @packageDocumentation
+ */
+
+import { z } from 'zod';
+import { BaseSchema, SchemaNodeSchema } from './base.zod.js';
+
+/**
+ * Kanban Card Schema
+ */
+export const KanbanCardSchema = z.object({
+  id: z.string().describe('Card ID'),
+  title: z.string().describe('Card title'),
+  description: z.string().optional().describe('Card description'),
+  labels: z.array(z.string()).optional().describe('Card labels'),
+  assignees: z.array(z.string()).optional().describe('Card assignees'),
+  dueDate: z.union([z.string(), z.date()]).optional().describe('Due date'),
+  priority: z.enum(['low', 'medium', 'high', 'critical']).optional().describe('Card priority'),
+  content: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Custom content'),
+  data: z.any().optional().describe('Custom card data'),
+});
+
+/**
+ * Kanban Column Schema
+ */
+export const KanbanColumnSchema = z.object({
+  id: z.string().describe('Column ID'),
+  title: z.string().describe('Column title'),
+  items: z.array(KanbanCardSchema).describe('Column cards'),
+  color: z.string().optional().describe('Column color'),
+  limit: z.number().optional().describe('Card limit'),
+  collapsed: z.boolean().optional().describe('Whether column is collapsed'),
+});
+
+/**
+ * Kanban Schema - Kanban board component
+ */
+export const KanbanSchema = BaseSchema.extend({
+  type: z.literal('kanban'),
+  columns: z.array(KanbanColumnSchema).describe('Kanban columns'),
+  draggable: z.boolean().optional().describe('Whether cards are draggable'),
+  onCardMove: z.function().optional().describe('Card move handler'),
+  onCardClick: z.function().optional().describe('Card click handler'),
+  onColumnAdd: z.function().optional().describe('Column add handler'),
+  onCardAdd: z.function().optional().describe('Card add handler'),
+});
+
+/**
+ * Calendar View Mode
+ */
+export const CalendarViewModeSchema = z.enum(['month', 'week', 'day', 'agenda']);
+
+/**
+ * Calendar Event Schema
+ */
+export const CalendarEventSchema = z.object({
+  id: z.string().describe('Event ID'),
+  title: z.string().describe('Event title'),
+  description: z.string().optional().describe('Event description'),
+  start: z.union([z.string(), z.date()]).describe('Event start time'),
+  end: z.union([z.string(), z.date()]).describe('Event end time'),
+  allDay: z.boolean().optional().describe('Whether event is all-day'),
+  color: z.string().optional().describe('Event color'),
+  data: z.any().optional().describe('Custom event data'),
+});
+
+/**
+ * Calendar View Schema - Calendar component
+ */
+export const CalendarViewSchema = BaseSchema.extend({
+  type: z.literal('calendar-view'),
+  events: z.array(CalendarEventSchema).describe('Calendar events'),
+  defaultView: CalendarViewModeSchema.optional().describe('Default view mode'),
+  view: CalendarViewModeSchema.optional().describe('Controlled view mode'),
+  defaultDate: z.union([z.string(), z.date()]).optional().describe('Default date'),
+  date: z.union([z.string(), z.date()]).optional().describe('Controlled date'),
+  views: z.array(CalendarViewModeSchema).optional().describe('Available views'),
+  editable: z.boolean().optional().describe('Whether events are editable'),
+  onEventClick: z.function().optional().describe('Event click handler'),
+  onEventCreate: z.function().optional().describe('Event create handler'),
+  onEventUpdate: z.function().optional().describe('Event update handler'),
+  onDateChange: z.function().optional().describe('Date change handler'),
+  onViewChange: z.function().optional().describe('View change handler'),
+});
+
+/**
+ * Filter Operator Enum
+ */
+export const FilterOperatorSchema = z.enum([
+  'equals',
+  'not_equals',
+  'contains',
+  'not_contains',
+  'starts_with',
+  'ends_with',
+  'greater_than',
+  'greater_than_or_equal',
+  'less_than',
+  'less_than_or_equal',
+  'in',
+  'not_in',
+  'is_null',
+  'is_not_null',
+]);
+
+/**
+ * Filter Condition Schema
+ */
+export const FilterConditionSchema: z.ZodType<any> = z.lazy(() =>
+  z.object({
+    field: z.string().describe('Field name'),
+    operator: FilterOperatorSchema.describe('Filter operator'),
+    value: z.any().optional().describe('Filter value'),
+  })
+);
+
+/**
+ * Filter Group Schema
+ */
+export const FilterGroupSchema: z.ZodType<any> = z.lazy(() =>
+  z.object({
+    operator: z.enum(['and', 'or']).describe('Group operator'),
+    conditions: z.array(z.union([FilterConditionSchema, FilterGroupSchema])).describe('Conditions or sub-groups'),
+  })
+);
+
+/**
+ * Filter Field Schema
+ */
+export const FilterFieldSchema = z.object({
+  name: z.string().describe('Field name'),
+  label: z.string().describe('Field label'),
+  type: z.enum(['string', 'number', 'date', 'boolean', 'select']).describe('Field type'),
+  operators: z.array(FilterOperatorSchema).optional().describe('Available operators'),
+  options: z.array(z.object({
+    label: z.string(),
+    value: z.any(),
+  })).optional().describe('Options for select type'),
+});
+
+/**
+ * Filter Builder Schema - Filter builder component
+ */
+export const FilterBuilderSchema = BaseSchema.extend({
+  type: z.literal('filter-builder'),
+  fields: z.array(FilterFieldSchema).describe('Available filter fields'),
+  defaultValue: z.union([FilterConditionSchema, FilterGroupSchema]).optional().describe('Default filter value'),
+  value: z.union([FilterConditionSchema, FilterGroupSchema]).optional().describe('Controlled filter value'),
+  onChange: z.function().optional().describe('Change handler'),
+  allowGroups: z.boolean().optional().describe('Allow grouped conditions'),
+  maxDepth: z.number().optional().describe('Maximum nesting depth'),
+});
+
+/**
+ * Carousel Item Schema
+ */
+export const CarouselItemSchema = z.object({
+  id: z.string().optional().describe('Item ID'),
+  content: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).describe('Item content'),
+});
+
+/**
+ * Carousel Schema - Carousel component
+ */
+export const CarouselSchema = BaseSchema.extend({
+  type: z.literal('carousel'),
+  items: z.array(CarouselItemSchema).describe('Carousel items'),
+  autoPlay: z.number().optional().describe('Auto-play interval (ms)'),
+  showArrows: z.boolean().optional().describe('Show navigation arrows'),
+  showDots: z.boolean().optional().describe('Show navigation dots'),
+  loop: z.boolean().optional().describe('Enable infinite loop'),
+  itemsPerView: z.number().optional().describe('Items per view'),
+  gap: z.number().optional().describe('Gap between items'),
+  onSlideChange: z.function().optional().describe('Slide change handler'),
+});
+
+/**
+ * Chat Message Schema
+ */
+export const ChatMessageSchema = z.object({
+  id: z.string().describe('Message ID'),
+  role: z.enum(['user', 'assistant', 'system']).describe('Message role'),
+  content: z.string().describe('Message content'),
+  timestamp: z.union([z.string(), z.date()]).optional().describe('Message timestamp'),
+  metadata: z.record(z.string(), z.any()).optional().describe('Custom metadata'),
+});
+
+/**
+ * Chatbot Schema - Chatbot component
+ */
+export const ChatbotSchema = BaseSchema.extend({
+  type: z.literal('chatbot'),
+  messages: z.array(ChatMessageSchema).describe('Chat messages'),
+  placeholder: z.string().optional().describe('Input placeholder'),
+  loading: z.boolean().optional().describe('Whether chat is loading'),
+  onSendMessage: z.function().optional().describe('Send message handler'),
+  showAvatars: z.boolean().optional().describe('Show user avatars'),
+  userAvatar: z.string().optional().describe('User avatar URL'),
+  assistantAvatar: z.string().optional().describe('Assistant avatar URL'),
+  markdown: z.boolean().optional().describe('Enable markdown rendering'),
+  height: z.union([z.string(), z.number()]).optional().describe('Chatbot height'),
+});
+
+/**
+ * Dashboard Widget Layout Schema
+ */
+export const DashboardWidgetLayoutSchema = z.object({
+  x: z.number().describe('Grid x position'),
+  y: z.number().describe('Grid y position'),
+  w: z.number().describe('Grid width'),
+  h: z.number().describe('Grid height'),
+});
+
+/**
+ * Dashboard Widget Schema
+ */
+export const DashboardWidgetSchema = z.object({
+  id: z.string().describe('Widget ID'),
+  title: z.string().optional().describe('Widget Title'),
+  component: SchemaNodeSchema.describe('Widget Component'),
+  layout: DashboardWidgetLayoutSchema.optional().describe('Widget Layout'),
+});
+
+/**
+ * Dashboard Schema - Dashboard component
+ */
+export const DashboardSchema = BaseSchema.extend({
+  type: z.literal('dashboard'),
+  columns: z.number().optional().describe('Number of columns'),
+  gap: z.number().optional().describe('Grid gap'),
+  widgets: z.array(DashboardWidgetSchema).describe('Dashboard widgets'),
+});
+
+/**
+ * Complex Schema Union - All complex component schemas
+ */
+export const ComplexSchema = z.union([
+  KanbanSchema,
+  CalendarViewSchema,
+  FilterBuilderSchema,
+  CarouselSchema,
+  ChatbotSchema,
+  DashboardSchema,
+]);