@azure/arm-maps 2.0.0 → 3.0.0-alpha.20220131.1

package/review/arm-maps.api.md

@@ -0,0 +1,423 @@
+## API Report File for "@azure/arm-maps"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+
+// @public
+export interface Accounts {
+    createOrUpdate(resourceGroupName: string, accountName: string, mapsAccount: MapsAccount, options?: AccountsCreateOrUpdateOptionalParams): Promise<AccountsCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, accountName: string, options?: AccountsGetOptionalParams): Promise<AccountsGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: AccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<MapsAccount>;
+    listBySubscription(options?: AccountsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<MapsAccount>;
+    listKeys(resourceGroupName: string, accountName: string, options?: AccountsListKeysOptionalParams): Promise<AccountsListKeysResponse>;
+    regenerateKeys(resourceGroupName: string, accountName: string, keySpecification: MapsKeySpecification, options?: AccountsRegenerateKeysOptionalParams): Promise<AccountsRegenerateKeysResponse>;
+    update(resourceGroupName: string, accountName: string, mapsAccountUpdateParameters: MapsAccountUpdateParameters, options?: AccountsUpdateOptionalParams): Promise<AccountsUpdateResponse>;
+}
+
+// @public
+export interface AccountsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccountsCreateOrUpdateResponse = MapsAccount;
+
+// @public
+export interface AccountsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface AccountsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccountsGetResponse = MapsAccount;
+
+// @public
+export interface AccountsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccountsListByResourceGroupNextResponse = MapsAccounts;
+
+// @public
+export interface AccountsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccountsListByResourceGroupResponse = MapsAccounts;
+
+// @public
+export interface AccountsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccountsListBySubscriptionNextResponse = MapsAccounts;
+
+// @public
+export interface AccountsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccountsListBySubscriptionResponse = MapsAccounts;
+
+// @public
+export interface AccountsListKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccountsListKeysResponse = MapsAccountKeys;
+
+// @public
+export interface AccountsRegenerateKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccountsRegenerateKeysResponse = MapsAccountKeys;
+
+// @public
+export interface AccountsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccountsUpdateResponse = MapsAccount;
+
+// @public (undocumented)
+export class AzureMapsManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureMapsManagementClientOptionalParams);
+    // (undocumented)
+    accounts: Accounts;
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    creators: Creators;
+    // (undocumented)
+    maps: Maps;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface AzureMapsManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export type Creator = TrackedResource & {
+    properties: CreatorProperties;
+};
+
+// @public
+export interface CreatorList {
+    nextLink?: string;
+    readonly value?: Creator[];
+}
+
+// @public
+export interface CreatorProperties {
+    readonly provisioningState?: string;
+    storageUnits: number;
+}
+
+// @public
+export interface Creators {
+    createOrUpdate(resourceGroupName: string, accountName: string, creatorName: string, creatorResource: Creator, options?: CreatorsCreateOrUpdateOptionalParams): Promise<CreatorsCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, accountName: string, creatorName: string, options?: CreatorsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, accountName: string, creatorName: string, options?: CreatorsGetOptionalParams): Promise<CreatorsGetResponse>;
+    listByAccount(resourceGroupName: string, accountName: string, options?: CreatorsListByAccountOptionalParams): PagedAsyncIterableIterator<Creator>;
+    update(resourceGroupName: string, accountName: string, creatorName: string, creatorUpdateParameters: CreatorUpdateParameters, options?: CreatorsUpdateOptionalParams): Promise<CreatorsUpdateResponse>;
+}
+
+// @public
+export interface CreatorsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CreatorsCreateOrUpdateResponse = Creator;
+
+// @public
+export interface CreatorsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface CreatorsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CreatorsGetResponse = Creator;
+
+// @public
+export interface CreatorsListByAccountNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CreatorsListByAccountNextResponse = CreatorList;
+
+// @public
+export interface CreatorsListByAccountOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CreatorsListByAccountResponse = CreatorList;
+
+// @public
+export interface CreatorsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CreatorsUpdateResponse = Creator;
+
+// @public
+export interface CreatorUpdateParameters {
+    readonly provisioningState?: string;
+    storageUnits?: number;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface Dimension {
+    displayName?: string;
+    internalMetricName?: string;
+    internalName?: string;
+    name?: string;
+    sourceMdmNamespace?: string;
+    toBeExportedToShoebox?: boolean;
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+type KeyType_2 = string;
+export { KeyType_2 as KeyType }
+
+// @public
+export type Kind = string;
+
+// @public
+export enum KnownCreatedByType {
+    // (undocumented)
+    Application = "Application",
+    // (undocumented)
+    Key = "Key",
+    // (undocumented)
+    ManagedIdentity = "ManagedIdentity",
+    // (undocumented)
+    User = "User"
+}
+
+// @public
+export enum KnownKeyType {
+    // (undocumented)
+    Primary = "primary",
+    // (undocumented)
+    Secondary = "secondary"
+}
+
+// @public
+export enum KnownKind {
+    // (undocumented)
+    Gen1 = "Gen1",
+    // (undocumented)
+    Gen2 = "Gen2"
+}
+
+// @public
+export enum KnownName {
+    // (undocumented)
+    G2 = "G2",
+    // (undocumented)
+    S0 = "S0",
+    // (undocumented)
+    S1 = "S1"
+}
+
+// @public
+export interface Maps {
+    listOperations(options?: MapsListOperationsOptionalParams): PagedAsyncIterableIterator<OperationDetail>;
+    listSubscriptionOperations(options?: MapsListSubscriptionOperationsOptionalParams): PagedAsyncIterableIterator<OperationDetail>;
+}
+
+// @public
+export type MapsAccount = TrackedResource & {
+    sku: Sku;
+    kind?: Kind;
+    readonly systemData?: SystemData;
+    properties?: MapsAccountProperties;
+};
+
+// @public
+export interface MapsAccountKeys {
+    readonly primaryKey?: string;
+    readonly primaryKeyLastUpdated?: string;
+    readonly secondaryKey?: string;
+    readonly secondaryKeyLastUpdated?: string;
+}
+
+// @public
+export interface MapsAccountProperties {
+    disableLocalAuth?: boolean;
+    readonly provisioningState?: string;
+    readonly uniqueId?: string;
+}
+
+// @public
+export interface MapsAccounts {
+    nextLink?: string;
+    readonly value?: MapsAccount[];
+}
+
+// @public
+export interface MapsAccountUpdateParameters {
+    disableLocalAuth?: boolean;
+    kind?: Kind;
+    readonly provisioningState?: string;
+    sku?: Sku;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    readonly uniqueId?: string;
+}
+
+// @public
+export interface MapsKeySpecification {
+    keyType: KeyType_2;
+}
+
+// @public
+export interface MapsListOperationsNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MapsListOperationsNextResponse = MapsOperations;
+
+// @public
+export interface MapsListOperationsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MapsListOperationsResponse = MapsOperations;
+
+// @public
+export interface MapsListSubscriptionOperationsNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MapsListSubscriptionOperationsNextResponse = MapsOperations;
+
+// @public
+export interface MapsListSubscriptionOperationsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MapsListSubscriptionOperationsResponse = MapsOperations;
+
+// @public
+export interface MapsOperations {
+    nextLink?: string;
+    readonly value?: OperationDetail[];
+}
+
+// @public
+export interface MetricSpecification {
+    aggregationType?: string;
+    category?: string;
+    dimensions?: Dimension[];
+    displayDescription?: string;
+    displayName?: string;
+    fillGapWithZero?: boolean;
+    name?: string;
+    resourceIdDimensionNameOverride?: string;
+    unit?: string;
+}
+
+// @public
+export type Name = string;
+
+// @public
+export interface OperationDetail {
+    display?: OperationDisplay;
+    isDataAction?: boolean;
+    name?: string;
+    origin?: string;
+    serviceSpecification?: ServiceSpecification;
+}
+
+// @public
+export interface OperationDisplay {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface ServiceSpecification {
+    metricSpecifications?: MetricSpecification[];
+}
+
+// @public
+export interface Sku {
+    name: Name;
+    readonly tier?: string;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export type TrackedResource = Resource & {
+    tags?: {
+        [propertyName: string]: string;
+    };
+    location: string;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -1,31 +1,188 @@
-import rollup from "rollup";
-import nodeResolve from "rollup-plugin-node-resolve";
-import sourcemaps from "rollup-plugin-sourcemaps";
-
-/**
- * @type {rollup.RollupFileOptions}
- */
-const config = {
-  input: "./esm/azureMapsManagementClient.js",
-  external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"],
-  output: {
-    file: "./dist/arm-maps.js",
-    format: "umd",
-    name: "Azure.ArmMaps",
-    sourcemap: true,
-    globals: {
-      "@azure/ms-rest-js": "msRest",
-      "@azure/ms-rest-azure-js": "msRestAzure"
-    },
-    banner: `/*
+/*
  * Copyright (c) Microsoft Corporation.
  * Licensed under the MIT License.
  *
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */`
-  },
-  plugins: [nodeResolve({ mainFields: ["module", "main"] }), sourcemaps()]
+ */
+
+import nodeResolve from "@rollup/plugin-node-resolve";
+import cjs from "@rollup/plugin-commonjs";
+import sourcemaps from "rollup-plugin-sourcemaps";
+import multiEntry from "@rollup/plugin-multi-entry";
+import json from "@rollup/plugin-json";
+
+import nodeBuiltins from "builtin-modules";
+
+/**
+ * Gets the proper configuration needed for rollup's commonJS plugin for @opentelemetry/api.
+ *
+ * NOTE: this manual configuration is only needed because OpenTelemetry uses an
+ * __exportStar downleveled helper function to declare its exports which confuses
+ * rollup's automatic discovery mechanism.
+ *
+ * @returns an object reference that can be `...`'d into your cjs() configuration.
+ */
+export function openTelemetryCommonJs() {
+  const namedExports = {};
+
+  for (const key of [
+    "@opentelemetry/api",
+    "@azure/core-tracing/node_modules/@opentelemetry/api"
+  ]) {
+    namedExports[key] = [
+      "SpanKind",
+      "TraceFlags",
+      "getSpan",
+      "setSpan",
+      "SpanStatusCode",
+      "getSpanContext",
+      "setSpanContext"
+    ];
+  }
+
+  const releasedOpenTelemetryVersions = ["0.10.2", "1.0.0-rc.0"];
+
+  for (const version of releasedOpenTelemetryVersions) {
+    namedExports[
+      // working around a limitation in the rollup common.js plugin - it's not able to resolve these modules so the named exports listed above will not get applied. We have to drill down to the actual path.
+      `../../../common/temp/node_modules/.pnpm/@opentelemetry/api@${version}/node_modules/@opentelemetry/api/build/src/index.js`
+    ] = [
+      "SpanKind",
+      "TraceFlags",
+      "getSpan",
+      "setSpan",
+      "StatusCode",
+      "CanonicalCode",
+      "getSpanContext",
+      "setSpanContext"
+    ];
+  }
+
+  return namedExports;
+}
+
+// #region Warning Handler
+
+/**
+ * A function that can determine whether a rollupwarning should be ignored. If
+ * the function returns `true`, then the warning will not be displayed.
+ */
+
+function ignoreNiseSinonEvalWarnings(warning) {
+  return (
+    warning.code === "EVAL" &&
+    warning.id &&
+      (warning.id.includes("node_modules/nise") ||
+        warning.id.includes("node_modules/sinon")) === true
+  );
+}
+
+function ignoreChaiCircularDependencyWarnings(warning) {
+  return (
+    warning.code === "CIRCULAR_DEPENDENCY" &&
+    warning.importer && warning.importer.includes("node_modules/chai") === true
+  );
+}
+
+const warningInhibitors = [
+  ignoreChaiCircularDependencyWarnings,
+  ignoreNiseSinonEvalWarnings
+];
+
+/**
+ * Construct a warning handler for the shared rollup configuration
+ * that ignores certain warnings that are not relevant to testing.
+ */
+function makeOnWarnForTesting() {
+  return (warning, warn) => {
+    // If every inhibitor returns false (i.e. no inhibitors), then show the warning
+    if (warningInhibitors.every((inhib) => !inhib(warning))) {
+      warn(warning);
+    }
+  };
+}
+
+// #endregion
+
+function makeBrowserTestConfig() {
+  const config = {
+    input: {
+      include: ["dist-esm/test/**/*.spec.js"],
+      exclude: ["dist-esm/test/**/node/**"]
+    },
+    output: {
+      file: `dist-test/index.browser.js`,
+      format: "umd",
+      sourcemap: true
+    },
+    preserveSymlinks: false,
+    plugins: [
+      multiEntry({ exports: false }),
+      nodeResolve({
+        mainFields: ["module", "browser"]
+      }),
+      cjs({
+        namedExports: {
+          // Chai's strange internal architecture makes it impossible to statically
+          // analyze its exports.
+          chai: [
+            "version",
+            "use",
+            "util",
+            "config",
+            "expect",
+            "should",
+            "assert"
+          ],
+          ...openTelemetryCommonJs()
+        }
+      }),
+      json(),
+      sourcemaps()
+      //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
+    ],
+    onwarn: makeOnWarnForTesting(),
+    // Disable tree-shaking of test code.  In rollup-plugin-node-resolve@5.0.0,
+    // rollup started respecting the "sideEffects" field in package.json.  Since
+    // our package.json sets "sideEffects=false", this also applies to test
+    // code, which causes all tests to be removed by tree-shaking.
+    treeshake: false
+  };
+
+  return config;
+}
+
+const defaultConfigurationOptions = {
+  disableBrowserBundle: false
 };
 
-export default config;
+export function makeConfig(pkg, options) {
+  options = {
+    ...defaultConfigurationOptions,
+    ...(options || {})
+  };
+
+  const baseConfig = {
+    // Use the package's module field if it has one
+    input: pkg["module"] || "dist-esm/src/index.js",
+    external: [
+      ...nodeBuiltins,
+      ...Object.keys(pkg.dependencies),
+      ...Object.keys(pkg.devDependencies)
+    ],
+    output: { file: "dist/index.js", format: "cjs", sourcemap: true },
+    preserveSymlinks: false,
+    plugins: [sourcemaps(), nodeResolve(), cjs()]
+  };
+
+  const config = [baseConfig];
+
+  if (!options.disableBrowserBundle) {
+    config.push(makeBrowserTestConfig());
+  }
+
+  return config;
+}
+
+export default makeConfig(require("./package.json"));