@memberjunction/interactive-component-types 2.92.0 → 2.93.0

package/README.md

@@ -0,0 +1,270 @@
+# @memberjunction/interactive-component-types
+
+Type definitions and interfaces for MemberJunction's Interactive Components system, enabling dynamic, data-driven UI components with AI capabilities.
+
+## Overview
+
+The `@memberjunction/interactive-component-types` package provides the foundational types and interfaces for building interactive components in MemberJunction. These components are designed to be dynamically generated, data-aware, and AI-enhanced, allowing for rich user experiences with minimal configuration.
+
+## Key Features
+
+- **Dynamic Component Generation**: Type-safe specifications for runtime component creation
+- **Data Context Management**: Support for both static and dynamic data loading
+- **AI Tool Integration**: Built-in interfaces for AI operations within components
+- **Framework Agnostic**: Core types that work across React, Angular, and other frameworks
+- **Vector Operations**: Support for similarity calculations and vector-based data operations
+- **Metadata Access**: Direct access to MemberJunction's metadata system
+
+## Installation
+
+```bash
+npm install @memberjunction/interactive-component-types
+```
+
+## Core Interfaces
+
+### SimpleAITools
+
+Provides AI capabilities to interactive components:
+
+```typescript
+interface SimpleAITools {
+  // Execute LLM prompts for qualitative analysis
+  ExecutePrompt: (params: SimpleExecutePromptParams) => Promise<SimpleExecutePromptResult>
+  
+  // Generate vector embeddings for similarity calculations
+  EmbedText: (params: SimpleEmbedTextParams) => Promise<SimpleEmbedTextResult>
+  
+  // Vector operations service for KNN, similarity scoring, etc.
+  VectorService: SimpleVectorService
+}
+```
+
+### SimpleExecutePromptParams
+
+Parameters for executing AI prompts within components:
+
+```typescript
+interface SimpleExecutePromptParams {
+  // System prompt to set context
+  systemPrompt: string;
+  
+  // Optional conversation history
+  messages?: Array<{message: string, role: 'user' | 'assistant'}>;
+  
+  // Preferred models in order of preference
+  preferredModels?: string[];
+  
+  // Model power selection: 'lowest' | 'medium' | 'highest'
+  modelPower?: 'lowest' | 'medium' | 'highest';
+  
+  // Optional user context
+  contextUser?: UserInfo;
+}
+```
+
+### SimpleEmbedTextParams
+
+Parameters for generating text embeddings:
+
+```typescript
+interface SimpleEmbedTextParams {
+  // Single string or array of strings to embed
+  textToEmbed: string | string[];
+  
+  // Model size selection
+  modelSize: 'small' | 'medium';
+  
+  // Optional user context
+  contextUser?: UserInfo;
+}
+```
+
+### SimpleMetadata
+
+Access to MemberJunction's metadata system:
+
+```typescript
+interface SimpleMetadata {
+  // Array of all entity metadata
+  Entities: EntityInfo[];
+  
+  // Get entity object for CRUD operations
+  GetEntityObject(entityName: string, contextUser?: UserInfo): Promise<BaseEntity>;
+}
+```
+
+### SimpleRunView
+
+Execute database views dynamically:
+
+```typescript
+interface SimpleRunView {
+  // Run a single view
+  RunView: (params: RunViewParams, contextUser?: UserInfo) => Promise<RunViewResult>
+  
+  // Run multiple views in parallel
+  RunViews: (params: RunViewParams[], contextUser?: UserInfo) => Promise<RunViewResult[]>
+}
+```
+
+### SimpleRunQuery
+
+Execute predefined queries:
+
+```typescript
+interface SimpleRunQuery {
+  // Run a predefined query with parameters
+  RunQuery: (params: RunQueryParams, contextUser?: UserInfo) => Promise<RunQueryResult>
+}
+```
+
+## Component Initialization
+
+Interactive components receive initialization functions with access to all tools:
+
+```typescript
+type ComponentInitFunction = (
+  props: ComponentInitProps,
+  events: ComponentEvents,
+  data: SimpleDataContext,
+  metadata: SimpleMetadata,
+  runView: SimpleRunView,
+  runQuery: SimpleRunQuery,
+  ai: SimpleAITools
+) => Promise<void>;
+```
+
+## Usage Examples
+
+### Using AI Tools in a Component
+
+```typescript
+// In your interactive component initialization
+async function initComponent(props, events, data, metadata, runView, runQuery, ai) {
+  // Execute a prompt for data analysis
+  const analysisResult = await ai.ExecutePrompt({
+    systemPrompt: 'You are a data analyst. Analyze the provided dataset.',
+    messages: [
+      { message: 'What are the key trends?', role: 'user' }
+    ],
+    modelPower: 'medium'
+  });
+  
+  if (analysisResult.success) {
+    console.log('Analysis:', analysisResult.result);
+    
+    // Parse JSON if available
+    if (analysisResult.resultObject) {
+      const insights = analysisResult.resultObject;
+      // Use insights in your component
+    }
+  }
+  
+  // Generate embeddings for similarity matching
+  const embedResult = await ai.EmbedText({
+    textToEmbed: ['Product A description', 'Product B description'],
+    modelSize: 'small'
+  });
+  
+  // Use vector service for similarity calculations
+  const similarity = ai.VectorService.cosineSimilarity(
+    embedResult.result[0],
+    embedResult.result[1]
+  );
+  
+  console.log('Product similarity:', similarity);
+}
+```
+
+### Accessing Metadata and Running Views
+
+```typescript
+async function loadComponentData(props, events, data, metadata, runView) {
+  // Get entity metadata
+  const userEntity = metadata.Entities.find(e => e.Name === 'Users');
+  
+  // Run a view to get data
+  const viewResult = await runView.RunView({
+    EntityName: 'Users',
+    ExtraFilter: "Status = 'Active'",
+    OrderBy: 'LastName, FirstName',
+    MaxRows: 100
+  });
+  
+  if (viewResult.Success) {
+    const users = viewResult.Results;
+    // Process users data
+  }
+  
+  // Create/update an entity
+  const newUser = await metadata.GetEntityObject('Users');
+  newUser.NewRecord();
+  newUser.Set('FirstName', 'John');
+  newUser.Set('LastName', 'Doe');
+  await newUser.Save();
+}
+```
+
+### Running Multiple Operations in Parallel
+
+```typescript
+async function loadDashboardData(props, events, data, metadata, runView) {
+  // Run multiple views in parallel for better performance
+  const [salesData, customerData, productData] = await runView.RunViews([
+    { EntityName: 'Sales', ExtraFilter: "Date >= '2024-01-01'" },
+    { EntityName: 'Customers', ExtraFilter: "Active = 1" },
+    { EntityName: 'Products', OrderBy: 'Name' }
+  ]);
+  
+  // All data loaded in parallel
+  console.log('Sales:', salesData.Results);
+  console.log('Customers:', customerData.Results);
+  console.log('Products:', productData.Results);
+}
+```
+
+## Component Specifications
+
+The package includes comprehensive types for component specifications:
+
+- `InteractiveComponentSpec`: Full component specification including metadata, props, and initialization
+- `ComponentDataRequirement`: Defines data loading requirements
+- `ComponentOption`: Configuration options for components
+- `ComponentLibraryDependency`: External library dependencies
+- `ComponentSpecCategory`: Component categorization and metadata
+
+## Vector Service Capabilities
+
+The included `SimpleVectorService` provides:
+
+- **Cosine Similarity**: Calculate similarity between vectors
+- **Euclidean Distance**: Measure distance between points
+- **K-Nearest Neighbors (KNN)**: Find similar items
+- **Clustering**: Group similar items together
+- **Dimensionality Reduction**: PCA and t-SNE support
+
+## Best Practices
+
+1. **Model Selection**: Use `modelPower` parameter wisely - 'lowest' for simple tasks, 'highest' for complex analysis
+2. **Batch Operations**: Use `RunViews` for parallel data loading instead of sequential `RunView` calls
+3. **Embedding Caching**: Cache embeddings when possible as they're deterministic for the same input
+4. **Error Handling**: Always check `success` flags in AI operation results
+5. **JSON Parsing**: Use `resultObject` when expecting structured data from AI prompts
+
+## Type Safety
+
+All interfaces are fully typed with TypeScript, providing:
+- IntelliSense support in IDEs
+- Compile-time type checking
+- Better code documentation
+- Reduced runtime errors
+
+## Dependencies
+
+- `@memberjunction/core`: Core MemberJunction types and interfaces
+- `@memberjunction/ai-vectors-memory`: Vector operations and similarity calculations
+
+## License
+
+ISC

