@memberjunction/component-registry-client-sdk 4.0.0 → 4.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -9
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,16 +1,36 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @memberjunction/component-registry-client-sdk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
TypeScript SDK for interacting with Component Registry servers. Provides a robust REST API client for fetching, searching, and managing interactive components from remote registries.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
```mermaid
|
|
8
|
+
sequenceDiagram
|
|
9
|
+
participant App as Application
|
|
10
|
+
participant SDK as RegistryClient SDK
|
|
11
|
+
participant Reg as Component Registry Server
|
|
12
|
+
|
|
13
|
+
App->>SDK: getComponent(namespace, name)
|
|
14
|
+
SDK->>SDK: Apply retry policy
|
|
15
|
+
SDK->>Reg: GET /api/v1/components/:ns/:name
|
|
16
|
+
Reg-->>SDK: Component specification
|
|
17
|
+
SDK-->>App: Typed component object
|
|
18
|
+
|
|
19
|
+
App->>SDK: searchComponents(query)
|
|
20
|
+
SDK->>Reg: GET /api/v1/components/search?q=...
|
|
21
|
+
Reg-->>SDK: Search results
|
|
22
|
+
SDK-->>App: ComponentSearchResult[]
|
|
23
|
+
```
|
|
4
24
|
|
|
5
25
|
## Features
|
|
6
26
|
|
|
7
|
-
-
|
|
8
|
-
-
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
27
|
+
- **Native Fetch** -- Uses native fetch API, no external HTTP dependencies
|
|
28
|
+
- **Retry Logic** -- Automatic retry with exponential backoff
|
|
29
|
+
- **Timeout Support** -- Configurable request timeouts
|
|
30
|
+
- **Type Safety** -- Full TypeScript support with comprehensive types
|
|
31
|
+
- **Component Management** -- Get, search, and resolve component dependencies
|
|
32
|
+
- **Authentication** -- Support for API key and Bearer token authentication
|
|
33
|
+
- **Registry Integration** -- Used by MJServer for external registry communication
|
|
14
34
|
|
|
15
35
|
## Installation
|
|
16
36
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@memberjunction/component-registry-client-sdk",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "4.
|
|
4
|
+
"version": "4.2.0",
|
|
5
5
|
"description": "MemberJunction: Component Registry Client SDK",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
7
|
"types": "dist/index.d.ts",
|
|
@@ -20,9 +20,9 @@
|
|
|
20
20
|
"typescript": "^5.9.3"
|
|
21
21
|
},
|
|
22
22
|
"dependencies": {
|
|
23
|
-
"@memberjunction/global": "4.
|
|
24
|
-
"@memberjunction/core": "4.
|
|
25
|
-
"@memberjunction/interactive-component-types": "4.
|
|
23
|
+
"@memberjunction/global": "4.2.0",
|
|
24
|
+
"@memberjunction/core": "4.2.0",
|
|
25
|
+
"@memberjunction/interactive-component-types": "4.2.0"
|
|
26
26
|
},
|
|
27
27
|
"repository": {
|
|
28
28
|
"type": "git",
|