Class GraphQLComponentRegistryClient

Client for executing Component Registry operations through GraphQL. This class provides an easy way to fetch components from external registries through the MJ API server, which handles authentication and caching.

The GraphQLComponentRegistryClient follows the same naming convention as other GraphQL clients in the MemberJunction ecosystem, such as GraphQLAIClient and GraphQLActionClient.

Example

// Create the client
const registryClient = new GraphQLComponentRegistryClient(graphQLProvider);

// Get a component from a registry
const component = await registryClient.GetRegistryComponent({
  registryName: "MJ",
  namespace: "core/ui",
  name: "DataGrid",
  version: "1.0.0"
});

// Search for components
const searchResult = await registryClient.SearchRegistryComponents({
  query: "dashboard",
  type: "dashboard",
  limit: 10
});

Index

Constructors

constructor

Methods

ComponentExists GetLatestVersion GetRegistryComponent GetRegistryComponentWithHash ResolveComponentDependencies SearchRegistryComponents SendComponentFeedback

Constructors

constructor

new GraphQLComponentRegistryClient(
dataProvider: GraphQLDataProvider,
): GraphQLComponentRegistryClient
Creates a new GraphQLComponentRegistryClient instance.
Parameters
- dataProvider: GraphQLDataProvider
  The GraphQL data provider to use for queries
Returns GraphQLComponentRegistryClient
- Defined in packages/GraphQLDataProvider/src/GraphQLComponentRegistryClient.ts:286

Methods

ComponentExists

ComponentExists(params: GetRegistryComponentParams): Promise<boolean>
Check if a specific version of a component exists in a registry.
Parameters
- params: GetRegistryComponentParams
  The parameters for checking component existence
Returns Promise<boolean>
A Promise that resolves to true if the component exists, false otherwise
Example
```
const exists = await registryClient.ComponentExists({
  registryId: "mj-central",
  namespace: "core/ui",
  name: "DataGrid",
  version: "2.0.0"
});

if (exists) {
  console.log('Component is available');
}
```
- Defined in packages/GraphQLDataProvider/src/GraphQLComponentRegistryClient.ts:653

GetLatestVersion

GetLatestVersion(
    registryName: string,
    namespace: string,
    name: string,
): Promise<string>
Get the latest version of a component.
Parameters
- registryName: string
- namespace: string
  The component namespace
- name: string
  The component name
Returns Promise<string>
A Promise that resolves to the latest version string or null
Example
```
const latestVersion = await registryClient.GetLatestVersion(
  "mj-central",
  "core/ui",
  "DataGrid"
);

console.log(`Latest version: ${latestVersion}`);
```
- Defined in packages/GraphQLDataProvider/src/GraphQLComponentRegistryClient.ts:682

GetRegistryComponent

GetRegistryComponent(params: GetRegistryComponentParams): Promise<ComponentSpec>
Get a specific component from a registry.

This method fetches a component specification from an external registry through the MJ API server. The server handles authentication with the registry and may cache the result for performance.
Parameters
- params: GetRegistryComponentParams
  The parameters for getting the component
Returns Promise<ComponentSpec>
A Promise that resolves to a ComponentSpec
Example
```
const component = await registryClient.GetRegistryComponent({
  registryName: "MJ",
  namespace: "core/ui",
  name: "DataGrid",
  version: "2.0.0"
});

console.log('Component:', component.name);
console.log('Description:', component.description);
console.log('Code:', component.code);
```
- Defined in packages/GraphQLDataProvider/src/GraphQLComponentRegistryClient.ts:314

GetRegistryComponentWithHash

GetRegistryComponentWithHash(
params: GetRegistryComponentParams,
): Promise<ComponentSpecWithHash>
Get a component from registry with hash and caching metadata. Returns the full response including hash and notModified flag.
Parameters
- params: GetRegistryComponentParams
  Parameters for fetching the component
Returns Promise<ComponentSpecWithHash>
Full response with specification, hash, and caching metadata
Example
```
const response = await client.GetRegistryComponentWithHash({
  registryName: 'MJ',
  namespace: 'core/ui',
  name: 'DataGrid',
  version: '1.0.0',
  hash: 'abc123...'
});

if (response.notModified) {
  // Use cached version
} else {
  // Use response.specification
}
```
- Defined in packages/GraphQLDataProvider/src/GraphQLComponentRegistryClient.ts:416

ResolveComponentDependencies

ResolveComponentDependencies(
registryId: string,
componentId: string,
): Promise<ComponentDependencyTree>
Resolve the dependency tree for a component.

This method fetches the complete dependency tree for a component, including all transitive dependencies. The server handles circular dependency detection and marks them appropriately.
Parameters
- registryId: string
  The registry ID
- componentId: string
  The component ID
Returns Promise<ComponentDependencyTree>
A Promise that resolves to a ComponentDependencyTree
Example
```
const dependencyTree = await registryClient.ResolveComponentDependencies(
  "mj-central",
  "component-123"
);

console.log(`Component has ${dependencyTree.totalCount} total dependencies`);
if (dependencyTree.circular) {
  console.warn('Circular dependency detected!');
}
```
- Defined in packages/GraphQLDataProvider/src/GraphQLComponentRegistryClient.ts:582

SearchRegistryComponents

SearchRegistryComponents(
params: SearchRegistryComponentsParams,
): Promise<RegistryComponentSearchResult>
Search for components in registries.

This method searches for components across one or more registries based on the provided criteria. Results are paginated for performance.
Parameters
- params: SearchRegistryComponentsParams
  The search parameters
Returns Promise<RegistryComponentSearchResult>
A Promise that resolves to a RegistryComponentSearchResult
Example
```
const searchResult = await registryClient.SearchRegistryComponents({
  query: "dashboard",
  type: "dashboard",
  tags: ["analytics", "reporting"],
  limit: 20,
  offset: 0
});

console.log(`Found ${searchResult.total} components`);
searchResult.components.forEach(component => {
  console.log(`- ${component.name}: ${component.description}`);
});
```
- Defined in packages/GraphQLDataProvider/src/GraphQLComponentRegistryClient.ts:518

SendComponentFeedback

SendComponentFeedback(
params: ComponentFeedbackParams,
): Promise<ComponentFeedbackResponse>

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.

Parameters

params: ComponentFeedbackParams
The feedback parameters

Returns Promise<ComponentFeedbackResponse>

A Promise that resolves to a ComponentFeedbackResponse

Example

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);
}

Class GraphQLComponentRegistryClient

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GraphQLComponentRegistryClient

Methods

ComponentExists

Parameters

Returns Promise<boolean>

Example

GetLatestVersion

Parameters

Returns Promise<string>

Example

GetRegistryComponent

Parameters

Returns Promise<ComponentSpec>

Example

GetRegistryComponentWithHash

Parameters

Returns Promise<ComponentSpecWithHash>

Example

ResolveComponentDependencies

Parameters

Returns Promise<ComponentDependencyTree>

Example

SearchRegistryComponents

Parameters

Returns Promise<RegistryComponentSearchResult>

Example

SendComponentFeedback

Parameters

Returns Promise<ComponentFeedbackResponse>

Example

Settings

On This Page