@appsemble/utils 0.24.9 → 0.24.12

package/miscellaneous.js

@@ -30,6 +30,9 @@ export function stripNullValues(value, { depth = Number.POSITIVE_INFINITY, ...op
     if (typeof value !== 'object') {
         return value;
     }
+    if (value instanceof Blob) {
+        return value;
+    }
     if (depth <= 0) {
         return value;
     }

package/miscellaneous.test.js

@@ -36,6 +36,18 @@ describe('stripNullValues', () => {
         const input = [, undefined, null];
         expect(stripNullValues(input)).toStrictEqual([]);
     });
+    it('should not remove Blob values', () => {
+        const blob = new Blob([], { type: 'image/jpeg' });
+        const input = {
+            foo: null,
+            bar: blob,
+            baz: 'hello',
+        };
+        expect(stripNullValues(input)).toStrictEqual({
+            bar: blob,
+            baz: 'hello',
+        });
+    });
     it('should remove undefined, and null values from objects', () => {
         const input = {
             foo: null,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.24.9",
+  "version": "0.24.12",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -37,7 +37,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.24.9",
+    "@appsemble/types": "0.24.12",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",

package/reference-schemas/remappers/data.js

@@ -361,6 +361,32 @@ Example:
   "sub": "5c6270e2-ad31-414f-bcab-6752a2c4dcfd",
   "properties": {}
 }
+\`\`\`
+    `,
+    },
+    appMember: {
+        enum: ['userId', 'memberId', 'name', 'primary_email', 'role'],
+        description: `
+> **Note:** For this remapper to work, the user that activated the remapper has to be logged in to
+> the app
+
+Provides some fields of the appMember object. 
+
+- \`userId\`: The id of the user to which the appMember object belongs.
+- \`memberId\`: The id of the appMember object itself. This value should be used when fetching resources created by the current user. 
+- \`primary_email\`: User’s **primary** email address.
+- \`name\`: The user’s name.
+- \`role\`: User's role in the context of the app.
+Example:
+
+\`\`\`json
+{
+  "memberId": "1f433c7a-54ea-466e-89f7-5dbb8f324b12",
+  "name": "Test User"
+  "primaryEmail": "example@hotmail.nl",
+  "role": "Medewerker",
+  "userId": "5c6270e2-ad31-414f-bcab-6752a2c4dcfd"
+}
 \`\`\`
     `,
     },

package/remap.d.ts

@@ -1,4 +1,4 @@
-import { type Remapper, type UserInfo } from '@appsemble/types';
+import { type AppMember, type Remapper, type UserInfo } from '@appsemble/types';
 import { type IntlMessageFormat } from 'intl-messageformat';
 export interface IntlMessage {
     id?: string;
@@ -48,6 +48,10 @@ export interface RemapperContext {
      * A custom context passed to the remap function.
      */
     context: Record<string, any>;
+    /**
+     * The appMember object for the current user in the app.
+     */
+    appMember: AppMember;
 }
 interface InternalContext extends RemapperContext {
     root?: unknown;

package/remap.js

@@ -347,5 +347,6 @@ const mapperImplementations = {
         return message.format() || `{${messageId}}`;
     },
     user: (property, input, context) => { var _a; return (_a = context.userInfo) === null || _a === void 0 ? void 0 : _a[property]; },
+    appMember: (property, input, context) => { var _a, _b; return (_b = (_a = context.userInfo) === null || _a === void 0 ? void 0 : _a.appMember) === null || _b === void 0 ? void 0 : _b[property]; },
 };
 //# sourceMappingURL=remap.js.map

package/remap.test.js

@@ -13,6 +13,7 @@ function runTests(tests) {
             appId: 6789,
             locale: 'en',
             pageData: { hello: 'Page data' },
+            appMember: userInfo === null || userInfo === void 0 ? void 0 : userInfo.appMember,
         });
         expect(result).toStrictEqual(expected);
     });
@@ -234,6 +235,7 @@ describe('log', () => {
                 appId: 6789,
                 locale: 'en',
                 pageData: { hello: 'Page data' },
+                appMember: userInfo === null || userInfo === void 0 ? void 0 : userInfo.appMember,
             });
             expect(console[mappers.log]).toHaveBeenCalledWith(expected);
         });

package/validation.js

@@ -76,6 +76,19 @@ function validateResourceSchemas(definition, report) {
         }
         const { schema } = resource;
         const prefix = ['resources', resourceName, 'schema'];
+        const reservedKeywords = new Set([
+            'created',
+            'updated',
+            'author',
+            'editor',
+            'seed',
+            'ephemeral',
+            'clonable',
+            'expires',
+        ]);
+        if (reservedKeywords.has(resourceName)) {
+            report(schema, 'is a reserved keyword', ['resources', resourceName]);
+        }
         validateJSONSchema(schema, prefix, report);
         if (!('type' in schema)) {
             report(schema, 'must define type object', prefix);

package/validation.test.js

@@ -866,6 +866,96 @@ describe('validateAppDefinition', () => {
             new ValidationError('does not exist in this app’s roles', 'Unknown', undefined, ['roles', 0]),
         ]);
     });
+    it('should validate resource types against reserved keywords', async () => {
+        const app = {
+            name: 'Test app',
+            defaultPage: 'Test Page',
+            pages: [
+                {
+                    name: 'Test Page',
+                    blocks: [],
+                },
+            ],
+            resources: {
+                created: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                updated: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                author: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                editor: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                seed: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                ephemeral: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                clonable: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+                expires: {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                    },
+                },
+            },
+        };
+        const result = await validateAppDefinition(app, () => []);
+        expect(result.valid).toBe(false);
+        expect(result.errors).toStrictEqual([
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'created']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'updated']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'author']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'editor']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'seed']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'ephemeral']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'clonable']),
+            new ValidationError('is a reserved keyword', { type: 'object', properties: { name: { type: 'string' } } }, undefined, ['resources', 'expires']),
+        ]);
+    });
     it('should validate the resource roles exist', async () => {
         const app = createTestApp();
         app.resources.person.roles = ['Unknown'];