@bluealba/pae-ui-react-core 4.6.0 → 4.7.0-develop-423

package/dist/src/components/PortalContainerContext.d.ts

@@ -0,0 +1,12 @@
+import { FC, ReactNode } from 'react';
+
+export interface PortalContainerProviderProps {
+    container: HTMLElement | null;
+    children: ReactNode;
+}
+export declare const PortalContainerProvider: FC<PortalContainerProviderProps>;
+/**
+ * Returns the portal container to use, or undefined to let Radix default to
+ * document.body.
+ */
+export declare const usePortalContainer: () => HTMLElement | undefined;

package/dist/src/components/index.d.ts

@@ -8,3 +8,5 @@ export { default as ThemeToggle } from './ThemeToggle/ThemeToggle';
 export { useTheme } from './ThemeToggle/useTheme';
 export { default as FragmentSlot } from './FragmentSlot';
 export type { FragmentSlotProps } from './FragmentSlot';
+export { PortalContainerProvider, usePortalContainer } from './PortalContainerContext';
+export type { PortalContainerProviderProps } from './PortalContainerContext';

package/dist/src/hooks/file-storage/index.d.ts

@@ -0,0 +1,2 @@
+export { useFileStorage } from './useFileStorage';
+export type { FileDto, UploadOptions, UpdateMetadataOptions, UseFileStorageResult } from './types';

package/dist/src/hooks/file-storage/types.d.ts

@@ -0,0 +1,35 @@
+export interface FileDto {
+    id: number;
+    originalName: string;
+    mimeType: string;
+    extension: string;
+    size: number;
+    isPublic: boolean;
+    description?: string;
+    metadata?: Record<string, unknown>;
+    url: string;
+    createdBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface UploadOptions {
+    isPublic?: boolean;
+    description?: string;
+    metadata?: Record<string, unknown>;
+    onProgress?: (percent: number) => void;
+    signal?: AbortSignal;
+}
+export interface UpdateMetadataOptions {
+    originalName?: string;
+    isPublic?: boolean;
+    description?: string;
+    metadata?: Record<string, unknown>;
+}
+export interface UseFileStorageResult {
+    isEnabled: boolean;
+    upload(file: File, options?: UploadOptions): Promise<FileDto>;
+    updateMetadata(id: number, options: UpdateMetadataOptions): Promise<FileDto>;
+    remove(id: number): Promise<void>;
+    download(id: number): Promise<void>;
+    getPreviewUrl(id: number): Promise<string>;
+}

package/dist/src/hooks/file-storage/uploadWithProgress.d.ts

@@ -0,0 +1,7 @@
+export declare function uploadWithProgress<T>(opts: {
+    url: string;
+    method: 'POST' | 'PATCH';
+    formData: FormData;
+    onProgress?: (percent: number) => void;
+    signal?: AbortSignal;
+}): Promise<T>;

package/dist/src/hooks/file-storage/uploadWithProgress.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/file-storage/useFileStorage.d.ts

@@ -0,0 +1,9 @@
+import { UseFileStorageResult } from './types';
+
+/**
+ * Hook providing client-side access to the platform File Storage API.
+ *
+ * The hook is a no-op when `fileStorageEnabled` is `false` in the platform state —
+ * every method will reject with a descriptive error.
+ */
+export declare function useFileStorage(): UseFileStorageResult;

package/dist/src/hooks/file-storage/useFileStorage.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/index.d.ts

@@ -43,3 +43,5 @@ export { useResource } from './commons/useResource';
 export { useTenants } from './tenants/useTenants';
 export { useUserState } from './userState/useUserState';
 export { useAppStatus } from './useAppStatus';
+export { useFileStorage } from './file-storage/useFileStorage';
+export type { FileDto, UploadOptions, UpdateMetadataOptions, UseFileStorageResult } from './file-storage/types';

package/dist/src/utils/initializeMicroFrontend.d.ts

@@ -4,6 +4,34 @@ import { RootComponentProps } from '../MicrofrontendProps';
 
 export interface MicroFrontendOptions<T extends RootComponentProps> extends SingleSpaReactOpts<T> {
     rootComponent: FC<T>;
+    /**
+     * Mount this module inside its own shadow root (attached to the host
+     * element the platform resolves from ui.mountAtSelector).
+     *
+     * Why: global CSS from OTHER modules mounted at the same time (a framework
+     * reset, unlayered utilities, ...) cannot reach this module's DOM, and this
+     * module's own DOM cannot be affected by it. This is the only isolation
+     * that works for SIMULTANEOUSLY mounted modules (e.g. fragments side by side).
+     *
+     * What module authors must know:
+     * - Design tokens (CSS custom properties) inherit into the shadow root —
+     *   they keep working.
+     * - Selectors like `:root`, `html` or `body` do NOT match inside a shadow
+     *   root; use `:host` instead.
+     * - CSS built with the SDK (`pae-ui-sdk`) is automatically encapsulated: the
+     *   platform moves every `<style data-pae-module>` node from `document.head`
+     *   into the shadow root at mount time, including lazy chunks and HMR updates.
+     *   No extra setup needed for webpack-imported stylesheets.
+     * - If you inject styles by other means (e.g. dynamic `<style>` creation,
+     *   third-party runtime CSS-in-JS), access the shadow root via:
+     *   `usePortalContainer()?.getRootNode() as ShadowRoot | undefined`
+     * - Platform core components (Dialog, Tooltip) portal into the shadow root
+     *   automatically when the module author passes the container from
+     *   `usePortalContainer()` to the `container` prop of their portal component.
+     *   Third-party overlay libraries default to document.body: pass them the
+     *   container from `usePortalContainer()` to keep them inside the shadow root.
+     */
+    shadowDom?: boolean;
 }
 /**
  * Main function to create a PAE micro-frontend module.
@@ -12,6 +40,12 @@ export interface MicroFrontendOptions<T extends RootComponentProps> extends Sing
  *
  * All PAE micro-frontends are wrapped in PAE components that provides react context later used
  * by the provided hooks.
+ *
+ * When `shadowDom: true` is passed the module is mounted inside its own open
+ * shadow root attached to the host element supplied by the platform orchestrator,
+ * isolating it from global CSS in the light DOM. A portal container node inside
+ * the shadow root is exposed via `usePortalContainer()` so that overlay components
+ * (modals, dropdowns, tooltips) can render inside the shadow root as well.
  */
-declare const initializeMicroFrontend: <T extends RootComponentProps>({ rootComponent, ...opts }: MicroFrontendOptions<T>) => ReactAppOrParcel<T>;
+declare const initializeMicroFrontend: <T extends RootComponentProps>({ rootComponent, shadowDom, ...opts }: MicroFrontendOptions<T>) => ReactAppOrParcel<T>;
 export default initializeMicroFrontend;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bluealba/pae-ui-react-core",
-  "version": "4.6.0",
+  "version": "4.7.0-develop-423",
   "type": "module",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.esm.js",