@entifix/rest 0.1.0 → 0.1.2

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.
Files changed (2) hide show
  1. package/README.md +15 -5
  2. package/package.json +6 -8
package/README.md CHANGED
@@ -1,11 +1,21 @@
1
1
  # @entifix/rest
2
2
 
3
- This library was generated with [Nx](https://nx.dev).
3
+ The HTTP adapter, for the browser and for anything else that talks to an entifix service rather than to its database. It implements the same get, load, save and delete a backend adapter does, so a use-case cannot tell which one it was given.
4
4
 
5
- ## Building
5
+ It also reads the entity metadata a service serves, and the status of a write the service accepted asynchronously.
6
6
 
7
- Run `nx build @entifix/rest` to build the library.
7
+ ## Install
8
8
 
9
- ## Running unit tests
9
+ ```sh
10
+ pnpm add @entifix/rest effect
11
+ ```
10
12
 
11
- Run `nx test @entifix/rest` to execute the unit tests via [Jest](https://jestjs.io).
13
+ ## Entry points
14
+
15
+ | Import | What it holds |
16
+ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
17
+ | `@entifix/rest` | `buildEntityRestAdapterGet` / `Load` / `Save` / `Delete`, `makeEntityMetadataSource`, `buildTransactionStatusReader`, `performHttpRequestThroughFetch` |
18
+
19
+ ---
20
+
21
+ Tier 2 (adapters) of entifix — a package depends only on its own tier or below. See [the tiers](https://github.com/r10c-technologies/entifix#the-tiers-and-what-you-are-allowed-to-install). MIT licensed.
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "@entifix/rest",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
+ "description": "HTTP entity adapter for the browser: get, load, save and delete against an entifix service, plus served metadata and transaction status.",
4
5
  "license": "MIT",
5
6
  "repository": {
6
7
  "type": "git",
@@ -30,9 +31,6 @@
30
31
  ],
31
32
  "nx": {
32
33
  "tags": [
33
- "layer:entifix",
34
- "scope:shared",
35
- "entifix:client",
36
34
  "tier:2"
37
35
  ],
38
36
  "sourceRoot": "packages/ts/rest-client/src",
@@ -54,13 +52,13 @@
54
52
  },
55
53
  "dependencies": {
56
54
  "@swc/helpers": "0.5.23",
57
- "@entifix/transactions": "0.1.0",
58
- "@entifix/business": "0.1.0",
59
- "@entifix/core": "0.1.0"
55
+ "@entifix/business": "0.1.2",
56
+ "@entifix/transactions": "0.1.2",
57
+ "@entifix/core": "0.1.2"
60
58
  },
61
59
  "devDependencies": {
62
60
  "effect": "3.22.1",
63
- "@entifix/testing-unit": "0.1.0"
61
+ "@entifix/testing-unit": "0.1.2"
64
62
  },
65
63
  "peerDependencies": {
66
64
  "effect": ">=3.22 <4"