@tachybase/test 0.23.8

package/lib/e2e/e2eUtils.d.ts

@@ -0,0 +1,298 @@
+import { Page } from '@playwright/test';
+import { defineConfig } from './defineConfig';
+export * from '@playwright/test';
+export { defineConfig };
+export interface CollectionSetting {
+    name: string;
+    title?: string;
+    /**
+     * @default 'general'
+     */
+    template?: string;
+    /**
+     * @default true
+     */
+    logging?: boolean;
+    /**
+     * Generate ID field automatically
+     * @default true
+     */
+    autoGenId?: boolean;
+    /**
+     * Store the creation user of each record
+     * @default true
+     */
+    createdBy?: boolean;
+    /**
+     * Store the last update user of each record
+     * @default true
+     */
+    updatedBy?: boolean;
+    /**
+     * Store the creation time of each record
+     * @default true
+     */
+    createdAt?: boolean;
+    /**
+     * Store the last update time of each record
+     * @default true
+     */
+    updatedAt?: boolean;
+    /**
+     * Records can be sorted
+     * @default true
+     */
+    sortable?: boolean | string;
+    /**
+     * @default false
+     */
+    inherit?: boolean;
+    inherits?: string[];
+    category?: any[];
+    hidden?: boolean;
+    description?: string;
+    view?: boolean;
+    key?: string;
+    fields?: Array<{
+        interface: string;
+        type?: string;
+        name?: string;
+        unique?: boolean;
+        uiSchema?: {
+            type?: string;
+            title?: string;
+            required?: boolean;
+            'x-component'?: string;
+            'x-read-pretty'?: boolean;
+            'x-validator'?: any;
+            'x-component-props'?: Record<string, any>;
+            [key: string]: any;
+        };
+        field?: string;
+        target?: string;
+        targetKey?: string;
+        foreignKey?: string;
+        allowNull?: boolean;
+        autoIncrement?: boolean;
+        primaryKey?: boolean;
+        key?: string;
+        description?: string;
+        collectionName?: string;
+        parentKey?: any;
+        reverseKey?: any;
+        [key: string]: any;
+    }>;
+}
+interface AclActionsSetting {
+    name: string;
+    fields?: any[];
+    scope?: any;
+}
+interface AclResourcesSetting {
+    name: string;
+    usingActionsConfig: boolean;
+    actions?: AclActionsSetting[];
+}
+interface AclRoleSetting {
+    name?: string;
+    title?: string;
+    /**
+     * @default true
+     */
+    allowNewMenu?: boolean;
+    snippets?: string[];
+    strategy?: any;
+    resources?: AclResourcesSetting[];
+    /**
+     * @default false
+     */
+    default?: boolean;
+    key?: string;
+    menuUiSchemas?: string[];
+    dataSourceKey?: string;
+}
+interface DatabaseSetting {
+    database: string;
+    host: string;
+    port: string;
+    schema?: string;
+    username?: string;
+    password?: string;
+}
+interface DataSourceSetting {
+    key: string;
+    displayName: string;
+    type: string;
+    options: DatabaseSetting;
+    enabled?: boolean;
+}
+export interface PageConfig {
+    /**
+     * 页面类型
+     * @default 'page'
+     */
+    type?: 'submenu' | 'page' | 'link';
+    /**
+     * type 为 link 时，表示跳转的链接
+     */
+    url?: string;
+    /**
+     * 用户可见的页面名称
+     * @default uid()
+     */
+    name?: string;
+    /**
+     * 页面的基础路径
+     * @default '/admin/'
+     */
+    basePath?: string;
+    /**
+     * 页面数据表的配置
+     * @default undefined
+     */
+    collections?: CollectionSetting[];
+    /**
+     * 页面整体的 Schema
+     * @default undefined
+     */
+    pageSchema?: any;
+}
+interface ExtendUtils {
+    /**
+     * 根据配置，生成一个 TachyBase 的页面
+     * @param pageConfig 页面配置
+     * @returns
+     */
+    mockPage: (pageConfig?: PageConfig) => NocoPage;
+    /**
+     * 根据配置，生成一个需要手动销毁的 NocoPage 页面
+     * @param pageConfig
+     * @returns
+     */
+    mockManualDestroyPage: (pageConfig?: PageConfig) => NocoPage;
+    /**
+     * 根据配置，生成多个 collections
+     * @param collectionSettings
+     * @returns 返回一个 destroy 方法，用于销毁创建的 collections
+     */
+    mockCollections: (collectionSettings: CollectionSetting[]) => Promise<any>;
+    /**
+     * 根据配置，生成一个 collection
+     * @param collectionSetting
+     * @returns 返回一个 destroy 方法，用于销毁创建的 collection
+     */
+    mockCollection: (collectionSetting: CollectionSetting) => Promise<any>;
+    /**
+     * 自动生成一条对应 collection 的数据
+     * @param collectionName 数据表名称
+     * @param data 自定义的数据，缺失时会生成随机数据
+     * @returns 返回一条生成的数据
+     */
+    mockRecord: <T = any>(collectionName: string, data?: any) => Promise<T>;
+    /**
+     * 自动生成多条对应 collection 的数据
+     */
+    mockRecords: {
+        /**
+         * @param collectionName - 数据表名称
+         * @param count - 生成的数据条数
+         */
+        <T = any>(collectionName: string, count?: number): Promise<T[]>;
+        /**
+         * @param collectionName - 数据表名称
+         * @param data - 指定生成的数据
+         */
+        <T = any>(collectionName: string, data?: any[]): Promise<T[]>;
+    };
+    /**
+     * 该方法已弃用，请使用 mockCollections
+     * @deprecated
+     * @param collectionSettings
+     * @returns
+     */
+    createCollections: (collectionSettings: CollectionSetting | CollectionSetting[]) => Promise<void>;
+    /**
+     * 根据页面 title 删除对应的页面
+     * @param pageName 显示在页面菜单中的名称
+     * @returns
+     */
+    deletePage: (pageName: string) => Promise<void>;
+    /**
+     * 生成一个新的角色，并和admin关联上
+     */
+    mockRole: <T = any>(roleSetting: AclRoleSetting) => Promise<T>;
+    /**
+     * 更新角色权限配置
+     */
+    updateRole: <T = any>(roleSetting: AclRoleSetting) => Promise<T>;
+    /**
+     * 创建一个外部数据源（pg）
+     */
+    mockExternalDataSource: <T = any>(DataSourceSetting: DataSourceSetting) => Promise<T>;
+    /**
+     * 删除外部数据源
+     * @param key 外部数据源key
+     */
+    destoryExternalDataSource: <T = any>(key: string) => Promise<T>;
+    /**
+     * 清空卡片模板
+     */
+    clearBlockTemplates: () => Promise<void>;
+}
+export declare class NocoPage {
+    private options?;
+    private page?;
+    private url;
+    private uid;
+    private collectionsName;
+    private _waitForInit;
+    constructor(options?: PageConfig, page?: Page);
+    init(): Promise<void>;
+    goto(): Promise<void>;
+    getUrl(): Promise<string>;
+    getUid(): Promise<string>;
+    waitForInit(this: NocoPage): Promise<NocoPage>;
+    destroy(): Promise<void>;
+}
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & ExtendUtils, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions> & {
+    /** 只运行在 postgres 数据库中 */
+    pgOnly: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & ExtendUtils, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions> | {
+        (title: string, body: (args: import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & ExtendUtils & import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions, testInfo: import("@playwright/test").TestInfo) => Promise<void> | void): void;
+        (title: string, details: import("@playwright/test").TestDetails, body: (args: import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & ExtendUtils & import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions, testInfo: import("@playwright/test").TestInfo) => Promise<void> | void): void;
+        (): void;
+        (condition: boolean, description?: string): void;
+        (callback: (args: import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & ExtendUtils & import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions) => boolean, description?: string): void;
+    };
+};
+/**
+ * 删除一些不需要的字段，如 key
+ * @param collectionSettings
+ * @returns
+ */
+export declare const omitSomeFields: (collectionSettings: CollectionSetting[]) => any[];
+interface ExpectSettingsMenuParams {
+    showMenu: () => Promise<void>;
+    supportedOptions: string[];
+    page: Page;
+    unsupportedOptions?: string[];
+}
+/**
+ * 辅助断言 SchemaSettings 的菜单项是否存在
+ * @param param0
+ */
+export declare function expectSettingsMenu({ showMenu, supportedOptions, page, unsupportedOptions, }: ExpectSettingsMenuParams): Promise<void>;
+/**
+ * 辅助断言 Initializer 的菜单项是否存在
+ * @param param0
+ */
+export declare function expectInitializerMenu({ showMenu, supportedOptions, page }: {
+    showMenu: any;
+    supportedOptions: any;
+    page: any;
+}): Promise<void>;
+/**
+ * 用于辅助在 page 中添加卡片
+ * @param page
+ * @param name
+ */
+export declare const createBlockInPage: (page: Page, name: string) => Promise<void>;