@esri/arcgis-rest-places 1.0.1 → 1.1.0

package/README.md

@@ -1,13 +1,10 @@
 [![npm version][npm-img]][npm-url]
-[![build status][travis-img]][travis-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-places.svg?style=flat-square
 [npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-places
-[travis-img]: https://img.shields.io/travis/Esri/arcgis-rest-js/master.svg?style=flat-square
-[travis-url]: https://travis-ci.org/Esri/arcgis-rest-js
 [gzip-image]: https://img.badgesize.io/https://unpkg.com/@esri/arcgis-rest-places/dist/bundled/places.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
@@ -24,21 +21,20 @@ npm install @esri/arcgis-rest-places
 ```
 
 ```js
-import { ApiKeyManager } from "@esri/arcgis-rest-request;
-import { findPlacesNearPoint 
-} from "@esri/arcgis-rest-places"
+import { ApiKeyManager } from "@esri/arcgis-rest-request";
+import { findPlacesNearPoint } from "@esri/arcgis-rest-places";
 
 const { places } = await findPlacesNearPoint({
-    x: -3.1883,
-    y: 55.9533,
-    categoryIds: ["13002"],
-    authentication: ApiKeyManager.fromKey("YOUR_API_KEY")
-  });
+  x: -3.1883,
+  y: 55.9533,
+  categoryIds: ["13002"],
+  authentication: ApiKeyManager.fromKey("YOUR_API_KEY")
+});
 
 console.log(places[0].name);
 ```
 
-### [API Reference](https://esri.github.io/arcgis-rest-js/api/places/)
+### [API Reference](https://developers.arcgis.com/arcgis-rest-js/api-reference/arcgis-rest-places/)
 
 @TODO
 

package/dist/bundled/places.esm.js

@@ -1,7 +1,7 @@
 /* @preserve
-* @esri/arcgis-rest-places - v1.0.0 - Apache-2.0
-* Copyright (c) 2017-2023 Esri, Inc.
-* Tue Jun 27 2023 16:16:59 GMT+0000 (Coordinated Universal Time)
+* @esri/arcgis-rest-places - v1.0.2 - Apache-2.0
+* Copyright (c) 2017-2024 Esri, Inc.
+* Tue Jun 18 2024 23:49:53 GMT+0000 (Coordinated Universal Time)
 */
 import { appendCustomParams, request } from '@esri/arcgis-rest-request';
 
@@ -35,11 +35,9 @@ function getNextPageParams(currentOffset = 0, currentPageSize = 10) {
  * - A partial name filter with `name` option
  *
  * As this request can return many results, pagination is supported.
- * Regardless of paging, the maximum number of places that can be returned
- * by a single query is `200`. When a query results in more than `200`
- * places, the response will contain the property
- * `"maxResultsExceeded":true` in addition to place results. If `maxResultsExceeded`
- * is true an additional method `response.nextPage()` can be used to get the next page of results.
+ * When a query results in more than [pageSize] places, the response will contain the property
+ * `pagination` in addition to place results. If `pagination` exists, an additional method
+ * `response.nextPage()` can be used to get the next page of results.
  *
  * ```js
  * import { findPlacesNearPoint } from "@esri/arcgis-rest-places";
