@appsemble/utils 0.27.9 → 0.27.11

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.9/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.11/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.9/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.9)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.27.11/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.11)
 [![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.9/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.27.11/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/parameters/$skip.d.ts

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

package/api/components/parameters/$skip.js

@@ -0,0 +1,7 @@
+export const $skip = {
+    name: '$skip',
+    in: 'query',
+    description: 'Start the query from an offset.',
+    schema: { type: 'integer', minimum: 0 },
+};
+//# sourceMappingURL=$skip.js.map

package/api/components/parameters/$top.js

@@ -2,7 +2,6 @@ export const $top = {
     name: '$top',
     in: 'query',
     description: 'Limit the number of entities returned.',
-    // XXX The type should be integer. This doesn’t work due to an upstream bug in Koas.
-    schema: { type: 'string' },
+    schema: { type: 'integer', minimum: 0 },
 };
 //# sourceMappingURL=$top.js.map

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

@@ -3,6 +3,7 @@ export * from './$orderby.js';
 export * from './$select.js';
 export * from './$team.js';
 export * from './$top.js';
+export * from './$skip.js';
 export * from './appId.js';
 export * from './appOAuth2SecretId.js';
 export * from './appSamlSecretId.js';
@@ -15,6 +16,7 @@ export * from './organizationId.js';
 export * from './resourceId.js';
 export * from './resourceType.js';
 export * from './screenshotId.js';
+export * from './readmeId.js';
 export * from './appServiceId.js';
 export * from './view.js';
 export * from './trainingId.js';

package/api/components/parameters/index.js

@@ -3,6 +3,7 @@ export * from './$orderby.js';
 export * from './$select.js';
 export * from './$team.js';
 export * from './$top.js';
+export * from './$skip.js';
 export * from './appId.js';
 export * from './appOAuth2SecretId.js';
 export * from './appSamlSecretId.js';
@@ -15,6 +16,7 @@ export * from './organizationId.js';
 export * from './resourceId.js';
 export * from './resourceType.js';
 export * from './screenshotId.js';
+export * from './readmeId.js';
 export * from './appServiceId.js';
 export * from './view.js';
 export * from './trainingId.js';

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

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

package/api/components/parameters/readmeId.js

@@ -0,0 +1,8 @@
+export const readmeId = {
+    name: 'readmeId',
+    in: 'path',
+    description: 'The id of an app readme',
+    required: true,
+    schema: { type: 'number' },
+};
+//# sourceMappingURL=readmeId.js.map

package/api/components/parameters/screenshotId.js

@@ -1,7 +1,7 @@
 export const screenshotId = {
     name: 'screenshotId',
     in: 'path',
-    description: 'The ID of the app an app screenshot',
+    description: 'The id of an app screenshot',
     required: true,
     schema: { type: 'number' },
 };

package/api/components/schemas/App.js

@@ -77,7 +77,7 @@ This doesn’t affect whether or not the app can be accessed on its own domain.
             description: `
 A long description for the app.
 
-The long desciption will be rendered on the app details page. Markdown content is supported.
+The long description will be rendered on the app details page. Markdown content is supported.
 `,
         },
         definition: { $ref: '#/components/schemas/AppDefinition' },

package/api/components/schemas/BlockDefinition.js

@@ -32,7 +32,13 @@ will remain the same until it is manually updated.
 `,
         },
         layout: {
-            description: 'An override of the block’s default.',
+            description: `An override of the block’s default layout.
+
+\`float\` sets the block position to float on the page and does not collide with other blocks.
+Layout float can be combined with the \`position\` property to place the block on the desired location.
+\`grow\` adds space between blocks so the page is filled.
+\`static\` on the contrary, does not add extra space between blocks.
+`,
             enum: ['float', 'grow', 'static'],
         },
         header: {
@@ -50,7 +56,7 @@ If a user does not have the right role, the block is not rendered.
             },
         },
         position: {
-            description: 'For floating blocks this propert defines where the block should float.',
+            description: 'For floating blocks this property defines where the block should float.',
             default: 'bottom right',
             enum: [
                 'top left',

package/api/paths/appCollections.js

@@ -283,6 +283,14 @@ export const paths = {
                         $ref: '#/components/schemas/AppCollection/properties/id',
                     },
                 },
+                {
+                    name: 'language',
+                    in: 'query',
+                    description: 'The language to include the translations of, if available',
+                    schema: {
+                        type: 'string',
+                    },
+                },
             ],
             responses: {
                 200: {

package/api/paths/apps.js

@@ -35,9 +35,6 @@ export const paths = {
                                 demoMode: {
                                     $ref: '#/components/schemas/App/properties/demoMode',
                                 },
-                                longDescription: {
-                                    $ref: '#/components/schemas/App/properties/longDescription',
-                                },
                                 yaml: {
                                     type: 'string',
                                     description: 'The original YAML definition used to define the app.',
@@ -76,6 +73,14 @@ export const paths = {
                                         format: 'binary',
                                     },
                                 },
+                                readmes: {
+                                    type: 'array',
+                                    description: 'Readmes to showcase in the store',
+                                    items: {
+                                        type: 'string',
+                                        format: 'binary',
+                                    },
+                                },
                                 controllerCode: {
                                     type: 'string',
                                     description: 'Custom app logic as a JavaScript string',
@@ -184,9 +189,6 @@ export const paths = {
                                 demoMode: {
                                     $ref: '#/components/schemas/App/properties/demoMode',
                                 },
-                                longDescription: {
-                                    $ref: '#/components/schemas/App/properties/longDescription',
-                                },
                                 force: {
                                     type: 'boolean',
                                     description: 'Whether the locked property should be ignored.',
@@ -225,6 +227,14 @@ export const paths = {
                                         format: 'binary',
                                     },
                                 },
+                                readmes: {
+                                    type: 'array',
+                                    description: 'Readmes to showcase in the store',
+                                    items: {
+                                        type: 'string',
+                                        format: 'binary',
+                                    },
+                                },
                                 controllerCode: {
                                     type: 'string',
                                     description: 'Custom app logic as a JavaScript string',
@@ -345,6 +355,18 @@ export const paths = {
                     description: 'Whether to include assets in the export file',
                     in: 'query',
                 },
+                {
+                    name: 'screenshots',
+                    schema: { type: 'boolean' },
+                    description: 'Whether to include screenshots in the export file',
+                    in: 'query',
+                },
+                {
+                    name: 'readmes',
+                    schema: { type: 'boolean' },
+                    description: 'Whether to include readmes in the export file',
+                    in: 'query',
+                },
             ],
             responses: {
                 200: {
@@ -984,6 +1006,22 @@ This will return a 404 if the user has not uploaded one.`,
             security: [{ studio: [] }, { cli: ['apps:write'] }],
         },
     },
+    '/api/apps/{appId}/readmes/{readmeId}': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            { $ref: '#/components/parameters/readmeId' },
+        ],
+        get: {
+            tags: ['app'],
+            description: 'Get a readme of an app.',
+            operationId: 'getAppReadme',
+            responses: {
+                200: {
+                    description: 'The app readme',
+                },
+            },
+        },
+    },
     '/api/apps/{appId}/style/core': {
         parameters: [{ $ref: '#/components/parameters/appId' }],
         get: {

package/api/paths/assets.js

@@ -66,7 +66,10 @@ export const paths = {
             tags: ['asset'],
             description: 'Get all of the app’s assets.',
             operationId: 'getAssets',
-            parameters: [{ $ref: '#/components/parameters/$top' }],
+            parameters: [
+                { $ref: '#/components/parameters/$skip' },
+                { $ref: '#/components/parameters/$top' },
+            ],
             responses: {
                 200: {
                     description: 'The assets associated with the app.',

package/api/paths/resources.js

@@ -87,6 +87,7 @@ export const paths = {
                 { $ref: '#/components/parameters/$filter' },
                 { $ref: '#/components/parameters/$orderby' },
                 { $ref: '#/components/parameters/$select' },
+                { $ref: '#/components/parameters/$skip' },
                 { $ref: '#/components/parameters/$top' },
                 { $ref: '#/components/parameters/$team' },
             ],

package/constants/patterns.d.ts

@@ -35,3 +35,7 @@ export declare const uuid4Pattern: RegExp;
  * A pattern which matches a JSON web token.
  */
 export declare const jwtPattern: RegExp;
+/**
+ * A pattern which matches an ISO 8601 datetime string.
+ */
+export declare const ISODateTimePattern: RegExp;

package/constants/patterns.js

@@ -35,4 +35,8 @@ export const uuid4Pattern = /^[\d[a-f]{8}-[\da-f]{4}-4[\da-f]{3}-[\da-f]{4}-[\d[
  * A pattern which matches a JSON web token.
  */
 export const jwtPattern = /^[\w-]+(?:\.[\w-]+){2}$/;
+/**
+ * A pattern which matches an ISO 8601 datetime string.
+ */
+export const ISODateTimePattern = /\d{4}(.\d{2}){2}(\s|T)(\d{2}.){2}\d{2}/;
 //# sourceMappingURL=patterns.js.map

package/package.json

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

package/validation.test.js

@@ -1581,6 +1581,58 @@ describe('validateAppDefinition', () => {
             ]),
         ]);
     });
+    it('should be valid if to is (remapper) object; considered as dynamic link', async () => {
+        const app = createTestApp();
+        app.pages[0].blocks.push({
+            type: 'test',
+            version: '1.2.3',
+            actions: {
+                onWhatever: {
+                    type: 'link',
+                    to: { static: 'test' },
+                },
+            },
+        });
+        const result = await validateAppDefinition(app, () => [
+            {
+                name: '@appsemble/test',
+                version: '1.2.3',
+                files: [],
+                languages: [],
+                actions: {
+                    onWhatever: {},
+                },
+            },
+        ]);
+        expect(result.valid).toBe(true);
+        expect(result.errors).toStrictEqual([]);
+    });
+    it('should be valid if to is array of (remapper) objects; considered as dynamic link', async () => {
+        const app = createTestApp();
+        app.pages[0].blocks.push({
+            type: 'test',
+            version: '1.2.3',
+            actions: {
+                onWhatever: {
+                    type: 'link',
+                    to: [{ static: 'test' }],
+                },
+            },
+        });
+        const result = await validateAppDefinition(app, () => [
+            {
+                name: '@appsemble/test',
+                version: '1.2.3',
+                files: [],
+                languages: [],
+                actions: {
+                    onWhatever: {},
+                },
+            },
+        ]);
+        expect(result.valid).toBe(true);
+        expect(result.errors).toStrictEqual([]);
+    });
     it('should report an error if user actions are used without a security definition', async () => {
         const { security, ...app } = createTestApp();
         app.pages[0].blocks.push({