@esri/arcgis-rest-elevation 1.0.0

package/README.md

@@ -0,0 +1,84 @@
+[![npm version][npm-img]][npm-url]
+[![gzip bundle size][gzip-image]][npm-url]
+[![Coverage Status][coverage-img]][coverage-url]
+[![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/arcgis-rest-js/master/LICENSE)
+
+[npm-img]: https://img.shields.io/npm/v/@esri/arcgis-rest-elevation.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-elevation
+[gzip-image]: https://img.badgesize.io/https://unpkg.com/@esri/arcgis-rest-elevation/dist/bundled/elevation.umd.min.js?compression=gzip
+[coverage-img]: https://codecov.io/gh/Esri/arcgis-rest-js/branch/master/graph/badge.svg
+[coverage-url]: https://codecov.io/gh/Esri/arcgis-rest-js
+
+# @esri/arcgis-rest-places
+
+> A wrapper class to access the ArcGIS Elevation service for [`@esri/arcgis-rest-request`](https://github.com/Esri/arcgis-rest-js).
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+npm install @esri/arcgis-rest-elevation
+```
+
+```js
+import { findElevationAtPoint } from "@esri/arcgis-rest-elevation";
+import { ApiKeyManager } from "@esri/arcgis-rest-request";
+
+const response = await findElevationAtPoint({
+ lon: -179.99,
+ lat: -85.05,
+ authentication: ApiKeyManager.fromKey("YOUR_ACCESS_TOKEN");
+});
+
+console.log(response.result.point.z)
+```
+
+### API Reference
+
+@TODO
+
+### Issues
+
+If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first. Have you found a new bug? Want to request a new feature? We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you.
+
+If you're looking for help you can also post issues on [GIS Stackexchange](http://gis.stackexchange.com/questions/ask?tags=esri-oss).
+
+### Versioning
+
+For transparency into the release cycle and in striving to maintain backward compatibility, @esri/arcgis-rest-js is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible.
+
+For more information on SemVer, please visit <http://semver.org/>.
+
+### Contributing
+
+Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](CONTRIBUTING.md).
+
+### Generating Types from Open API
+
+The places service publishes an Open API definition. Eventually this will live at a public URL on the service itself. However for now it lives inside the Esri internal GitHub Enterprise installation. To generate the types view the raw file on GitHub Enterprise and replace the URL below.
+
+```
+npx openapi-typescript@5 URL_TO_RAW_SPEC_FILE --output packages/arcgis-rest-places/src/openapi-types.ts
+```
+
+The generated types are used in the interfaces for ArcGIS REST JS.
+
+### [Changelog](https://github.com/Esri/arcgis-rest-js/blob/master/CHANGELOG.md)
+
+### License
+
+Copyright &copy; 2023 Esri
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+> http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+A copy of the license is available in the repository's [LICENSE](../../LICENSE) file.

package/dist/bundled/elevation.esm.js

@@ -0,0 +1,84 @@
+/* @preserve
+* @esri/arcgis-rest-elevation - v1.0.0 - Apache-2.0
+* Copyright (c) 2017-2025 Esri, Inc.
+* Thu Jan 30 2025 15:44:10 GMT+0000 (Coordinated Universal Time)
+*/
+import { appendCustomParams, request } from '@esri/arcgis-rest-request';
+
+const baseUrl = "https://elevation-api.arcgis.com/arcgis/rest/services/elevation-service/v1";
+
+/**
+ * This method returns the elevation in meters at a given longitude and latitude
+ * within the WGS84 coordinate system. By default the elevation is measured with
+ * respect to the Earth's mean sea level. It takes into account the local
+ * variations in gravity and provides a consistent vertical reference.
+ *
+ * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be
+ * measured with respect to the ellipsoid. This is a mathematical model that
+ * approximates the shape of the Earth. It does not consider local variations
+ * in gravity and is commonly used in GPS positioning.
+ *
+ * ```
+ * import { findElevationAtPoint } from "@esri/arcgis-rest-elevation";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const results = await findElevationAtPoint({
+ *   lon: -179.99,
+ *   lat: -85.05,
+ *   authentication: ApiKeyManager.fromKey("YOUR_ACCESS_TOKEN");
+ * });
+ *
+ * console.log(results)
+ * ```
+ */
+function findElevationAtPoint(requestOptions) {
+    const options = appendCustomParams(requestOptions, ["lon", "lat", "relativeTo"], Object.assign({}, requestOptions));
+    return request(`${baseUrl}/elevation/at-point`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
+        const r = Object.assign({}, response);
+        return r;
+    });
+}
+
+/**
+ * This method returns elevations in meters at given longitudes and latitudes
+ * within the WGS84 coordinate system. The order of the points returned by this
+ * request will be the same as the order of the points passed in the coordinates
+ * parameter.
+ *
+ * If the distance between the furthest West and furthest East coordinate or
+ * the furthest North and furthest South coordinate exceeds 50km, the service
+ * will return a 400 HTTP response as the distance between these points is too
+ * large.
+ *
+ * By default the elevation is measured with respect to the Earth's mean sea level.
+ * It takes into account the local variations in gravity and provides a consistent
+ * vertical reference.
+ *
+ * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be
+ * measured with respect to the ellipsoid. This is a mathematical model that
+ * approximates the shape of the Earth. It does not consider local variations
+ * in gravity and is commonly used in GPS positioning.
+ *
+ * ```
+ * import { findElevationAtManyPoints } from "@esri/arcgis-rest-elevation";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const results = await findElevationAtManyPoints({
+ *   coordinates: [[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]],
+ *   authentication: ApiKeyManager.fromKey("YOUR_ACCESS_TOKEN");
+ * });
+ *
+ * console.log(results)
+ * ```
+ */
+function findElevationAtManyPoints(requestOptions) {
+    const options = appendCustomParams(requestOptions, ["relativeTo"], Object.assign({}, requestOptions));
+    options.params.coordinates = JSON.stringify(requestOptions.coordinates);
+    return request(`${baseUrl}/elevation/at-many-points`, Object.assign({}, options)).then((response) => {
+        const r = Object.assign({}, response);
+        return r;
+    });
+}
+
+export { findElevationAtManyPoints, findElevationAtPoint };
+//# sourceMappingURL=elevation.esm.js.map

package/dist/bundled/elevation.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"elevation.esm.js","sources":["../../src/utils.ts","../../src/findElevationAtPoint.ts","../../src/findElevationAtManyPoints.ts"],"sourcesContent":["export const baseUrl =\n  \"https://elevation-api.arcgis.com/arcgis/rest/services/elevation-service/v1\";\n","import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"ElevationAtPointGet\"][\"parameters\"][\"query\"],\n  \"lon\" | \"lat\" | \"relativeTo\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"ElevationAtPointGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findElevationAtPoint};\n */\nexport interface IFindElevationAtPointResponse extends successResponse {}\n\n/**\n * Options for {@linkcode findElevationAtPoint}.\n */\nexport interface IFindElevationAtPointOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * This method returns the elevation in meters at a given longitude and latitude\n * within the WGS84 coordinate system. By default the elevation is measured with\n * respect to the Earth's mean sea level. It takes into account the local\n * variations in gravity and provides a consistent vertical reference.\n *\n * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be\n * measured with respect to the ellipsoid. This is a mathematical model that\n * approximates the shape of the Earth. It does not consider local variations\n * in gravity and is commonly used in GPS positioning.\n *\n * ```\n * import { findElevationAtPoint } from \"@esri/arcgis-rest-elevation\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findElevationAtPoint({\n *   lon: -179.99,\n *   lat: -85.05,\n *   authentication: ApiKeyManager.fromKey(\"YOUR_ACCESS_TOKEN\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findElevationAtPoint(\n  requestOptions: IFindElevationAtPointOptions\n): Promise<IFindElevationAtPointResponse> {\n  const options = appendCustomParams<IFindElevationAtPointOptions>(\n    requestOptions,\n    [\"lon\", \"lat\", \"relativeTo\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(`${baseUrl}/elevation/at-point`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindElevationAtPointResponse = {\n      ...response\n    };\n\n    return r;\n  });\n}\n","import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"ElevationAtManyPointsPost\"][\"requestBody\"][\"content\"][\"application/json\"],\n  \"coordinates\" | \"relativeTo\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"ElevationAtManyPointsPost\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findElevationAtPoint};\n */\nexport interface IFindElevationAtManyPointsResponse extends successResponse {}\n\n/**\n * Options for {@linkcode findElevationAtPoint}.\n */\nexport interface IFindElevationAtManyPointsOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * This method returns elevations in meters at given longitudes and latitudes\n * within the WGS84 coordinate system. The order of the points returned by this\n * request will be the same as the order of the points passed in the coordinates\n * parameter.\n *\n * If the distance between the furthest West and furthest East coordinate or\n * the furthest North and furthest South coordinate exceeds 50km, the service\n * will return a 400 HTTP response as the distance between these points is too\n * large.\n *\n * By default the elevation is measured with respect to the Earth's mean sea level.\n * It takes into account the local variations in gravity and provides a consistent\n * vertical reference.\n *\n * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be\n * measured with respect to the ellipsoid. This is a mathematical model that\n * approximates the shape of the Earth. It does not consider local variations\n * in gravity and is commonly used in GPS positioning.\n *\n * ```\n * import { findElevationAtManyPoints } from \"@esri/arcgis-rest-elevation\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findElevationAtManyPoints({\n *   coordinates: [[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]],\n *   authentication: ApiKeyManager.fromKey(\"YOUR_ACCESS_TOKEN\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findElevationAtManyPoints(\n  requestOptions: IFindElevationAtManyPointsOptions\n): Promise<IFindElevationAtManyPointsResponse> {\n  const options: any = appendCustomParams<IFindElevationAtManyPointsOptions>(\n    requestOptions,\n    [\"relativeTo\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  options.params.coordinates = JSON.stringify(requestOptions.coordinates);\n\n  return (\n    request(`${baseUrl}/elevation/at-many-points`, {\n      ...options\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindElevationAtManyPointsResponse = {\n      ...response\n    };\n\n    return r;\n  });\n}\n"],"names":[],"mappings":";;;;;;;AAAO,MAAM,OAAO,GAClB,4EAA4E;;AC+B9E;;;;;;;;;;;;;;;;;;;;;;;;SAwBgB,oBAAoB,CAClC,cAA4C;IAE5C,MAAM,OAAO,GAAG,kBAAkB,CAChC,cAAc,EACd,CAAC,KAAK,EAAE,KAAK,EAAE,YAAY,CAAC,oBAEvB,cAAc,EAEpB,CAAC;IAEF,OACE,OAAO,CAAC,GAAG,OAAO,qBAAqB,kCAClC,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC,IAAI,CAAC,CAAC,QAAQ;QACd,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;QAEF,OAAO,CAAC,CAAC;KACV,CAAC,CAAC;AACL;;AC/CA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAgCgB,yBAAyB,CACvC,cAAiD;IAEjD,MAAM,OAAO,GAAQ,kBAAkB,CACrC,cAAc,EACd,CAAC,YAAY,CAAC,oBAET,cAAc,EAEpB,CAAC;IAEF,OAAO,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAExE,OACE,OAAO,CAAC,GAAG,OAAO,2BAA2B,oBACxC,OAAO,EAEb,CAAC,IAAI,CAAC,CAAC,QAAQ;QACd,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;QAEF,OAAO,CAAC,CAAC;KACV,CAAC,CAAC;AACL;;;;"}

package/dist/bundled/elevation.esm.min.js

@@ -0,0 +1,7 @@
+/* @preserve
+* @esri/arcgis-rest-elevation - v1.0.0 - Apache-2.0
+* Copyright (c) 2017-2025 Esri, Inc.
+* Thu Jan 30 2025 15:44:10 GMT+0000 (Coordinated Universal Time)
+*/
+import{appendCustomParams as t,request as e}from"@esri/arcgis-rest-request";const s="https://elevation-api.arcgis.com/arcgis/rest/services/elevation-service/v1";function i(i){const n=t(i,["lon","lat","relativeTo"],Object.assign({},i));return e(`${s}/elevation/at-point`,Object.assign(Object.assign({},n),{httpMethod:"GET"})).then((t=>Object.assign({},t)))}function n(i){const n=t(i,["relativeTo"],Object.assign({},i));return n.params.coordinates=JSON.stringify(i.coordinates),e(`${s}/elevation/at-many-points`,Object.assign({},n)).then((t=>Object.assign({},t)))}export{n as findElevationAtManyPoints,i as findElevationAtPoint};
+//# sourceMappingURL=elevation.esm.min.js.map

package/dist/bundled/elevation.esm.min.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"elevation.esm.min.js","sources":["../../src/utils.ts","../../src/findElevationAtPoint.ts","../../src/findElevationAtManyPoints.ts"],"sourcesContent":["export const baseUrl =\n  \"https://elevation-api.arcgis.com/arcgis/rest/services/elevation-service/v1\";\n","import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"ElevationAtPointGet\"][\"parameters\"][\"query\"],\n  \"lon\" | \"lat\" | \"relativeTo\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"ElevationAtPointGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findElevationAtPoint};\n */\nexport interface IFindElevationAtPointResponse extends successResponse {}\n\n/**\n * Options for {@linkcode findElevationAtPoint}.\n */\nexport interface IFindElevationAtPointOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * This method returns the elevation in meters at a given longitude and latitude\n * within the WGS84 coordinate system. By default the elevation is measured with\n * respect to the Earth's mean sea level. It takes into account the local\n * variations in gravity and provides a consistent vertical reference.\n *\n * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be\n * measured with respect to the ellipsoid. This is a mathematical model that\n * approximates the shape of the Earth. It does not consider local variations\n * in gravity and is commonly used in GPS positioning.\n *\n * ```\n * import { findElevationAtPoint } from \"@esri/arcgis-rest-elevation\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findElevationAtPoint({\n *   lon: -179.99,\n *   lat: -85.05,\n *   authentication: ApiKeyManager.fromKey(\"YOUR_ACCESS_TOKEN\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findElevationAtPoint(\n  requestOptions: IFindElevationAtPointOptions\n): Promise<IFindElevationAtPointResponse> {\n  const options = appendCustomParams<IFindElevationAtPointOptions>(\n    requestOptions,\n    [\"lon\", \"lat\", \"relativeTo\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(`${baseUrl}/elevation/at-point`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindElevationAtPointResponse = {\n      ...response\n    };\n\n    return r;\n  });\n}\n","import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"ElevationAtManyPointsPost\"][\"requestBody\"][\"content\"][\"application/json\"],\n  \"coordinates\" | \"relativeTo\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"ElevationAtManyPointsPost\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findElevationAtPoint};\n */\nexport interface IFindElevationAtManyPointsResponse extends successResponse {}\n\n/**\n * Options for {@linkcode findElevationAtPoint}.\n */\nexport interface IFindElevationAtManyPointsOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * This method returns elevations in meters at given longitudes and latitudes\n * within the WGS84 coordinate system. The order of the points returned by this\n * request will be the same as the order of the points passed in the coordinates\n * parameter.\n *\n * If the distance between the furthest West and furthest East coordinate or\n * the furthest North and furthest South coordinate exceeds 50km, the service\n * will return a 400 HTTP response as the distance between these points is too\n * large.\n *\n * By default the elevation is measured with respect to the Earth's mean sea level.\n * It takes into account the local variations in gravity and provides a consistent\n * vertical reference.\n *\n * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be\n * measured with respect to the ellipsoid. This is a mathematical model that\n * approximates the shape of the Earth. It does not consider local variations\n * in gravity and is commonly used in GPS positioning.\n *\n * ```\n * import { findElevationAtManyPoints } from \"@esri/arcgis-rest-elevation\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findElevationAtManyPoints({\n *   coordinates: [[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]],\n *   authentication: ApiKeyManager.fromKey(\"YOUR_ACCESS_TOKEN\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findElevationAtManyPoints(\n  requestOptions: IFindElevationAtManyPointsOptions\n): Promise<IFindElevationAtManyPointsResponse> {\n  const options: any = appendCustomParams<IFindElevationAtManyPointsOptions>(\n    requestOptions,\n    [\"relativeTo\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  options.params.coordinates = JSON.stringify(requestOptions.coordinates);\n\n  return (\n    request(`${baseUrl}/elevation/at-many-points`, {\n      ...options\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindElevationAtManyPointsResponse = {\n      ...response\n    };\n\n    return r;\n  });\n}\n"],"names":["baseUrl","findElevationAtPoint","requestOptions","options","appendCustomParams","request","httpMethod","then","response","findElevationAtManyPoints","params","coordinates","JSON","stringify"],"mappings":";;;;;4EAAO,MAAMA,EACX,sFCuDcC,EACdC,GAEA,MAAMC,EAAUC,EACdF,EACA,CAAC,MAAO,MAAO,+BAEVA,IAIP,OACEG,EAAQ,GAAGL,sDACNG,IACHG,WAAY,SAEdC,MAAMC,oBAEDA,IAKT,UCfgBC,EACdP,GAEA,MAAMC,EAAeC,EACnBF,EACA,CAAC,+BAEIA,IAMP,OAFAC,EAAQO,OAAOC,YAAcC,KAAKC,UAAUX,EAAeS,aAGzDN,EAAQ,GAAGL,8CACNG,IAELI,MAAMC,oBAEDA,IAKT"}

package/dist/bundled/elevation.umd.js

@@ -0,0 +1,93 @@
+/* @preserve
+* @esri/arcgis-rest-elevation - v1.0.0 - Apache-2.0
+* Copyright (c) 2017-2025 Esri, Inc.
+* Thu Jan 30 2025 15:44:10 GMT+0000 (Coordinated Universal Time)
+*/
+(function (global, factory) {
+  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@esri/arcgis-rest-request')) :
+  typeof define === 'function' && define.amd ? define(['exports', '@esri/arcgis-rest-request'], factory) :
+  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.arcgisRest = global.arcgisRest || {}, global.arcgisRest));
+})(this, (function (exports, arcgisRestRequest) { 'use strict';
+
+  const baseUrl = "https://elevation-api.arcgis.com/arcgis/rest/services/elevation-service/v1";
+
+  /**
+   * This method returns the elevation in meters at a given longitude and latitude
+   * within the WGS84 coordinate system. By default the elevation is measured with
+   * respect to the Earth's mean sea level. It takes into account the local
+   * variations in gravity and provides a consistent vertical reference.
+   *
+   * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be
+   * measured with respect to the ellipsoid. This is a mathematical model that
+   * approximates the shape of the Earth. It does not consider local variations
+   * in gravity and is commonly used in GPS positioning.
+   *
+   * ```
+   * import { findElevationAtPoint } from "@esri/arcgis-rest-elevation";
+   * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+   *
+   * const results = await findElevationAtPoint({
+   *   lon: -179.99,
+   *   lat: -85.05,
+   *   authentication: ApiKeyManager.fromKey("YOUR_ACCESS_TOKEN");
+   * });
+   *
+   * console.log(results)
+   * ```
+   */
+  function findElevationAtPoint(requestOptions) {
+      const options = arcgisRestRequest.appendCustomParams(requestOptions, ["lon", "lat", "relativeTo"], Object.assign({}, requestOptions));
+      return arcgisRestRequest.request(`${baseUrl}/elevation/at-point`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
+          const r = Object.assign({}, response);
+          return r;
+      });
+  }
+
+  /**
+   * This method returns elevations in meters at given longitudes and latitudes
+   * within the WGS84 coordinate system. The order of the points returned by this
+   * request will be the same as the order of the points passed in the coordinates
+   * parameter.
+   *
+   * If the distance between the furthest West and furthest East coordinate or
+   * the furthest North and furthest South coordinate exceeds 50km, the service
+   * will return a 400 HTTP response as the distance between these points is too
+   * large.
+   *
+   * By default the elevation is measured with respect to the Earth's mean sea level.
+   * It takes into account the local variations in gravity and provides a consistent
+   * vertical reference.
+   *
+   * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be
+   * measured with respect to the ellipsoid. This is a mathematical model that
+   * approximates the shape of the Earth. It does not consider local variations
+   * in gravity and is commonly used in GPS positioning.
+   *
+   * ```
+   * import { findElevationAtManyPoints } from "@esri/arcgis-rest-elevation";
+   * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+   *
+   * const results = await findElevationAtManyPoints({
+   *   coordinates: [[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]],
+   *   authentication: ApiKeyManager.fromKey("YOUR_ACCESS_TOKEN");
+   * });
+   *
+   * console.log(results)
+   * ```
+   */
+  function findElevationAtManyPoints(requestOptions) {
+      const options = arcgisRestRequest.appendCustomParams(requestOptions, ["relativeTo"], Object.assign({}, requestOptions));
+      options.params.coordinates = JSON.stringify(requestOptions.coordinates);
+      return arcgisRestRequest.request(`${baseUrl}/elevation/at-many-points`, Object.assign({}, options)).then((response) => {
+          const r = Object.assign({}, response);
+          return r;
+      });
+  }
+
+  exports.findElevationAtManyPoints = findElevationAtManyPoints;
+  exports.findElevationAtPoint = findElevationAtPoint;
+
+  Object.defineProperty(exports, '__esModule', { value: true });
+
+}));
+//# sourceMappingURL=elevation.umd.js.map

package/dist/bundled/elevation.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"elevation.umd.js","sources":["../../src/utils.ts","../../src/findElevationAtPoint.ts","../../src/findElevationAtManyPoints.ts"],"sourcesContent":["export const baseUrl =\n  \"https://elevation-api.arcgis.com/arcgis/rest/services/elevation-service/v1\";\n","import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"ElevationAtPointGet\"][\"parameters\"][\"query\"],\n  \"lon\" | \"lat\" | \"relativeTo\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"ElevationAtPointGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findElevationAtPoint};\n */\nexport interface IFindElevationAtPointResponse extends successResponse {}\n\n/**\n * Options for {@linkcode findElevationAtPoint}.\n */\nexport interface IFindElevationAtPointOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * This method returns the elevation in meters at a given longitude and latitude\n * within the WGS84 coordinate system. By default the elevation is measured with\n * respect to the Earth's mean sea level. It takes into account the local\n * variations in gravity and provides a consistent vertical reference.\n *\n * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be\n * measured with respect to the ellipsoid. This is a mathematical model that\n * approximates the shape of the Earth. It does not consider local variations\n * in gravity and is commonly used in GPS positioning.\n *\n * ```\n * import { findElevationAtPoint } from \"@esri/arcgis-rest-elevation\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findElevationAtPoint({\n *   lon: -179.99,\n *   lat: -85.05,\n *   authentication: ApiKeyManager.fromKey(\"YOUR_ACCESS_TOKEN\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findElevationAtPoint(\n  requestOptions: IFindElevationAtPointOptions\n): Promise<IFindElevationAtPointResponse> {\n  const options = appendCustomParams<IFindElevationAtPointOptions>(\n    requestOptions,\n    [\"lon\", \"lat\", \"relativeTo\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(`${baseUrl}/elevation/at-point`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindElevationAtPointResponse = {\n      ...response\n    };\n\n    return r;\n  });\n}\n","import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"ElevationAtManyPointsPost\"][\"requestBody\"][\"content\"][\"application/json\"],\n  \"coordinates\" | \"relativeTo\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"ElevationAtManyPointsPost\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findElevationAtPoint};\n */\nexport interface IFindElevationAtManyPointsResponse extends successResponse {}\n\n/**\n * Options for {@linkcode findElevationAtPoint}.\n */\nexport interface IFindElevationAtManyPointsOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * This method returns elevations in meters at given longitudes and latitudes\n * within the WGS84 coordinate system. The order of the points returned by this\n * request will be the same as the order of the points passed in the coordinates\n * parameter.\n *\n * If the distance between the furthest West and furthest East coordinate or\n * the furthest North and furthest South coordinate exceeds 50km, the service\n * will return a 400 HTTP response as the distance between these points is too\n * large.\n *\n * By default the elevation is measured with respect to the Earth's mean sea level.\n * It takes into account the local variations in gravity and provides a consistent\n * vertical reference.\n *\n * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be\n * measured with respect to the ellipsoid. This is a mathematical model that\n * approximates the shape of the Earth. It does not consider local variations\n * in gravity and is commonly used in GPS positioning.\n *\n * ```\n * import { findElevationAtManyPoints } from \"@esri/arcgis-rest-elevation\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findElevationAtManyPoints({\n *   coordinates: [[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]],\n *   authentication: ApiKeyManager.fromKey(\"YOUR_ACCESS_TOKEN\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findElevationAtManyPoints(\n  requestOptions: IFindElevationAtManyPointsOptions\n): Promise<IFindElevationAtManyPointsResponse> {\n  const options: any = appendCustomParams<IFindElevationAtManyPointsOptions>(\n    requestOptions,\n    [\"relativeTo\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  options.params.coordinates = JSON.stringify(requestOptions.coordinates);\n\n  return (\n    request(`${baseUrl}/elevation/at-many-points`, {\n      ...options\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindElevationAtManyPointsResponse = {\n      ...response\n    };\n\n    return r;\n  });\n}\n"],"names":["appendCustomParams","request"],"mappings":";;;;;;;;;;;EAAO,MAAM,OAAO,GAClB,4EAA4E;;EC+B9E;;;;;;;;;;;;;;;;;;;;;;;;WAwBgB,oBAAoB,CAClC,cAA4C;MAE5C,MAAM,OAAO,GAAGA,oCAAkB,CAChC,cAAc,EACd,CAAC,KAAK,EAAE,KAAK,EAAE,YAAY,CAAC,oBAEvB,cAAc,EAEpB,CAAC;MAEF,OACEC,yBAAO,CAAC,GAAG,OAAO,qBAAqB,kCAClC,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC,IAAI,CAAC,CAAC,QAAQ;UACd,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;UAEF,OAAO,CAAC,CAAC;OACV,CAAC,CAAC;EACL;;EC/CA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgCgB,yBAAyB,CACvC,cAAiD;MAEjD,MAAM,OAAO,GAAQD,oCAAkB,CACrC,cAAc,EACd,CAAC,YAAY,CAAC,oBAET,cAAc,EAEpB,CAAC;MAEF,OAAO,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;MAExE,OACEC,yBAAO,CAAC,GAAG,OAAO,2BAA2B,oBACxC,OAAO,EAEb,CAAC,IAAI,CAAC,CAAC,QAAQ;UACd,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;UAEF,OAAO,CAAC,CAAC;OACV,CAAC,CAAC;EACL;;;;;;;;;;;"}

