@salesforce/lds-adapters-uiapi 1.244.0 → 1.246.0

package/sfdc/uiapi-static-functions.js

@@ -95,11 +95,11 @@ var TypeCheckShapes;
     TypeCheckShapes[TypeCheckShapes["Integer"] = 3] = "Integer";
     TypeCheckShapes[TypeCheckShapes["Unsupported"] = 4] = "Unsupported";
 })(TypeCheckShapes || (TypeCheckShapes = {}));
-// engine version: 0.150.3-a08cc935
+// engine version: 0.150.6-26328503
 
 const { keys: ObjectKeys, create: ObjectCreate } = Object;
 
-const { assign, create, freeze, keys } = Object;
+const { assign, create, freeze, isFrozen, keys } = Object;
 
 function isString(value) {
     return typeof value === 'string';

package/src/raml/api.raml

@@ -1232,6 +1232,10 @@ types:
         description: The lookupId for the column when the field is a reference, otherwise
           null.
         type: string | nil
+      searchable:
+        description: Whether the list column is searchable.
+        type: boolean
+        required: false # TODO: W-12761618 - make this required once LWC OH is ready for GA
       sortable:
         description: Whether the list column is sortable.
         type: boolean
@@ -1460,6 +1464,10 @@ types:
         description: Scope information for this list view.
         type: ListScopeRepresentation | nil # TODO: hand rolled
         required: false # TODO: W-12761618 - make this required once LWC OH is ready for GA
+      searchable:
+        description: Indicates whether the listview can be searched (SOSL).
+        type: boolean
+        required: false # TODO: W-12761618 - make this required once LWC OH is ready for GA
       updateable:
         description: Indicates whether the listview can be updated.
         type: boolean
@@ -1678,6 +1686,30 @@ types:
       isAscending:
         description: Boolean describing if the orderBy should be ascending.
         type: boolean
+  ListPreferencesRepresentation:
+    description: ListPreferencesRepresentation
+    type: object
+    properties:
+      columnWidths:
+        description: Column width preferences for the list.
+        type: object
+        properties:
+          //:
+            type: integer
+      columnWrap:
+        description: Column wrapping preferences for the list.
+        type: object
+        properties:
+          //:
+            type: boolean
+      listReference:
+        description: Reference information for the list.
+        type: ListReferenceRepresentation
+      orderedBy:
+        description: Ordering preference for the list.
+        type: array
+        items:
+          type: ListOrderByInfoRepresentation
   ListRecordCollectionRepresentation:
     description: ListRecordCollectionRepresentation
     type: object
@@ -1728,6 +1760,9 @@ types:
         type: array
         items:
           type: RecordRepresentation
+      searchTerm:
+        description: The searchTerm field requested when these records were fetched.
+        type: string | nil
       sortBy:
         description: The sortBy field requested when these records were fetched.
         type: string[] | nil # TODO: hand rolled
@@ -1772,9 +1807,11 @@ types:
       entityId:
         description: Input representation for the scope's entity id.
         type: string | nil
+        required: false
       relatedEntityId:
         description: Input representation for the scope's related entity id.
         type: string | nil
+        required: false
   ListScopeRelatedEntityRepresentation:
     description: ListScopeRelatedEntityRepresentation
     type: object
@@ -1991,6 +2028,16 @@ types:
               secondaryField:
                 description: API name of the field used as a secondary display field.
                 type: string | nil
+  LookupPOSTRequestBodyRepresentation:
+    description: A lookup POST request body.
+    type: object
+    properties:
+      sourceRecord:
+        description: The source record
+        # A bug in the keybuilder code generation forces us to support nil when the property is not required
+        # We can remove the support of nil as soon as W-14087127 is fixed.
+        type: RecordInputRepresentation | nil
+        required: false
   MatchRepresentation:
     description: 'Representation of group of possible matches '
     type: object
@@ -5819,6 +5866,24 @@ types:
         objectApiName:
           type: string
           required: true
+  /list-preferences:
+    /{objectApiName}/{listViewApiName}:
+      get:
+        displayName: getListPreferences
+        description: Retrieve list preferences
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ListPreferencesRepresentation
+      uriParameters:
+        listViewApiName:
+          type: string
+          required: true
+        objectApiName:
+          type: string
+          required: true
   /list-records:
     /{listViewId}:
       get:
@@ -5850,6 +5915,9 @@ types:
           pageToken:
             type: string
             required: false
+          searchTerm:
+            type: string
+            required: false
           sortBy:
             type: array
             required: false
@@ -5890,6 +5958,9 @@ types:
           pageToken:
             type: string
             required: false
+          searchTerm:
+            type: string
+            required: false
           sortBy:
             type: array
             required: false
@@ -6016,8 +6087,8 @@ types:
           type: string
           required: true
   /lookups/{objectApiName}/{fieldApiName}:
-    get:
-      displayName: getLookup
+    post:
+      displayName: getLookupRecords
       description: Returns record search results for the given lookup field.
       responses:
         '200':
@@ -6025,6 +6096,10 @@ types:
           body:
             application/json:
               type: LookupValuesRepresentation
+      body:
+        application/json:
+          type: LookupPOSTRequestBodyRepresentation
+          (oas-body-name): body
       queryParameters:
         dependentFieldBindings:
           type: array

package/src/raml/luvio.raml

@@ -103,6 +103,13 @@ types:
     (luvio.key):
       objectApiName: objectApiName
     (luvio.ttl): 900000
+  ListPreferencesRepresentation:
+    examples:
+      mockListPreferences: !include ../mocks/types/ListPreferencesRepresentation/mockListPreferencesAccountAllAccounts.json
+    (luvio.key):
+      objectApiName: listReference.objectApiName
+      listViewApiName: listReference.listViewApiName
+    (luvio.ttl): 900000
   ListRecordCollectionRepresentation:
     (luvio.ttl): 30000
     (luvio.private):
@@ -114,6 +121,7 @@ types:
     # the list.
     (luvio.key):
       listViewId: listInfoETag
+      searchTerm: searchTerm
       sortBy: sortBy
       objectApiName: listReference.objectApiName
       listViewApiName: listReference.listViewApiName
@@ -238,6 +246,9 @@ types:
       - eTag
     (luvio.private):
       - eTag
+  ObjectInfoDirectoryEntryRepresentation:
+    (luvio.key):
+      objectInfoUrl: objectInfoUrl
   PageReferenceRepresentation:
     (luvio.opaque): true
   AbstractRecordAvatarBatchRepresentation:
@@ -882,12 +893,38 @@ types:
             objectApiName: SalesforceObjectId
         (luvio.key):
           objectApiName: urlParams.objectApiName
+  /list-preferences:
+    '/{objectApiName}/{listViewApiName}':
+      uriParameters:
+        objectApiName:
+          examples:
+            mockListPreferences: Account
+        listViewApiName:
+          examples:
+            mockListPreferences: AllAccounts
+      get:
+        (luvio.adapter):
+          name: getListPreferences
+          tests:
+            expectedResponses:
+              - configInput: |
+                  {
+                    "objectApiName": "Account",
+                    "listViewApiName": "AllAccounts"
+                  }
+                mockPayloadId: mockListPreferences
+          coercedParams:
+            objectApiName: SalesforceObjectId
+        (luvio.key):
+          objectApiName: urlParams.objectApiName
+          listViewApiName: urlParams.listViewApiName
   /list-records:
     '/{listViewId}':
       get:
         (luvio.key):
           listViewId: urlParams.listViewId
           sortBy: queryParams.sortBy || null
+          searchTerm: queryParams.searchTerm || null
           objectApiName: '""'
           listViewApiName: '""'
     '/{objectApiName}/{listViewApiName}':
@@ -906,6 +943,7 @@ types:
           objectApiName: urlParams.objectApiName
           listViewApiName: urlParams.listViewApiName
           listViewId: '""'
+          searchTerm: queryParams.searchTerm || null
           sortBy: queryParams.sortBy || []
         (luvio.paginationParams):
           queryParameters:
@@ -978,25 +1016,10 @@ types:
       fieldApiName:
         examples:
           mockGetLookupRecords: ContactId
-    get:
+    post:
+      (luvio.method): get
       (luvio.adapter):
         name: getLookupRecords
-        # TODO: W-9927420 uncomment when getLookupRecords supports offline
-        # tests:
-        #   expectedResponses:
-        #     - configInput: |
-        #         {
-        #           "fieldApiName": "Case.ContactId",
-        #           "targetApiName": "Contact",
-        #           "requestParams": {
-        #             "q": "jak",
-        #             "pageSize": 10,
-        #             "searchType": "TypeAhead",
-        #             "page": 1,
-        #             "sourceRecordId": ""
-        #           }
-        #         }
-        #       mockPayloadId: mockGetLookupRecords
         coercedParams:
           fieldApiName: SalesforceFieldId
   /nav-items:
@@ -1159,6 +1182,9 @@ types:
                 }
               mockPayloadId: mockGetRecordUiResponse
   /object-info:
+    get:
+      (luvio.adapter):
+        name: getObjectInfoDirectory
     '/batch/{objectApiNames}':
       uriParameters:
         objectApiNames: