@appsemble/utils 0.20.23 → 0.20.25

package/README.md

@@ -1,10 +1,10 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.23/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.25/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.23/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.23)
-[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.23/graph/badge.svg)](https://codecov.io/gl/appsemble/appsemble)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.25/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.25)
+[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.25/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.23/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.25/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/schemas/BasePageDefinition.js

@@ -9,8 +9,7 @@ export const BasePageDefinition = {
             description: `The name of an app.
 
 This field is always required and must be unique within the app, meaning that it is not possible to
-have two pages with the same name. The name of the page is displayed at the top of each page as well
-as in the side navigational menu.
+have two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.
 
 > **Note**: The URL used to navigate to pages is determined by this property.
 `,
@@ -23,7 +22,27 @@ as in the side navigational menu.
             $ref: '#/components/schemas/RemapperDefinition',
             description: `The name of the page when displayed in the navigation menu.
 
-Context property \`name\` can be used to access the name of the page.
+  Context property \`name\` can be used to access the name of the page.
+  `,
+        },
+        hideNavTitle: {
+            type: 'boolean',
+            description: `Whether or not the page should be displayed in navigational menus.
+
+  By default all pages without parameters are added to navigational menus. Set to \`true\` to hide the
+  page from menus.
+  `,
+            default: false,
+        },
+        navigation: {
+            $ref: '#/components/schemas/AppLayoutDefinition/properties/navigation',
+            description: `The type of navigation displayed on the page.
+
+This overrides the navigation property of the app itself. Defaults to \`left-menu\` if navigation or
+App navigation are not set.
+
+Set to \`bottom\` to use a navigation pane at the bottom of the screen instead of the default side
+menu. Set to \`hidden\` to display no navigational menus at all.
 `,
         },
         icon: {
@@ -64,26 +83,6 @@ instructed to contact the app owner to get permissions.
         theme: {
             $ref: '#/components/schemas/Theme',
         },
-        navigation: {
-            $ref: '#/components/schemas/AppLayoutDefinition/properties/navigation',
-            description: `The type of navigation displayed on the page.
-
-This overrides the navigation property of the app itself. Defaults to \`left-menu\` if navigation or
-App navigation are not set.
-
-Set to \`bottom\` to use a navigation pane at the bottom of the screen instead of the default side
-menu. Set to \`hidden\` to display no navigational menus at all.
-`,
-        },
-        hideFromMenu: {
-            type: 'boolean',
-            description: `Whether or not the page should be displayed in navigational menus.
-
-By default all pages without parameters are added to navigational menus. Set to \`true\` to hide the
-page from menus.
-`,
-            default: false,
-        },
     },
 };
 //# sourceMappingURL=BasePageDefinition.js.map

package/api/components/schemas/BasePageDefinition.js.map

@@ -1 +1 @@
-{"version":3,"file":"BasePageDefinition.js","sourceRoot":"","sources":["BasePageDefinition.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,kBAAkB,GAAmC;IAChE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,EAAE;YACb,WAAW,EAAE;;;;;;;CAOlB;SACI;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,oEAAoE;SAClF;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE;;;CAGlB;SACI;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;CAGlB;SACI;QACD,UAAU,EAAE;YACV,IAAI,EAAE,OAAO;YACb,WAAW,EAAE;;;;CAIlB;YACK,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,CAAC;gBACZ,SAAS,EAAE,EAAE;aACd;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,WAAW,EAAE;;;;;;;;CAQlB;YACK,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,4BAA4B;SACnC;QACD,UAAU,EAAE;YACV,IAAI,EAAE,gEAAgE;YACtE,WAAW,EAAE;;;;;;;CAOlB;SACI;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,WAAW,EAAE;;;;CAIlB;YACK,OAAO,EAAE,KAAK;SACf;KACF;CACF,CAAC"}
+{"version":3,"file":"BasePageDefinition.js","sourceRoot":"","sources":["BasePageDefinition.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,kBAAkB,GAAmC;IAChE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,EAAE;YACb,WAAW,EAAE;;;;;;CAMlB;SACI;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,oEAAoE;SAClF;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE;;;GAGhB;SACE;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,WAAW,EAAE;;;;GAIhB;YACG,OAAO,EAAE,KAAK;SACf;QACD,UAAU,EAAE;YACV,IAAI,EAAE,gEAAgE;YACtE,WAAW,EAAE;;;;;;;CAOlB;SACI;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;CAGlB;SACI;QACD,UAAU,EAAE;YACV,IAAI,EAAE,OAAO;YACb,WAAW,EAAE;;;;CAIlB;YACK,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,CAAC;gBACZ,SAAS,EAAE,EAAE;aACd;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,WAAW,EAAE;;;;;;;;CAQlB;YACK,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,4BAA4B;SACnC;KACF;CACF,CAAC"}

package/api/components/schemas/BasePageDefinition.ts

@@ -11,8 +11,7 @@ export const BasePageDefinition: OpenAPIV3.NonArraySchemaObject = {
       description: `The name of an app.
 
 This field is always required and must be unique within the app, meaning that it is not possible to
-have two pages with the same name. The name of the page is displayed at the top of each page as well
-as in the side navigational menu.
+have two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.
 
 > **Note**: The URL used to navigate to pages is determined by this property.
 `,
@@ -25,7 +24,27 @@ as in the side navigational menu.
       $ref: '#/components/schemas/RemapperDefinition',
       description: `The name of the page when displayed in the navigation menu.
 
-Context property \`name\` can be used to access the name of the page.
+  Context property \`name\` can be used to access the name of the page.
+  `,
+    },
+    hideNavTitle: {
+      type: 'boolean',
+      description: `Whether or not the page should be displayed in navigational menus.
+
+  By default all pages without parameters are added to navigational menus. Set to \`true\` to hide the
+  page from menus.
+  `,
+      default: false,
+    },
+    navigation: {
+      $ref: '#/components/schemas/AppLayoutDefinition/properties/navigation',
+      description: `The type of navigation displayed on the page.
+
+This overrides the navigation property of the app itself. Defaults to \`left-menu\` if navigation or
+App navigation are not set.
+
+Set to \`bottom\` to use a navigation pane at the bottom of the screen instead of the default side
+menu. Set to \`hidden\` to display no navigational menus at all.
 `,
     },
     icon: {
@@ -66,25 +85,5 @@ instructed to contact the app owner to get permissions.
     theme: {
       $ref: '#/components/schemas/Theme',
     },
-    navigation: {
-      $ref: '#/components/schemas/AppLayoutDefinition/properties/navigation',
-      description: `The type of navigation displayed on the page.
-
-This overrides the navigation property of the app itself. Defaults to \`left-menu\` if navigation or
-App navigation are not set.
-
-Set to \`bottom\` to use a navigation pane at the bottom of the screen instead of the default side
-menu. Set to \`hidden\` to display no navigational menus at all.
-`,
-    },
-    hideFromMenu: {
-      type: 'boolean',
-      description: `Whether or not the page should be displayed in navigational menus.
-
-By default all pages without parameters are added to navigational menus. Set to \`true\` to hide the
-page from menus.
-`,
-      default: false,
-    },
   },
 };

package/api/schema-tests/PageDefinition/valid/all-properties.yaml

@@ -1,9 +1,9 @@
 # yaml-language-server: $schema=https://appsemble.app/api.json#/components/schemas/PageDefinition
 name: Test page
-hideFromMenu: true
 icon: book
-navigation: bottom
 navTitle: { translate: testPageTitle }
+hideNavTitle: true
+navigation: bottom
 theme:
   primaryColor: '#dfeb08'
 parameters:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.20.23",
+  "version": "0.20.25",
   "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.23",
+    "@appsemble/types": "0.20.25",
     "axios": "^0.27.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",