Skip to content

Commit

Permalink
chore: update docs and build
Browse files Browse the repository at this point in the history
  • Loading branch information
Papooch committed Jan 22, 2024
1 parent ab40aeb commit 0815ae3
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ lerna-debug.log*

# Automatically copied files
packages/**/LICENSE
packages/**/README.md
packages/core/README.md
4 changes: 2 additions & 2 deletions docs/docs/01_introduction/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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)).
Expand Down
Original file line number Diff line number Diff line change
@@ -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) 📖
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -62,4 +62,4 @@
"tsconfig-paths": "^4.0.0",
"typescript": "~4.8.0"
}
}
}
5 changes: 5 additions & 0 deletions packages/transactional/README.md
Original file line number Diff line number Diff line change
@@ -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) 📖
4 changes: 2 additions & 2 deletions packages/transactional/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -62,4 +62,4 @@
"tsconfig-paths": "^4.0.0",
"typescript": "~4.8.0"
}
}
}

0 comments on commit 0815ae3

Please sign in to comment.