@design-edito/tools 0.5.31 → 0.5.32

package/node/index.d.ts

@@ -1,11 +1,11 @@
-export * as awsS3 from './@aws-s3/index.js'
 export * as designEdito from './@design-edito/index.js'
 export * as express from './@express/index.js'
 export * as googleCloud from './@google-cloud/index.js'
+export * as awsS3 from './@aws-s3/index.js'
 export * as cloudStorage from './cloud-storage/index.js'
 export * as encryption from './encryption/index.js'
-export * as files from './files/index.js'
 export * as ftps from './ftps/index.js'
 export * as images from './images/index.js'
 export * as process from './process/index.js'
 export * as sftp from './sftp/index.js'
+export * as files from './files/index.js'

package/node/index.js

@@ -1,11 +1,11 @@
-export * as awsS3 from './@aws-s3/index.js'
 export * as designEdito from './@design-edito/index.js'
 export * as express from './@express/index.js'
 export * as googleCloud from './@google-cloud/index.js'
+export * as awsS3 from './@aws-s3/index.js'
 export * as cloudStorage from './cloud-storage/index.js'
 export * as encryption from './encryption/index.js'
-export * as files from './files/index.js'
 export * as ftps from './ftps/index.js'
 export * as images from './images/index.js'
 export * as process from './process/index.js'
 export * as sftp from './sftp/index.js'
+export * as files from './files/index.js'

package/node/process/index.d.ts

@@ -1,3 +1,3 @@
 export * as onExit from './on-exit/index.js'
-export * as spawner from './spawner/index.js'
 export * as promptContinue from './prompt-continue/index.js'
+export * as spawner from './spawner/index.js'

package/node/process/index.js

@@ -1,3 +1,3 @@
 export * as onExit from './on-exit/index.js'
-export * as spawner from './spawner/index.js'
 export * as promptContinue from './prompt-continue/index.js'
+export * as spawner from './spawner/index.js'

package/node/sftp/index.d.ts

@@ -1,2 +1,2 @@
-export * as directory from './directory/index.js'
 export * as file from './file/index.js'
+export * as directory from './directory/index.js'

package/node/sftp/index.js

@@ -1,2 +1,2 @@
-export * as directory from './directory/index.js'
 export * as file from './file/index.js'
+export * as directory from './directory/index.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@design-edito/tools",
-  "version": "0.5.31",
+  "version": "0.5.32",
   "description": "",
   "author": "Maxime Fabas",
   "license": "ISC",
@@ -1453,13 +1453,6 @@
     "./components/Gallery/index.js": {
       "import": "./components/Gallery/index.js"
     },
