@microsoft/teamsfx-api 0.22.3 → 0.22.4-alpha.22a5754c6.0

package/build/v2/solutionPlugin.d.ts

@@ -1,100 +0,0 @@
-import { Result } from "neverthrow";
-import { DeepReadonly, InputsWithProjectPath, ResourceProvisionOutput } from ".";
-import { M365TokenProvider, Func, FxError, Inputs, QTreeNode, TokenProvider, Void } from "../index";
-import { Json } from "../types";
-import { Context, EnvInfoV2, FxResult } from "./types";
-export declare type SolutionProvisionOutput = Record<string, ResourceProvisionOutput>;
-export interface SolutionPlugin {
-    name: string;
-    displayName: string;
-    /**
-     * Called by Toolkit when creating a new project or adding a new resource.
-     * Scaffolds source code on disk, relative to context.projectPath.
-     *
-     * @param {Context} ctx - plugin's runtime context shared by all lifecycles.
-     * @param {Inputs} inputs - User answers to questions defined in {@link getQuestionsForScaffolding} along with some system inputs.
-     *
-     * @returns scaffold return nothing in API, all source code are persist in FS.
-     */
-    scaffoldSourceCode: (ctx: Context, inputs: Inputs) => Promise<Result<Void, FxError>>;
-    /**
-     * Called when creating a new project or adding a new resource.
-     * Returns resource templates (e.g. Bicep templates/plain JSON) for provisioning
-     * based on the resource templates returned by resource plugins.
-     *
-     * @param {Context} ctx - plugin's runtime context shared by all lifecycles.
-     * @param {Inputs} inputs - User's answers to questions defined in {@link getQuestionsForLifecycleTask} for {@link Stage.create} along with some system inputs.
-     * @param {Json} - model for config.${env}.json, which is created core, solution will fill in some keys in it, such as azure, manifest
-     *
-     * @return {Json} envConfig
-     */
-    generateResourceTemplate: (ctx: Context, inputs: Inputs) => Promise<Result<Json, FxError>>;
-    /**
-     * This method is called by the Toolkit when users run "Provision in the Cloud" command.
-     * The implementation of solution is expected to do these operations in order:
-     * 1) Call resource plugins' provisionResource.
-     * 2) Run Bicep/ARM deployment returned by {@link generateResourceTemplate}.
-     * 3) Call resource plugins' configureResource.
-     *
-     * @param {Context} ctx - plugin's runtime context shared by all lifecycles.
-     * @param {ProvisionInputs} inputs - system inputs
-     * @param {EnvInfoV2} envInfo - model for config.${env}.json, in which, user can customize some inputs for provision
-     * @param {TokenProvider} tokenProvider - Tokens for Azure and AppStudio
-     */
-    provisionResources: (ctx: Context, inputs: Inputs, envInfo: EnvInfoV2, tokenProvider: TokenProvider) => Promise<Result<Void, FxError>>;
-    /**
-     * Depends on the values returned by {@link provisionResources}.
-     * Expected behavior is to deploy code to cloud using credentials provided by {@link AzureAccountProvider}.
-     *
-     * @param {Context} ctx - plugin's runtime context shared by all lifecycles.
-     * @param {Inputs} inputs - system inputs
-     * @param {DeepReadonly<EnvInfoV2>} envInfo - a readonly view of environment info modeled after (config|state).${env}.json
-     * @param {TokenProvider} tokenProvider - Token providers for Azure, AppStudio and m365.
-     *
-     */
-    deploy?: (ctx: Context, inputs: Inputs, envInfo: DeepReadonly<EnvInfoV2>, tokenProvider: TokenProvider) => Promise<Result<Void, FxError>>;
-    /**
-     * Depends on the output of {@link package}. Uploads Teams package to AppStudio
-     * @param {Context} ctx - plugin's runtime context shared by all lifecycles.
-     * @param {Inputs} inputs - User answers to questions defined in {@link getQuestionsForLifecycleTask}
-     * @param {DeepReadonly<EnvInfoV2>} envInfo - a readonly view to the current env
-     * @param {M365TokenProvider} tokenProvider - Token for M365
-     */
-    publishApplication: (ctx: Context, inputs: Inputs, envInfo: DeepReadonly<EnvInfoV2>, tokenProvider: M365TokenProvider) => Promise<Result<Void, FxError>>;
-    /**
-     * provisionLocalResource is a special lifecycle, called when users press F5 in vscode.
-     * It works like provision, but only creates necessary cloud resources for local debugging like AAD and AppStudio App.
-     * Implementation of this lifecycle is expected to call each resource plugins' provisionLocalResource, and after all of
-     * them finishes, call configureLocalResource of each plugin.
-     *
-     * @param {Context} ctx - plugin's runtime context shared by all lifecycles.
-     * @param {Inputs} inputs - User answers to questions defined in {@link getQuestionsForLifecycleTask}
-     * @param {Json} localSettings - JSON holding the output values for debugging
-     * @param {TokenProvider} tokenProvider - Tokens for Azure and AppStudio
-     *
-     * @returns the output localSettings
-     */
-    provisionLocalResource?: (ctx: Context, inputs: Inputs, localSettings: Json, tokenProvider: TokenProvider, envInfo?: EnvInfoV2) => Promise<FxResult<Json, FxError>>;
-    /**
-     * get question model for lifecycle {@link Stage} (create), Questions are organized as a tree. Please check {@link QTreeNode}.
-     */
-    getQuestionsForScaffolding?: (ctx: Context, inputs: Inputs) => Promise<Result<QTreeNode | undefined, FxError>>;
-    /**
-     * execute user customized task, for example `Add Resource`, `Add Capabilities`, etc
-     */
-    executeUserTask?: (ctx: Context, inputs: Inputs, func: Func, localSettings: Json, envInfo: EnvInfoV2, tokenProvider: TokenProvider) => Promise<Result<unknown, FxError>>;
-    /**
-     * for env management
-     */
-    createEnv?: (ctx: Context, inputs: Inputs) => Promise<Result<Void, FxError>>;
-    activateEnv?: (ctx: Context, inputs: Inputs) => Promise<Result<Void, FxError>>;
-    /**
-     * For grant and check permission in remote collaboration
-     */
-    grantPermission?: (ctx: Context, inputs: InputsWithProjectPath, envInfo: DeepReadonly<EnvInfoV2>, tokenProvider: TokenProvider) => Promise<Result<Json, FxError>>;
-    checkPermission?: (ctx: Context, inputs: InputsWithProjectPath, envInfo: DeepReadonly<EnvInfoV2>, tokenProvider: TokenProvider) => Promise<Result<Json, FxError>>;
-    listCollaborator?: (ctx: Context, inputs: InputsWithProjectPath, envInfo: DeepReadonly<EnvInfoV2>, tokenProvider: TokenProvider) => Promise<Result<Json, FxError>>;
-    getQuestions?: (ctx: Context, inputs: Inputs, envInfo: DeepReadonly<EnvInfoV2>, tokenProvider: TokenProvider) => Promise<Result<QTreeNode | undefined, FxError>>;
-    getQuestionsForUserTask?: (ctx: Context, inputs: Inputs, func: Func, envInfo: DeepReadonly<EnvInfoV2>, tokenProvider: TokenProvider) => Promise<Result<QTreeNode | undefined, FxError>>;
-}
-//# sourceMappingURL=solutionPlugin.d.ts.map

