@eide/uniformgen 0.1.0

package/dist/generators/types/field-types.js

@@ -0,0 +1,651 @@
+/**
+ * Generates the field-types.ts file with:
+ * - Value types for each field type (what the data looks like)
+ * - Field definition types (how to define fields in config)
+ *
+ * @generated by UniformGen
+ */
+export function generateFieldTypesFile() {
+    return `/**
+ * Field Types and Definitions
+ *
+ * This file contains:
+ * - Value types: What the actual data looks like for each field type
+ * - Field definitions: How to define fields in entity model configurations
+ *
+ * @generated by UniformGen - DO NOT EDIT MANUALLY
+ */
+
+// =============================================================================
+// VALUE TYPES - What the data looks like
+// =============================================================================
+
+/**
+ * Rich text content (Lexical JSON format)
+ */
+export type RichtextValue = unknown;
+
+/**
+ * Currency value with amount and code
+ */
+export interface CurrencyValue {
+  amount: number;
+  currency: string; // ISO 4217 code (USD, EUR, etc.)
+}
+
+/**
+ * Image reference with metadata
+ */
+export interface ImageValue {
+  id: string;
+  url: string;
+  alt?: string;
+  width?: number;
+  height?: number;
+}
+
+/**
+ * Video reference with metadata
+ */
+export interface VideoValue {
+  id: string;
+  url: string;
+  thumbnail?: string;
+  duration?: number;
+}
+
+/**
+ * File reference with metadata
+ */
+export interface FileValue {
+  id: string;
+  url: string;
+  name: string;
+  size: number;
+  mimeType: string;
+}
+
+/**
+ * Address structure
+ */
+export interface AddressValue {
+  street?: string;
+  city?: string;
+  state?: string;
+  postalCode?: string;
+  country?: string;
+}
+
+/**
+ * Link value (internal route or external URL)
+ */
+export interface LinkValue {
+  type: 'route' | 'url';
+  route?: string;
+  url?: string;
+  target?: '_self' | '_blank';
+}
+
+/**
+ * Entity reference value
+ */
+export interface ReferenceValue {
+  _type: 'reference';
+  _schema: string;
+  naturalKey: string;
+  _preview?: Record<string, unknown>;
+}
+
+/**
+ * Composite/inline value
+ */
+export interface CompositeValue {
+  _type: 'composite';
+  _schema: string;
+  fields: Record<string, unknown>;
+}
+
+// =============================================================================
+// FILTER OPERATOR TYPES - For typed filtering
+// =============================================================================
+
+/**
+ * Text field filter operators
+ */
+export interface TextFilter {
+  eq?: string;
+  ne?: string;
+  contains?: string;
+  startsWith?: string;
+  endsWith?: string;
+  in?: string[];
+  notIn?: string[];
+  isNull?: boolean;
+}
+
+/**
+ * Number field filter operators
+ */
+export interface NumberFilter {
+  eq?: number;
+  ne?: number;
+  gt?: number;
+  gte?: number;
+  lt?: number;
+  lte?: number;
+  in?: number[];
+  notIn?: number[];
+  isNull?: boolean;
+}
+
+/**
+ * Boolean field filter operators
+ */
+export interface BooleanFilter {
+  eq?: boolean;
+  ne?: boolean;
+  isNull?: boolean;
+}
+
+/**
+ * Date field filter operators
+ * Values should be ISO 8601 date strings
+ */
+export interface DateFilter {
+  eq?: string;
+  ne?: string;
+  gt?: string;
+  gte?: string;
+  lt?: string;
+  lte?: string;
+  isNull?: boolean;
+}
+
+/**
+ * Select field filter operators (with literal type for values)
+ */
+export interface SelectFilter<T extends string = string> {
+  eq?: T;
+  ne?: T;
+  in?: T[];
+  notIn?: T[];
+  isNull?: boolean;
+}
+
+/**
+ * Multiselect field filter operators
+ */
+export interface MultiselectFilter<T extends string = string> {
+  contains?: T;
+  containsAny?: T[];
+  containsAll?: T[];
+  isNull?: boolean;
+}
+
+/**
+ * Reference field filter operators
+ */
+export interface ReferenceFilter {
+  eq?: string;
+  ne?: string;
+  in?: string[];
+  notIn?: string[];
+  isNull?: boolean;
+}
+
+/**
+ * Generic filter input for API
+ */
+export interface FilterInput {
+  field: string;
+  operator: string;
+  value: unknown;
+}
+
+/**
+ * Sort input for queries
+ */
+export interface SortInput {
+  field: string;
+  direction: 'ASC' | 'DESC';
+}
+
+// =============================================================================
+// RESOLVE TYPES - For frontend entity resolution
+// =============================================================================
+
+/**
+ * Variant context for entity resolution
+ * Used to select the appropriate variant based on user context
+ *
+ * Context dimensions are configured in the CMS as "context" entities.
+ * Common contexts include: device, region, market, customerId, etc.
+ */
+export interface VariantContext {
+  /** Locale code for translation resolution (e.g., 'en-US', 'ja-JP') */
+  locale?: string;
+  /** Context dimensions for variant selection (dynamic, configured in CMS) */
+  contexts?: Record<string, unknown>;
+}
+
+/**
+ * Reference resolution options
+ */
+export interface ReferenceResolutionOptions {
+  /** Maximum depth for nested resolution (null = unlimited) */
+  maxDepth?: number;
+  /** Whether to resolve media references */
+  resolveMedia?: boolean;
+  /** Whether to resolve entity references */
+  resolveEntities?: boolean;
+}
+
+/**
+ * Resolved entity record metadata
+ */
+export interface ResolvedRecord {
+  id: string;
+  modelKey: string;
+  naturalKey: string | null;
+  metadata?: Record<string, unknown>;
+}
+
+/**
+ * Resolved variant info
+ */
+export interface ResolvedVariant {
+  id: string;
+  variantKey: string;
+}
+
+/**
+ * Zone layout mode
+ */
+export type ZoneLayoutMode = 'GRID' | 'LIST';
+
+/**
+ * Field source for debugging
+ */
+export type FieldSource = 'ENTITY' | 'TEMPLATE';
+
+/**
+ * Responsive visibility settings for zones
+ */
+export interface ZoneResponsiveSettings {
+  mobile?: boolean;
+  tablet?: boolean;
+  desktop?: boolean;
+}
+
+/**
+ * Grid position within a zone at a specific breakpoint
+ */
+export interface GridPosition {
+  x: number;
+  y: number;
+  w: number;
+  h: number;
+  minW?: number;
+  maxW?: number;
+  minH?: number;
+  maxH?: number;
+}
+
+/**
+ * Field layout positions per breakpoint
+ */
+export interface FieldLayout {
+  lg?: GridPosition;
+  md?: GridPosition;
+  sm?: GridPosition;
+  xs?: GridPosition;
+}
+
+/**
+ * Resolved field with value and layout attached
+ */
+export interface ResolvedField {
+  /** Field key */
+  key: string;
+  /** Field type - primitive type OR modelKey for inline entities OR 'zone' */
+  type: string;
+  /** Human-readable label */
+  label?: string;
+  /** Whether field is required */
+  required?: boolean;
+  /** Fully resolved value (can be ZoneValue when type is 'zone') */
+  value: unknown;
+  /** Grid layout position (used when layoutMode is GRID) */
+  layout?: FieldLayout;
+  /** Order in list (used when layoutMode is LIST, derived from zoneOrder) */
+  order?: number;
+  /** Where this field originated from (for debugging) */
+  source?: FieldSource;
+}
+
+/**
+ * Zone value structure - used when a field has type: 'zone'
+ * Contains entity fields placed in this zone
+ */
+export interface ZoneValue {
+  /** Zone identifier */
+  key: string;
+  /** Human-readable label */
+  label: string;
+  /** Layout mode for fields within this zone */
+  layoutMode: ZoneLayoutMode;
+  /** Responsive visibility settings */
+  responsive?: ZoneResponsiveSettings;
+  /** Entity fields placed in this zone */
+  fields: ResolvedField[];
+}
+
+/**
+ * Grid configuration from design system
+ * Used by @eide/foir-renderer for layout positioning
+ */
+export interface GridConfig {
+  /** Breakpoint pixel values (e.g., { lg: 1200, md: 996, sm: 768, xs: 480 }) */
+  breakpoints: Record<string, number>;
+  /** Column counts per breakpoint (e.g., { lg: 12, md: 10, sm: 6, xs: 4 }) */
+  cols: Record<string, number>;
+  /** Height of each grid row in pixels */
+  rowHeight: number;
+  /** Padding around the container [x, y] */
+  containerPadding: [number, number];
+  /** Margin between grid items [x, y] */
+  margin: [number, number];
+}
+
+/**
+ * Simplified template reference (no layout embedded)
+ * Layout information is now in the fields array
+ */
+export interface ResolvedTemplateRef {
+  id: string;
+  modelKey: string;
+  naturalKey: string | null;
+}
+
+/**
+ * All renderable content (new unified structure)
+ *
+ * - Templates are just references (no layout embedded)
+ * - Zones become regular fields with type: 'zone'
+ * - Top-level fields array contains all renderable content
+ */
+export interface ResolvedContent {
+  /** Template reference (null if no template assigned) */
+  template: ResolvedTemplateRef | null;
+  /** Layout mode for the content (GRID if fields have positions, LIST otherwise) */
+  layoutMode: ZoneLayoutMode;
+  /** All renderable fields including zones (ordered for rendering) */
+  fields: ResolvedField[];
+  /** Content fields not placed in any zone/layout */
+  extraContent?: ResolvedField[];
+}
+
+/**
+ * Resolution context output
+ */
+export interface ResolutionContext {
+  locale: string;
+  contexts: Record<string, unknown>;
+}
+
+/**
+ * Breadcrumb node types
+ */
+export type BreadcrumbType = 'home' | 'context' | 'static' | 'entity';
+
+/**
+ * Breadcrumb for navigation
+ */
+export interface Breadcrumb {
+  /** Display label */
+  label: string;
+  /** Route URL */
+  url: string;
+  /** Node type for styling hints */
+  type?: BreadcrumbType;
+  /** Is this the current/active page? */
+  isCurrent?: boolean;
+}
+
+/**
+ * Base resolved entity content (new format)
+ */
+export interface ResolvedEntityContentBase {
+  record: ResolvedRecord;
+  variant: ResolvedVariant;
+  /** Renderable content (template with zones + extra content) */
+  content: ResolvedContent;
+  resolvedWith: ResolutionContext;
+  breadcrumbs?: Breadcrumb[];
+  /** Grid configuration from design system for layout rendering */
+  gridConfig?: GridConfig;
+}
+
+// =============================================================================
+// FIELD DEFINITION TYPES - How to define fields in config
+// =============================================================================
+
+/**
+ * Base field definition properties shared by all field types
+ */
+export interface BaseFieldDef {
+  /** Unique field identifier (camelCase) */
+  key: string;
+  /** Display label */
+  label: string;
+  /** Whether field is required */
+  required?: boolean;
+  /** Help text shown to users */
+  helpText?: string;
+  /** Default value */
+  defaultValue?: unknown;
+}
+
+/**
+ * Text field definition
+ */
+export interface TextFieldDef extends BaseFieldDef {
+  type: 'text';
+  maxLength?: number;
+  minLength?: number;
+  pattern?: string;
+  ui?: {
+    widget?: 'text-input' | 'textarea' | 'code-editor';
+    placeholder?: string;
+    rows?: number;
+  };
+}
+
+/**
+ * Number field definition
+ */
+export interface NumberFieldDef extends BaseFieldDef {
+  type: 'number';
+  min?: number;
+  max?: number;
+  step?: number;
+  ui?: {
+    widget?: 'number-input' | 'slider';
+  };
+}
+
+/**
+ * Boolean field definition
+ */
+export interface BooleanFieldDef extends BaseFieldDef {
+  type: 'boolean';
+  ui?: {
+    widget?: 'checkbox' | 'switch';
+  };
+}
+
+/**
+ * Date field definition
+ */
+export interface DateFieldDef extends BaseFieldDef {
+  type: 'date';
+  ui?: {
+    widget?: 'date-picker' | 'datetime-picker';
+    format?: 'date-only' | 'datetime';
+  };
+}
+
+/**
+ * Rich text field definition
+ */
+export interface RichtextFieldDef extends BaseFieldDef {
+  type: 'richtext';
+}
+
+/**
+ * Image field definition
+ */
+export interface ImageFieldDef extends BaseFieldDef {
+  type: 'image';
+  allowedTypes?: string[];
+  maxSize?: number;
+}
+
+/**
+ * Video field definition
+ */
+export interface VideoFieldDef extends BaseFieldDef {
+  type: 'video';
+  allowedTypes?: string[];
+  maxSize?: number;
+}
+
+/**
+ * File field definition
+ */
+export interface FileFieldDef extends BaseFieldDef {
+  type: 'file';
+  allowedTypes?: string[];
+  maxSize?: number;
+}
+
+/**
+ * Select field definition (single choice)
+ */
+export interface SelectFieldDef extends BaseFieldDef {
+  type: 'select';
+  options: Array<{ label: string; value: string }>;
+}
+
+/**
+ * Multiselect field definition (multiple choices)
+ */
+export interface MultiselectFieldDef extends BaseFieldDef {
+  type: 'multiselect';
+  options: Array<{ label: string; value: string }>;
+}
+
+/**
+ * Entity reference field definition
+ */
+export interface EntityReferenceFieldDef extends BaseFieldDef {
+  type: 'entity-reference';
+  /** Entity model keys that can be referenced */
+  referenceTypes: string[];
+  /** Allow multiple references */
+  multiple?: boolean;
+}
+
+/**
+ * List field definition (array of items)
+ */
+export interface ListFieldDef extends BaseFieldDef {
+  type: 'list';
+  /** Type of items in the list */
+  itemType: string;
+  minItems?: number;
+  maxItems?: number;
+}
+
+/**
+ * Link field definition
+ */
+export interface LinkFieldDef extends BaseFieldDef {
+  type: 'link';
+}
+
+/**
+ * JSON field definition (unstructured data)
+ */
+export interface JsonFieldDef extends BaseFieldDef {
+  type: 'json';
+}
+
+/**
+ * Design system style field definition
+ */
+export interface DesignSystemStyleFieldDef extends BaseFieldDef {
+  type: 'design-system-style';
+}
+
+/**
+ * Inline schema field definition (references another entity model)
+ * The type value is the key of an entity model with modes.inline = true
+ */
+export interface InlineSchemaFieldDef extends BaseFieldDef {
+  /** Entity model key (e.g., 'hero-banner', 'product-card') */
+  type: string;
+}
+
+/**
+ * Union of all strongly-typed field definitions
+ */
+export type FieldDef =
+  | TextFieldDef
+  | NumberFieldDef
+  | BooleanFieldDef
+  | DateFieldDef
+  | RichtextFieldDef
+  | ImageFieldDef
+  | VideoFieldDef
+  | FileFieldDef
+  | SelectFieldDef
+  | MultiselectFieldDef
+  | EntityReferenceFieldDef
+  | ListFieldDef
+  | LinkFieldDef
+  | JsonFieldDef
+  | DesignSystemStyleFieldDef
+  | InlineSchemaFieldDef;
+
+/**
+ * Known primitive field type keys
+ */
+export const PRIMITIVE_FIELD_TYPES = [
+  'text',
+  'number',
+  'boolean',
+  'date',
+  'richtext',
+  'image',
+  'video',
+  'file',
+  'select',
+  'multiselect',
+  'entity-reference',
+  'list',
+  'link',
+  'json',
+  'design-system-style',
+] as const;
+
+export type PrimitiveFieldType = typeof PRIMITIVE_FIELD_TYPES[number];
+
+/**
+ * Check if a type is a primitive field type
+ */
+export function isPrimitiveFieldType(type: string): type is PrimitiveFieldType {
+  return PRIMITIVE_FIELD_TYPES.includes(type as PrimitiveFieldType);
+}
+`;
+}

package/dist/generators/types/hooks.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Generates the hooks.ts file with lifecycle hook type definitions
+ *
+ * @generated by UniformGen
+ */
+export declare function generateHooksFile(): string;
+//# sourceMappingURL=hooks.d.ts.map

package/dist/generators/types/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../src/generators/types/hooks.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,wBAAgB,iBAAiB,IAAI,MAAM,CA8H1C"}