@azure-rest/confidential-ledger 1.1.2-alpha.20250122.1 → 1.1.2-alpha.20250124.1

package/README.md

@@ -46,44 +46,51 @@ Creating the client also requires your Confidential Ledger's URL and id, which y
 
 Because Confidential Ledgers use self-signed certificates securely generated and stored in an enclave, the signing certificate for each Confidential Ledger must first be retrieved from the Confidential Ledger Identity Service.
 
-```typescript
-import ConfidentialLedger, { getLedgerIdentity } from "../../src";
+```ts snippet:ReadmeSampleCreateClient_Node
+import ConfidentialLedger, { getLedgerIdentity } from "@azure-rest/confidential-ledger";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const { ledgerIdentityCertificate } = await getLedgerIdentity(
-  // for example, test-ledger-name
-  LEDGER_IDENTITY,
-  // for example, https://identity.confidential-ledger.core.azure.com
-  IDENTITY_SERVICE_URL,
+  "test-ledger-name",
+  "https://identity.confidential-ledger.core.azure.com",
 );
 const credential = new DefaultAzureCredential();
 
-// ENDPOINT example: https://test-ledger-name.confidential-ledger.azure.com
-const ledgerClient = ConfidentialLedger(ENDPOINT, ledgerIdentityCertificate, credential);
+const client = ConfidentialLedger(
+  "https://test-ledger-name.confidential-ledger.azure.com",
+  ledgerIdentityCertificate,
+  credential,
+);
 ```
 
 #### Using a client certificate
 
 As an alternative to Azure Active Directory, clients may choose to authenticate with a client certificate in mutual TLS instead of via an Azure Active Directory token. For this kind of authentication, the client needs to be passed a `CertificateCredential` which is composed of a certificate and private key, both in PEM format.
 
-```typescript
+```ts snippet:ReadmeSampleCreateClient_Certificate
 import ConfidentialLedger, { getLedgerIdentity } from "@azure-rest/confidential-ledger";
 
 // Get the signing certificate from the Confidential Ledger Identity Service
 const { ledgerIdentityCertificate } = await getLedgerIdentity(
-  LEDGER_IDENTITY,
-  IDENTITY_SERVICE_URL,
+  "test-ledger-name",
+  "https://identity.confidential-ledger.core.azure.com",
 );
+
 // both cert (certificate key) and key (private key) are in PEM format
-const cert = PUBLIC_KEY;
-const key = PRIVATE_KEY;
+const cert = "<PUBLIC_CERTIFICATE>";
+const key = "<PRIVATE_KEY>";
+
 // Create the Confidential Ledger Client
-// ENDPOINT example: https://test-ledger-name.confidential-ledger.azure.com
-const ledgerClient = ConfidentialLedger(env.ENDPOINT, ledgerIdentityCertificate, {
-  tlsOptions: {
-    cert,
-    key,
+const client = ConfidentialLedger(
+  "https://test-ledger-name.confidential-ledger.azure.com",
+  ledgerIdentityCertificate,
+  {
+    tlsOptions: {
+      cert,
+      key,
+    },
   },
-});
+);
 ```
 
 ## Key concepts
@@ -127,9 +134,28 @@ This section contains code snippets for the following samples:
 
 ### Post Ledger Entry
 
