ogcopenapis 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +60 -0
- package/package.json +32 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2019 felipecarrillo100
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# OGC OPEN API's prototype for LuciadRIA
|
|
2
|
+
|
|
3
|
+
## Description
|
|
4
|
+
The ogcopenapis package provides OGC API functionalities to LuciadRIA Application.
|
|
5
|
+
|
|
6
|
+
In this version:
|
|
7
|
+
* Only Open API Features is implemented
|
|
8
|
+
|
|
9
|
+
In future versions
|
|
10
|
+
* Open API Tiles will be implemented
|
|
11
|
+
* Open API Maps will be implemented
|
|
12
|
+
|
|
13
|
+
The Main Components are:
|
|
14
|
+
|
|
15
|
+
* OgcOpenApiFeatureStore a ready to use store capable to retrieve features from an OGC API Service
|
|
16
|
+
* OgcOpenApiGetCapabilities a helper to retrieve the capabilities of a server such as available Collections and Formats
|
|
17
|
+
|
|
18
|
+
Additional components will be added in future versions for Maps and Tiles
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## To build
|
|
22
|
+
This is the source code of an npm package. To build install and build the library. This will create a lib folder with the transpiled library.
|
|
23
|
+
```
|
|
24
|
+
npm install
|
|
25
|
+
npm run build
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## To test
|
|
29
|
+
Some test have been added that run in nodejs. No browser test is available at the moment.
|
|
30
|
+
To run the test make sure you are using nodejs > 18 as function fetch is required.
|
|
31
|
+
```
|
|
32
|
+
npm run test
|
|
33
|
+
```
|
|
34
|
+
Test use the sever-side implementation of OGC Open API Features at "https://demo.pygeoapi.io/master/"
|
|
35
|
+
The server is reliable ans stable, but take in t account that changes at the server may brake some tests.
|
|
36
|
+
|
|
37
|
+
## To use
|
|
38
|
+
|
|
39
|
+
Simply import the NPM package in to your project
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
npm install ogcopenapis
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
If you require the GetCapabilities functionality then also import:
|
|
46
|
+
```
|
|
47
|
+
import {
|
|
48
|
+
CollectionLinkType, OgcOpenApiGetCapabilities
|
|
49
|
+
} from 'ogcopenapis/OgcOpenApiGetCapabilities';
|
|
50
|
+
|
|
51
|
+
import {
|
|
52
|
+
OgcOpenApiFeatureStore.ts, OgcOpenApiGetCapabilities
|
|
53
|
+
} from 'ogcopenapis/OgcOpenApiFeatureStore.ts';
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
At this moment you should be ready to use the functionality.
|
|
57
|
+
|
|
58
|
+
## Requirements.
|
|
59
|
+
* LuciadRIA 2020.0 or higher (place it on a local npm repository for instance verdaccio )
|
|
60
|
+
* A ES6 or Typescript capable transpiler.
|
package/package.json
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "ogcopenapis",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "",
|
|
5
|
+
"files": [
|
|
6
|
+
"lib/"
|
|
7
|
+
],
|
|
8
|
+
"scripts": {
|
|
9
|
+
"test": "jest",
|
|
10
|
+
"transpile": "tsc -p tsconfig.json",
|
|
11
|
+
"copyjs": "copyfiles -u 1 \"src/**/*.js\" ./lib",
|
|
12
|
+
"copycss": "copyfiles -u 1 \"src/**/*.css\" ./lib",
|
|
13
|
+
"copyscss": "copyfiles -u 1 \"src/**/*.scss\" ./lib",
|
|
14
|
+
"copysvg": "copyfiles -u 1 \"src/**/*.svg\" ./lib",
|
|
15
|
+
"copyfonts": "copyfiles -u 1 \"src/fonts/**\" ./lib",
|
|
16
|
+
"build": "npm run transpile && npm run copyjs && npm run copycss && npm run copyscss && npm run copysvg && npm run copyfonts"
|
|
17
|
+
},
|
|
18
|
+
"keywords": [],
|
|
19
|
+
"author": "",
|
|
20
|
+
"license": "ISC",
|
|
21
|
+
"devDependencies": {
|
|
22
|
+
"@babel/preset-env": "^7.20.2",
|
|
23
|
+
"@babel/preset-typescript": "^7.18.6",
|
|
24
|
+
"@jest/globals": "^29.3.1",
|
|
25
|
+
"copyfiles": "^2.3.0",
|
|
26
|
+
"jest": "^29.3.1",
|
|
27
|
+
"typescript": "^4.6.3"
|
|
28
|
+
},
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"@luciad/ria": ">=2020.0"
|
|
31
|
+
}
|
|
32
|
+
}
|