@finos/legend-application 3.0.3 → 4.0.2

package/lib/stores/LambdaParameterState.js

@@ -0,0 +1,184 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { CollectionInstanceValue, Enumeration, EnumValueExplicitReference, EnumValueInstanceValue, GenericType, GenericTypeExplicitReference, getEnumValue, observe_ValueSpecification, observe_VariableExpression, PrimitiveInstanceValue, PrimitiveType, PRIMITIVE_TYPE, VariableExpression, LambdaFunction, TYPICAL_MULTIPLICITY_TYPE, CORE_PURE_PATH, FunctionType, SimpleFunctionExpression, SUPPORTED_FUNCTIONS, extractElementNameFromPath, } from '@finos/legend-graph';
+import { addUniqueEntry, deleteEntry, IllegalStateError, isNonNullable, Randomizer, uuid, } from '@finos/legend-shared';
+import { makeObservable, observable, action } from 'mobx';
+import { genericType_setRawType, multiplicity_setLowerBound, multiplicity_setUpperBound, } from './ValueSpecificationModifierHelper.js';
+import { format, addDays } from 'date-fns';
+import { DATE_FORMAT, DATE_TIME_FORMAT } from '../const.js';
+export var PARAMETER_SUBMIT_ACTION;
+(function (PARAMETER_SUBMIT_ACTION) {
+    PARAMETER_SUBMIT_ACTION["EXECUTE"] = "EXECUTE";
+    PARAMETER_SUBMIT_ACTION["EXPORT"] = "EXPORT";
+})(PARAMETER_SUBMIT_ACTION = PARAMETER_SUBMIT_ACTION || (PARAMETER_SUBMIT_ACTION = {}));
+export const createMockEnumerationProperty = (enumeration) => new Randomizer().getRandomItemInCollection(enumeration.values)?.name ?? '';
+const createMockPrimitiveProperty = (primitiveType, propertyName) => {
+    const randomizer = new Randomizer();
+    switch (primitiveType.name) {
+        case PRIMITIVE_TYPE.BOOLEAN:
+            return randomizer.getRandomItemInCollection([true, false]) ?? true;
+        case PRIMITIVE_TYPE.FLOAT:
+            return randomizer.getRandomFloat();
+        case PRIMITIVE_TYPE.DECIMAL:
+            return randomizer.getRandomDouble();
+        case PRIMITIVE_TYPE.NUMBER:
+        case PRIMITIVE_TYPE.INTEGER:
+            return randomizer.getRandomWholeNumber(100);
+        // NOTE that `Date` is the umbrella type that comprises `StrictDate` and `DateTime`, but for simplicity, we will generate `Date` as `StrictDate`
+        case PRIMITIVE_TYPE.DATE:
+        case PRIMITIVE_TYPE.STRICTDATE:
+            return format(randomizer.getRandomDate(new Date(Date.now()), addDays(Date.now(), 100)), DATE_FORMAT);
+        case PRIMITIVE_TYPE.DATETIME:
+            return format(randomizer.getRandomDate(new Date(Date.now()), addDays(Date.now(), 100)), DATE_TIME_FORMAT);
+        case PRIMITIVE_TYPE.STRING:
+        default:
+            return `${propertyName} ${randomizer.getRandomWholeNumber(100)}`;
+    }
+};
+export const buildParametersLetLambdaFunc = (graph, lambdaParametersStates) => {
+    const multiplicityOne = graph.getTypicalMultiplicity(TYPICAL_MULTIPLICITY_TYPE.ONE);
+    const typeString = graph.getPrimitiveType(PRIMITIVE_TYPE.STRING);
+    const typeAny = graph.getType(CORE_PURE_PATH.ANY);
+    const letlambdaFunction = new LambdaFunction(new FunctionType(typeAny, multiplicityOne));
+    letlambdaFunction.expressionSequence = lambdaParametersStates
+        .map((queryParamState) => {
+        if (queryParamState.value) {
+            const letFunc = new SimpleFunctionExpression(extractElementNameFromPath(SUPPORTED_FUNCTIONS.LET), multiplicityOne);
+            const letVar = new PrimitiveInstanceValue(GenericTypeExplicitReference.create(new GenericType(typeString)), multiplicityOne);
+            letVar.values = [queryParamState.variableName];
+            letFunc.parametersValues.push(letVar);
+            letFunc.parametersValues.push(queryParamState.value);
+            return letFunc;
+        }
+        return undefined;
+    })
+        .filter(isNonNullable);
+    return letlambdaFunction;
+};
+export class LambdaParameterState {
+    uuid = uuid();
+    parameter;
+    observableContext;
+    value;
+    constructor(variableExpression, observableContext) {
+        makeObservable(this, {
+            value: observable,
+            setValue: action,
+            mockParameterValue: action,
+        });
+        this.observableContext = observableContext;
+        this.parameter = observe_VariableExpression(variableExpression);
+    }
+    mockParameterValue() {
+        this.setValue(this.generateMockValues(this.parameter.genericType?.value.rawType, this.parameter.multiplicity));
+    }
+    generateMockValues(varType, multiplicity) {
+        if ((!multiplicity.upperBound || multiplicity.upperBound > 1) && varType) {
+            return new CollectionInstanceValue(multiplicity, GenericTypeExplicitReference.create(new GenericType(varType)));
+        }
+        if (varType instanceof PrimitiveType) {
+            const primitiveInst = new PrimitiveInstanceValue(GenericTypeExplicitReference.create(new GenericType(varType)), multiplicity);
+            primitiveInst.values = [
+                createMockPrimitiveProperty(varType, this.parameter.name === '' ? 'myVar' : this.parameter.name),
+            ];
+            return primitiveInst;
+        }
+        else if (varType instanceof Enumeration) {
+            const enumValueInstance = new EnumValueInstanceValue(GenericTypeExplicitReference.create(new GenericType(varType)), multiplicity);
+            const mock = createMockEnumerationProperty(varType);
+            if (mock !== '') {
+                enumValueInstance.values = [
+                    EnumValueExplicitReference.create(getEnumValue(varType, mock)),
+                ];
+            }
+            return enumValueInstance;
+        }
+        return undefined;
+    }
+    setValue(value) {
+        if (value instanceof VariableExpression) {
+            throw new IllegalStateError('Can not assign a parameter to another parameter');
+        }
+        this.value = value
+            ? observe_ValueSpecification(value, this.observableContext)
+            : undefined;
+    }
+    changeVariableType(type) {
+        if (type !== this.variableType) {
+            const genricType = this.parameter.genericType?.value;
+            if (genricType) {
+                genericType_setRawType(genricType, type);
+            }
+            this.mockParameterValue();
+        }
+    }
+    changeMultiplicity(lowerBound, uppderBound) {
+        const current = this.parameter.multiplicity;
+        if (current.lowerBound !== lowerBound ||
+            current.upperBound !== uppderBound) {
+            multiplicity_setLowerBound(current, lowerBound);
+            multiplicity_setUpperBound(current, uppderBound);
+            this.mockParameterValue();
+        }
+    }
+    get variableName() {
+        return this.parameter.name;
+    }
+    get variableType() {
+        return this.parameter.genericType?.value.rawType;
+    }
+}
+export class ParameterInstanceValuesEditorState {
+    showModal = false;
+    submitAction;
+    constructor() {
+        makeObservable(this, {
+            showModal: observable,
+            submitAction: observable,
+            setShowModal: action,
+            open: action,
+            setSubmitAction: action,
+        });
+    }
+    setShowModal(val) {
+        this.showModal = val;
+    }
+    setSubmitAction(val) {
+        this.submitAction = val;
+    }
+    open(handler, label) {
+        this.setSubmitAction({ handler, label });
+        this.setShowModal(true);
+    }
+    close() {
+        this.setSubmitAction(undefined);
+        this.setShowModal(false);
+    }
+}
+export class LambdaParametersState {
+    parameterStates = [];
+    parameterValuesEditorState = new ParameterInstanceValuesEditorState();
+    addParameter(val) {
+        addUniqueEntry(this.parameterStates, val);
+    }
+    removeParameter(val) {
+        deleteEntry(this.parameterStates, val);
+    }
+    setParameters(val) {
+        this.parameterStates = val;
+    }
+}
+//# sourceMappingURL=LambdaParameterState.js.map

