@azure-rest/purview-datamap 1.0.0-alpha.20250220.1 → 1.0.0-alpha.20250224.2

package/README.md

@@ -44,6 +44,18 @@ can be used to authenticate the client.
 Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
 AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
 
+Use the returned token credential to authenticate the client:
+
+```ts snippet:ReadmeSampleCreateClient_Node
+import PurviewDataMap from "@azure-rest/purview-datamap";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = PurviewDataMap(
+  "https://<my-account-name>.purview.azure.com",
+  new DefaultAzureCredential(),
+);
+```
+
 ## Examples
 
 The following sections provide several code snippets covering some of the most common Purview DataMap scenarios, including:
@@ -52,26 +64,48 @@ The following sections provide several code snippets covering some of the most c
 
 ### Get All Type Definitions
 
-```typescript
-import PurviewDataMap from "@azure-rest/purview-datamap";
+```ts snippet:ReadmeSampleGetAllTypeDefinitions
+import PurviewDataMap, { isUnexpected } from "@azure-rest/purview-datamap";
 import { DefaultAzureCredential } from "@azure/identity";
-import { isUnexpected } from "@azure-rest/purview-datamap";
-import "dotenv/config";
 
-const endpoint = process.env["ENDPOINT"] || "";
+const client = PurviewDataMap(
+  "https://<my-account-name>.purview.azure.com",
+  new DefaultAzureCredential(),
+);
 
-async function main() {
-  console.log("== List entity typedefs sample ==");
-  const client = PurviewDataMap(endpoint, new DefaultAzureCredential());
+const result = await client.path("/atlas/v2/types/typedefs").get();
 
-  const result = await client.path("/atlas/v2/types/typedefs").get();
+if (isUnexpected(result)) {
+  throw result.body;
+}
+
+for (const entityDef of result.body?.businessMetadataDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
+}
 
-  if (isUnexpected(result)) {
-    throw result;
-  }
+for (const entityDef of result.body?.classificationDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
 }
 
-main().catch(console.error);
+for (const entityDef of result.body?.entityDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
+}
+
+for (const entityDef of result.body?.enumDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
+}
+
+for (const entityDef of result.body?.relationshipDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
+}
+
+for (const entityDef of result.body?.structDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
+}
+
+for (const entityDef of result.body?.termTemplateDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
+}
 ```
 
 ## Troubleshooting
@@ -80,8 +114,8 @@ main().catch(console.error);
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```ts
-const { setLogLevel } = require("@azure/logger");
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```

package/dist/commonjs/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.50.0"
+      "packageVersion": "7.50.1"
     }
   ]
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@azure-rest/purview-datamap",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
-  "version": "1.0.0-alpha.20250220.1",
+  "version": "1.0.0-alpha.20250224.2",
   "description": "Purview DataMap Service\"",
   "keywords": [
     "node",
@@ -53,14 +53,14 @@
     "unit-test": "npm run unit-test:node && npm run unit-test:browser",
     "unit-test:browser": "npm run clean && dev-tool run build-package && dev-tool run build-test && dev-tool run test:vitest --browser",
     "unit-test:node": "dev-tool run test:vitest",
-    "update-snippets": "echo skipped"
+    "update-snippets": "dev-tool run update-snippets"
   },
   "sideEffects": false,
   "autoPublish": false,
   "dependencies": {
     "@azure-rest/core-client": "^2.3.1",
     "@azure/core-auth": "^1.9.0",
-    "@azure/core-rest-pipeline": "^1.18.0",
+    "@azure/core-rest-pipeline": "^1.19.0",
     "@azure/logger": "^1.1.4",
     "tslib": "^2.8.1"
   },
@@ -70,16 +70,16 @@
     "@azure-tools/test-utils-vitest": ">=1.0.0-alpha <1.0.0-alphb",
     "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
     "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
-    "@azure/identity": "^4.0.1",
+    "@azure/identity": "^4.7.0",
     "@types/node": "^18.0.0",
-    "@vitest/browser": "^3.0.3",
-    "@vitest/coverage-istanbul": "^3.0.3",
+    "@vitest/browser": "^3.0.6",
+    "@vitest/coverage-istanbul": "^3.0.6",
     "autorest": "latest",
     "dotenv": "^16.0.0",
     "eslint": "^9.9.0",
-    "playwright": "^1.49.0",
+    "playwright": "^1.50.1",
     "typescript": "~5.7.2",
-    "vitest": "^3.0.3"
+    "vitest": "^3.0.6"
   },
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/purview/purview-datamap-rest/README.md",
   "//metadata": {
@@ -93,6 +93,7 @@
   "browser": "./dist/browser/index.js",
   "type": "module",
   "tshy": {
+    "project": "./tsconfig.src.json",
     "exports": {
       "./package.json": "./package.json",
       ".": "./src/index.ts"
@@ -105,8 +106,7 @@
       "browser",
       "react-native"
     ],
-    "selfLink": false,
-    "project": "./tsconfig.src.json"
+    "selfLink": false
   },
   "exports": {
     "./package.json": "./package.json",
@@ -128,5 +128,6 @@
         "default": "./dist/commonjs/index.js"
       }
     }
-  }
+  },
+  "react-native": "./dist/react-native/index.js"
 }