@appsemble/utils 0.29.10 → 0.30.1

package/README.md

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

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

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

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

@@ -0,0 +1,7 @@
+export const $own = {
+    name: '$own',
+    schema: { type: 'boolean' },
+    description: 'If only the resources created by the authenticated app member should be included',
+    in: 'query',
+};
+//# sourceMappingURL=$own.js.map

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

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

package/api/components/parameters/appMemberId.js

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

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

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

package/api/components/parameters/groupId.js

@@ -0,0 +1,8 @@
+export const groupId = {
+    name: 'groupId',
+    in: 'path',
+    description: 'The ID of the group on which to perform an operation',
+    required: true,
+    schema: { type: 'number' },
+};
+//# sourceMappingURL=groupId.js.map

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

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

package/api/components/parameters/groupMemberId.js

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

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

@@ -1,26 +1,30 @@
-export * from './$filter.js';
-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';
+export * from './appVariableId.js';
 export * from './assetId.js';
 export * from './blockId.js';
 export * from './blockVersion.js';
-export * from './endpoint.js';
 export * from './language.js';
+export * from './appMemberId.js';
+export * from './groupMemberId.js';
 export * from './organizationId.js';
+export * from './readmeId.js';
 export * from './resourceId.js';
 export * from './resourceType.js';
 export * from './screenshotId.js';
-export * from './readmeId.js';
-export * from './appServiceId.js';
-export * from './appVariableId.js';
-export * from './view.js';
-export * from './trainingId.js';
+export * from './serviceSecretId.js';
 export * from './trainingBlockId.js';
-export * from './memberEmail.js';
+export * from './trainingId.js';
+export * from './$filter.js';
+export * from './$orderby.js';
+export * from './$select.js';
+export * from './$skip.js';
+export * from './$top.js';
+export * from './$own.js';
+export * from './endpoint.js';
+export * from './groupId.js';
 export * from './roles.js';
+export * from './view.js';
+export * from './seed.js';
+export * from './selectedGroupId.js';

package/api/components/parameters/index.js

@@ -1,27 +1,31 @@
-export * from './$filter.js';
-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';
+export * from './appVariableId.js';
 export * from './assetId.js';
 export * from './blockId.js';
 export * from './blockVersion.js';
-export * from './endpoint.js';
 export * from './language.js';
+export * from './appMemberId.js';
+export * from './groupMemberId.js';
 export * from './organizationId.js';
+export * from './readmeId.js';
 export * from './resourceId.js';
 export * from './resourceType.js';
 export * from './screenshotId.js';
-export * from './readmeId.js';
-export * from './appServiceId.js';
-export * from './appVariableId.js';
-export * from './view.js';
-export * from './trainingId.js';
+export * from './serviceSecretId.js';
 export * from './trainingBlockId.js';
-export * from './memberEmail.js';
+export * from './trainingId.js';
+export * from './$filter.js';
+export * from './$orderby.js';
+export * from './$select.js';
+export * from './$skip.js';
+export * from './$top.js';
+export * from './$own.js';
+export * from './endpoint.js';
+export * from './groupId.js';
 export * from './roles.js';
+export * from './view.js';
+export * from './seed.js';
+export * from './selectedGroupId.js';
 //# sourceMappingURL=index.js.map

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

@@ -1,2 +1,9 @@
-import { type OpenAPIV3 } from 'openapi-types';
-export declare const organizationId: OpenAPIV3.ParameterObject;
+export declare const organizationId: {
+    name: string;
+    required: boolean;
+    in: string;
+    description: string;
+    schema: {
+        $ref: string;
+    };
+};

package/api/components/parameters/organizationId.js

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

package/api/components/parameters/roles.js

@@ -1,13 +1,19 @@
 export const roles = {
     name: 'roles',
     in: 'query',
-    description: 'The roles of users on which to perform an operation',
-    required: true,
+    description: 'The roles of app members on which to perform an operation',
     schema: {
-        type: 'array',
-        items: {
-            $ref: '#/components/schemas/AppAccount/properties/role',
-        },
+        oneOf: [
+            {
+                type: 'array',
+                items: {
+                    $ref: '#/components/schemas/AppMember/properties/role',
+                },
+            },
+            {
+                type: 'string',
+            },
+        ],
     },
 };
 //# sourceMappingURL=roles.js.map

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

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

