@memberjunction/ng-actions 4.0.0 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +139 -0
  2. package/package.json +5 -5
package/README.md ADDED
@@ -0,0 +1,139 @@
1
+ # @memberjunction/ng-actions
2
+
3
+ Reusable Angular components for testing and running MemberJunction Actions. This package provides a lightweight action test harness and parameter/result-code editing dialogs with no Kendo UI dependencies.
4
+
5
+ ## Overview
6
+
7
+ The `@memberjunction/ng-actions` package provides a self-contained set of components for interacting with MemberJunction Actions: executing them with custom parameter values, viewing results, and editing action parameter definitions and result codes. Unlike other MJ Angular packages, this module has no Kendo UI dependency, making it suitable for any Angular application.
8
+
9
+ ```mermaid
10
+ graph TD
11
+ A[ActionsModule] --> B[ActionTestHarnessComponent]
12
+ A --> C[ActionTestHarnessDialogComponent]
13
+ A --> D[ActionParamDialogComponent]
14
+ A --> E[ActionResultCodeDialogComponent]
15
+
16
+ B --> F["Parameter Input
17
+ (dynamic form)"]
18
+ B --> G["Execution & Results"]
19
+
20
+ C --> B
21
+
22
+ style A fill:#2d6a9f,stroke:#1a4971,color:#fff
23
+ style B fill:#7c5295,stroke:#563a6b,color:#fff
24
+ style C fill:#2d8659,stroke:#1a5c3a,color:#fff
25
+ style D fill:#b8762f,stroke:#8a5722,color:#fff
26
+ style E fill:#b8762f,stroke:#8a5722,color:#fff
27
+ ```
28
+
29
+ ## Installation
30
+
31
+ ```bash
32
+ npm install @memberjunction/ng-actions
33
+ ```
34
+
35
+ ## Usage
36
+
37
+ ### Module Import
38
+
39
+ ```typescript
40
+ import { ActionsModule } from '@memberjunction/ng-actions';
41
+
42
+ @NgModule({
43
+ imports: [ActionsModule]
44
+ })
45
+ export class YourModule { }
46
+ ```
47
+
48
+ ### Action Test Harness
49
+
50
+ Embed the test harness for running actions with dynamic parameter input:
51
+
52
+ ```html
53
+ <mj-action-test-harness
54
+ [actionId]="selectedActionId"
55
+ (executionComplete)="onExecutionComplete($event)">
56
+ </mj-action-test-harness>
57
+ ```
58
+
59
+ ### Action Test Harness Dialog
60
+
61
+ Wrap the test harness in a dialog for modal usage:
62
+
63
+ ```html
64
+ <mj-action-test-harness-dialog
65
+ [visible]="showDialog"
66
+ [actionId]="selectedActionId"
67
+ (dialogClosed)="onDialogClosed()">
68
+ </mj-action-test-harness-dialog>
69
+ ```
70
+
71
+ ### Action Param Dialog
72
+
73
+ Edit action parameter definitions:
74
+
75
+ ```html
76
+ <mj-action-param-dialog
77
+ [visible]="showParamDialog"
78
+ [actionParam]="selectedParam"
79
+ (saved)="onParamSaved($event)"
80
+ (cancelled)="onParamCancelled()">
81
+ </mj-action-param-dialog>
82
+ ```
83
+
84
+ ### Action Result Code Dialog
85
+
86
+ Edit action result code definitions:
87
+
88
+ ```html
89
+ <mj-action-result-code-dialog
90
+ [visible]="showResultCodeDialog"
91
+ [resultCode]="selectedResultCode"
92
+ (saved)="onResultCodeSaved($event)"
93
+ (cancelled)="onResultCodeCancelled()">
94
+ </mj-action-result-code-dialog>
95
+ ```
96
+
97
+ ## Exported Types
98
+
99
+ ```typescript
100
+ import {
101
+ ActionsModule,
102
+ ActionTestHarnessComponent,
103
+ ActionParamValue,
104
+ ActionResult,
105
+ ActionTestHarnessDialogComponent,
106
+ ActionParamDialogComponent,
107
+ ActionParamDialogResult,
108
+ ActionResultCodeDialogComponent,
109
+ ActionResultCodeDialogResult
110
+ } from '@memberjunction/ng-actions';
111
+ ```
112
+
113
+ ## Dependencies
114
+
115
+ | Package | Description |
116
+ |---------|-------------|
117
+ | `@memberjunction/core` | Core framework |
118
+ | `@memberjunction/core-entities` | Entity type definitions |
119
+ | `@memberjunction/global` | Global utilities |
120
+ | `@memberjunction/graphql-dataprovider` | GraphQL data access |
121
+
122
+ ### Peer Dependencies
123
+
124
+ - `@angular/common` ^21.x
125
+ - `@angular/core` ^21.x
126
+ - `@angular/forms` ^21.x
127
+
128
+ **Note**: This package does not depend on Kendo UI, making it lightweight and suitable for use in any Angular project.
129
+
130
+ ## Build
131
+
132
+ ```bash
133
+ cd packages/Angular/Generic/actions
134
+ npm run build
135
+ ```
136
+
137
+ ## License
138
+
139
+ ISC
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@memberjunction/ng-actions",
3
- "version": "4.0.0",
3
+ "version": "4.1.0",
4
4
  "description": "MemberJunction Action Runner - Reusable components for testing and running actions with no Kendo dependencies",
5
5
  "main": "./dist/public-api.js",
6
6
  "typings": "./dist/public-api.d.ts",
@@ -30,10 +30,10 @@
30
30
  },
31
31
  "dependencies": {
32
32
  "@angular/platform-browser": "21.1.3",
33
- "@memberjunction/core": "4.0.0",
34
- "@memberjunction/core-entities": "4.0.0",
35
- "@memberjunction/global": "4.0.0",
36
- "@memberjunction/graphql-dataprovider": "4.0.0",
33
+ "@memberjunction/core": "4.1.0",
34
+ "@memberjunction/core-entities": "4.1.0",
35
+ "@memberjunction/global": "4.1.0",
36
+ "@memberjunction/graphql-dataprovider": "4.1.0",
37
37
  "rxjs": "^7.8.2",
38
38
  "tslib": "^2.8.1"
39
39
  },