@esri/arcgis-rest-places 1.0.0

package/README.md

@@ -0,0 +1,89 @@
+[![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
+
+# @esri/arcgis-rest-places
+
+> Place finding helpers for [`@esri/arcgis-rest-request`](https://github.com/Esri/arcgis-rest-js).
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+npm install @esri/arcgis-rest-places
+```
+
+```js
+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")
+  });
+
+console.log(places[0].name);
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/places/)
+
+@TODO
+
+### Issues
+
+If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first. Have you found a new bug? Want to request a new feature? We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you.
+
+If you're looking for help you can also post issues on [GIS Stackexchange](http://gis.stackexchange.com/questions/ask?tags=esri-oss).
+
+### Versioning
+
+For transparency into the release cycle and in striving to maintain backward compatibility, @esri/arcgis-rest-js is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible.
+
+For more information on SemVer, please visit <http://semver.org/>.
+
+### Contributing
+
+Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](CONTRIBUTING.md).
+
+### Generating Types from Open API
+
+The places service publishes an Open API definition. Eventually this will live at a public URL on the service itself. However for now it lives inside the Esri internal GitHub Enterprise installation. To generate the types view the raw file on GitHub Enterprise and replace the URL below.
+
+```
+npx openapi-typescript@5 URL_TO_RAW_SPEC_FILE --output packages/arcgis-rest-places/src/openapi-types.ts
+```
+
+The generated types are used in the interfaces for ArcGIS REST JS.
+
+### [Changelog](https://github.com/Esri/arcgis-rest-js/blob/master/CHANGELOG.md)
+
+### License
+
+Copyright &copy; 2023 Esri
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+> http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+A copy of the license is available in the repository's [LICENSE](../../LICENSE) file.

package/dist/bundled/places.esm.js

