@fluid-app/rep-core 0.1.0

package/dist/registries/index.d.ts

@@ -0,0 +1,303 @@
+import { StrictOmit, AlignOptions, ColorOptions, SectionLayoutType, BorderRadiusOptions, PaddingOptions, ButtonSizeOptions, FontSizeOptions, GapOptions } from '../types/index.js';
+import { b as WidgetType, a as WidgetSchema } from '../shareable-item-DPmNZkE1.js';
+import '../theme-DrMUYZTO.js';
+import 'react';
+
+/**
+ * Tab configuration for organizing properties
+ */
+interface TabConfig {
+    /** Unique identifier for the tab */
+    id: string;
+    /** Display label for the tab */
+    label: string;
+}
+/**
+ * Property field type constant - single source of truth for field types.
+ * Use PROPERTY_FIELD_TYPES.text instead of "text" for type-safe comparisons.
+ */
+declare const PROPERTY_FIELD_TYPES: {
+    readonly text: "text";
+    readonly textarea: "textarea";
+    readonly number: "number";
+    readonly boolean: "boolean";
+    readonly select: "select";
+    readonly color: "color";
+    readonly range: "range";
+    readonly dataSource: "dataSource";
+    readonly resource: "resource";
+    readonly alignment: "alignment";
+    readonly slider: "slider";
+    readonly colorPicker: "colorPicker";
+    readonly sectionHeader: "sectionHeader";
+    readonly separator: "separator";
+    readonly buttonGroup: "buttonGroup";
+    readonly colorSelect: "colorSelect";
+    readonly sectionLayoutSelect: "sectionLayoutSelect";
+    readonly background: "background";
+    readonly contentPosition: "contentPosition";
+};
+/**
+ * Union type of all property field types, derived from PROPERTY_FIELD_TYPES constant.
+ * @see deriving-typeof-for-object-keys pattern
+ */
+type PropertyFieldType = (typeof PROPERTY_FIELD_TYPES)[keyof typeof PROPERTY_FIELD_TYPES];
+/**
+ * Runtime validation for property field types.
+ * @param value - The value to check
+ * @returns true if value is a valid PropertyFieldType
+ */
+declare function isPropertyFieldType(value: string): value is PropertyFieldType;
+/**
+ * Base schema for a property field
+ */
+interface PropertyFieldSchema {
+    /** Property key in the widget props */
+    key: string;
+    /** Display label for the field */
+    label: string;
+    /** Field type determines the input control */
+    type: PropertyFieldType;
+    /** Optional description/help text */
+    description?: string;
+    /** Optional default value */
+    defaultValue?: unknown;
+    /** Optional tab ID (must match a TabConfig id if widget has tabsConfig) */
+    tab?: string;
+    /** Optional group for organizing fields within a tab */
+    group?: string;
+    /**
+     * @deprecated Use requiresKeyValue instead
+     */
+    requiresKeyToBeTrue?: string;
+    /** Optional requires a specific key to have a specific value */
+    requiresKeyValue?: {
+        key: string;
+        value: unknown;
+    };
+}
+/**
+ * Text field schema
+ */
+interface TextFieldSchema extends PropertyFieldSchema {
+    type: "text";
+    placeholder?: string;
+    maxLength?: number;
+}
+/**
+ * Textarea field schema
+ */
+interface TextareaFieldSchema extends PropertyFieldSchema {
+    type: "textarea";
+    placeholder?: string;
+    rows?: number;
+    maxLength?: number;
+}
+/**
+ * Number field schema
+ */
+interface NumberFieldSchema extends PropertyFieldSchema {
+    type: "number";
+    min?: number;
+    max?: number;
+    step?: number;
+}
+/**
+ * Boolean field schema
+ */
+interface BooleanFieldSchema extends PropertyFieldSchema {
+    type: "boolean";
+}
+/**
+ * Select field schema with type-safe option values.
+ * Uses StrictOmit to ensure "defaultValue" key exists on PropertyFieldSchema.
+ */
+interface SelectFieldSchema<T extends string | number = string | number> extends StrictOmit<PropertyFieldSchema, "defaultValue"> {
+    type: "select";
+    options: Array<{
+        label: string;
+        value: T;
+    }>;
+    defaultValue?: T;
+}
+/**
+ * Color field schema
+ */
+interface ColorFieldSchema extends PropertyFieldSchema {
+    type: "color";
+}
+/**
+ * Range slider field schema
+ */
+interface RangeFieldSchema extends PropertyFieldSchema {
+    type: "range";
+    min: number;
+    max: number;
+    step?: number;
+}
+/**
+ * Data source field schema for configuring widget data sources
+ */
+interface DataSourceFieldSchema extends PropertyFieldSchema {
+    type: "dataSource";
+}
+/**
+ * Resource field schema for selecting a single resource from the selection modal
+ */
+interface ResourceFieldSchema extends PropertyFieldSchema {
+    type: "resource";
+    /** Optional filter to specific shareable types */
+    allowedTypes?: string[];
+}
+/**
+ * Alignment field schema
+ */
+interface AlignmentFieldSchema extends PropertyFieldSchema {
+    type: "alignment";
+    options: {
+        verticalEnabled: boolean;
+        horizontalEnabled: boolean;
+    };
+    defaultValue?: AlignOptions;
+}
+/**
+ * Slider field schema with optional unit suffix (e.g., "rem", "px")
+ */
+interface SliderFieldSchema extends PropertyFieldSchema {
+    type: "slider";
+    min: number;
+    max: number;
+    step?: number;
+    unit?: string;
+}
+/**
+ * Color picker field schema with optional swatches
+ */
+interface ColorPickerFieldSchema extends PropertyFieldSchema {
+    type: "colorPicker";
+    swatches?: string[];
+}
+/**
+ * Section header field schema for visual grouping
+ */
+interface SectionHeaderFieldSchema extends PropertyFieldSchema {
+    type: "sectionHeader";
+    subtitle?: string;
+}
+/**
+ * Separator field schema for visual separation
+ */
+interface SeparatorFieldSchema extends PropertyFieldSchema {
+    type: "separator";
+}
+/**
+ * Button group field schema.
+ * Uses StrictOmit to ensure "defaultValue" key exists on PropertyFieldSchema.
+ */
+interface ButtonGroupFieldSchema<T extends string | number = string | number> extends StrictOmit<PropertyFieldSchema, "defaultValue"> {
+    type: "buttonGroup";
+    options: Array<{
+        label: string;
+        value: T;
+    }>;
+    defaultValue?: T;
+}
+/**
+ * Color select field schema
+ */
+interface ColorSelectFieldSchema extends PropertyFieldSchema {
+    type: "colorSelect";
+    defaultValue?: ColorOptions;
+}
+/**
+ * Section layout select field schema for visual masonry layout selector
+ */
+interface SectionLayoutSelectFieldSchema extends PropertyFieldSchema {
+    type: "sectionLayoutSelect";
+    defaultValue?: SectionLayoutType;
+}
+/**
+ * Background field combines resource selection and color properties.
+ * Uses StrictOmit to exclude conflicting "type" discriminant from parents.
+ */
+interface BackgroundFieldSchema extends StrictOmit<ResourceFieldSchema, "type">, StrictOmit<ColorFieldSchema, "type"> {
+    type: "background";
+}
+/**
+ * Content position field schema for 3x3 grid position picker
+ */
+interface ContentPositionFieldSchema extends PropertyFieldSchema {
+    type: "contentPosition";
+    defaultValue?: string;
+}
+/**
+ * Union of all field schema types
+ */
+type PropertyField = TextFieldSchema | TextareaFieldSchema | NumberFieldSchema | BooleanFieldSchema | SelectFieldSchema<string | number> | ColorFieldSchema | RangeFieldSchema | DataSourceFieldSchema | ResourceFieldSchema | AlignmentFieldSchema | SliderFieldSchema | ColorPickerFieldSchema | SectionHeaderFieldSchema | SeparatorFieldSchema | ButtonGroupFieldSchema<string | number> | ColorSelectFieldSchema | SectionLayoutSelectFieldSchema | BackgroundFieldSchema | ContentPositionFieldSchema;
+/**
+ * Schema for per-item configuration in custom data sources.
+ * Widgets can define this to allow users to configure widget-specific
+ * settings for each selected item (e.g., title, description, button).
+ */
+interface ItemConfigSchema {
+    /** Fields available for per-item configuration */
+    fields: PropertyField[];
+    /** Optional description shown at top of item config panel */
+    description?: string;
+}
+/**
+ * Schema for a widget's editable properties
+ */
+interface WidgetPropertySchema {
+    /** Widget type this schema applies to */
+    widgetType: WidgetType;
+    /** Display name for the widget */
+    displayName: string;
+    /** Optional tab configuration - if present, tabs are enabled */
+    tabsConfig?: TabConfig[];
+    /** Editable property fields */
+    fields: PropertyField[];
+    /** Optional custom validator function */
+    validate?: (props: Record<string, unknown>) => string | null;
+    /** Props that can be populated from data sources */
+    dataSourceTargetProps?: string[];
+    /** Optional schema for per-item configurations in custom data sources */
+    itemConfigSchema?: ItemConfigSchema;
+}
+/**
+ * Registry mapping widget types to their property schemas
+ */
+type PropertySchemaRegistry = Record<WidgetType, WidgetPropertySchema>;
+/**
+ * Group property fields by their group property
+ */
+declare function groupPropertyFields(fields: readonly PropertyField[]): Record<string, PropertyField[]>;
+/**
+ * Extract current values from widget props based on property fields
+ */
+declare function extractPropertyValues(widget: Readonly<WidgetSchema>, fields: readonly PropertyField[]): Record<string, unknown>;
+/**
+ * Apply property values to widget props
+ */
+declare function applyPropertyValues(widget: Readonly<WidgetSchema>, values: Readonly<Record<string, unknown>>): WidgetSchema;
+
+declare const getColorField: (props: Readonly<Omit<ColorSelectFieldSchema, "type">>) => ColorSelectFieldSchema;
+declare const getBorderRadiusField: (props: Readonly<Omit<ButtonGroupFieldSchema<BorderRadiusOptions>, "options" | "type">>) => ButtonGroupFieldSchema<BorderRadiusOptions>;
+declare const getPaddingField: (props: Readonly<Omit<ButtonGroupFieldSchema<PaddingOptions>, "options" | "type">>) => ButtonGroupFieldSchema<PaddingOptions>;
+declare const getButtonSizeField: (props: Readonly<Omit<ButtonGroupFieldSchema<ButtonSizeOptions>, "options" | "type">>) => ButtonGroupFieldSchema<ButtonSizeOptions>;
+declare const getFontSizeField: (props: Readonly<Omit<SelectFieldSchema<FontSizeOptions>, "options" | "type">>) => SelectFieldSchema<FontSizeOptions>;
+declare const getGapField: (props: Readonly<Omit<ButtonGroupFieldSchema<GapOptions>, "options" | "type">>) => ButtonGroupFieldSchema<GapOptions>;
+/**
+ * Gap value mapping - use `as const satisfies` for compile-time validation
+ * with literal type preservation.
+ */
+declare const gapValues: {
+    readonly none: 0;
+    readonly xs: 1;
+    readonly sm: 2;
+    readonly md: 4;
+    readonly lg: 6;
+    readonly xl: 8;
+};
+
+export { type AlignmentFieldSchema, type BackgroundFieldSchema, type BooleanFieldSchema, type ButtonGroupFieldSchema, type ColorFieldSchema, type ColorPickerFieldSchema, type ColorSelectFieldSchema, type ContentPositionFieldSchema, type DataSourceFieldSchema, type ItemConfigSchema, type NumberFieldSchema, PROPERTY_FIELD_TYPES, type PropertyField, type PropertyFieldSchema, type PropertyFieldType, type PropertySchemaRegistry, type RangeFieldSchema, type ResourceFieldSchema, type SectionHeaderFieldSchema, type SectionLayoutSelectFieldSchema, type SelectFieldSchema, type SeparatorFieldSchema, type SliderFieldSchema, type TabConfig, type TextFieldSchema, type TextareaFieldSchema, type WidgetPropertySchema, applyPropertyValues, extractPropertyValues, gapValues, getBorderRadiusField, getButtonSizeField, getColorField, getFontSizeField, getGapField, getPaddingField, groupPropertyFields, isPropertyFieldType };