-```typescript
+```ts snippet:ReadmeSamplePostLedgerEntry
+import ConfidentialLedger, {
+  getLedgerIdentity,
+  LedgerEntry,
+  CreateLedgerEntryParameters,
+} from "@azure-rest/confidential-ledger";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const { ledgerIdentityCertificate } = await getLedgerIdentity(
+  "test-ledger-name",
+  "https://identity.confidential-ledger.core.azure.com",
+);
+const credential = new DefaultAzureCredential();
+
+const client = ConfidentialLedger(
+  "https://test-ledger-name.confidential-ledger.azure.com",
+  ledgerIdentityCertificate,
+  credential,
+);
+
 const entry: LedgerEntry = {
-  contents: contentBody,
+  contents: "<content>",
 };
 const ledgerEntry: CreateLedgerEntryParameters = {
   contentType: "application/json",
@@ -140,38 +166,117 @@ const result = await client.path("/app/transactions").post(ledgerEntry);
 
 ### Get a Ledger Entry By Transaction Id
 
-```typescript
+```ts snippet:ReadmeSampleGetLedgerEntry
+import ConfidentialLedger, { getLedgerIdentity } from "@azure-rest/confidential-ledger";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const { ledgerIdentityCertificate } = await getLedgerIdentity(
+  "test-ledger-name",
+  "https://identity.confidential-ledger.core.azure.com",
+);
+const credential = new DefaultAzureCredential();
+
+const client = ConfidentialLedger(
+  "https://test-ledger-name.confidential-ledger.azure.com",
+  ledgerIdentityCertificate,
+  credential,
+);
+
+const transactionId = "<TRANSACTION_ID>";
 const status = await client.path("/app/transactions/{transactionId}/status", transactionId).get();
 ```
 
 ### Get All Ledger Entries
 
-```typescript
+```ts snippet:ReadmeSampleGetAllLedgerEntries
+import ConfidentialLedger, { getLedgerIdentity } from "@azure-rest/confidential-ledger";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const { ledgerIdentityCertificate } = await getLedgerIdentity(
+  "test-ledger-name",
+  "https://identity.confidential-ledger.core.azure.com",
+);
+const credential = new DefaultAzureCredential();
+
+const client = ConfidentialLedger(
+  "https://test-ledger-name.confidential-ledger.azure.com",
+  ledgerIdentityCertificate,
+  credential,
+);
+
 const ledgerEntries = await client.path("/app/transactions");
 ```
 
 ### Get All Collections
 
-```typescript
+```ts snippet:ReadmeSampleGetAllCollections
+import ConfidentialLedger, { getLedgerIdentity } from "@azure-rest/confidential-ledger";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const { ledgerIdentityCertificate } = await getLedgerIdentity(
+  "test-ledger-name",
+  "https://identity.confidential-ledger.core.azure.com",
+);
+const credential = new DefaultAzureCredential();
+
+const client = ConfidentialLedger(
+  "https://test-ledger-name.confidential-ledger.azure.com",
+  ledgerIdentityCertificate,
+  credential,
+);
+
 const result = await client.path("/app/collections").get();
 ```
 
 ### Get Transactions for a Collection
 
-```typescript
+```ts snippet:ReadmeSampleGetTransactionsForCollection
+import ConfidentialLedger, { getLedgerIdentity } from "@azure-rest/confidential-ledger";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const { ledgerIdentityCertificate } = await getLedgerIdentity(
+  "test-ledger-name",
+  "https://identity.confidential-ledger.core.azure.com",
+);
+const credential = new DefaultAzureCredential();
+
+const client = ConfidentialLedger(
+  "https://test-ledger-name.confidential-ledger.azure.com",
+  ledgerIdentityCertificate,
+  credential,
+);
+
 const getLedgerEntriesParams = { queryParameters: { collectionId: "my collection" } };
 const ledgerEntries = await client.path("/app/transactions").get(getLedgerEntriesParams);
 ```
 
 ### List Enclave Quotes
 
-```typescript
+```ts snippet:ReadmeSampleListEnclaveQuotes
+import ConfidentialLedger, {
+  getLedgerIdentity,
+  isUnexpected,
+} from "@azure-rest/confidential-ledger";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const { ledgerIdentityCertificate } = await getLedgerIdentity(
+  "test-ledger-name",
+  "https://identity.confidential-ledger.core.azure.com",
+);
+const credential = new DefaultAzureCredential();
+
+const client = ConfidentialLedger(
+  "https://test-ledger-name.confidential-ledger.azure.com",
+  ledgerIdentityCertificate,
+  credential,
+);
+
 // Get enclave quotes
-const enclaveQuotes = await confidentialLedger.path("/app/enclaveQuotes").get();
+const enclaveQuotes = await client.path("/app/enclaveQuotes").get();
 
 // Check for non-success response
-if (enclaveQuotes.status !== "200") {
-  throw enclaveQuotes.body.error;
+if (isUnexpected(enclaveQuotes)) {
+  throw enclaveQuotes;
 }
 
 // Log all the enclave quotes' nodeId
@@ -180,49 +285,13 @@ Object.keys(enclaveQuotes.body.enclaveQuotes).forEach((key) => {
 });
 ```
 
-### Full Example
-
-```typescript
-import ConfidentialLedger, { getLedgerIdentity } from "@azure-rest/confidential-ledger";
-import { DefaultAzureCredential } from "@azure/identity";
-
-export async function main() {
-  // Get the signing certificate from the Confidential Ledger Identity Service
-  const ledgerIdentity = await getLedgerIdentity("<my-ledger-id>");
-
-  // Create the Confidential Ledger Client
-  const confidentialLedger = ConfidentialLedger(
-    "https://<ledger-name>.eastus.cloudapp.azure.com",
-    ledgerIdentity.ledgerIdentityCertificate,
-    new DefaultAzureCredential(),
-  );
-
-  // Get enclave quotes
-  const enclaveQuotes = await confidentialLedger.path("/app/enclaveQuotes").get();
-
-  // Check for non-success response
-  if (enclaveQuotes.status !== "200") {
-    throw enclaveQuotes.body.error;
-  }
-
-  // Log all the enclave quotes' nodeId
-  Object.keys(enclaveQuotes.body.enclaveQuotes).forEach((key) => {
-    console.log(enclaveQuotes.body.enclaveQuotes[key].nodeId);
-  });
-}
-
-main().catch((err) => {
-  console.error(err);
-});
-```
-
 ## Troubleshooting
 
 ### Logging
 
 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
+```ts snippet:SetLogLevel
 import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");

package/package.json

@@ -3,7 +3,7 @@
   "sdk-type": "client",
   "author": "Microsoft Corporation",
   "description": "An isomorphic rest level client library for the Azure Confidential Ledger service.",
-  "version": "1.1.2-alpha.20250122.1",
+  "version": "1.1.2-alpha.20250124.1",
   "keywords": [
     "node",
     "azure",
@@ -73,14 +73,14 @@
     "unit-test": "npm run unit-test:node",
     "unit-test:browser": "echo \"Browser is not supported.\" && exit 0",
     "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.18.2",
     "@azure/logger": "^1.1.4",
     "tslib": "^2.8.1"
   },
@@ -92,11 +92,11 @@
     "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
     "@azure/identity": "^4.5.0",
     "@types/node": "^18.0.0",
-    "@vitest/coverage-istanbul": "^2.1.5",
+    "@vitest/coverage-istanbul": "^3.0.3",
     "dotenv": "^16.0.0",
     "eslint": "^9.9.0",
     "typescript": "~5.7.2",
-    "vitest": "^2.1.5"
+    "vitest": "^3.0.3"
   },
   "type": "module",
   "tshy": {