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

package/src/ai/catalog/references/pcore-case-collaboration-genai.md

@@ -0,0 +1,264 @@
+# PCore: Case Utilities, Collaboration & GenAI
+
+> Part of the [PCore / PConnect API Reference skills](../README.md). See [pcore-case-collaboration-details.md](./pcore-case-collaboration-details.md) and [pcore-analytics-genai-details.md](./pcore-analytics-genai-details.md) for the full method catalogs of the objects these accessors return.
+
+## `getContainerUtils()`
+
+**Purpose:** Container management APIs — inspecting container state (`getContainers`, `getContainerData`, `isContainerInitialized`, and related helpers).
+
+**Signature:**
+
+```typescript
+getContainerUtils(): ContainerUtils
+```
+
+**Example:**
+
+```typescript
+const isInitialized = PCore.getContainerUtils().isContainerInitialized(context, containerName);
+```
+
+---
+
+## `getAttachmentUtils()`
+
+**Purpose:** Utility APIs to manage a case's attachments (`uploadAttachment`, `downloadAttachment`, `linkAttachmentsToCase`, `getCaseAttachments`, and others).
+
+**Signature:**
+
+```typescript
+getAttachmentUtils(): AttachmentUtils
+```
+
+**Example:**
+
+```typescript
+const { uploadAttachment } = PCore.getAttachmentUtils();
+await uploadAttachment(file, onUploadProgress, errorHandler, context, caseID);
+```
+
+**Notes:** Most `AttachmentUtils` methods return a `Promise`.
+
+---
+
+## `getFeedUtils()`
+
+**Purpose:** APIs to manage a case's feed/pulse (`postMessage`, `getFeeds`, `editMessage`, `likeMessage`, `deleteMessage`, and others).
+
+**Signature:**
+
+```typescript
+getFeedUtils(): FeedUtils
+```
+
+**Example:**
+
+```typescript
+await PCore.getFeedUtils().postMessage(context, 'Reviewed and approved.', pConn);
+```
+
+---
+
+## `getTagUtils()`
+
+**Purpose:** APIs to manage a case's tags (`getTaggedCases`, `getTags`, `postTags`, `removeTag`, `getTagsLandingPageURL`).
+
+**Signature:**
+
+```typescript
+getTagUtils(): TagUtils
+```
+
+**Example:**
+
+```typescript
+const { getTags, postTags } = PCore.getTagUtils();
+const tags = await getTags(caseID, pConn);
+```
+
+---
+
+## `getStakeholderUtils()`
+
+**Purpose:** APIs to manage a case's participants (`getParticipants`, `getRoleView`, `getParticipantRoles`, `getParticipant`, `createParticipant`, `updateParticipant`, `deleteParticipant`).
+
+**Signature:**
+
+```typescript
+getStakeholderUtils(): StakeholderUtils
+```
+
+**Example:**
+
+```typescript
+const participant = await PCore.getStakeholderUtils().getParticipant(caseID, participantID, pConn);
+```
+
+---
+
+## `getUserApi()`
+
+**Purpose:** APIs to retrieve user/operator data.
+
+**Signature:**
+
+```typescript
+getUserApi(): UserApi
+```
+
+**Example:**
+
+```typescript
+// The typedefs type the result as a bare `object`; at runtime it is an Axios-style response, so cast to read `.data`.
+const { data } = (await PCore.getUserApi().getOperatorDetails(operatorID)) as { data: Record<string, unknown> };
+```
+
+---
+
+## `getCaseFollowerApi()`
+
+**Purpose:** APIs to manage a case's followers (`addCaseFollower`, `deleteCaseFollower`, `getCaseFollowers`).
+
+**Signature:**
+
+```typescript
+getCaseFollowerApi(): CaseFollowerApi
+```
+
+**Example:**
+
+```typescript
+const { addCaseFollower, getCaseFollowers } = PCore.getCaseFollowerApi();
+await addCaseFollower(caseID, [userID], context);
+```
+
+---
+
+## `getCaseUtils()`
+
+**Purpose:** Case-related utility checks (`isCaseActive`, `isExternalCaseType`, `isObjectCaseType`, and related helpers).
+
+**Signature:**
+
+```typescript
+getCaseUtils(): CaseUtils
+```
+
+**Example:**
+
+```typescript
+const isObjectType = PCore.getCaseUtils().isObjectCaseType(caseClassName);
+```
+
+---
+
+## `getRelatedCasesApi()`
+
+**Purpose:** APIs to manage a case's related cases (`addRelatedCases`, `removeRelatedCase`, `getRelatedCases`).
+
+**Signature:**
+
+```typescript
+getRelatedCasesApi(): RelatedCasesApi
+```
+
+**Example:**
+
+```typescript
+const { getRelatedCases } = PCore.getRelatedCasesApi();
+const relatedCases = await getRelatedCases(caseID, context);
+```
+
+---
+
+## `getGenAIAssistantUtils()`
+
+**Purpose:** APIs for the GenAI Assistant conversational experience (`createConversation`, `sendMessage`, `getConversations`, `getMessages`, `getCoach`, `getAgent`, and related agent-scoped variants).
+
+**Signature:**
+
+```typescript
+getGenAIAssistantUtils(): GenAIAssistantUtils
+```
+
+**Example:**
+
+```typescript
+const { createConversation, sendMessage } = PCore.getGenAIAssistantUtils();
+const conversation = await createConversation(contextID, assistantID, context);
+await sendMessage(assistantID, conversation.data.ID, userMessage, context);
+```
+
+**Notes:** Message/conversation APIs return `Promise`s. `createConversation` resolves to `{ data: { ID, response, ... } }`, so the conversation ID is `conversation.data.ID`; `getMessages`/`sendMessage` resolve to an Axios response (payload on `.data`). `sendMessage` accepts an optional trailing `config` (`{ enableStreaming: boolean; ... }`).
+
+---
+
+## `getGenAIUtils()`
+
+**Purpose:** APIs for GenAI text operations, such as rewriting text.
+
+**Signature:**
+
+```typescript
+getGenAIUtils(): GenAIUtils
+```
+
+**Example:**
+
+```typescript
+if (PCore.getEnvironmentInfo().isGenAIEnabled()) {
+  const result = await PCore.getGenAIUtils().rewriteText({
+    originalText,
+    rewriteAction: 'Improve'
+  });
+  if (result.success) {
+    // use result.rewrittenText
+  }
+}
+```
+
+**Notes:** Check `PCore.getEnvironmentInfo().isGenAIEnabled()` first; `rewriteText()` resolves a discriminated union — handle the `success: false` case.
+
+---
+
+## `getAnalyticsUtils()`
+
+**Purpose:** Analytics/insight APIs (`getInsightIDs`, `getInsightByID`, `createInsight`, `exportToExcel`, `exportToCSV`, and others). All methods return a `Promise`.
+
+**Signature:**
+
+```typescript
+getAnalyticsUtils(): AnalyticsUtils
+```
+
+**Example:**
+
+```typescript
+const insightIDs = await PCore.getAnalyticsUtils().getInsightIDs();
+```
+
+---
+
+## `getPersonalizationUtils(listID)`
+
+**Purpose:** APIs to manage saved personalization instances (view/filter/sort configurations) for a list component.
+
+**Signature:**
+
+```typescript
+getPersonalizationUtils(listID: string): {
+  createPersonalization: (personalizationID: string, personalizedState: CreatePersonalizationInfo) => Promise<AxiosResponse<string>>;
+  updatePersonalization: (personalizationID: string, personalizedState: CreatePersonalizationInfo) => Promise<AxiosResponse<string>>;
+  deletePersonalization: (personalizationID: string) => Promise<AxiosResponse<string>>;
+  fetchPersonalizations: () => Promise<PersonalizationStore | AxiosResponse<PersonalizationStore>>;
+}
+```
+
+**Example:**
+
+```typescript
+const personalizationUtils = PCore.getPersonalizationUtils(listComponentID);
+const savedViews = await personalizationUtils.fetchPersonalizations();
+```
+
+**Notes:** `listID` should be limited to 32 characters. If `listID` is falsy, the returned methods are safe no-op stubs rather than throwing.

