@microsoft/teamsfx-core 2.0.4-alpha.dc097d3df.0 → 2.0.4-alpha.e432bab97.0

package/build/ui/validationUtils.js

@@ -0,0 +1,95 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validationUtils = void 0;
+const teamsfx_api_1 = require("@microsoft/teamsfx-api");
+const common_1 = require("../error/common");
+class ValidationUtils {
+    async validateInputForSingleSelectQuestion(question, value, inputs) {
+        let options = question.staticOptions;
+        if (question.dynamicOptions) {
+            options = await question.dynamicOptions(inputs);
+        }
+        return this.isAllowedValue(question.name, value, options, question.returnObject);
+    }
+    async validateInputForMultipleSelectQuestion(question, value, inputs) {
+        let options = question.staticOptions;
+        if (question.dynamicOptions) {
+            options = await question.dynamicOptions(inputs);
+        }
+        for (const item of value) {
+            const error = this.isAllowedValue(question.name, item, options, question.returnObject);
+            if (error)
+                return error;
+        }
+        return undefined;
+    }
+    formatInvalidInputError(key, value, options) {
+        return `Invalid input '${key}':${JSON.stringify(value)}, allowed value: ${JSON.stringify(options)}`;
+    }
+    formatInvalidOptionsError(options) {
+        return `Invalid question, expect input object, but allowed value: ${JSON.stringify(options)}`;
+    }
+    isAllowedValue(key, value, options, returnObject) {
+        if (options.length === 0) {
+            return new common_1.EmptyOptionError(key, "validationUtils").message;
+        }
+        const optionIsStringArray = typeof options[0] === "string";
+        if (returnObject) {
+            if (optionIsStringArray) {
+                return this.formatInvalidOptionsError(options);
+            }
+            if (!value || typeof value === "string") {
+                return this.formatInvalidInputError(key, value, options);
+            }
+            if (!options.find((item) => item.id === value.id)) {
+                return this.formatInvalidInputError(key, value, options);
+            }
+        }
+        else {
+            if (!value || typeof value !== "string") {
+                return this.formatInvalidInputError(key, value, options);
+            }
+            // value is string here
+            const foundOption = optionIsStringArray
+                ? options.find((item) => item === value)
+                : options.find((item) => item.id === value);
+            if (!foundOption) {
+                return this.formatInvalidInputError(key, value, options);
+            }
+        }
+    }
+    /**
+     * validate value against question model definition
+     */
+    async validateInputs(question, value, inputs) {
+        if (question.type === "singleSelect") {
+            if (question.skipValidation)
+                return undefined;
+            return await this.validateInputForSingleSelectQuestion(question, value, inputs);
+        }
+        else if (question.type === "multiSelect") {
+            if (question.skipValidation)
+                return undefined;
+            return await this.validateInputForMultipleSelectQuestion(question, value, inputs);
+        }
+        else {
+            if (question.validation) {
+                const vFunc = teamsfx_api_1.getValidationFunction(question.validation, inputs);
+                const res = await vFunc(value);
+                if (res)
+                    return res;
+            }
+            if (question.type === "text" && question.additionalValidationOnAccept) {
+                const vFunc = teamsfx_api_1.getValidationFunction(question.additionalValidationOnAccept, inputs);
+                const res = await vFunc(value);
+                if (res)
+                    return res;
+            }
+            return undefined;
+        }
+    }
+}
+exports.validationUtils = new ValidationUtils();
+//# sourceMappingURL=validationUtils.js.map

