feat(arcgis-rest-places): places api - add icon param

* fix: places api - add icon param

* chore: update open API types and doc

* docs: update docs with link to spec doc

* Update packages/arcgis-rest-places/README.md

Co-authored-by: Gavin Rehkemper <[email protected]>

* feat: add overwrite and isView options (#1175)

added overwrite and isView options to ICreateServiceOptions,
per https://developers.arcgis.com/rest/users-groups-and-items/create-service/#request-parameters

* chore(release): 4.1.0 [skip ci]

# @esri/arcgis-rest-feature-service [4.1.0](https://github.com/Esri/arcgis-rest-js/compare/@esri/[email protected]...@esri/[email protected]) (2024-12-17)

### Features

* add overwrite and isView options ([#1175](#1175)) ([949e341](949e341))

* docs: reference correct classes (#1183)

* chore: update open API types and doc

* docs: update docs with link to spec doc

* Update packages/arcgis-rest-places/README.md

Co-authored-by: Gavin Rehkemper <[email protected]>

* chore: update package-lock for merge

---------

Co-authored-by: Bruno Caimar <[email protected]>
Co-authored-by: Gavin Rehkemper <[email protected]>
Co-authored-by: semantic-release-bot <[email protected]>

Author: 4 people

demos/node-places-api/categories.mock.json

@@ -3,5 +3,8 @@
   "fullLabel": [
     "Arts and Entertainment"
   ],
-  "parents": []
+  "parents": [],
+  "icon": {
+    "url": "https://static.arcgis.com/icons/places/Default_Arts_and_Entertainment_15.cim"
+  }
 }

demos/node-places-api/category.mock.json

@@ -1,44 +1,71 @@
 {
   "results": [
     {
-      "placeId": "6eb039fa6c292d431b370f8ff9182955",
+      "placeId": "188ab43b2bec75c6e4f6d5df10afc003",
       "location": {
-        "x": -118.001636,
-        "y": 33.802438
+        "x": -118.008724,
+        "y": 33.816751
       },
       "categories": [
         {
-          "categoryId": "13043",
-          "label": "Donut Shop"
+          "categoryId": "13002",
+          "label": "Bakery"
         },
+        {
+          "categoryId": "13065",
+          "label": "Restaurant"
+        }
+      ],
+      "name": "Maxs Baked Goods",
+      "icon": {
+        "url": "https://static.arcgis.com/icons/places/Bakery_15.cim"
+      }
+    },
+    {
+      "placeId": "2a6ddf5433a1c9a664b268adbdcf7559",
+      "location": {
+        "x": -118.010416,
+        "y": 33.825168
+      },
+      "categories": [
         {
           "categoryId": "13001",
           "label": "Bagel Shop"
         },
+        {
+          "categoryId": "13065",
+          "label": "Restaurant"
+        },
         {
           "categoryId": "13002",
           "label": "Bakery"
         }
       ],
-      "name": "Donut King and Water"
+      "name": "Donut Storr",
+      "icon": {
+        "url": "https://static.arcgis.com/icons/places/Bakery_15.cim"
+      }
     },
     {
-      "placeId": "06dc48eba7c1c3106db6a0f498eaf1c7",
+      "placeId": "c602ca8f1010f95618c231046dbef3f6",
       "location": {
-        "x": -118.001186,
-        "y": 33.809568
+        "x": -118.001473,
+        "y": 33.831684
       },
       "categories": [
         {
           "categoryId": "13002",
           "label": "Bakery"
         },
         {
-          "categoryId": "13303",
-          "label": "Mexican Restaurant"
+          "categoryId": "13065",
+          "label": "Restaurant"
         }
       ],
-      "name": "Panaderia Cortez"
+      "name": "Tlaxcala Bakery",
+      "icon": {
+        "url": "https://static.arcgis.com/icons/places/Bakery_15.cim"
+      }
     },
     {
       "placeId": "693a02b6f4c32acf6d1060a164865da4",
@@ -47,20 +74,23 @@
         "y": 33.795145
       },
       "categories": [
-        {
-          "categoryId": "13043",
-          "label": "Donut Shop"
-        },
         {
           "categoryId": "13001",
           "label": "Bagel Shop"
         },
+        {
+          "categoryId": "13065",
+          "label": "Restaurant"
+        },
         {
           "categoryId": "13002",
           "label": "Bakery"
         }
       ],
-      "name": "Amy's Donuts"
+      "name": "Amy's Donuts",
+      "icon": {
+        "url": "https://static.arcgis.com/icons/places/Bakery_15.cim"
+      }
     }
   ]
 }

demos/node-places-api/extent.mock.json

@@ -1,5 +1,5 @@
 import { ApiKeyManager } from "@esri/arcgis-rest-request";
-import { getCategories } from "@esri/arcgis-rest-places";
+import { getCategories, IconOptions } from "@esri/arcgis-rest-places";
 import * as dotenv from "dotenv";
 import fs from "fs";
 import find from "unist-util-find";
@@ -15,6 +15,7 @@ const authentication = ApiKeyManager.fromKey(process.env.API_KEY);
 
 const { categories } = await getCategories({
   endpoint: "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/categories",
+  icon: IconOptions.PNG,
   authentication
 });
 
@@ -34,6 +35,7 @@ const tree = {
       type: "category",
       id: c.categoryId,
       fullLabel: c.fullLabel || [],
+      icon: c.icon,
       children: []
     };
   })
@@ -50,6 +52,7 @@ childCategories.reduce((tree, child) => {
     type: "category",
     id: child.categoryId,
     fullLabel: child.fullLabel || [],
+    icon: child.icon,
     children: []
   });
   return tree;

demos/node-places-api/index.js

@@ -4,7 +4,8 @@ import {
   findPlacesWithinExtent,
   getPlaceDetails,
   getCategories,
-  getCategory
+  getCategory,
+  IconOptions
 } from "@esri/arcgis-rest-places";
 import * as dotenv from "dotenv";
 import fs from "fs";
@@ -17,6 +18,7 @@ let lastResponse = await findPlacesNearPoint({
   x: -3.1883,
   y: 55.9533,
   radius: 100,
+  icon: IconOptions.PNG,
   authentication
 });
 
@@ -40,6 +42,7 @@ const extentResults = await findPlacesWithinExtent({
   xmax: -117.995753,
   ymax: 33.833337,
   categoryIds: ["13002"],
+  icon: IconOptions.CIM,
   authentication
 });
 
@@ -51,6 +54,7 @@ fs.promises.writeFile(
 const placeResult = await getPlaceDetails({
   placeId: extentResults.results[0].placeId,
   requestedFields: ["all"],
+  icon: IconOptions.SVG,
   authentication
 });
 
@@ -83,7 +87,10 @@ if (placeResult.placeDetails.categories) {
   );
 }
 
-const { categories } = await getCategories({ authentication });
+const { categories } = await getCategories({
+  authentication,
+  icon: IconOptions.PNG
+});
 
 console.log("Found categories: ", categories.length);
 
@@ -93,6 +100,7 @@ fs.promises.writeFile(
 );
 const categoryMock = await getCategory({
   categoryId: "10000",
+  icon: IconOptions.CIM,
   authentication
 });