Skip to content

Commit 9830fe3

Browse files
Add support for the new Elevation service via a new arcgis-rest-elevation package (#1190)
* feat(arcgis-rest-elevation): add basic package for elevation * test: remove fit and fdescribe * fix: remove duplicate error handling * chore: remove validation references * fix: add README.md and some optimization * fix: use appendCustomParams * fix: add appendCustomParams to at many points request * feat: switch to v1 url
1 parent 14df914 commit 9830fe3

26 files changed

+1343
-0
lines changed

demos/node-elevation-api/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
.env
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"result": {
3+
"points": [
4+
{
5+
"x": 1.2,
6+
"y": 3.4,
7+
"z": -4458,
8+
"spatialReference": {
9+
"wkid": 4326
10+
}
11+
},
12+
{
13+
"x": 1.23,
14+
"y": 3.45,
15+
"z": -4452,
16+
"spatialReference": {
17+
"wkid": 4326
18+
}
19+
}
20+
]
21+
},
22+
"elevationInfo": {
23+
"relativeTo": "meanSeaLevel"
24+
}
25+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"result": {
3+
"points": [
4+
{
5+
"x": 1.2,
6+
"y": 3.4,
7+
"z": -4441,
8+
"spatialReference": {
9+
"wkid": 4326
10+
}
11+
},
12+
{
13+
"x": 1.23,
14+
"y": 3.45,
15+
"z": -4435,
16+
"spatialReference": {
17+
"wkid": 4326
18+
}
19+
}
20+
]
21+
},
22+
"elevationInfo": {
23+
"relativeTo": "ellipsoid"
24+
}
25+
}
+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"result": {
3+
"point": {
4+
"x": -3.1883,
5+
"y": 55.9533,
6+
"z": 116,
7+
"spatialReference": {
8+
"wkid": 4326
9+
}
10+
}
11+
},
12+
"elevationInfo": {
13+
"relativeTo": "ellipsoid"
14+
}
15+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"result": {
3+
"point": {
4+
"x": -3.1883,
5+
"y": 55.9533,
6+
"z": 63,
7+
"spatialReference": {
8+
"wkid": 4326
9+
}
10+
}
11+
},
12+
"elevationInfo": {
13+
"relativeTo": "meanSeaLevel"
14+
}
15+
}

demos/node-elevation-api/index.ts

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
import { ApiKeyManager } from "@esri/arcgis-rest-request";
2+
import {
3+
findElevationAtPoint,
4+
findElevationAtManyPoints
5+
} from "@esri/arcgis-rest-elevation";
6+
import * as dotenv from "dotenv";
7+
import fs from "fs";
8+
9+
dotenv.config();
10+
11+
const authentication = ApiKeyManager.fromKey(process.env.API_KEY as string);
12+
13+
const atPointResponse = await findElevationAtPoint({
14+
lon: -3.1883,
15+
lat: 55.9533,
16+
relativeTo: "ellipsoid",
17+
authentication
18+
});
19+
20+
fs.promises.writeFile(
21+
"./atPoint.mock.json",
22+
JSON.stringify(atPointResponse, null, 2)
23+
);
24+
25+
console.log("Found elevation for atPoint (ellipsoid):", atPointResponse);
26+
27+
const atPointDefaultResponse = await findElevationAtPoint({
28+
lon: -3.1883,
29+
lat: 55.9533,
30+
authentication
31+
});
32+
33+
fs.promises.writeFile(
34+
"./atPointDefault.mock.json",
35+
JSON.stringify(atPointDefaultResponse, null, 2)
36+
);
37+
38+
console.log(
39+
"Found elevation for atPoint (mean sea level):",
40+
atPointDefaultResponse
41+
);
42+
43+
const atManyPointsDefaultResponse = await findElevationAtManyPoints({
44+
coordinates: [
45+
[1.2, 3.4],
46+
[1.23, 3.45]
47+
],
48+
authentication
49+
});
50+
51+
fs.promises.writeFile(
52+
"./atManyPointsDefault.mock.json",
53+
JSON.stringify(atManyPointsDefaultResponse, null, 2)
54+
);
55+
56+
console.log(
57+
"Found elevation for atManyPoints (mean sea level):",
58+
atManyPointsDefaultResponse
59+
);
60+
61+
const atManyPointsEllipsoidResponse = await findElevationAtManyPoints({
62+
coordinates: [
63+
[1.2, 3.4],
64+
[1.23, 3.45]
65+
],
66+
relativeTo: "ellipsoid",
67+
authentication
68+
});
69+
70+
fs.promises.writeFile(
71+
"./atManyPointsEllipsoid.mock.json",
72+
JSON.stringify(atManyPointsEllipsoidResponse, null, 2)
73+
);
74+
75+
console.log(
76+
"Found elevation for atManyPoints (ellipsoid):",
77+
atManyPointsEllipsoidResponse
78+
);

