@esri/arcgis-rest-places 1.0.0

package/dist/esm/findPlacesNearPoint.d.ts

@@ -0,0 +1,55 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { operations } from "./openapi-types.js";
+declare type queryParams = Pick<operations["nearPointGet"]["parameters"]["query"], "x" | "y" | "radius" | "categoryIds" | "pageSize" | "offset" | "searchText">;
+declare type successResponse = operations["nearPointGet"]["responses"]["200"]["content"]["application/json"];
+/**
+ * The response format for {@linkcode findPlacesNearPoint};
+ */
+export interface IFindPlacesNearPointResponse extends successResponse {
+    nextPage?: () => Promise<IFindPlacesNearPointResponse>;
+}
+/**
+ * Options for {@linkcode findPlacesNearPoint}.
+ */
+export interface IFindPlacesNearPointOptions extends Omit<IRequestOptions, "httpMethod" | "f">, queryParams {
+}
+/**
+ * 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);
+ * ```
+ */
+export declare function findPlacesNearPoint(requestOptions: IFindPlacesNearPointOptions): Promise<IFindPlacesNearPointResponse>;
+export {};

package/dist/esm/findPlacesNearPoint.js

@@ -0,0 +1,54 @@
+import { request, appendCustomParams } from "@esri/arcgis-rest-request";
+import { baseUrl, hasNextPage, getNextPageParams } from "./utils.js";
+/**
+ * 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);
+ * ```
+ */
+export 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;
+    });
+}
+//# sourceMappingURL=findPlacesNearPoint.js.map

package/dist/esm/findPlacesNearPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findPlacesNearPoint.js","sourceRoot":"","sources":["../../src/findPlacesNearPoint.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,kBAAkB,EAEnB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AA2BrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,UAAU,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,EAAE,EAAE;QAClB,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;QAEF,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE;YACzB,CAAC,CAAC,QAAQ,GAAG,GAAG,EAAE;gBAChB,MAAM,WAAW,mCACZ,cAAc,GACd,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CACrE,CAAC;gBACF,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC;YAC1C,CAAC,CAAC;SACH;QAED,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["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"]}

package/dist/esm/findPlacesWithinExtent.d.ts

@@ -0,0 +1,56 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { operations } from "./openapi-types.js";
+declare type queryParams = Pick<operations["withinExtentGet"]["parameters"]["query"], "xmin" | "ymin" | "xmax" | "ymax" | "categoryIds" | "pageSize" | "offset" | "searchText">;
+declare type successResponse = operations["withinExtentGet"]["responses"]["200"]["content"]["application/json"];
+/**
+ * The response format for {@linkcode findPlacesWithinExtent};
+ */
+export interface IFindPlacesWithinExtentResponse extends successResponse {
+    nextPage?: () => Promise<IFindPlacesWithinExtentResponse>;
+}
+/**
+ * Options for {@linkcode findPlacesNearPoint}.
+ */
+export interface IFindPlaceWithinExtentOptions extends Omit<IRequestOptions, "httpMethod" | "f">, queryParams {
+}
+/**
+ * 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)
+ * ```
+ */
+export declare function findPlacesWithinExtent(requestOptions: IFindPlaceWithinExtentOptions): Promise<IFindPlacesWithinExtentResponse>;
+export {};

package/dist/esm/findPlacesWithinExtent.js

@@ -0,0 +1,64 @@
+import { request, appendCustomParams } from "@esri/arcgis-rest-request";
+import { baseUrl, hasNextPage, getNextPageParams } from "./utils.js";
+/**
+ * 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)
+ * ```
+ */
+export 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;
+    });
+}
+//# sourceMappingURL=findPlacesWithinExtent.js.map

package/dist/esm/findPlacesWithinExtent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findPlacesWithinExtent.js","sourceRoot":"","sources":["../../src/findPlacesWithinExtent.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,kBAAkB,EAEnB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAkCrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,UAAU,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,EAAE,EAAE;QAClB,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;QAEF,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE;YACzB,CAAC,CAAC,QAAQ,GAAG,GAAG,EAAE;gBAChB,MAAM,WAAW,mCACZ,cAAc,GACd,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CACrE,CAAC;gBACF,OAAO,sBAAsB,CAAC,WAAW,CAAC,CAAC;YAC7C,CAAC,CAAC;SACH;QACD,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["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"]}

package/dist/esm/getCategories.d.ts

@@ -0,0 +1,38 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { operations } from "./openapi-types.js";
+declare type queryParams = Pick<operations["categoriesGet"]["parameters"]["query"], "filter">;
+declare type successResponse = operations["categoriesGet"]["responses"]["200"]["content"]["application/json"];
+/**
+ * The response format for {@linkcode getCategories};
+ */
+export interface IGetCategoriesResponse extends successResponse {
+}
+/**
+ * Options for {@linkcode getCategories}.
+ */
+export interface IGetCategoriesOptions extends Omit<IRequestOptions, "httpMethod" | "f">, queryParams {
+}
+/**
+ * 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);
+ * ```
+ */
+export declare function getCategories(requestOptions: IGetCategoriesOptions): Promise<IGetCategoriesResponse>;
+export {};