package/src/ai/catalog/references/pcore-environment-info-details.md

@@ -0,0 +1,96 @@
+# EnvironmentInfo, LocaleUtils & AuthUtils — Method Details
+
+> Part of the [PCore / PConnect API Reference skills](../README.md). Companion to [pcore-environment-locale-namespace.md](./pcore-environment-locale-namespace.md), which covers the top-level `PCore.get*()` accessors. This file catalogs the methods available on the objects those accessors return.
+>
+> This is a curated subset — methods that are purely internal bootstrap/theme-branding plumbing are intentionally omitted.
+
+## EnvironmentInfo (via `PCore.getEnvironmentInfo()`)
+
+| Method                      | Signature                                                          | Purpose                                                                   |
+| --------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------- |
+| `getLocale()`               | `(): string \| undefined`                                          | Returns the current operator locale.                                      |
+| `getTimeZone()`             | `(): string \| undefined`                                          | Returns the application's configured time zone.                           |
+| `getOperatorIdentifier()`   | `(): string \| undefined`                                          | Returns the current operator's identifier.                                |
+| `getOperatorName()`         | `(): string \| undefined`                                          | Returns the current operator's user name.                                 |
+| `getApplicationName()`      | `(): string \| undefined`                                          | Returns the application name.                                             |
+| `getApplicationLabel()`     | `(): string \| undefined`                                          | Returns the localized application label.                                  |
+| `getApplicationID()`        | `(): string \| undefined`                                          | Returns the application ID.                                               |
+| `getAccessGroup()`          | `(): string \| undefined`                                          | Returns the operator's access group.                                      |
+| `getPortalName()`           | `(): string \| undefined`                                          | Returns the current portal name.                                          |
+| `getRenderingMode()`        | `(): string \| undefined`                                          | Returns the rendering mode (`FULL_PORTAL`, `EMBED`, `HYBRID`, `PREVIEW`). |
+| `getFeatureMap()`           | `(): Record<string, unknown>`                                      | Returns the configured application feature-flag overrides.                |
+| `isWSSPortal()`             | `(): boolean`                                                      | Checks whether the current portal is a WSS (self-service) type.           |
+| `isInfinityRuntime()`       | `(): boolean`                                                      | Returns whether the runtime is Pega Infinity (as opposed to Launchpad).   |
+| `isGenAIEnabled()`          | `(): boolean`                                                      | Returns whether the GenAI feature is enabled for the application.         |
+| `isPegaMobile()`            | `(): boolean`                                                      | Checks whether the app is running inside the Pega Mobile shell.           |
+| `getMaxAttachmentSize()`    | `(): number \| undefined`                                          | Returns the system-configured attachment size limit, in MB.               |
+| `getTheme(options?)`        | `(options?: { type: 'light' \| 'dark' }): unknown`                 | Returns theme overrides for light or dark mode.                           |
+| `setTheme(theme, options?)` | `(theme: unknown, options?: { type: 'light' \| 'dark' }): unknown` | Updates theme overrides for light or dark mode.                           |
+| `getBaseLocale()`           | `(): string`                                                       | Returns the base locale string (defaults to `'en-US'`).                   |
+| `getKeyMapping(keyValue)`   | `(keyValue: string): string \| null`                               | Returns the Launchpad-namespaced identifier for a given key.              |
+| `getRuntime()`              | `(): 'Browser' \| 'Native'`                                        | Returns the runtime environment type.                                     |
+| `getCaseTypeList()`         | `(): unknown[]`                                                    | Returns the list of case types available in the application.              |
+
+**Example:**
+
+```typescript
+const envInfo = PCore.getEnvironmentInfo();
+const applicationName = envInfo.getApplicationName();
+const isEmbedMode = envInfo.getRenderingMode() === 'EMBED';
+```
+
+---
+
+## LocaleUtils (via `PCore.getLocaleUtils()`)
+
+| Method                                                                   | Signature                                                                                          | Purpose                                                                                |
+| ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `getLocaleValue(localeKey, localePath?, localeRuleKey?, componentName?)` | `(localeKey: string, localePath?: string, localeRuleKey?: string, componentName?: string): string` | Returns the localized value for a key, falling back to the raw key if not found.       |
+| `getPortalLocaleReference(portal)`                                       | `(portal: string \| null): string`                                                                 | Returns the locale reference string for a portal (for example, `PORTAL!WEBPORTAL`).    |
+| `getCaseLocaleReference(caseClass)`                                      | `(caseClass: string): string \| null`                                                              | Returns the locale reference string for a case type (for example, `CASE!MY-APP-WORK`). |
+| `setLocaleForRule(localeJson, localeRuleKey)`                            | `(localeJson: unknown, localeRuleKey: string): void`                                               | Sets the locale bundle for a specific rule key.                                        |
+| `getLocaleForRule(localeRuleKey)`                                        | `(localeRuleKey: string): unknown`                                                                 | Returns the locale bundle fields for a rule key.                                       |
+| `resetLocaleStore()`                                                     | `(): void`                                                                                         | Resets the in-memory localization store.                                               |
+| `loadLocaleResources(locales)`                                           | `(locales: string[]): Promise<void>`                                                               | Loads locale bundles and localization assets for the given locales.                    |
+| `setTimezone(timezone)`                                                  | `(timezone: string): void`                                                                         | Sets the active time zone.                                                             |
+| `getTimeZoneInUse()`                                                     | `(): string`                                                                                       | Returns the configured time zone, falling back to the browser's time zone.             |
+
+**Example:**
+
+```typescript
+const localizedLabel = PCore.getLocaleUtils().getLocaleValue('pyLabel');
+const caseLocaleRef = PCore.getLocaleUtils().getCaseLocaleReference('MyOrg-MyApp-Work-Request');
+```
+
+---
+
+## AuthUtils (via `PCore.getAuthUtils()`)
+
+| Method                          | Signature                                                         | Purpose                                                          |
+| ------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------- |
+| `setTokens(tokenInfo)`          | `(tokenInfo: TokenInfo): void`                                    | Adds an access token to outgoing REST request headers. `TokenInfo` is defined below the example. |
+| `getAuthInstance(config)`       | `(config: unknown): unknown`                                      | Returns an OAuth 2.0 auth instance for the given configuration.  |
+| `revokeTokens()`                | `(): Promise<void>`                                               | Revokes the current access and refresh tokens.                   |
+| `setAuthorizationHeader(value)` | `(value: string): void`                                           | Sets the `Authorization` header value used on outgoing requests. |
+
+**Example:**
+
+```typescript
+PCore.getAuthUtils().setTokens({ token_type: 'Bearer', access_token: token, expires_in: expiresIn, eA: eA });
+// ...on logout
+await PCore.getAuthUtils().revokeTokens();
+```
+
+**`TokenInfo`** (from the typedefs' `service_broker/types.d.ts`):
+
+```typescript
+type TokenInfo = {
+  expires_in: number;
+  eA: number; // required; its meaning is not documented in the typedefs
+  session_index?: string;
+  token_type?: string;
+  refresh_token?: string;
+} & ({ csrf: string; access_token?: undefined } | { csrf?: undefined; access_token: string });
+```
+
+Exactly one of `csrf` or `access_token` is supplied.

package/src/ai/catalog/references/pcore-environment-locale-namespace.md

@@ -0,0 +1,175 @@
+# PCore: Environment, Locale & Namespace
+
+> Part of the [PCore / PConnect API Reference skills](../README.md). See [pcore-environment-info-details.md](./pcore-environment-info-details.md) for the full method catalogs of `EnvironmentInfo`, `LocaleUtils`, and `AuthUtils`.
+
+## `getEnvironmentInfo()`
+
+**Purpose:** Returns the `EnvironmentInfo` API — locale, operator, and application information.
+
+**Signature:**
+
+```typescript
+getEnvironmentInfo(): EnvironmentInfo
+```
+
+**Example:**
+
+```typescript
+const envInfo = PCore.getEnvironmentInfo();
+const applicationName = envInfo.getApplicationName();
+const locale = envInfo.getLocale();
+```
+
+---
+
+## `switchLocale(locale)`
+
+**Purpose:** Switches the application locale at runtime and hot-reloads locale bundles without a full page reload.
+
+**Signature:**
+
+```typescript
+switchLocale(locale: string): Promise<void>
+```
+
+**Example:**
+
+```typescript
+await PCore.switchLocale('fr-FR');
+```
+
+---
+
+## `getLocaleUtils(locale?)`
+
+**Purpose:** Returns a `LocaleUtils` instance scoped to the given locale (or the current operator locale if omitted).
+
+**Signature:**
+
+```typescript
+getLocaleUtils(locale?: string): LocaleUtils
+```
+
+**Example:**
+
+```typescript
+const localizedLabel = PCore.getLocaleUtils().getLocaleValue('pyLabel');
+```
+
+---
+
+## `registerLocaleManager(customLocaleUtilApis)`
+
+**Purpose:** Registers custom `LocaleUtils` implementations, overriding the default ones in place.
+
+**Signature:**
+
+```typescript
+registerLocaleManager(customLocaleUtilApis: Partial<LocaleUtils>): void
+```
+
+**Example:**
+
+```typescript
+PCore.registerLocaleManager({
+  getLocaleValue: (key) => myCustomTranslationLookup(key)
+});
+```
+
+**Notes:** Only the keys present on `customLocaleUtilApis` are overridden — every other `LocaleUtils` method keeps its default implementation.
+
+---
+
+## `getQualifiedName(ruleName, namespace)`
+
+**Purpose:** Returns the fully qualified rule name for the given namespace.
+
+**Signature:**
+
+```typescript
+getQualifiedName(ruleName: string, namespace: string): string
+```
+
+**Example:**
+
+```typescript
+const qualifiedName = PCore.getQualifiedName('TestRule', 'MyNamespace'); // "MyNamespace__TestRule"
+```
+
+---
+
+## `getDefaultQualifiedName(ruleName)`
+
+**Purpose:** Returns the rule name qualified with the application's default namespace.
+
+**Signature:**
+
+```typescript
+getDefaultQualifiedName(ruleName: string): string
+```
+
+**Example:**
+
+```typescript
+const dataPageName = PCore.getDefaultQualifiedName('D_Accounts');
+```
+
+---
+
+## `getNameSpaceUtils()`
+
+**Purpose:** Returns `NamespaceUtils`, which provides namespace-related helpers (`getQualifiedName`, `getDefaultQualifiedName`, and related utilities).
+
+**Signature:**
+
+```typescript
+getNameSpaceUtils(): NamespaceUtils
+```
+
+**Example:**
+
+```typescript
+const dataPageName = PCore.getNameSpaceUtils().getDefaultQualifiedName('D_Accounts');
+```
+
+---
+
+## `getNetworkUtils()`
+
+**Purpose:** Returns the central controller for online/offline application state.
+
+**Signature:**
+
+```typescript
+getNetworkUtils(): NetworkUtils
+```
+
+**Example:**
+
+```typescript
+const isOnline = PCore.getNetworkUtils().isOnline();
+
+const unsubscribe = PCore.getNetworkUtils().onStatusChange((online) => {
+  // react to connectivity changes
+});
+```
+
+**Notes:** Prefer this over reading `navigator.onLine` directly or adding your own `online`/`offline` window listeners.
+
+---
+
+## `getAuthUtils()`
+
+**Purpose:** Returns `AuthUtils`, used to manage authentication tokens for REST API calls.
+
+**Signature:**
+
+```typescript
+getAuthUtils(): AuthUtils
+```
+
+**Example:**
+
+```typescript
+PCore.getAuthUtils().setTokens(tokenObject);
+```

package/src/ai/catalog/references/pcore-messaging-details.md

@@ -0,0 +1,99 @@
+# Messages, Pub/Sub, Events & Messaging Service — Method Details
+
+> Part of the [PCore / PConnect API Reference skills](../README.md). Companion to [pcore-rest-data-messaging.md](./pcore-rest-data-messaging.md), which covers the top-level `PCore.get*()` accessors. This file catalogs the methods available on the objects those accessors return.
+
+## SemanticUrlUtils (via `PCore.getSemanticUrlUtils()`)
+
+| Method                                                       | Signature                                                                        | Purpose                                                        |
+| ------------------------------------------------------------ | -------------------------------------------------------------------------------- | -------------------------------------------------------------- |
+| `getResolvedSemanticURL(routeKey, payload, params, locale?)` | `(routeKey: string, payload: unknown, params: unknown, locale?: string): string` | Builds a resolved semantic URL for a given route.              |
+| `getActions()`                                               | `(): Record<string, string>`                                                     | Returns the constant names for supported semantic-URL actions. |
+
+**Example:**
+
+```typescript
+const url = PCore.getSemanticUrlUtils().getResolvedSemanticURL(routeKey, payload, params);
+```
+
+---
+
+## MessageManager (via `PCore.getMessageManager()`)
+
+| Method                                                      | Signature                                                                                        | Purpose                                                         |
+| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- |
+| `addMessages(config)`                                       | `(config: { messages: unknown[]; category: string; context?: string; property?: string }): void` | Adds one or more messages to a context or property.             |
+| `getMessages(config)`                                       | `(config: { context: string \| null }): unknown[]`                                               | Retrieves messages (property, HTTP, or page) for a context.     |
+| `clearMessages(config)`                                     | `(config: { category?: string; context?: string; property?: string }): void`                     | Clears messages matching the given criteria.                    |
+| `clearContextMessages(config)`                              | `(config: { context: string }): void`                                                            | Clears all messages for a given context.                        |
+| `clearContextMessagesInActiveWorkArea(context)`             | `(context: string): void`                                                                        | Clears all messages in the active work-area container.          |
+| `getValidationErrorMessages(context, localizationService?)` | `(context: string, localizationService?: unknown): unknown[]`                                    | Returns all validation error messages for a context, localized. |
+| `isCustomPageErrorExist(context)`                           | `(context: string): boolean`                                                                     | Checks whether a custom page error exists for a context.        |
+
+**Example:**
+
+```typescript
+const { addMessages, clearMessages } = PCore.getMessageManager();
+
+addMessages({
+  messages: [{ type: 'error', message: 'Something went wrong' }],
+  category: 'PAGE',
+  context
+});
+clearMessages({ category: 'PAGE', context });
+```
+
+---
+
+## PubSubUtils (via `PCore.getPubSubUtils()`)
+
+| Method                                                               | Signature                                                       | Purpose                                                            |
+| -------------------------------------------------------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------ |
+| `subscribe(eventType, handler, name?, subscribeOnce?, contextName?)` | `(...): void`                                                   | Subscribes a handler to an event type.                             |
+| `subscribeOnce(eventType, handler, name)`                            | `(eventType: string, handler: Function, name: string): void`    | Subscribes a handler that fires only once, then auto-unsubscribes. |
+| `publish(eventType, payload?)`                                       | `(eventType: string, payload?: unknown): void`                  | Publishes an event, invoking all subscribed handlers.              |
+| `unsubscribe(eventType, name, contextName?)`                         | `(eventType: string, name: string, contextName?: string): void` | Unsubscribes a named handler from an event type.                   |
+| `cleanContextSubscribers(contextName)`                               | `(contextName: string): void`                                   | Removes all subscriptions registered under a context.              |
+
+**Example:**
+
+```typescript
+const { subscribe, unsubscribe } = PCore.getPubSubUtils();
+subscribe(PCore.getEvents().getCaseEvent().CREATE_STAGE_DONE, onStageCreated, 'my-subscriber');
+// later
+unsubscribe(PCore.getEvents().getCaseEvent().CREATE_STAGE_DONE, 'my-subscriber');
+```
+
+---
+
+## Events (via `PCore.getEvents()`)
+
+| Method                         | Signature                    | Purpose                                                         |
+| ------------------------------ | ---------------------------- | --------------------------------------------------------------- |
+| `getCaseEvent()`               | `(): Record<string, string>` | Returns case-related event name constants (for pub/sub topics). |
+| `getDataEvent()`               | `(): Record<string, string>` | Returns data-object-related event name constants.               |
+| `getBulkProcessEvent()`        | `(): Record<string, string>` | Returns the bulk-action-submitted event constant.               |
+| `getLocalActionProcessEvent()` | `(): Record<string, string>` | Returns the local-action-submitted event constant.              |
+
+**Example:**
+
+```typescript
+const caseCreated = PCore.getEvents().getCaseEvent().CREATE_STAGE_DONE;
+```
+
+---
+
+## MessagingServiceManager (via `PCore.getMessagingServiceManager()`)
+
+| Method                                                 | Signature                                                   | Purpose                                                                                              |
+| ------------------------------------------------------ | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| `subscribe(filter, messageHandler, contextName?, id?)` | `(filter: { matcher: string; criteria: Record<string, string> }, messageHandler: Function, contextName?: string, id?: string): string` | Subscribes to WebSocket messaging service updates matching a filter (for example `{ matcher: 'CASE', criteria: { caseId } }` for case updates); returns a subscription ID. |
+| `unsubscribe(id, notRemove?)`                          | `(id: string, notRemove?: boolean): void`                   | Removes a messaging-service subscription.                                                            |
+| `dispatchLocalMessage(payload)`                        | `(payload: unknown): void`                                  | Dispatches a locally-constructed message through the subscriber pipeline (used for offline support). |
+| `getUserPresence()`                                    | `(): { getUserState: (userIdentifier: string) => unknown }` | Returns the user-presence manager, used to read a user's online/away state.                          |
+| `getCaseSubscription(caseId)`                          | `(caseId: string): AtomicSubscription`                      | Gets or creates a subscription for case-specific server push updates. The returned object has `subscribe(criteria, callback): string` and `unsubscribe(subscriptionId): void`. |
+
+**Example:**
+
+```typescript
+const userState = PCore.getMessagingServiceManager().getUserPresence().getUserState(userIdentifier);
+```