@mj-biz-apps/common-ng 5.4.0

package/dist/lib/components/relationship-list/relationship-list.component.d.ts

@@ -0,0 +1,392 @@
+import { EventEmitter } from '@angular/core';
+import { FormNavigationEvent } from '@memberjunction/ng-base-forms';
+import { mjBizAppsCommonRelationshipEntity, mjBizAppsCommonRelationshipTypeEntity } from '@mj-biz-apps/common-entities';
+import * as i0 from "@angular/core";
+/**
+ * View model for a single relationship row, enriched with display-friendly
+ * fields that account for the directionality of the relationship.
+ *
+ * Because relationships are stored with From/To sides, this model resolves
+ * which label and target to show based on whether the current entity is the
+ * "From" or "To" party.
+ */
+interface RelationshipDisplayItem {
+    /** The underlying Relationship entity record. */
+    Relationship: mjBizAppsCommonRelationshipEntity;
+    /**
+     * The human-readable label describing the relationship direction
+     * (e.g., `'Employed by'` or `'Employer of'`).
+     */
+    DirectionLabel: string;
+    /** Display name of the "other" entity in the relationship (e.g., `'Acme Corp'`). */
+    TargetName: string;
+    /**
+     * The MemberJunction entity name for the target, used for navigation
+     * (e.g., `'MJ.BizApps.Common: People'` or `'MJ.BizApps.Common: Organizations'`).
+     */
+    TargetEntityName: string;
+    /** The primary key ID of the target record, used for navigation. */
+    TargetID: string;
+    /**
+     * A formatted date range string for display
+     * (e.g., `'Jan 2020 - Present'` or `'Mar 2018 - Dec 2023'`).
+     */
+    DateDisplay: string;
+}
+/**
+ * Groups relationship display items by category for the grouped-timeline
+ * layout in the template.
+ */
+interface CategoryGroup {
+    /**
+     * The raw category key from the RelationshipType
+     * (e.g., `'PersonToOrganization'`, `'PersonToPerson'`).
+     */
+    Category: string;
+    /** Human-readable group heading (e.g., `'Employment'`, `'Personal'`). */
+    Label: string;
+    /** Font Awesome icon class for the group header. */
+    Icon: string;
+    /** CSS class applied to the icon background for color theming. */
+    IconClass: string;
+    /** The relationship display items belonging to this category. */
+    Items: RelationshipDisplayItem[];
+}
+/**
+ * Represents a single result from the target entity search typeahead,
+ * used when adding a new relationship.
+ */
+interface SearchResult {
+    /** The primary key ID of the matched Person or Organization. */
+    ID: string;
+    /** The display name of the matched record. */
+    Name: string;
+    /** Additional detail shown below the name (e.g., Title for people, Type for orgs). */
+    Detail: string;
+}
+/**
+ * Form model for the "Add Relationship" panel.
+ *
+ * Fields map to the relationship entity properties plus search/selection
+ * state for the target entity typeahead.
+ */
+interface AddFormData {
+    /** The selected RelationshipType record ID. */
+    TypeID: string;
+    /** The current text in the target search input (for typeahead). */
+    TargetSearch: string;
+    /** The selected target entity's record ID (set after selection). */
+    TargetID: string;
+    /** The display name of the selected target entity. */
+    TargetName: string;
+    /** Optional title or role description for the relationship (e.g., `'CEO'`). */
+    Title: string;
+    /** ISO date string (`YYYY-MM-DD`) for the relationship start date. */
+    StartDate: string;
+    /** ISO date string (`YYYY-MM-DD`) for the relationship end date. */
+    EndDate: string;
+}
+/**
+ * Form model for the "Edit Relationship" inline panel.
+ *
+ * The target entity cannot be changed during editing -- only metadata
+ * fields (type, title, dates, status) are editable.
+ */
+interface EditFormData {
+    /** The selected RelationshipType record ID. */
+    TypeID: string;
+    /** Optional title or role description for the relationship. */
+    Title: string;
+    /** ISO date string (`YYYY-MM-DD`) for the relationship start date. */
+    StartDate: string;
+    /** ISO date string (`YYYY-MM-DD`) for the relationship end date. */
+    EndDate: string;
+    /** The current status of the relationship. */
+    Status: 'Active' | 'Inactive' | 'Ended';
+}
+/**
+ * Displays and manages relationships for a Person or Organization record,
+ * grouped by category (Employment, Personal, Business) in a timeline layout.
+ *
+ * Relationships are bidirectional: each record has From and To sides with
+ * optional Person and Organization foreign keys. The component automatically
+ * resolves direction labels and target names based on which side the current
+ * entity occupies.
+ *
+ * Supports adding new relationships with a typeahead target search, inline
+ * editing of relationship metadata, ending active relationships, and deletion.
+ *
+ * @example
+ * ```html
+ * <!-- For a Person -->
+ * <bizapps-relationship-list
+ *     [PersonID]="person.ID"
+ *     (Navigate)="onNavigate($event)">
+ * </bizapps-relationship-list>
+ *
+ * <!-- For an Organization -->
+ * <bizapps-relationship-list
+ *     [OrganizationID]="org.ID"
+ *     (Navigate)="onNavigate($event)">
+ * </bizapps-relationship-list>
+ * ```
+ */
+export declare class RelationshipListComponent {
+    private cdr;
+    /**
+     * Emitted when the user clicks a relationship target name to navigate
+     * to that Person or Organization record.
+     *
+     * The event payload is a {@link FormNavigationEvent} (specifically a
+     * {@link RecordNavigationEvent}) containing the target entity name,
+     * composite key, and whether to open in a new tab.
+     *
+     * @fires Navigate When the user clicks a target entity link
+     *
+     * @example
+     * ```html
+     * <bizapps-relationship-list
+     *     [PersonID]="person.ID"
+     *     (Navigate)="onNavigate($event)">
+     * </bizapps-relationship-list>
+     * ```
+     */
+    Navigate: EventEmitter<FormNavigationEvent>;
+    /**
+     * Controls whether add, edit, delete, and end-relationship actions are available.
+     * When `false`, the component renders in read-only display mode.
+     * Navigation links to related entities remain available regardless of this setting.
+     */
+    EditMode: boolean;
+    /** Emitted after any mutation (save, delete, end-relationship) so the parent can refresh derived data. */
+    DataChanged: EventEmitter<void>;
+    private _personID;
+    private _organizationID;
+    /**
+     * The Person record ID whose relationships should be displayed.
+     *
+     * Mutually exclusive with {@link OrganizationID}. Setting this triggers
+     * a data reload unless the value has not changed.
+     *
+     * @example `'A1B2C3D4-E5F6-7890-ABCD-EF1234567890'`
+     */
+    set PersonID(value: string | null);
+    get PersonID(): string | null;
+    /**
+     * The Organization record ID whose relationships should be displayed.
+     *
+     * Mutually exclusive with {@link PersonID}. Setting this triggers
+     * a data reload unless the value has not changed.
+     *
+     * @example `'B2C3D4E5-F6A7-8901-BCDE-F12345678901'`
+     */
+    set OrganizationID(value: string | null);
+    get OrganizationID(): string | null;
+    /**
+     * Relationships grouped by category (Employment, Personal, Business),
+     * each containing an array of display items. This is the primary data
+     * structure consumed by the template for rendering the grouped timeline.
+     */
+    GroupedRelationships: CategoryGroup[];
+    /**
+     * All active relationship types available for selection in type dropdowns.
+     * Loaded from `MJ.BizApps.Common: Relationship Types`, filtered to `IsActive=1`.
+     */
+    RelationshipTypes: mjBizAppsCommonRelationshipTypeEntity[];
+    /**
+     * Indicates whether the component is performing the initial data load.
+     * The template shows a loading spinner while this is `true`.
+     */
+    Loading: boolean;
+    /**
+     * Indicates whether a save, delete, or end-relationship operation is in progress.
+     * Used to disable action buttons and show spinner feedback while `true`.
+     */
+    Saving: boolean;
+    /**
+     * Controls visibility of the "Add Relationship" form panel. When `true`,
+     * the add form is displayed below the existing relationship groups.
+     */
+    ShowAddForm: boolean;
+    /**
+     * The ID of the relationship currently being edited inline, or `null`
+     * when not in edit mode.
+     */
+    EditingId: string | null;
+    /**
+     * The form model bound to the "Add Relationship" panel via two-way
+     * binding. Reset to defaults each time the add form is opened.
+     */
+    AddForm: AddFormData;
+    /**
+     * The form model bound to the inline edit panel via two-way binding.
+     * Populated from the existing relationship record when editing begins.
+     */
+    EditForm: EditFormData;
+    /**
+     * Search results from the target entity typeahead, displayed as a
+     * dropdown below the search input in the add form.
+     */
+    TargetSearchResults: SearchResult[];
+    /** Lookup map from RelationshipType ID to entity for quick access. */
+    private relationshipTypeMap;
+    /** Handle for the debounce timer used in target search. */
+    private searchDebounceTimer;
+    /** Creates a blank {@link AddFormData} with empty defaults. */
+    private createEmptyAddForm;
+    /** Creates a blank {@link EditFormData} with default status of Active. */
+    private createEmptyEditForm;
+    /**
+     * Loads relationships and relationship types from the server,
+     * then groups them by category. Resets editing state before loading.
+     */
+    private loadData;
+    /** Organizes relationships into category groups with display-friendly items. */
+    private buildGroups;
+    /** Constructs a display item from a relationship and its type, resolving direction. */
+    private buildDisplayItem;
+    /** Checks whether the current entity (Person or Org) is on the "From" side. */
+    private isCurrentEntityOnFromSide;
+    /** Returns the display name of the "To" side entity. */
+    private getToSideName;
+    /** Returns the display name of the "From" side entity. */
+    private getFromSideName;
+    /** Returns the display name of whichever side is NOT the current entity. */
+    private getOtherSideName;
+    /** Returns the entity name and ID for the "To" side. */
+    private getToSideTarget;
+    /** Returns the entity name and ID for the "From" side. */
+    private getFromSideTarget;
+    /** Returns the entity name and ID for whichever side is NOT the current entity. */
+    private getOtherSideTarget;
+    /**
+     * Emits a {@link Navigate} event to navigate to the target entity record
+     * of a relationship row.
+     *
+     * Supports Ctrl+Click / Cmd+Click to open in a new tab.
+     *
+     * @param item - The relationship display item whose target should be navigated to
+     * @param event - The mouse event, used to detect modifier keys for new-tab behavior
+     *
+     * @fires Navigate With a {@link RecordNavigationEvent} payload
+     */
+    onNavigateToTarget(item: RelationshipDisplayItem, event: MouseEvent): void;
+    /** Formats a date range into a compact display string. */
+    private formatDateRange;
+    /**
+     * Opens the "Add Relationship" form panel.
+     *
+     * Resets the add form to defaults, clears any previous search results,
+     * and closes any active inline edit.
+     */
+    onShowAdd(): void;
+    /**
+     * Closes the "Add Relationship" form panel without saving, and clears
+     * the target search results.
+     */
+    onCancelAdd(): void;
+    /**
+     * Handles a change to the relationship type in the add form.
+     *
+     * Clears the currently selected target because the category (and
+     * therefore the target entity type) may have changed.
+     */
+    onAddTypeChange(): void;
+    /**
+     * Returns the category key of the currently selected relationship type
+     * in the add form (e.g., `'PersonToOrganization'`).
+     *
+     * @returns The category string, or `'--'` if no type is selected
+     */
+    getAddCategory(): string;
+    /**
+     * Returns a user-facing label for the target entity search field based
+     * on the current add form's relationship category.
+     *
+     * @returns `'Organization'`, `'Person'`, or `'Target'` depending on category
+     */
+    getAddTargetLabel(): string;
+    /**
+     * Debounces the target search input and triggers a server-side search
+     * after a 300ms pause in typing.
+     *
+     * Called on each keystroke in the target search field.
+     */
+    onTargetSearch(): void;
+    /** Executes the debounced target search against Person or Organization entities. */
+    private performTargetSearch;
+    /**
+     * Selects a target entity from the search results dropdown, populating
+     * the add form's target fields and clearing the search input.
+     *
+     * @param result - The selected search result to use as the relationship target
+     */
+    onSelectTarget(result: SearchResult): void;
+    /**
+     * Clears the currently selected target entity from the add form,
+     * allowing the user to search for a different target.
+     */
+    onClearTarget(): void;
+    /**
+     * Persists the new relationship from the add form.
+     *
+     * Determines which From/To fields to populate based on the current
+     * entity type (Person or Organization) and the relationship category.
+     * After saving, the relationship list is reloaded.
+     */
+    onSaveAdd(): Promise<void>;
+    /**
+     * Opens the inline edit form for an existing relationship, populating
+     * the form fields from the current entity data.
+     *
+     * Closes the add form if it is currently open.
+     *
+     * @param rel - The relationship entity to edit
+     */
+    onEdit(rel: mjBizAppsCommonRelationshipEntity): void;
+    /**
+     * Cancels the current edit operation and returns to display mode.
+     */
+    onCancelEdit(): void;
+    /**
+     * Handles a change to the relationship type in the edit form.
+     *
+     * Triggers change detection so the category display updates.
+     */
+    onEditTypeChange(): void;
+    /**
+     * Returns the category key of the currently selected relationship type
+     * in the edit form (e.g., `'PersonToOrganization'`).
+     *
+     * @returns The category string, or `'--'` if no type is selected
+     */
+    getEditCategory(): string;
+    /**
+     * Persists the edited relationship from the inline edit form.
+     *
+     * Locates the relationship entity within the grouped data, applies
+     * the form values, saves, and reloads the list.
+     */
+    onSaveEdit(): Promise<void>;
+    /**
+     * Ends an active relationship by setting its status to `'Ended'` and
+     * its end date to today. After saving, the relationship list is reloaded.
+     *
+     * @param rel - The active relationship entity to end
+     */
+    onEndRelationship(rel: mjBizAppsCommonRelationshipEntity): Promise<void>;
+    /**
+     * Permanently deletes the given relationship record.
+     *
+     * After deletion, the relationship list is reloaded.
+     *
+     * @param rel - The relationship entity to delete
+     */
+    onDelete(rel: mjBizAppsCommonRelationshipEntity): Promise<void>;
+    /** Converts a Date to an ISO date string (`YYYY-MM-DD`) for HTML date inputs. */
+    private formatDateForInput;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RelationshipListComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<RelationshipListComponent, "bizapps-relationship-list", never, { "EditMode": { "alias": "EditMode"; "required": false; }; "PersonID": { "alias": "PersonID"; "required": false; }; "OrganizationID": { "alias": "OrganizationID"; "required": false; }; }, { "Navigate": "Navigate"; "DataChanged": "DataChanged"; }, never, never, true, never>;
+}
+export {};
+//# sourceMappingURL=relationship-list.component.d.ts.map

