@memberjunction/ng-core-entity-forms 2.43.0 → 2.45.0

package/README.md

@@ -133,6 +133,71 @@ The `MemberJunctionCoreEntityFormsModule` contains extended form components that
 2. `EntityActionExtendedFormComponent` - Enhanced form for EntityAction management
 3. `ActionTopComponentExtended` - Custom top section for Action forms
 
+## Custom Form Development Guide
+
+### **Core Architecture & Setup**
+- **Location**: Custom forms live in `packages/Angular/Explorer/core-entity-forms/src/lib/custom/{EntityName}/`
+- **File Structure**: 
+  - `{entity-name}-form.component.ts` (main logic)
+  - `{entity-name}-form.component.html` (template)
+- **Inheritance**: Extend generated form components (e.g., `TemplateFormComponent`) which inherit from `BaseFormComponent`
+- **Registration**: Use `@RegisterClass(BaseFormComponent, 'EntityName')` decorator
+- **Module Integration**: Add to `custom-forms.module.ts` declarations, exports, and import required Kendo modules
+
+### **Entity & Data Management**
+- **Strong Typing**: Never use `any` - always use proper entity types (`TemplateEntity`, `TemplateCategoryEntity`)
+- **Entity Creation**: Use `Metadata.GetEntityObject<EntityType>('EntityName')` pattern
+- **Data Loading**: Use `RunView` with `ResultType='entity_object'` and generic typing
+- **Cache Integration**: Leverage engine caches like `TemplateEngineBase.Instance.TemplateContentTypes`
+
+### **Angular Best Practices**
+- **Modern Syntax**: Always use `@if`, `@for`, `@switch` instead of structural directives
+- **Track Functions**: Include `track` in `@for` loops for performance
+- **Component Integration**: Use Kendo UI components for consistency (textbox, textarea, dropdownlist, combobox, numerictextbox, button)
+
+### **Save Lifecycle & Validation**
+- **Override SaveRecord()**: Handle complex saving by overriding `SaveRecord(StopEditModeAfterSave: boolean)`
+- **Related Entity Creation**: Create related entities (categories) BEFORE calling `super.SaveRecord()`
+- **Duplicate Prevention**: Implement validation like `trim().toLowerCase()` comparison for category names
+- **Error Handling**: Use `MJNotificationService.Instance.CreateSimpleNotification()` for user feedback
+- **State Management**: Respect `EditMode` state, implement proper change tracking
+
+### **UI/UX Patterns**
+- **Layout**: Use `mjFillContainer` directive with `bottomMargin` for proper container sizing
+- **Form Fields**: Use `mj-form-field` for individual fields; avoid problematic `mj-form-section` properties
+- **Responsive Design**: CSS Grid and Flexbox for layouts
+- **Visual Feedback**: Implement hover effects, loading states, progress indicators
+- **Smart Controls**: Conditional displays (e.g., show "New" badge for unsaved records, content type names for saved)
+
+### **Development Workflow**
+- **Package Building**: Always run `npm run build` in specific package directory for TypeScript checking
+- **Workspace Management**: Never `npm install` in package directories - always at repo root
+- **Dependencies**: Add to individual package.json, then `npm install` at root
+- **Styling**: Add custom CSS to `src/shared/form-styles.css`
+
+### **Advanced Features Implemented**
+- **Dynamic Content Management**: Multiple related entities (Template Contents) with priority-based ordering
+- **Type-Safe Dropdowns**: Filter invalid options, auto-select defaults
+- **Smart Validation**: Prevent duplicates with normalized comparisons
+- **User Feedback**: Comprehensive notification system for success/warning/error states
+- **State Synchronization**: Proper coordination between main entity and related entity saves
+
+### **Common Patterns & Anti-Patterns**
+✅ **Do:**
+- Use strong typing throughout
+- Respect MemberJunction entity patterns
+- Implement comprehensive error handling
+- Provide clear user feedback
+- Follow modern Angular syntax
+
+❌ **Avoid:**
+- Using `any` types
+- Bypassing `Metadata.GetEntityObject()`
+- Ignoring `EditMode` state
+- Using outdated Angular syntax
+- Running `npm install` in package directories
+- Creating duplicate entities without validation
+
 ## Forms Structure
 
 Each entity form typically follows this structure:

package/dist/lib/custom/AIPrompts/ai-prompt-execution-dialog.component.d.ts

