@appsemble/utils 0.23.7 → 0.23.9

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.23.7/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.23.9/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.23.7/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.23.7)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.23.9/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.23.9)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.23.7/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.23.9/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/schemas/ActionDefinition.js

@@ -75,6 +75,7 @@ export const ActionDefinition = {
                 { $ref: '#/components/schemas/UserLoginActionDefinition' },
                 { $ref: '#/components/schemas/UserLogoutActionDefinition' },
                 { $ref: '#/components/schemas/UserRegisterActionDefinition' },
+                { $ref: '#/components/schemas/UserCreateActionDefinition' },
                 { $ref: '#/components/schemas/UserUpdateActionDefinition' },
             ],
         },

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

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

package/api/components/schemas/UserCreateActionDefinition.js

@@ -0,0 +1,33 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const UserCreateActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['email', 'password'],
+    properties: {
+        type: {
+            enum: ['user.create'],
+            description: `Allows the user to create a new account using an email address and a password.
+
+Does nothing if the user is already logged in.`,
+        },
+        password: {
+            description: 'The password to login with.',
+        },
+        email: {
+            description: 'The email to login with.',
+        },
+        displayName: {
+            description: 'The display name of the user.',
+        },
+        properties: {
+            description: `The custom properties for the user.
+
+Every value will be converted to a string.`,
+        },
+        role: {
+            description: "The role for the created account. Defaults to the default role in the app's security definition.",
+        },
+    },
+});
+//# sourceMappingURL=UserCreateActionDefinition.js.map

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

@@ -121,6 +121,7 @@ export * from './UserEmail.js';
 export * from './UserLogoutActionDefinition.js';
 export * from './UserLoginActionDefinition.js';
 export * from './UserRegisterActionDefinition.js';
+export * from './UserCreateActionDefinition.js';
 export * from './UserUpdateActionDefinition.js';
 export * from './LoopPageDefinition.js';
 export * from './LoopPageActionsDefinition.js';

package/api/components/schemas/index.js

@@ -121,6 +121,7 @@ export * from './UserEmail.js';
 export * from './UserLogoutActionDefinition.js';
 export * from './UserLoginActionDefinition.js';
 export * from './UserRegisterActionDefinition.js';
+export * from './UserCreateActionDefinition.js';
 export * from './UserUpdateActionDefinition.js';
 export * from './LoopPageDefinition.js';
 export * from './LoopPageActionsDefinition.js';

package/api/index.js

