@memberjunction/ng-entity-card 0.0.1 → 5.25.0

package/dist/lib/entity-card.component.d.ts

@@ -0,0 +1,171 @@
+import { EventEmitter, OnChanges, SimpleChanges } from '@angular/core';
+import { EntityInfo } from '@memberjunction/core';
+import { EntityCardVariant, CardTemplate, CardDisplayField, CancelableCardEvent, CardRecordEvent } from './entity-card.types';
+import * as i0 from "@angular/core";
+/**
+ * `MJEntityCardComponent` — A generic, metadata-driven entity record card.
+ *
+ * Renders a single entity record as a visual card with automatically prioritized
+ * fields based on MemberJunction entity metadata (`IsNameField`, `DefaultInView`,
+ * `Sequence`). Designed to work with both full entity records and sparse vector
+ * metadata from the Knowledge Hub.
+ *
+ * ## Variants
+ * - `compact` — Tooltip-sized. Title + 2-3 key fields. No avatar.
+ * - `card` — Grid card. Avatar + title + subtitle + display fields + badge.
+ * - `detail` — Full panel. All available fields with labels.
+ *
+ * ## Field Resolution
+ * 1. **Title**: All `IsNameField` fields combined in Sequence order
+ * 2. **Primary fields**: `DefaultInView=true` sorted by Sequence
+ * 3. **Fallback**: First 5 non-PK/FK fields when no metadata flags are set
+ *
+ * ## Events
+ * All interactions follow the `BeforeXXX` / `AfterXXX` cancelable event pattern.
+ * Set `event.Cancel = true` in a `BeforeXXX` handler to prevent the default action.
+ *
+ * @example
+ * ```html
+ * <!-- From entity name + vector metadata -->
+ * <mj-entity-card
+ *     [EntityName]="'Members'"
+ *     [Record]="vectorMetadata"
+ *     Variant="card"
+ *     (CardClicked)="onCardClick($event)">
+ * </mj-entity-card>
+ *
+ * <!-- From EntityInfo + full record -->
+ * <mj-entity-card
+ *     [Entity]="entityInfo"
+ *     [Record]="record.GetAll()"
+ *     Variant="detail"
+ *     [ShowOpenButton]="true"
+ *     (OpenRequested)="onOpen($event)">
+ * </mj-entity-card>
+ * ```
+ *
+ * @selector mj-entity-card
+ */
+export declare class MJEntityCardComponent implements OnChanges {
+    private cdr;
+    /**
+     * The entity name (e.g., "Members"). Used to look up `EntityInfo` from
+     * the MJ Metadata cache. Mutually exclusive with `Entity` — if both are
+     * provided, `Entity` takes precedence.
+     */
+    EntityName: string | null;
+    /**
+     * Pre-resolved EntityInfo object. Takes precedence over `EntityName`.
+     * Use this when you already have the EntityInfo to avoid a redundant lookup.
+     */
+    Entity: EntityInfo | null;
+    /**
+     * The record data as a plain key-value object. Works with both full entity
+     * records (`record.GetAll()`) and sparse vector metadata.
+     *
+     * Fields not present in the record are gracefully skipped in the display.
+     */
+    Record: Record<string, unknown>;
+    /**
+     * Visual variant controlling size, layout, and detail level.
+     * @default 'card'
+     */
+    Variant: EntityCardVariant;
+    /**
+     * Custom card template. When provided, overrides the auto-generated template.
+     * Use `GenerateCardTemplate()` from the types module to build one programmatically.
+     */
+    Template: CardTemplate | null;
+    /**
+     * Maximum number of display fields in the card body.
+     * Only applies when using the auto-generated template.
+     * @default 4 for 'card', 2 for 'compact', unlimited for 'detail'
+     */
+    MaxDisplayFields: number | null;
+    /**
+     * Whether to show the entity icon/avatar.
+     * @default true for 'card', false for 'compact', true for 'detail'
+     */
+    ShowAvatar: boolean | null;
+    /**
+     * Whether to show the "Open Record" button.
+     * @default false
+     */
+    ShowOpenButton: boolean;
+    /**
+     * Whether to show field labels alongside values.
+     * @default true for 'detail', false for 'compact', true for 'card'
+     */
+    ShowFieldLabels: boolean | null;
+    /**
+     * CSS class to apply to the outer container for custom styling.
+     */
+    CssClass: string;
+    /**
+     * Fires before the card is clicked. Set `Cancel = true` to prevent
+     * the `CardClicked` event from firing.
+     */
+    BeforeCardClick: EventEmitter<CancelableCardEvent<CardRecordEvent>>;
+    /** Fires after the card is clicked (if not canceled). */
+    CardClicked: EventEmitter<CardRecordEvent>;
+    /**
+     * Fires before the "Open Record" button is clicked. Set `Cancel = true`
+     * to prevent the `OpenRequested` event from firing.
+     */
+    BeforeOpen: EventEmitter<CancelableCardEvent<CardRecordEvent>>;
+    /** Fires when the "Open Record" button is clicked (if not canceled). */
+    OpenRequested: EventEmitter<CardRecordEvent>;
+    /** The resolved EntityInfo (from Entity input or EntityName lookup) */
+    ResolvedEntity: EntityInfo | null;
+    /** The effective card template (custom or auto-generated) */
+    EffectiveTemplate: CardTemplate | null;
+    /** The combined title string */
+    Title: string;
+    /** The entity icon class (from vector metadata or entity info) */
+    EntityIcon: string;
+    /** Resolved entity display name */
+    EntityDisplayName: string;
+    ngOnChanges(changes: SimpleChanges): void;
+    /** @internal Handle card click with cancelable before/after pattern */
+    OnCardClick(): void;
+    /** @internal Handle open button click with cancelable before/after pattern */
+    OnOpenClick(event: MouseEvent): void;
+    /** Get the resolved display fields, respecting maxFields for variant */
+    get DisplayFields(): CardDisplayField[];
+    /** Whether to show the avatar based on variant and input */
+    get ShouldShowAvatar(): boolean;
+    /** Whether to show field labels based on variant and input */
+    get ShouldShowLabels(): boolean;
+    /** Get formatted value for a display field */
+    GetFieldValue(field: CardDisplayField): string;
+    /** Get the label for a field */
+    GetFieldLabel(fieldName: string): string;
+    /** Get initials from the title for avatar fallback */
+    get Initials(): string;
+    /** Get a deterministic color for the avatar based on the record */
+    get AvatarColor(): string;
+    /** Get the subtitle value */
+    get Subtitle(): string;
+    /** Get the description value */
+    get Description(): string;
+    /** Check if a thumbnail is available */
+    get HasThumbnail(): boolean;
+    /** Get the thumbnail URL or icon class */
+    get ThumbnailValue(): string;
+    /** Whether the thumbnail is an image URL */
+    get ThumbnailIsImage(): boolean;
+    /** Whether the thumbnail is an icon class */
+    get ThumbnailIsIcon(): boolean;
+    private get ResolvedMaxFields();
+    private resolve;
+    private resolveEntity;
+    private resolveTemplate;
+    private resolveTitle;
+    private resolveEntityIcon;
+    private resolveEntityDisplayName;
+    private FormatValue;
+    private BuildEventPayload;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MJEntityCardComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MJEntityCardComponent, "mj-entity-card", never, { "EntityName": { "alias": "EntityName"; "required": false; }; "Entity": { "alias": "Entity"; "required": false; }; "Record": { "alias": "Record"; "required": false; }; "Variant": { "alias": "Variant"; "required": false; }; "Template": { "alias": "Template"; "required": false; }; "MaxDisplayFields": { "alias": "MaxDisplayFields"; "required": false; }; "ShowAvatar": { "alias": "ShowAvatar"; "required": false; }; "ShowOpenButton": { "alias": "ShowOpenButton"; "required": false; }; "ShowFieldLabels": { "alias": "ShowFieldLabels"; "required": false; }; "CssClass": { "alias": "CssClass"; "required": false; }; }, { "BeforeCardClick": "BeforeCardClick"; "CardClicked": "CardClicked"; "BeforeOpen": "BeforeOpen"; "OpenRequested": "OpenRequested"; }, never, never, true, never>;
+}
+//# sourceMappingURL=entity-card.component.d.ts.map

