Merge remote-tracking branch 'upstream/main' into jriffs/custom-errors

Author: jriffs

.github/workflows/test-e2e.yml

@@ -34,9 +34,9 @@ jobs:
   test-e2e:
     runs-on: ubuntu-latest
     env:
-      GOVER: 1.19
-      DAPR_CLI_VER: 1.10.0
-      DAPR_RUNTIME_VER: 1.11.0-rc.5
+      GOVER: 1.20
+      DAPR_CLI_VER: 1.11.0
+      DAPR_RUNTIME_VER: 1.11.0
       DAPR_INSTALL_URL: https://raw.githubusercontent.com/dapr/cli/master/install/install.sh
       DAPR_CLI_REF: ""
       DAPR_REF: ""

daprdocs/content/en/js-sdk-docs/_index.md

@@ -11,15 +11,15 @@ A client library for building Dapr apps in JavaScript and TypeScript. This clien
 
 ## Installation
 
-To get started with the Javascript SDK, install the Dapr JavaScript SDK package from [NPM](https://www.npmjs.com/package/@dapr/dapr):
+To get started with the JavaScript SDK, install the Dapr JavaScript SDK package from [NPM](https://www.npmjs.com/package/@dapr/dapr):
 
 ```bash
 npm install --save @dapr/dapr
 ```
 
 ## Structure
 
-The Dapr Javascript SDK contains two major components:
+The Dapr JavaScript SDK contains two major components:
 
 - **DaprServer**: to manage all Dapr sidecar to application communication.
 - **DaprClient**: to manage all application to Dapr sidecar communication.

daprdocs/content/en/js-sdk-docs/js-client/_index.md

@@ -14,7 +14,7 @@ The Dapr Client allows you to communicate with the Dapr Sidecar and get access t
 
 - [Dapr CLI]({{< ref install-dapr-cli.md >}}) installed
 - Initialized [Dapr environment]({{< ref install-dapr-selfhost.md >}})
-- [Latest LTS version of Node or greater](https://nodejs.org/en/)
+- [Latest LTS version of Node.js or greater](https://nodejs.org/en/)
 
 ## Installing and importing Dapr's JS SDK
 
@@ -451,6 +451,96 @@ start().catch((e) => {
 });
 ```
 
+### Cryptography API
+
+> Support for the cryptography API is only available on the gRPC client in the JavaScript SDK.
+
+```typescript
+import { createReadStream, createWriteStream } from "node:fs";
+import { readFile, writeFile } from "node:fs/promises";
+import { pipeline } from "node:stream/promises";
+
+import { DaprClient, CommunicationProtocolEnum } from "@dapr/dapr";
+
+const daprHost = "127.0.0.1";
+const daprPort = "50050"; // Dapr Sidecar Port of this example server
+
+async function start() {
+  const client = new DaprClient({
+    daprHost,
+    daprPort,
+    communicationProtocol: CommunicationProtocolEnum.GRPC,
+  });
+
+  // Encrypt and decrypt a message using streams
+  await encryptDecryptStream(client);
+
+  // Encrypt and decrypt a message from a buffer
+  await encryptDecryptBuffer(client);
+}
+
+async function encryptDecryptStream(client: DaprClient) {
+  // First, encrypt the message
+  console.log("== Encrypting message using streams");
+  console.log("Encrypting plaintext.txt to ciphertext.out");
+
+  await pipeline(
+    createReadStream("plaintext.txt"),
+    await client.crypto.encrypt({
+      componentName: "crypto-local",
+      keyName: "symmetric256",
+      keyWrapAlgorithm: "A256KW",
+    }),
+    createWriteStream("ciphertext.out"),
+  );
+
+  // Decrypt the message
+  console.log("== Decrypting message using streams");
+  console.log("Encrypting ciphertext.out to plaintext.out");
+  await pipeline(
+    createReadStream("ciphertext.out"),
+    await client.crypto.decrypt({
+      componentName: "crypto-local",
+    }),
+    createWriteStream("plaintext.out"),
+  );
+}
+
+async function encryptDecryptBuffer(client: DaprClient) {
+  // Read "plaintext.txt" so we have some content
+  const plaintext = await readFile("plaintext.txt");
+
+  // First, encrypt the message
+  console.log("== Encrypting message using buffers");
+
+  const ciphertext = await client.crypto.encrypt(plaintext, {
+    componentName: "crypto-local",
+    keyName: "my-rsa-key",
+    keyWrapAlgorithm: "RSA",
+  });
+
+  await writeFile("test.out", ciphertext);
+
+  // Decrypt the message
+  console.log("== Decrypting message using buffers");
+  const decrypted = await client.crypto.decrypt(ciphertext, {
+    componentName: "crypto-local",
+  });
+
+  // The contents should be equal
+  if (plaintext.compare(decrypted) !== 0) {
+    throw new Error("Decrypted message does not match original message");
+  }
+}
+
+start().catch((e) => {
+  console.error(e);
+  process.exit(1);
+});
+```
+
+> For a full guide on cryptography visit [How-To: Cryptography]({{< ref howto-cryptography.md >}}).
+
 ### Distributed Lock API
 
 #### Try Lock and Unlock APIs
@@ -500,6 +590,56 @@ start().catch((e) => {
 
 > For a full guide on distributed locks visit [How-To: Use Distributed Locks]({{< ref howto-use-distributed-lock.md >}}).
 
+### Workflow API
+
+#### Workflow management
+
+```typescript
+import { DaprClient } from "@dapr/dapr";
+
+async function start() {
+  const client = new DaprClient();
+
+  // Start a new workflow instance
+  const instanceId = await client.workflow.start("OrderProcessingWorkflow", {
+    Name: "Paperclips",
+    TotalCost: 99.95,
+    Quantity: 4,
+  });
+  console.log(`Started workflow instance ${instanceId}`);
+
+  // Get a workflow instance
+  const workflow = await client.workflow.get(instanceId);
+  console.log(
+    `Workflow ${workflow.workflowName}, created at ${workflow.createdAt.toUTCString()}, has status ${
+      workflow.runtimeStatus
+    }`,
+  );
+  console.log(`Additional properties: ${JSON.stringify(workflow.properties)}`);
+
+  // Pause a workflow instance
+  await client.workflow.pause(instanceId);
+  console.log(`Paused workflow instance ${instanceId}`);
+
+  // Resume a workflow instance
+  await client.workflow.resume(instanceId);
+  console.log(`Resumed workflow instance ${instanceId}`);
+
+  // Terminate a workflow instance
+  await client.workflow.terminate(instanceId);
+  console.log(`Terminated workflow instance ${instanceId}`);
+
+  // Purge a workflow instance
+  await client.workflow.purge(instanceId);
+  console.log(`Purged workflow instance ${instanceId}`);
+}
+
+start().catch((e) => {
+  console.error(e);
+  process.exit(1);
+});
+```
+
 ## Related links
 
 - [JavaScript SDK examples](https://github.com/dapr/js-sdk/tree/master/examples)

examples/grpc/crypto/.gitignore

@@ -0,0 +1 @@
+*.out

examples/grpc/crypto/README.md

@@ -0,0 +1,11 @@
+# Examples - Crypto
+
+## Running
+
+```bash
+# Install
+npm install
+
+# Run the example
+npm run start:dapr
+```