@salesforce/lds-adapters-uiapi 1.354.0-dev17 → 1.354.0-dev18

package/dist/es/es2018/types/src/generated/adapters/getRelatedListRecords.d.ts

@@ -9,6 +9,7 @@ export interface GetRelatedListRecordsConfig {
     parentRecordId: string;
     relatedListId: string;
     fields?: Array<string>;
+    includeColumnLabels?: boolean;
     optionalFields?: Array<string>;
     pageSize?: number;
     pageToken?: string;

package/dist/es/es2018/types/src/generated/resources/postUiApiRelatedListRecordsByParentRecordIdAndRelatedListId.d.ts

@@ -8,6 +8,7 @@ export interface ResourceRequestConfig {
     };
     body: {
         fields?: Array<string>;
+        includeColumnLabels?: boolean;
         optionalFields?: Array<string>;
         pageSize?: number;
         pageToken?: string;

package/dist/es/es2018/types/src/generated/types/RelatedListRecordCollectionRepresentation.d.ts

@@ -3,7 +3,7 @@ import { KeyMetadata as $64$luvio_engine_KeyMetadata, NormalizedKeyMetadata as $
 import { PaginationParams as pagination_syntheticCursor_PaginationParams } from '../pagination/syntheticCursor';
 import { RecordRepresentation as RecordRepresentation_RecordRepresentation } from './RecordRepresentation';
 export declare const TTL = 30000;
-export declare const VERSION = "62467c27c19349b70c9db2a8d9d591d9";
+export declare const VERSION = "ecedd058ac9cfc9b51de0f2c00276ce8";
 export declare function validate(obj: any, path?: string): TypeError | null;
 export declare const RepresentationType: string;
 export interface KeyParams extends $64$luvio_engine_KeyMetadata {
@@ -44,6 +44,8 @@ export declare function dynamicIngest(ingestParams: DynamicIngestParams): $64$lu
  *    where (string | null): where
  */
 export interface RelatedListRecordCollectionRepresentationNormalized {
+    /** A map of column API name to column label. */
+    columnLabels?: unknown;
     /** The total count of records returned. */
     count: number;
     /** The token for the current page of records. */
@@ -84,6 +86,7 @@ export interface RelatedListRecordCollectionRepresentationNormalized {
  *    where (string | null): where
  */
 export interface RelatedListRecordCollectionRepresentation {
+    columnLabels?: unknown;
     count: number;
     currentPageToken: string;
     currentPageUrl: string | null;

package/dist/es/es2018/types/src/generated/types/RelatedListRecordsInputRepresentation.d.ts

@@ -1,5 +1,5 @@
 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';
-export declare const VERSION = "541567e0cd578bd356467b2690c7f65c";
+export declare const VERSION = "42875a6869d6a0cd8ef21f16e6c6d9f4";
 export declare function validate(obj: any, path?: string): TypeError | null;
 export declare const RepresentationType: string;
 export declare function normalize(input: RelatedListRecordsInputRepresentation, existing: RelatedListRecordsInputRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): RelatedListRecordsInputRepresentationNormalized;
@@ -16,6 +16,8 @@ export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableSto
 export interface RelatedListRecordsInputRepresentationNormalized {
     /** Additional fields queried for the records returned.  If the field is not available to the user, an error occurs. */
     fields?: Array<string>;
+    /** Flag to include includeColumnLabels for ease of localization. */
+    includeColumnLabels?: boolean;
     /** Additional fields queried for the records returned.  If the field is not available to the user, no error occurs and the field isn’t included in the records. */
     optionalFields?: Array<string>;
     /** The number of list records viewed at one time.  The default value is 50. Value can be 1–2000. */
@@ -35,6 +37,7 @@ export interface RelatedListRecordsInputRepresentationNormalized {
  */
 export interface RelatedListRecordsInputRepresentation {
     fields?: Array<string>;
+    includeColumnLabels?: boolean;
     optionalFields?: Array<string>;
     pageSize?: number;
     pageToken?: string;

package/dist/es/es2018/uiapi-records-service.js

@@ -31168,12 +31168,19 @@ function equalsMetadata(existingMetadata, incomingMetadata) {
 }
 
 const TTL$g = 30000;
-const VERSION$1I = "62467c27c19349b70c9db2a8d9d591d9";
+const VERSION$1I = "ecedd058ac9cfc9b51de0f2c00276ce8";
 function validate$E(obj, path = 'RelatedListRecordCollectionRepresentation') {
     const v_error = (() => {
         if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
             return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
         }
+        if (obj.columnLabels !== undefined) {
+            const obj_columnLabels = obj.columnLabels;
+            const path_columnLabels = path + '.columnLabels';
+            if (obj_columnLabels === undefined) {
+                return new TypeError('Expected "defined" but received "' + typeof obj_columnLabels + '" (at "' + path_columnLabels + '")');
+            }
+        }
         const obj_count = obj.count;
         const path_count = path + '.count';
         if (typeof obj_count !== 'number' || (typeof obj_count === 'number' && Math.floor(obj_count) !== obj_count)) {
@@ -31545,6 +31552,14 @@ const dynamicSelect$4 = function dynamicRelatedListRecordCollectionRepresentatio
             reader.enterPath('count');
             reader.readScalar('count', metadataProperties, sink);
             reader.exitPath();
+            reader.enterPath('columnLabels');
+            reader.readObject('columnLabels', {
+                name: 'columnLabels',
+                kind: 'Object',
+                // Any
+                required: false
+            }, source, sink);
+            reader.exitPath();
             reader.enterPath('fields');
             reader.readScalarPlural('fields', source, sink, true);
             reader.exitPath();
@@ -31587,6 +31602,19 @@ function equals$g(existing, incoming) {
     if (!(existing_currentPageToken === incoming_currentPageToken)) {
         return false;
     }
+    const existing_columnLabels = existing.columnLabels;
+    const incoming_columnLabels = incoming.columnLabels;
+    // if at least one of these optionals is defined
+    if (existing_columnLabels !== undefined || incoming_columnLabels !== undefined) {
+        // if one of these is not defined we know the other is defined and therefore
+        // not equal
+        if (existing_columnLabels === undefined || incoming_columnLabels === undefined) {
+            return false;
+        }
+        if (JSONStringify(incoming_columnLabels) !== JSONStringify(existing_columnLabels)) {
+            return false;
+        }
+    }
     const existing_currentPageUrl = existing.currentPageUrl;
     const incoming_currentPageUrl = incoming.currentPageUrl;
     if (!(existing_currentPageUrl === incoming_currentPageUrl)) {
@@ -31824,10 +31852,11 @@ function createPaginationParams(params) {
 }
 function keyBuilder$1S(luvio, params) {
     return keyBuilder$1T(luvio, {
+        includeColumnLabels: params.body.includeColumnLabels || null,
+        relatedListId: params.urlParams.relatedListId,
         sortBy: params.body.sortBy || [],
-        where: params.body.where || null,
         parentRecordId: params.urlParams.parentRecordId,
-        relatedListId: params.urlParams.relatedListId
+        where: params.body.where || null
     });
 }
 function getResponseCacheKeys$j(storeKeyMap, luvio, resourceParams, response) {
@@ -32249,6 +32278,7 @@ const getRelatedListRecords_ConfigPropertyMetadata = [
     generateParamConfigMetadata('parentRecordId', true, 0 /* UrlParameter */, 0 /* String */, false, getRecordId18),
     generateParamConfigMetadata('relatedListId', true, 0 /* UrlParameter */, 0 /* String */),
     generateParamConfigMetadata('fields', false, 2 /* Body */, 0 /* String */, true),
+    generateParamConfigMetadata('includeColumnLabels', false, 2 /* Body */, 1 /* Boolean */),
     generateParamConfigMetadata('optionalFields', false, 2 /* Body */, 0 /* String */, true),
     generateParamConfigMetadata('pageSize', false, 2 /* Body */, 3 /* Integer */),
     generateParamConfigMetadata('pageToken', false, 2 /* Body */, 0 /* String */),

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-adapters-uiapi",
-    "version": "1.354.0-dev17",
+    "version": "1.354.0-dev18",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "Wire adapters for record related UI API endpoints",
     "main": "dist/es/es2018/uiapi-records-service.js",
@@ -68,13 +68,13 @@
         }
     },
     "dependencies": {
-        "@salesforce/lds-bindings": "^1.354.0-dev17",
-        "@salesforce/lds-default-luvio": "^1.354.0-dev17"
+        "@salesforce/lds-bindings": "^1.354.0-dev18",
+        "@salesforce/lds-default-luvio": "^1.354.0-dev18"
     },
     "devDependencies": {
-        "@salesforce/lds-compiler-plugins": "^1.354.0-dev17",
-        "@salesforce/lds-jest": "^1.354.0-dev17",
-        "@salesforce/lds-store-binary": "^1.354.0-dev17"
+        "@salesforce/lds-compiler-plugins": "^1.354.0-dev18",
+        "@salesforce/lds-jest": "^1.354.0-dev18",
+        "@salesforce/lds-store-binary": "^1.354.0-dev18"
     },
     "luvioBundlesize": [
         {

package/sfdc/graphqlAdapters.js

@@ -24214,4 +24214,4 @@ register({
 });
 
 export { configurationForGraphQLAdapters as configuration, graphql, factory$1 as graphqlAdapterFactory, graphqlBatch, graphqlBatch_imperative, graphql_imperative };
-// version: 1.354.0-dev17-0989532028
+// version: 1.354.0-dev18-42dc52a64b

package/sfdc/index.js

@@ -30675,12 +30675,19 @@ function equalsMetadata(existingMetadata, incomingMetadata) {
 }
 
 const TTL$a = 30000;
-const VERSION$c = "62467c27c19349b70c9db2a8d9d591d9";
+const VERSION$c = "ecedd058ac9cfc9b51de0f2c00276ce8";
 function validate$A(obj, path = 'RelatedListRecordCollectionRepresentation') {
     const v_error = (() => {
         if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
             return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
         }
+        if (obj.columnLabels !== undefined) {
+            const obj_columnLabels = obj.columnLabels;
+            const path_columnLabels = path + '.columnLabels';
+            if (obj_columnLabels === undefined) {
+                return new TypeError('Expected "defined" but received "' + typeof obj_columnLabels + '" (at "' + path_columnLabels + '")');
+            }
+        }
         const obj_count = obj.count;
         const path_count = path + '.count';
         if (typeof obj_count !== 'number' || (typeof obj_count === 'number' && Math.floor(obj_count) !== obj_count)) {
@@ -31052,6 +31059,14 @@ const dynamicSelect$4 = function dynamicRelatedListRecordCollectionRepresentatio
             reader.enterPath('count');
             reader.readScalar('count', metadataProperties, sink);
             reader.exitPath();
+            reader.enterPath('columnLabels');
+            reader.readObject('columnLabels', {
+                name: 'columnLabels',
+                kind: 'Object',
+                // Any
+                required: false
+            }, source, sink);
+            reader.exitPath();
             reader.enterPath('fields');
             reader.readScalarPlural('fields', source, sink, true);
             reader.exitPath();
@@ -31094,6 +31109,19 @@ function equals$c(existing, incoming) {
     if (!(existing_currentPageToken === incoming_currentPageToken)) {
         return false;
     }
+    const existing_columnLabels = existing.columnLabels;
+    const incoming_columnLabels = incoming.columnLabels;
+    // if at least one of these optionals is defined
+    if (existing_columnLabels !== undefined || incoming_columnLabels !== undefined) {
+        // if one of these is not defined we know the other is defined and therefore
+        // not equal
+        if (existing_columnLabels === undefined || incoming_columnLabels === undefined) {
+            return false;
+        }
+        if (JSONStringify(incoming_columnLabels) !== JSONStringify(existing_columnLabels)) {
+            return false;
+        }
+    }
     const existing_currentPageUrl = existing.currentPageUrl;
     const incoming_currentPageUrl = incoming.currentPageUrl;
     if (!(existing_currentPageUrl === incoming_currentPageUrl)) {
@@ -31331,10 +31359,11 @@ function createPaginationParams(params) {
 }
 function keyBuilder$s(luvio, params) {
     return keyBuilder$t(luvio, {
+        includeColumnLabels: params.body.includeColumnLabels || null,
+        relatedListId: params.urlParams.relatedListId,
         sortBy: params.body.sortBy || [],
-        where: params.body.where || null,
         parentRecordId: params.urlParams.parentRecordId,
-        relatedListId: params.urlParams.relatedListId
+        where: params.body.where || null
     });
 }
 function getResponseCacheKeys$h(storeKeyMap, luvio, resourceParams, response) {
@@ -31756,6 +31785,7 @@ const getRelatedListRecords_ConfigPropertyMetadata = [
     generateParamConfigMetadata('parentRecordId', true, 0 /* UrlParameter */, 0 /* String */, false, getRecordId18),
     generateParamConfigMetadata('relatedListId', true, 0 /* UrlParameter */, 0 /* String */),
     generateParamConfigMetadata('fields', false, 2 /* Body */, 0 /* String */, true),
+    generateParamConfigMetadata('includeColumnLabels', false, 2 /* Body */, 1 /* Boolean */),
     generateParamConfigMetadata('optionalFields', false, 2 /* Body */, 0 /* String */, true),
     generateParamConfigMetadata('pageSize', false, 2 /* Body */, 3 /* Integer */),
     generateParamConfigMetadata('pageToken', false, 2 /* Body */, 0 /* String */),
@@ -38946,4 +38976,4 @@ withDefaultLuvio((luvio) => {
 });
 
 export { API_NAMESPACE, InMemoryRecordRepresentationQueryEvaluator, MRU, RepresentationType$J as ObjectInfoDirectoryEntryRepresentationType, RepresentationType$O as ObjectInfoRepresentationType, RECORD_FIELDS_KEY_JUNCTION, RECORD_ID_PREFIX, RECORD_REPRESENTATION_NAME, RECORD_VIEW_ENTITY_ID_PREFIX, RECORD_VIEW_ENTITY_REPRESENTATION_NAME, RepresentationType$V as RecordRepresentationRepresentationType, TTL$z as RecordRepresentationTTL, RepresentationType$V as RecordRepresentationType, VERSION$1g as RecordRepresentationVersion, keyPrefix as UiApiNamespace, buildRecordRepKeyFromId, getFieldApiNamesArray as coerceFieldIdArray, getObjectApiName$1 as coerceObjectId, getObjectApiNamesArray as coerceObjectIdArray, configurationForRestAdapters as configuration, createContentDocumentAndVersion, createContentVersion, createIngestRecordWithFields, createLDSAdapterWithPrediction, createListInfo, createRecord, createRelatedListAdapterWithPrediction, createRelatedListPlusAdapterWithPrediction, deleteListInfo, deleteRecord, executeBatchRecordOperations, extractRecordIdFromStoreKey, getActionOverrides, getActionOverrides_imperative, getAllApps, getAllApps_imperative, getAppDetails, getAppDetails_imperative, getDuplicateConfiguration, getDuplicateConfiguration_imperative, getDuplicates, getDuplicates_imperative, getFlexipageFormulaOverrides, getFlexipageFormulaOverrides_imperative, getGlobalActions, getGlobalActions_imperative, getKeywordSearchResults, getKeywordSearchResults_imperative, getLayout, getLayoutUserState, getLayoutUserState_imperative, getLayout_imperative, getListInfoByName, getListInfoByNameAdapterFactory, getListInfoByName_imperative, getListInfosByName, getListInfosByName_imperative, getListInfosByObjectName, getListInfosByObjectNameAdapterFactory, getListInfosByObjectName_imperative, getListObjectInfo, getListObjectInfoAdapterFactory, getListObjectInfo_imperative, getListPreferences, getListPreferences_imperative, getListRecordsByName, factory$a as getListRecordsByNameAdapterFactory, getListRecordsByName_imperative, getListUi, getListUi_imperative, getLookupActions, getLookupActions_imperative, getLookupMetadata, getLookupMetadata_imperative, getLookupRecords, getLookupRecords_imperative, getNavItems, getNavItems_imperative, getObjectCreateActions, getObjectCreateActions_imperative, getObjectInfo, getObjectInfoAdapterFactory, getObjectInfoDirectoryAdapterFactory, getObjectInfo_imperative, getObjectInfos, getObjectInfosAdapterFactory, getObjectInfos_imperative, getPathLayout, getPathLayout_imperative, getPicklistValues, getPicklistValuesByRecordType, getPicklistValuesByRecordType_imperative, getPicklistValues_imperative, getQuickActionDefaults, getQuickActionDefaults_imperative, getQuickActionInfo, getQuickActionInfo_imperative, getQuickActionLayout, getQuickActionLayout_imperative, getRecord, getRecordActions, getRecordActionsAdapterFactory, getRecordActions_imperative, factory$f as getRecordAdapterFactory, getRecordAvatars, getRecordAvatarsAdapterFactory, getRecordAvatars_imperative, getRecordCreateDefaults, getRecordCreateDefaults_imperative, getRecordEditActions, getRecordEditActions_imperative, getRecordId18, getRecordId18Array, getRecordIngestionOverride, getRecordNotifyChange, getRecordTemplateClone, getRecordTemplateClone_imperative, getRecordTemplateCreate, getRecordTemplateCreate_imperative, getRecordUi, getRecordUi_imperative, getRecord_imperative, getRecords, getRecordsAdapterFactory, getRecords_imperative, getRelatedListActions, getRelatedListActionsAdapterFactory, getRelatedListActions_imperative, getRelatedListCount, getRelatedListCount_imperative, getRelatedListInfo, getRelatedListInfoAdapterFactory, getRelatedListInfoBatch, getRelatedListInfoBatchAdapterFactory, getRelatedListInfoBatch_imperative, getRelatedListInfo_imperative, getRelatedListPreferences, getRelatedListPreferencesBatch, getRelatedListPreferencesBatch_imperative, getRelatedListPreferences_imperative, getRelatedListRecordActions, getRelatedListRecordActions_imperative, getRelatedListRecords, getRelatedListRecordsAdapterFactory, getRelatedListRecordsBatch, getRelatedListRecordsBatchAdapterFactory, getRelatedListRecordsBatch_imperative, getRelatedListRecords_imperative, getRelatedListsActions, getRelatedListsActionsAdapterFactory, getRelatedListsActions_imperative, getRelatedListsCount, getRelatedListsCount_imperative, getRelatedListsInfo, getRelatedListsInfoAdapterFactory, getRelatedListsInfo_imperative, getResponseCacheKeys as getResponseCacheKeysContentDocumentCompositeRepresentation, getSearchFilterMetadata, getSearchFilterMetadata_imperative, getSearchFilterOptions, getSearchFilterOptions_imperative, getSearchResults, getSearchResults_imperative, getTypeCacheKeys$X as getTypeCacheKeysRecord, ingest as ingestContentDocumentCompositeRepresentation, ingest$H as ingestObjectInfo, ingest$B as ingestQuickActionExecutionRepresentation, ingest$O as ingestRecord, instrument, isStoreKeyRecordViewEntity, isSupportedEntity, keyBuilder as keyBuilderContentDocumentCompositeRepresentation, keyBuilderFromType as keyBuilderFromTypeContentDocumentCompositeRepresentation, keyBuilderFromType$D as keyBuilderFromTypeRecordRepresentation, keyBuilder$1Y as keyBuilderObjectInfo, keyBuilder$1R as keyBuilderQuickActionExecutionRepresentation, keyBuilder$29 as keyBuilderRecord, notifyAllListInfoSummaryUpdateAvailable, notifyAllListRecordUpdateAvailable, notifyListInfoSummaryUpdateAvailable, notifyListInfoUpdateAvailable, notifyListRecordCollectionUpdateAvailable, notifyListViewSummaryUpdateAvailable, notifyQuickActionDefaultsUpdateAvailable, notifyRecordUpdateAvailable, performQuickAction, performUpdateRecordQuickAction, refresh, registerPrefetcher, updateLayoutUserState, updateListInfoByName, updateListPreferences, updateRecord, updateRecordAvatar, updateRelatedListInfo, updateRelatedListPreferences };
-// version: 1.354.0-dev17-0989532028
+// version: 1.354.0-dev18-42dc52a64b

package/src/raml/api.raml

@@ -4136,6 +4136,10 @@ types:
       where:
         description: The where condition requested when these records were fetched.
         type: string | nil # TODO: Hand rolled
+      columnLabels:
+        description: A map of column API name to column label.
+        type: any
+        required: false #handrolled
   BatchRelatedListCountRepresentation: # TODO: Handrolled
     description: BatchRelatedListCountRepresentation
     type: object
@@ -4211,6 +4215,10 @@ types:
         required: false #TODO: handrolled
         items:
           type: string
+      includeColumnLabels:
+        description: Flag to include includeColumnLabels for ease of localization.
+        type: boolean
+        required: false
       optionalFields:
         description: Additional fields queried for the records returned.  If the field
           is not available to the user, no error occurs and the field isn’t included
@@ -8567,6 +8575,9 @@ types:
         #     items:
         #       type: string
         #       (oas-collectionFormat): csv
+        #   includeColumnLabels:
+        #     type: boolean
+        #     required: false
         #   optionalFields:
         #     type: array
         #     required: false

package/src/raml/luvio.raml

@@ -1851,6 +1851,7 @@ types:
       (luvio.key):
         sortBy: body.sortBy || []
         where: body.where || null
+        includeColumnLabels: body.includeColumnLabels || null
         parentRecordId: urlParams.parentRecordId
         relatedListId: urlParams.relatedListId
       (luvio.paginationParams):