@memberjunction/ng-shared 2.42.1 → 2.44.0

package/README.md

@@ -12,6 +12,7 @@ Utility functions and reusable components used across MemberJunction Explorer An
 - Notification system integration
 - Event management
 - DOM utilities
+- Angular pipes for text and URL formatting
 
 ## Installation
 
@@ -19,18 +20,40 @@ Utility functions and reusable components used across MemberJunction Explorer An
 npm install @memberjunction/ng-shared
 ```
 
+## Dependencies
+
+### Peer Dependencies
+- `@angular/common`: ^18.0.2
+- `@angular/core`: ^18.0.2
+- `rxjs`: ^7.8.1
+
+### Core Dependencies
+- `@memberjunction/core`: Provides core functionality and metadata management
+- `@memberjunction/core-entities`: Entity definitions and resource management
+- `@memberjunction/ng-notifications`: Notification system integration
+- `@memberjunction/ng-base-types`: Base Angular component types
+- `@memberjunction/graphql-dataprovider`: GraphQL data provider for API communication
+- `@progress/kendo-angular-notification`: UI notification components
+
+## Module Import
+
+```typescript
+import { MemberJunctionSharedModule } from '@memberjunction/ng-shared';
+
+@NgModule({
+  imports: [
+    MemberJunctionSharedModule
+    // ... other imports
+  ]
+})
+export class YourModule { }
+```
+
 ## Key Components
 
 ### SharedService
 
-A singleton service that provides:
-
-- Application-wide state management
-- Resource type handling
-- User notifications
-- Markdown to HTML conversion
-- DOM utilities
-- Notification creation and management
+A singleton service that provides application-wide functionality:
 
 ```typescript
 import { SharedService } from '@memberjunction/ng-shared';
@@ -38,8 +61,30 @@ import { SharedService } from '@memberjunction/ng-shared';
 // Get singleton instance
 const service = SharedService.Instance;
 
-// Create a notification
-service.CreateSimpleNotification('Operation completed successfully', 'success', 3000);
+// Access session ID
+const sessionId = service.SessionId;
+
+// Access resource types
+const viewResourceType = service.ViewResourceType;
+const recordResourceType = service.RecordResourceType;
+const dashboardResourceType = service.DashboardResourceType;
+const reportResourceType = service.ReportResourceType;
+const searchResultsResourceType = service.SearchResultsResourceType;
+const listResourceType = service.ListResourceType;
+
+// Get resource type by ID or name
+const resourceTypeById = service.ResourceTypeByID('some-id');
+const resourceTypeByName = service.ResourceTypeByName('reports');
+
+// Format column values
+const formattedValue = service.FormatColumnValue(column, value, maxLength, '...');
+
+// Create notifications (Note: prefer MJNotificationService for new code)
+service.CreateSimpleNotification('Operation completed', 'success', 3000);
+
+// Convert between route segments and resource type names
+const routeSegment = service.mapResourceTypeNameToRouteSegment('user views'); // returns 'view'
+const resourceTypeName = service.mapResourceTypeRouteSegmentToName('view'); // returns 'user views'
 ```
 
 ### Base Components
@@ -49,10 +94,16 @@ service.CreateSimpleNotification('Operation completed successfully', 'success',
 Base class for all MJ Explorer navigation components that can be displayed from a route:
 
 ```typescript
+import { Component } from '@angular/core';
 import { BaseNavigationComponent } from '@memberjunction/ng-shared';
 
+@Component({
+  selector: 'app-your-navigation',
+  templateUrl: './your-navigation.component.html'
+})
 export class YourNavigationComponent extends BaseNavigationComponent {
-  // Your component implementation
+  // Inherits from BaseAngularComponent
+  // Provides foundation for routable components
 }
 ```
 
@@ -61,29 +112,87 @@ export class YourNavigationComponent extends BaseNavigationComponent {
 Extended base class for components that work with MemberJunction resources:
 
 ```typescript
+import { Component } from '@angular/core';
 import { BaseResourceComponent } from '@memberjunction/ng-shared';
+import { ResourceData } from '@memberjunction/core-entities';
 
+@Component({
+  selector: 'app-your-resource',
+  templateUrl: './your-resource.component.html'
+})
 export class YourResourceComponent extends BaseResourceComponent {
+  // Access resource data
+  ngOnInit() {
+    console.log(this.Data); // ResourceData object
+  }
+
   // Required abstract methods
   async GetResourceDisplayName(data: ResourceData): Promise<string> {
-    // Your implementation
-    return 'Resource Name';
+    // Return display name based on resource data
+    return `Resource: ${data.ResourceRecordID}`;
   }
 
   async GetResourceIconClass(data: ResourceData): Promise<string> {
-    // Your implementation
-    return 'fa-icon-class';
+    // Return Font Awesome icon class
+    return 'fa-solid fa-file';
+  }
+
+  // Lifecycle notifications
+  protected onLoad() {
+    this.NotifyLoadStarted();
+    // ... load resource data
+    this.NotifyLoadComplete();
+  }
+
+  // Handle resource save
+  protected async saveResource() {
+    const entity = await this.getResourceEntity();
+    if (await entity.Save()) {
+      this.ResourceRecordSaved(entity);
+    }
   }
 }
 ```
 
+## Angular Pipes
+
+### URLPipe (formatUrl)
+
+Ensures URLs have proper protocol prefix:
+
+```typescript
+// In template
+<a [href]="website | formatUrl">Visit Site</a>
+
+// Transforms:
+// "example.com" → "https://example.com"
+// "http://example.com" → "http://example.com" (unchanged)
+```
+
+### SimpleTextFormatPipe (formatText)
+
+Converts plain text formatting to HTML:
+
+```typescript
+// In template
+<div [innerHTML]="description | formatText"></div>
+
+// Transforms:
+// "Line 1\nLine 2" → "Line 1<br>Line 2"
+// "Text\tIndented" → "Text&nbsp;&nbsp;&nbsp;&nbsp;Indented"
+```
+
 ## Utilities
 
 ### Format Utilities
 
 ```typescript
