@appsemble/node-utils 0.23.9 → 0.24.1

package/EmailError.d.ts

@@ -0,0 +1,3 @@
+export declare class EmailError extends Error {
+    constructor(message: string);
+}

package/EmailError.js

@@ -0,0 +1,8 @@
+export class EmailError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'EmailError';
+        Error.captureStackTrace(this, EmailError);
+    }
+}
+//# sourceMappingURL=EmailError.js.map

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.23.9/config/assets/logo.svg) Appsemble Node Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.24.1/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.23.9/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.23.9)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.24.1/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.24.1)
 [![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.23.9/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.24.1/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/UserPropertiesError.d.ts

@@ -0,0 +1,3 @@
+export declare class UserPropertiesError extends Error {
+    constructor(message: string);
+}

package/UserPropertiesError.js

@@ -0,0 +1,8 @@
+export class UserPropertiesError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'UserPropertiesError';
+        Error.captureStackTrace(this, UserPropertiesError);
+    }
+}
+//# sourceMappingURL=UserPropertiesError.js.map

package/app.d.ts

@@ -10,7 +10,7 @@ import { type Options } from './server/types.js';
  * @param app The app for which to get the remapper context.
  * @param language The preferred language for the context.
  * @param userInfo The OAuth2 compatible user information.
- * @param options The utility options.
+ * @param options The API utility options.
  * @param context The koa context.
  * @returns A localized remapper context for the app.
  */

package/app.js

