@appsemble/utils 0.29.11 → 0.30.1

package/api/components/schemas/AppMemberPropertiesPatchActionDefinition.js

@@ -0,0 +1,26 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const AppMemberPropertiesPatchActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'sub'],
+    properties: {
+        type: {
+            enum: ['app.member.properties.patch'],
+            description: `Allows the app member to patch the properties of another app member account.
+
+Does nothing if the app member isn’t logged in.`,
+        },
+        sub: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The new full name 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.`,
+        },
+    },
+});
+//# sourceMappingURL=AppMemberPropertiesPatchActionDefinition.js.map

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

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

package/api/components/schemas/{UserPropertyDefinition.js → AppMemberPropertyDefinition.js}

@@ -1,8 +1,8 @@
-export const UserPropertyDefinition = {
+export const AppMemberPropertyDefinition = {
     anyOf: [
         {
             type: 'object',
-            description: 'Definition for a user property.',
+            description: 'Definition for an app member custom property.',
             required: ['schema'],
             additionalProperties: false,
             properties: {
@@ -19,7 +19,7 @@ export const UserPropertyDefinition = {
                     properties: {
                         resource: {
                             type: 'string',
-                            description: 'The resource referenced by this user property.',
+                            description: 'The resource referenced by this app member property.',
                         },
                     },
                 },
@@ -27,7 +27,7 @@ export const UserPropertyDefinition = {
         },
         {
             type: 'object',
-            description: 'Definition for a user property.',
+            description: 'Definition for an app member property.',
             required: ['schema'],
             additionalProperties: false,
             properties: {
@@ -46,4 +46,4 @@ export const UserPropertyDefinition = {
         },
     ],
 };
-//# sourceMappingURL=UserPropertyDefinition.js.map
+//# sourceMappingURL=AppMemberPropertyDefinition.js.map

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

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

package/api/components/schemas/AppMemberQueryActionDefinition.js

@@ -0,0 +1,20 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const AppMemberQueryActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['app.member.query'],
+            description: `Allows the currently logged in app member to fetch a list of app members by their roles.
+
+Does nothing if the app member isn’t logged in.`,
+        },
+        roles: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The roles of the app members that would be fetched.',
+        },
+    },
+});
+//# sourceMappingURL=AppMemberQueryActionDefinition.js.map

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

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

package/api/components/schemas/AppMemberRegisterActionDefinition.js

@@ -0,0 +1,43 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const AppMemberRegisterActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'email', 'password'],
+    properties: {
+        type: {
+            enum: ['app.member.register'],
+            description: `Allows the app member to register 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.',
+        },
+        name: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The full name of the app member.',
+        },
+        picture: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The image to use for the profile picture of the app member.',
+        },
+        properties: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: `The custom properties for the app member.
+
+Values will be validated based on \`members.properties\`, if defined in the app definition.`,
+        },
+        login: {
+            type: 'boolean',
+            description: 'Whether to login after registering.',
+            default: true,
+        },
+    },
+});
+//# sourceMappingURL=AppMemberRegisterActionDefinition.js.map

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

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

package/api/components/schemas/AppMemberRoleUpdateActionDefinition.js

@@ -0,0 +1,27 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const AppMemberRoleUpdateActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'sub'],
+    properties: {
+        type: {
+            enum: ['app.member.role.update'],
+            description: `Allows the app member to update the role of another app member account.
+
+Does nothing if the app member isn’t logged in.`,
+        },
+        sub: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The id of the app member.',
+        },
+        role: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: `The updated role of the app member.
+
+The role must exist in the roles property of the app's security definition or in the predefined app roles in the system -
+\`Member\`, \`MembersManager\`, \`GroupMembersManager\`, \`GroupsManager\`, \`ResourcesManager\` and \`Owner\``,
+        },
+    },
+});
+//# sourceMappingURL=AppMemberRoleUpdateActionDefinition.js.map

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

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

package/api/components/schemas/AppMembersDefinition.js

@@ -0,0 +1,17 @@
+export const AppMembersDefinition = {
+    type: 'object',
+    description: 'Definition for app member properties.',
+    required: [],
+    additionalProperties: false,
+    properties: {
+        properties: {
+            type: 'object',
+            description: 'The properties object configuring app members',
+            additionalProperties: {
+                description: 'A single app member property definition.',
+                $ref: '#/components/schemas/AppMemberPropertyDefinition',
+            },
+        },
+    },
+};
+//# sourceMappingURL=AppMembersDefinition.js.map

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

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

