@memberjunction/ng-entity-form-dialog 2.43.0 → 2.44.0

package/README.md

@@ -1,15 +1,17 @@
 # @memberjunction/ng-entity-form-dialog
 
-Angular component for displaying MemberJunction entity forms in a dialog, with support for both complete forms and individual form sections.
+Angular component for displaying MemberJunction entity forms in a modal dialog, with support for both complete forms and individual form sections. This component provides a reusable dialog wrapper that dynamically loads the appropriate form component based on the entity type and configuration.
 
 ## Features
 
-- Display entity forms in a modal dialog
-- Support for displaying the complete form or specific sections
-- Configurable save and cancel behavior
-- Automatic form component loading based on entity type
+- Display entity forms in a modal dialog powered by Kendo UI
+- Support for displaying complete forms or specific form sections
+- Automatic save functionality with error handling
+- Configurable cancel behavior with automatic change reversion
+- Dynamic form component loading using MemberJunction's class factory system
 - Customizable dialog dimensions and appearance
-- Integration with MemberJunction entity management
+- TypeScript support with full type safety
+- Integration with MemberJunction entity management system
 
 ## Installation
 
@@ -17,22 +19,40 @@ Angular component for displaying MemberJunction entity forms in a dialog, with s
 npm install @memberjunction/ng-entity-form-dialog
 ```
 
-## Usage
+## Dependencies
 
-Import the module in your application:
+This package requires the following peer dependencies:
+- `@angular/common`: ^18.0.2
+- `@angular/core`: ^18.0.2
+- `@angular/forms`: ^18.0.2
+- `@angular/router`: ^18.0.2
+
+The package also depends on:
+- `@memberjunction/core`: For BaseEntity support
+- `@memberjunction/ng-base-forms`: For form components
+- `@memberjunction/ng-shared`: For shared services
+- `@progress/kendo-angular-dialog`: For dialog UI
+- `@progress/kendo-angular-buttons`: For button UI
+
+## Module Setup
+
+Import the module in your Angular application:
 
 ```typescript
 import { EntityFormDialogModule } from '@memberjunction/ng-entity-form-dialog';
 
 @NgModule({
   imports: [
-    // ...
+    CommonModule,
+    FormsModule,
     EntityFormDialogModule
   ]
 })
 export class YourModule { }
 ```
 
+## Usage Examples
+
 ### Basic Usage
 
 ```html
@@ -80,50 +100,161 @@ Display only a specific section of a form:
 </mj-entity-form-dialog>
 ```
 
-## Input Properties
+### Component Implementation
+
+```typescript
+import { Component } from '@angular/core';
+import { BaseEntity, Metadata } from '@memberjunction/core';
+
+@Component({
+  selector: 'app-user-management',
+  template: `
+    <button (click)="editUser()">Edit User</button>
+    
+    <mj-entity-form-dialog
+      Title="Edit User"
+      [Record]="userRecord"
+      [Visible]="showDialog"
+      [HandleSave]="true"
+      [AutoRevertOnCancel]="true"
+      (DialogClosed)="onDialogClosed($event)">
+    </mj-entity-form-dialog>
+  `
+})
+export class UserManagementComponent {
+  userRecord: BaseEntity | null = null;
+  showDialog = false;
+
+  async editUser() {
+    // Load user record using MemberJunction metadata system
+    const md = new Metadata();
+    this.userRecord = await md.GetEntityObject('Users');
+    await this.userRecord.Load(userId);
+    
+    // Show the dialog
+    this.showDialog = true;
+  }
+
+  onDialogClosed(result: 'Save' | 'Cancel') {
+    if (result === 'Save') {
+      // Handle successful save
+      console.log('User saved successfully');
+      // Refresh your UI or perform other actions
+    } else {
+      // Handle cancel - changes are automatically reverted if AutoRevertOnCancel is true
+      console.log('Edit cancelled');
+    }
+    
+    // Hide the dialog
+    this.showDialog = false;
+  }
+}
+```
+
+## API Reference
+
+### Input Properties
 
 | Property | Type | Default | Description |
 |----------|------|---------|-------------|
-| Title | string | '' | Dialog title |
-| ShowSaveButton | boolean | true | Whether to show the Save button |
-| ShowCancelButton | boolean | true | Whether to show the Cancel button |
-| Width | number | 800 | Dialog width in pixels |
-| Height | number | 600 | Dialog height in pixels |
-| Mode | 'complete' \| 'section' | 'complete' | Whether to show the entire form or a specific section |
-| SectionName | string | '' | The section name to display (when Mode is 'section') |
-| Record | BaseEntity | null | The entity record to edit (required) |
-| HandleSave | boolean | true | Whether to automatically save the record on Save click |
-| AutoRevertOnCancel | boolean | true | Whether to automatically revert changes on Cancel click |
-| Visible | boolean | false | Controls dialog visibility |
-
-## Output Events
+| `Title` | `string` | `''` | The title displayed in the dialog header |
+| `ShowSaveButton` | `boolean` | `true` | Whether to display the Save button |
+| `ShowCancelButton` | `boolean` | `true` | Whether to display the Cancel button |
+| `Width` | `number` | `800` | Initial dialog width in pixels |
+| `Height` | `number` | `600` | Initial dialog height in pixels |
+| `Mode` | `'complete' \| 'section'` | `'complete'` | Display mode - entire form or specific section |
+| `SectionName` | `string` | `''` | The section name to display (required when Mode is 'section') |
+| `Record` | `BaseEntity \| null` | `null` | The entity record to edit (required) |
+| `HandleSave` | `boolean` | `true` | Automatically save the record when Save is clicked |
+| `AutoRevertOnCancel` | `boolean` | `true` | Automatically revert changes when Cancel is clicked |
+| `Visible` | `boolean` | `false` | Controls dialog visibility |
+
+### Output Events
 
 | Event | Type | Description |
 |-------|------|-------------|
-| DialogClosed | EventEmitter<'Save' \| 'Cancel'> | Emitted when the dialog is closed |
+| `DialogClosed` | `EventEmitter<'Save' \| 'Cancel'>` | Emitted when the dialog is closed with the action taken |
+
+### Public Methods
 
-## Handling Dialog Close
+#### `ShowForm()`
+Programmatically shows the form. This is automatically called when the `Visible` property is set to `true`.
 
 ```typescript