package/lib/stores/LambdaParameterState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LambdaParameterState.js","sourceRoot":"","sources":["../../src/stores/LambdaParameterState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAOL,uBAAuB,EACvB,WAAW,EACX,0BAA0B,EAC1B,sBAAsB,EACtB,WAAW,EACX,4BAA4B,EAC5B,YAAY,EACZ,0BAA0B,EAC1B,0BAA0B,EAC1B,sBAAsB,EACtB,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,yBAAyB,EACzB,cAAc,EACd,YAAY,EACZ,wBAAwB,EACxB,mBAAmB,EACnB,0BAA0B,GAC3B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,cAAc,EACd,WAAW,EACX,iBAAiB,EACjB,aAAa,EACb,UAAU,EACV,IAAI,GACL,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC1D,OAAO,EACL,sBAAsB,EACtB,0BAA0B,EAC1B,0BAA0B,GAC3B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE5D,MAAM,CAAN,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,8CAAmB,CAAA;IACnB,4CAAiB,CAAA;AACnB,CAAC,EAHW,uBAAuB,GAAvB,uBAAuB,KAAvB,uBAAuB,QAGlC;AAED,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,WAAwB,EAChB,EAAE,CACV,IAAI,UAAU,EAAE,CAAC,yBAAyB,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;AAE7E,MAAM,2BAA2B,GAAG,CAClC,aAA4B,EAC5B,YAAoB,EACO,EAAE;IAC7B,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;IACpC,QAAQ,aAAa,CAAC,IAAI,EAAE;QAC1B,KAAK,cAAc,CAAC,OAAO;YACzB,OAAO,UAAU,CAAC,yBAAyB,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC;QACrE,KAAK,cAAc,CAAC,KAAK;YACvB,OAAO,UAAU,CAAC,cAAc,EAAE,CAAC;QACrC,KAAK,cAAc,CAAC,OAAO;YACzB,OAAO,UAAU,CAAC,eAAe,EAAE,CAAC;QACtC,KAAK,cAAc,CAAC,MAAM,CAAC;QAC3B,KAAK,cAAc,CAAC,OAAO;YACzB,OAAO,UAAU,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC9C,gJAAgJ;QAChJ,KAAK,cAAc,CAAC,IAAI,CAAC;QACzB,KAAK,cAAc,CAAC,UAAU;YAC5B,OAAO,MAAM,CACX,UAAU,CAAC,aAAa,CACtB,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EACpB,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,CACzB,EACD,WAAW,CACZ,CAAC;QACJ,KAAK,cAAc,CAAC,QAAQ;YAC1B,OAAO,MAAM,CACX,UAAU,CAAC,aAAa,CACtB,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EACpB,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,CACzB,EACD,gBAAgB,CACjB,CAAC;QACJ,KAAK,cAAc,CAAC,MAAM,CAAC;QAC3B;YACE,OAAO,GAAG,YAAY,IAAI,UAAU,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC;KACpE;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,KAAgB,EAChB,sBAA8C,EAC9B,EAAE;IAClB,MAAM,eAAe,GAAG,KAAK,CAAC,sBAAsB,CAClD,yBAAyB,CAAC,GAAG,CAC9B,CAAC;IACF,MAAM,UAAU,GAAG,KAAK,CAAC,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACjE,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,iBAAiB,GAAG,IAAI,cAAc,CAC1C,IAAI,YAAY,CAAC,OAAO,EAAE,eAAe,CAAC,CAC3C,CAAC;IACF,iBAAiB,CAAC,kBAAkB,GAAG,sBAAsB;SAC1D,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE;QACvB,IAAI,eAAe,CAAC,KAAK,EAAE;YACzB,MAAM,OAAO,GAAG,IAAI,wBAAwB,CAC1C,0BAA0B,CAAC,mBAAmB,CAAC,GAAG,CAAC,EACnD,eAAe,CAChB,CAAC;YACF,MAAM,MAAM,GAAG,IAAI,sBAAsB,CACvC,4BAA4B,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,UAAU,CAAC,CAAC,EAChE,eAAe,CAChB,CAAC;YACF,MAAM,CAAC,MAAM,GAAG,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAC/C,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACtC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YACrD,OAAO,OAAO,CAAC;SAChB;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;SACD,MAAM,CAAC,aAAa,CAAC,CAAC;IACzB,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,OAAO,oBAAoB;IACtB,IAAI,GAAG,IAAI,EAAE,CAAC;IACd,SAAS,CAAqB;IACvC,iBAAiB,CAAkB;IACnC,KAAK,CAAiC;IAEtC,YACE,kBAAsC,EACtC,iBAAkC;QAElC,cAAc,CAAC,IAAI,EAAE;YACnB,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,MAAM;YAChB,kBAAkB,EAAE,MAAM;SAC3B,CAAC,CAAC;QACH,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,0BAA0B,CAAC,kBAAkB,CAAC,CAAC;IAClE,CAAC;IAED,kBAAkB;QAChB,IAAI,CAAC,QAAQ,CACX,IAAI,CAAC,kBAAkB,CACrB,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,CAAC,OAAO,EACzC,IAAI,CAAC,SAAS,CAAC,YAAY,CAC5B,CACF,CAAC;IACJ,CAAC;IAEO,kBAAkB,CACxB,OAAyB,EACzB,YAA0B;QAE1B,IAAI,CAAC,CAAC,YAAY,CAAC,UAAU,IAAI,YAAY,CAAC,UAAU,GAAG,CAAC,CAAC,IAAI,OAAO,EAAE;YACxE,OAAO,IAAI,uBAAuB,CAChC,YAAY,EACZ,4BAA4B,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAC9D,CAAC;SACH;QACD,IAAI,OAAO,YAAY,aAAa,EAAE;YACpC,MAAM,aAAa,GAAG,IAAI,sBAAsB,CAC9C,4BAA4B,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAC7D,YAAY,CACb,CAAC;YACF,aAAa,CAAC,MAAM,GAAG;gBACrB,2BAA2B,CACzB,OAAO,EACP,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAC3D;aACF,CAAC;YACF,OAAO,aAAa,CAAC;SACtB;aAAM,IAAI,OAAO,YAAY,WAAW,EAAE;YACzC,MAAM,iBAAiB,GAAG,IAAI,sBAAsB,CAClD,4BAA4B,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAC7D,YAAY,CACb,CAAC;YACF,MAAM,IAAI,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAC;YACpD,IAAI,IAAI,KAAK,EAAE,EAAE;gBACf,iBAAiB,CAAC,MAAM,GAAG;oBACzB,0BAA0B,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;iBAC/D,CAAC;aACH;YACD,OAAO,iBAAiB,CAAC;SAC1B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,QAAQ,CAAC,KAAqC;QAC5C,IAAI,KAAK,YAAY,kBAAkB,EAAE;YACvC,MAAM,IAAI,iBAAiB,CACzB,iDAAiD,CAClD,CAAC;SACH;QACD,IAAI,CAAC,KAAK,GAAG,KAAK;YAChB,CAAC,CAAC,0BAA0B,CAAC,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC;YAC3D,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAED,kBAAkB,CAAC,IAAU;QAC3B,IAAI,IAAI,KAAK,IAAI,CAAC,YAAY,EAAE;YAC9B,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,CAAC;YACrD,IAAI,UAAU,EAAE;gBACd,sBAAsB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;aAC1C;YACD,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC3B;IACH,CAAC;IAED,kBAAkB,CAChB,UAAkB,EAClB,WAA+B;QAE/B,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;QAC5C,IACE,OAAO,CAAC,UAAU,KAAK,UAAU;YACjC,OAAO,CAAC,UAAU,KAAK,WAAW,EAClC;YACA,0BAA0B,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAChD,0BAA0B,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YACjD,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC3B;IACH,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC;IACnD,CAAC;CACF;AAED,MAAM,OAAO,kCAAkC;IAC7C,SAAS,GAAG,KAAK,CAAC;IAClB,YAAY,CAKE;IAEd;QACE,cAAc,CAAC,IAAI,EAAE;YACnB,SAAS,EAAE,UAAU;YACrB,YAAY,EAAE,UAAU;YACxB,YAAY,EAAE,MAAM;YACpB,IAAI,EAAE,MAAM;YACZ,eAAe,EAAE,MAAM;SACxB,CAAC,CAAC;IACL,CAAC;IAED,YAAY,CAAC,GAAY;QACvB,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;IACvB,CAAC;IAED,eAAe,CACb,GAKa;QAEb,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;IAC1B,CAAC;IAED,IAAI,CAAC,OAA4B,EAAE,KAAa;QAC9C,IAAI,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,KAAK;QACH,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAChC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;CACF;AACD,MAAM,OAAO,qBAAqB;IAChC,eAAe,GAA2B,EAAE,CAAC;IAC7C,0BAA0B,GAAG,IAAI,kCAAkC,EAAE,CAAC;IAEtE,YAAY,CAAC,GAAyB;QACpC,cAAc,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED,eAAe,CAAC,GAAyB;QACvC,WAAW,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;IACzC,CAAC;IACD,aAAa,CAAC,GAA2B;QACvC,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC;IAC7B,CAAC;CACF"}

