@salesforce/mcp-provider-lwc-experts 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/LICENSE.txt +21 -0
  2. package/README.md +82 -0
  3. package/agents/lds/resources/lwc/guides/reference/reference-create-list-info.md +53 -0
  4. package/agents/lds/resources/lwc/guides/reference/reference-create-record.md +52 -0
  5. package/agents/lds/resources/lwc/guides/reference/reference-delete-list-info.md +56 -0
  6. package/agents/lds/resources/lwc/guides/reference/reference-delete-record.md +78 -0
  7. package/agents/lds/resources/lwc/guides/reference/reference-get-list-info-by-name.md +60 -0
  8. package/agents/lds/resources/lwc/guides/reference/reference-get-list-infos-by-name.md +55 -0
  9. package/agents/lds/resources/lwc/guides/reference/reference-get-list-infos-by-object-name.md +64 -0
  10. package/agents/lds/resources/lwc/guides/reference/reference-get-list-object-info.md +55 -0
  11. package/agents/lds/resources/lwc/guides/reference/reference-get-list-preferences.md +60 -0
  12. package/agents/lds/resources/lwc/guides/reference/reference-get-list-records-by-name.md +84 -0
  13. package/agents/lds/resources/lwc/guides/reference/reference-update-list-info.md +64 -0
  14. package/agents/lds/resources/lwc/guides/reference/reference-update-list-preferences.md +68 -0
  15. package/agents/lds/resources/lwc/guides/reference/reference-update-record.md +75 -0
  16. package/agents/lds/resources/lwc/guides/reference/wire-adapters/lds-wire-adapter-types.json +1330 -0
  17. package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-get-related-list-count.md +58 -0
  18. package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-get-related-list-info-batch.md +29 -0
  19. package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-get-related-list-info.md +36 -0
  20. package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-get-related-list-records-batch.md +48 -0
  21. package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-get-related-list-records.md +34 -0
  22. package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-get-related-lists-info.md +28 -0
  23. package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-object-info.md +51 -0
  24. package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-object-infos.md +54 -0
  25. package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-picklist-values-record.md +29 -0
  26. package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-picklist-values.md +78 -0
  27. package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-record.md +114 -0
  28. package/agents/lds/resources/lwc/guides/reference/wire-adapters/reference-wire-adapters-records.md +142 -0
  29. package/index.bundle.d.ts +10 -0
  30. package/index.bundle.js +375 -0
  31. package/package.json +49 -0
