@eik/core 1.3.58 → 1.3.60
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/CHANGELOG.md +14 -0
- package/README.md +52 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,17 @@
|
|
|
1
|
+
## [1.3.60](https://github.com/eik-lib/core/compare/v1.3.59...v1.3.60) (2024-08-13)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* **deps:** update dependency @eik/common to v4.0.9 ([d6208c9](https://github.com/eik-lib/core/commit/d6208c995fb487d4693318fa2d967319a3e4aa03))
|
|
7
|
+
|
|
8
|
+
## [1.3.59](https://github.com/eik-lib/core/compare/v1.3.58...v1.3.59) (2024-08-12)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Bug Fixes
|
|
12
|
+
|
|
13
|
+
* **deps:** update dependency @eik/common to v4.0.8 ([916cee6](https://github.com/eik-lib/core/commit/916cee6951997339c87685c7719a68b778c82f20))
|
|
14
|
+
|
|
1
15
|
## [1.3.58](https://github.com/eik-lib/core/compare/v1.3.57...v1.3.58) (2024-08-09)
|
|
2
16
|
|
|
3
17
|
|
package/README.md
CHANGED
|
@@ -1,3 +1,54 @@
|
|
|
1
1
|
# @eik/core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This module holds the core server functionality of [`@eik/service`](https://github.com/eik-lib/service#readme).
|
|
4
|
+
Each [HTTP API endpoint](https://eik.dev/docs/server/http-api) has
|
|
5
|
+
its own class handling the specific path and method.
|
|
6
|
+
|
|
7
|
+
## API
|
|
8
|
+
|
|
9
|
+
### http
|
|
10
|
+
|
|
11
|
+
This namespace holds the different HTTP API endpoint handlers. Each handler is a class with an async `handler` method.
|
|
12
|
+
|
|
13
|
+
```js
|
|
14
|
+
import { http } from "@eik/core";
|
|
15
|
+
|
|
16
|
+
let pkgGetHandler = new eik.http.PkgGet({ organizations, sink, logger });
|
|
17
|
+
|
|
18
|
+
let response = await pkgGetHandler.handler(
|
|
19
|
+
request,
|
|
20
|
+
type,
|
|
21
|
+
name,
|
|
22
|
+
version,
|
|
23
|
+
extras,
|
|
24
|
+
);
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
For a more complete usage example, see
|
|
28
|
+
[the implementation in `@eik/service`](https://github.com/eik-lib/service/blob/00c85c1d366df50b688a82e62e5890381df11b0f/lib/main.js#L76-L113).
|
|
29
|
+
|
|
30
|
+
### prop
|
|
31
|
+
|
|
32
|
+
A gollection of globals holding base paths.
|
|
33
|
+
|
|
34
|
+
```js
|
|
35
|
+
import { prop } from "@eik/core";
|
|
36
|
+
|
|
37
|
+
const { base_auth, base_map, base_pkg, base_npm } = prop;
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### HealthCheck
|
|
41
|
+
|
|
42
|
+
A health check implementation that does a create, read and delete check
|
|
43
|
+
against the configured [storage sink](https://eik.dev/docs/server/storage).
|
|
44
|
+
|
|
45
|
+
```js
|
|
46
|
+
import { HealthCheck } from "@eik/core";
|
|
47
|
+
|
|
48
|
+
const health = new HealthCheck({
|
|
49
|
+
logger,
|
|
50
|
+
sink,
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
await health.check();
|
|
54
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eik/core",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.60",
|
|
4
4
|
"description": "Core server package",
|
|
5
5
|
"main": "lib/main.js",
|
|
6
6
|
"types": "./types/main.d.ts",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"author": "",
|
|
26
26
|
"license": "MIT",
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@eik/common": "4.0.
|
|
28
|
+
"@eik/common": "4.0.9",
|
|
29
29
|
"@eik/sink": "1.2.5",
|
|
30
30
|
"@eik/sink-file-system": "1.0.1",
|
|
31
31
|
"@eik/sink-memory": "1.1.1",
|