package/dist/bundled/elevation.umd.min.js

@@ -0,0 +1,7 @@
+/* @preserve
+* @esri/arcgis-rest-elevation - v1.0.0 - Apache-2.0
+* Copyright (c) 2017-2025 Esri, Inc.
+* Thu Jan 30 2025 15:44:10 GMT+0000 (Coordinated Universal Time)
+*/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports,require("@esri/arcgis-rest-request")):"function"==typeof define&&define.amd?define(["exports","@esri/arcgis-rest-request"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).arcgisRest=e.arcgisRest||{},e.arcgisRest)}(this,(function(e,t){"use strict";const s="https://elevation-api.arcgis.com/arcgis/rest/services/elevation-service/v1";e.findElevationAtManyPoints=function(e){const i=t.appendCustomParams(e,["relativeTo"],Object.assign({},e));return i.params.coordinates=JSON.stringify(e.coordinates),t.request(`${s}/elevation/at-many-points`,Object.assign({},i)).then((e=>Object.assign({},e)))},e.findElevationAtPoint=function(e){const i=t.appendCustomParams(e,["lon","lat","relativeTo"],Object.assign({},e));return t.request(`${s}/elevation/at-point`,Object.assign(Object.assign({},i),{httpMethod:"GET"})).then((e=>Object.assign({},e)))},Object.defineProperty(e,"__esModule",{value:!0})}));
+//# sourceMappingURL=elevation.umd.min.js.map

