AssayDOM.importRun: support "plateMetadata" property (#155)

Author: labkey-nicka

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.22.0 - 2023-07-14
+- Support `plateMetadata` JSON property on `AssayDOM.importRun`.
+- Rename `IImportRunOptions` to `ImportRunOptions`.
+- Extend `RequestCallbackOptions` to streamline usage of common request options.
+- Factor out superfluous `FormWindow` type. TypeScript typings for DOM libraries have improved since initial implementation.
+
 ## 1.21.0 - 2023-05-23
 - Fixes the implementation of `List.create()` to support `keyName` and `keyType` as they were originally documented.
 - Deprecate `keyName` in favor of specifying `options.keyName` as specified on `Domain.create()`.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@labkey/api",
-  "version": "1.21.0",
+  "version": "1.22.0",
   "description": "JavaScript client API for LabKey Server",
   "scripts": {
     "build": "npm run build:dist && npm run build:docs",

package.json

@@ -15,13 +15,9 @@
  */
 import { buildURL } from '../ActionURL';
 import { request } from '../Ajax';
-import { getCallbackWrapper, getOnFailure, getOnSuccess, isObject } from '../Utils';
+import { getCallbackWrapper, getOnFailure, getOnSuccess, isObject, RequestCallbackOptions } from '../Utils';
 
-import { FormWindow } from './constants';
-
-declare let window: FormWindow;
-
-export interface IImportRunOptions {
+export interface ImportRunOptions extends RequestCallbackOptions {
     allowCrossRunFileInputs?: boolean;
     allowLookupByAlternateKey?: boolean;
     assayId?: number | string;
@@ -31,23 +27,21 @@ export interface IImportRunOptions {
     comments?: string;
     containerPath?: string;
     dataRows?: any[];
-    failure?: Function;
     files?: any[];
     forceAsync?: boolean;
     jobDescription?: string;
     jobNotificationProvider?: string;
     name?: string;
+    plateMetadata?: any;
     properties?: any;
     reRunId?: number | string;
     runFilePath?: string;
     saveDataAsFile?: boolean;
-    scope?: any;
-    success: Function;
     workflowTask?: number;
 }
 
-export function importRun(options: IImportRunOptions): void {
-    if (!window.FormData) {
+export function importRun(options: ImportRunOptions): XMLHttpRequest {
+    if (!FormData) {
         throw new Error('modern browser required');
     }
 
@@ -59,7 +53,7 @@ export function importRun(options: IImportRunOptions): void {
     if (options.files) {
         for (let i = 0; i < options.files.length; i++) {
             const f = options.files[i];
-            if (f instanceof window.File) {
+            if (f instanceof File) {
                 files.push(f);
             } else if (f.tagName == 'INPUT') {
                 for (let j = 0; j < f.files.length; j++) {
@@ -114,25 +108,21 @@ export function importRun(options: IImportRunOptions): void {
     }
 
     if (options.properties) {
-        for (const key in options.properties) {
-            if (options.properties.hasOwnProperty(key)) {
-                if (isObject(options.properties[key])) {
-                    formData.append("properties['" + key + "']", JSON.stringify(options.properties[key]));
-                } else {
-                    formData.append("properties['" + key + "']", options.properties[key]);
-                }
+        for (const [key, value] of Object.entries(options.properties)) {
+            if (isObject(value)) {
+                formData.append(`properties['${key}']`, JSON.stringify(value));
+            } else {
+                formData.append(`properties['${key}']`, options.properties[key]);
             }
         }
     }
 
     if (options.batchProperties) {
-        for (const key in options.batchProperties) {
-            if (options.batchProperties.hasOwnProperty(key)) {
-                if (isObject(options.batchProperties[key])) {
-                    formData.append("batchProperties['" + key + "']", JSON.stringify(options.batchProperties[key]));
-                } else {
-                    formData.append("batchProperties['" + key + "']", options.batchProperties[key]);
-                }
+        for (const [key, value] of Object.entries(options.batchProperties)) {
+            if (isObject(value)) {
+                formData.append(`batchProperties['${key}']`, JSON.stringify(value));
+            } else {
+                formData.append(`batchProperties['${key}']`, options.batchProperties[key]);
             }
         }
     }
@@ -152,7 +142,11 @@ export function importRun(options: IImportRunOptions): void {
         }
     }
 
-    request({
+    if (options.plateMetadata) {
+        formData.append('plateMetadata', JSON.stringify(options.plateMetadata));
+    }
+
+    return request({
         url: buildURL('assay', 'importRun.api', options.containerPath),
         method: 'POST',
         success: getCallbackWrapper(getOnSuccess(options), options.scope),

src/labkey/dom/Assay.ts

@@ -19,11 +19,8 @@ import { getCallbackWrapper, getOnFailure, getOnSuccess, merge } from '../Utils'
 import { appendFilterParams } from '../filter/Filter';
 import { ContainerFilter } from '../query/Utils';
 
-import { FormWindow } from './constants';
 import { postToAction } from './Utils';
 
-declare let window: FormWindow;
-
 export interface IExportSqlOptions {
     containerFilter?: ContainerFilter;
     containerPath?: string;
@@ -120,7 +117,7 @@ export interface IImportDataOptions {
 }
 
 export function importData(options: IImportDataOptions): XMLHttpRequest {
-    if (!window.FormData) {
+    if (!FormData) {
         throw new Error('modern browser required');
     }
 

src/labkey/dom/Query.ts

@@ -15,11 +15,6 @@
  */
 import { LabKey } from '../constants';
 
-export interface FormWindow extends Window {
-    File: any;
-    FormData: any;
-}
-
 export interface LabKeyDOM extends LabKey {
     $: any;
     requiresExt4ClientAPI: Function;