@quanticdigit/web-errors 1.0.0 → 1.0.2

package/README.md

@@ -1,64 +1,77 @@
-# WebErrors
+# @quanticdigit/web-errors
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 21.2.0.
+Error collection and presentation: level aggregation, a localized dialog in 31 languages, pluggable
+presenter.
 
-## Code scaffolding
+This is the implementation of `IErrorInfoAppender`, which `@quanticdigit/web-services` declares and
+does not provide. The service layer knows **that** something went wrong; this knows **how to say it**.
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+## Install
 
 ```bash
-ng generate component component-name
+npm install @quanticdigit/web-errors @quanticdigit/web-services
 ```
 
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+Peer dependencies: `@angular/core`, `devextreme`, `@quanticdigit/web-services`.
 
-```bash
-ng generate --help
-```
+## Use it
 
-## Building
+`ErrorCollector` is `providedIn: 'root'`. Hand it to any service call:
 
-To build the library, run:
+```ts
+export class UserPage {
+  private readonly errors = inject(ErrorCollector);
 
-```bash
-ng build web-errors
+  load(): void {
+    this.users.byId(7, this.errors).subscribe((user) => …);
+  }
+}
 ```
 
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+Errors raised in the same turn are gathered into **one** dialog. Three failing calls produce three
+lines, not three windows the user closes without reading.
 
-### Publishing the Library
+## It already speaks your language
 
-Once the project is built, you can publish your library by following these steps:
+The texts ship with the package in the same 31 languages DevExtreme covers, so the dialog does not
+come out in English surrounded by translated components. Nothing to configure.
 
-1. Navigate to the `dist` directory:
+## Three levels of customization
 
-   ```bash
-   cd dist/web-errors
-   ```
+Nothing is mandatory. In order of weight:
 
-2. Run the `npm publish` command to publish your library to the npm registry:
-   ```bash
-   npm publish
-   ```
+**One text.** Load that key into your own DevExtreme catalogue; it wins over the built-in one, and
+the other seven stay as they are.
 
-## Running unit tests
+```ts
+loadMessages({ it: { dialogTitleError: 'Ops' } });
+```
 
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+**The window.** Declare `ERROR_PRESENTER` and ours is never even built.
 
-```bash
-ng test
+```ts
+{ provide: ERROR_PRESENTER, useValue: (p) => myDialog(p.title, p.message, p.errors) }
 ```
 
-## Running end-to-end tests
-
-For end-to-end (e2e) testing, run:
+To keep the default and add to it, wrap the exported one:
 
-```bash
-ng e2e
+```ts
+{ provide: ERROR_PRESENTER, useValue: (p) => { telemetry(p); devExtremeDialogPresenter(p); } }
 ```
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+**Everything.** Implement `IErrorInfoAppender` yourself and this package is not needed.
+
+## A note on messages
+
+`IErrorInfoModel.message` carries whatever the server put there. In products that resolve errors
+through a copy catalogue it is a **key**, not a sentence: resolve it before handing it over, or the
+key is what the user reads.
+
+## The family
+
+`web-utils`, `web-model`, `web-services`, `web-component` and `web-errors` are released together and
+always share the same version. Install them at the same version.
 
-## Additional Resources
+## License
 
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+Commercial. See `LICENSE.txt` in the package.

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@quanticdigit/web-errors",
-  "version": "1.0.0",
-  "description": "Raccolta e presentazione degli errori applicativi: accumulo per livello e dialogo.",
+  "version": "1.0.2",
+  "description": "Error collection and presentation: level aggregation, a localized dialog in 31 languages, pluggable presenter.",
   "author": "Quantic Digit S.R.L.",
   "license": "SEE LICENSE IN LICENSE.txt",
   "homepage": "https://www.quanticdigit.it/",
   "repository": {
     "type": "git",
-    "url": "https://gitlab.com/quanticdigit/library.git"
+    "url": "git+https://gitlab.com/quanticdigit/library.git"
   },
   "sideEffects": false,
   "peerDependencies": {
     "@angular/core": "^21.2.0",
     "devextreme": "^25.1.3",
-    "@quanticdigit/web-services": "1.0.0"
+    "@quanticdigit/web-services": "1.0.2"
   },
   "dependencies": {
     "tslib": "^2.3.0"