@zola_do/interceptors 0.1.9 → 0.1.10

package/README.md

@@ -0,0 +1,85 @@
+# @zola_do/interceptors
+
+Tenant and transaction interceptors for NestJS applications.
+
+## Installation
+
+```bash
+# Install individually
+npm install @zola_do/interceptors
+
+# Or via meta package
+npm install @zola_do/nestjs-shared
+```
+
+## Usage
+
+### TenantInterceptor
+
+Automatically injects `tenantId` and `organizationId` into the query string for multi-tenant data isolation. Reads user from `req.user` (requires JWT auth).
+
+```typescript
+import { Module } from '@nestjs/common';
+import { APP_INTERCEPTOR } from '@nestjs/core';
+import { TenantInterceptor } from '@zola_do/interceptors';
+
+@Module({
+  providers: [
+    {
+      provide: APP_INTERCEPTOR,
+      useClass: TenantInterceptor,
+    },
+  ],
+})
+export class AppModule {}
+```
+
+Or apply to specific controllers:
+
+```typescript
+import { Controller, UseInterceptors } from '@nestjs/common';
+import { TenantInterceptor } from '@zola_do/interceptors';
+
+@Controller('orders')
+@UseInterceptors(TenantInterceptor)
+export class OrdersController {}
+```
+
+Skip tenant filtering on specific routes using `@IgnoreTenantInterceptor()` from `@zola_do/core`:
+
+```typescript
+import { IgnoreTenantInterceptor } from '@zola_do/core';
+
+@Get('global-stats')
+@IgnoreTenantInterceptor()
+getGlobalStats() {}
+```
+
+### TransactionInterceptor
+
+Wraps request handlers in a database transaction. Use for routes that must commit or rollback atomically:
+
+```typescript
+import { Controller, UseInterceptors } from '@nestjs/common';
+import { TransactionInterceptor } from '@zola_do/interceptors';
+
+@Controller('payments')
+@UseInterceptors(TransactionInterceptor)
+export class PaymentsController {
+  @Post('process')
+  async processPayment() {
+    // All DB operations in this handler run in a single transaction
+  }
+}
+```
+
+## Exports
+
+- `TenantInterceptor` — Injects tenant/organization filters into queries
+- `TransactionInterceptor` — Wraps handlers in DB transactions
+
+## Related Packages
+
+- [@zola_do/core](../core) — `@IgnoreTenantInterceptor` decorator
+- [@zola_do/collection-query](../collection-query) — Query format used by TenantInterceptor
+- [@zola_do/authorization](../authorization) — JWT auth populates `req.user` for TenantInterceptor

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zola_do/interceptors",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "description": "Tenant and transaction interceptors for NestJS",
   "author": "zolaDO",
   "license": "ISC",
@@ -15,7 +15,10 @@
       "default": "./dist/index.js"
     }
   },
-  "files": ["dist", "README.md"],
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "scripts": {
     "build": "rimraf dist && tsc",
     "prepublishOnly": "npm run build"
@@ -27,8 +30,8 @@
     "typeorm": "^0.3.0"
   },
   "dependencies": {
-    "@zola_do/core": "file:../core",
-    "@zola_do/collection-query": "file:../collection-query"
+    "@zola_do/core": "^0.1.9",
+    "@zola_do/collection-query": "^0.1.9"
   },
   "devDependencies": {
     "rimraf": "^6.1.0",