package/lib/stores/LegendApplicationAssistantService.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { LegendApplicationContextualDocumentationEntry, LegendApplicationDocumentationEntry } from './LegendApplicationDocumentationService.js';
+import type { LegendApplicationConfig } from './LegendApplicationConfig.js';
+import type { ApplicationStore } from './ApplicationStore.js';
+import { type MarkdownText, ActionState } from '@finos/legend-shared';
+export declare enum VIRTUAL_ASSISTANT_TAB {
+    SEARCH = "SEARCH",
+    CONTEXTUAL_SUPPORT = "CONTEXTUAL_SUPPORT"
+}
+export declare class VirtualAssistantDocumentationEntry {
+    uuid: string;
+    documentationKey: string;
+    title: string;
+    content?: string | MarkdownText | undefined;
+    url?: string | undefined;
+    isOpen: boolean;
+    constructor(docEntry: LegendApplicationDocumentationEntry);
+    setIsOpen(val: boolean): void;
+}
+export declare class VirtualAssistantContextualDocumentationEntry {
+    uuid: string;
+    context: string;
+    title?: string | undefined;
+    content?: string | MarkdownText | undefined;
+    url?: string | undefined;
+    related: VirtualAssistantDocumentationEntry[];
+    constructor(contextualDocEntry: LegendApplicationContextualDocumentationEntry, related: VirtualAssistantDocumentationEntry[]);
+}
+export declare class LegendApplicationAssistantService {
+    readonly applicationStore: ApplicationStore<LegendApplicationConfig>;
+    private readonly searchEngine;
+    isHidden: boolean;
+    isOpen: boolean;
+    selectedTab: VIRTUAL_ASSISTANT_TAB;
+    searchResults: VirtualAssistantDocumentationEntry[];
+    searchState: ActionState;
+    searchText: string;
+    constructor(applicationStore: ApplicationStore<LegendApplicationConfig>);
+    get currentContextualDocumentationEntry(): VirtualAssistantContextualDocumentationEntry | undefined;
+    setIsHidden(val: boolean): void;
+    hideAssistant(): void;
+    toggleAssistant(): void;
+    setIsOpen(val: boolean): void;
+    setSelectedTab(val: VIRTUAL_ASSISTANT_TAB): void;
+    setSearchText(val: string): void;
+    resetSearch(): void;
+    search(): void;
+}
+//# sourceMappingURL=LegendApplicationAssistantService.d.ts.map