@@ -0,0 +1,217 @@
+/* @preserve
+* @esri/arcgis-rest-places - v4.0.0 - Apache-2.0
+* Copyright (c) 2017-2023 Esri, Inc.
+* Thu May 04 2023 19:07:08 GMT+0000 (Coordinated Universal Time)
+*/
+import { appendCustomParams, request } from '@esri/arcgis-rest-request';
+
+const baseUrl = "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1";
+function hasNextPage(response) {
+    var _a;
+    return !!((_a = response === null || response === void 0 ? void 0 : response.links) === null || _a === void 0 ? void 0 : _a.next);
+}
+function getNextPageParams(currentOffset = 0, currentPageSize = 10) {
+    return {
+        offset: currentOffset + currentPageSize,
+        pageSize: currentPageSize
+    };
+}
+
+/**
+ * Searches places that are within a given radius of a geographic point.
+ * You must supply the `x` and `y` coordinates of the point that you wish
+ * to search from. You can either specify a search radius, or use the
+ * default (500 meters).  You could use this method to search for places
+ * around a user's GPS position, or a location clicked on a map.
+ *
+ * The returned places contain basic data such as name, category and
+ * location. You can use the {@linkcode getPlace} method to get additional
+ * details for a given place.
+ *
+ * You can refine the results by supplying additional search parameters,
+ * including:
+ *
+ * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.
+ * - 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.
+ *
+ * ```js
+ * import { findPlacesNearPoint } from "@esri/arcgis-rest-places";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const response = await findPlacesNearPoint({
+ *   x: -3.1883,
+ *   y: 55.9533,
+ *   radius: 100,
+ *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+ * });
+ *
+ * console.log(response);
+ * ```
+ */
+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) => {
+        const r = Object.assign({}, response);
+        if (hasNextPage(response)) {
+            r.nextPage = () => {
+                const nextOptions = Object.assign(Object.assign({}, requestOptions), getNextPageParams(requestOptions.offset, requestOptions.pageSize));
+                return findPlacesNearPoint(nextOptions);
+            };
+        }
+        return r;
+    });
+}
+
+/**
+ * Searches the world-wide set of places for those that are within an
+ * extent, or bounding box. You must supply the `xmin`, `ymin`, `xmax` and
+ * `ymax` coordinates of the extent. You could use this endpoint to search
+ * for places in the visible extent of a user's screen.
+ *
+ * The returned places contain basic data such as name, category and
+ * location. You can use the {@linkcode getPlace} method to get additional
+ * details for a given place.
+ *
+ * You can also refine the results by supplying additional search parameters,
+ * including:
+ *
+ * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.
+ * - 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.
+ *
+ * ```
+ * import { findPlacesWithinExtent } from "@esri/arcgis-rest-places";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const results = await findPlacesWithinExtent({
+ *   xmin: -118.013334,
+ *   ymin: 33.78193,
+ *   xmax: -117.795753,
+ *   ymax: 33.873337,
+ *   categoryIds: ["13002"],
+ *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+ * });
+ *
+ * console.log(results)
+ * ```
+ */
+function findPlacesWithinExtent(requestOptions) {
+    const options = appendCustomParams(requestOptions, [
+        "xmin",
+        "ymin",
+        "xmax",
+        "ymax",
+        "categoryIds",
+        "pageSize",
+        "offset",
+        "searchText"
+    ], Object.assign({}, requestOptions));
+    return request(`${baseUrl}/places/within-extent`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
+        const r = Object.assign({}, response);
+        if (hasNextPage(response)) {
+            r.nextPage = () => {
+                const nextOptions = Object.assign(Object.assign({}, requestOptions), getNextPageParams(requestOptions.offset, requestOptions.pageSize));
+                return findPlacesWithinExtent(nextOptions);
+            };
+        }
+        return r;
+    });
+}
+
+/**
+ * Returns a single place, including additional details, such as:
+ *
+ * - contact details
+ * - address
+ * - price information
+ * - user rating
+ * - opening hours
+ *
+ * This endpoint can be used to fetch additional details for a specific
+ * place, returned from a places search request.
+ *
+ * Note that some fields, such as opening hours, are not available for
+ * every place. Where a field is not available it will be omitted from the
+ * response and you will not be charged for this data.
+ *
+ *  ```js
+ * import { getPlaceDetails } from "@esri/arcgis-rest-places";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const place = getPlaceDetails({
+ *   placeId: "e78051acc722c55ab11ba930d8dd7772",
+ *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+ * });
+ *
+ * console.log(place);
+ * ```
+ */
+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" }));
+}
+
+/**
+ * The ArcGIS Places service has many categories (or types) of place, from
+ * art museums to zoos. This endpoint returns all the categories including
+ * their label and `categoryId`. The category Id can be used to search for
+ * types of places with a `places/near-point` or `places/within-extent`
+ * request.
+ *
+ * Categories also have information on their `parent`. This allows you to
+ * search for specific categories such as "French Restaurant" - or to
+ * look for more generic types such as "Restaurant".
+ *
+ * ```js
+ * import { getCategories } from "@esri/arcgis-rest-places";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const response = await getCategories({
+ *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY")
+ * });
+ *
+ * console.log(response.categories);
+ * ```
+ */
+function getCategories(requestOptions) {
+    const options = appendCustomParams(requestOptions, ["filter"], Object.assign({}, requestOptions));
+    return request(`${baseUrl}/categories`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
+}
+
+/**
+ * Returns details about a single category by Id.
+ *
+ * ```js
+ * import { getCategories } from "@esri/arcgis-rest-places";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const response = getCategory({
+ *   categoryId: "10000",
+ *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+ * });
+ *
+ * console.log(response);
+ * ```
+ **/
+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" }));
+}
+
+export { findPlacesNearPoint, findPlacesWithinExtent, getCategories, getCategory, getPlaceDetails };
+//# sourceMappingURL=places.esm.js.map

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

@@ -0,0 +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;\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,CAAC;AACjC,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;;;;"}

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

