@fluid-app/portal-core 0.1.19 → 0.1.21

package/dist/widget-manifest-DQmTtAF1.d.mts

@@ -0,0 +1,373 @@
+import { a as WidgetSchema, o as WidgetType } from "./widget-schema-BKZgsNG7.mjs";
+import { d as ColorOptions, n as AlignOptions, p as FontSizeOptions, t as StrictOmit, x as SectionLayoutType } from "./index-Cqt2JzkQ.mjs";
+import { ComponentType } from "react";
+import { IconDefinition } from "@fortawesome/fontawesome-svg-core";
+
+//#region src/registries/property-schema-types.d.ts
+/**
+* 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 image: "image";
+  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";
+  readonly textSizeSelect: "textSizeSelect";
+  readonly cssUnit: "cssUnit";
+};
+/**
+* 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[];
+}
+/**
+* Image field schema for selecting a single image from the image picker
+*/
+interface ImageFieldSchema extends PropertyFieldSchema {
+  type: "image";
+}
+/**
+* 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;
+    icon?: IconDefinition;
+    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;
+}
+/**
+* Text size select field schema for visual font size selector
+*/
+interface TextSizeSelectFieldSchema extends PropertyFieldSchema {
+  type: "textSizeSelect";
+  defaultValue?: FontSizeOptions;
+}
+/**
+* CSS unit type for height/width fields
+*/
+type CssUnit = "px" | "rem" | "vh" | "%";
+/**
+* CSS unit field schema for numeric values with selectable units (px, rem, vh, %)
+*/
+interface CssUnitFieldSchema extends PropertyFieldSchema {
+  type: "cssUnit";
+  minByUnit?: Partial<Record<CssUnit, number>>;
+  maxByUnit?: Partial<Record<CssUnit, number>>;
+  stepByUnit?: Partial<Record<CssUnit, number>>;
+  allowedUnits?: CssUnit[];
+  defaultUnit?: CssUnit;
+}
+/**
+* Union of all field schema types
+*/
+type PropertyField = TextFieldSchema | TextareaFieldSchema | NumberFieldSchema | BooleanFieldSchema | SelectFieldSchema<string | number> | ColorFieldSchema | RangeFieldSchema | DataSourceFieldSchema | ResourceFieldSchema | ImageFieldSchema | AlignmentFieldSchema | SliderFieldSchema | ColorPickerFieldSchema | SectionHeaderFieldSchema | SeparatorFieldSchema | ButtonGroupFieldSchema<string | number> | ColorSelectFieldSchema | SectionLayoutSelectFieldSchema | BackgroundFieldSchema | ContentPositionFieldSchema | TextSizeSelectFieldSchema | CssUnitFieldSchema;
+/**
+* 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;
+//#endregion
+//#region src/registries/container-types.d.ts
+/**
+* Interface for container widget behavior.
+* Container widgets can hold and manage child widgets.
+* Note: Children can be null for sparse arrays (e.g., grid layouts with empty cells)
+*/
+interface ContainerWidgetBehavior {
+  /** Identifies this widget type as a container */
+  isContainer: true;
+  /** Gets children from the widget's props */
+  getChildren: (props: Record<string, unknown>) => (WidgetSchema | null)[];
+  /** Creates new props with updated children */
+  setChildren: (props: Record<string, unknown>, children: (WidgetSchema | null)[]) => Record<string, unknown>;
+  /** Optional: Check if this container accepts a specific widget type */
+  canAcceptChild?: (childType: string) => boolean;
+}
+//#endregion
+//#region src/registries/widget-manifest.d.ts
+/**
+* The manifest a plugin author provides to register a custom widget.
+* Required fields ensure the widget works in both builder and SDK contexts.
+* Optional fields enable advanced behavior (containers, min SDK version).
+*/
+interface WidgetManifest {
+  /** Schema version for forward compatibility. Currently must be 1. */
+  manifestVersion: number;
+  /** Unique widget type identifier (e.g., "StockTickerWidget"). */
+  type: string;
+  /** The React component that renders this widget. */
+  component: ComponentType<any>;
+  /** Human-readable name shown in the builder palette. */
+  displayName: string;
+  /** Brief description shown in the builder palette. */
+  description: string;
+  /** Icon identifier for the builder palette (e.g., "chart-line"). */
+  icon: string;
+  /** Category ID for palette grouping (e.g., "components", "blocks", "utility"). */
+  category: string;
+  /** Property schema defining editable fields in the builder's property panel. */
+  propertySchema: WidgetPropertySchema;
+  /** Default prop values when the widget is first created. */
+  defaultProps: Record<string, unknown>;
+  /** Container behavior — only if this widget can hold child widgets. */
+  container?: ContainerWidgetBehavior;
+  /** Minimum SDK version required (e.g., "1.0.0"). */
+  minSdkVersion?: string;
+  /** Resizable configuration. */
+  resizable?: {
+    horizontal?: boolean;
+    vertical?: boolean;
+    minWidth?: number;
+    minHeight?: number;
+  };
+}
+//#endregion
+export { TextFieldSchema as A, ResourceFieldSchema as C, SeparatorFieldSchema as D, SelectFieldSchema as E, extractPropertyValues as F, groupPropertyFields as I, isPropertyFieldType as L, TextareaFieldSchema as M, WidgetPropertySchema as N, SliderFieldSchema as O, applyPropertyValues as P, RangeFieldSchema as S, SectionLayoutSelectFieldSchema as T, PROPERTY_FIELD_TYPES as _, BooleanFieldSchema as a, PropertyFieldType as b, ColorPickerFieldSchema as c, CssUnit as d, CssUnitFieldSchema as f, NumberFieldSchema as g, ItemConfigSchema as h, BackgroundFieldSchema as i, TextSizeSelectFieldSchema as j, TabConfig as k, ColorSelectFieldSchema as l, ImageFieldSchema as m, ContainerWidgetBehavior as n, ButtonGroupFieldSchema as o, DataSourceFieldSchema as p, AlignmentFieldSchema as r, ColorFieldSchema as s, WidgetManifest as t, ContentPositionFieldSchema as u, PropertyField as v, SectionHeaderFieldSchema as w, PropertySchemaRegistry as x, PropertyFieldSchema as y };
+//# sourceMappingURL=widget-manifest-DQmTtAF1.d.mts.map

