@zealicsolutions/web-ui 1.0.140-beta.151 → 1.0.140-beta.153

package/dist/cjs/helpers/utils.d.ts

@@ -58,19 +58,40 @@ export interface ResolvedDataDrivenLink {
 /**
  * Resolves a data-driven link to its destination and determines navigation type
  *
+ * ## Data-Driven Link Resolution
+ *
+ * ### Link Type Detection
+ * The `dataDrivenLinkType` field references a picklist value: `{ id, code, label }`
+ * - Internal: `code === "internal"` or `label === "Internal"`
+ * - External: `code === "external"` or `label === "External"`
+ *
+ * ### Internal Links
+ * Uses `internalLinkFieldId` to get the target page ID:
+ * - Extracts `.id` from the field value (NOT `.value`)
+ * - This ID should match `webpage.internalTaskTagId` in the host app
+ * - Host app resolves the webpage by: `appPages.find(p => p.internalTaskTagId === id)`
+ *
+ * ### External Links
+ * Uses `externalLinkFieldId` to get the URL:
+ * - Extracts `.value` from the field value (the actual URL string)
+ * - Opens in a new tab
+ * - Logs error if URL is invalid
+ *
  * @param link - The LinkProperties object
- * @param rawItemDataByDmfId - DMF data from container runtime context
+ * @param rawItemDataByDmfId - DMF data from container runtime context or local state
  * @returns Resolved link details or null if link cannot be resolved (disabled state)
  *
  * @example
  * // External URL
- * const result = resolveDataDrivenLink(link, { urlField: 'https://example.com' });
+ * // Data: { externalLinkFieldId: { value: 'https://example.com' } }
+ * const result = resolveDataDrivenLink(link, data);
  * // Returns: { destination: 'https://example.com', isExternal: true }
  *
  * @example
- * // Internal page with record ID
- * const result = resolveDataDrivenLink(link, { pageField: 'study-details', idField: 'S-001' });
- * // Returns: { destination: '?webpageId=study-details', isExternal: false, recordId: 'S-001' }
+ * // Internal page with internalTaskTagId
+ * // Data: { internalLinkFieldId: { id: '777a77bc-a0d4-4bdd-933b-9a343daa7891' } }
+ * const result = resolveDataDrivenLink(link, data);
+ * // Returns: { destination: '?internalTaskTagId=777a77bc-...', isExternal: false, internalTaskTagId: '777a77bc-...' }
  */
 export declare const resolveDataDrivenLink: (link: LinkProperties, rawItemDataByDmfId: Record<string, unknown> | undefined) => ResolvedDataDrivenLink | null;
 export declare const addInternalParamsToCurrentLink: (internalLink?: Nullable<string>, isPreview?: boolean) => string | undefined;