@azure-rest/maps-render 2.0.0-beta.1 → 2.0.0-beta.2

package/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+Copyright (c) Microsoft Corporation.
 
-Copyright (c) 2022 Microsoft
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -12,10 +12,10 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -12,7 +12,7 @@ Key links:
 - [Product Information][product_info]
 
 | Package Version | Service Version |
-|-----------------|-----------------|
+| --------------- | --------------- |
 | ^1.0.0-beta.4   | V1              |
 | ^2.0.0-beta.1   | 2024-04-01      |
 
@@ -62,11 +62,11 @@ You'll need to register the new Microsoft Entra ID application and grant access
 `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.
 
 You will also need to specify the Azure Maps resource you intend to use by specifying the `clientId` in the client options.
-The Azure Maps resource client id can be found in the Authentication sections in the Azure Maps resource. Please refer to the [documentation](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication#view-authentication-details) on how to find it.
+The Azure Maps resource client id can be found in the Authentication sections in the Azure Maps resource. Please refer to the [documentation](https://learn.microsoft.com/azure/azure-maps/how-to-manage-authentication#view-authentication-details) on how to find it.
 
-```javascript
-const MapsRender = require("@azure-rest/maps-render").default;
-const { DefaultAzureCredential } = require("@azure/identity");
+```ts snippet:ReadmeSampleCreateClient_TokenCredential
+import { DefaultAzureCredential } from "@azure/identity";
+import MapsRender from "@azure-rest/maps-render";
 
 const credential = new DefaultAzureCredential();
 const client = MapsRender(credential, "<maps-account-client-id>");
@@ -80,9 +80,9 @@ You can authenticate with your Azure Maps Subscription Key. Please install the["
 npm install @azure/core-auth
 ```
 
-```javascript
-const MapsRender = require("@azure-rest/maps-render").default;
-const { AzureKeyCredential } = require("@azure/core-auth");
+```ts snippet:ReadmeSampleCreateClient_SubscriptionKey
+import { AzureKeyCredential } from "@azure/core-auth";
+import MapsRender from "@azure-rest/maps-render";
 
 const credential = new AzureKeyCredential("<subscription-key>");
 const client = MapsRender(credential);
@@ -104,11 +104,11 @@ npm install @azure/core-auth
 
 Finally, you can use the SAS token to authenticate the client:
 
-```javascript
-const MapsRender = require("@azure-rest/maps-render").default;
-const { AzureSASCredential } = require("@azure/core-auth");
-const { DefaultAzureCredential } = require("@azure/identity");
-const { AzureMapsManagementClient } = require("@azure/arm-maps");
+```ts snippet:ReadmeSampleCreateClient_SAS
+import { DefaultAzureCredential } from "@azure/identity";
+import { AzureMapsManagementClient } from "@azure/arm-maps";
+import { AzureSASCredential } from "@azure/core-auth";
+import MapsRender from "@azure-rest/maps-render";
 
 const subscriptionId = "<subscription ID of the map account>";
 const resourceGroupName = "<resource group name of the map account>";
@@ -120,6 +120,7 @@ const mapsAccountSasParameters = {
   principalId: "<principle ID (object ID) of the managed identity>",
   signingKey: "primaryKey",
 };