@@ -57,7 +55,7 @@ function getNextPageParams(currentOffset = 0, currentPageSize = 10) {
  */
 function findPlacesNearPoint(requestOptions) {
     const options = appendCustomParams(requestOptions, ["x", "y", "radius", "categoryIds", "pageSize", "offset", "searchText"], Object.assign({}, requestOptions));
-    return request(`${baseUrl}/places/near-point`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
+    return request(requestOptions.endpoint || `${baseUrl}/places/near-point`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
         const r = Object.assign({}, response);
         if (hasNextPage(response)) {
             r.nextPage = () => {
@@ -86,11 +84,9 @@ function findPlacesNearPoint(requestOptions) {
  * - A partial name filter with `name` option
  *
  * As this request can return many results, pagination is supported.
- * Regardless of paging, the maximum number of places that can be returned
- * by a single query is `200`. When a query results in more than `200`
- * places, the response will contain the property
- * `"maxResultsExceeded":true` in addition to place results. If `maxResultsExceeded`
- * is true an additional method `response.nextPage()` can be used to get the next page of results.
+ * When a query results in more than [pageSize] places, the response will contain the property
+ * `pagination` in addition to place results. If `pagination` exists, an additional method
+ * `response.nextPage()` can be used to get the next page of results.
  *
  * ```
  * import { findPlacesWithinExtent } from "@esri/arcgis-rest-places";
@@ -102,7 +98,7 @@ function findPlacesNearPoint(requestOptions) {
  *   xmax: -117.795753,
  *   ymax: 33.873337,
  *   categoryIds: ["13002"],
- *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+ *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY")
  * });
  *
  * console.log(results)
@@ -119,7 +115,7 @@ function findPlacesWithinExtent(requestOptions) {
         "offset",
         "searchText"
     ], Object.assign({}, requestOptions));
-    return request(`${baseUrl}/places/within-extent`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
+    return request(requestOptions.endpoint || `${baseUrl}/places/within-extent`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
         const r = Object.assign({}, response);
         if (hasNextPage(response)) {
             r.nextPage = () => {
@@ -153,7 +149,7 @@ function findPlacesWithinExtent(requestOptions) {
  *
  * const place = getPlaceDetails({
  *   placeId: "e78051acc722c55ab11ba930d8dd7772",
- *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+ *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY")
  * });
  *
  * console.log(place);
@@ -162,7 +158,7 @@ function findPlacesWithinExtent(requestOptions) {
 function getPlaceDetails(requestOptions) {
     const { placeId } = requestOptions;
     const options = appendCustomParams(requestOptions, ["requestedFields"], Object.assign({}, requestOptions));
-    return request(`${baseUrl}/places/${placeId}`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
+    return request(requestOptions.endpoint || `${baseUrl}/places/${placeId}`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
 }
 
 /**
@@ -189,7 +185,7 @@ function getPlaceDetails(requestOptions) {
  */
 function getCategories(requestOptions) {
     const options = appendCustomParams(requestOptions, ["filter"], Object.assign({}, requestOptions));
-    return request(`${baseUrl}/categories`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
+    return request(requestOptions.endpoint || `${baseUrl}/categories`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
 }
 
 /**
@@ -201,7 +197,7 @@ function getCategories(requestOptions) {
  *
  * const response = getCategory({
  *   categoryId: "10000",
- *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+ *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY")
  * });
  *
  * console.log(response);
@@ -210,7 +206,7 @@ function getCategories(requestOptions) {
 function getCategory(requestOptions) {
     const { categoryId } = requestOptions;
     const options = appendCustomParams(requestOptions, [], Object.assign({}, requestOptions));
-    return request(`${baseUrl}/categories/${categoryId}`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
+    return request(requestOptions.endpoint || `${baseUrl}/categories/${categoryId}`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
 }
 
 export { findPlacesNearPoint, findPlacesWithinExtent, getCategories, getCategory, getPlaceDetails };

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

@@ -1 +1 @@
-{"version":3,"file":"places.esm.js","sources":["../../src/utils.ts","../../src/findPlacesNearPoint.ts","../../src/findPlacesWithinExtent.ts","../../src/getPlaceDetails.ts","../../src/getCategories.ts","../../src/getCategory.ts"],"sourcesContent":["export const baseUrl =\n  \"https://places-api.arcgis.com/arcgis/rest/services/places-service/v1\";\n\nexport function hasNextPage(response: any) {\n  return !!response?.links?.next || !!response?.pagination?.nextUrl;\n}\n\nexport function getNextPageParams(currentOffset = 0, currentPageSize = 10) {\n  return {\n    offset: currentOffset + currentPageSize,\n    pageSize: currentPageSize\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, hasNextPage, getNextPageParams } 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[\"nearPointGet\"][\"parameters\"][\"query\"],\n  \"x\" | \"y\" | \"radius\" | \"categoryIds\" | \"pageSize\" | \"offset\" | \"searchText\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"nearPointGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findPlacesNearPoint};\n */\nexport interface IFindPlacesNearPointResponse extends successResponse {\n  nextPage?: () => Promise<IFindPlacesNearPointResponse>;\n}\n\n/**\n * Options for {@linkcode findPlacesNearPoint}.\n */\nexport interface IFindPlacesNearPointOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * Searches places that are within a given radius of a geographic point.\n * You must supply the `x` and `y` coordinates of the point that you wish\n * to search from. You can either specify a search radius, or use the\n * default (500 meters).  You could use this method to search for places\n * around a user's GPS position, or a location clicked on a map.\n *\n * The returned places contain basic data such as name, category and\n * location. You can use the {@linkcode getPlace} method to get additional\n * details for a given place.\n *\n * You can refine the results by supplying additional search parameters,\n * including:\n *\n * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.\n * - A partial name filter with `name` option\n *\n * As this request can return many results, pagination is supported.\n * Regardless of paging, the maximum number of places that can be returned\n * by a single query is `200`. When a query results in more than `200`\n * places, the response will contain the property\n * `\"maxResultsExceeded\":true` in addition to place results. If `maxResultsExceeded`\n * is true an additional method `response.nextPage()` can be used to get the next page of results.\n *\n * ```js\n * import { findPlacesNearPoint } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = await findPlacesNearPoint({\n *   x: -3.1883,\n *   y: 55.9533,\n *   radius: 100,\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(response);\n * ```\n */\nexport function findPlacesNearPoint(\n  requestOptions: IFindPlacesNearPointOptions\n): Promise<IFindPlacesNearPointResponse> {\n  const options = appendCustomParams<IFindPlacesNearPointOptions>(\n    requestOptions,\n    [\"x\", \"y\", \"radius\", \"categoryIds\", \"pageSize\", \"offset\", \"searchText\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(`${baseUrl}/places/near-point`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindPlacesNearPointResponse = {\n      ...response\n    };\n\n    if (hasNextPage(response)) {\n      r.nextPage = () => {\n        const nextOptions = {\n          ...requestOptions,\n          ...getNextPageParams(requestOptions.offset, requestOptions.pageSize)\n        };\n        return findPlacesNearPoint(nextOptions);\n      };\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, hasNextPage, getNextPageParams } 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[\"withinExtentGet\"][\"parameters\"][\"query\"],\n  | \"xmin\"\n  | \"ymin\"\n  | \"xmax\"\n  | \"ymax\"\n  | \"categoryIds\"\n  | \"pageSize\"\n  | \"offset\"\n  | \"searchText\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"withinExtentGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findPlacesWithinExtent};\n */\nexport interface IFindPlacesWithinExtentResponse extends successResponse {\n  nextPage?: () => Promise<IFindPlacesWithinExtentResponse>;\n}\n\n/**\n * Options for {@linkcode findPlacesNearPoint}.\n */\nexport interface IFindPlaceWithinExtentOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * Searches the world-wide set of places for those that are within an\n * extent, or bounding box. You must supply the `xmin`, `ymin`, `xmax` and\n * `ymax` coordinates of the extent. You could use this endpoint to search\n * for places in the visible extent of a user's screen.\n *\n * The returned places contain basic data such as name, category and\n * location. You can use the {@linkcode getPlace} method to get additional\n * details for a given place.\n *\n * You can also refine the results by supplying additional search parameters,\n * including:\n *\n * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.\n * - A partial name filter with `name` option\n *\n * As this request can return many results, pagination is supported.\n * Regardless of paging, the maximum number of places that can be returned\n * by a single query is `200`. When a query results in more than `200`\n * places, the response will contain the property\n * `\"maxResultsExceeded\":true` in addition to place results. If `maxResultsExceeded`\n * is true an additional method `response.nextPage()` can be used to get the next page of results.\n *\n * ```\n * import { findPlacesWithinExtent } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findPlacesWithinExtent({\n *   xmin: -118.013334,\n *   ymin: 33.78193,\n *   xmax: -117.795753,\n *   ymax: 33.873337,\n *   categoryIds: [\"13002\"],\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findPlacesWithinExtent(\n  requestOptions: IFindPlaceWithinExtentOptions\n): Promise<IFindPlacesWithinExtentResponse> {\n  const options = appendCustomParams<IFindPlaceWithinExtentOptions>(\n    requestOptions,\n    [\n      \"xmin\",\n      \"ymin\",\n      \"xmax\",\n      \"ymax\",\n      \"categoryIds\",\n      \"pageSize\",\n      \"offset\",\n      \"searchText\"\n    ],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(`${baseUrl}/places/within-extent`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindPlacesWithinExtentResponse = {\n      ...response\n    };\n\n    if (hasNextPage(response)) {\n      r.nextPage = () => {\n        const nextOptions = {\n          ...requestOptions,\n          ...getNextPageParams(requestOptions.offset, requestOptions.pageSize)\n        };\n        return findPlacesWithinExtent(nextOptions);\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[\"placeIdGet\"][\"parameters\"][\"query\"],\n  \"requestedFields\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"placeIdGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getPlace};\n */\nexport interface IGetPlaceResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getPlace}.\n */\nexport interface IGetPlaceOptions\n  extends Omit<IRequestOptions, \"httpMethod\">,\n    queryParams {\n  placeId: string;\n}\n\n/**\n * Returns a single place, including additional details, such as:\n *\n * - contact details\n * - address\n * - price information\n * - user rating\n * - opening hours\n *\n * This endpoint can be used to fetch additional details for a specific\n * place, returned from a places search request.\n *\n * Note that some fields, such as opening hours, are not available for\n * every place. Where a field is not available it will be omitted from the\n * response and you will not be charged for this data.\n *\n *  ```js\n * import { getPlaceDetails } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const place = getPlaceDetails({\n *   placeId: \"e78051acc722c55ab11ba930d8dd7772\",\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(place);\n * ```\n */\nexport function getPlaceDetails(\n  requestOptions: IGetPlaceOptions\n): Promise<IGetPlaceResponse> {\n  const { placeId } = requestOptions;\n\n  const options = appendCustomParams<IGetPlaceOptions>(\n    requestOptions,\n    [\"requestedFields\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return request(`${baseUrl}/places/${placeId}`, {\n    ...options,\n    httpMethod: \"GET\"\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[\"categoriesGet\"][\"parameters\"][\"query\"],\n  \"filter\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"categoriesGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getCategories};\n */\nexport interface IGetCategoriesResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getCategories}.\n */\nexport interface IGetCategoriesOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * The ArcGIS Places service has many categories (or types) of place, from\n * art museums to zoos. This endpoint returns all the categories including\n * their label and `categoryId`. The category Id can be used to search for\n * types of places with a `places/near-point` or `places/within-extent`\n * request.\n *\n * Categories also have information on their `parent`. This allows you to\n * search for specific categories such as \"French Restaurant\" - or to\n * look for more generic types such as \"Restaurant\".\n *\n * ```js\n * import { getCategories } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = await getCategories({\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(response.categories);\n * ```\n */\nexport function getCategories(\n  requestOptions: IGetCategoriesOptions\n): Promise<IGetCategoriesResponse> {\n  const options = appendCustomParams<IGetCategoriesOptions>(\n    requestOptions,\n    [\"filter\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return request(`${baseUrl}/categories`, {\n    ...options,\n    httpMethod: \"GET\"\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 = operations[\"categoriesCategoryIdGet\"][\"parameters\"][\"query\"];\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"categoriesCategoryIdGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getCategory};\n */\nexport interface IGetCategoryResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getCategory}.\n */\nexport interface IGetCategoryOptions\n  extends Omit<IRequestOptions, \"httpMethod\">,\n    queryParams {\n  categoryId: string;\n}\n\n/**\n * Returns details about a single category by Id.\n *\n * ```js\n * import { getCategories } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = getCategory({\n *   categoryId: \"10000\",\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(response);\n * ```\n **/\nexport function getCategory(\n  requestOptions: IGetCategoryOptions\n): Promise<IGetCategoryResponse> {\n  const { categoryId } = requestOptions;\n\n  const options = appendCustomParams<IGetCategoryOptions>(requestOptions, [], {\n    ...requestOptions\n  });\n\n  return request(`${baseUrl}/categories/${categoryId}`, {\n    ...options,\n    httpMethod: \"GET\"\n  });\n}\n"],"names":[],"mappings":";;;;;;;AAAO,MAAM,OAAO,GAClB,sEAAsE,CAAC;SAEzD,WAAW,CAAC,QAAa;;IACvC,OAAO,CAAC,EAAC,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK,0CAAE,IAAI,CAAA,IAAI,CAAC,EAAC,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,0CAAE,OAAO,CAAA,CAAC;AACpE,CAAC;SAEe,iBAAiB,CAAC,aAAa,GAAG,CAAC,EAAE,eAAe,GAAG,EAAE;IACvE,OAAO;QACL,MAAM,EAAE,aAAa,GAAG,eAAe;QACvC,QAAQ,EAAE,eAAe;KAC1B,CAAC;AACJ;;ACsBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAsCgB,mBAAmB,CACjC,cAA2C;IAE3C,MAAM,OAAO,GAAG,kBAAkB,CAChC,cAAc,EACd,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,CAAC,oBAElE,cAAc,EAEpB,CAAC;IAEF,OACE,OAAO,CAAC,GAAG,OAAO,oBAAoB,kCACjC,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC,IAAI,CAAC,CAAC,QAAQ;QACd,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;QAEF,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE;YACzB,CAAC,CAAC,QAAQ,GAAG;gBACX,MAAM,WAAW,mCACZ,cAAc,GACd,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CACrE,CAAC;gBACF,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC;aACzC,CAAC;SACH;QAED,OAAO,CAAC,CAAC;KACV,CAAC,CAAC;AACL;;AChEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAuCgB,sBAAsB,CACpC,cAA6C;IAE7C,MAAM,OAAO,GAAG,kBAAkB,CAChC,cAAc,EACd;QACE,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,aAAa;QACb,UAAU;QACV,QAAQ;QACR,YAAY;KACb,oBAEI,cAAc,EAEpB,CAAC;IAEF,OACE,OAAO,CAAC,GAAG,OAAO,uBAAuB,kCACpC,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC,IAAI,CAAC,CAAC,QAAQ;QACd,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;QAEF,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE;YACzB,CAAC,CAAC,QAAQ,GAAG;gBACX,MAAM,WAAW,mCACZ,cAAc,GACd,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CACrE,CAAC;gBACF,OAAO,sBAAsB,CAAC,WAAW,CAAC,CAAC;aAC5C,CAAC;SACH;QACD,OAAO,CAAC,CAAC;KACV,CAAC,CAAC;AACL;;ACvFA;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA4BgB,eAAe,CAC7B,cAAgC;IAEhC,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC;IAEnC,MAAM,OAAO,GAAG,kBAAkB,CAChC,cAAc,EACd,CAAC,iBAAiB,CAAC,oBAEd,cAAc,EAEpB,CAAC;IAEF,OAAO,OAAO,CAAC,GAAG,OAAO,WAAW,OAAO,EAAE,kCACxC,OAAO,KACV,UAAU,EAAE,KAAK,IACjB,CAAC;AACL;;AC/CA;;;;;;;;;;;;;;;;;;;;;;SAsBgB,aAAa,CAC3B,cAAqC;IAErC,MAAM,OAAO,GAAG,kBAAkB,CAChC,cAAc,EACd,CAAC,QAAQ,CAAC,oBAEL,cAAc,EAEpB,CAAC;IAEF,OAAO,OAAO,CAAC,GAAG,OAAO,aAAa,kCACjC,OAAO,KACV,UAAU,EAAE,KAAK,IACjB,CAAC;AACL;;ACtCA;;;;;;;;;;;;;;;SAegB,WAAW,CACzB,cAAmC;IAEnC,MAAM,EAAE,UAAU,EAAE,GAAG,cAAc,CAAC;IAEtC,MAAM,OAAO,GAAG,kBAAkB,CAAsB,cAAc,EAAE,EAAE,oBACrE,cAAc,EACjB,CAAC;IAEH,OAAO,OAAO,CAAC,GAAG,OAAO,eAAe,UAAU,EAAE,kCAC/C,OAAO,KACV,UAAU,EAAE,KAAK,IACjB,CAAC;AACL;;;;"}
+{"version":3,"file":"places.esm.js","sources":["../../src/utils.ts","../../src/findPlacesNearPoint.ts","../../src/findPlacesWithinExtent.ts","../../src/getPlaceDetails.ts","../../src/getCategories.ts","../../src/getCategory.ts"],"sourcesContent":["export const baseUrl =\n  \"https://places-api.arcgis.com/arcgis/rest/services/places-service/v1\";\n\nexport function hasNextPage(response: any) {\n  return !!response?.links?.next || !!response?.pagination?.nextUrl;\n}\n\nexport function getNextPageParams(currentOffset = 0, currentPageSize = 10) {\n  return {\n    offset: currentOffset + currentPageSize,\n    pageSize: currentPageSize\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, hasNextPage, getNextPageParams } 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[\"nearPointGet\"][\"parameters\"][\"query\"],\n  \"x\" | \"y\" | \"radius\" | \"categoryIds\" | \"pageSize\" | \"offset\" | \"searchText\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"nearPointGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findPlacesNearPoint};\n */\nexport interface IFindPlacesNearPointResponse extends successResponse {\n  nextPage?: () => Promise<IFindPlacesNearPointResponse>;\n}\n\n/**\n * Options for {@linkcode findPlacesNearPoint}.\n */\nexport interface IFindPlacesNearPointOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * Searches places that are within a given radius of a geographic point.\n * You must supply the `x` and `y` coordinates of the point that you wish\n * to search from. You can either specify a search radius, or use the\n * default (500 meters).  You could use this method to search for places\n * around a user's GPS position, or a location clicked on a map.\n *\n * The returned places contain basic data such as name, category and\n * location. You can use the {@linkcode getPlace} method to get additional\n * details for a given place.\n *\n * You can refine the results by supplying additional search parameters,\n * including:\n *\n * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.\n * - A partial name filter with `name` option\n *\n * As this request can return many results, pagination is supported.\n * When a query results in more than [pageSize] places, the response will contain the property\n * `pagination` in addition to place results. If `pagination` exists, an additional method\n * `response.nextPage()` can be used to get the next page of results.\n *\n * ```js\n * import { findPlacesNearPoint } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = await findPlacesNearPoint({\n *   x: -3.1883,\n *   y: 55.9533,\n *   radius: 100,\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(response);\n * ```\n */\nexport function findPlacesNearPoint(\n  requestOptions: IFindPlacesNearPointOptions\n): Promise<IFindPlacesNearPointResponse> {\n  const options = appendCustomParams<IFindPlacesNearPointOptions>(\n    requestOptions,\n    [\"x\", \"y\", \"radius\", \"categoryIds\", \"pageSize\", \"offset\", \"searchText\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(requestOptions.endpoint || `${baseUrl}/places/near-point`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindPlacesNearPointResponse = {\n      ...response\n    };\n\n    if (hasNextPage(response)) {\n      r.nextPage = () => {\n        const nextOptions = {\n          ...requestOptions,\n          ...getNextPageParams(requestOptions.offset, requestOptions.pageSize)\n        };\n        return findPlacesNearPoint(nextOptions);\n      };\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, hasNextPage, getNextPageParams } 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[\"withinExtentGet\"][\"parameters\"][\"query\"],\n  | \"xmin\"\n  | \"ymin\"\n  | \"xmax\"\n  | \"ymax\"\n  | \"categoryIds\"\n  | \"pageSize\"\n  | \"offset\"\n  | \"searchText\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"withinExtentGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findPlacesWithinExtent};\n */\nexport interface IFindPlacesWithinExtentResponse extends successResponse {\n  nextPage?: () => Promise<IFindPlacesWithinExtentResponse>;\n}\n\n/**\n * Options for {@linkcode findPlacesNearPoint}.\n */\nexport interface IFindPlaceWithinExtentOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * Searches the world-wide set of places for those that are within an\n * extent, or bounding box. You must supply the `xmin`, `ymin`, `xmax` and\n * `ymax` coordinates of the extent. You could use this endpoint to search\n * for places in the visible extent of a user's screen.\n *\n * The returned places contain basic data such as name, category and\n * location. You can use the {@linkcode getPlace} method to get additional\n * details for a given place.\n *\n * You can also refine the results by supplying additional search parameters,\n * including:\n *\n * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.\n * - A partial name filter with `name` option\n *\n * As this request can return many results, pagination is supported.\n * When a query results in more than [pageSize] places, the response will contain the property\n * `pagination` in addition to place results. If `pagination` exists, an additional method\n * `response.nextPage()` can be used to get the next page of results.\n *\n * ```\n * import { findPlacesWithinExtent } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findPlacesWithinExtent({\n *   xmin: -118.013334,\n *   ymin: 33.78193,\n *   xmax: -117.795753,\n *   ymax: 33.873337,\n *   categoryIds: [\"13002\"],\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findPlacesWithinExtent(\n  requestOptions: IFindPlaceWithinExtentOptions\n): Promise<IFindPlacesWithinExtentResponse> {\n  const options = appendCustomParams<IFindPlaceWithinExtentOptions>(\n    requestOptions,\n    [\n      \"xmin\",\n      \"ymin\",\n      \"xmax\",\n      \"ymax\",\n      \"categoryIds\",\n      \"pageSize\",\n      \"offset\",\n      \"searchText\"\n    ],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(requestOptions.endpoint || `${baseUrl}/places/within-extent`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindPlacesWithinExtentResponse = {\n      ...response\n    };\n\n    if (hasNextPage(response)) {\n      r.nextPage = () => {\n        const nextOptions = {\n          ...requestOptions,\n          ...getNextPageParams(requestOptions.offset, requestOptions.pageSize)\n        };\n        return findPlacesWithinExtent(nextOptions);\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[\"placeIdGet\"][\"parameters\"][\"query\"],\n  \"requestedFields\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"placeIdGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getPlace};\n */\nexport interface IGetPlaceResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getPlace}.\n */\nexport interface IGetPlaceOptions\n  extends Omit<IRequestOptions, \"httpMethod\">,\n    queryParams {\n  placeId: string;\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * Returns a single place, including additional details, such as:\n *\n * - contact details\n * - address\n * - price information\n * - user rating\n * - opening hours\n *\n * This endpoint can be used to fetch additional details for a specific\n * place, returned from a places search request.\n *\n * Note that some fields, such as opening hours, are not available for\n * every place. Where a field is not available it will be omitted from the\n * response and you will not be charged for this data.\n *\n *  ```js\n * import { getPlaceDetails } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const place = getPlaceDetails({\n *   placeId: \"e78051acc722c55ab11ba930d8dd7772\",\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(place);\n * ```\n */\nexport function getPlaceDetails(\n  requestOptions: IGetPlaceOptions\n): Promise<IGetPlaceResponse> {\n  const { placeId } = requestOptions;\n\n  const options = appendCustomParams<IGetPlaceOptions>(\n    requestOptions,\n    [\"requestedFields\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return request(requestOptions.endpoint || `${baseUrl}/places/${placeId}`, {\n    ...options,\n    httpMethod: \"GET\"\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[\"categoriesGet\"][\"parameters\"][\"query\"],\n  \"filter\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"categoriesGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getCategories};\n */\nexport interface IGetCategoriesResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getCategories}.\n */\nexport interface IGetCategoriesOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * The ArcGIS Places service has many categories (or types) of place, from\n * art museums to zoos. This endpoint returns all the categories including\n * their label and `categoryId`. The category Id can be used to search for\n * types of places with a `places/near-point` or `places/within-extent`\n * request.\n *\n * Categories also have information on their `parent`. This allows you to\n * search for specific categories such as \"French Restaurant\" - or to\n * look for more generic types such as \"Restaurant\".\n *\n * ```js\n * import { getCategories } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = await getCategories({\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(response.categories);\n * ```\n */\nexport function getCategories(\n  requestOptions: IGetCategoriesOptions\n): Promise<IGetCategoriesResponse> {\n  const options = appendCustomParams<IGetCategoriesOptions>(\n    requestOptions,\n    [\"filter\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return request(requestOptions.endpoint || `${baseUrl}/categories`, {\n    ...options,\n    httpMethod: \"GET\"\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 = operations[\"categoriesCategoryIdGet\"][\"parameters\"][\"query\"];\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"categoriesCategoryIdGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getCategory};\n */\nexport interface IGetCategoryResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getCategory}.\n */\nexport interface IGetCategoryOptions\n  extends Omit<IRequestOptions, \"httpMethod\">,\n    queryParams {\n  categoryId: string;\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * Returns details about a single category by Id.\n *\n * ```js\n * import { getCategories } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = getCategory({\n *   categoryId: \"10000\",\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(response);\n * ```\n **/\nexport function getCategory(\n  requestOptions: IGetCategoryOptions\n): Promise<IGetCategoryResponse> {\n  const { categoryId } = requestOptions;\n\n  const options = appendCustomParams<IGetCategoryOptions>(requestOptions, [], {\n    ...requestOptions\n  });\n\n  return request(\n    requestOptions.endpoint || `${baseUrl}/categories/${categoryId}`,\n    {\n      ...options,\n      httpMethod: \"GET\"\n    }\n  );\n}\n"],"names":[],"mappings":";;;;;;;AAAO,MAAM,OAAO,GAClB,sEAAsE,CAAC;SAEzD,WAAW,CAAC,QAAa;;IACvC,OAAO,CAAC,EAAC,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK,0CAAE,IAAI,CAAA,IAAI,CAAC,EAAC,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,0CAAE,OAAO,CAAA,CAAC;AACpE,CAAC;SAEe,iBAAiB,CAAC,aAAa,GAAG,CAAC,EAAE,eAAe,GAAG,EAAE;IACvE,OAAO;QACL,MAAM,EAAE,aAAa,GAAG,eAAe;QACvC,QAAQ,EAAE,eAAe;KAC1B,CAAC;AACJ;;AC4BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAoCgB,mBAAmB,CACjC,cAA2C;IAE3C,MAAM,OAAO,GAAG,kBAAkB,CAChC,cAAc,EACd,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,CAAC,oBAElE,cAAc,EAEpB,CAAC;IAEF,OACE,OAAO,CAAC,cAAc,CAAC,QAAQ,IAAI,GAAG,OAAO,oBAAoB,kCAC5D,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC,IAAI,CAAC,CAAC,QAAQ;QACd,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;QAEF,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE;YACzB,CAAC,CAAC,QAAQ,GAAG;gBACX,MAAM,WAAW,mCACZ,cAAc,GACd,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CACrE,CAAC;gBACF,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC;aACzC,CAAC;SACH;QAED,OAAO,CAAC,CAAC;KACV,CAAC,CAAC;AACL;;AC9DA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAqCgB,sBAAsB,CACpC,cAA6C;IAE7C,MAAM,OAAO,GAAG,kBAAkB,CAChC,cAAc,EACd;QACE,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,aAAa;QACb,UAAU;QACV,QAAQ;QACR,YAAY;KACb,oBAEI,cAAc,EAEpB,CAAC;IAEF,OACE,OAAO,CAAC,cAAc,CAAC,QAAQ,IAAI,GAAG,OAAO,uBAAuB,kCAC/D,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC,IAAI,CAAC,CAAC,QAAQ;QACd,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;QAEF,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE;YACzB,CAAC,CAAC,QAAQ,GAAG;gBACX,MAAM,WAAW,mCACZ,cAAc,GACd,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CACrE,CAAC;gBACF,OAAO,sBAAsB,CAAC,WAAW,CAAC,CAAC;aAC5C,CAAC;SACH;QACD,OAAO,CAAC,CAAC;KACV,CAAC,CAAC;AACL;;ACtFA;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA4BgB,eAAe,CAC7B,cAAgC;IAEhC,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC;IAEnC,MAAM,OAAO,GAAG,kBAAkB,CAChC,cAAc,EACd,CAAC,iBAAiB,CAAC,oBAEd,cAAc,EAEpB,CAAC;IAEF,OAAO,OAAO,CAAC,cAAc,CAAC,QAAQ,IAAI,GAAG,OAAO,WAAW,OAAO,EAAE,kCACnE,OAAO,KACV,UAAU,EAAE,KAAK,IACjB,CAAC;AACL;;AC9CA;;;;;;;;;;;;;;;;;;;;;;SAsBgB,aAAa,CAC3B,cAAqC;IAErC,MAAM,OAAO,GAAG,kBAAkB,CAChC,cAAc,EACd,CAAC,QAAQ,CAAC,oBAEL,cAAc,EAEpB,CAAC;IAEF,OAAO,OAAO,CAAC,cAAc,CAAC,QAAQ,IAAI,GAAG,OAAO,aAAa,kCAC5D,OAAO,KACV,UAAU,EAAE,KAAK,IACjB,CAAC;AACL;;ACvCA;;;;;;;;;;;;;;;SAegB,WAAW,CACzB,cAAmC;IAEnC,MAAM,EAAE,UAAU,EAAE,GAAG,cAAc,CAAC;IAEtC,MAAM,OAAO,GAAG,kBAAkB,CAAsB,cAAc,EAAE,EAAE,oBACrE,cAAc,EACjB,CAAC;IAEH,OAAO,OAAO,CACZ,cAAc,CAAC,QAAQ,IAAI,GAAG,OAAO,eAAe,UAAU,EAAE,kCAE3D,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC;AACJ;;;;"}

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

@@ -1,7 +1,7 @@
 /* @preserve
-* @esri/arcgis-rest-places - v1.0.0 - Apache-2.0
-* Copyright (c) 2017-2023 Esri, Inc.
-* Tue Jun 27 2023 16:16:59 GMT+0000 (Coordinated Universal Time)
+* @esri/arcgis-rest-places - v1.0.2 - Apache-2.0
+* Copyright (c) 2017-2024 Esri, Inc.
+* Tue Jun 18 2024 23:49:53 GMT+0000 (Coordinated Universal Time)
 */
-import{appendCustomParams as e,request as t}from"@esri/arcgis-rest-request";const s="https://places-api.arcgis.com/arcgis/rest/services/places-service/v1";function n(e){var t,s;return!!(null===(t=null==e?void 0:e.links)||void 0===t?void 0:t.next)||!!(null===(s=null==e?void 0:e.pagination)||void 0===s?void 0:s.nextUrl)}function i(e=0,t=10){return{offset:e+t,pageSize:t}}function c(a){const r=e(a,["x","y","radius","categoryIds","pageSize","offset","searchText"],Object.assign({},a));return t(`${s}/places/near-point`,Object.assign(Object.assign({},r),{httpMethod:"GET"})).then((e=>{const t=Object.assign({},e);return n(e)&&(t.nextPage=()=>c(Object.assign(Object.assign({},a),i(a.offset,a.pageSize)))),t}))}function a(c){const r=e(c,["xmin","ymin","xmax","ymax","categoryIds","pageSize","offset","searchText"],Object.assign({},c));return t(`${s}/places/within-extent`,Object.assign(Object.assign({},r),{httpMethod:"GET"})).then((e=>{const t=Object.assign({},e);return n(e)&&(t.nextPage=()=>a(Object.assign(Object.assign({},c),i(c.offset,c.pageSize)))),t}))}function r(n){const{placeId:i}=n,c=e(n,["requestedFields"],Object.assign({},n));return t(`${s}/places/${i}`,Object.assign(Object.assign({},c),{httpMethod:"GET"}))}function o(n){const i=e(n,["filter"],Object.assign({},n));return t(`${s}/categories`,Object.assign(Object.assign({},i),{httpMethod:"GET"}))}function g(n){const{categoryId:i}=n,c=e(n,[],Object.assign({},n));return t(`${s}/categories/${i}`,Object.assign(Object.assign({},c),{httpMethod:"GET"}))}export{c as findPlacesNearPoint,a as findPlacesWithinExtent,o as getCategories,g as getCategory,r as getPlaceDetails};
+import{appendCustomParams as e,request as t}from"@esri/arcgis-rest-request";const n="https://places-api.arcgis.com/arcgis/rest/services/places-service/v1";function s(e){var t,n;return!!(null===(t=null==e?void 0:e.links)||void 0===t?void 0:t.next)||!!(null===(n=null==e?void 0:e.pagination)||void 0===n?void 0:n.nextUrl)}function i(e=0,t=10){return{offset:e+t,pageSize:t}}function c(a){const o=e(a,["x","y","radius","categoryIds","pageSize","offset","searchText"],Object.assign({},a));return t(a.endpoint||`${n}/places/near-point`,Object.assign(Object.assign({},o),{httpMethod:"GET"})).then((e=>{const t=Object.assign({},e);return s(e)&&(t.nextPage=()=>c(Object.assign(Object.assign({},a),i(a.offset,a.pageSize)))),t}))}function a(c){const o=e(c,["xmin","ymin","xmax","ymax","categoryIds","pageSize","offset","searchText"],Object.assign({},c));return t(c.endpoint||`${n}/places/within-extent`,Object.assign(Object.assign({},o),{httpMethod:"GET"})).then((e=>{const t=Object.assign({},e);return s(e)&&(t.nextPage=()=>a(Object.assign(Object.assign({},c),i(c.offset,c.pageSize)))),t}))}function o(s){const{placeId:i}=s,c=e(s,["requestedFields"],Object.assign({},s));return t(s.endpoint||`${n}/places/${i}`,Object.assign(Object.assign({},c),{httpMethod:"GET"}))}function r(s){const i=e(s,["filter"],Object.assign({},s));return t(s.endpoint||`${n}/categories`,Object.assign(Object.assign({},i),{httpMethod:"GET"}))}function g(s){const{categoryId:i}=s,c=e(s,[],Object.assign({},s));return t(s.endpoint||`${n}/categories/${i}`,Object.assign(Object.assign({},c),{httpMethod:"GET"}))}export{c as findPlacesNearPoint,a as findPlacesWithinExtent,r as getCategories,g as getCategory,o as getPlaceDetails};
 //# sourceMappingURL=places.esm.min.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"places.esm.min.js","sources":["../../src/utils.ts","../../src/findPlacesNearPoint.ts","../../src/findPlacesWithinExtent.ts","../../src/getPlaceDetails.ts","../../src/getCategories.ts","../../src/getCategory.ts"],"sourcesContent":["export const baseUrl =\n  \"https://places-api.arcgis.com/arcgis/rest/services/places-service/v1\";\n\nexport function hasNextPage(response: any) {\n  return !!response?.links?.next || !!response?.pagination?.nextUrl;\n}\n\nexport function getNextPageParams(currentOffset = 0, currentPageSize = 10) {\n  return {\n    offset: currentOffset + currentPageSize,\n    pageSize: currentPageSize\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, hasNextPage, getNextPageParams } 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[\"nearPointGet\"][\"parameters\"][\"query\"],\n  \"x\" | \"y\" | \"radius\" | \"categoryIds\" | \"pageSize\" | \"offset\" | \"searchText\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"nearPointGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findPlacesNearPoint};\n */\nexport interface IFindPlacesNearPointResponse extends successResponse {\n  nextPage?: () => Promise<IFindPlacesNearPointResponse>;\n}\n\n/**\n * Options for {@linkcode findPlacesNearPoint}.\n */\nexport interface IFindPlacesNearPointOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * Searches places that are within a given radius of a geographic point.\n * You must supply the `x` and `y` coordinates of the point that you wish\n * to search from. You can either specify a search radius, or use the\n * default (500 meters).  You could use this method to search for places\n * around a user's GPS position, or a location clicked on a map.\n *\n * The returned places contain basic data such as name, category and\n * location. You can use the {@linkcode getPlace} method to get additional\n * details for a given place.\n *\n * You can refine the results by supplying additional search parameters,\n * including:\n *\n * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.\n * - A partial name filter with `name` option\n *\n * As this request can return many results, pagination is supported.\n * Regardless of paging, the maximum number of places that can be returned\n * by a single query is `200`. When a query results in more than `200`\n * places, the response will contain the property\n * `\"maxResultsExceeded\":true` in addition to place results. If `maxResultsExceeded`\n * is true an additional method `response.nextPage()` can be used to get the next page of results.\n *\n * ```js\n * import { findPlacesNearPoint } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = await findPlacesNearPoint({\n *   x: -3.1883,\n *   y: 55.9533,\n *   radius: 100,\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(response);\n * ```\n */\nexport function findPlacesNearPoint(\n  requestOptions: IFindPlacesNearPointOptions\n): Promise<IFindPlacesNearPointResponse> {\n  const options = appendCustomParams<IFindPlacesNearPointOptions>(\n    requestOptions,\n    [\"x\", \"y\", \"radius\", \"categoryIds\", \"pageSize\", \"offset\", \"searchText\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(`${baseUrl}/places/near-point`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindPlacesNearPointResponse = {\n      ...response\n    };\n\n    if (hasNextPage(response)) {\n      r.nextPage = () => {\n        const nextOptions = {\n          ...requestOptions,\n          ...getNextPageParams(requestOptions.offset, requestOptions.pageSize)\n        };\n        return findPlacesNearPoint(nextOptions);\n      };\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, hasNextPage, getNextPageParams } 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[\"withinExtentGet\"][\"parameters\"][\"query\"],\n  | \"xmin\"\n  | \"ymin\"\n  | \"xmax\"\n  | \"ymax\"\n  | \"categoryIds\"\n  | \"pageSize\"\n  | \"offset\"\n  | \"searchText\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"withinExtentGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findPlacesWithinExtent};\n */\nexport interface IFindPlacesWithinExtentResponse extends successResponse {\n  nextPage?: () => Promise<IFindPlacesWithinExtentResponse>;\n}\n\n/**\n * Options for {@linkcode findPlacesNearPoint}.\n */\nexport interface IFindPlaceWithinExtentOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * Searches the world-wide set of places for those that are within an\n * extent, or bounding box. You must supply the `xmin`, `ymin`, `xmax` and\n * `ymax` coordinates of the extent. You could use this endpoint to search\n * for places in the visible extent of a user's screen.\n *\n * The returned places contain basic data such as name, category and\n * location. You can use the {@linkcode getPlace} method to get additional\n * details for a given place.\n *\n * You can also refine the results by supplying additional search parameters,\n * including:\n *\n * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.\n * - A partial name filter with `name` option\n *\n * As this request can return many results, pagination is supported.\n * Regardless of paging, the maximum number of places that can be returned\n * by a single query is `200`. When a query results in more than `200`\n * places, the response will contain the property\n * `\"maxResultsExceeded\":true` in addition to place results. If `maxResultsExceeded`\n * is true an additional method `response.nextPage()` can be used to get the next page of results.\n *\n * ```\n * import { findPlacesWithinExtent } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findPlacesWithinExtent({\n *   xmin: -118.013334,\n *   ymin: 33.78193,\n *   xmax: -117.795753,\n *   ymax: 33.873337,\n *   categoryIds: [\"13002\"],\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findPlacesWithinExtent(\n  requestOptions: IFindPlaceWithinExtentOptions\n): Promise<IFindPlacesWithinExtentResponse> {\n  const options = appendCustomParams<IFindPlaceWithinExtentOptions>(\n    requestOptions,\n    [\n      \"xmin\",\n      \"ymin\",\n      \"xmax\",\n      \"ymax\",\n      \"categoryIds\",\n      \"pageSize\",\n      \"offset\",\n      \"searchText\"\n    ],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(`${baseUrl}/places/within-extent`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindPlacesWithinExtentResponse = {\n      ...response\n    };\n\n    if (hasNextPage(response)) {\n      r.nextPage = () => {\n        const nextOptions = {\n          ...requestOptions,\n          ...getNextPageParams(requestOptions.offset, requestOptions.pageSize)\n        };\n        return findPlacesWithinExtent(nextOptions);\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[\"placeIdGet\"][\"parameters\"][\"query\"],\n  \"requestedFields\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"placeIdGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getPlace};\n */\nexport interface IGetPlaceResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getPlace}.\n */\nexport interface IGetPlaceOptions\n  extends Omit<IRequestOptions, \"httpMethod\">,\n    queryParams {\n  placeId: string;\n}\n\n/**\n * Returns a single place, including additional details, such as:\n *\n * - contact details\n * - address\n * - price information\n * - user rating\n * - opening hours\n *\n * This endpoint can be used to fetch additional details for a specific\n * place, returned from a places search request.\n *\n * Note that some fields, such as opening hours, are not available for\n * every place. Where a field is not available it will be omitted from the\n * response and you will not be charged for this data.\n *\n *  ```js\n * import { getPlaceDetails } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const place = getPlaceDetails({\n *   placeId: \"e78051acc722c55ab11ba930d8dd7772\",\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(place);\n * ```\n */\nexport function getPlaceDetails(\n  requestOptions: IGetPlaceOptions\n): Promise<IGetPlaceResponse> {\n  const { placeId } = requestOptions;\n\n  const options = appendCustomParams<IGetPlaceOptions>(\n    requestOptions,\n    [\"requestedFields\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return request(`${baseUrl}/places/${placeId}`, {\n    ...options,\n    httpMethod: \"GET\"\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[\"categoriesGet\"][\"parameters\"][\"query\"],\n  \"filter\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"categoriesGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getCategories};\n */\nexport interface IGetCategoriesResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getCategories}.\n */\nexport interface IGetCategoriesOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * The ArcGIS Places service has many categories (or types) of place, from\n * art museums to zoos. This endpoint returns all the categories including\n * their label and `categoryId`. The category Id can be used to search for\n * types of places with a `places/near-point` or `places/within-extent`\n * request.\n *\n * Categories also have information on their `parent`. This allows you to\n * search for specific categories such as \"French Restaurant\" - or to\n * look for more generic types such as \"Restaurant\".\n *\n * ```js\n * import { getCategories } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = await getCategories({\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(response.categories);\n * ```\n */\nexport function getCategories(\n  requestOptions: IGetCategoriesOptions\n): Promise<IGetCategoriesResponse> {\n  const options = appendCustomParams<IGetCategoriesOptions>(\n    requestOptions,\n    [\"filter\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return request(`${baseUrl}/categories`, {\n    ...options,\n    httpMethod: \"GET\"\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 = operations[\"categoriesCategoryIdGet\"][\"parameters\"][\"query\"];\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"categoriesCategoryIdGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getCategory};\n */\nexport interface IGetCategoryResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getCategory}.\n */\nexport interface IGetCategoryOptions\n  extends Omit<IRequestOptions, \"httpMethod\">,\n    queryParams {\n  categoryId: string;\n}\n\n/**\n * Returns details about a single category by Id.\n *\n * ```js\n * import { getCategories } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = getCategory({\n *   categoryId: \"10000\",\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(response);\n * ```\n **/\nexport function getCategory(\n  requestOptions: IGetCategoryOptions\n): Promise<IGetCategoryResponse> {\n  const { categoryId } = requestOptions;\n\n  const options = appendCustomParams<IGetCategoryOptions>(requestOptions, [], {\n    ...requestOptions\n  });\n\n  return request(`${baseUrl}/categories/${categoryId}`, {\n    ...options,\n    httpMethod: \"GET\"\n  });\n}\n"],"names":["baseUrl","hasNextPage","response","links","next","pagination","nextUrl","getNextPageParams","currentOffset","currentPageSize","offset","pageSize","findPlacesNearPoint","requestOptions","options","appendCustomParams","request","httpMethod","then","r","nextPage","findPlacesWithinExtent","getPlaceDetails","placeId","getCategories","getCategory","categoryId"],"mappings":";;;;;4EAAO,MAAMA,EACX,gFAEcC,EAAYC,WAC1B,mBAASA,eAAAA,EAAUC,4BAAOC,oBAAUF,eAAAA,EAAUG,iCAAYC,QAC5D,UAEgBC,EAAkBC,EAAgB,EAAGC,EAAkB,IACrE,MAAO,CACLC,OAAQF,EAAgBC,EACxBE,SAAUF,EAEd,UC4DgBG,EACdC,GAEA,MAAMC,EAAUC,EACdF,EACA,CAAC,IAAK,IAAK,SAAU,cAAe,WAAY,SAAU,+BAErDA,IAIP,OACEG,EAAQ,GAAGhB,qDACNc,IACHG,WAAY,SAEdC,MAAMhB,IACN,MAAMiB,mBACDjB,GAaL,OAVID,EAAYC,KACdiB,EAAEC,SAAW,IAKJR,iCAHFC,GACAN,EAAkBM,EAAeH,OAAQG,EAAeF,aAM1DQ,CAAC,GAEZ,UCzBgBE,EACdR,GAEA,MAAMC,EAAUC,EACdF,EACA,CACE,OACA,OACA,OACA,OACA,cACA,WACA,SACA,+BAGGA,IAIP,OACEG,EAAQ,GAAGhB,wDACNc,IACHG,WAAY,SAEdC,MAAMhB,IACN,MAAMiB,mBACDjB,GAYL,OATID,EAAYC,KACdiB,EAAEC,SAAW,IAKJC,iCAHFR,GACAN,EAAkBM,EAAeH,OAAQG,EAAeF,aAK1DQ,CAAC,GAEZ,UC3DgBG,EACdT,GAEA,MAAMU,QAAEA,GAAYV,EAEdC,EAAUC,EACdF,EACA,CAAC,oCAEIA,IAIP,OAAOG,EAAQ,GAAGhB,YAAkBuB,mCAC/BT,IACHG,WAAY,QAEhB,UCzBgBO,EACdX,GAEA,MAAMC,EAAUC,EACdF,EACA,CAAC,2BAEIA,IAIP,OAAOG,EAAQ,GAAGhB,8CACbc,IACHG,WAAY,QAEhB,UCvBgBQ,EACdZ,GAEA,MAAMa,WAAEA,GAAeb,EAEjBC,EAAUC,EAAwCF,EAAgB,oBACnEA,IAGL,OAAOG,EAAQ,GAAGhB,gBAAsB0B,mCACnCZ,IACHG,WAAY,QAEhB"}
+{"version":3,"file":"places.esm.min.js","sources":["../../src/utils.ts","../../src/findPlacesNearPoint.ts","../../src/findPlacesWithinExtent.ts","../../src/getPlaceDetails.ts","../../src/getCategories.ts","../../src/getCategory.ts"],"sourcesContent":["export const baseUrl =\n  \"https://places-api.arcgis.com/arcgis/rest/services/places-service/v1\";\n\nexport function hasNextPage(response: any) {\n  return !!response?.links?.next || !!response?.pagination?.nextUrl;\n}\n\nexport function getNextPageParams(currentOffset = 0, currentPageSize = 10) {\n  return {\n    offset: currentOffset + currentPageSize,\n    pageSize: currentPageSize\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, hasNextPage, getNextPageParams } 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[\"nearPointGet\"][\"parameters\"][\"query\"],\n  \"x\" | \"y\" | \"radius\" | \"categoryIds\" | \"pageSize\" | \"offset\" | \"searchText\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"nearPointGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findPlacesNearPoint};\n */\nexport interface IFindPlacesNearPointResponse extends successResponse {\n  nextPage?: () => Promise<IFindPlacesNearPointResponse>;\n}\n\n/**\n * Options for {@linkcode findPlacesNearPoint}.\n */\nexport interface IFindPlacesNearPointOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * Searches places that are within a given radius of a geographic point.\n * You must supply the `x` and `y` coordinates of the point that you wish\n * to search from. You can either specify a search radius, or use the\n * default (500 meters).  You could use this method to search for places\n * around a user's GPS position, or a location clicked on a map.\n *\n * The returned places contain basic data such as name, category and\n * location. You can use the {@linkcode getPlace} method to get additional\n * details for a given place.\n *\n * You can refine the results by supplying additional search parameters,\n * including:\n *\n * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.\n * - A partial name filter with `name` option\n *\n * As this request can return many results, pagination is supported.\n * When a query results in more than [pageSize] places, the response will contain the property\n * `pagination` in addition to place results. If `pagination` exists, an additional method\n * `response.nextPage()` can be used to get the next page of results.\n *\n * ```js\n * import { findPlacesNearPoint } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = await findPlacesNearPoint({\n *   x: -3.1883,\n *   y: 55.9533,\n *   radius: 100,\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(response);\n * ```\n */\nexport function findPlacesNearPoint(\n  requestOptions: IFindPlacesNearPointOptions\n): Promise<IFindPlacesNearPointResponse> {\n  const options = appendCustomParams<IFindPlacesNearPointOptions>(\n    requestOptions,\n    [\"x\", \"y\", \"radius\", \"categoryIds\", \"pageSize\", \"offset\", \"searchText\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(requestOptions.endpoint || `${baseUrl}/places/near-point`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindPlacesNearPointResponse = {\n      ...response\n    };\n\n    if (hasNextPage(response)) {\n      r.nextPage = () => {\n        const nextOptions = {\n          ...requestOptions,\n          ...getNextPageParams(requestOptions.offset, requestOptions.pageSize)\n        };\n        return findPlacesNearPoint(nextOptions);\n      };\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, hasNextPage, getNextPageParams } 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[\"withinExtentGet\"][\"parameters\"][\"query\"],\n  | \"xmin\"\n  | \"ymin\"\n  | \"xmax\"\n  | \"ymax\"\n  | \"categoryIds\"\n  | \"pageSize\"\n  | \"offset\"\n  | \"searchText\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"withinExtentGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findPlacesWithinExtent};\n */\nexport interface IFindPlacesWithinExtentResponse extends successResponse {\n  nextPage?: () => Promise<IFindPlacesWithinExtentResponse>;\n}\n\n/**\n * Options for {@linkcode findPlacesNearPoint}.\n */\nexport interface IFindPlaceWithinExtentOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * Searches the world-wide set of places for those that are within an\n * extent, or bounding box. You must supply the `xmin`, `ymin`, `xmax` and\n * `ymax` coordinates of the extent. You could use this endpoint to search\n * for places in the visible extent of a user's screen.\n *\n * The returned places contain basic data such as name, category and\n * location. You can use the {@linkcode getPlace} method to get additional\n * details for a given place.\n *\n * You can also refine the results by supplying additional search parameters,\n * including:\n *\n * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.\n * - A partial name filter with `name` option\n *\n * As this request can return many results, pagination is supported.\n * When a query results in more than [pageSize] places, the response will contain the property\n * `pagination` in addition to place results. If `pagination` exists, an additional method\n * `response.nextPage()` can be used to get the next page of results.\n *\n * ```\n * import { findPlacesWithinExtent } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findPlacesWithinExtent({\n *   xmin: -118.013334,\n *   ymin: 33.78193,\n *   xmax: -117.795753,\n *   ymax: 33.873337,\n *   categoryIds: [\"13002\"],\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findPlacesWithinExtent(\n  requestOptions: IFindPlaceWithinExtentOptions\n): Promise<IFindPlacesWithinExtentResponse> {\n  const options = appendCustomParams<IFindPlaceWithinExtentOptions>(\n    requestOptions,\n    [\n      \"xmin\",\n      \"ymin\",\n      \"xmax\",\n      \"ymax\",\n      \"categoryIds\",\n      \"pageSize\",\n      \"offset\",\n      \"searchText\"\n    ],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(requestOptions.endpoint || `${baseUrl}/places/within-extent`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindPlacesWithinExtentResponse = {\n      ...response\n    };\n\n    if (hasNextPage(response)) {\n      r.nextPage = () => {\n        const nextOptions = {\n          ...requestOptions,\n          ...getNextPageParams(requestOptions.offset, requestOptions.pageSize)\n        };\n        return findPlacesWithinExtent(nextOptions);\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[\"placeIdGet\"][\"parameters\"][\"query\"],\n  \"requestedFields\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"placeIdGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getPlace};\n */\nexport interface IGetPlaceResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getPlace}.\n */\nexport interface IGetPlaceOptions\n  extends Omit<IRequestOptions, \"httpMethod\">,\n    queryParams {\n  placeId: string;\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * Returns a single place, including additional details, such as:\n *\n * - contact details\n * - address\n * - price information\n * - user rating\n * - opening hours\n *\n * This endpoint can be used to fetch additional details for a specific\n * place, returned from a places search request.\n *\n * Note that some fields, such as opening hours, are not available for\n * every place. Where a field is not available it will be omitted from the\n * response and you will not be charged for this data.\n *\n *  ```js\n * import { getPlaceDetails } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const place = getPlaceDetails({\n *   placeId: \"e78051acc722c55ab11ba930d8dd7772\",\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(place);\n * ```\n */\nexport function getPlaceDetails(\n  requestOptions: IGetPlaceOptions\n): Promise<IGetPlaceResponse> {\n  const { placeId } = requestOptions;\n\n  const options = appendCustomParams<IGetPlaceOptions>(\n    requestOptions,\n    [\"requestedFields\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return request(requestOptions.endpoint || `${baseUrl}/places/${placeId}`, {\n    ...options,\n    httpMethod: \"GET\"\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[\"categoriesGet\"][\"parameters\"][\"query\"],\n  \"filter\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"categoriesGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getCategories};\n */\nexport interface IGetCategoriesResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getCategories}.\n */\nexport interface IGetCategoriesOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * The ArcGIS Places service has many categories (or types) of place, from\n * art museums to zoos. This endpoint returns all the categories including\n * their label and `categoryId`. The category Id can be used to search for\n * types of places with a `places/near-point` or `places/within-extent`\n * request.\n *\n * Categories also have information on their `parent`. This allows you to\n * search for specific categories such as \"French Restaurant\" - or to\n * look for more generic types such as \"Restaurant\".\n *\n * ```js\n * import { getCategories } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = await getCategories({\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(response.categories);\n * ```\n */\nexport function getCategories(\n  requestOptions: IGetCategoriesOptions\n): Promise<IGetCategoriesResponse> {\n  const options = appendCustomParams<IGetCategoriesOptions>(\n    requestOptions,\n    [\"filter\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return request(requestOptions.endpoint || `${baseUrl}/categories`, {\n    ...options,\n    httpMethod: \"GET\"\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 = operations[\"categoriesCategoryIdGet\"][\"parameters\"][\"query\"];\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"categoriesCategoryIdGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getCategory};\n */\nexport interface IGetCategoryResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getCategory}.\n */\nexport interface IGetCategoryOptions\n  extends Omit<IRequestOptions, \"httpMethod\">,\n    queryParams {\n  categoryId: string;\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * Returns details about a single category by Id.\n *\n * ```js\n * import { getCategories } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = getCategory({\n *   categoryId: \"10000\",\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(response);\n * ```\n **/\nexport function getCategory(\n  requestOptions: IGetCategoryOptions\n): Promise<IGetCategoryResponse> {\n  const { categoryId } = requestOptions;\n\n  const options = appendCustomParams<IGetCategoryOptions>(requestOptions, [], {\n    ...requestOptions\n  });\n\n  return request(\n    requestOptions.endpoint || `${baseUrl}/categories/${categoryId}`,\n    {\n      ...options,\n      httpMethod: \"GET\"\n    }\n  );\n}\n"],"names":["baseUrl","hasNextPage","response","links","next","pagination","nextUrl","getNextPageParams","currentOffset","currentPageSize","offset","pageSize","findPlacesNearPoint","requestOptions","options","appendCustomParams","request","endpoint","httpMethod","then","r","nextPage","findPlacesWithinExtent","getPlaceDetails","placeId","getCategories","getCategory","categoryId"],"mappings":";;;;;4EAAO,MAAMA,EACX,gFAEcC,EAAYC,WAC1B,mBAASA,eAAAA,EAAUC,4BAAOC,oBAAUF,eAAAA,EAAUG,iCAAYC,QAC5D,UAEgBC,EAAkBC,EAAgB,EAAGC,EAAkB,IACrE,MAAO,CACLC,OAAQF,EAAgBC,EACxBE,SAAUF,EAEd,UCgEgBG,EACdC,GAEA,MAAMC,EAAUC,EACdF,EACA,CAAC,IAAK,IAAK,SAAU,cAAe,WAAY,SAAU,+BAErDA,IAIP,OACEG,EAAQH,EAAeI,UAAY,GAAGjB,qDACjCc,IACHI,WAAY,SAEdC,MAAMjB,IACN,MAAMkB,mBACDlB,GAaL,OAVID,EAAYC,KACdkB,EAAEC,SAAW,IAKJT,iCAHFC,GACAN,EAAkBM,EAAeH,OAAQG,EAAeF,aAM1DS,CAAC,GAEZ,UCzBgBE,EACdT,GAEA,MAAMC,EAAUC,EACdF,EACA,CACE,OACA,OACA,OACA,OACA,cACA,WACA,SACA,+BAGGA,IAIP,OACEG,EAAQH,EAAeI,UAAY,GAAGjB,wDACjCc,IACHI,WAAY,SAEdC,MAAMjB,IACN,MAAMkB,mBACDlB,GAYL,OATID,EAAYC,KACdkB,EAAEC,SAAW,IAKJC,iCAHFT,GACAN,EAAkBM,EAAeH,OAAQG,EAAeF,aAK1DS,CAAC,GAEZ,UC1DgBG,EACdV,GAEA,MAAMW,QAAEA,GAAYX,EAEdC,EAAUC,EACdF,EACA,CAAC,oCAEIA,IAIP,OAAOG,EAAQH,EAAeI,UAAY,GAAGjB,YAAkBwB,mCAC1DV,IACHI,WAAY,QAEhB,UCxBgBO,EACdZ,GAEA,MAAMC,EAAUC,EACdF,EACA,CAAC,2BAEIA,IAIP,OAAOG,EAAQH,EAAeI,UAAY,GAAGjB,8CACxCc,IACHI,WAAY,QAEhB,UCxBgBQ,EACdb,GAEA,MAAMc,WAAEA,GAAed,EAEjBC,EAAUC,EAAwCF,EAAgB,oBACnEA,IAGL,OAAOG,EACLH,EAAeI,UAAY,GAAGjB,gBAAsB2B,mCAE/Cb,IACHI,WAAY,QAGlB"}

