Class ComponentRegistryClient

Client for interacting with Component Registry Servers

Index

Constructors

Methods

getComponent GetComponent getComponentWithHash GetComponentWithHash getRegistryInfo GetRegistryInfo listNamespaces ListNamespaces ping Ping resolveDependencies ResolveDependencies resolveVersion ResolveVersion searchComponents SearchComponents submitFeedback 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>
Parameters
- params: GetComponentParams
Returns Promise<ComponentSpec>
Deprecated
Use GetComponent.
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:62

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>
Parameters
- params: GetComponentParams
Returns Promise<ComponentResponse>
Deprecated
Use GetComponentWithHash.
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:114

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:70

getRegistryInfo

getRegistryInfo(registry: string): Promise<RegistryInfo>
Parameters
- registry: string
Returns Promise<RegistryInfo>
Deprecated
Use GetRegistryInfo.
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:221

GetRegistryInfo

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

listNamespaces

listNamespaces(registry: string): Promise<Namespace[]>
Parameters
- registry: string
Returns Promise<Namespace[]>
Deprecated
Use ListNamespaces.
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:248

ListNamespaces

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

ping

ping(): Promise<boolean>
Returns Promise<boolean>
Deprecated
Use Ping.
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:294

Ping

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

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

resolveDependencies

resolveDependencies(componentId: string): Promise<DependencyTree>
Parameters
- componentId: string
Returns Promise<DependencyTree>
Deprecated
Use ResolveDependencies.
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:275

ResolveDependencies

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

resolveVersion

resolveVersion(
    params: {
        name: string;
        namespace: string;
        registry: string;
        versionRange: string;
    },
): Promise<ResolvedVersion>
Parameters
- params: { name: string; namespace: string; registry: string; versionRange: string }
Returns Promise<ResolvedVersion>
Deprecated
Use ResolveVersion.
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:189

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:160

searchComponents

searchComponents(params: SearchComponentsParams): Promise<ComponentSearchResult>
Parameters
- params: SearchComponentsParams
Returns Promise<ComponentSearchResult>
Deprecated
Use SearchComponents.
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:153

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:121

submitFeedback

submitFeedback(
params: ComponentFeedbackParams,
): Promise<ComponentFeedbackResponse>
Parameters
- params: ComponentFeedbackParams
Returns Promise<ComponentFeedbackResponse>
Deprecated
Use SubmitFeedback.
- Defined in packages/ComponentRegistryClientSDK/src/ComponentRegistryClient.ts:324

SubmitFeedback

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