🤖 Merge PR DefinitelyTyped#74654 refactor: update lineclip types and tests for improved clarity and functionality by @SheepFromHeaven

Author: SheepFromHeaven

types/lineclip/index.d.ts

@@ -1,15 +1,7 @@
-declare namespace Lineclip {
-    type Point = [number, number];
-    type BoundingBox = [number, number, number, number];
-    type LineClipResult = Point[];
+export type Point = [number, number];
+export type BoundingBox = [number, number, number, number];
+export type LineClipResult = Point[][];
+export type PolygonClipResult = Point[];
 
-    function polyline(points: Point[], bbox: BoundingBox, result?: LineClipResult[]): LineClipResult;
-    function polygon(points: Point[], bbox: BoundingBox): LineClipResult;
-}
-
-declare function Lineclip(
-    points: Lineclip.Point[],
-    bbox: Lineclip.BoundingBox,
-    result?: Lineclip.LineClipResult[],
-): Lineclip.LineClipResult;
-export = Lineclip;
+export function clipPolyline(points: Point[], bbox: BoundingBox, result?: LineClipResult): LineClipResult;
+export function clipPolygon(points: Point[], bbox: BoundingBox): PolygonClipResult;

types/lineclip/lineclip-tests.ts

@@ -1,4 +1,11 @@
-import { type BoundingBox, type Point, polyline } from "lineclip";
+import {
+    type BoundingBox,
+    clipPolygon,
+    clipPolyline,
+    type LineClipResult,
+    type Point,
+    type PolygonClipResult,
+} from "lineclip";
 
 const line: Point[] = [
     [-10, 10],
@@ -19,6 +26,23 @@ const line: Point[] = [
     [-10, 20],
 ];
 
+const polygon: Point[] = [
+    [-10, 10],
+    [0, 10],
+    [10, 10],
+    [10, 5],
+    [10, -5],
+    [10, -10],
+    [20, -10],
+    [-10, 10],
+];
+
 const bbox: BoundingBox = [0, 0, 30, 30];
 
-polyline(line, bbox);
+const result: LineClipResult = clipPolyline(line, bbox);
+const withOptionalResult: LineClipResult = clipPolyline(line, bbox, [[[0, 1], [2, 3]]]);
+
+const polygonResult: PolygonClipResult = clipPolygon(polygon, bbox);
+
+const onePoint: Point = result[0][0];
+const onePolygonPoint: Point = polygonResult[0];

types/lineclip/package.json

@@ -1,7 +1,8 @@
 {
     "private": true,
     "name": "@types/lineclip",
-    "version": "1.1.9999",
+    "version": "2.0.9999",
+    "type": "module",
     "projects": [
         "https://github.com/mapbox/lineclip#readme"
     ],
@@ -12,6 +13,10 @@
         {
             "name": "Sikriti Dakua",
             "githubUsername": "devloop01"
+        },
+        {
+            "name": "Marc Emmanuel",
+            "githubUsername": "SheepFromHeaven"
         }
     ]
 }