@khester/dynamics-cell-renderers 1.1.0

package/dist/types/index.d.ts

@@ -0,0 +1,245 @@
+import { IColumn } from '@fluentui/react';
+/**
+ * Minimal API service interface for lookup cell search queries.
+ * Consumers should pass their own IApiService implementation that satisfies this contract.
+ */
+export interface IApiService {
+    retrieveMultipleRecords<T>(entitySetName: string, options?: string): Promise<{
+        value: T[];
+    }>;
+}
+/**
+ * Minimal ChangedRecord interface for edit mode tracking.
+ * The full implementation lives in the consuming grid component (e.g., web-resources).
+ */
+export interface ChangedRecord {
+    key: string;
+    changes: Record<string, {
+        oldValue: unknown;
+        newValue: unknown;
+    }>;
+}
+/**
+ * Supported field types for list columns.
+ */
+export type ListFieldType = 'text' | 'link' | 'currency' | 'date' | 'datetime' | 'number' | 'lookup' | 'optionset' | 'toggle' | 'icon' | 'progressBar' | 'coloredCell' | 'rating' | 'composite';
+/**
+ * Slot types for the composite cell renderer.
+ * Structurally aligned with form-runtime's CompositeSlotType so a grid
+ * customizer definition maps onto these without an import.
+ */
+export type CompositeSlotType = 'icon' | 'text' | 'badge' | 'link' | 'image' | 'spacer' | 'progress' | 'rating';
+/** Conditional style rule for a composite slot — first match wins. */
+export interface ConditionalStyle {
+    /** Field on the row to evaluate (not limited to this column). */
+    field: string;
+    /** Comparison operator. */
+    operator: 'eq' | 'gt' | 'lt' | 'gte' | 'lte' | 'contains' | 'between';
+    /** Value to compare against. */
+    value: string | number;
+    /** End value for the 'between' operator. */
+    valueTo?: string | number;
+    /** CSS style applied when the condition matches. */
+    style: Record<string, string>;
+}
+/** A composable slot within a composite cell. */
+export interface CompositeSlot {
+    /** Unique identifier. */
+    id: string;
+    /** Slot type — determines what is rendered. */
+    type: CompositeSlotType;
+    /** Bind to a row field (dynamic); omit for a static value. */
+    fieldBinding?: string;
+    /** Static value (icon name, text, URL…) when no field binding. */
+    staticValue?: string;
+    /** Base style when no conditional style matches. */
+    defaultStyle?: Record<string, string>;
+    /** Ordered conditional styles — first match wins, else `defaultStyle`. */
+    conditionalStyles?: ConditionalStyle[];
+}
+/** Configuration object for the composite renderer (mirrors form-runtime). */
+export interface CompositeRendererConfig {
+    /** Layout direction for slots. */
+    layout: 'horizontal' | 'vertical';
+    /** Gap between slots in pixels. */
+    gap: number;
+    /** Ordered list of composable slots. */
+    slots: CompositeSlot[];
+}
+/**
+ * Extended column interface for the ReusableDetailsList.
+ * Adds field type information and custom rendering options.
+ */
+export interface IReusableColumn<T> extends Omit<IColumn, 'onRender'> {
+    /** The type of field for automatic rendering */
+    fieldType: ListFieldType;
+    /** Whether the column is editable */
+    editable?: boolean;
+    /** Handler when link is clicked */
+    onLinkClick?: (item: T) => void;
+    /** Whether to open in new tab (for URLs) */
+    openInNewTab?: boolean;
+    /** Map of value to background color */
+    colorMap?: Record<string | number, string>;
+    /** Function to get background color from value */
+    getBackgroundColor?: (value: string | number) => string;
+    /** Label when toggle is on */
+    toggleOnText?: string;
+    /** Label when toggle is off */
+    toggleOffText?: string;
+    /** Handler when toggle value changes */
+    onToggleChange?: (key: string, fieldName: string, value: boolean) => void;
+    /** Icon name from Fluent UI icons */
+    iconName?: string;
+    /** Handler when icon is clicked */
+    onIconClick?: (item: T) => void;
+    /** Tooltip for the icon */
+    iconTitle?: string;
+    /** Maximum value for progress (default: 100) */
+    progressMax?: number;
+    /** Color for the progress bar */
+    progressColor?: string;
+    /** Whether to show percentage label */
+    showProgressLabel?: boolean;
+    /** Maximum rating (number of stars), default 5 */
+    ratingMax?: number;
+    /** Filled-star color (default gold '#ffb900') */
+    ratingColor?: string;
+    /** Round to half-stars from fractional values (default true) */
+    ratingAllowHalf?: boolean;
+    /** Rating display style: 'stars' (default) or 'emoji' (sentiment faces). */
+    ratingStyle?: 'stars' | 'emoji';
+    /** Number of emoji faces (2–5). Falls back to ratingMax clamped to 2..5. */
+    ratingFaceCount?: number;
+    /** Tint emoji faces with sentiment colors (red→green). Default true for emoji. */
+    ratingUseSentimentColor?: boolean;
+    /** Ordered slots for the composite renderer */
+    compositeSlots?: CompositeSlot[];
+    /** Layout direction for composite slots (default 'horizontal') */
+    compositeLayout?: 'horizontal' | 'vertical';
+    /** Gap between composite slots in px (default 4) */
+    compositeGap?: number;
+    /** Custom format function for display value */
+    formatValue?: (value: unknown, item: T) => string;
+    /** Currency code for currency fields (default: 'USD') */
+    currencyCode?: string;
+    /** Locale for formatting (default: 'en-US') */
+    locale?: string;
+    /** Whether this column links to the record itself (uses item.key as ID) */
+    isRecordLink?: boolean;
+    /** Entity logical name for record link navigation (e.g., 'account') */
+    recordEntityLogicalName?: string;
+    /** Field name for the lookup display value */
+    lookupDisplayField?: string;
+    /** Entity set name for the lookup target (e.g., 'contacts') - used for search API */
+    lookupEntitySetName?: string;
+    /** Primary name attribute of the lookup target entity (e.g., 'fullname' for contact) */
+    lookupSearchField?: string;
+    /** Logical name of the lookup target entity (e.g., 'contact') - used for navigation URLs */
+    lookupTargetEntity?: string;
+    /** Primary ID attribute of the lookup target entity (e.g., 'contactid') */
+    lookupPrimaryIdAttribute?: string;
+    /** Custom OData filter for lookup search (e.g., "statecode eq 0" for active records only) */
+    lookupFilter?: string;
+    /** Additional fields to select for lookup display (comma-separated) */
+    lookupSelectFields?: string;
+    /**
+     * Consumer-supplied search callback for editable lookup (fetch-free).
+     * Preferred over `apiService` when present — this is grid-kit's contract:
+     * the host owns the query, the cell only renders the returned options.
+     */
+    lookupSearch?: (term: string) => Promise<Array<{
+        id: string;
+        name: string;
+    }>>;
+    /**
+     * Option set choices for dropdown editing. `value` may be numeric (standard
+     * Dataverse optionset) or a string key; `iconName`/`color` are optional
+     * per-option adornments (rendered in the dropdown + read-mode badges).
+     */
+    optionSetOptions?: Array<{
+        value: number | string;
+        label: string;
+        iconName?: string;
+        color?: string;
+    }>;
+    /** Multi-select optionset: the value is an array of selected option values. */
+    optionSetMultiSelect?: boolean;
+    /** Validation function for edit mode - returns error message or undefined */
+    validate?: (value: unknown, rowKey: string) => string | undefined;
+    /** Whether to include this column in export options (default: true) */
+    exportable?: boolean;
+    /** Custom header name for export (defaults to column.name) */
+    exportLabel?: string;
+    /** Whether this column can be imported (default: true) */
+    importable?: boolean;
+    /** Whether this field is required during import */
+    importRequired?: boolean;
+    /** Alternative header names to match during import column mapping */
+    importAlias?: string[];
+}
+/**
+ * Result of a batch update operation.
+ */
+export interface BatchUpdateResult {
+    /** IDs of records successfully updated */
+    succeeded: string[];
+    /** Records that failed to update */
+    failed: {
+        id: string;
+        error: string;
+    }[];
+}
+/**
+ * Record for batch update operation.
+ */
+export interface BatchUpdateRecord {
+    /** Record ID */
+    id: string;
+    /** Fields to update */
+    data: Record<string, unknown>;
+}
+/**
+ * Selection mode for the list.
+ */
+export type ListSelectionMode = 'none' | 'single' | 'multiple';
+/**
+ * Sort direction for columns.
+ */
+export type SortDirection = 'asc' | 'desc';
+/**
+ * Sort state for the list.
+ */
+export interface SortState<T> {
+    /** Column key being sorted */
+    sortColumn: keyof T | null;
+    /** Sort direction */
+    sortDirection: SortDirection;
+}
+/**
+ * Pagination state for the list.
+ */
+export interface PaginationState {
+    /** Current page (1-based) */
+    currentPage: number;
+    /** Total number of pages */
+    totalPages: number;
+    /** Items per page */
+    pageSize: number;
+    /** Total number of items */
+    totalItems: number;
+}
+/**
+ * Props for cell renderer components.
+ */
+export interface CellRendererProps<T> {
+    /** The item being rendered */
+    item: T;
+    /** The column configuration */
+    column: IReusableColumn<T>;
+    /** The field value */
+    value: unknown;
+    /** The item's key (for callbacks) */
+    itemKey: string;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,uBAAuB,CAAC,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,CAAC,EAAE,CAAA;KAAE,CAAC,CAAC;CAC9F;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CACnE;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,MAAM,GACN,MAAM,GACN,UAAU,GACV,MAAM,GACN,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,MAAM,GACN,aAAa,GACb,aAAa,GACb,QAAQ,GACR,WAAW,CAAC;AAEhB;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GACzB,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,OAAO,GACP,QAAQ,GACR,UAAU,GACV,QAAQ,CAAC;AAEb,sEAAsE;AACtE,MAAM,WAAW,gBAAgB;IAC/B,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,QAAQ,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,SAAS,CAAC;IACtE,gCAAgC;IAChC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,4CAA4C;IAC5C,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAED,iDAAiD;AACjD,MAAM,WAAW,aAAa;IAC5B,yBAAyB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,+CAA+C;IAC/C,IAAI,EAAE,iBAAiB,CAAC;IACxB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kEAAkE;IAClE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACxC;AAED,8EAA8E;AAC9E,MAAM,WAAW,uBAAuB;IACtC,kCAAkC;IAClC,MAAM,EAAE,YAAY,GAAG,UAAU,CAAC;IAClC,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,wCAAwC;IACxC,KAAK,EAAE,aAAa,EAAE,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,CAAE,SAAQ,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC;IACnE,gDAAgD;IAChD,SAAS,EAAE,aAAa,CAAC;IAEzB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAGnB,mCAAmC;IACnC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;IAChC,4CAA4C;IAC5C,YAAY,CAAC,EAAE,OAAO,CAAC;IAGvB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,kDAAkD;IAClD,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,KAAK,MAAM,CAAC;IAGxD,8BAA8B;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+BAA+B;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wCAAwC;IACxC,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IAG1E,qCAAqC;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;IAChC,2BAA2B;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IAGnB,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iCAAiC;IACjC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uCAAuC;IACvC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAG5B,kDAAkD;IAClD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,4EAA4E;IAC5E,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAChC,4EAA4E;IAC5E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kFAAkF;IAClF,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAGlC,+CAA+C;IAC/C,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC,kEAAkE;IAClE,eAAe,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC;IAC5C,oDAAoD;IACpD,YAAY,CAAC,EAAE,MAAM,CAAC;IAGtB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAClD,yDAAyD;IACzD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;IAGhB,2EAA2E;IAC3E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,uEAAuE;IACvE,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAGjC,8CAA8C;IAC9C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,qFAAqF;IACrF,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,wFAAwF;IACxF,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,4FAA4F;IAC5F,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,2EAA2E;IAC3E,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,6FAA6F;IAC7F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uEAAuE;IACvE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAC;IAG9E;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvG,+EAA+E;IAC/E,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAG/B,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IAGlE,uEAAuE;IACvE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;IAGrB,0DAA0D;IAC1D,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mDAAmD;IACnD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qEAAqE;IACrE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,0CAA0C;IAC1C,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,oCAAoC;IACpC,MAAM,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,gBAAgB;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,8BAA8B;IAC9B,UAAU,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IAC3B,qBAAqB;IACrB,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,6BAA6B;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,8BAA8B;IAC9B,IAAI,EAAE,CAAC,CAAC;IACR,+BAA+B;IAC/B,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAC3B,sBAAsB;IACtB,KAAK,EAAE,OAAO,CAAC;IACf,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@khester/dynamics-cell-renderers",
+  "version": "1.1.0",
+  "description": "Cell renderer components for Dynamics 365 grids: text, currency, date, lookup, optionset, progress, and editable variants",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": ["dist"],
+  "scripts": {
+    "build": "rollup -c",
+    "dev": "rollup -c -w",
+    "test": "jest --passWithNoTests",
+    "test:coverage": "jest --coverage --passWithNoTests",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ext .ts,.tsx",
+    "lint:fix": "eslint src --ext .ts,.tsx --fix",
+    "clean": "rimraf dist coverage",
+    "clean:dist": "rimraf dist"
+  },
+  "dependencies": {
+    "@khester/dynamics-utils": "^1.2.0"
+  },
+  "peerDependencies": {
+    "@fluentui/react": "^8.115.6",
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-typescript": "^11.1.5",
+    "@types/react": "^18.2.45",
+    "@types/react-dom": "^18.2.18",
+    "rimraf": "^5.0.5",
+    "rollup": "^4.6.1",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "typescript": "^5.3.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}