@sketchmonk/tempest-client

@sketchmonk/tempest-client is a Nest.js client wrapper for the @temporalio/client package, providing seamless integration between Nest.js applications and a Temporal cluster. Temporal is a powerful workflow and event sourcing framework that allows you to build resilient, scalable, and distributed applications.

Installation

You can install @sketchmonk/tempest-client using npm or yarn:

npm install @sketchmonk/tempest-client
# or
yarn add @sketchmonk/tempest-client

Configuration

To configure @sketchmonk/tempest-client, add it to the imports array of your Nest.js application module. You can set up the Temporal client by providing the necessary connection details to your Temporal cluster. Here's an example of how to configure the module:

import { Module } from '@nestjs/common';
import { TemporalClientModule } from '@sketchmonk/tempest-client';
import { Connection } from '@temporalio/client';

@Module({
  imports: [
    TemporalClientModule.registerAsync({
      async useFactory() {
        const connection = await Connection.connect({
          address: 'localhost:7233', // Replace with your Temporal cluster address
        });
        return {
          connection,
          namespace: 'tempest', // Replace with your desired namespace
        };
      },
    }),
  ],
  // ...
})
export class AppModule {}

In this example, you configure the Temporal client by specifying the connection details and namespace. Ensure that you replace the cluster address and namespace with your actual configuration.

Usage

Once you have configured @sketchmonk/tempest-client, you can use it in your services or controllers by injecting the Client provided by the package. Here's an example of how to use the Temporal client in a controller:

import { Controller } from '@nestjs/common';
import { InjectClient, UseInterceptors } from '@sketchmonk/tempest-client';
import { Post, Body } from '@nestjs/common';
import { randomUUID } from 'crypto';
import { Client } from '@temporalio/client';

@Controller()
export class AppController {
  constructor(@InjectClient() private readonly client: Client) {}

  @Post('/calc')
  @UseInterceptors(TemporalFailureInterceptor)
  async calculate(
    @Body() operation: IOperation,
  ): Promise<IOperationResult> {
    const uuid = randomUUID();
    const result = await this.client.workflow.execute(calculateWorkflow, {
      workflowId: `calc/${uuid}`,
      args: [operation],
      taskQueue: 'math',
    });
    return result;
  }
}

In this example, the @InjectClient() decorator is used to inject the Client instance into the controller. You can then use the Client to execute workflows and interact with Temporal.

Feel free to adapt the code to your specific use cases and workflows. Temporal enables you to build complex, stateful, and reliable distributed systems with ease.

Contributing

Contributions to @sketchmonk/tempest-client are welcome. If you encounter issues, have suggestions, or want to add new features, please open an issue or submit a pull request on GitHub.

License

This package is licensed under the MIT License. See the LICENSE file for details.

Author

@sketchmonk/tempest-client is developed and maintained by Sketchmonk. If you have any questions or need assistance, please feel free to contact me at [email protected].