@memberjunction/graphql-dataprovider 2.116.0 → 2.118.0

package/dist/index.d.cts

@@ -2014,6 +2014,150 @@ declare class GraphQLActionClient {
     private handleEntityActionError;
 }
 
+/**
+ * Parameters for running a test
+ */
+interface RunTestParams {
+    testId: string;
+    verbose?: boolean;
+    environment?: string;
+    onProgress?: (progress: TestExecutionProgress) => void;
+}
+/**
+ * Result from running a test
+ */
+interface RunTestResult {
+    success: boolean;
+    errorMessage?: string;
+    executionTimeMs?: number;
+    result: any;
+}
+/**
+ * Parameters for running a test suite
+ */
+interface RunTestSuiteParams {
+    suiteId: string;
+    verbose?: boolean;
+    environment?: string;
+    parallel?: boolean;
+    onProgress?: (progress: TestExecutionProgress) => void;
+}
+/**
+ * Result from running a test suite
+ */
+interface RunTestSuiteResult {
+    success: boolean;
+    errorMessage?: string;
+    executionTimeMs?: number;
+    result: any;
+}
+/**
+ * Test execution progress update
+ */
+interface TestExecutionProgress {
+    currentStep: string;
+    percentage: number;
+    message: string;
+    testName?: string;
+    driverType?: string;
+    oracleEvaluation?: string;
+}
+/**
+ * Client for executing tests through GraphQL.
+ * This class provides an easy way to run tests and test suites from a client application.
+ *
+ * @example
+ * ```typescript
+ * // Create the client
+ * const testingClient = new GraphQLTestingClient(graphQLProvider);
+ *
+ * // Run a test
+ * const result = await testingClient.RunTest({
+ *   testId: "test-uuid",
+ *   verbose: true,
+ *   environment: "dev"
+ * });
+ *
+ * // Run a test suite
+ * const suiteResult = await testingClient.RunTestSuite({
+ *   suiteId: "suite-uuid",
+ *   parallel: true
+ * });
+ * ```
+ */
+declare class GraphQLTestingClient {
+    private _dataProvider;
+    /**
+     * Creates a new GraphQLTestingClient instance.
+     * @param dataProvider The GraphQL data provider to use for queries
+     */
+    constructor(dataProvider: GraphQLDataProvider);
+    /**
+     * Run a single test with the specified parameters.
+     *
+     * This method invokes a test on the server through GraphQL and returns the result.
+     * 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 test
+     * @returns A Promise that resolves to a RunTestResult object
+     *
+     * @example
+     * ```typescript
+     * const result = await testingClient.RunTest({
+     *   testId: "test-uuid",
+     *   verbose: true,
+     *   environment: "staging",
+     *   onProgress: (progress) => {
+     *     console.log(`${progress.currentStep}: ${progress.message} (${progress.percentage}%)`);
+     *   }
+     * });
+     *
+     * if (result.success) {
+     *   console.log('Test passed!', result.result);
+     * } else {
+     *   console.error('Test failed:', result.errorMessage);
+     * }
+     * ```
+     */
+    RunTest(params: RunTestParams): Promise<RunTestResult>;
+    /**
+     * Run a test suite with the specified parameters.
+     *
+     * 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 test suite
+     * @returns A Promise that resolves to a RunTestSuiteResult object
+     *
+     * @example
+     * ```typescript
+     * const result = await testingClient.RunTestSuite({
+     *   suiteId: "suite-uuid",
+     *   parallel: true,
+     *   verbose: false,
+     *   onProgress: (progress) => {
+     *     console.log(`Progress: ${progress.message} (${progress.percentage}%)`);
+     *   }
+     * });
+     *
+     * console.log(`Suite: ${result.result.totalTests} tests run`);
+     * console.log(`Passed: ${result.result.passedTests}`);
+     * ```
+     */
+    RunTestSuite(params: RunTestSuiteParams): Promise<RunTestSuiteResult>;
+    /**
+     * Check if a test is currently running
+     *
+     * @param testId The test ID to check
+     * @returns True if the test is running, false otherwise
+     */
+    IsTestRunning(testId: string): Promise<boolean>;
+    private processTestResult;
+    private processSuiteResult;
+    private handleError;
+}
+
 interface ComponentDataRequirements {
     /**
      * How the component gets its data
@@ -2345,6 +2489,19 @@ declare class ComponentSpec {
      * Technical explanation of the component in markdown.
      */
     technicalDesign: string;
+    /**
+     * Optional array of diagrams that use Mermaid syntax to illustrate component design.
+     * When provided each entry in the array specifies a title, optional description and the mermaid content itself.
+     * Examples of diagrams include:
+     * - Flowcharts of the process the component implements
+     * - Entity-relationship diagrams of the data model the component uses
+     * - Sequence diagrams illustrating interactions between the components various parts
+     */
+    diagrams?: Array<{
+        title: string;
+        description?: string;
+        content: string;
+    }>;
     /**
      * Properties the component accepts, if any
      */
@@ -2374,6 +2531,21 @@ declare class ComponentSpec {
      * Relevant examples of components intended to inspire this component's creation
      */
     relevantExamples?: ComponentExample[];
+    /**
+     * Self-declared maturity level of the component. When a component is "in progress" and is not
+     * yet complete but is partially done, it can be marked as "incomplete". When it is functionally complete
+     * but not yet widely tested, it can be marked as "beta". When it is fully complete and tested, it can be marked
+     * as "production". This is intended to help architects and developers understand the readiness of a component
+     * for use in production systems.
+     */
+    readinessLevel?: "incomplete" | "beta" | "production";
+    /**
+     * If a component isn't complete or encounters problems in testing, this field can be used to
+     * track a work plan for completing or fixing the component. Generally this work plan string will contain
+     * a markdown formatted list of tasks to be done with rich explanations to allow developers (human+AI) to
+     * collaborate on completing the component.
+     */
+    workPlan?: string;
 }
 /**
  * Defines standard and custom methods a component implements
@@ -2863,4 +3035,4 @@ declare class GraphQLComponentRegistryClient {
     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 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, GraphQLTestingClient, GraphQLTransactionGroup, type QueryEntity, type QueryField, type QueryParameter, type QueryPermission, type QueryPermissionInput, type RegistryComponentSearchResult, RoleInput, RolesAndUsersInput, type RunAIPromptParams, type RunAIPromptResult, type RunDynamicViewSystemUserInput, type RunQuerySystemUserResult, type RunTestParams, type RunTestResult, type RunTestSuiteParams, type RunTestSuiteResult, type RunViewByIDSystemUserInput, type RunViewByNameSystemUserInput, type RunViewSystemUserInput, type RunViewSystemUserResult, type RunViewSystemUserResultRow, type SearchRegistryComponentsParams, type SimplePromptResult, SimpleRemoteEntity, SimpleRemoteEntityField, SimpleRemoteEntityOutput, SyncDataAction, SyncDataResult, SyncRolesAndUsersResult, type TestExecutionProgress, type UpdateQueryInput, type UpdateQueryResult, UserInput, setupGraphQLClient };

package/dist/index.d.mts

@@ -2014,6 +2014,150 @@ declare class GraphQLActionClient {
     private handleEntityActionError;
 }
 
+/**
+ * Parameters for running a test
+ */
+interface RunTestParams {
+    testId: string;
+    verbose?: boolean;
+    environment?: string;
+    onProgress?: (progress: TestExecutionProgress) => void;
+}
+/**
+ * Result from running a test
+ */
+interface RunTestResult {
+    success: boolean;
+    errorMessage?: string;
+    executionTimeMs?: number;
+    result: any;
+}
+/**
+ * Parameters for running a test suite
+ */
+interface RunTestSuiteParams {
+    suiteId: string;
+    verbose?: boolean;
+    environment?: string;
+    parallel?: boolean;
+    onProgress?: (progress: TestExecutionProgress) => void;
+}
+/**
+ * Result from running a test suite
+ */
+interface RunTestSuiteResult {
+    success: boolean;
+    errorMessage?: string;
+    executionTimeMs?: number;
+    result: any;
+}
+/**
+ * Test execution progress update
+ */
+interface TestExecutionProgress {
+    currentStep: string;
+    percentage: number;
+    message: string;
+    testName?: string;
+    driverType?: string;
+    oracleEvaluation?: string;
+}
+/**
+ * Client for executing tests through GraphQL.
+ * This class provides an easy way to run tests and test suites from a client application.
+ *
+ * @example
+ * ```typescript
+ * // Create the client
+ * const testingClient = new GraphQLTestingClient(graphQLProvider);
+ *
+ * // Run a test
+ * const result = await testingClient.RunTest({
+ *   testId: "test-uuid",
+ *   verbose: true,
+ *   environment: "dev"
+ * });
+ *
+ * // Run a test suite
+ * const suiteResult = await testingClient.RunTestSuite({
+ *   suiteId: "suite-uuid",
+ *   parallel: true
+ * });
+ * ```
+ */
+declare class GraphQLTestingClient {
+    private _dataProvider;
+    /**
+     * Creates a new GraphQLTestingClient instance.
+     * @param dataProvider The GraphQL data provider to use for queries
+     */
+    constructor(dataProvider: GraphQLDataProvider);
+    /**
+     * Run a single test with the specified parameters.
+     *
+     * This method invokes a test on the server through GraphQL and returns the result.
+     * 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 test
+     * @returns A Promise that resolves to a RunTestResult object
+     *
+     * @example
+     * ```typescript
+     * const result = await testingClient.RunTest({
+     *   testId: "test-uuid",
+     *   verbose: true,
+     *   environment: "staging",
+     *   onProgress: (progress) => {
+     *     console.log(`${progress.currentStep}: ${progress.message} (${progress.percentage}%)`);
+     *   }
+     * });
+     *
+     * if (result.success) {
+     *   console.log('Test passed!', result.result);
+     * } else {
+     *   console.error('Test failed:', result.errorMessage);
+     * }
+     * ```
+     */
+    RunTest(params: RunTestParams): Promise<RunTestResult>;
+    /**
+     * Run a test suite with the specified parameters.
+     *
+     * 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 test suite
+     * @returns A Promise that resolves to a RunTestSuiteResult object
+     *
+     * @example
+     * ```typescript
+     * const result = await testingClient.RunTestSuite({
+     *   suiteId: "suite-uuid",
+     *   parallel: true,
+     *   verbose: false,
+     *   onProgress: (progress) => {
+     *     console.log(`Progress: ${progress.message} (${progress.percentage}%)`);
+     *   }
+     * });
+     *
+     * console.log(`Suite: ${result.result.totalTests} tests run`);
+     * console.log(`Passed: ${result.result.passedTests}`);
+     * ```
+     */
+    RunTestSuite(params: RunTestSuiteParams): Promise<RunTestSuiteResult>;
+    /**
+     * Check if a test is currently running
+     *
+     * @param testId The test ID to check
+     * @returns True if the test is running, false otherwise
+     */
+    IsTestRunning(testId: string): Promise<boolean>;
+    private processTestResult;
+    private processSuiteResult;
+    private handleError;
+}
+
 interface ComponentDataRequirements {
     /**
      * How the component gets its data
@@ -2345,6 +2489,19 @@ declare class ComponentSpec {
      * Technical explanation of the component in markdown.
      */
     technicalDesign: string;
+    /**
+     * Optional array of diagrams that use Mermaid syntax to illustrate component design.
+     * When provided each entry in the array specifies a title, optional description and the mermaid content itself.
+     * Examples of diagrams include:
+     * - Flowcharts of the process the component implements
+     * - Entity-relationship diagrams of the data model the component uses
+     * - Sequence diagrams illustrating interactions between the components various parts
+     */
+    diagrams?: Array<{
+        title: string;
+        description?: string;
+        content: string;
+    }>;
     /**
      * Properties the component accepts, if any
      */
@@ -2374,6 +2531,21 @@ declare class ComponentSpec {
      * Relevant examples of components intended to inspire this component's creation
      */
     relevantExamples?: ComponentExample[];
+    /**
+     * Self-declared maturity level of the component. When a component is "in progress" and is not
+     * yet complete but is partially done, it can be marked as "incomplete". When it is functionally complete
+     * but not yet widely tested, it can be marked as "beta". When it is fully complete and tested, it can be marked
+     * as "production". This is intended to help architects and developers understand the readiness of a component
+     * for use in production systems.
+     */
+    readinessLevel?: "incomplete" | "beta" | "production";
+    /**
+     * If a component isn't complete or encounters problems in testing, this field can be used to
+     * track a work plan for completing or fixing the component. Generally this work plan string will contain
+     * a markdown formatted list of tasks to be done with rich explanations to allow developers (human+AI) to
+     * collaborate on completing the component.
+     */
+    workPlan?: string;
 }
 /**
  * Defines standard and custom methods a component implements
@@ -2863,4 +3035,4 @@ declare class GraphQLComponentRegistryClient {
     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 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, GraphQLTestingClient, GraphQLTransactionGroup, type QueryEntity, type QueryField, type QueryParameter, type QueryPermission, type QueryPermissionInput, type RegistryComponentSearchResult, RoleInput, RolesAndUsersInput, type RunAIPromptParams, type RunAIPromptResult, type RunDynamicViewSystemUserInput, type RunQuerySystemUserResult, type RunTestParams, type RunTestResult, type RunTestSuiteParams, type RunTestSuiteResult, type RunViewByIDSystemUserInput, type RunViewByNameSystemUserInput, type RunViewSystemUserInput, type RunViewSystemUserResult, type RunViewSystemUserResultRow, type SearchRegistryComponentsParams, type SimplePromptResult, SimpleRemoteEntity, SimpleRemoteEntityField, SimpleRemoteEntityOutput, SyncDataAction, SyncDataResult, SyncRolesAndUsersResult, type TestExecutionProgress, type UpdateQueryInput, type UpdateQueryResult, UserInput, setupGraphQLClient };