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

package/dist/commonjs/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/commonjs/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/commonjs/createPathQuery.js

@@ -0,0 +1,117 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPathQuery = createPathQuery;
+const createMultiCollection_js_1 = require("./createMultiCollection.js");
+function isCircularPath(path) {
+    return "center" in path;
+}
+const optionKeyMap = {
+    lineColor: "lc",
+    lineOpacity: "la",
+    fillColor: "fc",
+    fillOpacity: "fa",
+    lineWidthInPixels: "lw",
+    radius: "ra",
+};
+function isOptionKey(key) {
+    return key in optionKeyMap;
+}
+function comosePathVal(coordinates, options) {
+    // compose the coordinates query string
+    const coordinatesQueryStr = coordinates.map(([lat, lon]) => `${lon} ${lat}`).join("|");
+    // compose the options query string
+    const optionsQueryStr = Object.entries(options).reduce((queryStr, [key, val]) => {
+        if (!isOptionKey(key))
+            throw Error(`Unknown key ${key}`);
+        queryStr += `${queryStr ? "|" : ""}${optionKeyMap[key]}${val}`;
+        return queryStr;
+    }, "");
+    return optionsQueryStr + "||" + coordinatesQueryStr;
+}
+/**
+ * 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}.
+ */
+function createPathQuery(paths) {
+    const pathQueries = paths.map((path) => {
+        if (isCircularPath(path)) {
+            const { center, radiusInMeters, options } = path;
+            return comosePathVal([center], Object.assign(Object.assign({}, options), { radius: radiusInMeters }));
+        }
+        return comosePathVal(path.coordinates, path.options || {});
+    });
+    return (0, createMultiCollection_js_1.createMultiCollection)("path", pathQueries);
+}
+//# sourceMappingURL=createPathQuery.js.map

package/dist/commonjs/createPathQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPathQuery.js","sourceRoot":"","sources":["../../src/createPathQuery.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AA2JlC,0CASC;AAjKD,yEAAmE;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,SAAgB,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,IAAA,gDAAqB,EAAC,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/commonjs/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/commonjs/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/commonjs/createPinsQuery.js

@@ -0,0 +1,96 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPinsQuery = createPinsQuery;
+const createMultiCollection_js_1 = require("./createMultiCollection.js");
+const optionKeyMap = {
+    opacity: "al",
+    labelAnchor: "la",
+    labelColor: "lc",
+    labelSizeInPixels: "ls",
+    pinAnchor: "an",
+    rotationInDegree: "ro",
+    scale: "sc",
+    pinColor: "co",
+};
+function isOptionKeyMap(key) {
+    return key in optionKeyMap;
+}
+/**
+ * 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.
+ */
+function createPinsQuery(pinSets) {
+    const pinsQueries = pinSets.map(({ pins, pinImage = "default", options = {} }) => {
+        // compose the pins' position query string
+        const pinsQueryStr = pins
+            .map(({ coordinate: [lat, lon], label }) => `${label ? `'${label}'` : ""}${lon} ${lat}`)
+            .join("|");
+        // compose the options query string
+        const optionsQueryStr = Object.entries(options).reduce((queryStr, [key, val]) => {
+            if (!isOptionKeyMap(key))
+                throw Error(`Unexpected option: ${key}`);
+            if (Array.isArray(val))
+                return (queryStr += `|${optionKeyMap[key]}${val[0]} ${val[1]}`);
+            return (queryStr += `|${optionKeyMap[key]}${val}`);
+        }, "");
+        if (pinImage === "none" || pinImage === "default") {
+            return `${pinImage}${optionsQueryStr}||${pinsQueryStr}`;
+        }
+        return `custom${optionsQueryStr}||${pinsQueryStr}||${pinImage}`;
+    });
+    return (0, createMultiCollection_js_1.createMultiCollection)("pins", pinsQueries);
+}
+//# sourceMappingURL=createPinsQuery.js.map