package/dist/esm/getCategories.js

@@ -0,0 +1,29 @@
+import { request, appendCustomParams } from "@esri/arcgis-rest-request";
+import { baseUrl } from "./utils.js";
+/**
+ * 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);
+ * ```
+ */
+export function getCategories(requestOptions) {
+    const options = appendCustomParams(requestOptions, ["filter"], Object.assign({}, requestOptions));
+    return request(`${baseUrl}/categories`, Object.assign(Object.assign({}, options), { httpMethod: "GET" }));
+}
+//# sourceMappingURL=getCategories.js.map

package/dist/esm/getCategories.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCategories.js","sourceRoot":"","sources":["../../src/getCategories.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,kBAAkB,EAEnB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAyBrC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,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,CAAC","sourcesContent":["import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"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"]}

package/dist/esm/getCategory.d.ts

@@ -0,0 +1,32 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { operations } from "./openapi-types.js";
+declare type queryParams = operations["categoriesCategoryIdGet"]["parameters"]["query"];
+declare type successResponse = operations["categoriesCategoryIdGet"]["responses"]["200"]["content"]["application/json"];
+/**
+ * The response format for {@linkcode getCategory};
+ */
+export interface IGetCategoryResponse extends successResponse {
+}
+/**
+ * Options for {@linkcode getCategory}.
+ */
+export interface IGetCategoryOptions extends Omit<IRequestOptions, "httpMethod">, queryParams {
+    categoryId: string;
+}
+/**
+ * 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);
+ * ```
+ **/
+export declare function getCategory(requestOptions: IGetCategoryOptions): Promise<IGetCategoryResponse>;
+export {};

package/dist/esm/getCategory.js

@@ -0,0 +1,23 @@
+import { request, appendCustomParams } from "@esri/arcgis-rest-request";
+import { baseUrl } from "./utils.js";
+/**
+ * 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);
+ * ```
+ **/
+export 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" }));
+}
+//# sourceMappingURL=getCategory.js.map

package/dist/esm/getCategory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCategory.js","sourceRoot":"","sources":["../../src/getCategory.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,kBAAkB,EAEnB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAwBrC;;;;;;;;;;;;;;IAcI;AACJ,MAAM,UAAU,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,CAAC","sourcesContent":["import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = 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"]}

package/dist/esm/getPlaceDetails.d.ts

@@ -0,0 +1,45 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { operations } from "./openapi-types.js";
+declare type queryParams = Pick<operations["placeIdGet"]["parameters"]["query"], "requestedFields">;
+declare type successResponse = operations["placeIdGet"]["responses"]["200"]["content"]["application/json"];
+/**
+ * The response format for {@linkcode getPlace};
+ */
+export interface IGetPlaceResponse extends successResponse {
+}
+/**
+ * Options for {@linkcode getPlace}.
+ */
+export interface IGetPlaceOptions extends Omit<IRequestOptions, "httpMethod">, queryParams {
+    placeId: string;
+}
+/**
+ * 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);
+ * ```
+ */
+export declare function getPlaceDetails(requestOptions: IGetPlaceOptions): Promise<IGetPlaceResponse>;
+export {};

package/dist/esm/getPlaceDetails.js

@@ -0,0 +1,36 @@
+import { request, appendCustomParams } from "@esri/arcgis-rest-request";
+import { baseUrl } from "./utils.js";
+/**
+ * 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);
+ * ```
+ */
+export 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" }));
+}
+//# sourceMappingURL=getPlaceDetails.js.map

package/dist/esm/getPlaceDetails.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPlaceDetails.js","sourceRoot":"","sources":["../../src/getPlaceDetails.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,kBAAkB,EAEnB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AA2BrC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,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,CAAC","sourcesContent":["import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"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"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,6 @@
+export type {} from "@esri/arcgis-rest-request";
+export * from "./findPlacesNearPoint.js";
+export * from "./findPlacesWithinExtent.js";
+export * from "./getPlaceDetails.js";
+export * from "./getCategories.js";
+export * from "./getCategory.js";

package/dist/esm/index.js

@@ -0,0 +1,8 @@
+/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+export * from "./findPlacesNearPoint.js";
+export * from "./findPlacesWithinExtent.js";
+export * from "./getPlaceDetails.js";
+export * from "./getCategories.js";
+export * from "./getCategory.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;gBACgB;AAMhB,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\n// Types that are used in this package are re-exported for convenience and\n// to make the links work correctly in the documentation pages.\nexport type {} from \"@esri/arcgis-rest-request\";\n\nexport * from \"./findPlacesNearPoint.js\";\nexport * from \"./findPlacesWithinExtent.js\";\nexport * from \"./getPlaceDetails.js\";\nexport * from \"./getCategories.js\";\nexport * from \"./getCategory.js\";\n"]}