package/api/components/schemas/GroupMember.js

@@ -0,0 +1,19 @@
+export const GroupMember = {
+    type: 'object',
+    description: 'An object representing a member of a group',
+    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 group.',
+        },
+        name: { $ref: '#/components/schemas/AppMember/properties/name' },
+        email: { $ref: '#/components/schemas/AppMember/properties/email' },
+    },
+};
+//# sourceMappingURL=GroupMember.js.map

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

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

package/api/components/schemas/{TeamMembersActionDefinition.js → GroupMemberDeleteActionDefinition.js}

@@ -1,18 +1,18 @@
 import { BaseActionDefinition } from './BaseActionDefinition.js';
 import { extendJSONSchema } from './utils.js';
-export const TeamMembersActionDefinition = extendJSONSchema(BaseActionDefinition, {
+export const GroupMemberDeleteActionDefinition = extendJSONSchema(BaseActionDefinition, {
     type: 'object',
     additionalProperties: false,
     required: ['type', 'id'],
     properties: {
         type: {
-            enum: ['team.members'],
-            description: "Get a list of a team's members",
+            enum: ['group.member.delete'],
+            description: 'Allow a user to join a group.',
         },
         id: {
-            description: 'The ID of a specific team to get the members from',
             $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The id of the group member to delete',
         },
     },
 });
-//# sourceMappingURL=TeamMembersActionDefinition.js.map
+//# sourceMappingURL=GroupMemberDeleteActionDefinition.js.map

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

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

package/api/components/schemas/{TeamInviteActionDefinition.js → GroupMemberInviteActionDefinition.js}

@@ -1,16 +1,16 @@
 import { BaseActionDefinition } from './BaseActionDefinition.js';
 import { extendJSONSchema } from './utils.js';
-export const TeamInviteActionDefinition = extendJSONSchema(BaseActionDefinition, {
+export const GroupMemberInviteActionDefinition = extendJSONSchema(BaseActionDefinition, {
     type: 'object',
     additionalProperties: false,
     required: ['type'],
     properties: {
         type: {
-            enum: ['team.invite'],
-            description: 'Invite a user to join a team.',
+            enum: ['group.member.invite'],
+            description: 'Invite an app member to join a group.',
         },
         id: {
-            description: 'The ID of the team to invite the user to.',
+            description: 'The ID of the group to invite the app member to.',
             $ref: '#/components/schemas/RemapperDefinition',
         },
         email: {
@@ -20,8 +20,7 @@ export const TeamInviteActionDefinition = extendJSONSchema(BaseActionDefinition,
         role: {
             description: 'The role to invite the user as.',
             $ref: '#/components/schemas/RemapperDefinition',
-            default: 'member',
         },
     },
 });
-//# sourceMappingURL=TeamInviteActionDefinition.js.map
+//# sourceMappingURL=GroupMemberInviteActionDefinition.js.map

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

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

package/api/components/schemas/GroupMemberQueryActionDefinition.js

@@ -0,0 +1,18 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const GroupMemberQueryActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'id'],
+    properties: {
+        type: {
+            enum: ['group.member.query'],
+            description: "Get a list of a group's members",
+        },
+        id: {
+            description: 'The ID of a specific group to get the members from',
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+    },
+});
+//# sourceMappingURL=GroupMemberQueryActionDefinition.js.map

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

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

package/api/components/schemas/GroupMemberRoleUpdateActionDefinition.js

@@ -0,0 +1,22 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const GroupMemberRoleUpdateActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'id', 'role'],
+    properties: {
+        type: {
+            enum: ['group.member.role.update'],
+            description: 'Update the role of a group member.',
+        },
+        id: {
+            description: 'The id of the group member to update the role of.',
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+        role: {
+            description: 'The new role of the group member.',
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+    },
+});
+//# sourceMappingURL=GroupMemberRoleUpdateActionDefinition.js.map

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

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

package/api/components/schemas/{UserLogoutActionDefinition.js → GroupQueryActionDefinition.js}

@@ -1,14 +1,14 @@
 import { BaseActionDefinition } from './BaseActionDefinition.js';
 import { extendJSONSchema } from './utils.js';
-export const UserLogoutActionDefinition = extendJSONSchema(BaseActionDefinition, {
+export const GroupQueryActionDefinition = extendJSONSchema(BaseActionDefinition, {
     type: 'object',
     additionalProperties: false,
     required: ['type'],
     properties: {
         type: {
-            enum: ['user.logout'],
-            description: 'Allow the users to logout of the application.',
+            enum: ['group.query'],
+            description: 'Get a list of all of the groups in an app.',
         },
     },
 });
-//# sourceMappingURL=UserLogoutActionDefinition.js.map
+//# sourceMappingURL=GroupQueryActionDefinition.js.map

package/api/components/schemas/OrganizationMember.js

@@ -1,4 +1,4 @@
-import { roles } from '../../../constants/index.js';
+import { predefinedOrganizationRoles } from '@appsemble/types';
 export const OrganizationMember = {
     type: 'object',
     description: 'A member of an organization.',
@@ -17,7 +17,7 @@ export const OrganizationMember = {
             description: 'The primary email address of the user.',
         },
         role: {
-            enum: Object.keys(roles),
+            enum: predefinedOrganizationRoles,
         },
         properties: {
             type: 'object',

package/api/components/schemas/ResourceCountActionDefinition.js

@@ -13,6 +13,10 @@ export const ResourceCountActionDefinition = extendJSONSchema(RequestActionDefin
             type: 'string',
             description: 'The type of the resource to count.',
         },
+        own: {
+            type: 'boolean',
+            description: 'If only the resources created by the authenticated app member should be included',
+        },
     },
 }, ['url']);
 //# sourceMappingURL=ResourceCountActionDefinition.js.map

package/api/components/schemas/ResourceCreateActionDefinition.js

@@ -14,5 +14,5 @@ export const ResourceCreateActionDefinition = extendJSONSchema(RequestActionDefi
             description: 'The type of the resource to create.',
         },
     },
-}, ['url']);
+}, ['url', 'method']);
 //# sourceMappingURL=ResourceCreateActionDefinition.js.map

