terra-draw 0.0.1-alpha.9 → 1.0.0-beta.1

package/e2e/tests/setup.ts

@@ -0,0 +1,198 @@
+import { Page, expect } from "@playwright/test";
+
+export const pageUrl = "http://localhost:3000/";
+
+export type TestConfigOptions =
+	| "validationSuccess"
+	| "validationFailure"
+	| "insertCoordinates"
+	| "insertCoordinatesGlobe"
+	| "globeCircle"
+	| "globeSelect";
+
+export const setupMap = async ({
+	page,
+	configQueryParam,
+}: {
+	page: Page;
+	configQueryParam?: TestConfigOptions[];
+}): Promise<{
+	x: number;
+	y: number;
+	width: number;
+	height: number;
+}> => {
+	if (configQueryParam) {
+		if (configQueryParam.length > 1) {
+			await page.goto(
+				pageUrl +
+					"?config=" +
+					configQueryParam.map((config) => config).join(","),
+			);
+		} else {
+			await page.goto(pageUrl + "?config=" + configQueryParam);
+		}
+	} else {
+		await page.goto(pageUrl);
+	}
+
+	const mapDiv = await page.getByRole("application");
+
+	// Get the bounding box of the div
+	const mapBoundingBox = await mapDiv.boundingBox();
+
+	if (!mapBoundingBox) {
+		throw new Error();
+	}
+
+	return mapBoundingBox;
+};
+
+export const changeMode = async ({
+	page,
+	mode,
+}: {
+	page: Page;
+	mode:
+		| "point"
+		| "polygon"
+		| "linestring"
+		| "select"
+		| "rectangle"
+		| "circle"
+		| "angled-rectangle";
+}) => {
+	let modeText = mode.charAt(0).toUpperCase() + mode.slice(1);
+
+	if (mode.includes("-")) {
+		modeText = mode
+			.split("-")
+			.map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+			.join(" ");
+	} else {
+		modeText = mode.charAt(0).toUpperCase() + mode.slice(1);
+	}
+
+	const buttons = page.getByTestId("buttons");
+	const button = buttons.getByText(modeText, { exact: true });
+
+	// Click the mode button
+	await button.click();
+
+	// Ensure it has been clickde and updatedc correctly
+	const color = await button.evaluate((el) =>
+		window.getComputedStyle(el).getPropertyValue("color"),
+	);
+	expect(color).toBe("rgb(39, 204, 255)"); // We set hex but it gets computed to rgb
+};
+
+export const expectPaths = async ({
+	page,
+	count,
+}: {
+	page: Page;
+	count: number;
+}) => {
+	const selector = "svg > g > path";
+
+	if (count > 0) {
+		await page.waitForSelector(selector);
+		expect(await page.locator(selector).count()).toBe(count);
+	} else {
+		await expect(await page.locator(selector).count()).toBe(0);
+	}
+};
+
+export const expectPathDimensions = async ({
+	page,
+	width,
+	height,
+}: {
+	page: Page;
+	width: number;
+	height: number;
+}) => {
+	const selector = "svg > g > path";
+
+	const boundingBox = await page.locator(selector).boundingBox();
+
+	expect(boundingBox?.width).toBe(width);
+	expect(boundingBox?.height).toBe(height);
+};
+
+export const expectGroupPosition = async ({
+	page,
+	x,
+	y,
+}: {
+	page: Page;
+	x: number;
+	y: number;
+}) => {
+	const selector = "svg > g > path";
+
+	const boundingBox = await page.locator(selector).boundingBox();
+
+	expect(boundingBox?.x).toBe(x);
+	expect(boundingBox?.y).toBe(y);
+};
+
+export const drawRectangularPolygon = async ({
+	mapDiv,
+	page,
+	size = "regular",
+}: {
+	mapDiv: {
+		x: number;
+		y: number;
+		width: number;
+		height: number;
+	};
+	page: Page;
+	size?: "regular" | "small";
+}) => {
+	// Draw a rectangle
+	const sideLength = size === "regular" ? 100 : 70;
+	const halfLength = sideLength / 2;
+	const centerX = mapDiv.width / 2;
+	const centerY = mapDiv.height / 2;
+	const topLeft = { x: centerX - halfLength, y: centerY - halfLength };
+	const topRight = { x: centerX + halfLength, y: centerY - halfLength };
+	const bottomLeft = { x: centerX - halfLength, y: centerY + halfLength };
+	const bottomRight = { x: centerX + halfLength, y: centerY + halfLength };
+	await page.mouse.click(topLeft.x, topLeft.y);
+	await page.mouse.click(topRight.x, topRight.y);
+	await page.mouse.click(bottomRight.x, bottomRight.y);
+	await page.mouse.click(bottomLeft.x, bottomLeft.y);
+	await page.mouse.click(bottomLeft.x, bottomLeft.y); // Closed
+
+	return { topLeft, topRight, bottomRight, bottomLeft };
+};
+
+export const drawTwoClickShape = async ({
+	mapDiv,
+	page,
+}: {
+	mapDiv: {
+		x: number;
+		y: number;
+		width: number;
+		height: number;
+	};
+	page: Page;
+}) => {
+	// Draw a rectangle
+	const sideLength = 100;
+	const halfLength = sideLength / 2;
+	const centerX = mapDiv.width / 2;
+	const centerY = mapDiv.height / 2;
+	const topLeft = { x: centerX - halfLength, y: centerY - halfLength };
+	const topRight = { x: centerX + halfLength, y: centerY - halfLength };
+	const bottomLeft = { x: centerX - halfLength, y: centerY + halfLength };
+	const bottomRight = { x: centerX + halfLength, y: centerY + halfLength };
+	await page.mouse.click(topLeft.x, topLeft.y);
+
+	await page.mouse.click(bottomRight.x, bottomRight.y); // Closed
+
+	return { topLeft, topRight, bottomRight, bottomLeft };
+};

