@azure/maps-common 1.0.0-beta.1 → 1.0.0-beta.2

package/README.md

@@ -9,6 +9,7 @@ This package contains common code that needs to be shared among the other Azure
 The following client libraries use this package:
 
 - @azure/maps-search
+- @azure-rest/maps-route
 
 ## Getting started
 

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@azure/maps-common",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.2",
   "description": "An internal shared package for Azure Maps TypeScript SDK",
   "sdk-type": "client",
   "main": "dist/index.js",
   "module": "dist-esm/index.js",
-  "types": "types/maps-common.d.ts",
+  "types": "types/latest/maps-common.d.ts",
   "typesVersions": {
     "<3.6": {
       "*": [
-        "types/3.1/index.d.ts"
+        "types/3.1/maps-common.d.ts"
       ]
     }
   },
@@ -53,7 +53,7 @@
   ],
   "repository": "github:Azure/azure-sdk-for-js",
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "keywords": [
     "azure",
@@ -81,11 +81,11 @@
     "@azure/test-utils": "^1.0.0",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@azure/dev-tool": "^1.0.0",
-    "@microsoft/api-extractor": "7.18.11",
+    "@microsoft/api-extractor": "^7.31.1",
     "downlevel-dts": "^0.8.0",
     "eslint": "^8.0.0",
     "prettier": "^2.5.1",
     "rimraf": "^3.0.0",
-    "typescript": "~4.6.0"
+    "typescript": "~4.8.0"
   }
 }

package/types/3.1/maps-common.d.ts

