Merge pull request #27 from modelon-community/topic/expose-experiment…

…-execution-options fix: add options input to runExperiment
modelon-community · Jan 4, 2024 · 29be1f2 · 29be1f2
2 parents 0599c9b + 59feb40
commit 29be1f2
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 4 deletions.
diff --git a/src/api.ts b/src/api.ts
@@ -28,6 +28,7 @@ import {
     ProjectId,
     WorkspaceProtocol,
     WorkspaceId,
+    ExecutionOptions,
 } from './types'
 
 import { wrapper as axiosCookieWrapper } from 'axios-cookiejar-support'
@@ -403,10 +404,12 @@ class Api {
         cases,
         experimentId,
         workspaceId,
+        options,
     }: {
         cases: CaseId[]
         experimentId: ExperimentId
         workspaceId: WorkspaceId
+        options?: ExecutionOptions
     }): Promise<void> =>
         new Promise((resolve, reject) => {
             this.ensureImpactToken()
@@ -418,9 +421,7 @@ class Api {
                                 includeCases: {
                                     ids: cases,
                                 },
-                                options: {
-                                    forceCompilation: true,
-                                },
+                                options
                             }
                         )
                         .then(() => resolve())

diff --git a/src/experiment.ts b/src/experiment.ts
@@ -1,5 +1,6 @@
 import {
     CaseId,
+    ExecutionOptions,
     ExperimentId,
     ExperimentMetaData,
     ExperimentRunInfo,
@@ -125,11 +126,12 @@ class Experiment {
         })
     }
 
-    run = async (cases: CaseId[]): Promise<void> =>
+    run = async (cases: CaseId[], options?: ExecutionOptions): Promise<void> =>
         this.api.runExperiment({
             cases,
             experimentId: this.id,
             workspaceId: this.workspaceId,
+            options,
         })
 
     executionDone = async (timeout: number): Promise<void> => {

diff --git a/src/index.ts b/src/index.ts
@@ -17,6 +17,7 @@ import {
     CaseTrajectories,
     CustomFunction,
     CustomFunctionOptions,
+    ExecutionOptions,
     ExecutionStatusType,
     ExperimentId,
     ExperimentRunInfo,
@@ -52,6 +53,7 @@ export {
     ExperimentId,
     ExperimentRunInfo,
     ExperimentTrajectories,
+    ExecutionOptions,
     FmuModel,
     InvalidApiKey,
     JhTokenError,

diff --git a/src/types/index.d.ts b/src/types/index.d.ts
@@ -7,6 +7,9 @@ export type CustomFunctionOptions =
 export type CustomFunction =
     operations['getCustomFunction']['responses']['200']['content']['application/json']
 
+export type ExecutionOptions = 
+    NonNullable<NonNullable<operations['execute']['requestBody']>['content']['application/json']['options']>
+
 export type ExecutionStatusType =
     operations['getExecutionStatus']['responses']['200']['content']['application/json']
 

diff --git a/src/workspace.ts b/src/workspace.ts
@@ -2,6 +2,7 @@ import {
     CaseId,
     CustomFunction,
     CustomFunctionOptions,
+    ExecutionOptions,
     ExperimentId,
     ExperimentItem,
     WorkspaceDefinition,
@@ -51,16 +52,19 @@ class Workspace {
     executeExperiment = async ({
         caseIds,
         experimentDefinition,
+        options,
     }: {
         caseIds: CaseId[]
         experimentDefinition: ExperimentDefinition
+        options?: ExecutionOptions
     }): Promise<Experiment> => {
         const experiment = await this.createExperiment(experimentDefinition)
 
         await this.api.runExperiment({
             cases: caseIds,
             experimentId: experiment.id,
             workspaceId: this.id,
+            options
         })
 
         return new Experiment({