+
 const credential = new DefaultAzureCredential();
 const managementClient = new AzureMapsManagementClient(credential, subscriptionId);
 const { accountSasToken } = await managementClient.accounts.listSas(
@@ -127,9 +128,11 @@ const { accountSasToken } = await managementClient.accounts.listSas(
   accountName,
   mapsAccountSasParameters,
 );
+
 if (accountSasToken === undefined) {
   throw new Error("No accountSasToken was found for the Maps Account.");
 }
+
 const sasCredential = new AzureSASCredential(accountSasToken);
 const client = MapsRender(sasCredential);
 ```
@@ -151,11 +154,15 @@ The following sections provide several code snippets covering some of the most c
 ### Request map tiles in vector or raster formats
 
 You can request map tiles in vector or raster formats. These tiles are typically to be integrated into a map control or SDK.
-Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://docs.microsoft.com/shows/internet-of-things-show/introducing-azure-maps-creator).
+Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://learn.microsoft.com/shows/internet-of-things-show/introducing-azure-maps-creator).
 
-```javascript
-const { createWriteStream } = require("fs");
-const { positionToTileXY } = require("@azure-rest/maps-render");
+```ts snippet:ReadmeSampleRequestMapTiles
+import { DefaultAzureCredential } from "@azure/identity";
+import MapsRender, { positionToTileXY } from "@azure-rest/maps-render";
+import { createWriteStream } from "node:fs";
+
+const credential = new DefaultAzureCredential();
+const client = MapsRender(credential, "<maps-account-client-id>");
 
 const zoom = 6;
 // Use the helper function `positionToTileXY` to get the tile index from the coordinate.
@@ -176,22 +183,27 @@ const response = await client
 if (!response.body) {
   throw Error("No response body");
 }
+
 response.body.pipe(createWriteStream("tile.png"));
 ```
 
 ### Request map copyright attribution information
 
 You can request map copyright attribution information for a section of a tileset.
-A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a tilesetId to use when making requests. The supported tilesetIds are listed [here](https://docs.microsoft.com/rest/api/maps/render/get-map-attribution?tabs=HTTP#tilesetid).
+A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a tilesetId to use when making requests. The supported tilesetIds are listed [here](https://learn.microsoft.com/rest/api/maps/render/get-map-attribution?tabs=HTTP#tilesetid).
 
-```javascript
-const { isUnexpected } = require("@azure-rest/maps-render");
+```ts snippet:ReadmeSampleRequestMapAttribution
+import { DefaultAzureCredential } from "@azure/identity";
+import MapsRender, { isUnexpected } from "@azure-rest/maps-render";
+
+const credential = new DefaultAzureCredential();
+const client = MapsRender(credential, "<maps-account-client-id>");
 
 const response = await client.path("/map/attribution").get({
   queryParameters: {
     tilesetId: "microsoft.base",
     zoom: 6,
-    /** The order is [SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude] */
+    // The order is [SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]
     bounds: [-122.414162, 47.57949, -122.247157, 47.668372],
   },
 });
@@ -209,8 +221,12 @@ response.body.copyrights.forEach((copyright) => console.log(copyright));
 
 You can request metadata for a tileset in TileJSON format using the following code snippet.
 
-```javascript
-const { isUnexpected } = require("@azure-rest/maps-render");
+```ts snippet:ReadmeSampleRequestTilesetMetadata
+import { DefaultAzureCredential } from "@azure/identity";
+import MapsRender, { isUnexpected } from "@azure-rest/maps-render";
+
+const credential = new DefaultAzureCredential();
+const client = MapsRender(credential, "<maps-account-client-id>");
 
 const response = await client.path("/map/tileset").get({
   queryParameters: {
@@ -236,8 +252,8 @@ console.log(
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```javascript
-const { setLogLevel } = require("@azure/logger");
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```
@@ -256,19 +272,17 @@ If you'd like to contribute to this library, please read the [contributing guide
 
 - [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
 
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fmaps%2Fmaps-render-rest%2FREADME.png)
-
 [source_code]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/maps/maps-render-rest
 [npm_package]: https://www.npmjs.com/package/@azure-rest/maps-render
-[api_ref]: https://docs.microsoft.com/javascript/api/@azure-rest/maps-render?view=azure-node-preview
+[api_ref]: https://learn.microsoft.com/javascript/api/@azure-rest/maps-render?view=azure-node-preview
 [samples]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/maps/maps-render-rest/samples
-[product_info]: https://docs.microsoft.com/rest/api/maps/render
+[product_info]: https://learn.microsoft.com/rest/api/maps/render
 [nodejs_release]: https://github.com/nodejs/release#release-schedule
 [az_subscription]: https://azure.microsoft.com/free/
-[az_maps_account_management]: https://docs.microsoft.com/azure/azure-maps/how-to-manage-account-keys
+[az_maps_account_management]: https://learn.microsoft.com/azure/azure-maps/how-to-manage-account-keys
 [azure_portal]: https://portal.azure.com
-[azure_powershell]: https://docs.microsoft.com/powershell/module/az.maps/new-azmapsaccount
-[azure_cli]: https://docs.microsoft.com/cli/azure
-[az_map_pricing]: https://docs.microsoft.com/azure/azure-maps/choose-pricing-tier
-[az_map_az_cli]: https://docs.microsoft.com/cli/azure/maps/account?view=azure-cli-latest#az_maps_account_create
+[azure_powershell]: https://learn.microsoft.com/powershell/module/az.maps/new-azmapsaccount
+[azure_cli]: https://learn.microsoft.com/cli/azure
+[az_map_pricing]: https://learn.microsoft.com/azure/azure-maps/choose-pricing-tier
+[az_map_az_cli]: https://learn.microsoft.com/cli/azure/maps/account?view=azure-cli-latest#az_maps_account_create
 [az_map_auth]: https://learn.microsoft.com/azure/azure-maps/azure-maps-authentication

package/dist/browser/createMultiCollection.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @internal
+ * Workaround to create a path query string for [ collectionFormat: multi ](https://swagger.io/docs/specification/2-0/describing-parameters/#:~:text=csv%20(-,default,-)).
+ * This should be removed once the core-client support collectionFormat: multi.
+ */
+export declare function createMultiCollection(key: string, values: string[]): string;
+//# sourceMappingURL=createMultiCollection.d.ts.map

package/dist/browser/createMultiCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createMultiCollection.d.ts","sourceRoot":"","sources":["../../src/createMultiCollection.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAI3E"}

package/dist/browser/createPathQuery.d.ts

@@ -0,0 +1,117 @@
+import type { LatLon } from "@azure/maps-common";
+/**
+ * The options that modify the style of a circular path.
+ */
+export interface CircularPathOptions {
+    /** The line color of the path. Range from 000000 to FFFFFF. */
+    lineColor?: string;
+    /** The line opacity of the path. Range from 0 to 1. */
+    lineOpacity?: number;
+    /** The line width of the line. Should be greater than 0. */
+    lineWidthInPixels?: number;
+}
+/**
+ * The options that modify the style of a polygonal path.
+ */
+export interface PolygonalPathOptions extends CircularPathOptions {
+    /** The fill color of the path. This only works if the path is a closed shape like polygon or circle. Range from 000000 to FFFFFF.*/
+    fillColor?: string;
+    /** The fill color of the path. This only works if the path is a closed shape like polygon or circle. Range from 0 to 1.*/
+    fillOpacity?: number;
+}
+/**
+ * Specify a circular path.
+ */
+export interface CircularPath {
+    /** The center of the circular path. */
+    center: LatLon;
+    /** The radius of the circular path. */
+    radiusInMeters: number;
+    /** The options that modify the style of the circular path. */
+    options?: CircularPathOptions;
+}
+/**
+ * Specify a polygonal path.
+ */
+export interface PolygonalPath {
+    /** The coordinates of the polygonal path. The identical coordinate in the first & last position construct a closed polygon.*/
+    coordinates: LatLon[];
+    /** The options that modify the style of the polygonal path. */
+    options?: PolygonalPathOptions;
+}
+/**
+ * Create a path query string for _get map static image_ request.
+ *
+ * @example
+ * ```ts snippet:ReadmeSampleCreatePathQuery
+ * import { DefaultAzureCredential } from "@azure/identity";
+ * import MapsRender, { CircularPath, PolygonalPath, createPathQuery } from "@azure-rest/maps-render";
+ * import { createWriteStream } from "node:fs";
+ *
+ * const credential = new DefaultAzureCredential();
+ * const client = MapsRender(credential, "<maps-account-client-id>");
+ *
+ * const circularPath: CircularPath = {
+ *   center: [52.4559, 13.228],
+ *   radiusInMeters: 10000,
+ *   options: {
+ *     lineColor: "000000",
+ *     lineOpacity: 0.9,
+ *     lineWidthInPixels: 2,
+ *   },
+ * };
+ *
+ * const linearPath: PolygonalPath = {
+ *   coordinates: [
+ *     [52.577, 13.35],
+ *     [52.6, 13.2988],
+ *     [52.32, 13.2988],
+ *   ],
+ *   options: {
+ *     lineColor: "000000",
+ *     lineOpacity: 0.9,
+ *     lineWidthInPixels: 2,
+ *   },
+ * };
+ *
+ * const polygonPath: PolygonalPath = {
+ *   coordinates: [
+ *     [52.577, 13.35],
+ *     [52.6, 13.2988],
+ *     [52.32, 13.2988],
+ *     [52.577, 13.35],
+ *   ],
+ *   options: {
+ *     lineColor: "000000",
+ *     lineOpacity: 0.9,
+ *     lineWidthInPixels: 2,
+ *     fillColor: "FFFFFF",
+ *     fillOpacity: 0.8,
+ *   },
+ * };
+ *
+ * const path = createPathQuery([circularPath, linearPath, polygonPath]);
+ * // Send the request
+ * const response = await client
+ *   .path("/map/static")
+ *   .get({
+ *     queryParameters: {
+ *       bbox: [13.228, 52.4559, 13.5794, 52.629],
+ *       path,
+ *     },
+ *   })
+ *   .asNodeStream();
+ *
+ * // Handle the error.
+ * if (!response.body) {
+ *   throw Error("No response body");
+ * }
+ *
+ * response.body.pipe(createWriteStream("path.png"));
+ * ```
+ *
+ * @param paths - A collection of {@link PolygonalPath} and {@link CircularPath} that you want to draw on the image.
+ * @param options - The options for the style of the path. See the possible options in {@link PolygonalPathOptions} and {@link CircularPathOptions}.
+ */
+export declare function createPathQuery(paths: Array<PolygonalPath | CircularPath>): string;
+//# sourceMappingURL=createPathQuery.d.ts.map

package/dist/browser/createPathQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPathQuery.d.ts","sourceRoot":"","sources":["../../src/createPathQuery.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAGjD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4DAA4D;IAC5D,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC/D,oIAAoI;IACpI,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0HAA0H;IAC1H,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAMD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,cAAc,EAAE,MAAM,CAAC;IACvB,8DAA8D;IAC9D,OAAO,CAAC,EAAE,mBAAmB,CAAC;CAC/B;AAKD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,8HAA8H;IAC9H,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,+DAA+D;IAC/D,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AA2BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,aAAa,GAAG,YAAY,CAAC,GAAG,MAAM,CASlF"}

package/{dist-esm/src → dist/browser}/createPathQuery.js

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import { createMultiCollection } from "./createMultiCollection";
+import { createMultiCollection } from "./createMultiCollection.js";
 function isCircularPath(path) {
     return "center" in path;
 }
@@ -31,8 +31,15 @@ function comosePathVal(coordinates, options) {
  * Create a path query string for _get map static image_ request.
  *
  * @example
- * ```ts
- * const circularPath = {
+ * ```ts snippet:ReadmeSampleCreatePathQuery
+ * import { DefaultAzureCredential } from "@azure/identity";
+ * import MapsRender, { CircularPath, PolygonalPath, createPathQuery } from "@azure-rest/maps-render";
+ * import { createWriteStream } from "node:fs";
+ *
+ * const credential = new DefaultAzureCredential();
+ * const client = MapsRender(credential, "<maps-account-client-id>");
+ *
+ * const circularPath: CircularPath = {
  *   center: [52.4559, 13.228],
  *   radiusInMeters: 10000,
  *   options: {
@@ -42,7 +49,7 @@ function comosePathVal(coordinates, options) {
  *   },
  * };
  *
- * const linearPath = {
+ * const linearPath: PolygonalPath = {
  *   coordinates: [
  *     [52.577, 13.35],
  *     [52.6, 13.2988],
@@ -55,30 +62,40 @@ function comosePathVal(coordinates, options) {
  *   },
  * };
  *
- * const polygonPath = {
- *  coordinates: [
- *    [52.577, 13.35],
- *    [52.6, 13.2988],
- *    [52.32, 13.2988],
- *    [52.577, 13.35],
- *  ],
- *  options: {
- *    lineColor: "000000",
- *    lineOpacity: 0.9,
- *    lineWidthInPixels: 2,
- *    fillColor: "FFFFFF",
- *    fillOpacity: 0.8,
- *  },
+ * const polygonPath: PolygonalPath = {
+ *   coordinates: [
+ *     [52.577, 13.35],
+ *     [52.6, 13.2988],
+ *     [52.32, 13.2988],
+ *     [52.577, 13.35],
+ *   ],
+ *   options: {
+ *     lineColor: "000000",
+ *     lineOpacity: 0.9,
+ *     lineWidthInPixels: 2,
+ *     fillColor: "FFFFFF",
+ *     fillOpacity: 0.8,
+ *   },
  * };
  *
  * const path = createPathQuery([circularPath, linearPath, polygonPath]);
  * // Send the request
- * const response = await client.path("/map/static/{format}", "png").get({
- *  queryParameters: {
- *    bbox: [13.228,52.4559,13.5794,52.629],
- *    path: path
- *  }
- * });
+ * const response = await client
+ *   .path("/map/static")
+ *   .get({
+ *     queryParameters: {
+ *       bbox: [13.228, 52.4559, 13.5794, 52.629],
+ *       path,
+ *     },
+ *   })
+ *   .asNodeStream();
+ *
+ * // Handle the error.
+ * if (!response.body) {
+ *   throw Error("No response body");
+ * }
+ *
+ * response.body.pipe(createWriteStream("path.png"));
  * ```
  *
  * @param paths - A collection of {@link PolygonalPath} and {@link CircularPath} that you want to draw on the image.

package/dist/browser/createPathQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPathQuery.js","sourceRoot":"","sources":["../../src/createPathQuery.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAwCnE,SAAS,cAAc,CAAC,IAAkC;IACxD,OAAO,QAAQ,IAAI,IAAI,CAAC;AAC1B,CAAC;AAWD,MAAM,YAAY,GAAgD;IAChE,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,iBAAiB,EAAE,IAAI;IACvB,MAAM,EAAE,IAAI;CACb,CAAC;AAEF,SAAS,WAAW,CAAC,GAAQ;IAC3B,OAAO,GAAG,IAAI,YAAY,CAAC;AAC7B,CAAC;AAED,SAAS,aAAa,CAAC,WAAqB,EAAE,OAA8B;IAC1E,uCAAuC;IACvC,MAAM,mBAAmB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvF,mCAAmC;IACnC,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAS,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;QACtF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;YAAE,MAAM,KAAK,CAAC,eAAe,GAAG,EAAE,CAAC,CAAC;QACzD,QAAQ,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC;QAC/D,OAAO,QAAQ,CAAC;IAClB,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,OAAO,eAAe,GAAG,IAAI,GAAG,mBAAmB,CAAC;AACtD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,MAAM,UAAU,eAAe,CAAC,KAA0C;IACxE,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACrC,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YACjD,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,kCAAO,OAAO,KAAE,MAAM,EAAE,cAAc,IAAG,CAAC;QACzE,CAAC;QACD,OAAO,aAAa,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IACH,OAAO,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AACpD,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { LatLon } from \"@azure/maps-common\";\nimport { createMultiCollection } from \"./createMultiCollection.js\";\n\n/**\n * The options that modify the style of a circular path.\n */\nexport interface CircularPathOptions {\n  /** The line color of the path. Range from 000000 to FFFFFF. */\n  lineColor?: string;\n  /** The line opacity of the path. Range from 0 to 1. */\n  lineOpacity?: number;\n  /** The line width of the line. Should be greater than 0. */\n  lineWidthInPixels?: number;\n}\n\n/**\n * The options that modify the style of a polygonal path.\n */\nexport interface PolygonalPathOptions extends CircularPathOptions {\n  /** The fill color of the path. This only works if the path is a closed shape like polygon or circle. Range from 000000 to FFFFFF.*/\n  fillColor?: string;\n  /** The fill color of the path. This only works if the path is a closed shape like polygon or circle. Range from 0 to 1.*/\n  fillOpacity?: number;\n}\n\ninterface PathOptionsForRequest extends PolygonalPathOptions {\n  radius?: number;\n}\n\n/**\n * Specify a circular path.\n */\nexport interface CircularPath {\n  /** The center of the circular path. */\n  center: LatLon;\n  /** The radius of the circular path. */\n  radiusInMeters: number;\n  /** The options that modify the style of the circular path. */\n  options?: CircularPathOptions;\n}\n\nfunction isCircularPath(path: PolygonalPath | CircularPath): path is CircularPath {\n  return \"center\" in path;\n}\n/**\n * Specify a polygonal path.\n */\nexport interface PolygonalPath {\n  /** The coordinates of the polygonal path. The identical coordinate in the first & last position construct a closed polygon.*/\n  coordinates: LatLon[];\n  /** The options that modify the style of the polygonal path. */\n  options?: PolygonalPathOptions;\n}\n\nconst optionKeyMap: Record<keyof PathOptionsForRequest, string> = {\n  lineColor: \"lc\",\n  lineOpacity: \"la\",\n  fillColor: \"fc\",\n  fillOpacity: \"fa\",\n  lineWidthInPixels: \"lw\",\n  radius: \"ra\",\n};\n\nfunction isOptionKey(key: any): key is keyof PathOptionsForRequest {\n  return key in optionKeyMap;\n}\n\nfunction comosePathVal(coordinates: LatLon[], options: PathOptionsForRequest): string {\n  // compose the coordinates query string\n  const coordinatesQueryStr = coordinates.map(([lat, lon]) => `${lon} ${lat}`).join(\"|\");\n  // compose the options query string\n  const optionsQueryStr = Object.entries(options).reduce<string>((queryStr, [key, val]) => {\n    if (!isOptionKey(key)) throw Error(`Unknown key ${key}`);\n    queryStr += `${queryStr ? \"|\" : \"\"}${optionKeyMap[key]}${val}`;\n    return queryStr;\n  }, \"\");\n  return optionsQueryStr + \"||\" + coordinatesQueryStr;\n}\n\n/**\n * Create a path query string for _get map static image_ request.\n *\n * @example\n * ```ts snippet:ReadmeSampleCreatePathQuery\n * import { DefaultAzureCredential } from \"@azure/identity\";\n * import MapsRender, { CircularPath, PolygonalPath, createPathQuery } from \"@azure-rest/maps-render\";\n * import { createWriteStream } from \"node:fs\";\n *\n * const credential = new DefaultAzureCredential();\n * const client = MapsRender(credential, \"<maps-account-client-id>\");\n *\n * const circularPath: CircularPath = {\n *   center: [52.4559, 13.228],\n *   radiusInMeters: 10000,\n *   options: {\n *     lineColor: \"000000\",\n *     lineOpacity: 0.9,\n *     lineWidthInPixels: 2,\n *   },\n * };\n *\n * const linearPath: PolygonalPath = {\n *   coordinates: [\n *     [52.577, 13.35],\n *     [52.6, 13.2988],\n *     [52.32, 13.2988],\n *   ],\n *   options: {\n *     lineColor: \"000000\",\n *     lineOpacity: 0.9,\n *     lineWidthInPixels: 2,\n *   },\n * };\n *\n * const polygonPath: PolygonalPath = {\n *   coordinates: [\n *     [52.577, 13.35],\n *     [52.6, 13.2988],\n *     [52.32, 13.2988],\n *     [52.577, 13.35],\n *   ],\n *   options: {\n *     lineColor: \"000000\",\n *     lineOpacity: 0.9,\n *     lineWidthInPixels: 2,\n *     fillColor: \"FFFFFF\",\n *     fillOpacity: 0.8,\n *   },\n * };\n *\n * const path = createPathQuery([circularPath, linearPath, polygonPath]);\n * // Send the request\n * const response = await client\n *   .path(\"/map/static\")\n *   .get({\n *     queryParameters: {\n *       bbox: [13.228, 52.4559, 13.5794, 52.629],\n *       path,\n *     },\n *   })\n *   .asNodeStream();\n *\n * // Handle the error.\n * if (!response.body) {\n *   throw Error(\"No response body\");\n * }\n *\n * response.body.pipe(createWriteStream(\"path.png\"));\n * ```\n *\n * @param paths - A collection of {@link PolygonalPath} and {@link CircularPath} that you want to draw on the image.\n * @param options - The options for the style of the path. See the possible options in {@link PolygonalPathOptions} and {@link CircularPathOptions}.\n */\nexport function createPathQuery(paths: Array<PolygonalPath | CircularPath>): string {\n  const pathQueries = paths.map((path) => {\n    if (isCircularPath(path)) {\n      const { center, radiusInMeters, options } = path;\n      return comosePathVal([center], { ...options, radius: radiusInMeters });\n    }\n    return comosePathVal(path.coordinates, path.options || {});\n  });\n  return createMultiCollection(\"path\", pathQueries);\n}\n"]}

package/dist/browser/createPinsQuery.d.ts

@@ -0,0 +1,102 @@
+import type { LatLon } from "@azure/maps-common";
+/**
+ * Specify how the pin's position and label text.
+ */
+export interface Pin {
+    /** The coordinate of the pin. */
+    coordinate: LatLon;
+    /** The label text for the pin. */
+    label?: string;
+}
+/**
+ * The pin options for default/none image style..
+ */
+export interface PinOptions {
+    /** The opacity of the pin. Range from 0 to 1 */
+    opacity?: number;
+    /**
+     * The labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and is at the top center of custom pushpins (see below).
+     * To override the label anchor, using the _labelAnchor_ option and provide X and Y pixel coordinates for the anchor.
+     * These coordinates are relative to the top left corner of the pushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down.
+     * For example, to position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image, use \{labelAnchor: [10, -4]\}
+     * */
+    labelAnchor?: [number, number];
+    /** Color of the label. Range from 000000 to FFFFFF */
+    labelColor?: string;
+    /** Size of the label in pixels. */
+    labelSizeInPixels?: number;
+    /**
+     * By default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures the location that you're trying to highlight.
+     * To override the anchor location of the pin image, use the _pinAnchor_ option. This uses the same format as the _labelAnchor_ options.
+     * For example, if your custom pin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by using \{pinAnchor: [0, 0]\}
+     */
+    pinAnchor?: [number, number];
+    /** The ration of the pin. Range from -360 to 360*/
+    rotationInDegree?: number;
+    /** The scale of the pin. Should be greater than 0. */
+    scale?: number;
+    /** Color of the pin. Range from 000000 to FFFFFF */
+    pinColor?: string;
+}
+export interface PinSet {
+    pins: Pin[];
+    pinImage?: "default" | "none" | string;
+    options?: PinOptions;
+}
+/**
+ * Create a pin query string for _get map static image_
+ *
+ * @example
+ * ```ts snippet:ReadmeSampleCreatePinsQuery
+ * import { DefaultAzureCredential } from "@azure/identity";
+ * import MapsRender, { PinSet, createPinsQuery } from "@azure-rest/maps-render";
+ * import { createWriteStream } from "node:fs";
+ *
+ * const credential = new DefaultAzureCredential();
+ * const client = MapsRender(credential, "<maps-account-client-id>");
+ *
+ * const pins: PinSet[] = [
+ *   {
+ *     pins: [
+ *       { coordinate: [52.577, 13.35], label: "Label start" },
+ *       { coordinate: [52.6, 13.2988], label: "Label end" },
+ *     ],
+ *     pinImage: "default",
+ *     options: {
+ *       scale: 0.9,
+ *       pinColor: "FF0000",
+ *       labelColor: "0000FF",
+ *       labelSizeInPixels: 18,
+ *     },
+ *   },
+ * ];
+ *
+ * const path = createPinsQuery(pins);
+ *
+ * const response = await client
+ *   .path("/map/static")
+ *   .get({
+ *     queryParameters: {
+ *       bbox: [13.228, 52.4559, 13.5794, 52.62],
+ *       zoom: 10,
+ *       path,
+ *     },
+ *     skipUrlEncoding: true,
+ *   })
+ *   .asNodeStream();
+ *
+ * // Handle the error.
+ * if (!response.body) {
+ *   throw Error("No response body");
+ * }
+ *
+ * response.body.pipe(createWriteStream("pin.png"));
+ * ```
+ *
+ * @param pins - An array of {@link Pin} that specify the positions and label text of each pin.
+ * @param pinImage - Specify the image source for custom pin. Set this to "none" if you don't want to show a pin image.
+ * @param options - The style options of the pins. See {@link PinOptions}
+ * @returns - The composed query string.
+ */
+export declare function createPinsQuery(pinSets: PinSet[]): string;
+//# sourceMappingURL=createPinsQuery.d.ts.map

package/dist/browser/createPinsQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPinsQuery.d.ts","sourceRoot":"","sources":["../../src/createPinsQuery.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAGjD;;GAEG;AACH,MAAM,WAAW,GAAG;IAClB,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;SAKK;IACL,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,mDAAmD;IACnD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAiBD,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,QAAQ,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;IACvC,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AAEH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAkBzD"}

package/{dist-esm/src → dist/browser}/createPinsQuery.js

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import { createMultiCollection } from "./createMultiCollection";
+import { createMultiCollection } from "./createMultiCollection.js";
 const optionKeyMap = {
     opacity: "al",
     labelAnchor: "la",
@@ -18,31 +18,50 @@ function isOptionKeyMap(key) {
  * Create a pin query string for _get map static image_
  *
  * @example
- * ```ts
+ * ```ts snippet:ReadmeSampleCreatePinsQuery
+ * import { DefaultAzureCredential } from "@azure/identity";
+ * import MapsRender, { PinSet, createPinsQuery } from "@azure-rest/maps-render";
+ * import { createWriteStream } from "node:fs";
  *
- * const pins = {
- *  pins: [
- *    { coordinate: [52.577, 13.35], label: "Label start" },
- *    { coordinate: [52.6, 13.2988], label: "Label end" },
- *  ],
- *  pinImage: "<image source url || default || none>"
- *  options: {
- *    scale: 0.9,
- *    pinColor: "FF0000",
- *    labelColor: "0000FF",
- *    labelSizeInPixels: 18,
- *  }
- * );
- * const res = await client
- *  .path("/map/static/{format}", "png")
- *  .get({
- *    queryParameters: {
- *      bbox: [13.228, 52.4559, 13.5794, 52.62],
- *      zoom: 10,
- *      pins: pins,
- *    },
- *    skipUrlEncoding: true,
- *  })
+ * const credential = new DefaultAzureCredential();
+ * const client = MapsRender(credential, "<maps-account-client-id>");
+ *
+ * const pins: PinSet[] = [
+ *   {
+ *     pins: [
+ *       { coordinate: [52.577, 13.35], label: "Label start" },
+ *       { coordinate: [52.6, 13.2988], label: "Label end" },
+ *     ],
+ *     pinImage: "default",
+ *     options: {
+ *       scale: 0.9,
+ *       pinColor: "FF0000",
+ *       labelColor: "0000FF",
+ *       labelSizeInPixels: 18,
+ *     },
+ *   },
+ * ];
+ *
+ * const path = createPinsQuery(pins);
+ *
+ * const response = await client
+ *   .path("/map/static")
+ *   .get({
+ *     queryParameters: {
+ *       bbox: [13.228, 52.4559, 13.5794, 52.62],
+ *       zoom: 10,
+ *       path,
+ *     },
+ *     skipUrlEncoding: true,
+ *   })
+ *   .asNodeStream();
+ *
+ * // Handle the error.
+ * if (!response.body) {
+ *   throw Error("No response body");
+ * }
+ *
+ * response.body.pipe(createWriteStream("pin.png"));
  * ```
  *
  * @param pins - An array of {@link Pin} that specify the positions and label text of each pin.