@solidev/data 1.0.1 → 1.1.1

package/AGENTS.md

@@ -371,6 +371,52 @@ Notes worth knowing:
 **Do not try to bind `[save]`.** It is declared as a plain class property, not an
 `input()`, so it is not template-bindable. Control saving via `mode`.
 
+### 7.1 Long text — `<data-richedit>` and `<data-mdedit>`
+
+**They are not dispedit editors.** `dispedit` lives in the primary entry point and
+cannot import a secondary one, so use these components directly. For the
+read-only half, point a dispedit at the rendered `…_html` column with
+`[viewer]="'html'"` — that renders trusted HTML and covers markdown too, since a
+markdown field is stored with an `…_html` twin. It does **not** sanitize: use it
+only on HTML your own editor produced.
+
+Two editors live in their own entry points, so they are only pulled in if imported:
+
+```html
+<!-- HTML, @solidev/data/richedit -->
+<data-richedit [model]="thing" field="description">Description</data-richedit>
+
+<!-- markdown source, @solidev/data/mdedit -->
+<data-mdedit [model]="thing" field="notes" toolbar="light">Notes</data-mdedit>
+```
+
+Same inputs on both (`model`, `field`, `htmlField`, `mode`, `edit`, `editable`,
+`hideLabel`, `hideButton`, `fc`, `form`, `toolbar`), one output (`changed`).
+
+- **They show the value first.** In `dd` mode a click on the value or the label
+  reveals the editor, exactly like dispedit; `[editable]="false"` forbids it.
+  `inline` and `form` show the editor straight away.
+- **`field` names a pair.** Given `field="description"` they edit
+  `description_src` and display `description_html` when the model declares them,
+  and fall back to `description` for both when it does not. `[htmlField]`
+  overrides the display half.
+
+- **They do not auto-save.** Unlike dispedit, the value reaches the API only when
+  the built-in save button runs `save()`, and only in `mode="dd"`. In `inline` and
+  `form` the model is updated in memory and nothing is sent.
+- **`[fc]` short-circuits everything.** Supply your own control and there is no
+  field manager lookup, no seeding from the model, and **no `changed` emissions**.
+- **No extra install.** `prosemirror-*` and `@codemirror/*` are ordinary peer
+  dependencies, so npm brings them in with the library. Neither reaches the
+  application bundle unless its entry point is imported.
+- **Rendering a `…_html` column elsewhere** needs `SafeHtmlPipe` from
+  `@solidev/data`: `<div [innerHTML]="thing.notes_html | safeHtml"></div>`.
+  Angular's sanitizer drops the inline styles the editor writes, so a plain
+  `[innerHTML]` renders alignment and colours away. Server-produced HTML only.
+- **Testing needs `installEditorDomShims()`** from `@solidev/data`, called in
+  `beforeEach` — jsdom has no layout engine and both editors measure the document.
+  Then `await fixture.whenStable()`, since both mount in `afterNextRender`.
+
 ---
 
 ## 8. Bootstrap wiring

package/README.md

@@ -1,36 +1,37 @@
 # @solidev/data
 
-A **Django-REST-Framework-style data layer for Angular**. Declare a model once and get
-HTTP access, querysets, filtering, sorting, pagination, forms, validation and
-display/edit widgets — all driven by that single declaration.
+A **Django-REST-Framework-style data layer for Angular**. Declare a model once and get HTTP access, querysets,
+filtering, sorting, pagination, forms, validation and display/edit widgets — all driven by that single declaration.
 
 ```ts
 export class ProductBase extends DataModel {
-  static override readonly __name: string = 'ProductBase';
+  static override readonly __name: string = "ProductBase";
 
-  @charField({ description: 'Name', maxLength: 200 })
+  @charField({ description: "Name", maxLength: 200 })
   public name!: string;
 
-  @charField({ description: 'Status', choices: [
-    { value: 'draft', desc: 'Draft' },
-    { value: 'published', desc: 'Published' },
-  ]})
+  @charField({
+    description: "Status",
+    choices: [
+      { value: "draft", desc: "Draft" },
+      { value: "published", desc: "Published" },
+    ],
+  })
   public status!: string;
 
-  @foreignKeyField({ description: 'Category', related: 'Category', priority: -1 })
+  @foreignKeyField({ description: "Category", related: "Category", priority: -1 })
   public category!: number;
 }
 ```
 
 ```html
-<data-dispedit [model]="product" field="name"   mode="dd" [editable]="true" />
+<data-dispedit [model]="product" field="name" mode="dd" [editable]="true" />
 <data-dispedit [model]="product" field="status" mode="dd" [editable]="true" />
-<data-dispedit [model]="product" field="category" mode="dd" [editable]="true"
-               [collection]="categories" />
+<data-dispedit [model]="product" field="category" mode="dd" [editable]="true" [collection]="categories" />
 ```
 
