@appsemble/utils 0.29.11 → 0.30.1

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

@@ -5,7 +5,8 @@ export * from './AppCollection.js';
 export * from './ControllerDefinition.js';
 export * from './ControllerActionDefinition.js';
 export * from './AppCollectionDefinition.js';
-export * from './AppAccount.js';
+export * from './AppMember.js';
+export * from './AppMemberInfo.js';
 export * from './AppDefinition.js';
 export * from './AppLayoutDefinition.js';
 export * from './AppMessages.js';
@@ -96,6 +97,7 @@ export * from './ResourceViewDefinition.js';
 export * from './SecurityDefaultDefinition.js';
 export * from './SecurityDefinition.js';
 export * from './SecurityRoleDefinition.js';
+export * from './SecurityGuestDefinition.js';
 export * from './ShareActionDefinition.js';
 export * from './ScimPatchOp.js';
 export * from './ScimSecret.js';
@@ -111,26 +113,31 @@ export * from './StorageUpdateActionDefinition.js';
 export * from './StorageDeleteActionDefinition.js';
 export * from './SubPage.js';
 export * from './TabsPageDefinition.js';
-export * from './TeamInviteActionDefinition.js';
-export * from './TeamJoinActionDefinition.js';
-export * from './TeamListActionDefinition.js';
-export * from './TeamMembersActionDefinition.js';
-export * from './TeamsDefinition.js';
+export * from './GroupMemberRoleUpdateActionDefinition.js';
+export * from './GroupMemberDeleteActionDefinition.js';
+export * from './GroupMemberQueryActionDefinition.js';
+export * from './GroupMemberInviteActionDefinition.js';
+export * from './GroupQueryActionDefinition.js';
 export * from './Theme.js';
 export * from './ThrowActionDefinition.js';
 export * from './User.js';
+export * from './UserInfo.js';
 export * from './Training.js';
 export * from './TrainingBlock.js';
 export * from './UserEmail.js';
-export * from './UserLogoutActionDefinition.js';
-export * from './UserLoginActionDefinition.js';
-export * from './UserRegisterActionDefinition.js';
-export * from './UserCreateActionDefinition.js';
-export * from './UserUpdateActionDefinition.js';
-export * from './UserQueryActionDefinition.js';
-export * from './UserRemoveActionDefinition.js';
+export * from './AppMemberLogoutActionDefinition.js';
+export * from './AppMemberLoginActionDefinition.js';
+export * from './AppMemberRegisterActionDefinition.js';
+export * from './AppMemberInviteActionDefinition.js';
+export * from './AppMemberQueryActionDefinition.js';
+export * from './AppMemberDeleteActionDefinition.js';
+export * from './AppMemberCurrentPatchActionDefinition.js';
+export * from './AppMemberPropertiesPatchActionDefinition.js';
+export * from './AppMemberRoleUpdateActionDefinition.js';
 export * from './LoopPageDefinition.js';
 export * from './LoopPageActionsDefinition.js';
 export * from './TabsPageActionsDefinition.js';
-export * from './UsersDefinition.js';
-export * from './UserPropertyDefinition.js';
+export * from './AppMembersDefinition.js';
+export * from './AppMemberPropertyDefinition.js';
+export * from './GroupMember.js';
+export * from './AppAccount.js';

package/api/components/schemas/index.js

@@ -5,7 +5,8 @@ export * from './AppCollection.js';
 export * from './ControllerDefinition.js';
 export * from './ControllerActionDefinition.js';
 export * from './AppCollectionDefinition.js';
-export * from './AppAccount.js';
+export * from './AppMember.js';
+export * from './AppMemberInfo.js';
 export * from './AppDefinition.js';
 export * from './AppLayoutDefinition.js';
 export * from './AppMessages.js';
@@ -96,6 +97,7 @@ export * from './ResourceViewDefinition.js';
 export * from './SecurityDefaultDefinition.js';
 export * from './SecurityDefinition.js';
 export * from './SecurityRoleDefinition.js';
+export * from './SecurityGuestDefinition.js';
 export * from './ShareActionDefinition.js';
 export * from './ScimPatchOp.js';
 export * from './ScimSecret.js';
@@ -111,27 +113,32 @@ export * from './StorageUpdateActionDefinition.js';
 export * from './StorageDeleteActionDefinition.js';
 export * from './SubPage.js';
 export * from './TabsPageDefinition.js';
-export * from './TeamInviteActionDefinition.js';
-export * from './TeamJoinActionDefinition.js';
-export * from './TeamListActionDefinition.js';
-export * from './TeamMembersActionDefinition.js';
-export * from './TeamsDefinition.js';
+export * from './GroupMemberRoleUpdateActionDefinition.js';
+export * from './GroupMemberDeleteActionDefinition.js';
+export * from './GroupMemberQueryActionDefinition.js';
+export * from './GroupMemberInviteActionDefinition.js';
+export * from './GroupQueryActionDefinition.js';
 export * from './Theme.js';
 export * from './ThrowActionDefinition.js';
 export * from './User.js';
