@salesforce/lds-adapters-uiapi 1.313.0 → 1.314.0

package/sfdc/uiapi-static-functions.js

@@ -151,6 +151,203 @@ function getFieldApiName(value, onlyQualifiedFieldNames = false) {
     return undefined;
 }
 
+/**
+ * Defines configuration for the module with a default value which can be overridden by the runtime environment.
+ */
+// A holder for a configurable adapter override
+class Configurable {
+    constructor() {
+        this.getAdapter = () => {
+            return this.adapter;
+        };
+        this.setAdapter = (value) => {
+            this.adapter = value;
+        };
+        this.adapter = undefined;
+    }
+}
+// Configurable adapters that can have environmental overrides
+let configurableCreateRecordAdapter = new Configurable();
+let configurableUpdateRecordAdapter = new Configurable();
+let configurableDeleteRecordAdapter = new Configurable();
+let configurablePerformQuickActionAdapter = new Configurable();
+let configurablePerformUpdateRecordQuickActionAdapter = new Configurable();
+let configurableCreateContentDocumentAndVersion = new Configurable();
+let configurableCreateContentVersion = new Configurable();
+/**
+ * Depth to which tracked fields will be added to a request that results from a cache miss.
+ * A value of 0 inhibits the addition of tracked fields, 1 will add tracked fields that can
+ * be reached by following 1 relationship from the root record, etc.
+ * @defaultValue '5', replicates the current behavior
+ */
+let trackedFieldDepthOnCacheMiss = 5;
+/**
+ * Depth to which tracked fields will be added to a request that results from a merge conflict
+ * A value of 0 inhibits the addition of tracked fields, 1 will add tracked fields that can
+ * be reached by following 1 relationship from the root record, etc.
+ * @defaultValue '5', replicates the current behavior
+ */
+let trackedFieldDepthOnCacheMergeConflict = 5;
+/**
+ * Depth to which tracked fields will be added to a request that results from a notify change invocation by the consumer
+ * A value of 0 inhibits the addition of tracked fields, 1 will add tracked fields that can
+ * be reached by following 1 relationship from the root record, etc.
+ * @defaultValue '5', replicates the current behavior
+ */
+let trackedFieldDepthOnNotifyChange = 5;
+/**
+ * Determines if we will only fetch the 'Id' field for the leaf relationship record
+ * @defaultValue 'false', replicates the current behavior and fetches all fields in the store for the leaf relationship record
+ */
+let trackedFieldLeafNodeIdAndNameOnly = false;
+/**
+ * One store enabled Get Object Info adapter
+ */
+let oneStoreGetObjectInfoAdapter = undefined;
+/**
+ * One store enabled Get Object Infos adapter
+ */
+let oneStoreGetObjectInfosAdapter = undefined;
+/**
+ * Determines when to include PDL strategies for Related Lists
+ */
+let relatedListsPredictionsEnabled = false;
+/**
+ * Defines the configuration API and is exposed internally as well as externally.
+ * Configuration for one store enabled REST adapters only.
+ */
+const configurationForOneStoreEnabledAdapters = {
+    setGetObjectInfoAdapter: function (adapter) {
+        oneStoreGetObjectInfoAdapter = adapter;
+    },
+    getGetObjectInfoAdapter: function () {
+        return oneStoreGetObjectInfoAdapter;
+    },
+    setGetObjectInfosAdapter: function (adapter) {
+        oneStoreGetObjectInfosAdapter = adapter;
+    },
+    getGetObjectInfosAdapter: function () {
+        return oneStoreGetObjectInfosAdapter;
+    },
+};
+const getKeywordSearchResultsFactory = new Configurable();
+const getListRecordsByNameFactory = new Configurable();
+const getListUiFactory = new Configurable();
+const getLookupRecordsFactory = new Configurable();
+const getQuickActionDefaultsFactory = new Configurable();
+const getRecordCreateDefaultsFactory = new Configurable();
+const getRecordTemplateCloneFactory = new Configurable();
+const getRecordTemplateCreateFactory = new Configurable();
+const getRecordUiFactory = new Configurable();
+const getRecordFactory = new Configurable();
+const getRecordsFactory = new Configurable();
+const getRelatedListRecordsFactory = new Configurable();
+const getRelatedListRecordsBatchFactory = new Configurable();
+const getSearchResultsFactory = new Configurable();
+// The following set of adapters all touch RecordRepresentation directly or indirectly,
+// so they need to support having a custom factory provided by the mobile environment.
+const configurationForEnvironmentFactoryOverrides = {
+    getKeywordSearchResultsAdapterFactory: getKeywordSearchResultsFactory.getAdapter,
+    setGetKeywordSearchResultsAdapterFactory: getKeywordSearchResultsFactory.setAdapter,
+    getListRecordsByNameAdapterFactory: getListRecordsByNameFactory.getAdapter,
+    setGetListRecordsByNameAdapterFactory: getListRecordsByNameFactory.setAdapter,
+    getListUiAdapterFactory: getListUiFactory.getAdapter,
+    setGetListUiAdapterFactory: getListUiFactory.setAdapter,
+    getLookupRecordsAdapterFactory: getLookupRecordsFactory.getAdapter,
+    setGetLookupRecordsAdapterFactory: getLookupRecordsFactory.setAdapter,
+    getQuickActionDefaultsAdapterFactory: getQuickActionDefaultsFactory.getAdapter,
+    setGetQuickActionDefaultsAdapterFactory: getQuickActionDefaultsFactory.setAdapter,
+    getRecordCreateDefaultsAdapterFactory: getRecordCreateDefaultsFactory.getAdapter,
+    setGetRecordCreateDefaultsAdapterFactory: getRecordCreateDefaultsFactory.setAdapter,
+    getRecordTemplateCloneAdapterFactory: getRecordTemplateCloneFactory.getAdapter,
+    setGetRecordTemplateCloneAdapterFactory: getRecordTemplateCloneFactory.setAdapter,
+    getRecordTemplateCreateAdapterFactory: getRecordTemplateCreateFactory.getAdapter,
+    setGetRecordTemplateCreateAdapterFactory: getRecordTemplateCreateFactory.setAdapter,
+    getRecordUiAdapterFactory: getRecordUiFactory.getAdapter,
+    setGetRecordUiAdapterFactory: getRecordUiFactory.setAdapter,
+    getRecordAdapterFactory: getRecordFactory.getAdapter,
+    setGetRecordAdapterFactory: getRecordFactory.setAdapter,
+    getRecordsAdapterFactory: getRecordsFactory.getAdapter,
+    setGetRecordsAdapterFactory: getRecordsFactory.setAdapter,
+    getRelatedListRecordsAdapterFactory: getRelatedListRecordsFactory.getAdapter,
+    setGetRelatedListRecordsAdapterFactory: getRelatedListRecordsFactory.setAdapter,
+    getRelatedListRecordsBatchAdapterFactory: getRelatedListRecordsBatchFactory.getAdapter,
+    setGetRelatedListRecordsBatchAdapterFactory: getRelatedListRecordsBatchFactory.setAdapter,
+    getSearchResultsAdapterFactory: getSearchResultsFactory.getAdapter,
+    setGetSearchResultsAdapterFactory: getSearchResultsFactory.setAdapter,
+};
+/**
+ * Defines the configuration API and is exposed internally as well as externally.
+ * Configuration for REST adapters only.
+ */
+({
+    setTrackedFieldDepthOnCacheMiss: function (trackedFieldDepthOnCacheMissParam) {
+        trackedFieldDepthOnCacheMiss = trackedFieldDepthOnCacheMissParam;
+    },
+    getTrackedFieldDepthOnCacheMiss: function () {
+        return trackedFieldDepthOnCacheMiss;
+    },
+    setTrackedFieldDepthOnCacheMergeConflict: function (trackedFieldDepthOnCacheMergeConflictParam) {
+        trackedFieldDepthOnCacheMergeConflict = trackedFieldDepthOnCacheMergeConflictParam;
+    },
+    getTrackedFieldDepthOnCacheMergeConflict: function () {
+        return trackedFieldDepthOnCacheMergeConflict;
+    },
+    setTrackedFieldDepthOnNotifyChange: function (trackedFieldDepthOnNotifyChangeParam) {
+        trackedFieldDepthOnNotifyChange = trackedFieldDepthOnNotifyChangeParam;
+    },
+    getTrackedFieldDepthOnNotifyChange: function () {
+        return trackedFieldDepthOnNotifyChange;
+    },
+    setTrackedFieldLeafNodeIdAndNameOnly: function (trackedFieldLeafNodeIdAndNameOnlyParam) {
+        trackedFieldLeafNodeIdAndNameOnly = trackedFieldLeafNodeIdAndNameOnlyParam;
+    },
+    getTrackedFieldLeafNodeIdAndNameOnly: function () {
+        return trackedFieldLeafNodeIdAndNameOnly;
+    },
+    setRelatedListsPredictionsEnabled: function (f) {
+        relatedListsPredictionsEnabled = f;
+    },
+    areRelatedListsPredictionsEnabled: function () {
+        return relatedListsPredictionsEnabled === true;
+    },
+    // createRecord
+    getDraftAwareCreateRecordAdapter: configurableCreateRecordAdapter.getAdapter,
+    setDraftAwareCreateRecordAdapter: configurableCreateRecordAdapter.setAdapter,
+    // updateRecord
+    getDraftAwareUpdateRecordAdapter: configurableUpdateRecordAdapter.getAdapter,
+    setDraftAwareUpdateRecordAdapter: configurableUpdateRecordAdapter.setAdapter,
+    // deleteRecord
+    getDraftAwareDeleteRecordAdapter: configurableDeleteRecordAdapter.getAdapter,
+    setDraftAwareDeleteRecordAdapter: configurableDeleteRecordAdapter.setAdapter,
+    // performQuickAction
+    getDraftAwarePerformQuickActionAdapter: configurablePerformQuickActionAdapter.getAdapter,
+    setDraftAwarePerformQuickActionAdapter: configurablePerformQuickActionAdapter.setAdapter,
+    // performRecordUpdateQuickAction
+    getDraftAwarePerformUpdateRecordQuickActionAdapter: configurablePerformUpdateRecordQuickActionAdapter.getAdapter,
+    setDraftAwarePerformUpdateRecordQuickActionAdapter: configurablePerformUpdateRecordQuickActionAdapter.setAdapter,
+    // createContentDocumentAndVersion
+    getDraftAwareCreateContentDocumentAndVersionAdapter: configurableCreateContentDocumentAndVersion.getAdapter,
+    setDraftAwareCreateContentDocumentAndVersionAdapter: configurableCreateContentDocumentAndVersion.setAdapter,
+    // createContentVersion
+    getDraftAwareCreateContentVersionAdapter: configurableCreateContentVersion.getAdapter,
+    setDraftAwareCreateContentVersionAdapter: configurableCreateContentVersion.setAdapter,
+    ...configurationForOneStoreEnabledAdapters,
+    ...configurationForEnvironmentFactoryOverrides,
+});
+let configurableGraphQLAdapter = new Configurable();
+let configurableGraphQLBatchAdapter = new Configurable();
+/**
+ * Defines the configuration API and is exposed internally as well as externally.
+ * Configuration for GraphQL adapters only.
+ */
+({
+    getDraftAwareGraphQLAdapter: configurableGraphQLAdapter.getAdapter,
+    setDraftAwareGraphQLAdapter: configurableGraphQLAdapter.setAdapter,
+    getEnvironmentAwareGraphQLBatchAdapter: configurableGraphQLBatchAdapter.getAdapter,
+    setEnvironmentAwareGraphQLBatchAdapter: configurableGraphQLBatchAdapter.setAdapter,
+});
+
 ObjectCreate(null);
 
 ObjectCreate(null);