package/build/ui/validationUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validationUtils.js","sourceRoot":"","sources":["../../src/ui/validationUtils.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,wDASgC;AAChC,4CAAmD;AAEnD,MAAM,eAAe;IACnB,KAAK,CAAC,oCAAoC,CACxC,QAA8B,EAC9B,KAA0B,EAC1B,MAAc;QAEd,IAAI,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC;QACrC,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,OAAO,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;SACjD;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;IACnF,CAAC;IAED,KAAK,CAAC,sCAAsC,CAC1C,QAA6B,EAC7B,KAA8B,EAC9B,MAAc;QAEd,IAAI,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC;QACrC,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,OAAO,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;SACjD;QACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;YACvF,IAAI,KAAK;gBAAE,OAAO,KAAK,CAAC;SACzB;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,uBAAuB,CAAC,GAAW,EAAE,KAA0B,EAAE,OAAsB;QACrF,OAAO,kBAAkB,GAAG,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,oBAAoB,IAAI,CAAC,SAAS,CACtF,OAAO,CACR,EAAE,CAAC;IACN,CAAC;IACD,yBAAyB,CAAC,OAAsB;QAC9C,OAAO,6DAA6D,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;IAChG,CAAC;IACD,cAAc,CACZ,GAAW,EACX,KAA0B,EAC1B,OAAsB,EACtB,YAAsB;QAEtB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YACxB,OAAO,IAAI,yBAAgB,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC,OAAO,CAAC;SAC7D;QACD,MAAM,mBAAmB,GAAG,OAAO,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;QAC3D,IAAI,YAAY,EAAE;YAChB,IAAI,mBAAmB,EAAE;gBACvB,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;aAChD;YACD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBACvC,OAAO,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;aAC1D;YACD,IAAI,CAAE,OAAwB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,CAAC,EAAE;gBACnE,OAAO,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;aAC1D;SACF;aAAM;YACL,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBACvC,OAAO,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;aAC1D;YACD,uBAAuB;YACvB,MAAM,WAAW,GAAG,mBAAmB;gBACrC,CAAC,CAAE,OAAoB,CAAC,IAAI,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC;gBAC9D,CAAC,CAAE,OAAwB,CAAC,IAAI,CAAC,CAAC,IAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC;YAC5E,IAAI,CAAC,WAAW,EAAE;gBAChB,OAAO,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;aAC1D;SACF;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAClB,QAAkB,EAClB,KAAoD,EACpD,MAAc;QAEd,IAAI,QAAQ,CAAC,IAAI,KAAK,cAAc,EAAE;YACpC,IAAI,QAAQ,CAAC,cAAc;gBAAE,OAAO,SAAS,CAAC;YAC9C,OAAO,MAAM,IAAI,CAAC,oCAAoC,CACpD,QAAQ,EACR,KAA4B,EAC5B,MAAM,CACP,CAAC;SACH;aAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,aAAa,EAAE;YAC1C,IAAI,QAAQ,CAAC,cAAc;gBAAE,OAAO,SAAS,CAAC;YAC9C,OAAO,MAAM,IAAI,CAAC,sCAAsC,CACtD,QAAQ,EACR,KAAgC,EAChC,MAAM,CACP,CAAC;SACH;aAAM;YACL,IAAI,QAAQ,CAAC,UAAU,EAAE;gBACvB,MAAM,KAAK,GAAG,mCAAqB,CAAoB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;gBACpF,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,KAA0B,CAAC,CAAC;gBACpD,IAAI,GAAG;oBAAE,OAAO,GAAG,CAAC;aACrB;YACD,IAAI,QAAQ,CAAC,IAAI,KAAK,MAAM,IAAI,QAAQ,CAAC,4BAA4B,EAAE;gBACrE,MAAM,KAAK,GAAG,mCAAqB,CACjC,QAAQ,CAAC,4BAA4B,EACrC,MAAM,CACP,CAAC;gBACF,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,KAA0B,CAAC,CAAC;gBACpD,IAAI,GAAG;oBAAE,OAAO,GAAG,CAAC;aACrB;YACD,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;CACF;AAEY,QAAA,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC"}

package/build/ui/visitor.d.ts

@@ -1,6 +1,18 @@
-import { Question, SingleSelectQuestion, StaticOptions, MultiSelectQuestion, Inputs, FxError, UserInteraction, Result, InputResult, TelemetryReporter, Void, IQTreeNode } from "@microsoft/teamsfx-api";
+import { FxError, IQTreeNode, InputResult, Inputs, MultiSelectQuestion, Question, Result, SingleSelectQuestion, StaticOptions, TelemetryReporter, UserInteraction, Void } from "@microsoft/teamsfx-api";
 export declare function isAutoSkipSelect(q: Question): boolean;
 export declare function getSingleOption(q: SingleSelectQuestion | MultiSelectQuestion, option?: StaticOptions): any;
