dt-common-device 3.0.9 → 3.0.11

package/src/issues/IssueBuilder.example.ts

@@ -1,210 +0,0 @@
-import { IssueBuilder } from "./IssueBuilder";
-import { IssuesCategory, IssuePriority, EntityType } from "./issue.types";
-
-/**
- * Example usage of IssueBuilder
- * This file demonstrates various ways to use the IssueBuilder pattern
- */
-
-// Example 1: Basic issue creation
-export function createBasicIssue() {
-  const issueData = new IssueBuilder()
-    .setCategory(IssuesCategory.OPERATIONS)
-    .setPropertyId("prop123")
-    .setTitle("Device Maintenance Required")
-    .setDescription("Device requires scheduled maintenance")
-    .setEntityId("device456")
-    .setEntityType(EntityType.DEVICE)
-    .setPriority(IssuePriority.HIGH)
-    .setAssignedTo("tech789")
-    .setCreatedBy("user123")
-    .setDueDate(new Date("2024-01-15"))
-    .build();
-
-  return issueData;
-}
-
-// Example 2: Using static factory methods
-export function createDeviceIssue() {
-  const issueData = IssueBuilder.createDeviceIssue("device123", "prop456")
-    .setCategory(IssuesCategory.READINESS)
-    .setTitle("Device Firmware Update")
-    .setDescription("Device firmware update is available")
-    .setPriority(IssuePriority.MEDIUM)
-    .setAssignedTo("admin")
-    .setCreatedBy("system")
-    .setDueDate(new Date("2024-01-20"))
-    .build();
-
-  return issueData;
-}
-
-// Example 3: Using predefined issue types
-export function createSecurityIssue() {
-  const issueData = IssueBuilder.createSecurityIssue()
-    .setPropertyId("prop789")
-    .setTitle("Security Breach Detected")
-    .setDescription("Unauthorized access attempt detected")
-    .setEntityId("user123")
-    .setEntityType(EntityType.USER)
-    .setAssignedTo("security-team")
-    .setCreatedBy("security-system")
-    .setDueDate(new Date("2024-01-10"))
-    .build();
-
-  return issueData;
-}
-
-// Example 4: Creating energy issue
-export function createEnergyIssue() {
-  const issueData = IssueBuilder.createEnergyIssue()
-    .setPropertyId("prop101")
-    .setTitle("High Energy Consumption")
-    .setDescription("Energy usage is 20% above normal levels")
-    .setEntityId("zone456")
-    .setEntityType(EntityType.COLLECTION)
-    .setAssignedTo("energy-manager")
-    .setCreatedBy("energy-monitor")
-    .setDueDate(new Date("2024-01-25"))
-    .build();
-
-  return issueData;
-}
-
-// Example 5: Creating hub issue
-export function createHubIssue() {
-  const issueData = IssueBuilder.createHubIssue("hub789", "prop202")
-    .setCategory(IssuesCategory.OPERATIONS)
-    .setTitle("Hub Connection Lost")
-    .setDescription("Hub has lost connection to the network")
-    .setPriority(IssuePriority.CRITICAL)
-    .setAssignedTo("network-admin")
-    .setCreatedBy("network-monitor")
-    .setDueDate(new Date("2024-01-05"))
-    .build();
-
-  return issueData;
-}
-
-// Example 6: Creating user-specific issue
-export function createUserIssue() {
-  const issueData = IssueBuilder.createUserIssue("user456", "prop303")
-    .setCategory(IssuesCategory.SECURITY)
-    .setTitle("User Access Review Required")
-    .setDescription("User access permissions need review")
-    .setPriority(IssuePriority.MEDIUM)
-    .setAssignedTo("hr-admin")
-    .setCreatedBy("access-control")
-    .setDueDate(new Date("2024-01-30"))
-    .build();
-
-  return issueData;
-}
-
-// Example 7: Creating property-specific issue
-export function createPropertyIssue() {
-  const issueData = IssueBuilder.createPropertyIssue("prop404")
-    .setCategory(IssuesCategory.READINESS)
-    .setTitle("Property Maintenance Schedule")
-    .setDescription("Annual property maintenance is due")
-    .setPriority(IssuePriority.LOW)
-    .setAssignedTo("property-manager")
-    .setCreatedBy("maintenance-system")
-    .setDueDate(new Date("2024-02-15"))
-    .build();
-
-  return issueData;
-}
-
-// Example 8: Creating maintenance issue
-export function createMaintenanceIssue() {
-  const issueData = IssueBuilder.createMaintenanceIssue("prop505", "device789", EntityType.DEVICE)
-    .setTitle("Scheduled Device Maintenance")
-    .setDescription("Regular maintenance is scheduled for this device")
-    .setAssignedTo("technician")
-    .setCreatedBy("maintenance-scheduler")
-    .setDueDate(new Date("2024-01-12"))
-    .build();
-
-  return issueData;
-}
-
-// Example 9: Creating urgent issue
-export function createUrgentIssue() {
-  const issueData = IssueBuilder.createUrgentIssue("prop606", "hub123", EntityType.HUB)
-    .setTitle("Critical Hub Failure")
-    .setDescription("Hub is experiencing critical failures")
-    .setAssignedTo("emergency-tech")
-    .setCreatedBy("monitoring-system")
-    .setDueDate(new Date("2024-01-03"))
-    .build();
-
-  return issueData;
-}
-
-// Example 10: Reusing builder instance
-export function createMultipleIssues() {
-  const builder = new IssueBuilder()
-    .setPropertyId("prop707")
-    .setCreatedBy("batch-processor");
-
-  const issue1 = builder
-    .setCategory(IssuesCategory.OPERATIONS)
-    .setTitle("Device Temperature High")
-    .setDescription("Device temperature exceeds normal operating range")
-    .setEntityId("device789")
-    .setEntityType(EntityType.DEVICE)
-    .setPriority(IssuePriority.HIGH)
-    .setAssignedTo("tech-support")
-    .build();
-
-  const issue2 = builder
-    .reset()
-    .setPropertyId("prop707")
-    .setCategory(IssuesCategory.ENERGY)
-    .setTitle("Low Battery Warning")
-    .setDescription("Device battery level is below 20%")
-    .setEntityId("device789")
-    .setEntityType(EntityType.DEVICE)
-    .setPriority(IssuePriority.MEDIUM)
-    .setAssignedTo("maintenance-team")
-    .setCreatedBy("batch-processor")
-    .build();
-
-  return [issue1, issue2];
-}
-
-// Example 11: Creating issue with due date calculation
-export function createIssueWithDueDate() {
-  const dueDate = new Date();
-  dueDate.setDate(dueDate.getDate() + 7); // Due in 7 days
-
-  const issueData = new IssueBuilder()
-    .setCategory(IssuesCategory.READINESS)
-    .setPropertyId("prop808")
-    .setTitle("System Update Required")
-    .setDescription("System requires critical security update")
-    .setEntityType(EntityType.PROPERTY)
-    .setPriority(IssuePriority.HIGH)
-    .setAssignedTo("system-admin")
-    .setCreatedBy("update-manager")
-    .setDueDate(dueDate)
-    .build();
-
-  return issueData;
-}
-
-// Example 12: Creating issue without assignment
-export function createUnassignedIssue() {
-  const issueData = new IssueBuilder()
-    .setCategory(IssuesCategory.OTHER)
-    .setPropertyId("prop909")
-    .setTitle("General Inquiry")
-    .setDescription("General inquiry about system functionality")
-    .setEntityType(EntityType.PROPERTY)
-    .setPriority(IssuePriority.LOW)
-    .setCreatedBy("user-inquiry")
-    .build();
-
-  return issueData;
-} 