package/e2e/webpack.config.js

@@ -0,0 +1,36 @@
+const path = require("path");
+const Dotenv = require("dotenv-webpack");
+
+module.exports = {
+	mode: "development",
+	entry: "./src/index.ts",
+	devtool: "inline-source-map",
+	plugins: [new Dotenv()],
+	module: {
+		rules: [
+			{
+				test: /\.tsx?$/,
+				use: "ts-loader",
+				exclude: /node_modules/,
+			},
+		],
+	},
+	resolve: {
+		extensions: [".tsx", ".ts", ".js"],
+	},
+	output: {
+		filename: "bundle.js",
+		path: path.resolve(__dirname, "dist"),
+	},
+	devServer: {
+		static: {
+			directory: path.join(__dirname, "public"),
+		},
+		liveReload: !process.env.CI,
+		watchFiles: !process.env.CI
+			? ["./src", "./*.{js,json,ts,html}", "../src", "../*.{js,json,ts,html}"]
+			: [],
+		compress: true,
+		port: 3000,
+	},
+};

package/jest.nocheck.config.ts

@@ -0,0 +1,17 @@
+console.log("===== Using @swc/jest ======");
+
+module.exports = {
+	transform: {
+		"^.+\\.(t|j)sx?$": "@swc/jest",
+	},
+	testPathIgnorePatterns: [
+		"<rootDir>/node_modules/",
+		"<rootDir>/e2e/",
+		"<rootDir>/docs/",
+		"<rootDir>/coverage/",
+		"<rootDir>/scripts/",
+		"<rootDir>/guides/",
+	],
+	coveragePathIgnorePatterns: ["<rootDir>/src/test/", "<rootDir>/e2e/"],
+	setupFilesAfterEnv: ["<rootDir>/src/test/jest.matchers.ts"],
+};

package/package.json

