@memberjunction/ng-entity-viewer 5.39.0 → 5.40.0

package/dist/lib/view-types/renderers/timeline-view-renderer.component.d.ts

@@ -0,0 +1,176 @@
+import { EventEmitter, OnInit } from '@angular/core';
+import { EntityInfo, EntityFieldInfo } from '@memberjunction/core';
+import { BaseAngularComponent } from '@memberjunction/ng-base-types';
+import { TimelineGroup, TimeSegmentGrouping, TimelineSortOrder, AfterEventClickArgs } from '@memberjunction/ng-timeline';
+import { TimelineOrientation } from '../../types';
+import { IViewRenderer } from '../view-type.contracts';
+import * as i0 from "@angular/core";
+/**
+ * The persisted configuration shape for the Timeline view type.
+ *
+ * This is the `config` payload the host hands to the renderer on mount and that the
+ * renderer emits back (in full) via {@link TimelineViewRendererComponent.configChanged}
+ * whenever the user changes any of the timeline chrome controls. The host treats it as an
+ * opaque blob — only this renderer (and an eventual prop-sheet) understands its keys — and
+ * persists it per `MJ: View Types` row.
+ *
+ * All fields are optional: on first mount the renderer falls back to sensible defaults
+ * (first available date field, vertical orientation, descending sort, monthly segments).
+ */
+export interface TimelineViewConfig {
+    /** The entity date-field used to place records on the timeline (e.g. `__mj_CreatedAt`). */
+    dateFieldName?: string;
+    /** Vertical (alternating) vs. horizontal (single-row) timeline layout. */
+    orientation?: TimelineOrientation;
+    /** Newest-first (`desc`) vs. oldest-first (`asc`) event ordering. */
+    sortOrder?: TimelineSortOrder;
+    /** How events are bucketed into collapsible segments (day/week/month/...). */
+    segmentGrouping?: TimeSegmentGrouping;
+}
+/**
+ * TimelineViewRendererComponent
+ * -----------------------------
+ * The Timeline **view type** as a self-contained {@link IViewRenderer} plug-in. Where the
+ * Timeline view used to be hard-wired into the generic `mj-entity-viewer` host (which owned
+ * the date-field detection, the record→{@link TimelineGroup} transformation, and the
+ * date-field / orientation / sort chrome), this component now OWNS all of it. The host simply
+ * dynamic-mounts this renderer when Timeline is the active view type and feeds it the standard
+ * renderer inputs (`entity` / `records` / `selectedRecordId` / `filterText` / `config`).
+ *
+ * It renders a small chrome header row (date-field selector + orientation toggle + sort toggle)
+ * above a flex-filling `<mj-timeline>`, exactly reproducing the host's previous timeline chrome
+ * and bindings. Because the host only mounts this plug-in when Timeline is active, the chrome
+ * always renders — no extra `EffectiveViewMode === 'timeline'` guard is needed.
+ *
+ * **What was absorbed from the host** (`EntityViewerComponent`): `detectDateFields()`,
+ * `sortDateFieldsByPriority()`, `AvailableDateFields`/`HasDateFields`, `configureTimeline()`,
+ * `updateTimelineGroups()` (+ `findTitleField`/`findDescriptionField`/`findSubtitleField`),
+ * `ToggleTimelineOrientation()`, `ToggleTimelineSortOrder()`, `SetTimelineDateField()`,
+ * `SelectedDateFieldDisplayName`, `OnTimelineEventClick()`, and the `TimelineSelectedEventID`
+ * composite-key→raw-id derivation.
+ *
+ * Inputs use the camelCase names mandated by the {@link IViewRenderer} contract (the host binds
+ * them by those exact names) rather than MJ's usual PascalCase for public members.
+ */
+export declare class TimelineViewRendererComponent extends BaseAngularComponent implements IViewRenderer<TimelineViewConfig>, OnInit {
+    private _entity;
+    /** The entity whose records are being rendered. Re-detects date fields + rebuilds groups on change. */
+    set entity(value: EntityInfo | null);
+    get entity(): EntityInfo | null;
+    private _records;
+    /** The records to render (already loaded/filtered by the host). Rebuilds groups on change. */
+    set records(value: Record<string, unknown>[]);
+    get records(): Record<string, unknown>[];
+    /** Primary-key string of the currently selected record, if any (composite-key encoded). */
+    selectedRecordId: string | null;
+    /** Active filter text — accepted for contract uniformity; the host pre-filters `records`. */
+    filterText: string | null;
+    private _config;
+    /**
+     * This view's persisted configuration. Seeding the chrome controls from it is deferred to
+     * {@link applyConfigToState}, called both here (for late updates) and in {@link ngOnInit}
+     * (for the initial mount, where the host sets `config` via `setInput` before init runs).
+     */
+    set config(value: TimelineViewConfig);
+    get config(): TimelineViewConfig;
+    /** Emitted when a timeline event is clicked — payload is the RAW record object. */
+    recordSelected: EventEmitter<unknown>;
+    /** Emitted when a record should be opened — payload is the RAW record object. */
+    recordOpened: EventEmitter<unknown>;
+    /** Emitted (with the FULL updated config) whenever the user changes a chrome control. */
+    configChanged: EventEmitter<TimelineViewConfig>;
+    /** Whether the current entity has any date fields available for timeline view. */
+    HasDateFields: boolean;
+    /** Available date fields from the entity, sorted by priority. */
+    AvailableDateFields: EntityFieldInfo[];
+    /** The currently selected date field name for the timeline. */
+    SelectedTimelineDateField: string | null;
+    /** The built timeline groups handed to `<mj-timeline>`. */
+    TimelineGroups: TimelineGroup<Record<string, unknown>>[];
+    /**
+     * Timeline sort order. Named `…State` (not `TimelineSortOrder`) to avoid colliding with the
+     * imported {@link TimelineSortOrder} type symbol used in the template / signatures.
+     */
+    TimelineSortOrderState: TimelineSortOrder;
+    /** Timeline segment grouping (day/week/month/...). */
+    TimelineSegmentGrouping: TimeSegmentGrouping;
+    /**
+     * Timeline orientation. Named `…State` to avoid colliding with the imported
+     * {@link TimelineOrientation} type symbol.
+     */
+    TimelineOrientationState: TimelineOrientation;
+    private _initialized;
+    private cdr;
+    ngOnInit(): void;
+    /** Display name of the currently selected timeline date field. */
+    get SelectedDateFieldDisplayName(): string;
+    /**
+     * The raw ID value derived from {@link selectedRecordId} for timeline selection. The host
+     * passes the selection in composite-key format (`ID|abc-123` or `ID=abc-123`), but the
+     * timeline stores just the raw ID value — so strip the field-name prefix.
+     */
+    get TimelineSelectedEventID(): string | null;
+    /** Toggle timeline orientation between vertical and horizontal, then persist via config. */
+    ToggleTimelineOrientation(): void;
+    /** Toggle timeline sort order between newest-first (desc) and oldest-first (asc), then persist. */
+    ToggleTimelineSortOrder(): void;
+    /** Change the date field used for the timeline, rebuild groups, then persist via config. */
+    SetTimelineDateField(fieldName: string): void;
+    /**
+     * Handle a timeline event click. Maps the {@link AfterEventClickArgs} to the underlying raw
+     * record (`event.event.entity`) and emits it on {@link recordSelected}. The host's dynamic
+     * handler builds the composite key from the raw record, so we emit the record object as-is.
+     */
+    OnTimelineEventClick(event: AfterEventClickArgs): void;
+    /**
+     * Seed the chrome control state from {@link config}, applying sensible defaults where the
+     * config is silent (vertical orientation, descending sort, monthly segments). The selected
+     * date field is resolved against the currently-available date fields in {@link detectDateFields}.
+     */
+    private applyConfigToState;
+    /** Emit the FULL current config object so the host can persist the change. */
+    private emitConfigChange;
+    /**
+     * Detect the entity's date fields and configure the timeline. Resolves the selected date
+     * field (preferring the configured one, falling back to the highest-priority available field)
+     * and rebuilds the groups. No-ops to an empty state when the entity has no date fields.
+     */
+    private detectDateFields;
+    /**
+     * Sort date fields by priority: `DefaultInView` fields first (by Sequence), then the rest
+     * (by Sequence).
+     */
+    private sortDateFieldsByPriority;
+    /**
+     * Resolve which date field to use: the configured `dateFieldName` when it's still a valid
+     * available field, otherwise the first (highest-priority) available date field.
+     */
+    private getEffectiveTimelineDateField;
+    /**
+     * Build the single {@link TimelineGroup} for the current entity + records + selected date
+     * field, mirroring the host's previous `updateTimelineGroups()`. No-ops to an empty state
+     * when there is no entity or no selected date field.
+     */
+    private updateTimelineGroups;
+    /**
+     * Find the best field to use as the event title: the entity's NameField, then a
+     * `DefaultInView` string field matching a common name pattern, then the first string field.
+     */
+    private findTitleField;
+    /** Find a suitable description field by common naming pattern, or null. */
+    private findDescriptionField;
+    /**
+     * Find a suitable subtitle field (different from the title): a `DefaultInView` string field
+     * matching a classification pattern (status/type/category/...), else the first other string
+     * field, else null.
+     */
+    private findSubtitleField;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TimelineViewRendererComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<TimelineViewRendererComponent, "mj-timeline-view-renderer", never, { "entity": { "alias": "entity"; "required": false; }; "records": { "alias": "records"; "required": false; }; "selectedRecordId": { "alias": "selectedRecordId"; "required": false; }; "filterText": { "alias": "filterText"; "required": false; }; "config": { "alias": "config"; "required": false; }; }, { "recordSelected": "recordSelected"; "recordOpened": "recordOpened"; "configChanged": "configChanged"; }, never, never, false, never>;
+}
+/**
+ * Tree-shaking guard. Force-references the component class so bundlers don't drop this module
+ * when it's only mounted dynamically via the view-type descriptor's `RendererComponent`.
+ */
+export declare function LoadTimelineViewRenderer(): void;
+//# sourceMappingURL=timeline-view-renderer.component.d.ts.map

