@venturialstd/project 0.0.7 → 0.0.8

package/README.md

@@ -1,278 +1,278 @@
-# @venturialstd/project
-
-A NestJS module for managing organizational projects with CRUD operations and organization-specific project management.
-
-## 📋 Table of Contents
-
-- [Features](#features)
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-- [API Reference](#api-reference)
-- [Examples](#examples)
-
----
-
-## ✨ Features
-
-- 🏢 **Project Management**: Complete CRUD operations for projects
-- 🏷️ **Project Attributes**: Support for keys, statuses, tags, and date ranges
-- 📦 **Organization Isolation**: Each project belongs to a specific organization
-- 🔄 **TypeORM Integration**: Full database support with TypeORM
-- 📦 **Fully Typed**: Complete TypeScript support
-- 🎯 **Archive Support**: Archive and unarchive projects
-
----
-
-## 📦 Installation
-
-```bash
-npm install @venturialstd/project
-```
-
-### Peer Dependencies
-
-```json
-{
-  "@dataui/crud": "^6.0.0",
-  "@dataui/crud-typeorm": "^6.0.0",
-  "@nestjs/common": "^11.0.11",
-  "@nestjs/core": "^11.0.5",
-  "@nestjs/swagger": "^8.0.3",
-  "@nestjs/typeorm": "^10.0.0",
-  "class-transformer": "^0.5.1",
-  "class-validator": "^0.14.1",
-  "typeorm": "^0.3.20"
-}
-```
-
----
-
-## 🚀 Quick Start
-
-### 1. Import the Module
-
-```typescript
-import { Module } from '@nestjs/common';
-import { ProjectModule } from '@venturialstd/project';
-
-@Module({
-  imports: [ProjectModule],
-})
-export class AppModule {}
-```
-
-### 2. Use the Services
-
-```typescript
-import { Injectable } from '@nestjs/common';
-import { 
-  OrganizationProjectService,
-  CreateProjectDto,
-  OrganizationProject,
-} from '@venturialstd/project';
-
-@Injectable()
-export class YourService {
-  constructor(
-    private readonly projectService: OrganizationProjectService,
-  ) {}
-
-  async createProject(organizationId: string, name: string) {
-    return this.projectService.createProjectForOrganization({
-      organizationId,
-      name,
-      description: 'My new project',
-      status: 'active',
-    });
-  }
-
-  async getProjects(organizationId: string) {
-    return this.projectService.getProjectsByOrganization(organizationId);
-  }
-}
-```
-
----
-
-## 📚 API Reference
-
-### Services
-
-#### OrganizationProjectService
-
-```typescript
-class OrganizationProjectService {
-  // Create a new project
-  createProjectForOrganization(dto: CreateProjectDto): Promise<OrganizationProject>
-
-  // Update a project
-  updateProject(id: string, dto: UpdateProjectDto): Promise<OrganizationProject | null>
-
-  // Get all projects for an organization
-  getProjectsByOrganization(
-    organizationId: string,
-    includeArchived?: boolean
-  ): Promise<OrganizationProject[]>
-
-  // Get project by ID
-  getProjectById(id: string): Promise<OrganizationProject | null>
-
-  // Get active projects
-  getActiveProjectsByOrganization(organizationId: string): Promise<OrganizationProject[]>
-
-  // Archive a project
-  archiveProject(id: string): Promise<OrganizationProject | null>
-
-  // Delete a project
-  deleteProject(id: string): Promise<void>
-}
-```
-
-### Entities
-
-#### OrganizationProject
-
-```typescript
-class OrganizationProject {
-  id: string;
-  organizationId: string;
-  name: string;
-  description?: string;
-  key?: string;              // Project key/code (e.g., "PROJ", "DEV")
-  status?: string;           // e.g., "active", "completed", "archived", "on-hold"
-  startDate?: Date;
-  endDate?: Date;
-  ownerId?: string;          // User who owns/leads the project
-  tags?: string[];
-  isArchived: boolean;
-  createdAt: Date;
-  updatedAt: Date;
-}
-```
-
-### DTOs
-
-#### CreateProjectDto
-
-```typescript
-class CreateProjectDto {
-  organizationId: string;    // Required
-  name: string;              // Required
-  description?: string;
-  key?: string;
-  status?: string;
-  startDate?: string;        // ISO date string
-  endDate?: string;          // ISO date string
-  ownerId?: string;
-  tags?: string[];
-  isArchived?: boolean;
-}
-```
-
-#### UpdateProjectDto
-
-```typescript
-class UpdateProjectDto {
-  name?: string;
-  description?: string;
-  key?: string;
-  status?: string;
-  startDate?: string;
-  endDate?: string;
-  ownerId?: string;
-  tags?: string[];
-  isArchived?: boolean;
-}
-```
-
----
-
-## 💻 Examples
-
-### Example 1: Create and Configure a Project
-
-```typescript
-@Injectable()
-export class ProjectSetupService {
-  constructor(
-    private readonly projectService: OrganizationProjectService,
-  ) {}
-
-  async setupNewProject(organizationId: string, ownerId: string) {
-    const project = await this.projectService.createProjectForOrganization({
-      organizationId,
-      name: 'Q1 2024 Initiative',
-      description: 'Strategic goals for Q1 2024',
-      key: 'Q1-2024',
-      status: 'active',
-      startDate: '2024-01-01',
-      endDate: '2024-03-31',
-      ownerId,
-      tags: ['strategic', 'quarterly'],
-    });
-
-    return project;
-  }
-}
-```
-
-### Example 2: Get Active Projects
-
-```typescript
-@Injectable()
-export class DashboardService {
-  constructor(
-    private readonly projectService: OrganizationProjectService,
-  ) {}
-
-  async getActiveDashboard(organizationId: string) {
-    const activeProjects = await this.projectService.getActiveProjectsByOrganization(
-      organizationId
-    );
-
-    return {
-      total: activeProjects.length,
-      projects: activeProjects,
-    };
-  }
-}
-```
-
-### Example 3: Archive Completed Projects
-
-```typescript
-@Injectable()
-export class ProjectMaintenanceService {
-  constructor(
-    private readonly projectService: OrganizationProjectService,
-  ) {}
-
-  async archiveCompletedProjects(organizationId: string) {
-    const projects = await this.projectService.getProjectsByOrganization(
-      organizationId
-    );
-
-    const completedProjects = projects.filter(
-      p => p.status === 'completed' && !p.isArchived
-    );
-
-    for (const project of completedProjects) {
-      await this.projectService.archiveProject(project.id);
-    }
-
-    return { archived: completedProjects.length };
-  }
-}
-```
-
----
-
-## 📄 License
-
-MIT
-
----
-
-## 🤝 Contributing
-
-Contributions welcome! Please read the contributing guidelines before submitting PRs.
+# @venturialstd/project
+
+A NestJS module for managing organizational projects with CRUD operations and organization-specific project management.
+
+## 📋 Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [API Reference](#api-reference)
+- [Examples](#examples)
+
+---
+
+## ✨ Features
+
+- 🏢 **Project Management**: Complete CRUD operations for projects
+- 🏷️ **Project Attributes**: Support for keys, statuses, tags, and date ranges
+- 📦 **Organization Isolation**: Each project belongs to a specific organization
+- 🔄 **TypeORM Integration**: Full database support with TypeORM
+- 📦 **Fully Typed**: Complete TypeScript support
+- 🎯 **Archive Support**: Archive and unarchive projects
+
+---
+
+## 📦 Installation
+
+```bash
+npm install @venturialstd/project
+```
+
+### Peer Dependencies
+
+```json
+{
+  "@dataui/crud": "^6.0.0",
+  "@dataui/crud-typeorm": "^6.0.0",
+  "@nestjs/common": "^11.0.11",
+  "@nestjs/core": "^11.0.5",
+  "@nestjs/swagger": "^8.0.3",
+  "@nestjs/typeorm": "^10.0.0",
+  "class-transformer": "^0.5.1",
+  "class-validator": "^0.14.1",
+  "typeorm": "^0.3.20"
+}
+```
+
+---
+
+## 🚀 Quick Start
+
+### 1. Import the Module
+
+```typescript
+import { Module } from '@nestjs/common';
+import { ProjectModule } from '@venturialstd/project';
+
+@Module({
+  imports: [ProjectModule],
+})
+export class AppModule {}
+```
+
+### 2. Use the Services
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { 
+  OrganizationProjectService,
+  CreateProjectDto,
+  OrganizationProject,
+} from '@venturialstd/project';
+
+@Injectable()
+export class YourService {
+  constructor(
+    private readonly projectService: OrganizationProjectService,
+  ) {}
+
+  async createProject(organizationId: string, name: string) {
+    return this.projectService.createProjectForOrganization({
+      organizationId,
+      name,
+      description: 'My new project',
+      status: 'active',
+    });
+  }
+
+  async getProjects(organizationId: string) {
+    return this.projectService.getProjectsByOrganization(organizationId);
+  }
+}
+```
+
+---
+
+## 📚 API Reference
+
+### Services
+
+#### OrganizationProjectService
+
+```typescript
+class OrganizationProjectService {
+  // Create a new project
+  createProjectForOrganization(dto: CreateProjectDto): Promise<OrganizationProject>
+
+  // Update a project
+  updateProject(id: string, dto: UpdateProjectDto): Promise<OrganizationProject | null>
+
+  // Get all projects for an organization
+  getProjectsByOrganization(
+    organizationId: string,
+    includeArchived?: boolean
+  ): Promise<OrganizationProject[]>
+
+  // Get project by ID
+  getProjectById(id: string): Promise<OrganizationProject | null>
+
+  // Get active projects
+  getActiveProjectsByOrganization(organizationId: string): Promise<OrganizationProject[]>
+
+  // Archive a project
+  archiveProject(id: string): Promise<OrganizationProject | null>
+
+  // Delete a project
+  deleteProject(id: string): Promise<void>
+}
+```
+
+### Entities
+
+#### OrganizationProject
+
+```typescript
+class OrganizationProject {
+  id: string;
+  organizationId: string;
+  name: string;
+  description?: string;
+  key?: string;              // Project key/code (e.g., "PROJ", "DEV")
+  status?: string;           // e.g., "active", "completed", "archived", "on-hold"
+  startDate?: Date;
+  endDate?: Date;
+  ownerId?: string;          // User who owns/leads the project
+  tags?: string[];
+  isArchived: boolean;
+  createdAt: Date;
+  updatedAt: Date;
+}
+```
+
+### DTOs
+
+#### CreateProjectDto
+
+```typescript
+class CreateProjectDto {
+  organizationId: string;    // Required
+  name: string;              // Required
+  description?: string;
+  key?: string;
+  status?: string;
+  startDate?: string;        // ISO date string
+  endDate?: string;          // ISO date string
+  ownerId?: string;
+  tags?: string[];
+  isArchived?: boolean;
+}
+```
+
+#### UpdateProjectDto
+
+```typescript
+class UpdateProjectDto {
+  name?: string;
+  description?: string;
+  key?: string;
+  status?: string;
+  startDate?: string;
+  endDate?: string;
+  ownerId?: string;
+  tags?: string[];
+  isArchived?: boolean;
+}
+```
+
+---
+
+## 💻 Examples
+
+### Example 1: Create and Configure a Project
+
+```typescript
+@Injectable()
+export class ProjectSetupService {
+  constructor(
+    private readonly projectService: OrganizationProjectService,
+  ) {}
+
+  async setupNewProject(organizationId: string, ownerId: string) {
+    const project = await this.projectService.createProjectForOrganization({
+      organizationId,
+      name: 'Q1 2024 Initiative',
+      description: 'Strategic goals for Q1 2024',
+      key: 'Q1-2024',
+      status: 'active',
+      startDate: '2024-01-01',
+      endDate: '2024-03-31',
+      ownerId,
+      tags: ['strategic', 'quarterly'],
+    });
+
+    return project;
+  }
+}
+```
+
+### Example 2: Get Active Projects
+
+```typescript
+@Injectable()
+export class DashboardService {
+  constructor(
+    private readonly projectService: OrganizationProjectService,
+  ) {}
+
+  async getActiveDashboard(organizationId: string) {
+    const activeProjects = await this.projectService.getActiveProjectsByOrganization(
+      organizationId
+    );
+
+    return {
+      total: activeProjects.length,
+      projects: activeProjects,
+    };
+  }
+}
+```
+
+### Example 3: Archive Completed Projects
+
+```typescript
+@Injectable()
+export class ProjectMaintenanceService {
+  constructor(
+    private readonly projectService: OrganizationProjectService,
+  ) {}
+
+  async archiveCompletedProjects(organizationId: string) {
+    const projects = await this.projectService.getProjectsByOrganization(
+      organizationId
+    );
+
+    const completedProjects = projects.filter(
+      p => p.status === 'completed' && !p.isArchived
+    );
+
+    for (const project of completedProjects) {
+      await this.projectService.archiveProject(project.id);
+    }
+
+    return { archived: completedProjects.length };
+  }
+}
+```
+
+---
+
+## 📄 License
+
+MIT
+
+---
+
+## 🤝 Contributing
+
+Contributions welcome! Please read the contributing guidelines before submitting PRs.

package/dist/project.module.js

@@ -18,7 +18,7 @@ let ProjectModule = class ProjectModule {
 exports.ProjectModule = ProjectModule;
 exports.ProjectModule = ProjectModule = __decorate([
     (0, common_1.Module)({
-        imports: [core_1.SharedModule.forRoot({}), typeorm_1.TypeOrmModule.forFeature([project_entity_1.Project])],
+        imports: [core_1.SharedModule, typeorm_1.TypeOrmModule.forFeature([project_entity_1.Project])],
         controllers: [project_controller_1.ProjectController],
         providers: [project_service_1.ProjectService],
         exports: [project_service_1.ProjectService],

package/dist/project.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"project.module.js","sourceRoot":"","sources":["../src/project.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,6CAAgD;AAChD,6CAAkD;AAElD,yEAAqE;AACrE,8DAAoD;AACpD,gEAA4D;AAQrD,IAAM,aAAa,GAAnB,MAAM,aAAa;CAAG,CAAA;AAAhB,sCAAa;wBAAb,aAAa;IANzB,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,mBAAY,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,uBAAa,CAAC,UAAU,CAAC,CAAC,wBAAO,CAAC,CAAC,CAAC;QACxE,WAAW,EAAE,CAAC,sCAAiB,CAAC;QAChC,SAAS,EAAE,CAAC,gCAAc,CAAC;QAC3B,OAAO,EAAE,CAAC,gCAAc,CAAC;KAC1B,CAAC;GACW,aAAa,CAAG"}
+{"version":3,"file":"project.module.js","sourceRoot":"","sources":["../src/project.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,6CAAgD;AAChD,6CAAkD;AAElD,yEAAqE;AACrE,8DAAoD;AACpD,gEAA4D;AAQrD,IAAM,aAAa,GAAnB,MAAM,aAAa;CAAG,CAAA;AAAhB,sCAAa;wBAAb,aAAa;IANzB,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,mBAAY,EAAE,uBAAa,CAAC,UAAU,CAAC,CAAC,wBAAO,CAAC,CAAC,CAAC;QAC5D,WAAW,EAAE,CAAC,sCAAiB,CAAC;QAChC,SAAS,EAAE,CAAC,gCAAc,CAAC;QAC3B,OAAO,EAAE,CAAC,gCAAc,CAAC;KAC1B,CAAC;GACW,aAAa,CAAG"}

package/package.json

@@ -1,54 +1,54 @@
-{
-  "name": "@venturialstd/project",
-  "version": "0.0.7",
-  "description": "Project Management Module for Venturial - Project Entity Only",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "type": "commonjs",
-  "files": [
-    "dist"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "prepublishOnly": "npm run build",
-    "release:patch": "npm run build && npm version patch --no-git-tag-version && npm publish"
-  },
-  "devDependencies": {
-    "@dataui/crud": "^5.3.4",
-    "@dataui/crud-typeorm": "^5.3.4",
-    "@nestjs/cache-manager": "^2.2.2",
-    "@nestjs/common": "^11.0.11",
-    "@nestjs/config": "^4.0.0",
-    "@nestjs/core": "^11.0.5",
-    "@nestjs/swagger": "^11.0.3",
-    "@nestjs/typeorm": "^10.0.0",
-    "@types/node": "^20.0.0",
-    "@venturialstd/core": "^1.6.6",
-    "cache-manager": "^5.7.6",
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.1",
-    "rxjs": "^7.8.2",
-    "ts-node": "^10.9.0",
-    "tsconfig-paths": "^4.2.0",
-    "typeorm": "^0.3.20",
-    "typescript": "^5.9.3"
-  },
-  "peerDependencies": {
-    "@dataui/crud": "^5.3.4",
-    "@dataui/crud-typeorm": "^5.3.4",
-    "@nestjs/cache-manager": "^2.2.2",
-    "@nestjs/common": "^11.0.11",
-    "@nestjs/core": "^11.0.5",
-    "@nestjs/swagger": "^11.0.3",
-    "@nestjs/typeorm": "^10.0.0",
-    "@venturialstd/core": "^1.0.16",
-    "cache-manager": "^5.7.6",
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.1",
-    "rxjs": "^7.8.2",
-    "typeorm": "^0.3.20"
-  }
-}
+{
+  "name": "@venturialstd/project",
+  "version": "0.0.8",
+  "description": "Project Management Module for Venturial - Project Entity Only",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepublishOnly": "npm run build",
+    "release:patch": "npm run build && npm version patch --no-git-tag-version && npm publish"
+  },
+  "devDependencies": {
+    "@dataui/crud": "^5.3.4",
+    "@dataui/crud-typeorm": "^5.3.4",
+    "@nestjs/cache-manager": "^2.2.2",
+    "@nestjs/common": "^11.0.11",
+    "@nestjs/config": "^4.0.0",
+    "@nestjs/core": "^11.0.5",
+    "@nestjs/swagger": "^11.0.3",
+    "@nestjs/typeorm": "^10.0.0",
+    "@types/node": "^20.0.0",
+    "@venturialstd/core": "^1.6.6",
+    "cache-manager": "^5.7.6",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
+    "rxjs": "^7.8.2",
+    "ts-node": "^10.9.0",
+    "tsconfig-paths": "^4.2.0",
+    "typeorm": "^0.3.20",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@dataui/crud": "^5.3.4",
+    "@dataui/crud-typeorm": "^5.3.4",
+    "@nestjs/cache-manager": "^2.2.2",
+    "@nestjs/common": "^11.0.11",
+    "@nestjs/core": "^11.0.5",
+    "@nestjs/swagger": "^11.0.3",
+    "@nestjs/typeorm": "^10.0.0",
+    "@venturialstd/core": "^1.0.16",
+    "cache-manager": "^5.7.6",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
+    "rxjs": "^7.8.2",
+    "typeorm": "^0.3.20"
+  }
+}