From 0815ae396db6f86267335b3498cec9c9cdcb90a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20=C5=A0vanda?= Date: Mon, 22 Jan 2024 18:05:56 +0100 Subject: [PATCH] chore: update docs and build --- .gitignore | 2 +- docs/docs/01_introduction/index.md | 4 ++-- .../transactional-adapter-prisma/README.md | 5 +++++ .../transactional-adapter-prisma/package.json | 4 ++-- packages/transactional/README.md | 5 +++++ packages/transactional/package.json | 4 ++-- 6 files changed, 17 insertions(+), 7 deletions(-) create mode 100644 packages/transactional-adapters/transactional-adapter-prisma/README.md create mode 100644 packages/transactional/README.md diff --git a/.gitignore b/.gitignore index 73f1213d..e711c870 100644 --- a/.gitignore +++ b/.gitignore @@ -50,4 +50,4 @@ lerna-debug.log* # Automatically copied files packages/**/LICENSE -packages/**/README.md +packages/core/README.md diff --git a/docs/docs/01_introduction/index.md b/docs/docs/01_introduction/index.md index 3b5aa5c8..5f72c4fa 100644 --- a/docs/docs/01_introduction/index.md +++ b/docs/docs/01_introduction/index.md @@ -18,7 +18,7 @@ Some common use cases that this library enables include: - Keeping track of the user throughout the whole request - Making the dynamic Tenant database connection available everywhere in multi-tenant apps - Propagating the authentication level or role to restrict access to resources -- Seamlessly propagating the `transaction` object of your favourite ORM across services without breaking encapsulation and isolation by explicitly passing it around. +- Seamlessly propagating database transaction across services without breaking encapsulation and isolation by explicitly passing it around (**Now available with the [Transactional plugin](../06_plugins/01_available-plugins/01-transactional/index.md)**) - Using "request" context in cases where actual REQUEST-scoped providers are not supported (passport strategies, cron controllers, websocket gateways, ...) Most of these are to some extent solvable using _REQUEST-scoped_ providers or passing the context as a parameter, but these solutions are often clunky and come with a whole lot of other issues. @@ -43,7 +43,7 @@ _Also, if you use some tracing library (like `otel`), it most likely already use ## Highlights -> **New** Version `4.0` brings support for [Plugins](!!) which enable pre-built integrations with other libraries and frameworks. (See [Migration guide](../10_migration-guide/01_v3x-v4x.md) for breaking changes). +> **New** Version `4.0` brings support for [Plugins](../06_plugins/index.md) which enable pre-built integrations with other libraries and frameworks. (See [Migration guide](../10_migration-guide/01_v3x-v4x.md) for breaking changes). > Version `3.0` introduces [_Proxy Providers_](../03_features-and-use-cases/06_proxy-providers.md) as an alternative to the imperative API. (Minor breaking changes were introduced, see [Migration guide](../10_migration-guide/01_v2x-v3x.md)). diff --git a/packages/transactional-adapters/transactional-adapter-prisma/README.md b/packages/transactional-adapters/transactional-adapter-prisma/README.md new file mode 100644 index 00000000..b751dbee --- /dev/null +++ b/packages/transactional-adapters/transactional-adapter-prisma/README.md @@ -0,0 +1,5 @@ +# @nestjs-cls/transactional-adapter-prisma + +Prisma adapter for the `@nestjs-cls/transactional` plugin. + +### ➡️ [Go to the documentation website](https://papooch.github.io/nestjs-cls/plugins/available-plugins/transactional) 📖 diff --git a/packages/transactional-adapters/transactional-adapter-prisma/package.json b/packages/transactional-adapters/transactional-adapter-prisma/package.json index 64bb48d7..2da2ba9c 100644 --- a/packages/transactional-adapters/transactional-adapter-prisma/package.json +++ b/packages/transactional-adapters/transactional-adapter-prisma/package.json @@ -30,7 +30,7 @@ "dist/src/**/!(*.spec).js" ], "scripts": { - "prepack": "cp ../../LICENSE ./LICENSE && cp ../../README.md ./README.md && yarn build", + "prepack": "cp ../../../LICENSE ./LICENSE", "prebuild": "rimraf dist", "build": "yarn prisma generate && tsc", "test": "jest", @@ -62,4 +62,4 @@ "tsconfig-paths": "^4.0.0", "typescript": "~4.8.0" } -} +} \ No newline at end of file diff --git a/packages/transactional/README.md b/packages/transactional/README.md new file mode 100644 index 00000000..9cc1b8c6 --- /dev/null +++ b/packages/transactional/README.md @@ -0,0 +1,5 @@ +# @nestjs-cls/transactional + +Transactional plugin for the `nestjs-cls` + +### ➡️ [Go to the documentation website](https://papooch.github.io/nestjs-cls/plugins) 📖 diff --git a/packages/transactional/package.json b/packages/transactional/package.json index 5bf53c61..24dc402f 100644 --- a/packages/transactional/package.json +++ b/packages/transactional/package.json @@ -30,7 +30,7 @@ "dist/src/**/!(*.spec).js" ], "scripts": { - "prepack": "cp ../../LICENSE ./LICENSE && cp ../../README.md ./README.md && yarn build", + "prepack": "cp ../../LICENSE ./LICENSE", "prebuild": "rimraf dist", "build": "tsc", "test": "jest", @@ -62,4 +62,4 @@ "tsconfig-paths": "^4.0.0", "typescript": "~4.8.0" } -} +} \ No newline at end of file