+export declare function loadOptions(question: SingleSelectQuestion | MultiSelectQuestion, inputs: Inputs): Promise<StaticOptions>;
 export declare type QuestionTreeVisitor = (question: Question, ui: UserInteraction, inputs: Inputs, step?: number, totalSteps?: number) => Promise<Result<InputResult<any>, FxError>>;
+/**
+ * ask question when visiting the question tree
+ * @param question
+ * @param core
+ * @param inputs
+ */
+export declare const questionVisitor: QuestionTreeVisitor;
+/**
+ * serialize the tree node into array in DFS order
+ */
+export declare function collect(node: IQTreeNode, list: IQTreeNode[], parentMap: Map<IQTreeNode, IQTreeNode>): void;
 export declare function traverse(root: IQTreeNode, inputs: Inputs, ui: UserInteraction, telemetryReporter?: TelemetryReporter, visitor?: QuestionTreeVisitor): Promise<Result<Void, FxError>>;
 //# sourceMappingURL=visitor.d.ts.map

package/build/ui/visitor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"visitor.d.ts","sourceRoot":"","sources":["../../src/ui/visitor.ts"],"names":[],"mappings":"AAGA,OAAO,EAGL,QAAQ,EACR,oBAAoB,EACpB,aAAa,EACb,mBAAmB,EACnB,MAAM,EACN,OAAO,EAIP,eAAe,EACf,MAAM,EACN,WAAW,EAGX,iBAAiB,EACjB,IAAI,EAIJ,UAAU,EACX,MAAM,wBAAwB,CAAC;AAGhC,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,QAAQ,GAAG,OAAO,CAQrD;AAED,wBAAgB,eAAe,CAC7B,CAAC,EAAE,oBAAoB,GAAG,mBAAmB,EAC7C,MAAM,CAAC,EAAE,aAAa,GACrB,GAAG,CAWL;AASD,oBAAY,mBAAmB,GAAG,CAChC,QAAQ,EAAE,QAAQ,EAClB,EAAE,EAAE,eAAe,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,KAChB,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AAiMhD,wBAAsB,QAAQ,CAC5B,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,eAAe,EACnB,iBAAiB,CAAC,EAAE,iBAAiB,EACrC,OAAO,GAAE,mBAAqC,GAC7C,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAoGhC"}
+{"version":3,"file":"visitor.d.ts","sourceRoot":"","sources":["../../src/ui/visitor.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,OAAO,EACP,UAAU,EACV,WAAW,EACX,MAAM,EACN,mBAAmB,EAGnB,QAAQ,EACR,MAAM,EACN,oBAAoB,EACpB,aAAa,EAGb,iBAAiB,EAEjB,eAAe,EACf,IAAI,EAKL,MAAM,wBAAwB,CAAC;AAYhC,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,QAAQ,GAAG,OAAO,CAQrD;AAED,wBAAgB,eAAe,CAC7B,CAAC,EAAE,oBAAoB,GAAG,mBAAmB,EAC7C,MAAM,CAAC,EAAE,aAAa,GACrB,GAAG,CAWL;AASD,wBAAsB,WAAW,CAC/B,QAAQ,EAAE,oBAAoB,GAAG,mBAAmB,EACpD,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,aAAa,CAAC,CAMxB;AAED,oBAAY,mBAAmB,GAAG,CAChC,QAAQ,EAAE,QAAQ,EAClB,EAAE,EAAE,eAAe,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,KAChB,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AAEhD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,EAAE,mBAwO7B,CAAC;AAEF;;GAEG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE,UAAU,EAAE,EAClB,SAAS,EAAE,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,GACrC,IAAI,CAUN;AAED,wBAAsB,QAAQ,CAC5B,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,eAAe,EACnB,iBAAiB,CAAC,EAAE,iBAAiB,EACrC,OAAO,GAAE,mBAAqC,GAC7C,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAmGhC"}