@appsemble/lang-sdk 0.40.9 → 0.40.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/lang-sdk",
-  "version": "0.40.9",
+  "version": "0.40.10",
   "description": "Language SDK for Appsemble",
   "keywords": [
     "app",

package/schemas/AppDefinition.js

@@ -27,7 +27,27 @@ This will be displayed on the app store.
             description: 'Properties related to the layout of the app.',
         },
         notifications: {
-            enum: ['login', 'opt-in', 'startup'],
+            oneOf: [
+                { enum: ['login', 'opt-in', 'startup'] },
+                {
+                    type: 'object',
+                    required: ['roles'],
+                    additionalProperties: false,
+                    properties: {
+                        default: {
+                            enum: ['login', 'none', 'opt-in', 'startup'],
+                            description: `The strategy for roles that aren’t listed in \`roles\`, and for users without
+a role. Defaults to \`none\`.`,
+                        },
+                        roles: {
+                            type: 'object',
+                            minProperties: 1,
+                            description: 'The strategy per role.',
+                            additionalProperties: { enum: ['login', 'none', 'opt-in'] },
+                        },
+                    },
+                },
+            ],
             description: `The strategy to use for apps to subscribe to push notifications.
 
 If specified, push notifications can be sent to subscribed users via the _Notifications_ tab in the
@@ -37,6 +57,10 @@ to \`startup\` will cause Appsemble to immediately request for the permission up
 If this is set to \`login\`, the app will request permissions for push notification once the user
 logs in.
 
+To use a different strategy per role, set \`roles\` to a map of role names to \`login\`, \`opt-in\`, or
+\`none\`. Roles that aren’t listed use \`default\`. A member with several roles gets the most eager
+strategy of those roles. Only roles assigned to the member count, not roles they inherit.
+
 > **Note**: Setting \`notifications\` to \`startup\` is not recommended, due to its invasive nature.
 `,
         },

package/schemas/actions/EmailActionDefinition.js

