@salesforce/lds-adapters-uiapi 1.245.0 → 1.247.0

package/sfdc/uiapi-static-functions.js

@@ -95,7 +95,7 @@ var TypeCheckShapes;
     TypeCheckShapes[TypeCheckShapes["Integer"] = 3] = "Integer";
     TypeCheckShapes[TypeCheckShapes["Unsupported"] = 4] = "Unsupported";
 })(TypeCheckShapes || (TypeCheckShapes = {}));
-// engine version: 0.150.5-275045c5
+// engine version: 0.151.0-f29c1c57
 
 const { keys: ObjectKeys, create: ObjectCreate } = Object;
 

package/src/raml/api.raml

@@ -1686,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
@@ -1736,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
@@ -5803,6 +5830,12 @@ types:
             body:
               application/json:
                 type: ListInfoRepresentation
+      delete:
+        displayName: deleteListInfo
+        description: Delete a listview.
+        responses:
+          '200':
+            description: Success
       patch:
         displayName: patchListInfo
         description: Update list info
@@ -5839,6 +5872,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:
@@ -5870,6 +5921,9 @@ types:
           pageToken:
             type: string
             required: false
+          searchTerm:
+            type: string
+            required: false
           sortBy:
             type: array
             required: false
@@ -5910,6 +5964,9 @@ types:
           pageToken:
             type: string
             required: false
+          searchTerm:
+            type: string
+            required: false
           sortBy:
             type: array
             required: false

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:
@@ -857,6 +868,13 @@ types:
           objectApiName: urlParams.objectApiName
           listViewApiName: urlParams.listViewApiName
           type: '"listView"'
+      delete:
+        (luvio.adapter):
+          name: deleteListInfo
+        (luvio.key):
+          objectApiName: urlParams.objectApiName
+          listViewApiName: urlParams.listViewApiName
+          type: '"listView"'
       patch:
         (luvio.adapter):
           name: updateListInfoByName
@@ -882,12 +900,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 +950,7 @@ types:
           objectApiName: urlParams.objectApiName
           listViewApiName: urlParams.listViewApiName
           listViewId: '""'
+          searchTerm: queryParams.searchTerm || null
           sortBy: queryParams.sortBy || []
         (luvio.paginationParams):
           queryParameters:
@@ -1144,6 +1189,9 @@ types:
                 }
               mockPayloadId: mockGetRecordUiResponse
   /object-info:
+    get:
+      (luvio.adapter):
+        name: getObjectInfoDirectory
     '/batch/{objectApiNames}':
       uriParameters:
         objectApiNames:

package/src/raml/uiapi.graphql

