@appsemble/node-utils 0.27.11 → 0.28.0

package/README.md

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

package/app.js

@@ -27,13 +27,14 @@ const getPluralRules = memoize((locale, opts) => new Intl.PluralRules(locale, op
  */
 export async function getRemapperContext(app, language, userInfo, options, context) {
     var _a, _b;
-    const { getAppMessages, getAppUrl } = options;
+    const { getAppMessages, getAppUrl, getAppVariables } = options;
     const appUrl = String(await getAppUrl({ context, app }));
     const appMessages = await getAppMessages({
         app,
         context,
         language,
     });
+    const appVariables = await getAppVariables({ context, app });
     const cache = objectCache((message) => new IntlMessageFormat(message, language, undefined, {
         formatters: {
             // @ts-expect-error intl-messageformat types are wrong
@@ -51,6 +52,10 @@ export async function getRemapperContext(app, language, userInfo, options, conte
             const message = msg ? msg.messages.messageIds[id] : defaultMessage;
             return cache(message || `'{${id}}'`);
         },
+        getVariable(variableName) {
+            var _a;
+            return (_a = appVariables.find((appVariable) => appVariable.name === variableName)) === null || _a === void 0 ? void 0 : _a.value;
+        },
         userInfo,
         appMember: userInfo === null || userInfo === void 0 ? void 0 : userInfo.appMember,
         context: {},
@@ -229,6 +234,7 @@ export async function applyAppVariant(appPath, appVariant) {
         await copy(appPath, appVariantDestDir);
         logger.verbose(`Successfully copied app files to ${appVariantDestDir}`);
         const appVariantDefDir = join(appPath, 'variants', appVariant);
+        await transferAppVariantFiles(appPath, appVariantDefDir, appVariantDestDir, 'config');
         await transferAppVariantFiles(appPath, appVariantDefDir, appVariantDestDir, 'assets');
         await transferAppVariantFiles(appPath, appVariantDefDir, appVariantDestDir, 'resources');
         await transferAppVariantFiles(appPath, appVariantDefDir, appVariantDestDir, 'screenshots');

package/package.json

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

package/server/controllers/resources.js

@@ -2,9 +2,13 @@ import { randomUUID } from 'node:crypto';
 import { isDeepStrictEqual } from 'node:util';
 import { assertKoaError, getRemapperContext, getResourceDefinition, logger, processResourceBody, throwKoaError, } from '@appsemble/node-utils';
 import { defaultLocale, remap } from '@appsemble/utils';
-function generateQuery(ctx, { parseQuery }) {
+function generateQuery(ctx, { parseQuery }, resourceDefinition) {
     try {
-        return parseQuery({ $filter: ctx.queryParams.$filter, $orderby: ctx.queryParams.$orderby });
+        return parseQuery({
+            $filter: ctx.queryParams.$filter,
+            $orderby: ctx.queryParams.$orderby,
+            resourceDefinition,
+        });
     }
     catch (error) {
         if (error instanceof Error) {
@@ -16,11 +20,13 @@ function generateQuery(ctx, { parseQuery }) {
 }
 export function createQueryResources(options) {
     return async (ctx) => {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e;
         const { pathParams: { appId, resourceType }, queryParams: { $select, $skip, $top }, user, } = ctx;
         const { getApp, getAppResources, verifyResourceActionPermission } = options;
         const app = await getApp({ context: ctx, query: { where: { id: appId } } });
-        const { order, where } = generateQuery(ctx, options);
+        const view = (_a = ctx.queryParams) === null || _a === void 0 ? void 0 : _a.view;
+        const resourceDefinition = getResourceDefinition(app, resourceType, ctx, view);
+        const { order, where } = generateQuery(ctx, options, resourceDefinition);
         const memberQuery = await verifyResourceActionPermission({
             context: ctx,
             app,
@@ -29,6 +35,7 @@ export function createQueryResources(options) {
             options,
             ctx,
         });
+        const isSameOrigin = ((_b = ctx === null || ctx === void 0 ? void 0 : ctx.headers) === null || _b === void 0 ? void 0 : _b.origin) === ((_c = ctx === null || ctx === void 0 ? void 0 : ctx.headers) === null || _c === void 0 ? void 0 : _c.host);
         const findOptions = {
             limit: $top,
             offset: $skip,
@@ -41,7 +48,7 @@ export function createQueryResources(options) {
                         type: resourceType,
                         AppId: appId,
                         expires: { or: [{ gt: new Date() }, null] },
-                        ...(app.demoMode ? { seed: false, ephemeral: true } : {}),
+                        ...(app.demoMode && !isSameOrigin ? { seed: false, ephemeral: true } : {}),
                     },
                 ],
             },
@@ -53,14 +60,12 @@ export function createQueryResources(options) {
             type: resourceType,
             context: ctx,
         });
-        const view = (_a = ctx.queryParams) === null || _a === void 0 ? void 0 : _a.view;
-        const resourceDefinition = getResourceDefinition(app, resourceType, ctx, view);
         if (view) {
             const context = await getRemapperContext(app, app.definition.defaultLanguage || defaultLocale, user && {
                 sub: user.id,
                 name: user.name,
                 email: user.primaryEmail,
-                email_verified: Boolean((_c = (_b = user.EmailAuthorizations) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.verified),
+                email_verified: Boolean((_e = (_d = user.EmailAuthorizations) === null || _d === void 0 ? void 0 : _d[0]) === null || _e === void 0 ? void 0 : _e.verified),
                 zoneinfo: user.timezone,
             }, options, ctx);
             ctx.body = resources.map((resource) => remap(resourceDefinition.views[view].remap, resource, context));

package/server/controllers/resources.test.js

@@ -10,6 +10,7 @@ let mockVerifyResourceActionPermission;
 let mockParseQuery;
 let mockGetAppUrl;
 let mockGetAppMessages;
+let mockGetAppVariables;
 let mockCreateAppResourcesWithAssets;
 let mockGetAppAssets;
 let mockCtx;
@@ -22,6 +23,7 @@ describe('createQueryResources', () => {
         mockParseQuery = vi.fn();
         mockGetAppUrl = vi.fn();
         mockGetAppMessages = vi.fn();
+        mockGetAppVariables = vi.fn();
         mockCtx = {
             pathParams: { appId: 1, resourceType: 'mockResourceType' },
             queryParams: { $select: 'field1, field2', $skip: 0, $top: 10 },
@@ -161,11 +163,13 @@ describe('createQueryResources', () => {
         };
         const mockAppUrl = new URL('https://localhost');
         const mockAppMessages = [{ language: 'eng', messages: {} }];
+        const mockAppVariables = [{ name: 'variable', value: 'variable' }];
         mockGetApp.mockResolvedValue(mockApp);
         mockGetAppResources.mockResolvedValue(mockResources);
         mockParseQuery.mockReturnValue(mockParsedQuery);
         mockGetAppUrl.mockResolvedValue(mockAppUrl);
         mockGetAppMessages.mockResolvedValue(mockAppMessages);
+        mockGetAppVariables.mockResolvedValue(mockAppVariables);
         mockCtx.queryParams.view = 'view';
         const options = {
             getApp: mockGetApp,
@@ -174,6 +178,7 @@ describe('createQueryResources', () => {
             parseQuery: mockParseQuery,
             getAppUrl: mockGetAppUrl,
             getAppMessages: mockGetAppMessages,
+            getAppVariables: mockGetAppVariables,
         };
         const resourceDefinition = getResourceDefinition(mockApp, 'mockResourceType', mockCtx, 'view');
         const remapperContext = await getRemapperContext(mockApp, mockApp.definition.defaultLanguage || defaultLocale, null, options, mockCtx);
@@ -305,6 +310,7 @@ describe('createGetResourceById', () => {
         mockVerifyResourceActionPermission = vi.fn();
         mockGetAppUrl = vi.fn();
         mockGetAppMessages = vi.fn();
+        mockGetAppVariables = vi.fn();
         mockCtx = {
             pathParams: { appId: 1, resourceId: 1, resourceType: 'mockResourceType' },
             user: { id: 'mockUserId', name: 'John Doe', primaryEmail: 'john@example.com' },
@@ -403,10 +409,12 @@ describe('createGetResourceById', () => {
         const mockResource = { id: 1 };
         const mockAppUrl = new URL('https://localhost');
         const mockAppMessages = [{ language: 'eng', messages: {} }];
+        const mockAppVariables = [{ name: 'variable', value: 'variable' }];
         mockGetApp.mockResolvedValue(mockApp);
         mockGetAppResource.mockResolvedValue(mockResource);
         mockGetAppUrl.mockResolvedValue(mockAppUrl);
         mockGetAppMessages.mockResolvedValue(mockAppMessages);
+        mockGetAppVariables.mockResolvedValue(mockAppVariables);
         mockCtx.queryParams = { view: 'view' };
         const options = {
             getApp: mockGetApp,
@@ -414,6 +422,7 @@ describe('createGetResourceById', () => {
             verifyResourceActionPermission: mockVerifyResourceActionPermission,
             getAppUrl: mockGetAppUrl,
             getAppMessages: mockGetAppMessages,
+            getAppVariables: mockGetAppVariables,
         };
         const resourceDefinition = getResourceDefinition(mockApp, 'mockResourceType', mockCtx, 'view');
         const remapperContext = await getRemapperContext(mockApp, mockApp.definition.defaultLanguage || defaultLocale, null, options, mockCtx);

package/server/types.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" resolution-mode="require"/>
-import { type App, type AppMember, type AppMessages, type Asset, type BlockDefinition, type BlockManifest, type ControllerDefinition, type EmailActionDefinition, type Resource, type ResourceDefinition, type TeamMember, type Theme as ThemeType, type UserInfo } from '@appsemble/types';
+import { type App, type AppConfigEntry, type AppMember, type AppMessages, type Asset, type BlockDefinition, type BlockManifest, type ControllerDefinition, type EmailActionDefinition, type Resource, type ResourceDefinition, type TeamMember, type Theme as ThemeType, type UserInfo } from '@appsemble/types';
 import { type IdentifiableBlock, type Permission } from '@appsemble/utils';
 import { type RawAxiosRequestConfig } from 'axios';
 import { type Context, type DefaultContext as DefaultContextInterface, type DefaultState, type ParameterizedContext } from 'koa';
@@ -13,6 +13,7 @@ export interface UtilsUser {
         verified: boolean;
     }[];
     subscribed?: boolean;
+    demoLoginUser?: boolean;
 }
 declare module 'koa' {
     interface Request {
@@ -24,6 +25,7 @@ declare module 'koa' {
         appsembleApp: App;
         appBlocks: BlockManifest[];
         appMessages: AppMessages[];
+        appVariables: AppConfigEntry[];
         appMembers: AppMember[];
         appUserInfo: UserInfo;
         appTeams: ExtendedTeam[];
@@ -56,6 +58,7 @@ declare module 'koas-security' {
 declare module 'koas-parameters' {
     interface PathParams {
         appId: number;
+        appPath: string;
         appCollectionId: number;
         appOAuth2SecretId: number;
         appSamlSecretId: number;
@@ -79,6 +82,8 @@ declare module 'koas-parameters' {
         teamId: string;
         token: string;
         appServiceId: number;
+        appSecretId: number;
+        appVariableId: number;
         userId: string;
         memberEmail: string;
         trainingBlockId: number;
@@ -239,6 +244,7 @@ export interface ReloadUserParams {
 export interface ParseQueryParams {
     $filter: string;
     $orderby: string;
+    resourceDefinition: ResourceDefinition;
 }
 export interface GetAppResourceParams extends GetAppSubEntityParams {
     findOptions: FindOptions;
@@ -380,5 +386,6 @@ export interface Options {
     deleteAppAsset: (params: DeleteAppAssetParams) => Promise<number>;
     email: (params: EmailParams) => Promise<void>;
     sendNotifications: (params: SendNotificationsParams) => Promise<void>;
+    getAppVariables: (params: GetAppSubEntityParams) => Promise<AppConfigEntry[]>;
 }
 export {};