chore: Miny tidy up

.eslintrc.cjs

@@ -29,7 +29,7 @@ module.exports = {
 
   plugins: ['tailwind', 'import', 'react'],
 
-  ignorePatterns: ['**/coverage/*', `/node_modules/*`, `/dist/`, `/demo/dist`],
+  ignorePatterns: ['**/coverage/*', `/node_modules/*`, `/dist/`],
 
   rules: {
     'react/prop-types': 0,

README.md

@@ -1,148 +1,6 @@
 # README
 
-This package allows you to generate a [Coons patch](https://en.wikipedia.org/wiki/Coons_patch) for a four sided shape whose bounds are defined by four cubic Bezier curves. The grid it calculates is very configurable, allowing you to modify a number of its features in some useful and interesting ways. It provides a simple API to allow you to retrieve metrics about the patch and grid to use however you need.
-
-There is an [interactive demo](https://coons-patch.undistraction.com) which allows you to generate and manipulate a patch.
-
-This package only models the coons patch and calculates the position of the curves that make up the grid, their intersections and the bounds of the grid squares. It doesn't handle the rendering of that data data to the screen, however it gives you all the underlying metrics you need to render a patch using SVG or HTML canvas. Both approaches are used in the demo, the code for which can be found in `/demo/`.
-
-Note that calulating the curves that make up the grid (and therefore the grid cell bounds) is not a perfect process, and involves transforming a parametised into a cubic Bezier curve. Because there is no guarantee that the interpolated curve can be represented by a cubic Bezier, the Bezier has to fitted to the parametised curve. In some cases this means the edges will deviate from the bounds. In cases of a 1x1 grid, I cheat and just return the bounds of the grid, however with low numbers of columns and rows, and when curves are tighter at the corners, the curves will sometimes deviate from the bounds. This isn't a problem with higher numbers of rows/columns as each curve is made up of a different curve for each cell which gives more accurate results. Whilst it would certainly be possible to compose each grid-cell's bounds of multiple curves for increased accuracy, this would prevent one of the most useful bits of functionality - recursion, meaning you can use the bounds of any grid cell as the bounds for another nested grid.
-
-## Install package
-
-```bash
-npm add coons-patch
-yarn add coons-patch
-pnpm add coons-patch
-```
-
-## Quick-start
-
-The basic workflow is that you pass bounds representing the edges of a square, and a grid object describing the grid you'd like to map onto the square, and in return you receive an object with information about the coons patch, and a small API to allow you to get metrics describing the patch.
-
-```javaScript
-import getCoonsPatch from 'coons-patch'
-
-const coonsPatch = getCoonsPatch(
-  // See below
-  boundingCurves,
-  // See below
-  grid)
-
-// Get a point on the patch at the provided horizontal and vertical ratios (0–1)
-const point = coonsPatch.api.getPoint(0.5, 0.75)
-
-// Get an object wity `xAxis` and `yAxis` keys. Each key contains an Array containing data representing all the sub-curves that make up each curve along that axis.
-const curves = coonsPatch.api.getCurves()
-
-// Get an array of points representing every grid intersection
-const intersections = coonsPatch.api.getIntersections()
-
-// Get the bounds for the grid-square at the supplied coordinates
-const bounds = coonsPatch.api.getGridCellBounds(3, 8)
-```
-
-## API
-
-### getCoonsPatch(boundingCurves, grid)
-
-#### Argument 1: boundingCurves.
-
-The first argument is `boundingCurves`, an object describing the four sides of the patch and comprising of four keys (`top`, `bottom`, `left` and `right`), each containing an object representing a cubic Bezier curve. Top and bottom curves run left-to-right, along the x-axis, left and and right curves run top-top bottom along the y-axis.
-
-Here is an example:
-
-```javaScript
-{
-  top: {
-    startPoint: { x: 0, y: 0 },
-    endPoint: { x: 100, y: 0 },
-    controlPoint1: { x: 10, y: -10 },
-    controlPoint2: { x: 90, y: -10 },
-  },
-  bottom: {
-    startPoint: { x: 0, y: 100 },
-    endPoint: { x: 100, y: 100 },
-    controlPoint1: { x: -10, y: 110 },
-    controlPoint2: { x: 110, y: 110 },
-  },
-  left: {
-    startPoint: { x: 0, y: 0 },
-    endPoint: { x: 0, y: 100 },
-    controlPoint1: { x: -10, y: -10 },
-    controlPoint2: { x: -10, y: 110 },
-  },
-  right: {
-    startPoint: { x: 100, y: 0 },
-    endPoint: { x: 100, y: 100 },
-    controlPoint1: { x: 110, y: -10 },
-    controlPoint2: { x: 110, y: 110 },
-  },
-}
-```
-
-#### Argument 2: grid
-
-The grid object describes the grid that will be interpolated onto the patch. It has two main fields, `colums` and `rows` both of which can be either an integer, or an Array of numbers. If an integer, the integer will be used as the value for the number of rows or columns, for example, if columns is `5` and rows is `9`, the grid will have five columns and nine rows, and therefore 45 cells. In this instance, all columns will be of uniform width based on the width of the bounds, divided by the number of columns, similarly, all rows will be of uniform height based on the height of the bounds divided by the number of rows.
-
-Passing an array of numbers as the value of `columns` or `rows`, allows a great deal more control over the widths of the columns or rows, by allowing each value in the array to describe the width of the column (or height of the row) it represents. This is calculated by dividing the value by the total value of all the items in the array, and setting the resolved value to be a ratio of the total width or height. This allows the creation of a grid that supports variable column and row dimensions.
-
-Additionally, the `grid` supports a setting called `interpolationStrategy`. This can be either `even` (the default) or `linear`. This changes the algorythm used to interplate the position of a point along a curve. If `linear` interplation is used, the effect is to exagerate the effect of curvature on the distance between rows and columns. `even` uses a more complex approach and usually results in more pleasing results. However it is significantly more memory intensive.
-
-Here is an example:
-
-```javaScript
-{
-  columns: 8,
-  rows: [10, 5, 20, 5, 10]
-  interpolationStategy: `even`,
-}
-
-```
-
-#### Return value
-
-The return value is a `coonsPatch` object representing the patch and providing an API to interrogate it.
-
-## coonsPatch object
-
-The `coonsPatch` object comprises of two fields, `config` and `api`.
-
-### coonsPatch.config
-
-`config` provides access to the resolved configuration data that was used to generate the patch
-
-- `columns` contains an array of column values
-- `rows` contains an array of row values
-- `boundingCurves` contains the bounding curves object that was passed in.
-
-### coonsPatch.api
-
-`api` provides a small API to access metrics describing the API.
-
-#### getPoint
-
-TBD
-
-#### getCurves
-
-TBD
-
-#### getIntersections
-
-TBD
-
-#### getGridCellBounds
-
-TBD
-
-#### Validations
-
-- The points where two of the `boundingCurves` sides meet must have the same coordinates or a validation error will be raised.
-- If any of the sides are missing from the `boundingCurves` object, a validation error will be raised
-- If either `columns` or `rows` are missing, or are not either of type `Array` or `Integer`, a validation error will be raised.
-
-# Repo
+This is an editor / demo for [coons-patch](https://github.com/undistraction/coons-patch).
 
 ## Install
 
@@ -152,7 +10,7 @@ pnpm install
 
 ```
 
-## Run demo in development
+## Run in development
 
 ```
 
@@ -164,14 +22,6 @@ pnpm run dev
 
 ```
 
-pnpm run build-package
-
-```
-
-## Build demo
-
-```
-
 pnpm run build
 
 ```
@@ -200,7 +50,3 @@ pnpm run test
 pnpm run lint-prettier
 pnpm run lint-eslint
 ```
-
-## Thanks
-
-Thanks to pomax for his help (and code) for curve fitting (which is much more complex than it might seem). His [A Primer on Bézier Curves](https://pomax.github.io/bezierinfo/) is a thing of wonder.

package.json

@@ -1,31 +1,17 @@
 {
-  "name": "coons-patch",
+  "name": "coons-patch-editor",
   "version": "1.1.0",
   "packageManager": "pnpm@9.6.0",
-  "description": "Create a Coons patch for a four-sided shape and manipulate the grid",
+  "description": "Editor/demo for coons-patch",
   "main": "dist/coons-patch.js",
-  "exports": {
-    ".": {
-      "import": "./dist/coons-patch.js",
-      "require": "./dist/index.umd.cjs"
-    }
-  },
-  "files": [
-    "/dist",
-    "/src"
-  ],
   "homepage": "https://coons-patch.undistraction.com",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/undistraction/coons-patch.git"
+    "url": "git+https://github.com/undistraction/coons-patch-editor.git"
   },
   "bugs": {
-    "url": "https://github.com/undistraction/coons-patch/issues"
+    "url": "https://github.com/undistraction/coons-patch-editor/issues"
   },
-  "publishConfig": {
-    "access": "public"
-  },
-  "private": false,
   "type": "module",
   "scripts": {
     "prepare": "husky",
@@ -35,11 +21,10 @@
     "lint": "pnpm run lint-prettier && pnpm run lint-eslint",
     "lint-prettier": "prettier . --write",
     "lint-eslint": "eslint './**/*.{js,jsx,cjs}'",
-    "dev": "vite --config vite.config.demo.js",
-    "build": "vite build --config vite.config.demo.js",
-    "preview": "vite preview --config vite.config.demo.js",
-    "build-package": "vite build",
-    "release": "semantic-release --no-ci --dry-run --debug"
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "build-package": "vite build"
   },
   "keywords": [
     "coons patch",
@@ -48,7 +33,7 @@
     "surface",
     "grid"
   ],
-  "author": "Pedr Browne ",
+  "author": "Pedr Browne",
   "license": "MIT",
   "devDependencies": {
     "@commitlint/config-conventional": "^19.2.2",
@@ -77,18 +62,17 @@
     "prettier": "3.3.2",
     "prettier-plugin-ejs": "^1.0.3",
     "prettier-plugin-tailwindcss": "^0.6.5",
-    "prop-types": "^15.8.1",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "react-draggable": "^4.4.6",
-    "semantic-release": "^24.0.0",
     "tailwindcss": "^3.4.4",
     "typescript": "^5.5.3",
-    "use-debounce": "^10.0.1",
-    "uuid": "^10.0.0",
     "vite": "^5.3.3"
   },
   "dependencies": {
-    "matrix-js": "^1.7.1"
+    "coons-patch": "^1.1.0",
+    "prop-types": "^15.8.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-draggable": "^4.4.6",
+    "use-debounce": "^10.0.1",
+    "uuid": "^10.0.0"
   }
 }