package/dist/bundled/places.umd.js

@@ -1,7 +1,7 @@
 /* @preserve
-* @esri/arcgis-rest-places - v1.0.0 - Apache-2.0
-* Copyright (c) 2017-2023 Esri, Inc.
-* Tue Jun 27 2023 16:16:59 GMT+0000 (Coordinated Universal Time)
+* @esri/arcgis-rest-places - v1.0.2 - Apache-2.0
+* Copyright (c) 2017-2024 Esri, Inc.
+* Tue Jun 18 2024 23:49:53 GMT+0000 (Coordinated Universal Time)
 */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@esri/arcgis-rest-request')) :
@@ -39,11 +39,9 @@
    * - A partial name filter with `name` option
    *
    * As this request can return many results, pagination is supported.
-   * Regardless of paging, the maximum number of places that can be returned
-   * by a single query is `200`. When a query results in more than `200`
-   * places, the response will contain the property
-   * `"maxResultsExceeded":true` in addition to place results. If `maxResultsExceeded`
-   * is true an additional method `response.nextPage()` can be used to get the next page of results.
+   * When a query results in more than [pageSize] places, the response will contain the property
+   * `pagination` in addition to place results. If `pagination` exists, an additional method
+   * `response.nextPage()` can be used to get the next page of results.
    *
    * ```js
    * import { findPlacesNearPoint } from "@esri/arcgis-rest-places";
@@ -61,7 +59,7 @@
    */
   function findPlacesNearPoint(requestOptions) {
       const options = arcgisRestRequest.appendCustomParams(requestOptions, ["x", "y", "radius", "categoryIds", "pageSize", "offset", "searchText"], Object.assign({}, requestOptions));
-      return arcgisRestRequest.request(`${baseUrl}/places/near-point`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
+      return arcgisRestRequest.request(requestOptions.endpoint || `${baseUrl}/places/near-point`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
           const r = Object.assign({}, response);
           if (hasNextPage(response)) {
               r.nextPage = () => {
@@ -90,11 +88,9 @@
    * - A partial name filter with `name` option
    *
    * As this request can return many results, pagination is supported.
-   * Regardless of paging, the maximum number of places that can be returned
-   * by a single query is `200`. When a query results in more than `200`
-   * places, the response will contain the property
-   * `"maxResultsExceeded":true` in addition to place results. If `maxResultsExceeded`
-   * is true an additional method `response.nextPage()` can be used to get the next page of results.
+   * When a query results in more than [pageSize] places, the response will contain the property
+   * `pagination` in addition to place results. If `pagination` exists, an additional method
+   * `response.nextPage()` can be used to get the next page of results.
    *
    * ```
    * import { findPlacesWithinExtent } from "@esri/arcgis-rest-places";
