simplix-react 0.0.3
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 +35 -0
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# simplix-react
|
|
2
|
+
|
|
3
|
+
Meta package that installs all `@simplix-react/*` packages in one dependency.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add simplix-react
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
This single install provides:
|
|
12
|
+
|
|
13
|
+
| Package | Description |
|
|
14
|
+
| --- | --- |
|
|
15
|
+
| `@simplix-react/contract` | Zod-based type-safe API contract definitions |
|
|
16
|
+
| `@simplix-react/react` | React Query hooks derived from contracts |
|
|
17
|
+
| `@simplix-react/form` | TanStack Form hooks derived from contracts |
|
|
18
|
+
| `@simplix-react/auth` | Authentication middleware (Bearer, API Key, OAuth2) |
|
|
19
|
+
| `@simplix-react/mock` | MSW handlers + PGlite repositories |
|
|
20
|
+
| `@simplix-react/i18n` | i18next-based internationalization |
|
|
21
|
+
| `@simplix-react/cli` | Project scaffolding and validation CLI |
|
|
22
|
+
| `@simplix-react/testing` | Test utilities (mock clients, query wrappers) |
|
|
23
|
+
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
Import directly from individual packages:
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
import { defineApi, simpleQueryBuilder } from "@simplix-react/contract";
|
|
30
|
+
import { deriveHooks } from "@simplix-react/react";
|
|
31
|
+
import { deriveFormHooks } from "@simplix-react/form";
|
|
32
|
+
import { createAuth, bearerScheme } from "@simplix-react/auth";
|
|
33
|
+
import { deriveMockHandlers } from "@simplix-react/mock";
|
|
34
|
+
import { I18nextAdapter } from "@simplix-react/i18n";
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Selective Installation
|
|
38
|
+
|
|
39
|
+
If you only need specific packages, install them individually:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pnpm add @simplix-react/contract @simplix-react/react
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Documentation
|
|
46
|
+
|
|
47
|
+
- [Getting Started](https://github.com/simplix-react/simplix-react/blob/main/docs/getting-started/overview.md)
|
|
48
|
+
- [API Reference](https://github.com/simplix-react/simplix-react/tree/main/docs/api)
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
MIT
|
package/package.json
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "simplix-react",
|
|
3
|
+
"version": "0.0.3",
|
|
4
|
+
"description": "Package-first React framework that auto-generates reusable domain packages from OpenAPI specs",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"sideEffects": false,
|
|
7
|
+
"publishConfig": {
|
|
8
|
+
"access": "public"
|
|
9
|
+
},
|
|
10
|
+
"dependencies": {
|
|
11
|
+
"@simplix-react/contract": "0.0.3",
|
|
12
|
+
"@simplix-react/form": "0.0.3",
|
|
13
|
+
"@simplix-react/react": "0.0.3",
|
|
14
|
+
"@simplix-react/auth": "0.0.3",
|
|
15
|
+
"@simplix-react/mock": "0.0.3",
|
|
16
|
+
"@simplix-react/i18n": "0.0.3",
|
|
17
|
+
"@simplix-react/cli": "0.0.5",
|
|
18
|
+
"@simplix-react/testing": "0.0.2"
|
|
19
|
+
},
|
|
20
|
+
"keywords": [
|
|
21
|
+
"react",
|
|
22
|
+
"openapi",
|
|
23
|
+
"codegen",
|
|
24
|
+
"tanstack-query",
|
|
25
|
+
"zod",
|
|
26
|
+
"msw",
|
|
27
|
+
"i18n",
|
|
28
|
+
"form"
|
|
29
|
+
],
|
|
30
|
+
"license": "MIT",
|
|
31
|
+
"repository": {
|
|
32
|
+
"type": "git",
|
|
33
|
+
"url": "https://github.com/simplix-react/simplix-react.git"
|
|
34
|
+
}
|
|
35
|
+
}
|