chore: enforce types used by API to be exported

Author: stropitek

.github/workflows/typedoc.yml

@@ -1,10 +1,11 @@
-name: Deploy TypeDoc on GitHub pages
+name: Typedoc
 
 on:
   workflow_dispatch:
   push:
     branches:
       - main
+  pull_request:
 
 env:
   NODE_VERSION: 18.x
@@ -24,7 +25,10 @@ jobs:
         uses: zakodium/typedoc-action@v2
         with:
           entry: ${{ env.ENTRY_FILE }}
+          name: ImageJS
+          treatWarningsAsErrors: ${{ github.ref != 'refs/heads/main' }}
       - name: Deploy to GitHub pages
+        if: github.ref == 'refs/heads/main'
         uses: JamesIves/github-pages-deploy-action@releases/v4
         with:
           token: ${{ secrets.BOT_TOKEN }}

package.json

@@ -67,8 +67,8 @@
     "@microsoft/api-extractor": "^7.38.2",
     "@tailwindcss/forms": "^0.5.6",
     "@types/jest": "^29.5.7",
-    "@types/js-priority-queue": "^0.0.8",
     "@types/jest-image-snapshot": "^6.2.2",
+    "@types/js-priority-queue": "^0.0.8",
     "@types/node": "^20.8.10",
     "@types/picomatch": "^2.3.2",
     "@types/react": "^18.2.34",
@@ -88,7 +88,7 @@
     "jest-image-snapshot": "^6.2.0",
     "jest-matcher-deep-close-to": "^3.0.2",
     "postcss": "^8.4.31",
-    "prettier": "^3.0.3",
+    "prettier": "^3.1.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "react-router-dom": "^6.18.0",

src/Image.ts

@@ -1,54 +1,54 @@
 import { RgbColor } from 'colord';
 
 import { Mask } from './Mask';
