@appsemble/utils 0.27.12 → 0.28.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.12/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.28.0/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.27.12/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.12)
+[![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 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.27.12/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.28.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/parameters/appPath.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const appPath: OpenAPIV3.ParameterObject;

package/api/components/parameters/appPath.js

@@ -0,0 +1,8 @@
+export const appPath = {
+    name: 'appPath',
+    in: 'path',
+    description: 'The app-path of the app on which to perform an operation',
+    required: true,
+    schema: { $ref: '#/components/schemas/App/properties/path' },
+};
+//# sourceMappingURL=appPath.js.map

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

@@ -5,6 +5,7 @@ export * from './$team.js';
 export * from './$top.js';
 export * from './$skip.js';
 export * from './appId.js';
+export * from './appPath.js';
 export * from './appOAuth2SecretId.js';
 export * from './appSamlSecretId.js';
 export * from './assetId.js';

package/api/components/parameters/index.js

@@ -5,6 +5,7 @@ export * from './$team.js';
 export * from './$top.js';
 export * from './$skip.js';
 export * from './appId.js';
+export * from './appPath.js';
 export * from './appOAuth2SecretId.js';
 export * from './appSamlSecretId.js';
 export * from './assetId.js';

package/api/paths/apps.js

@@ -142,6 +142,28 @@ export const paths = {
             security: [{ studio: [] }, {}],
         },
     },
+    '/api/apps/path/{appPath}': {
+        parameters: [{ $ref: '#/components/parameters/appPath' }],
+        get: {
+            tags: ['app', 'app-path'],
+            parameters: [
+                {
+                    name: 'language',
+                    schema: { type: 'string' },
+                    description: 'The language to include the translations of, if available',
+                    in: 'query',
+                },
+            ],
+            description: 'Get an app by app-path',
+            operationId: 'getAppByPath',
+            responses: {
+                200: {
+                    description: 'The app that matches the given app path.',
+                    $ref: '#/components/responses/app',
+                },
+            },
+        },
+    },
     '/api/apps/{appId}': {
         parameters: [{ $ref: '#/components/parameters/appId' }],
         get: {
@@ -340,7 +362,7 @@ export const paths = {
         parameters: [{ $ref: '#/components/parameters/appId' }],
         get: {
             tags: ['app', 'export', 'zip'],
-            description: 'Export the app',
+            description: 'Export an app as a zip file',
             operationId: 'exportApp',
             parameters: [
                 {

package/package.json

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

package/reference-schemas/remappers/data.js

@@ -203,6 +203,12 @@ The result of the final page’s log would then be:
             { type: 'string' },
             { type: 'integer' },
             { type: 'array', minItems: 1, items: { anyOf: [{ type: 'string' }, { type: 'integer' }] } },
+            {
+                type: 'array',
+                minItems: 1,
+                items: { $ref: '#/components/schemas/ObjectRemapperDefinition' },
+            },
+            { $ref: '#/components/schemas/ObjectRemapperDefinition' },
         ],
         description: `Gets the chosen property from an object.
 

package/reference-schemas/remappers/dates.js

@@ -26,7 +26,12 @@ ${schemaExample('date.add')}
 `,
     },
     'date.format': {
-        enum: ['string', null],
+        oneOf: [
+            { enum: [null] },
+            {
+                type: 'string',
+            },
+        ],
         description: `Format a date according to the RFC3339 format.
 
 Here is an example of a RFC3339 complicit date:

package/remap.js

@@ -245,13 +245,45 @@ const mapperImplementations = {
         return Array.isArray(input) ? input.filter((value, i) => !indices.has(i)) : [];
     },
     static: (input) => input,
-    prop(prop, obj) {
+    prop(prop, obj, context) {
         let result = obj;
-        for (const p of [prop].flat()) {
-            if (result == null) {
+        if (result == null) {
+            return result;
+        }
+        if (Array.isArray(prop)) {
+            if (prop.every((item) => typeof item === 'number' || typeof item === 'string')) {
+                // This runs if the provided value is an array of property names or indexes
+                for (const p of [prop].flat()) {
+                    result = result[p];
+                }
+            }
+            else if (prop.every((item) => typeof item === 'object' && !Array.isArray(item))) {
+                // This runs if the provided value is an array of remappers
+                const remapped = remap(prop, obj, context);
+                if (typeof remapped === 'number' || typeof remapped === 'string') {
+                    result = result[remapped];
+                }
+                else {
+                    console.error(`Invalid remapper ${JSON.stringify(prop)}`);
+                }
+            }
+        }
+        else if (typeof prop === 'object') {
+            if (prop == null) {
+                result = result.null;
                 return result;
             }
-            result = result[p];
+            // This runs if the provided value is a remapper
+            const remapped = remap(prop, result, context);
+            if (typeof remapped === 'number' || typeof remapped === 'string') {
+                result = result[remapped];
+            }
+            else {
+                console.error(`Invalid remapper ${JSON.stringify(prop)}`);
+            }
+        }
+        else if (typeof prop === 'number' || typeof prop === 'string') {
+            result = result[prop];
         }
         return result;
     },

package/remap.test.js

@@ -888,6 +888,24 @@ describe('prop', () => {
             mappers: [{ prop: 'names' }, { prop: 0 }],
             expected: 'foo',
         },
+        'handle a single remapper': {
+            input: { en: 'English', nl: 'Dutch' },
+            mappers: [{ prop: { app: 'locale' } }],
+            expected: 'English',
+        },
+        'handle an array of remappers': {
+            input: { address: { town: 'Bikini Bottom' } },
+            mappers: [{ prop: [{ 'object.from': { prop: 'address' } }, { prop: 'prop' }] }],
+            expected: { town: 'Bikini Bottom' },
+        },
+        'handle an array of remappers with numbers': {
+            input: { languages: ['English', 'Dutch'] },
+            mappers: [
+                { prop: [{ 'object.from': { prop: 'languages' } }, { prop: 'prop' }] },
+                { prop: 0 },
+            ],
+            expected: 'English',
+        },
         'handle null': {
             input: { name: 'Spongebob' },
             mappers: { prop: null },