@@ -10,22 +10,34 @@ export * as schemas from './components/schemas/index.js';
  * @returns The OpenAPI document for Appsemble.
  */
 export function api(version, { port = 9999, ssl, host = `${ssl ? 'https' : 'http'}://localhost:${port}` } = {}) {
+    let hostToBeLogged = host;
+    if (port) {
+        const splitHost = hostToBeLogged.split(':');
+        if (Number.isNaN(Number(splitHost.at(-1))) === false) {
+            splitHost[splitHost.length - 1] = String(port);
+            hostToBeLogged = splitHost.join(':');
+        }
+        else {
+            splitHost.push(String(port));
+            hostToBeLogged = splitHost.join(':');
+        }
+    }
     return {
         openapi: '3.0.2',
         components,
         externalDocs: {
             description: 'Appsemble developer documentation',
-            url: `${host}/docs`,
+            url: `${hostToBeLogged}/docs`,
         },
         info: {
             title: 'Appsemble',
             description: `Welcome to the Appsemble API.
 
 The app studio can be found on
-> ${host}
+> ${hostToBeLogged}
 
 The OpenAPI explorer can be found on
-> ${host}/api-explorer
+> ${hostToBeLogged}/api-explorer
 `,
             license: {
                 name: 'LGPL',

package/api/paths/apps.js

@@ -241,6 +241,10 @@ export const paths = {
                                     type: 'boolean',
                                     description: 'Whether the Appsemble OAuth2 login method should be shown.',
                                 },
+                                enableSelfRegistration: {
+                                    type: 'boolean',
+                                    description: 'Whether new users should be able to register themselves.',
+                                },
                                 emailName: {
                                     type: 'string',
                                     description: 'The name used for emails.',

package/api/paths/user.js

@@ -352,6 +352,55 @@ export const paths = {
             },
         },
     },
+    '/api/user/apps/{appId}/accounts': {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        post: {
+            tags: ['appMember'],
+            description: 'Create a new app account using an email address and a password.',
+            operationId: 'createMemberEmail',
+            security: [{ app: [] }],
+            requestBody: {
+                description: 'The user account to create.',
+                required: true,
+                content: {
+                    'multipart/form-data': {
+                        schema: {
+                            type: 'object',
+                            required: ['email', 'password', 'timezone'],
+                            properties: {
+                                name: {
+                                    type: 'string',
+                                },
+                                email: {
+                                    type: 'string',
+                                    format: 'email',
+                                },
+                                password: {
+                                    type: 'string',
+                                    minLength: 8,
+                                },
+                                properties: {
+                                    type: 'object',
+                                    additionalProperties: { type: 'string' },
+                                    description: 'The member’s custom properties.',
+                                },
+                                timezone: { type: 'string' },
+                                role: {
+                                    type: 'string',
+                                    description: "The role for the created account. Defaults to the default role in the app's security definition.",
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            responses: {
+                201: {
+                    description: 'The account that was created.',
+                },
+            },
+        },
+    },
     '/api/user/apps/{appId}/account/verify': {
         parameters: [{ $ref: '#/components/parameters/appId' }],
         post: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.23.7",
+  "version": "0.23.9",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -37,7 +37,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.23.7",
+    "@appsemble/types": "0.23.9",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",
@@ -59,7 +59,7 @@
     "@types/lcm": "^0.0.2",
     "bulma": "0.9.3",
     "koas-core": "^0.7.0",
-    "vitest": "^0.34.0",
+    "vitest": "^1.0.0",
     "yaml": "^2.0.0"
   },
   "engines": {

package/reference-schemas/remappers/arrays.js

@@ -167,6 +167,31 @@ remapper is a filtered list:
 ]
 \`\`\`
     `,
+    },
+    'array.find': {
+        $ref: '#/components/schemas/RemapperDefinition',
+        description: `
+Returns a single object or value from an array based on the given condition.
+
+For example:
+
+Input:
+
+\`\`\`json
+[{ name: "Craig" }, { name: "Joey" }, { name: "Stuart" }]
+\`\`\`
+\`\`\`yaml
+array.find:
+  equals: [{ prop: "name" }, "Craig" ]
+\`\`\`
+
+Result:
+
+\`\`\`json
+{ name: "Craig" }
+\`\`\`
+
+`,
     },
     'array.from': {
         type: 'array',

package/remap.js

@@ -209,6 +209,22 @@ const mapperImplementations = {
         });
     },
     array: (prop, input, context) => { var _a; return (_a = context.array) === null || _a === void 0 ? void 0 : _a[prop]; },
+    'array.find'(mapper, input, context) {
+        var _a;
+        if (!Array.isArray(input)) {
+            console.error(`${input} is not an array!`);
+            return null;
+        }
+        return ((_a = input === null || input === void 0 ? void 0 : input.find((item) => {
+            const remapped = remap(mapper, item, context);
+            switch (typeof remapped) {
+                case 'boolean':
+                    return remap(mapper, item, context) ? item : null;
+                default:
+                    return equal(remapped, item) ? item : null;
+            }
+        })) !== null && _a !== void 0 ? _a : null);
+    },
     'array.from': (mappers, input, context) => mappers.map((mapper) => remap(mapper, input, context)),
     'array.append': (mappers, input, context) => Array.isArray(input)
         ? input.concat(mappers.map((mapper) => remap(mapper, input, context)))

package/remap.test.js

@@ -764,6 +764,25 @@ describe('array', () => {
         },
     });
 });
+describe('array.find', () => {
+    runTests({
+        'return object with specified value from array': {
+            input: [{ name: 'Craig' }, { name: 'Joey' }, { name: 'Stuart' }],
+            mappers: [{ 'array.find': { equals: [{ prop: 'name' }, 'Craig'] } }],
+            expected: { name: 'Craig' },
+        },
+        'return undefined when condition doesn’t match anything': {
+            input: [{ name: 'Craig' }],
+            mappers: [{ 'array.find': { equals: [{ prop: 'name' }, 'foo'] } }],
+            expected: null,
+        },
+        'return single value when the array does not include objects': {
+            input: ['Craig', 'Stuart'],
+            mappers: [{ 'array.find': 'Craig' }],
+            expected: 'Craig',
+        },
+    });
+});
 describe('array.from', () => {
     runTests({
         'create new array with remapped values': {