package/api/components/parameters/seed.js

@@ -0,0 +1,9 @@
+export const seed = {
+    name: 'seed',
+    in: 'query',
+    description: `
+    Whether the resources or assets are seed instead.
+    `,
+    schema: { type: 'string' },
+};
+//# sourceMappingURL=seed.js.map

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

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

package/api/components/parameters/selectedGroupId.js

@@ -0,0 +1,7 @@
+export const selectedGroupId = {
+    name: 'selectedGroupId',
+    in: 'query',
+    description: 'The currently selected group of the app member.',
+    schema: { type: 'number' },
+};
+//# sourceMappingURL=selectedGroupId.js.map

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

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

package/api/components/parameters/{appServiceId.js → serviceSecretId.js}

@@ -1,8 +1,8 @@
-export const appServiceId = {
-    name: 'appServiceId',
+export const serviceSecretId = {
+    name: 'serviceSecretId',
     in: 'path',
     description: 'The id of the app service secret on which to perform an operation',
     required: true,
     schema: { type: 'string' },
 };
-//# sourceMappingURL=appServiceId.js.map
+//# sourceMappingURL=serviceSecretId.js.map

package/api/components/requestBodies/oauth2Consent.js

@@ -5,14 +5,10 @@ export const oauth2Consent = {
         'application/json': {
             schema: {
                 type: 'object',
-                required: ['appId', 'redirectUri', 'scope'],
+                required: ['redirectUri', 'scope'],
                 description: 'A representation of a user’s OAuth2 consent when logging in to an app.',
                 additionalProperties: false,
                 properties: {
-                    appId: {
-                        type: 'number',
-                        description: 'The app ID to manage the OAuth2 consent for',
-                    },
                     redirectUri: {
                         type: 'string',
                         format: 'uri',

package/api/components/requestBodies/user.js

@@ -3,7 +3,7 @@ export const user = {
     content: {
         'application/json': {
             schema: {
-                $ref: '#/components/schemas/User',
+                $ref: '#/components/schemas/UserInfo',
             },
         },
     },

package/api/components/schemas/ActionDefinition.js

@@ -68,18 +68,21 @@ export const ActionDefinition = {
                 { $ref: '#/components/schemas/StorageWriteActionDefinition' },
                 { $ref: '#/components/schemas/StorageUpdateActionDefinition' },
                 { $ref: '#/components/schemas/StorageDeleteActionDefinition' },
-                { $ref: '#/components/schemas/TeamInviteActionDefinition' },
-                { $ref: '#/components/schemas/TeamJoinActionDefinition' },
-                { $ref: '#/components/schemas/TeamListActionDefinition' },
-                { $ref: '#/components/schemas/TeamMembersActionDefinition' },
+                { $ref: '#/components/schemas/GroupMemberInviteActionDefinition' },
+                { $ref: '#/components/schemas/GroupMemberQueryActionDefinition' },
+                { $ref: '#/components/schemas/GroupMemberDeleteActionDefinition' },
+                { $ref: '#/components/schemas/GroupMemberRoleUpdateActionDefinition' },
+                { $ref: '#/components/schemas/GroupQueryActionDefinition' },
                 { $ref: '#/components/schemas/ThrowActionDefinition' },
-                { $ref: '#/components/schemas/UserLoginActionDefinition' },
-                { $ref: '#/components/schemas/UserLogoutActionDefinition' },
-                { $ref: '#/components/schemas/UserRegisterActionDefinition' },
-                { $ref: '#/components/schemas/UserCreateActionDefinition' },
-                { $ref: '#/components/schemas/UserUpdateActionDefinition' },
-                { $ref: '#/components/schemas/UserQueryActionDefinition' },
-                { $ref: '#/components/schemas/UserRemoveActionDefinition' },
+                { $ref: '#/components/schemas/AppMemberLoginActionDefinition' },
+                { $ref: '#/components/schemas/AppMemberLogoutActionDefinition' },
+                { $ref: '#/components/schemas/AppMemberRegisterActionDefinition' },
+                { $ref: '#/components/schemas/AppMemberInviteActionDefinition' },
+                { $ref: '#/components/schemas/AppMemberRoleUpdateActionDefinition' },
+                { $ref: '#/components/schemas/AppMemberCurrentPatchActionDefinition' },
+                { $ref: '#/components/schemas/AppMemberPropertiesPatchActionDefinition' },
+                { $ref: '#/components/schemas/AppMemberQueryActionDefinition' },
+                { $ref: '#/components/schemas/AppMemberDeleteActionDefinition' },
             ],
         },
     ],

package/api/components/schemas/AppAccount.js

@@ -1,38 +1,21 @@
 export const AppAccount = {
     type: 'object',
-    description: 'An user account connected to an app',
+    description: 'An object representing a member of an app',
     additionalProperties: false,
     properties: {
-        name: {
-            type: 'string',
-            description: 'The name as it is available in the app.',
-        },
-        email: {
-            type: 'string',
-            format: 'email',
-            description: 'The email address as it is available in the app.',
-        },
-        email_verified: {
-            type: 'boolean',
-            description: 'Whether this email address has been verified.',
-        },
-        role: {
-            type: 'string',
-            description: 'The role of the user within the app',
-        },
         app: {
-            $ref: '#/components/schemas/AppDefinition',
+            $ref: '#/components/schemas/App',
+            description: 'The app this account is for.',
+        },
+        appMemberInfo: {
+            $ref: '#/components/schemas/AppMemberInfo',
+            description: 'The app member info.',
         },
         sso: {
             type: 'array',
             description: 'The single sign on configurations which link the user to an external account.',
             items: { $ref: '#/components/schemas/SSOConfiguration' },
         },
-        avatar: {
-            type: 'string',
-            format: 'url',
-            description: 'The URL of the avatar of the member.',
-        },
     },
 };
 //# sourceMappingURL=AppAccount.js.map

package/api/components/schemas/AppDefinition.js

@@ -14,18 +14,6 @@ export const AppDefinition = {
 This will be displayed for example on the home screen or in the browser tab.
 `,
         },
-        roles: {
-            type: 'array',
-            description: `The list of roles that are allowed to view this app.
-
-This list is used as the default roles for the roles property on pages and blocks, which can be
-overridden by defining them for a specific page or block. Note that these roles must be defined in
-\`security.roles\`.
-`,
-            items: {
-                type: 'string',
-            },
-        },
         description: {
             type: 'string',
             maxLength: 80,
@@ -68,8 +56,8 @@ This **must** match the name of a page defined for the app.
         controller: {
             $ref: '#/components/schemas/ControllerDefinition',
         },
-        users: {
-            $ref: '#/components/schemas/UsersDefinition',
+        members: {
+            $ref: '#/components/schemas/AppMembersDefinition',
         },
         resources: {
             type: 'object',
@@ -84,7 +72,7 @@ The most basic resource has a \`schema\` property and defines the minimal securi
         },
         security: {
             $ref: '#/components/schemas/SecurityDefinition',
-            description: 'Role definitions that may be used by the app.',
+            description: 'Role and guest definitions that may be used by the app.',
         },
         pages: {
             type: 'array',

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

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

package/api/components/schemas/AppMember.js

@@ -0,0 +1,26 @@
+export const AppMember = {
+    type: 'object',
+    description: 'An object representing a member of an app',
+    additionalProperties: false,
+    properties: {
+        id: {
+            type: 'string',
+            readOnly: true,
+            description: 'The id of the app member.',
+        },
+        role: {
+            type: 'string',
+            description: 'The role of the app member within the app.',
+        },
+        name: {
+            type: 'string',
+            description: 'The full name of the app member.',
+        },
+        email: {
+            type: 'string',
+            format: 'email',
+            description: 'The email address of the app member.',
+        },
+    },
+};
+//# sourceMappingURL=AppMember.js.map

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

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

package/api/components/schemas/AppMemberCurrentPatchActionDefinition.js

@@ -0,0 +1,30 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const AppMemberCurrentPatchActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['app.member.current.patch'],
+            description: `Allows the app member to patch their own app member account.
+
+Does nothing if the app member isn’t logged in.`,
+        },
+        name: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The new full name of the app member.',
+        },
+        properties: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: `The updated custom properties for the app member.
+
+Values will be validated based on \`members.properties\`, if defined in the app definition.`,
+        },
+        picture: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The picture for the patched app member',
+        },
+    },
+});
+//# sourceMappingURL=AppMemberCurrentPatchActionDefinition.js.map

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

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

package/api/components/schemas/AppMemberDeleteActionDefinition.js

@@ -0,0 +1,20 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const AppMemberDeleteActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'sub'],
+    properties: {
+        type: {
+            enum: ['app.member.delete'],
+            description: `Allows the app member to delete another app member.
+
+Does nothing if the app member isn’t logged in.`,
+        },
+        sub: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The id of the app member to be deleted.',
+        },
+    },
+});
+//# sourceMappingURL=AppMemberDeleteActionDefinition.js.map

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

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