package/api/components/schemas/ResourceDefinition.js

@@ -1,13 +1,3 @@
-const roles = {
-    type: 'array',
-    description: `The list of roles that are allowed to use this action.
-
-This will override the default roles that are assigned.
-`,
-    items: {
-        type: 'string',
-    },
-};
 const query = {
     type: 'object',
     description: 'The query parameters to use in the request.',
@@ -92,11 +82,6 @@ name of the resource and how it should behave.
                 },
             },
         },
-        roles: {
-            type: 'array',
-            description: 'The default roles that are allowed to perform all actions.',
-            items: { type: 'string' },
-        },
         url: {
             type: 'string',
             default: '/api/apps/{appId}/{resource}',
@@ -123,7 +108,6 @@ name of the resource and how it should behave.
             description: "Overrides for 'query' requests.",
             additionalProperties: false,
             properties: {
-                roles,
                 query,
                 method: {
                     type: 'string',
@@ -142,7 +126,6 @@ name of the resource and how it should behave.
             description: "Overrides for 'get' requests.",
             additionalProperties: false,
             properties: {
-                roles,
                 query,
                 method: {
                     type: 'string',
@@ -161,7 +144,6 @@ name of the resource and how it should behave.
             description: "Overrides for 'count' requests.",
             additionalProperties: false,
             properties: {
-                roles,
                 query,
                 method: {
                     type: 'string',
@@ -180,7 +162,6 @@ name of the resource and how it should behave.
             description: "Overrides for 'create' requests.",
             additionalProperties: false,
             properties: {
-                roles,
                 query,
                 method: {
                     type: 'string',
@@ -202,7 +183,6 @@ name of the resource and how it should behave.
             description: "Overrides for 'patch' requests.",
             additionalProperties: false,
             properties: {
-                roles,
                 query,
                 method: {
                     type: 'string',
@@ -224,7 +204,6 @@ name of the resource and how it should behave.
             description: "Overrides for 'update' requests.",
             additionalProperties: false,
             properties: {
-                roles,
                 query,
                 method: {
                     type: 'string',
@@ -246,7 +225,6 @@ name of the resource and how it should behave.
             description: "Overrides for 'delete' requests.",
             additionalProperties: false,
             properties: {
-                roles,
                 query,
                 method: {
                     type: 'string',

package/api/components/schemas/ResourceQueryActionDefinition.js

@@ -17,6 +17,10 @@ export const ResourceQueryActionDefinition = extendJSONSchema(RequestActionDefin
             type: 'string',
             description: 'The view to use for the resource.',
         },
+        own: {
+            type: 'boolean',
+            description: 'If only the resources created by the authenticated app member should be included',
+        },
     },
 }, ['url']);
 //# sourceMappingURL=ResourceQueryActionDefinition.js.map

package/api/components/schemas/SecurityDefaultDefinition.js

@@ -12,7 +12,7 @@ export const SecurityDefaultDefinition = {
 The following values are allowed:
 - \`everyone\`: Every authenticated user gets the default role.
 - \`organization\`: Every authenticated user gets the default role if they are in the same organization as the app.
-- \`invite\`: The user has to manually get a role assigned.
+- \`invite\`: The app member has to be invited to the app with a specific role.
 
 > **Important**: When [OAuth2](../guides/oauth2) or [SAML2.0](../guides/saml) is used in the
 > app, you must set the policy to \`everyone\`. This will specifically allow every configured

package/api/components/schemas/SecurityDefinition.js

@@ -1,20 +1,16 @@
 export const SecurityDefinition = {
     type: 'object',
     description: 'This describes how the app is secured.',
-    required: ['default', 'roles'],
     additionalProperties: false,
     properties: {
         default: { $ref: '#/components/schemas/SecurityDefaultDefinition' },
+        guest: { $ref: '#/components/schemas/SecurityGuestDefinition' },
         roles: {
             type: 'object',
-            description: 'This property defines the user roles that are available within the app.',
+            description: 'This property defines the app roles that are available within the app.',
             minProperties: 1,
             additionalProperties: { $ref: '#/components/schemas/SecurityRoleDefinition' },
         },
-        teams: {
-            $ref: '#/components/schemas/TeamsDefinition',
-            description: 'Define how teams are handled by the app.',
-        },
     },
 };
 //# sourceMappingURL=SecurityDefinition.js.map

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

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

package/api/components/schemas/SecurityGuestDefinition.js

@@ -0,0 +1,26 @@
+export const SecurityGuestDefinition = {
+    type: 'object',
+    description: 'This describes the permissions that unauthenticated users have.',
+    additionalProperties: false,
+    properties: {
+        inherits: {
+            type: 'array',
+            minItems: 1,
+            description: `The name of the role to inherit from.
+
+Note that this role must exist.
+`,
+            items: {
+                type: 'string',
+            },
+        },
+        permissions: {
+            type: 'array',
+            description: 'Specific permissions within the app, which unauthenticated users should have',
+            items: {
+                type: 'string',
+            },
+        },
+    },
+};
+//# sourceMappingURL=SecurityGuestDefinition.js.map

package/api/components/schemas/SecurityRoleDefinition.js

@@ -23,6 +23,13 @@ of the referenced role.
                 type: 'string',
             },
         },
+        permissions: {
+            type: 'array',
+            description: 'Specific permissions within the app, which this role should have',
+            items: {
+                type: 'string',
+            },
+        },
     },
 };
 //# sourceMappingURL=SecurityRoleDefinition.js.map

package/api/components/schemas/User.js

@@ -1,32 +1,12 @@
 export const User = {
     type: 'object',
-    description: 'An object representing a user.',
+    description: 'An object representing a user',
     additionalProperties: false,
     properties: {
         id: {
             type: 'string',
             readOnly: true,
-            description: 'The ID of the user.',
-        },
-        name: {
-            type: 'string',
-            description: 'The display name of the user.',
-        },
-        email: {
-            type: 'string',
-            description: 'The primary email used for communication.',
-        },
-        locale: {
-            type: 'string',
-            description: 'The locale of the user.',
-        },
-        timezone: {
-            enum: Intl.supportedValuesOf('timeZone'),
-            description: 'The time zone of the user.',
-        },
-        subscribed: {
-            type: 'boolean',
-            description: 'If the user is subscribed to the newsletter.',
+            description: 'The id of the user.',
         },
     },
 };

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

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

package/api/components/schemas/UserInfo.js

@@ -0,0 +1,42 @@
+export const UserInfo = {
+    type: 'object',
+    description: 'An object representing the OAuth2 info of a user',
+    additionalProperties: false,
+    properties: {
+        sub: {
+            type: 'string',
+            readOnly: true,
+            description: 'The id of the user.',
+        },
+        name: {
+            type: 'string',
+            description: 'The full name of the user.',
+        },
+        email: {
+            type: 'string',
+            description: 'The email of the user.',
+        },
+        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 user.',
+        },
+        locale: {
+            type: 'string',
+            description: 'The locale of the user.',
+        },
+        timezone: {
+            enum: Intl.supportedValuesOf('timeZone'),
+            description: 'The time zone of the user.',
+        },
+        subscribed: {
+            type: 'boolean',
+            description: 'If the user is subscribed to the newsletter.',
+        },
+    },
+};
+//# sourceMappingURL=UserInfo.js.map