@strapi/admin 5.0.0-alpha.1 → 5.0.0-alpha.3

package/dist/admin/tests/utils.d.ts

@@ -0,0 +1,438 @@
+import * as React from 'react';
+import { ConfigureStoreOptions } from '@reduxjs/toolkit';
+import { fireEvent, waitFor, RenderOptions as RTLRenderOptions, RenderResult, act, screen, RenderHookOptions, RenderHookResult, Queries } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import { MemoryRouterProps } from 'react-router-dom';
+import { type Permission } from '../src/features/Auth';
+import { server } from './server';
+interface ProvidersProps {
+    children: React.ReactNode;
+    initialEntries?: MemoryRouterProps['initialEntries'];
+    storeConfig?: Partial<ConfigureStoreOptions>;
+    permissions?: Permission[] | ((defaultPermissions: Permission[]) => Permission[] | undefined);
+}
+declare const defaultTestStoreConfig: {
+    preloadedState: {
+        admin_app: {
+            language: {
+                locale: string;
+                localeNames: {
+                    en: string;
+                };
+            };
+            permissions: {
+                contentManager: {
+                    main: never[];
+                    collectionTypesConfigurations: {
+                        action: string;
+                        subject: null;
+                    }[];
+                    componentsConfigurations: {
+                        action: string;
+                        subject: null;
+                    }[];
+                    singleTypesConfigurations: {
+                        action: string;
+                        subject: null;
+                    }[];
+                };
+                marketplace: {
+                    main: {
+                        action: string;
+                        subject: null;
+                    }[];
+                    read: {
+                        action: string;
+                        subject: null;
+                    }[];
+                };
+                settings: {
+                    roles: {
+                        main: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        create: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        delete: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        read: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        update: {
+                            action: string;
+                            subject: null;
+                        }[];
+                    };
+                    users: {
+                        main: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        create: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        delete: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        read: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        update: {
+                            action: string;
+                            subject: null;
+                        }[];
+                    };
+                    webhooks: {
+                        main: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        create: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        delete: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        read: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        update: {
+                            action: string;
+                            subject: null;
+                        }[];
+                    };
+                    'api-tokens': {
+                        main: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        create: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        delete: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        read: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        update: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        regenerate: {
+                            action: string;
+                            subject: null;
+                        }[];
+                    };
+                    'transfer-tokens': {
+                        main: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        create: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        delete: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        read: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        update: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        regenerate: {
+                            action: string;
+                            subject: null;
+                        }[];
+                    };
+                    'project-settings': {
+                        read: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        update: {
+                            action: string;
+                            subject: null;
+                        }[];
+                    };
+                    auditLogs: {
+                        main: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        read: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        update: {
+                            action: string;
+                            subject: null;
+                        }[];
+                    };
+                    'review-workflows': {
+                        main: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        read: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        create: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        delete: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        update: {
+                            action: string;
+                            subject: null;
+                        }[];
+                    };
+                    sso: {
+                        main: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        read: {
+                            action: string;
+                            subject: null;
+                        }[];
+                        update: {
+                            action: string;
+                            subject: null;
+                        }[];
+                    };
+                };
+            };
+            theme: {
+                availableThemes: never[];
+                currentTheme: string;
+            };
+        };
+        'content-manager_app': {
+            collectionTypeLinks: never[];
+            components: {
+                uid: string;
+                isDisplayed: boolean;
+                apiID: string;
+                category: string;
+                info: {
+                    displayName: string;
+                    icon: string;
+                    description: string;
+                };
+                options: {};
+                attributes: {
+                    id: {
+                        type: string;
+                    };
+                    name: {
+                        type: string;
+                        default: string;
+                    };
+                };
+            }[];
+            fieldSizes: {};
+            models: ({
+                uid: string;
+                isDisplayed: boolean;
+                apiID: string;
+                kind: string;
+                info: {
+                    displayName: string;
+                    singularName: string;
+                    pluralName: string;
+                    description: string;
+                    name: string;
+                };
+                options: {};
+                pluginOptions: {
+                    i18n?: undefined;
+                };
+                attributes: {
+                    id: {
+                        type: string;
+                    };
+                    postal_code: {
+                        type: string;
+                        pluginOptions: {};
+                        maxLength: number;
+                    };
+                    json: {
+                        type: string;
+                        pluginOptions: {};
+                    };
+                    slug: {
+                        type: string;
+                        targetField?: undefined;
+                        required?: undefined;
+                        pluginOptions?: undefined;
+                    };
+                    repeat_req_min: {
+                        type: string;
+                        repeatable: boolean;
+                        pluginOptions: {};
+                        component: string;
+                        required: boolean;
+                        min: number;
+                    };
+                    createdAt: {
+                        type: string;
+                    };
+                    updatedAt: {
+                        type: string;
+                    };
+                    title?: undefined;
+                    single?: undefined;
+                    multiple?: undefined;
+                    createdBy?: undefined;
+                    updatedBy?: undefined;
+                };
+            } | {
+                uid: string;
+                isDisplayed: boolean;
+                apiID: string;
+                kind: string;
+                info: {
+                    displayName: string;
+                    singularName: string;
+                    pluralName: string;
+                    description?: undefined;
+                    name?: undefined;
+                };
+                options: {};
+                pluginOptions: {
+                    i18n: {
+                        localized: boolean;
+                    };
+                };
+                attributes: {
+                    id: {
+                        type: string;
+                    };
+                    title: {
+                        type: string;
+                        required: boolean;
+                        pluginOptions: {
+                            i18n: {
+                                localized: boolean;
+                            };
+                        };
+                    };
+                    slug: {
+                        type: string;
+                        targetField: string;
+                        required: boolean;
+                        pluginOptions: {
+                            i18n: {
+                                localized: boolean;
+                            };
+                        };
+                    };
+                    single: {
+                        type: string;
+                        allowedTypes: string[];
+                        required: boolean;
+                    };
+                    multiple: {
+                        type: string;
+                        multiple: boolean;
+                        allowedTypes: string[];
+                        required: boolean;
+                    };
+                    createdAt: {
+                        type: string;
+                    };
+                    updatedAt: {
+                        type: string;
+                    };
+                    createdBy: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        configurable: boolean;
+                        writable: boolean;
+                        visible: boolean;
+                        useJoinTable: boolean;
+                        private: boolean;
+                        targetModel: string;
+                        relationType: string;
+                    };
+                    updatedBy: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        configurable: boolean;
+                        writable: boolean;
+                        visible: boolean;
+                        useJoinTable: boolean;
+                        private: boolean;
+                        targetModel: string;
+                        relationType: string;
+                    };
+                    postal_code?: undefined;
+                    json?: undefined;
+                    repeat_req_min?: undefined;
+                };
+            })[];
+            singleTypeLinks: never[];
+            isLoading: boolean;
+        };
+    };
+    reducer: {
+        adminApi: import("redux").Reducer<import("@reduxjs/toolkit/query").CombinedState<{
+            regenerateToken: import("@reduxjs/toolkit/query").MutationDefinition<string, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("../src/utils/baseQuery").QueryArguments, unknown, import("../src/utils/baseQuery").BaseQueryError>, "ApiToken" | "LicenseLimits" | "Me" | "ProjectSettings" | "ProvidersOptions" | "ReviewWorkflow" | "ReviewWorkflowStage" | "Role" | "RolePermissions" | "TransferToken" | "User" | "Webhook", import("../../shared/contracts/transfer").TransferToken, "adminApi">;
+        }, "ApiToken" | "LicenseLimits" | "Me" | "ProjectSettings" | "ProvidersOptions" | "ReviewWorkflow" | "ReviewWorkflowStage" | "Role" | "RolePermissions" | "TransferToken" | "User" | "Webhook", "adminApi">, import("redux").AnyAction>;
+        admin_app: import("redux").Reducer<import("../src/reducer").AppState>;
+        'content-manager_app': (state: import("../src/content-manager/layout").ContentManagerAppState | undefined, action: import("redux").AnyAction) => import("../src/content-manager/layout").ContentManagerAppState;
+        contentManagerApi: import("redux").Reducer<import("@reduxjs/toolkit/query").CombinedState<{}, "ComponentConfiguration" | "ContentTypesConfiguration" | "ContentTypeSettings" | "Document" | "InitialData" | "HistoryVersion" | "Relations", "contentManagerApi">, import("redux").AnyAction>;
+        'content-manager': import("redux").Reducer<import("redux").CombinedState<{
+            rbac: import("../src/content-manager/modules/rbac").SyncRbacState;
+        }>, import("redux").AnyAction>;
+    };
+    middleware: (getDefaultMiddleware: any) => any[];
+};
+export interface RenderOptions {
+    renderOptions?: RTLRenderOptions;
+    userEventOptions?: Parameters<typeof userEvent.setup>[0];
+    initialEntries?: MemoryRouterProps['initialEntries'];
+    providerOptions?: Pick<ProvidersProps, 'storeConfig' | 'permissions'>;
+}
+/**
+ * @alpha
+ * @description A custom render function that wraps the component with the necessary providers,
+ * for use of testing components within the Strapi Admin.
+ */
+declare const render: (ui: React.ReactElement, { renderOptions, userEventOptions, initialEntries, providerOptions }?: RenderOptions) => RenderResult & {
+    user: ReturnType<typeof userEvent.setup>;
+};
+/**
+ * @alpha
+ * @description A custom render-hook function that wraps the component with the necessary providers,
+ * for use of testing hooks within the Strapi Admin.
+ */
+declare const renderHook: <Result, Props, Q extends Queries, Container extends Element | DocumentFragment = HTMLElement, BaseElement extends Element | DocumentFragment = Container>(hook: (initialProps: Props) => Result, options?: (RenderHookOptions<Props, Q, Container, BaseElement> & Pick<RenderOptions, "initialEntries" | "providerOptions">) | undefined) => RenderHookResult<Result, Props>;
+export { render, renderHook, waitFor, server, act, screen, fireEvent, defaultTestStoreConfig };