@microsoft/teamsfx-core 2.0.9 → 2.0.10-alpha.288b4cdfa.0

package/build/client/teamsDevPortalClient.d.ts

@@ -0,0 +1,127 @@
+/// <reference types="node" />
+import { AxiosInstance } from "axios";
+import { ApiSecretRegistration, ApiSecretRegistrationUpdate } from "../component/driver/teamsApp/interfaces/ApiSecretRegistration";
+import { AsyncAppValidationDetailsResponse } from "../component/driver/teamsApp/interfaces/AsyncAppValidationDetailsResponse";
+import { AsyncAppValidationResponse } from "../component/driver/teamsApp/interfaces/AsyncAppValidationResponse";
+import { AsyncAppValidationResultsResponse } from "../component/driver/teamsApp/interfaces/AsyncAppValidationResultsResponse";
+import { OauthConfigurationId } from "../component/driver/teamsApp/interfaces/OauthConfigurationId";
+import { OauthRegistration } from "../component/driver/teamsApp/interfaces/OauthRegistration";
+import { IPublishingAppDenition } from "../component/driver/teamsApp/interfaces/appdefinitions/IPublishingAppDefinition";
+import { IValidationResult } from "../component/driver/teamsApp/interfaces/appdefinitions/IValidationResult";
+import { AppDefinition } from "../component/driver/teamsApp/interfaces/appdefinitions/appDefinition";
+import { AppUser } from "../component/driver/teamsApp/interfaces/appdefinitions/appUser";
+import { IBotRegistration } from "../component/resource/botService/appStudio/interfaces/IBotRegistration";
+export declare class RetryHandler {
+    static RETRIES: number;
+    static Retry<T>(fn: () => Promise<T>): Promise<T | undefined>;
+}
+export declare class TeamsDevPortalClient {
+    regionEndpoint?: string;
+    getGlobalEndpoint(): string;
+    setRegionEndpoint(regionEndpoint: string): void;
+    setRegionEndpointByToken(authSvcToken: string): Promise<void>;
+    getEndpoint(): string;
+    /**
+     * Creates a new axios instance to call app studio to prevent setting the accessToken on global instance.
+     * @param {string}  token
+     * @returns {AxiosInstance}
+     */
+    createRequesterWithToken(token: string): AxiosInstance;
+    /**
+     * Import an app registration in app studio with the given archived file and returns the app definition.
+     * @param {string}  token - access token
+     * @param {Buffer}  file - Zip file with manifest.json and two icons
+     * @param {boolean} overwrite - whether to overrite the app if it already exists
+     * @returns {Promise<AppDefinition>}
+     */
+    importApp(token: string, file: Buffer, overwrite?: boolean): Promise<AppDefinition>;
+    listApps(token: string): Promise<AppDefinition[]>;
+    deleteApp(appStudioToken: string, teamsAppId: string): Promise<boolean>;
+    getApp(token: string, teamsAppId: string): Promise<AppDefinition>;
+    getAppPackage(token: string, teamsAppId: string): Promise<any>;
+    /**
+     * Check if app exists in the user's organization by the Teams app id
+     * @param teamsAppId
+     * @param token
+     * @param logProvider
+     * @returns
+     */
+    checkExistsInTenant(token: string, teamsAppId: string): Promise<boolean>;
+    /**
+     * Publish Teams app to Teams App Catalog
+     */
+    publishTeamsApp(token: string, teamsAppId: string, file: Buffer): Promise<string>;
+    /**
+     * Update existed publish request
+     * @param teamsAppId
+     * @param file
+     * @param token
+     * @returns
+     */
+    publishTeamsAppUpdate(token: string, teamsAppId: string, file: Buffer): Promise<string>;
+    /**
+     * Get Stagged Teams app from tenant app catalog
+     * @param teamsAppId manifest.id, which is externalId in app catalog.
+     * @param token
+     * @returns
+     */
+    getStaggedApp(token: string, teamsAppId: string): Promise<IPublishingAppDenition | undefined>;
+    getUserList(token: string, teamsAppId: string): Promise<AppUser[] | undefined>;
+    checkPermission(token: string, teamsAppId: string, userObjectId: string): Promise<string>;
+    grantPermission(token: string, teamsAppId: string, newUser: AppUser): Promise<void>;
+    /**
+     * Send the app package for partner center validation
+     * @param file
+     * @param token
+     * @returns
+     */
+    partnerCenterAppPackageValidation(token: string, file: Buffer): Promise<IValidationResult>;
+    checkUser(app: AppDefinition, newUser: AppUser): boolean;
+    /**
+     * Submit App Validation Request (In-App) for which App Definitions are stored at TDP.
+     * @param teamsAppId
+     * @param token
+     * @param timeoutSeconds
+     * @returns
+     */
+    submitAppValidationRequest(token: string, teamsAppId: string, timeoutSeconds?: number): Promise<AsyncAppValidationResponse>;
+    /**
+     * Get App validation requests sumitted by the user
+     */
+    getAppValidationRequestList(token: string, teamsAppId: string): Promise<AsyncAppValidationDetailsResponse>;
+    /**
+     * Get App validation results by provided app validation id
+     * @param appValidationId
+     * @param token
+     * @param timeoutSeconds
+     * @returns
+     */
+    getAppValidationById(token: string, appValidationId: string, timeoutSeconds?: number): Promise<AsyncAppValidationResultsResponse>;
+    getSideloadingStatus(token: string): Promise<boolean | undefined>;
+    /**
+     * Create the Api Key registration.
+     * @param token
+     * @param apiKeyRegistration
+     */
+    createApiKeyRegistration(token: string, apiKeyRegistration: ApiSecretRegistration): Promise<ApiSecretRegistration>;
+    /**
+     * Get the Api Key registration by Id.
+     * @param token
+     * @param apiSecretRegistrationId
+     */
+    getApiKeyRegistrationById(token: string, apiSecretRegistrationId: string): Promise<ApiSecretRegistration>;
+    updateApiKeyRegistration(token: string, apiKeyRegistration: ApiSecretRegistrationUpdate, apiKeyRegistrationId: string): Promise<ApiSecretRegistrationUpdate>;
+    getOauthRegistrationById(token: string, oauthRegistrationId: string): Promise<OauthRegistration>;
+    createOauthRegistration(token: string, oauthRegistration: OauthRegistration): Promise<OauthConfigurationId>;
+    updateOauthRegistration(token: string, oauthRegistration: OauthRegistration, oauthRegistrationId: string): Promise<OauthRegistration>;
+    getBotRegistration(token: string, botId: string): Promise<IBotRegistration | undefined>;
+    listBots(token: string): Promise<IBotRegistration[] | undefined>;
+    deleteBot(token: string, botId: string): Promise<void>;
+    createBotRegistration(token: string, registration: IBotRegistration, checkExistence?: boolean): Promise<void>;
+    updateMessageEndpoint(token: string, botId: string, endpoint: string): Promise<void>;
+    updateBotRegistration(token: string, botReg: IBotRegistration): Promise<void>;
+    handleBotFrameworkError(e: any, apiName: string): void | undefined;
+    wrapException(e: any, apiName: string): Error;
+}
+export declare const teamsDevPortalClient: TeamsDevPortalClient;
+//# sourceMappingURL=teamsDevPortalClient.d.ts.map

