retold-data-service 2.1.2 → 2.1.5

package/BUILDING-AND-PUBLISHING.md

@@ -29,7 +29,7 @@ dependencies, env-var contract, or the Dockerfile changed.
 
 - **npm login** — `npm whoami` should print your username.
 - **Git remote configured** — `git remote get-url origin` should print
-  `git@github.com:stevenvelozo/retold-data-service.git` (or the
+  `git@github.com:fable-retold/retold-data-service.git` (or the
   HTTPS equivalent).
 - **Push access to the repo** — required so `postversion` /
   `postpublish` hooks can push commits and tags.
@@ -118,7 +118,7 @@ BUILD_DOCKER=1 npm publish    (or: npm run publish:docker)
 ## Verifying a release
 
 1. **npm**: `npm view retold-data-service version`
-2. **Workflow**: `https://github.com/stevenvelozo/retold-data-service/actions`
+2. **Workflow**: `https://github.com/fable-retold/retold-data-service/actions`
 3. **Image**: `docker pull ghcr.io/stevenvelozo/retold-data-service:latest`
 
 If the first `docker pull` returns `denied`, the package is private by

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:20-bookworm AS base
+FROM node:22-bookworm AS base
 MAINTAINER steven velozo <steven@velozo.com>
 
 RUN apt-get update && apt-get -y --force-yes install curl vim nano less \

package/README.md

@@ -1,6 +1,8 @@
 # Retold Data Service
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+> **[Read the Retold-Data-Service Documentation](https://fable-retold.github.io/retold-data-service/)** - interactive docs with the full API reference.
+
+[MIT License](LICENSE)
 
 > An all-in-one Fable service that turns a compiled Stricture schema into a complete REST API
 
@@ -70,25 +72,8 @@ _Fable.RetoldDataService.initializeService(
 
 Retold Data Service orchestrates the full Meadow stack into a single initialization sequence:
 
-```
-Fable (Core)
-  └── Retold Data Service
-        ├── Orator (API Server)
-        │     └── Restify (HTTP Engine)
-        ├── Meadow (Data Access Layer)
-        │     ├── Schema (from compiled Stricture model)
-        │     ├── FoxHound (Query DSL)
-        │     └── Provider (MySQL / MSSQL / PostgreSQL / SQLite / MongoDB / etc.)
-        └── Meadow Endpoints (REST Routes)
-              ├── Create   POST   /1.0/Entity
-              ├── Read     GET    /1.0/Entity/:ID
-              ├── Reads    GET    /1.0/Entities/:Begin/:Cap
-              ├── Update   PUT    /1.0/Entity
-              ├── Delete   DELETE /1.0/Entity/:ID
-              ├── Count    GET    /1.0/Entities/Count
-              ├── Schema   GET    /1.0/Entity/Schema
-              └── New      GET    /1.0/Entity/Schema/New
-```
+<!-- bespoke diagram: edit diagrams/architecture.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/retold-data-service -->
+![Architecture](diagrams/architecture.svg)
 
 ## Options
 
@@ -226,13 +211,13 @@ npx docsify-cli serve docs
 
 ## Related Packages
 
-- [meadow](https://github.com/stevenvelozo/meadow) -- data access and ORM
-- [meadow-endpoints](https://github.com/stevenvelozo/meadow-endpoints) -- auto-generated REST endpoints
-- [foxhound](https://github.com/stevenvelozo/foxhound) -- query DSL for SQL generation
-- [stricture](https://github.com/stevenvelozo/stricture) -- schema definition DDL compiler
-- [orator](https://github.com/stevenvelozo/orator) -- API server abstraction
-- [fable](https://github.com/stevenvelozo/fable) -- application services framework
-- [retold-harness](https://github.com/stevenvelozo/retold-harness) -- application harness using this service
+- [meadow](https://github.com/fable-retold/meadow) -- data access and ORM
+- [meadow-endpoints](https://github.com/fable-retold/meadow-endpoints) -- auto-generated REST endpoints
+- [foxhound](https://github.com/fable-retold/foxhound) -- query DSL for SQL generation
+- [stricture](https://github.com/fable-retold/stricture) -- schema definition DDL compiler
+- [orator](https://github.com/fable-retold/orator) -- API server abstraction
+- [fable](https://github.com/fable-retold/fable) -- application services framework
+- [retold-harness](https://github.com/fable-retold/retold-harness) -- application harness using this service
 
 ## License
 

package/build-all.js

@@ -0,0 +1,66 @@
+#!/usr/bin/env node
+/**
+ * Build every web app in this package.
+ *
+ * Quackage reads `.quackage.json` from CWD with no `--config` flag, so to
+ * build the two apps we swap that file between runs. The original
+ * `.quackage.json` is restored even if a build fails.
+ *
+ * Apps are listed in `_Apps` — add a row for each new web app:
+ *   { Name: <label>, Config: <relative-path-to-its-quackage-config-file> }
+ *
+ * The primary config (`.quackage.json`) acts as the default state — the
+ * runner restores it from a backup taken at start.
+ */
+'use strict';
+
+const libFS    = require('fs');
+const libChild = require('child_process');
+
+const _PrimaryConfig = '.quackage.json';
+const _Apps =
+[
+	{ Name: 'data-cloner',          Config: '.quackage.json' },
+	{ Name: 'comprehension-loader', Config: '.quackage-comprehension-loader.json' }
+];
+
+let tmpBackup = null;
+let tmpExitCode = 0;
+
+try
+{
+	tmpBackup = libFS.readFileSync(_PrimaryConfig, 'utf8');
+
+	for (let i = 0; i < _Apps.length; i++)
+	{
+		let tmpApp = _Apps[i];
+		if (tmpApp.Config !== _PrimaryConfig)
+		{
+			libFS.writeFileSync(_PrimaryConfig, libFS.readFileSync(tmpApp.Config, 'utf8'));
+		}
+		else
+		{
+			libFS.writeFileSync(_PrimaryConfig, tmpBackup);
+		}
+		console.log('\n=== Building ' + tmpApp.Name + ' (config: ' + tmpApp.Config + ') ===\n');
+		libChild.execSync('npx quack build', { stdio: 'inherit' });
+	}
+}
+catch (pError)
+{
+	console.error('\nbuild-all: build failed — ' + pError.message);
+	tmpExitCode = 1;
+}
+finally
+{
+	if (tmpBackup !== null)
+	{
+		libFS.writeFileSync(_PrimaryConfig, tmpBackup);
+	}
+}
+
+if (tmpExitCode === 0)
+{
+	console.log('\nAll bundles built.');
+}
+process.exit(tmpExitCode);