@memberjunction/codegen-lib 2.48.0 → 2.49.0

package/dist/Angular/angular-codegen.d.ts

@@ -1,24 +1,83 @@
 import { EntityInfo, EntityFieldInfo, GeneratedFormSectionType, UserInfo, EntityRelationshipInfo } from '@memberjunction/core';
 import { GenerationResult } from './related-entity-components';
+/**
+ * Represents metadata about an Angular form section that is generated for an entity
+ */
 export declare class AngularFormSectionInfo {
+    /**
+     * The type of form section (e.g., Top, Category, Details)
+     */
     Type: GeneratedFormSectionType;
+    /**
+     * The display name of the section
+     */
     Name: string;
+    /**
+     * The generated HTML code for the tab
+     */
     TabCode: string;
+    /**
+     * The TypeScript class name for the section component
+     */
     ClassName?: string;
+    /**
+     * The filename where the section component will be saved
+     */
     FileName?: string;
+    /**
+     * The complete TypeScript component code for the section
+     */
     ComponentCode?: string;
+    /**
+     * Array of entity fields that belong to this section
+     */
     Fields?: EntityFieldInfo[];
+    /**
+     * The filename without the .ts extension
+     */
     FileNameWithoutExtension?: string;
+    /**
+     * The class name of the entity this section belongs to
+     */
     EntityClassName?: string;
+    /**
+     * Indicates if this section represents a related entity tab
+     */
     IsRelatedEntity?: boolean;
+    /**
+     * Specifies where related entity tabs should be displayed relative to field tabs
+     */
     RelatedEntityDisplayLocation?: 'Before Field Tabs' | 'After Field Tabs';
+    /**
+     * The generation result for related entity components
+     */
     GeneratedOutput?: GenerationResult;
 }
 /**
- * Base class for generating Angular client code, you can sub-class this class to create your own Angular client code generator logic
+ * Base class for generating Angular client code for MemberJunction entities.
+ * This class handles the generation of Angular components, forms, and modules based on entity metadata.
+ * You can sub-class this class to create your own Angular client code generator logic.
  */
 export declare class AngularClientGeneratorBase {
+    /**
+     * Main entry point for generating Angular code for a collection of entities
+     * @param entities Array of EntityInfo objects to generate Angular code for
+     * @param directory The output directory where generated files will be saved
+     * @param modulePrefix A prefix to use for the generated module name
+     * @param contextUser The user context for permission checking and personalization
+     * @returns Promise<boolean> True if generation was successful, false otherwise
+     */
     generateAngularCode(entities: EntityInfo[], directory: string, modulePrefix: string, contextUser: UserInfo): Promise<boolean>;
+    /**
+     * Generates the main Angular module that imports all generated components and sub-modules
+     * @param componentImports Array of import statements for generated components
+     * @param componentNames Array of component names with their required related entity items
+     * @param relatedEntityModuleImports Array of library imports for related entity modules
+     * @param sections Array of form section information
+     * @param modulePrefix Prefix for the module name
+     * @param maxComponentsPerModule Maximum number of components to include in each sub-module (default: 25)
+     * @returns The generated TypeScript code for the Angular module
+     */
     protected generateAngularModule(componentImports: string[], componentNames: {
         componentName: string;
         relatedEntityItemsRequired: {
@@ -29,6 +88,14 @@ export declare class AngularClientGeneratorBase {
         library: string;
         modules: string[];
     }[], sections: AngularFormSectionInfo[], modulePrefix: string, maxComponentsPerModule?: number): string;
+    /**
+     * Generates sub-modules to handle large numbers of components by breaking them into smaller chunks
+     * @param componentNames Array of component names with their required related entity items
+     * @param sections Array of form section information
+     * @param maxComponentsPerModule Maximum components per sub-module
+     * @param modulePrefix Prefix for module naming
+     * @returns Generated TypeScript code for all sub-modules and the master module
+     */
     protected generateAngularModuleCode(componentNames: {
         componentName: string;
         relatedEntityItemsRequired: {
@@ -36,35 +103,126 @@ export declare class AngularClientGeneratorBase {
             moduleClassName: string;
         }[];
     }[], sections: AngularFormSectionInfo[], maxComponentsPerModule: number, modulePrefix: string): string;
+    /**
+     * Base name used for generating sub-module names
+     * @protected
+     */
     protected subModule_BaseName: string;
     /**
-     * Get the base name for the sub-modules, override this method to change the base name. Defaults to 'GeneratedForms_SubModule_'
+     * Get the base name for the sub-modules. Override this method to change the base name.
+     * @returns The base name for sub-modules (default: 'GeneratedForms_SubModule_')
      */
     get SubModuleBaseName(): string;
+    /**
+     * Generates the closing section of a sub-module including imports and exports
+     * @param moduleNumber The sequential number of this sub-module
+     * @param additionalModulesToImport Array of additional module names to import
+     * @returns TypeScript code for the sub-module ending
+     */
     protected generateSubModuleEnding(moduleNumber: number, additionalModulesToImport: string[]): string;
+    /**
+     * Generates the TypeScript component code for a single entity
+     * @param entity The entity to generate the component for
+     * @param additionalSections Array of additional form sections for this entity
+     * @param relatedEntitySections Array of related entity sections
+     * @returns Generated TypeScript component code
+     */
     protected generateSingleEntityTypeScriptForAngular(entity: EntityInfo, additionalSections: AngularFormSectionInfo[], relatedEntitySections: AngularFormSectionInfo[]): string;
+    /**
+     * Checks if an entity has any fields designated for the top area section
+     * @param entity The entity to check
+     * @returns True if the entity has top area fields, false otherwise
+     */
     protected entityHasTopArea(entity: EntityInfo): boolean;
+    /**
+     * Generates HTML for the top area section of an entity form
+     * @param entity The entity to generate top area HTML for
+     * @returns HTML string for the top area section, or empty string if no top area exists
+     */
     protected generateTopAreaHTMLForAngular(entity: EntityInfo): string;
+    /**
+     * Adds a new section to the sections array if it doesn't already exist
+     * @param entity The entity the section belongs to
+     * @param sections Array of existing sections
+     * @param type The type of section to add
+     * @param name The name of the section
+     */
     protected AddSectionIfNeeded(entity: EntityInfo, sections: AngularFormSectionInfo[], type: GeneratedFormSectionType, name: string): void;
+    /**
+     * Generates additional form sections based on entity field metadata
+     * @param entity The entity to generate sections for
+     * @param startIndex Starting index for tab ordering
+     * @returns Array of generated form sections
+     */
     protected generateAngularAdditionalSections(entity: EntityInfo, startIndex: number): AngularFormSectionInfo[];
+    /**
+     * Generates HTML for a specific form section
+     * @param entity The entity containing the fields
+     * @param section The section to generate HTML for
+     * @returns HTML string for the form section
+     */
     protected generateSectionHTMLForAngular(entity: EntityInfo, section: AngularFormSectionInfo): string;
     /**
-     * This method generates the tab name for a related entity tab. It will append the field's name(display name, if available) to the tab name if there are multiple tabs for the same related entity
-     * @param relatedEntity
-     * @param sortedRelatedEntities
-     * @returns
+     * Generates the tab name for a related entity tab. Appends the field's display name to the tab name
+     * if there are multiple tabs for the same related entity to differentiate them.
+     * @param relatedEntity The relationship information for the related entity
+     * @param sortedRelatedEntities All related entities sorted by sequence
+     * @returns The generated tab name
      */
     protected generateRelatedEntityTabName(relatedEntity: EntityRelationshipInfo, sortedRelatedEntities: EntityRelationshipInfo[]): string;
+    /**
+     * Generates tabs for all related entities that should be displayed in the form
+     * @param entity The parent entity
+     * @param startIndex Starting index for tab ordering
+     * @param contextUser User context for permission checking
+     * @returns Promise resolving to array of related entity tab sections
+     */
     protected generateRelatedEntityTabs(entity: EntityInfo, startIndex: number, contextUser: UserInfo): Promise<AngularFormSectionInfo[]>;
+    /**
+     * Removes all whitespace from a string
+     * @param s The string to process
+     * @returns String with all whitespace removed
+     */
     protected stripWhiteSpace(s: string): string;
+    /**
+     * Generates the complete HTML template for a single entity form
+     * @param entity The entity to generate HTML for
+     * @param contextUser User context for permission checking
+     * @returns Promise resolving to an object containing the HTML code and section information
+     */
     protected generateSingleEntityHTMLForAngular(entity: EntityInfo, contextUser: UserInfo): Promise<{
         htmlCode: string;
         additionalSections: AngularFormSectionInfo[];
         relatedEntitySections: AngularFormSectionInfo[];
     }>;
+    /**
+     * Generates HTML with a vertical splitter layout for entities with a top area
+     * @param topArea HTML for the top area section
+     * @param additionalSections Array of additional form sections
+     * @param relatedEntitySections Array of related entity sections
+     * @returns Generated HTML with splitter layout
+     */
     protected generateSingleEntityHTMLWithSplitterForAngular(topArea: string, additionalSections: AngularFormSectionInfo[], relatedEntitySections: AngularFormSectionInfo[]): string;
+    /**
+     * Generates the inner HTML for the top area section
+     * @param topArea The top area content
+     * @returns HTML string for the top area container, or empty string if no content
+     */
     protected innerTopAreaHTML(topArea: string): string;
+    /**
+     * Generates the HTML for the tab strip containing all form sections
+     * @param additionalSections Array of field-based form sections
+     * @param relatedEntitySections Array of related entity sections
+     * @returns HTML string for the complete tab strip
+     */
     protected innerTabStripHTML(additionalSections: AngularFormSectionInfo[], relatedEntitySections: AngularFormSectionInfo[]): string;
+    /**
+     * Generates HTML without a splitter layout for entities without a top area
+     * @param topArea HTML for the top area section (expected to be empty)
+     * @param additionalSections Array of additional form sections
+     * @param relatedEntitySections Array of related entity sections
+     * @returns Generated HTML without splitter layout
+     */
     protected generateSingleEntityHTMLWithOUTSplitterForAngular(topArea: string, additionalSections: AngularFormSectionInfo[], relatedEntitySections: AngularFormSectionInfo[]): string;
 }
 //# sourceMappingURL=angular-codegen.d.ts.map

package/dist/Angular/angular-codegen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"angular-codegen.d.ts","sourceRoot":"","sources":["../../src/Angular/angular-codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,wBAAwB,EAAyD,QAAQ,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAMtL,OAAO,EAAE,gBAAgB,EAA8C,MAAM,6BAA6B,CAAC;AAE3G,qBAAa,sBAAsB;IAC/B,IAAI,EAAG,wBAAwB,CAAC;IAChC,IAAI,EAAG,MAAM,CAAC;IACd,OAAO,EAAG,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,eAAe,EAAE,CAAC;IAC3B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,CAAS;IAClC,4BAA4B,CAAC,EAAE,mBAAmB,GAAG,kBAAkB,CAAqB;IAC5F,eAAe,CAAC,EAAE,gBAAgB,CAAC;CACtC;AAED;;GAEG;AACH,qBAAa,0BAA0B;IACtB,mBAAmB,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAuFxI,SAAS,CAAC,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,EAAE,EAC1B,cAAc,EAAE;QAAC,aAAa,EAAE,MAAM,CAAC;QAAC,0BAA0B,EAAE;YAAC,aAAa,EAAE,MAAM,CAAC;YAAC,eAAe,EAAE,MAAM,CAAA;SAAC,EAAE,CAAA;KAAC,EAAE,EACzH,0BAA0B,EAAE;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAC,EAAE,EAClE,QAAQ,EAAE,sBAAsB,EAAE,EAClC,YAAY,EAAE,MAAM,EACpB,sBAAsB,GAAE,MAAW,GAAG,MAAM;IA2D5E,SAAS,CAAC,yBAAyB,CAAC,cAAc,EAAE;QAAC,aAAa,EAAE,MAAM,CAAC;QAAC,0BAA0B,EAAE;YAAC,aAAa,EAAE,MAAM,CAAC;YAAC,eAAe,EAAE,MAAM,CAAA;SAAC,EAAE,CAAA;KAAC,EAAE,EACzH,QAAQ,EAAE,sBAAsB,EAAE,EAClC,sBAAsB,EAAE,MAAM,EAC9B,YAAY,EAAE,MAAM,GAAG,MAAM;IAyDjE,SAAS,CAAC,kBAAkB,EAAE,MAAM,CAA+B;IACnE;;OAEG;IACH,IAAW,iBAAiB,IAAI,MAAM,CAErC;IAED,SAAS,CAAC,uBAAuB,CAAC,YAAY,EAAE,MAAM,EAAE,yBAAyB,EAAE,MAAM,EAAE,GAAG,MAAM;IA0BpG,SAAS,CAAC,wCAAwC,CAAC,MAAM,EAAE,UAAU,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,GAAG,MAAM;IA0D7K,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO;IAGvD,SAAS,CAAC,6BAA6B,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IAOnE,SAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,sBAAsB,EAAE,EAAE,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,MAAM;IAgBjI,SAAS,CAAC,iCAAiC,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,GAAG,sBAAsB,EAAE;IA4E7G,SAAS,CAAC,6BAA6B,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,sBAAsB,GAAG,MAAM;IA6FpG;;;;;OAKG;IACH,SAAS,CAAC,4BAA4B,CAAC,aAAa,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,GAAG,MAAM;cA6BtH,yBAAyB,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAsD3I,SAAS,CAAC,eAAe,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;cAI5B,kCAAkC,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,GAAG,OAAO,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QACjB,kBAAkB,EAAE,sBAAsB,EAAE,CAAC;QAC7C,qBAAqB,EAAE,sBAAsB,EAAE,CAAA;KAAC,CAAC;IAYzJ,SAAS,CAAC,8CAA8C,CAAC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,GAAG,MAAM;IAkBhL,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAQnD,SAAS,CAAC,iBAAiB,CAAC,kBAAkB,EAAE,sBAAsB,EAAE,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,GAAG,MAAM;IAalI,SAAS,CAAC,iDAAiD,CAAC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,GAAG,MAAM;CAWxL"}
+{"version":3,"file":"angular-codegen.d.ts","sourceRoot":"","sources":["../../src/Angular/angular-codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,wBAAwB,EAAyD,QAAQ,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAMtL,OAAO,EAAE,gBAAgB,EAA8C,MAAM,6BAA6B,CAAC;AAE3G;;GAEG;AACH,qBAAa,sBAAsB;IAC/B;;OAEG;IACH,IAAI,EAAG,wBAAwB,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAG,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAG,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,EAAE,CAAC;IAE3B;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAS;IAElC;;OAEG;IACH,4BAA4B,CAAC,EAAE,mBAAmB,GAAG,kBAAkB,CAAqB;IAE5F;;OAEG;IACH,eAAe,CAAC,EAAE,gBAAgB,CAAC;CACtC;AAED;;;;GAIG;AACH,qBAAa,0BAA0B;IACnC;;;;;;;OAOG;IACU,mBAAmB,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAuFxI;;;;;;;;;OASG;IACH,SAAS,CAAC,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,EAAE,EAC1B,cAAc,EAAE;QAAC,aAAa,EAAE,MAAM,CAAC;QAAC,0BAA0B,EAAE;YAAC,aAAa,EAAE,MAAM,CAAC;YAAC,eAAe,EAAE,MAAM,CAAA;SAAC,EAAE,CAAA;KAAC,EAAE,EACzH,0BAA0B,EAAE;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAC,EAAE,EAClE,QAAQ,EAAE,sBAAsB,EAAE,EAClC,YAAY,EAAE,MAAM,EACpB,sBAAsB,GAAE,MAAW,GAAG,MAAM;IA2D5E;;;;;;;OAOG;IACH,SAAS,CAAC,yBAAyB,CAAC,cAAc,EAAE;QAAC,aAAa,EAAE,MAAM,CAAC;QAAC,0BAA0B,EAAE;YAAC,aAAa,EAAE,MAAM,CAAC;YAAC,eAAe,EAAE,MAAM,CAAA;SAAC,EAAE,CAAA;KAAC,EAAE,EACzH,QAAQ,EAAE,sBAAsB,EAAE,EAClC,sBAAsB,EAAE,MAAM,EAC9B,YAAY,EAAE,MAAM,GAAG,MAAM;IAyDjE;;;OAGG;IACH,SAAS,CAAC,kBAAkB,EAAE,MAAM,CAA+B;IAEnE;;;OAGG;IACH,IAAW,iBAAiB,IAAI,MAAM,CAErC;IAED;;;;;OAKG;IACH,SAAS,CAAC,uBAAuB,CAAC,YAAY,EAAE,MAAM,EAAE,yBAAyB,EAAE,MAAM,EAAE,GAAG,MAAM;IA0BpG;;;;;;OAMG;IACH,SAAS,CAAC,wCAAwC,CAAC,MAAM,EAAE,UAAU,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,GAAG,MAAM;IA0D7K;;;;OAIG;IACH,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO;IAGvD;;;;OAIG;IACH,SAAS,CAAC,6BAA6B,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IAOnE;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,sBAAsB,EAAE,EAAE,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,MAAM;IAgBjI;;;;;OAKG;IACH,SAAS,CAAC,iCAAiC,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,GAAG,sBAAsB,EAAE;IA4E7G;;;;;OAKG;IACH,SAAS,CAAC,6BAA6B,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,sBAAsB,GAAG,MAAM;IA6FpG;;;;;;OAMG;IACH,SAAS,CAAC,4BAA4B,CAAC,aAAa,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,GAAG,MAAM;IA6BtI;;;;;;OAMG;cACa,yBAAyB,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAsD3I;;;;OAIG;IACH,SAAS,CAAC,eAAe,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAI5C;;;;;OAKG;cACa,kCAAkC,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,GAAG,OAAO,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QACjB,kBAAkB,EAAE,sBAAsB,EAAE,CAAC;QAC7C,qBAAqB,EAAE,sBAAsB,EAAE,CAAA;KAAC,CAAC;IAYzJ;;;;;;OAMG;IACH,SAAS,CAAC,8CAA8C,CAAC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,GAAG,MAAM;IAkBhL;;;;OAIG;IACH,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAQnD;;;;;OAKG;IACH,SAAS,CAAC,iBAAiB,CAAC,kBAAkB,EAAE,sBAAsB,EAAE,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,GAAG,MAAM;IAalI;;;;;;OAMG;IACH,SAAS,CAAC,iDAAiD,CAAC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,GAAG,MAAM;CAWxL"}

package/dist/Angular/angular-codegen.js

@@ -10,20 +10,74 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const config_1 = require("../Config/config");
 const related_entity_components_1 = require("./related-entity-components");
+/**
+ * Represents metadata about an Angular form section that is generated for an entity
+ */
 class AngularFormSectionInfo {
-    constructor() {
-        this.IsRelatedEntity = false;
-        this.RelatedEntityDisplayLocation = 'After Field Tabs';
-    }
+    /**
+     * The type of form section (e.g., Top, Category, Details)
+     */
+    Type;
+    /**
+     * The display name of the section
+     */
+    Name;
+    /**
+     * The generated HTML code for the tab
+     */
+    TabCode;
+    /**
+     * The TypeScript class name for the section component
+     */
+    ClassName;
+    /**
+     * The filename where the section component will be saved
+     */
+    FileName;
+    /**
+     * The complete TypeScript component code for the section
+     */
+    ComponentCode;
+    /**
+     * Array of entity fields that belong to this section
+     */
+    Fields;
+    /**
+     * The filename without the .ts extension
+     */
+    FileNameWithoutExtension;
+    /**
+     * The class name of the entity this section belongs to
+     */
+    EntityClassName;
+    /**
+     * Indicates if this section represents a related entity tab
+     */
+    IsRelatedEntity = false;
+    /**
+     * Specifies where related entity tabs should be displayed relative to field tabs
+     */
+    RelatedEntityDisplayLocation = 'After Field Tabs';
+    /**
+     * The generation result for related entity components
+     */
+    GeneratedOutput;
 }
 exports.AngularFormSectionInfo = AngularFormSectionInfo;
 /**
- * Base class for generating Angular client code, you can sub-class this class to create your own Angular client code generator logic
+ * Base class for generating Angular client code for MemberJunction entities.
+ * This class handles the generation of Angular components, forms, and modules based on entity metadata.
+ * You can sub-class this class to create your own Angular client code generator logic.
  */
 class AngularClientGeneratorBase {
-    constructor() {
-        this.subModule_BaseName = 'GeneratedForms_SubModule_';
-    }
+    /**
+     * Main entry point for generating Angular code for a collection of entities
+     * @param entities Array of EntityInfo objects to generate Angular code for
+     * @param directory The output directory where generated files will be saved
+     * @param modulePrefix A prefix to use for the generated module name
+     * @param contextUser The user context for permission checking and personalization
+     * @returns Promise<boolean> True if generation was successful, false otherwise
+     */
     async generateAngularCode(entities, directory, modulePrefix, contextUser) {
         try {
             const entityPath = path_1.default.join(directory, 'Entities');
@@ -92,6 +146,16 @@ class AngularClientGeneratorBase {
             return false;
         }
     }
+    /**
+     * Generates the main Angular module that imports all generated components and sub-modules
+     * @param componentImports Array of import statements for generated components
+     * @param componentNames Array of component names with their required related entity items
+     * @param relatedEntityModuleImports Array of library imports for related entity modules
+     * @param sections Array of form section information
+     * @param modulePrefix Prefix for the module name
+     * @param maxComponentsPerModule Maximum number of components to include in each sub-module (default: 25)
+     * @returns The generated TypeScript code for the Angular module
+     */
     generateAngularModule(componentImports, componentNames, relatedEntityModuleImports, sections, modulePrefix, maxComponentsPerModule = 25) {
         // this function will generate the overall code for the module file.
         // there is one master angular module called GeneratedFormsModule, and this module will include all of the sub-modules
@@ -146,6 +210,14 @@ export function Load${modulePrefix}GeneratedForms() {
 }
     `;
     }
+    /**
+     * Generates sub-modules to handle large numbers of components by breaking them into smaller chunks
+     * @param componentNames Array of component names with their required related entity items
+     * @param sections Array of form section information
+     * @param maxComponentsPerModule Maximum components per sub-module
+     * @param modulePrefix Prefix for module naming
+     * @returns Generated TypeScript code for all sub-modules and the master module
+     */
     generateAngularModuleCode(componentNames, sections, maxComponentsPerModule, modulePrefix) {
         // this function breaks up the componentNames and sections up, we only want to have a max of maxComponentsPerModule components per module (of components and/or sections, doesn't matter)
         // so, we break up the list of components into sub-modules, and then generate the code for each sub-module
@@ -198,11 +270,23 @@ export class ${modulePrefix}GeneratedFormsModule { }`;
         return subModules.join('\n\n') + '\n\n' + masterModuleCode;
     }
     /**
-     * Get the base name for the sub-modules, override this method to change the base name. Defaults to 'GeneratedForms_SubModule_'
+     * Base name used for generating sub-module names
+     * @protected
+     */
+    subModule_BaseName = 'GeneratedForms_SubModule_';
+    /**
+     * Get the base name for the sub-modules. Override this method to change the base name.
+     * @returns The base name for sub-modules (default: 'GeneratedForms_SubModule_')
      */
     get SubModuleBaseName() {
         return this.subModule_BaseName;
     }
+    /**
+     * Generates the closing section of a sub-module including imports and exports
+     * @param moduleNumber The sequential number of this sub-module
+     * @param additionalModulesToImport Array of additional module names to import
+     * @returns TypeScript code for the sub-module ending
+     */
     generateSubModuleEnding(moduleNumber, additionalModulesToImport) {
         return `],
 imports: [
@@ -227,6 +311,13 @@ exports: [
 export class ${this.SubModuleBaseName}${moduleNumber} { }
     `;
     }
+    /**
+     * Generates the TypeScript component code for a single entity
+     * @param entity The entity to generate the component for
+     * @param additionalSections Array of additional form sections for this entity
+     * @param relatedEntitySections Array of related entity sections
+     * @returns Generated TypeScript component code
+     */
     generateSingleEntityTypeScriptForAngular(entity, additionalSections, relatedEntitySections) {
         const entityObjectClass = entity.ClassName;
         const sectionImports = additionalSections.length > 0 ? additionalSections.map(s => `import { Load${s.ClassName} } from "./sections/${s.FileNameWithoutExtension}"`).join('\n') : '';
@@ -280,15 +371,32 @@ export function Load${entity.ClassName}FormComponent() {
 }
 `;
     }
+    /**
+     * Checks if an entity has any fields designated for the top area section
+     * @param entity The entity to check
+     * @returns True if the entity has top area fields, false otherwise
+     */
     entityHasTopArea(entity) {
         return entity.Fields.some(f => f.GeneratedFormSectionType === core_1.GeneratedFormSectionType.Top);
     }
+    /**
+     * Generates HTML for the top area section of an entity form
+     * @param entity The entity to generate top area HTML for
+     * @returns HTML string for the top area section, or empty string if no top area exists
+     */
     generateTopAreaHTMLForAngular(entity) {
         if (!this.entityHasTopArea(entity))
             return '';
         else
             return `<mj-form-section Entity="${entity.Name}" Section="top-area" [record]="record" [EditMode]="this.EditMode"></mj-form-section>`;
     }
+    /**
+     * Adds a new section to the sections array if it doesn't already exist
+     * @param entity The entity the section belongs to
+     * @param sections Array of existing sections
+     * @param type The type of section to add
+     * @param name The name of the section
+     */
     AddSectionIfNeeded(entity, sections, type, name) {
         const section = sections.find(s => s.Name === name && s.Type === type);
         const fName = `${this.stripWhiteSpace(name.toLowerCase())}.component`;
@@ -305,6 +413,12 @@ export function Load${entity.ClassName}FormComponent() {
                 FileNameWithoutExtension: fName
             });
     }
+    /**
+     * Generates additional form sections based on entity field metadata
+     * @param entity The entity to generate sections for
+     * @param startIndex Starting index for tab ordering
+     * @returns Array of generated form sections
+     */
     generateAngularAdditionalSections(entity, startIndex) {
         const sections = [];
         let index = startIndex;
@@ -374,6 +488,12 @@ export function Load${entity.ClassName}${this.stripWhiteSpace(section.Name)}Comp
         }
         return sections;
     }
+    /**
+     * Generates HTML for a specific form section
+     * @param entity The entity containing the fields
+     * @param section The section to generate HTML for
+     * @returns HTML string for the form section
+     */
     generateSectionHTMLForAngular(entity, section) {
         let html = '';
         // figure out which fields will be in this section first
@@ -463,10 +583,11 @@ export function Load${entity.ClassName}${this.stripWhiteSpace(section.Name)}Comp
         return html;
     }
     /**
-     * This method generates the tab name for a related entity tab. It will append the field's name(display name, if available) to the tab name if there are multiple tabs for the same related entity
-     * @param relatedEntity
-     * @param sortedRelatedEntities
-     * @returns
+     * Generates the tab name for a related entity tab. Appends the field's display name to the tab name
+     * if there are multiple tabs for the same related entity to differentiate them.
+     * @param relatedEntity The relationship information for the related entity
+     * @param sortedRelatedEntities All related entities sorted by sequence
+     * @returns The generated tab name
      */
     generateRelatedEntityTabName(relatedEntity, sortedRelatedEntities) {
         if (relatedEntity.DisplayName && relatedEntity.DisplayName.length > 0) {
@@ -494,6 +615,13 @@ export function Load${entity.ClassName}${this.stripWhiteSpace(section.Name)}Comp
             return tabName;
         }
     }
+    /**
+     * Generates tabs for all related entities that should be displayed in the form
+     * @param entity The parent entity
+     * @param startIndex Starting index for tab ordering
+     * @param contextUser User context for permission checking
+     * @returns Promise resolving to array of related entity tab sections
+     */
     async generateRelatedEntityTabs(entity, startIndex, contextUser) {
         const md = new core_1.Metadata();
         const tabs = [];
@@ -542,9 +670,20 @@ ${componentCodeWithTabs}
         }
         return tabs;
     }
+    /**
+     * Removes all whitespace from a string
+     * @param s The string to process
+     * @returns String with all whitespace removed
+     */
     stripWhiteSpace(s) {
         return s.replace(/\s/g, '');
     }
+    /**
+     * Generates the complete HTML template for a single entity form
+     * @param entity The entity to generate HTML for
+     * @param contextUser User context for permission checking
+     * @returns Promise resolving to an object containing the HTML code and section information
+     */
     async generateSingleEntityHTMLForAngular(entity, contextUser) {
         const topArea = this.generateTopAreaHTMLForAngular(entity);
         const additionalSections = this.generateAngularAdditionalSections(entity, 0);
@@ -555,6 +694,13 @@ ${componentCodeWithTabs}
             this.generateSingleEntityHTMLWithOUTSplitterForAngular(topArea, additionalSections, relatedEntitySections);
         return { htmlCode, additionalSections, relatedEntitySections };
     }
+    /**
+     * Generates HTML with a vertical splitter layout for entities with a top area
+     * @param topArea HTML for the top area section
+     * @param additionalSections Array of additional form sections
+     * @param relatedEntitySections Array of related entity sections
+     * @returns Generated HTML with splitter layout
+     */
     generateSingleEntityHTMLWithSplitterForAngular(topArea, additionalSections, relatedEntitySections) {
         const htmlCode = `<div class="record-form-container" mjFillContainer [bottomMargin]="20" [rightMargin]="5">
     <form *ngIf="record" class="record-form"  #form="ngForm" mjFillContainer>
@@ -572,6 +718,11 @@ ${this.innerTabStripHTML(additionalSections, relatedEntitySections)}
         `;
         return htmlCode;
     }
+    /**
+     * Generates the inner HTML for the top area section
+     * @param topArea The top area content
+     * @returns HTML string for the top area container, or empty string if no content
+     */
     innerTopAreaHTML(topArea) {
         if (topArea.trim().length === 0)
             return '';
@@ -580,6 +731,12 @@ ${this.innerTabStripHTML(additionalSections, relatedEntitySections)}
                     ${topArea}
                 </div>`;
     }
+    /**
+     * Generates the HTML for the tab strip containing all form sections
+     * @param additionalSections Array of field-based form sections
+     * @param relatedEntitySections Array of related entity sections
+     * @returns HTML string for the complete tab strip
+     */
     innerTabStripHTML(additionalSections, relatedEntitySections) {
         // come up with the overall order by looking for the tabs that have DisplayLocation === 'Before Field Tabs' and put those, in sequence order
         // ahead of the additionalSections, then do the additionalSections, and then do the relatedEntitySections
@@ -591,6 +748,13 @@ ${this.innerTabStripHTML(additionalSections, relatedEntitySections)}
                     ${relatedEntityAfterFieldTabs ? relatedEntityAfterFieldTabs.map(s => s.TabCode).join('\n') : ''}
                 </mj-tabstrip>`;
     }
+    /**
+     * Generates HTML without a splitter layout for entities without a top area
+     * @param topArea HTML for the top area section (expected to be empty)
+     * @param additionalSections Array of additional form sections
+     * @param relatedEntitySections Array of related entity sections
+     * @returns Generated HTML without splitter layout
+     */
     generateSingleEntityHTMLWithOUTSplitterForAngular(topArea, additionalSections, relatedEntitySections) {
         const htmlCode = `<div class="record-form-container" mjFillContainer [bottomMargin]="20" [rightMargin]="5">
     <form *ngIf="record" class="record-form"  #form="ngForm" mjFillContainer>