@pega/custom-dx-components 26.1.11 → 26.1.12-alpha.0.2

package/src/ai/catalog/references/pconnect-case-validation-utilities.md

@@ -0,0 +1,238 @@
+# PConnect: Case & Data Info, Validation Checks, Sub-API Access Points
+
+> Part of the [PCore / PConnect API Reference skills](../README.md). Methods documented here are called on a `PConnect` instance (`pConn`), obtained via the `getPConnect()` prop passed to every component.
+>
+> `getActionsApi()`, `getValidationApi()`, `getContainerManager()`, `getCaseInfo()`, `getDataInfo()`, and `getListActions()` are accessors only — see [pconnect-actions-api.md](./pconnect-actions-api.md), [pconnect-validation-api.md](./pconnect-validation-api.md), [pconnect-container-manager.md](./pconnect-container-manager.md), [pconnect-case-info-data-info-localization.md](./pconnect-case-info-data-info-localization.md), and [pconnect-list-actions.md](./pconnect-list-actions.md) for the full method catalogs of the objects they return.
+
+## `getCaseInfo()`
+
+**Purpose:** Returns a `CaseInfo` instance for the case bound to the current context — the entry point for case-level accessors (ID, class name, key, business ID, stages, and so on).
+
+**Signature:**
+
+```typescript
+getCaseInfo(): CaseInfo
+```
+
+**Example:**
+
+```typescript
+const caseId = pConn.getCaseInfo().getBusinessID();
+```
+
+**Notes:** See [pconnect-case-info-data-info-localization.md](./pconnect-case-info-data-info-localization.md) for the full `CaseInfo` method catalog.
+
+---
+
+## `getDataInfo()`
+
+**Purpose:** Returns a `DataInfo` instance for the data object bound to the current context.
+
+**Signature:**
+
+```typescript
+getDataInfo(): DataInfo
+```
+
+**Example:**
+
+```typescript
+const contextKey = pConn.getDataInfo().getContextKey();
+```
+
+**Notes:** See [pconnect-case-info-data-info-localization.md](./pconnect-case-info-data-info-localization.md) for the full `DataInfo` method catalog.
+
+---
+
+## `getCaseSummary()`
+
+**Purpose:** Returns a snapshot of case summary information (case ID, urgency, class, name, and related metadata). Per the typedefs the object has `caseID` (the case ID), `ID` (the **assignment** ID, for example `ASSIGN-WORKLIST ... !FLOW`), `caseClass`, `name`, `urgency`, `routedTo` and `isCaseWideAction()`.
+
+**Signature:**
+
+```typescript
+getCaseSummary(): Record<string, unknown>
+```
+
+**Example:**
+
+```typescript
+const caseId = pConn.getCaseSummary().caseID; // `.ID` is the assignment ID, not the case ID
+```
+
+---
+
+## `getReferencedUser(userId)`
+
+**Purpose:** Looks up a referenced user (from the view's referenced-users data) by user identifier.
+
+**Signature:**
+
+```typescript
+getReferencedUser(userId: string): { userId: string; UserName: string } | null
+```
+
+**Example:**
+
+```typescript
+const userName = pConn.getReferencedUser(userId)?.UserName;
+```
+
+---
+
+## `getCaseStages()`
+
+**Purpose:** Returns the case's stages, read directly from the current case's data in state.
+
+**Signature:**
+
+```typescript
+getCaseStages(): unknown[]
+```
+
+**Example:**
+
+```typescript
+const stages = pConn.getCaseStages();
+```
+
+**Notes:** This is distinct from `CaseInfo.getCaseStages(caseID, contextName)` (a different method, on the sub-API returned by [`getCaseInfo()`](#getcaseinfo)), which fetches stage data asynchronously from the server — see [pconnect-case-info-data-info-localization.md](./pconnect-case-info-data-info-localization.md).
+
+---
+
+## `getStageID()`
+
+**Purpose:** Returns the current stage ID, read directly from the current case's data in state.
+
+**Signature:**
+
+```typescript
+getStageID(): string
+```
+
+**Example:**
+
+```typescript
+const stageID = pConn.getStageID();
+```
+
+---
+
+## `isConditionExist()`
+
+**Purpose:** Returns `true` if the component has an expression or a "when" condition configured.
+
+**Signature:**
+
+```typescript
+isConditionExist(): boolean
+```
+
+**Example:**
+
+```typescript
+if (pConn.isConditionExist()) {
+  // this component's visibility/value depends on a condition
+}
+```
+
+---
+
+## `isBoundToState()`
+
+**Purpose:** Returns `true` if the component has any property reference bound to it.
+
+**Signature:**
+
+```typescript
+isBoundToState(): boolean
+```
+
+**Example:**
+
+```typescript
+if (pConn.isBoundToState()) {
+  // component reads/writes a state-bound property
+}
+```
+
+---
+
+## `getValidationApi()`
+
+**Purpose:** Returns a `ValidationApi` instance used to validate the current field.
+
+**Signature:**
+
+```typescript
+getValidationApi(): ValidationApi
+```
+
+**Example:**
+
+```typescript
+const result = pConn.getValidationApi().validate(inputValue);
+```
+
+**Notes:** See [pconnect-validation-api.md](./pconnect-validation-api.md) for the full method catalog.
+
+---
+
+## `getActionsApi()`
+
+**Purpose:** Returns an `ActionsApi` instance used to dispatch case/work-level operations.
+
+**Signature:**
+
+```typescript
+getActionsApi(): ActionsApi
+```
+
+**Example:**
+
+```typescript
+const actionsApi = pConn.getActionsApi();
+```
+
+**Notes:** See [pconnect-actions-api.md](./pconnect-actions-api.md) for the full `ActionsApi` method catalog.
+
+---
+
+## `getContainerManager()`
+
+**Purpose:** Returns a `ContainerManager` instance used to manage the items within a container region.
+
+**Signature:**
+
+```typescript
+getContainerManager(): ContainerManager
+```
+
+**Example:**
+
+```typescript
+const containerManager = pConn.getContainerManager();
+```
+
+**Notes:** See [pconnect-container-manager.md](./pconnect-container-manager.md) for the full method catalog.
+
+---
+
+## `getListActions()`
+
+**Purpose:** Returns a `ListActions` instance with APIs for list-related operations (insert, delete, reorder, and selection) on components bound to page-list data.
+
+**Signature:**
+
+```typescript
+getListActions(): ListActions
+```
+
+**Example:**
+
+```typescript
+const listActions = pConn.getListActions();
+const selectedRows = await listActions.getSelectedRows(true);
+```
+
+**Notes:** See [pconnect-list-actions.md](./pconnect-list-actions.md) for the full `ListActions` method catalog.

package/src/ai/catalog/references/pconnect-container-manager.md

@@ -0,0 +1,215 @@
+# ContainerManager
+
+> Part of the [PCore / PConnect API Reference skills](../README.md). Obtained via `pConn.getContainerManager()`.
+
+## `initializeContainers(containerInfo)`
+
+**Purpose:** Initializes a container (single or multiple type) within a complex component.
+
+**Signature:**
+
+```typescript
+initializeContainers(containerInfo: { type?: 'single' | 'multiple'; name?: string }): Promise<unknown>
+```
+
+**Example:**
+
+```typescript
+await pConn.getContainerManager().initializeContainers({ type: 'single', name: containerName });
+```
+
+---
+
+## `addContainerItem(containerInfo)`
+
+**Purpose:** Adds an item to a container.
+
+**Signature:**
+
+```typescript
+addContainerItem(containerInfo: {
+  context?: string;
+  semanticURL?: string;
+  containerItemID?: string | null;
+  target?: string;
+  caseViewMode?: string;
+  data?: { coreHeaders?: unknown; classID?: string };
+}): Promise<unknown>
+```
+
+**Example:**
+
+```typescript
+await pConn.getContainerManager().addContainerItem({ context, semanticURL: '' });
+```
+
+---
+
+## `updateContainerItem(containerInfo)`
+
+**Purpose:** Updates the data of an existing item within a container.
+
+**Signature:**
+
+```typescript
+updateContainerItem(containerInfo: { context: string; key?: string; target?: string; data?: Record<string, unknown> }): Promise<unknown>
+```
+
+**Example:**
+
+```typescript
+await pConn.getContainerManager().updateContainerItem({ context: containerItemID, data: { caseInfo } });
+```
+
+---
+
+## `activateContainerItem(containerInfo)`
+
+**Purpose:** Activates a specific item within a container (for example, bringing a modal/tab item to the foreground).
+
+**Signature:**
+
+```typescript
+activateContainerItem(containerInfo: { containerItemID: string; context?: string }): Promise<unknown>
+```
+
+**Example:**
+
+```typescript
+await pConn.getContainerManager().activateContainerItem({ containerItemID });
+```
+
+---
+
+## `removeContainerItem(containerInfo)`
+
+**Purpose:** Removes an item from a container.
+
+**Signature:**
+
+```typescript
+removeContainerItem(containerInfo: { containerItemID: string; skipReleaseLockRequest?: boolean }): Promise<unknown>
+```
+
+**Example:**
+
+```typescript
+await pConn.getContainerManager().removeContainerItem({ containerItemID });
+```
+
+---
+
+## `resetContainers(containerInfo)`
+
+**Purpose:** Resets a container (or containers) back to its initial state.
+
+**Signature:**
+
+```typescript
+resetContainers(containerInfo: { name: string; context: string }): Promise<unknown>
+```
+
+**Example:**
+
+```typescript
+await pConn.getContainerManager().resetContainers({ name: 'preview', context: 'app' });
+```
+
+---
+
+## `addTransientItem(containerInfo)`
+
+**Purpose:** Adds a transient item to a container — used to hold values (for example, search filters or inline-edit staging data) that should not be submitted with the case's regular content.
+
+**Signature:**
+
+```typescript
+addTransientItem(containerInfo: { id: string; sourceContainerItemId?: string }): string
+```
+
+**Example:**
+
+```typescript
+const transientId = pConn.getContainerManager().addTransientItem({
+  id: 'InlineEdit',
+  sourceContainerItemId: pConn.getContextName()
+});
+```
+
+**Notes:** Returns the newly created transient item's ID synchronously (not a `Promise`).
+
+---
+
+## `updateTransientData(transientObject)`
+
+**Purpose:** Updates the data held by a transient item.
+
+**Signature:**
+
+```typescript
+updateTransientData(transientObject: { transientItemID: string; data: Record<string, unknown> }): void
+```
+
+**Example:**
+
+```typescript
+pConn.getContainerManager().updateTransientData({ transientItemID, data: { comment } });
+```
+
+---
+
+## `removeTransientItem(transientItemInfo)`
+
+**Purpose:** Removes a transient item.
+
+**Signature:**
+
+```typescript
+removeTransientItem(transientItemInfo: { transientItemID: string }): void
+```
+
+**Example:**
+
+```typescript
+pConn.getContainerManager().removeTransientItem({ transientItemID });
+```
+
+---
+
+## `hasContainerItems()`
+
+**Purpose:** Checks whether the container has any items.
+
+**Signature:**
+
+```typescript
+hasContainerItems(): boolean
+```
+
+**Example:**
+
+```typescript
+if (pConn.getContainerManager().hasContainerItems()) {
+  // container has at least one item
+}
+```
+
+---
+
+## `isContainerInitialized()`
+
+**Purpose:** Checks whether the container has been initialized.
+
+**Signature:**
+
+```typescript
+isContainerInitialized(): boolean
+```
+
+**Example:**
+
+```typescript
+if (!pConn.getContainerManager().isContainerInitialized()) {
+  pConn.getContainerManager().initializeContainers({ type: 'single', name: containerName });
+}
+```

package/src/ai/catalog/references/pconnect-list-actions.md

@@ -0,0 +1,250 @@
+# ListActions
+
+> Part of the [PCore / PConnect API Reference skills](../README.md). Obtained via `pConn.getListActions()`. Used by components that render and edit page-list (repeating) data — tables, lists, and embedded-data grids.
+
+## `insert(payload, index, pageRef?, options?)`
+
+**Purpose:** Inserts a new row into the referenced list at the given index.
+
+**Signature:**
+
+```typescript
+insert(
+  payload: object,
+  index: number,
+  pageRef?: string,
+  options?: { skipStateUpdate?: boolean; insertIfEmpty?: boolean; skipDirtyValidation?: boolean }
+): void
+```
+
+**Example:**
+
+```typescript
+pConn.getListActions().insert({ Name: 'New Employee' }, 0);
+```
+
+---
+
+## `update(payload, index, options?)`
+
+**Purpose:** Updates an existing row at the given index in the referenced list.
+
+**Signature:**
+
+```typescript
+update(payload: object, index: number, options?: { pageRef?: string; skipStateUpdate?: boolean }): void
+```
+
+**Example:**
+
+```typescript
+pConn.getListActions().update({ Name: 'John', Experience: 2 }, 0);
+```
+
+---
+
+## `updateProperty(propertyName, value, options?)`
+
+**Purpose:** Updates a single field within a row of the referenced list (rather than the whole row).
+
+**Signature:**
+
+```typescript
+updateProperty(
+  propertyName: string | undefined,
+  value: GenericObject | undefined,
+  options?: { skipStateUpdate?: boolean; isArrayDeepMerge?: boolean; skipDirtyValidation?: boolean }
+): void
+```
+
+**Example:**
+
+```typescript
+pConn.getListActions().updateProperty('.Name', 'John Doe' as unknown as GenericObject);
+```
+
+**Notes:** `GenericObject` is `Record<string, unknown>`. The 5.1.0 typedefs type `value` as `GenericObject | undefined`, even though the typedef's own example passes a string; a primitive therefore needs a cast to compile (as in the example above).
+
+---
+
+## `deleteEntry(index, pageRef?, options?)`
+
+**Purpose:** Deletes the row at the given index in the referenced list.
+
+**Signature:**
+
+```typescript
+deleteEntry(index: number, pageRef?: string, options?: { skipStateUpdate?: boolean }): void
+```
+
+**Example:**
+
+```typescript
+pConn.getListActions().deleteEntry(0);
+```
+
+---
+
+## `reorder(fromIndex, toIndex)`
+
+**Purpose:** Moves a row from one position to another within the referenced list.
+
+**Signature:**
+
+```typescript
+reorder(fromIndex: number, toIndex: number): void
+```
+
+**Example:**
+
+```typescript
+pConn.getListActions().reorder(1, 0);
+```
+
+---
+
+## `setSelectedRows(rows, options?)`
+
+**Purpose:** Marks a set of rows as selected/deselected in application state.
+
+**Signature:**
+
+```typescript
+setSelectedRows(rows: Record<string, unknown>[], options?: { skipPageInstructions: boolean }): Promise<void>
+```
+
+**Example:**
+
+```typescript
+await pConn.getListActions().setSelectedRows([{ $key: rowKey, $selected: true, Name: 'Alice' }]);
+```
+
+---
+
+## `getSelectedRows(withPayload?)`
+
+**Purpose:** Returns the currently selected rows in the referenced list.
+
+**Signature:**
+
+```typescript
+getSelectedRows(withPayload?: boolean): Promise<string[] | object[]>
+```
+
+**Example:**
+
+```typescript
+const selectedRows = await pConn.getListActions().getSelectedRows(true);
+```
+
+**Notes:** When `withPayload` is `false` (the default), resolves to a `string[]` of the selected rows' unique keys; when `true`, resolves to an `object[]` of the full row data.
+
+---
+
+## `clearSelectedRows()`
+
+**Purpose:** Deselects all currently selected rows.
+
+**Signature:**
+
+```typescript
+clearSelectedRows(): Promise<void>
+```
+
+**Example:**
+
+```typescript
+await pConn.getListActions().clearSelectedRows();
+```
+
+---
+
+## `setVisibility(isVisible)`
+
+**Purpose:** Informs the framework whether the referenced editable list is currently mounted on screen, which controls whether page instructions are generated for it.
+
+**Signature:**
+
+```typescript
+setVisibility(isVisible: boolean): void
+```
+
+**Example:**
+
+```typescript
+pConn.getListActions().setVisibility(true);
+```
+
+---
+
+## `initDefaultPageInstructions(property, propertyNames, uniqueField?)`
+
+**Purpose:** Registers update instructions for a list's existing (already-populated) rows, for fields that need to be included in the submit payload.
+
+**Signature:**
+
+```typescript
+initDefaultPageInstructions(property: string, propertyNames: string[], uniqueField?: string): void
+```
+
+**Example:**
+
+```typescript
+pConn.getListActions().initDefaultPageInstructions('.Employees', ['pyGUID', 'pyName'], '.EmbedListUUID__');
+```
+
+---
+
+## `deleteAll(property, options?)`
+
+**Purpose:** Deletes every row from the referenced list.
+
+**Signature:**
+
+```typescript
+deleteAll(property: string, options?: { skipStateUpdate?: boolean }): void
+```
+
+**Example:**
+
+```typescript
+pConn.getListActions().deleteAll('.ShippingAddress');
+```
+
+---
+
+## `replacePage(property, payload, options?)`
+
+**Purpose:** Replaces the data of an embedded page property, resetting its associated fields.
+
+**Signature:**
+
+```typescript
+replacePage(property: string, payload: object, options?: { skipStateUpdate?: boolean }): void
+```
+
+**Example:**
+
+```typescript
+pConn.getListActions().replacePage('.ShippingAddress', { pyCountry: 'US' });
+```
+
+**Notes:** Commonly used for an address field when the country changes and dependent fields (state/province) must reset.
+
+---
+
+## `deletePage(property, options?)`
+
+**Purpose:** Deletes an embedded page property.
+
+**Signature:**
+
+```typescript
+deletePage(property: string, options?: { skipStateUpdate?: boolean }): void
+```
+
+**Example:**
+
+```typescript
+pConn.getListActions().deletePage('.ShippingAddress');
+```