package/lib/stores/LegendApplicationAssistantService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LegendApplicationAssistantService.d.ts","sourceRoot":"","sources":["../../src/stores/LegendApplicationAssistantService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,KAAK,EACV,6CAA6C,EAC7C,mCAAmC,EACpC,MAAM,4CAA4C,CAAC;AACpD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D,OAAO,EACL,KAAK,YAAY,EAIjB,WAAW,EACZ,MAAM,sBAAsB,CAAC;AAE9B,oBAAY,qBAAqB;IAC/B,MAAM,WAAW;IACjB,kBAAkB,uBAAuB;CAC1C;AAED,qBAAa,kCAAkC;IAC7C,IAAI,SAAU;IACd,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAAC;IAC5C,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,MAAM,UAAS;gBAEH,QAAQ,EAAE,mCAAmC;IAYzD,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;CAG9B;AAED,qBAAa,4CAA4C;IACvD,IAAI,SAAU;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAAC;IAC5C,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,OAAO,EAAE,kCAAkC,EAAE,CAAC;gBAG5C,kBAAkB,EAAE,6CAA6C,EACjE,OAAO,EAAE,kCAAkC,EAAE;CAQhD;AAED,qBAAa,iCAAiC;IAC5C,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;IACrE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA4C;IACzE,QAAQ,UAAS;IACjB,MAAM,UAAS;IACf,WAAW,wBAAgC;IAE3C,aAAa,EAAE,kCAAkC,EAAE,CAAM;IACzD,WAAW,cAA+B;IAC1C,UAAU,SAAM;gBAEJ,gBAAgB,EAAE,gBAAgB,CAAC,uBAAuB,CAAC;IAqDvE,IAAI,mCAAmC,IACnC,4CAA4C,GAC5C,SAAS,CAwBZ;IAED,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAI/B,aAAa,IAAI,IAAI;IAKrB,eAAe,IAAI,IAAI;IASvB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAI7B,cAAc,CAAC,GAAG,EAAE,qBAAqB,GAAG,IAAI;IAIhD,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIhC,WAAW,IAAI,IAAI;IAMnB,MAAM,IAAI,IAAI;CAOf"}

package/lib/stores/LegendApplicationAssistantService.js

@@ -0,0 +1,167 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { action, makeObservable, observable, computed } from 'mobx';
+import { Fuse } from './CJS__Fuse.cjs';
+import { guaranteeNonEmptyString, uuid, isNonNullable, ActionState, } from '@finos/legend-shared';
+export var VIRTUAL_ASSISTANT_TAB;
+(function (VIRTUAL_ASSISTANT_TAB) {
+    VIRTUAL_ASSISTANT_TAB["SEARCH"] = "SEARCH";
+    VIRTUAL_ASSISTANT_TAB["CONTEXTUAL_SUPPORT"] = "CONTEXTUAL_SUPPORT";
+})(VIRTUAL_ASSISTANT_TAB = VIRTUAL_ASSISTANT_TAB || (VIRTUAL_ASSISTANT_TAB = {}));
+export class VirtualAssistantDocumentationEntry {
+    uuid = uuid();
+    documentationKey;
+    title;
+    content;
+    url;
+    isOpen = false;
+    constructor(docEntry) {
+        makeObservable(this, {
+            isOpen: observable,
+            setIsOpen: action,
+        });
+        this.documentationKey = docEntry._documentationKey;
+        this.title = guaranteeNonEmptyString(docEntry.title);
+        this.content = docEntry.markdownText ?? docEntry.text;
+        this.url = docEntry.url;
+    }
+    setIsOpen(val) {
+        this.isOpen = val;
+    }
+}
+export class VirtualAssistantContextualDocumentationEntry {
+    uuid = uuid();
+    context;
+    title;
+    content;
+    url;
+    related;
+    constructor(contextualDocEntry, related) {
+        this.context = contextualDocEntry._context;
+        this.title = contextualDocEntry.title;
+        this.content = contextualDocEntry.markdownText ?? contextualDocEntry.text;
+        this.url = contextualDocEntry.url;
+        this.related = related;
+    }
+}
+export class LegendApplicationAssistantService {
+    applicationStore;
+    searchEngine;
+    isHidden = false;
+    isOpen = false;
+    selectedTab = VIRTUAL_ASSISTANT_TAB.SEARCH;
+    searchResults = [];
+    searchState = ActionState.create().pass();
+    searchText = '';
+    constructor(applicationStore) {
+        makeObservable(this, {
+            isHidden: observable,
+            isOpen: observable,
+            selectedTab: observable,
+            searchText: observable,
+            searchResults: observable,
+            currentContextualDocumentationEntry: computed,
+            setIsHidden: action,
+            setIsOpen: action,
+            setSelectedTab: action,
+            setSearchText: action,
+            resetSearch: action,
+            search: action,
+        });
+        this.applicationStore = applicationStore;
+        this.searchEngine = new Fuse(this.applicationStore.documentationService.getAllDocEntries().filter((entry) => 
+        // NOTE: since we're searching for user-friendly docs, we will discard anything that
+        // doesn't come with a title, or does not have any content/url
+        entry.title && (entry.url ?? entry.text ?? entry.markdownText)), {
+            includeScore: true,
+            shouldSort: true,
+            // Ignore location when computing the search score
+            // See https://fusejs.io/concepts/scoring-theory.html
+            ignoreLocation: true,
+            // This specifies the point the search gives up
+            // `0.0` means exact match where `1.0` would match anything
+            // We set a relatively low threshold to filter out irrelevant results
+            threshold: 0.2,
+            keys: [
+                {
+                    // NOTE: for now, we would weight title the most
+                    name: 'title',
+                    weight: 4,
+                },
+                {
+                    name: 'text',
+                    weight: 1,
+                },
+                {
+                    name: 'markdownText.value',
+                    weight: 1,
+                },
+            ],
+        });
+    }
+    get currentContextualDocumentationEntry() {
+        const currentContextualDocumentationEntry = this.applicationStore
+            .navigationContextService.currentContext
+            ? this.applicationStore.documentationService.getContextualDocEntry(this.applicationStore.navigationContextService.currentContext.value)
+            : undefined;
+        return currentContextualDocumentationEntry
+            ? new VirtualAssistantContextualDocumentationEntry(currentContextualDocumentationEntry, currentContextualDocumentationEntry.related
+                .map((entry) => this.applicationStore.documentationService.getDocEntry(entry))
+                .filter(isNonNullable)
+                .filter((entry) => 
+            // NOTE: since we're searching for user-friendly docs, we will discard anything that
+            // doesn't come with a title, or does not have any content/url
+            entry.title && (entry.url ?? entry.text ?? entry.markdownText))
+                .map((entry) => new VirtualAssistantDocumentationEntry(entry)))
+            : undefined;
+    }
+    setIsHidden(val) {
+        this.isHidden = val;
+    }
+    hideAssistant() {
+        this.setIsHidden(true);
+        this.setIsOpen(false);
+    }
+    toggleAssistant() {
+        const newVal = !this.isHidden;
+        if (newVal) {
+            this.hideAssistant();
+        }
+        else {
+            this.setIsHidden(false);
+        }
+    }
+    setIsOpen(val) {
+        this.isOpen = val;
+    }
+    setSelectedTab(val) {
+        this.selectedTab = val;
+    }
+    setSearchText(val) {
+        this.searchText = val;
+    }
+    resetSearch() {
+        this.searchText = '';
+        this.searchResults = [];
+        this.searchState.complete();
+    }
+    search() {
+        this.searchState.inProgress();
+        this.searchResults = Array.from(this.searchEngine.search(this.searchText).values()).map((result) => new VirtualAssistantDocumentationEntry(result.item));
+        this.searchState.complete();
+    }
+}
+//# sourceMappingURL=LegendApplicationAssistantService.js.map

