@memberjunction/graphql-dataprovider 2.102.0 → 2.104.0

package/dist/index.d.cts

@@ -3,6 +3,7 @@ export { gql } from 'graphql-request';
 import { ProviderConfigDataBase, ProviderBase, IEntityDataProvider, IMetadataProvider, IRunViewProvider, IRunReportProvider, IRunQueryProvider, UserInfo, RunReportParams, RunReportResult, RunQueryParams, RunQueryResult, RunViewParams, RunViewResult, EntityInfo, ProviderType, CompositeKey, RecordChange, RecordDependency, KeyValuePair, PotentialDuplicateRequest, PotentialDuplicateResponse, RecordMergeRequest, EntityMergeOptions, RecordMergeResult, BaseEntity, EntitySaveOptions, EntityDeleteOptions, DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, TransactionGroupBase, EntityRecordNameInput, EntityRecordNameResult, ILocalStorageProvider, TransactionResult } from '@memberjunction/core';
 import { UserViewEntityExtended } from '@memberjunction/core-entities';
 import { Observable } from 'rxjs';
+import { ExecuteAgentParams, ExecuteAgentResult } from '@memberjunction/ai-core-plus';
 import { ActionParam, ActionResult, EntityActionInvocationParams, EntityActionResult } from '@memberjunction/actions-base';
 
 /**
@@ -97,6 +98,9 @@ declare class GraphQLAIClient {
      * This method invokes an AI agent on the server through GraphQL and returns the result.
      * The agent can maintain conversation context across multiple interactions.
      *
+     * If a progress callback is provided in params.onProgress, this method will subscribe
+     * to real-time progress updates from the GraphQL server and forward them to the callback.
+     *
      * @param params The parameters for running the AI agent
      * @returns A Promise that resolves to a RunAIAgentResult object
      *
@@ -108,7 +112,10 @@ declare class GraphQLAIClient {
      *     { role: "user", content: "What's the weather like?" }
      *   ],
      *   sessionId: "session-123",
-     *   data: { location: "New York" }
+     *   data: { location: "New York" },
+     *   onProgress: (progress) => {
+     *     console.log(`Progress: ${progress.message} (${progress.percentage}%)`);
+     *   }
      * });
      *
      * if (result.success) {
@@ -119,7 +126,7 @@ declare class GraphQLAIClient {
      * }
      * ```
      */
-    RunAIAgent(params: RunAIAgentParams): Promise<RunAIAgentResult>;
+    RunAIAgent(params: ExecuteAgentParams): Promise<ExecuteAgentResult>;
     /**
      * Prepares variables for the AI agent mutation
      * @param params The agent parameters
@@ -416,67 +423,6 @@ interface RunAIPromptResult {
      */
     chatResult?: any;
 }
-/**
- * Parameters for running an AI agent
- */
-interface RunAIAgentParams {
-    /**
-     * The ID of the AI agent to run
-     */
-    agentId: string;
-    /**
-     * Conversation messages
-     */
-    messages: Array<{
-        role: string;
-        content: string;
-    }>;
-    /**
-     * Session ID for maintaining conversation context
-     */
-    sessionId: string;
-    /**
-     * Data context to pass to the agent (will be JSON serialized)
-     */
-    data?: Record<string, any>;
-    /**
-     * Template data for agent templating (will be JSON serialized)
-     */
-    templateData?: Record<string, any>;
-    /**
-     * ID of the last agent run for context continuity
-     */
-    lastRunId?: string;
-    /**
-     * Auto-populate the last run payload
-     */
-    autoPopulateLastRunPayload?: boolean;
-    /**
-     * Configuration ID to use
-     */
-    configurationId?: string;
-}
-/**
- * Result from running an AI agent
- */
-interface RunAIAgentResult {
-    /**
-     * Whether the agent execution was successful
-     */
-    success: boolean;
-    /**
-     * Error message if the execution failed
-     */
-    errorMessage?: string;
-    /**
-     * Execution time in milliseconds
-     */
-    executionTimeMs?: number;
-    /**
-     * The agent's response payload (parsed from JSON)
-     */
-    payload?: any;
-}
 
 /**************************************************************************************************************
  * The graphQLDataProvider provides a data provider for the entities framework that uses GraphQL to communicate
@@ -870,6 +816,7 @@ declare class ActionItemOutput {
  */
 declare class GraphQLSystemUserClient {
     private _client;
+    private _sessionId;
     /**
      * Returns the underlying GraphQL client which is an instance of the GraphQLClient object
      * from the graphql-request package. This is useful if you want to perform any operation
@@ -1011,7 +958,7 @@ declare class GraphQLSystemUserClient {
      * });
      * ```
      */
-    RunAIAgent(params: RunAIAgentParams): Promise<RunAIAgentResult>;
+    RunAIAgent(params: ExecuteAgentParams): Promise<ExecuteAgentResult>;
     /**
      * Helper method to prepare prompt variables for GraphQL
      * @private
@@ -2600,6 +2547,72 @@ interface ComponentDependencyTree {
      */
     totalCount?: number;
 }
