@salesforce/mcp-provider-lwc-experts 0.1.0

package/agents/lds/resources/lwc/guides/reference/reference-get-list-records-by-name.md

@@ -0,0 +1,84 @@
+# `getListRecordsByName`
+
+Use this wire adapter to get record data for a list view.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getListRecordsByName } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class Example extends LightningElement {
+  @wire(getListRecordsByName, {
+    objectApiName: ACCOUNT_OBJECT,
+    listViewApiName: 'AllAccounts',
+    fields: ['Account.Name', 'Account.Id'],
+    sortBy: ['Account.Name'],
+  })
+  propertyOrFunction;
+}
+```
+
+## Parameters
+
+- **`objectApiName`** (String, Required) - The API name of a supported object.
+- **`listViewApiName`** (String, Required) - The API name of a list view, such as `"AllAccounts"`.
+- **`fields`** (String[]) - Additional fields queried for the records returned. These fields don’t create visible columns. If the field isn’t available to the user, an error occurs.
+- **`optionalFields`** (String[]) - Additional fields queried for the records returned. These fields don’t create visible columns. If the field isn’t available to the user, no error occurs, and the field isn’t included in the records.
+- **`pageSize`** (Integer) - The number of list records viewed at one time. The default value is `50`. Valid values are `1–2000`.
+- **`searchTerm`** (String) - A search term to filter the results. Wildcards are supported.
+- **`sortBy`** (String) - The API name of the field the list view is sorted by. Preceding with `-` sorts in descending order (e.g., `"-CreatedDate"`).
+- **`where`** (String) - The filter applied to returned records using GraphQL syntax.
+- **`pageToken`** (Integer) - A token that represents the page offset. Use with `pageSize` to control pagination.
+
+## Returns
+
+- **`data`** – List Record Collection
+- **`error`** – FetchResponse
+
+## Usage
+
+This example fetches list view records by API name and iterates through the records. The `handleNextPage` click handler retrieves the next set of records.
+
+### **JavaScript**
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getListRecordsByName } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class GetListRecords extends LightningElement {
+  error;
+  records;
+  pageToken;
+  nextPageToken;
+
+  @wire(getListRecordsByName, {
+    objectApiName: ACCOUNT_OBJECT.objectApiName,
+    listViewApiName: 'AllAccounts',
+    fields: ['Account.Id', 'Account.Name'],
+    sortBy: ['Account.Name'],
+    pageSize: 10,
+    pageToken: '$pageToken',
+  })
+  listRecords({ error, data }) {
+    if (data) {
+      this.records = data.records;
+      this.nextPageToken = data?.nextPageToken;
+      this.error = undefined;
+    } else if (error) {
+      this.error = error;
+    }
+  }
+
+  handleNextPage(event) {
+    event.stopPropagation();
+    if (this.nextPageToken) {
+      this.pageToken = this.nextPageToken;
+    }
+  }
+}
+```
+
+For backward pagination, use the `previousPageToken` property returned by `getListRecordsByName`.

package/agents/lds/resources/lwc/guides/reference/reference-update-list-info.md

@@ -0,0 +1,64 @@
+# `updateListInfoByName`
+
+Use this function to update a list view’s metadata.
+
+## Syntax
+
+```js
+import { updateListInfoByName } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+updateListInfoByName({
+  objectApiName: ACCOUNT_OBJECT,
+  listViewApiName: 'MyAccountListView',
+  label: 'NewListViewLabel',
+});
+```
+
+## Parameters
+
+- **`objectApiName`** (String, Required) - The API name of a supported object.
+- **`listViewApiName`** (String, Required) - The API name of a list view, such as `"AllAccounts"`.
+- **`displayColumns`** (String[]) - The display columns (field API names) for the list.
+- **`filterLogicString`** (String) - The filter logic string, such as `"(1 OR 2) and 3"`. Indexes start with 1.
+- **`filteredByInfo`** (Object) - Filtering information for the list. See List Filter By Info Input.
+- **`label`** (String) - The list’s display label. For example, `"All Accounts"`.
+- **`listShares`** (String[]) - Objects the list is shared with, if `visibility` is set to `Shared`.
+- **`scope`** (Object) - The scope information for the list. See List Scope Input.
+- **`visibility`** (String) - The list’s visibility. Valid values are: `"Private"`, `"Public"`, `"Shared"`.
+
+## Returns
+
+- **`data`** – List Info
+- **`error`** – FetchResponse
+
+## Usage
+
+This example updates the list view’s label when the button is clicked.
+
+### **JavaScript**
+
+```js
+import { updateListInfoByName } from 'lightning/uiListsApi';
+import { LightningElement, api } from 'lwc';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class UpdateListInfo extends LightningElement {
+  error;
+  label;
+
+  @api async updateListView() {
+    updateListInfoByName({
+      objectApiName: ACCOUNT_OBJECT.objectApiName,
+      listViewApiName: 'AllAccounts',
+      label: 'New Label',
+    })
+      .then((result) => {
+        this.label = result.data.label;
+      })
+      .catch((error) => {
+        this.error = error;
+      });
+  }
+}
+```

