@salesforce/mcp-provider-lwc-experts 0.1.0

package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-get-related-list-count.md

@@ -0,0 +1,58 @@
+# `getRelatedListCount`
+
+Use this wire adapter to get the `RelatedList` record count.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getRelatedListCount } from 'lightning/uiRelatedListApi';
+
+export default class LdsGetRelatedListCount extends LightningElement {
+  @wire(getRelatedListCount, {
+      parentRecordId: '001RM000003UNu6YAG',
+      relatedListId: 'Contacts',
+  })
+}
+```
+
+## Parameters
+
+- **`parentRecordId`** (String, Required) – The ID of the parent record, such as an Account ID.
+- **`relatedListId`** (String, Required) – The API name of a related list object, such as Contacts, Opportunities, or Cases.
+- **`maxCount`** (Number) – The maximum number of records to return. Default is 20.
+
+## Returns
+
+- **`data`** – Related List Record Count.
+- **`error`** – FetchResponse.
+
+## Usage
+
+This example fetches the record count for a related list.
+
+### **JavaScript**
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getRelatedListCount } from 'lightning/uiRelatedListApi';
+
+export default class WireGetRelatedListCount extends LightningElement {
+  error;
+  responseData;
+
+  @wire(getRelatedListCount, {
+    parentRecordId: '001RM000003UNu6YAG',
+    relatedListId: 'Contacts',
+  })
+  listInfo({ error, data }) {
+    if (data) {
+      this.responseData = data;
+      this.error = undefined;
+    } else if (error) {
+      this.error = error;
+      this.responseData = undefined;
+    }
+  }
+}
+```

package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-get-related-list-info-batch.md

@@ -0,0 +1,29 @@
+# `getRelatedListInfoBatch`
+
+Use this wire adapter to get metadata for a batch of `RelatedLists`.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getRelatedListInfoBatch } from 'lightning/uiRelatedListApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class LdsGetRelatedListInfoBatch extends LightningElement {
+  @wire(getRelatedListInfoBatch, {
+    parentObjectApiName: ACCOUNT_OBJECT.objectApiName,
+    relatedListNames: ['Contacts', 'Opportunities'],
+  })
+}
+```
+
+## Parameters
+
+- **`parentObjectApiName`** (String, Required) – API name of a parent object, such as `Account`.
+- **`relatedListNames`** (String[], Required) – Array of related list API names, such as `Contacts`, `Opportunities`, or `Cases`. In the wire adapter code, `relatedListNames` maps to `relatedListIds` in the User Interface API resource.
+- **`recordTypeId`** (String) – ID of the parent record type. If not provided, the default record type is used.
+
+## Returns
+
+- **`data`** – Simplified Batch Results.
+- **`error`** – FetchResponse.

package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-get-related-list-info.md

@@ -0,0 +1,36 @@
+# `getRelatedListInfo`
+
+Use this wire adapter to get metadata for `RelatedList`.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getRelatedListInfo } from 'lightning/uiRelatedListApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class LdsGetRelatedListInfo extends LightningElement {
+  @wire(getRelatedListInfo, {
+      parentObjectApiName: ACCOUNT_OBJECT.objectApiName,
+      relatedListId: 'Contacts',
+      recordTypeId: '012000000000000AAA', // optional
+      fields: ['Contact.Name', 'Contact.Id'], // optional
+      optionalFields: ['Contact.OptionalField'], // optional
+      restrictColumnsToLayout: false // optional
+  })
+}
+```
+
+## Parameters
+
+- **`parentObjectApiName`** (String, Required) – API name of a parent object, such as `Account`.
+- **`relatedListId`** (String, Required) – API name of a related list object, such as `Contacts`, `Opportunities`, or `Cases`.
+- **`recordTypeId`** (String) – ID of the parent record type. If not provided, the default record type is used.
+- **`fields`** (String[]) – API names of related list fields to query. If a field is inaccessible, an error is returned.
+- **`optionalFields`** (String[]) – Additional fields to query. Inaccessible fields are ignored but do not cause an error.
+- **`restrictColumnsToLayout`** (Boolean) – If `true`, retrieves only list columns in the page layout; if `false`, retrieves all columns. Default is `true`.
+
+## Returns
+
+- **`data`** – Related List Info.
+- **`error`** – FetchResponse.

package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-get-related-list-records-batch.md