@@ -1,88 +1,159 @@
 {
-    "name": "terra-draw",
-    "version": "0.0.1-alpha.9",
-    "description": "Frictionless map drawing across mapping provider",
-    "scripts": {
-        "build": "microbundle",
-        "watch": "microbundle --watch --format modern",
-        "test": "jest --config jest.config.ts",
-        "test:coverage": "jest --config jest.config.ts --coverage",
-        "test:nocheck": "NO_CHECK=true jest --config jest.config.ts",
-        "test:nocheck:coverage": "NO_CHECK=true jest --config jest.config.ts --coverage",
-        "lint": "eslint --ext .ts src/",
-        "lint:quiet": "eslint --ext .ts --quiet src/",
-        "lint:fix": "eslint --fix --ext .ts src/",
-        "lint:fix:quiet": "eslint --fix --quiet --ext .ts src/",
-        "prepare": "husky install"
-    },
-    "type": "module",
-    "source": "src/terra-draw.ts",
-    "exports": {
-        "types": "./dist/terra-draw.d.ts",
-        "require": "./dist/terra-draw.cjs",
-        "default": "./dist/terra-draw.modern.js"
-    },
-    "types": "./dist/terra-draw.d.ts",
-    "main": "./dist/terra-draw.cjs",
-    "module": "./dist/terra-draw.module.js",
-    "unpkg": "./dist/terra-draw.umd.js",
-    "author": "James Milner",
-    "license": "MIT",
-    "repository": "JamesLMilner/terra-draw",
-    "devDependencies": {
-        "@commitlint/cli": "^17.1.2",
-        "@commitlint/config-conventional": "^17.1.0",
-        "@googlemaps/js-api-loader": "^1.14.3",
-        "@swc/jest": "^0.2.22",
-        "@types/geojson": "^7946.0.8",
-        "@types/google.maps": "^3.49.2",
-        "@types/jest": "^28.1.5",
-        "@types/leaflet": "^1.7.11",
-        "@types/mapbox-gl": "^2.7.3",
-        "@types/rbush": "^3.0.0",
-        "@typescript-eslint/eslint-plugin": "^5.38.1",
-        "@typescript-eslint/parser": "^5.38.1",
-        "eslint": "^8.24.0",
-        "eslint-config-prettier": "^8.5.0",
-        "eslint-plugin-prettier": "^4.2.1",
-        "husky": "^7.0.0",
-        "jest": "^28.1.2",
-        "leaflet": "^1.8.0",
-        "mapbox-gl": "^2.9.1",
-        "microbundle": "^0.15.0",
-        "serve": "^13.0.4",
-        "ts-jest": "^28.0.5",
-        "ts-loader": "^9.3.1",
-        "typescript": "^4.7.4"
-    },
-    "commitlint": {
-        "extends": [
-            "@commitlint/config-conventional"
-        ]
-    },
-    "eslintConfig": {
-        "parser": "@typescript-eslint/parser",
-        "plugins": [
-            "@typescript-eslint"
-        ],
-        "rules": {
-            "indent": [
-                "error",
-                4
-            ],
-            "semi": [
-                "error",
-                "always"
-            ],
-            "@typescript-eslint/no-empty-function": "warn"
-        },
-        "extends": [
-            "plugin:@typescript-eslint/recommended",
-            "prettier"
-        ]
-    },
-    "prettier": {
-        "printWidth": 80,
-        "semi": true
-    }
-}
+	"name": "terra-draw",
+	"version": "1.0.0-beta.1",
+	"description": "Frictionless map drawing across mapping provider",
+	"scripts": {
+		"docs": "typedoc",
+		"docs:serve": "serve ./docs",
+		"release:beta:increment": "standard-version --prerelease beta",
+		"release:beta:changelog": "tsx ./scripts/changelog-valid.ts",
+		"release:beta:next": "tsx ./scripts/next-beta-version.ts",
+		"build": "microbundle",
+		"watch": "microbundle --watch --format modern",
+		"test": "jest --config jest.config.ts",
+		"test:coverage": "jest --config jest.config.ts --coverage",
+		"test:nocheck": "jest --config jest.nocheck.config.ts",
+		"test:nocheck:coverage": "jest --config jest.nocheck.config.ts --coverage",
+		"lint": "eslint --ext .ts src/",
+		"lint:quiet": "eslint --ext .ts --quiet src/",
+		"lint:fix": "eslint --fix --ext .ts src/",
+		"lint:fix:quiet": "eslint --fix --quiet --ext .ts src/",
+		"format": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\"",
+		"format:quiet": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\" --log-level=silent",
+		"prepare": "husky install"
+	},
+	"type": "module",
+	"source": "src/terra-draw.ts",
+	"exports": {
+		"types": "./dist/terra-draw.d.ts",
+		"require": "./dist/terra-draw.cjs",
+		"default": "./dist/terra-draw.modern.js"
+	},
+	"types": "./dist/terra-draw.d.ts",
+	"main": "./dist/terra-draw.cjs",
+	"module": "./dist/terra-draw.module.js",
+	"unpkg": "./dist/terra-draw.umd.js",
+	"author": "James Milner",
+	"license": "MIT",
+	"repository": "JamesLMilner/terra-draw",
+	"keywords": [
+		"map",
+		"drawing",
+		"draw",
+		"map drawing",
+		"geometry",
+		"leaflet",
+		"leafletjs",
+		"mapbox",
+		"mapboxgl",
+		"google maps",
+		"openlayers",
+		"maplibre"
+	],
+	"devDependencies": {
+		"@arcgis/core": "4.27.6",
+		"@commitlint/cli": "17.1.2",
+		"@commitlint/config-conventional": "17.1.0",
+		"@googlemaps/js-api-loader": "1.14.3",
+		"@swc/jest": "0.2.36",
+		"@types/geojson": "7946.0.8",
+		"@types/google.maps": "3.49.2",
+		"@types/jest": "29.5.12",
+		"@types/leaflet": "^1.9.12",
+		"@types/mapbox-gl": "2.7.3",
+		"@types/rbush": "3.0.0",
+		"@typescript-eslint/eslint-plugin": "7.14.1",
+		"@typescript-eslint/parser": "7.14.1",
+		"eslint": "8.57.0",
+		"eslint-config-prettier": "9.0.0",
+		"eslint-plugin-prettier": "5.0.0",
+		"husky": "7.0.0",
+		"jest": "29.7.0",
+		"jest-environment-jsdom": "29.7.0",
+		"leaflet": "^1.9.4",
+		"mapbox-gl": "2.13.0",
+		"maplibre-gl": "3.2.0",
+		"microbundle": "0.15.0",
+		"ol": "10.0.0",
+		"serve": "14.1.2",
+		"standard-version": "9.5.0",
+		"ts-jest": "29.1.2",
+		"ts-loader": "9.5.1",
+		"tsx": "4.7.2",
+		"typedoc": "^0.26.2",
+		"typescript": "5.5.2"
+	},
+	"commitlint": {
+		"extends": [
+			"@commitlint/config-conventional"
+		]
+	},
+	"eslintConfig": {
+		"parser": "@typescript-eslint/parser",
+		"plugins": [
+			"@typescript-eslint"
+		],
+		"rules": {
+			"@typescript-eslint/no-empty-function": "warn",
+			"@typescript-eslint/no-explicit-any": "warn"
+		},
+		"extends": [
+			"plugin:@typescript-eslint/recommended",
+			"prettier"
+		]
+	},
+	"prettier": {
+		"printWidth": 80,
+		"semi": true,
+		"useTabs": true
+	},
+	"standard-version": {
+		"types": [
+			{
+				"type": "feat",
+				"section": "Features"
+			},
+			{
+				"type": "fix",
+				"section": "Bug Fixes"
+			},
+			{
+				"type": "docs",
+				"section": "Documentation"
+			},
+			{
+				"type": "style",
+				"section": "Styling"
+			},
+			{
+				"type": "refactor",
+				"section": "Refactors"
+			},
+			{
+				"type": "perf",
+				"section": "Performance"
+			},
+			{
+				"type": "test",
+				"section": "Tests"
+			},
+			{
+				"type": "build",
+				"section": "Build System"
+			},
+			{
+				"type": "ci",
+				"section": "CI"
+			},
+			{
+				"type": "chore",
+				"section": "Chore"
+			},
+			{
+				"type": "revert",
+				"section": "Reverts"
+			}
+		]
+	},
+	"sideEffects": false
+}

