@memberjunction/ng-record-changes 5.27.1 → 5.28.0

package/dist/lib/restore-preview-panel/restore-preview-panel.component.d.ts

@@ -0,0 +1,267 @@
+import { ChangeDetectorRef, EventEmitter, OnInit } from '@angular/core';
+import { BaseEntity } from '@memberjunction/core';
+import { MJRecordChangeEntity } from '@memberjunction/core-entities';
+import * as i0 from "@angular/core";
+/**
+ * Mode controls how the preview is rendered and how the restore is interpreted.
+ *
+ * - `'live'`: target record exists; the preview shows a current-vs-restore
+ *   diff per field. Confirming applies the snapshot to the live record and
+ *   triggers an UPDATE.
+ * - `'undelete'`: target record was hard-deleted. The preview shows the
+ *   snapshot fields that will be inserted; confirming triggers an INSERT.
+ */
+export type RestorePreviewMode = 'live' | 'undelete';
+/**
+ * One row in the restore preview table.
+ *
+ * Renders as a checkbox + field name + (current / restore) values. The
+ * `IsChanged` flag drives the default-checked state and the row's visual
+ * treatment. `IsMissingInSchema` and `IsFKMissing` surface drift warnings.
+ */
+export interface RestoreFieldRow {
+    /** Raw field name (matches EntityField.Name). */
+    FieldName: string;
+    /** Friendly label (EntityField.DisplayNameOrName). */
+    DisplayName: string;
+    /** Formatted current value of the live record (empty in undelete mode). */
+    CurrentValue: string;
+    /** Formatted snapshot value that would be applied. */
+    RestoreValue: string;
+    /** Raw snapshot value (the value passed to BaseEntity.Set). */
+    RawRestoreValue: unknown;
+    /** True when CurrentValue and RestoreValue differ. Drives default checked. */
+    IsChanged: boolean;
+    /** User's selection — when true, this field will be applied on restore. */
+    Selected: boolean;
+    /** True when the snapshot references a field that no longer exists on the entity. */
+    IsMissingInSchema: boolean;
+    /** True when the field is a FK whose target row no longer exists (best-effort). */
+    IsFKMissing: boolean;
+    /** True when the field is read-only / system / PK and cannot be restored. */
+    IsImmutable: boolean;
+}
+/**
+ * Cancelable event fired immediately after the user clicks Restore but
+ * before {@link RestorePreviewPanelComponent.RestoreConfirmed} emits.
+ *
+ * Consumers can set `cancel = true` (and optionally `cancelReason`) to abort
+ * the restore — useful for custom approval workflows, audit logging hooks,
+ * or for a consumer that wants to take over the actual save itself.
+ */
+export interface BeforeRestoreCommitEvent {
+    /** Set to true to abort. RestoreConfirmed will not fire. */
+    cancel: boolean;
+    /** Optional explanation surfaced by the consumer. */
+    cancelReason?: string;
+    /** Selected field names (only fields the user kept checked). */
+    SelectedFieldNames: string[];
+    /** The full set of rows in the preview, including unselected. */
+    AllRows: RestoreFieldRow[];
+    /** ID of the source RecordChange row whose state is being restored. */
+    SourceChangeID: string;
+    /** Optional reason text the user entered. */
+    Reason: string | null;
+    /** The mode — 'live' (UPDATE) or 'undelete' (INSERT). */
+    Mode: RestorePreviewMode;
+}
+/**
+ * Event payload emitted after the user has confirmed a restore.
+ *
+ * The host component is responsible for applying the snapshot to a
+ * BaseEntity instance, calling {@link BaseEntity.SetRestoreContext}, and
+ * invoking Save(). This component never touches the database directly so
+ * it remains usable in any consumer context.
+ */
+export interface RestoreCommitEvent {
+    /** ID of the source RecordChange row whose state is being restored. */
+    SourceChangeID: string;
+    /** Optional user-entered reason; persisted to RecordChange.RestoreReason. */
+    Reason: string | null;
+    /** Selected fields with their snapshot values, ready for BaseEntity.Set. */
+    FieldValues: Array<{
+        FieldName: string;
+        Value: unknown;
+    }>;
+    /** The full preview rows (including unselected) for audit/logging. */
+    AllRows: RestoreFieldRow[];
+    /** Mode indicates UPDATE (live) vs INSERT (undelete). */
+    Mode: RestorePreviewMode;
+}
+/**
+ * Reusable slide-in panel that previews a restore operation against a
+ * historical {@link MJRecordChangeEntity} and lets the user confirm with
+ * field-level granularity.
+ *
+ * This component is rendered by both:
+ * - The Record Changes timeline (for restoring a live record from any past
+ *   change row)
+ * - The Recycle Bin (for re-creating a hard-deleted record from its delete
+ *   snapshot)
+ *
+ * It does NOT perform the save itself — the host component receives a
+ * {@link RestoreCommitEvent} with the selected field values and is
+ * responsible for applying them to a BaseEntity, setting the restore
+ * context, and calling Save(). This keeps the component purely
+ * presentational and reusable in any context.
+ *
+ * ### Semantic correctness
+ *
+ * The preview compares the **full snapshot** captured in the source
+ * change's `FullRecordJSON` to the current live record (or to nothing in
+ * un-delete mode). It does NOT roll back a single delta — restoring `v2`
+ * means "make the record look like it did at v2", not "undo v3's changes".
+ *
+ * @example Live restore from the timeline
+ *   <mj-restore-preview-panel
+ *     [Visible]="showPreview"
+ *     [Mode]="'live'"
+ *     [RecordChange]="selectedChange"
+ *     [LiveRecord]="record"
+ *     (RestoreConfirmed)="onRestoreConfirmed($event)"
+ *     (RestoreCancelled)="showPreview = false">
+ *   </mj-restore-preview-panel>
+ *
+ * @example Un-delete from the Recycle Bin
+ *   <mj-restore-preview-panel
+ *     [Visible]="showPreview"
+ *     [Mode]="'undelete'"
+ *     [RecordChange]="deletedChange"
+ *     [EntityName]="'Customers'"
+ *     (RestoreConfirmed)="onRecreate($event)"
+ *     (RestoreCancelled)="showPreview = false">
+ *   </mj-restore-preview-panel>
+ */
+export declare class RestorePreviewPanelComponent implements OnInit {
+    private cdr;
+    /**
+     * Controls panel visibility. Setting to true opens the slide-in;
+     * setting to false closes it.
+     */
+    Visible: boolean;
+    /**
+     * Operating mode — `'live'` for restoring an existing record from a
+     * snapshot, `'undelete'` for re-creating a hard-deleted record.
+     */
+    Mode: RestorePreviewMode;
+    /**
+     * The historical RecordChange row whose state will be restored. Required.
+     * The component reads `FullRecordJSON` from this entity to determine the
+     * target state. The change's `Type` does not matter — `Create`,
+     * `Update`, `Snapshot`, and `Delete` are all valid restore sources.
+     */
+    private _recordChange;
+    set RecordChange(value: MJRecordChangeEntity | null);
+    get RecordChange(): MJRecordChangeEntity | null;
+    /**
+     * The current live record to diff against. Required in `'live'` mode,
+     * ignored in `'undelete'` mode (since the live record no longer exists).
+     */
+    private _liveRecord;
+    set LiveRecord(value: BaseEntity | null);
+    get LiveRecord(): BaseEntity | null;
+    /**
+     * The entity name. Required in `'undelete'` mode (since there's no live
+     * record to read it from). In `'live'` mode it can be omitted and is
+     * inferred from the LiveRecord.
+     */
+    EntityName: string | null;
+    /**
+     * When true, the Restore button is disabled until the user enters a
+     * non-empty reason. Useful for regulated environments where every
+     * reversal needs justification. Default: false.
+     */
+    RequireReason: boolean;
+    /**
+     * When true, hides the optional reason text area entirely. Default: false.
+     */
+    HideReason: boolean;
+    /**
+     * Cancelable event fired when the user clicks Restore but before
+     * {@link RestoreConfirmed} emits. Consumers can set `cancel = true` on
+     * the event arg to abort the operation — useful for custom approval
+     * workflows or for taking over the save themselves.
+     */
+    BeforeRestoreCommit: EventEmitter<BeforeRestoreCommitEvent>;
+    /**
+     * Emitted after the user confirms the restore (and BeforeRestoreCommit
+     * was not cancelled). The host is responsible for applying the field
+     * values to a BaseEntity, calling SetRestoreContext, and invoking Save().
+     */
+    RestoreConfirmed: EventEmitter<RestoreCommitEvent>;
+    /**
+     * Emitted when the user cancels the preview without restoring.
+     */
+    RestoreCancelled: EventEmitter<void>;
+    Rows: RestoreFieldRow[];
+    Reason: string;
+    IsRestoring: boolean;
+    ShowUnchanged: boolean;
+    /** Number of rows where the current value differs from the snapshot. */
+    ChangedCount: number;
+    /** Number of rows that are checked (will be applied on restore). */
+    SelectedCount: number;
+    /** Number of rows the schema has dropped or renamed since the snapshot. */
+    DriftCount: number;
+    private isInitialized;
+    private resolvedEntityInfo;
+    constructor(cdr: ChangeDetectorRef);
+    ngOnInit(): void;
+    /**
+     * Toggles whether unchanged rows are visible in the table. When false
+     * (default), only rows where current ≠ snapshot are shown.
+     */
+    ToggleUnchanged(): void;
+    /**
+     * Toggles whether a single row is selected for restore. Updates the
+     * SelectedCount in real time so the primary button label reflects it.
+     */
+    ToggleRow(row: RestoreFieldRow): void;
+    /**
+     * Selects every row that can be selected (skips immutable / drifted).
+     */
+    SelectAll(): void;
+    /**
+     * Deselects every row in the preview.
+     */
+    DeselectAll(): void;
+    /**
+     * User clicked Restore — fire BeforeRestoreCommit (cancelable), then
+     * RestoreConfirmed if not cancelled.
+     */
+    ConfirmRestore(): void;
+    /**
+     * User cancelled the preview. Resets state and emits RestoreCancelled.
+     */
+    Cancel(): void;
+    /**
+     * Resets internal state — useful after a save completes so the panel
+     * can be reopened cleanly. Called by the host component when needed.
+     */
+    Reset(): void;
+    get IsRestoreDisabled(): boolean;
+    get RestoreButtonLabel(): string;
+    get HeaderTitle(): string;
+    get VersionTimestamp(): Date | null;
+    get VersionUser(): string;
+    get UnchangedCount(): number;
+    /**
+     * Rebuilds the Rows array from the current RecordChange + LiveRecord.
+     * Idempotent and cheap — safe to call from input setters.
+     */
+    private rebuildRows;
+    private buildRowFromSnapshot;
+    private getCurrentFieldValue;
+    private parseSnapshot;
+    /**
+     * Resolves the entity metadata. Prefers LiveRecord.EntityInfo (always
+     * accurate). Falls back to looking up by EntityName. Memoized.
+     */
+    private resolveEntityInfo;
+    private formatValue;
+    private recountSelected;
+    formatTimestamp(date: Date | null): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RestorePreviewPanelComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<RestorePreviewPanelComponent, "mj-restore-preview-panel", never, { "Visible": { "alias": "Visible"; "required": false; }; "Mode": { "alias": "Mode"; "required": false; }; "RecordChange": { "alias": "RecordChange"; "required": false; }; "LiveRecord": { "alias": "LiveRecord"; "required": false; }; "EntityName": { "alias": "EntityName"; "required": false; }; "RequireReason": { "alias": "RequireReason"; "required": false; }; "HideReason": { "alias": "HideReason"; "required": false; }; }, { "BeforeRestoreCommit": "BeforeRestoreCommit"; "RestoreConfirmed": "RestoreConfirmed"; "RestoreCancelled": "RestoreCancelled"; }, never, never, false, never>;
+}
+//# sourceMappingURL=restore-preview-panel.component.d.ts.map

