@appsemble/node-utils 0.22.10 → 0.23.0

package/AppsembleError.test.js

@@ -1,3 +1,4 @@
+import { expect, it } from 'vitest';
 import { AppsembleError } from './AppsembleError.js';
 it('should define AppsembleError as its name', () => {
     const error = new AppsembleError('message');

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.22.10/config/assets/logo.svg) Appsemble Node Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.23.0/config/assets/logo.svg) Appsemble Node Utilities
 
 > NodeJS utilities used by Appsemble internally.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/node-utils)](https://www.npmjs.com/package/@appsemble/node-utils)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.22.10/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.22.10)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.23.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.23.0)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ compatibility is not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.22.10/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.23.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/basicAuth.test.js

@@ -1,3 +1,4 @@
+import { expect, it } from 'vitest';
 import { basicAuth } from './basicAuth.js';
 it('should serialize credentials', () => {
     const result = basicAuth('me', 'password1');

package/formData.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest';
 import { createFormData } from './formData.js';
 describe('createFormData', () => {
     it('should handle strings', () => {

package/fs.test.js

@@ -1,3 +1,4 @@
+import { describe, expect, it, vi } from 'vitest';
 import { AppsembleError, isErrno, opendirSafe, readData, resolveFixture } from './index.js';
 describe('isErrno', () => {
     it('should return false for null', () => {

package/handleError.test.js

@@ -1,3 +1,4 @@
+import { beforeEach, expect, it, vi } from 'vitest';
 import { AppsembleError } from './AppsembleError.js';
 import { handleError } from './handleError.js';
 import { logger } from './logger.js';

package/interceptors.test.js

@@ -2,6 +2,7 @@ import axios from 'axios';
 import MockAdapter from 'axios-mock-adapter';
 import { highlight } from 'cli-highlight';
 import FormData from 'form-data';
+import { beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
 import { configureAxios, formData, logger, requestLogger, responseLogger } from './index.js';
 function h(content) {
     return highlight(content, { language: 'http' });

package/jsonschema.js

@@ -1,18 +1,10 @@
+import { throwKoaError } from './koa.js';
 export function handleValidatorResult(ctx, result, msg = 'JSON schema validation failed') {
     if (!result.valid) {
         if (ctx.response === undefined) {
             throw new Error(msg, { cause: result.errors });
         }
-        ctx.response.status = 400;
-        ctx.response.body = {
-            statusCode: 400,
-            error: 'Bad Request',
-            message: msg,
-            data: {
-                errors: result.errors,
-            },
-        };
-        ctx.throw();
+        throwKoaError(ctx, 400, msg, { errors: result.errors });
     }
 }
 //# sourceMappingURL=jsonschema.js.map

package/koa.d.ts

@@ -1,6 +1,69 @@
+import { type Context } from 'koa';
 import { type Plugin } from 'koas-core';
 declare function serializer(): Plugin;
 declare function bodyParser(): Plugin;
 export { bodyParser, serializer };
 export * from 'koas-parameters';
 export * from 'koas-security';
+declare const errorStatusMap: {
+    readonly 400: "Bad Request";
+    readonly 401: "Unauthorized";
+    readonly 402: "Payment Required";
+    readonly 403: "Forbidden";
+    readonly 404: "Not Found";
+    readonly 405: "Method Not Allowed";
+    readonly 406: "Not Acceptable";
+    readonly 407: "Proxy Authentication Required";
+    readonly 408: "Request Timeout";
+    readonly 409: "Conflict";
+    readonly 410: "Gone";
+    readonly 411: "Length Required";
+    readonly 412: "Precondition Failed";
+    readonly 413: "Payload Too Large";
+    readonly 414: "Uri Too Long";
+    readonly 415: "Unsupported Media Type";
+    readonly 416: "Range Not Satisfiable";
+    readonly 417: "Expectation Failed";
+    readonly 418: "Im A Teapot";
+    readonly 421: "Misdirected Request";
+    readonly 422: "Unprocessable Entity";
+    readonly 423: "Locked";
+    readonly 424: "Failed Dependency";
+    readonly 425: "Too Early";
+    readonly 426: "Upgrade Required";
+    readonly 428: "Precondition Required";
+    readonly 429: "Too Many Requests";
+    readonly 431: "Request Header Fields Too Large";
+    readonly 451: "Unavailable For Legal Reasons";
+    readonly 500: "Internal Server Error";
+    readonly 501: "Not Implemented";
+    readonly 502: "Bad Gateway";
+    readonly 503: "Service Unavailable";
+    readonly 504: "Gateway Timeout";
+    readonly 505: "Http Version Not Supported";
+    readonly 506: "Variant Also Negotiates";
+    readonly 507: "Insufficient Storage";
+    readonly 508: "Loop Detected";
+    readonly 510: "Not Extended";
+    readonly 511: "Network Authentication Required";
+};
+type HttpErrorCodes = keyof typeof errorStatusMap;
+/**
+ * Throw standard Koa error response.
+ *
+ * @param ctx The Koa context used to throw the error response.
+ * @param status The HTTP status code to use.
+ * @param message The message for in the response body.
+ * @param data Optional data to include.
+ */
+export declare function throwKoaError(ctx: Context, status: HttpErrorCodes, message: string, data?: Record<string, any>): void;
+/**
+ * Throw standard Koa error response when condition is met.
+ *
+ * @param condition The condition to check.
+ * @param ctx The Koa context used to throw the error response.
+ * @param status The HTTP status code to use.
+ * @param message The message for in the response body.
+ * @param data Optional data to include.
+ */
+export declare function assertKoaError(condition: boolean, ctx: Context, status: HttpErrorCodes, message: string, data?: Record<string, any>): void;

package/koa.js

@@ -24,4 +24,78 @@ function bodyParser() {
 export { bodyParser, serializer };
 export * from 'koas-parameters';
 export * from 'koas-security';
+const errorStatusMap = {
+    400: 'Bad Request',
+    401: 'Unauthorized',
+    402: 'Payment Required',
+    403: 'Forbidden',
+    404: 'Not Found',
+    405: 'Method Not Allowed',
+    406: 'Not Acceptable',
+    407: 'Proxy Authentication Required',
+    408: 'Request Timeout',
+    409: 'Conflict',
+    410: 'Gone',
+    411: 'Length Required',
+    412: 'Precondition Failed',
+    413: 'Payload Too Large',
+    414: 'Uri Too Long',
+    415: 'Unsupported Media Type',
+    416: 'Range Not Satisfiable',
+    417: 'Expectation Failed',
+    418: 'Im A Teapot',
+    421: 'Misdirected Request',
+    422: 'Unprocessable Entity',
+    423: 'Locked',
+    424: 'Failed Dependency',
+    425: 'Too Early',
+    426: 'Upgrade Required',
+    428: 'Precondition Required',
+    429: 'Too Many Requests',
+    431: 'Request Header Fields Too Large',
+    451: 'Unavailable For Legal Reasons',
+    500: 'Internal Server Error',
+    501: 'Not Implemented',
+    502: 'Bad Gateway',
+    503: 'Service Unavailable',
+    504: 'Gateway Timeout',
+    505: 'Http Version Not Supported',
+    506: 'Variant Also Negotiates',
+    507: 'Insufficient Storage',
+    508: 'Loop Detected',
+    510: 'Not Extended',
+    511: 'Network Authentication Required',
+};
+/**
+ * Throw standard Koa error response.
+ *
+ * @param ctx The Koa context used to throw the error response.
+ * @param status The HTTP status code to use.
+ * @param message The message for in the response body.
+ * @param data Optional data to include.
+ */
+export function throwKoaError(ctx, status, message, data) {
+    ctx.response.status = status;
+    ctx.response.body = {
+        error: errorStatusMap[status],
+        message,
+        statusCode: status,
+        data,
+    };
+    ctx.throw();
+}
+/**
+ * Throw standard Koa error response when condition is met.
+ *
+ * @param condition The condition to check.
+ * @param ctx The Koa context used to throw the error response.
+ * @param status The HTTP status code to use.
+ * @param message The message for in the response body.
+ * @param data Optional data to include.
+ */
+export function assertKoaError(condition, ctx, status, message, data) {
+    if (condition) {
+        throwKoaError(ctx, status, message, data);
+    }
+}
 //# sourceMappingURL=koa.js.map

package/logger.test.js

@@ -1,3 +1,4 @@
+import { afterEach, describe, expect, it } from 'vitest';
 import { configureLogger, logger, setLogLevel } from './logger.js';
 describe('setLogLevel', () => {
     afterEach(() => {

package/middleware/error.test.js

@@ -1,6 +1,8 @@
 import { request, setTestApp } from 'axios-test-instance';
 import Koa from 'koa';
+import { beforeEach, describe, expect, it } from 'vitest';
 import { errorMiddleware } from './error.js';
+import { throwKoaError } from '../koa.js';
 describe('errorMiddleware', () => {
     let app;
     beforeEach(async () => {
@@ -10,13 +12,7 @@ describe('errorMiddleware', () => {
     });
     it('should catch Koa errors', async () => {
         app.use((ctx) => {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: 'Error not found',
-            };
-            ctx.throw();
+            throwKoaError(ctx, 404, 'Error not found');
         });
         const response = await request.get('/');
         expect(response).toMatchObject({
@@ -44,13 +40,7 @@ describe('errorMiddleware', () => {
     it('should set Koa headers correctly', async () => {
         app.use((ctx) => {
             ctx.set('www-authenticate', 'Basic realm="Access to test data", charset="UTF-8"');
-            ctx.response.status = 401;
-            ctx.response.body = {
-                error: 'Unauthorized',
-                message: 'Not authorized!',
-                statusCode: 401,
-            };
-            ctx.throw();
+            throwKoaError(ctx, 401, 'Not authorized!');
         });
         const response = await request.get('/');
         expect(response).toMatchObject({

package/middleware/loggerMiddleware.test.js

@@ -2,6 +2,7 @@ import { logger, loggerMiddleware } from '@appsemble/node-utils';
 import { request, setTestApp } from 'axios-test-instance';
 import chalk from 'chalk';
 import Koa from 'koa';
+import { beforeEach, expect, it, vi } from 'vitest';
 class TestError extends Error {
     constructor(message) {
         super(message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/node-utils",
-  "version": "0.22.10",
+  "version": "0.23.0",
   "description": "NodeJS utilities used by Appsemble internally.",
   "keywords": [
     "app",
@@ -38,8 +38,8 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.22.10",
-    "@appsemble/utils": "0.22.10",
+    "@appsemble/types": "0.23.0",
+    "@appsemble/utils": "0.23.0",
     "@formatjs/fast-memoize": "^2.0.0",
     "@fortawesome/fontawesome-free": "^6.0.0",
     "@koa/cors": "^4.0.0",
@@ -50,7 +50,7 @@
     "bulma-checkradio": "2.1.1",
     "bulma-slider": "2.0.4",
     "bulma-switch": "^2.0.0",
-    "chalk": "^4.0.0",
+    "chalk": "^5.0.0",
     "cli-highlight": "^2.0.0",
     "csv-parse": "^5.0.0",
     "date-fns": "^2.0.0",

package/readFileOrString.test.js

@@ -1,3 +1,4 @@
+import { expect, it } from 'vitest';
 import { readFileOrString } from './readFileOrString.js';
 import { resolveFixture } from './testFixtures.js';
 it('should return file content if it resolves to a file', async () => {

package/resource.js

@@ -4,6 +4,7 @@ import { addMilliseconds, isPast, parseISO } from 'date-fns';
 import { ValidationError, Validator } from 'jsonschema';
 import parseDuration from 'parse-duration';
 import { preProcessCSV } from './csv.js';
+import { throwKoaError } from './koa.js';
 function stripResource({ $author, $created, $editor, $updated, ...data }) {
     return data;
 }
@@ -25,13 +26,7 @@ export function getResourceDefinition(app, resourceType, ctx, view) {
             throw new Error('App not found');
         }
         else {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: 'App not found',
-            };
-            ctx.throw();
+            throwKoaError(ctx, 404, 'App not found');
         }
     }
     const definition = (_a = app.definition.resources) === null || _a === void 0 ? void 0 : _a[resourceType];
@@ -40,13 +35,7 @@ export function getResourceDefinition(app, resourceType, ctx, view) {
             throw new Error(`App does not have resources called ${resourceType}`);
         }
         else {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: `App does not have resources called ${resourceType}`,
-            };
-            ctx.throw();
+            throwKoaError(ctx, 404, `App does not have resources called ${resourceType}`);
         }
     }
     if (view && !definition.views[view]) {
@@ -54,13 +43,7 @@ export function getResourceDefinition(app, resourceType, ctx, view) {
             throw new Error(`View ${view} does not exist for resource type ${resourceType}`);
         }
         else {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: `View ${view} does not exist for resource type ${resourceType}`,
-            };
-            ctx.throw();
+            throwKoaError(ctx, 404, `View ${view} does not exist for resource type ${resourceType}`);
         }
     }
     return definition;

package/server/controllers/action.js

@@ -1,4 +1,4 @@
-import { getRemapperContext, logger, version } from '@appsemble/node-utils';
+import { assertKoaError, getRemapperContext, logger, throwKoaError, version, } from '@appsemble/node-utils';
 import { defaultLocale, formatRequestAction, remap } from '@appsemble/utils';
 import axios from 'axios';
 import { get, pick } from 'lodash-es';
@@ -16,13 +16,7 @@ const supportedActions = ['email', 'notify', 'request'];
 async function handleEmail(ctx, app, action, options) {
     const { mailer, method, request: { body: data }, user, } = ctx;
     if (method !== 'POST') {
-        ctx.response.status = 405;
-        ctx.response.body = {
-            statusCode: 405,
-            message: 'Method must be POST for email actions',
-            error: 'Method Not Allowed',
-        };
-        ctx.throw();
+        throwKoaError(ctx, 405, 'Method must be POST for email actions');
     }
     const { email, reloadUser } = options;
     await reloadUser({ context: ctx });
@@ -31,13 +25,7 @@ async function handleEmail(ctx, app, action, options) {
     }
     catch (error) {
         if (error instanceof EmailQuotaExceededError) {
-            ctx.response.status = 429;
-            ctx.response.body = {
-                statusCode: 429,
-                error: 'Too Many Requests',
-                message: error.message,
-            };
-            ctx.throw();
+            throwKoaError(ctx, 429, error.message);
         }
         ctx.throw(error);
     }
@@ -73,13 +61,7 @@ async function handleRequestProxy(ctx, app, action, useBody, options) {
             data = JSON.parse(query.data);
         }
         catch {
-            ctx.response.status = 400;
-            ctx.response.body = {
-                status: 400,
-                message: 'data should be a JSON object.',
-                error: 'Bad Request',
-            };
-            ctx.throw();
+            throwKoaError(ctx, 400, 'data should be a JSON object.');
         }
     }
     const { applyAppServiceSecrets, reloadUser } = options;
@@ -94,13 +76,7 @@ async function handleRequestProxy(ctx, app, action, useBody, options) {
     let axiosConfig = formatRequestAction(action, data, (remapper, d) => remap(remapper, d, remapperContext), remapperContext.context);
     axiosConfig = await applyAppServiceSecrets({ axiosConfig, context: ctx, app });
     if (axiosConfig.method.toUpperCase() !== method) {
-        ctx.response.status = 400;
-        ctx.response.body = {
-            statusCode: 400,
-            message: 'Method does not match the request action method',
-            error: 'Bad Request',
-        };
-        ctx.throw();
+        throwKoaError(ctx, 400, 'Method does not match the request action method');
     }
     if (useBody) {
         axiosConfig.data = data;
@@ -116,13 +92,7 @@ async function handleRequestProxy(ctx, app, action, useBody, options) {
     }
     catch (err) {
         logger.error(err);
-        ctx.response.status = 502;
-        ctx.response.body = {
-            statusCode: 502,
-            error: 'Bad Gateway',
-            message: 'Bad Gateway',
-        };
-        ctx.throw(502);
+        throwKoaError(ctx, 502, 'Bad Gateway');
     }
     ctx.status = response.status;
     ctx.set(pick(response.headers, allowResponseHeaders));
@@ -132,15 +102,7 @@ function createProxyHandler(useBody, options) {
     return async (ctx) => {
         const { pathParams: { appId, path }, } = ctx;
         const app = await options.getApp({ context: ctx, query: { where: { id: appId } } });
-        if (!app) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: 'App not found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!app, ctx, 404, 'App not found');
         const appAction = get(app.definition, path);
         const action = supportedActions.find((act) => act === (appAction === null || appAction === void 0 ? void 0 : appAction.type));
         switch (action) {
@@ -151,13 +113,7 @@ function createProxyHandler(useBody, options) {
             case 'request':
                 return handleRequestProxy(ctx, app, appAction, useBody, options);
             default:
-                ctx.response.status = 400;
-                ctx.response.body = {
-                    statusCode: 400,
-                    message: 'path does not point to a proxyable action',
-                    error: 'Bad Request',
-                };
-                ctx.throw();
+                throwKoaError(ctx, 400, 'path does not point to a proxyable action');
         }
     };
 }

package/server/controllers/appMembers.js

@@ -1,35 +1,12 @@
+import { assertKoaError } from '../../koa.js';
 export function createGetAppMember({ getApp, getAppMembers }) {
     return async (ctx) => {
         const { pathParams: { appId, memberId }, } = ctx;
         const app = await getApp({ context: ctx, query: { where: { id: appId } } });
-        if (!app) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: 'App not found',
-            };
-            ctx.throw();
-        }
-        if (app.definition.security === undefined) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: 'App does not have a security definition',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!app, ctx, 404, 'App not found');
+        assertKoaError(app.definition.security === undefined, ctx, 404, 'App does not have a security definition');
         const appMembers = await getAppMembers({ context: ctx, app, memberId });
-        if (appMembers.length !== 1) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: 'App member not found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(appMembers.length !== 1, ctx, 404, 'App member not found');
         ctx.body = appMembers[0];
     };
 }

package/server/controllers/appMessages.js

@@ -1,4 +1,4 @@
-import { getAppsembleMessages, mergeMessages, } from '@appsemble/node-utils';
+import { assertKoaError, getAppsembleMessages, mergeMessages, throwKoaError, } from '@appsemble/node-utils';
 import { defaultLocale, extractAppMessages, normalizeBlockName, } from '@appsemble/utils';
 import tags from 'language-tags';
 export function createGetMessages({ getApp, getAppMessages, getBlockMessages, }) {
@@ -6,12 +6,7 @@ export function createGetMessages({ getApp, getAppMessages, getBlockMessages, })
         var _a, _b, _c, _d, _e;
         const { pathParams: { appId, language }, query: { merge, override = 'true' }, } = ctx;
         if (!tags.check(language)) {
-            ctx.response.status = 400;
-            ctx.response.body = {
-                error: 'Bad Request',
-                message: '`Language “${language}” is invalid`',
-            };
-            ctx.throw();
+            throwKoaError(ctx, 400, '`Language “${language}” is invalid`');
         }
         const lang = language.toLowerCase();
         const baseLanguage = tags(language)
@@ -19,18 +14,10 @@ export function createGetMessages({ getApp, getAppMessages, getBlockMessages, })
             .find((sub) => sub.type() === 'language');
         const baseLang = baseLanguage && String(baseLanguage).toLowerCase();
         const app = await getApp({ context: ctx, query: { where: { id: appId } } });
-        if (!app) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                status: 404,
-                message: 'App not found',
-                error: 'Not Found',
-            };
-            ctx.throw();
-        }
-        const appMessages = await getAppMessages({ context: ctx, app, language });
+        assertKoaError(!app, ctx, 404, 'App not found');
         const blockPrefixes = [];
         const blockQuery = [];
+        const appMessages = await getAppMessages({ context: ctx, app, language });
         const coreMessages = await getAppsembleMessages(lang, baseLang);
         const messages = {
             core: Object.fromEntries(Object.entries(coreMessages).filter(([key]) => key.startsWith('app') || key.startsWith('react-components') || key.startsWith('server'))),
@@ -45,13 +32,7 @@ export function createGetMessages({ getApp, getAppMessages, getBlockMessages, })
         const blockMessages = await getBlockMessages({ context: ctx, blockQuery, baseLang, lang });
         if ((!appMessages.length || (merge && !appMessages.some((m) => m.language === lang))) &&
             lang !== (app.definition.defaultLanguage || defaultLocale)) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                message: `Language “${language}” could not be found`,
-                error: 'Not Found',
-            };
-            ctx.throw();
+            throwKoaError(ctx, 404, `Language “${language}” could not be found`);
         }
         const baseLanguageMessages = override === 'true' && appMessages.find((m) => m.language === baseLang);
         const languageMessages = override === 'true' && appMessages.find((m) => m.language === lang);

package/server/controllers/assets.js

@@ -1,18 +1,11 @@
+import { assertKoaError } from '@appsemble/node-utils';
 import { Permission } from '@appsemble/utils';
 import { extension } from 'mime-types';
 export function createGetAssets({ checkRole, getApp, getAppAssets }) {
     return async (ctx) => {
         const { pathParams: { appId }, queryParams: { $skip, $top }, } = ctx;
         const app = await getApp({ context: ctx, query: { where: { id: appId } } });
-        if (!app) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                message: 'App not found',
-                error: 'Not Found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!app, ctx, 404, 'App not found');
         const findOptions = {
             limit: $top,
             offset: $skip,
@@ -26,27 +19,11 @@ export function createGetAssetById({ getApp, getAppAssets }) {
     return async (ctx) => {
         const { pathParams: { appId, assetId }, } = ctx;
         const app = await getApp({ context: ctx, query: { where: { id: appId } } });
-        if (!app) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                message: 'App not found',
-                error: 'Not Found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!app, ctx, 404, 'App not found');
         const assets = await getAppAssets({ app, context: ctx });
         // Pick asset id over asset name
         const asset = assets.find((a) => a.id === assetId) || assets.find((a) => a.name === assetId);
-        if (!asset) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                message: 'Asset not found',
-                error: 'Not Found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!asset, ctx, 404, 'Asset not found');
         if (assetId !== asset.id) {
             // Redirect to asset using current asset ID
             ctx.status = 302;
@@ -76,15 +53,7 @@ export function createCreateAsset({ createAppAsset, getApp }) {
     return async (ctx) => {
         const { pathParams: { appId }, request: { body: { file: { contents, filename, mime }, name, }, }, } = ctx;
         const app = await getApp({ context: ctx, query: { where: { id: appId } } });
-        if (!app) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                message: 'App not found',
-                error: 'Not Found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!app, ctx, 404, 'App not found');
         const asset = await createAppAsset({
             app,
             context: ctx,

package/server/controllers/resources.js

@@ -1,4 +1,4 @@
-import { getRemapperContext, getResourceDefinition, logger, processResourceBody, } from '@appsemble/node-utils';
+import { assertKoaError, getRemapperContext, getResourceDefinition, logger, processResourceBody, throwKoaError, } from '@appsemble/node-utils';
 import { defaultLocale, remap } from '@appsemble/utils';
 function generateQuery(ctx, { parseQuery }) {
     try {
@@ -6,23 +6,10 @@ function generateQuery(ctx, { parseQuery }) {
     }
     catch (error) {
         if (error instanceof Error) {
-            ctx.response.status = 400;
-            ctx.response.body = {
-                statusCode: 400,
-                error: 'Bad Request',
-                message: 'Unable to process this query',
-                data: { syntaxError: error.message },
-            };
-            ctx.throw();
+            throwKoaError(ctx, 400, 'Unable to process this query', { syntaxError: error.message });
         }
         logger.error(error);
-        ctx.response.status = 500;
-        ctx.response.body = {
-            statusCode: 500,
-            error: 'Internal Server Error',
-            message: 'Unable to process this query',
-        };
-        ctx.throw();
+        throwKoaError(ctx, 400, 'Unable to process this query');
     }
 }
 export function createQueryResources(options) {
@@ -149,15 +136,7 @@ export function createGetResourceById(options) {
             context: ctx,
             findOptions,
         });
-        if (!resource) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: 'Resource not found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!resource, ctx, 404, 'Resource not found');
         if (view) {
             const context = await getRemapperContext(app, app.definition.defaultLanguage || defaultLocale, user && {
                 sub: user.id,
@@ -229,15 +208,7 @@ export function createUpdateResource(options) {
             context: ctx,
             findOptions,
         });
-        if (!oldResource) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: 'Resource not found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!oldResource, ctx, 404, 'Resource not found');
         const appAssets = await getAppAssets({ context: ctx, app });
         const [processedBody, preparedAssets, deletedAssetIds] = processResourceBody(ctx, resourceDefinition, appAssets.filter((asset) => asset.resourceId === resourceId).map((asset) => asset.id), oldResource.expires);
         const resources = Array.isArray(processedBody) ? processedBody : [processedBody];
@@ -285,15 +256,7 @@ export function createDeleteResource(options) {
             context: ctx,
             findOptions,
         });
-        if (!resource) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: 'Resource not found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!resource, ctx, 404, 'Resource not found');
         await deleteAppResource({
             app,
             context: ctx,

package/server/controllers/resources.test.js

@@ -1,4 +1,5 @@
 import { defaultLocale, remap } from '@appsemble/utils';
+import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { createCountResources, createCreateResource, createGetResourceById, createQueryResources, } from './resources.js';
 import { getRemapperContext } from '../../app.js';
 import { getResourceDefinition } from '../../resource.js';

package/server/controllers/teams.js

@@ -1,16 +1,9 @@
+import { assertKoaError } from '../../koa.js';
 export function createGetTeams({ getApp, getAppTeams }) {
     return async (ctx) => {
         const { pathParams: { appId }, user, } = ctx;
         const app = await getApp({ context: ctx, query: { where: { id: appId } } });
-        if (!app) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: 'App not found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!app, ctx, 404, 'App not found');
         ctx.body = await getAppTeams({ context: ctx, app, user });
     };
 }

package/server/routes/appRouter/blockAssetHandler.js

@@ -1,16 +1,9 @@
+import { assertKoaError } from '@appsemble/node-utils';
 export function createBlockAssetHandler({ getBlockAsset }) {
     return async (ctx) => {
         const { params: { filename, name, version }, } = ctx;
         const blockAsset = await getBlockAsset({ filename, name, version, context: ctx });
-        if (!blockAsset) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                message: 'Block asset not found',
-                error: 'Not Found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!blockAsset, ctx, 404, 'Block asset not found');
         ctx.body = blockAsset.content;
         ctx.type = blockAsset.mime;
     };

package/server/routes/appRouter/blockCssHandler.js

@@ -1,16 +1,9 @@
+import { assertKoaError } from '@appsemble/node-utils';
 export function createBlockCssHandler({ getApp, getAppBlockStyles }) {
     return async (ctx) => {
         const { params: { name }, } = ctx;
         const app = await getApp({ context: ctx });
-        if (!app) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: 'App not found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!app, ctx, 404, 'App not found');
         const appBlockStyles = await getAppBlockStyles({ app, name, context: ctx });
         const [style] = appBlockStyles;
         ctx.body = style ? style.style : '';

package/server/routes/appRouter/cssHandler.js

@@ -1,15 +1,8 @@
+import { assertKoaError } from '@appsemble/node-utils';
 export function createCssHandler(type, { getAppStyles }) {
     return async (ctx) => {
         const app = await getAppStyles({ context: ctx, query: { attributes: [type], raw: true } });
-        if (!app) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                error: 'Not Found',
-                message: 'App not found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!app, ctx, 404, 'App not found');
         ctx.body = app[type];
         ctx.type = 'css';
     };

package/server/routes/appRouter/iconHandler.js

@@ -10,7 +10,7 @@ export function createIconHandler({ getApp, getAppIcon, getDbUpdated }) {
         const dbUpdated = app ? await getDbUpdated({ app, maskable, context: ctx }) : false;
         const appIcon = app ? await getAppIcon({ app, context: ctx }) : null;
         await serveIcon(ctx, {
-            background: maskable ? app.iconBackground || '#ffffff' : undefined,
+            background: maskable ? (app === null || app === void 0 ? void 0 : app.iconBackground) || '#ffffff' : undefined,
             cache: dbUpdated ? isEqual(parseISO(updated), dbUpdated) : false,
             fallback: 'mobile-alt-solid.png',
             height: size && Number.parseInt(size),

package/server/routes/appRouter/manifestHandler.js

@@ -1,18 +1,11 @@
+import { assertKoaError } from '@appsemble/node-utils';
 import { baseTheme, normalize } from '@appsemble/utils';
 import { extension } from 'mime-types';
 const iconSizes = [48, 144, 192, 512];
 export function createManifestHandler({ getApp, getAppScreenshots }) {
     return async (ctx) => {
         const app = await getApp({ context: ctx });
-        if (!app) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                message: 'Block asset not found',
-                error: 'Not Found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!app, ctx, 404, 'Block asset not found');
         const { defaultPage, description, name, theme = baseTheme } = app.definition;
         const { themeColor = '#ffffff', splashColor = themeColor } = theme;
         const appScreenshots = await getAppScreenshots({ app, context: ctx });

package/server/routes/appRouter/screenshotHandler.js

@@ -1,27 +1,12 @@
+import { assertKoaError } from '@appsemble/node-utils';
 export function createScreenshotHandler({ getApp, getAppScreenshots }) {
     return async (ctx) => {
         const { id } = ctx.params;
         const app = await getApp({ context: ctx });
-        if (!app) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                message: 'App not found',
-                error: 'Not Found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!app, ctx, 404, 'App not found');
         const appScreenshots = await getAppScreenshots({ app, context: ctx });
         const appScreenshot = appScreenshots.find((screenshot) => screenshot.id === Number.parseInt(id));
-        if (!appScreenshot) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                message: 'Screenshot not found',
-                error: 'Not Found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!appScreenshot, ctx, 404, 'Screenshot not found');
         const { mime, screenshot } = appScreenshot;
         ctx.type = mime;
         ctx.body = screenshot;

package/server/routes/appRouter/serviceWorkerHandler.js

@@ -1,4 +1,5 @@
 import { readFile } from 'node:fs/promises';
+import { assertKoaError } from '@appsemble/node-utils';
 import { getAppBlocks } from '@appsemble/utils';
 export function createServiceWorkerHandler({ getApp, getBlocksAssetsPaths }) {
     return async (ctx) => {
@@ -8,15 +9,7 @@ export function createServiceWorkerHandler({ getApp, getBlocksAssetsPaths }) {
             ? readFile(new URL('../../../../../dist/app/service-worker.js', import.meta.url), 'utf8')
             : ctx.fs.promises.readFile(filename, 'utf8'));
         const app = await getApp({ context: ctx });
-        if (!app) {
-            ctx.response.status = 404;
-            ctx.response.body = {
-                statusCode: 404,
-                message: 'App does not exist.',
-                error: 'Not Found',
-            };
-            ctx.throw();
-        }
+        assertKoaError(!app, ctx, 404, 'App does not exist.');
         const identifiableBlocks = getAppBlocks(app.definition);
         const blocksAssetsPaths = await getBlocksAssetsPaths({ identifiableBlocks, context: ctx });
         ctx.body = `const blockAssets=${JSON.stringify(blocksAssetsPaths)};${serviceWorker}`;

package/server/types.d.ts

@@ -76,6 +76,8 @@ declare module 'koas-parameters' {
         token: string;
         appServiceId: number;
         userId: string;
+        trainingBlockId: number;
+        trainingId: number;
     }
     interface QueryParams {
         domains: string[];
@@ -89,6 +91,7 @@ declare module 'koas-parameters' {
         count: number;
         startIndex: number;
         view: string;
+        resources: boolean;
     }
 }
 export type Operator = 'and' | 'not' | 'or';
@@ -193,8 +196,8 @@ export interface GetCspParams {
     settingsHash: string;
     nonce: string;
 }
-export type HookAction = 'create' | 'delete' | 'update';
-export type Action = HookAction | 'count' | 'get' | 'patch' | 'query';
+export type ResourceAction = 'create' | 'delete' | 'update';
+export type Action = ResourceAction | 'count' | 'get' | 'patch' | 'query';
 export interface VerifyResourceActionPermissionParams {
     context: ParameterizedContext<DefaultState, DefaultContextInterface, any>;
     app: App;
@@ -238,7 +241,7 @@ export interface CreateAppResourcesWithAssetsParams extends GetAppSubEntityParam
     resources: Record<string, unknown>[];
     preparedAssets: PreparedAsset[];
     resourceType: string;
-    action: HookAction;
+    action: ResourceAction;
     options: Options;
 }
 export interface UpdateAppResourceParams extends GetAppSubEntityParams {
@@ -249,13 +252,13 @@ export interface UpdateAppResourceParams extends GetAppSubEntityParams {
     deletedAssetIds: string[];
     type: string;
     options: Options;
-    action: HookAction;
+    action: ResourceAction;
 }
 export interface DeleteAppResourceParams extends GetAppSubEntityParams {
     id: number | string;
     type: string;
     whereOptions?: WhereOptions;
-    action: HookAction;
+    action: ResourceAction;
     options: Options;
 }
 export interface CreateAppAssetParams extends GetAppSubEntityParams {

package/tinyRouter.js

@@ -1,4 +1,5 @@
 import { has } from '@appsemble/utils';
+import { throwKoaError } from './koa.js';
 /**
  * A tiny dynamic router middleware for GET requests.
  *
@@ -22,13 +23,7 @@ export function tinyRouter(routes) {
         let m = method.toLowerCase();
         if (!has(result, m)) {
             if (!has(result, 'any')) {
-                ctx.response.status = 405;
-                ctx.response.body = {
-                    statusCode: 405,
-                    error: 'Method Not Allowed',
-                    message: 'Method not allowed',
-                };
-                ctx.throw();
+                throwKoaError(ctx, 405, 'Method not allowed');
             }
             m = 'any';
         }

package/tinyRouter.test.js

@@ -1,6 +1,7 @@
 import { noop } from '@appsemble/utils';
 import { request, setTestApp } from 'axios-test-instance';
 import Koa from 'koa';
+import { beforeEach, expect, it, vi } from 'vitest';
 import { errorMiddleware } from './index.js';
 import { tinyRouter } from './tinyRouter.js';
 let app;