-import { subtract, add, SubtractImageOptions } from './compare';
-import { median } from './compute/median';
+import { add, subtract, SubtractImageOptions } from './compare';
+import { median } from './compute';
 import { variance } from './compute/variance';
 import { correctColor } from './correctColor';
 import {
-  drawLineOnImage,
-  drawPolygonOnImage,
-  drawPolylineOnImage,
   drawCircleOnImage,
-  DrawPolygonOnImageOptions,
-  DrawPolylineOnImageOptions,
   DrawCircleOnImageOptions,
-  DrawRectangleOptions,
-  drawRectangle,
+  drawLineOnImage,
   DrawLineOnImageOptions,
-  drawPoints,
-  DrawPointsOptions,
   drawMarker,
   DrawMarkerOptions,
   drawMarkers,
+  drawPoints,
+  DrawPointsOptions,
+  drawPolygonOnImage,
+  DrawPolygonOnImageOptions,
+  drawPolylineOnImage,
+  DrawPolylineOnImageOptions,
+  drawRectangle,
+  DrawRectangleOptions,
 } from './draw';
 import {
-  BlurOptions,
   blur,
+  BlurOptions,
   ConvolutionOptions,
-  directConvolution,
-  separableConvolution,
-  gaussianBlur,
-  GaussianBlurOptions,
-  HypotenuseOptions,
-  rawDirectConvolution,
-  GradientFilterOptions,
-  gradientFilter,
   derivativeFilter,
   DerivativeFilterOptions,
+  directConvolution,
   flip,
   FlipOptions,
+  gaussianBlur,
+  GaussianBlurOptions,
+  gradientFilter,
+  GradientFilterOptions,
   hypotenuse,
+  HypotenuseOptions,
   invert,
   InvertOptions,
   level,
   LevelOptions,
   increaseContrast,
   IncreaseContrastOptions,
-  pixelate,
-  PixelateOptions,
   medianFilter,
   MedianFilterOptions,
+  pixelate,
+  PixelateOptions,
+  rawDirectConvolution,
+  separableConvolution,
 } from './filters';
 import {
   Point,
@@ -61,7 +61,6 @@ import {
   transformRotate,
   TransformRotateOptions,
 } from './geometry';
-import { ImageMetadata } from './load/getMetadata';
 import {
   bottomHat,
   BottomHatOptions,
@@ -81,20 +80,21 @@ import {
   TopHatOptions,
 } from './morphology';
 import {
+  convertBitDepth,
   convertColor,
   ConvertColorOptions,
-  convertBitDepth,
   copyTo,
   CopyToOptions,
   crop,
+  CropAlphaOptions,
   CropOptions,
   grey,
   paintMaskOnImage,
   PaintMaskOnImageOptions,
   split,
 } from './operations';
-import { cropAlpha, CropAlphaOptions } from './operations/cropAlpha';
-import { ImageColorModel, colorModels } from './utils/constants/colorModels';
+import { cropAlpha } from './operations/cropAlpha';
+import { colorModels, ImageColorModel } from './utils/constants/colorModels';
 import { getMinMax } from './utils/getMinMax';
 import { validateChannel, validateValue } from './utils/validators/validators';
 
@@ -104,6 +104,7 @@ import {
   GreyOptions,
   histogram,
   HistogramOptions,
+  ImageMetadata,
   mean,
   threshold,
   ThresholdOptions,

src/Mask.ts

@@ -3,14 +3,15 @@ import { subtract, SubtractImageOptions } from './compare';
 import {
   drawLineOnMask,
   DrawLineOnMaskOptions,
+  drawPoints,
+  DrawPointsOptions,
   drawPolygonOnMask,
   DrawPolygonOnMaskOptions,
   drawPolylineOnMask,
   DrawPolylineOnMaskOptions,
   drawRectangle,
   DrawRectangleOptions,
 } from './draw';
-import { drawPoints, DrawPointsOptions } from './draw/drawPoints';
 import {
   and,
   AndOptions,
@@ -19,15 +20,11 @@ import {
   or,
   OrOptions,
 } from './filters';
-import {
-  GetBorderPointsOptions,
-  getBorderPoints,
-  getConvexHull,
-  ConvexHull,
-  Feret,
-  getFeret,
-} from './maskAnalysis';
-import { getMbr, Mbr } from './maskAnalysis/getMbr';
+import { ConvexHull, Feret, GetBorderPointsOptions, Mbr } from './maskAnalysis';
+import { getBorderPoints } from './maskAnalysis/getBorderPoints';
+import { getConvexHull } from './maskAnalysis/getConvexHull';
+import { getFeret } from './maskAnalysis/getFeret';
+import { getMbr } from './maskAnalysis/getMbr';
 import {
   bottomHat,
   BottomHatOptions,
@@ -37,6 +34,7 @@ import {
   CloseOptions,
   dilate,
   DilateOptions,
+  erode,
   ErodeOptions,
   floodFill,
   FloodFillOptions,
@@ -49,7 +47,6 @@ import {
   topHat,
   TopHatOptions,
 } from './morphology';
-import { erode } from './morphology/erode';
 import {
   convertColor,
   copyTo,
@@ -58,7 +55,7 @@ import {
   PaintMaskOnMaskOptions,
 } from './operations';
 import { boolToNumber } from './utils/boolToNumber';
-import { ImageColorModel, colorModels } from './utils/constants/colorModels';
+import { colorModels, ImageColorModel } from './utils/constants/colorModels';
 import { Point } from './utils/geometry/points';
 
 export type BitValue = 1 | 0 | boolean;
@@ -323,8 +320,7 @@ export class Mask {
    * @param value - Value to set.
    */
   public setBitByIndex(index: number, value: BitValue): void {
-    const result = boolToNumber(value);
-    this.data[index * this.channels] = result;
+    this.data[index * this.channels] = boolToNumber(value);
   }
 
   /**

src/compare/computeRmse.ts

@@ -2,7 +2,7 @@ import { Image } from '..';
 
 /**
  * Compute the Root Mean Square Error (RMSE) between two images. It is just the square root of the MSE.
- * {@see @link https://en.wikipedia.org/wiki/Root-mean-square_deviation}
+ * @see {@link https://en.wikipedia.org/wiki/Root-mean-square_deviation}
  * @param image - First image.
  * @param otherImage - Second image.
  * @returns RMSE of the two images.

src/featureMatching/descriptors/getBriefDescriptors.ts

@@ -1,12 +1,10 @@
 import { Image } from '../../Image';
 import { GaussianBlurSigmaOptions } from '../../filters';
+import { GetGaussianPointsOptions } from '../../utils/utils.types';
 import checkProcessable from '../../utils/validators/checkProcessable';
 import { OrientedFastKeypoint } from '../keypoints/getOrientedFastKeypoints';
 import { compareIntensity } from '../utils/compareIntensity';
-import {
-  getGaussianPoints,
-  GetGaussianPointsOptions,
-} from '../utils/getGaussianPoints';
+import { getGaussianPoints } from '../utils/getGaussianPoints';
 
 import { getKeypointPatch } from './utils/getKeypointPatch';
 

src/featureMatching/featureMatching.types.ts

@@ -0,0 +1,26 @@
+export interface GetColorsOptions {
+  /**
+   * Number of shades to generate.
+   * @default `6`
+   */
+  nbShades?: number;
+  /**
+   * Factor between 0 and 1 by which to multiply the maximal value of the color to obtain the minimum value.
+   * @default `0.2`
+   */
+  minValueFactor?: number;
+}
+
+export interface GetHarrisScoreOptions {
+  /**
+   * Size of the window to compute the Harris score.
+   * Should be an odd number so that the window can be centered on the corner.
+   * @default `7`
+   */
+  windowSize?: number;
+  /**
+   * Constant for the score computation. Should be between 0.04 and 0.06 (empirical values). This consant is commonly called k.
+   * @default `0.04`
+   */
+  harrisConstant?: number;
+}

src/featureMatching/index.ts

@@ -1,4 +1,5 @@
 export * from './descriptors/getBriefDescriptors';
+export * from './featureMatching.types';
 export * from './keypoints/getFastKeypoints';
 export * from './keypoints/getIntensityCentroid';
 export * from './keypoints/getOrientedFastKeypoints';

src/featureMatching/keypoints/getFastKeypoints.ts

@@ -7,9 +7,10 @@ import {
 import { getIndex } from '../../utils/getIndex';
 import { surroundingPixels } from '../../utils/surroundingPixels';
 import checkProcessable from '../../utils/validators/checkProcessable';
+import { GetHarrisScoreOptions } from '../featureMatching.types';
 
 import { getFastScore } from './getFastScore';
-import { getHarrisScore, GetHarrisScoreOptions } from './getHarrisScore';
+import { getHarrisScore } from './getHarrisScore';
 import { isFastKeypoint, IsFastKeypointOptions } from './isFastKeypoint';
 
 export interface GetFastKeypointsOptions extends IsFastKeypointOptions {

src/featureMatching/keypoints/getHarrisScore.ts

@@ -3,20 +3,7 @@ import Matrix, { EigenvalueDecomposition, WrapperMatrix1D } from 'ml-matrix';
 import { Image } from '../../Image';
 import { Point } from '../../geometry';
 import { SOBEL_X, SOBEL_Y } from '../../utils/constants/kernels';
-
-export interface GetHarrisScoreOptions {
-  /**
-   * Size of the window to compute the Harris score.
-   * Should be an odd number so that the window can be centered on the corner.
-   * @default `7`
-   */
-  windowSize?: number;
-  /**
-   * Constant for the score computation. Should be between 0.04 and 0.06 (empirical values). This consant is commonly called k.
-   * @default `0.04`
-   */
-  harrisConstant?: number;
-}
+import { GetHarrisScoreOptions } from '../featureMatching.types';
 
 /**
  * Get the Harris score of a corner. The idea behind the algorithm is that a