@mohsinonxrm/pptb-fetchxml-studio 1.0.0 → 1.0.2

package/src/features/fetchxml/model/layoutxml.ts

@@ -1,372 +0,0 @@
-/**
- * LayoutXML Parser and Generator
- * Handles Dataverse view layout configuration
- *
- * LayoutXML structure:
- * <grid name="resultset" object="1" jump="name" select="1" icon="1" preview="1">
- *   <row name="result" id="accountid">
- *     <cell name="name" width="300" />
- *     <cell name="primarycontactid" width="150" />
- *     <cell name="createdon" width="125" />
- *   </row>
- * </grid>
- */
-
-import type { FetchNode, AttributeNode, LinkEntityNode } from "./nodes";
-
-/**
- * Column configuration for a single column in the grid
- */
-export interface LayoutColumn {
-	/** Attribute logical name */
-	name: string;
-	/** Column width in pixels */
-	width: number;
-	/** Link-entity alias if this column is from a related entity */
-	linkEntityAlias?: string;
-	/** Whether sorting is disabled for this column */
-	disableSorting?: boolean;
-	/** Image provider for icon columns */
-	imageProviderName?: string;
-	/** Original display name from metadata (for UI) */
-	displayName?: string;
-}
-
-/**
- * Full layout configuration for the grid
- */
-export interface LayoutXmlConfig {
-	/** Grid name (usually "resultset") */
-	gridName: string;
-	/** Entity type code */
-	objectTypeCode?: number;
-	/** Attribute to navigate to on double-click */
-	jumpAttribute?: string;
-	/** Row selection enabled */
-	enableSelection?: boolean;
-	/** Show entity icon */
-	showIcon?: boolean;
-	/** Enable row preview */
-	enablePreview?: boolean;
-	/** Primary ID attribute for the row */
-	primaryIdAttribute?: string;
-	/** Column configurations in display order */
-	columns: LayoutColumn[];
-}
-
-/**
- * Default column widths based on attribute type
- */
-const DEFAULT_WIDTHS: Record<string, number> = {
-	// Text types - wider
-	String: 200,
-	Memo: 250,
-
-	// Numeric types - narrower
-	Integer: 100,
-	BigInt: 120,
-	Decimal: 120,
-	Double: 120,
-	Money: 130,
-
-	// Date/Time
-	DateTime: 150,
-
-	// Lookups - medium
-	Lookup: 180,
-	Customer: 180,
-	Owner: 180,
-
-	// Option sets - medium
-	Picklist: 150,
-	State: 100,
-	Status: 120,
-	MultiSelectPicklist: 200,
-
-	// Boolean - narrow
-	Boolean: 80,
-
-	// Unique identifier - wide (GUIDs)
-	Uniqueidentifier: 280,
-
-	// Image - narrow
-	Image: 60,
-
-	// File - medium
-	File: 150,
-
-	// Default fallback
-	default: 150,
-};
-
-/**
- * Get default width for an attribute type
- */
-export function getDefaultWidthForType(attributeType?: string): number {
-	if (!attributeType) return DEFAULT_WIDTHS.default;
-	return DEFAULT_WIDTHS[attributeType] ?? DEFAULT_WIDTHS.default;
-}
-
-/**
- * Parse a LayoutXML string into a LayoutXmlConfig
- */
-export function parseLayoutXml(xml: string): LayoutXmlConfig {
-	const parser = new DOMParser();
-	const doc = parser.parseFromString(xml, "text/xml");
-
-	// Check for parsing errors
-	const parseError = doc.querySelector("parsererror");
-	if (parseError) {
-		throw new Error(`Invalid LayoutXML: ${parseError.textContent}`);
-	}
-
-	const gridElement = doc.querySelector("grid");
-	if (!gridElement) {
-		throw new Error("Invalid LayoutXML: missing <grid> element");
-	}
-
-	const rowElement = doc.querySelector("row");
-	const cellElements = doc.querySelectorAll("cell");
-
-	const columns: LayoutColumn[] = [];
-	cellElements.forEach((cell) => {
-		const name = cell.getAttribute("name");
-		const width = cell.getAttribute("width");
-		const disableSorting = cell.getAttribute("disableSorting");
-		const imageProviderName = cell.getAttribute("imageproviderwebresource");
-
-		if (name) {
-			columns.push({
-				name,
-				width: width ? parseInt(width, 10) : DEFAULT_WIDTHS.default,
-				disableSorting: disableSorting === "1",
-				imageProviderName: imageProviderName || undefined,
-			});
-		}
-	});
-
-	return {
-		gridName: gridElement.getAttribute("name") || "resultset",
-		objectTypeCode: gridElement.getAttribute("object")
-			? parseInt(gridElement.getAttribute("object")!, 10)
-			: undefined,
-		jumpAttribute: gridElement.getAttribute("jump") || undefined,
-		enableSelection: gridElement.getAttribute("select") === "1",
-		showIcon: gridElement.getAttribute("icon") === "1",
-		enablePreview: gridElement.getAttribute("preview") === "1",
-		primaryIdAttribute: rowElement?.getAttribute("id") || undefined,
-		columns,
-	};
-}
-
-/**
- * Generate LayoutXML string from a LayoutXmlConfig
- */
-export function generateLayoutXml(config: LayoutXmlConfig): string {
-	const cells = config.columns
-		.map((col) => {
-			const attrs: string[] = [`name="${col.name}"`, `width="${col.width}"`];
-			if (col.disableSorting) {
-				attrs.push('disableSorting="1"');
-			}
-			if (col.imageProviderName) {
-				attrs.push(`imageproviderwebresource="${col.imageProviderName}"`);
-			}
-			return `    <cell ${attrs.join(" ")} />`;
-		})
-		.join("\n");
-
-	const gridAttrs: string[] = [`name="${config.gridName}"`];
-	if (config.objectTypeCode !== undefined) {
-		gridAttrs.push(`object="${config.objectTypeCode}"`);
-	}
-	if (config.jumpAttribute) {
-		gridAttrs.push(`jump="${config.jumpAttribute}"`);
-	}
-	gridAttrs.push(`select="${config.enableSelection ? "1" : "0"}"`);
-	gridAttrs.push(`icon="${config.showIcon ? "1" : "0"}"`);
-	gridAttrs.push(`preview="${config.enablePreview ? "1" : "0"}"`);
-
-	const rowId = config.primaryIdAttribute || "id";
-
-	return `<grid ${gridAttrs.join(" ")}>
-  <row name="result" id="${rowId}">
-${cells}
-  </row>
-</grid>`;
-}
-
-/**
- * Collect all attributes from a FetchXML query into column configs
- * Traverses root entity and all link-entities recursively
- */
-export function collectAttributesFromFetchXml(
-	fetchQuery: FetchNode,
-	attributeTypeMap?: Map<string, string>
-): LayoutColumn[] {
-	const columns: LayoutColumn[] = [];
-
-	// Helper to get the column key for an attribute
-	const getColumnKey = (attr: AttributeNode, linkAlias?: string): string => {
-		// If attribute has an alias, use it
-		if (attr.alias) return attr.alias;
-		// If from link-entity with alias, prefix with alias
-		if (linkAlias) return `${linkAlias}.${attr.name}`;
-		// Otherwise just the attribute name
-		return attr.name;
-	};
-
-	// Collect from root entity
-	if (fetchQuery.entity.attributes) {
-		for (const attr of fetchQuery.entity.attributes) {
-			const columnKey = getColumnKey(attr);
-			const attrType = attributeTypeMap?.get(attr.name);
-			columns.push({
-				name: columnKey,
-				width: getDefaultWidthForType(attrType),
-			});
-		}
-	}
-
-	// Recursive function to collect from link-entities
-	const collectFromLinkEntity = (link: LinkEntityNode) => {
-		// Determine the alias for this link-entity
-		const linkAlias = link.alias || link.name;
-
-		// Collect attributes
-		if (link.attributes) {
-			for (const attr of link.attributes) {
-				const columnKey = getColumnKey(attr, linkAlias);
-				const attrType = attributeTypeMap?.get(`${link.name}.${attr.name}`);
-				columns.push({
-					name: columnKey,
-					width: getDefaultWidthForType(attrType),
-					linkEntityAlias: linkAlias,
-				});
-			}
-		}
-
-		// Recurse into nested link-entities
-		if (link.links) {
-			for (const nestedLink of link.links) {
-				collectFromLinkEntity(nestedLink);
-			}
-		}
-	};
-
-	// Collect from all link-entities
-	if (fetchQuery.entity.links) {
-		for (const link of fetchQuery.entity.links) {
-			collectFromLinkEntity(link);
-		}
-	}
-
-	return columns;
-}
-
-/**
- * Generate a LayoutXmlConfig from a FetchXML query
- * Used when no layoutxml exists (custom FetchXML)
- */
-export function generateLayoutFromFetchXml(
-	fetchQuery: FetchNode,
-	attributeTypeMap?: Map<string, string>
-): LayoutXmlConfig {
-	const entityName = fetchQuery.entity.name;
-	const columns = collectAttributesFromFetchXml(fetchQuery, attributeTypeMap);
-
-	return {
-		gridName: "resultset",
-		jumpAttribute: columns.length > 0 ? columns[0].name : undefined,
-		enableSelection: true,
-		showIcon: true,
-		enablePreview: true,
-		primaryIdAttribute: `${entityName}id`,
-		columns,
-	};
-}
-
-/**
- * Merge existing layout with FetchXML changes
- * - Keeps existing column widths/order for columns that still exist
- * - Adds new columns from FetchXML at the end
- * - Removes columns no longer in FetchXML
- */
-export function mergeLayoutWithFetchXml(
-	existingConfig: LayoutXmlConfig,
-	fetchQuery: FetchNode,
-	attributeTypeMap?: Map<string, string>
-): LayoutXmlConfig {
-	const fetchColumns = collectAttributesFromFetchXml(fetchQuery, attributeTypeMap);
-	const fetchColumnNames = new Set(fetchColumns.map((c) => c.name));
-	const existingColumnNames = new Set(existingConfig.columns.map((c) => c.name));
-
-	// Keep existing columns that are still in FetchXML (preserves order and width)
-	const mergedColumns: LayoutColumn[] = existingConfig.columns.filter((col) =>
-		fetchColumnNames.has(col.name)
-	);
-
-	// Add new columns from FetchXML that weren't in existing layout
-	for (const col of fetchColumns) {
-		if (!existingColumnNames.has(col.name)) {
-			mergedColumns.push(col);
-		}
-	}
-
-	return {
-		...existingConfig,
-		columns: mergedColumns,
-	};
-}
-
-/**
- * Check if a LayoutXmlConfig matches the FetchXML attributes
- * Returns true if all FetchXML attributes are represented in the layout
- */
-export function isLayoutValidForFetchXml(config: LayoutXmlConfig, fetchQuery: FetchNode): boolean {
-	const fetchColumns = collectAttributesFromFetchXml(fetchQuery);
-	const layoutColumnNames = new Set(config.columns.map((c) => c.name));
-
-	// Check if all FetchXML attributes are in the layout
-	for (const col of fetchColumns) {
-		if (!layoutColumnNames.has(col.name)) {
-			return false;
-		}
-	}
-
-	return true;
-}
-
-/**
- * Update a single column's width in the config
- */
-export function updateColumnWidth(
-	config: LayoutXmlConfig,
-	columnName: string,
-	newWidth: number
-): LayoutXmlConfig {
-	return {
-		...config,
-		columns: config.columns.map((col) =>
-			col.name === columnName ? { ...col, width: newWidth } : col
-		),
-	};
-}
-
-/**
- * Reorder columns in the config
- */
-export function reorderColumns(
-	config: LayoutXmlConfig,
-	fromIndex: number,
-	toIndex: number
-): LayoutXmlConfig {
-	const columns = [...config.columns];
-	const [removed] = columns.splice(fromIndex, 1);
-	columns.splice(toIndex, 0, removed);
-
-	return {
-		...config,
-		columns,
-	};
-}