package/agents/lds/resources/lwc/guides/reference/reference-update-list-preferences.md

@@ -0,0 +1,68 @@
+# `updateListPreferences`
+
+Use this function to update the preferences for a list view.
+
+## Syntax
+
+```js
+import { updateListPreferences } from "lightning/uiListsApi";
+import ACCOUNT_OBJECT from "@salesforce/schema/Account";
+
+export default class UpdateListPrefExample extends LightningElement {
+  updateListPreferences({
+    objectApiName: ACCOUNT_OBJECT,
+    listViewApiName: "AllAccounts",
+  });
+}
+```
+
+## Parameters
+
+- **`objectApiName`** (String, Required) - The API name of a supported object.
+- **`listViewApiName`** (String, Required) - The API name of a list view, such as `"AllAccounts"`.
+- **`columnWidths`** (Object) - The column-width preferences for the list. Pass in a key-value pair with the name of the column and an integer.
+- **`columnWrap`** (Object) - The column-wrapping preferences for the list. Pass in a key-value pair with the name of the column and a boolean.
+- **`listReference`** (Object) - The reference information for the list.
+- **`orderedBy`** (String[]) - The ordering preference for the list. See List Order Input.
+
+## Returns
+
+- **`data`** – List Info
+- **`error`** – FetchResponse
+
+## Usage
+
+This example updates a list view’s preferences and displays the updated values.
+
+### **JavaScript**
+
+```js
+import { updateListPreferences } from 'lightning/uiListsApi';
+import { LightningElement, api } from 'lwc';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class UpdateListPrefs extends LightningElement {
+  error;
+  columnWidths;
+
+  @api async updateListViewPrefs() {
+    updateListPreferences({
+      objectApiName: ACCOUNT_OBJECT.objectApiName,
+      listViewApiName: 'AllAccounts',
+      columnWidths: {
+        Type: 200,
+        'Owner.Alias': 200,
+        Phone: 200,
+        BillingState: 250,
+        Name: 250,
+      },
+    })
+      .then((result) => {
+        this.columnWidths = Object.entries(result.data.columnWidths);
+      })
+      .catch((error) => {
+        this.error = error;
+      });
+  }
+}
+```

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

@@ -0,0 +1,75 @@
+# `updateRecord(recordInput, clientOptions)`
+
+Updates a record. Provide the record ID in `recordInput`.
+
+## Syntax
+
+```js
+import { updateRecord } from 'lightning/uiRecordApi';
+updateRecord(recordInput: Record, clientOptions?: Object): Promise<Record>;
+```
+
+## Parameters
+
+- **`recordInput`** (Object, Required) – A RecordInput object used to update the record.
+- **`clientOptions`** (Object, Optional) – To check for conflicts before updating, pass `{'ifUnmodifiedSince' : lastModifiedDate}` using the `LastModifiedDate` value.
+
+### `recordInput` Properties
+
+- **`fields`** (Object, Required) – Map of field names to field values.
+- **`apiName`** (String) – Use `null` or omit this property when updating a record.
+- **`triggerOtherEmail`** (Boolean) – For cases, specifies whether to send email to external users. Default: `false`.
+- **`triggerUserEmail`** (Boolean) – For cases or leads, specifies whether to send internal user email notifications. Default: `false`.
+- **`useDefaultRule`** (Boolean) – For cases or leads, specifies whether to use default assignment rules. Default: `false`.
+- **`allowSaveOnDuplicate`** (Boolean) – Specifies whether to save a duplicate record. Default: `false`.
+
+## Returns
+
+A Promise that resolves with the updated record containing field data.
+
+## Usage
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { ShowToastEvent } from 'lightning/platformShowToastEvent';
+import { updateRecord } from 'lightning/uiRecordApi';
+import { refreshApex } from '@salesforce/apex';
+import getSingleContact from '@salesforce/apex/ContactController.getSingleContact';
+import FIRSTNAME_FIELD from '@salesforce/schema/Contact.FirstName';
+import LASTNAME_FIELD from '@salesforce/schema/Contact.LastName';
+import ID_FIELD from '@salesforce/schema/Contact.Id';
+
+export default class UpdateRecordExample extends LightningElement {
+  @wire(getSingleContact) contact;
+  contactId;
+
+  updateContact() {
+    const fields = {
+      [ID_FIELD.fieldApiName]: this.contactId,
+      [FIRSTNAME_FIELD.fieldApiName]: this.template.querySelector("[data-field='FirstName']").value,
+      [LASTNAME_FIELD.fieldApiName]: this.template.querySelector("[data-field='LastName']").value,
+    };
+
+    updateRecord({ fields })
+      .then(() => {
+        this.dispatchEvent(
+          new ShowToastEvent({
+            title: 'Success',
+            message: 'Contact updated',
+            variant: 'success',
+          }),
+        );
+        return refreshApex(this.contact);
+      })
+      .catch((error) => {
+        this.dispatchEvent(
+          new ShowToastEvent({
+            title: 'Error updating record',
+            message: error.body.message,
+            variant: 'error',
+          }),
+        );
+      });
+  }
+}
+```