package/dist/lib/entity-card.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-card.component.d.ts","sourceRoot":"","sources":["../../src/lib/entity-card.component.ts"],"names":[],"mappings":"AAAA,OAAO,EACuB,YAAY,EACtC,SAAS,EAAE,aAAa,EAC3B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAY,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EACH,iBAAiB,EAAE,YAAY,EAAE,gBAAgB,EACjD,mBAAmB,EAAE,eAAe,EAGvC,MAAM,qBAAqB,CAAC;;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,qBAOa,qBAAsB,YAAW,SAAS;IACnD,OAAO,CAAC,GAAG,CAA6B;IAMxC;;;;OAIG;IACM,UAAU,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE1C;;;OAGG;IACM,MAAM,EAAE,UAAU,GAAG,IAAI,CAAQ;IAE1C;;;;;OAKG;IACM,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM;IAE9C;;;OAGG;IACM,OAAO,EAAE,iBAAiB,CAAU;IAM7C;;;OAGG;IACM,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAQ;IAE9C;;;;OAIG;IACM,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEhD;;;OAGG;IACM,UAAU,EAAE,OAAO,GAAG,IAAI,CAAQ;IAE3C;;;OAGG;IACM,cAAc,UAAS;IAEhC;;;OAGG;IACM,eAAe,EAAE,OAAO,GAAG,IAAI,CAAQ;IAEhD;;OAEG;IACM,QAAQ,SAAM;IAMvB;;;OAGG;IACO,eAAe,qDAA4D;IAErF,yDAAyD;IAC/C,WAAW,gCAAuC;IAE5D;;;OAGG;IACO,UAAU,qDAA4D;IAEhF,wEAAwE;IAC9D,aAAa,gCAAuC;IAM9D,uEAAuE;IAChE,cAAc,EAAE,UAAU,GAAG,IAAI,CAAQ;IAEhD,6DAA6D;IACtD,iBAAiB,EAAE,YAAY,GAAG,IAAI,CAAQ;IAErD,gCAAgC;IACzB,KAAK,SAAM;IAElB,kEAAkE;IAC3D,UAAU,SAAM;IAEvB,mCAAmC;IAC5B,iBAAiB,SAAM;IAM9B,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAUzC,uEAAuE;IAChE,WAAW,IAAI,IAAI;IAS1B,8EAA8E;IACvE,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAc3C,wEAAwE;IACxE,IAAW,aAAa,IAAI,gBAAgB,EAAE,CAI7C;IAED,4DAA4D;IAC5D,IAAW,gBAAgB,IAAI,OAAO,CAGrC;IAED,8DAA8D;IAC9D,IAAW,gBAAgB,IAAI,OAAO,CAGrC;IAED,8CAA8C;IACvC,aAAa,CAAC,KAAK,EAAE,gBAAgB,GAAG,MAAM;IAMrD,gCAAgC;IACzB,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAI/C,sDAAsD;IACtD,IAAW,QAAQ,IAAI,MAAM,CAK5B;IAED,mEAAmE;IACnE,IAAW,WAAW,IAAI,MAAM,CAW/B;IAED,6BAA6B;IAC7B,IAAW,QAAQ,IAAI,MAAM,CAI5B;IAED,gCAAgC;IAChC,IAAW,WAAW,IAAI,MAAM,CAM/B;IAED,wCAAwC;IACxC,IAAW,YAAY,IAAI,OAAO,CAMjC;IAED,0CAA0C;IAC1C,IAAW,cAAc,IAAI,MAAM,CAOlC;IAED,4CAA4C;IAC5C,IAAW,gBAAgB,IAAI,OAAO,CAGrC;IAED,6CAA6C;IAC7C,IAAW,eAAe,IAAI,OAAO,CAGpC;IAMD,OAAO,KAAK,iBAAiB,GAO5B;IAED,OAAO,CAAC,OAAO;IASf,OAAO,CAAC,aAAa;IAWrB,OAAO,CAAC,eAAe;IAwBvB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,wBAAwB;IAMhC,OAAO,CAAC,WAAW;IA+BnB,OAAO,CAAC,iBAAiB;yCA5WhB,qBAAqB;2CAArB,qBAAqB;CAmXjC"}