@@ -0,0 +1,7 @@
+/* @preserve
+* @esri/arcgis-rest-places - v4.0.0 - Apache-2.0
+* Copyright (c) 2017-2023 Esri, Inc.
+* Thu May 04 2023 19:07:08 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;return!!(null===(t=null==e?void 0:e.links)||void 0===t?void 0:t.next)}function c(e=0,t=10){return{offset:e+t,pageSize:t}}function i(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=()=>i(Object.assign(Object.assign({},a),c(a.offset,a.pageSize)))),t}))}function a(i){const r=e(i,["xmin","ymin","xmax","ymax","categoryIds","pageSize","offset","searchText"],Object.assign({},i));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({},i),c(i.offset,i.pageSize)))),t}))}function r(n){const{placeId:c}=n,i=e(n,["requestedFields"],Object.assign({},n));return t(`${s}/places/${c}`,Object.assign(Object.assign({},i),{httpMethod:"GET"}))}function o(n){const c=e(n,["filter"],Object.assign({},n));return t(`${s}/categories`,Object.assign(Object.assign({},c),{httpMethod:"GET"}))}function g(n){const{categoryId:c}=n,i=e(n,[],Object.assign({},n));return t(`${s}/categories/${c}`,Object.assign(Object.assign({},i),{httpMethod:"GET"}))}export{i as findPlacesNearPoint,a as findPlacesWithinExtent,o as getCategories,g as getCategory,r as getPlaceDetails};
+//# sourceMappingURL=places.esm.min.js.map

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

@@ -0,0 +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;\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","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,SAC1B,mBAASA,eAAAA,EAAUC,4BAAOC,KAC5B,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,GAAGd,qDACNY,IACHG,WAAY,SAEdC,MAAMd,IACN,MAAMe,mBACDf,GAaL,OAVID,EAAYC,KACde,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,GAAGd,wDACNY,IACHG,WAAY,SAEdC,MAAMd,IACN,MAAMe,mBACDf,GAYL,OATID,EAAYC,KACde,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,GAAGd,YAAkBqB,mCAC/BT,IACHG,WAAY,QAEhB,UCzBgBO,EACdX,GAEA,MAAMC,EAAUC,EACdF,EACA,CAAC,2BAEIA,IAIP,OAAOG,EAAQ,GAAGd,8CACbY,IACHG,WAAY,QAEhB,UCvBgBQ,EACdZ,GAEA,MAAMa,WAAEA,GAAeb,EAEjBC,EAAUC,EAAwCF,EAAgB,oBACnEA,IAGL,OAAOG,EAAQ,GAAGd,gBAAsBwB,mCACnCZ,IACHG,WAAY,QAEhB"}

package/dist/bundled/places.umd.js

@@ -0,0 +1,229 @@
+/* @preserve
+* @esri/arcgis-rest-places - v4.0.0 - Apache-2.0
+* Copyright (c) 2017-2023 Esri, Inc.
+* Thu May 04 2023 19:07:08 GMT+0000 (Coordinated Universal Time)
+*/
+(function (global, factory) {
+  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@esri/arcgis-rest-request')) :
+  typeof define === 'function' && define.amd ? define(['exports', '@esri/arcgis-rest-request'], factory) :
+  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.arcgisRest = global.arcgisRest || {}, global.arcgisRest));
+})(this, (function (exports, arcgisRestRequest) { 'use strict';
+
+  const baseUrl = "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1";
+  function hasNextPage(response) {
+      var _a;
+      return !!((_a = response === null || response === void 0 ? void 0 : response.links) === null || _a === void 0 ? void 0 : _a.next);
+  }
+  function getNextPageParams(currentOffset = 0, currentPageSize = 10) {
+      return {
+          offset: currentOffset + currentPageSize,
+          pageSize: currentPageSize
+      };
+  }
+
+  /**
+   * Searches places that are within a given radius of a geographic point.
+   * You must supply the `x` and `y` coordinates of the point that you wish
+   * to search from. You can either specify a search radius, or use the
+   * default (500 meters).  You could use this method to search for places
+   * around a user's GPS position, or a location clicked on a map.
+   *
+   * The returned places contain basic data such as name, category and
+   * location. You can use the {@linkcode getPlace} method to get additional
+   * details for a given place.
+   *
+   * You can refine the results by supplying additional search parameters,
+   * including:
+   *
+   * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.
+   * - 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.
+   *
+   * ```js
+   * import { findPlacesNearPoint } from "@esri/arcgis-rest-places";
+   * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+   *
+   * const response = await findPlacesNearPoint({
+   *   x: -3.1883,
+   *   y: 55.9533,
+   *   radius: 100,
+   *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+   * });
+   *
+   * console.log(response);
+   * ```
+   */
+  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) => {
+          const r = Object.assign({}, response);
+          if (hasNextPage(response)) {
+              r.nextPage = () => {
+                  const nextOptions = Object.assign(Object.assign({}, requestOptions), getNextPageParams(requestOptions.offset, requestOptions.pageSize));
+                  return findPlacesNearPoint(nextOptions);
+              };
+          }
+          return r;
+      });
+  }
+
+  /**
+   * Searches the world-wide set of places for those that are within an
+   * extent, or bounding box. You must supply the `xmin`, `ymin`, `xmax` and
+   * `ymax` coordinates of the extent. You could use this endpoint to search
+   * for places in the visible extent of a user's screen.
+   *
+   * The returned places contain basic data such as name, category and
+   * location. You can use the {@linkcode getPlace} method to get additional
+   * details for a given place.
+   *
+   * You can also refine the results by supplying additional search parameters,
+   * including:
+   *
+   * - A list of category Ids, see {@linkcode searchCategories} or {@linkcode getCategories}.
+   * - 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.
+   *
+   * ```
+   * import { findPlacesWithinExtent } from "@esri/arcgis-rest-places";
+   * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+   *
+   * const results = await findPlacesWithinExtent({
+   *   xmin: -118.013334,
+   *   ymin: 33.78193,
+   *   xmax: -117.795753,
+   *   ymax: 33.873337,
+   *   categoryIds: ["13002"],
+   *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+   * });
+   *
+   * console.log(results)
+   * ```
+   */
+  function findPlacesWithinExtent(requestOptions) {
+      const options = arcgisRestRequest.appendCustomParams(requestOptions, [
+          "xmin",
+          "ymin",
+          "xmax",
+          "ymax",
+          "categoryIds",
+          "pageSize",
+          "offset",
+          "searchText"
+      ], Object.assign({}, requestOptions));
+      return arcgisRestRequest.request(`${baseUrl}/places/within-extent`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
+          const r = Object.assign({}, response);
+          if (hasNextPage(response)) {
+              r.nextPage = () => {
+                  const nextOptions = Object.assign(Object.assign({}, requestOptions), getNextPageParams(requestOptions.offset, requestOptions.pageSize));
+                  return findPlacesWithinExtent(nextOptions);
+              };
+          }
+          return r;
+      });
+  }
+
+  /**
+   * Returns a single place, including additional details, such as:
+   *
+   * - contact details
+   * - address
+   * - price information
+   * - user rating
+   * - opening hours
+   *
+   * This endpoint can be used to fetch additional details for a specific
+   * place, returned from a places search request.
+   *
+   * Note that some fields, such as opening hours, are not available for
+   * every place. Where a field is not available it will be omitted from the
+   * response and you will not be charged for this data.
+   *
+   *  ```js
+   * import { getPlaceDetails } from "@esri/arcgis-rest-places";
+   * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+   *
+   * const place = getPlaceDetails({
+   *   placeId: "e78051acc722c55ab11ba930d8dd7772",
+   *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+   * });
+   *
+   * console.log(place);
+   * ```
+   */
+  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" }));
+  }
+
+  /**
+   * The ArcGIS Places service has many categories (or types) of place, from
+   * art museums to zoos. This endpoint returns all the categories including
+   * their label and `categoryId`. The category Id can be used to search for
+   * types of places with a `places/near-point` or `places/within-extent`
+   * request.
+   *
+   * Categories also have information on their `parent`. This allows you to
+   * search for specific categories such as "French Restaurant" - or to
+   * look for more generic types such as "Restaurant".
+   *
+   * ```js
+   * import { getCategories } from "@esri/arcgis-rest-places";
+   * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+   *
+   * const response = await getCategories({
+   *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY")
+   * });
+   *
+   * console.log(response.categories);
+   * ```
+   */
+  function getCategories(requestOptions) {
+      const options = arcgisRestRequest.appendCustomParams(requestOptions, ["filter"], Object.assign({}, requestOptions));
+      return arcgisRestRequest.request(`${baseUrl}/categories`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
+  }
+
+  /**
+   * Returns details about a single category by Id.
+   *
+   * ```js
+   * import { getCategories } from "@esri/arcgis-rest-places";
+   * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+   *
+   * const response = getCategory({
+   *   categoryId: "10000",
+   *   authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
+   * });
+   *
+   * console.log(response);
+   * ```
+   **/
+  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" }));
+  }
+
+  exports.findPlacesNearPoint = findPlacesNearPoint;
+  exports.findPlacesWithinExtent = findPlacesWithinExtent;
+  exports.getCategories = getCategories;
+  exports.getCategory = getCategory;
+  exports.getPlaceDetails = getPlaceDetails;
+
+  Object.defineProperty(exports, '__esModule', { value: true });
+
+}));
+//# sourceMappingURL=places.umd.js.map