demos/node-elevation-api/package.json

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"private": true,
3+
"name": "node-elevation-api",
4+
"version": "1.0.0",
5+
"description": "",
6+
"license": "MIT",
7+
"keywords": [],
8+
"type": "module",
9+
"main": "index.js",
10+
"scripts": {
11+
"start": "ts-node index.ts"
12+
},
13+
"dependencies": {
14+
"@esri/arcgis-rest-elevation": "^1.0.0-beta.1",
15+
"@esri/arcgis-rest-request": "^4.0.0"
16+
},
17+
"devDependencies": {
18+
"ts-node": "^10.7.0",
19+
"typescript": "^4.6.2"
20+
},
21+
"author": "Sheryl Tania",
22+
"volta": {
23+
"node": "16.14.0",
24+
"npm": "8.5.3"
25+
}
26+
}

demos/node-elevation-api/readme.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Basic demo of the Elevation API
2+
3+
1. Copy `.env.template` to `.env` and add your own API key which has the elevation service privilege enabled.
4+
2. Run the following commands:
5+
6+
```bash
7+
npm install
8+
npm run start
9+
```
+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig.json to read more about this file */
4+
5+
/* Projects */
6+
// "incremental": true, /* Enable incremental compilation */
7+
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8+
// "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
9+
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
10+
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11+
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12+
13+
/* Language and Environment */
14+
"target": "es2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
15+
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
16+
// "jsx": "preserve", /* Specify what JSX code is generated. */
17+
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
18+
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19+
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
20+
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21+
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
22+
// "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
23+
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24+
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25+
26+
/* Modules */
27+
"module": "esnext", /* Specify what module code is generated. */
28+
// "rootDir": "./", /* Specify the root folder within your source files. */
29+
"moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
30+
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
31+
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
32+
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
33+
// "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
34+
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
35+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
36+
// "resolveJsonModule": true, /* Enable importing .json files */
37+
// "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
38+
39+
/* JavaScript Support */
40+
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
41+
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
42+
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
43+
44+
/* Emit */
45+
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
46+
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
47+
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
48+
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
49+
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
50+
// "outDir": "./", /* Specify an output folder for all emitted files. */
51+
// "removeComments": true, /* Disable emitting comments. */
52+
// "noEmit": true, /* Disable emitting files from a compilation. */
53+
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
54+
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
55+
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
56+
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
57+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
58+
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
59+
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
60+
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
61+
// "newLine": "crlf", /* Set the newline character for emitting files. */
62+
// "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
63+
// "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
64+
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
65+
// "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
66+
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
67+
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
68+
69+
/* Interop Constraints */
70+
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
71+
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
72+
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
73+
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
74+
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
75+
76+
/* Type Checking */
77+
"strict": true, /* Enable all strict type-checking options. */
78+
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
79+
// "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
80+
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
81+
// "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
82+
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
83+
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
84+
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
85+
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
86+
// "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
87+
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
88+
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
89+
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
90+
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
91+
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
92+
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
93+
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
94+
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
95+
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
96+
97+
/* Completeness */
98+
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
99+
"skipLibCheck": true /* Skip type checking all .d.ts files. */
100+
},
101+
"ts-node": {
102+
"esm": true
103+
}
104+
}

package-lock.json

+51
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)