@appsemble/utils 0.29.11 → 0.30.2

package/api/paths/blocks.js

@@ -1,220 +1,45 @@
-export const paths = {
-    '/api/blocks': {
-        post: {
-            tags: ['block version'],
-            description: 'Publish a block.',
-            operationId: 'publishBlock',
-            requestBody: {
-                description: 'The new block version to publish.',
-                content: {
-                    'multipart/form-data': {
-                        schema: {
-                            $ref: '#/components/schemas/BlockVersion',
-                        },
-                    },
-                },
-            },
-            responses: {
-                201: {
-                    $ref: '#/components/responses/blockVersion',
-                },
-            },
-            security: [{ cli: ['blocks:write'] }],
-        },
-        get: {
-            tags: ['block'],
-            description: 'Get all block’s latest definitions.',
-            operationId: 'queryBlocks',
-            responses: {
-                200: {
-                    description: 'The list of all latest block versions.',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'array',
-                                items: {
-                                    $ref: '#/components/schemas/BlockVersion',
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-            security: [{ studio: [] }, {}],
-        },
-    },
-    '/api/blocks/@{organizationId}/{blockId}': {
-        parameters: [
-            { $ref: '#/components/parameters/organizationId' },
-            { $ref: '#/components/parameters/blockId' },
-        ],
-        get: {
-            tags: ['block'],
-            description: 'Get a single block',
-            operationId: 'getBlock',
-            responses: {
-                200: {
-                    description: 'The latest version of the block that matches the given id.',
-                    $ref: '#/components/responses/blockVersion',
-                },
-            },
-        },
-    },
-    '/api/blocks/@{organizationId}/{blockId}/versions': {
-        parameters: [
-            { $ref: '#/components/parameters/organizationId' },
-            { $ref: '#/components/parameters/blockId' },
-        ],
-        get: {
-            tags: ['block version'],
-            description: 'Retrieves all available versions of a block.',
-            operationId: 'getBlockVersions',
-            responses: {
-                200: {
-                    description: 'A list of versions of a block.',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'array',
-                                items: {
-                                    $ref: '#/components/schemas/BlockVersion',
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-        },
-    },
-    '/api/blocks/@{organizationId}/{blockId}/versions/list': {
-        parameters: [
-            { $ref: '#/components/parameters/organizationId' },
-            { $ref: '#/components/parameters/blockId' },
-        ],
-        get: {
-            tags: ['block', 'versions'],
-            description: 'Retrieve a string list of all versions of a block.',
-            operationId: 'getVersionsList',
-            responses: {
-                200: {
-                    description: 'String list of all versions of a block.',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'array',
-                                items: {
-                                    $ref: 'string',
-                                },
-                            },
-                        },
+export const pathItems = {
+    post: {
+        tags: ['main', 'block'],
+        description: 'Publish a block.',
+        operationId: 'createBlock',
+        requestBody: {
+            description: 'The new block version to publish.',
+            content: {
+                'multipart/form-data': {
+                    schema: {
+                        $ref: '#/components/schemas/BlockVersion',
                     },
                 },
             },
         },
-    },
-    '/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}': {
-        parameters: [
-            { $ref: '#/components/parameters/organizationId' },
-            { $ref: '#/components/parameters/blockId' },
-            { $ref: '#/components/parameters/blockVersion' },
-        ],
-        get: {
-            tags: ['block'],
-            description: 'Retrieve a single block version.',
-            operationId: 'getBlockVersion',
-            responses: {
-                200: {
-                    $ref: '#/components/responses/blockVersion',
-                },
-            },
-        },
-        delete: {
-            tags: ['block', 'delete'],
-            description: 'Delete a single block version.',
-            operationId: 'removeBlockVersion',
-            responses: {
-                204: {
-                    description: 'Block version has successfully been deleted',
-                },
+        responses: {
+            201: {
+                $ref: '#/components/responses/blockVersion',
             },
-            security: [{ cli: ['blocks:delete'] }],
         },
+        security: [{ cli: ['blocks:write'] }],
     },
-    '/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/asset': {
-        parameters: [
-            { $ref: '#/components/parameters/organizationId' },
-            { $ref: '#/components/parameters/blockId' },
-            { $ref: '#/components/parameters/blockVersion' },
-            {
-                name: 'filename',
-                in: 'query',
-                description: 'The file name of the block asset to download',
-                schema: { type: 'string' },
-            },
-        ],
-        get: {
-            tags: ['block'],
-            description: 'Download a single block asset',
-            operationId: 'getBlockAsset',
-            responses: {
-                200: {
-                    description: 'The asset that has been requested.',
-                },
-            },
-        },
-    },
-    '/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/messages/{language}': {
-        parameters: [
-            { $ref: '#/components/parameters/organizationId' },
-            { $ref: '#/components/parameters/blockId' },
-            { $ref: '#/components/parameters/blockVersion' },
-            {
-                in: 'path',
-                name: 'language',
-                schema: { type: 'string' },
-                description: 'The language to get messages for.',
-                required: true,
-            },
-        ],
-        get: {
-            tags: ['block'],
-            description: 'Get internationalized messages for a block.',
-            operationId: 'getBlockMessages',
-            responses: {
-                200: {
-                    description: 'A key/value mapping of block messages.',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'object',
-                                description: 'A key/value mapping of block messages.',
-                                additionalProperties: {
-                                    type: 'string',
-                                    description: 'A translated block message.',
-                                },
+    get: {
+        tags: ['common', 'block'],
+        description: 'Get all block’s latest definitions.',
+        operationId: 'queryBlocks',
+        responses: {
+            200: {
+                description: 'The list of all latest block versions.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/BlockVersion',
                             },
                         },
                     },
                 },
             },
         },
-    },
-    '/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/icon': {
-        parameters: [
-            { $ref: '#/components/parameters/organizationId' },
-            { $ref: '#/components/parameters/blockId' },
-            { $ref: '#/components/parameters/blockVersion' },
-        ],
-        get: {
-            tags: ['block'],
-            description: 'Get the icon of a block version.',
-            operationId: 'getBlockIcon',
-            responses: {
-                200: {
-                    description: 'The icon that represents the block.',
-                },
-            },
-        },
+        security: [{ studio: [] }, {}],
     },
 };
 //# sourceMappingURL=blocks.js.map

package/api/paths/containerLogs.d.ts

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

package/api/paths/containerLogs.js

@@ -1,38 +1,36 @@
-export const paths = {
-    '/api/containers/{appId}/logs/{container}': {
-        get: {
-            tags: ['container'],
-            description: 'Retrieve the logs related to a companion container',
-            operationId: 'getContainerLogs',
-            parameters: [
-                {
-                    name: 'appId',
-                    schema: { type: 'number' },
-                    description: 'Id of the app which defines the companion container',
-                    in: 'path',
-                },
-                {
-                    name: 'container',
-                    schema: { type: 'string' },
-                    description: 'Name of the companion container to fetch the logs for',
-                    in: 'path',
-                },
-            ],
-            responses: {
-                200: {
-                    description: 'Logs of the container running in a specific app',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'array',
-                                items: {},
-                            },
+export const pathItems = {
+    get: {
+        tags: ['container'],
+        description: 'Retrieve the logs related to a companion container',
+        operationId: 'getContainerLogs',
+        parameters: [
+            {
+                name: 'appId',
+                schema: { type: 'number' },
+                description: 'Id of the app which defines the companion container',
+                in: 'path',
+            },
+            {
+                name: 'container',
+                schema: { type: 'string' },
+                description: 'Name of the companion container to fetch the logs for',
+                in: 'path',
+            },
+        ],
+        responses: {
+            200: {
+                description: 'Logs of the container running in a specific app',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {},
                         },
                     },
                 },
             },
-            security: [{ studio: [] }],
         },
+        security: [{ studio: [] }],
     },
 };
 //# sourceMappingURL=containerLogs.js.map

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

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

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

@@ -0,0 +1,42 @@
+export const pathItems = {
+    parameters: [
+        {
+            name: 'token',
+            in: 'path',
+            description: 'The token of the invite.',
+            required: true,
+            schema: { type: 'string' },
+        },
+    ],
+    post: {
+        tags: ['group-invite'],
+        description: 'Respond to a given invitation.',
+        operationId: 'respondGroupInvite',
+        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',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The response has been processed.',
+            },
+        },
+        security: [{ app: [] }],
+    },
+};
+//# sourceMappingURL=respond.js.map

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

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

package/api/paths/group-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: ['group-invite'],
+        description: 'Fetch information about an invite.',
+        operationId: 'getGroupInvite',
+        responses: {
+            200: {
+                description: 'An invite response',
+                $ref: '#/components/responses/invite',
+            },
+        },
+    },
+};
+//# sourceMappingURL=token.js.map

package/api/paths/group-members/groupMemberId/role.d.ts

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

package/api/paths/group-members/groupMemberId/role.js

@@ -0,0 +1,40 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/groupMemberId' }],
+    put: {
+        tags: ['common', 'group-member'],
+        description: 'Set the role of a member within a group.',
+        operationId: 'updateGroupMemberRole',
+        parameters: [{ $ref: '#/components/parameters/selectedGroupId' }],
+        requestBody: {
+            description: 'The role to set.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['role'],
+                        properties: {
+                            role: {
+                                type: 'string',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The member’s role has been successfully updated.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/GroupMember',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: [] }, { cli: ['groups:write'] }],
+    },
+};
+//# sourceMappingURL=role.js.map

package/api/paths/group-members/groupMemberId.d.ts

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

package/api/paths/group-members/groupMemberId.js

@@ -0,0 +1,34 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/groupMemberId' }],
+    get: {
+        tags: ['common', 'group-member'],
+        description: 'Get a certain group member from a group',
+        operationId: 'getGroupMember',
+        responses: {
+            200: {
+                description: 'The specified group member',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/GroupMember',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: [] }],
+    },
+    delete: {
+        tags: ['common', 'group-member'],
+        description: 'Remove a member from a group.',
+        operationId: 'deleteGroupMember',
+        parameters: [{ $ref: '#/components/parameters/selectedGroupId' }],
+        responses: {
+            204: {
+                description: 'The group member has been removed successfully.',
+            },
+        },
+        security: [{ studio: [] }, { app: [] }, { cli: ['groups:write'] }],
+    },
+};
+//# sourceMappingURL=groupMemberId.js.map

package/api/paths/groups/groupId/invites.d.ts

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

package/api/paths/groups/groupId/invites.js

@@ -0,0 +1,87 @@
+export const pathItems = {
+    parameters: [
+        {
+            name: 'groupId',
+            in: 'path',
+            description: 'The ID of the group',
+            required: true,
+            schema: { type: 'number', readOnly: true },
+        },
+    ],
+    get: {
+        tags: ['group', 'invite'],
+        description: 'Get a list of invited group members.',
+        operationId: 'getGroupInvites',
+        responses: {
+            200: {
+                description: 'The list of all invites.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    email: {
+                                        type: 'string',
+                                        format: 'email',
+                                    },
+                                    role: {
+                                        type: 'string',
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    post: {
+        tags: ['group', 'invite'],
+        description: 'Invite a new user to a group.',
+        operationId: 'createGroupInvites',
+        parameters: [{ $ref: '#/components/parameters/selectedGroupId' }],
+        requestBody: {
+            description: 'The group invite to create.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'array',
+                        items: {
+                            type: 'object',
+                            required: ['email', 'role'],
+                            properties: {
+                                email: {
+                                    type: 'string',
+                                    format: 'email',
+                                    description: 'The email address of the user to invite.',
+                                },
+                                role: {
+                                    type: 'string',
+                                    description: 'The role to invite the user as.',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The invited member',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/AppMember',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: ['groups:write'] }, { cli: ['groups:write'] }],
+    },
+};
+//# sourceMappingURL=invites.js.map

package/api/paths/groups/groupId/members.d.ts

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

package/api/paths/groups/groupId/members.js

@@ -0,0 +1,34 @@
+export const pathItems = {
+    parameters: [
+        {
+            name: 'groupId',
+            in: 'path',
+            description: 'The ID of the group',
+            required: true,
+            schema: { type: 'number', readOnly: true },
+        },
+    ],
+    get: {
+        tags: ['common', 'app', 'group', 'members'],
+        description: 'Fetch the members of a group and their roles within the group.',
+        operationId: 'getGroupMembers',
+        parameters: [{ $ref: '#/components/parameters/selectedGroupId' }],
+        responses: {
+            200: {
+                description: 'The list of all members.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/OrganizationMember',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: ['groups:read'] }],
+    },
+};
+//# sourceMappingURL=members.js.map

package/api/paths/groups/groupId.d.ts

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