+/**
+ * Input parameters for sending component feedback
+ */
+interface ComponentFeedbackParams {
+    /**
+     * Component name
+     */
+    componentName: string;
+    /**
+     * Component namespace
+     */
+    componentNamespace: string;
+    /**
+     * Component version (optional)
+     */
+    componentVersion?: string;
+    /**
+     * Registry name (optional - for registry-specific feedback)
+     */
+    registryName?: string;
+    /**
+     * Rating (typically 0-5 scale)
+     */
+    rating: number;
+    /**
+     * Type of feedback (optional)
+     */
+    feedbackType?: string;
+    /**
+     * User comments (optional)
+     */
+    comments?: string;
+    /**
+     * Associated conversation ID (optional)
+     */
+    conversationID?: string;
+    /**
+     * Associated conversation detail ID (optional)
+     */
+    conversationDetailID?: string;
+    /**
+     * Associated report ID (optional)
+     */
+    reportID?: string;
+    /**
+     * Associated dashboard ID (optional)
+     */
+    dashboardID?: string;
+}
+/**
+ * Response from sending component feedback
+ */
+interface ComponentFeedbackResponse {
+    /**
+     * Whether the feedback was successfully submitted
+     */
+    success: boolean;
+    /**
+     * ID of the created feedback record (if available)
+     */
+    feedbackID?: string;
+    /**
+     * Error message if submission failed
+     */
+    error?: string;
+}
 /**
  * Client for executing Component Registry operations through GraphQL.
  * This class provides an easy way to fetch components from external registries
@@ -2782,6 +2795,40 @@ declare class GraphQLComponentRegistryClient {
      * ```
      */
     GetLatestVersion(registryName: string, namespace: string, name: string): Promise<string | null>;
+    /**
+     * Send feedback for a component.
+     *
+     * This is a registry-agnostic method that allows submitting feedback
+     * for any component from any registry. The feedback can include ratings,
+     * comments, and associations with conversations, reports, or dashboards.
+     *
+     * @param params The feedback parameters
+     * @returns A Promise that resolves to a ComponentFeedbackResponse
+     *
+     * @example
+     * ```typescript
+     * const response = await registryClient.SendComponentFeedback({
+     *   componentName: 'DataGrid',
+     *   componentNamespace: 'core/ui',
+     *   componentVersion: '1.0.0',
+     *   registryName: 'MJ',
+     *   rating: 5,
+     *   feedbackType: 'feature-request',
+     *   comments: 'Would love to see export to Excel functionality',
+     *   conversationID: 'conv-123'
+     * });
+     *
+     * if (response.success) {
+     *   console.log('Feedback submitted successfully!');
+     *   if (response.feedbackID) {
+     *     console.log(`Feedback ID: ${response.feedbackID}`);
+     *   }
+     * } else {
+     *   console.error('Feedback submission failed:', response.error);
+     * }
+     * ```
+     */
+    SendComponentFeedback(params: ComponentFeedbackParams): Promise<ComponentFeedbackResponse>;
 }
 