@@ -49,7 +49,6 @@ type StringAggregate implements FieldValue {
 
 type Query {
   uiapi: UIAPI!
-  rateLimit: RateLimit
 }
 
 input EmailOperators {
@@ -138,6 +137,10 @@ type RecordTypeInfo {
   recordTypeId: ID
 }
 
+input UIAPIMutationsInput {
+  allOrNone: Boolean = true
+}
+
 type BooleanValue implements FieldValue {
   value: Boolean
   displayValue: String
@@ -265,7 +268,7 @@ input StringOperators {
 type UIAPI {
   query: RecordQuery!
   aggregate: RecordQueryAggregate!
-  objectInfos(apiNames: [String]): [ObjectInfo]
+  objectInfos(apiNames: [String], locale: String): [ObjectInfo]
   relatedListByName(parentApiName: String!, relatedListName: String!): RelatedListInfo
 }
 
@@ -332,6 +335,17 @@ type MultiPicklistValue implements FieldValue {
   label: String
 }
 
+input DatePrimitiveOperators {
+  eq: Date
+  ne: Date
+  lt: Date
+  gt: Date
+  lte: Date
+  gte: Date
+  in: [Date]
+  nin: [Date]
+}
+
 type TimeAggregate implements FieldValue {
   value: Time
   displayValue: String
@@ -418,7 +432,7 @@ input AggregateOrderBy @generic {
   orderableGeolocationField: OrderByGeolocationClause @fieldCategory
   orderableParentRelationship: AggregateOrderBy @fieldCategory
   orderablePolymorphicParentRelationship: PolymorphicParentRelationshipOrderBy @fieldCategory
-  type: String = ORDER_BY
+  type: String = ORDER_BY # Handrolled
 }
 
 input GroupByClause {
@@ -506,8 +520,8 @@ enum DataType {
 }
 
 enum NullOrder {
-  LAST
   FIRST
+  LAST
 }
 
 type PhoneNumberValue implements FieldValue {
@@ -671,29 +685,29 @@ type UrlAggregate implements FieldValue {
 }
 
 enum DateLiteral {
-  TODAY
-  LAST_90_DAYS
-  LAST_YEAR
-  NEXT_YEAR
-  TOMORROW
   NEXT_QUARTER
-  LAST_WEEK
-  NEXT_90_DAYS
-  THIS_YEAR
-  LAST_FISCAL_QUARTER
-  LAST_QUARTER
   THIS_FISCAL_YEAR
-  THIS_MONTH
-  THIS_FISCAL_QUARTER
-  THIS_QUARTER
-  NEXT_FISCAL_QUARTER
   NEXT_FISCAL_YEAR
+  THIS_WEEK
+  LAST_YEAR
+  NEXT_FISCAL_QUARTER
+  THIS_MONTH
+  THIS_YEAR
   LAST_FISCAL_YEAR
+  LAST_WEEK
+  LAST_90_DAYS
+  THIS_FISCAL_QUARTER
+  NEXT_YEAR
+  NEXT_90_DAYS
+  LAST_QUARTER
+  LAST_FISCAL_QUARTER
   NEXT_WEEK
+  TODAY
   YESTERDAY
-  THIS_WEEK
-  NEXT_MONTH
   LAST_MONTH
+  TOMORROW
+  NEXT_MONTH
+  THIS_QUARTER
 }
 
 type __EnumValue {
@@ -1000,7 +1014,7 @@ input DateFunctionInput {
 
 # Mutations aren't supported yet.
 #type Mutation {
-#  uiapi: UIAPIMutations!
+#  uiapi(input: UIAPIMutationsInput): UIAPIMutations!
 #}
 
 type DependentField {
@@ -1122,6 +1136,7 @@ type ObjectInfo {
   searchable: Boolean!
   themeInfo: ThemeInfo
   updateable: Boolean!
+  locale: String
 }
 
 input LongitudeOperators {
@@ -1242,8 +1257,8 @@ type UIAPIMutations {
 }
 
 input DateTimeFunctionInput {
-  value: DateTimePrimitiveOperators
-  convertTimezoneValue: DateTimePrimitiveOperators
+  value: DatePrimitiveOperators
+  convertTimezoneValue: DatePrimitiveOperators
 }
 
 type Base64Value implements FieldValue {
@@ -1334,17 +1349,6 @@ input DateTimeInput {
   range: DateRange
 }
 
-input DateTimePrimitiveOperators {
-  eq: DateTime
-  ne: DateTime
-  lt: DateTime
-  gt: DateTime
-  lte: DateTime
-  gte: DateTime
-  in: [DateTime]
-  nin: [DateTime]
-}
-
 type ChildRelationship {
   childObjectApiName: String!
   fieldName: String
@@ -1391,10 +1395,10 @@ type DateFunctionAggregation {
 }
 
 type RecordQuery {
-  # scope should be type RecordScope but it cannot currently be used
+  # scope should be type RecordScope but that's empty enum.
   recordQuery(first: Int, after: String, where: RecordFilter, orderBy: RecordOrderBy, scope: String, upperBound: Int): RecordConnection @fieldCategory
 }
 
 directive @generic on OBJECT | INTERFACE | UNION | ENUM | INPUT_OBJECT
 directive @fieldCategory on FIELD_DEFINITION | ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION | ENUM_VALUE
-directive @category on FIELD
+directive @category(name: String!) on FIELD