@docusaurus/plugin-ideal-image 3.10.2 → 4.0.0-canary-6809

package/lib/index.js

@@ -52,7 +52,7 @@ function pluginIdealImage(context, options) {
                                     options: {
                                         // Don't emit for server-side rendering
                                         emitFile: !isServer,
-                                        // eslint-disable-next-line global-require
+                                        // eslint-disable-next-line @typescript-eslint/no-require-imports
                                         adapter: require('@docusaurus/responsive-loader/sharp'),
                                         name: 'assets/ideal-img/[name].[hash:hex:7].[width].[ext]',
                                         ...loaderOptions,

package/lib/theme/IdealImageLegacy/components/Icon/Download.d.ts

@@ -1,3 +1,3 @@
-export default Download;
-declare function Download(props: any): React.JSX.Element;
 import React from 'react';
+declare const Download: (props: any) => React.JSX.Element;
+export default Download;

package/lib/theme/IdealImageLegacy/components/Icon/Loading.d.ts

@@ -1,3 +1,3 @@
-export default Loading;
-declare function Loading(props: any): React.JSX.Element;
 import React from 'react';
+declare const Loading: (props: any) => React.JSX.Element;
+export default Loading;

package/lib/theme/IdealImageLegacy/components/Icon/Offline.d.ts

@@ -1,3 +1,3 @@
-export default Offline;
-declare function Offline(props: any): React.JSX.Element;
 import React from 'react';
+declare const Offline: (props: any) => React.JSX.Element;
+export default Offline;

package/lib/theme/IdealImageLegacy/components/Icon/Warning.d.ts

@@ -1,3 +1,3 @@
-export default Warning;
-declare function Warning(props: any): React.JSX.Element;
 import React from 'react';
+declare const Warning: (props: any) => React.JSX.Element;
+export default Warning;

package/lib/theme/IdealImageLegacy/components/Icon/index.d.ts

@@ -1,8 +1,8 @@
-export default Icon;
-declare function Icon({ size, fill, className, path }: {
-    size?: number | undefined;
-    fill?: string | undefined;
+import React from 'react';
+declare const Icon: ({ size, fill, className, path }: {
     className: any;
+    fill?: string | undefined;
     path: any;
-}): React.JSX.Element;
-import React from 'react';
+    size?: number | undefined;
+}) => React.JSX.Element;
+export default Icon;

package/lib/theme/IdealImageLegacy/components/IdealImage/index.d.ts

@@ -1,16 +1,13 @@
-export default class IdealImage extends React.Component<any, any, any> {
-    static defaultProps: {
-        shouldAutoDownload: ({ connection, size, threshold, possiblySlowNetwork, }: {
-            connection: any;
-            size: any;
-            threshold: any;
-            possiblySlowNetwork: any;
-        }) => boolean;
-        getMessage: (icon: any, state: any) => "Loading..." | "Your browser is offline. Image not loaded" | "404. Image not found" | "Error. Click to reload" | (string | React.JSX.Element)[] | "Click to load" | null;
-        getIcon: (state: any) => string;
-        loader: string;
-    };
-    constructor(props: any);
+import React, { Component } from 'react';
+declare const defaultShouldAutoDownload: ({ connection, size, threshold, possiblySlowNetwork, }: {
+    connection: any;
+    possiblySlowNetwork: any;
+    size: any;
+    threshold: any;
+}) => boolean;
+declare const defaultGetMessage: (icon: any, state: any) => "404. Image not found" | "Click to load" | "Error. Click to reload" | "Loading..." | "Your browser is offline. Image not loaded" | (string | React.JSX.Element)[] | null;
+declare const defaultGetIcon: (state: any) => string;
+export default class IdealImage extends Component {
     state: {
         loadState: string;
         connection: {
@@ -24,14 +21,21 @@ export default class IdealImage extends React.Component<any, any, any> {
         userTriggered: boolean;
         possiblySlowNetwork: boolean;
     };
-    componentDidMount(): void;
     updateConnection: (() => void) | undefined;
     possiblySlowNetworkListener: ((e: any) => void) | undefined;
     updateOnlineStatus: (() => void) | undefined;
+    loader: Promise<any> | undefined;
+    constructor(props: any);
+    static defaultProps: {
+        shouldAutoDownload: typeof defaultShouldAutoDownload;
+        getMessage: typeof defaultGetMessage;
+        getIcon: typeof defaultGetIcon;
+        loader: string;
+    };
+    componentDidMount(): void;
     componentWillUnmount(): void;
     onClick: () => void;
     clear(): void;
-    loader: Promise<any> | undefined;
     cancel(userTriggered: any): void;
     loadStateChange(loadState: any, userTriggered: any, loadInfo?: null): void;
     load: (userTriggered: any) => void;
@@ -39,4 +43,4 @@ export default class IdealImage extends React.Component<any, any, any> {
     onLeave: () => void;
     render(): React.JSX.Element;
 }
-import React from 'react';
+export {};

package/lib/theme/IdealImageLegacy/components/IdealImage/waypoint.d.ts

@@ -6,5 +6,5 @@ type Props = {
     onLeave: () => void;
     children: ReactNode;
 };
-export declare function Waypoint(props: Props): string | number | bigint | boolean | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | React.JSX.Element | null | undefined;
+export declare function Waypoint(props: Props): string | number | bigint | boolean | React.JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | Iterable<ReactNode> | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | React.ReactPortal | null | undefined> | null | undefined;
 export {};

package/lib/theme/IdealImageLegacy/components/IdealImageWithDefaults/index.d.ts

@@ -1,5 +1,5 @@
-export default IdealImageWithDefaults;
-declare function IdealImageWithDefaults({ icons: iconsProp, theme: themeProp, ...props }: {
+import React from 'react';
+declare const IdealImageWithDefaults: ({ icons: iconsProp, theme: themeProp, ...props }: {
     [x: string]: any;
     icons?: {
         [x: string]: ((props: any) => React.JSX.Element) | null;
@@ -29,5 +29,5 @@ declare function IdealImageWithDefaults({ icons: iconsProp, theme: themeProp, ..
             left: number;
         };
     } | undefined;
-}): React.JSX.Element;
-import React from 'react';
+}) => React.JSX.Element;
+export default IdealImageWithDefaults;

package/lib/theme/IdealImageLegacy/components/Media/index.d.ts

@@ -1,20 +1,20 @@
-export default class Media extends React.PureComponent<any, any, any> {
+import React, { PureComponent } from 'react';
+export default class Media extends PureComponent {
+    state: {
+        isMounted: boolean;
+    };
+    dimensionElement: SVGSVGElement | null | undefined;
     static defaultProps: {
         iconColor: string;
         iconSize: number;
     };
     constructor(props: any);
-    state: {
-        isMounted: boolean;
-    };
     componentDidMount(): void;
     renderIcon(props: any): React.DetailedReactHTMLElement<{
         className: string;
         style: object;
     }, HTMLElement> | null;
     renderImage(props: any): React.JSX.Element;
-    dimensionElement: SVGSVGElement | null | undefined;
     renderNoscript(props: any): React.JSX.Element | null;
     render(): React.JSX.Element;
 }
-import React from 'react';

package/lib/theme/IdealImageLegacy/components/MediaWithDefaults/index.d.ts

@@ -1,5 +1,5 @@
-export default MediaWithDefaults;
-declare function MediaWithDefaults({ icons: iconsProp, theme: themeProp, ...props }: {
+import React from 'react';
+declare const MediaWithDefaults: ({ icons: iconsProp, theme: themeProp, ...props }: {
     [x: string]: any;
     icons?: {
         [x: string]: ((props: any) => React.JSX.Element) | null;
@@ -29,5 +29,5 @@ declare function MediaWithDefaults({ icons: iconsProp, theme: themeProp, ...prop
             left: number;
         };
     } | undefined;
-}): React.JSX.Element;
-import React from 'react';
+}) => React.JSX.Element;
+export default MediaWithDefaults;

package/lib/theme/IdealImageLegacy/components/composeStyle.d.ts

@@ -1,5 +1,23 @@
+export default _default;
+/**
+ * Composes styles and/or classes
+ *
+ * For classes it will concat them in in one string
+ * and return as `className` property.
+ * Alternative is https://github.com/JedWatson/classnames
+ *
+ * For objects it will merge them in one object
+ * and return as `style` property.
+ *
+ * Usage:
+ * Assume you have `theme` object, which can be css-module
+ * or object or other css-in-js compatible with css-module
+ *
+ * <a {...compose(theme.link, theme.active, {color: "#000"})}>link</a>
+ *
+ * @returns {{className: string, style: object}} - params for React component
+ */
 declare function _default(...stylesOrClasses: any[]): {
     className: string;
     style: object;
 };
-export default _default;

package/lib/theme/IdealImageLegacy/components/constants.d.ts

@@ -1,22 +1,14 @@
-export namespace icons {
-    export { load };
-    export { loading };
-    export { loaded };
-    export { error };
-    export { noicon };
-    export { offline };
-}
-export namespace loadStates {
-    export { initial };
-    export { loading };
-    export { loaded };
-    export { error };
-}
-declare const load: "load";
-declare const loading: "loading";
-declare const loaded: "loaded";
-declare const error: "error";
-declare const noicon: "noicon";
-declare const offline: "offline";
-declare const initial: "initial";
-export {};
+export declare const icons: {
+    load: string;
+    loading: string;
+    loaded: string;
+    error: string;
+    noicon: string;
+    offline: string;
+};
+export declare const loadStates: {
+    initial: string;
+    loading: string;
+    loaded: string;
+    error: string;
+};

package/lib/theme/IdealImageLegacy/components/helpers.d.ts

@@ -1,17 +1,17 @@
-export const ssr: boolean;
-export const nativeConnection: boolean;
-export function guessMaxImageWidth(dimensions: any, w: any): number;
-export function bytesToSize(bytes: any): string;
-export const supportsWebp: boolean;
-export function selectSrc({ srcSet, maxImageWidth, supportsWebp }: {
-    srcSet: any;
+export declare const ssr: boolean;
+export declare const nativeConnection: boolean;
+export declare const guessMaxImageWidth: (dimensions: any, w: any) => number;
+export declare const bytesToSize: (bytes: any) => string;
+export declare const supportsWebp: boolean;
+export declare const selectSrc: ({ srcSet, maxImageWidth, supportsWebp }: {
     maxImageWidth: any;
-    supportsWebp: any;
-}): any;
-export function fallbackParams({ srcSet, getUrl }: {
     srcSet: any;
+    supportsWebp: any;
+}) => any;
+export declare const fallbackParams: ({ srcSet, getUrl }: {
     getUrl: any;
-}): {
+    srcSet: any;
+}) => {
     nsSrcSet?: undefined;
     nsSrc?: undefined;
     ssr?: undefined;

package/lib/theme/IdealImageLegacy/components/icons.d.ts

@@ -1,15 +1,14 @@
+import DownloadIcon from './Icon/Download';
+import OfflineIcon from './Icon/Offline';
+import WarningIcon from './Icon/Warning';
+import LoadingIcon from './Icon/Loading';
+declare const load: string, loading: string, loaded: string, error: string, noicon: string, offline: string;
 declare const _default: {
-    [load]: (props: any) => import("react").JSX.Element;
-    [loading]: (props: any) => import("react").JSX.Element;
+    [load]: typeof DownloadIcon;
+    [loading]: typeof LoadingIcon;
     [loaded]: null;
-    [error]: (props: any) => import("react").JSX.Element;
+    [error]: typeof WarningIcon;
     [noicon]: null;
-    [offline]: (props: any) => import("react").JSX.Element;
+    [offline]: typeof OfflineIcon;
 };
 export default _default;
-declare const load: string;
-declare const loading: string;
-declare const loaded: string;
-declare const error: string;
-declare const noicon: string;
-declare const offline: string;

package/lib/theme/IdealImageLegacy/components/loaders.d.ts

@@ -1,4 +1,11 @@
-export function combineCancel(p1: Promise<any>, p2: Promise<any>): Promise<any>;
-export function timeout(threshold: any): Promise<any>;
-export function imageLoader(src: any): Promise<any>;
-export function xhrLoader(url: any, options: any): Promise<any>;
+/**
+ * returns new "promise" with cancel function combined
+ *
+ * @param {Promise} p1 - first "promise" with cancel
+ * @param {Promise} p2 - second "promise" with cancel
+ * @returns {Promise} - new "promise" with cancel
+ */
+export declare const combineCancel: (p1: Promise<any>, p2: Promise<any>) => Promise<any>;
+export declare const timeout: (threshold: any) => Promise<any>;
+export declare const imageLoader: (src: any) => Promise<any>;
+export declare const xhrLoader: (url: any, options: any) => Promise<any>;

package/lib/theme/IdealImageLegacy/components/theme.d.ts

@@ -1,30 +1,26 @@
-declare namespace _default {
-    namespace placeholder {
-        let backgroundSize: string;
-        let backgroundRepeat: string;
-        let position: string;
-    }
-    namespace img {
-        let width: string;
-        let height: string;
-        let maxWidth: string;
-        let marginBottom: string;
-    }
-    namespace icon {
-        let position_1: string;
-        export { position_1 as position };
-        export let top: string;
-        export let left: string;
-        export let transform: string;
-        export let textAlign: string;
-    }
-    namespace noscript {
-        let position_2: string;
-        export { position_2 as position };
-        let top_1: number;
-        export { top_1 as top };
-        let left_1: number;
-        export { left_1 as left };
-    }
-}
+declare const _default: {
+    placeholder: {
+        backgroundSize: string;
+        backgroundRepeat: string;
+        position: string;
+    };
+    img: {
+        width: string;
+        height: string;
+        maxWidth: string;
+        marginBottom: string;
+    };
+    icon: {
+        position: string;
+        top: string;
+        left: string;
+        transform: string;
+        textAlign: string;
+    };
+    noscript: {
+        position: string;
+        top: number;
+        left: number;
+    };
+};
 export default _default;

package/lib/theme/IdealImageLegacy/components/unfetch.d.ts

@@ -1,7 +1,8 @@
-export class UnfetchAbortController {
+export declare class UnfetchAbortController {
     signal: {
         onabort: () => void;
     };
     abort: () => void;
+    constructor();
 }
-export function unfetch(url: any, options: any): Promise<any>;
+export declare const unfetch: (url: any, options: any) => Promise<any>;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@docusaurus/plugin-ideal-image",
-  "version": "3.10.2",
+  "version": "4.0.0-canary-6809",
   "description": "Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).",
   "main": "lib/index.js",
   "types": "src/plugin-ideal-image.d.ts",
   "scripts": {
-    "build": "tsc --build && node ../../admin/scripts/copyUntypedFiles.js && prettier --config ../../.prettierrc --write \"lib/theme/**/*.js\"",
+    "build": "tsc --build && node ../../admin/scripts/copyUntypedFiles.js && oxfmt \"lib/theme/**/*.js\"",
     "watch": "run-p -c copy:watch build:watch",
     "build:watch": "tsc --build --watch",
     "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
@@ -20,24 +20,24 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.10.2",
-    "@docusaurus/lqip-loader": "3.10.2",
-    "@docusaurus/responsive-loader": "^1.7.0",
-    "@docusaurus/theme-translations": "3.10.2",
-    "@docusaurus/types": "3.10.2",
-    "@docusaurus/utils-validation": "3.10.2",
-    "sharp": "^0.32.3",
-    "tslib": "^2.6.0",
-    "webpack": "^5.88.1"
+    "@docusaurus/core": "4.0.0-canary-6809",
+    "@docusaurus/lqip-loader": "4.0.0-canary-6809",
+    "@docusaurus/responsive-loader": "^1.7.1",
+    "@docusaurus/theme-translations": "4.0.0-canary-6809",
+    "@docusaurus/types": "4.0.0-canary-6809",
+    "@docusaurus/utils-validation": "4.0.0-canary-6809",
+    "sharp": "^0.35.1",
+    "tslib": "^2.8.1",
+    "webpack": "^5.110.3"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.10.2",
-    "fs-extra": "^11.1.0"
+    "@docusaurus/module-type-aliases": "4.0.0-canary-6809",
+    "fs-extra": "^11.4.0"
   },
   "peerDependencies": {
-    "jimp": "*",
-    "react": "^18.0.0 || ^19.0.0",
-    "react-dom": "^18.0.0 || ^19.0.0"
+    "jimp": "^1.6.1",
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0"
   },
   "peerDependenciesMeta": {
     "jimp": {
@@ -45,7 +45,7 @@
     }
   },
   "engines": {
-    "node": ">=20.0"
+    "node": ">=24.14"
   },
-  "gitHead": "f37f9035584917a97a260b91fc2842cba4f8b94f"
+  "gitHead": "db942b07f3529b5359bcae27ab3796cb07dec10e"
 }

package/src/index.ts

@@ -67,7 +67,7 @@ export default function pluginIdealImage(
                   options: {
                     // Don't emit for server-side rendering
                     emitFile: !isServer,
-                    // eslint-disable-next-line global-require
+                    // eslint-disable-next-line @typescript-eslint/no-require-imports
                     adapter: require('@docusaurus/responsive-loader/sharp'),
                     name: 'assets/ideal-img/[name].[hash:hex:7].[width].[ext]',
                     ...loaderOptions,

package/src/plugin-ideal-image.d.ts

@@ -118,8 +118,10 @@ declare module '@theme/IdealImageLegacy' {
 
   type ThemeKey = 'placeholder' | 'img' | 'icon' | 'noscript';
 
-  export interface ImageProps
-    extends Omit<ComponentProps<'img'>, 'srcSet' | 'placeholder'> {
+  export interface ImageProps extends Omit<
+    ComponentProps<'img'>,
+    'srcSet' | 'placeholder'
+  > {
     /**
      * This function decides what icon to show based on the current state of the
      * component.