@zola_do/crud 0.1.9 → 0.1.13

package/README.md

@@ -0,0 +1,145 @@
+# @zola_do/crud
+
+Generic CRUD controllers, services, and repositories for NestJS entities.
+
+## Installation
+
+```bash
+# Install individually
+npm install @zola_do/crud
+
+# Or via meta package
+npm install @zola_do/nestjs-shared
+```
+
+## Dependencies
+
+This package requires:
+
+- `@zola_do/core` — Entities, `DataResponseFormat`, `EntityCrudOptions`
+- `@zola_do/collection-query` — `decodeCollectionQuery`, `QueryConstructor`, `FilterOperators`
+- `@zola_do/authorization` — `JwtGuard`, `PermissionsGuard`
+
+## Usage
+
+### Entity Setup
+
+Extend `CommonEntity` (or `Audit` for tenant-aware entities) and use with the CRUD factories:
+
+```typescript
+import { CommonEntity } from '@zola_do/core';
+import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';
+
+@Entity('products')
+export class Product extends CommonEntity {
+  @PrimaryGeneratedColumn('uuid')
+  id: string;
+
+  @Column()
+  name: string;
+
+  @Column({ type: 'decimal', precision: 10, scale: 2 })
+  price: number;
+}
+```
+
+### Controller and Service
+
+Create a CRUD controller and service for your entity:
+
+```typescript
+import { Controller } from '@nestjs/common';
+import {
+  EntityCrudController,
+  EntityCrudService,
+} from '@zola_do/crud';
+import { Product } from './product.entity';
+
+@Controller('products')
+export class ProductsController extends EntityCrudController<Product>({
+  createPermission: 'product:create',
+  viewPermission: 'product:view',
+  updatePermission: 'product:update',
+  deletePermission: 'product:delete',
+}) {
+  constructor(service: EntityCrudService<Product>) {
+    super(service);
+  }
+}
+```
+
+```typescript
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { EntityCrudService } from '@zola_do/crud';
+import { Product } from './product.entity';
+import { ProductsController } from './products.controller';
+
+@Module({
+  imports: [TypeOrmModule.forFeature([Product])],
+  controllers: [ProductsController],
+  providers: [EntityCrudService],
+})
+export class ProductsModule {}
+```
+
+### Available Endpoints
+
+- `POST /` — Create
+- `GET /` — Find all (supports `?q=` collection query)
+- `GET /:id` — Find one
+- `PUT /:id` — Update
+- `DELETE /:id` — Soft delete
+
+### EntityCrudOptions
+
+```typescript
+import { EntityCrudOptions } from '@zola_do/core';
+
+const options: EntityCrudOptions = {
+  createDto: CreateProductDto,
+  updateDto: UpdateProductDto,
+  createPermission: 'product:create',
+  viewPermission: 'product:view',
+  updatePermission: 'product:update',
+  deletePermission: 'product:delete',
+  restorePermission: 'product:restore',
+  viewArchivedPermission: 'product:view_archived',
+};
+```
+
+### Relation CRUD
+
+For many-to-many or relation management:
+
+```typescript
+import { RelationCrudController, RelationCrudService } from '@zola_do/crud';
+
+@Controller('products/:productId/categories')
+export class ProductCategoriesController extends RelationCrudController(
+  {
+    firstEntityIdName: 'productId',
+    firstInclude: 'product',
+    secondEntityIdName: 'categoryId',
+    secondInclude: 'category',
+    viewPermission: 'product:view',
+  },
+  ProductCategory,
+) {
+  constructor(service: RelationCrudService) {
+    super(service);
+  }
+}
+```
+
+## Exports
+
+- **Controllers:** `EntityCrudController`, `RelationCrudController`, `ExtraCrudController`
+- **Services:** `EntityCrudService`, `RelationCrudService`, `ExtraCrudService`
+- **Repositories:** `EntityCrudRepository`, `RelationCrudRepository`, `ExtraCrudRepository`
+
+## Related Packages
+
+- [@zola_do/core](../core) — Entity base classes, `EntityCrudOptions`
+- [@zola_do/collection-query](../collection-query) — Query decoding for list endpoints
+- [@zola_do/authorization](../authorization) — Guards for protected CRUD

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zola_do/crud",
-  "version": "0.1.9",
+  "version": "0.1.13",
   "description": "Generic CRUD controllers and services 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"
@@ -30,12 +33,14 @@
     "typeorm-extension": "^3.7.1"
   },
   "peerDependenciesMeta": {
-    "@nestjs/swagger": { "optional": true }
+    "@nestjs/swagger": {
+      "optional": true
+    }
   },
   "dependencies": {
-    "@zola_do/core": "file:../core",
-    "@zola_do/collection-query": "file:../collection-query",
-    "@zola_do/authorization": "file:../authorization"
+    "@zola_do/core": "^0.1.9",
+    "@zola_do/collection-query": "^0.1.9",
+    "@zola_do/authorization": "^0.1.9"
   },
   "devDependencies": {
     "rimraf": "^6.1.0",