@@ -0,0 +1,48 @@
+# `getRelatedListRecordsBatch`
+
+Use this wire adapter to get records for a batch of `RelatedLists`.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getRelatedListRecordsBatch } from 'lightning/uiRelatedListApi';
+
+export default class LdsGetRelatedListRecordsBatch extends LightningElement {
+  @wire(getRelatedListRecordsBatch, {
+    parentRecordId: '001RM000003UNu6YAG',
+    relatedListParameters: [
+      {
+        relatedListId: 'Contacts',
+        fields: ['Contact.Name', 'Contact.Id'],
+        sortBy: ['Contact.Name']
+      },
+      {
+        relatedListId: 'Opportunities',
+        fields: ['Opportunity.Name', 'Opportunity.Amount'],
+        sortBy: ['Opportunity.Amount'],
+        where: "{ and: [{ Name: { like: \"ACME%\" }}] }"
+      }
+    ]
+  })
+}
+```
+
+## Parameters
+
+- **`parentRecordId`** (String, Required) – ID of the parent record, such as an Account ID.
+- **`relatedListParameters`** (Object[], Required) – Array of related list parameter collections.
+
+### **`relatedListParameters` Properties**
+
+- **`relatedListId`** (String, Required) – API name of a related list object, such as `Contacts`, `Opportunities`, or `Cases`.
+- **`fields`** (String[]) – API names of the related list’s column fields.
+- **`optionalFields`** (String[]) – Additional fields in the related list.
+- **`pageSize`** (Number) – Number of list records to return per page.
+- **`sortBy`** (String[]) – Field API name(s) to sort by. Accepts one value per request.
+- **`where`** (String) – Filter for related list records in GraphQL syntax.
+
+## Returns
+
+- **`data`** – Simplified Batch Results.
+- **`error`** – FetchResponse.

package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-get-related-list-records.md

@@ -0,0 +1,34 @@
+# `getRelatedListRecords`
+
+Use this wire adapter to get `RelatedList` records. Related lists display details and links to records associated with a specific record, such as contacts, cases, notes, or files related to an account.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getRelatedListRecords } from 'lightning/uiRelatedListApi';
+
+export default class LdsGetRelatedListRecords extends LightningElement {
+  @wire(getRelatedListRecords, {
+    parentRecordId: '001RM000003UNu6YAG',
+    relatedListId: 'Contacts',
+    fields: ['Contact.Name','Contact.Id'],
+    sortBy: ['Contact.Name']
+  })
+}
+```
+
+## Parameters
+
+- **`parentRecordId`** (String, Required) – ID of the parent record, such as an Account ID.
+- **`relatedListId`** (String, Required) – API name of a related list or child relationship (e.g., `Contacts`, `Opportunities`, `Cases`). For custom objects, use `Custom_Objects__r`.
+- **`fields`** (String[]) – API names of the related list’s column fields. For standard fields on custom objects, use `Custom_Object__c.FieldName`; for custom fields, use `Custom_Object__c.FieldName__c`.
+- **`optionalFields`** (String[]) – Additional fields in the related list.
+- **`pageSize`** (Number) – Number of records per page (default: 50, range: 1-1999).
+- **`sortBy`** (String[]) – API name of the field to sort by. Accepts one value per request.
+- **`where`** (String) – Filter for related list records. Semi-joins and anti-joins are not supported.
+
+## Returns
+
+- **`data`** – Related List Record Collection.
+- **`error`** – FetchResponse.

package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-get-related-lists-info.md

@@ -0,0 +1,28 @@
+# `getRelatedListsInfo`
+
+Use this wire adapter to get metadata for `RelatedLists` in an object’s default layout.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getRelatedListsInfo } from 'lightning/uiRelatedListApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class LdsGetRelatedListsInfo extends LightningElement {
+  @wire(getRelatedListsInfo, {
+    parentObjectApiName: ACCOUNT_OBJECT.objectApiName,
+    recordTypeId: '012000000000000AAA' // optional
+  })
+}
+```
+
+## Parameters
+
+- **`parentObjectApiName`** (String, Required) – API name of a parent object, such as `Account`.
+- **`recordTypeId`** (String) – ID of the parent record type.
+
+## Returns
+
+- **`data`** – Related List Summary Collection.
+- **`error`** – FetchResponse.

package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-object-info.md

@@ -0,0 +1,51 @@
+# `getObjectInfo`
+
+Use this wire adapter to get metadata about a specific object, including its fields, child relationships, record types, and theme.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getObjectInfo } from 'lightning/uiObjectInfoApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class Example extends LightningElement {
+  @wire(getObjectInfo, { objectApiName: ACCOUNT_OBJECT })
+  propertyOrFunction;
+}
+```
+
+## Parameters
+
+- **`objectApiName`** (String, Required) – API name of a supported object.
+
+## Returns
+
+- **`data`** – Object Info.
+- **`error`** – FetchResponse.
+
+## Usage
+
+Use `getObjectInfo` for a single object. For multiple objects, use `getObjectInfos`.
+
+This example retrieves record type IDs and finds the ID for the record type named "Special Account":
+
+```js
+import { LightningElement, api, wire, track } from 'lwc';
+import { getObjectInfo } from 'lightning/uiObjectInfoApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class RecordFormWithRecordType extends LightningElement {
+  @api recordId;
+  @api objectApiName;
+  @track objectInfo;
+
+  @wire(getObjectInfo, { objectApiName: ACCOUNT_OBJECT })
+  objectInfo;
+
+  get recordTypeId() {
+    const rtis = this.objectInfo.data.recordTypeInfos;
+    return Object.keys(rtis).find((rti) => rtis[rti].name === 'Special Account');
+  }
+}
+```