@@ -106,7 +102,7 @@
    *   xmax: -117.795753,
    *   ymax: 33.873337,
    *   categoryIds: ["13002"],
-   *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+   *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY")
    * });
    *
    * console.log(results)
@@ -123,7 +119,7 @@
           "offset",
           "searchText"
       ], Object.assign({}, requestOptions));
-      return arcgisRestRequest.request(`${baseUrl}/places/within-extent`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
+      return arcgisRestRequest.request(requestOptions.endpoint || `${baseUrl}/places/within-extent`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
           const r = Object.assign({}, response);
           if (hasNextPage(response)) {
               r.nextPage = () => {
@@ -157,7 +153,7 @@
    *
    * const place = getPlaceDetails({
    *   placeId: "e78051acc722c55ab11ba930d8dd7772",
-   *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+   *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY")
    * });
    *
    * console.log(place);
@@ -166,7 +162,7 @@
   function getPlaceDetails(requestOptions) {
       const { placeId } = requestOptions;
       const options = arcgisRestRequest.appendCustomParams(requestOptions, ["requestedFields"], Object.assign({}, requestOptions));
-      return arcgisRestRequest.request(`${baseUrl}/places/${placeId}`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
+      return arcgisRestRequest.request(requestOptions.endpoint || `${baseUrl}/places/${placeId}`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
   }
 
   /**
@@ -193,7 +189,7 @@
    */
   function getCategories(requestOptions) {
       const options = arcgisRestRequest.appendCustomParams(requestOptions, ["filter"], Object.assign({}, requestOptions));
-      return arcgisRestRequest.request(`${baseUrl}/categories`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
+      return arcgisRestRequest.request(requestOptions.endpoint || `${baseUrl}/categories`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
   }
 
   /**
@@ -205,7 +201,7 @@
    *
    * const response = getCategory({
    *   categoryId: "10000",
-   *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+   *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY")
    * });
    *
    * console.log(response);
@@ -214,7 +210,7 @@
   function getCategory(requestOptions) {
       const { categoryId } = requestOptions;
       const options = arcgisRestRequest.appendCustomParams(requestOptions, [], Object.assign({}, requestOptions));
-      return arcgisRestRequest.request(`${baseUrl}/categories/${categoryId}`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
+      return arcgisRestRequest.request(requestOptions.endpoint || `${baseUrl}/categories/${categoryId}`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
   }
 
   exports.findPlacesNearPoint = findPlacesNearPoint;

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

@@ -1 +1 @@
-{"version":3,"file":"places.umd.js","sources":["../../src/utils.ts","../../src/findPlacesNearPoint.ts","../../src/findPlacesWithinExtent.ts","../../src/getPlaceDetails.ts","../../src/getCategories.ts","../../src/getCategory.ts"],"sourcesContent":["export const baseUrl =\n  \"https://places-api.arcgis.com/arcgis/rest/services/places-service/v1\";\n\nexport function hasNextPage(response: any) {\n  return !!response?.links?.next || !!response?.pagination?.nextUrl;\n}\n\nexport function getNextPageParams(currentOffset = 0, currentPageSize = 10) {\n  return {\n    offset: currentOffset + currentPageSize,\n    pageSize: currentPageSize\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, hasNextPage, getNextPageParams } 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[\"nearPointGet\"][\"parameters\"][\"query\"],\n  \"x\" | \"y\" | \"radius\" | \"categoryIds\" | \"pageSize\" | \"offset\" | \"searchText\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"nearPointGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findPlacesNearPoint};\n */\nexport interface IFindPlacesNearPointResponse extends successResponse {\n  nextPage?: () => Promise<IFindPlacesNearPointResponse>;\n}\n\n/**\n * Options for {@linkcode findPlacesNearPoint}.\n */\nexport interface IFindPlacesNearPointOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * Searches places that are within a given radius of a geographic point.\n * You must supply the `x` and `y` coordinates of the point that you wish\n * to search from. You can either specify a search radius, or use the\n * default (500 meters).  You could use this method to search for places\n * around a user's GPS position, or a location clicked on a map.\n *\n * The returned places contain basic data such as name, category and\n * location. You can use the {@linkcode getPlace} method to get additional\n * details for a given place.\n *\n * You can refine the results by supplying additional search parameters,\n * including:\n *\n * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.\n * - A partial name filter with `name` option\n *\n * As this request can return many results, pagination is supported.\n * Regardless of paging, the maximum number of places that can be returned\n * by a single query is `200`. When a query results in more than `200`\n * places, the response will contain the property\n * `\"maxResultsExceeded\":true` in addition to place results. If `maxResultsExceeded`\n * is true an additional method `response.nextPage()` can be used to get the next page of results.\n *\n * ```js\n * import { findPlacesNearPoint } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = await findPlacesNearPoint({\n *   x: -3.1883,\n *   y: 55.9533,\n *   radius: 100,\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(response);\n * ```\n */\nexport function findPlacesNearPoint(\n  requestOptions: IFindPlacesNearPointOptions\n): Promise<IFindPlacesNearPointResponse> {\n  const options = appendCustomParams<IFindPlacesNearPointOptions>(\n    requestOptions,\n    [\"x\", \"y\", \"radius\", \"categoryIds\", \"pageSize\", \"offset\", \"searchText\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(`${baseUrl}/places/near-point`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindPlacesNearPointResponse = {\n      ...response\n    };\n\n    if (hasNextPage(response)) {\n      r.nextPage = () => {\n        const nextOptions = {\n          ...requestOptions,\n          ...getNextPageParams(requestOptions.offset, requestOptions.pageSize)\n        };\n        return findPlacesNearPoint(nextOptions);\n      };\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, hasNextPage, getNextPageParams } 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[\"withinExtentGet\"][\"parameters\"][\"query\"],\n  | \"xmin\"\n  | \"ymin\"\n  | \"xmax\"\n  | \"ymax\"\n  | \"categoryIds\"\n  | \"pageSize\"\n  | \"offset\"\n  | \"searchText\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"withinExtentGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findPlacesWithinExtent};\n */\nexport interface IFindPlacesWithinExtentResponse extends successResponse {\n  nextPage?: () => Promise<IFindPlacesWithinExtentResponse>;\n}\n\n/**\n * Options for {@linkcode findPlacesNearPoint}.\n */\nexport interface IFindPlaceWithinExtentOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * Searches the world-wide set of places for those that are within an\n * extent, or bounding box. You must supply the `xmin`, `ymin`, `xmax` and\n * `ymax` coordinates of the extent. You could use this endpoint to search\n * for places in the visible extent of a user's screen.\n *\n * The returned places contain basic data such as name, category and\n * location. You can use the {@linkcode getPlace} method to get additional\n * details for a given place.\n *\n * You can also refine the results by supplying additional search parameters,\n * including:\n *\n * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.\n * - A partial name filter with `name` option\n *\n * As this request can return many results, pagination is supported.\n * Regardless of paging, the maximum number of places that can be returned\n * by a single query is `200`. When a query results in more than `200`\n * places, the response will contain the property\n * `\"maxResultsExceeded\":true` in addition to place results. If `maxResultsExceeded`\n * is true an additional method `response.nextPage()` can be used to get the next page of results.\n *\n * ```\n * import { findPlacesWithinExtent } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findPlacesWithinExtent({\n *   xmin: -118.013334,\n *   ymin: 33.78193,\n *   xmax: -117.795753,\n *   ymax: 33.873337,\n *   categoryIds: [\"13002\"],\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findPlacesWithinExtent(\n  requestOptions: IFindPlaceWithinExtentOptions\n): Promise<IFindPlacesWithinExtentResponse> {\n  const options = appendCustomParams<IFindPlaceWithinExtentOptions>(\n    requestOptions,\n    [\n      \"xmin\",\n      \"ymin\",\n      \"xmax\",\n      \"ymax\",\n      \"categoryIds\",\n      \"pageSize\",\n      \"offset\",\n      \"searchText\"\n    ],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(`${baseUrl}/places/within-extent`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindPlacesWithinExtentResponse = {\n      ...response\n    };\n\n    if (hasNextPage(response)) {\n      r.nextPage = () => {\n        const nextOptions = {\n          ...requestOptions,\n          ...getNextPageParams(requestOptions.offset, requestOptions.pageSize)\n        };\n        return findPlacesWithinExtent(nextOptions);\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[\"placeIdGet\"][\"parameters\"][\"query\"],\n  \"requestedFields\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"placeIdGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getPlace};\n */\nexport interface IGetPlaceResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getPlace}.\n */\nexport interface IGetPlaceOptions\n  extends Omit<IRequestOptions, \"httpMethod\">,\n    queryParams {\n  placeId: string;\n}\n\n/**\n * Returns a single place, including additional details, such as:\n *\n * - contact details\n * - address\n * - price information\n * - user rating\n * - opening hours\n *\n * This endpoint can be used to fetch additional details for a specific\n * place, returned from a places search request.\n *\n * Note that some fields, such as opening hours, are not available for\n * every place. Where a field is not available it will be omitted from the\n * response and you will not be charged for this data.\n *\n *  ```js\n * import { getPlaceDetails } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const place = getPlaceDetails({\n *   placeId: \"e78051acc722c55ab11ba930d8dd7772\",\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(place);\n * ```\n */\nexport function getPlaceDetails(\n  requestOptions: IGetPlaceOptions\n): Promise<IGetPlaceResponse> {\n  const { placeId } = requestOptions;\n\n  const options = appendCustomParams<IGetPlaceOptions>(\n    requestOptions,\n    [\"requestedFields\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return request(`${baseUrl}/places/${placeId}`, {\n    ...options,\n    httpMethod: \"GET\"\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[\"categoriesGet\"][\"parameters\"][\"query\"],\n  \"filter\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"categoriesGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getCategories};\n */\nexport interface IGetCategoriesResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getCategories}.\n */\nexport interface IGetCategoriesOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * The ArcGIS Places service has many categories (or types) of place, from\n * art museums to zoos. This endpoint returns all the categories including\n * their label and `categoryId`. The category Id can be used to search for\n * types of places with a `places/near-point` or `places/within-extent`\n * request.\n *\n * Categories also have information on their `parent`. This allows you to\n * search for specific categories such as \"French Restaurant\" - or to\n * look for more generic types such as \"Restaurant\".\n *\n * ```js\n * import { getCategories } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = await getCategories({\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(response.categories);\n * ```\n */\nexport function getCategories(\n  requestOptions: IGetCategoriesOptions\n): Promise<IGetCategoriesResponse> {\n  const options = appendCustomParams<IGetCategoriesOptions>(\n    requestOptions,\n    [\"filter\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return request(`${baseUrl}/categories`, {\n    ...options,\n    httpMethod: \"GET\"\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 = operations[\"categoriesCategoryIdGet\"][\"parameters\"][\"query\"];\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"categoriesCategoryIdGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getCategory};\n */\nexport interface IGetCategoryResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getCategory}.\n */\nexport interface IGetCategoryOptions\n  extends Omit<IRequestOptions, \"httpMethod\">,\n    queryParams {\n  categoryId: string;\n}\n\n/**\n * Returns details about a single category by Id.\n *\n * ```js\n * import { getCategories } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = getCategory({\n *   categoryId: \"10000\",\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(response);\n * ```\n **/\nexport function getCategory(\n  requestOptions: IGetCategoryOptions\n): Promise<IGetCategoryResponse> {\n  const { categoryId } = requestOptions;\n\n  const options = appendCustomParams<IGetCategoryOptions>(requestOptions, [], {\n    ...requestOptions\n  });\n\n  return request(`${baseUrl}/categories/${categoryId}`, {\n    ...options,\n    httpMethod: \"GET\"\n  });\n}\n"],"names":["appendCustomParams","request"],"mappings":";;;;;;;;;;;EAAO,MAAM,OAAO,GAClB,sEAAsE,CAAC;WAEzD,WAAW,CAAC,QAAa;;MACvC,OAAO,CAAC,EAAC,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK,0CAAE,IAAI,CAAA,IAAI,CAAC,EAAC,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,0CAAE,OAAO,CAAA,CAAC;EACpE,CAAC;WAEe,iBAAiB,CAAC,aAAa,GAAG,CAAC,EAAE,eAAe,GAAG,EAAE;MACvE,OAAO;UACL,MAAM,EAAE,aAAa,GAAG,eAAe;UACvC,QAAQ,EAAE,eAAe;OAC1B,CAAC;EACJ;;ECsBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAsCgB,mBAAmB,CACjC,cAA2C;MAE3C,MAAM,OAAO,GAAGA,oCAAkB,CAChC,cAAc,EACd,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,CAAC,oBAElE,cAAc,EAEpB,CAAC;MAEF,OACEC,yBAAO,CAAC,GAAG,OAAO,oBAAoB,kCACjC,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC,IAAI,CAAC,CAAC,QAAQ;UACd,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;UAEF,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE;cACzB,CAAC,CAAC,QAAQ,GAAG;kBACX,MAAM,WAAW,mCACZ,cAAc,GACd,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CACrE,CAAC;kBACF,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC;eACzC,CAAC;WACH;UAED,OAAO,CAAC,CAAC;OACV,CAAC,CAAC;EACL;;EChEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAuCgB,sBAAsB,CACpC,cAA6C;MAE7C,MAAM,OAAO,GAAGD,oCAAkB,CAChC,cAAc,EACd;UACE,MAAM;UACN,MAAM;UACN,MAAM;UACN,MAAM;UACN,aAAa;UACb,UAAU;UACV,QAAQ;UACR,YAAY;OACb,oBAEI,cAAc,EAEpB,CAAC;MAEF,OACEC,yBAAO,CAAC,GAAG,OAAO,uBAAuB,kCACpC,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC,IAAI,CAAC,CAAC,QAAQ;UACd,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;UAEF,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE;cACzB,CAAC,CAAC,QAAQ,GAAG;kBACX,MAAM,WAAW,mCACZ,cAAc,GACd,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CACrE,CAAC;kBACF,OAAO,sBAAsB,CAAC,WAAW,CAAC,CAAC;eAC5C,CAAC;WACH;UACD,OAAO,CAAC,CAAC;OACV,CAAC,CAAC;EACL;;ECvFA;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4BgB,eAAe,CAC7B,cAAgC;MAEhC,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC;MAEnC,MAAM,OAAO,GAAGD,oCAAkB,CAChC,cAAc,EACd,CAAC,iBAAiB,CAAC,oBAEd,cAAc,EAEpB,CAAC;MAEF,OAAOC,yBAAO,CAAC,GAAG,OAAO,WAAW,OAAO,EAAE,kCACxC,OAAO,KACV,UAAU,EAAE,KAAK,IACjB,CAAC;EACL;;EC/CA;;;;;;;;;;;;;;;;;;;;;;WAsBgB,aAAa,CAC3B,cAAqC;MAErC,MAAM,OAAO,GAAGD,oCAAkB,CAChC,cAAc,EACd,CAAC,QAAQ,CAAC,oBAEL,cAAc,EAEpB,CAAC;MAEF,OAAOC,yBAAO,CAAC,GAAG,OAAO,aAAa,kCACjC,OAAO,KACV,UAAU,EAAE,KAAK,IACjB,CAAC;EACL;;ECtCA;;;;;;;;;;;;;;;WAegB,WAAW,CACzB,cAAmC;MAEnC,MAAM,EAAE,UAAU,EAAE,GAAG,cAAc,CAAC;MAEtC,MAAM,OAAO,GAAGD,oCAAkB,CAAsB,cAAc,EAAE,EAAE,oBACrE,cAAc,EACjB,CAAC;MAEH,OAAOC,yBAAO,CAAC,GAAG,OAAO,eAAe,UAAU,EAAE,kCAC/C,OAAO,KACV,UAAU,EAAE,KAAK,IACjB,CAAC;EACL;;;;;;;;;;;;;;"}
+{"version":3,"file":"places.umd.js","sources":["../../src/utils.ts","../../src/findPlacesNearPoint.ts","../../src/findPlacesWithinExtent.ts","../../src/getPlaceDetails.ts","../../src/getCategories.ts","../../src/getCategory.ts"],"sourcesContent":["export const baseUrl =\n  \"https://places-api.arcgis.com/arcgis/rest/services/places-service/v1\";\n\nexport function hasNextPage(response: any) {\n  return !!response?.links?.next || !!response?.pagination?.nextUrl;\n}\n\nexport function getNextPageParams(currentOffset = 0, currentPageSize = 10) {\n  return {\n    offset: currentOffset + currentPageSize,\n    pageSize: currentPageSize\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, hasNextPage, getNextPageParams } 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[\"nearPointGet\"][\"parameters\"][\"query\"],\n  \"x\" | \"y\" | \"radius\" | \"categoryIds\" | \"pageSize\" | \"offset\" | \"searchText\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"nearPointGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findPlacesNearPoint};\n */\nexport interface IFindPlacesNearPointResponse extends successResponse {\n  nextPage?: () => Promise<IFindPlacesNearPointResponse>;\n}\n\n/**\n * Options for {@linkcode findPlacesNearPoint}.\n */\nexport interface IFindPlacesNearPointOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * Searches places that are within a given radius of a geographic point.\n * You must supply the `x` and `y` coordinates of the point that you wish\n * to search from. You can either specify a search radius, or use the\n * default (500 meters).  You could use this method to search for places\n * around a user's GPS position, or a location clicked on a map.\n *\n * The returned places contain basic data such as name, category and\n * location. You can use the {@linkcode getPlace} method to get additional\n * details for a given place.\n *\n * You can refine the results by supplying additional search parameters,\n * including:\n *\n * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.\n * - A partial name filter with `name` option\n *\n * As this request can return many results, pagination is supported.\n * When a query results in more than [pageSize] places, the response will contain the property\n * `pagination` in addition to place results. If `pagination` exists, an additional method\n * `response.nextPage()` can be used to get the next page of results.\n *\n * ```js\n * import { findPlacesNearPoint } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = await findPlacesNearPoint({\n *   x: -3.1883,\n *   y: 55.9533,\n *   radius: 100,\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\");\n * });\n *\n * console.log(response);\n * ```\n */\nexport function findPlacesNearPoint(\n  requestOptions: IFindPlacesNearPointOptions\n): Promise<IFindPlacesNearPointResponse> {\n  const options = appendCustomParams<IFindPlacesNearPointOptions>(\n    requestOptions,\n    [\"x\", \"y\", \"radius\", \"categoryIds\", \"pageSize\", \"offset\", \"searchText\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(requestOptions.endpoint || `${baseUrl}/places/near-point`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindPlacesNearPointResponse = {\n      ...response\n    };\n\n    if (hasNextPage(response)) {\n      r.nextPage = () => {\n        const nextOptions = {\n          ...requestOptions,\n          ...getNextPageParams(requestOptions.offset, requestOptions.pageSize)\n        };\n        return findPlacesNearPoint(nextOptions);\n      };\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, hasNextPage, getNextPageParams } 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[\"withinExtentGet\"][\"parameters\"][\"query\"],\n  | \"xmin\"\n  | \"ymin\"\n  | \"xmax\"\n  | \"ymax\"\n  | \"categoryIds\"\n  | \"pageSize\"\n  | \"offset\"\n  | \"searchText\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"withinExtentGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findPlacesWithinExtent};\n */\nexport interface IFindPlacesWithinExtentResponse extends successResponse {\n  nextPage?: () => Promise<IFindPlacesWithinExtentResponse>;\n}\n\n/**\n * Options for {@linkcode findPlacesNearPoint}.\n */\nexport interface IFindPlaceWithinExtentOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * Searches the world-wide set of places for those that are within an\n * extent, or bounding box. You must supply the `xmin`, `ymin`, `xmax` and\n * `ymax` coordinates of the extent. You could use this endpoint to search\n * for places in the visible extent of a user's screen.\n *\n * The returned places contain basic data such as name, category and\n * location. You can use the {@linkcode getPlace} method to get additional\n * details for a given place.\n *\n * You can also refine the results by supplying additional search parameters,\n * including:\n *\n * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.\n * - A partial name filter with `name` option\n *\n * As this request can return many results, pagination is supported.\n * When a query results in more than [pageSize] places, the response will contain the property\n * `pagination` in addition to place results. If `pagination` exists, an additional method\n * `response.nextPage()` can be used to get the next page of results.\n *\n * ```\n * import { findPlacesWithinExtent } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findPlacesWithinExtent({\n *   xmin: -118.013334,\n *   ymin: 33.78193,\n *   xmax: -117.795753,\n *   ymax: 33.873337,\n *   categoryIds: [\"13002\"],\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findPlacesWithinExtent(\n  requestOptions: IFindPlaceWithinExtentOptions\n): Promise<IFindPlacesWithinExtentResponse> {\n  const options = appendCustomParams<IFindPlaceWithinExtentOptions>(\n    requestOptions,\n    [\n      \"xmin\",\n      \"ymin\",\n      \"xmax\",\n      \"ymax\",\n      \"categoryIds\",\n      \"pageSize\",\n      \"offset\",\n      \"searchText\"\n    ],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(requestOptions.endpoint || `${baseUrl}/places/within-extent`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindPlacesWithinExtentResponse = {\n      ...response\n    };\n\n    if (hasNextPage(response)) {\n      r.nextPage = () => {\n        const nextOptions = {\n          ...requestOptions,\n          ...getNextPageParams(requestOptions.offset, requestOptions.pageSize)\n        };\n        return findPlacesWithinExtent(nextOptions);\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[\"placeIdGet\"][\"parameters\"][\"query\"],\n  \"requestedFields\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"placeIdGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getPlace};\n */\nexport interface IGetPlaceResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getPlace}.\n */\nexport interface IGetPlaceOptions\n  extends Omit<IRequestOptions, \"httpMethod\">,\n    queryParams {\n  placeId: string;\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * Returns a single place, including additional details, such as:\n *\n * - contact details\n * - address\n * - price information\n * - user rating\n * - opening hours\n *\n * This endpoint can be used to fetch additional details for a specific\n * place, returned from a places search request.\n *\n * Note that some fields, such as opening hours, are not available for\n * every place. Where a field is not available it will be omitted from the\n * response and you will not be charged for this data.\n *\n *  ```js\n * import { getPlaceDetails } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const place = getPlaceDetails({\n *   placeId: \"e78051acc722c55ab11ba930d8dd7772\",\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(place);\n * ```\n */\nexport function getPlaceDetails(\n  requestOptions: IGetPlaceOptions\n): Promise<IGetPlaceResponse> {\n  const { placeId } = requestOptions;\n\n  const options = appendCustomParams<IGetPlaceOptions>(\n    requestOptions,\n    [\"requestedFields\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return request(requestOptions.endpoint || `${baseUrl}/places/${placeId}`, {\n    ...options,\n    httpMethod: \"GET\"\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[\"categoriesGet\"][\"parameters\"][\"query\"],\n  \"filter\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"categoriesGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getCategories};\n */\nexport interface IGetCategoriesResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getCategories}.\n */\nexport interface IGetCategoriesOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * The ArcGIS Places service has many categories (or types) of place, from\n * art museums to zoos. This endpoint returns all the categories including\n * their label and `categoryId`. The category Id can be used to search for\n * types of places with a `places/near-point` or `places/within-extent`\n * request.\n *\n * Categories also have information on their `parent`. This allows you to\n * search for specific categories such as \"French Restaurant\" - or to\n * look for more generic types such as \"Restaurant\".\n *\n * ```js\n * import { getCategories } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = await getCategories({\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(response.categories);\n * ```\n */\nexport function getCategories(\n  requestOptions: IGetCategoriesOptions\n): Promise<IGetCategoriesResponse> {\n  const options = appendCustomParams<IGetCategoriesOptions>(\n    requestOptions,\n    [\"filter\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return request(requestOptions.endpoint || `${baseUrl}/categories`, {\n    ...options,\n    httpMethod: \"GET\"\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 = operations[\"categoriesCategoryIdGet\"][\"parameters\"][\"query\"];\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"categoriesCategoryIdGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode getCategory};\n */\nexport interface IGetCategoryResponse extends successResponse {}\n\n/**\n * Options for {@linkcode getCategory}.\n */\nexport interface IGetCategoryOptions\n  extends Omit<IRequestOptions, \"httpMethod\">,\n    queryParams {\n  categoryId: string;\n  /**\n   * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing.\n   * @private\n   */\n  endpoint?: string;\n}\n\n/**\n * Returns details about a single category by Id.\n *\n * ```js\n * import { getCategories } from \"@esri/arcgis-rest-places\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const response = getCategory({\n *   categoryId: \"10000\",\n *   authentication: ApiKeyManager.fromKey(\"YOUR_API_KEY\")\n * });\n *\n * console.log(response);\n * ```\n **/\nexport function getCategory(\n  requestOptions: IGetCategoryOptions\n): Promise<IGetCategoryResponse> {\n  const { categoryId } = requestOptions;\n\n  const options = appendCustomParams<IGetCategoryOptions>(requestOptions, [], {\n    ...requestOptions\n  });\n\n  return request(\n    requestOptions.endpoint || `${baseUrl}/categories/${categoryId}`,\n    {\n      ...options,\n      httpMethod: \"GET\"\n    }\n  );\n}\n"],"names":["appendCustomParams","request"],"mappings":";;;;;;;;;;;EAAO,MAAM,OAAO,GAClB,sEAAsE,CAAC;WAEzD,WAAW,CAAC,QAAa;;MACvC,OAAO,CAAC,EAAC,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK,0CAAE,IAAI,CAAA,IAAI,CAAC,EAAC,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,0CAAE,OAAO,CAAA,CAAC;EACpE,CAAC;WAEe,iBAAiB,CAAC,aAAa,GAAG,CAAC,EAAE,eAAe,GAAG,EAAE;MACvE,OAAO;UACL,MAAM,EAAE,aAAa,GAAG,eAAe;UACvC,QAAQ,EAAE,eAAe;OAC1B,CAAC;EACJ;;EC4BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAoCgB,mBAAmB,CACjC,cAA2C;MAE3C,MAAM,OAAO,GAAGA,oCAAkB,CAChC,cAAc,EACd,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,CAAC,oBAElE,cAAc,EAEpB,CAAC;MAEF,OACEC,yBAAO,CAAC,cAAc,CAAC,QAAQ,IAAI,GAAG,OAAO,oBAAoB,kCAC5D,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC,IAAI,CAAC,CAAC,QAAQ;UACd,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;UAEF,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE;cACzB,CAAC,CAAC,QAAQ,GAAG;kBACX,MAAM,WAAW,mCACZ,cAAc,GACd,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CACrE,CAAC;kBACF,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC;eACzC,CAAC;WACH;UAED,OAAO,CAAC,CAAC;OACV,CAAC,CAAC;EACL;;EC9DA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAqCgB,sBAAsB,CACpC,cAA6C;MAE7C,MAAM,OAAO,GAAGD,oCAAkB,CAChC,cAAc,EACd;UACE,MAAM;UACN,MAAM;UACN,MAAM;UACN,MAAM;UACN,aAAa;UACb,UAAU;UACV,QAAQ;UACR,YAAY;OACb,oBAEI,cAAc,EAEpB,CAAC;MAEF,OACEC,yBAAO,CAAC,cAAc,CAAC,QAAQ,IAAI,GAAG,OAAO,uBAAuB,kCAC/D,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC,IAAI,CAAC,CAAC,QAAQ;UACd,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;UAEF,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE;cACzB,CAAC,CAAC,QAAQ,GAAG;kBACX,MAAM,WAAW,mCACZ,cAAc,GACd,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CACrE,CAAC;kBACF,OAAO,sBAAsB,CAAC,WAAW,CAAC,CAAC;eAC5C,CAAC;WACH;UACD,OAAO,CAAC,CAAC;OACV,CAAC,CAAC;EACL;;ECtFA;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4BgB,eAAe,CAC7B,cAAgC;MAEhC,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC;MAEnC,MAAM,OAAO,GAAGD,oCAAkB,CAChC,cAAc,EACd,CAAC,iBAAiB,CAAC,oBAEd,cAAc,EAEpB,CAAC;MAEF,OAAOC,yBAAO,CAAC,cAAc,CAAC,QAAQ,IAAI,GAAG,OAAO,WAAW,OAAO,EAAE,kCACnE,OAAO,KACV,UAAU,EAAE,KAAK,IACjB,CAAC;EACL;;EC9CA;;;;;;;;;;;;;;;;;;;;;;WAsBgB,aAAa,CAC3B,cAAqC;MAErC,MAAM,OAAO,GAAGD,oCAAkB,CAChC,cAAc,EACd,CAAC,QAAQ,CAAC,oBAEL,cAAc,EAEpB,CAAC;MAEF,OAAOC,yBAAO,CAAC,cAAc,CAAC,QAAQ,IAAI,GAAG,OAAO,aAAa,kCAC5D,OAAO,KACV,UAAU,EAAE,KAAK,IACjB,CAAC;EACL;;ECvCA;;;;;;;;;;;;;;;WAegB,WAAW,CACzB,cAAmC;MAEnC,MAAM,EAAE,UAAU,EAAE,GAAG,cAAc,CAAC;MAEtC,MAAM,OAAO,GAAGD,oCAAkB,CAAsB,cAAc,EAAE,EAAE,oBACrE,cAAc,EACjB,CAAC;MAEH,OAAOC,yBAAO,CACZ,cAAc,CAAC,QAAQ,IAAI,GAAG,OAAO,eAAe,UAAU,EAAE,kCAE3D,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC;EACJ;;;;;;;;;;;;;;"}

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

@@ -1,7 +1,7 @@
 /* @preserve
-* @esri/arcgis-rest-places - v1.0.0 - Apache-2.0
-* Copyright (c) 2017-2023 Esri, Inc.
-* Tue Jun 27 2023 16:16:59 GMT+0000 (Coordinated Universal Time)
+* @esri/arcgis-rest-places - v1.0.2 - Apache-2.0
+* Copyright (c) 2017-2024 Esri, Inc.
+* Tue Jun 18 2024 23:49:53 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://places-api.arcgis.com/arcgis/rest/services/places-service/v1";function n(e){var t,s;return!!(null===(t=null==e?void 0:e.links)||void 0===t?void 0:t.next)||!!(null===(s=null==e?void 0:e.pagination)||void 0===s?void 0:s.nextUrl)}function i(e=0,t=10){return{offset:e+t,pageSize:t}}e.findPlacesNearPoint=function e(a){const c=t.appendCustomParams(a,["x","y","radius","categoryIds","pageSize","offset","searchText"],Object.assign({},a));return t.request(`${s}/places/near-point`,Object.assign(Object.assign({},c),{httpMethod:"GET"})).then((t=>{const s=Object.assign({},t);return n(t)&&(s.nextPage=()=>e(Object.assign(Object.assign({},a),i(a.offset,a.pageSize)))),s}))},e.findPlacesWithinExtent=function e(a){const c=t.appendCustomParams(a,["xmin","ymin","xmax","ymax","categoryIds","pageSize","offset","searchText"],Object.assign({},a));return t.request(`${s}/places/within-extent`,Object.assign(Object.assign({},c),{httpMethod:"GET"})).then((t=>{const s=Object.assign({},t);return n(t)&&(s.nextPage=()=>e(Object.assign(Object.assign({},a),i(a.offset,a.pageSize)))),s}))},e.getCategories=function(e){const n=t.appendCustomParams(e,["filter"],Object.assign({},e));return t.request(`${s}/categories`,Object.assign(Object.assign({},n),{httpMethod:"GET"}))},e.getCategory=function(e){const{categoryId:n}=e,i=t.appendCustomParams(e,[],Object.assign({},e));return t.request(`${s}/categories/${n}`,Object.assign(Object.assign({},i),{httpMethod:"GET"}))},e.getPlaceDetails=function(e){const{placeId:n}=e,i=t.appendCustomParams(e,["requestedFields"],Object.assign({},e));return t.request(`${s}/places/${n}`,Object.assign(Object.assign({},i),{httpMethod:"GET"}))},Object.defineProperty(e,"__esModule",{value:!0})}));
+!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://places-api.arcgis.com/arcgis/rest/services/places-service/v1";function n(e){var t,s;return!!(null===(t=null==e?void 0:e.links)||void 0===t?void 0:t.next)||!!(null===(s=null==e?void 0:e.pagination)||void 0===s?void 0:s.nextUrl)}function i(e=0,t=10){return{offset:e+t,pageSize:t}}e.findPlacesNearPoint=function e(a){const c=t.appendCustomParams(a,["x","y","radius","categoryIds","pageSize","offset","searchText"],Object.assign({},a));return t.request(a.endpoint||`${s}/places/near-point`,Object.assign(Object.assign({},c),{httpMethod:"GET"})).then((t=>{const s=Object.assign({},t);return n(t)&&(s.nextPage=()=>e(Object.assign(Object.assign({},a),i(a.offset,a.pageSize)))),s}))},e.findPlacesWithinExtent=function e(a){const c=t.appendCustomParams(a,["xmin","ymin","xmax","ymax","categoryIds","pageSize","offset","searchText"],Object.assign({},a));return t.request(a.endpoint||`${s}/places/within-extent`,Object.assign(Object.assign({},c),{httpMethod:"GET"})).then((t=>{const s=Object.assign({},t);return n(t)&&(s.nextPage=()=>e(Object.assign(Object.assign({},a),i(a.offset,a.pageSize)))),s}))},e.getCategories=function(e){const n=t.appendCustomParams(e,["filter"],Object.assign({},e));return t.request(e.endpoint||`${s}/categories`,Object.assign(Object.assign({},n),{httpMethod:"GET"}))},e.getCategory=function(e){const{categoryId:n}=e,i=t.appendCustomParams(e,[],Object.assign({},e));return t.request(e.endpoint||`${s}/categories/${n}`,Object.assign(Object.assign({},i),{httpMethod:"GET"}))},e.getPlaceDetails=function(e){const{placeId:n}=e,i=t.appendCustomParams(e,["requestedFields"],Object.assign({},e));return t.request(e.endpoint||`${s}/places/${n}`,Object.assign(Object.assign({},i),{httpMethod:"GET"}))},Object.defineProperty(e,"__esModule",{value:!0})}));
 //# sourceMappingURL=places.umd.min.js.map