package/dist/widget-manifest-DQmTtAF1.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget-manifest-DQmTtAF1.d.mts","names":[],"sources":["../src/registries/property-schema-types.ts","../src/registries/container-types.ts","../src/registries/widget-manifest.ts"],"mappings":";;;;;;;;;UAciB,SAAA;EAAjB;EAEE,EAAA;;EAEA,KAAA;AAAA;AAWF;;;;AAAA,cAAa,oBAAA;EAAA,SACX,IAAA;EAAA,SACA,QAAA;EAAA,SACA,MAAA;EAAA,SACA,OAAA;EAAA,SACA,MAAA;EAAA,SACA,KAAA;EAAA,SACA,KAAA;EAAA,SACA,UAAA;EAAA,SACA,QAAA;EAAA,SACA,KAAA;EAAA,SACA,SAAA;EAAA,SACA,MAAA;EAAA,SACA,WAAA;EAAA,SACA,aAAA;EAAA,SACA,SAAA;EAAA,SACA,WAAA;EAAA,SACA,WAAA;EAAA,SACA,mBAAA;EAAA,SACA,UAAA;EAAA,SACA,eAAA;EAAA,SACA,cAAA;EAAA,SACA,OAAA;AAAA;AAOF;;;;AAAA,KAAY,iBAAA,WACF,oBAAA,eAAmC,oBAAA;AAO7C;;;;;AAAA,iBAAgB,mBAAA,CAAoB,KAAA,WAAgB,KAAA,IAAS,iBAAA;;;;UAS5C,mBAAA;EAAA;EAEf,GAAA;EAIM;EAFN,KAAA;;EAEA,IAAA,EAAM,iBAAA;;EAEN,WAAA;;EAEA,YAAA;;EAEA,GAAA;;EAEA,KAAA;;;;EAIA,mBAAA;EAQe;EANf,gBAAA;IAAqB,GAAA;IAAa,KAAA;EAAA;AAAA;;;;UAMnB,eAAA,SAAwB,mBAAA;EACvC,IAAA;EACA,WAAA;EACA,SAAA;AAAA;;;;UAMe,mBAAA,SAA4B,mBAAA;EAC3C,IAAA;EACA,WAAA;EACA,IAAA;EACA,SAAA;AAAA;;;;UAMe,iBAAA,SAA0B,mBAAA;EACzC,IAAA;EACA,GAAA;EACA,GAAA;EACA,IAAA;AAAA;;;;UAMe,kBAAA,SAA2B,mBAAA;EAC1C,IAAA;AAAA;;;;;UAOe,iBAAA,sDAEP,UAAA,CAAW,mBAAA;EACnB,IAAA;EACA,OAAA,EAAS,KAAA;IAAQ,KAAA;IAAe,KAAA,EAAO,CAAA;EAAA;EACvC,YAAA,GAAe,CAAA;AAAA;;;;UAMA,gBAAA,SAAyB,mBAAA;EACxC,IAAA;AAAA;;;;UAMe,gBAAA,SAAyB,mBAAA;EACxC,IAAA;EACA,GAAA;EACA,GAAA;EACA,IAAA;AAAA;;;;UAMe,qBAAA,SAA8B,mBAAA;EAC7C,IAAA;AAAA;;;;UAMe,mBAAA,SAA4B,mBAAA;EAC3C,IAAA;EARe;EAUf,YAAA;AAAA;;AAHF;;UASiB,gBAAA,SAAyB,mBAAA;EACxC,IAAA;AAAA;;;;UAMe,oBAAA,SAA6B,mBAAA;EAC5C,IAAA;EACA,OAAA;IACE,eAAA;IACA,iBAAA;EAAA;EAEF,YAAA,GAAe,YAAA;AAAA;;;;UAMA,iBAAA,SAA0B,mBAAA;EACzC,IAAA;EACA,GAAA;EACA,GAAA;EACA,IAAA;EACA,IAAA;AAAA;;AALF;;UAWiB,sBAAA,SAA+B,mBAAA;EAC9C,IAAA;EACA,QAAA;AAAA;;;;UAMe,wBAAA,SAAiC,mBAAA;EAChD,IAAA;EACA,QAAA;AAAA;;;;UAMe,oBAAA,SAA6B,mBAAA;EAC5C,IAAA;AAAA;;;AATF;;UAgBiB,sBAAA,sDAEP,UAAA,CAAW,mBAAA;EACnB,IAAA;EACA,OAAA,EAAS,KAAA;IAAQ,KAAA;IAAgB,IAAA,GAAO,cAAA;IAAgB,KAAA,EAAO,CAAA;EAAA;EAC/D,YAAA,GAAe,CAAA;AAAA;;;;UAMA,sBAAA,SAA+B,mBAAA;EAC9C,IAAA;EACA,YAAA,GAAe,YAAA;AAAA;;;;UAMA,8BAAA,SAAuC,mBAAA;EACtD,IAAA;EACA,YAAA,GAAe,iBAAA;AAAA;;;;;UAOA,qBAAA,SAEb,UAAA,CAAW,mBAAA,WACX,UAAA,CAAW,gBAAA;EACb,IAAA;AAAA;;;;UAMe,0BAAA,SAAmC,mBAAA;EAClD,IAAA;EACA,YAAA;AAAA;;AA7BF;;UAmCiB,yBAAA,SAAkC,mBAAA;EACjD,IAAA;EACA,YAAA,GAAe,eAAA;AAAA;;;;KAML,OAAA;AAnCZ;;;AAAA,UAwCiB,kBAAA,SAA2B,mBAAA;EAC1C,IAAA;EACA,SAAA,GAAY,OAAA,CAAQ,MAAA,CAAO,OAAA;EAC3B,SAAA,GAAY,OAAA,CAAQ,MAAA,CAAO,OAAA;EAC3B,UAAA,GAAa,OAAA,CAAQ,MAAA,CAAO,OAAA;EAC5B,YAAA,GAAe,OAAA;EACf,WAAA,GAAc,OAAA;AAAA;;;;KAMJ,aAAA,GACR,eAAA,GACA,mBAAA,GACA,iBAAA,GACA,kBAAA,GACA,iBAAA,oBACA,gBAAA,GACA,gBAAA,GACA,qBAAA,GACA,mBAAA,GACA,gBAAA,GACA,oBAAA,GACA,iBAAA,GACA,sBAAA,GACA,wBAAA,GACA,oBAAA,GACA,sBAAA,oBACA,sBAAA,GACA,8BAAA,GACA,qBAAA,GACA,0BAAA,GACA,yBAAA,GACA,kBAAA;;;;;;UAOa,gBAAA;;EAEf,MAAA,EAAQ,aAAA;;EAER,WAAA;AAAA;AAlEF;;;AAAA,UAwEiB,oBAAA;;EAEf,UAAA,EAAY,UAAA;;EAEZ,WAAA;EA1EA;EA4EA,UAAA,GAAa,SAAA;EAtEE;EAwEf,MAAA,EAAQ,aAAA;EAxEyC;EA0EjD,QAAA,IAAY,KAAA,EAAO,MAAA;;EAEnB,qBAAA;;EAEA,gBAAA,GAAmB,gBAAA;AAAA;AAtErB;;;AAAA,KA4EY,sBAAA,GAAyB,MAAA,CAAO,UAAA,EAAY,oBAAA;;AAvExD;;iBA4EgB,mBAAA,CACd,MAAA,WAAiB,aAAA,KAChB,MAAA,SAAe,aAAA;;;;iBAiBF,qBAAA,CACd,MAAA,EAAQ,QAAA,CAAS,YAAA,GACjB,MAAA,WAAiB,aAAA,KAChB,MAAA;;;;iBAca,mBAAA,CACd,MAAA,EAAQ,QAAA,CAAS,YAAA,GACjB,MAAA,EAAQ,QAAA,CAAS,MAAA,qBAChB,YAAA;;;;;;;;UCnZc,uBAAA;EDOA;ECLf,WAAA;EDKe;ECFf,WAAA,GAAc,KAAA,EAAO,MAAA,uBAA6B,YAAA;EDiBpD;ECdE,WAAA,GACE,KAAA,EAAO,MAAA,mBACP,QAAA,GAAW,YAAA,eACR,MAAA;;EAGL,cAAA,IAAkB,SAAA;AAAA;;;;;;ADPpB;;UELiB,cAAA;EFKA;EEHf,eAAA;EFkBF;EEfE,IAAA;;EAIA,SAAA,EAAW,aAAA;;EAGX,WAAA;;EAGA,WAAA;;EAGA,IAAA;;EAGA,QAAA;;EAGA,cAAA,EAAgB,oBAAA;;EAGhB,YAAA,EAAc,MAAA;;EAGd,SAAA,GAAY,uBAAA;;EAGZ,aAAA;;EAGA,SAAA;IACE,UAAA;IACA,QAAA;IACA,QAAA;IACA,SAAA;EAAA;AAAA"}