package/dist/registries/index.js

@@ -0,0 +1,143 @@
+// src/registries/property-schema-types.ts
+var PROPERTY_FIELD_TYPES = {
+  text: "text",
+  textarea: "textarea",
+  number: "number",
+  boolean: "boolean",
+  select: "select",
+  color: "color",
+  range: "range",
+  dataSource: "dataSource",
+  resource: "resource",
+  alignment: "alignment",
+  slider: "slider",
+  colorPicker: "colorPicker",
+  sectionHeader: "sectionHeader",
+  separator: "separator",
+  buttonGroup: "buttonGroup",
+  colorSelect: "colorSelect",
+  sectionLayoutSelect: "sectionLayoutSelect",
+  background: "background",
+  contentPosition: "contentPosition"
+};
+function isPropertyFieldType(value) {
+  return Object.values(PROPERTY_FIELD_TYPES).includes(
+    value
+  );
+}
+function groupPropertyFields(fields) {
+  const grouped = {};
+  fields.forEach((field) => {
+    const group = field.group || "General";
+    if (!grouped[group]) {
+      grouped[group] = [];
+    }
+    grouped[group].push(field);
+  });
+  return grouped;
+}
+function extractPropertyValues(widget, fields) {
+  const values = {};
+  fields.forEach((field) => {
+    const value = widget.props[field.key];
+    values[field.key] = value !== void 0 ? value : field.defaultValue;
+  });
+  return values;
+}
+function applyPropertyValues(widget, values) {
+  return {
+    ...widget,
+    props: {
+      ...widget.props,
+      ...values
+    }
+  };
+}
+
+// src/registries/field-helpers.ts
+var getColorField = (props) => {
+  return {
+    ...props,
+    type: "colorSelect"
+  };
+};
+var getBorderRadiusField = (props) => {
+  return {
+    ...props,
+    type: "buttonGroup",
+    options: [
+      { label: "None", value: "none" },
+      { label: "SM", value: "sm" },
+      { label: "MD", value: "md" },
+      { label: "LG", value: "lg" },
+      { label: "XL", value: "xl" },
+      { label: "FULL", value: "full" }
+    ]
+  };
+};
+var getPaddingField = (props) => {
+  return {
+    ...props,
+    type: "buttonGroup",
+    options: [
+      { label: "None", value: 0 },
+      { label: "SM", value: 2 },
+      { label: "MD", value: 4 },
+      { label: "LG", value: 6 },
+      { label: "XL", value: 8 },
+      { label: "FULL", value: 10 }
+    ]
+  };
+};
+var getButtonSizeField = (props) => {
+  return {
+    ...props,
+    type: "buttonGroup",
+    options: [
+      { label: "SM", value: "sm" },
+      { label: "MD", value: "default" },
+      { label: "LG", value: "lg" },
+      { label: "XL", value: "xl" }
+    ]
+  };
+};
+var getFontSizeField = (props) => {
+  return {
+    ...props,
+    type: "select",
+    options: [
+      { label: "Giant", value: "2xl" },
+      { label: "Extra Large", value: "xl" },
+      { label: "Large", value: "lg" },
+      { label: "Regular", value: "md" },
+      { label: "Small", value: "sm" },
+      { label: "Extra Small", value: "xs" }
+    ]
+  };
+};
+var getGapField = (props) => {
+  return {
+    ...props,
+    type: "buttonGroup",
+    options: [
+      { label: "None", value: "none" },
+      { label: "XS", value: "xs" },
+      { label: "SM", value: "sm" },
+      { label: "MD", value: "md" },
+      { label: "LG", value: "lg" },
+      { label: "XL", value: "xl" }
+    ]
+  };
+};
+var gapValues = {
+  none: 0,
+  xs: 1,
+  sm: 2,
+  md: 4,
+  lg: 6,
+  xl: 8
+};
+
+export { PROPERTY_FIELD_TYPES, applyPropertyValues, extractPropertyValues, gapValues, getBorderRadiusField, getButtonSizeField, getColorField, getFontSizeField, getGapField, getPaddingField, groupPropertyFields, isPropertyFieldType };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/registries/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/registries/property-schema-types.ts","../../src/registries/field-helpers.ts"],"names":[],"mappings":";AA2BO,IAAM,oBAAA,GAAuB;AAAA,EAClC,IAAA,EAAM,MAAA;AAAA,EACN,QAAA,EAAU,UAAA;AAAA,EACV,MAAA,EAAQ,QAAA;AAAA,EACR,OAAA,EAAS,SAAA;AAAA,EACT,MAAA,EAAQ,QAAA;AAAA,EACR,KAAA,EAAO,OAAA;AAAA,EACP,KAAA,EAAO,OAAA;AAAA,EACP,UAAA,EAAY,YAAA;AAAA,EACZ,QAAA,EAAU,UAAA;AAAA,EACV,SAAA,EAAW,WAAA;AAAA,EACX,MAAA,EAAQ,QAAA;AAAA,EACR,WAAA,EAAa,aAAA;AAAA,EACb,aAAA,EAAe,eAAA;AAAA,EACf,SAAA,EAAW,WAAA;AAAA,EACX,WAAA,EAAa,aAAA;AAAA,EACb,WAAA,EAAa,aAAA;AAAA,EACb,mBAAA,EAAqB,qBAAA;AAAA,EACrB,UAAA,EAAY,YAAA;AAAA,EACZ,eAAA,EAAiB;AACnB;AAcO,SAAS,oBAAoB,KAAA,EAA2C;AAC7E,EAAA,OAAO,MAAA,CAAO,MAAA,CAAO,oBAAoB,CAAA,CAAE,QAAA;AAAA,IACzC;AAAA,GACF;AACF;AAwQO,SAAS,oBACd,MAAA,EACiC;AACjC,EAAA,MAAM,UAA2C,EAAC;AAElD,EAAA,MAAA,CAAO,OAAA,CAAQ,CAAC,KAAA,KAAU;AACxB,IAAA,MAAM,KAAA,GAAQ,MAAM,KAAA,IAAS,SAAA;AAC7B,IAAA,IAAI,CAAC,OAAA,CAAQ,KAAK,CAAA,EAAG;AACnB,MAAA,OAAA,CAAQ,KAAK,IAAI,EAAC;AAAA,IACpB;AACA,IAAA,OAAA,CAAQ,KAAK,CAAA,CAAE,IAAA,CAAK,KAAK,CAAA;AAAA,EAC3B,CAAC,CAAA;AAED,EAAA,OAAO,OAAA;AACT;AAKO,SAAS,qBAAA,CACd,QACA,MAAA,EACyB;AACzB,EAAA,MAAM,SAAkC,EAAC;AAEzC,EAAA,MAAA,CAAO,OAAA,CAAQ,CAAC,KAAA,KAAU;AACxB,IAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,KAAA,CAAM,KAAA,CAAM,GAAG,CAAA;AACpC,IAAA,MAAA,CAAO,MAAM,GAAG,CAAA,GAAI,KAAA,KAAU,MAAA,GAAY,QAAQ,KAAA,CAAM,YAAA;AAAA,EAC1D,CAAC,CAAA;AAED,EAAA,OAAO,MAAA;AACT;AAKO,SAAS,mBAAA,CACd,QACA,MAAA,EACc;AACd,EAAA,OAAO;AAAA,IACL,GAAG,MAAA;AAAA,IACH,KAAA,EAAO;AAAA,MACL,GAAG,MAAA,CAAO,KAAA;AAAA,MACV,GAAG;AAAA;AACL,GACF;AACF;;;AC3WO,IAAM,aAAA,GAAgB,CAC3B,KAAA,KAC2B;AAC3B,EAAA,OAAO;AAAA,IACL,GAAG,KAAA;AAAA,IACH,IAAA,EAAM;AAAA,GACR;AACF;AAEO,IAAM,oBAAA,GAAuB,CAClC,KAAA,KAGgD;AAChD,EAAA,OAAO;AAAA,IACL,GAAG,KAAA;AAAA,IACH,IAAA,EAAM,aAAA;AAAA,IACN,OAAA,EAAS;AAAA,MACP,EAAE,KAAA,EAAO,MAAA,EAAQ,KAAA,EAAO,MAAA,EAAO;AAAA,MAC/B,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,IAAA,EAAK;AAAA,MAC3B,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,IAAA,EAAK;AAAA,MAC3B,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,IAAA,EAAK;AAAA,MAC3B,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,IAAA,EAAK;AAAA,MAC3B,EAAE,KAAA,EAAO,MAAA,EAAQ,KAAA,EAAO,MAAA;AAAO;AACjC,GACF;AACF;AAEO,IAAM,eAAA,GAAkB,CAC7B,KAAA,KAG2C;AAC3C,EAAA,OAAO;AAAA,IACL,GAAG,KAAA;AAAA,IACH,IAAA,EAAM,aAAA;AAAA,IACN,OAAA,EAAS;AAAA,MACP,EAAE,KAAA,EAAO,MAAA,EAAQ,KAAA,EAAO,CAAA,EAAE;AAAA,MAC1B,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,CAAA,EAAE;AAAA,MACxB,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,CAAA,EAAE;AAAA,MACxB,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,CAAA,EAAE;AAAA,MACxB,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,CAAA,EAAE;AAAA,MACxB,EAAE,KAAA,EAAO,MAAA,EAAQ,KAAA,EAAO,EAAA;AAAG;AAC7B,GACF;AACF;AAEO,IAAM,kBAAA,GAAqB,CAChC,KAAA,KAG8C;AAC9C,EAAA,OAAO;AAAA,IACL,GAAG,KAAA;AAAA,IACH,IAAA,EAAM,aAAA;AAAA,IACN,OAAA,EAAS;AAAA,MACP,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,IAAA,EAAK;AAAA,MAC3B,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,SAAA,EAAU;AAAA,MAChC,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,IAAA,EAAK;AAAA,MAC3B,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,IAAA;AAAK;AAC7B,GACF;AACF;AAEO,IAAM,gBAAA,GAAmB,CAC9B,KAAA,KACuC;AACvC,EAAA,OAAO;AAAA,IACL,GAAG,KAAA;AAAA,IACH,IAAA,EAAM,QAAA;AAAA,IACN,OAAA,EAAS;AAAA,MACP,EAAE,KAAA,EAAO,OAAA,EAAS,KAAA,EAAO,KAAA,EAAM;AAAA,MAC/B,EAAE,KAAA,EAAO,aAAA,EAAe,KAAA,EAAO,IAAA,EAAK;AAAA,MACpC,EAAE,KAAA,EAAO,OAAA,EAAS,KAAA,EAAO,IAAA,EAAK;AAAA,MAC9B,EAAE,KAAA,EAAO,SAAA,EAAW,KAAA,EAAO,IAAA,EAAK;AAAA,MAChC,EAAE,KAAA,EAAO,OAAA,EAAS,KAAA,EAAO,IAAA,EAAK;AAAA,MAC9B,EAAE,KAAA,EAAO,aAAA,EAAe,KAAA,EAAO,IAAA;AAAK;AACtC,GACF;AACF;AAEO,IAAM,WAAA,GAAc,CACzB,KAAA,KACuC;AACvC,EAAA,OAAO;AAAA,IACL,GAAG,KAAA;AAAA,IACH,IAAA,EAAM,aAAA;AAAA,IACN,OAAA,EAAS;AAAA,MACP,EAAE,KAAA,EAAO,MAAA,EAAQ,KAAA,EAAO,MAAA,EAAO;AAAA,MAC/B,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,IAAA,EAAK;AAAA,MAC3B,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,IAAA,EAAK;AAAA,MAC3B,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,IAAA,EAAK;AAAA,MAC3B,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,IAAA,EAAK;AAAA,MAC3B,EAAE,KAAA,EAAO,IAAA,EAAM,KAAA,EAAO,IAAA;AAAK;AAC7B,GACF;AACF;AAMO,IAAM,SAAA,GAAY;AAAA,EACvB,IAAA,EAAM,CAAA;AAAA,EACN,EAAA,EAAI,CAAA;AAAA,EACJ,EAAA,EAAI,CAAA;AAAA,EACJ,EAAA,EAAI,CAAA;AAAA,EACJ,EAAA,EAAI,CAAA;AAAA,EACJ,EAAA,EAAI;AACN","file":"index.js","sourcesContent":["import type {\n  WidgetType,\n  WidgetSchema,\n  AlignOptions,\n  ColorOptions,\n  SectionLayoutType,\n  StrictOmit,\n} from \"../types\";\n\n/**\n * Tab configuration for organizing properties\n */\nexport interface TabConfig {\n  /** Unique identifier for the tab */\n  id: string;\n  /** Display label for the tab */\n  label: string;\n}\n\n// ============================================================================\n// Property Field Types - Derive from constant for single source of truth\n// ============================================================================\n\n/**\n * Property field type constant - single source of truth for field types.\n * Use PROPERTY_FIELD_TYPES.text instead of \"text\" for type-safe comparisons.\n */\nexport const PROPERTY_FIELD_TYPES = {\n  text: \"text\",\n  textarea: \"textarea\",\n  number: \"number\",\n  boolean: \"boolean\",\n  select: \"select\",\n  color: \"color\",\n  range: \"range\",\n  dataSource: \"dataSource\",\n  resource: \"resource\",\n  alignment: \"alignment\",\n  slider: \"slider\",\n  colorPicker: \"colorPicker\",\n  sectionHeader: \"sectionHeader\",\n  separator: \"separator\",\n  buttonGroup: \"buttonGroup\",\n  colorSelect: \"colorSelect\",\n  sectionLayoutSelect: \"sectionLayoutSelect\",\n  background: \"background\",\n  contentPosition: \"contentPosition\",\n} as const;\n\n/**\n * Union type of all property field types, derived from PROPERTY_FIELD_TYPES constant.\n * @see deriving-typeof-for-object-keys pattern\n */\nexport type PropertyFieldType =\n  (typeof PROPERTY_FIELD_TYPES)[keyof typeof PROPERTY_FIELD_TYPES];\n\n/**\n * Runtime validation for property field types.\n * @param value - The value to check\n * @returns true if value is a valid PropertyFieldType\n */\nexport function isPropertyFieldType(value: string): value is PropertyFieldType {\n  return Object.values(PROPERTY_FIELD_TYPES).includes(\n    value as PropertyFieldType,\n  );\n}\n\n/**\n * Base schema for a property field\n */\nexport interface PropertyFieldSchema {\n  /** Property key in the widget props */\n  key: string;\n  /** Display label for the field */\n  label: string;\n  /** Field type determines the input control */\n  type: PropertyFieldType;\n  /** Optional description/help text */\n  description?: string;\n  /** Optional default value */\n  defaultValue?: unknown;\n  /** Optional tab ID (must match a TabConfig id if widget has tabsConfig) */\n  tab?: string;\n  /** Optional group for organizing fields within a tab */\n  group?: string;\n  /**\n   * @deprecated Use requiresKeyValue instead\n   */\n  requiresKeyToBeTrue?: string;\n  /** Optional requires a specific key to have a specific value */\n  requiresKeyValue?: { key: string; value: unknown };\n}\n\n/**\n * Text field schema\n */\nexport interface TextFieldSchema extends PropertyFieldSchema {\n  type: \"text\";\n  placeholder?: string;\n  maxLength?: number;\n}\n\n/**\n * Textarea field schema\n */\nexport interface TextareaFieldSchema extends PropertyFieldSchema {\n  type: \"textarea\";\n  placeholder?: string;\n  rows?: number;\n  maxLength?: number;\n}\n\n/**\n * Number field schema\n */\nexport interface NumberFieldSchema extends PropertyFieldSchema {\n  type: \"number\";\n  min?: number;\n  max?: number;\n  step?: number;\n}\n\n/**\n * Boolean field schema\n */\nexport interface BooleanFieldSchema extends PropertyFieldSchema {\n  type: \"boolean\";\n}\n\n/**\n * Select field schema with type-safe option values.\n * Uses StrictOmit to ensure \"defaultValue\" key exists on PropertyFieldSchema.\n */\nexport interface SelectFieldSchema<T extends string | number = string | number>\n  extends StrictOmit<PropertyFieldSchema, \"defaultValue\"> {\n  type: \"select\";\n  options: Array<{ label: string; value: T }>;\n  defaultValue?: T;\n}\n\n/**\n * Color field schema\n */\nexport interface ColorFieldSchema extends PropertyFieldSchema {\n  type: \"color\";\n}\n\n/**\n * Range slider field schema\n */\nexport interface RangeFieldSchema extends PropertyFieldSchema {\n  type: \"range\";\n  min: number;\n  max: number;\n  step?: number;\n}\n\n/**\n * Data source field schema for configuring widget data sources\n */\nexport interface DataSourceFieldSchema extends PropertyFieldSchema {\n  type: \"dataSource\";\n}\n\n/**\n * Resource field schema for selecting a single resource from the selection modal\n */\nexport interface ResourceFieldSchema extends PropertyFieldSchema {\n  type: \"resource\";\n  /** Optional filter to specific shareable types */\n  allowedTypes?: string[];\n}\n\n/**\n * Alignment field schema\n */\nexport interface AlignmentFieldSchema extends PropertyFieldSchema {\n  type: \"alignment\";\n  options: {\n    verticalEnabled: boolean;\n    horizontalEnabled: boolean;\n  };\n  defaultValue?: AlignOptions;\n}\n\n/**\n * Slider field schema with optional unit suffix (e.g., \"rem\", \"px\")\n */\nexport interface SliderFieldSchema extends PropertyFieldSchema {\n  type: \"slider\";\n  min: number;\n  max: number;\n  step?: number;\n  unit?: string;\n}\n\n/**\n * Color picker field schema with optional swatches\n */\nexport interface ColorPickerFieldSchema extends PropertyFieldSchema {\n  type: \"colorPicker\";\n  swatches?: string[];\n}\n\n/**\n * Section header field schema for visual grouping\n */\nexport interface SectionHeaderFieldSchema extends PropertyFieldSchema {\n  type: \"sectionHeader\";\n  subtitle?: string;\n}\n\n/**\n * Separator field schema for visual separation\n */\nexport interface SeparatorFieldSchema extends PropertyFieldSchema {\n  type: \"separator\";\n}\n\n/**\n * Button group field schema.\n * Uses StrictOmit to ensure \"defaultValue\" key exists on PropertyFieldSchema.\n */\nexport interface ButtonGroupFieldSchema<\n  T extends string | number = string | number,\n> extends StrictOmit<PropertyFieldSchema, \"defaultValue\"> {\n  type: \"buttonGroup\";\n  options: Array<{ label: string; value: T }>;\n  defaultValue?: T;\n}\n\n/**\n * Color select field schema\n */\nexport interface ColorSelectFieldSchema extends PropertyFieldSchema {\n  type: \"colorSelect\";\n  defaultValue?: ColorOptions;\n}\n\n/**\n * Section layout select field schema for visual masonry layout selector\n */\nexport interface SectionLayoutSelectFieldSchema extends PropertyFieldSchema {\n  type: \"sectionLayoutSelect\";\n  defaultValue?: SectionLayoutType;\n}\n\n/**\n * Background field combines resource selection and color properties.\n * Uses StrictOmit to exclude conflicting \"type\" discriminant from parents.\n */\nexport interface BackgroundFieldSchema\n  extends StrictOmit<ResourceFieldSchema, \"type\">,\n    StrictOmit<ColorFieldSchema, \"type\"> {\n  type: \"background\";\n}\n\n/**\n * Content position field schema for 3x3 grid position picker\n */\nexport interface ContentPositionFieldSchema extends PropertyFieldSchema {\n  type: \"contentPosition\";\n  defaultValue?: string;\n}\n\n/**\n * Union of all field schema types\n */\nexport type PropertyField =\n  | TextFieldSchema\n  | TextareaFieldSchema\n  | NumberFieldSchema\n  | BooleanFieldSchema\n  | SelectFieldSchema<string | number>\n  | ColorFieldSchema\n  | RangeFieldSchema\n  | DataSourceFieldSchema\n  | ResourceFieldSchema\n  | AlignmentFieldSchema\n  | SliderFieldSchema\n  | ColorPickerFieldSchema\n  | SectionHeaderFieldSchema\n  | SeparatorFieldSchema\n  | ButtonGroupFieldSchema<string | number>\n  | ColorSelectFieldSchema\n  | SectionLayoutSelectFieldSchema\n  | BackgroundFieldSchema\n  | ContentPositionFieldSchema;\n\n/**\n * Schema for per-item configuration in custom data sources.\n * Widgets can define this to allow users to configure widget-specific\n * settings for each selected item (e.g., title, description, button).\n */\nexport interface ItemConfigSchema {\n  /** Fields available for per-item configuration */\n  fields: PropertyField[];\n  /** Optional description shown at top of item config panel */\n  description?: string;\n}\n\n/**\n * Schema for a widget's editable properties\n */\nexport interface WidgetPropertySchema {\n  /** Widget type this schema applies to */\n  widgetType: WidgetType;\n  /** Display name for the widget */\n  displayName: string;\n  /** Optional tab configuration - if present, tabs are enabled */\n  tabsConfig?: TabConfig[];\n  /** Editable property fields */\n  fields: PropertyField[];\n  /** Optional custom validator function */\n  validate?: (props: Record<string, unknown>) => string | null;\n  /** Props that can be populated from data sources */\n  dataSourceTargetProps?: string[];\n  /** Optional schema for per-item configurations in custom data sources */\n  itemConfigSchema?: ItemConfigSchema;\n}\n\n/**\n * Registry mapping widget types to their property schemas\n */\nexport type PropertySchemaRegistry = Record<WidgetType, WidgetPropertySchema>;\n\n/**\n * Group property fields by their group property\n */\nexport function groupPropertyFields(\n  fields: readonly PropertyField[],\n): Record<string, PropertyField[]> {\n  const grouped: Record<string, PropertyField[]> = {};\n\n  fields.forEach((field) => {\n    const group = field.group || \"General\";\n    if (!grouped[group]) {\n      grouped[group] = [];\n    }\n    grouped[group].push(field);\n  });\n\n  return grouped;\n}\n\n/**\n * Extract current values from widget props based on property fields\n */\nexport function extractPropertyValues(\n  widget: Readonly<WidgetSchema>,\n  fields: readonly PropertyField[],\n): Record<string, unknown> {\n  const values: Record<string, unknown> = {};\n\n  fields.forEach((field) => {\n    const value = widget.props[field.key];\n    values[field.key] = value !== undefined ? value : field.defaultValue;\n  });\n\n  return values;\n}\n\n/**\n * Apply property values to widget props\n */\nexport function applyPropertyValues(\n  widget: Readonly<WidgetSchema>,\n  values: Readonly<Record<string, unknown>>,\n): WidgetSchema {\n  return {\n    ...widget,\n    props: {\n      ...widget.props,\n      ...values,\n    },\n  };\n}\n","import type {\n  ButtonGroupFieldSchema,\n  ColorSelectFieldSchema,\n  SelectFieldSchema,\n} from \"./property-schema-types\";\nimport type {\n  BorderRadiusOptions,\n  FontSizeOptions,\n  PaddingOptions,\n  ButtonSizeOptions,\n  GapOptions,\n} from \"../types\";\n\nexport const getColorField = (\n  props: Readonly<Omit<ColorSelectFieldSchema, \"type\">>,\n): ColorSelectFieldSchema => {\n  return {\n    ...props,\n    type: \"colorSelect\",\n  };\n};\n\nexport const getBorderRadiusField = (\n  props: Readonly<\n    Omit<ButtonGroupFieldSchema<BorderRadiusOptions>, \"options\" | \"type\">\n  >,\n): ButtonGroupFieldSchema<BorderRadiusOptions> => {\n  return {\n    ...props,\n    type: \"buttonGroup\",\n    options: [\n      { label: \"None\", value: \"none\" },\n      { label: \"SM\", value: \"sm\" },\n      { label: \"MD\", value: \"md\" },\n      { label: \"LG\", value: \"lg\" },\n      { label: \"XL\", value: \"xl\" },\n      { label: \"FULL\", value: \"full\" },\n    ],\n  };\n};\n\nexport const getPaddingField = (\n  props: Readonly<\n    Omit<ButtonGroupFieldSchema<PaddingOptions>, \"options\" | \"type\">\n  >,\n): ButtonGroupFieldSchema<PaddingOptions> => {\n  return {\n    ...props,\n    type: \"buttonGroup\",\n    options: [\n      { label: \"None\", value: 0 },\n      { label: \"SM\", value: 2 },\n      { label: \"MD\", value: 4 },\n      { label: \"LG\", value: 6 },\n      { label: \"XL\", value: 8 },\n      { label: \"FULL\", value: 10 },\n    ],\n  };\n};\n\nexport const getButtonSizeField = (\n  props: Readonly<\n    Omit<ButtonGroupFieldSchema<ButtonSizeOptions>, \"options\" | \"type\">\n  >,\n): ButtonGroupFieldSchema<ButtonSizeOptions> => {\n  return {\n    ...props,\n    type: \"buttonGroup\",\n    options: [\n      { label: \"SM\", value: \"sm\" },\n      { label: \"MD\", value: \"default\" },\n      { label: \"LG\", value: \"lg\" },\n      { label: \"XL\", value: \"xl\" },\n    ],\n  };\n};\n\nexport const getFontSizeField = (\n  props: Readonly<Omit<SelectFieldSchema<FontSizeOptions>, \"options\" | \"type\">>,\n): SelectFieldSchema<FontSizeOptions> => {\n  return {\n    ...props,\n    type: \"select\",\n    options: [\n      { label: \"Giant\", value: \"2xl\" },\n      { label: \"Extra Large\", value: \"xl\" },\n      { label: \"Large\", value: \"lg\" },\n      { label: \"Regular\", value: \"md\" },\n      { label: \"Small\", value: \"sm\" },\n      { label: \"Extra Small\", value: \"xs\" },\n    ],\n  };\n};\n\nexport const getGapField = (\n  props: Readonly<Omit<ButtonGroupFieldSchema<GapOptions>, \"options\" | \"type\">>,\n): ButtonGroupFieldSchema<GapOptions> => {\n  return {\n    ...props,\n    type: \"buttonGroup\",\n    options: [\n      { label: \"None\", value: \"none\" },\n      { label: \"XS\", value: \"xs\" },\n      { label: \"SM\", value: \"sm\" },\n      { label: \"MD\", value: \"md\" },\n      { label: \"LG\", value: \"lg\" },\n      { label: \"XL\", value: \"xl\" },\n    ],\n  };\n};\n\n/**\n * Gap value mapping - use `as const satisfies` for compile-time validation\n * with literal type preservation.\n */\nexport const gapValues = {\n  none: 0,\n  xs: 1,\n  sm: 2,\n  md: 4,\n  lg: 6,\n  xl: 8,\n} as const satisfies Record<GapOptions, number>;\n"]}