package/dist/bundled/elevation.umd.min.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"elevation.umd.min.js","sources":["../../src/utils.ts","../../src/findElevationAtManyPoints.ts","../../src/findElevationAtPoint.ts"],"sourcesContent":["export const baseUrl =\n  \"https://elevation-api.arcgis.com/arcgis/rest/services/elevation-service/v1\";\n","import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"ElevationAtManyPointsPost\"][\"requestBody\"][\"content\"][\"application/json\"],\n  \"coordinates\" | \"relativeTo\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"ElevationAtManyPointsPost\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findElevationAtPoint};\n */\nexport interface IFindElevationAtManyPointsResponse extends successResponse {}\n\n/**\n * Options for {@linkcode findElevationAtPoint}.\n */\nexport interface IFindElevationAtManyPointsOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * This method returns elevations in meters at given longitudes and latitudes\n * within the WGS84 coordinate system. The order of the points returned by this\n * request will be the same as the order of the points passed in the coordinates\n * parameter.\n *\n * If the distance between the furthest West and furthest East coordinate or\n * the furthest North and furthest South coordinate exceeds 50km, the service\n * will return a 400 HTTP response as the distance between these points is too\n * large.\n *\n * By default the elevation is measured with respect to the Earth's mean sea level.\n * It takes into account the local variations in gravity and provides a consistent\n * vertical reference.\n *\n * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be\n * measured with respect to the ellipsoid. This is a mathematical model that\n * approximates the shape of the Earth. It does not consider local variations\n * in gravity and is commonly used in GPS positioning.\n *\n * ```\n * import { findElevationAtManyPoints } from \"@esri/arcgis-rest-elevation\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findElevationAtManyPoints({\n *   coordinates: [[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]],\n *   authentication: ApiKeyManager.fromKey(\"YOUR_ACCESS_TOKEN\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findElevationAtManyPoints(\n  requestOptions: IFindElevationAtManyPointsOptions\n): Promise<IFindElevationAtManyPointsResponse> {\n  const options: any = appendCustomParams<IFindElevationAtManyPointsOptions>(\n    requestOptions,\n    [\"relativeTo\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  options.params.coordinates = JSON.stringify(requestOptions.coordinates);\n\n  return (\n    request(`${baseUrl}/elevation/at-many-points`, {\n      ...options\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindElevationAtManyPointsResponse = {\n      ...response\n    };\n\n    return r;\n  });\n}\n","import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"ElevationAtPointGet\"][\"parameters\"][\"query\"],\n  \"lon\" | \"lat\" | \"relativeTo\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"ElevationAtPointGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findElevationAtPoint};\n */\nexport interface IFindElevationAtPointResponse extends successResponse {}\n\n/**\n * Options for {@linkcode findElevationAtPoint}.\n */\nexport interface IFindElevationAtPointOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * This method returns the elevation in meters at a given longitude and latitude\n * within the WGS84 coordinate system. By default the elevation is measured with\n * respect to the Earth's mean sea level. It takes into account the local\n * variations in gravity and provides a consistent vertical reference.\n *\n * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be\n * measured with respect to the ellipsoid. This is a mathematical model that\n * approximates the shape of the Earth. It does not consider local variations\n * in gravity and is commonly used in GPS positioning.\n *\n * ```\n * import { findElevationAtPoint } from \"@esri/arcgis-rest-elevation\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findElevationAtPoint({\n *   lon: -179.99,\n *   lat: -85.05,\n *   authentication: ApiKeyManager.fromKey(\"YOUR_ACCESS_TOKEN\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findElevationAtPoint(\n  requestOptions: IFindElevationAtPointOptions\n): Promise<IFindElevationAtPointResponse> {\n  const options = appendCustomParams<IFindElevationAtPointOptions>(\n    requestOptions,\n    [\"lon\", \"lat\", \"relativeTo\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(`${baseUrl}/elevation/at-point`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindElevationAtPointResponse = {\n      ...response\n    };\n\n    return r;\n  });\n}\n"],"names":["baseUrl","requestOptions","options","appendCustomParams","params","coordinates","JSON","stringify","request","then","response","httpMethod"],"mappings":";;;;;gVAAO,MAAMA,EACX,kHCgEAC,GAEA,MAAMC,EAAeC,qBACnBF,EACA,CAAC,+BAEIA,IAMP,OAFAC,EAAQE,OAAOC,YAAcC,KAAKC,UAAUN,EAAeI,aAGzDG,UAAQ,GAAGR,8CACNE,IAELO,MAAMC,oBAEDA,IAKT,kCC/BET,GAEA,MAAMC,EAAUC,qBACdF,EACA,CAAC,MAAO,MAAO,+BAEVA,IAIP,OACEO,UAAQ,GAAGR,sDACNE,IACHS,WAAY,SAEdF,MAAMC,oBAEDA,IAKT"}

package/dist/cjs/findElevationAtManyPoints.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findElevationAtManyPoints = void 0;
+const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
+const utils_js_1 = require("./utils.js");
+/**
+ * This method returns elevations in meters at given longitudes and latitudes
+ * within the WGS84 coordinate system. The order of the points returned by this
+ * request will be the same as the order of the points passed in the coordinates
+ * parameter.
+ *
+ * If the distance between the furthest West and furthest East coordinate or
+ * the furthest North and furthest South coordinate exceeds 50km, the service
+ * will return a 400 HTTP response as the distance between these points is too
+ * large.
+ *
+ * By default the elevation is measured with respect to the Earth's mean sea level.
+ * It takes into account the local variations in gravity and provides a consistent
+ * vertical reference.
+ *
+ * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be
+ * measured with respect to the ellipsoid. This is a mathematical model that
+ * approximates the shape of the Earth. It does not consider local variations
+ * in gravity and is commonly used in GPS positioning.
+ *
+ * ```
+ * import { findElevationAtManyPoints } from "@esri/arcgis-rest-elevation";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const results = await findElevationAtManyPoints({
+ *   coordinates: [[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]],
+ *   authentication: ApiKeyManager.fromKey("YOUR_ACCESS_TOKEN");
+ * });
+ *
+ * console.log(results)
+ * ```
+ */
+function findElevationAtManyPoints(requestOptions) {
+    const options = (0, arcgis_rest_request_1.appendCustomParams)(requestOptions, ["relativeTo"], Object.assign({}, requestOptions));
+    options.params.coordinates = JSON.stringify(requestOptions.coordinates);
+    return (0, arcgis_rest_request_1.request)(`${utils_js_1.baseUrl}/elevation/at-many-points`, Object.assign({}, options)).then((response) => {
+        const r = Object.assign({}, response);
+        return r;
+    });
+}
+exports.findElevationAtManyPoints = findElevationAtManyPoints;
+//# sourceMappingURL=findElevationAtManyPoints.js.map

package/dist/cjs/findElevationAtManyPoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findElevationAtManyPoints.js","sourceRoot":"","sources":["../../src/findElevationAtManyPoints.ts"],"names":[],"mappings":";;;AAAA,mEAImC;AAGnC,yCAAqC;AAyBrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,SAAgB,yBAAyB,CACvC,cAAiD;IAEjD,MAAM,OAAO,GAAQ,IAAA,wCAAkB,EACrC,cAAc,EACd,CAAC,YAAY,CAAC,oBAET,cAAc,EAEpB,CAAC;IAEF,OAAO,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAExE,OACE,IAAA,6BAAO,EAAC,GAAG,kBAAO,2BAA2B,oBACxC,OAAO,EAEb,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QAClB,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;QAEF,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC;AAxBD,8DAwBC","sourcesContent":["import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"ElevationAtManyPointsPost\"][\"requestBody\"][\"content\"][\"application/json\"],\n  \"coordinates\" | \"relativeTo\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"ElevationAtManyPointsPost\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findElevationAtPoint};\n */\nexport interface IFindElevationAtManyPointsResponse extends successResponse {}\n\n/**\n * Options for {@linkcode findElevationAtPoint}.\n */\nexport interface IFindElevationAtManyPointsOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * This method returns elevations in meters at given longitudes and latitudes\n * within the WGS84 coordinate system. The order of the points returned by this\n * request will be the same as the order of the points passed in the coordinates\n * parameter.\n *\n * If the distance between the furthest West and furthest East coordinate or\n * the furthest North and furthest South coordinate exceeds 50km, the service\n * will return a 400 HTTP response as the distance between these points is too\n * large.\n *\n * By default the elevation is measured with respect to the Earth's mean sea level.\n * It takes into account the local variations in gravity and provides a consistent\n * vertical reference.\n *\n * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be\n * measured with respect to the ellipsoid. This is a mathematical model that\n * approximates the shape of the Earth. It does not consider local variations\n * in gravity and is commonly used in GPS positioning.\n *\n * ```\n * import { findElevationAtManyPoints } from \"@esri/arcgis-rest-elevation\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findElevationAtManyPoints({\n *   coordinates: [[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]],\n *   authentication: ApiKeyManager.fromKey(\"YOUR_ACCESS_TOKEN\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findElevationAtManyPoints(\n  requestOptions: IFindElevationAtManyPointsOptions\n): Promise<IFindElevationAtManyPointsResponse> {\n  const options: any = appendCustomParams<IFindElevationAtManyPointsOptions>(\n    requestOptions,\n    [\"relativeTo\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  options.params.coordinates = JSON.stringify(requestOptions.coordinates);\n\n  return (\n    request(`${baseUrl}/elevation/at-many-points`, {\n      ...options\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindElevationAtManyPointsResponse = {\n      ...response\n    };\n\n    return r;\n  });\n}\n"]}