package/dist/commonjs/createPinsQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPinsQuery.js","sourceRoot":"","sources":["../../src/createPinsQuery.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AA0HlC,0CAkBC;AAzID,yEAAmE;AA2CnE,MAAM,YAAY,GAAqC;IACrD,OAAO,EAAE,IAAI;IACb,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;IAChB,iBAAiB,EAAE,IAAI;IACvB,SAAS,EAAE,IAAI;IACf,gBAAgB,EAAE,IAAI;IACtB,KAAK,EAAE,IAAI;IACX,QAAQ,EAAE,IAAI;CACf,CAAC;AAEF,SAAS,cAAc,CAAC,GAAQ;IAC9B,OAAO,GAAG,IAAI,YAAY,CAAC;AAC7B,CAAC;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AAEH,SAAgB,eAAe,CAAC,OAAiB;IAC/C,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,GAAG,SAAS,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE,EAAE;QAC/E,0CAA0C;QAC1C,MAAM,YAAY,GAAG,IAAI;aACtB,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;aACvF,IAAI,CAAC,GAAG,CAAC,CAAC;QACb,mCAAmC;QACnC,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAS,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;YACtF,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;gBAAE,MAAM,KAAK,CAAC,sBAAsB,GAAG,EAAE,CAAC,CAAC;YACnE,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;gBAAE,OAAO,CAAC,QAAQ,IAAI,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACxF,OAAO,CAAC,QAAQ,IAAI,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;QACrD,CAAC,EAAE,EAAE,CAAC,CAAC;QACP,IAAI,QAAQ,KAAK,MAAM,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClD,OAAO,GAAG,QAAQ,GAAG,eAAe,KAAK,YAAY,EAAE,CAAC;QAC1D,CAAC;QACD,OAAO,SAAS,eAAe,KAAK,YAAY,KAAK,QAAQ,EAAE,CAAC;IAClE,CAAC,CAAC,CAAC;IACH,OAAO,IAAA,gDAAqB,EAAC,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 * Specify how the pin's position and label text.\n */\nexport interface Pin {\n  /** The coordinate of the pin. */\n  coordinate: LatLon;\n  /** The label text for the pin. */\n  label?: string;\n}\n\n/**\n * The pin options for default/none image style..\n */\nexport interface PinOptions {\n  /** The opacity of the pin. Range from 0 to 1 */\n  opacity?: number;\n  /**\n   * 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).\n   * To override the label anchor, using the _labelAnchor_ option and provide X and Y pixel coordinates for the anchor.\n   * 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.\n   * 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]\\}\n   * */\n  labelAnchor?: [number, number];\n  /** Color of the label. Range from 000000 to FFFFFF */\n  labelColor?: string;\n  /** Size of the label in pixels. */\n  labelSizeInPixels?: number;\n  /**\n   * 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.\n   * To override the anchor location of the pin image, use the _pinAnchor_ option. This uses the same format as the _labelAnchor_ options.\n   * 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]\\}\n   */\n  pinAnchor?: [number, number];\n  /** The ration of the pin. Range from -360 to 360*/\n  rotationInDegree?: number;\n  /** The scale of the pin. Should be greater than 0. */\n  scale?: number;\n  /** Color of the pin. Range from 000000 to FFFFFF */\n  pinColor?: string;\n}\n\nconst optionKeyMap: Record<keyof PinOptions, string> = {\n  opacity: \"al\",\n  labelAnchor: \"la\",\n  labelColor: \"lc\",\n  labelSizeInPixels: \"ls\",\n  pinAnchor: \"an\",\n  rotationInDegree: \"ro\",\n  scale: \"sc\",\n  pinColor: \"co\",\n};\n\nfunction isOptionKeyMap(key: any): key is keyof PinOptions {\n  return key in optionKeyMap;\n}\n\nexport interface PinSet {\n  pins: Pin[];\n  pinImage?: \"default\" | \"none\" | string;\n  options?: PinOptions;\n}\n/**\n * Create a pin query string for _get map static image_\n *\n * @example\n * ```ts snippet:ReadmeSampleCreatePinsQuery\n * import { DefaultAzureCredential } from \"@azure/identity\";\n * import MapsRender, { PinSet, createPinsQuery } 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 pins: PinSet[] = [\n *   {\n *     pins: [\n *       { coordinate: [52.577, 13.35], label: \"Label start\" },\n *       { coordinate: [52.6, 13.2988], label: \"Label end\" },\n *     ],\n *     pinImage: \"default\",\n *     options: {\n *       scale: 0.9,\n *       pinColor: \"FF0000\",\n *       labelColor: \"0000FF\",\n *       labelSizeInPixels: 18,\n *     },\n *   },\n * ];\n *\n * const path = createPinsQuery(pins);\n *\n * const response = await client\n *   .path(\"/map/static\")\n *   .get({\n *     queryParameters: {\n *       bbox: [13.228, 52.4559, 13.5794, 52.62],\n *       zoom: 10,\n *       path,\n *     },\n *     skipUrlEncoding: true,\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(\"pin.png\"));\n * ```\n *\n * @param pins - An array of {@link Pin} that specify the positions and label text of each pin.\n * @param pinImage - Specify the image source for custom pin. Set this to \"none\" if you don't want to show a pin image.\n * @param options - The style options of the pins. See {@link PinOptions}\n * @returns - The composed query string.\n */\n\nexport function createPinsQuery(pinSets: PinSet[]): string {\n  const pinsQueries = pinSets.map(({ pins, pinImage = \"default\", options = {} }) => {\n    // compose the pins' position query string\n    const pinsQueryStr = pins\n      .map(({ coordinate: [lat, lon], label }) => `${label ? `'${label}'` : \"\"}${lon} ${lat}`)\n      .join(\"|\");\n    // compose the options query string\n    const optionsQueryStr = Object.entries(options).reduce<string>((queryStr, [key, val]) => {\n      if (!isOptionKeyMap(key)) throw Error(`Unexpected option: ${key}`);\n      if (Array.isArray(val)) return (queryStr += `|${optionKeyMap[key]}${val[0]} ${val[1]}`);\n      return (queryStr += `|${optionKeyMap[key]}${val}`);\n    }, \"\");\n    if (pinImage === \"none\" || pinImage === \"default\") {\n      return `${pinImage}${optionsQueryStr}||${pinsQueryStr}`;\n    }\n    return `custom${optionsQueryStr}||${pinsQueryStr}||${pinImage}`;\n  });\n  return createMultiCollection(\"pins\", pinsQueries);\n}\n"]}

package/dist/commonjs/generated/clientDefinitions.d.ts

@@ -0,0 +1,131 @@
+import { RenderGetMapTileParameters, RenderGetMapTilesetParameters, RenderGetMapAttributionParameters, RenderGetMapStateTileParameters, RenderGetCopyrightCaptionParameters, RenderGetMapStaticImageParameters, RenderGetCopyrightFromBoundingBoxParameters, RenderGetCopyrightForTileParameters, RenderGetCopyrightForWorldParameters } from "./parameters.js";
+import { RenderGetMapTile200Response, RenderGetMapTileDefaultResponse, RenderGetMapTileset200Response, RenderGetMapTilesetDefaultResponse, RenderGetMapAttribution200Response, RenderGetMapAttributionDefaultResponse, RenderGetMapStateTile200Response, RenderGetMapStateTileDefaultResponse, RenderGetCopyrightCaption200Response, RenderGetCopyrightCaptionDefaultResponse, RenderGetMapStaticImage200Response, RenderGetMapStaticImageDefaultResponse, RenderGetCopyrightFromBoundingBox200Response, RenderGetCopyrightFromBoundingBoxDefaultResponse, RenderGetCopyrightForTile200Response, RenderGetCopyrightForTileDefaultResponse, RenderGetCopyrightForWorld200Response, RenderGetCopyrightForWorldDefaultResponse } from "./responses.js";
+import { Client, StreamableMethod } from "@azure-rest/core-client";
+export interface GetMapTile {
+    /**
+     *
+     * The `Get Map Tiles` API in an HTTP GET request that allows users to request map tiles in vector or raster formats 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://aka.ms/amcreator). By default,  Azure Maps uses vector tiles for its web map control ([Web SDK](/azure/azure-maps/about-azure-maps#web-sdk)) and [Android SDK](/azure/azure-maps/about-azure-maps#android-sdk).
+     */
+    get(options: RenderGetMapTileParameters): StreamableMethod<RenderGetMapTile200Response | RenderGetMapTileDefaultResponse>;
+}
+export interface GetMapTileset {
+    /**
+     *
+     * The Get Map Tileset API allows users to request metadata for a tileset.
+     */
+    get(options: RenderGetMapTilesetParameters): StreamableMethod<RenderGetMapTileset200Response | RenderGetMapTilesetDefaultResponse>;
+}
+export interface GetMapAttribution {
+    /**
+     *
+     * The `Get Map Attribution` API allows users to request map copyright attribution information for a section of a tileset.
+     */
+    get(options: RenderGetMapAttributionParameters): StreamableMethod<RenderGetMapAttribution200Response | RenderGetMapAttributionDefaultResponse>;
+}
+export interface GetMapStateTile {
+    /**
+     *
+     * Fetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid).
+     */
+    get(options: RenderGetMapStateTileParameters): StreamableMethod<RenderGetMapStateTile200Response | RenderGetMapStateTileDefaultResponse>;
+}
+export interface GetCopyrightCaption {
+    /**
+     *
+     * The `Get Copyright Caption` API is an HTTP GET request designed to serve copyright information to be used with tiles requested from the Render service. In addition to a basic copyright for the whole map, it can serve specific groups of copyrights for some countries/regions.
+     *
+     * As an alternative to copyrights for map request, it can also return captions for displaying provider information on the map.
+     */
+    get(options?: RenderGetCopyrightCaptionParameters): StreamableMethod<RenderGetCopyrightCaption200Response | RenderGetCopyrightCaptionDefaultResponse>;
+}
+export interface GetMapStaticImage {
+    /**
+     * This rendering API produces static, rasterized map views of a user-defined area. It's suitable for lightweight web applications, when the desired user experience doesn't require interactive map controls, or when bandwidth is limited. This API is also useful for embedding maps in applications outside of the browser, in backend services, report generation, or desktop applications.
+     *
+     *  This API includes parameters for basic data visualization:
+     *
+     * - Labeled pushpins in multiple styles.
+     * - Render circle, path, and polygon geometry types.
+     *
+     * For more information and detailed examples, see [Render custom data on a raster map](/azure/azure-maps/how-to-render-custom-data).
+     * <br><br>
+     * The dimensions of the bbox parameter are constrained, depending on the zoom level. This ensures the resulting image has an appropriate level of detail.
+     * <br><br>
+     *
+     *   |Zoom Level | Min Lon Range   | Max Lon Range   | Min Lat Range| Max Lat Range|
+     *   |:----------|:----------------|:----------------|:----------------|:-------------|
+     *   |0          | 56.25     | 360.0       | 30.1105585173    | 180.0        |
+     *   |1          | 28.125         | 360.0       | 14.87468995    | 180.0        |
+     *   |2         | 14.063       | 351.5625      |  7.4130741851    | 137.9576312246       |
+     *   |3     | 7.03125     | 175.78125    |  3.7034501005    |   73.6354071932     |
+     *   |4     | 3.515625    | 87.890625  | 1.8513375155  | 35.4776115315  |
+     *   |5          | 1.7578125  | 43.9453125  | 0.925620264 | 17.4589959239  |
+     *   |6       | 0.87890625 | 21.97265625 | 0.4628040687  | 8.6907788223  |
+     *   |7      | 0.439453125 |  10.986328125 | 0.2314012764  | 4.3404320789 |
+     *   |8       | 0.2197265625 | 5.4931640625 | 0.1157005434  | 2.1695927024  |
+     *   |9      | 0.1098632812 | 2.7465820312  |  0.0578502599  | 1.0847183194  |
+     *   |10    | 0.0549316406  | 1.3732910156 | 0.0289251285  | 0.5423494021  |
+     *   |11     | 0.0274658203 | 0.6866455078 | 0.014462564 | 0.2711734813 |
+     *   |12      |  0.0137329102  | 0.3433227539 | 0.007231282 | 0.1355865882  |
+     *   |13    | 0.0068664551 | 0.171661377 | 0.003615641 | 0.067793275 |
+     *   |14     |  0.0034332275  | 0.0858306885 | 0.0018078205 | 0.0338966351 |
+     *   |15     |  0.0017166138 | 0.0429153442 | 0.0009039102 | 0.0169483173 |
+     *   |16   |  0.0008583069  | 0.0214576721  |  0.0004519551  | 0.0084741586 |
+     *   |17  | 0.0004291534 |  0.0107288361  |  0.0002259776 | 0.0042370793 |
+     *   |18    | 0.0002145767 | 0.005364418 | 0.0001129888 | 0.0021185396 |
+     *   |19    | 0.0001072884  |  0.002682209  | 5.64944E-05 | 0.0010592698 |
+     *   |20    |  5.36442E-05  | 0.0013411045 | 2.82472E-05  | 0.0005296349 |
+     *
+     * _Note_ : Either **center** or **bbox** parameter must be supplied to the API.
+     */
+    get(options?: RenderGetMapStaticImageParameters): StreamableMethod<RenderGetMapStaticImage200Response | RenderGetMapStaticImageDefaultResponse>;
+}
+export interface GetCopyrightFromBoundingBox {
+    /**
+     *
+     * Returns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates
+     */
+    get(options: RenderGetCopyrightFromBoundingBoxParameters): StreamableMethod<RenderGetCopyrightFromBoundingBox200Response | RenderGetCopyrightFromBoundingBoxDefaultResponse>;
+}
+export interface GetCopyrightForTile {
+    /**
+     *
+     * To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates. For more information, see [Zoom Levels and Tile Grid](/azure/azure-maps/zoom-levels-and-tile-grid).
+     *
+     * Copyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.
+     */
+    get(options: RenderGetCopyrightForTileParameters): StreamableMethod<RenderGetCopyrightForTile200Response | RenderGetCopyrightForTileDefaultResponse>;
+}
+export interface GetCopyrightForWorld {
+    /**
+     *
+     * Returns the copyright information for the world. To obtain the default copyright information for the whole world, don't specify a tile or bounding box.
+     *
+     * Copyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.
+     */
+    get(options?: RenderGetCopyrightForWorldParameters): StreamableMethod<RenderGetCopyrightForWorld200Response | RenderGetCopyrightForWorldDefaultResponse>;
+}
+export interface Routes {
+    /** Resource for '/map/tile' has methods for the following verbs: get */
+    (path: "/map/tile"): GetMapTile;
+    /** Resource for '/map/tileset' has methods for the following verbs: get */
+    (path: "/map/tileset"): GetMapTileset;
+    /** Resource for '/map/attribution' has methods for the following verbs: get */
+    (path: "/map/attribution"): GetMapAttribution;
+    /** Resource for '/map/statetile' has methods for the following verbs: get */
+    (path: "/map/statetile"): GetMapStateTile;
+    /** Resource for '/map/copyright/caption/\{format\}' has methods for the following verbs: get */
+    (path: "/map/copyright/caption/{format}", format: "json" | "xml"): GetCopyrightCaption;
+    /** Resource for '/map/static' has methods for the following verbs: get */
+    (path: "/map/static"): GetMapStaticImage;
+    /** Resource for '/map/copyright/bounding/\{format\}' has methods for the following verbs: get */
+    (path: "/map/copyright/bounding/{format}", format: "json" | "xml"): GetCopyrightFromBoundingBox;
+    /** Resource for '/map/copyright/tile/\{format\}' has methods for the following verbs: get */
+    (path: "/map/copyright/tile/{format}", format: "json" | "xml"): GetCopyrightForTile;
+    /** Resource for '/map/copyright/world/\{format\}' has methods for the following verbs: get */
+    (path: "/map/copyright/world/{format}", format: "json" | "xml"): GetCopyrightForWorld;
+}
+export type MapsRenderClient = Client & {
+    path: Routes;
+};
+//# sourceMappingURL=clientDefinitions.d.ts.map

package/dist/commonjs/generated/clientDefinitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientDefinitions.d.ts","sourceRoot":"","sources":["../../../src/generated/clientDefinitions.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,0BAA0B,EAC1B,6BAA6B,EAC7B,iCAAiC,EACjC,+BAA+B,EAC/B,mCAAmC,EACnC,iCAAiC,EACjC,2CAA2C,EAC3C,mCAAmC,EACnC,oCAAoC,EACrC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,2BAA2B,EAC3B,+BAA+B,EAC/B,8BAA8B,EAC9B,kCAAkC,EAClC,kCAAkC,EAClC,sCAAsC,EACtC,gCAAgC,EAChC,oCAAoC,EACpC,oCAAoC,EACpC,wCAAwC,EACxC,kCAAkC,EAClC,sCAAsC,EACtC,4CAA4C,EAC5C,gDAAgD,EAChD,oCAAoC,EACpC,wCAAwC,EACxC,qCAAqC,EACrC,yCAAyC,EAC1C,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEnE,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,GAAG,CACD,OAAO,EAAE,0BAA0B,GAClC,gBAAgB,CACjB,2BAA2B,GAAG,+BAA+B,CAC9D,CAAC;CACH;AAED,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,GAAG,CACD,OAAO,EAAE,6BAA6B,GACrC,gBAAgB,CACjB,8BAA8B,GAAG,kCAAkC,CACpE,CAAC;CACH;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,GAAG,CACD,OAAO,EAAE,iCAAiC,GACzC,gBAAgB,CACjB,kCAAkC,GAAG,sCAAsC,CAC5E,CAAC;CACH;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,GAAG,CACD,OAAO,EAAE,+BAA+B,GACvC,gBAAgB,CACjB,gCAAgC,GAAG,oCAAoC,CACxE,CAAC;CACH;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,mCAAmC,GAC5C,gBAAgB,CACf,oCAAoC,GACpC,wCAAwC,CAC3C,CAAC;CACH;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,iCAAiC,GAC1C,gBAAgB,CACjB,kCAAkC,GAAG,sCAAsC,CAC5E,CAAC;CACH;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,GAAG,CACD,OAAO,EAAE,2CAA2C,GACnD,gBAAgB,CACf,4CAA4C,GAC5C,gDAAgD,CACnD,CAAC;CACH;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,GAAG,CACD,OAAO,EAAE,mCAAmC,GAC3C,gBAAgB,CACf,oCAAoC,GACpC,wCAAwC,CAC3C,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,oCAAoC,GAC7C,gBAAgB,CACf,qCAAqC,GACrC,yCAAyC,CAC5C,CAAC;CACH;AAED,MAAM,WAAW,MAAM;IACrB,wEAAwE;IACxE,CAAC,IAAI,EAAE,WAAW,GAAG,UAAU,CAAC;IAChC,2EAA2E;IAC3E,CAAC,IAAI,EAAE,cAAc,GAAG,aAAa,CAAC;IACtC,+EAA+E;IAC/E,CAAC,IAAI,EAAE,kBAAkB,GAAG,iBAAiB,CAAC;IAC9C,6EAA6E;IAC7E,CAAC,IAAI,EAAE,gBAAgB,GAAG,eAAe,CAAC;IAC1C,gGAAgG;IAChG,CACE,IAAI,EAAE,iCAAiC,EACvC,MAAM,EAAE,MAAM,GAAG,KAAK,GACrB,mBAAmB,CAAC;IACvB,0EAA0E;IAC1E,CAAC,IAAI,EAAE,aAAa,GAAG,iBAAiB,CAAC;IACzC,iGAAiG;IACjG,CACE,IAAI,EAAE,kCAAkC,EACxC,MAAM,EAAE,MAAM,GAAG,KAAK,GACrB,2BAA2B,CAAC;IAC/B,6FAA6F;IAC7F,CACE,IAAI,EAAE,8BAA8B,EACpC,MAAM,EAAE,MAAM,GAAG,KAAK,GACrB,mBAAmB,CAAC;IACvB,8FAA8F;IAC9F,CACE,IAAI,EAAE,+BAA+B,EACrC,MAAM,EAAE,MAAM,GAAG,KAAK,GACrB,oBAAoB,CAAC;CACzB;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG;IACtC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/commonjs/generated/clientDefinitions.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=clientDefinitions.js.map

package/dist/commonjs/generated/clientDefinitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientDefinitions.js","sourceRoot":"","sources":["../../../src/generated/clientDefinitions.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n  RenderGetMapTileParameters,\n  RenderGetMapTilesetParameters,\n  RenderGetMapAttributionParameters,\n  RenderGetMapStateTileParameters,\n  RenderGetCopyrightCaptionParameters,\n  RenderGetMapStaticImageParameters,\n  RenderGetCopyrightFromBoundingBoxParameters,\n  RenderGetCopyrightForTileParameters,\n  RenderGetCopyrightForWorldParameters,\n} from \"./parameters.js\";\nimport {\n  RenderGetMapTile200Response,\n  RenderGetMapTileDefaultResponse,\n  RenderGetMapTileset200Response,\n  RenderGetMapTilesetDefaultResponse,\n  RenderGetMapAttribution200Response,\n  RenderGetMapAttributionDefaultResponse,\n  RenderGetMapStateTile200Response,\n  RenderGetMapStateTileDefaultResponse,\n  RenderGetCopyrightCaption200Response,\n  RenderGetCopyrightCaptionDefaultResponse,\n  RenderGetMapStaticImage200Response,\n  RenderGetMapStaticImageDefaultResponse,\n  RenderGetCopyrightFromBoundingBox200Response,\n  RenderGetCopyrightFromBoundingBoxDefaultResponse,\n  RenderGetCopyrightForTile200Response,\n  RenderGetCopyrightForTileDefaultResponse,\n  RenderGetCopyrightForWorld200Response,\n  RenderGetCopyrightForWorldDefaultResponse,\n} from \"./responses.js\";\nimport { Client, StreamableMethod } from \"@azure-rest/core-client\";\n\nexport interface GetMapTile {\n  /**\n   *\n   * The `Get Map Tiles` API in an HTTP GET request that allows users to request map tiles in vector or raster formats 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://aka.ms/amcreator). By default,  Azure Maps uses vector tiles for its web map control ([Web SDK](/azure/azure-maps/about-azure-maps#web-sdk)) and [Android SDK](/azure/azure-maps/about-azure-maps#android-sdk).\n   */\n  get(\n    options: RenderGetMapTileParameters,\n  ): StreamableMethod<\n    RenderGetMapTile200Response | RenderGetMapTileDefaultResponse\n  >;\n}\n\nexport interface GetMapTileset {\n  /**\n   *\n   * The Get Map Tileset API allows users to request metadata for a tileset.\n   */\n  get(\n    options: RenderGetMapTilesetParameters,\n  ): StreamableMethod<\n    RenderGetMapTileset200Response | RenderGetMapTilesetDefaultResponse\n  >;\n}\n\nexport interface GetMapAttribution {\n  /**\n   *\n   * The `Get Map Attribution` API allows users to request map copyright attribution information for a section of a tileset.\n   */\n  get(\n    options: RenderGetMapAttributionParameters,\n  ): StreamableMethod<\n    RenderGetMapAttribution200Response | RenderGetMapAttributionDefaultResponse\n  >;\n}\n\nexport interface GetMapStateTile {\n  /**\n   *\n   * Fetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid).\n   */\n  get(\n    options: RenderGetMapStateTileParameters,\n  ): StreamableMethod<\n    RenderGetMapStateTile200Response | RenderGetMapStateTileDefaultResponse\n  >;\n}\n\nexport interface GetCopyrightCaption {\n  /**\n   *\n   * The `Get Copyright Caption` API is an HTTP GET request designed to serve copyright information to be used with tiles requested from the Render service. In addition to a basic copyright for the whole map, it can serve specific groups of copyrights for some countries/regions.\n   *\n   * As an alternative to copyrights for map request, it can also return captions for displaying provider information on the map.\n   */\n  get(\n    options?: RenderGetCopyrightCaptionParameters,\n  ): StreamableMethod<\n    | RenderGetCopyrightCaption200Response\n    | RenderGetCopyrightCaptionDefaultResponse\n  >;\n}\n\nexport interface GetMapStaticImage {\n  /**\n   * This rendering API produces static, rasterized map views of a user-defined area. It's suitable for lightweight web applications, when the desired user experience doesn't require interactive map controls, or when bandwidth is limited. This API is also useful for embedding maps in applications outside of the browser, in backend services, report generation, or desktop applications.\n   *\n   *  This API includes parameters for basic data visualization:\n   *\n   * - Labeled pushpins in multiple styles.\n   * - Render circle, path, and polygon geometry types.\n   *\n   * For more information and detailed examples, see [Render custom data on a raster map](/azure/azure-maps/how-to-render-custom-data).\n   * <br><br>\n   * The dimensions of the bbox parameter are constrained, depending on the zoom level. This ensures the resulting image has an appropriate level of detail.\n   * <br><br>\n   *\n   *   |Zoom Level | Min Lon Range   | Max Lon Range   | Min Lat Range| Max Lat Range|\n   *   |:----------|:----------------|:----------------|:----------------|:-------------|\n   *   |0          | 56.25     | 360.0       | 30.1105585173    | 180.0        |\n   *   |1          | 28.125         | 360.0       | 14.87468995    | 180.0        |\n   *   |2         | 14.063       | 351.5625      |  7.4130741851    | 137.9576312246       |\n   *   |3     | 7.03125     | 175.78125    |  3.7034501005    |   73.6354071932     |\n   *   |4     | 3.515625    | 87.890625  | 1.8513375155  | 35.4776115315  |\n   *   |5          | 1.7578125  | 43.9453125  | 0.925620264 | 17.4589959239  |\n   *   |6       | 0.87890625 | 21.97265625 | 0.4628040687  | 8.6907788223  |\n   *   |7      | 0.439453125 |  10.986328125 | 0.2314012764  | 4.3404320789 |\n   *   |8       | 0.2197265625 | 5.4931640625 | 0.1157005434  | 2.1695927024  |\n   *   |9      | 0.1098632812 | 2.7465820312  |  0.0578502599  | 1.0847183194  |\n   *   |10    | 0.0549316406  | 1.3732910156 | 0.0289251285  | 0.5423494021  |\n   *   |11     | 0.0274658203 | 0.6866455078 | 0.014462564 | 0.2711734813 |\n   *   |12      |  0.0137329102  | 0.3433227539 | 0.007231282 | 0.1355865882  |\n   *   |13    | 0.0068664551 | 0.171661377 | 0.003615641 | 0.067793275 |\n   *   |14     |  0.0034332275  | 0.0858306885 | 0.0018078205 | 0.0338966351 |\n   *   |15     |  0.0017166138 | 0.0429153442 | 0.0009039102 | 0.0169483173 |\n   *   |16   |  0.0008583069  | 0.0214576721  |  0.0004519551  | 0.0084741586 |\n   *   |17  | 0.0004291534 |  0.0107288361  |  0.0002259776 | 0.0042370793 |\n   *   |18    | 0.0002145767 | 0.005364418 | 0.0001129888 | 0.0021185396 |\n   *   |19    | 0.0001072884  |  0.002682209  | 5.64944E-05 | 0.0010592698 |\n   *   |20    |  5.36442E-05  | 0.0013411045 | 2.82472E-05  | 0.0005296349 |\n   *\n   * _Note_ : Either **center** or **bbox** parameter must be supplied to the API.\n   */\n  get(\n    options?: RenderGetMapStaticImageParameters,\n  ): StreamableMethod<\n    RenderGetMapStaticImage200Response | RenderGetMapStaticImageDefaultResponse\n  >;\n}\n\nexport interface GetCopyrightFromBoundingBox {\n  /**\n   *\n   * Returns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates\n   */\n  get(\n    options: RenderGetCopyrightFromBoundingBoxParameters,\n  ): StreamableMethod<\n    | RenderGetCopyrightFromBoundingBox200Response\n    | RenderGetCopyrightFromBoundingBoxDefaultResponse\n  >;\n}\n\nexport interface GetCopyrightForTile {\n  /**\n   *\n   * To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates. For more information, see [Zoom Levels and Tile Grid](/azure/azure-maps/zoom-levels-and-tile-grid).\n   *\n   * Copyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.\n   */\n  get(\n    options: RenderGetCopyrightForTileParameters,\n  ): StreamableMethod<\n    | RenderGetCopyrightForTile200Response\n    | RenderGetCopyrightForTileDefaultResponse\n  >;\n}\n\nexport interface GetCopyrightForWorld {\n  /**\n   *\n   * Returns the copyright information for the world. To obtain the default copyright information for the whole world, don't specify a tile or bounding box.\n   *\n   * Copyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.\n   */\n  get(\n    options?: RenderGetCopyrightForWorldParameters,\n  ): StreamableMethod<\n    | RenderGetCopyrightForWorld200Response\n    | RenderGetCopyrightForWorldDefaultResponse\n  >;\n}\n\nexport interface Routes {\n  /** Resource for '/map/tile' has methods for the following verbs: get */\n  (path: \"/map/tile\"): GetMapTile;\n  /** Resource for '/map/tileset' has methods for the following verbs: get */\n  (path: \"/map/tileset\"): GetMapTileset;\n  /** Resource for '/map/attribution' has methods for the following verbs: get */\n  (path: \"/map/attribution\"): GetMapAttribution;\n  /** Resource for '/map/statetile' has methods for the following verbs: get */\n  (path: \"/map/statetile\"): GetMapStateTile;\n  /** Resource for '/map/copyright/caption/\\{format\\}' has methods for the following verbs: get */\n  (\n    path: \"/map/copyright/caption/{format}\",\n    format: \"json\" | \"xml\",\n  ): GetCopyrightCaption;\n  /** Resource for '/map/static' has methods for the following verbs: get */\n  (path: \"/map/static\"): GetMapStaticImage;\n  /** Resource for '/map/copyright/bounding/\\{format\\}' has methods for the following verbs: get */\n  (\n    path: \"/map/copyright/bounding/{format}\",\n    format: \"json\" | \"xml\",\n  ): GetCopyrightFromBoundingBox;\n  /** Resource for '/map/copyright/tile/\\{format\\}' has methods for the following verbs: get */\n  (\n    path: \"/map/copyright/tile/{format}\",\n    format: \"json\" | \"xml\",\n  ): GetCopyrightForTile;\n  /** Resource for '/map/copyright/world/\\{format\\}' has methods for the following verbs: get */\n  (\n    path: \"/map/copyright/world/{format}\",\n    format: \"json\" | \"xml\",\n  ): GetCopyrightForWorld;\n}\n\nexport type MapsRenderClient = Client & {\n  path: Routes;\n};\n"]}