-// Convert Markdown to HTML list
+// Convert Markdown list to HTML
 const htmlList = service.ConvertMarkdownStringToHtmlList('Unordered', '- Item 1\n- Item 2');
+// Result: <ul><li>Item 1</li><li>Item 2</li></ul>
+
+const orderedList = service.ConvertMarkdownStringToHtmlList('Ordered', '1. First\n2. Second');
+// Result: <ol><li>First</li><li>Second</li></ol>
 ```
 
 ### DOM Utilities
@@ -92,28 +201,85 @@ const htmlList = service.ConvertMarkdownStringToHtmlList('Unordered', '- Item 1\
 // Check if one element is a descendant of another
 const isDescendant = SharedService.IsDescendant(parentRef, childRef);
 
-// Trigger manual resize events
-service.InvokeManualResize(50);
+// Trigger manual window resize event (useful for responsive components)
+service.InvokeManualResize(50); // 50ms delay
 ```
 
-### Resource Type Helpers
+### Push Status Updates
 
 ```typescript
-// Get resource type by name
-const resourceType = service.ResourceTypeByName('reports');
-
-// Convert between route segments and resource type names
-const routeSegment = service.mapResourceTypeNameToRouteSegment('user views');
-const resourceTypeName = service.mapResourceTypeRouteSegmentToName('view');
+// Subscribe to server push updates
+service.PushStatusUpdates().subscribe(status => {
+  console.log('Server status:', status);
+});
 ```
 
-## Events
+## Event Codes
 
-The module includes predefined event codes for standardized application event handling:
+Predefined event codes for standardized application event handling:
 
 ```typescript
 import { EventCodes } from '@memberjunction/ng-shared';
 
-// Example event code
-const eventCode = EventCodes.ViewClicked;
-```
+// Available event codes:
+EventCodes.ViewClicked              // User clicked on a view
+EventCodes.EntityRecordClicked      // User clicked on an entity record
+EventCodes.AddDashboard            // Request to add a dashboard
+EventCodes.AddReport               // Request to add a report
+EventCodes.AddQuery                // Request to add a query
+EventCodes.ViewCreated             // View was created
+EventCodes.ViewUpdated             // View was updated
+EventCodes.RunSearch               // Execute a search
+EventCodes.ViewNotifications       // View notifications panel
+EventCodes.PushStatusUpdates       // Server push status updates
+EventCodes.UserNotificationsUpdated // User notifications changed
+EventCodes.CloseCurrentTab         // Close current tab
+EventCodes.ListCreated             // List was created
+EventCodes.ListClicked             // User clicked on a list
+```
+
+## Integration with Other MJ Packages
+
+This package seamlessly integrates with:
+
+- **@memberjunction/core**: Uses Metadata for entity access and logging
+- **@memberjunction/core-entities**: Works with ResourceTypeEntity, UserNotificationEntity, and ResourceData
+- **@memberjunction/ng-notifications**: Delegates notification functionality to the dedicated notification service
+- **@memberjunction/global**: Uses global event system and utilities
+
+## Migration Notes
+
+### Deprecated Methods
+
+Several notification-related methods in SharedService are deprecated in favor of MJNotificationService:
+
+```typescript
+// Deprecated
+SharedService.UserNotifications
+SharedService.UnreadUserNotifications
+SharedService.UnreadUserNotificationCount
+service.CreateNotification(...)
+SharedService.RefreshUserNotifications()
+service.CreateSimpleNotification(...)
+
+// Use instead
+import { MJNotificationService } from '@memberjunction/ng-notifications';
+
+MJNotificationService.UserNotifications
+MJNotificationService.UnreadUserNotifications
+MJNotificationService.UnreadUserNotificationCount
+mjNotificationService.CreateNotification(...)
+MJNotificationService.RefreshUserNotifications()
+mjNotificationService.CreateSimpleNotification(...)
+```
+
+## Build
+
+To build this package:
+
+```bash
+cd packages/Angular/Explorer/shared
+npm run build
+```
+
+The build uses Angular's `ngc` compiler and outputs to the `dist` directory.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/ng-shared",
-  "version": "2.42.1",
+  "version": "2.44.0",
   "description": "MemberJunction: MJ Explorer Angular Shared Package - utility functions and other reusable elements used across other MJ Angular packages within the MJ Explorer App - do not use outside of MJ Explorer.",
   "main": "./dist/public-api.js",
   "typings": "./dist/public-api.d.ts",
@@ -27,11 +27,11 @@
     "rxjs": "^7.8.1"
   },
   "dependencies": {
-    "@memberjunction/core": "2.42.1",
-    "@memberjunction/core-entities": "2.42.1",
-    "@memberjunction/ng-notifications": "2.42.1",
-    "@memberjunction/ng-base-types": "2.42.1",
-    "@memberjunction/graphql-dataprovider": "2.42.1",
+    "@memberjunction/core": "2.44.0",
+    "@memberjunction/core-entities": "2.44.0",
+    "@memberjunction/ng-notifications": "2.44.0",
+    "@memberjunction/ng-base-types": "2.44.0",
+    "@memberjunction/graphql-dataprovider": "2.44.0",
     "@progress/kendo-angular-notification": "16.2.0",
     "tslib": "^2.3.0"
   },