-    "./components/GalleryAlt": {
-      "import": "./components/GalleryAlt/index.js",
-      "types": "./components/GalleryAlt/index.d.ts"
-    },
-    "./components/GalleryAlt/index.js": {
-      "import": "./components/GalleryAlt/index.js"
-    },
     "./components/Iframe": {
       "import": "./components/Iframe/index.js",
       "types": "./components/Iframe/index.d.ts"

package/components/GalleryAlt/index.d.ts

@@ -1,76 +0,0 @@
-import { type FunctionComponent, type PropsWithChildren, type ReactNode } from 'react';
-import type { WithClassName } from '../utils/types.js';
-/**
- * Props for the GalleryAlt component. Same shape as {@link Gallery}, so the two swap.
- *
- * @property paddingLeft - Left padding applied to the first slot. A number is pixels.
- * Falls back to `padding`, then `0px`.
- * @property paddingRight - Right padding applied to the last slot. Same rules.
- * @property padding - Shorthand for both ends, used when a side is not set.
- * @property prevButtonContent - Content of the "previous" control. Defaults to `"prev"`.
- * @property nextButtonContent - Content of the "next" control. Defaults to `"next"`.
- * @property paginationContent - Content of each pagination item: a node used for all of
- * them, a function of the page index, or undefined to show the index.
- * @property defaultActive - Slot to scroll to at mount, in uncontrolled mode.
- * @property active - Controlled index. When set, the active slot is this one and hand
- * scrolling is disabled.
- * @property noSnap - Frees the scroll from snapping to a slot.
- * @property onPrevClicked - Fires before the gallery reacts, with the index as it was.
- * @property onNextClicked - Fires before the gallery reacts, with the index as it was.
- * @property onPaginationClicked - Fires before the gallery reacts, with the index as it
- * was and the one aimed at.
- * @property onActiveSlotChanged - Fires after the active slot changed, with the new index.
- * @property onCanGoLeftChanged - Fires after the ability to scroll further left changed.
- * Never on mount.
- * @property onCanGoRightChanged - Same, to the right.
- * @property className - Added to the root element.
- * @property children - One slot per child.
- */
-export type Props = PropsWithChildren<WithClassName<{
-    paddingLeft?: string | number;
-    paddingRight?: string | number;
-    padding?: string | number;
-    prevButtonContent?: ReactNode;
-    nextButtonContent?: ReactNode;
-    paginationContent?: ReactNode | ((page: number) => ReactNode);
-    defaultActive?: number;
-    active?: number;
-    noSnap?: boolean;
-    onPrevClicked?: (activePos: number) => void;
-    onNextClicked?: (activePos: number) => void;
-    onPaginationClicked?: (activePos: number, targetPos: number) => void;
-    onActiveSlotChanged?: (activePos: number) => void;
-    onCanGoLeftChanged?: (canGoLeft: boolean) => void;
-    onCanGoRightChanged?: (canGoRight: boolean) => void;
-}>>;
-/**
- * Horizontally scrollable gallery, told apart from {@link Gallery} by how it locates the
- * active slot.
- *
- * Geometry is measured **once per layout change** into a table of scroll positions, one
- * per slot, and the boundaries between them. A scroll event then only has to place a
- * number between two others — no element is measured while the reader scrolls.
- *
- * The same table is what the controls scroll to, so reading the active slot and moving
- * to one cannot disagree, with or without snapping.
- *
- * ### CSS elements
- * - `scroller`
- * - `slot`, `slot--active`
- * - `actions`, `prev`, `next`
- * - `pagination`, `page`, `page--active`
- *
- * Root modifiers: `controlled`, `no-snap`, `measured`, `at-first`, `at-last`,
- * `can-go-left`, `can-go-right`.
- *
- * @param props - Component properties.
- * @see {@link Props}
- * @returns A container wrapping the scroller, the two controls and the pagination.
- *
- * @remarks
- * Nothing is measured while the reader scrolls: the table is rebuilt only when a box
- * changes size or a slot is added, watched through a `ResizeObserver`. Until the first
- * measurement lands, the root carries no `measured` modifier and every slot position
- * reads as `0`.
- */
-export declare const GalleryAlt: FunctionComponent<Props>;

package/components/GalleryAlt/index.js

@@ -1,188 +0,0 @@
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { Children, useCallback, useEffect, useRef, useState } from 'react';
-import { clss } from '../../agnostic/css/clss/index.js';
-import { mergeClassNames, useChangeDispatch } from '../utils/index.js';
-import { galleryAlt as publicClassName } from '../public-classnames.js';
-import { EMPTY_GEOMETRY, measureGeometry, readActiveIndex, readReach } from './utils.js';
-import cssModule from './styles.module.css';
-/** Resolves one side's padding to a CSS length, falling back to the shorthand then to `0px`. */
-function resolvePadding(side, shorthand) {
-    const value = side ?? shorthand ?? 0;
-    return typeof value === 'number' ? `${value}px` : value;
-}
-/**
- * Horizontally scrollable gallery, told apart from {@link Gallery} by how it locates the
- * active slot.
- *
- * Geometry is measured **once per layout change** into a table of scroll positions, one
- * per slot, and the boundaries between them. A scroll event then only has to place a
- * number between two others — no element is measured while the reader scrolls.
- *
- * The same table is what the controls scroll to, so reading the active slot and moving
- * to one cannot disagree, with or without snapping.
- *
- * ### CSS elements
- * - `scroller`
- * - `slot`, `slot--active`
- * - `actions`, `prev`, `next`
- * - `pagination`, `page`, `page--active`
- *
- * Root modifiers: `controlled`, `no-snap`, `measured`, `at-first`, `at-last`,
- * `can-go-left`, `can-go-right`.
- *
- * @param props - Component properties.
- * @see {@link Props}
- * @returns A container wrapping the scroller, the two controls and the pagination.
- *
- * @remarks
- * Nothing is measured while the reader scrolls: the table is rebuilt only when a box
- * changes size or a slot is added, watched through a `ResizeObserver`. Until the first
- * measurement lands, the root carries no `measured` modifier and every slot position
- * reads as `0`.
- */
-export const GalleryAlt = ({ paddingLeft, paddingRight, padding, prevButtonContent, nextButtonContent, paginationContent, defaultActive, active, noSnap, onPrevClicked, onNextClicked, onPaginationClicked, onActiveSlotChanged, onCanGoLeftChanged, onCanGoRightChanged, children, className }) => {
-    // State & refs
-    const scrollerRef = useRef(null);
-    const geometryRef = useRef(EMPTY_GEOMETRY);
-    const [scrolledIndex, setScrolledIndex] = useState(0);
-    const [isMeasured, setIsMeasured] = useState(false);
-    const [canGoLeft, setCanGoLeft] = useState(false);
-    const [canGoRight, setCanGoRight] = useState(false);
-    const childrenCount = Children.count(children);
-    const isControlled = active !== undefined;
-    // Controlled, the prop is the answer: the class names and `data-active` say where the
-    // gallery was told to be, rather than where a smooth scroll has got to so far.
-    const activeIndex = active ?? scrolledIndex;
-    // State dispatch
-    useChangeDispatch(activeIndex, onActiveSlotChanged);
-    useChangeDispatch(canGoLeft, onCanGoLeftChanged);
-    useChangeDispatch(canGoRight, onCanGoRightChanged);
-    const readScroll = useCallback(() => {
-        const scrollerElt = scrollerRef.current;
-        if (scrollerElt === null)
-            return;
-        const { scrollLeft } = scrollerElt;
-        const geometry = geometryRef.current;
-        setScrolledIndex(readActiveIndex(geometry, scrollLeft));
-        const { canGoLeft, canGoRight } = readReach(geometry, scrollLeft);
-        setCanGoLeft(canGoLeft);
-        setCanGoRight(canGoRight);
-    }, []);
-    const measure = useCallback(() => {
-        const scrollerElt = scrollerRef.current;
-        if (scrollerElt === null)
-            return;
-        geometryRef.current = measureGeometry(scrollerElt);
-        setIsMeasured(true);
-        readScroll();
-    }, [readScroll]);
-    const scrollToSlot = useCallback((pos, smooth = true) => {
-        const scrollerElt = scrollerRef.current;
-        const offset = geometryRef.current.offsets[pos];
-        if (scrollerElt === null || offset === undefined)
-            return;
-        scrollerElt.scrollTo({ left: offset, behavior: smooth ? 'smooth' : 'instant' });
-    }, []);
-    // User actions handlers
-    const handlePrevClick = () => {
-        onPrevClicked?.(activeIndex);
-        if (isControlled)
-            return;
-        scrollToSlot(activeIndex - 1);
-    };
-    const handleNextClick = () => {
-        onNextClicked?.(activeIndex);
-        if (isControlled)
-            return;
-        scrollToSlot(activeIndex + 1);
-    };
-    const handlePaginationClick = (pos) => {
-        onPaginationClicked?.(activeIndex, pos);
-        if (isControlled)
-            return;
-        scrollToSlot(pos);
-    };
-    // Fx. dep. childrenCount - Measure, and measure again whenever a box changes size.
-    // Watching the slots and not only the scroller is what makes a late image or font
-    // land correctly, where a delay after mount could only guess.
-    useEffect(() => {
-        const scrollerElt = scrollerRef.current;
-        if (scrollerElt === null)
-            return;
-        measure();
-        const observer = new ResizeObserver(measure);
-        observer.observe(scrollerElt);
-        Array.from(scrollerElt.children).forEach(child => observer.observe(child));
-        return () => observer.disconnect();
-    }, [childrenCount, measure]);
-    // Fx. no dep. - One read per frame while scrolling, and it touches no element.
-    useEffect(() => {
-        const scrollerElt = scrollerRef.current;
-        if (scrollerElt === null)
-            return;
-        let animationFrame = null;
-        const onScroll = () => {
-            if (animationFrame !== null)
-                return;
-            animationFrame = requestAnimationFrame(() => {
-                animationFrame = null;
-                readScroll();
-            });
-        };
-        scrollerElt.addEventListener('scroll', onScroll, { passive: true });
-        return () => {
-            scrollerElt.removeEventListener('scroll', onScroll);
-            if (animationFrame !== null)
-                cancelAnimationFrame(animationFrame);
-        };
-    }, [readScroll]);
-    // Fx. no dep. - Place the gallery where it starts, once the table exists.
-    useEffect(() => {
-        const toActivate = active ?? defaultActive;
-        if (toActivate === undefined)
-            return;
-        scrollToSlot(toActivate, false);
-    }, []);
-    // Fx. dep. active - Follow the controlled index.
-    useEffect(() => {
-        if (active === undefined)
-            return;
-        scrollToSlot(active);
-    }, [active]);
-    // Rendering
-    const c = clss(publicClassName, { cssModule });
-    const rootClss = mergeClassNames(c(null, {
-        'controlled': isControlled,
-        'no-snap': noSnap === true,
-        'measured': isMeasured,
-        'at-first': activeIndex === 0,
-        'at-last': activeIndex === childrenCount - 1,
-        'can-go-left': canGoLeft,
-        'can-go-right': canGoRight
-    }), className);
-    const scrollerClss = c('scroller');
-    const actionsClss = c('actions');
-    const prevBtnClss = c('prev');
-    const nextBtnClss = c('next');
-    const paginationClss = c('pagination');
-    const dataAttributes = { 'data-active': `${activeIndex}` };
-    const actualPaddingLeft = resolvePadding(paddingLeft, padding);
-    const actualPaddingRight = resolvePadding(paddingRight, padding);
-    return _jsxs("div", { className: rootClss, ...dataAttributes, children: [_jsx("div", { className: scrollerClss, ref: scrollerRef, children: Children.map(children, (child, pos) => {
-                    const slotClss = c('slot', { active: pos === activeIndex });
-                    const style = {
-                        'margin-left': pos === 0
-                            ? actualPaddingLeft
-                            : undefined,
-                        'margin-right': pos === childrenCount - 1
-                            ? actualPaddingRight
-                            : undefined
-                    };
-                    return _jsx("div", { className: slotClss, style: { ...style }, "data-slot": pos, children: child }, pos);
-                }) }), _jsxs("div", { className: actionsClss, children: [_jsx("div", { className: prevBtnClss, onClick: handlePrevClick, children: prevButtonContent ?? 'prev' }), _jsx("div", { className: nextBtnClss, onClick: handleNextClick, children: nextButtonContent ?? 'next' })] }), _jsx("div", { className: paginationClss, children: Children.map(children, (_, pos) => {
-                    const pageClss = c('page', { active: pos === activeIndex });
-                    return _jsx("div", { className: pageClss, "data-page": pos, onClick: () => handlePaginationClick(pos), children: typeof paginationContent === 'function'
-                            ? paginationContent(pos)
-                            : paginationContent ?? pos });
-                }) })] });
-};

package/components/GalleryAlt/styles.module.css

@@ -1,33 +0,0 @@
-.scroller {
-  display: flex;
-  overflow-x: auto;
-  scroll-snap-type: x mandatory;
-  scroll-behavior: smooth;
-  -webkit-overflow-scrolling: touch;
-  scrollbar-width: none;
-  -ms-overflow-style: none;
-  scrollbar-color: transparent transparent;
-}
-
-.scroller::-webkit-scrollbar {
-  display: none;
-  height: 0;
-}
-
-.scroller::-webkit-scrollbar-track,
-.scroller::-webkit-scrollbar-thumb {
-  background: transparent;
-}
-
-.root.root--controlled .scroller {
-  overflow-x: hidden;
-}
-
-.root.root--no-snap .scroller {
-  scroll-snap-type: unset;
-  scroll-behavior: unset;
-}
-
-.slot {
-  scroll-snap-align: center;
-}

package/components/GalleryAlt/utils.d.ts

@@ -1,36 +0,0 @@
-/** The layout, measured once, so that reading the active slot touches no element. */
-export type Geometry = {
-    /** Scroll positions that bring each slot to the middle, clamped to the track. */
-    offsets: number[];
-    /** Midpoints between consecutive slot centres, in content coordinates. */
-    boundaries: number[];
-    /** Half the viewport, kept here rather than read again on every scroll. */
-    halfViewport: number;
-    /** The far end of the track. */
-    maxScroll: number;
-};
-export declare const EMPTY_GEOMETRY: Geometry;
-/**
- * Everything the gallery needs to know about its own layout.
- *
- * Positions are taken against the scroller's own box rather than `offsetLeft`, which is
- * relative to whichever ancestor happens to be positioned — so a gallery nested anywhere
- * measures the same.
- *
- * **Boundaries come from slot centres, and scroll positions are clamped.** Keeping them
- * apart is what avoids ties: two slots at the same end of the track share a scroll
- * position, but never a centre, so every slot owns a range of its own.
- */
-export declare function measureGeometry(scroller: HTMLElement): Geometry;
-/**
- * Which slot the middle of the viewport is nearest — numbers only, whatever the count.
- *
- * Same answer as walking the slots and keeping the closest centre, which is what the
- * table was built from.
- */
-export declare function readActiveIndex(geometry: Geometry, scrollLeft: number): number;
-/** Whether there is track left on each side, within {@link EDGE_TOLERANCE}. */
-export declare function readReach(geometry: Geometry, scrollLeft: number): {
-    canGoLeft: boolean;
-    canGoRight: boolean;
-};

package/components/GalleryAlt/utils.js

@@ -1,58 +0,0 @@
-/** A tolerance in px, so a sub-pixel scroll position does not read as « can still go ». */
-const EDGE_TOLERANCE = 1;
-export const EMPTY_GEOMETRY = {
-    offsets: [],
-    boundaries: [],
-    halfViewport: 0,
-    maxScroll: 0
-};
-/**
- * Everything the gallery needs to know about its own layout.
- *
- * Positions are taken against the scroller's own box rather than `offsetLeft`, which is
- * relative to whichever ancestor happens to be positioned — so a gallery nested anywhere
- * measures the same.
- *
- * **Boundaries come from slot centres, and scroll positions are clamped.** Keeping them
- * apart is what avoids ties: two slots at the same end of the track share a scroll
- * position, but never a centre, so every slot owns a range of its own.
- */
-export function measureGeometry(scroller) {
-    const { clientWidth, scrollWidth, scrollLeft } = scroller;
-    const halfViewport = clientWidth / 2;
-    const maxScroll = Math.max(0, scrollWidth - clientWidth);
-    const scrollerLeft = scroller.getBoundingClientRect().left;
-    const centers = Array.from(scroller.children).map(child => {
-        const rect = child.getBoundingClientRect();
-        return rect.left - scrollerLeft + scrollLeft + rect.width / 2;
-    });
-    return {
-        offsets: centers.map(center => Math.min(Math.max(center - halfViewport, 0), maxScroll)),
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- i is in range by construction, centers[i] sits before the one being mapped
-        boundaries: centers.slice(1).map((center, i) => (centers[i] + center) / 2),
-        halfViewport,
-        maxScroll
-    };
-}
-/**
- * Which slot the middle of the viewport is nearest — numbers only, whatever the count.
- *
- * Same answer as walking the slots and keeping the closest centre, which is what the
- * table was built from.
- */
-export function readActiveIndex(geometry, scrollLeft) {
-    const { boundaries, halfViewport } = geometry;
-    const viewportCenter = scrollLeft + halfViewport;
-    let index = 0;
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- index is bounded by the loop condition
-    while (index < boundaries.length && viewportCenter > boundaries[index])
-        index += 1;
-    return index;
-}
-/** Whether there is track left on each side, within {@link EDGE_TOLERANCE}. */
-export function readReach(geometry, scrollLeft) {
-    return {
-        canGoLeft: scrollLeft > EDGE_TOLERANCE,
-        canGoRight: scrollLeft < geometry.maxScroll - EDGE_TOLERANCE
-    };
-}