package/dist/runtime-types.d.ts

@@ -1,5 +1,5 @@
 import { CompositeKey } from "@memberjunction/core";
-import { SimpleMetadata, SimpleRunQuery, SimpleRunView } from "./shared";
+import { SimpleAITools, SimpleMetadata, SimpleRunQuery, SimpleRunView } from "./shared";
 /**
  * Callbacks a component can use.
  */
@@ -151,5 +151,10 @@ export interface ComponentUtilities {
     md: SimpleMetadata;
     rv: SimpleRunView;
     rq: SimpleRunQuery;
+    /**
+     * Access to AI tools. This will not always be available in all environments and security contexts, ensure
+     * component code has fallbacks when this property is undefined
+     */
+    ai?: SimpleAITools;
 }
 //# sourceMappingURL=runtime-types.d.ts.map

package/dist/runtime-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime-types.d.ts","sourceRoot":"","sources":["../src/runtime-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAqB,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;;OAKG;IACH,gBAAgB,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY,KAAK,IAAI,CAAC;CACrE;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC5B,MAAM,EAAE;QAEJ,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,EAAE,MAAM,CAAA;QACpB,YAAY,CAAC,EAAE,MAAM,CAAA;QAGrB,SAAS,EAAE,MAAM,CAAA;QACjB,cAAc,CAAC,EAAE,MAAM,CAAA;QAGvB,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,SAAS,CAAC,EAAE,MAAM,CAAA;QAGlB,UAAU,EAAE,MAAM,CAAA;QAClB,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE,MAAM,CAAA;QAGrB,IAAI,EAAE,MAAM,CAAA;QACZ,aAAa,EAAE,MAAM,CAAA;QACrB,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,WAAW,CAAC,EAAE,MAAM,CAAA;QAGpB,MAAM,EAAE,MAAM,CAAA;QACd,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,WAAW,CAAC,EAAE,MAAM,CAAA;QAGpB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,WAAW,CAAC,EAAE,MAAM,CAAA;QAGpB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACrC,CAAC;IACF,OAAO,EAAE;QACL,EAAE,EAAE,MAAM,CAAA;QACV,EAAE,EAAE,MAAM,CAAA;QACV,EAAE,EAAE,MAAM,CAAA;QACV,EAAE,EAAE,MAAM,CAAA;QACV,EAAE,EAAE,MAAM,CAAA;QACV,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,CAAA;QAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACrC,CAAC;IACF,UAAU,EAAE;QACR,UAAU,EAAE,MAAM,CAAA;QAClB,QAAQ,EAAE;YACR,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,EAAE,EAAE,MAAM,CAAA;YACV,EAAE,EAAE,MAAM,CAAA;YACV,EAAE,EAAE,MAAM,CAAA;YACV,EAAE,EAAE,MAAM,CAAA;YACV,GAAG,CAAC,EAAE,MAAM,CAAA;YACZ,IAAI,CAAC,EAAE,MAAM,CAAA;YAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAC;QACF,UAAU,CAAC,EAAE;YACX,KAAK,CAAC,EAAE,MAAM,CAAA;YACd,OAAO,CAAC,EAAE,MAAM,CAAA;YAChB,MAAM,CAAC,EAAE,MAAM,CAAA;YACf,QAAQ,CAAC,EAAE,MAAM,CAAA;YACjB,IAAI,CAAC,EAAE,MAAM,CAAA;YAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAC;QACF,UAAU,CAAC,EAAE;YACX,KAAK,CAAC,EAAE,MAAM,CAAA;YACd,MAAM,CAAC,EAAE,MAAM,CAAA;YACf,OAAO,CAAC,EAAE,MAAM,CAAA;YAGhB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAA;KACJ,CAAC;IACF,OAAO,EAAE;QACL,MAAM,EAAE,MAAM,GAAG;YACf,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,IAAI,CAAC,EAAE,MAAM,CAAA;YAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAC;QACF,KAAK,EAAE,MAAM,GAAG;YACd,IAAI,CAAC,EAAE,MAAM,CAAA;YACb,MAAM,CAAC,EAAE,MAAM,CAAA;YACf,KAAK,CAAC,EAAE,MAAM,CAAA;YAGd,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAC;KACL,CAAA;IACD,OAAO,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,KAAK,CAAC,EAAE,MAAM,CAAA;QAGd,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACrC,CAAA;IACD,WAAW,CAAC,EAAE;QACV,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;QAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACrC,CAAA;IACD,QAAQ,EAAE,MAAM,CAAA;CACnB;AAID;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,IAAI,CAAC;AAChD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,IAAI,CAAC;AAGlD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,SAAS,EAAE,GAAG,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,EAAE,EAAE,cAAc,CAAC;IACnB,EAAE,EAAE,aAAa,CAAC;IAClB,EAAE,EAAE,cAAc,CAAA;CACrB"}
+{"version":3,"file":"runtime-types.d.ts","sourceRoot":"","sources":["../src/runtime-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAqB,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE3G;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;;OAKG;IACH,gBAAgB,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY,KAAK,IAAI,CAAC;CACrE;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC5B,MAAM,EAAE;QAEJ,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,EAAE,MAAM,CAAA;QACpB,YAAY,CAAC,EAAE,MAAM,CAAA;QAGrB,SAAS,EAAE,MAAM,CAAA;QACjB,cAAc,CAAC,EAAE,MAAM,CAAA;QAGvB,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,SAAS,CAAC,EAAE,MAAM,CAAA;QAGlB,UAAU,EAAE,MAAM,CAAA;QAClB,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE,MAAM,CAAA;QAGrB,IAAI,EAAE,MAAM,CAAA;QACZ,aAAa,EAAE,MAAM,CAAA;QACrB,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,WAAW,CAAC,EAAE,MAAM,CAAA;QAGpB,MAAM,EAAE,MAAM,CAAA;QACd,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,WAAW,CAAC,EAAE,MAAM,CAAA;QAGpB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,WAAW,CAAC,EAAE,MAAM,CAAA;QAGpB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACrC,CAAC;IACF,OAAO,EAAE;QACL,EAAE,EAAE,MAAM,CAAA;QACV,EAAE,EAAE,MAAM,CAAA;QACV,EAAE,EAAE,MAAM,CAAA;QACV,EAAE,EAAE,MAAM,CAAA;QACV,EAAE,EAAE,MAAM,CAAA;QACV,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,CAAA;QAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACrC,CAAC;IACF,UAAU,EAAE;QACR,UAAU,EAAE,MAAM,CAAA;QAClB,QAAQ,EAAE;YACR,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,EAAE,EAAE,MAAM,CAAA;YACV,EAAE,EAAE,MAAM,CAAA;YACV,EAAE,EAAE,MAAM,CAAA;YACV,EAAE,EAAE,MAAM,CAAA;YACV,GAAG,CAAC,EAAE,MAAM,CAAA;YACZ,IAAI,CAAC,EAAE,MAAM,CAAA;YAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAC;QACF,UAAU,CAAC,EAAE;YACX,KAAK,CAAC,EAAE,MAAM,CAAA;YACd,OAAO,CAAC,EAAE,MAAM,CAAA;YAChB,MAAM,CAAC,EAAE,MAAM,CAAA;YACf,QAAQ,CAAC,EAAE,MAAM,CAAA;YACjB,IAAI,CAAC,EAAE,MAAM,CAAA;YAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAC;QACF,UAAU,CAAC,EAAE;YACX,KAAK,CAAC,EAAE,MAAM,CAAA;YACd,MAAM,CAAC,EAAE,MAAM,CAAA;YACf,OAAO,CAAC,EAAE,MAAM,CAAA;YAGhB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAA;KACJ,CAAC;IACF,OAAO,EAAE;QACL,MAAM,EAAE,MAAM,GAAG;YACf,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,IAAI,CAAC,EAAE,MAAM,CAAA;YAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAC;QACF,KAAK,EAAE,MAAM,GAAG;YACd,IAAI,CAAC,EAAE,MAAM,CAAA;YACb,MAAM,CAAC,EAAE,MAAM,CAAA;YACf,KAAK,CAAC,EAAE,MAAM,CAAA;YAGd,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAC;KACL,CAAA;IACD,OAAO,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,KAAK,CAAC,EAAE,MAAM,CAAA;QAGd,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACrC,CAAA;IACD,WAAW,CAAC,EAAE;QACV,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;QAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACrC,CAAA;IACD,QAAQ,EAAE,MAAM,CAAA;CACnB;AAID;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,IAAI,CAAC;AAChD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,IAAI,CAAC;AAGlD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,SAAS,EAAE,GAAG,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,EAAE,EAAE,cAAc,CAAC;IACnB,EAAE,EAAE,aAAa,CAAC;IAClB,EAAE,EAAE,cAAc,CAAC;IACnB;;;OAGG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;CACrB"}

package/dist/shared.d.ts

@@ -1,4 +1,5 @@
-import { BaseEntity, EntityInfo, RunQueryParams, RunQueryResult, RunViewParams, RunViewResult } from "@memberjunction/core";
+import { SimpleVectorService } from "@memberjunction/ai-vectors-memory";
+import { BaseEntity, EntityInfo, RunQueryParams, RunQueryResult, RunViewParams, RunViewResult, UserInfo } from "@memberjunction/core";
 /**
  * This is a simple data context object that is passed into the ComponentInitFunction containing any required `static` data. This object is empty when the mode is `dynamic`
  */
@@ -17,7 +18,7 @@ export interface SimpleMetadata {
      * Retrieves a single BaseEntity derived class for the specified entity
      * @param entityName
      */
-    GetEntityObject(entityName: string): Promise<BaseEntity>;
+    GetEntityObject(entityName: string, contextUser?: UserInfo): Promise<BaseEntity>;
 }
 /**
 * Simple interface for running views in MJ
@@ -28,13 +29,13 @@ export interface SimpleRunView {
      * @param params
      * @returns
      */
-    RunView: (params: RunViewParams) => Promise<RunViewResult>;
+    RunView: (params: RunViewParams, contextUser?: UserInfo) => Promise<RunViewResult>;
     /**
      * Runs multiple views and returns the results. This is efficient for running views in **parallel**.
      * @param params
      * @returns
      */
-    RunViews: (params: RunViewParams[]) => Promise<RunViewResult[]>;
+    RunViews: (params: RunViewParams[], contextUser?: UserInfo) => Promise<RunViewResult[]>;
 }
 /**
  * Simple interface for running predefined queries in MJ
@@ -45,6 +46,114 @@ export interface SimpleRunQuery {
      * @param params
      * @returns
      */
