InferDomain API call and response to include distinctValues for specified column keys

Author: cnathe

packages/components/src/public/InferDomainResponse.ts

@@ -1,4 +1,4 @@
-import { fromJS, List, Record } from 'immutable';
+import { fromJS, List, Map, Record } from 'immutable';
 
 import { ActionURL, Ajax, Utils } from '@labkey/api';
 
@@ -9,16 +9,19 @@ export class InferDomainResponse extends Record({
     fields: List<QueryColumn>(),
     reservedFields: List<QueryColumn>(),
     commentLineCount: undefined,
+    distinctValues: Map<string, List<string>>(),
 }) {
     declare data: List<any>;
     declare fields: List<QueryColumn>;
     declare reservedFields: List<QueryColumn>;
     declare commentLineCount?: number;
+    declare distinctValues: Map<string, List<string>>;
 
     static create(rawModel): InferDomainResponse {
         let data = List<any>();
         let fields = List<QueryColumn>();
         let reservedFields = List<QueryColumn>();
+        let distinctValues = Map<string, List<string>>();
 
         if (rawModel) {
             if (rawModel.data) {
@@ -32,21 +35,37 @@ export class InferDomainResponse extends Record({
             if (rawModel.reservedFields) {
                 reservedFields = List(rawModel.reservedFields.map(field => new QueryColumn(field)));
             }
+
+            if (rawModel.distinctValues) {
+                distinctValues = Map<string, List<string>>(
+                    Object.entries(rawModel.distinctValues).map(([key, value]) => [
+                        key,
+                        List<string>(value),
+                    ])
+                );
+            }
         }
 
         return new InferDomainResponse({
             data,
             fields,
             reservedFields,
             commentLineCount: rawModel.commentLineCount,
+            distinctValues,
         });
     }
+
+    // get the distinct values for a specific column, return empty list if the column doesn't exist
+    getDistinctValuesForColumn(columnName: string): List<string> {
+        return this.distinctValues.get(columnName, List<string>());
+    }
 }
 
 export function inferDomainFromFile(
     file: File | string, // file or webdav url path
     numLinesToInclude: number,
-    domainKindName?: string
+    domainKindName?: string,
+    distinctValueColumns?: string[]
 ): Promise<InferDomainResponse> {
     return new Promise((resolve, reject) => {
         const form = new FormData();
@@ -56,6 +75,10 @@ export function inferDomainFromFile(
         if (domainKindName) {
             form.append('domainKindName', domainKindName);
         }
+        if (distinctValueColumns && distinctValueColumns.length > 0) {
+            // append each value separately so they are received as an array on the server
+            distinctValueColumns.forEach(col => form.append('distinctValueColumns', col));
+        }
 
         Ajax.request({
             url: ActionURL.buildURL('property', 'inferDomain.api'),

packages/components/src/public/files/FileAttachmentForm.tsx

@@ -306,9 +306,13 @@ export class FileAttachmentForm extends PureComponent<FileAttachmentFormProps, S
             }
         }
 
-        this.updatePreviewStatus('Uploading file...');
-
-        inferDomainFromFile(file, previewGridProps.previewCount, previewGridProps.domainKindName)
+        this.updatePreviewStatus('Loading file preview...');
+        inferDomainFromFile(
+            file,
+            previewGridProps.previewCount,
+            previewGridProps.domainKindName,
+            previewGridProps.distinctValueColumns
+        )
             .then(response => {
                 this.updatePreviewStatus(null);
 

packages/components/src/public/files/models.ts

@@ -19,6 +19,7 @@ export interface FileSizeLimitProps {
 
 export interface FileGridPreviewProps {
     acceptedFormats?: string; // comma-separated list of allowed extensions i.e. '.png, .jpg, .jpeg'
+    distinctValueColumns?: string[];
     domainKindName?: string;
     errorStyle?: string;
     header?: string;