@appsemble/lang-sdk 0.34.10 → 0.34.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/lang-sdk",
-  "version": "0.34.10",
+  "version": "0.34.12",
   "description": "Language SDK for Appsemble",
   "keywords": [
     "app",

package/reference-schemas/remappers/data.js

@@ -323,6 +323,7 @@ parameters:
             'zoneinfo',
             'role',
             'properties',
+            'phoneNumber',
         ],
         description: `
 > **Note:** For this remapper to work, the app member that activated the remapper has to be logged in to
@@ -340,6 +341,7 @@ Provides some fields of app member information taken from the OpenID user info.
 - \`zoneinfo\`: The app member’s timezone
 - \`role\`: The role of the app member in the app
 - \`properties\`: Custom properties defined on the app member
+- \`phoneNumber\`: Phone number of the app member if enabled in app definition.
 
 Example:
 
@@ -351,7 +353,8 @@ Example:
   "name": "Test User",
   "picture": "https://www.gravatar.com/avatar/f46b82357ce29bcd1099915946cda468?s=128&d=mp",
   "sub": "5c6270e2-ad31-414f-bcab-6752a2c4dcfd",
-  "properties": {}
+  "properties": {},
+  "phoneNumber":+31 612345678"
 }
 \`\`\`
     `,

package/schemas/AppLayoutDefinition.js

@@ -25,6 +25,13 @@ If set to \`navigation\`, it will only be visible if \`login\` is also visible i
 If set to \`navigation\`, it will only be visible if \`login\` is also visible in \`navigation\`.
 `,
         },
+        enabledSettings: {
+            type: 'array',
+            items: {
+                enum: ['name', 'phoneNumber', 'picture', 'languages'],
+            },
+            description: 'A list of the settings to display on the settings page.',
+        },
         install: {
             enum: ['navbar', 'navigation', 'hidden'],
             default: 'navigation',

package/schemas/AppMembersDefinition.js

@@ -12,6 +12,21 @@ export const AppMembersDefinition = {
                 $ref: '#/components/schemas/AppMemberPropertyDefinition',
             },
         },
+        phoneNumber: {
+            type: 'object',
+            description: 'Whether the phone number property should be enabled',
+            required: ['enable'],
+            properties: {
+                enable: {
+                    type: 'boolean',
+                    default: false,
+                },
+                required: {
+                    type: 'boolean',
+                    default: false,
+                },
+            },
+        },
     },
 };
 //# sourceMappingURL=AppMembersDefinition.js.map

package/schemas/BasePageDefinition.js

@@ -35,7 +35,7 @@ have two pages with the same name. The name of the page is displayed at the *app
             default: false,
         },
         navigation: {
-            $ref: '#/components/schemas/AppLayoutDefinition/properties/navigation',
+            enum: ['bottom', 'left-menu', 'hidden', 'dropdown', 'profileDropdown'],
             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

package/schemas/actions/AppMemberCurrentPatchActionDefinition.js

@@ -15,6 +15,10 @@ Does nothing if the app member isn’t logged in.`,
             $ref: '#/components/schemas/RemapperDefinition',
             description: 'The new full name of the app member.',
         },
+        phoneNumber: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'Phone number of the app member',
+        },
         properties: {
             $ref: '#/components/schemas/RemapperDefinition',
             description: `The updated custom properties for the app member.

package/schemas/actions/AppMemberRegisterActionDefinition.js

@@ -19,6 +19,10 @@ Does nothing if the app member is already logged in.`,
             $ref: '#/components/schemas/RemapperDefinition',
             description: 'The email to log in with.',
         },
+        phoneNumber: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'Phone number of the app member',
+        },
         name: {
             $ref: '#/components/schemas/RemapperDefinition',
             description: 'The full name of the app member.',

package/types/actionDefinition.d.ts

@@ -361,6 +361,11 @@ export interface AppMemberRegisterAction extends BaseActionDefinition<'app.membe
      * The email address to register with.
      */
     email: Remapper;
+    /**
+     * The phone number of the app member,
+     * only works if the phone number is enabled in the members definition.
+     */
+    phoneNumber?: Remapper;
     /**
      * The password to login with.
      */
@@ -436,6 +441,10 @@ export interface AppMemberCurrentPatchAction extends BaseActionDefinition<'app.m
      * The display name to update.
      */
     name?: Remapper;
+    /**
+     * Phone number of the app member
+     */
+    phoneNumber?: Remapper;
     /**
      * Custom properties that can be assigned freely.
      *

package/types/core.d.ts

@@ -9,6 +9,7 @@ import { type ResourceDefinition } from './resource.js';
 import { type ViewRole } from './roles.js';
 import { type Security } from './security.js';
 import { type Theme } from './theme.js';
+export type SettingName = 'languages' | 'name' | 'phoneNumber' | 'picture';
 export interface AppDefinition {
     /**
      * The name of the app.
@@ -70,6 +71,10 @@ export interface AppDefinition {
          * @default 'navbar'
          */
         install?: LayoutPosition;
+        /**
+         * Settings to be shown on the default settings page.
+         */
+        enabledSettings?: SettingName[];
         /**
          * The navigation type to use.
          *
@@ -95,7 +100,8 @@ export interface AppDefinition {
     pages: PageDefinition[];
     controller?: ControllerDefinition;
     members?: {
-        properties: Record<string, AppMemberPropertyDefinition>;
+        phoneNumber?: AppMemberPhoneNumberDefinition;
+        properties?: Record<string, AppMemberPropertyDefinition>;
     };
     /**
      * Resource definitions that may be used by the app.
@@ -159,8 +165,9 @@ export interface BasePageDefinition {
     /**
      * The navigation type to use for the page.
      * Setting this will override the default navigation for the app.
+     * if this is set to `navbar`, navigation link is rendered in the profile dropdown.
      */
-    navigation?: Navigation;
+    navigation?: Navigation | 'profileDropdown';
     /**
      * A list of roles that may view the page.
      */
@@ -294,6 +301,10 @@ export interface WebhookDefinition {
     schema: OpenAPIV3.SchemaObject;
     action: ActionDefinition;
 }
+export interface AppMemberPhoneNumberDefinition {
+    enable: boolean;
+    required?: boolean;
+}
 export interface AppMemberPropertyDefinition {
     /**
      * The JSON schema to validate user properties against before sending it to the backend.

package/types/member.d.ts

@@ -12,6 +12,10 @@ export interface AppMemberInfo {
      * The end-user's preferred email address.
      */
     email: string;
+    /**
+     * The phone number of the app member.
+     */
+    phoneNumber?: string;
     /**
      * True if the end-user's email address has been verified, else false.
      */

package/types/remapper.d.ts

@@ -1,5 +1,5 @@
 import { type RequireExactlyOne } from 'type-fest';
-type AppMemberInfoKey = 'demo' | 'email_verified' | 'email' | 'locale' | 'name' | 'picture' | 'properties' | 'role' | 'sub' | 'zoneinfo';
+type AppMemberInfoKey = 'demo' | 'email_verified' | 'email' | 'locale' | 'name' | 'phoneNumber' | 'picture' | 'properties' | 'role' | 'sub' | 'zoneinfo';
 interface BaseICSRemapper {
     /**
      * The start of the icalendar event.

package/validation.js

@@ -75,10 +75,10 @@ function validateUniquePageNames(definition, report) {
     checkPages(definition.pages);
 }
 function validateMembersSchema(definition, report) {
-    if (!definition.members) {
+    if (!definition.members?.properties) {
         return;
     }
-    for (const [propertyName, propertyDefinition] of Object.entries(definition.members.properties)) {
+    for (const [propertyName, propertyDefinition] of Object.entries(definition.members.properties ?? {})) {
         // Handled by schema validation
         if (!propertyDefinition?.schema) {
             continue;
@@ -104,6 +104,18 @@ function validateMembersSchema(definition, report) {
         }
     }
 }
+function validatePhoneNumberDefinition(definition, report) {
+    if (!definition.members?.phoneNumber) {
+        return;
+    }
+    if (!definition.members.phoneNumber.enable && definition.members.phoneNumber.required) {
+        report(definition.members.phoneNumber, 'phone number should be enabled', [
+            'members',
+            'phoneNumber',
+            'required',
+        ]);
+    }
+}
 // XXX: Very not good nesting
 function validateResourceSchemas(definition, report) {
     if (!definition.resources) {
@@ -1222,6 +1234,7 @@ export async function validateAppDefinition(definition, getBlockVersions, contro
         validateLanguage(definition, report);
         validateResourceReferences(definition, report);
         validateMembersSchema(definition, report);
+        validatePhoneNumberDefinition(definition, report);
         validateResourceSchemas(definition, report);
         validateSecurity(definition, report);
         validateBlocks(definition, blockVersionMap, report);