Referência de API

Esta API do Kit de Ferramentas do Power Platform Playwright faz referência a documentos públicos, métodos e tipos que você pode usar para automatizar testes de ponta a ponta de aplicativos orientados por tela e modelos.

`AppProvider`

Ponto de entrada para iniciar aplicativos do Power Platform. Instancie uma vez por teste e, em seguida, chame launch().

class AppProvider {
  constructor(page: Page, context: BrowserContext)

  launch(options: AppLaunchOptions): Promise<void>
  getModelDrivenAppPage(): ModelDrivenAppPage
  getCanvasAppPage(): CanvasAppPage
  getGenUxPage(): GenUxPage
}

`AppLaunchOptions`

Opções passadas para AppProvider.launch() configurar qual aplicativo abrir e como.

interface AppLaunchOptions {
  app: string;                  // Display name of the app
  type: AppType;                // Canvas | ModelDriven
  mode: AppLaunchMode;          // Play | Edit
  skipMakerPortal?: boolean;    // true: use directUrl, skip make.powerapps.com navigation
  directUrl?: string;           // Full URL when skipMakerPortal is true
}

`AppType`

Especifica o tipo de aplicativo do Power Platform a ser iniciado.

enum AppType {
  Canvas = 'canvas',
  ModelDriven = 'model-driven',
}

`AppLaunchMode`

Determina se o aplicativo é aberto no modo de reprodução ou no modo de edição.

enum AppLaunchMode {
  Play = 'play',
  Edit = 'edit',
}

`ModelDrivenAppPage`

Retornado por AppProvider.getModelDrivenAppPage(). Fornece acesso de navegação e componente.

class ModelDrivenAppPage {
  readonly grid: GridComponent
  readonly form: FormComponent
  readonly commanding: CommandingComponent

  navigateToGridView(entityLogicalName: string): Promise<void>
  navigateToFormView(entityLogicalName: string): Promise<void>
}

`GridComponent`

Encapsula a Grade do AG usada em exibições de lista controladas por modelos. Acessado por meio de ModelDrivenAppPage.grid.

class GridComponent {
  waitForGridLoad(): Promise<void>

  filterByKeyword(keyword: string): Promise<void>
  filterByColumn(columnName: string, value: string): Promise<void>

  getCellValue(rowIndex: number, columnName: string): Promise<string | null>
  getRowCount(): Promise<number>
  isGridEmpty(): Promise<boolean>

  openRecord(options: OpenRecordOptions): Promise<void>
  selectRow(rowIndex: number): Promise<void>
  selectRows(rowIndexes: number[]): Promise<void>
}

`OpenRecordOptions`

Opções para identificar qual registro abrir da grade.

interface OpenRecordOptions {
  rowNumber?: number;         // 0-based row index
  columnName?: string;        // column to match (display name or schema name)
  columnValue?: string;       // value to match in the column
}

`FormComponent`

Encapsula o Dynamics 365 runtime do formulário. Acessado por meio de ModelDrivenAppPage.form.

class FormComponent {
  getAttribute(fieldName: string): Promise<string | null>
  setAttribute(fieldName: string, value: string): Promise<void>

  save(): Promise<void>
  isDirty(): Promise<boolean>
  isValid(): Promise<boolean>

  navigateToTab(tabName: string): Promise<void>

  setFieldVisibility(fieldName: string, visible: boolean): Promise<void>
  setFieldDisabled(fieldName: string, disabled: boolean): Promise<void>
  setFieldRequiredLevel(
    fieldName: string,
    level: 'none' | 'recommended' | 'required'
  ): Promise<void>

  execute<T>(
    fn: (formContext: Xrm.FormContext) => T | Promise<T>
  ): Promise<T>
}

`FormComponent.execute()`

Executa código arbitrário no contexto de formulário do navegador com acesso total à API do Cliente Xrm:

const value = await mda.form.execute(
  (ctx) => ctx.getAttribute('nwind_ordernumber')?.getValue()
);

Consulte o teste de API por meio do contexto de formulário para uso detalhado.

`CommandingComponent`

Encapsula a barra de comandos do aplicativo controlado por modelos. Acessado por meio de ModelDrivenAppPage.commanding.

class CommandingComponent {
  clickButton(ariaLabel: string): Promise<void>
  clickMoreCommands(): Promise<void>
}

`CanvasAppPage`

Retornado por AppProvider.getCanvasAppPage(). Fornece o localizador de quadro iframe de tela.

class CanvasAppPage {
  getFrame(): FrameLocator
  waitForLoad(controlName?: string): Promise<void>
}

`GenUxPage`