@@ -0,0 +1,94 @@
+import { EventEmitter, OnInit } from '@angular/core';
+import { AIPromptEntity, AIModelEntityExtended, AIVendorEntity } from '@memberjunction/core-entities';
+import * as i0 from "@angular/core";
+export interface AIPromptRunResult {
+    success: boolean;
+    output?: string;
+    parsedResult?: string;
+    error?: string;
+    executionTimeMs?: number;
+    tokensUsed?: number;
+    promptRunId?: string;
+    rawResult?: string;
+    validationResult?: string;
+}
+export interface AIPromptExecutionOptions {
+    modelId?: string;
+    vendorId?: string;
+    configurationId?: string;
+    skipValidation?: boolean;
+    parallelizationMode?: string;
+}
+export interface DataContextVariable {
+    name: string;
+    value: string;
+    type: 'string' | 'number' | 'boolean' | 'object';
+}
+export declare class AIPromptExecutionDialogComponent implements OnInit {
+    aiPrompt: AIPromptEntity | null;
+    _isVisible: boolean;
+    get isVisible(): boolean;
+    set isVisible(value: boolean);
+    isVisibleChange: EventEmitter<boolean>;
+    onClose: EventEmitter<void>;
+    dataContext: string;
+    dataContextVariables: DataContextVariable[];
+    executionOptions: AIPromptExecutionOptions;
+    availableModels: AIModelEntityExtended[];
+    availableVendors: AIVendorEntity[];
+    isLoading: boolean;
+    isRunning: boolean;
+    executionResult: AIPromptRunResult | null;
+    dataContextExpanded: boolean;
+    optionsExpanded: boolean;
+    resultsExpanded: boolean;
+    constructor();
+    ngOnInit(): void;
+    /**
+     * Resets the dialog to initial state
+     */
+    private resetDialogState;
+    /**
+     * Loads available models for the execution dialog
+     */
+    private loadDialogData;
+    /**
+     * Loads available AI models for the prompt
+     */
+    private loadAvailableModels;
+    /**
+     * Loads available AI vendors for the prompt
+     */
+    private loadAvailableVendors;
+    /**
+     * Adds a new data context variable
+     */
+    addDataContextVariable(): void;
+    /**
+     * Removes a data context variable
+     */
+    removeDataContextVariable(index: number): void;
+    /**
+     * Updates the JSON data context from variables
+     */
+    updateDataContextFromVariables(): void;
+    /**
+     * Validates that at least one variable has a name
+     */
+    private validateDataContext;
+    /**
+     * Executes the AI prompt
+     */
+    runAIPrompt(): Promise<void>;
+    /**
+     * Saves execution results to file
+     */
+    saveResults(): void;
+    /**
+     * Closes the dialog
+     */
+    close(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AIPromptExecutionDialogComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AIPromptExecutionDialogComponent, "mj-ai-prompt-execution-dialog", never, { "aiPrompt": { "alias": "aiPrompt"; "required": false; }; "isVisible": { "alias": "isVisible"; "required": false; }; }, { "isVisibleChange": "isVisibleChange"; "onClose": "onClose"; }, never, never, false, never>;
+}
+//# sourceMappingURL=ai-prompt-execution-dialog.component.d.ts.map

package/dist/lib/custom/AIPrompts/ai-prompt-execution-dialog.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-prompt-execution-dialog.component.d.ts","sourceRoot":"","sources":["../../../../src/lib/custom/AIPrompts/ai-prompt-execution-dialog.component.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,YAAY,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC/E,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;;AAMtG,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,wBAAwB;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;CACpD;AAED,qBAKa,gCAAiC,YAAW,MAAM;IAClD,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAQ;IAEzC,UAAU,EAAE,OAAO,CAAS;IACnC,IACI,SAAS,IAAI,OAAO,CAEvB;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,EAQ3B;IAES,eAAe,wBAA+B;IAC9C,OAAO,qBAA4B;IAEtC,WAAW,EAAE,MAAM,CAAM;IACzB,oBAAoB,EAAE,mBAAmB,EAAE,CAAM;IACjD,gBAAgB,EAAE,wBAAwB,CAAM;IAChD,eAAe,EAAE,qBAAqB,EAAE,CAAM;IAC9C,gBAAgB,EAAE,cAAc,EAAE,CAAM;IACxC,SAAS,UAAS;IAClB,SAAS,UAAS;IAClB,eAAe,EAAE,iBAAiB,GAAG,IAAI,CAAQ;IAGjD,mBAAmB,UAAQ;IAC3B,eAAe,UAAS;IACxB,eAAe,UAAS;;IAI/B,QAAQ;IAER;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAiBxB;;OAEG;YACW,cAAc;IAwB5B;;OAEG;YACW,mBAAmB;IAkBjC;;OAEG;YACW,oBAAoB;IAmBlC;;OAEG;IACH,sBAAsB;IAStB;;OAEG;IACH,yBAAyB,CAAC,KAAK,EAAE,MAAM;IAOvC;;OAEG;IACH,8BAA8B;IAiC9B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAe3B;;OAEG;IACG,WAAW;IAgFjB;;OAEG;IACH,WAAW;IA2BX;;OAEG;IACH,KAAK;yCAjUI,gCAAgC;2CAAhC,gCAAgC;CAsU5C"}