-export { ActionItemInput, ActionItemOutput, type ComponentDependencyTree, type ComponentSpecWithHash, type CreateQueryInput, type CreateQueryResult, type DeleteQueryOptionsInput, type DeleteQueryResult, type EmbedTextParams, type EmbedTextResult, type ExecuteSimplePromptParams, FieldMapper, GetDataOutput, type GetQueryDataByNameSystemUserInput, type GetQueryDataSystemUserInput, type GetRegistryComponentParams, GraphQLAIClient, GraphQLActionClient, GraphQLComponentRegistryClient, GraphQLDataProvider, GraphQLProviderConfigData, GraphQLSystemUserClient, GraphQLTransactionGroup, type QueryEntity, type QueryField, type QueryParameter, type QueryPermission, type QueryPermissionInput, type RegistryComponentSearchResult, RoleInput, RolesAndUsersInput, type RunAIAgentParams, type RunAIAgentResult, type RunAIPromptParams, type RunAIPromptResult, type RunDynamicViewSystemUserInput, type RunQuerySystemUserResult, type RunViewByIDSystemUserInput, type RunViewByNameSystemUserInput, type RunViewSystemUserInput, type RunViewSystemUserResult, type RunViewSystemUserResultRow, type SearchRegistryComponentsParams, type SimplePromptResult, SimpleRemoteEntity, SimpleRemoteEntityField, SimpleRemoteEntityOutput, SyncDataAction, SyncDataResult, SyncRolesAndUsersResult, type UpdateQueryInput, type UpdateQueryResult, UserInput, setupGraphQLClient };
+export { ActionItemInput, ActionItemOutput, type ComponentDependencyTree, type ComponentSpecWithHash, type CreateQueryInput, type CreateQueryResult, type DeleteQueryOptionsInput, type DeleteQueryResult, type EmbedTextParams, type EmbedTextResult, type ExecuteSimplePromptParams, FieldMapper, GetDataOutput, type GetQueryDataByNameSystemUserInput, type GetQueryDataSystemUserInput, type GetRegistryComponentParams, GraphQLAIClient, GraphQLActionClient, GraphQLComponentRegistryClient, GraphQLDataProvider, GraphQLProviderConfigData, GraphQLSystemUserClient, GraphQLTransactionGroup, type QueryEntity, type QueryField, type QueryParameter, type QueryPermission, type QueryPermissionInput, type RegistryComponentSearchResult, RoleInput, RolesAndUsersInput, type RunAIPromptParams, type RunAIPromptResult, type RunDynamicViewSystemUserInput, type RunQuerySystemUserResult, type RunViewByIDSystemUserInput, type RunViewByNameSystemUserInput, type RunViewSystemUserInput, type RunViewSystemUserResult, type RunViewSystemUserResultRow, type SearchRegistryComponentsParams, type SimplePromptResult, SimpleRemoteEntity, SimpleRemoteEntityField, SimpleRemoteEntityOutput, SyncDataAction, SyncDataResult, SyncRolesAndUsersResult, type UpdateQueryInput, type UpdateQueryResult, UserInput, setupGraphQLClient };

package/dist/index.d.mts

@@ -3,6 +3,7 @@ export { gql } from 'graphql-request';
 import { ProviderConfigDataBase, ProviderBase, IEntityDataProvider, IMetadataProvider, IRunViewProvider, IRunReportProvider, IRunQueryProvider, UserInfo, RunReportParams, RunReportResult, RunQueryParams, RunQueryResult, RunViewParams, RunViewResult, EntityInfo, ProviderType, CompositeKey, RecordChange, RecordDependency, KeyValuePair, PotentialDuplicateRequest, PotentialDuplicateResponse, RecordMergeRequest, EntityMergeOptions, RecordMergeResult, BaseEntity, EntitySaveOptions, EntityDeleteOptions, DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, TransactionGroupBase, EntityRecordNameInput, EntityRecordNameResult, ILocalStorageProvider, TransactionResult } from '@memberjunction/core';
 import { UserViewEntityExtended } from '@memberjunction/core-entities';
 import { Observable } from 'rxjs';
+import { ExecuteAgentParams, ExecuteAgentResult } from '@memberjunction/ai-core-plus';
 import { ActionParam, ActionResult, EntityActionInvocationParams, EntityActionResult } from '@memberjunction/actions-base';
 
 /**
@@ -97,6 +98,9 @@ declare class GraphQLAIClient {
      * This method invokes an AI agent on the server through GraphQL and returns the result.
      * The agent can maintain conversation context across multiple interactions.
      *
+     * If a progress callback is provided in params.onProgress, this method will subscribe
+     * to real-time progress updates from the GraphQL server and forward them to the callback.
+     *
      * @param params The parameters for running the AI agent
      * @returns A Promise that resolves to a RunAIAgentResult object
      *
@@ -108,7 +112,10 @@ declare class GraphQLAIClient {
      *     { role: "user", content: "What's the weather like?" }
      *   ],
      *   sessionId: "session-123",
-     *   data: { location: "New York" }
+     *   data: { location: "New York" },
+     *   onProgress: (progress) => {
+     *     console.log(`Progress: ${progress.message} (${progress.percentage}%)`);
+     *   }
      * });
      *
      * if (result.success) {
@@ -119,7 +126,7 @@ declare class GraphQLAIClient {
      * }
      * ```
      */