package/lib/stores/LegendApplicationAssistantService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LegendApplicationAssistantService.js","sourceRoot":"","sources":["../../src/stores/LegendApplicationAssistantService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAOpE,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAEL,uBAAuB,EACvB,IAAI,EACJ,aAAa,EACb,WAAW,GACZ,MAAM,sBAAsB,CAAC;AAE9B,MAAM,CAAN,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC/B,0CAAiB,CAAA;IACjB,kEAAyC,CAAA;AAC3C,CAAC,EAHW,qBAAqB,GAArB,qBAAqB,KAArB,qBAAqB,QAGhC;AAED,MAAM,OAAO,kCAAkC;IAC7C,IAAI,GAAG,IAAI,EAAE,CAAC;IACd,gBAAgB,CAAS;IACzB,KAAK,CAAS;IACd,OAAO,CAAqC;IAC5C,GAAG,CAAsB;IACzB,MAAM,GAAG,KAAK,CAAC;IAEf,YAAY,QAA6C;QACvD,cAAc,CAAC,IAAI,EAAE;YACnB,MAAM,EAAE,UAAU;YAClB,SAAS,EAAE,MAAM;SAClB,CAAC,CAAC;QAEH,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,KAAK,GAAG,uBAAuB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,IAAI,CAAC;QACtD,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;IAC1B,CAAC;IAED,SAAS,CAAC,GAAY;QACpB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;IACpB,CAAC;CACF;AAED,MAAM,OAAO,4CAA4C;IACvD,IAAI,GAAG,IAAI,EAAE,CAAC;IACd,OAAO,CAAS;IAChB,KAAK,CAAsB;IAC3B,OAAO,CAAqC;IAC5C,GAAG,CAAsB;IACzB,OAAO,CAAuC;IAE9C,YACE,kBAAiE,EACjE,OAA6C;QAE7C,IAAI,CAAC,OAAO,GAAG,kBAAkB,CAAC,QAAQ,CAAC;QAC3C,IAAI,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC;QACtC,IAAI,CAAC,OAAO,GAAG,kBAAkB,CAAC,YAAY,IAAI,kBAAkB,CAAC,IAAI,CAAC;QAC1E,IAAI,CAAC,GAAG,GAAG,kBAAkB,CAAC,GAAG,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,MAAM,OAAO,iCAAiC;IACnC,gBAAgB,CAA4C;IACpD,YAAY,CAA4C;IACzE,QAAQ,GAAG,KAAK,CAAC;IACjB,MAAM,GAAG,KAAK,CAAC;IACf,WAAW,GAAG,qBAAqB,CAAC,MAAM,CAAC;IAE3C,aAAa,GAAyC,EAAE,CAAC;IACzD,WAAW,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;IAC1C,UAAU,GAAG,EAAE,CAAC;IAEhB,YAAY,gBAA2D;QACrE,cAAc,CAAC,IAAI,EAAE;YACnB,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,UAAU;YAClB,WAAW,EAAE,UAAU;YACvB,UAAU,EAAE,UAAU;YACtB,aAAa,EAAE,UAAU;YACzB,mCAAmC,EAAE,QAAQ;YAC7C,WAAW,EAAE,MAAM;YACnB,SAAS,EAAE,MAAM;YACjB,cAAc,EAAE,MAAM;YACtB,aAAa,EAAE,MAAM;YACrB,WAAW,EAAE,MAAM;YACnB,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;QAEH,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,YAAY,GAAG,IAAI,IAAI,CAC1B,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,CAAC,MAAM,CAClE,CAAC,KAAK,EAAE,EAAE;QACR,oFAAoF;QACpF,8DAA8D;QAC9D,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,YAAY,CAAC,CACjE,EACD;YACE,YAAY,EAAE,IAAI;YAClB,UAAU,EAAE,IAAI;YAChB,kDAAkD;YAClD,qDAAqD;YACrD,cAAc,EAAE,IAAI;YACpB,+CAA+C;YAC/C,2DAA2D;YAC3D,qEAAqE;YACrE,SAAS,EAAE,GAAG;YACd,IAAI,EAAE;gBACJ;oBACE,gDAAgD;oBAChD,IAAI,EAAE,OAAO;oBACb,MAAM,EAAE,CAAC;iBACV;gBACD;oBACE,IAAI,EAAE,MAAM;oBACZ,MAAM,EAAE,CAAC;iBACV;gBACD;oBACE,IAAI,EAAE,oBAAoB;oBAC1B,MAAM,EAAE,CAAC;iBACV;aACF;SACF,CACF,CAAC;IACJ,CAAC;IAED,IAAI,mCAAmC;QAGrC,MAAM,mCAAmC,GAAG,IAAI,CAAC,gBAAgB;aAC9D,wBAAwB,CAAC,cAAc;YACxC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,qBAAqB,CAC9D,IAAI,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,cAAc,CAAC,KAAK,CACpE;YACH,CAAC,CAAC,SAAS,CAAC;QACd,OAAO,mCAAmC;YACxC,CAAC,CAAC,IAAI,4CAA4C,CAC9C,mCAAmC,EACnC,mCAAmC,CAAC,OAAO;iBACxC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACb,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,WAAW,CAAC,KAAK,CAAC,CAC9D;iBACA,MAAM,CAAC,aAAa,CAAC;iBACrB,MAAM,CACL,CAAC,KAAK,EAAE,EAAE;YACR,oFAAoF;YACpF,8DAA8D;YAC9D,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,YAAY,CAAC,CACjE;iBACA,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,kCAAkC,CAAC,KAAK,CAAC,CAAC,CACjE;YACH,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAED,WAAW,CAAC,GAAY;QACtB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;IACtB,CAAC;IAED,aAAa;QACX,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACvB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAED,eAAe;QACb,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,aAAa,EAAE,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;SACzB;IACH,CAAC;IAED,SAAS,CAAC,GAAY;QACpB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;IACpB,CAAC;IAED,cAAc,CAAC,GAA0B;QACvC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;IACzB,CAAC;IAED,aAAa,CAAC,GAAW;QACvB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IACxB,CAAC;IAED,WAAW;QACT,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAC9B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,IAAI,CAC7B,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CACnD,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;CACF"}