package/api/components/schemas/AppMemberInfo.js

@@ -0,0 +1,48 @@
+export const AppMemberInfo = {
+    type: 'object',
+    description: 'An object representing the OAuth2 info of a member of an app',
+    additionalProperties: false,
+    properties: {
+        sub: {
+            type: 'string',
+            readOnly: true,
+            description: 'The id of the app member.',
+        },
+        name: {
+            type: 'string',
+            description: 'The full name of the app member.',
+        },
+        email: {
+            type: 'string',
+            format: 'email',
+            description: 'The email address of the app member.',
+        },
+        email_verified: {
+            type: 'boolean',
+            description: 'Whether this email address has been verified.',
+        },
+        picture: {
+            type: 'string',
+            format: 'url',
+            description: 'The URL of the profile picture of the app member.',
+        },
+        locale: {
+            type: 'string',
+            description: 'The locale of the app member.',
+        },
+        zoneinfo: {
+            enum: Intl.supportedValuesOf('timeZone'),
+            description: 'The time zone of the app member.',
+        },
+        role: {
+            type: 'string',
+            description: 'The role of the app member within the app',
+        },
+        properties: {
+            type: 'object',
+            description: 'The custom properties of the app member.',
+            additionalProperties: true,
+        },
+    },
+};
+//# sourceMappingURL=AppMemberInfo.js.map

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

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