package/build/v2/solutionPlugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"solutionPlugin.d.ts","sourceRoot":"","sources":["../../src/v2/solutionPlugin.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACpC,OAAO,EACL,YAAY,EAEZ,qBAAqB,EAErB,uBAAuB,EACxB,MAAM,GAAG,CAAC;AAGX,OAAO,EACL,iBAAiB,EAEjB,IAAI,EACJ,OAAO,EACP,MAAM,EACN,SAAS,EACT,aAAa,EACb,IAAI,EACL,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEvD,oBAAY,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;AAE9E,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IAEb,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;OAQG;IACH,kBAAkB,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAErF;;;;;;;;;;OAUG;IACH,wBAAwB,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAE3F;;;;;;;;;;;OAWG;IACH,kBAAkB,EAAE,CAClB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,SAAS,EAClB,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAEpC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,CACP,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAChC,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAEpC;;;;;;OAMG;IACH,kBAAkB,EAAE,CAClB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAChC,aAAa,EAAE,iBAAiB,KAC7B,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAEpC;;;;;;;;;;;;OAYG;IACH,sBAAsB,CAAC,EAAE,CACvB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,IAAI,EACnB,aAAa,EAAE,aAAa,EAC5B,OAAO,CAAC,EAAE,SAAS,KAChB,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAEtC;;OAEG;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;;OAEG;IACH,eAAe,CAAC,EAAE,CAChB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,EACV,aAAa,EAAE,IAAI,EACnB,OAAO,EAAE,SAAS,EAClB,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAEvC;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7E,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAE/E;;OAEG;IACH,eAAe,CAAC,EAAE,CAChB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,qBAAqB,EAC7B,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAChC,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACpC,eAAe,CAAC,EAAE,CAChB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,qBAAqB,EAC7B,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAChC,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACpC,gBAAgB,CAAC,EAAE,CACjB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,qBAAqB,EAC7B,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAChC,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAGpC,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/build/v2/solutionPlugin.js

@@ -1,5 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=solutionPlugin.js.map

package/build/v2/solutionPlugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"solutionPlugin.js","sourceRoot":"","sources":["../../src/v2/solutionPlugin.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,YAAY,CAAC"}