@memberjunction/ng-record-process-studio 0.0.1 → 5.44.0

package/README.md

@@ -1,45 +1,67 @@
 # @memberjunction/ng-record-process-studio
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+The generic **Bulk Operations studio** — reusable Angular UI for authoring, running, and auditing
+**Record Processes** (rules-driven bulk operations). MJExplorer's *Bulk Operations* app is a thin host over
+these components, but any MJ Angular app can drop them in.
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+A "Record Process" is a saved, reusable operation that runs over a set of an entity's records. The flagship
+work type is **FieldRules** — declarative rules that set fields from a fixed value, another field, a
+formula, an entity lookup, or an **AI prompt** — always previewed as an exact per-record diff before any
+write happens.
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+## Components
 
-## Purpose
+| Component | Selector | Purpose |
+|---|---|---|
+| `RecordProcessStudioComponent` | `<mj-record-process-studio>` | The hub — list / search / create / edit / run bulk operations. |
+| `RecordProcessEditorComponent` | `<mj-record-process-editor>` | Author one process: basics + target entity + scope + the embedded visual rules builder + an inline dry-run **Preview**. |
+| `RecordProcessHistoryComponent` | `<mj-record-process-history>` | Run history with per-record drill-in (the field diff persisted on each Process Run Detail). |
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@memberjunction/ng-record-process-studio`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+All three are **standalone**, `OnPush`, extend `BaseAngularComponent` (so they accept `[Provider]` for
+multi-provider), use **`--mj-*` design tokens** only (light + dark), and import nothing from
+`@angular/router` (Generic-package rule).
 
-## What is OIDC Trusted Publishing?
+## Quick use
 
-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.
+```html
+<!-- the whole hub -->
+<mj-record-process-studio [Provider]="ProviderToUse"></mj-record-process-studio>
 
-## Setup Instructions
+<!-- just the authoring editor for one record (e.g. embedded in an entity form) -->
+<mj-record-process-editor [Record]="record" [ShowToolbar]="false" [Provider]="ProviderToUse"></mj-record-process-editor>
 