package/dist/shareable-item-DPmNZkE1.d.cts

@@ -0,0 +1,138 @@
+import { ComponentType } from 'react';
+
+/**
+ * Widget type names as a const object.
+ * This serves as the single source of truth for widget discriminants.
+ * Use `as const` for literal type inference (safety-as-const-deep-readonly rule).
+ */
+declare const WIDGET_TYPE_NAMES: {
+    readonly Alert: "AlertWidget";
+    readonly Calendar: "CalendarWidget";
+    readonly Carousel: "CarouselWidget";
+    readonly CatchUp: "CatchUpWidget";
+    readonly Chart: "ChartWidget";
+    readonly Container: "ContainerWidget";
+    readonly Embed: "EmbedWidget";
+    readonly Image: "ImageWidget";
+    readonly Layout: "LayoutWidget";
+    readonly List: "ListWidget";
+    readonly MySite: "MySiteWidget";
+    readonly Nested: "NestedWidget";
+    readonly QuickShare: "QuickShareWidget";
+    readonly RecentActivity: "RecentActivityWidget";
+    readonly Spacer: "SpacerWidget";
+    readonly Table: "TableWidget";
+    readonly Text: "TextWidget";
+    readonly ToDo: "ToDoWidget";
+    readonly Video: "VideoWidget";
+};
+/**
+ * Union of all known widget type names.
+ * Derived from WIDGET_TYPE_NAMES to avoid duplication (deriving-typeof-for-object-keys rule).
+ */
+type WidgetTypeName = (typeof WIDGET_TYPE_NAMES)[keyof typeof WIDGET_TYPE_NAMES];
+/**
+ * Legacy alias for backwards compatibility.
+ * Prefer using WidgetTypeName for new code when you need the union type.
+ */
+type WidgetType = string;
+type WidgetRegistry = Record<WidgetType, ComponentType<any>>;
+/**
+ * Base widget schema with loose typing for runtime data.
+ * Use TypedWidgetSchema<T> when you have a known registry for better type safety.
+ */
+type WidgetSchema = {
+    readonly type: WidgetType;
+    readonly props: Readonly<Record<string, unknown>>;
+    readonly id?: string;
+    /** Column index for masonry layouts (0-indexed) */
+    readonly columnIndex?: number;
+};
+/**
+ * Type-safe widget schema based on registry.
+ * Uses discriminated unions - the `type` field serves as discriminant.
+ * When narrowed (e.g., `if (widget.type === "AlertWidget")`),
+ * TypeScript automatically knows the correct props type.
+ */
+type TypedWidgetSchema<T extends Record<string, ComponentType<any>>> = {
+    [K in keyof T]: {
+        readonly type: K;
+        readonly props: Readonly<React.ComponentProps<T[K]>>;
+        readonly id?: string;
+        /** Column index for masonry layouts (0-indexed) */
+        readonly columnIndex?: number;
+    };
+}[keyof T];
+/**
+ * Widget path in the tree - array of indices.
+ * Readonly tuple to prevent accidental mutation.
+ */
+type WidgetPath = readonly number[];
+/**
+ * Type predicate to check if a string is a known widget type name.
+ * Use for runtime validation of widget types.
+ *
+ * @example
+ * if (isWidgetTypeName(widget.type)) {
+ *   // TypeScript knows widget.type is WidgetTypeName
+ * }
+ */
+declare function isWidgetTypeName(type: string): type is WidgetTypeName;
+/**
+ * Type predicate to check if a widget has a specific type.
+ * Enables type-safe widget narrowing without `as` assertions.
+ *
+ * @example
+ * if (isWidgetType(widget, "LayoutWidget")) {
+ *   // TypeScript knows widget.type === "LayoutWidget"
+ *   // and widget.props is LayoutWidget props
+ * }
+ */
+declare function isWidgetType<T extends WidgetTypeName>(widget: WidgetSchema | null | undefined, typeName: T): widget is WidgetSchema & {
+    readonly type: T;
+};
+/**
+ * Helper for exhaustive switch statements on widget types.
+ * Use in the default case to ensure all widget types are handled.
+ *
+ * @example
+ * switch (widget.type) {
+ *   case "AlertWidget": return handleAlert();
+ *   case "TextWidget": return handleText();
+ *   // ... all other widget types
+ *   default: return assertNever(widget.type, "widget type");
+ * }
+ */
+declare function assertNever(value: never, context?: string): never;
+/**
+ * Assertion function that throws if value is undefined.
+ * Narrows the type to exclude undefined.
+ *
+ * @example
+ * const widget = screen[0];
+ * assertDefined(widget, "widget at index 0");
+ * // TypeScript knows widget is defined here
+ */
+declare function assertDefined<T>(value: T | undefined | null, name?: string): asserts value is T;
+
+/**
+ * Base props for a shareable item.
+ * Uses structural typing to be compatible with various modal implementations.
+ * The index signature allows additional properties from consuming apps.
+ */
+interface ShareableItem {
+    id: string | number;
+    title?: string | null;
+    image_url?: string | null;
+    imageUrl?: string | null;
+    kind?: string | null;
+    type?: string | null;
+    shareableType?: string | null;
+    share_link?: string | null;
+    videoUrl?: string;
+    price?: string | number | null;
+    display_price?: string | null;
+    [key: string]: unknown;
+}
+
+export { type ShareableItem as S, type TypedWidgetSchema as T, type WidgetPath as W, type WidgetSchema as a, type WidgetType as b, type WidgetTypeName as c, type WidgetRegistry as d, WIDGET_TYPE_NAMES as e, isWidgetType as f, assertNever as g, assertDefined as h, isWidgetTypeName as i };