Command: add auditBehavior, auditUserComment, skipReselectRows (#189)

Author: labkey-alan

CHANGELOG.md

@@ -1,3 +1,6 @@
+### 1.37.0 - 2024-12-19
+- Command: add auditBehavior, auditUserComment, skipReselectRows
+
 ### 1.36.0 - 2024-11-05
 - Package updates
 

package-lock.json

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

package.json

@@ -80,7 +80,7 @@ export enum ExperimentalFeatures {
     javascriptMothership = 'javascriptMothership',
 }
 
-/** THe different types of audit behaviors for query requests. May be used to override behavior for a specific requests. */
+/** The different types of audit behaviors for query requests. May be used to override behavior for a specific requests. */
 export enum AuditBehaviorTypes {
     DETAILED = 'DETAILED',
     NONE = 'NONE',

src/labkey/constants.ts

@@ -211,6 +211,10 @@ export interface ModifyRowsResults {
 }
 
 export interface Command {
+    /** Can be used to override the audit behavior for the table the Command is acting on. See{@link AuditBehaviorTypes}. */
+    auditBehavior?: AuditBehaviorTypes;
+    /** Can be used to provide a comment from the user that will be attached to certain detailed audit log records. */
+    auditUserComment?: string;
     /** Name of the command to be performed. Must be one of "insert", "update", or "delete". */
     command: CommandType;
     /** **Experimental:** Optional extra context object passed into the transformation/validation script environment. */
@@ -230,6 +234,11 @@ export interface Command {
      * See also: [How To Find schemaName, queryName & viewName](https://www.labkey.org/Documentation/wiki-page.view?name=findNames).
      */
     schemaName: string;
+    /**
+     * Whether the full detailed response for the update/insert rows can be skipped.
+     * Defaults to false.
+     */
+    skipReselectRows?: boolean;
 }
 
 export interface MoveRowsResponse extends ModifyRowsResults {
@@ -260,7 +269,7 @@ export interface SaveRowsOptions extends RequestCallbackOptions<SaveRowsResponse
      * will be invoked instead in the event of a validation failure.
      */
     apiVersion?: string | number;
-    /** An array of all of the update/insert/delete operations to be performed. */
+    /** An array of the update/insert/delete operations to be performed. */
     commands: Command[];
     /**
      * The container path in which the changes are to be performed.