package/lib/stores/LegendApplicationConfig.d.ts

@@ -13,8 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { type PlainObject } from '@finos/legend-shared';
-import { type LegendApplicationKeyedDocumentationEntry, type LegendApplicationDocumentationEntry } from './LegendApplicationDocumentationRegistry';
+import { type LegendApplicationKeyedDocumentationEntry, type LegendApplicationDocumentationEntryConfig, type LegendApplicationKeyedContextualDocumentationEntry, type LegendApplicationContextualDocumentationEntryConfig } from './LegendApplicationDocumentationService.js';
 export interface LegendApplicationVersionData {
     buildTime: string;
     version: string;
@@ -25,7 +24,8 @@ export interface LegendApplicationConfigurationData {
     env: string;
     documentation?: {
         url: string;
-        entries?: Record<string, PlainObject<LegendApplicationDocumentationEntry>>;
+        entries?: Record<string, LegendApplicationDocumentationEntryConfig>;
+        contextualEntries?: Record<string, LegendApplicationContextualDocumentationEntryConfig>;
     };
     extensions?: Record<PropertyKey, unknown>;
 }
@@ -34,7 +34,8 @@ export declare abstract class LegendApplicationConfig {
     readonly baseUrl: string;
     readonly env: string;
     readonly documentationUrl: string | undefined;
-    readonly documentationKeyedEntries: LegendApplicationKeyedDocumentationEntry[];
+    readonly keyedDocumentationEntries: LegendApplicationKeyedDocumentationEntry[];
+    readonly keyedContextualDocumentationEntries: LegendApplicationKeyedContextualDocumentationEntry[];
     readonly appVersion: string;
     readonly appVersionBuildTime: string;
     readonly appVersionCommitId: string;

package/lib/stores/LegendApplicationConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LegendApplicationConfig.d.ts","sourceRoot":"","sources":["../../src/stores/LegendApplicationConfig.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAGL,KAAK,WAAW,EACjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,KAAK,wCAAwC,EAC7C,KAAK,mCAAmC,EAEzC,MAAM,0CAA0C,CAAC;AAElD,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kCAAkC;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,CAAC,EAAE;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,mCAAmC,CAAC,CAAC,CAAC;KAC5E,CAAC;IAIF,UAAU,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;CAC3C;AAED,8BAAsB,uBAAuB;IAC3C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C,QAAQ,CAAC,yBAAyB,EAAE,wCAAwC,EAAE,CACzE;IAEL,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;gBAGlC,UAAU,EAAE,kCAAkC,EAC9C,WAAW,EAAE,4BAA4B,EACzC,OAAO,EAAE,MAAM;CAgClB"}
+{"version":3,"file":"LegendApplicationConfig.d.ts","sourceRoot":"","sources":["../../src/stores/LegendApplicationConfig.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAMH,OAAO,EACL,KAAK,wCAAwC,EAC7C,KAAK,yCAAyC,EAC9C,KAAK,kDAAkD,EACvD,KAAK,mDAAmD,EAGzD,MAAM,4CAA4C,CAAC;AAEpD,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kCAAkC;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,CAAC,EAAE;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,yCAAyC,CAAC,CAAC;QACpE,iBAAiB,CAAC,EAAE,MAAM,CACxB,MAAM,EACN,mDAAmD,CACpD,CAAC;KACH,CAAC;IAIF,UAAU,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;CAC3C;AAED,8BAAsB,uBAAuB;IAC3C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAGrB,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C,QAAQ,CAAC,yBAAyB,EAAE,wCAAwC,EAAE,CACzE;IACL,QAAQ,CAAC,mCAAmC,EAAE,kDAAkD,EAAE,CAC7F;IAGL,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;gBAGlC,UAAU,EAAE,kCAAkC,EAC9C,WAAW,EAAE,4BAA4B,EACzC,OAAO,EAAE,MAAM;CAoClB"}

package/lib/stores/LegendApplicationConfig.js

@@ -14,13 +14,16 @@
  * limitations under the License.
  */
 import { guaranteeNonEmptyString, guaranteeNonNullable, } from '@finos/legend-shared';
-import { collectKeyedDocumnetationEntriesFromConfig, } from './LegendApplicationDocumentationRegistry';
+import { collectKeyedDocumnetationEntriesFromConfig, collectKeyedContextualDocumentationEntriesFromConfig, } from './LegendApplicationDocumentationService.js';
 export class LegendApplicationConfig {
     appName;
     baseUrl;
     env;
+    // documentation
     documentationUrl;
-    documentationKeyedEntries = [];
+    keyedDocumentationEntries = [];
+    keyedContextualDocumentationEntries = [];
+    // version
     appVersion;
     appVersionBuildTime;
     appVersionCommitId;
@@ -30,7 +33,9 @@ export class LegendApplicationConfig {
         this.env = guaranteeNonEmptyString(configData.env, `Can't configure application: 'env' field is missing or empty`);
         // Documentation
         this.documentationUrl = configData.documentation?.url;
-        this.documentationKeyedEntries = collectKeyedDocumnetationEntriesFromConfig(configData.documentation?.entries ?? {});
+        this.keyedDocumentationEntries = collectKeyedDocumnetationEntriesFromConfig(configData.documentation?.entries ?? {});
+        this.keyedContextualDocumentationEntries =
+            collectKeyedContextualDocumentationEntriesFromConfig(configData.documentation?.contextualEntries ?? {});
         // Version
         this.appVersion = guaranteeNonNullable(versionData.version, `Can't collect application version: 'version' field is missing`);
         this.appVersionBuildTime = guaranteeNonNullable(versionData.buildTime, `Can't collect application version: 'buildTime' field is missing`);

package/lib/stores/LegendApplicationConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"LegendApplicationConfig.js","sourceRoot":"","sources":["../../src/stores/LegendApplicationConfig.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,uBAAuB,EACvB,oBAAoB,GAErB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAGL,0CAA0C,GAC3C,MAAM,0CAA0C,CAAC;AAqBlD,MAAM,OAAgB,uBAAuB;IAClC,OAAO,CAAS;IAChB,OAAO,CAAS;IAChB,GAAG,CAAS;IAEZ,gBAAgB,CAAqB;IACrC,yBAAyB,GAChC,EAAE,CAAC;IAEI,UAAU,CAAS;IACnB,mBAAmB,CAAS;IAC5B,kBAAkB,CAAS;IAEpC,YACE,UAA8C,EAC9C,WAAyC,EACzC,OAAe;QAEf,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,uBAAuB,CACpC,UAAU,CAAC,OAAO,EAClB,kEAAkE,CACnE,CAAC;QACF,IAAI,CAAC,GAAG,GAAG,uBAAuB,CAChC,UAAU,CAAC,GAAG,EACd,8DAA8D,CAC/D,CAAC;QAEF,gBAAgB;QAChB,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,aAAa,EAAE,GAAG,CAAC;QACtD,IAAI,CAAC,yBAAyB,GAAG,0CAA0C,CACzE,UAAU,CAAC,aAAa,EAAE,OAAO,IAAI,EAAE,CACxC,CAAC;QAEF,UAAU;QACV,IAAI,CAAC,UAAU,GAAG,oBAAoB,CACpC,WAAW,CAAC,OAAO,EACnB,+DAA+D,CAChE,CAAC;QACF,IAAI,CAAC,mBAAmB,GAAG,oBAAoB,CAC7C,WAAW,CAAC,SAAS,EACrB,iEAAiE,CAClE,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,oBAAoB,CAC5C,WAAW,CAAC,SAAS,EACrB,iEAAiE,CAClE,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"LegendApplicationConfig.js","sourceRoot":"","sources":["../../src/stores/LegendApplicationConfig.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,uBAAuB,EACvB,oBAAoB,GACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAKL,0CAA0C,EAC1C,oDAAoD,GACrD,MAAM,4CAA4C,CAAC;AAyBpD,MAAM,OAAgB,uBAAuB;IAClC,OAAO,CAAS;IAChB,OAAO,CAAS;IAChB,GAAG,CAAS;IAErB,gBAAgB;IACP,gBAAgB,CAAqB;IACrC,yBAAyB,GAChC,EAAE,CAAC;IACI,mCAAmC,GAC1C,EAAE,CAAC;IAEL,UAAU;IACD,UAAU,CAAS;IACnB,mBAAmB,CAAS;IAC5B,kBAAkB,CAAS;IAEpC,YACE,UAA8C,EAC9C,WAAyC,EACzC,OAAe;QAEf,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,uBAAuB,CACpC,UAAU,CAAC,OAAO,EAClB,kEAAkE,CACnE,CAAC;QACF,IAAI,CAAC,GAAG,GAAG,uBAAuB,CAChC,UAAU,CAAC,GAAG,EACd,8DAA8D,CAC/D,CAAC;QAEF,gBAAgB;QAChB,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,aAAa,EAAE,GAAG,CAAC;QACtD,IAAI,CAAC,yBAAyB,GAAG,0CAA0C,CACzE,UAAU,CAAC,aAAa,EAAE,OAAO,IAAI,EAAE,CACxC,CAAC;QACF,IAAI,CAAC,mCAAmC;YACtC,oDAAoD,CAClD,UAAU,CAAC,aAAa,EAAE,iBAAiB,IAAI,EAAE,CAClD,CAAC;QAEJ,UAAU;QACV,IAAI,CAAC,UAAU,GAAG,oBAAoB,CACpC,WAAW,CAAC,OAAO,EACnB,+DAA+D,CAChE,CAAC;QACF,IAAI,CAAC,mBAAmB,GAAG,oBAAoB,CAC7C,WAAW,CAAC,SAAS,EACrB,iEAAiE,CAClE,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,oBAAoB,CAC5C,WAAW,CAAC,SAAS,EACrB,iEAAiE,CAClE,CAAC;IACJ,CAAC;CACF"}

package/lib/stores/LegendApplicationDocumentationService.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { type MarkdownText, type PlainObject, SerializationFactory } from '@finos/legend-shared';
+import type { ApplicationStore } from './ApplicationStore.js';
+import type { LegendApplicationConfig } from './LegendApplicationConfig.js';
+export declare type LegendApplicationDocumentationEntryConfig = {
+    markdownText?: MarkdownText | undefined;
+    title?: string | undefined;
+    text?: string | undefined;
+    url?: string | undefined;
+};
+export declare class LegendApplicationDocumentationEntry {
+    readonly _documentationKey: string;
+    markdownText?: MarkdownText | undefined;
+    title?: string | undefined;
+    text?: string | undefined;
+    url?: string | undefined;
+    static readonly serialization: SerializationFactory<LegendApplicationDocumentationEntry>;
+    static create(json: PlainObject<LegendApplicationDocumentationEntry>, documentationKey: string): LegendApplicationDocumentationEntry;
+}
+export declare type LegendApplicationContextualDocumentationEntryConfig = LegendApplicationDocumentationEntryConfig & {
+    related?: string[];
+};
+export declare class LegendApplicationContextualDocumentationEntry {
+    readonly _context: string;
+    markdownText?: MarkdownText | undefined;
+    title?: string | undefined;
+    text?: string | undefined;
+    url?: string | undefined;
+    related: string[];
+    static readonly serialization: SerializationFactory<LegendApplicationContextualDocumentationEntry>;
+    static create(json: PlainObject<LegendApplicationContextualDocumentationEntry>, context: string): LegendApplicationContextualDocumentationEntry;
+}
+export interface LegendApplicationKeyedContextualDocumentationEntry {
+    key: string;
+    content: LegendApplicationContextualDocumentationEntry;
+}
+export declare const collectKeyedContextualDocumentationEntriesFromConfig: (rawEntries: Record<string, LegendApplicationContextualDocumentationEntryConfig>) => LegendApplicationKeyedContextualDocumentationEntry[];
+export interface LegendApplicationKeyedDocumentationEntry {
+    key: string;
+    content: LegendApplicationDocumentationEntry;
+}
+export declare const collectKeyedDocumnetationEntriesFromConfig: (rawEntries: Record<string, LegendApplicationDocumentationEntryConfig>) => LegendApplicationKeyedDocumentationEntry[];
+export declare class LegendApplicationDocumentationService {
+    url?: string | undefined;
+    private docRegistry;
+    private contextualDocRegistry;
+    constructor(applicationStore: ApplicationStore<LegendApplicationConfig>);
+    getDocEntry(key: string): LegendApplicationDocumentationEntry | undefined;
+    hasDocEntry(key: string): boolean;
+    getContextualDocEntry(key: string): LegendApplicationContextualDocumentationEntry | undefined;
+    hasContextualDocEntry(key: string): boolean;
+    getAllDocEntries(): LegendApplicationDocumentationEntry[];
+    publishDocRegistry(): Record<string, LegendApplicationDocumentationEntryConfig>;
+    publishContextualDocRegistry(): object;
+}
+//# sourceMappingURL=LegendApplicationDocumentationService.d.ts.map

package/lib/stores/LegendApplicationDocumentationService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LegendApplicationDocumentationService.d.ts","sourceRoot":"","sources":["../../src/stores/LegendApplicationDocumentationService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,WAAW,EAEhB,oBAAoB,EAIrB,MAAM,sBAAsB,CAAC;AAS9B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAE5E,oBAAY,yCAAyC,GAAG;IACtD,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B,CAAC;AAEF,qBAAa,mCAAmC;IAC9C,QAAQ,CAAC,iBAAiB,EAAG,MAAM,CAAC;IAEpC,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzB,MAAM,CAAC,QAAQ,CAAC,aAAa,4DAU3B;IAEF,MAAM,CAAC,MAAM,CACX,IAAI,EAAE,WAAW,CAAC,mCAAmC,CAAC,EACtD,gBAAgB,EAAE,MAAM,GACvB,mCAAmC;CAOvC;AAED,oBAAY,mDAAmD,GAC7D,yCAAyC,GAAG;IAC1C,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEJ,qBAAa,6CAA6C;IACxD,QAAQ,CAAC,QAAQ,EAAG,MAAM,CAAC;IAE3B,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,OAAO,EAAE,MAAM,EAAE,CAAM;IAEvB,MAAM,CAAC,QAAQ,CAAC,aAAa,sEAW3B;IAEF,MAAM,CAAC,MAAM,CACX,IAAI,EAAE,WAAW,CAAC,6CAA6C,CAAC,EAChE,OAAO,EAAE,MAAM,GACd,6CAA6C;CAUjD;AAED,MAAM,WAAW,kDAAkD;IACjE,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,6CAA6C,CAAC;CACxD;AAED,eAAO,MAAM,oDAAoD,eACnD,OACV,MAAM,EACN,mDAAmD,CACpD,KACA,kDAAkD,EAOhD,CAAC;AAEN,MAAM,WAAW,wCAAwC;IACvD,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,mCAAmC,CAAC;CAC9C;AAED,eAAO,MAAM,0CAA0C,eACzC,OAAO,MAAM,EAAE,yCAAyC,CAAC,KACpE,wCAAwC,EAItC,CAAC;AAEN,qBAAa,qCAAqC;IAChD,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzB,OAAO,CAAC,WAAW,CAA0D;IAC7E,OAAO,CAAC,qBAAqB,CAGzB;gBAEQ,gBAAgB,EAAE,gBAAgB,CAAC,uBAAuB,CAAC;IAqEvE,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,mCAAmC,GAAG,SAAS;IAIzE,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIjC,qBAAqB,CACnB,GAAG,EAAE,MAAM,GACV,6CAA6C,GAAG,SAAS;IAI5D,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAI3C,gBAAgB,IAAI,mCAAmC,EAAE;IAIzD,kBAAkB,IAAI,MAAM,CAC1B,MAAM,EACN,yCAAyC,CAC1C;IAUD,4BAA4B,IAAI,MAAM;CAavC"}