@flatten-js/core - npm Package Compare versions

Comparing version 1.0.5 to 1.0.6

index.js

@@ -5,28 +5,23 @@ /**
 
-// import Flatten from '../../src/flatten';
-// import * as Utils from "../../src/utils/utils";
-// import * as Errors from "../../src/utils/errors";
-//
-// export {Utils, Errors};
-// export {Matrix, matrix} from '../../src/classes/matrix';
-// export {PlanarSet} from '../../src/data_structures/planar_set';
-// export {Point, point} from '../../src/classes/point';
-// export {Vector, vector} from '../../src/classes/vector';
-// export {Segment, segment} from '../../src/classes/segment';
-// export {Line, line} from '../../src/classes/line';
-// export {Circle, circle} from '../../src/classes/circle';
-// export {Arc, arc} from '../../src/classes/arc';
-// export {Box, box} from '../../src/classes/box';
-// export {Edge} from '../../src/classes/edge';
-// export {Face} from '../../src/classes/face';
-// export {Ray, ray} from '../../src/classes/ray';
-// export {ray_shoot} from '../../src/algorithms/ray_shooting';
-// export {Polygon} from '../../src/classes/polygon';
-// export {Distance} from '../../src/algorithms/distance';
-//
-// export default Flatten;
-export {Utils, Errors} from 'flatten-js';
-export {Matrix, PlanarSet, Point, Vector, Segment, Line, Circle, Arc, Box, Edge, Face, Ray, Polygon} from 'flatten-js';
-export {matrix, point, vector, circle, line, segment, arc, box, ray} from 'flatten-js';
-export {ray_shoot} from 'flatten-js';
-export {default} from 'flatten-js';
+import Flatten from './src/flatten';
+import * as Utils from "./src/utils/utils";
+import * as Errors from "./src/utils/errors";
+
+export {Utils, Errors};
+export {Matrix, matrix} from './src/classes/matrix';
+export {PlanarSet} from './src/data_structures/planar_set';
+export {Point, point} from './src/classes/point';
+export {Vector, vector} from './src/classes/vector';
+export {Segment, segment} from './src/classes/segment';
+export {Line, line} from './src/classes/line';
+export {Circle, circle} from './src/classes/circle';
+export {Arc, arc} from './src/classes/arc';
+export {Box, box} from './src/classes/box';
+export {Edge} from './src/classes/edge';
+export {Face} from './src/classes/face';
+export {Ray, ray} from './src/classes/ray';
+export {ray_shoot} from './src/algorithms/ray_shooting';
+export {Polygon} from './src/classes/polygon';
+export {Distance} from './src/algorithms/distance';
+
+export default Flatten;

package.json

 {
   "name": "@flatten-js/core",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Javascript library for 2d geometry",
-  "main": "packages/core/dist/main.cjs.js",
-  "umd:main": "packages/core/dist/main.umd.js",
-  "unpkg": "packages/core/dist/main.umd.js",
-  "module": "packages/core/dist/main.esm.js",
-  "types": "packages/core/index.d.ts",
+  "main": "dist/main.cjs.js",
+  "umd:main": "dist/main.umd.js",
+  "unpkg": "dist/main.umd.js",
+  "module": "dist/main.esm.js",
+  "types": "index.d.ts",
   "scripts": {
@@ -14,4 +14,3 @@ "test": "mocha --require @babel/register --reporter spec",
     "generate-docs": "jsdoc -c ./.jsdoc.json --verbose",
-    "npm-publish-norun": "npm version patch; git push && git push --tags; npm publish",
-    "npm-publish": "npm publish --access public",
+    "npm-publish": "npm publish --tag beta",
     "cover": "istanbul cover ./node_modules/mocha/bin/_mocha -- --require @babel/register -R spec test/*",
@@ -46,5 +45,20 @@ "build": "rollup -c"
   },
+  "devDependencies": {
+    "@babel/cli": "^7.2.3",
+    "@babel/core": "^7.2.2",
+    "@babel/node": "^7.2.2",
+    "@babel/preset-env": "^7.3.1",
+    "@babel/register": "^7.0.0",
+    "chai": "^4.2.0",
+    "coveralls": "^3.0.2",
+    "istanbul": "^0.4.5",
+    "jsdoc": "^3.5.5",
+    "minami": "^1.2.3",
+    "mocha": "^5.2.0",
+    "rollup-plugin-node-resolve": "^4.0.0",
+    "rollup-plugin-terser": "^4.0.4"
+  },
   "dependencies": {
-    "flatten-js": "^1.0.1"
+    "flatten-interval-tree": "^0.3.4"
   }
 }

README.md

@@ -9,1 +9,99 @@ [![npm version](https://badge.fury.io/js/flatten-js.svg)](https://badge.fury.io/js/flatten-js)
 
+FlattenJS is a javascript library (about 50 Kb minified) for manipulating abstract geometrical shapes like point, vector, line, segment,
+circle, arc and polygon. Shapes may be organized into Planar Set - searchable container which support spatial queries.
+
+FlattenJS provides a lot of useful methods and algorithms like finding intersections, checking inclusion, calculating distance, apply
+transformations and more.
+Polygon model is rather comprehensive and supports multi polygons with many islands and holes. Edges of polygon may be circular arcs or segments.
+Some algorithms like [Boolean Operations](https://github.com/alexbol99/flatten-boolean-op) and [Offset](https://github.com/alexbol99/flatten-offset),
+implemented in separate packages.     
+ 
+This library designed to work in any modern browser as well as under nodejs.
+It is written in plain javascript with es6 syntax elements.
+You can use es5 precompiled bundled package (added in v0.6.2) if you need to support old browsers.
+
+TypeScript users may take advantage of static type checking with typescript definition file index.d.ts included into the package.
+
+FlattenJS does not concern too much about visualization.
+Anyway, all objects have svg() methods, that returns a string which may be inserted into SVG container. 
+This works pretty well together with  [d3js](https://d3js.org/) library. But it is definitely possible to create bridges to other graphic libraries.
+
+The best way to start working with FlattenJS is to use awesome [Observable](https://beta.observablehq.com/) javascript interactive notebooks.
+There are several FlattenJS tutorials published in Observable Notebooks, see below.
+
+Full documentation may be found [here](https://alexbol99.github.io/flatten-js/index.html)
+
+## Installation
+
+    npm install --save flatten-js
+
+## Usage
+
+Package may be required in different ways:
+
+##### Require as es6 module:
+```javascript
+    import Flatten from 'flatten-js';
+```
+
+##### Require as CommonJS package (nodejs) 
+```javascript
+    const Flatten = require('flatten-js');
+```
+
+##### Require minified package precompiled into UMD format.
+ [Observable](https://beta.observablehq.com/) notebooks requires this format.
+
+```javascript
+    const Flatten = require('flatten-js.umd.min.js');
+```
+
+##### Require precompiled to es5 package in Commonjs2 format.
+
+```javascript
+    import Flatten from "flatten-js/dist/flatten.commonjs2"
+```
+This package is not minified.
+
+This is the way you have to consume the package for [React](https://reactjs.org/) library, at least when you use
+[create-react-library](https://github.com/facebook/create-react-app) starter kit:
+```
+""
+    Some third-party packages don't compile their code to ES5 before publishing to npm.
+    This often causes problems in the ecosystem because neither browsers (except for most modern versions)
+    nor some tools currently support all ES6 features.
+    We recommend to publish code on npm as ES5 at least for a few more years.
+""    
+```
+You can see example of **FlattenJS + React** usage in [flatten-react-demo](https://github.com/alexbol99/flatten-react-demo) project.
+It is live [here](https://alexbol99.github.io/flatten-react-demo/). 
+Just clone it from the GitHub, install dependencies and start working using *npm start* or
+compile it to production using *npm run build*.
+
+## Example
+
+After module required, you can create some construction:
+```javascript
+    // extract object creators
+    let {point, circle, segment} = Flatten;
+
+    // make some construction
+    let s1 = segment(10,10,200,200);
+    let s2 = segment(10,160,200,30);
+    let c = circle(point(200, 110), 50);
+    let ip = s1.intersect(s2);
+```
+You may test the code above also in [NPM RunKit](https://npm.runkit.com/flatten-js)
+
+## Tutorials
+
+1. [![Getting Started](https://user-images.githubusercontent.com/6965440/41164953-0e3700b6-6b45-11e8-982f-de3c5bc2012d.PNG)](https://beta.observablehq.com/@alexbol99/flattenjs-tutorials-getting-started)
+2. [![Messing Around](https://user-images.githubusercontent.com/6965440/41164955-0e6019ec-6b45-11e8-9501-1565ccd75e0d.PNG)](https://beta.observablehq.com/@alexbol99/flattenjs-tutorials-messing-around)
+3. [![Planar Set](https://user-images.githubusercontent.com/6965440/41164948-0dde3b66-6b45-11e8-8a1a-b70f4ad228c1.PNG)](https://beta.observablehq.com/@alexbol99/flattenjs-tutorials-planar-set)
+4. [![polygons](https://user-images.githubusercontent.com/6965440/41164949-0e0ccd1e-6b45-11e8-9400-009c8ba6e7e3.PNG)](https://beta.observablehq.com/@alexbol99/flattenjs-tutorials-polygons)
+
+## Contacts
+
+Follow me on [Twitter](https://twitter.com/alex_bol_)
+
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 14 instances in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3906238

increased by571.57%

Number of package files

162

increased by1925%

Lines of code

22510

increased by53.25%

Number of lines in readme file

107

increased by1088.89%

Published versions last two months

1

increased byInfinity%

Worsened metrics

Dev dependency count

13

increased byInfinity%

Number of low license alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

14

increased byInfinity%

Dependency changes

• + Addedflatten-interval-tree@^0.3.4

• - Removedflatten-js@^1.0.1

• - Removedflatten-js@1.0.1(transitive)