@microsoft/teamsfx-api 0.8.1-alpha.ea92b816.0 → 0.8.1-alpha.f82bd314.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/types.d.ts
CHANGED
package/build/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAEzD,oBAAY,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEvC,oBAAY,WAAW,GAAG,GAAG,CAAC;AAE9B,oBAAY,cAAc,GAAG,MAAM,CAAC;AAEpC,oBAAY,YAAY,GAAG,SAAS,CAAC;AACrC,oBAAY,oBAAoB,GAAG,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAEpE,oBAAY,cAAc,GAAG,GAAG,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;AAC/D,oBAAY,sBAAsB,GAAG,WAAW,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;AAEvF,qBAAa,SAAU,SAAQ,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC;IACrD,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAK/D,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAKlE,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAK/D,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS;IAKxE,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS;IAKxE,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,SAAS;IAK3E,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS;IAS3E,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,GAAG,SAAS;IAMpF,MAAM,IAAI,IAAI;WAYA,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,GAAG,SAAS,GAAG,SAAS;gBAY7C,OAAO,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,EAAE,GAAG,IAAI;CAIzE;AAED,wBAAgB,cAAc,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAQtF;AAGD,oBAAY,IAAI,GAAG,EAAE,CAAC;AACtB,eAAO,MAAM,IAAI,IAAK,CAAC;AAEvB,oBAAY,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAE3D,oBAAY,iBAAiB,GAAG;IAC9B,CAAC,CAAC,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC;CAC3C,CAAC;AAEF,oBAAY,cAAc,GAAG,gBAAgB,CAAC;AAE9C,oBAAY,eAAe,GAAG,iBAAiB,CAAC;AAEhD,oBAAY,sBAAsB,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;AAE9D,oBAAY,uBAAuB,GAAG,QAAQ,CAAC;IAC7C,CAAC,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS,CAAC;CACjD,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,IAAI;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,SAAS,CAAC;IACpB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,GAAG,CAAC,EAAE,SAAS,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACtC,SAAS,EAAE;QACT,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;KAC1C,CAAC;CACH;AACD,MAAM,WAAW,MAAO,SAAQ,IAAI;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAEzD,oBAAY,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEvC,oBAAY,WAAW,GAAG,GAAG,CAAC;AAE9B,oBAAY,cAAc,GAAG,MAAM,CAAC;AAEpC,oBAAY,YAAY,GAAG,SAAS,CAAC;AACrC,oBAAY,oBAAoB,GAAG,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAEpE,oBAAY,cAAc,GAAG,GAAG,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;AAC/D,oBAAY,sBAAsB,GAAG,WAAW,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;AAEvF,qBAAa,SAAU,SAAQ,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC;IACrD,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAK/D,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAKlE,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAK/D,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS;IAKxE,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS;IAKxE,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,SAAS;IAK3E,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS;IAS3E,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,GAAG,SAAS;IAMpF,MAAM,IAAI,IAAI;WAYA,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,GAAG,SAAS,GAAG,SAAS;gBAY7C,OAAO,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,EAAE,GAAG,IAAI;CAIzE;AAED,wBAAgB,cAAc,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAQtF;AAGD,oBAAY,IAAI,GAAG,EAAE,CAAC;AACtB,eAAO,MAAM,IAAI,IAAK,CAAC;AAEvB,oBAAY,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAE3D,oBAAY,iBAAiB,GAAG;IAC9B,CAAC,CAAC,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC;CAC3C,CAAC;AAEF,oBAAY,cAAc,GAAG,gBAAgB,CAAC;AAE9C,oBAAY,eAAe,GAAG,iBAAiB,CAAC;AAEhD,oBAAY,sBAAsB,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;AAE9D,oBAAY,uBAAuB,GAAG,QAAQ,CAAC;IAC7C,CAAC,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS,CAAC;CACjD,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,IAAI;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,SAAS,CAAC;IACpB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,GAAG,CAAC,EAAE,SAAS,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACtC,SAAS,EAAE;QACT,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;KAC1C,CAAC;CACH;AACD,MAAM,WAAW,MAAO,SAAQ,IAAI;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAC/B,aAAa,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CACtC"}
|
|
@@ -22,8 +22,8 @@ export declare type ResourceProvisionOutput = {
|
|
|
22
22
|
* lifecycles by implementing the corresponding API.
|
|
23
23
|
* Implementation of all lifecycles is expected to be idempotent. The return values
|
|
24
24
|
* and observable side effects of each lifecycle are expected to be the same with the same input.
|
|
25
|
-
* All lifecycles follow the same pattern of returning a Promise<Result<T, FxError>>.
|
|
26
25
|
*
|
|
26
|
+
* All lifecycles follow the same pattern of returning a Promise<Result<T, FxError>>.
|
|
27
27
|
* Please return {@link UserError} or {@link SystemError} when error happens
|
|
28
28
|
* instead of throwing.
|
|
29
29
|
*/
|
|
@@ -31,13 +31,17 @@ export interface ResourcePlugin {
|
|
|
31
31
|
name: string;
|
|
32
32
|
displayName: string;
|
|
33
33
|
/**
|
|
34
|
-
* resource plugin decide whether it
|
|
34
|
+
* A resource plugin can decide whether it needs to be activated when the Toolkit initializes
|
|
35
|
+
* based on solution settings.
|
|
36
|
+
*
|
|
35
37
|
* @param solutionSettings solution settings
|
|
38
|
+
*
|
|
39
|
+
* @returns whether to be activated
|
|
36
40
|
*/
|
|
37
41
|
activate(solutionSettings: AzureSolutionSettings): boolean;
|
|
38
42
|
/**
|
|
39
43
|
* Called by Toolkit when creating a new project or adding a new resource.
|
|
40
|
-
*
|
|
44
|
+
* A resource plugin is expected to scaffold source code or files on disk, relative to context.projectPath.
|
|
41
45
|
*
|
|
42
46
|
* @example
|
|
43
47
|
* ```
|
|
@@ -47,22 +51,20 @@ export interface ResourcePlugin {
|
|
|
47
51
|
* let path = path.join(ctx.projectPath, "myFolder");
|
|
48
52
|
* let sourcePath = "somePathhere";
|
|
49
53
|
* let result = await fs.copy(sourcePath, content);
|
|
50
|
-
*
|
|
51
|
-
* return { "output": {} };
|
|
54
|
+
* return ok(Void);
|
|
52
55
|
* }
|
|
53
56
|
* ```
|
|
54
57
|
*
|
|
55
58
|
* @param {Context} ctx - plugin's runtime context shared by all lifecycles.
|
|
56
59
|
* @param {Inputs} inputs - User answers to questions defined in {@link getQuestionsForScaffolding} along with some system inputs.
|
|
57
60
|
*
|
|
58
|
-
* @returns
|
|
59
|
-
* For example, Azure Function plugin outputs "defaultFunctionName" in this lifecycle.
|
|
60
|
-
* For most plugins, empty output is good enough.
|
|
61
|
+
* @returns Void because side effect is expected.
|
|
61
62
|
*/
|
|
62
63
|
scaffoldSourceCode?: (ctx: Context, inputs: Inputs) => Promise<Result<Void, FxError>>;
|
|
63
64
|
/**
|
|
64
|
-
*
|
|
65
|
-
*
|
|
65
|
+
* This method is called when creating a new project or adding a new resource.
|
|
66
|
+
* A resource plugin is expected to return a resource template(e.g. Bicep templates/plain JSON) which will be persisted
|
|
67
|
+
* by the Toolkit and will be used to provision resource when Provision command is called.
|
|
66
68
|
*
|
|
67
69
|
* @param {Context} ctx - plugin's runtime context shared by all lifecycles.
|
|
68
70
|
* @param {Inputs} inputs - User's answers to questions defined in {@link getQuestionsForScaffolding} along with some system inputs.
|
|
@@ -71,40 +73,46 @@ export interface ResourcePlugin {
|
|
|
71
73
|
*/
|
|
72
74
|
generateResourceTemplate?: (ctx: Context, inputs: Inputs) => Promise<Result<ResourceTemplate, FxError>>;
|
|
73
75
|
/**
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
+
* provisionResource() runs before ARM/Bicep provision when Provision command is called.
|
|
77
|
+
* There are two reasons why a resource needs to implement this method:
|
|
78
|
+
* 1) to generate input for ARM/Bicep provision to consume.
|
|
79
|
+
* 2) the resource can't be provisioned using resource templates like ARM/Bicep.
|
|
80
|
+
* Two typical resources that need to implement this method are AAD(Azure Active Directory)
|
|
81
|
+
* and AppSudio, which statisfy both above criteria.
|
|
76
82
|
*
|
|
77
|
-
*
|
|
83
|
+
* A plugin can get access tokens to cloud service using TokenProvider.
|
|
78
84
|
*
|
|
79
85
|
* @param {Context} ctx - plugin's runtime context shared by all lifecycles.
|
|
80
86
|
* @param {ProvisionInputs} inputs - inputs injected by Toolkit runtime and solution.
|
|
81
|
-
* @param {DeepReadonly<EnvInfoV2>} envInfo -
|
|
87
|
+
* @param {DeepReadonly<EnvInfoV2>} envInfo - a readonly view of environment info modeled after (config|profile).${env}.json
|
|
82
88
|
* @param {TokenProvider} tokenProvider - Tokens for Azure and AppStudio
|
|
83
89
|
*
|
|
84
|
-
* @returns {ResourceProvisionOutput} resource provision output
|
|
90
|
+
* @returns {ResourceProvisionOutput} resource provision output which will be persisted by the toolkit into envInfo's profile.
|
|
85
91
|
*/
|
|
86
92
|
provisionResource?: (ctx: Context, inputs: ProvisionInputs, envInfo: DeepReadonly<EnvInfoV2>, tokenProvider: TokenProvider) => Promise<Result<ResourceProvisionOutput, FxError>>;
|
|
87
93
|
/**
|
|
88
|
-
* configureResource is
|
|
89
|
-
* Plugins are expected to read the provision output
|
|
90
|
-
* possibly with added fields.
|
|
94
|
+
* configureResource() is guaranteed to run after Bicep/ARM provision.
|
|
95
|
+
* Plugins are expected to read the provision output of other plugins via envInfo's profile,
|
|
96
|
+
* and return a new copy of its own provision output possibly with added and modified fields.
|
|
97
|
+
*
|
|
98
|
+
* Plugins can also sync their settings to the clould using access tokens provided by TokenProvider
|
|
91
99
|
*
|
|
92
100
|
* @param {Context} ctx - plugin's runtime context shared by all lifecycles.
|
|
93
101
|
* @param {ProvisionInputs} inputs - inputs injected by Toolkit runtime and solution.
|
|
94
|
-
* @param {
|
|
95
|
-
* @param {Readonly<SolutionProvisionOutput>} provisionOutputs - the profile (persist by core as `profile.${env}.json`) containing provision outputs
|
|
102
|
+
* @param {DeepReadonly<EnvInfoV2>} envInfo - a readonly view of environment info modeled after (config|profile).${env}.json
|
|
96
103
|
* @param {TokenProvider} tokenProvider - Tokens for Azure and AppStudio
|
|
97
104
|
*
|
|
98
|
-
* @returns {ResourceProvisionOutput} resource provision output
|
|
105
|
+
* @returns {ResourceProvisionOutput} resource provision output which will be persisted by the toolkit into envInfo's profile.
|
|
99
106
|
*/
|
|
100
|
-
configureResource?: (ctx: Context, inputs: ProvisionInputs, envInfo:
|
|
107
|
+
configureResource?: (ctx: Context, inputs: ProvisionInputs, envInfo: DeepReadonly<EnvInfoV2>, tokenProvider: TokenProvider) => Promise<Result<ResourceProvisionOutput, FxError>>;
|
|
101
108
|
/**
|
|
102
|
-
* Depends on the values returned by {@link provisionResource}
|
|
103
|
-
*
|
|
109
|
+
* Depends on the provision output values returned by {@link provisionResource}, ARM/Bicep provision
|
|
110
|
+
* and {@link configureResource}.
|
|
111
|
+
* Plugins are expected to deploy code to cloud using access tokens provided by {@link AzureAccountProvider}.
|
|
104
112
|
*
|
|
105
113
|
* @param {Context} ctx - plugin's runtime context shared by all lifecycles.
|
|
106
114
|
* @param {DeploymentInputs} inputs - inputs injected by Toolkit runtime and solution.
|
|
107
|
-
* @param {Json} provisionOutputs - profile containing provision outputs
|
|
115
|
+
* @param {Json} provisionOutputs - profile containing provision outputs modeled after profile.${env}.json
|
|
108
116
|
* @param {AzureAccountProvider} tokenProvider - Tokens for Azure and AppStudio
|
|
109
117
|
*/
|
|
110
118
|
deploy?: (ctx: Context, inputs: DeploymentInputs, provisionOutputs: Json, tokenProvider: AzureAccountProvider) => Promise<Result<Void, FxError>>;
|
|
@@ -112,8 +120,7 @@ export interface ResourcePlugin {
|
|
|
112
120
|
* Depends on the output of {@link package}. Uploads Teams package to AppStudio
|
|
113
121
|
* @param {Context} ctx - plugin's runtime context shared by all lifecycles.
|
|
114
122
|
* @param {Inputs} inputs - system inputs.
|
|
115
|
-
* @param {
|
|
116
|
-
* @param {Json} provisionOutputs - contains the provision output values for manifest placeholders
|
|
123
|
+
* @param {DeepReadonly<EnvInfoV2>} envInfo - a readonly view of environment info modeled after (config|profile).${env}.json
|
|
117
124
|
* @param {AppStudioTokenProvider} tokenProvider - Token for AppStudio
|
|
118
125
|
*
|
|
119
126
|
* @returns Void because side effect is expected.
|
|
@@ -128,19 +135,31 @@ export interface ResourcePlugin {
|
|
|
128
135
|
* @param {Json} localSettings - local debug settings generated by {@link provisionLocalResource}
|
|
129
136
|
* @param {TokenProvider} tokenProvider - Tokens for Azure and AppStudio
|
|
130
137
|
*
|
|
138
|
+
* @returns Void because side effect is expected.
|
|
131
139
|
*/
|
|
132
140
|
provisionLocalResource?: (ctx: Context, inputs: Inputs, localSettings: Json, tokenProvider: TokenProvider) => Promise<Result<Void, FxError>>;
|
|
133
141
|
/**
|
|
134
142
|
* configureLocalResource works like {@link configureResource} but only for local debugging resources.
|
|
135
|
-
* Plugins are expected to read the local provision output values of other plugins, and
|
|
136
|
-
* possibly with added fields.
|
|
143
|
+
* Plugins are expected to read the local provision output values of other plugins, and modify in-place
|
|
137
144
|
*
|
|
138
145
|
* @param {Context} ctx - plugin's runtime context shared by all lifecycles.
|
|
139
146
|
* @param {Json} localSettings - local debug settings generated by {@link scaffoldSourceCode}
|
|
140
147
|
* @param {TokenProvider} tokenProvider - Tokens for Azure and AppStudio
|
|
141
148
|
*
|
|
149
|
+
* @returns Void because side effect is expected.
|
|
142
150
|
*/
|
|
143
151
|
configureLocalResource?: (ctx: Context, inputs: Inputs, localSettings: Json, tokenProvider: TokenProvider) => Promise<Result<Void, FxError>>;
|
|
152
|
+
/**
|
|
153
|
+
* Plugins that need to collect user input are expected to implement this method.
|
|
154
|
+
* Questions are organized as a tree. Please see {@link QTreeNode}.
|
|
155
|
+
*
|
|
156
|
+
* getQuestionsForScaffolding() is guaranteed to be called before scaffoldSourceCode().
|
|
157
|
+
*
|
|
158
|
+
* @param {Context} ctx - plugin's runtime context shared by all lifecycles.
|
|
159
|
+
* @param {Inputs} inputs - system inputs.
|
|
160
|
+
*
|
|
161
|
+
* @returns question tree.
|
|
162
|
+
*/
|
|
144
163
|
getQuestionsForScaffolding?: (ctx: Context, inputs: Inputs) => Promise<Result<QTreeNode | undefined, FxError>>;
|
|
145
164
|
executeUserTask?: (ctx: Context, inputs: Inputs, func: Func, envInfo: EnvInfoV2, tokenProvider: TokenProvider) => Promise<Result<unknown, FxError>>;
|
|
146
165
|
getQuestions?: (ctx: Context, inputs: Inputs, envInfo: DeepReadonly<EnvInfoV2>, tokenProvider: TokenProvider) => Promise<Result<QTreeNode | undefined, FxError>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resourcePlugin.d.ts","sourceRoot":"","sources":["../../src/v2/resourcePlugin.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,GAAG,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAChG,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AACxE,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAY,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1F,oBAAY,gBAAgB,GAAG,aAAa,GAAG,YAAY,CAAC;AAE5D,oBAAY,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF,oBAAY,aAAa,GAAG;IAC1B,IAAI,EAAE,OAAO,CAAC;IAEd,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF,oBAAY,uBAAuB,GAAG;IACpC,MAAM,EAAE,IAAI,CAAC;IAEb,OAAO,EAAE,IAAI,CAAC;CACf,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,WAAW,cAAc;IAE7B,IAAI,EAAE,MAAM,CAAC;IAGb,WAAW,EAAE,MAAM,CAAC;IAEpB
|
|
1
|
+
{"version":3,"file":"resourcePlugin.d.ts","sourceRoot":"","sources":["../../src/v2/resourcePlugin.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,GAAG,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAChG,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AACxE,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAY,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1F,oBAAY,gBAAgB,GAAG,aAAa,GAAG,YAAY,CAAC;AAE5D,oBAAY,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF,oBAAY,aAAa,GAAG;IAC1B,IAAI,EAAE,OAAO,CAAC;IAEd,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF,oBAAY,uBAAuB,GAAG;IACpC,MAAM,EAAE,IAAI,CAAC;IAEb,OAAO,EAAE,IAAI,CAAC;CACf,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,WAAW,cAAc;IAE7B,IAAI,EAAE,MAAM,CAAC;IAGb,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;OAOG;IACH,QAAQ,CAAC,gBAAgB,EAAE,qBAAqB,GAAG,OAAO,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,kBAAkB,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAEtF;;;;;;;;;OASG;IACH,wBAAwB,CAAC,EAAE,CACzB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,KACX,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC;IAEhD;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,EAAE,CAClB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAChC,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC,CAAC;IAEvD;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,EAAE,CAClB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAChC,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC,CAAC;IAEvD;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,CACP,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,gBAAgB,EACxB,gBAAgB,EAAE,IAAI,EACtB,aAAa,EAAE,oBAAoB,KAChC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAEpC;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,CACnB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAChC,aAAa,EAAE,sBAAsB,KAClC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAEpC;;;;;;;;;;OAUG;IACH,sBAAsB,CAAC,EAAE,CACvB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,IAAI,EACnB,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAEpC;;;;;;;;;OASG;IACH,sBAAsB,CAAC,EAAE,CACvB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,IAAI,EACnB,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAEpC;;;;;;;;;;OAUG;IACH,0BAA0B,CAAC,EAAE,CAC3B,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,KACX,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;IAErD,eAAe,CAAC,EAAE,CAChB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,SAAS,EAClB,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAGvC,YAAY,CAAC,EAAE,CACb,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAChC,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;IAErD,uBAAuB,CAAC,EAAE,CACxB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAChC,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;CACtD"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@microsoft/teamsfx-api",
|
|
3
|
-
"version": "0.8.1-alpha.
|
|
3
|
+
"version": "0.8.1-alpha.f82bd314.0",
|
|
4
4
|
"description": "teamsfx framework api",
|
|
5
5
|
"main": "build/index.js",
|
|
6
6
|
"types": "build/index.d.ts",
|
|
@@ -64,7 +64,7 @@
|
|
|
64
64
|
"jsonschema": "^1.4.0",
|
|
65
65
|
"neverthrow": "^3.2.0"
|
|
66
66
|
},
|
|
67
|
-
"gitHead": "
|
|
67
|
+
"gitHead": "952f466470c0f725280bed5d08226b658a6bc0b6",
|
|
68
68
|
"publishConfig": {
|
|
69
69
|
"access": "public"
|
|
70
70
|
},
|