@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,1330 @@
1
+ {
2
+ "title": "LDS Wire Adapter Types Schema",
3
+ "description": "Comprehensive type definitions for Lightning Data Service wire adapters",
4
+ "version": "1.0.0",
5
+ "types": {
6
+ "primitives": {
7
+ "String": {
8
+ "type": "string",
9
+ "description": "Text values"
10
+ },
11
+ "Number": {
12
+ "type": "number",
13
+ "description": "Numeric values"
14
+ },
15
+ "Integer": {
16
+ "type": "integer",
17
+ "description": "Whole number values"
18
+ },
19
+ "Boolean": {
20
+ "type": "boolean",
21
+ "description": "True/false values"
22
+ },
23
+ "Object": {
24
+ "type": "object",
25
+ "description": "Generic object type"
26
+ },
27
+ "Any": {
28
+ "type": "any",
29
+ "description": "Any type value"
30
+ }
31
+ },
32
+ "fieldDataTypes": {
33
+ "address": {
34
+ "type": "string",
35
+ "description": "Address field type"
36
+ },
37
+ "base64": {
38
+ "type": "string",
39
+ "description": "Base64 encoded data"
40
+ },
41
+ "boolean": {
42
+ "type": "boolean",
43
+ "description": "Boolean field type"
44
+ },
45
+ "combobox": {
46
+ "type": "string",
47
+ "description": "Combobox field type"
48
+ },
49
+ "complexvalue": {
50
+ "type": "object",
51
+ "description": "Complex value type"
52
+ },
53
+ "currency": {
54
+ "type": "number",
55
+ "description": "Currency field type"
56
+ },
57
+ "date": {
58
+ "type": "string",
59
+ "format": "date",
60
+ "description": "Date field type"
61
+ },
62
+ "datetime": {
63
+ "type": "string",
64
+ "format": "date-time",
65
+ "description": "DateTime field type"
66
+ },
67
+ "double": {
68
+ "type": "number",
69
+ "description": "Double precision number"
70
+ },
71
+ "email": {
72
+ "type": "string",
73
+ "format": "email",
74
+ "description": "Email field type"
75
+ },
76
+ "encryptedstring": {
77
+ "type": "string",
78
+ "description": "Encrypted string type"
79
+ },
80
+ "int": {
81
+ "type": "integer",
82
+ "description": "Integer field type"
83
+ },
84
+ "location": {
85
+ "type": "object",
86
+ "description": "Location/geolocation type"
87
+ },
88
+ "multipicklist": {
89
+ "type": "array",
90
+ "items": {
91
+ "type": "string"
92
+ },
93
+ "description": "Multi-select picklist"
94
+ },
95
+ "percent": {
96
+ "type": "number",
97
+ "description": "Percentage field type"
98
+ },
99
+ "phone": {
100
+ "type": "string",
101
+ "description": "Phone number field type"
102
+ },
103
+ "picklist": {
104
+ "type": "string",
105
+ "description": "Single-select picklist"
106
+ },
107
+ "reference": {
108
+ "type": "string",
109
+ "description": "Reference/lookup field type"
110
+ },
111
+ "string": {
112
+ "type": "string",
113
+ "description": "String field type"
114
+ },
115
+ "textarea": {
116
+ "type": "string",
117
+ "description": "Text area field type"
118
+ },
119
+ "time": {
120
+ "type": "string",
121
+ "format": "time",
122
+ "description": "Time field type"
123
+ },
124
+ "url": {
125
+ "type": "string",
126
+ "format": "uri",
127
+ "description": "URL field type"
128
+ }
129
+ },
130
+ "coreTypes": {
131
+ "FieldValue": {
132
+ "type": "object",
133
+ "description": "Individual field data container",
134
+ "properties": {
135
+ "displayValue": {
136
+ "type": ["string", "null"],
137
+ "description": "Display-formatted value"
138
+ },
139
+ "value": {
140
+ "type": "any",
141
+ "description": "Raw field value"
142
+ }
143
+ },
144
+ "required": ["value"]
145
+ },
146
+ "Record": {
147
+ "type": "object",
148
+ "description": "Individual record object",
149
+ "properties": {
150
+ "apiName": {
151
+ "type": "string",
152
+ "description": "API name of the record's object"
153
+ },
154
+ "childRelationships": {
155
+ "type": "object",
156
+ "description": "Child relationship records (if requested)"
157
+ },
158
+ "eTag": {
159
+ "type": "string",
160
+ "description": "Entity tag for caching"
161
+ },
162
+ "fields": {
163
+ "type": "object",
164
+ "additionalProperties": {
165
+ "$ref": "#/types/coreTypes/FieldValue"
166
+ },
167
+ "description": "Map of field API names to field values"
168
+ },
169
+ "id": {
170
+ "type": "string",
171
+ "description": "Record ID"
172
+ },
173
+ "lastModifiedById": {
174
+ "type": "string",
175
+ "description": "ID of user who last modified the record"
176
+ },
177
+ "lastModifiedDate": {
178
+ "type": "string",
179
+ "format": "date-time",
180
+ "description": "ISO 8601 date of last modification"
181
+ },
182
+ "recordTypeId": {
183
+ "type": "string",
184
+ "description": "Record type ID"
185
+ },
186
+ "recordTypeInfo": {
187
+ "anyOf": [{ "$ref": "#/types/recordTypes/RecordTypeInfo" }, { "type": "null" }],
188
+ "description": "Record type information"
189
+ },
190
+ "systemModstamp": {
191
+ "type": "string",
192
+ "description": "System modification timestamp"
193
+ },
194
+ "weakEtag": {
195
+ "type": "number",
196
+ "description": "Weak entity tag for comparison"
197
+ }
198
+ },
199
+ "required": ["apiName", "fields", "id"]
200
+ },
201
+ "ErrorDetail": {
202
+ "type": "object",
203
+ "description": "Error information object",
204
+ "properties": {
205
+ "errorCode": {
206
+ "type": "string",
207
+ "description": "Error code (e.g., 'UNKNOWN_EXCEPTION', 'INVALID_ID_FIELD')"
208
+ },
209
+ "message": {
210
+ "type": "string",
211
+ "description": "Human-readable error message"
212
+ }
213
+ },
214
+ "required": ["errorCode", "message"]
215
+ },
216
+ "FetchResponse": {
217
+ "type": "object",
218
+ "description": "Error response object",
219
+ "properties": {
220
+ "status": {
221
+ "type": "number",
222
+ "minimum": 400,
223
+ "maximum": 599,
224
+ "description": "HTTP status code (400-599 range)"
225
+ },
226
+ "body": {
227
+ "type": "object",
228
+ "properties": {
229
+ "message": {
230
+ "type": "string",
231
+ "description": "Human-readable error message"
232
+ },
233
+ "statusCode": {
234
+ "type": "number",
235
+ "description": "HTTP status code"
236
+ },
237
+ "errorCode": {
238
+ "type": "string",
239
+ "description": "Error code identifier"
240
+ }
241
+ },
242
+ "description": "Error details from the underlying API"
243
+ },
244
+ "headers": {
245
+ "type": "object",
246
+ "description": "HTTP response headers"
247
+ },
248
+ "ok": {
249
+ "type": "boolean",
250
+ "const": false,
251
+ "description": "Always false for errors"
252
+ },
253
+ "statusText": {
254
+ "type": "string",
255
+ "description": "HTTP status message"
256
+ },
257
+ "errorType": {
258
+ "type": "string",
259
+ "const": "fetchResponse",
260
+ "description": "Always 'fetchResponse' for fetch errors"
261
+ }
262
+ },
263
+ "required": ["status", "body", "ok", "errorType"]
264
+ }
265
+ },
266
+ "batchTypes": {
267
+ "BatchResult": {
268
+ "type": "object",
269
+ "description": "Individual batch result",
270
+ "properties": {
271
+ "statusCode": {
272
+ "type": "number",
273
+ "description": "HTTP status code for the individual request"
274
+ },
275
+ "result": {
276
+ "anyOf": [
277
+ { "$ref": "#/types/coreTypes/Record" },
278
+ { "$ref": "#/types/objectTypes/ObjectInfo" },
279
+ { "$ref": "#/types/relatedListTypes/RelatedListRecordCollection" },
280
+ {
281
+ "type": "array",
282
+ "items": { "$ref": "#/types/coreTypes/ErrorDetail" }
283
+ }
284
+ ],
285
+ "description": "The result data or error information"
286
+ }
287
+ },
288
+ "required": ["statusCode", "result"]
289
+ },
290
+ "SimplifiedBatchResults": {
291
+ "type": "object",
292
+ "description": "Simplified batch results container",
293
+ "properties": {
294
+ "results": {
295
+ "type": "array",
296
+ "items": { "$ref": "#/types/batchTypes/BatchResult" },
297
+ "description": "Array of result objects"
298
+ }
299
+ },
300
+ "required": ["results"]
301
+ },
302
+ "RecordBatchResult": {
303
+ "type": "object",
304
+ "description": "Individual result in a batch",
305
+ "properties": {
306
+ "statusCode": {
307
+ "type": "number",
308
+ "description": "HTTP status code for the individual record request"
309
+ },
310
+ "result": {
311
+ "anyOf": [
312
+ { "$ref": "#/types/coreTypes/Record" },
313
+ {
314
+ "type": "array",
315
+ "items": { "$ref": "#/types/coreTypes/ErrorDetail" }
316
+ }
317
+ ],
318
+ "description": "Either a Record object or error array"
319
+ }
320
+ },
321
+ "required": ["statusCode", "result"]
322
+ },
323
+ "RecordsBatchResults": {
324
+ "type": "object",
325
+ "description": "Batch of record results",
326
+ "properties": {
327
+ "results": {
328
+ "type": "array",
329
+ "items": { "$ref": "#/types/batchTypes/RecordBatchResult" },
330
+ "description": "Array of result objects for each record request"
331
+ }
332
+ },
333
+ "required": ["results"]
334
+ }
335
+ },
336
+ "requestTypes": {
337
+ "RecordRequest": {
338
+ "type": "object",
339
+ "description": "Request for specific records",
340
+ "properties": {
341
+ "recordIds": {
342
+ "type": "array",
343
+ "items": { "type": "string" },
344
+ "description": "Record IDs from supported objects"
345
+ },
346
+ "fields": {
347
+ "type": "array",
348
+ "items": { "type": "string" },
349
+ "description": "Fields to return"
350
+ },
351
+ "optionalFields": {
352
+ "type": "array",
353
+ "items": { "type": "string" },
354
+ "description": "Additional fields to return"
355
+ }
356
+ },
357
+ "required": ["recordIds"]
358
+ },
359
+ "RelatedListParameter": {
360
+ "type": "object",
361
+ "description": "Parameter for related list requests",
362
+ "properties": {
363
+ "relatedListId": {
364
+ "type": "string",
365
+ "description": "API name of a related list object"
366
+ },
367
+ "fields": {
368
+ "type": "array",
369
+ "items": { "type": "string" },
370
+ "description": "API names of the related list's column fields"
371
+ },
372
+ "optionalFields": {
373
+ "type": "array",
374
+ "items": { "type": "string" },
375
+ "description": "Additional fields in the related list"
376
+ },
377
+ "pageSize": {
378
+ "type": "number",
379
+ "description": "Number of list records to return per page"
380
+ },
381
+ "sortBy": {
382
+ "type": "array",
383
+ "items": { "type": "string" },
384
+ "description": "Field API name(s) to sort by"
385
+ },
386
+ "where": {
387
+ "type": "string",
388
+ "description": "Filter for related list records in GraphQL syntax"
389
+ }
390
+ },
391
+ "required": ["relatedListId"]
392
+ }
393
+ },
394
+ "recordTypes": {
395
+ "RecordTypeInfo": {
396
+ "type": "object",
397
+ "description": "Record type metadata",
398
+ "properties": {
399
+ "available": {
400
+ "type": "boolean",
401
+ "description": "Whether this record type is available to the context user"
402
+ },
403
+ "defaultRecordTypeMapping": {
404
+ "type": "boolean",
405
+ "description": "Whether this record type mapping is the default"
406
+ },
407
+ "master": {
408
+ "type": "boolean",
409
+ "description": "Whether this record type is the master record type"
410
+ },
411
+ "name": {
412
+ "type": "string",
413
+ "description": "The record type's label name"
414
+ },
415
+ "recordTypeId": {
416
+ "type": "string",
417
+ "description": "The ID of the record type"
418
+ }
419
+ },
420
+ "required": ["available", "defaultRecordTypeMapping", "master", "name", "recordTypeId"]
421
+ }
422
+ },
423
+ "objectTypes": {
424
+ "ObjectInfo": {
425
+ "type": "object",
426
+ "description": "Object metadata",
427
+ "properties": {
428
+ "apiName": {
429
+ "type": "string",
430
+ "description": "API name of the object"
431
+ },
432
+ "childRelationships": {
433
+ "type": "array",
434
+ "items": { "$ref": "#/types/relationshipTypes/ChildRelationship" },
435
+ "description": "Array of child relationship information"
436
+ },
437
+ "createable": {
438
+ "type": "boolean",
439
+ "description": "Whether the object allows record creation"
440
+ },
441
+ "custom": {
442
+ "type": "boolean",
443
+ "description": "Whether the object is custom"
444
+ },
445
+ "defaultRecordTypeId": {
446
+ "type": "string",
447
+ "description": "ID of the default record type"
448
+ },
449
+ "deletable": {
450
+ "type": "boolean",
451
+ "description": "Whether the object allows record deletion"
452
+ },
453
+ "dependentFields": {
454
+ "type": "object",
455
+ "description": "Map of dependent field relationships"
456
+ },
457
+ "eTag": {
458
+ "type": "string",
459
+ "description": "ETag for cache validation"
460
+ },
461
+ "feedEnabled": {
462
+ "type": "boolean",
463
+ "description": "Whether Chatter feed is enabled for the object"
464
+ },
465
+ "fields": {
466
+ "type": "object",
467
+ "description": "Map of field metadata keyed by field API name"
468
+ },
469
+ "keyPrefix": {
470
+ "type": "string",
471
+ "description": "Three-character prefix for record IDs"
472
+ },
473
+ "label": {
474
+ "type": "string",
475
+ "description": "Display label for the object"
476
+ },
477
+ "labelPlural": {
478
+ "type": "string",
479
+ "description": "Plural display label for the object"
480
+ },
481
+ "layoutable": {
482
+ "type": "boolean",
483
+ "description": "Whether the object supports page layouts"
484
+ },
485
+ "mruEnabled": {
486
+ "type": "boolean",
487
+ "description": "Whether the object supports most recently used lists"
488
+ },
489
+ "nameFields": {
490
+ "type": "array",
491
+ "items": { "type": "string" },
492
+ "description": "Array of field API names that make up the name field"
493
+ },
494
+ "queryable": {
495
+ "type": "boolean",
496
+ "description": "Whether the object can be queried"
497
+ },
498
+ "recordTypeInfos": {
499
+ "type": "object",
500
+ "additionalProperties": { "$ref": "#/types/recordTypes/RecordTypeInfo" },
501
+ "description": "Map of record type information keyed by record type ID"
502
+ },
503
+ "searchable": {
504
+ "type": "boolean",
505
+ "description": "Whether the object can be searched"
506
+ },
507
+ "searchLayoutable": {
508
+ "type": "boolean",
509
+ "description": "Whether the object supports search layouts"
510
+ },
511
+ "themeInfo": {
512
+ "$ref": "#/types/uiTypes/ThemeInfo",
513
+ "description": "Theme information for the object"
514
+ },
515
+ "updateable": {
516
+ "type": "boolean",
517
+ "description": "Whether the object allows record updates"
518
+ }
519
+ },
520
+ "required": ["apiName", "createable", "custom", "deletable", "updateable"]
521
+ }
522
+ },
523
+ "picklistTypes": {
524
+ "PicklistValue": {
525
+ "type": "object",
526
+ "description": "Individual picklist option",
527
+ "properties": {
528
+ "attributes": {
529
+ "anyOf": [{ "type": "object" }, { "type": "null" }],
530
+ "description": "Additional attributes for the picklist value"
531
+ },
532
+ "label": {
533
+ "type": "string",
534
+ "description": "Display label shown to users"
535
+ },
536
+ "validFor": {
537
+ "type": "array",
538
+ "items": { "type": "number" },
539
+ "description": "Array of controller value indexes this value is valid for"
540
+ },
541
+ "value": {
542
+ "type": "string",
543
+ "description": "The actual picklist value stored in the database"
544
+ }
545
+ },
546
+ "required": ["label", "value", "validFor"]
547
+ },
548
+ "PicklistValues": {
549
+ "type": "object",
550
+ "description": "Picklist field values",
551
+ "properties": {
552
+ "controllerValues": {
553
+ "type": "object",
554
+ "additionalProperties": { "type": "number" },
555
+ "description": "Map of controlling field values to their indexes"
556
+ },
557
+ "defaultValue": {
558
+ "anyOf": [{ "$ref": "#/types/picklistTypes/PicklistValue" }, { "type": "null" }],
559
+ "description": "Default picklist value object, if any"
560
+ },
561
+ "eTag": {
562
+ "type": "string",
563
+ "description": "ETag for cache validation"
564
+ },
565
+ "url": {
566
+ "type": "string",
567
+ "description": "URL to retrieve this picklist field's values"
568
+ },
569
+ "values": {
570
+ "type": "array",
571
+ "items": { "$ref": "#/types/picklistTypes/PicklistValue" },
572
+ "description": "Array of available picklist values"
573
+ }
574
+ },
575
+ "required": ["values", "eTag", "url"]
576
+ },
577
+ "PicklistFieldValues": {
578
+ "type": "object",
579
+ "description": "Picklist field information",
580
+ "properties": {
581
+ "controllerValues": {
582
+ "type": "object",
583
+ "description": "Map of controlling field values to their indexes"
584
+ },
585
+ "defaultValue": {
586
+ "anyOf": [{ "$ref": "#/types/picklistTypes/PicklistValue" }, { "type": "null" }],
587
+ "description": "Default picklist value object, if any"
588
+ },
589
+ "eTag": {
590
+ "type": "string",
591
+ "description": "ETag for the individual picklist field"
592
+ },
593
+ "url": {
594
+ "type": "string",
595
+ "description": "URL to retrieve this specific picklist field's values"
596
+ },
597
+ "values": {
598
+ "type": "array",
599
+ "items": { "$ref": "#/types/picklistTypes/PicklistValue" },
600
+ "description": "Array of available picklist values"
601
+ }
602
+ },
603
+ "required": ["values", "eTag", "url"]
604
+ },
605
+ "PicklistValuesCollection": {
606
+ "type": "object",
607
+ "description": "Collection of picklist values",
608
+ "properties": {
609
+ "eTag": {
610
+ "type": "string",
611
+ "description": "ETag for cache validation"
612
+ },
613
+ "picklistFieldValues": {
614
+ "type": "object",
615
+ "additionalProperties": { "$ref": "#/types/picklistTypes/PicklistFieldValues" },
616
+ "description": "Map of field API names to their picklist values"
617
+ }
618
+ },
619
+ "required": ["eTag", "picklistFieldValues"]
620
+ }
621
+ },
622
+ "relationshipTypes": {
623
+ "ChildRelationship": {
624
+ "type": "object",
625
+ "description": "Child relationship metadata",
626
+ "properties": {
627
+ "childObjectApiName": {
628
+ "type": "string",
629
+ "description": "API name of the child object"
630
+ },
631
+ "fieldName": {
632
+ "type": "string",
633
+ "description": "Name of the field that creates the relationship"
634
+ },
635
+ "junctionIdListNames": {
636
+ "type": "array",
637
+ "items": { "type": "string" },
638
+ "description": "List of junction ID names for many-to-many relationships"
639
+ },
640
+ "junctionReferenceTo": {
641
+ "type": "array",
642
+ "items": { "type": "string" },
643
+ "description": "Reference information for junction objects"
644
+ },
645
+ "relationshipName": {
646
+ "type": "string",
647
+ "description": "Name of the relationship"
648
+ }
649
+ },
650
+ "required": ["childObjectApiName", "fieldName", "relationshipName"]
651
+ }
652
+ },
653
+ "relatedListTypes": {
654
+ "RelatedListReference": {
655
+ "type": "object",
656
+ "description": "Reference to related list",
657
+ "properties": {
658
+ "id": {
659
+ "type": "string",
660
+ "description": "ID of the related list reference"
661
+ },
662
+ "inContextOfRecordId": {
663
+ "type": "string",
664
+ "description": "ID of the parent record for the related list"
665
+ },
666
+ "listViewApiName": {
667
+ "type": "string",
668
+ "description": "API name of the related list"
669
+ },
670
+ "objectApiName": {
671
+ "type": "string",
672
+ "description": "API name of the supported related list object"
673
+ },
674
+ "parentObjectApiName": {
675
+ "type": "string",
676
+ "description": "API name for the parent object of the related list"
677
+ },
678
+ "recordTypeId": {
679
+ "type": "string",
680
+ "description": "Record type ID for the parent of the related list"
681
+ },
682
+ "relatedListId": {
683
+ "type": "string",
684
+ "description": "ID of the related list"
685
+ },
686
+ "type": {
687
+ "type": "string",
688
+ "description": "Type of related list"
689
+ }
690
+ },
691
+ "required": ["id", "listViewApiName", "objectApiName", "parentObjectApiName", "relatedListId", "type"]
692
+ },
693
+ "RelatedListColumn": {
694
+ "type": "object",
695
+ "description": "Column information for related lists",
696
+ "properties": {
697
+ "dataType": {
698
+ "type": "string",
699
+ "enum": [
700
+ "address",
701
+ "base64",
702
+ "boolean",
703
+ "combobox",
704
+ "complexvalue",
705
+ "currency",
706
+ "date",
707
+ "datetime",
708
+ "double",
709
+ "email",
710
+ "encryptedstring",
711
+ "int",
712
+ "location",
713
+ "multipicklist",
714
+ "percent",
715
+ "phone",
716
+ "picklist",
717
+ "reference",
718
+ "string",
719
+ "textarea",
720
+ "time",
721
+ "url"
722
+ ],
723
+ "description": "Field type"
724
+ },
725
+ "fieldApiName": {
726
+ "type": "string",
727
+ "description": "The API name for the field"
728
+ },
729
+ "filterable": {
730
+ "type": "boolean",
731
+ "description": "Indicates whether this column is filterable"
732
+ },
733
+ "label": {
734
+ "type": "string",
735
+ "description": "The label of the field"
736
+ },
737
+ "lookupId": {
738
+ "anyOf": [{ "type": "string" }, { "type": "null" }],
739
+ "description": "The ID of the field if the field is a reference"
740
+ },
741
+ "picklistValues": {
742
+ "anyOf": [
743
+ {
744
+ "type": "array",
745
+ "items": { "type": "string" }
746
+ },
747
+ { "type": "null" }
748
+ ],
749
+ "description": "The picklist values for this field"
750
+ },
751
+ "quickFilterOperator": {
752
+ "type": "string",
753
+ "description": "The operator used for quick filters on this column"
754
+ },
755
+ "sortable": {
756
+ "type": "boolean",
757
+ "description": "Indicates whether the list column is sortable"
758
+ }
759
+ },
760
+ "required": ["dataType", "fieldApiName", "filterable", "label", "sortable"]
761
+ },
762
+ "RelatedListInfo": {
763
+ "type": "object",
764
+ "description": "Related list metadata",
765
+ "properties": {
766
+ "cloneable": {
767
+ "type": "boolean",
768
+ "description": "Indicates whether the related list can be cloned"
769
+ },
770
+ "createable": {
771
+ "type": "boolean",
772
+ "description": "Indicates whether a new related list can be created"
773
+ },
774
+ "deletable": {
775
+ "type": "boolean",
776
+ "description": "Indicates whether the related list can be deleted"
777
+ },
778
+ "displayColumns": {
779
+ "type": "array",
780
+ "items": { "$ref": "#/types/relatedListTypes/RelatedListColumn" },
781
+ "description": "All display columns for this related list"
782
+ },
783
+ "eTag": {
784
+ "type": "string",
785
+ "description": "ETag for cache validation"
786
+ },
787
+ "fieldApiName": {
788
+ "type": "string",
789
+ "description": "The API name of the field in the child object that links to the parent object"
790
+ },
791
+ "fields": {
792
+ "type": "array",
793
+ "items": { "type": "string" },
794
+ "description": "Related list fields queried"
795
+ },
796
+ "filterable": {
797
+ "type": "boolean",
798
+ "description": "Indicates whether users can apply quick filters to the related list"
799
+ },
800
+ "filterLogicString": {
801
+ "type": "string",
802
+ "description": "The filter logic string"
803
+ },
804
+ "filteredByInfo": {
805
+ "type": "array",
806
+ "items": { "$ref": "#/types/listTypes/ListFilterByInfo" },
807
+ "description": "Filtering information for the related list"
808
+ },
809
+ "label": {
810
+ "type": "string",
811
+ "description": "The related list display label"
812
+ },
813
+ "listReference": {
814
+ "$ref": "#/types/relatedListTypes/RelatedListReference",
815
+ "description": "A reference to the related list"
816
+ },
817
+ "objectApiNames": {
818
+ "type": "array",
819
+ "items": { "type": "string" },
820
+ "description": "The API names for the objects returned in the related list"
821
+ },
822
+ "orderedByInfo": {
823
+ "type": "array",
824
+ "items": { "$ref": "#/types/listTypes/ListOrderByInfo" },
825
+ "description": "Ordering information for the related list"
826
+ },
827
+ "optionalFields": {
828
+ "type": "array",
829
+ "items": { "type": "string" },
830
+ "description": "Additional related list fields queried"
831
+ },
832
+ "restrictColumnsToLayout": {
833
+ "type": "boolean",
834
+ "description": "Indicates whether metadata was retrieved for only the list columns in the page layout"
835
+ },
836
+ "updateable": {
837
+ "type": "boolean",
838
+ "description": "Indicates whether the related list can be updated"
839
+ },
840
+ "url": {
841
+ "type": "string",
842
+ "description": "URL to access the related list"
843
+ },
844
+ "userPreferences": {
845
+ "$ref": "#/types/listTypes/ListUserPreference",
846
+ "description": "User preferences for the related list"
847
+ },
848
+ "visibility": {
849
+ "type": "string",
850
+ "description": "The related list's visibility"
851
+ },
852
+ "visibilityEditable": {
853
+ "type": "boolean",
854
+ "description": "Indicates whether the visibility of the related list can be edited"
855
+ }
856
+ },
857
+ "required": [
858
+ "cloneable",
859
+ "createable",
860
+ "deletable",
861
+ "displayColumns",
862
+ "fieldApiName",
863
+ "filterable",
864
+ "label",
865
+ "listReference",
866
+ "updateable",
867
+ "visibility",
868
+ "visibilityEditable"
869
+ ]
870
+ },
871
+ "RelatedListInfoBatch": {
872
+ "type": "object",
873
+ "description": "Batch of related list metadata",
874
+ "properties": {
875
+ "results": {
876
+ "type": "array",
877
+ "items": { "$ref": "#/types/relatedListTypes/RelatedListInfo" },
878
+ "description": "Array of RelatedListInfo objects for each requested related list"
879
+ }
880
+ },
881
+ "required": ["results"]
882
+ },
883
+ "RelatedListCount": {
884
+ "type": "object",
885
+ "description": "Related list count information",
886
+ "properties": {
887
+ "count": {
888
+ "type": "number",
889
+ "description": "The number of records in the related list"
890
+ },
891
+ "hasMore": {
892
+ "type": "boolean",
893
+ "description": "Indicates whether there are more records than the provided count"
894
+ },
895
+ "listReference": {
896
+ "$ref": "#/types/relatedListTypes/RelatedListReference",
897
+ "description": "Reference information for the related list"
898
+ }
899
+ },
900
+ "required": ["count", "hasMore", "listReference"]
901
+ },
902
+ "RelatedListRecordCollection": {
903
+ "type": "object",
904
+ "description": "Collection of related list records",
905
+ "properties": {
906
+ "count": {
907
+ "type": "number",
908
+ "description": "Total number of records available in the related list"
909
+ },
910
+ "currentPageToken": {
911
+ "type": "string",
912
+ "description": "Token representing the current page offset"
913
+ },
914
+ "currentPageUrl": {
915
+ "type": "string",
916
+ "description": "URL for the current page of results"
917
+ },
918
+ "fields": {
919
+ "type": "array",
920
+ "items": { "type": "string" },
921
+ "description": "List of fields requested when these records were fetched"
922
+ },
923
+ "listInfoETag": {
924
+ "type": "string",
925
+ "description": "ETag for the related list information"
926
+ },
927
+ "listReference": {
928
+ "$ref": "#/types/relatedListTypes/RelatedListReference",
929
+ "description": "Reference information for the related list"
930
+ },
931
+ "nextPageToken": {
932
+ "anyOf": [{ "type": "string" }, { "type": "null" }],
933
+ "description": "Token for the next page, if available"
934
+ },
935
+ "nextPageUrl": {
936
+ "anyOf": [{ "type": "string" }, { "type": "null" }],
937
+ "description": "URL for the next page, if available"
938
+ },
939
+ "optionalFields": {
940
+ "type": "array",
941
+ "items": { "type": "string" },
942
+ "description": "List of optional fields requested when these records were fetched"
943
+ },
944
+ "pageSize": {
945
+ "type": "number",
946
+ "description": "Number of records per page"
947
+ },
948
+ "previousPageToken": {
949
+ "anyOf": [{ "type": "string" }, { "type": "null" }],
950
+ "description": "Token for the previous page, if available"
951
+ },
952
+ "previousPageUrl": {
953
+ "anyOf": [{ "type": "string" }, { "type": "null" }],
954
+ "description": "URL for the previous page, if available"
955
+ },
956
+ "records": {
957
+ "type": "array",
958
+ "items": { "$ref": "#/types/coreTypes/Record" },
959
+ "description": "Array of record objects"
960
+ },
961
+ "sortBy": {
962
+ "type": "string",
963
+ "description": "Sort criteria applied to the records"
964
+ },
965
+ "where": {
966
+ "type": "string",
967
+ "description": "Filter clause applied to the records"
968
+ }
969
+ },
970
+ "required": ["count", "listReference", "pageSize", "records"]
971
+ },
972
+ "RelatedListSummary": {
973
+ "type": "object",
974
+ "description": "Summary of related list",
975
+ "properties": {
976
+ "apiName": {
977
+ "type": "string",
978
+ "description": "API name of the related list"
979
+ },
980
+ "displayColumns": {
981
+ "type": "array",
982
+ "items": { "$ref": "#/types/relatedListTypes/RelatedListColumn" },
983
+ "description": "Array of display column information"
984
+ },
985
+ "id": {
986
+ "type": "string",
987
+ "description": "Unique identifier for the related list"
988
+ },
989
+ "label": {
990
+ "type": "string",
991
+ "description": "Display label for the related list"
992
+ },
993
+ "listReference": {
994
+ "$ref": "#/types/relatedListTypes/RelatedListReference",
995
+ "description": "Reference information for the related list"
996
+ },
997
+ "orderedByInfo": {
998
+ "type": "array",
999
+ "items": { "$ref": "#/types/listTypes/ListOrderByInfo" },
1000
+ "description": "Array of ordering information"
1001
+ },
1002
+ "relatedListId": {
1003
+ "type": "string",
1004
+ "description": "Unique identifier for the related list"
1005
+ },
1006
+ "url": {
1007
+ "type": "string",
1008
+ "description": "URL to access the related list"
1009
+ }
1010
+ },
1011
+ "required": ["apiName", "displayColumns", "id", "label", "listReference", "relatedListId", "url"]
1012
+ },
1013
+ "RelatedListSummaryCollection": {
1014
+ "type": "object",
1015
+ "description": "Collection of related list summaries",
1016
+ "properties": {
1017
+ "count": {
1018
+ "type": "number",
1019
+ "description": "Total number of related lists in the collection"
1020
+ },
1021
+ "currentPageToken": {
1022
+ "type": "string",
1023
+ "description": "Token representing the current page offset"
1024
+ },
1025
+ "currentPageUrl": {
1026
+ "type": "string",
1027
+ "description": "URL for the current page of results"
1028
+ },
1029
+ "eTag": {
1030
+ "type": "string",
1031
+ "description": "ETag for cache validation"
1032
+ },
1033
+ "lists": {
1034
+ "type": "array",
1035
+ "items": { "$ref": "#/types/relatedListTypes/RelatedListSummary" },
1036
+ "description": "Array of related list summary objects"
1037
+ },
1038
+ "nextPageToken": {
1039
+ "anyOf": [{ "type": "string" }, { "type": "null" }],
1040
+ "description": "Token for the next page, if available"
1041
+ },
1042
+ "nextPageUrl": {
1043
+ "anyOf": [{ "type": "string" }, { "type": "null" }],
1044
+ "description": "URL for the next page, if available"
1045
+ },
1046
+ "objectApiName": {
1047
+ "type": "string",
1048
+ "description": "API name of the parent object"
1049
+ },
1050
+ "pageSize": {
1051
+ "type": "number",
1052
+ "description": "Number of items per page"
1053
+ },
1054
+ "previousPageToken": {
1055
+ "anyOf": [{ "type": "string" }, { "type": "null" }],
1056
+ "description": "Token for the previous page, if available"
1057
+ },
1058
+ "previousPageUrl": {
1059
+ "anyOf": [{ "type": "string" }, { "type": "null" }],
1060
+ "description": "URL for the previous page, if available"
1061
+ }
1062
+ },
1063
+ "required": ["count", "eTag", "lists", "objectApiName", "pageSize"]
1064
+ }
1065
+ },
1066
+ "listTypes": {
1067
+ "ListFilterByInfo": {
1068
+ "type": "object",
1069
+ "description": "Filter information for lists",
1070
+ "properties": {
1071
+ "fieldApiName": {
1072
+ "type": "string",
1073
+ "description": "The API name for the field used to filter the list"
1074
+ },
1075
+ "label": {
1076
+ "type": "string",
1077
+ "description": "The label for the field used to filter the list"
1078
+ },
1079
+ "operandLabels": {
1080
+ "type": "array",
1081
+ "items": { "type": "string" },
1082
+ "description": "The values used to filter the list"
1083
+ },
1084
+ "operator": {
1085
+ "type": "string",
1086
+ "enum": [
1087
+ "Contains",
1088
+ "Equals",
1089
+ "Excludes",
1090
+ "GreaterOrEqual",
1091
+ "GreaterThan",
1092
+ "Includes",
1093
+ "LessOrEqual",
1094
+ "LessThan",
1095
+ "NotContain",
1096
+ "NotEqual",
1097
+ "StartsWith",
1098
+ "Within"
1099
+ ],
1100
+ "description": "The filter operator"
1101
+ }
1102
+ },
1103
+ "required": ["fieldApiName", "label", "operandLabels", "operator"]
1104
+ },
1105
+ "ListOrderByInfo": {
1106
+ "type": "object",
1107
+ "description": "Ordering information for lists",
1108
+ "properties": {
1109
+ "fieldApiName": {
1110
+ "type": "string",
1111
+ "description": "The API name for the field"
1112
+ },
1113
+ "isAscending": {
1114
+ "type": "boolean",
1115
+ "description": "Indicates whether the list column is ascending or descending"
1116
+ },
1117
+ "label": {
1118
+ "type": "string",
1119
+ "description": "The localized label of the field"
1120
+ }
1121
+ },
1122
+ "required": ["fieldApiName", "isAscending", "label"]
1123
+ },
1124
+ "ListUserPreference": {
1125
+ "type": "object",
1126
+ "description": "User preferences for lists",
1127
+ "properties": {
1128
+ "columnWidths": {
1129
+ "type": "object",
1130
+ "additionalProperties": { "type": "number" },
1131
+ "description": "Column width preferences as a map of field names to widths"
1132
+ },
1133
+ "columnWrap": {
1134
+ "type": "object",
1135
+ "additionalProperties": { "type": "boolean" },
1136
+ "description": "Column text wrapping preferences as a map of field names to wrap settings"
1137
+ },
1138
+ "orderedBy": {
1139
+ "$ref": "#/types/listTypes/ListOrderByInfo",
1140
+ "description": "Ordering information for the related list"
1141
+ },
1142
+ "preferencesId": {
1143
+ "type": "string",
1144
+ "description": "The related list ID for the user preferences"
1145
+ }
1146
+ },
1147
+ "required": ["preferencesId"]
1148
+ }
1149
+ },
1150
+ "uiTypes": {
1151
+ "ThemeInfo": {
1152
+ "type": "object",
1153
+ "description": "Theme information for objects",
1154
+ "properties": {
1155
+ "color": {
1156
+ "type": "string",
1157
+ "pattern": "^#[0-9A-Fa-f]{6}$",
1158
+ "description": "Hex color code for the object's theme"
1159
+ },
1160
+ "iconUrl": {
1161
+ "type": "string",
1162
+ "format": "uri",
1163
+ "description": "URL to the object's icon"
1164
+ }
1165
+ },
1166
+ "required": ["color", "iconUrl"]
1167
+ },
1168
+ "FilteredLookupInfo": {
1169
+ "type": "object",
1170
+ "description": "Information for filtered lookup fields",
1171
+ "properties": {
1172
+ "controllingFields": {
1173
+ "type": "array",
1174
+ "items": { "type": "string" },
1175
+ "description": "Fields that control the filtering"
1176
+ },
1177
+ "dependent": {
1178
+ "type": "boolean",
1179
+ "description": "Whether the lookup is dependent on other fields"
1180
+ },
1181
+ "optionalFilter": {
1182
+ "type": "boolean",
1183
+ "description": "Whether the filter is optional"
1184
+ }
1185
+ },
1186
+ "required": ["dependent", "optionalFilter"]
1187
+ }
1188
+ },
1189
+ "collectionTypes": {
1190
+ "RecordCollection": {
1191
+ "type": "object",
1192
+ "description": "Collection of records",
1193
+ "properties": {
1194
+ "count": {
1195
+ "type": "number",
1196
+ "description": "Total number of records in the collection"
1197
+ },
1198
+ "records": {
1199
+ "type": "array",
1200
+ "items": { "$ref": "#/types/coreTypes/Record" },
1201
+ "description": "Array of record objects"
1202
+ }
1203
+ },
1204
+ "required": ["count", "records"]
1205
+ }
1206
+ }
1207
+ },
1208
+ "wireAdapterResponses": {
1209
+ "getRecord": {
1210
+ "success": {
1211
+ "data": { "$ref": "#/types/coreTypes/Record" },
1212
+ "error": null
1213
+ },
1214
+ "error": {
1215
+ "data": null,
1216
+ "error": { "$ref": "#/types/coreTypes/FetchResponse" }
1217
+ }
1218
+ },
1219
+ "getRecords": {
1220
+ "success": {
1221
+ "data": { "$ref": "#/types/batchTypes/RecordsBatchResults" },
1222
+ "error": null
1223
+ },
1224
+ "error": {
1225
+ "data": null,
1226
+ "error": { "$ref": "#/types/coreTypes/FetchResponse" }
1227
+ }
1228
+ },
1229
+ "getObjectInfo": {
1230
+ "success": {
1231
+ "data": { "$ref": "#/types/objectTypes/ObjectInfo" },
1232
+ "error": null
1233
+ },
1234
+ "error": {
1235
+ "data": null,
1236
+ "error": { "$ref": "#/types/coreTypes/FetchResponse" }
1237
+ }
1238
+ },
1239
+ "getObjectInfos": {
1240
+ "success": {
1241
+ "data": { "$ref": "#/types/batchTypes/SimplifiedBatchResults" },
1242
+ "error": null
1243
+ },
1244
+ "error": {
1245
+ "data": null,
1246
+ "error": { "$ref": "#/types/coreTypes/FetchResponse" }
1247
+ }
1248
+ },
1249
+ "getPicklistValues": {
1250
+ "success": {
1251
+ "data": { "$ref": "#/types/picklistTypes/PicklistValues" },
1252
+ "error": null
1253
+ },
1254
+ "error": {
1255
+ "data": null,
1256
+ "error": { "$ref": "#/types/coreTypes/FetchResponse" }
1257
+ }
1258
+ },
1259
+ "getPicklistValuesByRecordType": {
1260
+ "success": {
1261
+ "data": { "$ref": "#/types/picklistTypes/PicklistValuesCollection" },
1262
+ "error": null
1263
+ },
1264
+ "error": {
1265
+ "data": null,
1266
+ "error": { "$ref": "#/types/coreTypes/FetchResponse" }
1267
+ }
1268
+ },
1269
+ "getRelatedListInfo": {
1270
+ "success": {
1271
+ "data": { "$ref": "#/types/relatedListTypes/RelatedListInfo" },
1272
+ "error": null
1273
+ },
1274
+ "error": {
1275
+ "data": null,
1276
+ "error": { "$ref": "#/types/coreTypes/FetchResponse" }
1277
+ }
1278
+ },
1279
+ "getRelatedListInfoBatch": {
1280
+ "success": {
1281
+ "data": { "$ref": "#/types/relatedListTypes/RelatedListInfoBatch" },
1282
+ "error": null
1283
+ },
1284
+ "error": {
1285
+ "data": null,
1286
+ "error": { "$ref": "#/types/coreTypes/FetchResponse" }
1287
+ }
1288
+ },
1289
+ "getRelatedListRecords": {
1290
+ "success": {
1291
+ "data": { "$ref": "#/types/relatedListTypes/RelatedListRecordCollection" },
1292
+ "error": null
1293
+ },
1294
+ "error": {
1295
+ "data": null,
1296
+ "error": { "$ref": "#/types/coreTypes/FetchResponse" }
1297
+ }
1298
+ },
1299
+ "getRelatedListRecordsBatch": {
1300
+ "success": {
1301
+ "data": { "$ref": "#/types/batchTypes/SimplifiedBatchResults" },
1302
+ "error": null
1303
+ },
1304
+ "error": {
1305
+ "data": null,
1306
+ "error": { "$ref": "#/types/coreTypes/FetchResponse" }
1307
+ }
1308
+ },
1309
+ "getRelatedListCount": {
1310
+ "success": {
1311
+ "data": { "$ref": "#/types/relatedListTypes/RelatedListCount" },
1312
+ "error": null
1313
+ },
1314
+ "error": {
1315
+ "data": null,
1316
+ "error": { "$ref": "#/types/coreTypes/FetchResponse" }
1317
+ }
1318
+ },
1319
+ "getRelatedListsInfo": {
1320
+ "success": {
1321
+ "data": { "$ref": "#/types/relatedListTypes/RelatedListSummaryCollection" },
1322
+ "error": null
1323
+ },
1324
+ "error": {
1325
+ "data": null,
1326
+ "error": { "$ref": "#/types/coreTypes/FetchResponse" }
1327
+ }
1328
+ }
1329
+ }
1330
+ }