Merge pull request #3 from vojtatom/dev

Updated exports, licensing terms and tests

LICENCE.md

@@ -0,0 +1,49 @@
+MIT License
+
+Copyright (c) 2023 vojtatom
+
+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.
+
+## Third-Party Code
+
+shp.ts uses the following third-party code:
+
+### [ts-shapefile](https://github.com/oyvindi/ts-shapefile/)
+
+> MIT License
+>
+> Copyright (c) 2020 oyvindi
+>
+> 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.json

@@ -1,7 +1,7 @@
 {
     "name": "shpts",
     "private": false,
-    "version": "1.0.1",
+    "version": "1.0.2",
     "type": "module",
     "repository": {
         "type": "git",
@@ -24,7 +24,7 @@
     ],
     "main": "./dist/shpts.umd.js",
     "module": "./dist/shpts.js",
-    "types": "./dist/shpts/shpts.d.ts",
+    "types": "./dist/shpts.d.ts",
     "exports": {
         ".": {
             "import": "./dist/shpts.js",

shpts/shpts.ts

@@ -9,17 +9,22 @@ import { PointRecord } from './geometry/point';
 import { MultiPointRecord } from './geometry/multipoint';
 import { MultiPatchRecord } from './geometry/multipatch';
 import { DbfRecord } from './table/record';
+import { DbfFieldDescr, DbfFieldType } from './types/dbfTypes';
+import { Coord, CoordType } from './types/coordinate';
 
 export {
     DbfReader,
     DbfRecord,
     ShapeReader,
-    FeatureCollection as ShapeFeatureCollection,
-    Feature as ShapeFeature,
-    FeatureReader as ShapeFeatureReader,
+    FeatureCollection,
+    Feature,
+    FeatureReader,
     PolygonRecord,
     PolyLineRecord,
     PointRecord,
     MultiPointRecord,
     MultiPatchRecord,
+    CoordType,
 };
+
+export type { DbfFieldType, DbfFieldDescr, Coord };

test/dbf.test.ts

@@ -1,7 +1,6 @@
-import { DbfFieldDescr, DbfFieldType } from '@shpts/types/dbfTypes';
+import { DbfFieldDescr, DbfFieldType, DbfReader } from '@shpts/shpts';
 import { expect, test } from 'vitest';
 import { openFileAsArray } from './utils';
-import { DbfReader } from '@shpts/reader/dbfReader';
 
 function expectField(
     field: DbfFieldDescr,

test/features.test.ts

@@ -1,7 +1,6 @@
 import { expect, test } from 'vitest';
 import { expectPointsEqual, openFileAsArray } from './utils';
-import { FeatureReader } from '@shpts/reader/featureReader';
-import { PolyLineRecord } from '@shpts/geometry/polyline';
+import { FeatureReader, PolyLineRecord } from '@shpts/shpts';
 
 test('Read feature OK', async () => {
     const shp = openFileAsArray('testdata/featureclass.shp');

test/multipatch.test.ts

@@ -1,8 +1,6 @@
 import { expect, test } from 'vitest';
-import { ShapeReader } from '@shpts/reader/shpReader';
-import { expectGeometry, expectPointsEqual, expectRing, openFileAsArray } from './utils';
-import { MultiPatchRecord } from '@shpts/geometry/multipatch';
-import { CoordType, Coord } from '@shpts/types/coordinate';
+import { expectGeometry, expectRing, openFileAsArray } from './utils';
+import { ShapeReader, MultiPatchRecord, CoordType } from '@shpts/shpts';
 
 test('Reading MultiPatchRecord with Z', async () => {
     const shpBuffer = openFileAsArray('testdata/multipatch.shp');

test/multipoint.test.ts

@@ -1,8 +1,6 @@
 import { expect, test } from 'vitest';
-import { ShapeReader } from '@shpts/reader/shpReader';
 import { expectGeometry, expectPointsEqual, openFileAsArray } from './utils';
-import { MultiPointRecord } from '@shpts/geometry/multipoint';
-import { CoordType } from '@shpts/types/coordinate';
+import { ShapeReader, MultiPointRecord, CoordType } from '@shpts/shpts';
 
 test('Reading PointRecord', async () => {
     const shpBuffer = openFileAsArray('testdata/multipoint.shp');

test/orientation.test.ts

@@ -1,5 +1,5 @@
 import { expect, test } from 'vitest';
-import { CoordType, Coord } from '@shpts/types/coordinate';
+import { Coord } from '@shpts/types/coordinate';
 import { assemblePolygonsWithHoles } from '@shpts/utils/orientation';
 
 test('Testing orientiton for vertical polygons', async () => {

test/point.test.ts

@@ -1,8 +1,6 @@
 import { test } from 'vitest';
-import { ShapeReader } from '@shpts/reader/shpReader';
 import { expectGeometry, expectPointsEqual, openFileAsArray } from './utils';
-import { PointRecord } from '@shpts/geometry/point';
-import { CoordType } from '@shpts/types/coordinate';
+import { ShapeReader, PointRecord, CoordType } from '@shpts/shpts';
 
 test('Reading PointRecord', async () => {
     const shpBuffer = openFileAsArray('testdata/point.shp');

test/polygon.test.ts

@@ -1,8 +1,6 @@
 import { expect, test } from 'vitest';
-import { ShapeReader } from '@shpts/reader/shpReader';
 import { expectGeometry, expectRing, openFileAsArray } from './utils';
-import { PolygonRecord } from '@shpts/geometry/polygon';
-import { CoordType } from '@shpts/types/coordinate';
+import { ShapeReader, PolygonRecord, CoordType } from '@shpts/shpts';
 
 test('Reading PolygonRecord', async () => {
     const shpBuffer = openFileAsArray('testdata/polygon.shp');

test/polyline.test.ts

@@ -1,8 +1,6 @@
 import { expect, test } from 'vitest';
-import { ShapeReader } from '@shpts/reader/shpReader';
 import { expectGeometry, expectPointsEqual, openFileAsArray } from './utils';
-import { PolyLineRecord } from '@shpts/geometry/polyline';
-import { CoordType } from '@shpts/types/coordinate';
+import { ShapeReader, PolyLineRecord, CoordType } from '@shpts/shpts';
 
 test('Reading PolyLineRecord', async () => {
     const shpBuffer = openFileAsArray('testdata/polyline.shp');

test/utils.ts

@@ -1,5 +1,4 @@
-import { ShapeReader } from '@shpts/reader/shpReader';
-import { Coord, CoordType } from '@shpts/types/coordinate';
+import { ShapeReader, Coord, CoordType } from '@shpts/shpts';
 import fs from 'fs';
 import { expect } from 'vitest';