@appsemble/utils 0.20.32 → 0.20.33

package/README.md

@@ -1,10 +1,10 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.32/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.33/config/assets/logo.svg) Appsemble Utilities
 
 > Internal utility functions used across multiple Appsemble projects.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/utils)](https://www.npmjs.com/package/@appsemble/utils)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.32/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.32)
-[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.32/graph/badge.svg)](https://codecov.io/gl/appsemble/appsemble)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.33/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.33)
+[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.33/graph/badge.svg)](https://codecov.io/gl/appsemble/appsemble)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Installation
@@ -21,5 +21,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.32/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.33/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/schemas/ActionDefinition.js

@@ -44,6 +44,7 @@ export const ActionDefinition = {
                 { $ref: '#/components/schemas/LogActionDefinition' },
                 { $ref: '#/components/schemas/MessageActionDefinition' },
                 { $ref: '#/components/schemas/NoopActionDefinition' },
+                { $ref: '#/components/schemas/NotifyActionDefinition' },
                 { $ref: '#/components/schemas/RequestActionDefinition' },
                 { $ref: '#/components/schemas/ResourceCountActionDefinition' },
                 { $ref: '#/components/schemas/ResourceCreateActionDefinition' },

package/api/components/schemas/AppDefinition.js

@@ -39,13 +39,15 @@ This will be displayed on the app store.
             description: 'Properties related to the layout of the app.',
         },
         notifications: {
-            enum: ['opt-in', 'startup'],
+            enum: ['login', 'opt-in', 'startup'],
             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
 app details page in Appsemble Studio. Setting this to \`opt-in\` allows for users to opt into
 receiving push notifications by pressing the subscribe button in the App settings page. Setting this
 to \`startup\` will cause Appsemble to immediately request for the permission upon opening the app.
+If this is set to \`login\`, the app will request permissions for push notification once the user
+logs in.
 
 > **Note**: Setting \`notifications\` to \`startup\` is not recommended, due to its invasive nature.
 `,

package/api/components/schemas/NotifyActionDefinition.d.ts

@@ -0,0 +1 @@
+export declare const NotifyActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/NotifyActionDefinition.js

@@ -0,0 +1,32 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const NotifyActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'title', 'body', 'to'],
+    properties: {
+        type: {
+            enum: ['notify'],
+            description: 'Send notifications to one or all the users of an app.',
+        },
+        title: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The title of the notification.',
+        },
+        body: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The description of the notification.',
+        },
+        to: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: `To whom the notification should be sent.
+
+Use \`all\` to send the notification to all app subscribed users.
+Or notify specific users by passing either a single user id or an array of user ids.
+
+Nothing is sent if the value is **not** a valid user id.
+`,
+        },
+    },
+});
+//# sourceMappingURL=NotifyActionDefinition.js.map

package/api/components/schemas/index.d.ts

@@ -56,6 +56,7 @@ export * from './MessageActionDefinition.js';
 export * from './NoopActionDefinition.js';
 export * from './NotificationHookDataDefinition.js';
 export * from './NotificationHookDefinition.js';
+export * from './NotifyActionDefinition.js';
 export * from './OAuth2AuthorizationCode.js';
 export * from './OAuth2ClientCredentials.js';
 export * from './ObjectRemapperDefinition.js';

package/api/components/schemas/index.js

@@ -56,6 +56,7 @@ export * from './MessageActionDefinition.js';
 export * from './NoopActionDefinition.js';
 export * from './NotificationHookDataDefinition.js';
 export * from './NotificationHookDefinition.js';
+export * from './NotifyActionDefinition.js';
 export * from './OAuth2AuthorizationCode.js';
 export * from './OAuth2ClientCredentials.js';
 export * from './ObjectRemapperDefinition.js';

package/api/paths/apps.js

@@ -444,7 +444,7 @@ export const paths = {
                     description: 'The subscription has successfully been registered.',
                 },
             },
-            security: [{ studio: [] }, {}],
+            security: [{ app: ['openid'] }, {}],
         },
         patch: {
             tags: ['app'],
@@ -484,7 +484,7 @@ export const paths = {
                     description: 'The subscription has successfully been updated.',
                 },
             },
-            security: [{ studio: [] }, {}],
+            security: [{ app: ['openid'] }, {}],
         },
     },
     '/api/apps/{appId}/members': {

package/blockUtils.js

@@ -25,7 +25,6 @@ export function stripBlockName(name) {
     }
     return name;
 }
-// eslint-disable-next-line jsdoc/require-returns-check
 /**
  * Parse a block name into a tuple of organization id and block id.
  *

package/formatRequestAction.d.ts

@@ -1,3 +1,3 @@
 import { Remapper, RequestLikeActionDefinition } from '@appsemble/types';
-import { AxiosRequestConfig } from 'axios';
-export declare function formatRequestAction({ method, query, ...action }: RequestLikeActionDefinition, data: unknown, remap: (remapper: Remapper, data: any, context: Record<string, unknown>) => any, context: Record<string, unknown>): AxiosRequestConfig;
+import { RawAxiosRequestConfig } from 'axios';
+export declare function formatRequestAction({ method, query, ...action }: RequestLikeActionDefinition, data: unknown, remap: (remapper: Remapper, data: any, context: Record<string, unknown>) => any, context: Record<string, unknown>): RawAxiosRequestConfig;

package/jsonschema.js

@@ -1,6 +1,5 @@
 import lcm from 'lcm';
 import { mapValues } from './mapValues.js';
-// eslint-disable-next-line jsdoc/require-returns-check
 /**
  * Generate data based on a JSON schema.
  *

package/miscellaneous.js

@@ -16,7 +16,6 @@ export function identity(data) {
 export function rethrow(data) {
     throw data;
 }
-// eslint-disable-next-line jsdoc/require-returns-check
 /**
  * Strip all null, undefined, and empty array values from an object.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.20.32",
+  "version": "0.20.33",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -31,7 +31,7 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest"
   },
   "dependencies": {
-    "@appsemble/types": "0.20.32",
+    "@appsemble/types": "0.20.33",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",

package/validation.js

@@ -224,9 +224,12 @@ function checkCyclicRoleInheritance(roles, name, report) {
  * @param report A function used to report a value.
  */
 function validateSecurity(definition, report) {
-    const { security } = definition;
+    const { notifications, security } = definition;
     const defaultAllow = ['$none', '$public', '$team:member', '$team:manager'];
     if (!security) {
+        if (notifications === 'login') {
+            report(notifications, 'only works if security is defined', ['notifications']);
+        }
         return;
     }
     const checkRoleExists = (name, path, allow = defaultAllow) => {

package/validation.test.js

@@ -701,6 +701,18 @@ describe('validateAppDefinition', () => {
         const result = await validateAppDefinition(app, () => []);
         expect(result.valid).toBe(true);
     });
+    it('should report if notifications is "login" without a security definition', async () => {
+        const app = createTestApp();
+        delete app.security;
+        app.notifications = 'login';
+        const result = await validateAppDefinition(app, () => []);
+        expect(result.valid).toBe(false);
+        expect(result.errors).toStrictEqual([
+            new ValidationError('only works if security is defined', 'login', undefined, [
+                'notifications',
+            ]),
+        ]);
+    });
     it('should validate the default role exists', async () => {
         const app = createTestApp();
         app.security.default.role = 'Unknown';