@xeplr/base-apis 2.0.4 → 2.0.6

package/README.md

@@ -120,7 +120,7 @@ Why on by default: a service that forgot to configure auth used to boot clean, p
 |---|---|
 | path starts with a `publicPaths` entry | skipped |
 | no `Bearer` token | 401 `No token provided` |
-| auth answers `403` with `code` `DISABLED` or `HIDDEN` | 403 with that `code`: signed in, but not allowed this API |
+| auth answers `403` with `code` `DISABLED`, `HIDDEN` or `UNLICENSED` | 403 with that `code`: signed in, but not allowed this API (`UNLICENSED`: its module is not in the caller's licence) |
 | auth answers 401 / other 403 | same status, `Invalid or expired token` |
 | auth answers 200 **without** `state: 'enabled'` (an older auth, or an `endpoint` such as `/me` that only says who the caller is) | **503**: "did not say no" is not "said yes" |
 | auth unreachable, times out (`timeoutMs`, 5000), answers anything else, or answers non-JSON | **503 `Authentication service unavailable` — never let through** |
@@ -203,7 +203,7 @@ Responses use `@xeplr/utils`' shape: `{ code, message, error, dataArray, updated
 
 | error | status |
 |---|---|
-| `ValidationError` | 422 |
+| `ValidationError` | 422. jsonSchema's answers `Validation failed` with `fields`; one a model hook throws with its own `type` (e.g. a licence limit) answers its own `message` |
 | `UniqueViolationError`, `ForeignKeyViolationError` | 409 |
 | `NotNullViolationError` (`<column> is required`), `CheckViolationError`, `DataError` | 400 |
 | `NotFoundError` | 404 |

package/lib/genericController.js

@@ -7,7 +7,7 @@ var { generateId } = require('@xeplr/utils/lib/helpers');
  * of a blanket 500. Matched by `err.name` (not instanceof) so it survives two
  * copies of objection in a linked monorepo. Unknown errors still fall to 500.
  *
- *   ValidationError        → 422  { fields }   (jsonSchema: required/format/…)
+ *   ValidationError        → 422  { fields }   (jsonSchema: required/format/…); a hook's own type keeps its message
  *   UniqueViolationError   → 409  already exists
  *   NotNullViolationError  → 400  <column> is required
  *   ForeignKeyViolationError → 409 referenced record missing / in use
@@ -19,8 +19,12 @@ function sendError(req, res, err) {
 
   switch (err && err.name) {
     case 'ValidationError':
+      // A model's own check (a hook throwing ValidationError with a type of
+      // its own, e.g. a licence limit) carries a sentence for the person;
+      // jsonSchema's (ModelValidation) carries per-field detail instead.
       return respond(res, HTTP.VALIDATION_ERROR, STATUS.VALIDATION_ERROR, 'validation_error', {
-        message: 'Validation failed', fields: err.data || {}
+        message: err.type && err.type !== 'ModelValidation' && err.message ? err.message : 'Validation failed',
+        fields: err.data || {}
       });
     case 'UniqueViolationError':
       return respond(res, HTTP.CONFLICT, STATUS.CONFLICT, 'conflict', {
@@ -66,7 +70,6 @@ function sendError(req, res, err) {
  */
 async function save(req, res, hierarchy) {
   var changeSet = req.body;
-console.log('bruh: ', 1);
   if (!Array.isArray(changeSet) || changeSet.length === 0) {
     return respond(res, HTTP.BAD_REQUEST, STATUS.BAD_REQUEST, 'bad_request', {
       message: 'Expected a non-empty changeset array'
@@ -102,7 +105,6 @@ console.log('bruh: ', 1);
       var ids = await processEntry(changeSet[i], rootDef, trx, null, queryContext);
       updatedIds = updatedIds.concat(ids);
     }
-console.log('bruh: ', 2);
 
     await trx.commit();
 
@@ -114,7 +116,6 @@ console.log('bruh: ', 2);
         else console.error('[genericController] afterCommit callback failed:', err.message);
       }
     }
-console.log('bruh: ', 3);
 
     respond(res, HTTP.OK, STATUS.UPDATED, 'updated', { updatedIds: updatedIds });
   } catch (err) {
@@ -296,4 +297,4 @@ async function list(req, res, Model, graph) {
   }
 }
 
-module.exports = { save, deleteByIds, getById, list };
+module.exports = { save, deleteByIds, getById, list, sendError };

package/lib/remoteAuth.js

@@ -34,6 +34,11 @@ var DEFAULT_CACHE_SECONDS = 5;
 // closed after 5s is bad; failing closed after forever is an outage.
 var DEFAULT_TIMEOUT_MS = 5000;
 
+// The 403 codes auth gives for a signed-in caller this API is refused to. Any
+// other 403 is a token problem. UNLICENSED: the API's module is not in the
+// caller's licence (@xeplr/auth's licence.use).
+var REFUSALS = ['DISABLED', 'HIDDEN', 'UNLICENSED'];
+
 /**
  * @param {object} config
  * @param {string} config.url - base URL of the auth service, e.g.
@@ -125,9 +130,10 @@ function remoteAuth(config) {
     var body = null;
     try { body = await response.json(); } catch (err) { body = null; }
 
-    if (response.status === 403 && body && (body.code === 'DISABLED' || body.code === 'HIDDEN')) {
+    if (response.status === 403 && body && REFUSALS.indexOf(body.code) !== -1) {
       // Signed in, but not allowed this API. The code says which, so a UI can
-      // grey a disabled item out rather than treat it as missing.
+      // grey a disabled item out rather than treat it as missing, and tell
+      // "not in your licence" from "not for your role".
       return { kind: 'refused', newToken: newToken, body: { error: body.error || 'Access denied', code: body.code } };
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeplr/base-apis",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "description": "Base API bootstrapper — Express and plain HTTP server factories with middleware injection",
   "main": "index.js",
   "bin": {