package/dist/cjs/findElevationAtPoint.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findElevationAtPoint = void 0;
+const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
+const utils_js_1 = require("./utils.js");
+/**
+ * This method returns the elevation in meters at a given longitude and latitude
+ * within the WGS84 coordinate system. By default the elevation is measured with
+ * respect to the Earth's mean sea level. It takes into account the local
+ * variations in gravity and provides a consistent vertical reference.
+ *
+ * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be
+ * measured with respect to the ellipsoid. This is a mathematical model that
+ * approximates the shape of the Earth. It does not consider local variations
+ * in gravity and is commonly used in GPS positioning.
+ *
+ * ```
+ * import { findElevationAtPoint } from "@esri/arcgis-rest-elevation";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const results = await findElevationAtPoint({
+ *   lon: -179.99,
+ *   lat: -85.05,
+ *   authentication: ApiKeyManager.fromKey("YOUR_ACCESS_TOKEN");
+ * });
+ *
+ * console.log(results)
+ * ```
+ */
+function findElevationAtPoint(requestOptions) {
+    const options = (0, arcgis_rest_request_1.appendCustomParams)(requestOptions, ["lon", "lat", "relativeTo"], Object.assign({}, requestOptions));
+    return (0, arcgis_rest_request_1.request)(`${utils_js_1.baseUrl}/elevation/at-point`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
+        const r = Object.assign({}, response);
+        return r;
+    });
+}
+exports.findElevationAtPoint = findElevationAtPoint;
+//# sourceMappingURL=findElevationAtPoint.js.map