package/build/client/teamsDevPortalClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"teamsDevPortalClient.d.ts","sourceRoot":"","sources":["../../src/client/teamsDevPortalClient.ts"],"names":[],"mappings":";AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAkBtC,OAAO,EACL,qBAAqB,EACrB,2BAA2B,EAC5B,MAAM,+DAA+D,CAAC;AACvE,OAAO,EAAE,iCAAiC,EAAE,MAAM,2EAA2E,CAAC;AAC9H,OAAO,EAAE,0BAA0B,EAAE,MAAM,oEAAoE,CAAC;AAChH,OAAO,EAAE,iCAAiC,EAAE,MAAM,2EAA2E,CAAC;AAC9H,OAAO,EAAE,oBAAoB,EAAE,MAAM,8DAA8D,CAAC;AACpG,OAAO,EAAE,iBAAiB,EAAE,MAAM,2DAA2D,CAAC;AAC9F,OAAO,EAAE,sBAAsB,EAAE,MAAM,iFAAiF,CAAC;AACzH,OAAO,EAAE,iBAAiB,EAAE,MAAM,0EAA0E,CAAC;AAC7G,OAAO,EAAE,aAAa,EAAE,MAAM,sEAAsE,CAAC;AACrG,OAAO,EAAE,OAAO,EAAE,MAAM,gEAAgE,CAAC;AAGzF,OAAO,EAEL,gBAAgB,EACjB,MAAM,wEAAwE,CAAC;AAkBhF,qBAAa,YAAY;IACvB,OAAc,OAAO,SAAK;WACN,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;CAkB3E;AAED,qBAAa,oBAAoB;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,iBAAiB,IAAI,MAAM;IAQ3B,iBAAiB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAIzC,wBAAwB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAcnE,WAAW,IAAI,MAAM;IAIrB;;;;OAIG;IACH,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa;IAStD;;;;;;OAMG;IAEG,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,OAAO,CAAC,aAAa,CAAC;IAoEjF,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAoBjD,SAAS,CAAC,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA0BvE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IA4BjE,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAoBpE;;;;;;OAMG;IAEG,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAgB9E;;OAEG;IAEG,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IA8DvF;;;;;;OAMG;IAEG,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkD7F;;;;;OAKG;IAEG,aAAa,CACjB,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,sBAAsB,GAAG,SAAS,CAAC;IA6BxC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC;IAM9E,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAqBzF,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IA8BzF;;;;;OAKG;IAEG,iCAAiC,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAehG,SAAS,CAAC,GAAG,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO;IASxD;;;;;;OAMG;IAEG,0BAA0B,CAC9B,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,EAClB,cAAc,SAAK,GAClB,OAAO,CAAC,0BAA0B,CAAC;IAiBtC;;OAEG;IAEG,2BAA2B,CAC/B,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,iCAAiC,CAAC;IAY7C;;;;;;OAMG;IAEG,oBAAoB,CACxB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,EACvB,cAAc,SAAK,GAClB,OAAO,CAAC,iCAAiC,CAAC;IAcvC,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IA2DvE;;;;OAIG;IAEG,wBAAwB,CAC5B,KAAK,EAAE,MAAM,EACb,kBAAkB,EAAE,qBAAqB,GACxC,OAAO,CAAC,qBAAqB,CAAC;IAajC;;;;OAIG;IAEG,yBAAyB,CAC7B,KAAK,EAAE,MAAM,EACb,uBAAuB,EAAE,MAAM,GAC9B,OAAO,CAAC,qBAAqB,CAAC;IAa3B,wBAAwB,CAC5B,KAAK,EAAE,MAAM,EACb,kBAAkB,EAAE,2BAA2B,EAC/C,oBAAoB,EAAE,MAAM,GAC3B,OAAO,CAAC,2BAA2B,CAAC;IAiBjC,wBAAwB,CAC5B,KAAK,EAAE,MAAM,EACb,mBAAmB,EAAE,MAAM,GAC1B,OAAO,CAAC,iBAAiB,CAAC;IAcvB,uBAAuB,CAC3B,KAAK,EAAE,MAAM,EACb,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,oBAAoB,CAAC;IAc1B,uBAAuB,CAC3B,KAAK,EAAE,MAAM,EACb,iBAAiB,EAAE,iBAAiB,EACpC,mBAAmB,EAAE,MAAM,GAC1B,OAAO,CAAC,iBAAiB,CAAC;IAcvB,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAiBvF,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,GAAG,SAAS,CAAC;IAgBhE,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUtD,qBAAqB,CACzB,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,gBAAgB,EAC9B,cAAc,UAAO,GACpB,OAAO,CAAC,IAAI,CAAC;IAsBV,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAcpF,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcnF,uBAAuB,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAclE,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK;CAO9C;AAED,eAAO,MAAM,oBAAoB,sBAA6B,CAAC"}