-To properly configure OIDC trusted publishing for this package:
+<!-- run history, optionally scoped to one process -->
+<mj-record-process-history [RecordProcessID]="id" [Provider]="ProviderToUse"></mj-record-process-history>
+```
 
-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
+Call `LoadRecordProcessStudio()` once from your app bootstrap to keep the components through tree-shaking.
 
-## DO NOT USE THIS PACKAGE
+## How it composes
 
-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
+```
+ng-record-process-studio
+   ├─ embeds <mj-field-rules-builder>   ← @memberjunction/ng-entity-action-ux (visual rule authoring)
+   ├─ embeds <mj-ai-prompt-selector>    ← (grouped AI-prompt picker, via the builder)
+   ├─ mounts  RecordProcessRunnerUX     ← @memberjunction/ng-entity-action-ux (dry-run → confirm runner)
+   └─ runs    RunRecordProcess          ← @memberjunction/graphql-dataprovider → RecordProcessExecutor engine
+```
 
-## More Information
+The studio is intentionally **thin orchestration** over already-tested primitives: the rule engine
+(`@memberjunction/global` field-rules, 25 tests), its metadata-aware layer (`@memberjunction/core`
+`EntityFieldRules`), the transform plugins (`@memberjunction/field-rules-transforms`, 8 tests), the
+builder/runner/serialization (`@memberjunction/ng-entity-action-ux`, 23 tests), and the executor +
+scope-override (`@memberjunction/record-set-processor`, 24 facade tests). The studio adds the
+list/edit/run/history surfaces around them.
 
-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)
+## The editor, embedded two ways
 
----
+- **In the Bulk Operations app** — `RecordProcessStudioComponent` shows it with its Save / Preview toolbar.
+- **In the custom `MJ: Record Processes` entity form** — `ShowToolbar=false`; the form's
+  `<mj-record-form-container>` owns Save while the editor mutates the record in place. So editing a process
+  from anywhere in Explorer gets the same visual rules builder instead of a raw `Configuration` JSON field.
 
-**Maintained for OIDC setup purposes only**
+## Conventions held
+
+Standalone + `inject()` · `@if`/`@for`/`@switch` · **PascalCase public members** · `--mj-*` tokens only ·
+multi-provider via `[Provider]` / `ProviderToUse` · no Router imports · self-contained chrome (each component
+owns its own toolbar so it drops into any host).

package/dist/lib/record-process-editor/record-process-editor.component.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @fileoverview The authoring surface for a single Record Process (a reusable bulk operation). Edits the
+ * basics + target entity + scope, and — for the FieldRules work type — embeds the visual
+ * `<mj-field-rules-builder>` so a business user defines rules without touching JSON. An inline "Preview"
+ * runs the same server dry-run + diff runner used at invocation time.
+ *
+ * Reused in two places: standalone in the Bulk Operations hub (owns its Save/Preview toolbar), and inside
+ * the custom Record Process entity form (toolbar hidden — the form owns Save).
+ * @module @memberjunction/ng-record-process-studio
+ */
+import { EventEmitter, OnInit } from '@angular/core';
+import { BaseAngularComponent } from '@memberjunction/ng-base-types';
+import { type EntityInfo } from '@memberjunction/core';
+import { type FieldRuleSet } from '@memberjunction/global';
+import { MJRecordProcessEntity } from '@memberjunction/core-entities';
+import { type EntityActionUXContext, type EntityActionUXResult } from '@memberjunction/ng-entity-action-ux';
+import * as i0 from "@angular/core";
+export declare class RecordProcessEditorComponent extends BaseAngularComponent implements OnInit {
+    private cdr;
+    /** The process being edited. Set this OR `RecordProcessID` (or neither, for a new draft). */
+    Record: MJRecordProcessEntity | null;
+    /** Load an existing process by ID (alternative to passing `Record`). */
+    RecordProcessID: string | null;
+    /** Default EntityID for a brand-new process (e.g. the grid the user came from). */
+    DefaultEntityID: string | null;
+    /** Show the built-in Save / Preview / Cancel toolbar. Set false when an outer form owns Save. */
+    ShowToolbar: boolean;
+    /** Emitted after a successful Save (the persisted record). */
+    Saved: EventEmitter<MJRecordProcessEntity>;
+    /** Emitted when the user cancels. */
+    Cancelled: EventEmitter<void>;
+    Entities: EntityInfo[];
+    SelectedEntityName: string;
+    RuleSet: FieldRuleSet;
+    RulesValid: boolean;
+    Saving: boolean;
+    ErrorMessage: string;
+    PreviewDriver: {
+        DriverClass: string;
+        Context: EntityActionUXContext;
+    } | null;
+    get CanSave(): boolean;
+    get CanPreview(): boolean;
+    ngOnInit(): Promise<void>;
+    /** Resolves the record to edit: passed instance → by ID → a fresh draft. */
+    private loadRecord;
+    /** Generic setter for the simple string/enum fields, driven by the template inputs. */
+    set(field: 'Name' | 'Description' | 'Status' | 'ScopeType' | 'ScopeFilter' | 'WorkType', event: Event): void;
+    onEntityChange(event: Event): void;
+    onRulesChange(ruleSet: FieldRuleSet): void;
+    /** Saves the record (and emits). Returns success. */
+    Save(): Promise<boolean>;
+    /** Saves (if needed) then mounts the dry-run runner against the process's default scope. */
+    Preview(): Promise<void>;
+    onPreviewDone(_result: EntityActionUXResult): void;
+    Cancel(): void;
+    private resolveEntityName;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RecordProcessEditorComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<RecordProcessEditorComponent, "mj-record-process-editor", never, { "Record": { "alias": "Record"; "required": false; }; "RecordProcessID": { "alias": "RecordProcessID"; "required": false; }; "DefaultEntityID": { "alias": "DefaultEntityID"; "required": false; }; "ShowToolbar": { "alias": "ShowToolbar"; "required": false; }; }, { "Saved": "Saved"; "Cancelled": "Cancelled"; }, never, never, true, never>;
+}
+//# sourceMappingURL=record-process-editor.component.d.ts.map

package/dist/lib/record-process-editor/record-process-editor.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-process-editor.component.d.ts","sourceRoot":"","sources":["../../../src/lib/record-process-editor/record-process-editor.component.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAyD,YAAY,EAAS,MAAM,EAAkB,MAAM,eAAe,CAAC;AACnI,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAiB,KAAK,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAA2D,KAAK,qBAAqB,EAAE,KAAK,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;;AAKrK,qBA6Ga,4BAA6B,SAAQ,oBAAqB,YAAW,MAAM;IACpF,OAAO,CAAC,GAAG,CAA6B;IAExC,6FAA6F;IACpF,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAAQ;IACrD,wEAAwE;IAC/D,eAAe,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC/C,mFAAmF;IAC1E,eAAe,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC/C,iGAAiG;IACxF,WAAW,UAAQ;IAE5B,8DAA8D;IACpD,KAAK,sCAA6C;IAC5D,qCAAqC;IAC3B,SAAS,qBAA4B;IAExC,QAAQ,EAAE,UAAU,EAAE,CAAM;IAC5B,kBAAkB,SAAM;IACxB,OAAO,EAAE,YAAY,CAAiB;IACtC,UAAU,UAAQ;IAClB,MAAM,UAAS;IACf,YAAY,SAAM;IAClB,aAAa,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,qBAAqB,CAAA;KAAE,GAAG,IAAI,CAAQ;IAE5F,IAAI,OAAO,IAAI,OAAO,CAA8E;IACpG,IAAI,UAAU,IAAI,OAAO,CAA0D;IAE7E,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAM/B,4EAA4E;YAC9D,UAAU;IAmBxB,uFAAuF;IACvF,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,QAAQ,GAAG,WAAW,GAAG,aAAa,GAAG,UAAU,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IAe5G,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAOlC,aAAa,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAM1C,qDAAqD;IAC/C,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IAe9B,4FAA4F;IACtF,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAwB9B,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAKlD,MAAM,IAAI,IAAI;IAEd,OAAO,CAAC,iBAAiB;yCAnIhB,4BAA4B;2CAA5B,4BAA4B;CAsIxC"}