@scality/data-browser-library 1.0.0-preview.8 → 1.0.1

package/dist/test/setup.js

@@ -11,42 +11,25 @@ var __webpack_require__ = {};
         }
     })();
 })();
-process.env.AWS_ACCESS_KEY_ID = "test-access-key";
-process.env.AWS_SECRET_ACCESS_KEY = "test-secret-key";
-process.env.AWS_DEFAULT_REGION = "us-east-1";
-const testS3Config = {
-    endpoint: "http://localhost:8000",
-    region: "us-east-1",
-    realHost: "s3.amazonaws.com",
-    forcePathStyle: true
-};
-const testDevConfig = {
-    useProxy: false,
-    proxyEndpoint: "http://localhost:3000/api/s3",
-    proxyBasePath: "/api/s3",
-    proxyHost: "localhost",
-    proxyPort: 3000
-};
-globalThis.__S3_CONFIG__ = testS3Config;
-globalThis.__DEV_CONFIG__ = testDevConfig;
-globalThis.__IS_DEVELOPMENT__ = true;
-globalThis.__IS_PRODUCTION__ = false;
+process.env.AWS_ACCESS_KEY_ID = 'test-access-key';
+process.env.AWS_SECRET_ACCESS_KEY = 'test-secret-key';
+process.env.AWS_DEFAULT_REGION = 'us-east-1';
 jest.setTimeout(10000);
 Object.assign(__webpack_require__.g, {
     TextDecoder: TextDecoder,
     TextEncoder: TextEncoder
 });
