(fix) : resolve failing workspace launcher (#160)

Author: donaldkibet

projects/ngx-formentry/src/components/workspace-launcher/workspace-launcher.component.ts

@@ -9,11 +9,13 @@ export class WorkspaceLauncherComponent {
   @Input() public buttonLabel: string;
   @Input() public buttonType: string;
   @Input() public workspaceName: string;
+  @Input() public additionalProps: Record<string, unknown>;
 
   public handleClick() {
     // We check that this is defined in question.factory.ts `toWorkspaceLauncher`
-    window['_openmrs_esm_patient_common_lib'].launchPatientWorkspace(
-      this.workspaceName
+    window['_openmrs_esm_framework'].launchWorkspace(
+      this.workspaceName,
+      this.additionalProps ?? {}
     );
   }
 }

projects/ngx-formentry/src/form-entry/form-factory/question.factory.ts

@@ -39,7 +39,7 @@ export class QuestionFactory {
   dataSources: any = {};
   historicalHelperService: HistoricalHelperService = new HistoricalHelperService();
   quetionIndex = 0;
-  checkedForEsmPatientCommonLib = false;
+  checkedForEsmFramework = false;
   constructor() {}
 
   createQuestionModel(formSchema: any, form?: Form): QuestionBase {
@@ -822,18 +822,17 @@ export class QuestionFactory {
   }
 
   toWorkspaceLauncher(schemaQuestion: any): WorkspaceLauncherQuestion {
-    if (!this.checkedForEsmPatientCommonLib) {
-      this.checkedForEsmPatientCommonLib = true;
-      if (!window['_openmrs_esm_patient_common_lib']) {
+    if (!this.checkedForEsmFramework) {
+      this.checkedForEsmFramework = true;
+      if (!window['_openmrs_esm_framework']) {
         console.error(
-          "@openmrs/esm-patient-common-lib is not accessible. The 'workspace-launcher' question type can only be used in the context of the O3 patient chart, where the workspace is."
+          "@openmrs/esm-framework is not accessible. The 'workspace-launcher' question type can only be used in the context of the O3 patient chart, where the workspace is."
         );
       } else if (
-        typeof window['_openmrs_esm_patient_common_lib']
-          .launchPatientWorkspace !== 'function'
+        typeof window['_openmrs_esm_framework'].launchWorkspace !== 'function'
       ) {
         console.error(
-          '@openmrs/esm-patient-common-lib is accessible, but the `launchPatientWorkspace` function is missing. It is likely that the version of @openmrs/esm-patient-common-lib that is being used is not compatible with this version of ngx-formentry.'
+          '@openmrs/esm-framework is accessible, but the `launchWorkspace` function is missing. It is likely that the version of @openmrs/esm-framework that is being used is not compatible with this version of ngx-formentry.'
         );
       }
     }
@@ -843,7 +842,8 @@ export class QuestionFactory {
       label: schemaQuestion.label,
       buttonLabel: schemaQuestion.questionOptions.buttonLabel,
       buttonType: schemaQuestion.questionOptions.buttonType,
-      workspaceName: schemaQuestion.questionOptions.workspaceName
+      workspaceName: schemaQuestion.questionOptions.workspaceName,
+      additionalProps: schemaQuestion.questionOptions?.additionalProps ?? {}
     });
     question.questionIndex = this.quetionIndex;
     question.extras = schemaQuestion;

projects/ngx-formentry/src/form-entry/form-renderer/form-renderer.component.html

@@ -361,6 +361,9 @@
               [workspaceName]="
                 node.question.extras.questionOptions.workspaceName
               "
+              [additionalProps]="
+                node.question.extras.questionOptions.additionalProps
+              "
             ></ofe-workspace-launcher>
           </div>
 

projects/ngx-formentry/src/form-entry/question-models/interfaces/workspace-launcher-options.ts

@@ -4,4 +4,5 @@ export interface WorkspaceLauncherOptions extends BaseOptions {
   buttonLabel: string;
   buttonType: string;
   workspaceName: string;
+  additionalProps: Record<string, unknown>;
 }

projects/ngx-formentry/src/form-entry/question-models/workspace-launcher.model.ts

@@ -6,6 +6,7 @@ export class WorkspaceLauncherQuestion extends QuestionBase {
   buttonLabel: string;
   buttonType: string;
   workspaceName: string;
+  additionalProps: Record<string, unknown>;
 
   constructor(options: WorkspaceLauncherOptions) {
     super(options);
@@ -14,6 +15,7 @@ export class WorkspaceLauncherQuestion extends QuestionBase {
     this.buttonLabel = options.buttonLabel || '';
     this.buttonType = options.buttonType || 'primary';
     this.workspaceName = options.workspaceName || 'order-basket';
+    this.additionalProps = options.additionalProps || {};
     this.controlType = AfeControlType.AfeFormControl;
   }
 }