center-center 0.1.65 → 0.1.67

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "center-center",
-  "version": "0.1.65",
+  "version": "0.1.67",
   "description": "Position an element at the center center of a container",
   "main": "./src/index.mjs",
   "type": "module",
@@ -27,7 +27,7 @@
   },
   "devDependencies": {
     "@sequencemedia/eslint-config-standard": "^0.2.43",
-    "@sequencemedia/eslint-config-typescript": "^0.1.62",
+    "@sequencemedia/eslint-config-typescript": "^0.1.63",
     "@sequencemedia/process": "^0.0.15",
     "@types/chai": "^5.2.0",
     "@types/debug": "^4.1.12",
@@ -35,7 +35,7 @@
     "@types/mocha": "^10.0.10",
     "chai": "^5.2.0",
     "cross-env": "^7.0.3",
-    "eslint": "^9.22.0",
+    "eslint": "^9.23.0",
     "express": "^4.21.2",
     "globals": "^16.0.0",
     "husky": "^9.1.7",

package/src/common/index.d.mts

@@ -8,7 +8,7 @@ declare namespace CenterCenterTypes {
   }
 
   /**
-   * A Center Center `Rect`
+   *  A Center Center `Rect`
    */
   export interface CenterCenterRect {
     left: number
@@ -20,7 +20,7 @@ declare namespace CenterCenterTypes {
   }
 
   /**
-   * Center Center `Rects`
+   *  Center Center `Rects`
    */
   export interface CenterCenterRects {
     viewport: CenterCenterRect

package/src/common/index.mjs

@@ -1,13 +1,13 @@
 /**
- * @typedef {import('center-center/common').ScrollingElement} ScrollingElement
- * @typedef {import('center-center/common').CenterCenterRect} CenterCenterRect
- * @typedef {import('center-center/common').CenterCenterRects} CenterCenterRects
+ *  @typedef {import('center-center/common').ScrollingElement} ScrollingElement
+ *  @typedef {import('center-center/common').CenterCenterRect} CenterCenterRect
+ *  @typedef {import('center-center/common').CenterCenterRects} CenterCenterRects
  */
 
 /**
- * Gets the document `scrollingElement` (or a valid alternative)
+ *  Gets the document `scrollingElement` (or a valid alternative)
  *
- * @returns {ScrollingElement}
+ *  @returns {ScrollingElement}
  */
 export function getScrollingElement () {
   if ('scrollingElement' in document) { // (Reflect.has(document, 'scrollingElement')) {
@@ -22,9 +22,9 @@ export function getScrollingElement () {
 }
 
 /**
- * Creates a `Rect` for the viewport
+ *  Creates a `Rect` for the viewport
  *
- * @returns {CenterCenterRect}
+ *  @returns {CenterCenterRect}
  */
 export function createViewportRect () {
   const {
@@ -48,10 +48,10 @@ export function createViewportRect () {
 }
 
 /**
- * Creates a `Rect` for a DOM element
+ *  Creates a `Rect` for a DOM element
  *
- * @param {Element} element
- * @returns {CenterCenterRect}
+ *  @param {Element} element
+ *  @returns {CenterCenterRect}
 */
 export function createDOMElementRect (element) {
   const {
@@ -80,10 +80,10 @@ export function createDOMElementRect (element) {
 }
 
 /**
- * Creates a `Rect` for an SVG element
+ *  Creates a `Rect` for an SVG element
  *
- * @param {SVGGraphicsElement} element
- * @returns {CenterCenterRect}
+ *  @param {SVGGraphicsElement} element
+ *  @returns {CenterCenterRect}
 */
 export function createSVGElementRect (element) {
   const {
@@ -104,14 +104,14 @@ export function createSVGElementRect (element) {
 }
 
 /**
- * Creates a collection of `Rects` describing
- *  1. The viewport
- *  2. The DOM container element
- *  3. The DOM target element
+ *  Creates a collection of `Rects` describing
+ *    1. The viewport
+ *    2. The DOM container element
+ *    3. The DOM target element
  *
- * @param {Element} container
- * @param {Element} target
- * @returns {CenterCenterRects}
+ *  @param {Element} container
+ *  @param {Element} target
+ *  @returns {CenterCenterRects}
  */
 export function createDOMRects (container, target) {
   return {
@@ -122,14 +122,14 @@ export function createDOMRects (container, target) {
 }
 
 /**
- * Creates a collection of `Rects` describing
- *  1. The viewport
- *  2. The DOM container element
- *  3. The SVG target element
+ *  Creates a collection of `Rects` describing
+ *    1. The viewport
+ *    2. The DOM container element
+ *    3. The SVG target element
  *
- * @param {Element} container
- * @param {SVGGraphicsElement} target
- * @returns {CenterCenterRects}
+ *  @param {Element} container
+ *  @param {SVGGraphicsElement} target
+ *  @returns {CenterCenterRects}
  */
 export function createSVGRects (container, target) {
   return {
@@ -140,102 +140,102 @@ export function createSVGRects (container, target) {
 }
 
 /**
- * Destructures the `left` field from a `Rect`
+ *  Destructures the `left` field from a `Rect`
  *
- * @param {CenterCenterRect} rect
- * @returns {number}
+ *  @param {CenterCenterRect} rect
+ *  @returns {number}
  */
 export function getRectLeft ({ left }) {
   return left
 }
 
 /**
- * Destructures the `top` field from a `Rect`
+ *  Destructures the `top` field from a `Rect`
  *
- * @param {CenterCenterRect} rect
- * @returns {number}
+ *  @param {CenterCenterRect} rect
+ *  @returns {number}
  */
 export function getRectTop ({ top }) {
   return top
 }
 
 /**
- * Destructures the `width` field from a `Rect`
+ *  Destructures the `width` field from a `Rect`
  *
- * @param {CenterCenterRect} rect
- * @returns {number}
+ *  @param {CenterCenterRect} rect
+ *  @returns {number}
  */
 export function getRectWidth ({ width }) {
   return width
 }
 
 /**
- * Destructures the `height` field from a `Rect`
+ *  Destructures the `height` field from a `Rect`
  *
- * @param {CenterCenterRect} rect
- * @returns {number}
+ *  @param {CenterCenterRect} rect
+ *  @returns {number}
  */
 export function getRectHeight ({ height }) {
   return height
 }
 
 /**
- * Destructures the viewport `Rect` from a collection of `Rects`
+ *  Destructures the viewport `Rect` from a collection of `Rects`
  *
- * @param {CenterCenterRects} rects
- * @returns {CenterCenterRect}
+ *  @param {CenterCenterRects} rects
+ *  @returns {CenterCenterRect}
  */
 export function getViewportRect ({ viewport }) {
   return viewport
 }
 
 /**
- * Destructures the container `Rect` from a collection of `Rects`
+ *  Destructures the container `Rect` from a collection of `Rects`
  *
- * @param {CenterCenterRects} rects
- * @returns {CenterCenterRect}
+ *  @param {CenterCenterRects} rects
+ *  @returns {CenterCenterRect}
  */
 export function getContainerRect ({ container }) {
   return container
 }
 
 /**
- * Destructures the target `Rect` from a collection of `Rects`
+ *  Destructures the target `Rect` from a collection of `Rects`
  *
- * @param {CenterCenterRects} rects
- * @returns {CenterCenterRect}
+ *  @param {CenterCenterRects} rects
+ *  @returns {CenterCenterRect}
  */
 export function getTargetRect ({ target }) {
   return target
 }
 
 /**
- * Calculates the `x` coordinate of a `Rect`
+ *  Calculates the `x` coordinate of a `Rect`
  *
- * @param {CenterCenterRect} rect
- * @returns {number}
+ *  @param {CenterCenterRect} rect
+ *  @returns {number}
  */
 export function calculateRectX ({ left: l, width: w }) {
   return (l + (w / 2))
 }
 
 /**
- * Calculates the `y` coordinate of a `Rect`
+ *  Calculates the `y` coordinate of a `Rect`
  *
- * @param {CenterCenterRect} rect
- * @returns {number}
+ *  @param {CenterCenterRect} rect
+ *  @returns {number}
  */
 export function calculateRectY ({ top: t, height: h }) {
   return (t + (h / 2))
 }
 
 /**
- * Calculates the right-most boundary `x` coordinate of the target in the container
+ *  Calculates the right-most boundary `x` coordinate of the target in the container
  *
- * The range is inclusive from left-most 0 to right-most boundary `x`
+ *  The range is inclusive from left-most 0 to right-most boundary `x`
  *
- * @param {CenterCenterRects} rects
- * @returns {number}
+ *  @param {CenterCenterRects} rects
+ *  @returns {number}
  */
 export function calculateBoundaryX (rects) {
   const containerW = getRectWidth(getContainerRect(rects))
@@ -245,12 +245,12 @@ export function calculateBoundaryX (rects) {
 }
 
 /**
- * Calculates the bottom-most boundary `y` coordinate of the target in the container
+ *  Calculates the bottom-most boundary `y` coordinate of the target in the container
  *
- * The range is inclusive from top-most 0 to bottom-most boundary `y`
+ *  The range is inclusive from top-most 0 to bottom-most boundary `y`
  *
- * @param {CenterCenterRects} rects
- * @returns {number}
+ *  @param {CenterCenterRects} rects
+ *  @returns {number}
  */
 export function calculateBoundaryY (rects) {
   const containerH = getRectHeight(getContainerRect(rects))
@@ -260,10 +260,10 @@ export function calculateBoundaryY (rects) {
 }
 
 /**
- * Calculates the `x` coordinate of the container
+ *  Calculates the `x` coordinate of the container
  *
- * @param {CenterCenterRects} rects
- * @returns {number}
+ *  @param {CenterCenterRects} rects
+ *  @returns {number}
  */
 export function calculateContainerX ({
   viewport: {
@@ -284,10 +284,10 @@ export function calculateContainerX ({
 }
 
 /**
- * Calculates the `y` coordinate of the container
+ *  Calculates the `y` coordinate of the container
  *
- * @param {CenterCenterRects} rects
- * @returns {number}
+ *  @param {CenterCenterRects} rects
+ *  @returns {number}
  */
 export function calculateContainerY ({
   viewport: {
@@ -308,10 +308,10 @@ export function calculateContainerY ({
 }
 
 /**
- * Calculates the `x` coordinate of the target
+ *  Calculates the `x` coordinate of the target
  *
- * @param {CenterCenterRects} rects
- * @returns {number}
+ *  @param {CenterCenterRects} rects
+ *  @returns {number}
  */
 export function calculateTargetX (rects) {
   const x = calculateContainerX(rects)
@@ -321,10 +321,10 @@ export function calculateTargetX (rects) {
 }
 
 /**
- * Calculates the `y` coordinate of the target
+ *  Calculates the `y` coordinate of the target
  *
- * @param {CenterCenterRects} rects
- * @returns {number}
+ *  @param {CenterCenterRects} rects
+ *  @returns {number}
  */
 export function calculateTargetY (rects) {
   const y = calculateContainerY(rects)

package/src/dom/index.mjs

@@ -1,5 +1,5 @@
 /**
- * @typedef {import('center-center/common').CenterCenterRects} CenterCenterRects
+ *  @typedef {import('center-center/common').CenterCenterRects} CenterCenterRects
  */
 
 import {
@@ -14,10 +14,10 @@ export {
 } from '#center-center/common'
 
 /**
- * Calculates the target `left` position
+ *  Calculates the target `left` position
  *
- * @param {CenterCenterRects} rects
- * @returns {number}
+ *  @param {CenterCenterRects} rects
+ *  @returns {number}
  */
 export function calculateLeft (rects) {
   const boundary = calculateBoundaryX(rects)
@@ -29,10 +29,10 @@ export function calculateLeft (rects) {
 }
 
 /**
- * Calculates the target `top` position
+ *  Calculates the target `top` position
  *
- * @param {CenterCenterRects} rects
- * @returns {number}
+ *  @param {CenterCenterRects} rects
+ *  @returns {number}
  */
 export function calculateTop (rects) {
   const boundary = calculateBoundaryY(rects)

package/src/svg/index.mjs

@@ -1,5 +1,5 @@
 /**
- * @typedef {import('center-center/common').CenterCenterRects} CenterCenterRects
+ *  @typedef {import('center-center/common').CenterCenterRects} CenterCenterRects
  */
 
 import {
@@ -18,12 +18,12 @@ export {
 } from '#center-center/common'
 
 /**
- * Calculates the target `x` position
+ *  Calculates the target `x` position
  *
- * @param {CenterCenterRects} rects
- * @param {number | undefined} viewBoxW
- * @param {number | undefined} scale
- * @returns {number}
+ *  @param {CenterCenterRects} rects
+ *  @param {number | undefined} viewBoxW
+ *  @param {number | undefined} scale
+ *  @returns {number}
  */
 export function calculateX (rects, viewBoxW = 0, scale = 1) {
   const w = getRectWidth(getContainerRect(rects))
@@ -36,12 +36,12 @@ export function calculateX (rects, viewBoxW = 0, scale = 1) {
 }
 
 /**
- * Calculates the target `y` position
+ *  Calculates the target `y` position
  *
- * @param {CenterCenterRects} rects
- * @param {number | undefined} viewBoxH
- * @param {number | undefined} scale
- * @returns {number}
+ *  @param {CenterCenterRects} rects
+ *  @param {number | undefined} viewBoxH
+ *  @param {number | undefined} scale
+ *  @returns {number}
  */
 export function calculateY (rects, viewBoxH = 0, scale = 1) {
   const h = getRectHeight(getContainerRect(rects))

package/src/svg/view-box/index.mjs

@@ -14,10 +14,10 @@ export const W = 2
 export const H = 3
 
 /**
- * Transforms a string to a round number
+ *  Transforms a string to a round number
  *
- * @param {string} s
- * @returns {number}
+ *  @param {string} s
+ *  @returns {number}
  */
 function toRound (s) {
   return (
@@ -26,10 +26,10 @@ function toRound (s) {
 }
 
 /**
- * Get the number at position `H` for the SVG element `viewBox` attribute
+ *  Get the number at position `H` for the SVG element `viewBox` attribute
  *
- * @param {Element} svg
- * @returns {number}
+ *  @param {Element} svg
+ *  @returns {number}
  */
 export function getXFor (svg) {
   return (
@@ -38,10 +38,10 @@ export function getXFor (svg) {
 }
 
 /**
- * Get the number at position `H` for the SVG element `viewBox` attribute
+ *  Get the number at position `H` for the SVG element `viewBox` attribute
  *
- * @param {Element} svg
- * @returns {number}
+ *  @param {Element} svg
+ *  @returns {number}
  */
 export function getYFor (svg) {
   return (
@@ -50,10 +50,10 @@ export function getYFor (svg) {
 }
 
 /**
- * Get the number at position `H` for the SVG element `viewBox` attribute
+ *  Get the number at position `H` for the SVG element `viewBox` attribute
  *
- * @param {Element} svg
- * @returns {number}
+ *  @param {Element} svg
+ *  @returns {number}
  */
 export function getWFor (svg) {
   return (
@@ -62,10 +62,10 @@ export function getWFor (svg) {
 }
 
 /**
- * Get the number at position `H` for the SVG element `viewBox` attribute
+ *  Get the number at position `H` for the SVG element `viewBox` attribute
  *
- * @param {Element} svg
- * @returns {number}
+ *  @param {Element} svg
+ *  @returns {number}
  */
 export function getHFor (svg) {
   return (
@@ -74,50 +74,50 @@ export function getHFor (svg) {
 }
 
 /**
- * Get the number at position `X`
+ *  Get the number at position `X`
  *
- * @param {number[]}
- * @returns {number}
+ *  @param {number[]}
+ *  @returns {number}
  */
 export function getX ({ [X]: x = 0 }) {
   return x
 }
 
 /**
- * Get the number at position `Y`
+ *  Get the number at position `Y`
  *
- * @param {number[]}
- * @returns {number}
+ *  @param {number[]}
+ *  @returns {number}
  */
 export function getY ({ [Y]: y = 0 }) {
   return y
 }
 
 /**
- * Get the number at position `W`
+ *  Get the number at position `W`
  *
- * @param {number[]}
- * @returns {number}
+ *  @param {number[]}
+ *  @returns {number}
  */
 export function getW ({ [W]: w = 0 }) {
   return w
 }
 
 /**
- * Get the number at position `H`
+ *  Get the number at position `H`
  *
- * @param {number[]}
- * @returns {number}
+ *  @param {number[]}
+ *  @returns {number}
  */
 export function getH ({ [H]: h = 0 }) {
   return h
 }
 
 /**
- * Get an SVG element `viewBox` attribute as an array of numbers
+ *  Get an SVG element `viewBox` attribute as an array of numbers
  *
- * @param {Element} svg
- * @returns {number[]}
+ *  @param {Element} svg
+ *  @returns {number[]}
  */
 export default function getViewBox (svg) {
   log('getViewBox')