Class ComponentRegistryClient

Client for interacting with Component Registry Servers

Index

Constructors

Methods

getComponent getComponentWithHash getRegistryInfo listNamespaces ping resolveDependencies resolveVersion searchComponents submitFeedback

Constructors

constructor

new ComponentRegistryClient(
config: ComponentRegistryClientConfig,
): ComponentRegistryClient
Parameters
- config: ComponentRegistryClientConfig
Returns ComponentRegistryClient
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:32

Methods

getComponent

getComponent(params: GetComponentParams): Promise<ComponentSpec>
Get a specific component from the registry (backward compatible)
Parameters
- params: GetComponentParams
Returns Promise<ComponentSpec>
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:48

getComponentWithHash

getComponentWithHash(params: GetComponentParams): Promise<ComponentResponse>
Get a specific component from the registry with hash support Returns ComponentResponse which includes hash and notModified flag
Parameters
- params: GetComponentParams
Returns Promise<ComponentResponse>
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:65

getRegistryInfo

getRegistryInfo(registry: string): Promise<RegistryInfo>
Get information about a registry
Parameters
- registry: string
Returns Promise<RegistryInfo>
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:176

listNamespaces

listNamespaces(registry: string): Promise<Namespace[]>
List namespaces in a registry
Parameters
- registry: string
Returns Promise<Namespace[]>
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:198

ping

ping(): Promise<boolean>
Health check for the registry server

Returns Promise<boolean>
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:242

resolveDependencies

resolveDependencies(componentId: string): Promise<DependencyTree>
Resolve dependencies for a component
Parameters
- componentId: string
Returns Promise<DependencyTree>
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:220

resolveVersion

resolveVersion(
    params: {
        name: string;
        namespace: string;
        registry: string;
        versionRange: string;
    },
): Promise<ResolvedVersion>
Resolve a version range to a specific version
Parameters
- params: { name: string; namespace: string; registry: string; versionRange: string }
Returns Promise<ResolvedVersion>
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:145

searchComponents

searchComponents(params: SearchComponentsParams): Promise<ComponentSearchResult>
Search for components in the registry
Parameters
- params: SearchComponentsParams
Returns Promise<ComponentSearchResult>
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:111

submitFeedback

submitFeedback(
params: ComponentFeedbackParams,
): Promise<ComponentFeedbackResponse>
Submit feedback for a component
Parameters
- params: ComponentFeedbackParams
Returns Promise<ComponentFeedbackResponse>
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:256