-    RunAIAgent(params: RunAIAgentParams): Promise<RunAIAgentResult>;
+    RunAIAgent(params: ExecuteAgentParams): Promise<ExecuteAgentResult>;
     /**
      * Prepares variables for the AI agent mutation
      * @param params The agent parameters
@@ -416,67 +423,6 @@ interface RunAIPromptResult {
      */
     chatResult?: any;
 }
-/**
- * Parameters for running an AI agent
- */
-interface RunAIAgentParams {
-    /**
-     * The ID of the AI agent to run
-     */
-    agentId: string;
-    /**
-     * Conversation messages
-     */
-    messages: Array<{
-        role: string;
-        content: string;
-    }>;
-    /**
-     * Session ID for maintaining conversation context
-     */
-    sessionId: string;
-    /**
-     * Data context to pass to the agent (will be JSON serialized)
-     */
-    data?: Record<string, any>;
-    /**
-     * Template data for agent templating (will be JSON serialized)
-     */
-    templateData?: Record<string, any>;
-    /**
-     * ID of the last agent run for context continuity
-     */
-    lastRunId?: string;
-    /**
-     * Auto-populate the last run payload
-     */
-    autoPopulateLastRunPayload?: boolean;
-    /**
-     * Configuration ID to use
-     */
-    configurationId?: string;
-}
-/**
- * Result from running an AI agent
- */
-interface RunAIAgentResult {
-    /**
-     * Whether the agent execution was successful
-     */
-    success: boolean;
-    /**
-     * Error message if the execution failed
-     */
-    errorMessage?: string;
-    /**
-     * Execution time in milliseconds
-     */
-    executionTimeMs?: number;
-    /**
-     * The agent's response payload (parsed from JSON)
-     */
-    payload?: any;
-}
 
 /**************************************************************************************************************
  * The graphQLDataProvider provides a data provider for the entities framework that uses GraphQL to communicate
@@ -870,6 +816,7 @@ declare class ActionItemOutput {
  */
 declare class GraphQLSystemUserClient {
     private _client;
+    private _sessionId;
     /**
      * Returns the underlying GraphQL client which is an instance of the GraphQLClient object
      * from the graphql-request package. This is useful if you want to perform any operation
@@ -1011,7 +958,7 @@ declare class GraphQLSystemUserClient {
      * });
      * ```
      */
-    RunAIAgent(params: RunAIAgentParams): Promise<RunAIAgentResult>;
+    RunAIAgent(params: ExecuteAgentParams): Promise<ExecuteAgentResult>;
     /**
      * Helper method to prepare prompt variables for GraphQL
      * @private
@@ -2600,6 +2547,72 @@ interface ComponentDependencyTree {
      */
     totalCount?: number;
 }
+/**
+ * Input parameters for sending component feedback
+ */
+interface ComponentFeedbackParams {
+    /**
+     * Component name
+     */
+    componentName: string;
+    /**
+     * Component namespace
+     */
+    componentNamespace: string;
+    /**
+     * Component version (optional)
+     */
+    componentVersion?: string;
+    /**
+     * Registry name (optional - for registry-specific feedback)
+     */
+    registryName?: string;
+    /**
+     * Rating (typically 0-5 scale)
+     */
+    rating: number;
+    /**
+     * Type of feedback (optional)
+     */
+    feedbackType?: string;
+    /**
+     * User comments (optional)
+     */
+    comments?: string;
+    /**
+     * Associated conversation ID (optional)
+     */
+    conversationID?: string;
+    /**
+     * Associated conversation detail ID (optional)
+     */
+    conversationDetailID?: string;
+    /**
+     * Associated report ID (optional)
+     */
+    reportID?: string;
+    /**
+     * Associated dashboard ID (optional)
+     */
+    dashboardID?: string;
+}
+/**
+ * Response from sending component feedback
+ */
+interface ComponentFeedbackResponse {
+    /**
+     * Whether the feedback was successfully submitted
+     */
+    success: boolean;
+    /**
+     * ID of the created feedback record (if available)
+     */
+    feedbackID?: string;
+    /**
+     * Error message if submission failed
+     */
+    error?: string;
+}
 /**
  * Client for executing Component Registry operations through GraphQL.
  * This class provides an easy way to fetch components from external registries
@@ -2782,6 +2795,40 @@ declare class GraphQLComponentRegistryClient {
      * ```
      */
     GetLatestVersion(registryName: string, namespace: string, name: string): Promise<string | null>;