package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-object-infos.md

@@ -0,0 +1,54 @@
+# `getObjectInfos`
+
+Use this wire adapter to get metadata for multiple objects, including fields, child relationships, record types, and themes.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getObjectInfos } from 'lightning/uiObjectInfoApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+import OPPORTUNITY_OBJECT from '@salesforce/schema/Opportunity';
+
+export default class GetObjectInfosExample extends LightningElement {
+  @wire(getObjectInfos, { objectApiNames: [ACCOUNT_OBJECT, OPPORTUNITY_OBJECT] })
+  propertyOrFunction;
+}
+```
+
+## Parameters
+
+- **`objectApiNames`** (String[], Required) – API names of supported objects.
+
+## Returns
+
+- **`data`** – Contains a `results` object with Object Info metadata and status codes.
+- **`error`** – FetchResponse.
+
+### Response Structure
+
+The metadata for each requested object is returned in `data.results` in the same order they were requested. If an object has an error, the error code and message are included in `data.results[].result`. The `error` object is returned only if the server call fails.
+
+```json
+{
+  "results": [
+    {
+      "result": ObjectInfo1,
+      "statusCode": 200
+    },
+    {
+      "result": ObjectInfo2,
+      "statusCode": 200
+    },
+    {
+      "result": [
+        {
+          "errorCode": "FORBIDDEN",
+          "message": "You don't have access to this record. Ask your administrator for help or to request access."
+        }
+      ],
+      "statusCode": 403
+    }
+  ]
+}
+```

package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-picklist-values-record.md

@@ -0,0 +1,29 @@
+# `getPicklistValuesByRecordType`
+
+Use this wire adapter to retrieve values for all picklists of a specified record type.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getPicklistValuesByRecordType } from 'lightning/uiObjectInfoApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class Example extends LightningElement {
+  @wire(getPicklistValuesByRecordType, {
+    objectApiName: ACCOUNT_OBJECT,
+    recordTypeId: '012000000000000AAA',
+  })
+  propertyOrFunction;
+}
+```
+
+## Parameters
+
+- **`objectApiName`** (String, Required) – API name of a supported object.
+- **`recordTypeId`** (String, Required) – ID of the record type. Use the Object Info `defaultRecordTypeId` property from `getObjectInfo`.
+
+## Returns
+
+- **`data`** – Picklist Values Collection.
+- **`error`** – FetchResponse.

package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-picklist-values.md

@@ -0,0 +1,78 @@
+# `getPicklistValues`
+
+Use this wire adapter to retrieve picklist values for a specified field.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getPicklistValues } from 'lightning/uiObjectInfoApi';
+import INDUSTRY_FIELD from '@salesforce/schema/Account.Industry';
+
+export default class Example extends LightningElement {
+  @wire(getPicklistValues, { recordTypeId: '012000000000000AAA', fieldApiName: INDUSTRY_FIELD })
+  propertyOrFunction;
+}
+```
+
+## Parameters
+
+- **`recordTypeId`** (String, Required) – ID of the record type. Use the Object Info `defaultRecordTypeId` property from `getObjectInfo`. If no default record type exists, the master record type is `012000000000000AAA`.
+- **`fieldApiName`** (String, Required) – API name of the picklist field on a supported object.
+
+## Returns
+
+- **`data`** – Picklist Values.
+- **`error`** – FetchResponse.
+
+## Usage
+
+Picklist values are scoped to a record type. For dependent picklists, `getPicklistValues` returns data for controlling fields and their mappings.
+
+Both `recordTypeId` and `fieldApiName` are required. Use `getObjectInfo` to retrieve `defaultRecordTypeId` and pass it reactively to `getPicklistValues`.
+
+This example retrieves the Rating field picklist values (`Hot`, `Warm`, `Cold`) from the Account object:
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getObjectInfo, getPicklistValues } from 'lightning/uiObjectInfoApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+import RATING_FIELD from '@salesforce/schema/Account.Rating';
+
+export default class WireGetRatingPicklist extends LightningElement {
+  accountRecordTypeId;
+  ratings;
+
+  @wire(getObjectInfo, { objectApiName: ACCOUNT_OBJECT })
+  results({ error, data }) {
+    if (data) {
+      this.accountRecordTypeId = data.defaultRecordTypeId;
+      this.error = undefined;
+    } else {
+      this.error = error;
+      this.accountRecordTypeId = undefined;
+    }
+  }
+
+  @wire(getPicklistValues, { recordTypeId: '$accountRecordTypeId', fieldApiName: RATING_FIELD })
+  picklistResults({ error, data }) {
+    if (data) {
+      this.ratings = data.values;
+      this.error = undefined;
+    } else {
+      this.error = error;
+      this.ratings = undefined;
+    }
+  }
+}
+```
+
+### Example Response
+
+```json
+[
+  { "attributes": null, "label": "Hot", "validFor": [], "value": "Hot" },
+  { "attributes": null, "label": "Warm", "validFor": [], "value": "Warm" },
+  { "attributes": null, "label": "Cold", "validFor": [], "value": "Cold" }
+]
+```