package/dist/lib/restore-preview-panel/restore-preview-panel.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"restore-preview-panel.component.d.ts","sourceRoot":"","sources":["../../../src/lib/restore-preview-panel/restore-preview-panel.component.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,iBAAiB,EACjB,YAAY,EAGZ,MAAM,EAEP,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,UAAU,EAKX,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;;AAErE;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,UAAU,CAAC;AAErD;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,WAAW,EAAE,MAAM,CAAC;IACpB,2EAA2E;IAC3E,YAAY,EAAE,MAAM,CAAC;IACrB,sDAAsD;IACtD,YAAY,EAAE,MAAM,CAAC;IACrB,+DAA+D;IAC/D,eAAe,EAAE,OAAO,CAAC;IACzB,8EAA8E;IAC9E,SAAS,EAAE,OAAO,CAAC;IACnB,2EAA2E;IAC3E,QAAQ,EAAE,OAAO,CAAC;IAClB,qFAAqF;IACrF,iBAAiB,EAAE,OAAO,CAAC;IAC3B,mFAAmF;IACnF,WAAW,EAAE,OAAO,CAAC;IACrB,6EAA6E;IAC7E,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACvC,4DAA4D;IAC5D,MAAM,EAAE,OAAO,CAAC;IAChB,qDAAqD;IACrD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gEAAgE;IAChE,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,iEAAiE;IACjE,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,uEAAuE;IACvE,cAAc,EAAE,MAAM,CAAC;IACvB,6CAA6C;IAC7C,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,yDAAyD;IACzD,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,uEAAuE;IACvE,cAAc,EAAE,MAAM,CAAC;IACvB,6EAA6E;IAC7E,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,4EAA4E;IAC5E,WAAW,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAC1D,sEAAsE;IACtE,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,yDAAyD;IACzD,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,qBAQa,4BAA6B,YAAW,MAAM;IAuG7C,OAAO,CAAC,GAAG;IApGvB;;;OAGG;IACM,OAAO,UAAS;IAEzB;;;OAGG;IACM,IAAI,EAAE,kBAAkB,CAAU;IAE3C;;;;;OAKG;IACH,OAAO,CAAC,aAAa,CAAqC;IAC1D,IACI,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,IAAI,EAGlD;IACD,IAAI,YAAY,IAAI,oBAAoB,GAAG,IAAI,CAE9C;IAED;;;OAGG;IACH,OAAO,CAAC,WAAW,CAA2B;IAC9C,IACI,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,EAGtC;IACD,IAAI,UAAU,IAAI,UAAU,GAAG,IAAI,CAElC;IAED;;;;OAIG;IACM,UAAU,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE1C;;;;OAIG;IACM,aAAa,UAAS;IAE/B;;OAEG;IACM,UAAU,UAAS;IAI5B;;;;;OAKG;IACO,mBAAmB,yCAAgD;IAE7E;;;;OAIG;IACO,gBAAgB,mCAA0C;IAEpE;;OAEG;IACO,gBAAgB,qBAA4B;IAI/C,IAAI,EAAE,eAAe,EAAE,CAAM;IAC7B,MAAM,SAAM;IACZ,WAAW,UAAS;IACpB,aAAa,UAAS;IAE7B,wEAAwE;IACjE,YAAY,SAAK;IACxB,oEAAoE;IAC7D,aAAa,SAAK;IACzB,2EAA2E;IACpE,UAAU,SAAK;IAEtB,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,kBAAkB,CAA2B;gBAEjC,GAAG,EAAE,iBAAiB;IAE1C,QAAQ,IAAI,IAAI;IAOhB;;;OAGG;IACI,eAAe,IAAI,IAAI;IAK9B;;;OAGG;IACI,SAAS,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAO5C;;OAEG;IACI,SAAS,IAAI,IAAI;IAQxB;;OAEG;IACI,WAAW,IAAI,IAAI;IAM1B;;;OAGG;IACI,cAAc,IAAI,IAAI;IA+B7B;;OAEG;IACI,MAAM,IAAI,IAAI;IAIrB;;;OAGG;IACI,KAAK,IAAI,IAAI;IASpB,IAAW,iBAAiB,IAAI,OAAO,CAKtC;IAED,IAAW,kBAAkB,IAAI,MAAM,CAMtC;IAED,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED,IAAW,gBAAgB,IAAI,IAAI,GAAG,IAAI,CAEzC;IAED,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED,IAAW,cAAc,IAAI,MAAM,CAElC;IAID;;;OAGG;IACH,OAAO,CAAC,WAAW;IA6CnB,OAAO,CAAC,oBAAoB;IA0C5B,OAAO,CAAC,oBAAoB;IAS5B,OAAO,CAAC,aAAa;IASrB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAiBzB,OAAO,CAAC,WAAW;IAuBnB,OAAO,CAAC,eAAe;IAMhB,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,MAAM;yCA/YtC,4BAA4B;2CAA5B,4BAA4B;CA0ZxC"}