+    /**
+     * Send feedback for a component.
+     *
+     * This is a registry-agnostic method that allows submitting feedback
+     * for any component from any registry. The feedback can include ratings,
+     * comments, and associations with conversations, reports, or dashboards.
+     *
+     * @param params The feedback parameters
+     * @returns A Promise that resolves to a ComponentFeedbackResponse
+     *
+     * @example
+     * ```typescript
+     * const response = await registryClient.SendComponentFeedback({
+     *   componentName: 'DataGrid',
+     *   componentNamespace: 'core/ui',
+     *   componentVersion: '1.0.0',
+     *   registryName: 'MJ',
+     *   rating: 5,
+     *   feedbackType: 'feature-request',
+     *   comments: 'Would love to see export to Excel functionality',
+     *   conversationID: 'conv-123'
+     * });
+     *
+     * if (response.success) {
+     *   console.log('Feedback submitted successfully!');
+     *   if (response.feedbackID) {
+     *     console.log(`Feedback ID: ${response.feedbackID}`);
+     *   }
+     * } else {
+     *   console.error('Feedback submission failed:', response.error);
+     * }
+     * ```
+     */
+    SendComponentFeedback(params: ComponentFeedbackParams): Promise<ComponentFeedbackResponse>;
 }
 
-export { ActionItemInput, ActionItemOutput, type ComponentDependencyTree, type ComponentSpecWithHash, type CreateQueryInput, type CreateQueryResult, type DeleteQueryOptionsInput, type DeleteQueryResult, type EmbedTextParams, type EmbedTextResult, type ExecuteSimplePromptParams, FieldMapper, GetDataOutput, type GetQueryDataByNameSystemUserInput, type GetQueryDataSystemUserInput, type GetRegistryComponentParams, GraphQLAIClient, GraphQLActionClient, GraphQLComponentRegistryClient, GraphQLDataProvider, GraphQLProviderConfigData, GraphQLSystemUserClient, GraphQLTransactionGroup, type QueryEntity, type QueryField, type QueryParameter, type QueryPermission, type QueryPermissionInput, type RegistryComponentSearchResult, RoleInput, RolesAndUsersInput, type RunAIAgentParams, type RunAIAgentResult, type RunAIPromptParams, type RunAIPromptResult, type RunDynamicViewSystemUserInput, type RunQuerySystemUserResult, type RunViewByIDSystemUserInput, type RunViewByNameSystemUserInput, type RunViewSystemUserInput, type RunViewSystemUserResult, type RunViewSystemUserResultRow, type SearchRegistryComponentsParams, type SimplePromptResult, SimpleRemoteEntity, SimpleRemoteEntityField, SimpleRemoteEntityOutput, SyncDataAction, SyncDataResult, SyncRolesAndUsersResult, type UpdateQueryInput, type UpdateQueryResult, UserInput, setupGraphQLClient };
+export { ActionItemInput, ActionItemOutput, type ComponentDependencyTree, type ComponentSpecWithHash, type CreateQueryInput, type CreateQueryResult, type DeleteQueryOptionsInput, type DeleteQueryResult, type EmbedTextParams, type EmbedTextResult, type ExecuteSimplePromptParams, FieldMapper, GetDataOutput, type GetQueryDataByNameSystemUserInput, type GetQueryDataSystemUserInput, type GetRegistryComponentParams, GraphQLAIClient, GraphQLActionClient, GraphQLComponentRegistryClient, GraphQLDataProvider, GraphQLProviderConfigData, GraphQLSystemUserClient, GraphQLTransactionGroup, type QueryEntity, type QueryField, type QueryParameter, type QueryPermission, type QueryPermissionInput, type RegistryComponentSearchResult, RoleInput, RolesAndUsersInput, type RunAIPromptParams, type RunAIPromptResult, type RunDynamicViewSystemUserInput, type RunQuerySystemUserResult, type RunViewByIDSystemUserInput, type RunViewByNameSystemUserInput, type RunViewSystemUserInput, type RunViewSystemUserResult, type RunViewSystemUserResultRow, type SearchRegistryComponentsParams, type SimplePromptResult, SimpleRemoteEntity, SimpleRemoteEntityField, SimpleRemoteEntityOutput, SyncDataAction, SyncDataResult, SyncRolesAndUsersResult, type UpdateQueryInput, type UpdateQueryResult, UserInput, setupGraphQLClient };