package/api/components/schemas/AppMemberInviteActionDefinition.js

@@ -0,0 +1,24 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const AppMemberInviteActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'email', 'role'],
+    properties: {
+        type: {
+            enum: ['app.member.invite'],
+            description: `Allows the app member to invite another app member using an email address and a role.
+
+Does nothing if the app member is not logged in.`,
+        },
+        email: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The email to invite.',
+        },
+        role: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The role of the invited app member.',
+        },
+    },
+});
+//# sourceMappingURL=AppMemberInviteActionDefinition.js.map

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

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

package/api/components/schemas/AppMemberLoginActionDefinition.js

@@ -0,0 +1,24 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const AppMemberLoginActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['app.member.login'],
+            description: `Allows the app member to login using an email address and a password.
+
+Does nothing if the app member is already logged in.`,
+        },
+        password: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The password to log in with.',
+        },
+        email: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The email to log in with.',
+        },
+    },
+});
+//# sourceMappingURL=AppMemberLoginActionDefinition.js.map

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

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

package/api/components/schemas/AppMemberLogoutActionDefinition.js

@@ -0,0 +1,14 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const AppMemberLogoutActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['app.member.logout'],
+            description: 'Allow the app members to log out of the application.',
+        },
+    },
+});
+//# sourceMappingURL=AppMemberLogoutActionDefinition.js.map

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

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