package/dist/cjs/findElevationAtPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findElevationAtPoint.js","sourceRoot":"","sources":["../../src/findElevationAtPoint.ts"],"names":[],"mappings":";;;AAAA,mEAImC;AAGnC,yCAAqC;AAyBrC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,oBAAoB,CAClC,cAA4C;IAE5C,MAAM,OAAO,GAAG,IAAA,wCAAkB,EAChC,cAAc,EACd,CAAC,KAAK,EAAE,KAAK,EAAE,YAAY,CAAC,oBAEvB,cAAc,EAEpB,CAAC;IAEF,OACE,IAAA,6BAAO,EAAC,GAAG,kBAAO,qBAAqB,kCAClC,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QAClB,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;QAEF,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC;AAvBD,oDAuBC","sourcesContent":["import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"ElevationAtPointGet\"][\"parameters\"][\"query\"],\n  \"lon\" | \"lat\" | \"relativeTo\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"ElevationAtPointGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findElevationAtPoint};\n */\nexport interface IFindElevationAtPointResponse extends successResponse {}\n\n/**\n * Options for {@linkcode findElevationAtPoint}.\n */\nexport interface IFindElevationAtPointOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * This method returns the elevation in meters at a given longitude and latitude\n * within the WGS84 coordinate system. By default the elevation is measured with\n * respect to the Earth's mean sea level. It takes into account the local\n * variations in gravity and provides a consistent vertical reference.\n *\n * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be\n * measured with respect to the ellipsoid. This is a mathematical model that\n * approximates the shape of the Earth. It does not consider local variations\n * in gravity and is commonly used in GPS positioning.\n *\n * ```\n * import { findElevationAtPoint } from \"@esri/arcgis-rest-elevation\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findElevationAtPoint({\n *   lon: -179.99,\n *   lat: -85.05,\n *   authentication: ApiKeyManager.fromKey(\"YOUR_ACCESS_TOKEN\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findElevationAtPoint(\n  requestOptions: IFindElevationAtPointOptions\n): Promise<IFindElevationAtPointResponse> {\n  const options = appendCustomParams<IFindElevationAtPointOptions>(\n    requestOptions,\n    [\"lon\", \"lat\", \"relativeTo\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(`${baseUrl}/elevation/at-point`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindElevationAtPointResponse = {\n      ...response\n    };\n\n    return r;\n  });\n}\n"]}

