Add detailed auditing of domain changes & comment ability

CHANGELOG.md

@@ -1,3 +1,6 @@
+### 1.41.1 - 2025-05-22
+- Add `auditUserComment` to `Domain.drop` and `Domain.save`
+
 ### 1.41.0 - 2025-05-22
 - ActionURL.queryString: Add support for numbers, booleans, and mixed arrays
 

package.json

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

src/labkey/Domain.ts

@@ -205,12 +205,15 @@ function mapCreateArguments(args: IArguments): CreateDomainOptions {
 }
 
 export interface DropDomainOptions extends RequestCallbackOptions {
+    /** Can be used to provide a comment from the user that will be attached to domain audit event. */
+    auditUserComment?: string;
     /**
      * The container path in which the requested Domain is defined.
      * If not supplied, the current container path will be used.
      */
     containerPath?: string;
-    domainDesign?: any; // consider removing, this doesn't appear to be needed
+    // consider removing, this doesn't appear to be needed
+    domainDesign?: any;
     /** The domain query name. */
     queryName: string;
     /** The domain schema name. */
@@ -230,6 +233,7 @@ export function drop(config: DropDomainOptions): XMLHttpRequest {
             domainDesign: config.domainDesign,
             schemaName: config.schemaName,
             queryName: config.queryName,
+            auditUserComment: config.auditUserComment,
         },
     });
 }
@@ -346,6 +350,8 @@ export function get(config: GetDomainOptions): XMLHttpRequest {
 }
 
 export interface SaveDomainOptions extends RequestCallbackOptions {
+    /** Can be used to provide a comment from the user that will be attached to domain audit event. */
+    auditUserComment?: string;
     /**
      * The container path in which the requested Domain is defined.
      * If not supplied, the current container path will be used.
@@ -387,6 +393,7 @@ export function save(config: SaveDomainOptions): XMLHttpRequest {
                   containerPath: arguments[5],
                   includeWarnings: arguments[6],
                   options: arguments[7],
+                  auditUserComment: arguments[8],
               }
             : config;
 
@@ -401,6 +408,7 @@ export function save(config: SaveDomainOptions): XMLHttpRequest {
             queryName: options.queryName,
             domainId: options.domainId,
             includeWarnings: options.includeWarnings,
+            auditUserComment: options.auditUserComment,
             options: options.options,
         },
     });

src/labkey/Exp.ts

@@ -437,7 +437,7 @@ export class Data extends ExpObject {
      *                  ["StringColumn", "DateColumn"],
      *                  ["Hello", "16 May 2009 17:00:00"],
      *                  ["world", "12/21/2008 08:45AM"]
- *                  ]
+     *                  ]
      *         },{
      *             "name": "Sheet2",
      *             "data": [

src/labkey/security/Container.ts

@@ -168,6 +168,10 @@ export interface GetContainersOptions extends RequestCallbackOptions /* <Contain
      * will not be included. (defaults to true)
      */
     includeEffectivePermissions?: boolean;
+    /**
+     * If set to true, will include properties about the inherited state of the formats as well as formats from parent folders that can be inherited.
+     */
+    includeInheritableFormats?: 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.
@@ -182,10 +186,6 @@ export interface GetContainersOptions extends RequestCallbackOptions /* <Contain
      * If set to false, child containers of type "workbook" will not be included. (defaults to true)
      */
     includeWorkbookChildren?: boolean;
-    /**
-     * If set to true, will include properties about the inherited state of the formats as well as formats from parent folders that can be inherited.
-     */
-    includeInheritableFormats?: 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.

src/labkey/security/constants.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import { getServerContext } from '../constants';
+
 import { getRoles, hasEffectivePermission } from './Permission';
 
 /**