@memberjunction/ng-versions 0.0.1 → 4.1.0

package/README.md

@@ -1,45 +1,127 @@
 # @memberjunction/ng-versions
 
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@memberjunction/ng-versions`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+Angular components for viewing entity record version history in MemberJunction applications. Provides a slide panel, label creation, label detail, and record micro-view for working with the built-in Record Changes system.
+
+## Installation
+
+```bash
+npm install @memberjunction/ng-versions
+```
+
+## Overview
+
+MemberJunction includes built-in version control ("Record Changes") that tracks all changes to entity records. This package provides Angular components for browsing that history: a slide panel for navigating versions, a micro-view for previewing snapshots, and label management for bookmarking specific versions.
+
+```mermaid
+flowchart TD
+    subgraph Panel["SlidePanelComponent"]
+        A["Version List"]
+        A --> B["RecordMicroViewComponent"]
+        A --> C["LabelCreateComponent"]
+        A --> D["LabelDetailComponent"]
+    end
+    subgraph Data["MJ Record Changes"]
+        E["RecordChange Entity"]
+        F["Field-level Diffs"]
+        G["Version Labels"]
+    end
+
+    E --> Panel
+    F --> B
+    G --> C
+    G --> D
+
+    style Panel fill:#2d6a9f,stroke:#1a4971,color:#fff
+    style Data fill:#2d8659,stroke:#1a5c3a,color:#fff
+```
+
+## Usage
+
+### Module Import
+
+```typescript
+import { VersionsModule } from '@memberjunction/ng-versions';
+
+@NgModule({
+  imports: [VersionsModule]
+})
+export class YourModule {}
+```
+
+### Slide Panel
+
+```html
+<mj-slide-panel
+  [EntityName]="'Products'"
+  [RecordID]="productId"
+  [Mode]="'slide'"
+  [Visible]="showVersionPanel">
+</mj-slide-panel>
+```
+
+### Record Micro View
+
+```html
+<mj-record-micro-view
+  [Data]="microViewData">
+</mj-record-micro-view>
+```
+
+### Label Creation
+
+```html
+<mj-label-create
+  [EntityName]="'Products'"
+  [RecordID]="productId"
+  [RecordChangeID]="selectedChangeId"
+  (LabelCreated)="onLabelCreated($event)">
+</mj-label-create>
+```
+
+## Components
+
+| Component | Selector | Purpose |
+|-----------|----------|---------|
+| `SlidePanelComponent` | `mj-slide-panel` | Container for version history navigation |
+| `RecordMicroViewComponent` | `mj-record-micro-view` | Compact snapshot preview with field diffs |
+| `LabelCreateComponent` | `mj-label-create` | Create a named label/bookmark for a version |
+| `LabelDetailComponent` | `mj-label-detail` | View and manage label details |
+
+## Exported Types
+
+### MicroViewData
+
+```typescript
+interface MicroViewData {
+  EntityName: string;
+  EntityID: string;
+  RecordID: string;
+  RecordChangeID: string;
+  FullRecordJSON: Record<string, unknown> | null;
+  FieldDiffs: FieldChangeView[] | null;
+}
+```
+
+### FieldChangeView
+
+```typescript
+interface FieldChangeView {
+  FieldName: string;
+  OldValue: string;
+  NewValue: string;
+  ChangeType: 'Added' | 'Modified' | 'Removed';
+}
+```
+
+### SlidePanelMode
+
+```typescript
+type SlidePanelMode = 'slide' | 'dialog';
+```
+
+## Dependencies
+
+- [@memberjunction/core](../../MJCore/README.md) -- Metadata, RunView
+- [@memberjunction/core-entities](../../MJCoreEntities/README.md) -- RecordChange entities
+- [@memberjunction/graphql-dataprovider](../../GraphQLDataProvider/README.md) -- Data provider
+- [@memberjunction/ng-shared-generic](../shared/README.md) -- Loading component

package/dist/lib/label-create/label-create.component.d.ts

@@ -0,0 +1,71 @@
+import { EventEmitter, OnInit, ChangeDetectorRef } from '@angular/core';
+import { EntityInfo } from '@memberjunction/core';
+import { CreateVersionLabelProgress } from '@memberjunction/graphql-dataprovider';
+import * as i0 from "@angular/core";
+export interface RecordOption {
+    ID: string;
+    DisplayName: string;
+    Selected: boolean;
+}
+export declare class MjLabelCreateComponent implements OnInit {
+    private cdr;
+    /**
+     * When set, skips the entity picker step and pre-selects this entity.
+     */
+    PreselectedEntity: EntityInfo | null;
+    /**
+     * When set along with PreselectedEntity, auto-selects these record IDs
+     * and skips directly to the details step.
+     */
+    PreselectedRecordIds: string[];
+    /** Emitted when labels are successfully created. */
+    Created: EventEmitter<{
+        LabelCount: number;
+        ItemCount: number;
+    }>;
+    /** Emitted when the user cancels. */
+    Cancel: EventEmitter<void>;
+    CreateStep: 'entity' | 'records' | 'details' | 'creating' | 'done';
+    EntitySearchText: string;
+    FilteredEntities: EntityInfo[];
+    SelectedEntity: EntityInfo | null;
+    RecordSearchText: string;
+    AvailableRecords: RecordOption[];
+    FilteredRecords: RecordOption[];
+    IsLoadingRecords: boolean;
+    LabelName: string;
+    LabelDescription: string;
+    IsCreatingLabel: boolean;
+    CreateError: string;
+    CreatedLabelCount: number;
+    CreatedItemCount: number;
+    CreateProgress: CreateVersionLabelProgress | null;
+    private metadata;
+    constructor(cdr: ChangeDetectorRef);
+    ngOnInit(): void;
+    private skipToDetailsWithPreselection;
+    private preselectRecordsByIds;
+    OnEntitySearchChange(text: string): void;
+    SelectEntity(entity: EntityInfo): void;
+    OnRecordSearchChange(text: string): void;
+    ToggleRecordSelection(record: RecordOption): void;
+    SelectAllRecords(): void;
+    DeselectAllRecords(): void;
+    get SelectedRecordCount(): number;
+    GoToDetailsStep(): void;
+    GoBackToRecords(): void;
+    GoBackToEntity(): void;
+    CreateLabels(): Promise<void>;
+    FinishCreate(): void;
+    OnCancel(): void;
+    private createSingleLabel;
+    private createGroupedLabels;
+    private loadEntityRecords;
+    private findNameField;
+    private getTrackableEntities;
+    private suggestLabelName;
+    private resetCreateDialog;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MjLabelCreateComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MjLabelCreateComponent, "mj-label-create", never, { "PreselectedEntity": { "alias": "PreselectedEntity"; "required": false; }; "PreselectedRecordIds": { "alias": "PreselectedRecordIds"; "required": false; }; }, { "Created": "Created"; "Cancel": "Cancel"; }, never, never, false, never>;
+}
+//# sourceMappingURL=label-create.component.d.ts.map

package/dist/lib/label-create/label-create.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"label-create.component.d.ts","sourceRoot":"","sources":["../../../src/lib/label-create/label-create.component.ts"],"names":[],"mappings":"AAAA,OAAO,EAIH,YAAY,EACZ,MAAM,EACN,iBAAiB,EAEpB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAqB,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAGH,0BAA0B,EAC7B,MAAM,sCAAsC,CAAC;;AAE9C,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,qBAOa,sBAAuB,YAAW,MAAM;IA6CrC,OAAO,CAAC,GAAG;IA5CvB;;OAEG;IACM,iBAAiB,EAAE,UAAU,GAAG,IAAI,CAAQ;IAErD;;;OAGG;IACM,oBAAoB,EAAE,MAAM,EAAE,CAAM;IAE7C,oDAAoD;IAC1C,OAAO;oBAAkC,MAAM;mBAAa,MAAM;OAAM;IAElF,qCAAqC;IAC3B,MAAM,qBAA4B;IAGrC,UAAU,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,MAAM,CAAY;IAG9E,gBAAgB,SAAM;IACtB,gBAAgB,EAAE,UAAU,EAAE,CAAM;IACpC,cAAc,EAAE,UAAU,GAAG,IAAI,CAAQ;IAGzC,gBAAgB,SAAM;IACtB,gBAAgB,EAAE,YAAY,EAAE,CAAM;IACtC,eAAe,EAAE,YAAY,EAAE,CAAM;IACrC,gBAAgB,UAAS;IAGzB,SAAS,SAAM;IACf,gBAAgB,SAAM;IAGtB,eAAe,UAAS;IACxB,WAAW,SAAM;IACjB,iBAAiB,SAAK;IACtB,gBAAgB,SAAK;IACrB,cAAc,EAAE,0BAA0B,GAAG,IAAI,CAAQ;IAEhE,OAAO,CAAC,QAAQ,CAAkB;gBAEd,GAAG,EAAE,iBAAiB;IAE1C,QAAQ,IAAI,IAAI;YAqBF,6BAA6B;IAQ3C,OAAO,CAAC,qBAAqB;IAWtB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAUxC,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAUtC,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IASxC,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAKjD,gBAAgB,IAAI,IAAI;IAOxB,kBAAkB,IAAI,IAAI;IAOjC,IAAW,mBAAmB,IAAI,MAAM,CAEvC;IAMM,eAAe,IAAI,IAAI;IAOvB,eAAe,IAAI,IAAI;IAKvB,cAAc,IAAI,IAAI;IAYhB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IA6BnC,YAAY,IAAI,IAAI;IAOpB,QAAQ,IAAI,IAAI;YAQT,iBAAiB;YAuBjB,mBAAmB;YAkDnB,iBAAiB;IA0C/B,OAAO,CAAC,aAAa;IAWrB,OAAO,CAAC,oBAAoB;IAM5B,OAAO,CAAC,gBAAgB;IAcxB,OAAO,CAAC,iBAAiB;yCArWhB,sBAAsB;2CAAtB,sBAAsB;CAqXlC"}