@@ -11,7 +11,7 @@ const getPluralRules = memoize((locale, opts) => new Intl.PluralRules(locale, op
  * @param app The app for which to get the remapper context.
  * @param language The preferred language for the context.
  * @param userInfo The OAuth2 compatible user information.
- * @param options The utility options.
+ * @param options The API utility options.
  * @param context The koa context.
  * @returns A localized remapper context for the app.
  */

package/index.d.ts

@@ -32,4 +32,6 @@ export * from './server/types.js';
 export * from './koa.js';
 export { bulmaVersion, faVersion, version } from './versions.cjs';
 export * from './EmailQuotaExceededError.js';
+export * from './EmailError.js';
+export * from './UserPropertiesError.js';
 export * from './authentication.js';

package/index.js

@@ -32,5 +32,7 @@ export * from './server/types.js';
 export * from './koa.js';
 export { bulmaVersion, faVersion, version } from './versions.cjs';
 export * from './EmailQuotaExceededError.js';
+export * from './EmailError.js';
+export * from './UserPropertiesError.js';
 export * from './authentication.js';
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/node-utils",
-  "version": "0.23.9",
+  "version": "0.24.1",
   "description": "NodeJS utilities used by Appsemble internally.",
   "keywords": [
     "app",
@@ -38,8 +38,8 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.23.9",
-    "@appsemble/utils": "0.23.9",
+    "@appsemble/types": "0.24.1",
+    "@appsemble/utils": "0.24.1",
     "@formatjs/fast-memoize": "^2.0.0",
     "@fortawesome/fontawesome-free": "^6.0.0",
     "@koa/cors": "^4.0.0",

package/resource.js

@@ -128,8 +128,18 @@ export function processResourceBody(ctx, definition, knownAssetIds = [], knownEx
         properties: {
             ...definition.schema.properties,
             id: { type: 'integer' },
-            $expires: { type: 'string', format: 'date-time' },
+            $expires: {
+                anyOf: [
+                    { type: 'string', format: 'date-time' },
+                    {
+                        type: 'string',
+                        pattern: /^(\d+(y|yr|years))?\s*(\d+months)?\s*(\d+(w|wk|weeks))?\s*(\d+(d|days))?\s*(\d+(h|hr|hours))?\s*(\d+(m|min|minutes))?\s*(\d+(s|sec|seconds))?$/
+                            .source,
+                    },
+                ],
+            },
             $clonable: { type: 'boolean' },
+            $ephemeral: { type: 'boolean' },
         },
     };
     const customErrors = [];
@@ -139,12 +149,21 @@ export function processResourceBody(ctx, definition, knownAssetIds = [], knownEx
         preValidateProperty,
         nestedErrors: true,
         rewrite(value, { format }, options, { path }) {
-            if (Array.isArray(resource)
-                ? path.length === 2 && typeof path[0] === 'number' && path[1] === '$expires'
-                : path.length === 1 && path[0] === '$expires') {
+            let propertyName;
+            if (Array.isArray(resource) && path.length === 2 && typeof path[0] === 'number') {
+                propertyName = path[1];
+            }
+            else if (path.length === 1) {
+                propertyName = path[0];
+            }
+            if (propertyName === '$expires') {
                 if (value !== undefined) {
                     const date = parseISO(value);
-                    if (isPast(date)) {
+                    if (Number.isNaN(date.getTime())) {
+                        return addMilliseconds(new Date(), parseDuration(value));
+                    }
+                    if (isPast(date) &&
+                        !customErrors.some((error) => error.message === 'has already passed' && error.path === path)) {
                         customErrors.push(new ValidationError('has already passed', value, null, path));
                     }
                     return date;
@@ -157,6 +176,12 @@ export function processResourceBody(ctx, definition, knownAssetIds = [], knownEx
                 }
             }
             if (value === undefined) {
+                if (propertyName === '$clonable') {
+                    return definition.clonable;
+                }
+                if (propertyName === '$ephemeral') {
+                    return definition.ephemeral;
+                }
                 return;
             }
             if (format !== 'binary') {

package/server/controllers/action.js

@@ -1,5 +1,5 @@
 import { assertKoaError, getRemapperContext, logger, throwKoaError, version, } from '@appsemble/node-utils';
-import { defaultLocale, formatRequestAction, remap } from '@appsemble/utils';
+import { defaultLocale, remap } from '@appsemble/utils';
 import axios from 'axios';
 import { get, pick } from 'lodash-es';
 import { EmailQuotaExceededError } from '../../EmailQuotaExceededError.js';
@@ -50,7 +50,7 @@ async function handleNotify(ctx, app, action, options) {
     ctx.status = 204;
 }
 async function handleRequestProxy(ctx, app, action, useBody, options) {
-    var _a, _b;
+    var _a, _b, _c;
     const { method, query, request: { body, headers }, user, } = ctx;
     let data;
     if (useBody) {
@@ -73,7 +73,22 @@ async function handleRequestProxy(ctx, app, action, useBody, options) {
         email_verified: Boolean((_b = (_a = user.EmailAuthorizations) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.verified),
         zoneinfo: user.timezone,
     }, options, ctx);
-    let axiosConfig = formatRequestAction(action, data, (remapper, d) => remap(remapper, d, remapperContext), remapperContext.context);
+    let params;
+    try {
+        if (query.params) {
+            params = JSON.parse(query.params);
+        }
+    }
+    catch {
+        throwKoaError(ctx, 400, 'params should be a JSON object.');
+    }
+    let axiosConfig = {
+        method: (_c = action.method) !== null && _c !== void 0 ? _c : 'GET',
+        url: String(remap(action.url, data, remapperContext)),
+        params,
+        responseType: 'arraybuffer',
+        headers: {},
+    };
     axiosConfig = await applyAppServiceSecrets({ axiosConfig, context: ctx, app });
     if (axiosConfig.method.toUpperCase() !== method) {
         throwKoaError(ctx, 400, 'Method does not match the request action method');

package/server/controllers/resources.js

@@ -39,6 +39,7 @@ export function createQueryResources(options) {
                         type: resourceType,
                         AppId: appId,
                         expires: { or: [{ gt: new Date() }, null] },
+                        ...(app.demoMode ? { seed: false, ephemeral: true } : {}),
                     },
                 ],
             },
@@ -90,6 +91,7 @@ export function createCountResources(options) {
                         type: resourceType,
                         AppId: appId,
                         expires: { or: [{ gt: new Date() }, null] },
+                        ...(app.demoMode ? { seed: false, ephemeral: true } : {}),
                     },
                 ],
             },
@@ -127,6 +129,7 @@ export function createGetResourceById(options) {
                 type: resourceType,
                 AppId: appId,
                 expires: { or: [{ gt: new Date() }, null] },
+                ...(app.demoMode ? { seed: false, ephemeral: true } : {}),
             },
         };
         const resource = await getAppResource({
@@ -154,9 +157,10 @@ export function createGetResourceById(options) {
 export function createCreateResource(options) {
     return async (ctx) => {
         const { pathParams: { appId, resourceType }, } = ctx;
-        const { createAppResourcesWithAssets, getApp, verifyResourceActionPermission } = options;
+        const { checkSeededResources, createAppResourcesWithAssets, getApp, verifyResourceActionPermission, } = options;
         const action = 'create';
         const app = await getApp({ context: ctx, query: { where: { id: appId } } });
+        const resourceSeeded = await checkSeededResources({ context: ctx, app, resourceType });
         const resourceDefinition = getResourceDefinition(app, resourceType, ctx);
         await verifyResourceActionPermission({ app, context: ctx, action, resourceType, options, ctx });
         const [processedBody, preparedAssets] = processResourceBody(ctx, resourceDefinition);
@@ -165,15 +169,57 @@ export function createCreateResource(options) {
             return;
         }
         const resources = Array.isArray(processedBody) ? processedBody : [processedBody];
-        const createdResources = await createAppResourcesWithAssets({
-            app,
-            context: ctx,
-            resources,
-            preparedAssets,
-            resourceType,
-            action,
-            options,
-        });
+        let createdResources;
+        // In demo apps, there are two types of resources.
+        // If the app has not been seeded, resources passed from the request body
+        // are interpreted as seed resources and created with "seed: true". In addition,
+        // copies of these resources are created with "ephemeral: true".
+        // If the app has already been seeded, only new ephemeral resources are created,
+        // processed from the request body.
+        if (app.demoMode) {
+            if (!resourceSeeded) {
+                await createAppResourcesWithAssets({
+                    app,
+                    context: ctx,
+                    resources: resources.map((resource) => ({
+                        ...resource,
+                        $seed: true,
+                        $ephemeral: false,
+                    })),
+                    preparedAssets,
+                    resourceType,
+                    action,
+                    options,
+                });
+            }
+            createdResources = await createAppResourcesWithAssets({
+                app,
+                context: ctx,
+                resources: resources.map((resource) => ({
+                    ...resource,
+                    $seed: false,
+                    $ephemeral: true,
+                    $clonable: false,
+                })),
+                preparedAssets,
+                resourceType,
+                action,
+                options,
+            });
+        }
+        else {
+            // In regular apps, resources are created as usual
+            // with "clonable", "ephemeral" and "expires" passed from the request body
+            createdResources = await createAppResourcesWithAssets({
+                app,
+                context: ctx,
+                resources,
+                preparedAssets,
+                resourceType,
+                action,
+                options,
+            });
+        }
         ctx.body = Array.isArray(processedBody) ? createdResources : createdResources[0];
     };
 }
@@ -199,6 +245,7 @@ export function createUpdateResource(options) {
                 type: resourceType,
                 AppId: appId,
                 expires: { or: [{ gt: new Date() }, null] },
+                ...(app.demoMode ? { seed: false, ephemeral: true } : {}),
             },
         };
         const oldResource = await getAppResource({
@@ -217,7 +264,10 @@ export function createUpdateResource(options) {
             context: ctx,
             id: resourceId,
             type: resourceType,
-            resource: resources[0],
+            resource: {
+                ...resources[0],
+                ...(app.demoMode ? { $ephemeral: true, $clonable: false } : {}),
+            },
             preparedAssets,
             deletedAssetIds,
             resourceDefinition,
@@ -246,7 +296,8 @@ export function createDeleteResource(options) {
                 id: resourceId,
                 type: resourceType,
                 AppId: appId,
-                expires: { or: [{ gt: new Date() }, null] },
+                expires: { or: [{ gt: new Date() }, { eq: null }] },
+                ...(app.demoMode ? { seed: false, ephemeral: true } : {}),
             },
         };
         const resource = await getAppResource({

package/server/controllers/resources.test.js

@@ -11,6 +11,7 @@ let mockParseQuery;
 let mockGetAppUrl;
 let mockGetAppMessages;
 let mockCreateAppResourcesWithAssets;
+let mockCheckSeededResources;
 let mockCtx;
 let mockCtxIs;
 describe('createQueryResources', () => {
@@ -427,6 +428,7 @@ describe('createCreateResource', () => {
         mockGetApp = vi.fn();
         mockVerifyResourceActionPermission = vi.fn();
         mockCreateAppResourcesWithAssets = vi.fn();
+        mockCheckSeededResources = vi.fn();
         mockCtxIs = vi.fn();
         mockCtx = {
             pathParams: { appId: 1, resourceType: 'mockResourceType' },
@@ -449,10 +451,12 @@ describe('createCreateResource', () => {
         mockGetApp.mockResolvedValue(mockApp);
         mockCtxIs.mockReturnValue('multipart/form-data');
         mockCreateAppResourcesWithAssets.mockResolvedValue(mockResources);
+        mockCheckSeededResources.mockResolvedValue(false);
         const middleware = createCreateResource({
             getApp: mockGetApp,
             createAppResourcesWithAssets: mockCreateAppResourcesWithAssets,
             verifyResourceActionPermission: mockVerifyResourceActionPermission,
+            checkSeededResources: mockCheckSeededResources,
         });
         await middleware(mockCtx, vi.fn());
         expect(mockGetApp).toHaveBeenCalledWith(expect.objectContaining({
@@ -506,10 +510,12 @@ describe('createCreateResource', () => {
         mockGetApp.mockResolvedValue(mockApp);
         mockCtxIs.mockReturnValue('multipart/form-data');
         mockCreateAppResourcesWithAssets.mockResolvedValue(mockResources);
+        mockCheckSeededResources.mockResolvedValue(false);
         const middleware = createCreateResource({
             getApp: mockGetApp,
             createAppResourcesWithAssets: mockCreateAppResourcesWithAssets,
             verifyResourceActionPermission: mockVerifyResourceActionPermission,
+            checkSeededResources: mockCheckSeededResources,
         });
         await middleware(mockCtx, vi.fn());
         expect(mockGetApp).toHaveBeenCalledWith(expect.objectContaining({

package/server/types.d.ts

@@ -79,6 +79,7 @@ declare module 'koas-parameters' {
         token: string;
         appServiceId: number;
         userId: string;
+        memberEmail: string;
         trainingBlockId: number;
         trainingId: number;
     }
@@ -95,6 +96,7 @@ declare module 'koas-parameters' {
         startIndex: number;
         view: string;
         resources: boolean;
+        roles: string[];
     }
 }
 export type Operator = 'and' | 'not' | 'or';
@@ -122,6 +124,9 @@ export interface GetAppSubEntityParams {
     context: ParameterizedContext<DefaultState, DefaultContextInterface, any>;
     app: App;
 }
+export interface CheckSeededResourcesParams extends GetAppSubEntityParams {
+    resourceType: string;
+}
 export interface GetAppMessagesParams extends GetAppSubEntityParams {
     language?: string;
     merge?: string[] | string;
@@ -370,5 +375,6 @@ export interface Options {
     deleteAppAsset: (params: DeleteAppAssetParams) => Promise<number>;
     email: (params: EmailParams) => Promise<void>;
     sendNotifications: (params: SendNotificationsParams) => Promise<void>;
+    checkSeededResources: (params: CheckSeededResourcesParams) => Promise<boolean>;
 }
 export {};