@azure-rest/purview-workflow 1.0.0-alpha.20250221.1 → 1.0.0-alpha.20250224.2

package/README.md

@@ -26,21 +26,13 @@ Since the Workflow service uses an Azure Active Directory (AAD) bearer token for
 Set the values of the client ID, tenant ID, username and password as environment variables:
 AZURE_CLIENT_ID, AZURE_TENANT_ID, USERNAME, PASSWORD
 
-```typescript
+```ts snippet:ReadmeSampleCreateClient_Node
 import PurviewWorkflow from "@azure-rest/purview-workflow";
-import { UsernamePasswordCredential } from "@azure/identity";
-import * as dotenv from "dotenv";
+import { DefaultAzureCredential } from "@azure/identity";
 
-dotenv.config();
-
-const endpoint = process.env["ENDPOINT"];
-const tenantId = process.env["AZURE_TENANT_ID"];
-const clientId = process.env["AZURE_CLIENT_ID"];
-const username = process.env["USERNAME"];
-const password = process.env["PASSWORD"];
 const client = PurviewWorkflow(
-  endpoint,
-  new UsernamePasswordCredential(tenantId, clientId, username, password),
+  "https://<my-account-name>.purview.azure.com",
+  new DefaultAzureCredential(),
 );
 ```
 
@@ -53,85 +45,70 @@ The following section provides several code snippets covering some of the most c
 
 ### Submit user requests
 
-```typescript
-import createPurviewWorkflowClient, {
+```ts snippet:ReadmeSampleUserRequestsSubmit
+import PurviewWorkflow, {
   SubmitUserRequestsParameters,
+  isUnexpected,
 } from "@azure-rest/purview-workflow";
-import { UsernamePasswordCredential } from "@azure/identity";
-import * as dotenv from "dotenv";
-
-dotenv.config();
-
-async function userRequestsSubmit() {
-  const endpoint = process.env["ENDPOINT"];
-  const tenantId = process.env["AZURE_TENANT_ID"];
-  const clientId = process.env["AZURE_CLIENT_ID"];
-  const username = process.env["USERNAME"];
-  const password = process.env["PASSWORD"];
-
-  const credential = new UsernamePasswordCredential(tenantId, clientId, username, password);
-  const client = createPurviewWorkflowClient(endpoint, credential);
-  const options: SubmitUserRequestsParameters = {
-    body: {
-      comment: "Thanks!",
-      operations: [
-        {
-          type: "CreateTerm",
-          payload: {
-            glossaryTerm: {
-              name: "term",
-              anchor: { glossaryGuid: "20031e20-b4df-4a66-a61d-1b0716f3fa48" },
-              nickName: "term",
-              status: "Approved",
-            },
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = PurviewWorkflow(
+  "https://<my-account-name>.purview.azure.com",
+  new DefaultAzureCredential(),
+);
+
+const options: SubmitUserRequestsParameters = {
+  body: {
+    comment: "Thanks!",
+    operations: [
+      {
+        type: "CreateTerm",
+        payload: {
+          glossaryTerm: {
+            name: "term",
+            anchor: { glossaryGuid: "20031e20-b4df-4a66-a61d-1b0716f3fa48" },
+            nickName: "term",
+            status: "Approved",
           },
         },
-      ],
-    },
-  };
-  const result = await client.path("/userrequests").post(options);
-  if (isUnexpected(result)) {
-    throw result.body.error;
-  }
-  console.log(result);
+      },
+    ],
+  },
+};
+const result = await client.path("/userrequests").post(options);
+
+if (isUnexpected(result)) {
+  throw result.body.error;
 }
 
-userRequestsSubmit().catch(console.error);
+console.log(`Requestor: ${result.body.requestor}`);
 ```
 
 ### Approve workflow task
 
-```typescript
-// This taskId represents an existing workflow task. The id can be obtained by calling GET /workflowtasks API.
-import createPurviewWorkflowClient, {
-  SubmitUserRequestsParameters,
+```ts snippet:ReadmeSampleWorkflowTaskApprove
+import PurviewWorkflow, {
+  ApproveApprovalTaskParameters,
+  isUnexpected,
 } from "@azure-rest/purview-workflow";
-import { UsernamePasswordCredential } from "@azure/identity";
-import * as dotenv from "dotenv";
-
-dotenv.config();
-async function approvalTaskApprove() {
-  const endpoint = process.env["ENDPOINT"];
-  const tenantId = process.env["AZURE_TENANT_ID"];
-  const clientId = process.env["AZURE_CLIENT_ID"];
-  const username = process.env["USERNAME"];
-  const password = process.env["PASSWORD"];
-  const credential = new UsernamePasswordCredential(tenantId, clientId, username, password);
-  const client = createPurviewWorkflowClient(endpoint, credential);
-  const taskId = "98d98e2c-23fa-4157-a3f8-ff8ce5cc095c";
-  const options: ApproveApprovalTaskParameters = {
-    body: { comment: "Thanks for raising this!" },
-  };
-  const result = await client
-    .path("/workflowtasks/{taskId}/approve-approval", taskId)
-    .post(options);
-  if (isUnexpected(result)) {
-    throw result.body.error;
-  }
-  console.log(result);
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = PurviewWorkflow(
+  "https://<my-account-name>.purview.azure.com",
+  new DefaultAzureCredential(),
+);
+
+const taskId = "98d98e2c-23fa-4157-a3f8-ff8ce5cc095c";
+const options: ApproveApprovalTaskParameters = {
+  body: { comment: "Thanks for raising this!" },
+};
+const result = await client.path("/workflowtasks/{taskId}/approve-approval", taskId).post(options);
+
+if (isUnexpected(result)) {
+  throw result.body.error;
 }
 
-approvalTaskApprove().catch(console.error);
+console.log(`Task approved with Task ID: ${taskId}`);
 ```
 
 ## Troubleshooting
@@ -140,8 +117,8 @@ approvalTaskApprove().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`:
 
-```javascript
-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-workflow",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
-  "version": "1.0.0-alpha.20250221.1",
+  "version": "1.0.0-alpha.20250224.2",
   "description": "A generated SDK for PurviewWorkflow.",
   "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.5.0",
+    "@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-workflow-rest/README.md",
   "//metadata": {
@@ -104,6 +104,7 @@
   },
   "type": "module",
   "tshy": {
+    "project": "./tsconfig.src.json",
     "exports": {
       "./package.json": "./package.json",
       ".": "./src/index.ts"
@@ -116,8 +117,7 @@
       "browser",
       "react-native"
     ],
-    "selfLink": false,
-    "project": "./tsconfig.src.json"
+    "selfLink": false
   },
   "exports": {
     "./package.json": "./package.json",
@@ -139,5 +139,6 @@
         "default": "./dist/commonjs/index.js"
       }
     }
-  }
+  },
+  "react-native": "./dist/react-native/index.js"
 }