meadow-endpoints 4.0.22 → 4.0.23

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 (51) hide show
  1. package/README.md +8 -15
  2. package/diagrams/how-it-works.excalidraw +1462 -0
  3. package/diagrams/how-it-works.mmd +9 -0
  4. package/diagrams/how-it-works.svg +2 -0
  5. package/dist/meadow-endpoints.js +516 -221
  6. package/dist/meadow-endpoints.js.map +1 -1
  7. package/dist/meadow-endpoints.min.js +18 -18
  8. package/dist/meadow-endpoints.min.js.map +1 -1
  9. package/docs/README.md +9 -25
  10. package/docs/_cover.md +9 -0
  11. package/docs/_sidebar.md +1 -0
  12. package/docs/_version.json +3 -3
  13. package/docs/architecture.md +119 -0
  14. package/docs/crud/README.md +6 -6
  15. package/docs/diagrams/behavior-injection-hook-points.excalidraw +677 -0
  16. package/docs/diagrams/behavior-injection-hook-points.mmd +9 -0
  17. package/docs/diagrams/behavior-injection-hook-points.svg +2 -0
  18. package/docs/diagrams/how-it-works.excalidraw +2777 -0
  19. package/docs/diagrams/how-it-works.mmd +16 -0
  20. package/docs/diagrams/how-it-works.svg +2 -0
  21. package/docs/diagrams/how-routes-are-generated.excalidraw +1237 -0
  22. package/docs/diagrams/how-routes-are-generated.mmd +13 -0
  23. package/docs/diagrams/how-routes-are-generated.svg +2 -0
  24. package/docs/diagrams/request-lifecycle.excalidraw +1897 -0
  25. package/docs/diagrams/request-lifecycle.mmd +22 -0
  26. package/docs/diagrams/request-lifecycle.svg +2 -0
  27. package/docs/diagrams/where-it-sits-in-the-stack.excalidraw +2068 -0
  28. package/docs/diagrams/where-it-sits-in-the-stack.mmd +19 -0
  29. package/docs/diagrams/where-it-sits-in-the-stack.svg +2 -0
  30. package/docs/index.html +2 -2
  31. package/docs/quickstart.md +151 -0
  32. package/docs/retold-catalog.json +155 -174
  33. package/docs/retold-keyword-index.json +6593 -2920
  34. package/package.json +8 -8
  35. package/source/controller/Meadow-Endpoints-Controller-Base.js +40 -0
  36. package/source/endpoints/count/Meadow-Endpoint-Count.js +1 -0
  37. package/source/endpoints/count/Meadow-Endpoint-CountBy.js +1 -0
  38. package/source/endpoints/create/Meadow-Operation-Create.js +1 -0
  39. package/source/endpoints/delete/Meadow-Endpoint-Delete.js +1 -0
  40. package/source/endpoints/delete/Meadow-Endpoint-Undelete.js +1 -0
  41. package/source/endpoints/read/Meadow-Endpoint-Read.js +1 -0
  42. package/source/endpoints/read/Meadow-Endpoint-ReadDistinctList.js +1 -0
  43. package/source/endpoints/read/Meadow-Endpoint-ReadLiteList.js +1 -0
  44. package/source/endpoints/read/Meadow-Endpoint-ReadMax.js +1 -0
  45. package/source/endpoints/read/Meadow-Endpoint-ReadSelectList.js +1 -0
  46. package/source/endpoints/read/Meadow-Endpoint-Reads.js +1 -0
  47. package/source/endpoints/read/Meadow-Endpoint-ReadsBy.js +1 -0
  48. package/source/endpoints/update/Meadow-Operation-Update.js +2 -0
  49. package/source/endpoints/upsert/Meadow-Operation-Upsert.js +1 -0
  50. package/test/MeadowEndpoints_SessionOverride_tests.js +75 -0
  51. package/dist/indoctrinate_content_staging/Indoctrinate-Catalog-AppData.json +0 -4808
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # Meadow Endpoints
2
2
 
3
+ > **[Read the Meadow-Endpoints Documentation](https://fable-retold.github.io/meadow-endpoints/)** - interactive docs with the full API reference.
4
+
3
5
  > Automagic REST endpoints for CRUD operations on the Retold framework
4
6
 
5
7
  Meadow Endpoints generates a full suite of RESTful API routes from your Meadow data entities. Define your data model with Meadow, point Meadow Endpoints at it, and you get Create, Read, Update, Delete, Count, Schema, and Validate endpoints -- with authentication hooks, authorization, dynamic filtering, pagination, and behavior injection for customization. The design philosophy is to cover the 99% via configuration; the last 1% is easily hand-craftable.
@@ -80,17 +82,8 @@ npm install meadow-endpoints
80
82
 
81
83
  Meadow Endpoints takes a configured Meadow DAL instance and registers HTTP routes with an Orator service server. Each route follows an async waterfall pattern with behavior injection points for customization.
82
84
 
83
- ```
84
- Orator (API Server)
85
- └── Meadow Endpoints (Route Registration)
86
- ├── Controller (Request Lifecycle)
87
- │ ├── Session Marshaler
88
- │ ├── Behavior Injection
89
- │ ├── Error Handler
90
- │ └── Log Controller
91
- └── Meadow DAL (Data Access)
92
- └── Database Provider
93
- ```
85
+ <!-- bespoke diagram: edit diagrams/how-it-works.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-endpoints -->
86
+ ![How It Works](diagrams/how-it-works.svg)
94
87
 
95
88
  ## Generated Routes
96
89
 
@@ -189,10 +182,10 @@ npx docsify-cli serve docs
189
182
 
190
183
  ## Related Packages
191
184
 
192
- - [meadow](https://github.com/stevenvelozo/meadow) - Data access and ORM
193
- - [foxhound](https://github.com/stevenvelozo/foxhound) - Query DSL for SQL generation
194
- - [orator](https://github.com/stevenvelozo/orator) - API server abstraction
195
- - [fable](https://github.com/stevenvelozo/fable) - Application services framework
185
+ - [meadow](https://github.com/fable-retold/meadow) - Data access and ORM
186
+ - [foxhound](https://github.com/fable-retold/foxhound) - Query DSL for SQL generation
187
+ - [orator](https://github.com/fable-retold/orator) - API server abstraction
188
+ - [fable](https://github.com/fable-retold/fable) - Application services framework
196
189
 
197
190
  ## License
198
191