@@ -0,0 +1,142 @@
1
+ # `getRecords`
2
+
3
+ Use this wire adapter to retrieve data for multiple records across different objects or record types.
4
+
5
+ ## Syntax
6
+
7
+ ```js
8
+ import { LightningElement, wire } from 'lwc';
9
+ import { getRecords } from 'lightning/uiRecordApi';
10
+
11
+ @wire(getRecords, { records: [ { recordIds: string[], fields: string[] } ] })
12
+ propertyOrFunction;
13
+
14
+ @wire(getRecords, { records: [ { recordIds: string[], fields: string[], optionalFields?: string[] } ] })
15
+ propertyOrFunction;
16
+ ```
17
+
18
+ ## Parameters
19
+
20
+ - **`records`** (Object[], Required) – Array of record requests, which can span multiple objects or record types.
21
+
22
+ ### `records` Properties
23
+
24
+ - **`recordIds`** (String[], Required) – Record IDs from supported objects.
25
+ - **`fields`** (String[]) – Fields to return. If a field is inaccessible, an error occurs. Use `optionalFields` if unsure about access.
26
+ - **`optionalFields`** (String[]) – Additional fields to return. Inaccessible fields are ignored without causing an error.
27
+
28
+ ## Returns
29
+
30
+ - **`data`** – Batch Results.
31
+ - **`error`** – FetchResponse.
32
+
33
+ ## Usage
34
+
35
+ For a single record, use `getRecord`.
36
+
37
+ ### Example: Fetching Multiple Records
38
+
39
+ ```js
40
+ import { LightningElement, wire } from 'lwc';
41
+ import { getRecords } from 'lightning/uiRecordApi';
42
+ import NAME_FIELD from '@salesforce/schema/User.Name';
43
+ import EMAIL_FIELD from '@salesforce/schema/User.Email';
44
+
45
+ export default class GetRecordsExample extends LightningElement {
46
+ @wire(getRecords, {
47
+ records: [
48
+ {
49
+ recordIds: ['005XXXXXXXXXXXXXXX'],
50
+ fields: [NAME_FIELD],
51
+ optionalFields: [EMAIL_FIELD],
52
+ },
53
+ ],
54
+ })
55
+ wiredRecords;
56
+ }
57
+ ```
58
+
59
+ ### Example: Fetching Records Across Multiple Objects
60
+
61
+ ```js
62
+ import { LightningElement, wire } from 'lwc';
63
+ import { getRecords } from 'lightning/uiRecordApi';
64
+ import USER_NAME_FIELD from '@salesforce/schema/User.Name';
65
+ import ACCOUNT_NAME_FIELD from '@salesforce/schema/Account.Name';
66
+
67
+ export default class GetRecordsExample extends LightningElement {
68
+ @wire(getRecords, {
69
+ records: [
70
+ { recordIds: ['005XXXXXXXXXXXXXXX'], fields: [USER_NAME_FIELD] },
71
+ { recordIds: ['001XXXXXXXXXXXXXXX'], fields: [ACCOUNT_NAME_FIELD] },
72
+ ],
73
+ })
74
+ wiredRecords;
75
+ }
76
+ ```
77
+
78
+ ### Error Handling
79
+
80
+ Errors are included in the `error` property. To identify subrequest errors, check `data.results[].result`.
81
+
82
+ ```json
83
+ {
84
+ "results": [
85
+ {
86
+ "statusCode": 200,
87
+ "result": {
88
+ "apiName": "Contact",
89
+ "fields": {
90
+ "Name": { "value": "Sean Forbes" },
91
+ "Email": { "value": "sean@edge.com" }
92
+ }
93
+ }
94
+ },
95
+ {
96
+ "statusCode": 400,
97
+ "result": [
98
+ {
99
+ "errorCode": "UNKNOWN_EXCEPTION",
100
+ "message": "Record ID is malformed"
101
+ }
102
+ ]
103
+ }
104
+ ]
105
+ }
106
+ ```
107
+
108
+ ### Example: Handling Errors in LWC
109
+
110
+ ```js
111
+ import { LightningElement, api, wire } from 'lwc';
112
+ import { ShowToastEvent } from 'lightning/platformShowToastEvent';
113
+ import { getRecords } from 'lightning/uiRecordApi';
114
+
115
+ const FIELDS = ['Contact.Name', 'Contact.Phone'];
116
+
117
+ export default class LoadContact extends LightningElement {
118
+ @api recordId;
119
+ contacts;
120
+ name;
121
+ phone;
122
+ @wire(getRecords, {
123
+ records: [{ recordIds: ['005XXXXXXXXXXXXXXX'], fields: FIELDS }],
124
+ })
125
+ wiredRecord({ error, data }) {
126
+ if (error) {
127
+ let message = error.body.message || 'Unknown error';
128
+ this.dispatchEvent(
129
+ new ShowToastEvent({
130
+ title: 'Error loading contacts',
131
+ message,
132
+ variant: 'error',
133
+ }),
134
+ );
135
+ } else if (data) {
136
+ this.contacts = data;
137
+ this.name = this.contacts.results[0].result.fields.Name.value;
138
+ this.phone = this.contacts.results[0].result.fields.Phone.value;
139
+ }
140
+ }
141
+ }
142
+ ```
@@ -0,0 +1,10 @@
1
+ // Generated by dts-bundle-generator v9.5.1
2
+
3
+ import { McpProvider, McpTool, Services } from '@salesforce/mcp-provider-api';
4
+
5
+ export declare class LwcExpertsMcpProvider extends McpProvider {
6
+ getName(): string;
7
+ provideTools(_services: Services): Promise<McpTool[]>;
8
+ }
9
+
10
+ export {};