+export * from './UserInfo.js';
 export * from './Training.js';
 export * from './TrainingBlock.js';
 export * from './UserEmail.js';
-export * from './UserLogoutActionDefinition.js';
-export * from './UserLoginActionDefinition.js';
-export * from './UserRegisterActionDefinition.js';
-export * from './UserCreateActionDefinition.js';
-export * from './UserUpdateActionDefinition.js';
-export * from './UserQueryActionDefinition.js';
-export * from './UserRemoveActionDefinition.js';
+export * from './AppMemberLogoutActionDefinition.js';
+export * from './AppMemberLoginActionDefinition.js';
+export * from './AppMemberRegisterActionDefinition.js';
+export * from './AppMemberInviteActionDefinition.js';
+export * from './AppMemberQueryActionDefinition.js';
+export * from './AppMemberDeleteActionDefinition.js';
+export * from './AppMemberCurrentPatchActionDefinition.js';
+export * from './AppMemberPropertiesPatchActionDefinition.js';
+export * from './AppMemberRoleUpdateActionDefinition.js';
 export * from './LoopPageDefinition.js';
 export * from './LoopPageActionsDefinition.js';
 export * from './TabsPageActionsDefinition.js';
-export * from './UsersDefinition.js';
-export * from './UserPropertyDefinition.js';
+export * from './AppMembersDefinition.js';
+export * from './AppMemberPropertyDefinition.js';
+export * from './GroupMember.js';
+export * from './AppAccount.js';
 //# sourceMappingURL=index.js.map

package/api/components/securitySchemes/app.js