-    RunQuery: (params: RunQueryParams) => Promise<RunQueryResult>;
+    RunQuery: (params: RunQueryParams, contextUser?: UserInfo) => Promise<RunQueryResult>;
+}
+/**
+ * Params for an Interactive Component to execute a prompt
+ */
+export interface SimpleExecutePromptParams {
+    /**
+     * Text for the prompt, will be sent in as the system message
+     */
+    systemPrompt: string;
+    /**
+     * Optional, message history to append to the conversation after the system prompt
+     */
+    messages?: Array<{
+        message: string;
+        role: 'user' | 'assistant';
+    }>;
+    /**
+     * An ordered array of model names that are preferred for this prompt. This is not guaranteed but the preferences
+     * are taken into account
+     */
+    preferredModels?: string[];
+    /**
+     * Optional power level for model selection when preferredModels is not provided.
+     * 'lowest' = least powerful/cheapest model
+     * 'medium' = balanced power/cost (default)
+     * 'highest' = most powerful model
+     */
+    modelPower?: 'lowest' | 'medium' | 'highest';
+    /**
+     * Optional context user information
+     */
+    contextUser?: UserInfo;
+}
+/**
+ * Simple return structure for prompt execution
+ */
+export interface SimpleExecutePromptResult {
+    success: boolean;
+    /**
+     * Raw string result
+     */
+    result: string;
+    /**
+     * If the result was JSON or contained JSON anywhere within it that could be parsed, this will contain
+     * the JSON object
+     */
+    resultObject?: any;
+    /**
+     * The model that was used for the response
+     */
+    modelName: string;
+}
+/**
+ *
+ */
+export interface SimpleEmbedTextParams {
+    /**
+     * Either a single string or an array of strings to calculate embeddings for
+     */
+    textToEmbed: string | string[];
+    modelSize: 'small' | 'medium';
+    contextUser?: UserInfo;
+}
+/**
+ * Results of a call to EmbedText
+ */
+export interface SimpleEmbedTextResult {
+    /**
+     * Either a single vector if a single string was provided in params, or an array of vectors if an array of strings was provided to the method
+     */
+    result: number[] | Array<number[]>;
+    /**
+     * Name of the model used for embedding calculation
+     */
+    modelName: string;
+    /**
+     * Number of dimensions in each vector
+     */
+    vectorDimensions: number;
+}
+/**
+ * Provides a simple interface for InteractiveComponents to perform a wide variety of common AI operations
+ * such as prompt execution with LLMs, calculating embeddings on strings, and using vector search for small to mediun
+ * sized datasets in memory.
+ */
+export interface SimpleAITools {
+    /**
+     * Uses an LLM to respond to a provided prompt. Often used by interactive components to provide rich analysis of data within a component that a user
+     * is interested in gaining qualitative insights on
+     * @param params
+     * @returns
+     */
+    ExecutePrompt: (params: SimpleExecutePromptParams) => Promise<SimpleExecutePromptResult>;
+    /**
+     * Used to calculate vector embeddings for one or more strings. Uses very fast small/medium sized
+     * local models so the embeddings can be rapidly calculated for hundreds or even thousands of pieces of text.
+     * This allows interactive components to dynamically compute similarity/distance between any kinds of data
+     * and generate very interesting interactive experiences for users
+     * @param params
+     * @returns
+     */
+    EmbedText: (params: SimpleEmbedTextParams) => Promise<SimpleEmbedTextResult>;
+    /**
+     * Instance of the SimpleVectorService that can be used by Interactive Components
+     * @see SimpleVectorService for more details on this. This object can perform a wide array
+     * of vector data operations such as KNN, Similarity Scoring, and more.
+     */
+    VectorService: SimpleVectorService;
 }
 //# sourceMappingURL=shared.d.ts.map