package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-record.md

@@ -0,0 +1,114 @@
+# `getRecord`
+
+Use this wire adapter to retrieve a record’s data.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getRecord } from 'lightning/uiRecordApi';
+
+@wire(getRecord, { recordId: string, fields: string|string[], optionalFields?: string|string[] })
+propertyOrFunction;
+
+@wire(getRecord, { recordId: string, layoutTypes: string|string[],
+                    modes?: string|string[], optionalFields?: string|string[] })
+propertyOrFunction;
+```
+
+## Parameters
+
+- **`recordId`** (String, Required) – ID of a record from a supported object.
+- **`fields`** (String[]) – Either `fields` or `layoutTypes` is required. A field or an array of fields to return. If a field is inaccessible, an error is returned. Use `optionalFields` if unsure about access.
+- **`layoutTypes`** (String[]) – Either `fields` or `layoutTypes` is required. Specifies the fields to return. Options:
+  - **`Compact`** – Retrieves a record’s key fields.
+  - **`Full`** – Retrieves a full layout.
+- **`modes`** (String[]) – Optional if `layoutTypes` is specified. Determines which fields to get from a layout. Options:
+  - **`Create`** – For UI that lets a user create a record.
+  - **`Edit`** – For UI that lets a user edit a record.
+  - **`View`** – (Default) For UI that displays a record.
+- **`optionalFields`** (String[]) – Optional fields. If accessible, they’re included; if not, they are ignored without error.
+
+## Returns
+
+- **`data`** – Record response.
+- **`error`** – FetchResponse.
+
+## Usage
+
+This example retrieves a record and its field values:
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getRecord, getFieldValue } from 'lightning/uiRecordApi';
+import NAME_FIELD from '@salesforce/schema/Account.Name';
+import OWNER_NAME_FIELD from '@salesforce/schema/Account.Owner.Name';
+import PHONE_FIELD from '@salesforce/schema/Account.Phone';
+import INDUSTRY_FIELD from '@salesforce/schema/Account.Industry';
+
+export default class Example extends LightningElement {
+  @wire(getRecord, {
+    recordId: '001456789012345678',
+    fields: [NAME_FIELD, INDUSTRY_FIELD],
+    optionalFields: [PHONE_FIELD, OWNER_NAME_FIELD],
+  })
+  account;
+
+  get name() {
+    return getFieldValue(this.account.data, NAME_FIELD);
+  }
+
+  get phone() {
+    return getFieldValue(this.account.data, PHONE_FIELD);
+  }
+
+  get industry() {
+    return getFieldValue(this.account.data, INDUSTRY_FIELD);
+  }
+
+  get owner() {
+    return getFieldValue(this.account.data, OWNER_NAME_FIELD);
+  }
+}
+```
+
+### Error Handling
+
+Use a Promise with `then()` and `catch()` blocks. To display errors, use toasts from `lightning/platformShowToastEvent`.
+
+```js
+import { LightningElement, api, wire } from 'lwc';
+import { ShowToastEvent } from 'lightning/platformShowToastEvent';
+import { getRecord } from 'lightning/uiRecordApi';
+
+const FIELDS = ['Contact.Name', 'Contact.Phone'];
+
+export default class LoadContact extends LightningElement {
+  @api recordId;
+  contact;
+  name;
+  phone;
+  @wire(getRecord, { recordId: '$recordId', fields: FIELDS })
+  wiredRecord({ error, data }) {
+    if (error) {
+      let message = 'Unknown error';
+      if (Array.isArray(error.body)) {
+        message = error.body.map((e) => e.message).join(', ');
+      } else if (typeof error.body.message === 'string') {
+        message = error.body.message;
+      }
+      this.dispatchEvent(
+        new ShowToastEvent({
+          title: 'Error loading contact',
+          message,
+          variant: 'error',
+        }),
+      );
+    } else if (data) {
+      this.contact = data;
+      this.name = this.contact.fields.Name.value;
+      this.phone = this.contact.fields.Phone.value;
+    }
+  }
+}
+```