@@ -0,0 +1,162 @@
+import { KeyCredential } from '@azure/core-auth';
+import { LroResponse } from '@azure/core-lro';
+import { OperationOptions } from '@azure/core-client';
+import { OperationSpec } from '@azure/core-client';
+import { PipelinePolicy } from '@azure/core-rest-pipeline';
+import { ServiceClient } from '@azure/core-client';
+/** Bounding box including information on the coordinate range for its geometries */
+export declare type BBox = BBox2D | BBox3D;
+/** 2D bounding box */
+export declare type BBox2D = [
+    /*southWestLongitude*/ number,
+    /*southWestLatitude*/ number,
+    /*northEastLongitude*/ number,
+    /*northEastLatitude*/ number
+];
+/** 3D bounding box */
+export declare type BBox3D = [
+    /*southWestLongitude*/ number,
+    /*southWestLatitude*/ number,
+    /*southWestElevation*/ number,
+    /*northEastLongitude*/ number,
+    /*northEastLatitude*/ number,
+    /*northEastElevation*/ number
+];
+/**
+ * Bounding Box
+ */
+export declare interface BoundingBox {
+    /** Top left corner of the bounding box */
+    topLeft: LatLon;
+    /** Bottom right corner of the bounding box */
+    bottomRight: LatLon;
+}
+/**
+ * Create an HTTP pipeline policy to authenticate a request
+ * using an `AzureKeyCredential` for Azure Maps
+ */
+export declare function createAzureMapsKeyCredentialPolicy(azureKeyCredential: KeyCredential): PipelinePolicy;
+/**
+ * Create an HTTP pipeline policy to add x-ms-client-id header
+ * for `TokenCredential` based authentication for Azure Maps
+ */
+export declare function createMapsClientIdPolicy(mapsClientId: string): PipelinePolicy;
+/**
+ * Helper function to create a method that can be passed to sendPollRequest in createHttpPoller.
+ *
+ * @param settings - The settings of the poll request, including client, options and the spec
+ * @returns A callback that accept the path as input and return the promise of Lro response.
+ */
+export declare function createSendPollRequest<TOptions extends OperationOptions, TClient extends ServiceClient>(settings: {
+    client: TClient;
+    options: TOptions;
+    spec: OperationSpec;
+}): (path: string) => Promise<LroResponse<unknown>>;
+/**
+ * GeoJSON Feature
+ * A Feature object represents a spatially bounded thing.  Every Feature
+ object is a GeoJSON object. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.2)
+ */
+export declare interface GeoJsonFeature extends GeoJsonObject {
+    type: "Feature";
+    geometry?: GeoJsonGeometry;
+    properties?: Record<string, any>;
+    id?: number | string;
+}
+/** GeoJSON FeatureCollection. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.3) */
+export declare interface GeoJsonFeatureCollection extends GeoJsonObject {
+    type: "FeatureCollection";
+    features: GeoJsonFeature[];
+}
+/** GeoJSON Geometry */
+export declare type GeoJsonGeometry = GeoJsonPoint | GeoJsonMultiPoint | GeoJsonLineString | GeoJsonMultiLineString | GeoJsonPolygon | GeoJsonMultiPolygon;
+/** GeoJSON GeometryCollection. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.8) */
+export declare interface GeoJsonGeometryCollection extends GeoJsonObject {
+    type: "GeometryCollection";
+    geometries: GeoJsonGeometry[];
+}
+/** GeoJSON LineString. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.4) */
+export declare interface GeoJsonLineString extends GeoJsonObject {
+    type: "LineString";
+    /** For type "LineString", the "coordinates" member is an array of two or more positions. */
+    coordinates: Position[];
+}
+/** GeoJSON MultiLineString. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.5) */
+export declare interface GeoJsonMultiLineString extends GeoJsonObject {
+    type: "MultiLineString";
+    /** For type "MultiLineString", the "coordinates" member is an array of LineString coordinate arrays. */
+    coordinates: Position[][];
+}
+/** GeoJSON MultiPoint. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.3) */
+export declare interface GeoJsonMultiPoint extends GeoJsonObject {
+    type: "MultiPoint";
+    /** For type "MultiPoint", the "coordinates" member is an array of positions. */
+    coordinates: Position[];
+}
+/** GeoJSON MultiPolygon. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.7) */
+export declare interface GeoJsonMultiPolygon extends GeoJsonObject {
+    type: "MultiPolygon";
+    /** For type "MultiPolygon", the "coordinates" member is an array of Polygon coordinate arrays. */
+    coordinates: Position[][][];
+}
+/** A GeoJSON object represents a Geometry, Feature, or collection of
+ Features. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3) */
+export declare interface GeoJsonObject {
+    /** Representing the type of this GeoJSON object, including the seven geometry type and "Feature", "FeatureCollection". [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-1.4) */
+    type: GeoJsonType;
+    /** Include information on the coordinate range for its Geometries, Features, or FeatureCollections. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-5) */
+    bbox?: BBox;
+}
+/** GeoJSON Point. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.2) */
+export declare interface GeoJsonPoint extends GeoJsonObject {
+    type: "Point";
+    /** For type "Point", the "coordinates" member is a single position. */
+    coordinates: Position;
+}
+/**
+ * GeoJSON Polygon. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.6)
+ *
+ * To specify a constraint specific to Polygons, it is useful to introduce the concept of a linear ring:
+ *  - A linear ring is a closed LineString with four or more positions.
+ *  - The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
+ *  - A linear ring is the boundary of a surface or the boundary of a hole in a surface.
+ *  - A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
+ * */
+export declare interface GeoJsonPolygon extends GeoJsonObject {
+    type: "Polygon";
+    /** For type "Polygon", the "coordinates" member MUST be an array of linear ring coordinate arrays. */
+    coordinates: Position[][];
+}
+/** GeoJSON types */
+export declare type GeoJsonType = GeometryType | "Feature" | "FeatureCollection";
+/** Geometry types */
+export declare type GeometryType = "Point" | "MultiPoint" | "LineString" | "MultiLineString" | "Polygon" | "MultiPolygon" | "GeometryCollection";
+/**
+ * Extract several fields of the response to the rawResponse
+ *
+ * @param getResponse - A async function that actually call the backend API.
+ * @param options - The options for the getResponse callback
+ * @returns A promise for the API call.
+ */
+export declare function getRawResponse<TOptions extends OperationOptions, TResponse>(getResponse: (options: TOptions) => Promise<TResponse>, options: TOptions): Promise<LroResponse<TResponse>>;
+/**
+ * Latitude/Longitude Pair
+ */
+export declare type LatLon = [
+    /*latitude*/ number,
+    /*longitude*/ number
+];
+/** An array of number representing a point */
+export declare type Position = Position2D | Position3D;
+/** 2D position */
+export declare type Position2D = [
+    /*longitude*/ number,
+    /*latitude*/ number
+];
+/** 3D position */
+export declare type Position3D = [
+    /*longitude*/ number,
+    /*latitude*/ number,
+    /*elevation*/ number
+];
+export {};

