@memberjunction/react-runtime 2.93.0 → 2.95.0

package/.turbo/turbo-build.log

@@ -1,24 +1,24 @@
 
-> @memberjunction/react-runtime@2.93.0 build
+> @memberjunction/react-runtime@2.95.0 build
 > npm run build:node && npm run build:umd
 
 
-> @memberjunction/react-runtime@2.93.0 build:node
+> @memberjunction/react-runtime@2.95.0 build:node
 > tsc
 
 
-> @memberjunction/react-runtime@2.93.0 build:umd
+> @memberjunction/react-runtime@2.95.0 build:umd
 > webpack --config webpack.umd.config.js
 
 [BABEL] Note: The code generator has deoptimised the styling of /home/runner/work/MJ/MJ/packages/MJCoreEntities/dist/generated/entity_subclasses.js as it exceeds the max of 500KB.
-asset runtime.umd.js 1.88 MiB [emitted] [minimized] [big] (name: main) 1 related asset
+asset runtime.umd.js 1.92 MiB [emitted] [minimized] [big] (name: main) 1 related asset
 runtime modules 344 bytes 2 modules
 modules by path ../../../node_modules/ 1.01 MiB 237 modules
 modules by path ../../MJGlobal/ 174 KiB
   modules by path ../../MJGlobal/node_modules/uuid/dist/commonjs-browser/*.js 35 KiB 21 modules
   modules by path ../../MJGlobal/dist/ 139 KiB 14 modules
 modules by path ../../MJCore/ 643 KiB 31 modules
-modules by path ./dist/ 283 KiB 23 modules
+modules by path ./dist/ 352 KiB 25 modules
 modules by path ../../MJCoreEntities/dist/ 2.04 MiB
   modules by path ../../MJCoreEntities/dist/custom/*.js 241 KiB 15 modules
   modules by path ../../MJCoreEntities/dist/custom/ResourcePermissions/*.js 46.9 KiB 3 modules
@@ -27,4 +27,4 @@ modules by path ../../InteractiveComponents/dist/*.js 36.8 KiB
   ../../InteractiveComponents/dist/index.js 1.21 KiB [built] [code generated]
   ../../InteractiveComponents/dist/data-requirements.js 79 bytes [built] [code generated]
   + 8 modules
-webpack 5.92.1 compiled successfully in 108887 ms
+webpack 5.92.1 compiled successfully in 110738 ms

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @memberjunction/react-runtime
 
+## 2.95.0
+
+### Patch Changes
+
+- 3cd7db6: fix rendering issue
+- Updated dependencies [a54c014]
+- Updated dependencies [85985bd]
+  - @memberjunction/core@2.95.0
+  - @memberjunction/interactive-component-types@2.95.0
+  - @memberjunction/core-entities@2.95.0
+  - @memberjunction/global@2.95.0
+
+## 2.94.0
+
+### Minor Changes
+
+- 455654e: migration (unrelated) to bump to minor
+- 7c27b04: migration
+- 98afc80: migrations
+
+### Patch Changes
+
+- Updated dependencies [eed16e0]
+  - @memberjunction/interactive-component-types@2.94.0
+  - @memberjunction/core-entities@2.94.0
+  - @memberjunction/core@2.94.0
+  - @memberjunction/global@2.94.0
+
 ## 2.93.0
 
 ### Patch Changes

package/README.md

@@ -165,20 +165,198 @@ const context = {
 const MyComponent = runtime.registry.get('MyComponent', 'MyNamespace');
 
 // Execute the component factory
-const { component } = MyComponent(context);
+const componentObject = MyComponent(context);
+
+// The componentObject contains the React component and method accessors
+const { component, print, refresh, getCurrentDataState, isDirty } = componentObject;
 
 // Render with props
 const props = {
   data: { name: 'World' },
   userState: {},
   callbacks: {
-    RefreshData: () => console.log('Refresh clicked!')
+    OpenEntityRecord: (entityName, key) => console.log('Open entity:', entityName),
+    RegisterMethod: (methodName, handler) => {
+      // Component will register its methods here
+    }
   }
 };
 
 React.createElement(component, props);
 ```
 
+## Component Methods System
+
+### Overview
+
+Components can expose methods that allow containers to interact with them beyond just passing props. This enables scenarios like:
+- AI agents introspecting component state
+- Containers checking if components have unsaved changes
+- Programmatic validation and reset operations
+- Custom business logic exposed by components
+
+### How Components Register Methods
+
+Components register their methods during initialization using the `RegisterMethod` callback:
+
+```typescript
+function MyComponent({ callbacks, data, userState }) {
+  const [currentData, setCurrentData] = React.useState(data);
+  const [isDirty, setIsDirty] = React.useState(false);
+  
+  // Register methods on mount
+  React.useEffect(() => {
+    if (callbacks?.RegisterMethod) {
+      // Register standard methods
+      callbacks.RegisterMethod('getCurrentDataState', () => {
+        return currentData;
+      });
+      
+      callbacks.RegisterMethod('isDirty', () => {
+        return isDirty;
+      });
+      
+      callbacks.RegisterMethod('reset', () => {
+        setCurrentData(data);
+        setIsDirty(false);
+      });
+      
+      callbacks.RegisterMethod('validate', () => {
+        // Custom validation logic
+        if (!currentData.name) {
+          return { valid: false, errors: ['Name is required'] };
+        }
+        return true;
+      });
+      
+      // Register custom methods
+      callbacks.RegisterMethod('exportToCSV', () => {
+        // Custom export logic
+        return convertToCSV(currentData);
+      });
+    }
+  }, [callbacks, currentData, isDirty]);
+  
+  return (
+    <div>
+      {/* Component UI */}
+    </div>
+  );
+}
+```
+
+### Standard Methods
+
+The ComponentObject interface defines standard methods that components can optionally implement:
+
+- **`getCurrentDataState()`**: Returns the current data being displayed
+- **`getDataStateHistory()`**: Returns an array of timestamped state changes
+- **`validate()`**: Validates the component state
+- **`isDirty()`**: Checks if there are unsaved changes
+- **`reset()`**: Resets the component to initial state
+- **`scrollTo(target)`**: Scrolls to a specific element
+- **`focus(target)`**: Sets focus to an element
+- **`print()`**: Prints the component content
+- **`refresh()`**: Refreshes the component data
+
+### Using Component Methods
+
+After compilation, the ComponentObject provides typed access to standard methods:
+
+```typescript
+// Compile the component
+const result = await compiler.compile({
+  componentName: 'MyComponent',
+  componentCode: componentCode
+});
+
+// Get the component object
+const componentObject = result.component.component(context);
+
+// Call standard methods directly (type-safe)
+const currentData = componentObject.getCurrentDataState();
+const isDirty = componentObject.isDirty();
+const validationResult = componentObject.validate();
+
+if (isDirty) {
+  componentObject.reset();
+}
+
+// Call custom methods via invokeMethod
+if (componentObject.hasMethod('exportToCSV')) {
+  const csvData = componentObject.invokeMethod('exportToCSV');
+}
+```
+
+### Method Availability
+
+All methods are optional. The runtime provides sensible defaults when methods aren't registered:
+
+- `getCurrentDataState()` returns `undefined`
+- `getDataStateHistory()` returns `[]`
+- `isDirty()` returns `false`
+- `validate()` returns `true`
+- Other methods perform no operation if not implemented
+
+### Integration with Angular
+
+The Angular wrapper (`@memberjunction/ng-react`) provides strongly-typed access to all standard methods:
+
+```typescript
+export class MyDashboard {
+  @ViewChild(MJReactComponent) reactComponent!: MJReactComponent;
+  
+  checkComponentState() {
+    // Standard methods have full TypeScript support
+    if (this.reactComponent.isDirty()) {
+      const data = this.reactComponent.getCurrentDataState();
+      console.log('Component has unsaved changes:', data);
+    }
+    
+    // Validate before saving
+    const validation = this.reactComponent.validate();
+    if (validation === true || validation.valid) {
+      // Save data...
+    }
+    
+    // Custom methods
+    if (this.reactComponent.hasMethod('generateReport')) {
+      const report = this.reactComponent.invokeMethod('generateReport', options);
+    }
+  }
+}
+```
+
+### Method Declaration in Component Spec
+
+Components can declare their supported methods in the ComponentSpec for discovery:
+
+```typescript
+const componentSpec = {
+  name: 'MyComponent',
+  code: '...',
+  methods: [
+    {
+      name: 'getCurrentDataState',
+      category: 'standard',
+      description: 'Returns current component data',
+      returnType: 'DataState | undefined'
+    },
+    {
+      name: 'exportToExcel',
+      category: 'custom',
+      description: 'Exports data to Excel format',
+      parameters: [{
+        name: 'options',
+        type: '{includeHeaders?: boolean, sheetName?: string}',
+        required: false
+      }],
+      returnType: 'Promise<Blob>'
+    }
+  ]
+};
+```
+
 ## Advanced Features
 
 ### Component Hierarchies

package/dist/compiler/component-compiler.d.ts

@@ -8,6 +8,7 @@ export declare class ComponentCompiler {
     setBabelInstance(babel: any): void;
     compile(options: CompileOptions): Promise<CompilationResult>;
     private transpileComponent;
+    private readonly CORE_LIBRARIES;
     private wrapComponentCode;
     private loadRequiredLibraries;
     private loadStyles;

package/dist/compiler/component-compiler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"component-compiler.d.ts","sourceRoot":"","sources":["../../src/compiler/component-compiler.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,cAAc,EAEd,iBAAiB,EACjB,cAAc,EAGf,MAAM,UAAU,CAAC;AAsBlB,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,gBAAgB,CAAiC;IACzD,OAAO,CAAC,gBAAgB,CAAW;IACnC,OAAO,CAAC,aAAa,CAAM;gBAMf,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC;IAS5C,gBAAgB,CAAC,KAAK,EAAE,GAAG,GAAG,IAAI;IAS5B,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAyElE,OAAO,CAAC,kBAAkB;IAkC1B,OAAO,CAAC,iBAAiB;YAmDX,qBAAqB;YAwGrB,UAAU;IA+BxB,OAAO,CAAC,UAAU;IAmElB,OAAO,CAAC,sBAAsB;IA0E9B,OAAO,CAAC,sBAAsB;IAiE9B,OAAO,CAAC,mBAAmB;IAU3B,OAAO,CAAC,kBAAkB;IAY1B,OAAO,CAAC,cAAc;IAgBtB,OAAO,CAAC,cAAc;IAmBtB,OAAO,CAAC,sBAAsB;IAa9B,UAAU,IAAI,IAAI;IAQlB,YAAY,IAAI,MAAM;IAQtB,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,IAAI;CAGpD"}
+{"version":3,"file":"component-compiler.d.ts","sourceRoot":"","sources":["../../src/compiler/component-compiler.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,cAAc,EAEd,iBAAiB,EACjB,cAAc,EAGf,MAAM,UAAU,CAAC;AAyBlB,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,gBAAgB,CAAiC;IACzD,OAAO,CAAC,gBAAgB,CAAW;IACnC,OAAO,CAAC,aAAa,CAAM;gBAMf,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC;IAS5C,gBAAgB,CAAC,KAAK,EAAE,GAAG,GAAG,IAAI;IAS5B,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAyElE,OAAO,CAAC,kBAAkB;IAmC1B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAkC;IAEjE,OAAO,CAAC,iBAAiB;YA0NX,qBAAqB;YA2HrB,UAAU;IA+BxB,OAAO,CAAC,UAAU;IAyElB,OAAO,CAAC,sBAAsB;IA0E9B,OAAO,CAAC,sBAAsB;IAiE9B,OAAO,CAAC,mBAAmB;IAU3B,OAAO,CAAC,kBAAkB;IAY1B,OAAO,CAAC,cAAc;IAgBtB,OAAO,CAAC,cAAc;IAmBtB,OAAO,CAAC,sBAAsB;IAa9B,UAAU,IAAI,IAAI;IAQlB,YAAY,IAAI,MAAM;IAQtB,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,IAAI;CAGpD"}