package/src/issues/IssueBuilder.ts

@@ -1,263 +0,0 @@
-import {
-  CreateIssueData,
-  IssuesCategory,
-  IssuePriority,
-  EntityType,
-} from "./issue.types";
-
-/**
- * IssueBuilder - A builder pattern implementation for constructing CreateIssueData objects
- * 
- * This builder provides a fluent interface for creating issue data with proper validation
- * and default values. It follows the Builder pattern which is a standard design pattern
- * in TypeScript for constructing complex objects.
- * 
- * Usage example:
- * const issueData = new IssueBuilder()
- *   .setCategory(IssuesCategory.OPERATIONS)
- *   .setPropertyId("prop123")
- *   .setTitle("Device Maintenance Required")
- *   .setDescription("Device requires scheduled maintenance")
- *   .setEntityId("device456")
- *   .setEntityType(EntityType.DEVICE)
- *   .setPriority(IssuePriority.HIGH)
- *   .setAssignedTo("tech789")
- *   .setCreatedBy("user123")
- *   .setDueDate(new Date("2024-01-15"))
- *   .build();
- */
-export class IssueBuilder {
-  private data: Partial<CreateIssueData> = {};
-
-  /**
-   * Sets the issue category
-   */
-  setCategory(category: IssuesCategory): IssueBuilder {
-    this.data.category = category;
-    return this;
-  }
-
-  /**
-   * Sets the property ID
-   */
-  setPropertyId(propertyId: string): IssueBuilder {
-    if (!propertyId || propertyId.trim() === "") {
-      throw new Error("Property ID is required and cannot be empty");
-    }
-    this.data.propertyId = propertyId;
-    return this;
-  }
-
-  /**
-   * Sets the issue title
-   */
-  setTitle(title: string): IssueBuilder {
-    if (!title || title.trim() === "") {
-      throw new Error("Title is required and cannot be empty");
-    }
-    this.data.title = title.trim();
-    return this;
-  }
-
-  /**
-   * Sets the issue description
-   */
-  setDescription(description: string): IssueBuilder {
-    if (!description || description.trim() === "") {
-      throw new Error("Description is required and cannot be empty");
-    }
-    this.data.description = description.trim();
-    return this;
-  }
-
-  /**
-   * Sets the entity ID (optional)
-   */
-  setEntityId(entityId?: string): IssueBuilder {
-    if (entityId !== undefined) {
-      this.data.entityId = entityId.trim() || undefined;
-    }
-    return this;
-  }
-
-  /**
-   * Sets the entity type
-   */
-  setEntityType(entityType: EntityType): IssueBuilder {
-    this.data.entityType = entityType;
-    return this;
-  }
-
-  /**
-   * Sets the issue priority (optional, defaults to MEDIUM)
-   */
-  setPriority(priority?: IssuePriority): IssueBuilder {
-    if (priority !== undefined) {
-      this.data.priority = priority;
-    }
-    return this;
-  }
-
-  /**
-   * Sets the user assigned to the issue (optional)
-   */
-  setAssignedTo(assignedTo?: string): IssueBuilder {
-    if (assignedTo !== undefined) {
-      this.data.assignedTo = assignedTo.trim() || undefined;
-    }
-    return this;
-  }
-
-  /**
-   * Sets the user who created the issue (required)
-   */
-  setCreatedBy(createdBy: string): IssueBuilder {
-    if (!createdBy || createdBy.trim() === "") {
-      throw new Error("Created by user is required and cannot be empty");
-    }
-    this.data.createdBy = createdBy.trim();
-    return this;
-  }
-
-  /**
-   * Sets the due date (optional)
-   */
-  setDueDate(dueDate?: Date): IssueBuilder {
-    if (dueDate !== undefined) {
-      this.data.dueDate = dueDate;
-    }
-    return this;
-  }
-
-  /**
-   * Validates that all required fields are present
-   */
-  private validate(): void {
-    const requiredFields = ["category", "propertyId", "title", "description", "entityType", "createdBy"];
-    const missingFields = requiredFields.filter(field => !this.data[field as keyof CreateIssueData]);
-
-    if (missingFields.length > 0) {
-      throw new Error(`Missing required fields: ${missingFields.join(", ")}`);
-    }
-  }
-
-  /**
-   * Builds and returns the CreateIssueData object
-   * @throws Error if required fields are missing
-   */
-  build(): CreateIssueData {
-    this.validate();
-
-    // Set default priority if not provided
-    if (!this.data.priority) {
-      this.data.priority = IssuePriority.MEDIUM;
-    }
-
-    return this.data as CreateIssueData;
-  }
-
-  /**
-   * Resets the builder to its initial state
-   */
-  reset(): IssueBuilder {
-    this.data = {};
-    return this;
-  }
-
-  /**
-   * Creates a new builder instance with predefined values for common issue types
-   */
-  static createReadinessIssue(): IssueBuilder {
-    return new IssueBuilder()
-      .setCategory(IssuesCategory.READINESS)
-      .setPriority(IssuePriority.MEDIUM);
-  }
-
-  static createOperationsIssue(): IssueBuilder {
-    return new IssueBuilder()
-      .setCategory(IssuesCategory.OPERATIONS)
-      .setPriority(IssuePriority.HIGH);
-  }
-
-  static createSecurityIssue(): IssueBuilder {
-    return new IssueBuilder()
-      .setCategory(IssuesCategory.SECURITY)
-      .setPriority(IssuePriority.CRITICAL);
-  }
-
-  static createEnergyIssue(): IssueBuilder {
-    return new IssueBuilder()
-      .setCategory(IssuesCategory.ENERGY)
-      .setPriority(IssuePriority.LOW);
-  }
-
-  /**
-   * Creates a device-specific issue builder
-   */
-  static createDeviceIssue(deviceId: string, propertyId: string): IssueBuilder {
-    return new IssueBuilder()
-      .setEntityType(EntityType.DEVICE)
-      .setEntityId(deviceId)
-      .setPropertyId(propertyId);
-  }
-
-  /**
-   * Creates a hub-specific issue builder
-   */
-  static createHubIssue(hubId: string, propertyId: string): IssueBuilder {
-    return new IssueBuilder()
-      .setEntityType(EntityType.HUB)
-      .setEntityId(hubId)
-      .setPropertyId(propertyId);
-  }
-
-  /**
-   * Creates a user-specific issue builder
-   */
-  static createUserIssue(userId: string, propertyId: string): IssueBuilder {
-    return new IssueBuilder()
-      .setEntityType(EntityType.USER)
-      .setEntityId(userId)
-      .setPropertyId(propertyId);
-  }
-
-  /**
-   * Creates a property-specific issue builder
-   */
-  static createPropertyIssue(propertyId: string): IssueBuilder {
-    return new IssueBuilder()
-      .setEntityType(EntityType.PROPERTY)
-      .setEntityId(propertyId)
-      .setPropertyId(propertyId);
-  }
-
-  /**
-   * Creates a maintenance issue builder
-   */
-  static createMaintenanceIssue(propertyId: string, entityId?: string, entityType?: EntityType): IssueBuilder {
-    const builder = new IssueBuilder()
-      .setCategory(IssuesCategory.READINESS)
-      .setPropertyId(propertyId)
-      .setPriority(IssuePriority.MEDIUM);
-
-    if (entityId) builder.setEntityId(entityId);
-    if (entityType) builder.setEntityType(entityType);
-
-    return builder;
-  }
-
-  /**
-   * Creates an urgent issue builder
-   */
-  static createUrgentIssue(propertyId: string, entityId?: string, entityType?: EntityType): IssueBuilder {
-    const builder = new IssueBuilder()
-      .setCategory(IssuesCategory.OPERATIONS)
-      .setPropertyId(propertyId)
-      .setPriority(IssuePriority.URGENT);
-
-    if (entityId) builder.setEntityId(entityId);
-    if (entityType) builder.setEntityType(entityType);
-
-    return builder;
-  }
-}