-Object.defineProperty(HTMLCanvasElement.prototype, "getContext", {
+Object.defineProperty(HTMLCanvasElement.prototype, 'getContext', {
     value: ()=>null
 });
-jest.mock("pretty-bytes", ()=>({
+jest.mock('pretty-bytes', ()=>({
         __esModule: true,
         default: (bytes)=>{
             const sizes = [
-                "B",
-                "KB",
-                "MB",
-                "GB"
+                'B',
+                'KB',
+                'MB',
+                'GB'
             ];
             let i = 0;
             let num = bytes;
@@ -57,8 +40,8 @@ jest.mock("pretty-bytes", ()=>({
             return `${Math.round(num)} ${sizes[i]}`;
         }
     }));
-jest.mock("joi", ()=>{
-    const Joi = jest.requireActual("joi");
+jest.mock('joi', ()=>{
+    const Joi = jest.requireActual('joi');
     return {
         __esModule: true,
         default: Joi,
@@ -76,11 +59,11 @@ const originalError = console.error;
 const originalWarn = console.warn;
 beforeAll(()=>{
     console.error = (...args)=>{
-        if ("string" == typeof args[0] && (args[0].includes("AWS") || args[0].includes("S3") || args[0].includes("Warning: An update to") || args[0].includes('Warning: A props object containing a "key" prop'))) return;
+        if ('string' == typeof args[0] && (args[0].includes('AWS') || args[0].includes('S3') || args[0].includes('Warning: An update to') || args[0].includes('Warning: A props object containing a "key" prop'))) return;
         originalError(...args);
     };
     console.warn = (...args)=>{
-        if ("string" == typeof args[0] && (args[0].includes("AWS") || args[0].includes("S3") || args[0].includes("Warning: An update to") || args[0].includes('Warning: A props object containing a "key" prop'))) return;
+        if ('string' == typeof args[0] && (args[0].includes('AWS') || args[0].includes('S3') || args[0].includes('Warning: An update to') || args[0].includes('Warning: A props object containing a "key" prop'))) return;
         originalWarn(...args);
     };
 });

package/dist/test/testUtils.d.ts

@@ -1,20 +1,50 @@
-import { S3Client, PutObjectCommand } from "@aws-sdk/client-s3";
-import React from "react";
-import { S3BrowserConfig, S3Credentials } from "../types";
+/**
+ * @fileoverview Test utilities for data-browser-library
+ *
+ * This file provides common utilities for testing:
+ * - Test configuration and credentials
+ * - Mock setup utilities (S3, DOM, etc.)
+ * - React Testing Library wrappers
+ * - React Query wrappers
+ * - Global configuration utilities
+ * - Factory pattern validation utilities
+ * - Form testing helpers
+ */
+import { PutObjectCommand, S3Client } from '@aws-sdk/client-s3';
+import { type UseQueryResult } from '@tanstack/react-query';
+import type React from 'react';
+import type { S3BrowserConfig, S3Credentials } from '../types';
+/**
+ * Default S3 configuration for tests
+ */
 export declare const testConfig: S3BrowserConfig;
+/**
+ * Default S3 credentials for tests
+ */
 export declare const testCredentials: S3Credentials;
+/**
+ * Mock S3 client for tests
+ */
 export declare const mockS3Client: {
     send: jest.Mock<any, any, any>;
 };
 export declare const MockedS3Client: jest.MockedClass<typeof S3Client>;
 export declare const MockedPutObjectCommand: jest.MockedClass<typeof PutObjectCommand>;
-export declare function mockOffsetSize(width: number, height: number): void;
 /**
- * Creates a simple QueryClient wrapper for tests that don't need DataBrowser context
+ * Sets up S3 mocks for testing
  */
-export declare const createQueryWrapper: () => ({ children }: {
-    children: React.ReactNode;
-}) => import("react/jsx-runtime").JSX.Element;
+export declare const setupS3Mocks: () => void;
+/**
+ * Common mock setup that should be run before each test
+ */
+export declare const setupCommonMocks: () => void;
+/**
+ * Mocks DOM measurements APIs for virtualization and layout testing
+ * AutoSizer uses offsetWidth and offsetHeight which Jest/JSDom doesn't support
+ * @param width - The mock width in pixels
+ * @param height - The mock height in pixels
+ */
+export declare function mockOffsetSize(width: number, height: number): void;
 /**
  * Creates a test wrapper with DataBrowser context and QueryClient
  */
@@ -34,49 +64,153 @@ export declare const renderHookWithWrapper: <TProps, TResult>(hook: (props: TPro
  */
 export declare const createTestFile: (name: string, content: string, type?: string) => File;
 /**
- * Sets up S3 mocks for testing
+ * Creates a factory test error
  */
-export declare const setupS3Mocks: () => void;
+export declare const createFactoryTestError: (testContext: string, operationName: string, details?: string) => Error;
 /**
- * Common mock setup that should be run before each test
+ * Validates that a hook follows the expected factory pattern
  */
-export declare const setupCommonMocks: () => void;
+export declare const validateFactoryHook: (hook: any, operationName: string) => void;
+/**
+ * Validates that a hook result has expected React Query properties
+ */
+export declare const validateHookResult: (result: any, hookType: "query" | "mutation" | "infiniteQuery") => void;
 /**
- * Configuration test utilities for overriding build-time globals
+ * Creates a mock UseMutationResult for testing React Query mutations
+ *
+ * This helper provides a complete mock object that matches the UseMutationResult type
+ * from @tanstack/react-query, eliminating the need for 'as any' type assertions.
+ *
+ * @param mutate - The mocked mutate function (usually jest.fn())
+ * @param overrides - Optional overrides for any properties (e.g., { isPending: true })
+ * @returns A complete UseMutationResult mock object
+ *
+ * @example
+ * ```ts
+ * const mockCreateBucket = jest.fn();
+ * const mockResult = createMockMutationResult(mockCreateBucket, { isPending: true });
+ * mockUseCreateBucket.mockReturnValue(mockResult);
+ * ```
  */
-import type { S3Configuration, DevelopmentConfiguration } from "../config/types";
-type GlobalConfigOverrides = {
-    s3?: Partial<S3Configuration>;
-    dev?: Partial<DevelopmentConfiguration>;
-    environment?: {
-        isDevelopment?: boolean;
-        isProduction?: boolean;
-    };
+export declare const createMockMutationResult: (mutate: jest.Mock, overrides?: {}) => {
+    mutate: jest.Mock<any, any, any>;
+    mutateAsync: jest.Mock<any, any, any>;
+    reset: jest.Mock<any, any, any>;
+    isPending: false;
+    isIdle: true;
+    isError: false;
+    isSuccess: false;
+    status: "idle";
+    data: undefined;
+    error: null;
+    variables: undefined;
+    context: undefined;
+    failureCount: number;
+    failureReason: null;
+    isPaused: false;
+    submittedAt: number;
 };
 /**
- * Override global configuration for testing specific scenarios
- * Useful for testing different deployment environments or proxy configurations
+ * Creates a mock UseQueryResult for testing React Query queries
+ *
+ * This helper provides a complete mock object that matches the UseQueryResult type
+ * from @tanstack/react-query, eliminating the need for 'as any' type assertions.
+ *
+ * @param overrides - Optional overrides for any properties (e.g., { isLoading: true, data: mockData })
+ * @returns A complete UseQueryResult mock object
+ *
+ * @example
+ * ```ts
+ * const mockQueryResult = createMockQueryResult({ isLoading: true });
+ * mockUseGetBucketPolicy.mockReturnValue(mockQueryResult);
+ * ```
  */
-export declare const overrideGlobalConfig: (overrides: GlobalConfigOverrides) => void;
+export declare const createMockQueryResult: <T, E = Error>(overrides?: Partial<UseQueryResult<T, E>>) => UseQueryResult<T, E>;
 /**
- * Reset global configuration to test defaults
- * Should be called in afterEach or afterAll to ensure test isolation
+ * Finds a Toggle input element by its label text
+ * Traverses the DOM to locate the associated checkbox input
+ * @param labelText - The text content of the label
+ * @returns The toggle input element or null if not found
  */
-export declare const resetGlobalConfig: () => void;
+export declare const findToggleByLabel: (labelText: string) => HTMLInputElement | null;
 /**
- * Test helper for running tests with specific global configuration
+ * Waits for a submit button to be enabled and clicks it
+ * @param buttonName - The type of button to click ("create" or "save")
  */
-export declare const withGlobalConfig: (overrides: GlobalConfigOverrides, testFn: () => void | Promise<void>) => () => Promise<void>;
+export declare const submitForm: (buttonName?: "create" | "save") => Promise<void>;
 /**
- * Validates that a hook follows the expected factory pattern
+ * Sets up a mock mutation to simulate successful form submission
+ * @param mockMutate - The jest mock function for the mutation
  */
-export declare const validateFactoryHook: (hook: any, operationName: string) => void;
+export declare const mockSuccessSubmit: (mockMutate: jest.Mock) => void;
 /**
- * Creates a factory test error
+ * Sets up a mock mutation to simulate failed form submission
+ * @param mockMutate - The jest mock function for the mutation
+ * @param errorMessage - The error message to return (default: "Network Error")
  */
-export declare const createFactoryTestError: (testContext: string, operationName: string, details?: string) => Error;
+export declare const mockErrorSubmit: (mockMutate: jest.Mock, errorMessage?: string) => void;
+import type { GetBucketAclCommandOutput, GetBucketCorsCommandOutput, GetBucketLifecycleConfigurationCommandOutput, GetBucketLocationCommandOutput, GetBucketPolicyCommandOutput, GetBucketReplicationCommandOutput, GetBucketTaggingCommandOutput, GetBucketVersioningCommandOutput, GetObjectLockConfigurationCommandOutput } from '@aws-sdk/client-s3';
+export type MockQueryResult<T> = {
+    data: T | undefined;
+    status: 'idle' | 'pending' | 'success' | 'error';
+    error?: Error | null;
+};
+export type ISVBucketStatusMock = {
+    isVeeamBucket: boolean;
+    isCommvaultBucket: boolean;
+    isISVManaged: boolean;
+    isvApplication: string | undefined;
+    isLoading: boolean;
+    bucketTagsStatus: 'idle' | 'pending' | 'success' | 'error';
+};
+export interface BucketMockData {
+    versioning: MockQueryResult<GetBucketVersioningCommandOutput>;
+    acl: MockQueryResult<GetBucketAclCommandOutput>;
+    location: MockQueryResult<GetBucketLocationCommandOutput>;
+    cors: MockQueryResult<GetBucketCorsCommandOutput>;
+    objectLock: MockQueryResult<GetObjectLockConfigurationCommandOutput>;
+    policy: MockQueryResult<GetBucketPolicyCommandOutput>;
+    tagging: MockQueryResult<GetBucketTaggingCommandOutput>;
+    lifecycle: MockQueryResult<GetBucketLifecycleConfigurationCommandOutput>;
+    replication: MockQueryResult<GetBucketReplicationCommandOutput>;
+    isvBucketStatus: ISVBucketStatusMock;
+    features: boolean;
+}
 /**
- * Validates that a hook result has expected React Query properties
+ * Creates default bucket mock data for testing
+ * @returns Default bucket mock data with all properties set to success state
  */
-export declare const validateHookResult: (result: any, hookType: "query" | "mutation" | "infiniteQuery") => void;
-export { setupMswServer, overrideHandlers } from "./msw";
+export declare const createDefaultBucketMocks: () => BucketMockData;
+/**
+ * Applies bucket mock data to the provided mock functions
+ * @param mocks - Object containing all the mocked hook functions
+ * @param mockData - Optional partial overrides for the default mock data
+ *
+ * @example
+ * ```ts
+ * applyBucketMocks(
+ *   {
+ *     useGetBucketVersioning: mockUseGetBucketVersioning,
+ *     useGetBucketAcl: mockUseGetBucketAcl,
+ *     // ... other mocks
+ *   },
+ *   {
+ *     versioning: { data: { Status: "Suspended" }, status: "success" }
+ *   }
+ * );
+ * ```
+ */
+export declare const applyBucketMocks: (mocks: {
+    useGetBucketVersioning: jest.Mock;
+    useGetBucketAcl: jest.Mock;
+    useGetBucketLocation: jest.Mock;
+    useGetBucketCors: jest.Mock;
+    useGetBucketObjectLockConfiguration: jest.Mock;
+    useGetBucketPolicy: jest.Mock;
+    useGetBucketTagging: jest.Mock;
+    useGetBucketLifecycle?: jest.Mock;
+    useGetBucketReplication?: jest.Mock;
+    useISVBucketStatus: jest.Mock;
+    useFeatures: jest.Mock;
+}, mockData?: Partial<BucketMockData>) => void;
+export { overrideHandlers, setupMswServer } from './msw';