package/dist/shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE5H;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB;;;OAGG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,OAAO,CAAC,aAAa,CAAC,CAAA;IAC1D;;;;OAIG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,KAAK,OAAO,CAAC,aAAa,EAAE,CAAC,CAAA;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;OAIG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC,cAAc,CAAC,CAAA;CAChE"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEtI;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB;;;OAGG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACpF;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,aAAa,CAAC,CAAA;IAClF;;;;OAIG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,EAAE,WAAW,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,aAAa,EAAE,CAAC,CAAA;CAC1F;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;OAIG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,WAAW,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,cAAc,CAAC,CAAA;CACxF;AAGD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAA;KAAC,CAAC,CAAC;IAChE;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B,SAAS,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC9B,WAAW,CAAC,EAAE,QAAQ,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;;OAKG;IACH,aAAa,EAAE,CAAC,MAAM,EAAE,yBAAyB,KAAK,OAAO,CAAC,yBAAyB,CAAC,CAAA;IAExF;;;;;;;OAOG;IACH,SAAS,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAE5E;;;;OAIG;IACH,aAAa,EAAE,mBAAmB,CAAA;CACrC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/interactive-component-types",
-  "version": "2.92.0",
+  "version": "2.93.0",
   "description": "MemberJunction: Interactive Component - Type specifications for MJ Interactive UI Componentry",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,6 +19,7 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@memberjunction/core": "2.92.0"
+    "@memberjunction/core": "2.93.0",
+    "@memberjunction/ai-vectors-memory": "2.93.0"
   }
 }