@microsoft/teamsfx-api
Advanced tools
Comparing version 0.3.1-alpha.8e89c3a5.0 to 0.3.1-alpha.bdddbbf8.0
@@ -22,2 +22,5 @@ import { Result } from "neverthrow"; | ||
getQuestionsForUserTask?: (router: FunctionRouter, inputs: Inputs) => Promise<Result<QTreeNode | undefined, FxError>>; | ||
/** | ||
* Used for encryption of secrets in user data file | ||
*/ | ||
encrypt: (plaintext: string, inputs: Inputs) => Promise<Result<string, FxError>>; | ||
@@ -24,0 +27,0 @@ decrypt: (ciphertext: string, inputs: Inputs) => Promise<Result<string, FxError>>; |
@@ -1,3 +0,1 @@ | ||
import { Result } from "neverthrow"; | ||
import { FxError } from "../error"; | ||
/** | ||
@@ -8,27 +6,3 @@ * @deprecated | ||
/** | ||
* Platforms (such as VSCode, CLI) support this function to communicate with core. | ||
* There are 3 dialog types. | ||
* 1. Ask: core can ask platform for questions and platform will render UI for users to collect data. | ||
* The return type is Answer. | ||
* 2. Show: core can let platform show some messages to users. | ||
* | ||
* Example 1 (ask for appType): | ||
* await communicate(new DialogMsg( | ||
* DialogType.Ask, | ||
* { | ||
* type: QuestionType.Radio, | ||
* description: "Which type of Teams App do you want to develop?", | ||
* defaultAnswer: "tab", | ||
* options: ["tab", "bot", "message"], | ||
* } | ||
* )) | ||
* | ||
* Example 2 (show something): | ||
* await communicate(new DialogMsg( | ||
* DialogType.Show, | ||
* { | ||
* description: "Scaffold successfully!", | ||
* level: MsgLevel.Info, | ||
* } | ||
* )) | ||
* @deprecated | ||
*/ | ||
@@ -48,14 +22,3 @@ communicate: (msg: DialogMsg) => Promise<DialogMsg>; | ||
*/ | ||
export interface IMessage { | ||
description: string; | ||
level: MsgLevel; | ||
items?: string[]; | ||
modal?: boolean; | ||
} | ||
/** | ||
* @deprecated | ||
*/ | ||
export declare enum QuestionType { | ||
OpenFolder = "OpenFolder", | ||
ExecuteCmd = "ExecuteCmd", | ||
UpdateGlobalState = "UpdateGlobalState" | ||
@@ -69,9 +32,2 @@ } | ||
description: string; | ||
defaultAnswer?: string; | ||
options?: string[]; | ||
terminalName?: string; | ||
validateInput?: (value: string) => string | undefined | null | Promise<string | undefined | null>; | ||
multiSelect?: boolean; | ||
password?: boolean; | ||
prompt?: string; | ||
} | ||
@@ -86,13 +42,4 @@ /** | ||
/** | ||
* Iprogress status | ||
* @deprecated | ||
*/ | ||
export interface IProgress { | ||
title?: string; | ||
cancellable?: boolean; | ||
progressIter: AsyncGenerator<IProgressStatus, Result<null, FxError>>; | ||
} | ||
/** | ||
* @deprecated | ||
*/ | ||
export declare type Answer = string | undefined; | ||
@@ -103,7 +50,4 @@ /** | ||
export declare enum DialogType { | ||
Show = "Show", | ||
ShowProgress = "ShowProgress", | ||
Ask = "Ask", | ||
Answer = "Answer", | ||
Output = "Output" | ||
Answer = "Answer" | ||
} | ||
@@ -115,6 +59,5 @@ /** | ||
dialogType: DialogType; | ||
content: IMessage | IQuestion | IProgress | Answer; | ||
constructor(dialogType: DialogType, content: IMessage | IQuestion | IProgress | Answer); | ||
getAnswer(): Answer | undefined; | ||
content: IQuestion | Answer; | ||
constructor(dialogType: DialogType, content: IQuestion | Answer); | ||
} | ||
//# sourceMappingURL=dialog.d.ts.map |
@@ -20,4 +20,2 @@ // Copyright (c) Microsoft Corporation. | ||
(function (QuestionType) { | ||
QuestionType["OpenFolder"] = "OpenFolder"; | ||
QuestionType["ExecuteCmd"] = "ExecuteCmd"; | ||
QuestionType["UpdateGlobalState"] = "UpdateGlobalState"; | ||
@@ -30,7 +28,4 @@ })(QuestionType = exports.QuestionType || (exports.QuestionType = {})); | ||
(function (DialogType) { | ||
DialogType["Show"] = "Show"; | ||
DialogType["ShowProgress"] = "ShowProgress"; | ||
DialogType["Ask"] = "Ask"; | ||
DialogType["Answer"] = "Answer"; | ||
DialogType["Output"] = "Output"; | ||
})(DialogType = exports.DialogType || (exports.DialogType = {})); | ||
@@ -46,10 +41,4 @@ /** | ||
} | ||
getAnswer() { | ||
if (this.dialogType === DialogType.Answer && this.content !== undefined) { | ||
return this.content; | ||
} | ||
return undefined; | ||
} | ||
} | ||
exports.DialogMsg = DialogMsg; | ||
//# sourceMappingURL=dialog.js.map |
@@ -18,5 +18,5 @@ import { UserInteraction } from "../qm/ui"; | ||
treeProvider?: TreeProvider; | ||
dialog: Dialog; | ||
dialog?: Dialog; | ||
ui: UserInteraction; | ||
} | ||
//# sourceMappingURL=index.d.ts.map |
{ | ||
"name": "@microsoft/teamsfx-api", | ||
"version": "0.3.1-alpha.8e89c3a5.0", | ||
"version": "0.3.1-alpha.bdddbbf8.0", | ||
"description": "teamsfx framework api", | ||
@@ -63,3 +63,3 @@ "main": "build/index.js", | ||
}, | ||
"gitHead": "431ee81afc505f6b145ff6a91c5b196a1a6a9aa4", | ||
"gitHead": "da175f45d1236b36b38a8f64f53c65127724f6ea", | ||
"publishConfig": { | ||
@@ -66,0 +66,0 @@ "access": "public" |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
180674
3002