package/src/features/fetchxml/model/nodes.ts

@@ -1,255 +0,0 @@
-/**
- * TypeScript type definitions for FetchXML Studio tree nodes
- * Based on FetchXML XSD schema with all supported attributes
- */
-
-export type NodeId = string;
-
-/**
- * Root fetch node - top level query configuration
- */
-export interface FetchNode {
-	id: NodeId;
-	type: "fetch";
-	entity: EntityNode;
-	options: {
-		aggregate?: boolean;
-		distinct?: boolean;
-		top?: number;
-		count?: number;
-		page?: number;
-		pagingCookie?: string;
-		returnTotalRecordCount?: boolean;
-		noLock?: boolean;
-		utcOffset?: number;
-		latematerialize?: boolean;
-		// Query optimization hints
-		hints?: {
-			forceOrder?: boolean;
-			disableRowGoal?: boolean;
-			enableOptimizerHotfixes?: boolean;
-			loopJoin?: boolean;
-			mergeJoin?: boolean;
-			hashJoin?: boolean;
-			noPerformanceSpool?: boolean;
-			enableHistAmendmentForAscKeys?: boolean;
-		};
-	};
-}
-
-/**
- * Entity node - the root or linked table being queried
- */
-export interface EntityNode {
-	id: NodeId;
-	type: "entity";
-	name: string; // logical name (e.g., 'account', 'contact')
-	enablePrefiltering?: boolean;
-	prefilterParameterName?: string;
-	allAttributes?: AllAttributesNode;
-	attributes: AttributeNode[];
-	orders: OrderNode[];
-	filters: FilterNode[];
-	links: LinkEntityNode[];
-}
-
-/**
- * All-Attributes node - select all columns from entity
- */
-export interface AllAttributesNode {
-	id: NodeId;
-	type: "all-attributes";
-	enabled: boolean; // toggle to include/exclude all attributes
-}
-
-/**
- * Attribute node - individual column selection
- */
-export interface AttributeNode {
-	id: NodeId;
-	type: "attribute";
-	name: string; // logical attribute name
-	alias?: string;
-	groupby?: boolean;
-	aggregate?: "sum" | "count" | "countcolumn" | "min" | "max" | "avg" | "rowaggregate";
-	usertimezone?: boolean;
-	dategrouping?: "day" | "week" | "month" | "quarter" | "year" | "fiscal-period" | "fiscal-year";
-}
-
-/**
- * Order node - sorting specification
- */
-export interface OrderNode {
-	id: NodeId;
-	type: "order";
-	attribute: string; // logical attribute name
-	descending?: boolean;
-	entityname?: string; // for link-entity attributes, references the link alias
-}
-
-/**
- * Filter node - logical grouping of conditions
- */
-export interface FilterNode {
-	id: NodeId;
-	type: "filter";
-	conjunction: "and" | "or"; // filter type
-	hint?: "union"; // optimization hint for multi-table filters
-	conditions: ConditionNode[];
-	subfilters: FilterNode[]; // nested filters
-	links: LinkEntityNode[]; // link-entities inside filter (for any/not any/all/not all)
-}
-
-/**
- * Condition node - individual filter criteria
- */
-export interface ConditionNode {
-	id: NodeId;
-	type: "condition";
-	attribute: string; // logical attribute name
-	operator: OperatorType;
-	value?: string | number | boolean | (string | number)[] | null; // arrays for in/not-in operators
-	aggregate?: "sum" | "count" | "countcolumn" | "min" | "max" | "avg"; // for aggregate filtering
-	entityname?: string; // for link-entity filters, references the entity/link alias
-	valueof?: string; // for cross-table column comparisons (references another attribute)
-}
-
-/**
- * Link-Entity node - join to related table
- */
-export interface LinkEntityNode {
-	id: NodeId;
-	type: "link-entity";
-	name: string; // related entity logical name
-	from: string; // attribute on related entity
-	to: string; // attribute on current entity
-	linkType: LinkType;
-	alias?: string;
-	intersect?: boolean; // for N:N relationships
-	visible?: boolean; // include in query results
-	relationshipType?: "1N" | "N1" | "NN"; // metadata hint for UI
-	allAttributes?: AllAttributesNode;
-	attributes: AttributeNode[];
-	orders: OrderNode[];
-	filters: FilterNode[];
-	links: LinkEntityNode[]; // nested link-entities (max 15 total depth)
-}
-
-/**
- * Link types supported by FetchXML
- */
-export type LinkType =
-	| "inner" // Inner join (default)
-	| "outer" // Left outer join
-	| "any" // Exists with ANY match in related
-	| "not any" // NOT EXISTS with any match
-	| "all" // ALL records match
-	| "not all" // NOT ALL records match
-	| "exists" // EXISTS (semi-join)
-	| "in" // IN (similar to exists)
-	| "matchfirstrowusingcrossapply"; // CROSS APPLY for first match
-
-/**
- * FetchXML operators (60+ supported)
- * Applicability depends on attribute type
- */
-export type OperatorType =
-	// Comparison operators (all types)
-	| "eq"
-	| "ne"
-	| "gt"
-	| "ge"
-	| "lt"
-	| "le"
-	// Null checks (all types)
-	| "null"
-	| "not-null"
-	// String operators
-	| "like"
-	| "not-like"
-	| "begins-with"
-	| "not-begin-with"
-	| "ends-with"
-	| "not-end-with"
-	// Collection operators
-	| "in"
-	| "not-in"
-	| "between"
-	| "not-between"
-	| "contain-values"
-	| "not-contain-values" // for multi-select picklist
-	// Date relative operators
-	| "yesterday"
-	| "today"
-	| "tomorrow"
-	| "last-seven-days"
-	| "last-week"
-	| "this-week"
-	| "next-week"
-	| "next-seven-days"
-	| "last-month"
-	| "this-month"
-	| "next-month"
-	| "last-year"
-	| "this-year"
-	| "next-year"
-	| "on"
-	| "on-or-before"
-	| "on-or-after"
-	// Date range operators (require integer value for 'x')
-	| "last-x-hours"
-	| "next-x-hours"
-	| "last-x-days"
-	| "next-x-days"
-	| "last-x-weeks"
-	| "next-x-weeks"
-	| "last-x-months"
-	| "next-x-months"
-	| "last-x-years"
-	| "next-x-years"
-	| "olderthan-x-minutes"
-	| "olderthan-x-hours"
-	| "olderthan-x-days"
-	| "olderthan-x-weeks"
-	| "olderthan-x-months"
-	| "olderthan-x-years"
-	// Fiscal period operators
-	| "this-fiscal-year"
-	| "this-fiscal-period"
-	| "next-fiscal-year"
-	| "next-fiscal-period"
-	| "last-fiscal-year"
-	| "last-fiscal-period"
-	| "last-x-fiscal-years"
-	| "last-x-fiscal-periods"
-	| "next-x-fiscal-years"
-	| "next-x-fiscal-periods"
-	| "in-fiscal-year"
-	| "in-fiscal-period"
-	| "in-fiscal-period-and-year"
-	| "in-or-before-fiscal-period-and-year"
-	| "in-or-after-fiscal-period-and-year"
-	// User/Business unit operators (for Lookup to systemuser/businessunit)
-	| "eq-userid"
-	| "ne-userid"
-	| "eq-userteams"
-	| "eq-useroruserteams"
-	| "eq-useroruserhierarchy"
-	| "eq-useroruserhierarchyandteams"
-	| "eq-businessid"
-	| "ne-businessid"
-	| "eq-userlanguage"
-	// Hierarchy operators (for hierarchical lookups)
-	| "under"
-	| "eq-or-under"
-	| "not-under"
-	| "above"
-	| "eq-or-above";
-
-/**
- * Value node - for operators that accept multiple values (e.g., 'in')
- * Not a tree node, but used in FetchXML generation
- */
-export interface ValueNode {
-	value: string | number | boolean;
-}