@@ -3,8 +3,8 @@ const scopes = {
     openid: 'Login the user to the requesting app using OpenID.',
     profile: 'Read the user profile, including the display name and profile picture.',
     'resources:manage': 'Manage app resources on behalf of a user.',
-    'teams:read': 'Read the teams the user is a part of.',
-    'teams:write': 'Add new members to a team.',
+    'groups:read': 'Read the groups the user is a part of.',
+    'groups:write': 'Add new members to a group.',
 };
 export const app = {
     type: 'oauth2',
@@ -17,13 +17,13 @@ export const app = {
     flows: {
         authorizationCode: {
             authorizationUrl: '/connect/authorize',
-            tokenUrl: '/oauth2/token',
-            refreshUrl: '/oauth2/token',
+            tokenUrl: '/apps/{appId}/auth/oauth2/token',
+            refreshUrl: '/apps/{appId}/auth/oauth2/token',
             scopes,
         },
         password: {
-            tokenUrl: '/oauth2/token',
-            refreshUrl: '/oauth2/token',
+            tokenUrl: '/apps/{appId}/auth/oauth2/token',
+            refreshUrl: '/apps/{appId}/auth/oauth2/token',
             scopes,
         },
     },

package/api/components/securitySchemes/cli.js

@@ -7,7 +7,7 @@ export const cli = {
   `,
     flows: {
         clientCredentials: {
-            tokenUrl: '/oauth2/token',
+            tokenUrl: '/auth/oauth2/token',
             scopes: {
                 'apps:export': 'Export apps as zip files',
                 'apps:write': 'Create and update apps',
@@ -18,8 +18,8 @@ export const cli = {
                 'resources:read': 'Read app resources on behalf of a user.',
                 'resources:write': 'Modify app resources on behalf of a user.',
                 'assets:write': 'Create app assets on behalf of a user.',
-                'teams:read': 'Read information about the user’s teams.',
-                'teams:write': 'Read information about the user’s teams.',
+                'groups:read': 'Read information about the user’s groups.',
+                'groups:write': 'Read information about the user’s groups.',
             },
         },
     },

package/api/paths/app-collections/appCollectionId/apps/appId/pinned.d.ts

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

package/api/paths/app-collections/appCollectionId/apps/appId/pinned.js

@@ -0,0 +1,70 @@
+export const pathItems = {
+    post: {
+        tags: ['main', 'app-collection', 'app'],
+        description: 'Pin an app to an app collection',
+        operationId: 'pinAppToAppCollection',
+        parameters: [
+            {
+                name: 'appCollectionId',
+                in: 'path',
+                description: 'The id of the app collection to pin the app to',
+                required: true,
+                schema: { $ref: '#/components/schemas/AppCollection/properties/id' },
+            },
+            {
+                name: 'appId',
+                in: 'path',
+                description: 'The id of the app to pin',
+                required: true,
+                schema: { $ref: '#/components/schemas/App/properties/id' },
+            },
+        ],
+        responses: {
+            200: {
+                description: 'The app was pinned to the app collection',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                pinned: {
+                                    type: 'string',
+                                    format: 'date-time',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    delete: {
+        tags: ['main', 'app-collection', 'app'],
+        description: 'Unpin an app from an app collection',
+        operationId: 'unpinAppFromAppCollection',
+        parameters: [
+            {
+                name: 'appCollectionId',
+                in: 'path',
+                description: 'The id of the app collection to unpin the app from',
+                required: true,
+                schema: { $ref: '#/components/schemas/AppCollection/properties/id' },
+            },
+            {
+                name: 'appId',
+                in: 'path',
+                description: 'The id of the app to unpin',
+                required: true,
+                schema: { $ref: '#/components/schemas/App/properties/id' },
+            },
+        ],
+        responses: {
+            204: {
+                description: 'The app was unpinned from the app collection',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=pinned.js.map

package/api/paths/app-collections/appCollectionId/apps/appId.d.ts

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

package/api/paths/app-collections/appCollectionId/apps/appId.js

@@ -0,0 +1,34 @@
+export const pathItems = {
+    delete: {
+        tags: ['main', 'app-collection', 'app'],
+        description: 'Remove an app from an app collection',
+        operationId: 'removeAppFromAppCollection',
+        parameters: [
+            {
+                name: 'appCollectionId',
+                in: 'path',
+                description: 'The id of the app collection',
+                required: true,
+                schema: {
+                    $ref: '#/components/schemas/AppCollection/properties/id',
+                },
+            },
+            {
+                name: 'appId',
+                in: 'path',
+                description: 'The id of the app',
+                required: true,
+                schema: {
+                    $ref: '#/components/schemas/AppCollection/properties/id',
+                },
+            },
+        ],
+        responses: {
+            204: {
+                description: 'The app was removed from the app collection',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=appId.js.map

package/api/paths/app-collections/appCollectionId/apps.d.ts

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

package/api/paths/app-collections/appCollectionId/apps.js

@@ -0,0 +1,93 @@
+export const pathItems = {
+    get: {
+        tags: ['main', 'app-collection', 'app'],
+        description: 'Get a list of apps in an app collection',
+        operationId: 'queryAppCollectionApps',
+        parameters: [
+            {
+                name: 'appCollectionId',
+                in: 'path',
+                description: 'The id of the app collection',
+                required: true,
+                schema: {
+                    $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: {
+                description: 'A list of apps',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                allOf: [
+                                    { $ref: '#/components/schemas/App' },
+                                    {
+                                        type: 'object',
+                                        properties: {
+                                            pinned: {
+                                                type: 'string',
+                                                format: 'date-time',
+                                                nullable: true,
+                                            },
+                                        },
+                                    },
+                                ],
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, {}],
+    },
+    post: {
+        tags: ['main', 'app-collection', 'app'],
+        description: 'Add an app to an app collection',
+        operationId: 'addAppToAppCollection',
+        parameters: [
+            {
+                name: 'appCollectionId',
+                in: 'path',
+                description: 'The id of the app collection',
+                required: true,
+                schema: {
+                    $ref: '#/components/schemas/AppCollection/properties/id',
+                },
+            },
+        ],
+        requestBody: {
+            description: 'The app to add to the app collection',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            AppId: {
+                                $ref: '#/components/schemas/App/properties/id',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The app was added to the app collection',
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=apps.js.map

package/api/paths/app-collections/appCollectionId/expert/profileImage.d.ts

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

package/api/paths/app-collections/appCollectionId/expert/profileImage.js

@@ -0,0 +1,31 @@
+export const pathItems = {
+    get: {
+        tags: ['main', 'app-collection'],
+        description: 'Get an app collection’s expert’s profile image',
+        operationId: 'getAppCollectionExpertProfileImage',
+        parameters: [
+            {
+                name: 'appCollectionId',
+                in: 'path',
+                description: 'The id of the app collection',
+                required: true,
+                schema: {
+                    $ref: '#/components/schemas/AppCollection/properties/id',
+                },
+            },
+        ],
+        responses: {
+            200: {
+                description: 'The app collection’s expert’s profile image',
+                content: {
+                    'image/png': {},
+                    'image/jpeg': {},
+                    'image/tiff': {},
+                    'image/webp': {},
+                },
+            },
+        },
+        security: [{ studio: [] }, {}],
+    },
+};
+//# sourceMappingURL=profileImage.js.map

package/api/paths/app-collections/appCollectionId/headerImage.d.ts

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

package/api/paths/app-collections/appCollectionId/headerImage.js

@@ -0,0 +1,31 @@
+export const pathItems = {
+    get: {
+        tags: ['main', 'app-collection'],
+        description: 'Get an app collection’s header image',
+        operationId: 'getAppCollectionHeaderImage',
+        parameters: [
+            {
+                name: 'appCollectionId',
+                in: 'path',
+                description: 'The id of the app collection',
+                required: true,
+                schema: {
+                    $ref: '#/components/schemas/AppCollection/properties/id',
+                },
+            },
+        ],
+        responses: {
+            200: {
+                description: 'The app collection’s header image',
+                content: {
+                    'image/png': {},
+                    'image/jpeg': {},
+                    'image/tiff': {},
+                    'image/webp': {},
+                },
+            },
+        },
+        security: [{ studio: [] }, {}],
+    },
+};
+//# sourceMappingURL=headerImage.js.map

package/api/paths/app-collections/appCollectionId.d.ts

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

package/api/paths/app-collections/appCollectionId.js

@@ -0,0 +1,102 @@
+export const pathItems = {
+    get: {
+        tags: ['main', 'app-collection'],
+        description: 'Get an app collection',
+        operationId: 'getAppCollection',
+        parameters: [
+            {
+                name: 'appCollectionId',
+                in: 'path',
+                description: 'The id of the app collection',
+                required: true,
+                schema: {
+                    $ref: '#/components/schemas/AppCollection/properties/id',
+                },
+            },
+        ],
+        responses: {
+            200: {
+                description: 'An app collection',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/AppCollection',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, {}],
+    },
+    patch: {
+        tags: ['main', 'app-collection'],
+        description: 'Update an app collection',
+        operationId: 'updateAppCollection',
+        parameters: [
+            {
+                name: 'appCollectionId',
+                in: 'path',
+                description: 'The id of the app collection',
+                required: true,
+                schema: {
+                    $ref: '#/components/schemas/AppCollection/properties/id',
+                },
+            },
+        ],
+        requestBody: {
+            description: 'The app collection to update',
+            required: true,
+            content: {
+                'multipart/form-data': {
+                    schema: {
+                        $ref: '#/components/schemas/AppCollectionDefinition',
+                    },
+                    encoding: {
+                        expertProfileImage: {
+                            contentType: 'image/png,image/jpeg,image/tiff,image/webp',
+                        },
+                        headerImage: {
+                            contentType: 'image/png,image/jpeg,image/tiff,image/webp',
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The updated app collection',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/AppCollection',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    delete: {
+        tags: ['main', 'app-collection'],
+        description: 'Delete an app collection',
+        operationId: 'deleteAppCollection',
+        parameters: [
+            {
+                name: 'appCollectionId',
+                in: 'path',
+                description: 'The id of the app collection',
+                required: true,
+                schema: {
+                    $ref: '#/components/schemas/AppCollection/properties/id',
+                },
+            },
+        ],
+        responses: {
+            204: {
+                description: 'The app collection was deleted',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=appCollectionId.js.map

package/api/paths/app-invites/token/respond.d.ts

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

package/api/paths/app-invites/token/respond.js

@@ -0,0 +1,51 @@
+export const pathItems = {
+    parameters: [
+        {
+            name: 'token',
+            in: 'path',
+            description: 'The token of the invite.',
+            required: true,
+            schema: { type: 'string' },
+        },
+    ],
+    post: {
+        tags: ['app-invite'],
+        description: 'Respond to a given invitation.',
+        operationId: 'respondAppInvite',
+        requestBody: {
+            description: `The response of the invitation.
+
+        If response is true, user will join the app. If response is false, the user declines the invite and the invite is removed.`,
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['response'],
+                        properties: {
+                            response: {
+                                type: 'boolean',
+                            },
+                            password: {
+                                type: 'string',
+                                minLength: 8,
+                            },
+                            timezone: {
+                                enum: Intl.supportedValuesOf('timeZone'),
+                            },
+                            locale: {
+                                type: 'string',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The response has been processed.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=respond.js.map

package/api/paths/app-invites/token.d.ts

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

package/api/paths/app-invites/token.js

@@ -0,0 +1,23 @@
+export const pathItems = {
+    parameters: [
+        {
+            name: 'token',
+            in: 'path',
+            description: 'The token of the invite.',
+            required: true,
+            schema: { type: 'string' },
+        },
+    ],
+    get: {
+        tags: ['app-invite'],
+        description: 'Fetch information about an invite.',
+        operationId: 'getAppInvite',
+        responses: {
+            200: {
+                description: 'An invite response',
+                $ref: '#/components/responses/invite',
+            },
+        },
+    },
+};
+//# sourceMappingURL=token.js.map

package/api/paths/app-members/appMemberId/picture.d.ts

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