Issue 47202: Options to reduce payload of getContainers.api response (#149)

## 1.18.8 - 2023-03-02
- Issue 47202: Options to reduce payload of getContainers.api response
  - two new properties: includeWorkbookChildren and includeStandardProperties

Author: cnathe

CHANGELOG.md

@@ -1,9 +1,13 @@
+## 1.18.8 - 2023-03-02
+- Issue 47202: Options to reduce payload of getContainers.api response
+  - two new properties: includeWorkbookChildren and includeStandardProperties 
+
 ## 1.18.7 - 2023-02-28
 - Add `comment` param to `deleteContainer` fn
 
 ## 1.18.6 - 2023-02-28
-* Update `LineageItemBase` to optionally include `comment?: string`.
-* Update `LineageNodeBase` to optionally include `protocol?: LineageItemBase`.
+- Update `LineageItemBase` to optionally include `comment?: string`.
+- Update `LineageNodeBase` to optionally include `protocol?: LineageItemBase`.
 
 ## 1.18.5 - 2023-02-24
 - Add the `AllInProject` and `AllInProjectPlusShared` container filter types supported starting in v23.03.

package-lock.json

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

package.json

@@ -140,11 +140,20 @@ export interface GetContainersOptions extends RequestCallbackOptions /* <Contain
      * will not be included. (defaults to true)
      */
     includeEffectivePermissions?: boolean;
+    /**
+     * If set to true, all of the container's standard properties will be included. (defaults to true)
+     * If set to false, only the base set of properties (i.e. id, name, and path) will be included.
+     */
+    includeStandardProperties?: boolean;
     /**
      * If set to true, the entire branch of containers will be returned.
      * If false, only the immediate children of the starting container will be returned (defaults to false).
      */
     includeSubfolders?: boolean;
+    /**
+     * If set to false, child containers of type "workbook" will not be included. (defaults to true)
+     */
+    includeWorkbookChildren?: boolean;
     /**
      * The names (Strings) of modules whose Module Property values should be included for each container.
      * Use "*" to get the value of all Module Properties for all modules.
@@ -188,6 +197,12 @@ export function getContainers(config: GetContainersOptions): XMLHttpRequest {
         if (config.includeEffectivePermissions != undefined) {
             params.includeEffectivePermissions = config.includeEffectivePermissions;
         }
+        if (config.includeWorkbookChildren != undefined) {
+            params.includeWorkbookChildren = config.includeWorkbookChildren;
+        }
+        if (config.includeStandardProperties != undefined) {
+            params.includeStandardProperties = config.includeStandardProperties;
+        }
     }
 
     return request({