terra-draw 0.0.1-alpha.0

package/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: Terra Draw CI Tasks
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: "16.x"
+      - name: Install Parent Folder
+        run: npm install
+      - name: Ensure no package-lock.json changes
+        run: git diff --exit-code
+      - name: Build
+        run: npm run build
+      - name: Test
+        run: npm run test
+        env:
+          CI: true

package/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit 

package/.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run lint:fix:quiet
+git add .

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,17 @@
+# 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).

package/DEVELOPMENT.md

@@ -0,0 +1,77 @@
+# Development
+
+This file acts as a way to document how to develop the Terra Draw project locally. 
+
+### Prerequisites
+
+A few things you will need to have installed in order to develop on this project:
+
+* git
+* Node LTS - currently v16
+* npm 8 
+
+### Folder Structure
+
+
+* `.github` - used for all GitHub related configuration such as the GitHub Actions work flows
+* `.husky` - used to storing the precommit hooks that are used on the project
+* `src` - source files for the project
+* `dist` - the bundled distributed files of the project
+* `docs` - the demo app that is published to GitHub pages
+* `development` - the local development app that is used for developing locally (see below)
+* `common` - code that is used across `development` and `docs` folder`
+
+### Technologies Used
+
+Terra Draw 
+
+* [TypeScript](https://www.typescriptlang.org/) - provides strong compile time typing for JavaScript
+* Jest - used for testing (see more information below)
+* microbundle - used for the production bundle
+* Webpack - used for bundling locally in development (`development` and `docs` folders)
+* esno - for running tests quickly without type checking
+
+### Precommit Hooks
+
+It is probably useful to be aware of the precommit hooks you will face when trying to run a git commit on the project. There are two currently in use, namely:
+
+* Uses pre-commit hook to run lint rules (eslint/prettier) on code before commit
+* Uses pre-commit hook to ensure [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/) are used 
+
+### Testing
+
+Terra Draw uses [jest](https://jestjs.io/) as it's testing framework. You can distinguish a test by it's `.spec.ts` prefix on the file name.  
+
+To run the tests as they would run in CI:
+
+```
+npm run test
+```
+
+You can also check the coverage by running:
+
+
+```
+npm run test:coverage
+```
+
+For local development you may benefit from the `nocheck` option which allows you to avoid running TypeScript type checking when running the tests. This option also only checks files which are explicitly tested (i.e. have a spec file.)
+
+```
+npm run test:nocheck
+npm run test:nocheck:coverage
+```
+
+### Developing Locally
+
+A folder called `development` has been set up locally to allow you to test developing Terra Draw locally more easily. It allows you to run the different adapters and test different map providers in parallel, ensuring. You will need to update the .env file in the `development` folder in order to use the related adapters working. An example `.env` file in the `development` folder:
+
+
+```
+GOOGLE_API_KEY=YOUR_KEY_HERE
+MAPBOX_ACCESS_TOKEN=YOUR_KEY_HERE
+```
+
+### GitHub Pages Example
+
+We also provide a GitHub Pages example that can developed on in the `docs` folder. This automatically deploys from the `main` branch.

package/LICENSE

@@ -0,0 +1,8 @@
+Copyright 2022 James Milner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/README.md

@@ -0,0 +1,19 @@
+<img src="docs/logo.png" alt="Terra Draw Logo" width="400"/>
+
+![Terra Draw CI Badge](https://github.com/JamesLMilner/terra-draw/actions/workflows/ci.yml/badge.svg)
+
+Frictionless map drawing across mapping libraries.
+
+TerraDraw centralises map drawing logic and provides a host of out the box drawing modes that work across map providers (currently Leaflet, Mapbox, Google) via adapters.
+
+### Development
+
+Please see the [the development documentation](./DEVELOPMENT.md)
+
+### Contributing
+
+Please see the [the contributing documentation](./CONTRIBUTING.md)
+
+### License
+
+MIT

package/ROADMAP.md

@@ -0,0 +1,63 @@
+## Roadmap
+
+A simple file for tracking what's being worked on.
+
+## Doing
+
+
+## To do
+
+### Bugs
+
+- Cross Provider
+  - Bug: Possible to create zero area polygons which are unselectable
+  - Bug: Snapping can snap to same coordinate mulitple times (idential coordinate proptection?)
+  - Bug: Dragging doesn't trigger dragging cursor on mouse down
+- Mapbox
+  - Bug (Mapbox): More robust implementation for fixing zIndexing for layers for Mapbox
+  - Bug (Mapbox): When drawing second coordinate the line can stop rendering at certain angles
+- Google Maps
+  - Bug (Google Maps): Figure out why Polygons move so much slower selection points when dragged
+  - Bug (Google Maps): Does not respect midpoint insertion crosshair
+
+### Chores
+
+- Chore: Figure a more robust way to handle project/unproject in tests
+- Chore: Identical coordinate protection
+- Chore: Type properties for different mode features
+- Chore: Add unit tests for rotation/scaling in Select mode
+
+Could Do:
+
+- Consider Tablets/Mobile devices
+- Feature: Undo/Redo
+
+## Done
+
+- Chore: Enable TypeScript strict mode
+- Bug (Leaflet): On click event triggered after dragging coordinate which deselects feature
+- Chore: Demo that can run on GitHub
+- Feature: Select - Scale
+- Feature: Select - Rotation
+- Chore: Come up with strategy for layering functionality/behaviors
+- Bug: Can drag feature when cursor is not dragging over the feature
+- Bug (Leaflet): Dragging coordinate deselects coordinate after drag
+- Feature: Select renders Polygon and LineString coordinates
+- Feature: Drag drawn feature
+- Feature: Configurable keybindings
+- Bug: Can't drag any more
+- Chore: Make store take an array for updates/create etc
+- Chore: Use Position instead of [number,number] for typing
+- Feature: Set cursor
+- Chore: Lifecycle state machine - registered -> start -> stop
+- Chore: Create mock terra draw config
+- Feature: Drag coordinates
+- Chore: Code coverage back to 100% - test custom key bindings
+- Chore: Spatial indexing
+- Bug (Mapbox): Correct zIndexing for layers for Mapbox
+- Feature: Snapping
+- Feature: Insert midpoints
+- Chore: Remove geometry logic from selection mode
+- Feature: Right click to delete coordinate
+- Chore: Show crosshairs when on inserting midpoints
+- Bug (Mapbox): First two points of Mapbox Adapter polygons don't render

package/common/addModeChangeHandler.ts

@@ -0,0 +1,26 @@
+import { TerraDraw } from "../src/terra-draw";
+
+export const addModeChangeHandler = (
+  draw: TerraDraw,
+  currentSelected: { button: undefined | HTMLButtonElement; mode: string }
+) => {
+  ["select", "point", "linestring", "polygon", "freehand", "circle"].forEach(
+    (mode) => {
+      (document.getElementById(mode) as HTMLButtonElement).addEventListener(
+        "click",
+        () => {
+          currentSelected.mode = mode;
+          draw.changeMode(currentSelected.mode);
+
+          if (currentSelected.button) {
+            currentSelected.button.style.color = "565656";
+          }
+          currentSelected.button = document.getElementById(
+            mode
+          ) as HTMLButtonElement;
+          currentSelected.button.style.color = "#27ccff";
+        }
+      );
+    }
+  );
+};