@larose-ui/contracts 0.1.0 → 0.1.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 +52 -0
- package/package.json +9 -4
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# @larose-ui/contracts
|
|
2
|
+
|
|
3
|
+
> Validate UI schemas against API contracts in CI.
|
|
4
|
+
|
|
5
|
+
Part of **[laRose UI](https://github.com/hamdymohamedak/larose-ui)** — the UI Operating System for modern SaaS applications.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @larose-ui/contracts
|
|
11
|
+
# or
|
|
12
|
+
pnpm add @larose-ui/contracts
|
|
13
|
+
# or
|
|
14
|
+
yarn add @larose-ui/contracts
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Quick start
|
|
20
|
+
|
|
21
|
+
```tsx
|
|
22
|
+
import { validateContract } from '@larose-ui/contracts';
|
|
23
|
+
|
|
24
|
+
const result = validateContract(uiSchema, apiSchema);
|
|
25
|
+
if (!result.valid) console.error(result.mismatches);
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Features
|
|
29
|
+
|
|
30
|
+
- Field presence and type mismatch detection
|
|
31
|
+
- Used by `larose doctor` in CI
|
|
32
|
+
- Prevents UI/API drift before release
|
|
33
|
+
|
|
34
|
+
## Related packages
|
|
35
|
+
|
|
36
|
+
| Layer | Packages |
|
|
37
|
+
|-------|----------|
|
|
38
|
+
| Foundation | `@larose-ui/core`, `@larose-ui/tokens`, `@larose-ui/react` |
|
|
39
|
+
| Runtime | `@larose-ui/runtime`, `@larose-ui/network`, `@larose-ui/offline` |
|
|
40
|
+
| Intelligence | `@larose-ui/data`, `@larose-ui/forms`, `@larose-ui/permissions` |
|
|
41
|
+
| Platform | `@larose-ui/observability`, `@larose-ui/enterprise`, `@larose-ui/ai` |
|
|
42
|
+
|
|
43
|
+
## Documentation
|
|
44
|
+
|
|
45
|
+
- [Monorepo README](https://github.com/hamdymohamedak/larose-ui#readme)
|
|
46
|
+
- [Architecture](https://github.com/hamdymohamedak/larose-ui/blob/main/docs/architecture/ARCHITECTURE.md)
|
|
47
|
+
- [Roadmap](https://github.com/hamdymohamedak/larose-ui/blob/main/docs/ROADMAP.md)
|
|
48
|
+
- [Report an issue](https://github.com/hamdymohamedak/larose-ui/issues)
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
MIT © [laRose UI](https://github.com/hamdymohamedak/larose-ui)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@larose-ui/contracts",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "UI/API contract validation for laRose platform",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -13,10 +13,11 @@
|
|
|
13
13
|
}
|
|
14
14
|
},
|
|
15
15
|
"files": [
|
|
16
|
-
"dist"
|
|
16
|
+
"dist",
|
|
17
|
+
"README.md"
|
|
17
18
|
],
|
|
18
19
|
"dependencies": {
|
|
19
|
-
"@larose-ui/core": "0.1.
|
|
20
|
+
"@larose-ui/core": "0.1.1"
|
|
20
21
|
},
|
|
21
22
|
"devDependencies": {
|
|
22
23
|
"tsup": "^8.3.5",
|
|
@@ -29,7 +30,7 @@
|
|
|
29
30
|
},
|
|
30
31
|
"repository": {
|
|
31
32
|
"type": "git",
|
|
32
|
-
"url": "https://github.com/larose-ui
|
|
33
|
+
"url": "git+https://github.com/hamdymohamedak/larose-ui.git",
|
|
33
34
|
"directory": "packages/contracts"
|
|
34
35
|
},
|
|
35
36
|
"keywords": [
|
|
@@ -39,6 +40,10 @@
|
|
|
39
40
|
"design-system",
|
|
40
41
|
"saas"
|
|
41
42
|
],
|
|
43
|
+
"homepage": "https://github.com/hamdymohamedak/larose-ui/blob/main/packages/contracts#readme",
|
|
44
|
+
"bugs": {
|
|
45
|
+
"url": "https://github.com/hamdymohamedak/larose-ui/issues"
|
|
46
|
+
},
|
|
42
47
|
"scripts": {
|
|
43
48
|
"build": "tsup src/index.ts --format esm --dts --clean",
|
|
44
49
|
"test": "vitest run",
|