package/types/latest/maps-common.d.ts

@@ -0,0 +1,178 @@
+import { KeyCredential } from '@azure/core-auth';
+import { LroResponse } from '@azure/core-lro';
+import { OperationOptions } from '@azure/core-client';
+import { OperationSpec } from '@azure/core-client';
+import { PipelinePolicy } from '@azure/core-rest-pipeline';
+import { ServiceClient } from '@azure/core-client';
+
+/** Bounding box including information on the coordinate range for its geometries */
+export declare type BBox = BBox2D | BBox3D;
+
+/** 2D bounding box */
+export declare type BBox2D = [
+southWestLongitude: number,
+southWestLatitude: number,
+northEastLongitude: number,
+northEastLatitude: number
+];
+
+/** 3D bounding box */
+export declare type BBox3D = [
+southWestLongitude: number,
+southWestLatitude: number,
+southWestElevation: number,
+northEastLongitude: number,
+northEastLatitude: number,
+northEastElevation: number
+];
+
+/**
+ * Bounding Box
+ */
+export declare interface BoundingBox {
+    /** Top left corner of the bounding box */
+    topLeft: LatLon;
+    /** Bottom right corner of the bounding box */
+    bottomRight: LatLon;
+}
+
+/**
+ * Create an HTTP pipeline policy to authenticate a request
+ * using an `AzureKeyCredential` for Azure Maps
+ */
+export declare function createAzureMapsKeyCredentialPolicy(azureKeyCredential: KeyCredential): PipelinePolicy;
+
+/**
+ * Create an HTTP pipeline policy to add x-ms-client-id header
+ * for `TokenCredential` based authentication for Azure Maps
+ */
+export declare function createMapsClientIdPolicy(mapsClientId: string): PipelinePolicy;
+
+/**
+ * Helper function to create a method that can be passed to sendPollRequest in createHttpPoller.
+ *
+ * @param settings - The settings of the poll request, including client, options and the spec
+ * @returns A callback that accept the path as input and return the promise of Lro response.
+ */
+export declare function createSendPollRequest<TOptions extends OperationOptions, TClient extends ServiceClient>(settings: {
+    client: TClient;
+    options: TOptions;
+    spec: OperationSpec;
+}): (path: string) => Promise<LroResponse<unknown>>;
+
+/**
+ * GeoJSON Feature
+ * A Feature object represents a spatially bounded thing.  Every Feature
+ object is a GeoJSON object. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.2)
+ */
+export declare interface GeoJsonFeature extends GeoJsonObject {
+    type: "Feature";
+    geometry?: GeoJsonGeometry;
+    properties?: Record<string, any>;
+    id?: number | string;
+}
+
+/** GeoJSON FeatureCollection. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.3) */
+export declare interface GeoJsonFeatureCollection extends GeoJsonObject {
+    type: "FeatureCollection";
+    features: GeoJsonFeature[];
+}
+
+/** GeoJSON Geometry */
+export declare type GeoJsonGeometry = GeoJsonPoint | GeoJsonMultiPoint | GeoJsonLineString | GeoJsonMultiLineString | GeoJsonPolygon | GeoJsonMultiPolygon;
+
+/** GeoJSON GeometryCollection. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.8) */
+export declare interface GeoJsonGeometryCollection extends GeoJsonObject {
+    type: "GeometryCollection";
+    geometries: GeoJsonGeometry[];
+}
+
+/** GeoJSON LineString. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.4) */
+export declare interface GeoJsonLineString extends GeoJsonObject {
+    type: "LineString";
+    /** For type "LineString", the "coordinates" member is an array of two or more positions. */
+    coordinates: Position[];
+}
+
+/** GeoJSON MultiLineString. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.5) */
+export declare interface GeoJsonMultiLineString extends GeoJsonObject {
+    type: "MultiLineString";
+    /** For type "MultiLineString", the "coordinates" member is an array of LineString coordinate arrays. */
+    coordinates: Position[][];
+}
+
+/** GeoJSON MultiPoint. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.3) */
+export declare interface GeoJsonMultiPoint extends GeoJsonObject {
+    type: "MultiPoint";
+    /** For type "MultiPoint", the "coordinates" member is an array of positions. */
+    coordinates: Position[];
+}
+
+/** GeoJSON MultiPolygon. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.7) */
+export declare interface GeoJsonMultiPolygon extends GeoJsonObject {
+    type: "MultiPolygon";
+    /** For type "MultiPolygon", the "coordinates" member is an array of Polygon coordinate arrays. */
+    coordinates: Position[][][];
+}
+
+/** A GeoJSON object represents a Geometry, Feature, or collection of
+ Features. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3) */
+export declare interface GeoJsonObject {
+    /** Representing the type of this GeoJSON object, including the seven geometry type and "Feature", "FeatureCollection". [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-1.4) */
+    type: GeoJsonType;
+    /** Include information on the coordinate range for its Geometries, Features, or FeatureCollections. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-5) */
+    bbox?: BBox;
+}
+
+/** GeoJSON Point. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.2) */
+export declare interface GeoJsonPoint extends GeoJsonObject {
+    type: "Point";
+    /** For type "Point", the "coordinates" member is a single position. */
+    coordinates: Position;
+}
+
+/**
+ * GeoJSON Polygon. [Reference](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.6)
+ *
+ * To specify a constraint specific to Polygons, it is useful to introduce the concept of a linear ring:
+ *  - A linear ring is a closed LineString with four or more positions.
+ *  - The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
+ *  - A linear ring is the boundary of a surface or the boundary of a hole in a surface.
+ *  - A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
+ * */
+export declare interface GeoJsonPolygon extends GeoJsonObject {
+    type: "Polygon";
+    /** For type "Polygon", the "coordinates" member MUST be an array of linear ring coordinate arrays. */
+    coordinates: Position[][];
+}
+
+/** GeoJSON types */
+export declare type GeoJsonType = GeometryType | "Feature" | "FeatureCollection";
+
+/** Geometry types */
+export declare type GeometryType = "Point" | "MultiPoint" | "LineString" | "MultiLineString" | "Polygon" | "MultiPolygon" | "GeometryCollection";
+
+/**
+ * Extract several fields of the response to the rawResponse
+ *
+ * @param getResponse - A async function that actually call the backend API.
+ * @param options - The options for the getResponse callback
+ * @returns A promise for the API call.
+ */
+export declare function getRawResponse<TOptions extends OperationOptions, TResponse>(getResponse: (options: TOptions) => Promise<TResponse>, options: TOptions): Promise<LroResponse<TResponse>>;
+
+/**
+ * Latitude/Longitude Pair
+ */
+export declare type LatLon = [latitude: number, longitude: number];
+
+/** An array of number representing a point */
+export declare type Position = Position2D | Position3D;
+
+/** 2D position */
+export declare type Position2D = [longitude: number, latitude: number];
+
+/** 3D position */
+export declare type Position3D = [longitude: number, latitude: number, elevation: number];
+
+export { }

package/types/latest/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.33.5"
+    }
+  ]
+}