retold-harness 1.1.11 → 1.1.13

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.
Files changed (45) hide show
  1. package/Dockerfile_Service +7 -3
  2. package/README.md +13 -28
  3. package/diagrams/architecture.excalidraw +2885 -0
  4. package/diagrams/architecture.mmd +17 -0
  5. package/diagrams/architecture.svg +2 -0
  6. package/docs/README.md +13 -13
  7. package/docs/_brand.json +18 -0
  8. package/docs/_cover.md +1 -1
  9. package/docs/_topbar.md +1 -1
  10. package/docs/_version.json +3 -3
  11. package/docs/api/meadow-provider-configurator.md +1 -1
  12. package/docs/api/reference.md +4 -4
  13. package/docs/api/retold-harness.md +3 -3
  14. package/docs/api/schema-provider.md +2 -2
  15. package/docs/architecture.md +4 -42
  16. package/docs/diagrams/component-architecture.excalidraw +3643 -0
  17. package/docs/diagrams/component-architecture.mmd +18 -0
  18. package/docs/diagrams/component-architecture.svg +2 -0
  19. package/docs/diagrams/entity-relationships.excalidraw +1852 -0
  20. package/docs/diagrams/entity-relationships.mmd +19 -0
  21. package/docs/diagrams/entity-relationships.svg +2 -0
  22. package/docs/diagrams/initialization-flow.excalidraw +1708 -0
  23. package/docs/diagrams/initialization-flow.mmd +20 -0
  24. package/docs/diagrams/initialization-flow.svg +2 -0
  25. package/docs/endpoints.md +1 -1
  26. package/docs/index.html +6 -7
  27. package/docs/quickstart.md +2 -2
  28. package/docs/retold-catalog.json +181 -162
  29. package/docs/retold-keyword-index.json +18339 -8417
  30. package/docs/schema.md +2 -21
  31. package/package.json +9 -9
  32. package/source/management-tool/docs/sqlite/linux.md +7 -25
  33. package/source/management-tool/docs/sqlite/mac.md +7 -15
  34. package/source/management-tool/docs/sqlite/windows.md +6 -17
  35. package/source/schemas/Retold-Harness-Service-Schema-Bookstore.js +12 -0
  36. package/source/schemas/bookstore/BookStore.ddl +6 -0
  37. package/source/schemas/bookstore/MeadowModel-Extended.json +324 -1
  38. package/source/schemas/bookstore/MeadowModel.json +41 -0
  39. package/source/schemas/bookstore/Schema.json +324 -1
  40. package/source/schemas/bookstore/sqlite_create/BookStore-CreateSQLiteTables.sql +8 -0
  41. package/source/schemas/bookstore/sqlite_create/BookStore-SeedData-CatalogJoin.sql +378 -0
  42. package/source/schemas/entertainment/ingestion/ingest-entertainment-data.js +1 -1
  43. package/source/web/harness_app.js +12 -12
  44. package/source/web/pict.js +10 -10
  45. package/docs/css/docuserve.css +0 -327
package/Dockerfile_Service CHANGED
@@ -1,8 +1,12 @@
1
- FROM node:20-slim
1
+ FROM node:22-slim
2
2
  LABEL maintainer="steven velozo <steven@velozo.com>"
3
3
 
4
- # Build tools needed to compile better-sqlite3 native addon
5
- RUN apt-get update && apt-get install -y --no-install-recommends python3 make g++ && rm -rf /var/lib/apt/lists/*
4
+ # No build toolchain needed. Retold's SQLite usage flows through
5
+ # meadow-connection-sqlite, which uses Node's built-in `node:sqlite`
6
+ # module (v22.5+) instead of the better-sqlite3 native addon. This
7
+ # eliminates the python3 + make + g++ apt-install that previously broke
8
+ # this image on Colima GPG-signature failures and on architecture
9
+ # mismatches between host (arm64) and container (amd64).
6
10
 
7
11
  VOLUME /retold-harness
8
12
  WORKDIR /retold-harness
package/README.md CHANGED
@@ -1,6 +1,8 @@
1
1
  # Retold Harness
2
2
 
3
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
3
+ > **[Read the Retold-Harness Documentation](https://fable-retold.github.io/retold-harness/)** - interactive docs with the full API reference.
4
+
5
+ [MIT License](LICENSE)
4
6
 
5
7
  > A composable REST API harness for the Retold framework
6
8
 
@@ -61,25 +63,8 @@ retold-harness-management-tool
61
63
 
62
64
  ## Architecture
63
65
 
64
- ```
65
- Retold Harness
66
- ├── Schema Provider (Bookstore / USFederalData / Entertainment)
67
- │ ├── Table Generation (DDL from Stricture)
68
- │ ├── Seed Data Loading
69
- │ └── Behavior Injection (e.g. Author enrichment)
70
- ├── Provider Configurator (SQLite / MySQL / MSSQL / PostgreSQL / MongoDB / DGraph / Solr)
71
- │ ├── Database Connection (via meadow-connection-*)
72
- │ ├── Schema Initialization
73
- │ └── Data Service Bootstrap
74
- ├── Retold Data Service
75
- │ ├── Orator + Restify (HTTP Server)
76
- │ ├── Meadow (DAL for each entity)
77
- │ └── Meadow Endpoints (REST Routes)
78
- └── Management Tool (Terminal UI)
79
- ├── Docker Container Management
80
- ├── Harness Process Launcher
81
- └── Consistency Proxy Control
82
- ```
66
+ <!-- bespoke diagram: edit diagrams/architecture.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/retold-harness -->
67
+ ![Architecture](diagrams/architecture.svg)
83
68
 
84
69
  ## REST API Examples
85
70
 
@@ -207,14 +192,14 @@ npx docsify-cli serve docs
207
192
 
208
193
  ## Related Packages
209
194
 
210
- - [retold-harness-consistency-proxy](https://github.com/stevenvelozo/retold-harness-consistency-proxy) -- compare responses across providers
211
- - [retold-data-service](https://github.com/stevenvelozo/retold-data-service) -- all-in-one data service
212
- - [meadow](https://github.com/stevenvelozo/meadow) -- data access layer and ORM
213
- - [meadow-endpoints](https://github.com/stevenvelozo/meadow-endpoints) -- automatic REST endpoint generation
214
- - [foxhound](https://github.com/stevenvelozo/foxhound) -- query DSL for SQL generation
215
- - [stricture](https://github.com/stevenvelozo/stricture) -- schema definition language
216
- - [orator](https://github.com/stevenvelozo/orator) -- API server abstraction
217
- - [fable](https://github.com/stevenvelozo/fable) -- service provider framework
195
+ - [retold-harness-consistency-proxy](https://github.com/fable-retold/retold-harness-consistency-proxy) -- compare responses across providers
196
+ - [retold-data-service](https://github.com/fable-retold/retold-data-service) -- all-in-one data service
197
+ - [meadow](https://github.com/fable-retold/meadow) -- data access layer and ORM
198
+ - [meadow-endpoints](https://github.com/fable-retold/meadow-endpoints) -- automatic REST endpoint generation
199
+ - [foxhound](https://github.com/fable-retold/foxhound) -- query DSL for SQL generation
200
+ - [stricture](https://github.com/fable-retold/stricture) -- schema definition language
201
+ - [orator](https://github.com/fable-retold/orator) -- API server abstraction
202
+ - [fable](https://github.com/fable-retold/fable) -- service provider framework
218
203
 
219
204
  ## License
220
205