@salesforce/lds-adapters-uiapi 1.248.0 → 1.250.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 (26) hide show
  1. package/dist/es/es2018/types/src/generated/adapters/getKeywordSearchResults.d.ts +3 -3
  2. package/dist/es/es2018/types/src/generated/adapters/getSearchFilterMetadata.d.ts +3 -3
  3. package/dist/es/es2018/types/src/generated/adapters/getSearchResults.d.ts +3 -3
  4. package/dist/es/es2018/types/src/generated/resources/getUiApiSearchInfoFiltersByObjectApiName.d.ts +3 -1
  5. package/dist/es/es2018/types/src/generated/resources/postUiApiSearchResults.d.ts +1 -1
  6. package/dist/es/es2018/types/src/generated/resources/postUiApiSearchResultsKeyword.d.ts +1 -1
  7. package/dist/es/es2018/types/src/generated/types/KeywordSearchRequestInputRepresentation.d.ts +4 -1
  8. package/dist/es/es2018/types/src/generated/types/KeywordSearchResultsSummaryRepresentation.d.ts +7 -1
  9. package/dist/es/es2018/types/src/generated/types/ListInfoShareRepresentation.d.ts +4 -4
  10. package/dist/es/es2018/types/src/generated/types/SearchDataCategoryFilterDefinitionRepresentation.d.ts +34 -0
  11. package/dist/es/es2018/types/src/generated/types/{SearchFilterAttributesRepresentation.d.ts → SearchFieldFilterAttributesRepresentation.d.ts} +8 -8
  12. package/dist/es/es2018/types/src/generated/types/SearchFieldFilterDefinitionRepresentation.d.ts +39 -0
  13. package/dist/es/es2018/types/src/generated/types/{SearchFilterSelectAttributesRepresentation.d.ts → SearchFieldFilterSelectAttributesRepresentation.d.ts} +10 -7
  14. package/dist/es/es2018/types/src/generated/types/SearchFieldFilterTextAttributesRepresentation.d.ts +30 -0
  15. package/dist/es/es2018/types/src/generated/types/SearchFilterDefinitionRepresentation.d.ts +16 -16
  16. package/dist/es/es2018/types/src/generated/types/SearchFilterMetadataCollectionRepresentation.d.ts +12 -4
  17. package/dist/es/es2018/types/src/generated/types/SearchRequestInputRepresentation.d.ts +4 -1
  18. package/dist/es/es2018/types/src/generated/types/SearchResultsSummaryRepresentation.d.ts +7 -1
  19. package/dist/es/es2018/uiapi-records-service.js +1057 -1157
  20. package/package.json +1 -1
  21. package/sfdc/graphqlAdapters.js +21 -14
  22. package/sfdc/index.js +1038 -1139
  23. package/sfdc/uiapi-static-functions.js +1 -1
  24. package/src/raml/api.raml +88 -33
  25. package/src/raml/luvio.raml +7 -0
  26. package/dist/es/es2018/types/src/generated/types/SearchFilterTextAttributesRepresentation.d.ts +0 -30
@@ -95,7 +95,7 @@ var TypeCheckShapes;
95
95
  TypeCheckShapes[TypeCheckShapes["Integer"] = 3] = "Integer";
96
96
  TypeCheckShapes[TypeCheckShapes["Unsupported"] = 4] = "Unsupported";
97
97
  })(TypeCheckShapes || (TypeCheckShapes = {}));
98
- // engine version: 0.151.1-fc3a996e
98
+ // engine version: 0.152.2-f6f687b3
99
99
 
100
100
  const { keys: ObjectKeys, create: ObjectCreate } = Object;
101
101
 
package/src/raml/api.raml CHANGED
@@ -1165,6 +1165,10 @@ types:
1165
1165
  description: Input parameters to request on Search for keyword type
1166
1166
  type: object
1167
1167
  properties:
1168
+ configurationName:
1169
+ description: A configuration name defined in Search Manager
1170
+ type: string
1171
+ required: false #TODO: handrolled for W-13591079
1168
1172
  filters:
1169
1173
  description: Filters to apply on our results
1170
1174
  type: array
@@ -1197,6 +1201,9 @@ types:
1197
1201
  description: Root of the keyword search response
1198
1202
  type: object
1199
1203
  properties:
1204
+ configurationName:
1205
+ description: Configuration Name to be applied
1206
+ type: string | nil
1200
1207
  keywordSearchResult:
1201
1208
  description: Search’s scoped result collection
1202
1209
  type: SearchResultCollectionRepresentation
@@ -1508,7 +1515,7 @@ types:
1508
1515
  description: ListInfoShareRepresentation
1509
1516
  type: object
1510
1517
  properties:
1511
- groupApiName:
1518
+ shareApiName:
1512
1519
  description: The group API name for this shared item.
1513
1520
  type: string
1514
1521
  label:
@@ -3997,7 +4004,20 @@ types:
3997
4004
  type: array
3998
4005
  items:
3999
4006
  type: SearchAnswersRecordRepresentation
4000
- SearchFilterAttributesRepresentation:
4007
+ SearchDataCategoryFilterDefinitionRepresentation:
4008
+ description: Data category filter definition
4009
+ discriminatorValue: DataCategory
4010
+ type: SearchFilterDefinitionRepresentation
4011
+ properties:
4012
+ categories:
4013
+ description: Possible values
4014
+ type: array
4015
+ items:
4016
+ type: SearchFilterOptionRepresentation
4017
+ groupName:
4018
+ description: Group name
4019
+ type: string
4020
+ SearchFieldFilterAttributesRepresentation:
4001
4021
  description: Attributes of the different filters.
4002
4022
  discriminator: affordance
4003
4023
  type: object
@@ -4010,9 +4030,10 @@ types:
4010
4030
  - Range
4011
4031
  - Select
4012
4032
  - Text
4013
- SearchFilterDefinitionRepresentation:
4014
- description: Individual metadata that represents a filter.
4015
- type: object
4033
+ SearchFieldFilterDefinitionRepresentation:
4034
+ description: Field filter definition
4035
+ discriminatorValue: Field
4036
+ type: SearchFilterDefinitionRepresentation
4016
4037
  properties:
4017
4038
  affordance:
4018
4039
  description: The affordance name that displays the filter
@@ -4024,7 +4045,48 @@ types:
4024
4045
  - Text
4025
4046
  attributes:
4026
4047
  description: Api name of the object with filter field
4027
- type: SearchFilterAttributesRepresentation
4048
+ type: SearchFieldFilterAttributesRepresentation
4049
+ targetFieldPath:
4050
+ description: "The field's path targeted by this filter. Examples: CaseNumber,
4051
+ Account.ParentId"
4052
+ type: string
4053
+ SearchFieldFilterSelectAttributesRepresentation:
4054
+ description: Attributes for Select affordances.
4055
+ discriminatorValue: Select
4056
+ type: SearchFieldFilterAttributesRepresentation
4057
+ properties:
4058
+ isStatic:
4059
+ description: Indicates if this select has static options.
4060
+ type: boolean
4061
+ minNumValues:
4062
+ description: 'Indicates how many values are required. By default: 0'
4063
+ type: integer
4064
+ multiple:
4065
+ description: Indicates if this select allows multiple values selection
4066
+ type: boolean
4067
+ staticOptions:
4068
+ description: Static options that will populate the select filter.
4069
+ type: array
4070
+ items:
4071
+ type: SearchFilterOptionRepresentation
4072
+ SearchFieldFilterTextAttributesRepresentation:
4073
+ description: Attributes for Text affordances.
4074
+ discriminatorValue: Text
4075
+ type: SearchFieldFilterAttributesRepresentation
4076
+ properties:
4077
+ placeholder:
4078
+ description: Placeholder to default the text affordance.
4079
+ type: string
4080
+ SearchFilterDefinitionRepresentation:
4081
+ description: Definition of the different filters.
4082
+ discriminator: type
4083
+ type: object
4084
+ properties:
4085
+ defaultValues:
4086
+ description: List of default values
4087
+ type: array
4088
+ items:
4089
+ type: string
4028
4090
  helpMessage:
4029
4091
  description: An optional help message.
4030
4092
  type: string | nil
@@ -4032,10 +4094,12 @@ types:
4032
4094
  label:
4033
4095
  description: The filter display label.
4034
4096
  type: string
4035
- targetFieldPath:
4036
- description: "The field's path targeted by this filter. Examples: CaseNumber,
4037
- Account.ParentId"
4097
+ type:
4098
+ description: Type of the definition filter
4038
4099
  type: string
4100
+ enum:
4101
+ - DataCategory
4102
+ - Field
4039
4103
  SearchFilterInputRepresentation:
4040
4104
  description: Input parameters to pilot filtering of our results
4041
4105
  type: object
@@ -4071,6 +4135,9 @@ types:
4071
4135
  description: Search filter metadata response.
4072
4136
  type: object
4073
4137
  properties:
4138
+ channel:
4139
+ description: Additional channel associated to the object.
4140
+ type: string | nil
4074
4141
  filters:
4075
4142
  description: List of filter definitions.
4076
4143
  type: array
@@ -4107,30 +4174,6 @@ types:
4107
4174
  value:
4108
4175
  description: Value of the search filter option.
4109
4176
  type: string
4110
- SearchFilterSelectAttributesRepresentation:
4111
- description: Attributes for Select affordances.
4112
- discriminatorValue: Select
4113
- type: SearchFilterAttributesRepresentation
4114
- properties:
4115
- isStatic:
4116
- description: Indicates if this select has static options.
4117
- type: boolean
4118
- multiple:
4119
- description: Indicates if this select allows multiple values selection
4120
- type: boolean
4121
- staticOptions:
4122
- description: Static options that will populate the select filter.
4123
- type: array
4124
- items:
4125
- type: SearchFilterOptionRepresentation
4126
- SearchFilterTextAttributesRepresentation:
4127
- description: Attributes for Text affordances.
4128
- discriminatorValue: Text
4129
- type: SearchFilterAttributesRepresentation
4130
- properties:
4131
- placeholder:
4132
- description: Placeholder to default the text affordance.
4133
- type: string
4134
4177
  SearchRecordHighlightRepresentation:
4135
4178
  description: Record-level search information
4136
4179
  type: object
@@ -4167,6 +4210,10 @@ types:
4167
4210
  - KeywordSearchResults
4168
4211
  - QnAResult
4169
4212
  required: false #TODO: handrolled for W-10327520
4213
+ configurationName:
4214
+ description: A configuration name defined in Search Manager
4215
+ type: string
4216
+ required: false #TODO: handrolled for W-13591079
4170
4217
  objectApiNames:
4171
4218
  description: A list of supported objects, such as Account.
4172
4219
  type: array
@@ -4231,6 +4278,9 @@ types:
4231
4278
  description: Root of the search response
4232
4279
  type: object
4233
4280
  properties:
4281
+ configurationName:
4282
+ description: Configuration Name to be applied
4283
+ type: string | nil
4234
4284
  keywordSearchResults:
4235
4285
  description: Keyword Search Results Response
4236
4286
  type: KeywordSearchResultsRepresentation | nil
@@ -7385,6 +7435,10 @@ types:
7385
7435
  body:
7386
7436
  application/json:
7387
7437
  type: SearchFilterMetadataCollectionRepresentation
7438
+ queryParameters:
7439
+ channel:
7440
+ type: string
7441
+ required: false
7388
7442
  uriParameters:
7389
7443
  objectApiName:
7390
7444
  type: string
@@ -7450,6 +7504,7 @@ types:
7450
7504
  (oas-body-name): options
7451
7505
  /search/results/keyword:
7452
7506
  post:
7507
+ displayName: postKeywordSearchResults
7453
7508
  description: List all results over entities (or only one) for the keyword
7454
7509
  results type
7455
7510
  responses:
@@ -433,9 +433,11 @@ types:
433
433
  SalesforceFormFactor:
434
434
  (luvio.coerceFunction): ../primitives/FormFactor/coerce
435
435
  SearchFilterMetadataCollectionRepresentation:
436
+ (luvio.opaque): true
436
437
  (luvio.ttl): 30000
437
438
  (luvio.key):
438
439
  objectApiName: objectApiName
440
+ channel: channel
439
441
  SearchFilterOptionCollectionRepresentation:
440
442
  (luvio.opaque): true
441
443
  (luvio.ttl): 30000
@@ -448,12 +450,14 @@ types:
448
450
  (luvio.ttl): 200
449
451
  (luvio.key): # to get it working, our key should be computed with input parameters.
450
452
  query: query
453
+ configurationName: configurationName
451
454
  KeywordSearchResultsSummaryRepresentation:
452
455
  (luvio.opaque): true
453
456
  (luvio.ttl): 200
454
457
  (luvio.key): # to get it working, our key should be computed with input parameters.
455
458
  query: query
456
459
  objectApiName: objectApiName
460
+ configurationName: configurationName
457
461
  SimplifiedBatchRepresentation:
458
462
  examples:
459
463
  mockGetObjectInfosResponse: !include ../mocks/types/SimplifiedBatchRepresentation/object-Opportunity-Account.json
@@ -1705,6 +1709,7 @@ types:
1705
1709
  name: getSearchFilterMetadata
1706
1710
  (luvio.key):
1707
1711
  objectApiName: urlParams.objectApiName
1712
+ channel: queryParams.channel || null
1708
1713
  '/search-info/{objectApiName}/filters/{filterApiName}/options':
1709
1714
  get:
1710
1715
  (luvio.adapter):
@@ -1726,6 +1731,7 @@ types:
1726
1731
  (luvio.method): get
1727
1732
  (luvio.key):
1728
1733
  query: queryParams.q
1734
+ configurationName: body.configurationName || null
1729
1735
  (luvio.adapter):
1730
1736
  name: getSearchResults
1731
1737
  /search/results/keyword:
@@ -1735,6 +1741,7 @@ types:
1735
1741
  (luvio.key):
1736
1742
  query: queryParams.q
1737
1743
  objectApiName: queryParams.objectApiName
1744
+ configurationName: body.configurationName || null
1738
1745
  (luvio.adapter):
1739
1746
  name: getKeywordSearchResults
1740
1747
  /predupe:
@@ -1,30 +0,0 @@
1
- import { SearchFilterAttributesRepresentation as SearchFilterAttributesRepresentation_SearchFilterAttributesRepresentation } from './SearchFilterAttributesRepresentation';
2
- import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
3
- export declare const VERSION = "d6e96768ef23ee3c72141c83dc91c1ab";
4
- export declare function validate(obj: any, path?: string): TypeError | null;
5
- export declare const RepresentationType: string;
6
- export declare function normalize(input: SearchFilterTextAttributesRepresentation, existing: SearchFilterTextAttributesRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): SearchFilterTextAttributesRepresentationNormalized;
7
- export declare const select: () => $64$luvio_engine_FragmentSelection;
8
- export declare function equals(existing: SearchFilterTextAttributesRepresentationNormalized, incoming: SearchFilterTextAttributesRepresentationNormalized): boolean;
9
- export declare const ingest: $64$luvio_engine_ResourceIngest;
10
- export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: SearchFilterTextAttributesRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
11
- /**
12
- * Attributes for Text affordances.
13
- *
14
- * Keys:
15
- * (none)
16
- */
17
- export interface SearchFilterTextAttributesRepresentationNormalized extends SearchFilterAttributesRepresentation_SearchFilterAttributesRepresentation {
18
- /** Placeholder to default the text affordance. */
19
- placeholder: string;
20
- }
21
- /**
22
- * Attributes for Text affordances.
23
- *
24
- * Keys:
25
- * (none)
26
- */
27
- export interface SearchFilterTextAttributesRepresentation extends SearchFilterAttributesRepresentation_SearchFilterAttributesRepresentation {
28
- placeholder: string;
29
- affordance: 'Text';
30
- }