package/dist/lib/view-types/renderers/timeline-view-renderer.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeline-view-renderer.component.d.ts","sourceRoot":"","sources":["../../../../src/lib/view-types/renderers/timeline-view-renderer.component.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,YAAY,EAEZ,MAAM,EAGP,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,UAAU,EAAE,eAAe,EAAqB,MAAM,sBAAsB,CAAC;AAEtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;;AAEvD;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,kBAAkB;IACjC,2FAA2F;IAC3F,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0EAA0E;IAC1E,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,qEAAqE;IACrE,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,8EAA8E;IAC9E,eAAe,CAAC,EAAE,mBAAmB,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAiLa,6BACX,SAAQ,oBACR,YAAW,aAAa,CAAC,kBAAkB,CAAC,EAAE,MAAM;IAMpD,OAAO,CAAC,OAAO,CAA2B;IAC1C,uGAAuG;IACvG,IACI,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,EAOlC;IACD,IAAI,MAAM,IAAI,UAAU,GAAG,IAAI,CAE9B;IAED,OAAO,CAAC,QAAQ,CAAiC;IACjD,8FAA8F;IAC9F,IACI,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAI3C;IACD,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAEvC;IAED,2FAA2F;IAClF,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEhD,6FAA6F;IACpF,UAAU,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE1C,OAAO,CAAC,OAAO,CAA0B;IACzC;;;;OAIG;IACH,IACI,MAAM,CAAC,KAAK,EAAE,kBAAkB,EAMnC;IACD,IAAI,MAAM,IAAI,kBAAkB,CAE/B;IAMD,mFAAmF;IACzE,cAAc,wBAA+B;IAEvD,iFAAiF;IACvE,YAAY,wBAA+B;IAErD,yFAAyF;IAC/E,aAAa,mCAA0C;IAMjE,kFAAkF;IAC3E,aAAa,UAAS;IAE7B,iEAAiE;IAC1D,mBAAmB,EAAE,eAAe,EAAE,CAAM;IAEnD,+DAA+D;IACxD,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEvD,2DAA2D;IACpD,cAAc,EAAE,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,CAAM;IAErE;;;OAGG;IACI,sBAAsB,EAAE,iBAAiB,CAAU;IAE1D,sDAAsD;IAC/C,uBAAuB,EAAE,mBAAmB,CAAW;IAE9D;;;OAGG;IACI,wBAAwB,EAAE,mBAAmB,CAAc;IAElE,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,GAAG,CAA6B;IAMxC,QAAQ,IAAI,IAAI;IAahB,kEAAkE;IAClE,IAAI,4BAA4B,IAAI,MAAM,CAMzC;IAED;;;;OAIG;IACH,IAAI,uBAAuB,IAAI,MAAM,GAAG,IAAI,CAa3C;IAMD,4FAA4F;IAC5F,yBAAyB,IAAI,IAAI;IAMjC,mGAAmG;IACnG,uBAAuB,IAAI,IAAI;IAM/B,4FAA4F;IAC5F,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAa7C;;;;OAIG;IACH,oBAAoB,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAWtD;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAO1B,8EAA8E;IAC9E,OAAO,CAAC,gBAAgB;IAcxB;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAsBxB;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAMhC;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAcrC;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAyC5B;;;OAGG;IACH,OAAO,CAAC,cAAc;IAuBtB,2EAA2E;IAC3E,OAAO,CAAC,oBAAoB;IAiB5B;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;yCA1Xd,6BAA6B;2CAA7B,6BAA6B;CAiZzC;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,IAAI,IAAI,CAG/C"}