package/dist/cjs/index.js

@@ -0,0 +1,8 @@
+"use strict";
+/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./findElevationAtPoint.js"), exports);
+(0, tslib_1.__exportStar)(require("./findElevationAtManyPoints.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAMhB,yEAA0C;AAC1C,8EAA+C","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\n// Types that are used in this package are re-exported for convenience and\n// to make the links work correctly in the documentation pages.\nexport type {} from \"@esri/arcgis-rest-request\";\n\nexport * from \"./findElevationAtPoint.js\";\nexport * from \"./findElevationAtManyPoints.js\";\n"]}

package/dist/cjs/openapi-types.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=openapi-types.js.map

package/dist/cjs/openapi-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-types.js","sourceRoot":"","sources":["../../src/openapi-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file was auto-generated by openapi-typescript.\n * Do not make direct changes to the file.\n */\n\nexport interface paths {\n  \"/elevation/at-point\": {\n    /**\n     * Returns the elevation in meters at a given longitude and latitude within the WGS84 coordinate system.\n     *\n     * By default the elevation is measured with respect to the Earth's mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.\n     *\n     * If the `relativeTo` query parameter is set to `ellipsoid`, the elevation will be measured with respect to the ellipsoid. This is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.\n     *\n     * Note: You cannot permanently store elevations. Please see the [Terms of use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).\n     */\n    get: operations[\"ElevationAtPointGet\"];\n  };\n  \"/elevation/at-many-points\": {\n    /**\n     * Returns elevations in meters at given longitudes and latitudes within the WGS84 coordinate system.\n     *\n     * The order of the points returned by this request will be the same as the order of the points passed in the\n     * `coordinates` parameter.\n     *\n     * If the distance between the furthest West and furthest East coordinate exceeds 50km, the service will return a `400` HTTP response as the distance between these points is too large.\n     *\n     * If the distance between the furthest North and furthest South coordinate exceeds 50km, the service will return a `400` HTTP response as the distance between these points is too large.\n     *\n     * If any of the points are otherwise invalid, a `400` HTTP response will be returned.\n     *\n     * By default the elevation is measured with respect to the Earth's mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.\n     *\n     * If the `relativeTo` parameter in the body is set to `ellipsoid`, the elevation will be measured with respect to the ellipsoid. This is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.\n     *\n     * Note: You cannot permanently store elevations. Please see the [Terms of use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).\n     *\n     * The Post Body content type must be either:\n     * - JSON with content type of `application/json`, or\n     * - form URL encoded key-value pairs with content type `application/x-www-form-urlencoded`.\n     *\n     * The following parameters are used to fetch elevations for multiple coordinates:\n     *\n     * **coordinates**\n     *   - (Required) Array of (longitude, latitude) pairs in the WGS84 spatial reference. Maximum size of 100 coordinates. The order of each pair must be\n     *     - longitude in the range `-179.99` to `179.99` representing the east/west or x-axis\n     *     - latitude in the range `-85.05` to `85.05` representing the north/south or y-axis\n     *   - For example: `[[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]]`\n     *\n     * **f**\n     *   - (Optional) Case-sensitive parameter to specify the format in which responses are given. Can either be `json` or `pjson`.\n     *\n     * **relativeTo**\n     *   - (Optional) The reference position (datum) from which to measure elevation. The valid values are:\n     *\n     *     - **meanSeaLevel**: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.\n     *     - **ellipsoid**: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.\n     *\n     * **token**\n     *   - (Optional) The authentication token, used to access the elevation service. Alternatively, you can supply a token in the request header with either the `Authorization` or `X-Esri-Authorization` key, using the \"Bearer\" scheme.\n     */\n    post: operations[\"ElevationAtManyPointsPost\"];\n  };\n}\n\nexport interface components {\n  schemas: {\n    /** @description A geometry point referring to a location on a map. */\n    Point: {\n      /** @description The spatial reference system the point is relative to. */\n      spatialReference: {\n        /**\n         * @description The Well-Known ID (WKID) value of the spatial reference.\n         * @example 4326\n         */\n        wkid: number;\n      };\n      /**\n       * @description The X coordinate which is measured along the east/west axis.\n       * @example 86.925278\n       */\n      x: number;\n      /**\n       * @description The Y coordinate which is measured along the north/south axis.\n       * @example 27.988333\n       */\n      y: number;\n      /**\n       * @description The Z coordinate represents the vertical position of a point above or below a reference level, such as sea level (in meters, rounded to the nearest meter).\n       * @example 8744\n       */\n      z: number;\n    };\n    /** @description A structure containing human readable metadata about the specified point. */\n    ElevationInfo: {\n      /**\n       * @description The reference position (datum) from which to measure elevation.\n       * The valid values are:\n       * - meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level.\n       *                 It takes into account the local variations in gravity and provides a consistent vertical reference.\n       * - ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth.\n       *               It does not consider local variations in gravity and is commonly used in GPS positioning.\n       *\n       * @default meanSeaLevel\n       * @example meanSeaLevel\n       * @enum {string}\n       */\n      relativeTo: \"meanSeaLevel\" | \"ellipsoid\";\n    };\n    /** @description A structure containing a point including an elevation value (defined as Z). */\n    Elevation: {\n      /** @description The point containing the elevation. */\n      point: components[\"schemas\"][\"Point\"];\n    };\n    /**\n     * @description A structure containing a collection of points which contain elevation values (defined as Z). When returned from\n     * a request to the `/elevation/at-many-points` endpoint, the order of the points will match the order of the\n     * points in the request.\n     */\n    Elevations: {\n      points: components[\"schemas\"][\"Point\"][];\n    };\n    Error: {\n      /** @description Error information */\n      error: {\n        /**\n         * @description A code identifying the type of error, either an HTTP error code, `498` (signifying invalid or expired token), or `499` (signifying missing token).\n         * @example 400\n         * @enum {integer}\n         */\n        code: 400 | 401 | 403 | 404 | 413 | 415 | 498 | 499 | 500;\n        /** @description A message describing the error. */\n        message: string;\n        /** @description List of details about the error. */\n        details?: string[];\n        /**\n         * @description URL that provides the elevation service information.\n         * @example https://elevation-api.arcgis.com/arcgis/rest/info\n         */\n        restInfoUrl?: string;\n      };\n    };\n    /**\n     * @description Optional, case-sensitive parameter to specify the format in which responses are given. Can either be `json` or `pjson`.\n     * @enum {string}\n     */\n    Format: \"json\" | \"pjson\";\n  };\n  responses: {\n    /** Response to a request for the elevation at a specified point. */\n    ElevationResponse: {\n      content: {\n        \"application/json\": {\n          elevationInfo: components[\"schemas\"][\"ElevationInfo\"];\n          result: components[\"schemas\"][\"Elevation\"];\n        };\n      };\n    };\n    /**\n     * Response to a request for the elevations at specified points. There will be one response point for each point\n     * in the request. The order of these points will match the order of the points in the request.\n     */\n    MultipleElevationsResponse: {\n      content: {\n        \"application/json\": {\n          elevationInfo: components[\"schemas\"][\"ElevationInfo\"];\n          result: components[\"schemas\"][\"Elevations\"];\n        };\n      };\n    };\n    /** Authentication Error. The API key or token is missing, invalid or expired. */\n    UnauthorizedErrorResponse: {\n      content: {\n        \"application/json\": components[\"schemas\"][\"Error\"];\n      };\n    };\n    /** An error occurred on the server. */\n    ServerErrorResponse: {\n      content: {\n        \"application/json\": components[\"schemas\"][\"Error\"];\n      };\n    };\n    /** Invalid query parameters / Incorrect portal item type. */\n    InvalidQueryErrorResponse: {\n      content: {\n        \"application/json\": components[\"schemas\"][\"Error\"];\n      };\n    };\n    /** The supplied authentication information is valid but does not have permission to access the service. */\n    PermissionMissingErrorResponse: {\n      content: {\n        \"application/json\": components[\"schemas\"][\"Error\"];\n      };\n    };\n    /** The requested resource cannot be accessed because of incorrect sharing permissions. */\n    ResourcePermissionErrorResponse: {\n      content: {\n        \"application/json\": components[\"schemas\"][\"Error\"];\n      };\n    };\n    /** The request body was larger than limits defined by the service. */\n    ContentTooLargeErrorResponse: {\n      content: {\n        \"application/json\": components[\"schemas\"][\"Error\"];\n      };\n    };\n    /** The request's message content is of a media-type that the service does not support. */\n    UnsupportedMediaTypeErrorResponse: {\n      content: {\n        \"application/json\": components[\"schemas\"][\"Error\"];\n      };\n    };\n  };\n  parameters: {\n    /** @description Optional, case-sensitive parameter to specify the format in which responses are given. Can either be `json` or `pjson`. */\n    FormatParam: components[\"schemas\"][\"Format\"];\n    /**\n     * @description The authentication token, used to access the elevation service.\n     *\n     * The `token` parameter can be either an API Key or short-lived token.\n     *\n     * Alternatively, you can supply a token in the request header with one of\n     * the following keys using the \"Bearer\" scheme:\n     *\n     * - `Authorization: Bearer <YOUR_TOKEN>`\n     * - `X-Esri-Authorization: Bearer <YOUR_TOKEN>`\n     *\n     * The provided `token` must be created from an ArcGIS Location Platform account and have the necessary `premium:user:elevation` privilege to use the elevation service.\n     *\n     * **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/).\n     */\n    TokenParam: string;\n    /** @description The longitude of the specified point. */\n    LongitudeParam: number;\n    /** @description The latitude of the specified point. */\n    LatitudeParam: number;\n    /**\n     * @description The reference position (datum) from which to measure elevation.\n     * The valid values are:\n     * - meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level.\n     *                 It takes into account the local variations in gravity and provides a consistent vertical reference.\n     * - ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth.\n     *               It does not consider local variations in gravity and is commonly used in GPS positioning.\n     */\n    RelativeToParam: \"meanSeaLevel\" | \"ellipsoid\";\n  };\n}\n\nexport interface operations {\n  /**\n   * Returns the elevation in meters at a given longitude and latitude within the WGS84 coordinate system.\n   *\n   * By default the elevation is measured with respect to the Earth's mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.\n   *\n   * If the `relativeTo` query parameter is set to `ellipsoid`, the elevation will be measured with respect to the ellipsoid. This is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.\n   *\n   * Note: You cannot permanently store elevations. Please see the [Terms of use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).\n   */\n  ElevationAtPointGet: {\n    parameters: {\n      query: {\n        /** The longitude of the specified point. */\n        lon: components[\"parameters\"][\"LongitudeParam\"];\n        /** The latitude of the specified point. */\n        lat: components[\"parameters\"][\"LatitudeParam\"];\n        /**\n         * The reference position (datum) from which to measure elevation.\n         * The valid values are:\n         * - meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level.\n         *                 It takes into account the local variations in gravity and provides a consistent vertical reference.\n         * - ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth.\n         *               It does not consider local variations in gravity and is commonly used in GPS positioning.\n         */\n        relativeTo?: components[\"parameters\"][\"RelativeToParam\"];\n        /**\n         * The authentication token, used to access the elevation service.\n         *\n         * The `token` parameter can be either an API Key or short-lived token.\n         *\n         * Alternatively, you can supply a token in the request header with one of\n         * the following keys using the \"Bearer\" scheme:\n         *\n         * - `Authorization: Bearer <YOUR_TOKEN>`\n         * - `X-Esri-Authorization: Bearer <YOUR_TOKEN>`\n         *\n         * The provided `token` must be created from an ArcGIS Location Platform account and have the necessary `premium:user:elevation` privilege to use the elevation service.\n         *\n         * **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/).\n         */\n        token?: components[\"parameters\"][\"TokenParam\"];\n        /** Optional, case-sensitive parameter to specify the format in which responses are given. Can either be `json` or `pjson`. */\n        f?: components[\"parameters\"][\"FormatParam\"];\n      };\n    };\n    responses: {\n      200: components[\"responses\"][\"ElevationResponse\"];\n      400: components[\"responses\"][\"InvalidQueryErrorResponse\"];\n      401: components[\"responses\"][\"UnauthorizedErrorResponse\"];\n      403: components[\"responses\"][\"ResourcePermissionErrorResponse\"];\n      \"5XX\": components[\"responses\"][\"ServerErrorResponse\"];\n    };\n  };\n  /**\n   * Returns elevations in meters at given longitudes and latitudes within the WGS84 coordinate system.\n   *\n   * The order of the points returned by this request will be the same as the order of the points passed in the\n   * `coordinates` parameter.\n   *\n   * If the distance between the furthest West and furthest East coordinate exceeds 50km, the service will return a `400` HTTP response as the distance between these points is too large.\n   *\n   * If the distance between the furthest North and furthest South coordinate exceeds 50km, the service will return a `400` HTTP response as the distance between these points is too large.\n   *\n   * If any of the points are otherwise invalid, a `400` HTTP response will be returned.\n   *\n   * By default the elevation is measured with respect to the Earth's mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.\n   *\n   * If the `relativeTo` parameter in the body is set to `ellipsoid`, the elevation will be measured with respect to the ellipsoid. This is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.\n   *\n   * Note: You cannot permanently store elevations. Please see the [Terms of use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).\n   *\n   * The Post Body content type must be either:\n   * - JSON with content type of `application/json`, or\n   * - form URL encoded key-value pairs with content type `application/x-www-form-urlencoded`.\n   *\n   * The following parameters are used to fetch elevations for multiple coordinates:\n   *\n   * **coordinates**\n   *   - (Required) Array of (longitude, latitude) pairs in the WGS84 spatial reference. Maximum size of 100 coordinates. The order of each pair must be\n   *     - longitude in the range `-179.99` to `179.99` representing the east/west or x-axis\n   *     - latitude in the range `-85.05` to `85.05` representing the north/south or y-axis\n   *   - For example: `[[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]]`\n   *\n   * **f**\n   *   - (Optional) Case-sensitive parameter to specify the format in which responses are given. Can either be `json` or `pjson`.\n   *\n   * **relativeTo**\n   *   - (Optional) The reference position (datum) from which to measure elevation. The valid values are:\n   *\n   *     - **meanSeaLevel**: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.\n   *     - **ellipsoid**: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.\n   *\n   * **token**\n   *   - (Optional) The authentication token, used to access the elevation service. Alternatively, you can supply a token in the request header with either the `Authorization` or `X-Esri-Authorization` key, using the \"Bearer\" scheme.\n   */\n  ElevationAtManyPointsPost: {\n    responses: {\n      200: components[\"responses\"][\"MultipleElevationsResponse\"];\n      400: components[\"responses\"][\"InvalidQueryErrorResponse\"];\n      401: components[\"responses\"][\"UnauthorizedErrorResponse\"];\n      403: components[\"responses\"][\"ResourcePermissionErrorResponse\"];\n      413: components[\"responses\"][\"ContentTooLargeErrorResponse\"];\n      415: components[\"responses\"][\"UnsupportedMediaTypeErrorResponse\"];\n      \"5XX\": components[\"responses\"][\"ServerErrorResponse\"];\n    };\n    requestBody: {\n      content: {\n        \"application/json\": {\n          /**\n           * @description The authentication token, used to access the elevation service.\n           *\n           * The `token` parameter can be either an API Key or short-lived token.\n           *\n           * Alternatively, you can supply a token in the request header with one of\n           * the following keys using the \"Bearer\" scheme:\n           *\n           * - `Authorization: Bearer <YOUR_TOKEN>`\n           * - `X-Esri-Authorization: Bearer <YOUR_TOKEN>`\n           *\n           * The provided `token` must be created from an ArcGIS Location Platform account and have the necessary `premium:user:elevation` privilege to use the elevation service.\n           *\n           * **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/security-and-authentication/).\n           *\n           * @example My token\n           */\n          token?: string;\n          /**\n           * @description The reference position (datum) from which to measure elevation.\n           * The valid values are:\n           * - meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level.\n           *                 It takes into account the local variations in gravity and provides a consistent vertical reference.\n           * - ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth.\n           *               It does not consider local variations in gravity and is commonly used in GPS positioning.\n           *\n           * @default meanSeaLevel\n           * @example meanSeaLevel\n           * @enum {string}\n           */\n          relativeTo?: \"meanSeaLevel\" | \"ellipsoid\";\n          f?: components[\"schemas\"][\"Format\"];\n          /**\n           * @description Array of (longitude, latitude) pairs in the WGS84 spatial reference. Maximum size of 100 coordinates. The order of each pair must be\n           *   - longitude in the range `-179.99` to `179.99` representing the east/west or x-axis\n           *   - latitude in the range `-85.05` to `85.05` representing the north/south or y-axis\n           *\n           * For example: `[[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]]`\n           *\n           * @example [\n           *   [\n           *     31.134167,\n           *     29.979167\n           *   ],\n           *   [\n           *     31.130833,\n           *     29.976111\n           *   ],\n           *   [\n           *     31.128333,\n           *     29.9725\n           *   ]\n           * ]\n           */\n          coordinates: number[][];\n        };\n        \"application/x-www-form-urlencoded\": {\n          /**\n           * @description The authentication token, used to access the elevation service.\n           *\n           * The `token` parameter can be either an API Key or short-lived token.\n           *\n           * Alternatively, you can supply a token in the request header with one of\n           * the following keys using the \"Bearer\" scheme:\n           *\n           * - `Authorization: Bearer <YOUR_TOKEN>`\n           * - `X-Esri-Authorization: Bearer <YOUR_TOKEN>`\n           *\n           * The provided `token` must be created from an ArcGIS Location Platform account and have the necessary `premium:user:elevation` privilege to use the elevation service.\n           *\n           * **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/security-and-authentication/).\n           *\n           * @example My token\n           */\n          token?: string;\n          /**\n           * @description The reference position (datum) from which to measure elevation.\n           * The valid values are:\n           * - meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level.\n           *                 It takes into account the local variations in gravity and provides a consistent vertical reference.\n           * - ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth.\n           *               It does not consider local variations in gravity and is commonly used in GPS positioning.\n           *\n           * @default meanSeaLevel\n           * @example meanSeaLevel\n           * @enum {string}\n           */\n          relativeTo?: \"meanSeaLevel\" | \"ellipsoid\";\n          f?: components[\"schemas\"][\"Format\"];\n          /**\n           * @description Array of (longitude, latitude) pairs in the WGS84 spatial reference. Maximum size of 100 coordinates. The order of each pair must be\n           *   - longitude in the range `-179.99` to `179.99` representing the east/west or x-axis\n           *   - latitude in the range `-85.05` to `85.05` representing the north/south or y-axis\n           *\n           * For example: `[[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]]`\n           *\n           * @example [\n           *   [\n           *     31.134167,\n           *     29.979167\n           *   ],\n           *   [\n           *     31.130833,\n           *     29.976111\n           *   ],\n           *   [\n           *     31.128333,\n           *     29.9725\n           *   ]\n           * ]\n           */\n          coordinates: number[][];\n        };\n      };\n    };\n  };\n}\n\nexport interface external {}\n"]}

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/cjs/utils.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.baseUrl = void 0;
+exports.baseUrl = "https://elevation-api.arcgis.com/arcgis/rest/services/elevation-service/v1";
+//# sourceMappingURL=utils.js.map