Retornado por AppProvider.getGenUxPage(). Fornece interações com o designer de IA do Power Apps Maker Portal GenUX para criar, gerar, inspecionar e publicar aplicativos baseados em modelos de prompts de IA.

class GenUxPage {
  readonly previewFrame: FrameLocator  // UCI Preview iframe locator

  // Power Apps navigation
  goToAppsPage(): Promise<void>
  navigateToStartWithPageDesign(): Promise<void>
  createAppWithName(appName: string): Promise<void>
  addNewPage(): Promise<void>

  // AI generation
  waitForUCIPreviewFrameAndFillPrompt(prompt: string): Promise<void>
  waitForUCIPreviewFrameAndSelectTemplate(templateText: string): Promise<void>
  verifyThoughtStreaming(): Promise<void>
  verifyCodeAndPreviewTabsAvailable(): Promise<void>
  verifyCodeStreaming(): Promise<void>

  // Inspection
  clickPreviewTab(): Promise<void>
  clickCodeTab(): Promise<void>
  waitForGeneratedContent(): Promise<void>
  waitForCodeTabContent(): Promise<void>
  getPreviewTabDom(): Promise<string>
  getCodeTabContent(): Promise<string>

  // Publishing
  publishApp(): Promise<void>
  buildCanvasPlayUrl(): string

  // Form interaction
  submitForm(): Promise<void>
  waitForSubmitSuccess(timeout?: number): Promise<void>

  // App management
  getAppIdFromUrl(): string
  searchAndPlayApp(appName: string, context: BrowserContext): Promise<Page | null>
  deleteAppsMatchingPrefix(prefix: string): Promise<void>
  deleteAppFromAppListIfFound(appName: string): Promise<void>
}

`GenUxPage.previewFrame`

Expõe o FrameLocator iframe da versão prévia da UCI. Use essa propriedade para consultar diretamente os elementos de formulário gerados:

const input = genUxPage.previewFrame.getByRole('textbox', { name: 'First Name' });
await expect(input).toBeVisible();

`GenUxPage.verifyThoughtStreaming()`

Verifica se há indicadores transitórios de streaming do GenUX, como texto de pensamento, botão Parar e Pensamentos do Agente. Cada verificação é o melhor esforço – a geração pode ser concluída antes que todos os indicadores apareçam. A única afirmação dura é que o streaming está em andamento ou "Your page is now generated" está visível.

`GenUxPage.searchAndPlayApp()`

Retorna null quando o Play está desabilitado (o aplicativo ainda não foi publicado) em vez de gerar um erro. Use test.skip() em um null retorno:

const appPage = await genUxPage.searchAndPlayApp(appName, context);
if (!appPage) test.skip();

Funções de utilitário

Funções auxiliares autônomas para tarefas comuns de configuração e configuração.

`buildCanvasAppUrlFromEnv`

Leituras CANVAS_APP_URL do ambiente:

function buildCanvasAppUrlFromEnv(): string

`getStorageStatePath`

Retorna o caminho para o arquivo de estado de armazenamento Power Apps para o email fornecido:

function getStorageStatePath(email: string): string
// Returns: packages/e2e-tests/.playwright-ms-auth/state-<email>.json

`ConfigHelper`

Fornece auxiliares de configuração, como verificar se o estado de armazenamento armazenado em cache expirou.

class ConfigHelper {
  static checkStorageStateExpiration(
    statePath: string
  ): { expired: boolean; expiresOn?: number }
}

Utilitários do localizador

Métodos auxiliares para localizar controles Power Apps dentro de iframes.

`LocatorUtils`

Métodos estáticos para localizar controles de aplicativo de tela e itens da galeria por nome.

class LocatorUtils {
  static getByControlName(frame: FrameLocator, controlName: string): Locator
  static getGalleryItem(frame: FrameLocator, titleText: string): Locator
}

Exportações de tipo

Exportar todos os tipos da raiz do pacote:

import {
  AppProvider,
  AppType,
  AppLaunchMode,
  AppLaunchOptions,
  ModelDrivenAppPage,
  GridComponent,
  FormComponent,
  CommandingComponent,
  CanvasAppPage,
  GenUxPage,
  buildCanvasAppUrlFromEnv,
  getStorageStatePath,
  ConfigHelper,
  LocatorUtils,
} from 'power-platform-playwright-toolkit';

Compartilhar via

Referência de API

AppProvider

AppLaunchOptions

AppType

AppLaunchMode

ModelDrivenAppPage

GridComponent

OpenRecordOptions

FormComponent

FormComponent.execute()

CommandingComponent

CanvasAppPage

GenUxPage

GenUxPage.previewFrame

GenUxPage.verifyThoughtStreaming()

GenUxPage.searchAndPlayApp()