@azure/arm-resourcegraph 4.0.0 → 5.0.0-beta.1

package/review/arm-resourcegraph.api.md

@@ -0,0 +1,214 @@
+## API Report File for "@azure/arm-resourcegraph"
+
+> 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 type AuthorizationScopeFilter = "AtScopeAndBelow" | "AtScopeAndAbove" | "AtScopeExact" | "AtScopeAboveAndBelow";
+
+// @public
+export interface Column {
+    name: string;
+    type: ColumnDataType;
+}
+
+// @public
+export type ColumnDataType = "string" | "integer" | "number" | "boolean" | "object" | "datetime";
+
+// @public
+export interface DateTimeInterval {
+    end: Date;
+    start: Date;
+}
+
+// @public
+export interface ErrorDetails {
+    [property: string]: any;
+    code: string;
+    message: string;
+}
+
+// @public
+export interface ErrorModel {
+    code: string;
+    details?: ErrorDetails[];
+    message: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error: ErrorModel;
+}
+
+// @public
+export interface Facet {
+    expression: string;
+    resultType: "FacetResult" | "FacetError";
+}
+
+// @public
+export type FacetError = Facet & {
+    resultType: "FacetError";
+    errors: ErrorDetails[];
+};
+
+// @public
+export interface FacetRequest {
+    expression: string;
+    options?: FacetRequestOptions;
+}
+
+// @public
+export interface FacetRequestOptions {
+    filter?: string;
+    sortBy?: string;
+    sortOrder?: FacetSortOrder;
+    top?: number;
+}
+
+// @public
+export type FacetResult = Facet & {
+    resultType: "FacetResult";
+    totalRecords: number;
+    count: number;
+    data: Record<string, unknown>;
+};
+
+// @public
+export type FacetSortOrder = "asc" | "desc";
+
+// @public (undocumented)
+export type FacetUnion = Facet | FacetResult | FacetError;
+
+// @public
+export interface Operation {
+    display?: OperationDisplay;
+    name?: string;
+    origin?: string;
+}
+
+// @public
+export interface OperationDisplay {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export interface QueryRequest {
+    facets?: FacetRequest[];
+    managementGroups?: string[];
+    options?: QueryRequestOptions;
+    query: string;
+    subscriptions?: string[];
+}
+
+// @public
+export interface QueryRequestOptions {
+    allowPartialScopes?: boolean;
+    authorizationScopeFilter?: AuthorizationScopeFilter;
+    resultFormat?: ResultFormat;
+    skip?: number;
+    skipToken?: string;
+    top?: number;
+}
+
+// @public
+export interface QueryResponse {
+    count: number;
+    data: Record<string, unknown>;
+    facets?: FacetUnion[];
+    resultTruncated: ResultTruncated;
+    skipToken?: string;
+    totalRecords: number;
+}
+
+// @public (undocumented)
+export class ResourceGraphClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, options?: ResourceGraphClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    operations: Operations;
+    resources(query: QueryRequest, options?: ResourcesOptionalParams): Promise<ResourcesResponse>;
+    resourcesHistory(request: ResourcesHistoryRequest, options?: ResourcesHistoryOptionalParams): Promise<ResourcesHistoryResponse>;
+}
+
+// @public
+export interface ResourceGraphClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface ResourcesHistoryOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ResourcesHistoryRequest {
+    managementGroups?: string[];
+    options?: ResourcesHistoryRequestOptions;
+    query?: string;
+    subscriptions?: string[];
+}
+
+// @public
+export interface ResourcesHistoryRequestOptions {
+    interval?: DateTimeInterval;
+    resultFormat?: ResultFormat;
+    skip?: number;
+    skipToken?: string;
+    top?: number;
+}
+
+// @public
+export type ResourcesHistoryResponse = Record<string, unknown>;
+
+// @public
+export interface ResourcesOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ResourcesResponse = QueryResponse;
+
+// @public
+export type ResultFormat = "table" | "objectArray";
+
+// @public
+export type ResultTruncated = "true" | "false";
+
+// @public
+export interface Table {
+    columns: Column[];
+    rows: Record<string, unknown>[][];
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -1,37 +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/resourceGraphClient.js",
-  external: [
-    "@azure/ms-rest-js",
-    "@azure/ms-rest-azure-js"
-  ],
-  output: {
-    file: "./dist/arm-resourcegraph.js",
-    format: "umd",
-    name: "Azure.ArmResourcegraph",
-    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"));

package/src/index.ts

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+/// <reference lib="esnext.asynciterable" />
+export * from "./models";
+export { ResourceGraphClient } from "./resourceGraphClient";
+export * from "./operationsInterfaces";