@nubitio/crud 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Johan Guerreros
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,78 @@
+# @nubitio/crud
+
+The Nubit CRUD engine: declarative resource pages with a data grid, dialog form, field DSL, RBAC, conditional rules, URL routing, audit trail, and pluggable backend adapters.
+
+## Install
+
+```bash
+npm install @nubitio/crud @nubitio/core @nubitio/ui
+```
+
+## Peer dependencies
+
+```json
+"@tanstack/react-query": "^5",
+"i18next": "^23",
+"luxon": "^3",
+"react": "^19",
+"react-dom": "^19",
+"react-i18next": "^14",
+"react-router-dom": "^6"
+```
+
+## Setup
+
+```ts
+import '@nubitio/ui/tokens.css';   // design tokens
+import '@nubitio/ui/style.css';    // UI primitives styles
+import '@nubitio/crud/style.css';  // grid + form styles
+```
+
+## Quick start
+
+```tsx
+import { SmartCrudPage, defineResource, textField, numberField } from '@nubitio/crud';
+import { HydraAdapter } from '@nubitio/crud';
+
+const products = defineResource('/api/products', {
+  title: 'Products',
+  adapter: HydraAdapter,
+  fields: [
+    textField('name').label('Name').required(),
+    numberField('price').label('Price').format('currency'),
+  ],
+});
+
+export function ProductsPage() {
+  return <SmartCrudPage resource={products} />;
+}
+```
+
+## Key exports
+
+### Engine
+| Export | Description |
+|--------|-------------|
+| `SmartCrudPage` | Main component — resolves schema, applies rules, renders grid + form |
+| `CrudPage` | Lower-level page if you manage fields manually |
+| `defineResource` | Create a typed `ResourceConfig` for a REST/Hydra resource |
+
+### Field DSL
+`textField`, `numberField`, `dateField`, `datetimeField`, `entityField`, `enumField`, `selectField`, `checkboxField`, `switchField`, `currencyField`, `imageField`, `textareaField`, `passwordField`
+
+Each returns a chainable `FieldBuilder` with `.label()`, `.required()`, `.visibleWhen()`, `.disabledWhen()`, `.onChange()`, `.formatter()`, and more.
+
+### Backend adapters
+| Export | Description |
+|--------|-------------|
+| `HydraAdapter` | API Platform / JSON-LD + Hydra (default) |
+| `RestAdapter` | Plain REST with `{ data, total }` or array responses |
+| `BackendAdapter` | Interface to implement a custom adapter |
+
+### Extension points
+| Export | Description |
+|--------|-------------|
+| `ResourceSchemaProvider` | Supply a custom field schema for a resource |
+| `ResourceStoreProvider` | Supply a custom data store factory |
+| `SmartCrudRolesProvider` | Inject RBAC role claims for field-level permissions |
+| `defineFieldContract` | Type-safe field contract for `SmartCrudPage` |