package/tsconfig.json

@@ -1,14 +1,27 @@
 {
-  "compilerOptions": {
-    "outDir": "./dist/",
-    "strict": true,
-    "noImplicitAny": true,
-    "module": "es6",
-    "target": "es6",
-    "jsx": "react",
-    "sourceMap": true,
-    "allowJs": true,
-    "moduleResolution": "node",
-    "allowSyntheticDefaultImports": true
-  }
+	"compilerOptions": {
+		"outDir": "./dist/",
+		"strict": true,
+		"module": "es6",
+		"target": "es6",
+		"jsx": "react",
+		"sourceMap": true,
+		"allowJs": true,
+		"moduleResolution": "node",
+		"allowSyntheticDefaultImports": true
+	},
+	"typedocOptions": {
+		"entryPoints": ["src/terra-draw.ts"],
+		"exclude": ["src/geometry/**/*.ts", "src/test/**/*.ts", "src/util/**/*.ts"],
+		"out": "docs",
+		"skipErrorChecking": true
+	},
+	"exclude": [
+		"node_modules/",
+		"guides/",
+		"docs/",
+		"dist/",
+		"development/dist",
+		"development/node_modules"
+	]
 }

package/CODE_OF_CONDUCT.md

@@ -1,36 +0,0 @@
-Contributor Covenant Code of Conduct
-Our Pledge
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-Our Standards
-Examples of behavior that contributes to creating a positive environment include:
-
-Using welcoming and inclusive language
-Being respectful of differing viewpoints and experiences
-Gracefully accepting constructive criticism
-Focusing on what is best for the community
-Showing empathy towards other community members
-Examples of unacceptable behavior by participants include:
-
-The use of sexualized language or imagery and unwelcome sexual attention or advances
-Trolling, insulting/derogatory comments, and personal or political attacks
-Public or private harassment
-Publishing others' private information, such as a physical or electronic address, without explicit permission
-Other conduct which could reasonably be considered inappropriate in a professional setting
-Our Responsibilities
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-Scope
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
-
-Enforcement
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at codeofconduct@loxo.industries. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
-
-Attribution
-This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

package/CONTRIBUTING.md

@@ -1,17 +0,0 @@
-# Contributing
-
-## Instructions
-
-This document will receive a more thorough update in the future. For the time being, if you wish to contribute to Terra Draw, we request that you:
-
-1) Make an issue on GitHub describing the bug you intend to fix or the feature you intend to add.
-2) Create a fork of the project, and work on a branch that represents the issue
-3) Ensure that the work you have done is unit tested, aiming for 80% code coverage
-4) Create a PR that represents this work. Please refer to the issue from the PR
-5) We will address the PR and give you feedback 
-
-Please note that we can not garauntee that all PRs will be merged. There are cases where a PR may deviate from the long-term vision for Terra Draw and hence we may have to decline it. Creating the issue in advance helps us discuss any potential issues upfront before the PR is made.
-
-## Code of Conduct
-
-We have a code of conduct which we expect individuals interacting with the project to respect. Please see the [full Code of Conduct in the repository](./CODE_OF_CONDUCT.md).