@hexah/skin-sdk 0.2.0 → 0.2.1
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 +18 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,8 +5,7 @@ deweloperzy budują własne podstrony (ekrany szablonu) i motywy, **bez dostępu
|
|
|
5
5
|
|
|
6
6
|
Pakiet jest celowo „chudy": zawiera wyłącznie kontrakt (zero implementacji, zero importów
|
|
7
7
|
z aplikacji, brak Reacta i kroku budowania). Implementacje read-modeli, usług platformy i
|
|
8
|
-
prymitywów UI dostarcza **host** w runtime
|
|
9
|
-
repo: `frontend/common/skin-sdk/{runtime,ui,slots}.js`).
|
|
8
|
+
prymitywów UI dostarcza **aplikacja-host** w runtime przez Module Federation (shareScope).
|
|
10
9
|
|
|
11
10
|
## Instalacja
|
|
12
11
|
|
|
@@ -30,18 +29,24 @@ import { SCREEN_KEYS, SLOT_KEYS, DEFAULT_TEMPLATE, SKIN_API_VERSION } from '@hex
|
|
|
30
29
|
|
|
31
30
|
Read-modele/usługi (`useReports`, `useSnackbar`, `useDialog`, `useShard`…), prymitywy UI
|
|
32
31
|
(`PageBox`, `HexahChip`, `DataList`…) i `useSlots()` paczka udostępnia jako **typowane atrapy**
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
32
|
+
— dają podpowiedzi w edytorze, a realne implementacje dostarcza host w runtime (Module
|
|
33
|
+
Federation, shareScope). Atrapa wywołana poza hostem rzuca jasny błąd: skórka działa wyłącznie
|
|
34
|
+
wewnątrz aplikacji Hexah. Bundler skórki dzieli te paczki z `import: false`, więc atrapy nigdy
|
|
35
|
+
nie trafiają do bundla.
|
|
37
36
|
|
|
38
|
-
##
|
|
37
|
+
## Tworzenie skórki
|
|
39
38
|
|
|
40
|
-
|
|
41
|
-
|
|
39
|
+
Najszybciej wystartujesz przez scaffolder:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npm create @hexah/skin moja-skorka # albo: npx @hexah/create-skin moja-skorka
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Wygenerowany projekt zawiera gotowy build (rspack + Module Federation), przykładowy ekran i
|
|
46
|
+
instrukcję podłączenia do środowiska testowego Hexah.
|
|
42
47
|
|
|
43
|
-
##
|
|
48
|
+
## Wersjonowanie
|
|
44
49
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
50
|
+
`SKIN_API_VERSION` (semver): **major** = zmiana łamiąca powierzchnię, **minor** = dodanie
|
|
51
|
+
zgodne wstecz, **patch** = bez zmiany powierzchni. Skórka deklaruje wersję w configu; host
|
|
52
|
+
odrzuca niezgodny major.
|
package/package.json
CHANGED