-That is the whole idea: `status` renders as a `<select>` and `category` as an FK
-dropdown **because the field metadata says so**. You declare the model; the UI follows.
+That is the whole idea: `status` renders as a `<select>` and `category` as an FK dropdown **because the field metadata
+says so**. You declare the model; the UI follows.
 
 ## Install
 
@@ -40,57 +41,52 @@ npm install @solidev/data
 
 ```ts
 bootstrapApplication(AppComponent, {
-  providers: [
-    { provide: DATA_API_URL, useValue: 'https://api.example.com/v1' },
-    provideHttpClient(),
-  ],
+  providers: [{ provide: DATA_API_URL, useValue: "https://api.example.com/v1" }, provideHttpClient()],
 });
 ```
 
 ## What's in the box
 
-| Module | What it gives you |
-|---|---|
-| **data** | `DataModel` + field decorators, `Collection<T>`, `Queryset<T>`, `DataBackend` (with SSR `TransferState` support) |
-| **modellist** | `ModelListService` — field selection, filters, sorter, paginator, and the components to render them |
-| **dispedit** | `<data-dispedit>` and friends — metadata-driven display/edit, FK/M2M pickers, flags, safe-delete |
-| **auth** | JWT service + interceptor with automatic refresh and replay |
-| **messages, routing, updates, uploader, richedit** | supporting pieces |
+| Module                                             | What it gives you                                                                                                |
+| -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| **data**                                           | `DataModel` + field decorators, `Collection<T>`, `Queryset<T>`, `DataBackend` (with SSR `TransferState` support) |
+| **modellist**                                      | `ModelListService` — field selection, filters, sorter, paginator, and the components to render them              |
+| **dispedit**                                       | `<data-dispedit>` and friends — metadata-driven display/edit, FK/M2M pickers, flags, safe-delete                 |
+| **auth**                                           | JWT service + interceptor with automatic refresh and replay                                                      |
+| **messages, routing, updates, uploader, richedit** | supporting pieces                                                                                                |
 
 ## Documentation
 
-- **Guides** — see the `docs/` directory in the repository, also published in the
-  generated documentation under **Guides**.
-- **API reference** — generated with [compodoc](https://compodoc.app):
-  `npm run mkdocs:serve`.
-- **Worked example** — `projects/data/src/examples/catalog/`, a small catalog domain
-  (tree categories, m2m tags, geolocated stores, flags) that is **test-covered**, so it
-  cannot drift from the library.
+- **Guides** — see the `docs/` directory in the repository, also published in the generated documentation under
+  **Guides**.
+- **API reference** — generated with [compodoc](https://compodoc.app): `npm run mkdocs:serve`.
+- **Worked example** — `projects/data/src/examples/catalog/`, a small catalog domain (tree categories, m2m tags,
+  geolocated stores, flags) that is **test-covered**, so it cannot drift from the library.
 
 ### Using this library with an AI agent
 
-This package ships **[`AGENTS.md`](./AGENTS.md)** — a rules file covering the model
-conventions and the runtime contracts that fail silently when broken. It is available
-in consuming projects at `node_modules/@solidev/data/AGENTS.md`.
+This package ships **[`AGENTS.md`](./AGENTS.md)** — a rules file covering the model conventions and the runtime
+contracts that fail silently when broken. It is available in consuming projects at
+`node_modules/@solidev/data/AGENTS.md`.
 
 Point your agent at it from your own `AGENTS.md` / `CLAUDE.md`:
 
 ```markdown
-This project uses `@solidev/data`. Before writing or changing any model, collection,
-list component, or `dispedit` usage, read `node_modules/@solidev/data/AGENTS.md`
-and follow it.
+This project uses `@solidev/data`. Before writing or changing any model, collection, list component, or `dispedit`
+usage, read `node_modules/@solidev/data/AGENTS.md` and follow it.
 ```
 
 ## Start here
 
-Whatever else you skip, read the **Relations** guide and the **Traps** guide. The
-FK ⇄ details pairing is a runtime contract enforced by string concatenation, and most
-of the ways to misuse this library fail **silently**.
+Whatever else you skip, read the **Relations** guide and the **Traps** guide. The FK ⇄ details pairing is a runtime
+contract enforced by string concatenation, and most of the ways to misuse this library fail **silently**.
 
 ## Requirements
 
-Angular 22+. Peer dependencies: `@angular/common`, `@angular/core`, and — depending on
-which parts you use — `@ng-bootstrap/ng-bootstrap`, `jwt-decode`, `ngx-editor`.
+Angular 22+. Peer dependencies: `@angular/common`, `@angular/core`, `@ng-bootstrap/ng-bootstrap` and `jwt-decode`, plus
+the engines behind the two editor entry points — `prosemirror-*` for `@solidev/data/richedit` and `@codemirror/*` for
+`@solidev/data/mdedit`. npm 7+ installs all of them with the package; the editors only reach your bundle if you import
+their entry point.
 
 ## Licence