-onDialogClosed(result: 'Save' | 'Cancel') {
-  if (result === 'Save') {
-    // Handle successful save
-    console.log('Record saved');
-  } else {
-    // Handle cancel
-    console.log('Edit cancelled');
-  }
-  
-  // Hide the dialog
-  this.showDialog = false;
+@ViewChild(EntityFormDialogComponent) formDialog!: EntityFormDialogComponent;
+
+showFormProgrammatically() {
+  this.formDialog.ShowForm();
 }
 ```
 
-## Dynamic Form Loading
+#### `CloseWindow(status: 'Save' | 'Cancel')`
+Programmatically closes the dialog with the specified status.
 
-The component automatically loads the appropriate form component based on the entity type:
+```typescript
+closeDialogProgrammatically() {
+  this.formDialog.CloseWindow('Cancel');
+}
+```
 
-- In 'complete' mode, it loads a subclass of `BaseFormComponent` for the entity
-- In 'section' mode, it loads a subclass of `BaseFormSectionComponent` for the entity and section
+## Form Component Registration
+
+The dialog dynamically loads form components based on the entity type and mode. These components must be registered with MemberJunction's class factory system:
+
+### For Complete Mode
+Register a subclass of `BaseFormComponent` with the entity name:
+```typescript
+import { RegisterClass } from '@memberjunction/global';
+import { BaseFormComponent } from '@memberjunction/ng-base-forms';
+
+@RegisterClass(BaseFormComponent, 'Users')
+export class UserFormComponent extends BaseFormComponent {
+  // Your form implementation
+}
+```
+
+### For Section Mode
+Register a subclass of `BaseFormSectionComponent` with the pattern `EntityName.SectionName`:
+```typescript
+import { RegisterClass } from '@memberjunction/global';
+import { BaseFormSectionComponent } from '@memberjunction/ng-base-forms';
+
+@RegisterClass(BaseFormSectionComponent, 'Users.details')
+export class UserDetailsSectionComponent extends BaseFormSectionComponent {
+  // Your section implementation
+}
+```
+
+## Error Handling
+
+The component includes built-in error handling for save operations:
+
+- If `HandleSave` is `true` and the save operation fails, the component will:
+  1. Display an error notification using `SharedService`
+  2. Automatically revert the changes to prevent data corruption
+  3. Still emit the `DialogClosed` event with 'Save' status
+
+## Best Practices
+
+1. **Always provide a Record**: The `Record` property is required and must be a valid BaseEntity instance
+2. **Handle the DialogClosed event**: Always implement a handler to manage dialog visibility
+3. **Use proper entity loading**: Load entities using MemberJunction's Metadata system
+4. **Register form components**: Ensure your custom form components are properly registered
+5. **Consider dialog dimensions**: Adjust `Width` and `Height` based on your form complexity
+
+## Integration with Other MemberJunction Packages
+
+This package integrates seamlessly with:
+- `@memberjunction/core`: For entity management
+- `@memberjunction/ng-base-forms`: For form component base classes
+- `@memberjunction/ng-shared`: For notification services
+- `@memberjunction/global`: For class factory registration
+
+## Building
+
+To build the package:
+```bash
+npm run build
+```
 
-These components must be registered with the MemberJunction class factory system.
+The package uses Angular's `ngc` compiler and outputs to the `dist` directory.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/ng-entity-form-dialog",
-  "version": "2.43.0",
+  "version": "2.44.0",
   "description": "MemberJunction: Dialog component that is able to display a form for display and/or editing for any record from any entity in MemberJunction.",
   "main": "./dist/public-api.js",
   "typings": "./dist/public-api.d.ts",
@@ -25,12 +25,12 @@
     "@angular/router": "18.0.2"
   },
   "dependencies": {
-    "@memberjunction/core-entities": "2.43.0",
-    "@memberjunction/global": "2.43.0",
-    "@memberjunction/core": "2.43.0",
-    "@memberjunction/ng-container-directives": "2.43.0",
-    "@memberjunction/ng-shared": "2.43.0",
-    "@memberjunction/ng-base-forms": "2.43.0",
+    "@memberjunction/core-entities": "2.44.0",
+    "@memberjunction/global": "2.44.0",
+    "@memberjunction/core": "2.44.0",
+    "@memberjunction/ng-container-directives": "2.44.0",
+    "@memberjunction/ng-shared": "2.44.0",
+    "@memberjunction/ng-base-forms": "2.44.0",
     "@progress/kendo-angular-buttons": "16.2.0",
     "@progress/kendo-angular-dialog": "16.2.0",
     "tslib": "^2.3.0"