@@ -42,7 +42,7 @@ If \`to\`, \`cc\`, and \`bcc\` all end up being empty, no emails will be sent bu
 
 The remapper must resolve to an object containing the following properties:
 
-- \`target\`: The asset ID or link to download contents from to add as an attachment. This is mutually exclusive with \`content\`.
+- \`target\`: The asset ID or link to download contents from to add as an attachment. This is mutually exclusive with \`content\`. The files downloaded from links may total at most 25 MiB per email.
 - \`content\`: The raw content to include as the file content. This is mutually exclusive with \`target\`.
 - \`filename\`: The filename to include the attachment as.
 - \`accept\` If the target is a URL, this will be set as the HTTP \`Accept\` header when downloading the file.

package/types/core.d.ts

@@ -184,9 +184,19 @@ export interface AppDefinition {
     /**
      * The strategy to use for apps to subscribe to push notifications.
      *
-     * If this is omitted, push notifications can not be sent.
+     * Either one strategy for all app members, or a strategy per role. If this is omitted, push
+     * notifications can not be sent.
      */
-    notifications?: 'login' | 'opt-in' | 'startup';
+    notifications?: 'login' | 'opt-in' | 'startup' | {
+        /**
+         * The strategy for roles that aren't listed in `roles`, and for users without a role.
+         */
+        default?: 'login' | 'none' | 'opt-in' | 'startup';
+        /**
+         * The strategy per role.
+         */
+        roles: Record<AppRole, 'login' | 'none' | 'opt-in'>;
+    };
     /**
      * The pages of the app.
      */

package/validation.js

@@ -97,7 +97,7 @@ function validateUniquePageNames(definition, report) {
                 pageNames.set(normalizedPageName, [pagePath]);
             }
             if (page.type === 'container') {
-                checkPages(page.pages, pagePath);
+                checkPages(page.pages ?? [], pagePath);
             }
         }
     }
@@ -122,7 +122,7 @@ function iterPageParents(pages, onParent, prefix = ['pages']) {
             onParent(entry, Array.isArray(page.parent) ? [...pagePath, 'parent', entryIndex] : [...pagePath, 'parent'], page);
         }
         if (page.type === 'container') {
-            iterPageParents(page.pages, onParent, [...pagePath, 'pages']);
+            iterPageParents(page.pages ?? [], onParent, [...pagePath, 'pages']);
         }
     }
 }
@@ -703,7 +703,7 @@ function validateGridLayout(definition, report) {
             // Flow page
             if (page.type === 'flow') {
                 const flowPage = page;
-                const steps = flowPage.steps.map((step, stepId) => [
+                const steps = (flowPage.steps ?? []).map((step, stepId) => [
                     step,
                     [...path, 'steps', stepId],
                 ]);
@@ -1122,8 +1122,9 @@ function validateSecurity(definition, report) {
             checkRoleExists(role, [...path, 'roles', index], ['$guest', ...predefinedRoles]);
         }
     };
+    const notificationRoles = notifications && typeof notifications === 'object' ? notifications.roles : undefined;
     if (!security) {
-        if (notifications === 'login') {
+        if (notifications === 'login' || notificationRoles) {
             report(notifications, 'only works if security is defined', ['notifications']);
         }
         return;
@@ -1224,6 +1225,11 @@ function validateSecurity(definition, report) {
             }
         });
     }
+    if (notificationRoles) {
+        for (const role of Object.keys(notificationRoles)) {
+            checkRoleExists(role, ['notifications', 'roles', role]);
+        }
+    }
     const { hideGroupDropdown } = definition.layout ?? {};
     if (Array.isArray(hideGroupDropdown)) {
         for (const [index, role] of hideGroupDropdown.entries()) {
@@ -1819,6 +1825,9 @@ export async function validateAppDefinition(definition, getBlockVersions, contro
     const report = (instance, message, path) => {
         result.errors.push(new ValidationError(message, instance, undefined, path));
     };
+    const reportUnexpectedError = (error) => {
+        report(null, `Unexpected error: ${error instanceof Error ? error.message : error}`, []);
+    };
     try {
         // IMPORTANT: Create a deep copy to prevent validation logic from mutating the original definition.
         // The imperative/procedural-style algorithms below (e.g., in validateActions) build up arrays
@@ -1834,27 +1843,36 @@ export async function validateAppDefinition(definition, getBlockVersions, contro
             }
             blockVersionMap.get(version.name).set(version.version, version);
         }
-        validateController(clonedDefinition, controllerImplementations, report);
-        validateCronJobs(clonedDefinition, report);
-        validateDefaultPage(clonedDefinition, report);
-        validateHooks(clonedDefinition, report);
-        validateIcons(clonedDefinition, report);
-        validateIconReferences(clonedDefinition, blockVersionMap, report);
-        validateLanguage(clonedDefinition, report);
-        validateResourceReferences(clonedDefinition, report);
-        validateMembersSchema(clonedDefinition, report);
-        validatePageParents(clonedDefinition, report);
-        validatePhoneNumberDefinition(clonedDefinition, report);
-        validateResourceSchemas(clonedDefinition, report);
-        validateSecurity(clonedDefinition, report);
-        validateBlocks(clonedDefinition, blockVersionMap, report);
-        validateActions(clonedDefinition, report);
-        validateEvents(clonedDefinition, blockVersionMap, report);
-        validateUniquePageNames(clonedDefinition, report);
-        validateGridLayout(clonedDefinition, report);
+        // Run each check on its own, so a check that fails does not keep the others from reporting.
+        const check = (validate) => {
+            try {
+                validate();
+            }
+            catch (error) {
+                reportUnexpectedError(error);
+            }
+        };
+        check(() => validateController(clonedDefinition, controllerImplementations, report));
+        check(() => validateCronJobs(clonedDefinition, report));
+        check(() => validateDefaultPage(clonedDefinition, report));
+        check(() => validateHooks(clonedDefinition, report));
+        check(() => validateIcons(clonedDefinition, report));
+        check(() => validateIconReferences(clonedDefinition, blockVersionMap, report));
+        check(() => validateLanguage(clonedDefinition, report));
+        check(() => validateResourceReferences(clonedDefinition, report));
+        check(() => validateMembersSchema(clonedDefinition, report));
+        check(() => validatePageParents(clonedDefinition, report));
+        check(() => validatePhoneNumberDefinition(clonedDefinition, report));
+        check(() => validateResourceSchemas(clonedDefinition, report));
+        check(() => validateSecurity(clonedDefinition, report));
+        check(() => validateBlocks(clonedDefinition, blockVersionMap, report));
+        check(() => validateActions(clonedDefinition, report));
+        check(() => validateEvents(clonedDefinition, blockVersionMap, report));
+        check(() => validateUniquePageNames(clonedDefinition, report));
+        check(() => validateGridLayout(clonedDefinition, report));
     }
     catch (error) {
-        report(null, `Unexpected error: ${error instanceof Error ? error.message : error}`, []);
+        reportUnexpectedError(error);
     }
     return result;
 }