package/dist/cjs/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAClB,4EAA4E,CAAC","sourcesContent":["export const baseUrl =\n  \"https://elevation-api.arcgis.com/arcgis/rest/services/elevation-service/v1\";\n"]}

package/dist/esm/findElevationAtManyPoints.d.ts

@@ -0,0 +1,48 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { operations } from "./openapi-types.js";
+declare type queryParams = Pick<operations["ElevationAtManyPointsPost"]["requestBody"]["content"]["application/json"], "coordinates" | "relativeTo">;
+declare type successResponse = operations["ElevationAtManyPointsPost"]["responses"]["200"]["content"]["application/json"];
+/**
+ * The response format for {@linkcode findElevationAtPoint};
+ */
+export interface IFindElevationAtManyPointsResponse extends successResponse {
+}
+/**
+ * Options for {@linkcode findElevationAtPoint}.
+ */
+export interface IFindElevationAtManyPointsOptions extends Omit<IRequestOptions, "httpMethod" | "f">, queryParams {
+}
+/**
+ * This method returns elevations in meters at given longitudes and latitudes
+ * within the WGS84 coordinate system. The order of the points returned by this
+ * request will be the same as the order of the points passed in the coordinates
+ * parameter.
+ *
+ * If the distance between the furthest West and furthest East coordinate or
+ * the furthest North and furthest South coordinate exceeds 50km, the service
+ * will return a 400 HTTP response as the distance between these points is too
+ * large.
+ *
+ * By default the elevation is measured with respect to the Earth's mean sea level.
+ * It takes into account the local variations in gravity and provides a consistent
+ * vertical reference.
+ *
+ * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be
+ * measured with respect to the ellipsoid. This is a mathematical model that
+ * approximates the shape of the Earth. It does not consider local variations
+ * in gravity and is commonly used in GPS positioning.
+ *
+ * ```
+ * import { findElevationAtManyPoints } from "@esri/arcgis-rest-elevation";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const results = await findElevationAtManyPoints({
+ *   coordinates: [[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]],
+ *   authentication: ApiKeyManager.fromKey("YOUR_ACCESS_TOKEN");
+ * });
+ *
+ * console.log(results)
+ * ```
+ */
+export declare function findElevationAtManyPoints(requestOptions: IFindElevationAtManyPointsOptions): Promise<IFindElevationAtManyPointsResponse>;
+export {};