package/dist/lib/components/relationship-list/relationship-list.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relationship-list.component.d.ts","sourceRoot":"","sources":["../../../../src/lib/components/relationship-list/relationship-list.component.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,YAAY,EAA6B,MAAM,eAAe,CAAC;AAIlG,OAAO,EAAE,mBAAmB,EAAyB,MAAM,+BAA+B,CAAC;AAC3F,OAAO,EACH,iCAAiC,EACjC,qCAAqC,EAGxC,MAAM,8BAA8B,CAAC;;AAEtC;;;;;;;GAOG;AACH,UAAU,uBAAuB;IAC7B,iDAAiD;IACjD,YAAY,EAAE,iCAAiC,CAAC;IAEhD;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,oFAAoF;IACpF,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,oEAAoE;IACpE,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,UAAU,aAAa;IACnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,yEAAyE;IACzE,KAAK,EAAE,MAAM,CAAC;IAEd,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC;IAEb,kEAAkE;IAClE,SAAS,EAAE,MAAM,CAAC;IAElB,iEAAiE;IACjE,KAAK,EAAE,uBAAuB,EAAE,CAAC;CACpC;AAED;;;GAGG;AACH,UAAU,YAAY;IAClB,gEAAgE;IAChE,EAAE,EAAE,MAAM,CAAC;IAEX,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IAEb,sFAAsF;IACtF,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,UAAU,WAAW;IACjB,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IAEf,mEAAmE;IACnE,YAAY,EAAE,MAAM,CAAC;IAErB,oEAAoE;IACpE,QAAQ,EAAE,MAAM,CAAC;IAEjB,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;IAEnB,+EAA+E;IAC/E,KAAK,EAAE,MAAM,CAAC;IAEd,sEAAsE;IACtE,SAAS,EAAE,MAAM,CAAC;IAElB,oEAAoE;IACpE,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,UAAU,YAAY;IAClB,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IAEf,+DAA+D;IAC/D,KAAK,EAAE,MAAM,CAAC;IAEd,sEAAsE;IACtE,SAAS,EAAE,MAAM,CAAC;IAElB,oEAAoE;IACpE,OAAO,EAAE,MAAM,CAAC;IAEhB,8CAA8C;IAC9C,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;CAC3C;AAeD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAOa,yBAAyB;IAClC,OAAO,CAAC,GAAG,CAA6B;IAExC;;;;;;;;;;;;;;;;;OAiBG;IACO,QAAQ,oCAA2C;IAE7D;;;;OAIG;IACM,QAAQ,UAAS;IAE1B,0GAA0G;IAChG,WAAW,qBAA4B;IAEjD,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,eAAe,CAAuB;IAE9C;;;;;;;OAOG;IACH,IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAMhC;IACD,IAAI,QAAQ,IAAI,MAAM,GAAG,IAAI,CAA2B;IAExD;;;;;;;OAOG;IACH,IACI,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAMtC;IACD,IAAI,cAAc,IAAI,MAAM,GAAG,IAAI,CAAiC;IAEpE;;;;OAIG;IACH,oBAAoB,EAAE,aAAa,EAAE,CAAM;IAE3C;;;OAGG;IACH,iBAAiB,EAAE,qCAAqC,EAAE,CAAM;IAEhE;;;OAGG;IACH,OAAO,UAAS;IAEhB;;;OAGG;IACH,MAAM,UAAS;IAEf;;;OAGG;IACH,WAAW,UAAS;IAEpB;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEhC;;;OAGG;IACH,OAAO,EAAE,WAAW,CAA6B;IAEjD;;;OAGG;IACH,QAAQ,EAAE,YAAY,CAA8B;IAEpD;;;OAGG;IACH,mBAAmB,EAAE,YAAY,EAAE,CAAM;IAEzC,sEAAsE;IACtE,OAAO,CAAC,mBAAmB,CAA4D;IAEvF,2DAA2D;IAC3D,OAAO,CAAC,mBAAmB,CAA8C;IAEzE,+DAA+D;IAC/D,OAAO,CAAC,kBAAkB;IAI1B,0EAA0E;IAC1E,OAAO,CAAC,mBAAmB;IAI3B;;;OAGG;YACW,QAAQ;IAwDtB,gFAAgF;IAChF,OAAO,CAAC,WAAW;IA8BnB,uFAAuF;IACvF,OAAO,CAAC,gBAAgB;IA6CxB,+EAA+E;IAC/E,OAAO,CAAC,yBAAyB;IAUjC,wDAAwD;IACxD,OAAO,CAAC,aAAa;IAIrB,0DAA0D;IAC1D,OAAO,CAAC,eAAe;IAIvB,4EAA4E;IAC5E,OAAO,CAAC,gBAAgB;IAIxB,wDAAwD;IACxD,OAAO,CAAC,eAAe;IAMvB,0DAA0D;IAC1D,OAAO,CAAC,iBAAiB;IAMzB,mFAAmF;IACnF,OAAO,CAAC,kBAAkB;IAI1B;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,IAAI,EAAE,uBAAuB,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI;IAa1E,0DAA0D;IAC1D,OAAO,CAAC,eAAe;IAkBvB;;;;;OAKG;IACH,SAAS,IAAI,IAAI;IAQjB;;;OAGG;IACH,WAAW,IAAI,IAAI;IAMnB;;;;;OAKG;IACH,eAAe,IAAI,IAAI;IASvB;;;;;OAKG;IACH,cAAc,IAAI,MAAM;IAMxB;;;;;OAKG;IACH,iBAAiB,IAAI,MAAM;IAQ3B;;;;;OAKG;IACH,cAAc,IAAI,IAAI;IAStB,oFAAoF;YACtE,mBAAmB;IAiDjC;;;;;OAKG;IACH,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAQ1C;;;OAGG;IACH,aAAa,IAAI,IAAI;IAMrB;;;;;;OAMG;IACG,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAkDhC;;;;;;;OAOG;IACH,MAAM,CAAC,GAAG,EAAE,iCAAiC,GAAG,IAAI;IAapD;;OAEG;IACH,YAAY,IAAI,IAAI;IAKpB;;;;OAIG;IACH,gBAAgB,IAAI,IAAI;IAIxB;;;;;OAKG;IACH,eAAe,IAAI,MAAM;IAMzB;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAmCjC;;;;;OAKG;IACG,iBAAiB,CAAC,GAAG,EAAE,iCAAiC,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB9E;;;;;;OAMG;IACG,QAAQ,CAAC,GAAG,EAAE,iCAAiC,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBrE,iFAAiF;IACjF,OAAO,CAAC,kBAAkB;yCA9sBjB,yBAAyB;2CAAzB,yBAAyB;CAqtBrC"}